Annotation of loncom/interface/loncommon.pm, revision 1.1362
1.10 albertel 1: # The LearningOnline Network with CAPA
1.1 albertel 2: # a pile of common routines
1.10 albertel 3: #
1.1362 ! raeburn 4: # $Id: loncommon.pm,v 1.1361 2021/06/15 20:52:26 raeburn Exp $
1.10 albertel 5: #
6: # Copyright Michigan State University Board of Trustees
7: #
8: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
9: #
10: # LON-CAPA is free software; you can redistribute it and/or modify
11: # it under the terms of the GNU General Public License as published by
12: # the Free Software Foundation; either version 2 of the License, or
13: # (at your option) any later version.
14: #
15: # LON-CAPA is distributed in the hope that it will be useful,
16: # but WITHOUT ANY WARRANTY; without even the implied warranty of
17: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18: # GNU General Public License for more details.
19: #
20: # You should have received a copy of the GNU General Public License
21: # along with LON-CAPA; if not, write to the Free Software
22: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23: #
24: # /home/httpd/html/adm/gpl.txt
25: #
26: # http://www.lon-capa.org/
27: #
1.1 albertel 28:
29: # Makes a table out of the previous attempts
1.2 albertel 30: # Inputs result_from_symbread, user, domain, course_id
1.16 harris41 31: # Reads in non-network-related .tab files
1.1 albertel 32:
1.35 matthew 33: # POD header:
34:
1.45 matthew 35: =pod
36:
1.35 matthew 37: =head1 NAME
38:
39: Apache::loncommon - pile of common routines
40:
41: =head1 SYNOPSIS
42:
1.112 bowersj2 43: Common routines for manipulating connections, student answers,
44: domains, common Javascript fragments, etc.
1.35 matthew 45:
1.112 bowersj2 46: =head1 OVERVIEW
1.35 matthew 47:
1.112 bowersj2 48: A collection of commonly used subroutines that don't have a natural
49: home anywhere else. This collection helps remove
1.35 matthew 50: redundancy from other modules and increase efficiency of memory usage.
51:
52: =cut
53:
54: # End of POD header
1.1 albertel 55: package Apache::loncommon;
56:
57: use strict;
1.258 albertel 58: use Apache::lonnet;
1.46 matthew 59: use GDBM_File;
1.51 www 60: use POSIX qw(strftime mktime);
1.82 www 61: use Apache::lonmenu();
1.498 albertel 62: use Apache::lonenc();
1.117 www 63: use Apache::lonlocal;
1.685 tempelho 64: use Apache::lonnet();
1.139 matthew 65: use HTML::Entities;
1.334 albertel 66: use Apache::lonhtmlcommon();
67: use Apache::loncoursedata();
1.344 albertel 68: use Apache::lontexconvert();
1.444 albertel 69: use Apache::lonclonecourse();
1.1108 raeburn 70: use Apache::lonuserutils();
1.1110 raeburn 71: use Apache::lonuserstate();
1.1182 raeburn 72: use Apache::courseclassifier();
1.479 albertel 73: use LONCAPA qw(:DEFAULT :match);
1.1280 raeburn 74: use LONCAPA::LWPReq;
1.1328 raeburn 75: use HTTP::Request;
1.657 raeburn 76: use DateTime::TimeZone;
1.1241 raeburn 77: use DateTime::Locale;
1.1220 raeburn 78: use Encode();
1.1091 foxr 79: use Text::Aspell;
1.1094 raeburn 80: use Authen::Captcha;
81: use Captcha::reCAPTCHA;
1.1234 raeburn 82: use JSON::DWIW;
1.1174 raeburn 83: use Crypt::DES;
84: use DynaLoader; # for Crypt::DES version
1.1223 musolffc 85: use MIME::Lite;
86: use MIME::Types;
1.1292 raeburn 87: use File::Copy();
1.1300 raeburn 88: use File::Path();
1.1309 raeburn 89: use String::CRC32();
90: use Short::URL();
1.117 www 91:
1.517 raeburn 92: # ---------------------------------------------- Designs
93: use vars qw(%defaultdesign);
94:
1.22 www 95: my $readit;
96:
1.517 raeburn 97:
1.157 matthew 98: ##
99: ## Global Variables
100: ##
1.46 matthew 101:
1.643 foxr 102:
103: # ----------------------------------------------- SSI with retries:
104: #
105:
106: =pod
107:
1.648 raeburn 108: =head1 Server Side include with retries:
1.643 foxr 109:
110: =over 4
111:
1.648 raeburn 112: =item * &ssi_with_retries(resource,retries form)
1.643 foxr 113:
114: Performs an ssi with some number of retries. Retries continue either
115: until the result is ok or until the retry count supplied by the
116: caller is exhausted.
117:
118: Inputs:
1.648 raeburn 119:
120: =over 4
121:
1.643 foxr 122: resource - Identifies the resource to insert.
1.648 raeburn 123:
1.643 foxr 124: retries - Count of the number of retries allowed.
1.648 raeburn 125:
1.643 foxr 126: form - Hash that identifies the rendering options.
127:
1.648 raeburn 128: =back
129:
130: Returns:
131:
132: =over 4
133:
1.643 foxr 134: content - The content of the response. If retries were exhausted this is empty.
1.648 raeburn 135:
1.643 foxr 136: response - The response from the last attempt (which may or may not have been successful.
137:
1.648 raeburn 138: =back
139:
140: =back
141:
1.643 foxr 142: =cut
143:
144: sub ssi_with_retries {
145: my ($resource, $retries, %form) = @_;
146:
147:
148: my $ok = 0; # True if we got a good response.
149: my $content;
150: my $response;
151:
152: # Try to get the ssi done. within the retries count:
153:
154: do {
155: ($content, $response) = &Apache::lonnet::ssi($resource, %form);
156: $ok = $response->is_success;
1.650 www 157: if (!$ok) {
158: &Apache::lonnet::logthis("Failed ssi_with_retries on $resource: ".$response->is_success.', '.$response->code.', '.$response->message);
159: }
1.643 foxr 160: $retries--;
161: } while (!$ok && ($retries > 0));
162:
163: if (!$ok) {
164: $content = ''; # On error return an empty content.
165: }
166: return ($content, $response);
167:
168: }
169:
170:
171:
1.20 www 172: # ----------------------------------------------- Filetypes/Languages/Copyright
1.12 harris41 173: my %language;
1.124 www 174: my %supported_language;
1.1088 foxr 175: my %supported_codes;
1.1048 foxr 176: my %latex_language; # For choosing hyphenation in <transl..>
177: my %latex_language_bykey; # for choosing hyphenation from metadata
1.12 harris41 178: my %cprtag;
1.192 taceyjo1 179: my %scprtag;
1.351 www 180: my %fe; my %fd; my %fm;
1.41 ng 181: my %category_extensions;
1.12 harris41 182:
1.46 matthew 183: # ---------------------------------------------- Thesaurus variables
1.144 matthew 184: #
185: # %Keywords:
186: # A hash used by &keyword to determine if a word is considered a keyword.
187: # $thesaurus_db_file
188: # Scalar containing the full path to the thesaurus database.
1.46 matthew 189:
190: my %Keywords;
191: my $thesaurus_db_file;
192:
1.144 matthew 193: #
194: # Initialize values from language.tab, copyright.tab, filetypes.tab,
195: # thesaurus.tab, and filecategories.tab.
196: #
1.18 www 197: BEGIN {
1.46 matthew 198: # Variable initialization
199: $thesaurus_db_file = $Apache::lonnet::perlvar{'lonTabDir'}."/thesaurus.db";
200: #
1.22 www 201: unless ($readit) {
1.12 harris41 202: # ------------------------------------------------------------------- languages
203: {
1.158 raeburn 204: my $langtabfile = $Apache::lonnet::perlvar{'lonTabDir'}.
205: '/language.tab';
1.1317 raeburn 206: if ( open(my $fh,'<',$langtabfile) ) {
1.356 albertel 207: while (my $line = <$fh>) {
208: next if ($line=~/^\#/);
209: chomp($line);
1.1088 foxr 210: my ($key,$code,$country,$three,$enc,$val,$sup,$latex)=(split(/\t/,$line));
1.158 raeburn 211: $language{$key}=$val.' - '.$enc;
212: if ($sup) {
213: $supported_language{$key}=$sup;
1.1088 foxr 214: $supported_codes{$key} = $code;
1.158 raeburn 215: }
1.1048 foxr 216: if ($latex) {
217: $latex_language_bykey{$key} = $latex;
1.1088 foxr 218: $latex_language{$code} = $latex;
1.1048 foxr 219: }
1.158 raeburn 220: }
221: close($fh);
222: }
1.12 harris41 223: }
224: # ------------------------------------------------------------------ copyrights
225: {
1.158 raeburn 226: my $copyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
227: '/copyright.tab';
1.1317 raeburn 228: if ( open (my $fh,'<',$copyrightfile) ) {
1.356 albertel 229: while (my $line = <$fh>) {
230: next if ($line=~/^\#/);
231: chomp($line);
232: my ($key,$val)=(split(/\s+/,$line,2));
1.158 raeburn 233: $cprtag{$key}=$val;
234: }
235: close($fh);
236: }
1.12 harris41 237: }
1.351 www 238: # ----------------------------------------------------------- source copyrights
1.192 taceyjo1 239: {
240: my $sourcecopyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
241: '/source_copyright.tab';
1.1317 raeburn 242: if ( open (my $fh,'<',$sourcecopyrightfile) ) {
1.356 albertel 243: while (my $line = <$fh>) {
244: next if ($line =~ /^\#/);
245: chomp($line);
246: my ($key,$val)=(split(/\s+/,$line,2));
1.192 taceyjo1 247: $scprtag{$key}=$val;
248: }
249: close($fh);
250: }
251: }
1.63 www 252:
1.517 raeburn 253: # -------------------------------------------------------------- default domain designs
1.63 www 254: my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
1.517 raeburn 255: my $designfile = $designdir.'/default.tab';
1.1317 raeburn 256: if ( open (my $fh,'<',$designfile) ) {
1.517 raeburn 257: while (my $line = <$fh>) {
258: next if ($line =~ /^\#/);
259: chomp($line);
260: my ($key,$val)=(split(/\=/,$line));
261: if ($val) { $defaultdesign{$key}=$val; }
262: }
263: close($fh);
1.63 www 264: }
265:
1.15 harris41 266: # ------------------------------------------------------------- file categories
267: {
1.158 raeburn 268: my $categoryfile = $Apache::lonnet::perlvar{'lonTabDir'}.
269: '/filecategories.tab';
1.1317 raeburn 270: if ( open (my $fh,'<',$categoryfile) ) {
1.356 albertel 271: while (my $line = <$fh>) {
272: next if ($line =~ /^\#/);
273: chomp($line);
274: my ($extension,$category)=(split(/\s+/,$line,2));
1.1263 raeburn 275: push(@{$category_extensions{lc($category)}},$extension);
1.158 raeburn 276: }
277: close($fh);
278: }
279:
1.15 harris41 280: }
1.12 harris41 281: # ------------------------------------------------------------------ file types
282: {
1.158 raeburn 283: my $typesfile = $Apache::lonnet::perlvar{'lonTabDir'}.
284: '/filetypes.tab';
1.1317 raeburn 285: if ( open (my $fh,'<',$typesfile) ) {
1.356 albertel 286: while (my $line = <$fh>) {
287: next if ($line =~ /^\#/);
288: chomp($line);
289: my ($ending,$emb,$mime,$descr)=split(/\s+/,$line,4);
1.158 raeburn 290: if ($descr ne '') {
291: $fe{$ending}=lc($emb);
292: $fd{$ending}=$descr;
1.351 www 293: if ($mime ne 'unk') { $fm{$ending}=$mime; }
1.158 raeburn 294: }
295: }
296: close($fh);
297: }
1.12 harris41 298: }
1.22 www 299: &Apache::lonnet::logthis(
1.705 tempelho 300: "<span style='color:yellow;'>INFO: Read file types</span>");
1.22 www 301: $readit=1;
1.46 matthew 302: } # end of unless($readit)
1.32 matthew 303:
304: }
1.112 bowersj2 305:
1.42 matthew 306: ###############################################################
307: ## HTML and Javascript Helper Functions ##
308: ###############################################################
309:
310: =pod
311:
1.112 bowersj2 312: =head1 HTML and Javascript Functions
1.42 matthew 313:
1.112 bowersj2 314: =over 4
315:
1.648 raeburn 316: =item * &browser_and_searcher_javascript()
1.112 bowersj2 317:
318: X<browsing, javascript>X<searching, javascript>Returns a string
319: containing javascript with two functions, C<openbrowser> and
320: C<opensearcher>. Returned string does not contain E<lt>scriptE<gt>
321: tags.
1.42 matthew 322:
1.648 raeburn 323: =item * &openbrowser(formname,elementname,only,omit) [javascript]
1.42 matthew 324:
325: inputs: formname, elementname, only, omit
326:
327: formname and elementname indicate the name of the html form and name of
328: the element that the results of the browsing selection are to be placed in.
329:
330: Specifying 'only' will restrict the browser to displaying only files
1.185 www 331: with the given extension. Can be a comma separated list.
1.42 matthew 332:
333: Specifying 'omit' will restrict the browser to NOT displaying files
1.185 www 334: with the given extension. Can be a comma separated list.
1.42 matthew 335:
1.648 raeburn 336: =item * &opensearcher(formname,elementname) [javascript]
1.42 matthew 337:
338: Inputs: formname, elementname
339:
340: formname and elementname specify the name of the html form and the name
341: of the element the selection from the search results will be placed in.
1.542 raeburn 342:
1.42 matthew 343: =cut
344:
345: sub browser_and_searcher_javascript {
1.199 albertel 346: my ($mode)=@_;
347: if (!defined($mode)) { $mode='edit'; }
1.453 albertel 348: my $resurl=&escape_single(&lastresurl());
1.42 matthew 349: return <<END;
1.219 albertel 350: // <!-- BEGIN LON-CAPA Internal
1.50 matthew 351: var editbrowser = null;
1.135 albertel 352: function openbrowser(formname,elementname,only,omit,titleelement) {
1.170 www 353: var url = '$resurl/?';
1.42 matthew 354: if (editbrowser == null) {
355: url += 'launch=1&';
356: }
357: url += 'catalogmode=interactive&';
1.199 albertel 358: url += 'mode=$mode&';
1.611 albertel 359: url += 'inhibitmenu=yes&';
1.42 matthew 360: url += 'form=' + formname + '&';
361: if (only != null) {
362: url += 'only=' + only + '&';
1.217 albertel 363: } else {
364: url += 'only=&';
365: }
1.42 matthew 366: if (omit != null) {
367: url += 'omit=' + omit + '&';
1.217 albertel 368: } else {
369: url += 'omit=&';
370: }
1.135 albertel 371: if (titleelement != null) {
372: url += 'titleelement=' + titleelement + '&';
1.217 albertel 373: } else {
374: url += 'titleelement=&';
375: }
1.42 matthew 376: url += 'element=' + elementname + '';
377: var title = 'Browser';
1.435 albertel 378: var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42 matthew 379: options += ',width=700,height=600';
380: editbrowser = open(url,title,options,'1');
381: editbrowser.focus();
382: }
383: var editsearcher;
1.135 albertel 384: function opensearcher(formname,elementname,titleelement) {
1.42 matthew 385: var url = '/adm/searchcat?';
386: if (editsearcher == null) {
387: url += 'launch=1&';
388: }
389: url += 'catalogmode=interactive&';
1.199 albertel 390: url += 'mode=$mode&';
1.42 matthew 391: url += 'form=' + formname + '&';
1.135 albertel 392: if (titleelement != null) {
393: url += 'titleelement=' + titleelement + '&';
1.217 albertel 394: } else {
395: url += 'titleelement=&';
396: }
1.42 matthew 397: url += 'element=' + elementname + '';
398: var title = 'Search';
1.435 albertel 399: var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42 matthew 400: options += ',width=700,height=600';
401: editsearcher = open(url,title,options,'1');
402: editsearcher.focus();
403: }
1.219 albertel 404: // END LON-CAPA Internal -->
1.42 matthew 405: END
1.170 www 406: }
407:
408: sub lastresurl {
1.258 albertel 409: if ($env{'environment.lastresurl'}) {
410: return $env{'environment.lastresurl'}
1.170 www 411: } else {
412: return '/res';
413: }
414: }
415:
416: sub storeresurl {
417: my $resurl=&Apache::lonnet::clutter(shift);
418: unless ($resurl=~/^\/res/) { return 0; }
419: $resurl=~s/\/$//;
420: &Apache::lonnet::put('environment',{'lastresurl' => $resurl});
1.646 raeburn 421: &Apache::lonnet::appenv({'environment.lastresurl' => $resurl});
1.170 www 422: return 1;
1.42 matthew 423: }
424:
1.74 www 425: sub studentbrowser_javascript {
1.111 www 426: unless (
1.258 albertel 427: (($env{'request.course.id'}) &&
1.302 albertel 428: (&Apache::lonnet::allowed('srm',$env{'request.course.id'})
429: || &Apache::lonnet::allowed('srm',$env{'request.course.id'}.
430: '/'.$env{'request.course.sec'})
431: ))
1.258 albertel 432: || ($env{'request.role'}=~/^(au|dc|su)/)
1.111 www 433: ) { return ''; }
1.74 www 434: return (<<'ENDSTDBRW');
1.776 bisitz 435: <script type="text/javascript" language="Javascript">
1.824 bisitz 436: // <![CDATA[
1.74 www 437: var stdeditbrowser;
1.1337 raeburn 438: function openstdbrowser(formname,uname,udom,clicker,roleflag,ignorefilter,courseadv) {
1.74 www 439: var url = '/adm/pickstudent?';
440: var filter;
1.558 albertel 441: if (!ignorefilter) {
442: eval('filter=document.'+formname+'.'+uname+'.value;');
443: }
1.74 www 444: if (filter != null) {
445: if (filter != '') {
446: url += 'filter='+filter+'&';
447: }
448: }
449: url += 'form=' + formname + '&unameelement='+uname+
1.999 www 450: '&udomelement='+udom+
451: '&clicker='+clicker;
1.111 www 452: if (roleflag) { url+="&roles=1"; }
1.1337 raeburn 453: if (courseadv == 'condition') {
454: if (document.getElementById('courseadv')) {
455: courseadv = document.getElementById('courseadv').value;
456: }
457: }
458: if ((courseadv == 'only') || (courseadv == 'none')) { url+="&courseadv="+courseadv; }
1.102 www 459: var title = 'Student_Browser';
1.74 www 460: var options = 'scrollbars=1,resizable=1,menubar=0';
461: options += ',width=700,height=600';
462: stdeditbrowser = open(url,title,options,'1');
463: stdeditbrowser.focus();
464: }
1.824 bisitz 465: // ]]>
1.74 www 466: </script>
467: ENDSTDBRW
468: }
1.42 matthew 469:
1.1003 www 470: sub resourcebrowser_javascript {
471: unless ($env{'request.course.id'}) { return ''; }
1.1004 www 472: return (<<'ENDRESBRW');
1.1003 www 473: <script type="text/javascript" language="Javascript">
474: // <![CDATA[
475: var reseditbrowser;
1.1004 www 476: function openresbrowser(formname,reslink) {
1.1005 www 477: var url = '/adm/pickresource?form='+formname+'&reslink='+reslink;
1.1003 www 478: var title = 'Resource_Browser';
479: var options = 'scrollbars=1,resizable=1,menubar=0';
1.1005 www 480: options += ',width=700,height=500';
1.1004 www 481: reseditbrowser = open(url,title,options,'1');
482: reseditbrowser.focus();
1.1003 www 483: }
484: // ]]>
485: </script>
1.1004 www 486: ENDRESBRW
1.1003 www 487: }
488:
1.74 www 489: sub selectstudent_link {
1.1337 raeburn 490: my ($form,$unameele,$udomele,$courseadv,$clickerid)=@_;
1.999 www 491: my $callargs = "'".&Apache::lonhtmlcommon::entity_encode($form)."','".
492: &Apache::lonhtmlcommon::entity_encode($unameele)."','".
493: &Apache::lonhtmlcommon::entity_encode($udomele)."'";
1.258 albertel 494: if ($env{'request.course.id'}) {
1.302 albertel 495: if (!&Apache::lonnet::allowed('srm',$env{'request.course.id'})
496: && !&Apache::lonnet::allowed('srm',$env{'request.course.id'}.
497: '/'.$env{'request.course.sec'})) {
1.111 www 498: return '';
499: }
1.999 www 500: $callargs.=",'".&Apache::lonhtmlcommon::entity_encode($clickerid)."'";
1.1337 raeburn 501: if ($courseadv eq 'only') {
502: $callargs .= ",'',1,'$courseadv'";
503: } elsif ($courseadv eq 'none') {
504: $callargs .= ",'','','$courseadv'";
505: } elsif ($courseadv eq 'condition') {
506: $callargs .= ",'','','$courseadv'";
1.793 raeburn 507: }
508: return '<span class="LC_nobreak">'.
509: '<a href="javascript:openstdbrowser('.$callargs.');">'.
510: &mt('Select User').'</a></span>';
1.74 www 511: }
1.258 albertel 512: if ($env{'request.role'}=~/^(au|dc|su)/) {
1.1012 www 513: $callargs .= ",'',1";
1.793 raeburn 514: return '<span class="LC_nobreak">'.
515: '<a href="javascript:openstdbrowser('.$callargs.');">'.
516: &mt('Select User').'</a></span>';
1.111 www 517: }
518: return '';
1.91 www 519: }
520:
1.1004 www 521: sub selectresource_link {
522: my ($form,$reslink,$arg)=@_;
523:
524: my $callargs = "'".&Apache::lonhtmlcommon::entity_encode($form)."','".
525: &Apache::lonhtmlcommon::entity_encode($reslink)."'";
526: unless ($env{'request.course.id'}) { return $arg; }
527: return '<span class="LC_nobreak">'.
528: '<a href="javascript:openresbrowser('.$callargs.');">'.
529: $arg.'</a></span>';
530: }
531:
532:
533:
1.653 raeburn 534: sub authorbrowser_javascript {
535: return <<"ENDAUTHORBRW";
1.776 bisitz 536: <script type="text/javascript" language="JavaScript">
1.824 bisitz 537: // <![CDATA[
1.653 raeburn 538: var stdeditbrowser;
539:
540: function openauthorbrowser(formname,udom) {
541: var url = '/adm/pickauthor?';
542: url += 'form='+formname+'&roledom='+udom;
543: var title = 'Author_Browser';
544: var options = 'scrollbars=1,resizable=1,menubar=0';
545: options += ',width=700,height=600';
546: stdeditbrowser = open(url,title,options,'1');
547: stdeditbrowser.focus();
548: }
549:
1.824 bisitz 550: // ]]>
1.653 raeburn 551: </script>
552: ENDAUTHORBRW
553: }
554:
1.91 www 555: sub coursebrowser_javascript {
1.1116 raeburn 556: my ($domainfilter,$sec_element,$formname,$role_element,$crstype,
1.1221 raeburn 557: $credits_element,$instcode) = @_;
1.932 raeburn 558: my $wintitle = 'Course_Browser';
1.931 raeburn 559: if ($crstype eq 'Community') {
1.932 raeburn 560: $wintitle = 'Community_Browser';
1.909 raeburn 561: }
1.876 raeburn 562: my $id_functions = &javascript_index_functions();
563: my $output = '
1.776 bisitz 564: <script type="text/javascript" language="JavaScript">
1.824 bisitz 565: // <![CDATA[
1.468 raeburn 566: var stdeditbrowser;'."\n";
1.876 raeburn 567:
568: $output .= <<"ENDSTDBRW";
1.909 raeburn 569: function opencrsbrowser(formname,uname,udom,desc,extra_element,multflag,type,type_elem) {
1.91 www 570: var url = '/adm/pickcourse?';
1.895 raeburn 571: var formid = getFormIdByName(formname);
1.876 raeburn 572: var domainfilter = getDomainFromSelectbox(formname,udom);
1.128 albertel 573: if (domainfilter != null) {
574: if (domainfilter != '') {
575: url += 'domainfilter='+domainfilter+'&';
576: }
577: }
1.91 www 578: url += 'form=' + formname + '&cnumelement='+uname+
1.187 albertel 579: '&cdomelement='+udom+
580: '&cnameelement='+desc;
1.468 raeburn 581: if (extra_element !=null && extra_element != '') {
1.594 raeburn 582: if (formname == 'rolechoice' || formname == 'studentform') {
1.468 raeburn 583: url += '&roleelement='+extra_element;
584: if (domainfilter == null || domainfilter == '') {
585: url += '&domainfilter='+extra_element;
586: }
1.234 raeburn 587: }
1.468 raeburn 588: else {
589: if (formname == 'portform') {
590: url += '&setroles='+extra_element;
1.800 raeburn 591: } else {
592: if (formname == 'rules') {
593: url += '&fixeddom='+extra_element;
594: }
1.468 raeburn 595: }
596: }
1.230 raeburn 597: }
1.909 raeburn 598: if (type != null && type != '') {
599: url += '&type='+type;
600: }
601: if (type_elem != null && type_elem != '') {
602: url += '&typeelement='+type_elem;
603: }
1.872 raeburn 604: if (formname == 'ccrs') {
605: var ownername = document.forms[formid].ccuname.value;
606: var ownerdom = document.forms[formid].ccdomain.options[document.forms[formid].ccdomain.selectedIndex].value;
1.1238 raeburn 607: url += '&cloner='+ownername+':'+ownerdom;
608: if (type == 'Course') {
609: url += '&crscode='+document.forms[formid].crscode.value;
610: }
1.1221 raeburn 611: }
612: if (formname == 'requestcrs') {
613: url += '&crsdom=$domainfilter&crscode=$instcode';
1.872 raeburn 614: }
1.293 raeburn 615: if (multflag !=null && multflag != '') {
616: url += '&multiple='+multflag;
617: }
1.909 raeburn 618: var title = '$wintitle';
1.91 www 619: var options = 'scrollbars=1,resizable=1,menubar=0';
620: options += ',width=700,height=600';
621: stdeditbrowser = open(url,title,options,'1');
622: stdeditbrowser.focus();
623: }
1.876 raeburn 624: $id_functions
625: ENDSTDBRW
1.1116 raeburn 626: if (($sec_element ne '') || ($role_element ne '') || ($credits_element ne '')) {
627: $output .= &setsec_javascript($sec_element,$formname,$role_element,
628: $credits_element);
1.876 raeburn 629: }
630: $output .= '
631: // ]]>
632: </script>';
633: return $output;
634: }
635:
636: sub javascript_index_functions {
637: return <<"ENDJS";
638:
639: function getFormIdByName(formname) {
640: for (var i=0;i<document.forms.length;i++) {
641: if (document.forms[i].name == formname) {
642: return i;
643: }
644: }
645: return -1;
646: }
647:
648: function getIndexByName(formid,item) {
649: for (var i=0;i<document.forms[formid].elements.length;i++) {
650: if (document.forms[formid].elements[i].name == item) {
651: return i;
652: }
653: }
654: return -1;
655: }
1.468 raeburn 656:
1.876 raeburn 657: function getDomainFromSelectbox(formname,udom) {
658: var userdom;
659: var formid = getFormIdByName(formname);
660: if (formid > -1) {
661: var domid = getIndexByName(formid,udom);
662: if (domid > -1) {
663: if (document.forms[formid].elements[domid].type == 'select-one') {
664: userdom=document.forms[formid].elements[domid].options[document.forms[formid].elements[domid].selectedIndex].value;
665: }
666: if (document.forms[formid].elements[domid].type == 'hidden') {
667: userdom=document.forms[formid].elements[domid].value;
1.468 raeburn 668: }
669: }
670: }
1.876 raeburn 671: return userdom;
672: }
673:
674: ENDJS
1.468 raeburn 675:
1.876 raeburn 676: }
677:
1.1017 raeburn 678: sub javascript_array_indexof {
1.1018 raeburn 679: return <<ENDJS;
1.1017 raeburn 680: <script type="text/javascript" language="JavaScript">
681: // <![CDATA[
682:
683: if (!Array.prototype.indexOf) {
684: Array.prototype.indexOf = function (searchElement /*, fromIndex */ ) {
685: "use strict";
686: if (this === void 0 || this === null) {
687: throw new TypeError();
688: }
689: var t = Object(this);
690: var len = t.length >>> 0;
691: if (len === 0) {
692: return -1;
693: }
694: var n = 0;
695: if (arguments.length > 0) {
696: n = Number(arguments[1]);
1.1088 foxr 697: if (n !== n) { // shortcut for verifying if it is NaN
1.1017 raeburn 698: n = 0;
699: } else if (n !== 0 && n !== (1 / 0) && n !== -(1 / 0)) {
700: n = (n > 0 || -1) * Math.floor(Math.abs(n));
701: }
702: }
703: if (n >= len) {
704: return -1;
705: }
706: var k = n >= 0 ? n : Math.max(len - Math.abs(n), 0);
707: for (; k < len; k++) {
708: if (k in t && t[k] === searchElement) {
709: return k;
710: }
711: }
712: return -1;
713: }
714: }
715:
716: // ]]>
717: </script>
718:
719: ENDJS
720:
721: }
722:
1.876 raeburn 723: sub userbrowser_javascript {
724: my $id_functions = &javascript_index_functions();
725: return <<"ENDUSERBRW";
726:
1.888 raeburn 727: function openuserbrowser(formname,uname,udom,ulast,ufirst,uemail,hideudom,crsdom,caller) {
1.876 raeburn 728: var url = '/adm/pickuser?';
729: var userdom = getDomainFromSelectbox(formname,udom);
730: if (userdom != null) {
731: if (userdom != '') {
732: url += 'srchdom='+userdom+'&';
733: }
734: }
735: url += 'form=' + formname + '&unameelement='+uname+
736: '&udomelement='+udom+
737: '&ulastelement='+ulast+
738: '&ufirstelement='+ufirst+
739: '&uemailelement='+uemail+
1.881 raeburn 740: '&hideudomelement='+hideudom+
741: '&coursedom='+crsdom;
1.888 raeburn 742: if ((caller != null) && (caller != undefined)) {
743: url += '&caller='+caller;
744: }
1.876 raeburn 745: var title = 'User_Browser';
746: var options = 'scrollbars=1,resizable=1,menubar=0';
747: options += ',width=700,height=600';
748: var stdeditbrowser = open(url,title,options,'1');
749: stdeditbrowser.focus();
750: }
751:
1.888 raeburn 752: function fix_domain (formname,udom,origdom,uname) {
1.876 raeburn 753: var formid = getFormIdByName(formname);
754: if (formid > -1) {
1.888 raeburn 755: var unameid = getIndexByName(formid,uname);
1.876 raeburn 756: var domid = getIndexByName(formid,udom);
757: var hidedomid = getIndexByName(formid,origdom);
758: if (hidedomid > -1) {
759: var fixeddom = document.forms[formid].elements[hidedomid].value;
1.888 raeburn 760: var unameval = document.forms[formid].elements[unameid].value;
761: if ((fixeddom != '') && (fixeddom != undefined) && (fixeddom != null) && (unameval != '') && (unameval != undefined) && (unameval != null)) {
762: if (domid > -1) {
763: var slct = document.forms[formid].elements[domid];
764: if (slct.type == 'select-one') {
765: var i;
766: for (i=0;i<slct.length;i++) {
767: if (slct.options[i].value==fixeddom) { slct.selectedIndex=i; }
768: }
769: }
770: if (slct.type == 'hidden') {
771: slct.value = fixeddom;
1.876 raeburn 772: }
773: }
1.468 raeburn 774: }
775: }
776: }
1.876 raeburn 777: return;
778: }
779:
780: $id_functions
781: ENDUSERBRW
1.468 raeburn 782: }
783:
784: sub setsec_javascript {
1.1116 raeburn 785: my ($sec_element,$formname,$role_element,$credits_element) = @_;
1.905 raeburn 786: my (@courserolenames,@communityrolenames,$rolestr,$courserolestr,
787: $communityrolestr);
788: if ($role_element ne '') {
789: my @allroles = ('st','ta','ep','in','ad');
790: foreach my $crstype ('Course','Community') {
791: if ($crstype eq 'Community') {
792: foreach my $role (@allroles) {
793: push(@communityrolenames,&Apache::lonnet::plaintext($role,$crstype));
794: }
795: push(@communityrolenames,&Apache::lonnet::plaintext('co'));
796: } else {
797: foreach my $role (@allroles) {
798: push(@courserolenames,&Apache::lonnet::plaintext($role,$crstype));
799: }
800: push(@courserolenames,&Apache::lonnet::plaintext('cc'));
801: }
802: }
803: $rolestr = '"'.join('","',@allroles).'"';
804: $courserolestr = '"'.join('","',@courserolenames).'"';
805: $communityrolestr = '"'.join('","',@communityrolenames).'"';
806: }
1.468 raeburn 807: my $setsections = qq|
808: function setSect(sectionlist) {
1.629 raeburn 809: var sectionsArray = new Array();
810: if ((sectionlist != '') && (typeof sectionlist != "undefined")) {
811: sectionsArray = sectionlist.split(",");
812: }
1.468 raeburn 813: var numSections = sectionsArray.length;
814: document.$formname.$sec_element.length = 0;
815: if (numSections == 0) {
816: document.$formname.$sec_element.multiple=false;
817: document.$formname.$sec_element.size=1;
818: document.$formname.$sec_element.options[0] = new Option('No existing sections','',false,false)
819: } else {
820: if (numSections == 1) {
821: document.$formname.$sec_element.multiple=false;
822: document.$formname.$sec_element.size=1;
823: document.$formname.$sec_element.options[0] = new Option('Select','',true,true);
824: document.$formname.$sec_element.options[1] = new Option('No section','',false,false)
825: document.$formname.$sec_element.options[2] = new Option(sectionsArray[0],sectionsArray[0],false,false);
826: } else {
827: for (var i=0; i<numSections; i++) {
828: document.$formname.$sec_element.options[i] = new Option(sectionsArray[i],sectionsArray[i],false,false)
829: }
830: document.$formname.$sec_element.multiple=true
831: if (numSections < 3) {
832: document.$formname.$sec_element.size=numSections;
833: } else {
834: document.$formname.$sec_element.size=3;
835: }
836: document.$formname.$sec_element.options[0].selected = false
837: }
838: }
1.91 www 839: }
1.905 raeburn 840:
841: function setRole(crstype) {
1.468 raeburn 842: |;
1.905 raeburn 843: if ($role_element eq '') {
844: $setsections .= ' return;
845: }
846: ';
847: } else {
848: $setsections .= qq|
849: var elementLength = document.$formname.$role_element.length;
850: var allroles = Array($rolestr);
851: var courserolenames = Array($courserolestr);
852: var communityrolenames = Array($communityrolestr);
853: if (elementLength != undefined) {
854: if (document.$formname.$role_element.options[5].value == 'cc') {
855: if (crstype == 'Course') {
856: return;
857: } else {
858: allroles[5] = 'co';
859: for (var i=0; i<6; i++) {
860: document.$formname.$role_element.options[i].value = allroles[i];
861: document.$formname.$role_element.options[i].text = communityrolenames[i];
862: }
863: }
864: } else {
865: if (crstype == 'Community') {
866: return;
867: } else {
868: allroles[5] = 'cc';
869: for (var i=0; i<6; i++) {
870: document.$formname.$role_element.options[i].value = allroles[i];
871: document.$formname.$role_element.options[i].text = courserolenames[i];
872: }
873: }
874: }
875: }
876: return;
877: }
878: |;
879: }
1.1116 raeburn 880: if ($credits_element) {
881: $setsections .= qq|
882: function setCredits(defaultcredits) {
883: document.$formname.$credits_element.value = defaultcredits;
884: return;
885: }
886: |;
887: }
1.468 raeburn 888: return $setsections;
889: }
890:
1.91 www 891: sub selectcourse_link {
1.909 raeburn 892: my ($form,$unameele,$udomele,$desc,$extra_element,$multflag,$selecttype,
893: $typeelement) = @_;
894: my $type = $selecttype;
1.871 raeburn 895: my $linktext = &mt('Select Course');
896: if ($selecttype eq 'Community') {
1.909 raeburn 897: $linktext = &mt('Select Community');
1.1239 raeburn 898: } elsif ($selecttype eq 'Placement') {
899: $linktext = &mt('Select Placement Test');
1.906 raeburn 900: } elsif ($selecttype eq 'Course/Community') {
901: $linktext = &mt('Select Course/Community');
1.909 raeburn 902: $type = '';
1.1019 raeburn 903: } elsif ($selecttype eq 'Select') {
904: $linktext = &mt('Select');
905: $type = '';
1.871 raeburn 906: }
1.787 bisitz 907: return '<span class="LC_nobreak">'
908: ."<a href='"
909: .'javascript:opencrsbrowser("'.$form.'","'.$unameele
910: .'","'.$udomele.'","'.$desc.'","'.$extra_element
1.909 raeburn 911: .'","'.$multflag.'","'.$type.'","'.$typeelement.'");'
1.871 raeburn 912: ."'>".$linktext.'</a>'
1.787 bisitz 913: .'</span>';
1.74 www 914: }
1.42 matthew 915:
1.653 raeburn 916: sub selectauthor_link {
917: my ($form,$udom)=@_;
918: return '<a href="javascript:openauthorbrowser('."'$form','$udom'".');">'.
919: &mt('Select Author').'</a>';
920: }
921:
1.876 raeburn 922: sub selectuser_link {
1.881 raeburn 923: my ($form,$unameelem,$domelem,$lastelem,$firstelem,$emailelem,$hdomelem,
1.888 raeburn 924: $coursedom,$linktext,$caller) = @_;
1.876 raeburn 925: return '<a href="javascript:openuserbrowser('."'$form','$unameelem','$domelem',".
1.888 raeburn 926: "'$lastelem','$firstelem','$emailelem','$hdomelem','$coursedom','$caller'".
1.881 raeburn 927: ');">'.$linktext.'</a>';
1.876 raeburn 928: }
929:
1.273 raeburn 930: sub check_uncheck_jscript {
931: my $jscript = <<"ENDSCRT";
932: function checkAll(field) {
933: if (field.length > 0) {
934: for (i = 0; i < field.length; i++) {
1.1093 raeburn 935: if (!field[i].disabled) {
936: field[i].checked = true;
937: }
1.273 raeburn 938: }
939: } else {
1.1093 raeburn 940: if (!field.disabled) {
941: field.checked = true;
942: }
1.273 raeburn 943: }
944: }
945:
946: function uncheckAll(field) {
947: if (field.length > 0) {
948: for (i = 0; i < field.length; i++) {
949: field[i].checked = false ;
1.543 albertel 950: }
951: } else {
1.273 raeburn 952: field.checked = false ;
953: }
954: }
955: ENDSCRT
956: return $jscript;
957: }
958:
1.656 www 959: sub select_timezone {
1.1256 raeburn 960: my ($name,$selected,$onchange,$includeempty,$disabled)=@_;
961: my $output='<select name="'.$name.'" '.$onchange.$disabled.'>'."\n";
1.659 raeburn 962: if ($includeempty) {
963: $output .= '<option value=""';
964: if (($selected eq '') || ($selected eq 'local')) {
965: $output .= ' selected="selected" ';
966: }
967: $output .= '> </option>';
968: }
1.657 raeburn 969: my @timezones = DateTime::TimeZone->all_names;
970: foreach my $tzone (@timezones) {
971: $output.= '<option value="'.$tzone.'"';
972: if ($tzone eq $selected) {
973: $output.=' selected="selected"';
974: }
975: $output.=">$tzone</option>\n";
1.656 www 976: }
977: $output.="</select>";
978: return $output;
979: }
1.273 raeburn 980:
1.687 raeburn 981: sub select_datelocale {
1.1256 raeburn 982: my ($name,$selected,$onchange,$includeempty,$disabled)=@_;
983: my $output='<select name="'.$name.'" '.$onchange.$disabled.'>'."\n";
1.687 raeburn 984: if ($includeempty) {
985: $output .= '<option value=""';
986: if ($selected eq '') {
987: $output .= ' selected="selected" ';
988: }
989: $output .= '> </option>';
990: }
1.1241 raeburn 991: my @languages = &Apache::lonlocal::preferred_languages();
1.687 raeburn 992: my (@possibles,%locale_names);
1.1241 raeburn 993: my @locales = DateTime::Locale->ids();
994: foreach my $id (@locales) {
995: if ($id ne '') {
996: my ($en_terr,$native_terr);
997: my $loc = DateTime::Locale->load($id);
998: if (ref($loc)) {
999: $en_terr = $loc->name();
1000: $native_terr = $loc->native_name();
1.687 raeburn 1001: if (grep(/^en$/,@languages) || !@languages) {
1002: if ($en_terr ne '') {
1003: $locale_names{$id} = '('.$en_terr.')';
1004: } elsif ($native_terr ne '') {
1005: $locale_names{$id} = $native_terr;
1006: }
1007: } else {
1008: if ($native_terr ne '') {
1009: $locale_names{$id} = $native_terr.' ';
1010: } elsif ($en_terr ne '') {
1011: $locale_names{$id} = '('.$en_terr.')';
1012: }
1013: }
1.1220 raeburn 1014: $locale_names{$id} = Encode::encode('UTF-8',$locale_names{$id});
1.1241 raeburn 1015: push(@possibles,$id);
1016: }
1.687 raeburn 1017: }
1018: }
1019: foreach my $item (sort(@possibles)) {
1020: $output.= '<option value="'.$item.'"';
1021: if ($item eq $selected) {
1022: $output.=' selected="selected"';
1023: }
1024: $output.=">$item";
1025: if ($locale_names{$item} ne '') {
1.1220 raeburn 1026: $output.=' '.$locale_names{$item};
1.687 raeburn 1027: }
1028: $output.="</option>\n";
1029: }
1030: $output.="</select>";
1031: return $output;
1032: }
1033:
1.792 raeburn 1034: sub select_language {
1.1256 raeburn 1035: my ($name,$selected,$includeempty,$noedit) = @_;
1.792 raeburn 1036: my %langchoices;
1037: if ($includeempty) {
1.1117 raeburn 1038: %langchoices = ('' => 'No language preference');
1.792 raeburn 1039: }
1040: foreach my $id (&languageids()) {
1041: my $code = &supportedlanguagecode($id);
1042: if ($code) {
1043: $langchoices{$code} = &plainlanguagedescription($id);
1044: }
1045: }
1.1117 raeburn 1046: %langchoices = &Apache::lonlocal::texthash(%langchoices);
1.1256 raeburn 1047: return &select_form($selected,$name,\%langchoices,undef,$noedit);
1.792 raeburn 1048: }
1049:
1.42 matthew 1050: =pod
1.36 matthew 1051:
1.1088 foxr 1052:
1053: =item * &list_languages()
1054:
1055: Returns an array reference that is suitable for use in language prompters.
1056: Each array element is itself a two element array. The first element
1057: is the language code. The second element a descsriptiuon of the
1058: language itself. This is suitable for use in e.g.
1059: &Apache::edit::select_arg (once dereferenced that is).
1060:
1061: =cut
1062:
1063: sub list_languages {
1064: my @lang_choices;
1065:
1066: foreach my $id (&languageids()) {
1067: my $code = &supportedlanguagecode($id);
1068: if ($code) {
1069: my $selector = $supported_codes{$id};
1070: my $description = &plainlanguagedescription($id);
1.1263 raeburn 1071: push(@lang_choices, [$selector, $description]);
1.1088 foxr 1072: }
1073: }
1074: return \@lang_choices;
1075: }
1076:
1077: =pod
1078:
1.648 raeburn 1079: =item * &linked_select_forms(...)
1.36 matthew 1080:
1081: linked_select_forms returns a string containing a <script></script> block
1082: and html for two <select> menus. The select menus will be linked in that
1083: changing the value of the first menu will result in new values being placed
1084: in the second menu. The values in the select menu will appear in alphabetical
1.609 raeburn 1085: order unless a defined order is provided.
1.36 matthew 1086:
1087: linked_select_forms takes the following ordered inputs:
1088:
1089: =over 4
1090:
1.112 bowersj2 1091: =item * $formname, the name of the <form> tag
1.36 matthew 1092:
1.112 bowersj2 1093: =item * $middletext, the text which appears between the <select> tags
1.36 matthew 1094:
1.112 bowersj2 1095: =item * $firstdefault, the default value for the first menu
1.36 matthew 1096:
1.112 bowersj2 1097: =item * $firstselectname, the name of the first <select> tag
1.36 matthew 1098:
1.112 bowersj2 1099: =item * $secondselectname, the name of the second <select> tag
1.36 matthew 1100:
1.112 bowersj2 1101: =item * $hashref, a reference to a hash containing the data for the menus.
1.36 matthew 1102:
1.609 raeburn 1103: =item * $menuorder, the order of values in the first menu
1104:
1.1115 raeburn 1105: =item * $onchangefirst, additional javascript call to execute for an onchange
1106: event for the first <select> tag
1107:
1108: =item * $onchangesecond, additional javascript call to execute for an onchange
1109: event for the second <select> tag
1110:
1.1245 raeburn 1111: =item * $suffix, to differentiate separate uses of select2data javascript
1112: objects in a page.
1113:
1.41 ng 1114: =back
1115:
1.36 matthew 1116: Below is an example of such a hash. Only the 'text', 'default', and
1117: 'select2' keys must appear as stated. keys(%menu) are the possible
1118: values for the first select menu. The text that coincides with the
1.41 ng 1119: first menu value is given in $menu{$choice1}->{'text'}. The values
1.36 matthew 1120: and text for the second menu are given in the hash pointed to by
1121: $menu{$choice1}->{'select2'}.
1122:
1.112 bowersj2 1123: my %menu = ( A1 => { text =>"Choice A1" ,
1124: default => "B3",
1125: select2 => {
1126: B1 => "Choice B1",
1127: B2 => "Choice B2",
1128: B3 => "Choice B3",
1129: B4 => "Choice B4"
1.609 raeburn 1130: },
1131: order => ['B4','B3','B1','B2'],
1.112 bowersj2 1132: },
1133: A2 => { text =>"Choice A2" ,
1134: default => "C2",
1135: select2 => {
1136: C1 => "Choice C1",
1137: C2 => "Choice C2",
1138: C3 => "Choice C3"
1.609 raeburn 1139: },
1140: order => ['C2','C1','C3'],
1.112 bowersj2 1141: },
1142: A3 => { text =>"Choice A3" ,
1143: default => "D6",
1144: select2 => {
1145: D1 => "Choice D1",
1146: D2 => "Choice D2",
1147: D3 => "Choice D3",
1148: D4 => "Choice D4",
1149: D5 => "Choice D5",
1150: D6 => "Choice D6",
1151: D7 => "Choice D7"
1.609 raeburn 1152: },
1153: order => ['D4','D3','D2','D1','D7','D6','D5'],
1.112 bowersj2 1154: }
1155: );
1.36 matthew 1156:
1157: =cut
1158:
1159: sub linked_select_forms {
1160: my ($formname,
1161: $middletext,
1162: $firstdefault,
1163: $firstselectname,
1164: $secondselectname,
1.609 raeburn 1165: $hashref,
1166: $menuorder,
1.1115 raeburn 1167: $onchangefirst,
1.1245 raeburn 1168: $onchangesecond,
1169: $suffix
1.36 matthew 1170: ) = @_;
1171: my $second = "document.$formname.$secondselectname";
1172: my $first = "document.$formname.$firstselectname";
1173: # output the javascript to do the changing
1174: my $result = '';
1.776 bisitz 1175: $result.='<script type="text/javascript" language="JavaScript">'."\n";
1.824 bisitz 1176: $result.="// <![CDATA[\n";
1.1245 raeburn 1177: $result.="var select2data${suffix} = new Object();\n";
1.36 matthew 1178: $" = '","';
1179: my $debug = '';
1180: foreach my $s1 (sort(keys(%$hashref))) {
1.1245 raeburn 1181: $result.="select2data${suffix}['d_$s1'] = new Object();\n";
1182: $result.="select2data${suffix}['d_$s1'].def = new String('".
1.36 matthew 1183: $hashref->{$s1}->{'default'}."');\n";
1.1245 raeburn 1184: $result.="select2data${suffix}['d_$s1'].values = new Array(";
1.36 matthew 1185: my @s2values = sort(keys( %{ $hashref->{$s1}->{'select2'} } ));
1.609 raeburn 1186: if (ref($hashref->{$s1}->{'order'}) eq 'ARRAY') {
1187: @s2values = @{$hashref->{$s1}->{'order'}};
1188: }
1.36 matthew 1189: $result.="\"@s2values\");\n";
1.1245 raeburn 1190: $result.="select2data${suffix}['d_$s1'].texts = new Array(";
1.36 matthew 1191: my @s2texts;
1192: foreach my $value (@s2values) {
1.1263 raeburn 1193: push(@s2texts, $hashref->{$s1}->{'select2'}->{$value});
1.36 matthew 1194: }
1195: $result.="\"@s2texts\");\n";
1196: }
1197: $"=' ';
1198: $result.= <<"END";
1199:
1.1245 raeburn 1200: function select1${suffix}_changed() {
1.36 matthew 1201: // Determine new choice
1.1245 raeburn 1202: var newvalue = "d_" + $first.options[$first.selectedIndex].value;
1.36 matthew 1203: // update select2
1.1245 raeburn 1204: var values = select2data${suffix}[newvalue].values;
1205: var texts = select2data${suffix}[newvalue].texts;
1206: var select2def = select2data${suffix}[newvalue].def;
1.36 matthew 1207: var i;
1208: // out with the old
1.1245 raeburn 1209: $second.options.length = 0;
1210: // in with the new
1.36 matthew 1211: for (i=0;i<values.length; i++) {
1212: $second.options[i] = new Option(values[i]);
1.143 matthew 1213: $second.options[i].value = values[i];
1.36 matthew 1214: $second.options[i].text = texts[i];
1215: if (values[i] == select2def) {
1216: $second.options[i].selected = true;
1217: }
1218: }
1219: }
1.824 bisitz 1220: // ]]>
1.36 matthew 1221: </script>
1222: END
1223: # output the initial values for the selection lists
1.1245 raeburn 1224: $result .= "<select size=\"1\" name=\"$firstselectname\" onchange=\"select1${suffix}_changed();$onchangefirst\">\n";
1.609 raeburn 1225: my @order = sort(keys(%{$hashref}));
1226: if (ref($menuorder) eq 'ARRAY') {
1227: @order = @{$menuorder};
1228: }
1229: foreach my $value (@order) {
1.36 matthew 1230: $result.=" <option value=\"$value\" ";
1.253 albertel 1231: $result.=" selected=\"selected\" " if ($value eq $firstdefault);
1.119 www 1232: $result.=">".&mt($hashref->{$value}->{'text'})."</option>\n";
1.36 matthew 1233: }
1234: $result .= "</select>\n";
1235: my %select2 = %{$hashref->{$firstdefault}->{'select2'}};
1236: $result .= $middletext;
1.1115 raeburn 1237: $result .= "<select size=\"1\" name=\"$secondselectname\"";
1238: if ($onchangesecond) {
1239: $result .= ' onchange="'.$onchangesecond.'"';
1240: }
1241: $result .= ">\n";
1.36 matthew 1242: my $seconddefault = $hashref->{$firstdefault}->{'default'};
1.609 raeburn 1243:
1244: my @secondorder = sort(keys(%select2));
1245: if (ref($hashref->{$firstdefault}->{'order'}) eq 'ARRAY') {
1246: @secondorder = @{$hashref->{$firstdefault}->{'order'}};
1247: }
1248: foreach my $value (@secondorder) {
1.36 matthew 1249: $result.=" <option value=\"$value\" ";
1.253 albertel 1250: $result.=" selected=\"selected\" " if ($value eq $seconddefault);
1.119 www 1251: $result.=">".&mt($select2{$value})."</option>\n";
1.36 matthew 1252: }
1253: $result .= "</select>\n";
1254: # return $debug;
1255: return $result;
1256: } # end of sub linked_select_forms {
1257:
1.45 matthew 1258: =pod
1.44 bowersj2 1259:
1.973 raeburn 1260: =item * &help_open_topic($topic,$text,$stayOnPage,$width,$height,$imgid)
1.44 bowersj2 1261:
1.112 bowersj2 1262: Returns a string corresponding to an HTML link to the given help
1263: $topic, where $topic corresponds to the name of a .tex file in
1264: /home/httpd/html/adm/help/tex, with underscores replaced by
1265: spaces.
1266:
1267: $text will optionally be linked to the same topic, allowing you to
1268: link text in addition to the graphic. If you do not want to link
1269: text, but wish to specify one of the later parameters, pass an
1270: empty string.
1271:
1272: $stayOnPage is a value that will be interpreted as a boolean. If true,
1273: the link will not open a new window. If false, the link will open
1274: a new window using Javascript. (Default is false.)
1275:
1276: $width and $height are optional numerical parameters that will
1277: override the width and height of the popped up window, which may
1.973 raeburn 1278: be useful for certain help topics with big pictures included.
1279:
1280: $imgid is the id of the img tag used for the help icon. This may be
1281: used in a javascript call to switch the image src. See
1282: lonhtmlcommon::htmlareaselectactive() for an example.
1.44 bowersj2 1283:
1284: =cut
1285:
1286: sub help_open_topic {
1.973 raeburn 1287: my ($topic, $text, $stayOnPage, $width, $height, $imgid) = @_;
1.48 bowersj2 1288: $text = "" if (not defined $text);
1.44 bowersj2 1289: $stayOnPage = 0 if (not defined $stayOnPage);
1.1033 www 1290: $width = 500 if (not defined $width);
1.44 bowersj2 1291: $height = 400 if (not defined $height);
1292: my $filename = $topic;
1293: $filename =~ s/ /_/g;
1294:
1.48 bowersj2 1295: my $template = "";
1296: my $link;
1.572 banghart 1297:
1.159 www 1298: $topic=~s/\W/\_/g;
1.44 bowersj2 1299:
1.572 banghart 1300: if (!$stayOnPage) {
1.1033 www 1301: $link = "javascript:openMyModal('/adm/help/${filename}.hlp',$width,$height,'yes');";
1.1037 www 1302: } elsif ($stayOnPage eq 'popup') {
1303: $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 1304: } else {
1.48 bowersj2 1305: $link = "/adm/help/${filename}.hlp";
1306: }
1307:
1308: # Add the text
1.1314 raeburn 1309: my $target = ' target="_top"';
1310: if (($env{'request.lti.login'}) && ($env{'request.lti.target'} eq 'iframe')) {
1311: $target = '';
1312: }
1.755 neumanie 1313: if ($text ne "") {
1.763 bisitz 1314: $template.='<span class="LC_help_open_topic">'
1.1314 raeburn 1315: .'<a'.$target.' href="'.$link.'">'
1.763 bisitz 1316: .$text.'</a>';
1.48 bowersj2 1317: }
1318:
1.763 bisitz 1319: # (Always) Add the graphic
1.179 matthew 1320: my $title = &mt('Online Help');
1.667 raeburn 1321: my $helpicon=&lonhttpdurl("/adm/help/help.png");
1.973 raeburn 1322: if ($imgid ne '') {
1323: $imgid = ' id="'.$imgid.'"';
1324: }
1.1314 raeburn 1325: $template.=' <a'.$target.' href="'.$link.'" title="'.$title.'">'
1.763 bisitz 1326: .'<img src="'.$helpicon.'" border="0"'
1327: .' alt="'.&mt('Help: [_1]',$topic).'"'
1.973 raeburn 1328: .' title="'.$title.'" style="vertical-align:middle;"'.$imgid
1.763 bisitz 1329: .' /></a>';
1330: if ($text ne "") {
1331: $template.='</span>';
1332: }
1.44 bowersj2 1333: return $template;
1334:
1.106 bowersj2 1335: }
1336:
1337: # This is a quicky function for Latex cheatsheet editing, since it
1338: # appears in at least four places
1339: sub helpLatexCheatsheet {
1.1037 www 1340: my ($topic,$text,$not_author,$stayOnPage) = @_;
1.732 raeburn 1341: my $out;
1.106 bowersj2 1342: my $addOther = '';
1.732 raeburn 1343: if ($topic) {
1.1037 www 1344: $addOther = '<span>'.&help_open_topic($topic,&mt($text),$stayOnPage, undef, 600).'</span> ';
1.763 bisitz 1345: }
1346: $out = '<span>' # Start cheatsheet
1347: .$addOther
1348: .'<span>'
1.1037 www 1349: .&help_open_topic('Greek_Symbols',&mt('Greek Symbols'),$stayOnPage,undef,600)
1.763 bisitz 1350: .'</span> <span>'
1.1037 www 1351: .&help_open_topic('Other_Symbols',&mt('Other Symbols'),$stayOnPage,undef,600)
1.763 bisitz 1352: .'</span>';
1.732 raeburn 1353: unless ($not_author) {
1.1186 kruse 1354: $out .= '<span>'
1355: .&help_open_topic('Authoring_Output_Tags',&mt('Output Tags'),$stayOnPage,undef,600)
1356: .'</span> <span>'
1357: .&help_open_topic('Authoring_Multilingual_Problems',&mt('How to create problems in different languages'),$stayOnPage,undef,600)
1.763 bisitz 1358: .'</span>';
1.732 raeburn 1359: }
1.763 bisitz 1360: $out .= '</span>'; # End cheatsheet
1.732 raeburn 1361: return $out;
1.172 www 1362: }
1363:
1.430 albertel 1364: sub general_help {
1365: my $helptopic='Student_Intro';
1366: if ($env{'request.role'}=~/^(ca|au)/) {
1367: $helptopic='Authoring_Intro';
1.907 raeburn 1368: } elsif ($env{'request.role'}=~/^(cc|co)/) {
1.430 albertel 1369: $helptopic='Course_Coordination_Intro';
1.672 raeburn 1370: } elsif ($env{'request.role'}=~/^dc/) {
1371: $helptopic='Domain_Coordination_Intro';
1.430 albertel 1372: }
1373: return $helptopic;
1374: }
1375:
1376: sub update_help_link {
1377: my ($topic,$component_help,$faq,$bug,$stayOnPage) = @_;
1378: my $origurl = $ENV{'REQUEST_URI'};
1379: $origurl=~s|^/~|/priv/|;
1380: my $timestamp = time;
1381: foreach my $datum (\$topic,\$component_help,\$faq,\$bug,\$origurl) {
1382: $$datum = &escape($$datum);
1383: }
1384:
1385: my $banner_link = "/adm/helpmenu?page=banner&topic=$topic&component_help=$component_help&faq=$faq&bug=$bug&origurl=$origurl&stamp=$timestamp&stayonpage=$stayOnPage";
1386: my $output .= <<"ENDOUTPUT";
1387: <script type="text/javascript">
1.824 bisitz 1388: // <![CDATA[
1.430 albertel 1389: banner_link = '$banner_link';
1.824 bisitz 1390: // ]]>
1.430 albertel 1391: </script>
1392: ENDOUTPUT
1393: return $output;
1394: }
1395:
1396: # now just updates the help link and generates a blue icon
1.193 raeburn 1397: sub help_open_menu {
1.430 albertel 1398: my ($topic,$component_help,$faq,$bug,$stayOnPage,$width,$height,$text)
1.552 banghart 1399: = @_;
1.949 droeschl 1400: $stayOnPage = 1;
1.430 albertel 1401: my $output;
1402: if ($component_help) {
1403: if (!$text) {
1404: $output=&help_open_topic($component_help,undef,$stayOnPage,
1405: $width,$height);
1406: } else {
1407: my $help_text;
1408: $help_text=&unescape($topic);
1409: $output='<table><tr><td>'.
1410: &help_open_topic($component_help,$help_text,$stayOnPage,
1411: $width,$height).'</td></tr></table>';
1412: }
1413: }
1414: my $banner_link = &update_help_link($topic,$component_help,$faq,$bug,$stayOnPage);
1415: return $output.$banner_link;
1416: }
1417:
1418: sub top_nav_help {
1419: my ($text) = @_;
1.436 albertel 1420: $text = &mt($text);
1.949 droeschl 1421: my $stay_on_page = 1;
1422:
1.1168 raeburn 1423: my ($link,$banner_link);
1424: unless ($env{'request.noversionuri'} =~ m{^/adm/helpmenu}) {
1425: $link = ($stay_on_page) ? "javascript:helpMenu('display')"
1426: : "javascript:helpMenu('open')";
1427: $banner_link = &update_help_link(undef,undef,undef,undef,$stay_on_page);
1428: }
1.201 raeburn 1429: my $title = &mt('Get help');
1.1168 raeburn 1430: if ($link) {
1431: return <<"END";
1.436 albertel 1432: $banner_link
1.1159 raeburn 1433: <a href="$link" title="$title">$text</a>
1.436 albertel 1434: END
1.1168 raeburn 1435: } else {
1436: return ' '.$text.' ';
1437: }
1.436 albertel 1438: }
1439:
1440: sub help_menu_js {
1.1154 raeburn 1441: my ($httphost) = @_;
1.949 droeschl 1442: my $stayOnPage = 1;
1.436 albertel 1443: my $width = 620;
1444: my $height = 600;
1.430 albertel 1445: my $helptopic=&general_help();
1.1154 raeburn 1446: my $details_link = $httphost.'/adm/help/'.$helptopic.'.hlp';
1.261 albertel 1447: my $nothing=&Apache::lonhtmlcommon::javascript_nothing();
1.331 albertel 1448: my $start_page =
1449: &Apache::loncommon::start_page('Help Menu', undef,
1450: {'frameset' => 1,
1451: 'js_ready' => 1,
1.1154 raeburn 1452: 'use_absolute' => $httphost,
1.331 albertel 1453: 'add_entries' => {
1.1168 raeburn 1454: 'border' => '0',
1.579 raeburn 1455: 'rows' => "110,*",},});
1.331 albertel 1456: my $end_page =
1457: &Apache::loncommon::end_page({'frameset' => 1,
1458: 'js_ready' => 1,});
1459:
1.436 albertel 1460: my $template .= <<"ENDTEMPLATE";
1461: <script type="text/javascript">
1.877 bisitz 1462: // <![CDATA[
1.253 albertel 1463: // <!-- BEGIN LON-CAPA Internal
1.430 albertel 1464: var banner_link = '';
1.243 raeburn 1465: function helpMenu(target) {
1466: var caller = this;
1467: if (target == 'open') {
1468: var newWindow = null;
1469: try {
1.262 albertel 1470: newWindow = window.open($nothing,"helpmenu","HEIGHT=$height,WIDTH=$width,resizable=yes,scrollbars=yes" )
1.243 raeburn 1471: }
1472: catch(error) {
1473: writeHelp(caller);
1474: return;
1475: }
1476: if (newWindow) {
1477: caller = newWindow;
1478: }
1.193 raeburn 1479: }
1.243 raeburn 1480: writeHelp(caller);
1481: return;
1482: }
1483: function writeHelp(caller) {
1.1168 raeburn 1484: caller.document.writeln('$start_page\\n<frame name="bannerframe" src="'+banner_link+'" marginwidth="0" marginheight="0" frameborder="0">\\n');
1485: caller.document.writeln('<frame name="bodyframe" src="$details_link" marginwidth="0" marginheight="0" frameborder="0">\\n$end_page');
1486: caller.document.close();
1487: caller.focus();
1.193 raeburn 1488: }
1.877 bisitz 1489: // END LON-CAPA Internal -->
1.253 albertel 1490: // ]]>
1.436 albertel 1491: </script>
1.193 raeburn 1492: ENDTEMPLATE
1493: return $template;
1494: }
1495:
1.172 www 1496: sub help_open_bug {
1497: my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258 albertel 1498: unless ($env{'user.adv'}) { return ''; }
1.172 www 1499: unless ($Apache::lonnet::perlvar{'BugzillaHost'}) { return ''; }
1500: $text = "" if (not defined $text);
1501: $stayOnPage=1;
1.184 albertel 1502: $width = 600 if (not defined $width);
1503: $height = 600 if (not defined $height);
1.172 www 1504:
1505: $topic=~s/\W+/\+/g;
1506: my $link='';
1507: my $template='';
1.379 albertel 1508: my $url=$Apache::lonnet::perlvar{'BugzillaHost'}.'enter_bug.cgi?product=LON-CAPA&bug_file_loc='.
1509: &escape($ENV{'REQUEST_URI'}).'&component='.$topic;
1.172 www 1510: if (!$stayOnPage)
1511: {
1512: $link = "javascript:void(open('$url', 'Bugzilla', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1513: }
1514: else
1515: {
1516: $link = $url;
1517: }
1.1314 raeburn 1518:
1519: my $target = ' target="_top"';
1520: if (($env{'request.lti.login'}) && ($env{'request.lti.target'} eq 'iframe')) {
1521: $target = '';
1522: }
1.172 www 1523: # Add the text
1524: if ($text ne "")
1525: {
1526: $template .=
1527: "<table bgcolor='#AA3333' cellspacing='1' cellpadding='1' border='0'><tr>".
1.1314 raeburn 1528: "<td bgcolor='#FF5555'><a".$target." href=\"$link\"><span style=\"color:#FFFFFF;font-size:10pt;\">$text</span></a>";
1.172 www 1529: }
1530:
1531: # Add the graphic
1.179 matthew 1532: my $title = &mt('Report a Bug');
1.215 albertel 1533: my $bugicon=&lonhttpdurl("/adm/lonMisc/smallBug.gif");
1.172 www 1534: $template .= <<"ENDTEMPLATE";
1.1314 raeburn 1535: <a$target href="$link" title="$title"><img src="$bugicon" border="0" alt="(Bug: $topic)" /></a>
1.172 www 1536: ENDTEMPLATE
1537: if ($text ne '') { $template.='</td></tr></table>' };
1538: return $template;
1539:
1540: }
1541:
1542: sub help_open_faq {
1543: my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258 albertel 1544: unless ($env{'user.adv'}) { return ''; }
1.172 www 1545: unless ($Apache::lonnet::perlvar{'FAQHost'}) { return ''; }
1546: $text = "" if (not defined $text);
1547: $stayOnPage=1;
1548: $width = 350 if (not defined $width);
1549: $height = 400 if (not defined $height);
1550:
1551: $topic=~s/\W+/\+/g;
1552: my $link='';
1553: my $template='';
1554: my $url=$Apache::lonnet::perlvar{'FAQHost'}.'/fom/cache/'.$topic.'.html';
1555: if (!$stayOnPage)
1556: {
1557: $link = "javascript:void(open('$url', 'FAQ-O-Matic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1558: }
1559: else
1560: {
1561: $link = $url;
1562: }
1563:
1564: # Add the text
1565: if ($text ne "")
1566: {
1567: $template .=
1.173 www 1568: "<table bgcolor='#337733' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705 tempelho 1569: "<td bgcolor='#448844'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF; font-size:10pt;\">$text</span></a>";
1.172 www 1570: }
1571:
1572: # Add the graphic
1.179 matthew 1573: my $title = &mt('View the FAQ');
1.215 albertel 1574: my $faqicon=&lonhttpdurl("/adm/lonMisc/smallFAQ.gif");
1.172 www 1575: $template .= <<"ENDTEMPLATE";
1.436 albertel 1576: <a target="_top" href="$link" title="$title"><img src="$faqicon" border="0" alt="(FAQ: $topic)" /></a>
1.172 www 1577: ENDTEMPLATE
1578: if ($text ne '') { $template.='</td></tr></table>' };
1579: return $template;
1580:
1.44 bowersj2 1581: }
1.37 matthew 1582:
1.180 matthew 1583: ###############################################################
1584: ###############################################################
1585:
1.45 matthew 1586: =pod
1587:
1.648 raeburn 1588: =item * &change_content_javascript():
1.256 matthew 1589:
1590: This and the next function allow you to create small sections of an
1591: otherwise static HTML page that you can update on the fly with
1592: Javascript, even in Netscape 4.
1593:
1594: The Javascript fragment returned by this function (no E<lt>scriptE<gt> tag)
1595: must be written to the HTML page once. It will prove the Javascript
1596: function "change(name, content)". Calling the change function with the
1597: name of the section
1598: you want to update, matching the name passed to C<changable_area>, and
1599: the new content you want to put in there, will put the content into
1600: that area.
1601:
1602: B<Note>: Netscape 4 only reserves enough space for the changable area
1603: to contain room for the original contents. You need to "make space"
1604: for whatever changes you wish to make, and be B<sure> to check your
1605: code in Netscape 4. This feature in Netscape 4 is B<not> powerful;
1606: it's adequate for updating a one-line status display, but little more.
1607: This script will set the space to 100% width, so you only need to
1608: worry about height in Netscape 4.
1609:
1610: Modern browsers are much less limiting, and if you can commit to the
1611: user not using Netscape 4, this feature may be used freely with
1612: pretty much any HTML.
1613:
1614: =cut
1615:
1616: sub change_content_javascript {
1617: # If we're on Netscape 4, we need to use Layer-based code
1.258 albertel 1618: if ($env{'browser.type'} eq 'netscape' &&
1619: $env{'browser.version'} =~ /^4\./) {
1.256 matthew 1620: return (<<NETSCAPE4);
1621: function change(name, content) {
1622: doc = document.layers[name+"___escape"].layers[0].document;
1623: doc.open();
1624: doc.write(content);
1625: doc.close();
1626: }
1627: NETSCAPE4
1628: } else {
1629: # Otherwise, we need to use semi-standards-compliant code
1630: # (technically, "innerHTML" isn't standard but the equivalent
1631: # is really scary, and every useful browser supports it
1632: return (<<DOMBASED);
1633: function change(name, content) {
1634: element = document.getElementById(name);
1635: element.innerHTML = content;
1636: }
1637: DOMBASED
1638: }
1639: }
1640:
1641: =pod
1642:
1.648 raeburn 1643: =item * &changable_area($name,$origContent):
1.256 matthew 1644:
1645: This provides a "changable area" that can be modified on the fly via
1646: the Javascript code provided in C<change_content_javascript>. $name is
1647: the name you will use to reference the area later; do not repeat the
1648: same name on a given HTML page more then once. $origContent is what
1649: the area will originally contain, which can be left blank.
1650:
1651: =cut
1652:
1653: sub changable_area {
1654: my ($name, $origContent) = @_;
1655:
1.258 albertel 1656: if ($env{'browser.type'} eq 'netscape' &&
1657: $env{'browser.version'} =~ /^4\./) {
1.256 matthew 1658: # If this is netscape 4, we need to use the Layer tag
1659: return "<ilayer width='100%' id='${name}___escape' overflow='none'><layer width='100%' id='$name' overflow='none'>$origContent</layer></ilayer>";
1660: } else {
1661: return "<span id='$name'>$origContent</span>";
1662: }
1663: }
1664:
1665: =pod
1666:
1.648 raeburn 1667: =item * &viewport_geometry_js
1.590 raeburn 1668:
1669: Provides javascript object (Geometry) which can provide information about the viewport geometry for the client browser.
1670:
1671: =cut
1672:
1673:
1674: sub viewport_geometry_js {
1675: return <<"GEOMETRY";
1676: var Geometry = {};
1677: function init_geometry() {
1678: if (Geometry.init) { return };
1679: Geometry.init=1;
1680: if (window.innerHeight) {
1681: Geometry.getViewportHeight = function() { return window.innerHeight; };
1682: Geometry.getViewportWidth = function() { return window.innerWidth; };
1683: Geometry.getHorizontalScroll = function() { return window.pageXOffset; };
1684: Geometry.getVerticalScroll = function() { return window.pageYOffset; };
1685: }
1686: else if (document.documentElement && document.documentElement.clientHeight) {
1687: Geometry.getViewportHeight =
1688: function() { return document.documentElement.clientHeight; };
1689: Geometry.getViewportWidth =
1690: function() { return document.documentElement.clientWidth; };
1691:
1692: Geometry.getHorizontalScroll =
1693: function() { return document.documentElement.scrollLeft; };
1694: Geometry.getVerticalScroll =
1695: function() { return document.documentElement.scrollTop; };
1696: }
1697: else if (document.body.clientHeight) {
1698: Geometry.getViewportHeight =
1699: function() { return document.body.clientHeight; };
1700: Geometry.getViewportWidth =
1701: function() { return document.body.clientWidth; };
1702: Geometry.getHorizontalScroll =
1703: function() { return document.body.scrollLeft; };
1704: Geometry.getVerticalScroll =
1705: function() { return document.body.scrollTop; };
1706: }
1707: }
1708:
1709: GEOMETRY
1710: }
1711:
1712: =pod
1713:
1.648 raeburn 1714: =item * &viewport_size_js()
1.590 raeburn 1715:
1716: 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.
1717:
1718: =cut
1719:
1720: sub viewport_size_js {
1721: my $geometry = &viewport_geometry_js();
1722: return <<"DIMS";
1723:
1724: $geometry
1725:
1726: function getViewportDims(width,height) {
1727: init_geometry();
1728: width.value = Geometry.getViewportWidth();
1729: height.value = Geometry.getViewportHeight();
1730: return;
1731: }
1732:
1733: DIMS
1734: }
1735:
1736: =pod
1737:
1.648 raeburn 1738: =item * &resize_textarea_js()
1.565 albertel 1739:
1740: emits the needed javascript to resize a textarea to be as big as possible
1741:
1742: creates a function resize_textrea that takes two IDs first should be
1743: the id of the element to resize, second should be the id of a div that
1744: surrounds everything that comes after the textarea, this routine needs
1745: to be attached to the <body> for the onload and onresize events.
1746:
1.648 raeburn 1747: =back
1.565 albertel 1748:
1749: =cut
1750:
1751: sub resize_textarea_js {
1.590 raeburn 1752: my $geometry = &viewport_geometry_js();
1.565 albertel 1753: return <<"RESIZE";
1754: <script type="text/javascript">
1.824 bisitz 1755: // <![CDATA[
1.590 raeburn 1756: $geometry
1.565 albertel 1757:
1.588 albertel 1758: function getX(element) {
1759: var x = 0;
1760: while (element) {
1761: x += element.offsetLeft;
1762: element = element.offsetParent;
1763: }
1764: return x;
1765: }
1766: function getY(element) {
1767: var y = 0;
1768: while (element) {
1769: y += element.offsetTop;
1770: element = element.offsetParent;
1771: }
1772: return y;
1773: }
1774:
1775:
1.565 albertel 1776: function resize_textarea(textarea_id,bottom_id) {
1777: init_geometry();
1778: var textarea = document.getElementById(textarea_id);
1779: //alert(textarea);
1780:
1.588 albertel 1781: var textarea_top = getY(textarea);
1.565 albertel 1782: var textarea_height = textarea.offsetHeight;
1783: var bottom = document.getElementById(bottom_id);
1.588 albertel 1784: var bottom_top = getY(bottom);
1.565 albertel 1785: var bottom_height = bottom.offsetHeight;
1786: var window_height = Geometry.getViewportHeight();
1.588 albertel 1787: var fudge = 23;
1.565 albertel 1788: var new_height = window_height-fudge-textarea_top-bottom_height;
1789: if (new_height < 300) {
1790: new_height = 300;
1791: }
1792: textarea.style.height=new_height+'px';
1793: }
1.824 bisitz 1794: // ]]>
1.565 albertel 1795: </script>
1796: RESIZE
1797:
1798: }
1799:
1.1205 golterma 1800: sub colorfuleditor_js {
1.1248 raeburn 1801: my $browse_or_search;
1802: my $respath;
1803: my ($cnum,$cdom) = &crsauthor_url();
1804: if ($cnum) {
1805: $respath = "/res/$cdom/$cnum/";
1806: my %js_lt = &Apache::lonlocal::texthash(
1807: sunm => 'Sub-directory name',
1808: save => 'Save page to make this permanent',
1809: );
1810: &js_escape(\%js_lt);
1811: $browse_or_search = <<"END";
1812:
1813: function toggleChooser(form,element,titleid,only,search) {
1814: var disp = 'none';
1815: if (document.getElementById('chooser_'+element)) {
1816: var curr = document.getElementById('chooser_'+element).style.display;
1817: if (curr == 'none') {
1818: disp='inline';
1819: if (form.elements['chooser_'+element].length) {
1820: for (var i=0; i<form.elements['chooser_'+element].length; i++) {
1821: form.elements['chooser_'+element][i].checked = false;
1822: }
1823: }
1824: toggleResImport(form,element);
1825: }
1826: document.getElementById('chooser_'+element).style.display = disp;
1827: }
1828: }
1829:
1830: function toggleCrsFile(form,element,numdirs) {
1831: if (document.getElementById('chooser_'+element+'_crsres')) {
1832: var curr = document.getElementById('chooser_'+element+'_crsres').style.display;
1833: if (curr == 'none') {
1834: if (numdirs) {
1835: form.elements['coursepath_'+element].selectedIndex = 0;
1836: if (numdirs > 1) {
1837: window['select1'+element+'_changed']();
1838: }
1839: }
1840: }
1841: document.getElementById('chooser_'+element+'_crsres').style.display = 'block';
1842:
1843: }
1844: if (document.getElementById('chooser_'+element+'_upload')) {
1845: document.getElementById('chooser_'+element+'_upload').style.display = 'none';
1846: if (document.getElementById('uploadcrsres_'+element)) {
1847: document.getElementById('uploadcrsres_'+element).value = '';
1848: }
1849: }
1850: return;
1851: }
1852:
1853: function toggleCrsUpload(form,element,numcrsdirs) {
1854: if (document.getElementById('chooser_'+element+'_crsres')) {
1855: document.getElementById('chooser_'+element+'_crsres').style.display = 'none';
1856: }
1857: if (document.getElementById('chooser_'+element+'_upload')) {
1858: var curr = document.getElementById('chooser_'+element+'_upload').style.display;
1859: if (curr == 'none') {
1860: if (numcrsdirs) {
1861: form.elements['crsauthorpath_'+element].selectedIndex = 0;
1862: form.elements['newsubdir_'+element][0].checked = true;
1863: toggleNewsubdir(form,element);
1864: }
1865: }
1866: document.getElementById('chooser_'+element+'_upload').style.display = 'block';
1867: }
1868: return;
1869: }
1870:
1871: function toggleResImport(form,element) {
1872: var choices = new Array('crsres','upload');
1873: for (var i=0; i<choices.length; i++) {
1874: if (document.getElementById('chooser_'+element+'_'+choices[i])) {
1875: document.getElementById('chooser_'+element+'_'+choices[i]).style.display = 'none';
1876: }
1877: }
1878: }
1879:
1880: function toggleNewsubdir(form,element) {
1881: var newsub = form.elements['newsubdir_'+element];
1882: if (newsub) {
1883: if (newsub.length) {
1884: for (var j=0; j<newsub.length; j++) {
1885: if (newsub[j].checked) {
1886: if (document.getElementById('newsubdirname_'+element)) {
1887: if (newsub[j].value == '1') {
1888: document.getElementById('newsubdirname_'+element).type = "text";
1889: if (document.getElementById('newsubdir_'+element)) {
1890: document.getElementById('newsubdir_'+element).innerHTML = '<br />$js_lt{sunm}';
1891: }
1892: } else {
1893: document.getElementById('newsubdirname_'+element).type = "hidden";
1894: document.getElementById('newsubdirname_'+element).value = "";
1895: document.getElementById('newsubdir_'+element).innerHTML = "";
1896: }
1897: }
1898: break;
1899: }
1900: }
1901: }
1902: }
1903: }
1904:
1905: function updateCrsFile(form,element) {
1906: var directory = form.elements['coursepath_'+element];
1907: var filename = form.elements['coursefile_'+element];
1908: var path = directory.options[directory.selectedIndex].value;
1909: var file = filename.options[filename.selectedIndex].value;
1910: form.elements[element].value = '$respath';
1911: if (path == '/') {
1912: form.elements[element].value += file;
1913: } else {
1914: form.elements[element].value += path+'/'+file;
1915: }
1916: unClean();
1917: if (document.getElementById('previewimg_'+element)) {
1918: document.getElementById('previewimg_'+element).src = form.elements[element].value;
1919: var newsrc = document.getElementById('previewimg_'+element).src;
1920: }
1921: if (document.getElementById('showimg_'+element)) {
1922: document.getElementById('showimg_'+element).innerHTML = '($js_lt{save})';
1923: }
1924: toggleChooser(form,element);
1925: return;
1926: }
1927:
1928: function uploadDone(suffix,name) {
1929: if (name) {
1930: document.forms["lonhomework"].elements[suffix].value = name;
1931: unClean();
1932: toggleChooser(document.forms["lonhomework"],suffix);
1933: }
1934: }
1935:
1936: \$(document).ready(function(){
1937:
1938: \$(document).delegate('form :submit', 'click', function( event ) {
1939: if ( \$( this ).hasClass( "LC_uploadcrsres" ) ) {
1940: var buttonId = this.id;
1941: var suffix = buttonId.toString();
1942: suffix = suffix.replace(/^crsupload_/,'');
1943: event.preventDefault();
1944: document.lonhomework.target = 'crsupload_target_'+suffix;
1945: document.lonhomework.action = '/adm/coursepub?LC_uploadcrsres='+suffix;
1946: \$(this.form).submit();
1947: document.lonhomework.target = '';
1948: if (document.getElementById('crsuploadto_'+suffix)) {
1949: document.lonhomework.action = document.getElementById('crsuploadto_'+suffix).value;
1950: }
1951: return false;
1952: }
1953: });
1954: });
1955: END
1956: }
1.1205 golterma 1957: return <<"COLORFULEDIT"
1958: <script type="text/javascript">
1959: // <![CDATA[>
1960: function fold_box(curDepth, lastresource){
1961:
1962: // we need a list because there can be several blocks you need to fold in one tag
1963: var block = document.getElementsByName('foldblock_'+curDepth);
1964: // but there is only one folding button per tag
1965: var foldbutton = document.getElementById('folding_btn_'+curDepth);
1966:
1967: if(block.item(0).style.display == 'none'){
1968:
1969: foldbutton.value = '@{[&mt("Hide")]}';
1970: for (i = 0; i < block.length; i++){
1971: block.item(i).style.display = '';
1972: }
1973: }else{
1974:
1975: foldbutton.value = '@{[&mt("Show")]}';
1976: for (i = 0; i < block.length; i++){
1977: // block.item(i).style.visibility = 'collapse';
1978: block.item(i).style.display = 'none';
1979: }
1980: };
1981: saveState(lastresource);
1982: }
1983:
1984: function saveState (lastresource) {
1985:
1986: var tag_list = getTagList();
1987: if(tag_list != null){
1988: var timestamp = new Date().getTime();
1989: var key = lastresource;
1990:
1991: // the value pattern is: 'time;key1,value1;key2,value2; ... '
1992: // starting with timestamp
1993: var value = timestamp+';';
1994:
1995: // building the list of key-value pairs
1996: for(var i = 0; i < tag_list.length; i++){
1997: value += tag_list[i]+',';
1998: value += document.getElementsByName(tag_list[i])[0].style.display+';';
1999: }
2000:
2001: // only iterate whole storage if nothing to override
2002: if(localStorage.getItem(key) == null){
2003:
2004: // prevent storage from growing large
2005: if(localStorage.length > 50){
2006: var regex_getTimestamp = /^(?:\d)+;/;
2007: var oldest_timestamp = regex_getTimestamp.exec(localStorage.key(0));
2008: var oldest_key;
2009:
2010: for(var i = 1; i < localStorage.length; i++){
2011: if (regex_getTimestamp.exec(localStorage.key(i)) < oldest_timestamp) {
2012: oldest_key = localStorage.key(i);
2013: oldest_timestamp = regex_getTimestamp.exec(oldest_key);
2014: }
2015: }
2016: localStorage.removeItem(oldest_key);
2017: }
2018: }
2019: localStorage.setItem(key,value);
2020: }
2021: }
2022:
2023: // restore folding status of blocks (on page load)
2024: function restoreState (lastresource) {
2025: if(localStorage.getItem(lastresource) != null){
2026: var key = lastresource;
2027: var value = localStorage.getItem(key);
2028: var regex_delTimestamp = /^\d+;/;
2029:
2030: value.replace(regex_delTimestamp, '');
2031:
2032: var valueArr = value.split(';');
2033: var pairs;
2034: var elements;
2035: for (var i = 0; i < valueArr.length; i++){
2036: pairs = valueArr[i].split(',');
2037: elements = document.getElementsByName(pairs[0]);
2038:
2039: for (var j = 0; j < elements.length; j++){
2040: elements[j].style.display = pairs[1];
2041: if (pairs[1] == "none"){
2042: var regex_id = /([_\\d]+)\$/;
2043: regex_id.exec(pairs[0]);
2044: document.getElementById("folding_btn"+RegExp.\$1).value = "Show";
2045: }
2046: }
2047: }
2048: }
2049: }
2050:
2051: function getTagList () {
2052:
2053: var stringToSearch = document.lonhomework.innerHTML;
2054:
2055: var ret = new Array();
2056: var regex_findBlock = /(foldblock_.*?)"/g;
2057: var tag_list = stringToSearch.match(regex_findBlock);
2058:
2059: if(tag_list != null){
2060: for(var i = 0; i < tag_list.length; i++){
2061: ret.push(tag_list[i].replace(/"/, ''));
2062: }
2063: }
2064: return ret;
2065: }
2066:
2067: function saveScrollPosition (resource) {
2068: var tag_list = getTagList();
2069:
2070: // we dont always want to jump to the first block
2071: // 170 is roughly above the "Problem Editing" header. we just want to save if the user scrolled down further than this
2072: if(\$(window).scrollTop() > 170){
2073: if(tag_list != null){
2074: var result;
2075: for(var i = 0; i < tag_list.length; i++){
2076: if(isElementInViewport(tag_list[i])){
2077: result += tag_list[i]+';';
2078: }
2079: }
2080: sessionStorage.setItem('anchor_'+resource, result);
2081: }
2082: } else {
2083: // we dont need to save zero, just delete the item to leave everything tidy
2084: sessionStorage.removeItem('anchor_'+resource);
2085: }
2086: }
2087:
2088: function restoreScrollPosition(resource){
2089:
2090: var elem = sessionStorage.getItem('anchor_'+resource);
2091: if(elem != null){
2092: var tag_list = elem.split(';');
2093: var elem_list;
2094:
2095: for(var i = 0; i < tag_list.length; i++){
2096: elem_list = document.getElementsByName(tag_list[i]);
2097:
2098: if(elem_list.length > 0){
2099: elem = elem_list[0];
2100: break;
2101: }
2102: }
2103: elem.scrollIntoView();
2104: }
2105: }
2106:
2107: function isElementInViewport(el) {
2108:
2109: // change to last element instead of first
2110: var elem = document.getElementsByName(el);
2111: var rect = elem[0].getBoundingClientRect();
2112:
2113: return (
2114: rect.top >= 0 &&
2115: rect.left >= 0 &&
2116: rect.bottom <= (window.innerHeight || document.documentElement.clientHeight) && /*or $(window).height() */
2117: rect.right <= (window.innerWidth || document.documentElement.clientWidth) /*or $(window).width() */
2118: );
2119: }
2120:
2121: function autosize(depth){
2122: var cmInst = window['cm'+depth];
2123: var fitsizeButton = document.getElementById('fitsize'+depth);
2124:
2125: // is fixed size, switching to dynamic
2126: if (sessionStorage.getItem("autosized_"+depth) == null) {
2127: cmInst.setSize("","auto");
2128: fitsizeButton.value = "@{[&mt('Fixed size')]}";
2129: sessionStorage.setItem("autosized_"+depth, "yes");
2130:
2131: // is dynamic size, switching to fixed
2132: } else {
2133: cmInst.setSize("","300px");
2134: fitsizeButton.value = "@{[&mt('Dynamic size')]}";
2135: sessionStorage.removeItem("autosized_"+depth);
2136: }
2137: }
2138:
1.1248 raeburn 2139: $browse_or_search
1.1205 golterma 2140:
2141: // ]]>
2142: </script>
2143: COLORFULEDIT
2144: }
2145:
2146: sub xmleditor_js {
2147: return <<XMLEDIT
2148: <script type="text/javascript" src="/adm/jQuery/addons/jquery-scrolltofixed.js"></script>
2149: <script type="text/javascript">
2150: // <![CDATA[>
2151:
2152: function saveScrollPosition (resource) {
2153:
2154: var scrollPos = \$(window).scrollTop();
2155: sessionStorage.setItem(resource,scrollPos);
2156: }
2157:
2158: function restoreScrollPosition(resource){
2159:
2160: var scrollPos = sessionStorage.getItem(resource);
2161: \$(window).scrollTop(scrollPos);
2162: }
2163:
2164: // unless internet explorer
2165: if (!(window.navigator.appName == "Microsoft Internet Explorer" && (document.documentMode || document.compatMode))){
2166:
2167: \$(document).ready(function() {
2168: \$(".LC_edit_actionbar").scrollToFixed(\{zIndex: 100\});
2169: });
2170: }
2171:
2172: // inserts text at cursor position into codemirror (xml editor only)
2173: function insertText(text){
2174: cm.focus();
2175: var curPos = cm.getCursor();
2176: cm.replaceRange(text.replace(/ESCAPEDSCRIPT/g,'script'), {line: curPos.line,ch: curPos.ch});
2177: }
2178: // ]]>
2179: </script>
2180: XMLEDIT
2181: }
2182:
2183: sub insert_folding_button {
2184: my $curDepth = $Apache::lonxml::curdepth;
2185: my $lastresource = $env{'request.ambiguous'};
2186:
2187: return "<input type=\"button\" id=\"folding_btn_$curDepth\"
2188: value=\"".&mt('Hide')."\" onclick=\"fold_box('$curDepth','$lastresource')\">";
2189: }
2190:
1.1248 raeburn 2191: sub crsauthor_url {
2192: my ($url) = @_;
2193: if ($url eq '') {
2194: $url = $ENV{'REQUEST_URI'};
2195: }
2196: my ($cnum,$cdom);
2197: if ($env{'request.course.id'}) {
2198: my ($audom,$auname) = ($url =~ m{^/priv/($match_domain)/($match_name)/});
2199: if ($audom ne '' && $auname ne '') {
2200: if (($env{'course.'.$env{'request.course.id'}.'.num'} eq $auname) &&
2201: ($env{'course.'.$env{'request.course.id'}.'.domain'} eq $audom)) {
2202: $cnum = $auname;
2203: $cdom = $audom;
2204: }
2205: }
2206: }
2207: return ($cnum,$cdom);
2208: }
2209:
2210: sub import_crsauthor_form {
1.1265 raeburn 2211: my ($form,$firstselectname,$secondselectname,$onchangefirst,$only,$suffix,$disabled) = @_;
1.1248 raeburn 2212: return (0) unless ($env{'request.course.id'});
2213: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
2214: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
2215: my $crshome = $env{'course.'.$env{'request.course.id'}.'.home'};
2216: return (0) unless (($cnum ne '') && ($cdom ne ''));
2217: my $londocroot = $Apache::lonnet::perlvar{'lonDocRoot'};
2218: my @ids=&Apache::lonnet::current_machine_ids();
2219: my ($output,$is_home,$relpath,%subdirs,%files,%selimport_menus);
2220:
2221: if (grep(/^\Q$crshome\E$/,@ids)) {
2222: $is_home = 1;
2223: }
2224: $relpath = "/priv/$cdom/$cnum";
2225: &Apache::lonnet::recursedirs($is_home,'priv',$londocroot,$relpath,'',\%subdirs,\%files);
2226: my %lt = &Apache::lonlocal::texthash (
2227: fnam => 'Filename',
2228: dire => 'Directory',
2229: );
2230: my $numdirs = scalar(keys(%files));
2231: my (%possexts,$singledir,@singledirfiles);
2232: if ($only) {
2233: map { $possexts{$_} = 1; } split(/\s*,\s*/,$only);
2234: }
2235: my (%nonemptydirs,$possdirs);
2236: if ($numdirs > 1) {
2237: my @order;
2238: foreach my $key (sort { lc($a) cmp lc($b) } (keys(%files))) {
2239: if (ref($files{$key}) eq 'HASH') {
2240: my $shown = $key;
2241: if ($key eq '') {
2242: $shown = '/';
2243: }
2244: my @ordered = ();
2245: foreach my $file (sort { lc($a) cmp lc($b) } (keys(%{$files{$key}}))) {
1.1315 raeburn 2246: next if ($file =~ /\.rights$/);
1.1248 raeburn 2247: if ($only) {
2248: my ($ext) = ($file =~ /\.([^.]+)$/);
2249: unless ($possexts{lc($ext)}) {
2250: next;
2251: }
2252: }
2253: $selimport_menus{$key}->{'select2'}->{$file} = $file;
2254: push(@ordered,$file);
2255: }
2256: if (@ordered) {
2257: push(@order,$key);
2258: $nonemptydirs{$key} = 1;
2259: $selimport_menus{$key}->{'text'} = $shown;
2260: $selimport_menus{$key}->{'default'} = '';
2261: $selimport_menus{$key}->{'select2'}->{''} = '';
2262: $selimport_menus{$key}->{'order'} = \@ordered;
2263: }
2264: }
2265: }
2266: $possdirs = scalar(keys(%nonemptydirs));
2267: if ($possdirs > 1) {
2268: my @order = sort { lc($a) cmp lc($b) } (keys(%nonemptydirs));
2269: $output = $lt{'dire'}.
2270: &linked_select_forms($form,'<br />'.
2271: $lt{'fnam'},'',
2272: $firstselectname,$secondselectname,
2273: \%selimport_menus,\@order,
2274: $onchangefirst,'',$suffix).'<br />';
2275: } elsif ($possdirs == 1) {
2276: $singledir = (keys(%nonemptydirs))[0];
2277: if (ref($selimport_menus{$singledir}->{'order'}) eq 'ARRAY') {
2278: @singledirfiles = @{$selimport_menus{$singledir}->{'order'}};
2279: }
2280: delete($selimport_menus{$singledir});
2281: }
2282: } elsif ($numdirs == 1) {
2283: $singledir = (keys(%files))[0];
2284: foreach my $file (sort { lc($a) cmp lc($b) } (keys(%{$files{$singledir}}))) {
2285: if ($only) {
2286: my ($ext) = ($file =~ /\.([^.]+)$/);
2287: unless ($possexts{lc($ext)}) {
2288: next;
2289: }
1.1315 raeburn 2290: } else {
2291: next if ($file =~ /\.rights$/);
1.1248 raeburn 2292: }
2293: push(@singledirfiles,$file);
2294: }
2295: if (@singledirfiles) {
1.1315 raeburn 2296: $possdirs = 1;
1.1248 raeburn 2297: }
2298: }
2299: if (($possdirs == 1) && (@singledirfiles)) {
2300: my $showdir = $singledir;
2301: if ($singledir eq '') {
2302: $showdir = '/';
2303: }
2304: $output = $lt{'dire'}.
2305: '<select name="'.$firstselectname.'">'.
2306: '<option value="'.$singledir.'">'.$showdir.'</option>'."\n".
2307: '</select><br />'.
2308: $lt{'fnam'}.'<select name="'.$secondselectname.'">'."\n".
2309: '<option value="" selected="selected">'.$lt{'se'}.'</option>'."\n";
2310: foreach my $file (@singledirfiles) {
2311: $output .= '<option value="'.$file.'">'.$file.'</option>'."\n";
2312: }
2313: $output .= '</select><br />'."\n";
2314: }
2315: return ($possdirs,$output);
2316: }
2317:
1.565 albertel 2318: =pod
2319:
1.256 matthew 2320: =head1 Excel and CSV file utility routines
2321:
2322: =cut
2323:
2324: ###############################################################
2325: ###############################################################
2326:
2327: =pod
2328:
1.1162 raeburn 2329: =over 4
2330:
1.648 raeburn 2331: =item * &csv_translate($text)
1.37 matthew 2332:
1.185 www 2333: Translate $text to allow it to be output as a 'comma separated values'
1.37 matthew 2334: format.
2335:
2336: =cut
2337:
1.180 matthew 2338: ###############################################################
2339: ###############################################################
1.37 matthew 2340: sub csv_translate {
2341: my $text = shift;
2342: $text =~ s/\"/\"\"/g;
1.209 albertel 2343: $text =~ s/\n/ /g;
1.37 matthew 2344: return $text;
2345: }
1.180 matthew 2346:
2347: ###############################################################
2348: ###############################################################
2349:
2350: =pod
2351:
1.648 raeburn 2352: =item * &define_excel_formats()
1.180 matthew 2353:
2354: Define some commonly used Excel cell formats.
2355:
2356: Currently supported formats:
2357:
2358: =over 4
2359:
2360: =item header
2361:
2362: =item bold
2363:
2364: =item h1
2365:
2366: =item h2
2367:
2368: =item h3
2369:
1.256 matthew 2370: =item h4
2371:
2372: =item i
2373:
1.180 matthew 2374: =item date
2375:
2376: =back
2377:
2378: Inputs: $workbook
2379:
2380: Returns: $format, a hash reference.
2381:
1.1057 foxr 2382:
1.180 matthew 2383: =cut
2384:
2385: ###############################################################
2386: ###############################################################
2387: sub define_excel_formats {
2388: my ($workbook) = @_;
2389: my $format;
2390: $format->{'header'} = $workbook->add_format(bold => 1,
2391: bottom => 1,
2392: align => 'center');
2393: $format->{'bold'} = $workbook->add_format(bold=>1);
2394: $format->{'h1'} = $workbook->add_format(bold=>1, size=>18);
2395: $format->{'h2'} = $workbook->add_format(bold=>1, size=>16);
2396: $format->{'h3'} = $workbook->add_format(bold=>1, size=>14);
1.255 matthew 2397: $format->{'h4'} = $workbook->add_format(bold=>1, size=>12);
1.246 matthew 2398: $format->{'i'} = $workbook->add_format(italic=>1);
1.180 matthew 2399: $format->{'date'} = $workbook->add_format(num_format=>
1.207 matthew 2400: 'mm/dd/yyyy hh:mm:ss');
1.180 matthew 2401: return $format;
2402: }
2403:
2404: ###############################################################
2405: ###############################################################
1.113 bowersj2 2406:
2407: =pod
2408:
1.648 raeburn 2409: =item * &create_workbook()
1.255 matthew 2410:
2411: Create an Excel worksheet. If it fails, output message on the
2412: request object and return undefs.
2413:
2414: Inputs: Apache request object
2415:
2416: Returns (undef) on failure,
2417: Excel worksheet object, scalar with filename, and formats
2418: from &Apache::loncommon::define_excel_formats on success
2419:
2420: =cut
2421:
2422: ###############################################################
2423: ###############################################################
2424: sub create_workbook {
2425: my ($r) = @_;
2426: #
2427: # Create the excel spreadsheet
2428: my $filename = '/prtspool/'.
1.258 albertel 2429: $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.255 matthew 2430: time.'_'.rand(1000000000).'.xls';
2431: my $workbook = Spreadsheet::WriteExcel->new('/home/httpd'.$filename);
2432: if (! defined($workbook)) {
2433: $r->log_error("Error creating excel spreadsheet $filename: $!");
1.928 bisitz 2434: $r->print(
2435: '<p class="LC_error">'
2436: .&mt('Problems occurred in creating the new Excel file.')
2437: .' '.&mt('This error has been logged.')
2438: .' '.&mt('Please alert your LON-CAPA administrator.')
2439: .'</p>'
2440: );
1.255 matthew 2441: return (undef);
2442: }
2443: #
1.1014 foxr 2444: $workbook->set_tempdir(LONCAPA::tempdir());
1.255 matthew 2445: #
2446: my $format = &Apache::loncommon::define_excel_formats($workbook);
2447: return ($workbook,$filename,$format);
2448: }
2449:
2450: ###############################################################
2451: ###############################################################
2452:
2453: =pod
2454:
1.648 raeburn 2455: =item * &create_text_file()
1.113 bowersj2 2456:
1.542 raeburn 2457: Create a file to write to and eventually make available to the user.
1.256 matthew 2458: If file creation fails, outputs an error message on the request object and
2459: return undefs.
1.113 bowersj2 2460:
1.256 matthew 2461: Inputs: Apache request object, and file suffix
1.113 bowersj2 2462:
1.256 matthew 2463: Returns (undef) on failure,
2464: Filehandle and filename on success.
1.113 bowersj2 2465:
2466: =cut
2467:
1.256 matthew 2468: ###############################################################
2469: ###############################################################
2470: sub create_text_file {
2471: my ($r,$suffix) = @_;
2472: if (! defined($suffix)) { $suffix = 'txt'; };
2473: my $fh;
2474: my $filename = '/prtspool/'.
1.258 albertel 2475: $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.256 matthew 2476: time.'_'.rand(1000000000).'.'.$suffix;
2477: $fh = Apache::File->new('>/home/httpd'.$filename);
2478: if (! defined($fh)) {
2479: $r->log_error("Couldn't open $filename for output $!");
1.928 bisitz 2480: $r->print(
2481: '<p class="LC_error">'
2482: .&mt('Problems occurred in creating the output file.')
2483: .' '.&mt('This error has been logged.')
2484: .' '.&mt('Please alert your LON-CAPA administrator.')
2485: .'</p>'
2486: );
1.113 bowersj2 2487: }
1.256 matthew 2488: return ($fh,$filename)
1.113 bowersj2 2489: }
2490:
2491:
1.256 matthew 2492: =pod
1.113 bowersj2 2493:
2494: =back
2495:
2496: =cut
1.37 matthew 2497:
2498: ###############################################################
1.33 matthew 2499: ## Home server <option> list generating code ##
2500: ###############################################################
1.35 matthew 2501:
1.169 www 2502: # ------------------------------------------
2503:
2504: sub domain_select {
1.1289 raeburn 2505: my ($name,$value,$multiple,$incdoms,$excdoms)=@_;
2506: my @possdoms;
2507: if (ref($incdoms) eq 'ARRAY') {
2508: @possdoms = @{$incdoms};
2509: } else {
2510: @possdoms = &Apache::lonnet::all_domains();
2511: }
2512:
1.169 www 2513: my %domains=map {
1.514 albertel 2514: $_ => $_.' '. &Apache::lonnet::domain($_,'description')
1.1289 raeburn 2515: } @possdoms;
2516:
2517: if ((ref($excdoms) eq 'ARRAY') && (@{$excdoms} > 0)) {
2518: foreach my $dom (@{$excdoms}) {
2519: delete($domains{$dom});
2520: }
2521: }
2522:
1.169 www 2523: if ($multiple) {
2524: $domains{''}=&mt('Any domain');
1.550 albertel 2525: $domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.287 albertel 2526: return &multiple_select_form($name,$value,4,\%domains);
1.169 www 2527: } else {
1.550 albertel 2528: $domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.970 raeburn 2529: return &select_form($name,$value,\%domains);
1.169 www 2530: }
2531: }
2532:
1.282 albertel 2533: #-------------------------------------------
2534:
2535: =pod
2536:
1.519 raeburn 2537: =head1 Routines for form select boxes
2538:
2539: =over 4
2540:
1.648 raeburn 2541: =item * &multiple_select_form($name,$value,$size,$hash,$order)
1.282 albertel 2542:
2543: Returns a string containing a <select> element int multiple mode
2544:
2545:
2546: Args:
2547: $name - name of the <select> element
1.506 raeburn 2548: $value - scalar or array ref of values that should already be selected
1.282 albertel 2549: $size - number of rows long the select element is
1.283 albertel 2550: $hash - the elements should be 'option' => 'shown text'
1.282 albertel 2551: (shown text should already have been &mt())
1.506 raeburn 2552: $order - (optional) array ref of the order to show the elements in
1.283 albertel 2553:
1.282 albertel 2554: =cut
2555:
2556: #-------------------------------------------
1.169 www 2557: sub multiple_select_form {
1.284 albertel 2558: my ($name,$value,$size,$hash,$order)=@_;
1.169 www 2559: my %selected = map { $_ => 1 } ref($value)?@{$value}:($value);
2560: my $output='';
1.191 matthew 2561: if (! defined($size)) {
2562: $size = 4;
1.283 albertel 2563: if (scalar(keys(%$hash))<4) {
2564: $size = scalar(keys(%$hash));
1.191 matthew 2565: }
2566: }
1.734 bisitz 2567: $output.="\n".'<select name="'.$name.'" size="'.$size.'" multiple="multiple">';
1.501 banghart 2568: my @order;
1.506 raeburn 2569: if (ref($order) eq 'ARRAY') {
2570: @order = @{$order};
2571: } else {
2572: @order = sort(keys(%$hash));
1.501 banghart 2573: }
2574: if (exists($$hash{'select_form_order'})) {
2575: @order = @{$$hash{'select_form_order'}};
2576: }
2577:
1.284 albertel 2578: foreach my $key (@order) {
1.356 albertel 2579: $output.='<option value="'.&HTML::Entities::encode($key,'"<>&').'" ';
1.284 albertel 2580: $output.='selected="selected" ' if ($selected{$key});
2581: $output.='>'.$hash->{$key}."</option>\n";
1.169 www 2582: }
2583: $output.="</select>\n";
2584: return $output;
2585: }
2586:
1.88 www 2587: #-------------------------------------------
2588:
2589: =pod
2590:
1.1254 raeburn 2591: =item * &select_form($defdom,$name,$hashref,$onchange,$readonly)
1.88 www 2592:
2593: Returns a string containing a <select name='$name' size='1'> form to
1.970 raeburn 2594: allow a user to select options from a ref to a hash containing:
2595: option_name => displayed text. An optional $onchange can include
1.1254 raeburn 2596: a javascript onchange item, e.g., onchange="this.form.submit();".
2597: An optional arg -- $readonly -- if true will cause the select form
2598: to be disabled, e.g., for the case where an instructor has a section-
2599: specific role, and is viewing/modifying parameters.
1.970 raeburn 2600:
1.88 www 2601: See lonrights.pm for an example invocation and use.
2602:
2603: =cut
2604:
2605: #-------------------------------------------
2606: sub select_form {
1.1228 raeburn 2607: my ($def,$name,$hashref,$onchange,$readonly) = @_;
1.970 raeburn 2608: return unless (ref($hashref) eq 'HASH');
2609: if ($onchange) {
2610: $onchange = ' onchange="'.$onchange.'"';
2611: }
1.1228 raeburn 2612: my $disabled;
2613: if ($readonly) {
2614: $disabled = ' disabled="disabled"';
2615: }
2616: my $selectform = "<select name=\"$name\" size=\"1\"$onchange$disabled>\n";
1.128 albertel 2617: my @keys;
1.970 raeburn 2618: if (exists($hashref->{'select_form_order'})) {
2619: @keys=@{$hashref->{'select_form_order'}};
1.128 albertel 2620: } else {
1.970 raeburn 2621: @keys=sort(keys(%{$hashref}));
1.128 albertel 2622: }
1.356 albertel 2623: foreach my $key (@keys) {
2624: $selectform.=
2625: '<option value="'.&HTML::Entities::encode($key,'"<>&').'" '.
2626: ($key eq $def ? 'selected="selected" ' : '').
1.970 raeburn 2627: ">".$hashref->{$key}."</option>\n";
1.88 www 2628: }
2629: $selectform.="</select>";
2630: return $selectform;
2631: }
2632:
1.475 www 2633: # For display filters
2634:
2635: sub display_filter {
1.1074 raeburn 2636: my ($context) = @_;
1.475 www 2637: if (!$env{'form.show'}) { $env{'form.show'}=10; }
1.477 www 2638: if (!$env{'form.displayfilter'}) { $env{'form.displayfilter'}='currentfolder'; }
1.1074 raeburn 2639: my $phraseinput = 'hidden';
2640: my $includeinput = 'hidden';
2641: my ($checked,$includetypestext);
2642: if ($env{'form.displayfilter'} eq 'containing') {
2643: $phraseinput = 'text';
2644: if ($context eq 'parmslog') {
2645: $includeinput = 'checkbox';
2646: if ($env{'form.includetypes'}) {
2647: $checked = ' checked="checked"';
2648: }
2649: $includetypestext = &mt('Include parameter types');
2650: }
2651: } else {
2652: $includetypestext = ' ';
2653: }
2654: my ($additional,$secondid,$thirdid);
2655: if ($context eq 'parmslog') {
2656: $additional =
2657: '<label><input type="'.$includeinput.'" name="includetypes"'.
2658: $checked.' name="includetypes" value="1" id="includetypes" />'.
2659: ' <span id="includetypestext">'.$includetypestext.'</span>'.
2660: '</label>';
2661: $secondid = 'includetypes';
2662: $thirdid = 'includetypestext';
2663: }
2664: my $onchange = "javascript:toggleHistoryOptions(this,'containingphrase','$context',
2665: '$secondid','$thirdid')";
2666: return '<span class="LC_nobreak"><label>'.&mt('Records: [_1]',
1.475 www 2667: &Apache::lonmeta::selectbox('show',$env{'form.show'},undef,
2668: (&mt('all'),10,20,50,100,1000,10000))).
1.714 bisitz 2669: '</label></span> <span class="LC_nobreak">'.
1.1074 raeburn 2670: &mt('Filter: [_1]',
1.477 www 2671: &select_form($env{'form.displayfilter'},
2672: 'displayfilter',
1.970 raeburn 2673: {'currentfolder' => 'Current folder/page',
1.477 www 2674: 'containing' => 'Containing phrase',
1.1074 raeburn 2675: 'none' => 'None'},$onchange)).' '.
2676: '<input type="'.$phraseinput.'" name="containingphrase" id="containingphrase" size="30" value="'.
2677: &HTML::Entities::encode($env{'form.containingphrase'}).
2678: '" />'.$additional;
2679: }
2680:
2681: sub display_filter_js {
2682: my $includetext = &mt('Include parameter types');
2683: return <<"ENDJS";
2684:
2685: function toggleHistoryOptions(setter,firstid,context,secondid,thirdid) {
2686: var firstType = 'hidden';
2687: if (setter.options[setter.selectedIndex].value == 'containing') {
2688: firstType = 'text';
2689: }
2690: firstObject = document.getElementById(firstid);
2691: if (typeof(firstObject) == 'object') {
2692: if (firstObject.type != firstType) {
2693: changeInputType(firstObject,firstType);
2694: }
2695: }
2696: if (context == 'parmslog') {
2697: var secondType = 'hidden';
2698: if (firstType == 'text') {
2699: secondType = 'checkbox';
2700: }
2701: secondObject = document.getElementById(secondid);
2702: if (typeof(secondObject) == 'object') {
2703: if (secondObject.type != secondType) {
2704: changeInputType(secondObject,secondType);
2705: }
2706: }
2707: var textItem = document.getElementById(thirdid);
2708: var currtext = textItem.innerHTML;
2709: var newtext;
2710: if (firstType == 'text') {
2711: newtext = '$includetext';
2712: } else {
2713: newtext = ' ';
2714: }
2715: if (currtext != newtext) {
2716: textItem.innerHTML = newtext;
2717: }
2718: }
2719: return;
2720: }
2721:
2722: function changeInputType(oldObject,newType) {
2723: var newObject = document.createElement('input');
2724: newObject.type = newType;
2725: if (oldObject.size) {
2726: newObject.size = oldObject.size;
2727: }
2728: if (oldObject.value) {
2729: newObject.value = oldObject.value;
2730: }
2731: if (oldObject.name) {
2732: newObject.name = oldObject.name;
2733: }
2734: if (oldObject.id) {
2735: newObject.id = oldObject.id;
2736: }
2737: oldObject.parentNode.replaceChild(newObject,oldObject);
2738: return;
2739: }
2740:
2741: ENDJS
1.475 www 2742: }
2743:
1.167 www 2744: sub gradeleveldescription {
2745: my $gradelevel=shift;
2746: my %gradelevels=(0 => 'Not specified',
2747: 1 => 'Grade 1',
2748: 2 => 'Grade 2',
2749: 3 => 'Grade 3',
2750: 4 => 'Grade 4',
2751: 5 => 'Grade 5',
2752: 6 => 'Grade 6',
2753: 7 => 'Grade 7',
2754: 8 => 'Grade 8',
2755: 9 => 'Grade 9',
2756: 10 => 'Grade 10',
2757: 11 => 'Grade 11',
2758: 12 => 'Grade 12',
2759: 13 => 'Grade 13',
2760: 14 => '100 Level',
2761: 15 => '200 Level',
2762: 16 => '300 Level',
2763: 17 => '400 Level',
2764: 18 => 'Graduate Level');
2765: return &mt($gradelevels{$gradelevel});
2766: }
2767:
1.163 www 2768: sub select_level_form {
2769: my ($deflevel,$name)=@_;
2770: unless ($deflevel) { $deflevel=0; }
1.167 www 2771: my $selectform = "<select name=\"$name\" size=\"1\">\n";
2772: for (my $i=0; $i<=18; $i++) {
2773: $selectform.="<option value=\"$i\" ".
1.253 albertel 2774: ($i==$deflevel ? 'selected="selected" ' : '').
1.167 www 2775: ">".&gradeleveldescription($i)."</option>\n";
2776: }
2777: $selectform.="</select>";
2778: return $selectform;
1.163 www 2779: }
1.167 www 2780:
1.35 matthew 2781: #-------------------------------------------
2782:
1.45 matthew 2783: =pod
2784:
1.1256 raeburn 2785: =item * &select_dom_form($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms,$excdoms,$disabled)
1.35 matthew 2786:
2787: Returns a string containing a <select name='$name' size='1'> form to
2788: allow a user to select the domain to preform an operation in.
2789: See loncreateuser.pm for an example invocation and use.
2790:
1.90 www 2791: If the $includeempty flag is set, it also includes an empty choice ("no domain
2792: selected");
2793:
1.743 raeburn 2794: If the $showdomdesc flag is set, the domain name is followed by the domain description.
2795:
1.910 raeburn 2796: 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.
2797:
1.1121 raeburn 2798: The optional $incdoms is a reference to an array of domains which will be the only available options.
2799:
2800: The optional $excdoms is a reference to an array of domains which will be excluded from the available options.
1.563 raeburn 2801:
1.1256 raeburn 2802: The optional $disabled argument, if true, adds the disabled attribute to the select tag.
2803:
1.35 matthew 2804: =cut
2805:
2806: #-------------------------------------------
1.34 matthew 2807: sub select_dom_form {
1.1256 raeburn 2808: my ($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms,$excdoms,$disabled) = @_;
1.872 raeburn 2809: if ($onchange) {
1.874 raeburn 2810: $onchange = ' onchange="'.$onchange.'"';
1.743 raeburn 2811: }
1.1256 raeburn 2812: if ($disabled) {
2813: $disabled = ' disabled="disabled"';
2814: }
1.1121 raeburn 2815: my (@domains,%exclude);
1.910 raeburn 2816: if (ref($incdoms) eq 'ARRAY') {
2817: @domains = sort {lc($a) cmp lc($b)} (@{$incdoms});
2818: } else {
2819: @domains = sort {lc($a) cmp lc($b)} (&Apache::lonnet::all_domains());
2820: }
1.90 www 2821: if ($includeempty) { @domains=('',@domains); }
1.1121 raeburn 2822: if (ref($excdoms) eq 'ARRAY') {
2823: map { $exclude{$_} = 1; } @{$excdoms};
2824: }
1.1256 raeburn 2825: my $selectdomain = "<select name=\"$name\" size=\"1\"$onchange$disabled>\n";
1.356 albertel 2826: foreach my $dom (@domains) {
1.1121 raeburn 2827: next if ($exclude{$dom});
1.356 albertel 2828: $selectdomain.="<option value=\"$dom\" ".
1.563 raeburn 2829: ($dom eq $defdom ? 'selected="selected" ' : '').'>'.$dom;
2830: if ($showdomdesc) {
2831: if ($dom ne '') {
2832: my $domdesc = &Apache::lonnet::domain($dom,'description');
2833: if ($domdesc ne '') {
2834: $selectdomain .= ' ('.$domdesc.')';
2835: }
2836: }
2837: }
2838: $selectdomain .= "</option>\n";
1.34 matthew 2839: }
2840: $selectdomain.="</select>";
2841: return $selectdomain;
2842: }
2843:
1.35 matthew 2844: #-------------------------------------------
2845:
1.45 matthew 2846: =pod
2847:
1.648 raeburn 2848: =item * &home_server_form_item($domain,$name,$defaultflag)
1.35 matthew 2849:
1.586 raeburn 2850: input: 4 arguments (two required, two optional) -
2851: $domain - domain of new user
2852: $name - name of form element
2853: $default - Value of 'default' causes a default item to be first
2854: option, and selected by default.
2855: $hide - Value of 'hide' causes hiding of the name of the server,
2856: if 1 server found, or default, if 0 found.
1.594 raeburn 2857: output: returns 2 items:
1.586 raeburn 2858: (a) form element which contains either:
2859: (i) <select name="$name">
2860: <option value="$hostid1">$hostid $servers{$hostid}</option>
2861: <option value="$hostid2">$hostid $servers{$hostid}</option>
2862: </select>
2863: form item if there are multiple library servers in $domain, or
2864: (ii) an <input type="hidden" name="$name" value="$hostid" /> form item
2865: if there is only one library server in $domain.
2866:
2867: (b) number of library servers found.
2868:
2869: See loncreateuser.pm for example of use.
1.35 matthew 2870:
2871: =cut
2872:
2873: #-------------------------------------------
1.586 raeburn 2874: sub home_server_form_item {
2875: my ($domain,$name,$default,$hide) = @_;
1.513 albertel 2876: my %servers = &Apache::lonnet::get_servers($domain,'library');
1.586 raeburn 2877: my $result;
2878: my $numlib = keys(%servers);
2879: if ($numlib > 1) {
2880: $result .= '<select name="'.$name.'" />'."\n";
2881: if ($default) {
1.804 bisitz 2882: $result .= '<option value="default" selected="selected">'.&mt('default').
1.586 raeburn 2883: '</option>'."\n";
2884: }
2885: foreach my $hostid (sort(keys(%servers))) {
2886: $result.= '<option value="'.$hostid.'">'.
2887: $hostid.' '.$servers{$hostid}."</option>\n";
2888: }
2889: $result .= '</select>'."\n";
2890: } elsif ($numlib == 1) {
2891: my $hostid;
2892: foreach my $item (keys(%servers)) {
2893: $hostid = $item;
2894: }
2895: $result .= '<input type="hidden" name="'.$name.'" value="'.
2896: $hostid.'" />';
2897: if (!$hide) {
2898: $result .= $hostid.' '.$servers{$hostid};
2899: }
2900: $result .= "\n";
2901: } elsif ($default) {
2902: $result .= '<input type="hidden" name="'.$name.
2903: '" value="default" />';
2904: if (!$hide) {
2905: $result .= &mt('default');
2906: }
2907: $result .= "\n";
1.33 matthew 2908: }
1.586 raeburn 2909: return ($result,$numlib);
1.33 matthew 2910: }
1.112 bowersj2 2911:
2912: =pod
2913:
1.534 albertel 2914: =back
2915:
1.112 bowersj2 2916: =cut
1.87 matthew 2917:
2918: ###############################################################
1.112 bowersj2 2919: ## Decoding User Agent ##
1.87 matthew 2920: ###############################################################
2921:
2922: =pod
2923:
1.112 bowersj2 2924: =head1 Decoding the User Agent
2925:
2926: =over 4
2927:
2928: =item * &decode_user_agent()
1.87 matthew 2929:
2930: Inputs: $r
2931:
2932: Outputs:
2933:
2934: =over 4
2935:
1.112 bowersj2 2936: =item * $httpbrowser
1.87 matthew 2937:
1.112 bowersj2 2938: =item * $clientbrowser
1.87 matthew 2939:
1.112 bowersj2 2940: =item * $clientversion
1.87 matthew 2941:
1.112 bowersj2 2942: =item * $clientmathml
1.87 matthew 2943:
1.112 bowersj2 2944: =item * $clientunicode
1.87 matthew 2945:
1.112 bowersj2 2946: =item * $clientos
1.87 matthew 2947:
1.1137 raeburn 2948: =item * $clientmobile
2949:
1.1141 raeburn 2950: =item * $clientinfo
2951:
1.1194 raeburn 2952: =item * $clientosversion
2953:
1.87 matthew 2954: =back
2955:
1.157 matthew 2956: =back
2957:
1.87 matthew 2958: =cut
2959:
2960: ###############################################################
2961: ###############################################################
2962: sub decode_user_agent {
1.247 albertel 2963: my ($r)=@_;
1.87 matthew 2964: my @browsertype=split(/\&/,$Apache::lonnet::perlvar{"lonBrowsDet"});
2965: my %mathcap=split(/\&/,$$Apache::lonnet::perlvar{"lonMathML"});
2966: my $httpbrowser=$ENV{"HTTP_USER_AGENT"};
1.247 albertel 2967: if (!$httpbrowser && $r) { $httpbrowser=$r->header_in('User-Agent'); }
1.87 matthew 2968: my $clientbrowser='unknown';
2969: my $clientversion='0';
2970: my $clientmathml='';
2971: my $clientunicode='0';
1.1137 raeburn 2972: my $clientmobile=0;
1.1194 raeburn 2973: my $clientosversion='';
1.87 matthew 2974: for (my $i=0;$i<=$#browsertype;$i++) {
1.1193 raeburn 2975: my ($bname,$match,$notmatch,$vreg,$minv,$univ)=split(/\%/,$browsertype[$i]);
1.87 matthew 2976: if (($httpbrowser=~/$match/i) && ($httpbrowser!~/$notmatch/i)) {
2977: $clientbrowser=$bname;
2978: $httpbrowser=~/$vreg/i;
2979: $clientversion=$1;
2980: $clientmathml=($clientversion>=$minv);
2981: $clientunicode=($clientversion>=$univ);
2982: }
2983: }
2984: my $clientos='unknown';
1.1141 raeburn 2985: my $clientinfo;
1.87 matthew 2986: if (($httpbrowser=~/linux/i) ||
2987: ($httpbrowser=~/unix/i) ||
2988: ($httpbrowser=~/ux/i) ||
2989: ($httpbrowser=~/solaris/i)) { $clientos='unix'; }
2990: if (($httpbrowser=~/vax/i) ||
2991: ($httpbrowser=~/vms/i)) { $clientos='vms'; }
2992: if ($httpbrowser=~/next/i) { $clientos='next'; }
2993: if (($httpbrowser=~/mac/i) ||
2994: ($httpbrowser=~/powerpc/i)) { $clientos='mac'; }
1.1194 raeburn 2995: if ($httpbrowser=~/win/i) {
2996: $clientos='win';
2997: if ($httpbrowser =~/Windows\s+NT\s+(\d+\.\d+)/i) {
2998: $clientosversion = $1;
2999: }
3000: }
1.87 matthew 3001: if ($httpbrowser=~/embed/i) { $clientos='pda'; }
1.1137 raeburn 3002: if ($httpbrowser=~/(Android|iPod|iPad|iPhone|webOS|Blackberry|Windows Phone|Opera m(?:ob|in)|Fennec)/i) {
3003: $clientmobile=lc($1);
3004: }
1.1141 raeburn 3005: if ($httpbrowser=~ m{Firefox/(\d+\.\d+)}) {
3006: $clientinfo = 'firefox-'.$1;
3007: } elsif ($httpbrowser=~ m{chromeframe/(\d+\.\d+)\.}) {
3008: $clientinfo = 'chromeframe-'.$1;
3009: }
1.87 matthew 3010: return ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
1.1194 raeburn 3011: $clientunicode,$clientos,$clientmobile,$clientinfo,
3012: $clientosversion);
1.87 matthew 3013: }
3014:
1.32 matthew 3015: ###############################################################
3016: ## Authentication changing form generation subroutines ##
3017: ###############################################################
3018: ##
3019: ## All of the authform_xxxxxxx subroutines take their inputs in a
3020: ## hash, and have reasonable default values.
3021: ##
3022: ## formname = the name given in the <form> tag.
1.35 matthew 3023: #-------------------------------------------
3024:
1.45 matthew 3025: =pod
3026:
1.112 bowersj2 3027: =head1 Authentication Routines
3028:
3029: =over 4
3030:
1.648 raeburn 3031: =item * &authform_xxxxxx()
1.35 matthew 3032:
3033: The authform_xxxxxx subroutines provide javascript and html forms which
3034: handle some of the conveniences required for authentication forms.
3035: This is not an optimal method, but it works.
3036:
3037: =over 4
3038:
1.112 bowersj2 3039: =item * authform_header
1.35 matthew 3040:
1.112 bowersj2 3041: =item * authform_authorwarning
1.35 matthew 3042:
1.112 bowersj2 3043: =item * authform_nochange
1.35 matthew 3044:
1.112 bowersj2 3045: =item * authform_kerberos
1.35 matthew 3046:
1.112 bowersj2 3047: =item * authform_internal
1.35 matthew 3048:
1.112 bowersj2 3049: =item * authform_filesystem
1.35 matthew 3050:
1.1310 raeburn 3051: =item * authform_lti
3052:
1.35 matthew 3053: =back
3054:
1.648 raeburn 3055: See loncreateuser.pm for invocation and use examples.
1.157 matthew 3056:
1.35 matthew 3057: =cut
3058:
3059: #-------------------------------------------
1.32 matthew 3060: sub authform_header{
3061: my %in = (
3062: formname => 'cu',
1.80 albertel 3063: kerb_def_dom => '',
1.32 matthew 3064: @_,
3065: );
3066: $in{'formname'} = 'document.' . $in{'formname'};
3067: my $result='';
1.80 albertel 3068:
3069: #---------------------------------------------- Code for upper case translation
3070: my $Javascript_toUpperCase;
3071: unless ($in{kerb_def_dom}) {
3072: $Javascript_toUpperCase =<<"END";
3073: switch (choice) {
3074: case 'krb': currentform.elements[choicearg].value =
3075: currentform.elements[choicearg].value.toUpperCase();
3076: break;
3077: default:
3078: }
3079: END
3080: } else {
3081: $Javascript_toUpperCase = "";
3082: }
3083:
1.165 raeburn 3084: my $radioval = "'nochange'";
1.591 raeburn 3085: if (defined($in{'curr_authtype'})) {
3086: if ($in{'curr_authtype'} ne '') {
3087: $radioval = "'".$in{'curr_authtype'}."arg'";
3088: }
1.174 matthew 3089: }
1.165 raeburn 3090: my $argfield = 'null';
1.591 raeburn 3091: if (defined($in{'mode'})) {
1.165 raeburn 3092: if ($in{'mode'} eq 'modifycourse') {
1.591 raeburn 3093: if (defined($in{'curr_autharg'})) {
3094: if ($in{'curr_autharg'} ne '') {
1.165 raeburn 3095: $argfield = "'$in{'curr_autharg'}'";
3096: }
3097: }
3098: }
3099: }
3100:
1.32 matthew 3101: $result.=<<"END";
3102: var current = new Object();
1.165 raeburn 3103: current.radiovalue = $radioval;
3104: current.argfield = $argfield;
1.32 matthew 3105:
3106: function changed_radio(choice,currentform) {
3107: var choicearg = choice + 'arg';
3108: // If a radio button in changed, we need to change the argfield
3109: if (current.radiovalue != choice) {
3110: current.radiovalue = choice;
3111: if (current.argfield != null) {
3112: currentform.elements[current.argfield].value = '';
3113: }
3114: if (choice == 'nochange') {
3115: current.argfield = null;
3116: } else {
3117: current.argfield = choicearg;
3118: switch(choice) {
3119: case 'krb':
3120: currentform.elements[current.argfield].value =
3121: "$in{'kerb_def_dom'}";
3122: break;
3123: default:
3124: break;
3125: }
3126: }
3127: }
3128: return;
3129: }
1.22 www 3130:
1.32 matthew 3131: function changed_text(choice,currentform) {
3132: var choicearg = choice + 'arg';
3133: if (currentform.elements[choicearg].value !='') {
1.80 albertel 3134: $Javascript_toUpperCase
1.32 matthew 3135: // clear old field
3136: if ((current.argfield != choicearg) && (current.argfield != null)) {
3137: currentform.elements[current.argfield].value = '';
3138: }
3139: current.argfield = choicearg;
3140: }
3141: set_auth_radio_buttons(choice,currentform);
3142: return;
1.20 www 3143: }
1.32 matthew 3144:
3145: function set_auth_radio_buttons(newvalue,currentform) {
1.986 raeburn 3146: var numauthchoices = currentform.login.length;
3147: if (typeof numauthchoices == "undefined") {
3148: return;
3149: }
1.32 matthew 3150: var i=0;
1.986 raeburn 3151: while (i < numauthchoices) {
1.32 matthew 3152: if (currentform.login[i].value == newvalue) { break; }
3153: i++;
3154: }
1.986 raeburn 3155: if (i == numauthchoices) {
1.32 matthew 3156: return;
3157: }
3158: current.radiovalue = newvalue;
3159: currentform.login[i].checked = true;
3160: return;
3161: }
3162: END
3163: return $result;
3164: }
3165:
1.1106 raeburn 3166: sub authform_authorwarning {
1.32 matthew 3167: my $result='';
1.144 matthew 3168: $result='<i>'.
3169: &mt('As a general rule, only authors or co-authors should be '.
3170: 'filesystem authenticated '.
3171: '(which allows access to the server filesystem).')."</i>\n";
1.32 matthew 3172: return $result;
3173: }
3174:
1.1106 raeburn 3175: sub authform_nochange {
1.32 matthew 3176: my %in = (
3177: formname => 'document.cu',
3178: kerb_def_dom => 'MSU.EDU',
3179: @_,
3180: );
1.1106 raeburn 3181: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.586 raeburn 3182: my $result;
1.1104 raeburn 3183: if (!$authnum) {
1.1105 raeburn 3184: $result = &mt('Under your current role you are not permitted to change login settings for this user');
1.586 raeburn 3185: } else {
3186: $result = '<label>'.&mt('[_1] Do not change login data',
3187: '<input type="radio" name="login" value="nochange" '.
3188: 'checked="checked" onclick="'.
1.281 albertel 3189: "javascript:changed_radio('nochange',$in{'formname'});".'" />').
3190: '</label>';
1.586 raeburn 3191: }
1.32 matthew 3192: return $result;
3193: }
3194:
1.591 raeburn 3195: sub authform_kerberos {
1.32 matthew 3196: my %in = (
3197: formname => 'document.cu',
3198: kerb_def_dom => 'MSU.EDU',
1.80 albertel 3199: kerb_def_auth => 'krb4',
1.32 matthew 3200: @_,
3201: );
1.586 raeburn 3202: my ($check4,$check5,$krbcheck,$krbarg,$krbver,$result,$authtype,
1.1259 raeburn 3203: $autharg,$jscall,$disabled);
1.1106 raeburn 3204: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.80 albertel 3205: if ($in{'kerb_def_auth'} eq 'krb5') {
1.772 bisitz 3206: $check5 = ' checked="checked"';
1.80 albertel 3207: } else {
1.772 bisitz 3208: $check4 = ' checked="checked"';
1.80 albertel 3209: }
1.1259 raeburn 3210: if ($in{'readonly'}) {
3211: $disabled = ' disabled="disabled"';
3212: }
1.165 raeburn 3213: $krbarg = $in{'kerb_def_dom'};
1.591 raeburn 3214: if (defined($in{'curr_authtype'})) {
3215: if ($in{'curr_authtype'} eq 'krb') {
1.772 bisitz 3216: $krbcheck = ' checked="checked"';
1.623 raeburn 3217: if (defined($in{'mode'})) {
3218: if ($in{'mode'} eq 'modifyuser') {
3219: $krbcheck = '';
3220: }
3221: }
1.591 raeburn 3222: if (defined($in{'curr_kerb_ver'})) {
3223: if ($in{'curr_krb_ver'} eq '5') {
1.772 bisitz 3224: $check5 = ' checked="checked"';
1.591 raeburn 3225: $check4 = '';
3226: } else {
1.772 bisitz 3227: $check4 = ' checked="checked"';
1.591 raeburn 3228: $check5 = '';
3229: }
1.586 raeburn 3230: }
1.591 raeburn 3231: if (defined($in{'curr_autharg'})) {
1.165 raeburn 3232: $krbarg = $in{'curr_autharg'};
3233: }
1.586 raeburn 3234: if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
1.591 raeburn 3235: if (defined($in{'curr_autharg'})) {
1.586 raeburn 3236: $result =
3237: &mt('Currently Kerberos authenticated with domain [_1] Version [_2].',
3238: $in{'curr_autharg'},$krbver);
3239: } else {
3240: $result =
3241: &mt('Currently Kerberos authenticated, Version [_1].',$krbver);
3242: }
3243: return $result;
3244: }
3245: }
3246: } else {
3247: if ($authnum == 1) {
1.784 bisitz 3248: $authtype = '<input type="hidden" name="login" value="krb" />';
1.165 raeburn 3249: }
3250: }
1.586 raeburn 3251: if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
3252: return;
1.587 raeburn 3253: } elsif ($authtype eq '') {
1.591 raeburn 3254: if (defined($in{'mode'})) {
1.587 raeburn 3255: if ($in{'mode'} eq 'modifycourse') {
3256: if ($authnum == 1) {
1.1259 raeburn 3257: $authtype = '<input type="radio" name="login" value="krb"'.$disabled.' />';
1.587 raeburn 3258: }
3259: }
3260: }
1.586 raeburn 3261: }
3262: $jscall = "javascript:changed_radio('krb',$in{'formname'});";
3263: if ($authtype eq '') {
3264: $authtype = '<input type="radio" name="login" value="krb" '.
3265: 'onclick="'.$jscall.'" onchange="'.$jscall.'"'.
1.1259 raeburn 3266: $krbcheck.$disabled.' />';
1.586 raeburn 3267: }
3268: if (($can_assign{'krb4'} && $can_assign{'krb5'}) ||
1.1106 raeburn 3269: ($can_assign{'krb4'} && !$can_assign{'krb5'} &&
1.586 raeburn 3270: $in{'curr_authtype'} eq 'krb5') ||
1.1106 raeburn 3271: (!$can_assign{'krb4'} && $can_assign{'krb5'} &&
1.586 raeburn 3272: $in{'curr_authtype'} eq 'krb4')) {
3273: $result .= &mt
1.144 matthew 3274: ('[_1] Kerberos authenticated with domain [_2] '.
1.281 albertel 3275: '[_3] Version 4 [_4] Version 5 [_5]',
1.586 raeburn 3276: '<label>'.$authtype,
1.281 albertel 3277: '</label><input type="text" size="10" name="krbarg" '.
1.165 raeburn 3278: 'value="'.$krbarg.'" '.
1.1259 raeburn 3279: 'onchange="'.$jscall.'"'.$disabled.' />',
3280: '<label><input type="radio" name="krbver" value="4" '.$check4.$disabled.' />',
3281: '</label><label><input type="radio" name="krbver" value="5" '.$check5.$disabled.' />',
1.281 albertel 3282: '</label>');
1.586 raeburn 3283: } elsif ($can_assign{'krb4'}) {
3284: $result .= &mt
3285: ('[_1] Kerberos authenticated with domain [_2] '.
3286: '[_3] Version 4 [_4]',
3287: '<label>'.$authtype,
3288: '</label><input type="text" size="10" name="krbarg" '.
3289: 'value="'.$krbarg.'" '.
1.1259 raeburn 3290: 'onchange="'.$jscall.'"'.$disabled.' />',
1.586 raeburn 3291: '<label><input type="hidden" name="krbver" value="4" />',
3292: '</label>');
3293: } elsif ($can_assign{'krb5'}) {
3294: $result .= &mt
3295: ('[_1] Kerberos authenticated with domain [_2] '.
3296: '[_3] Version 5 [_4]',
3297: '<label>'.$authtype,
3298: '</label><input type="text" size="10" name="krbarg" '.
3299: 'value="'.$krbarg.'" '.
1.1259 raeburn 3300: 'onchange="'.$jscall.'"'.$disabled.' />',
1.586 raeburn 3301: '<label><input type="hidden" name="krbver" value="5" />',
3302: '</label>');
3303: }
1.32 matthew 3304: return $result;
3305: }
3306:
1.1106 raeburn 3307: sub authform_internal {
1.586 raeburn 3308: my %in = (
1.32 matthew 3309: formname => 'document.cu',
3310: kerb_def_dom => 'MSU.EDU',
3311: @_,
3312: );
1.1259 raeburn 3313: my ($intcheck,$intarg,$result,$authtype,$autharg,$jscall,$disabled);
1.1106 raeburn 3314: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.1259 raeburn 3315: if ($in{'readonly'}) {
3316: $disabled = ' disabled="disabled"';
3317: }
1.591 raeburn 3318: if (defined($in{'curr_authtype'})) {
3319: if ($in{'curr_authtype'} eq 'int') {
1.586 raeburn 3320: if ($can_assign{'int'}) {
1.772 bisitz 3321: $intcheck = 'checked="checked" ';
1.623 raeburn 3322: if (defined($in{'mode'})) {
3323: if ($in{'mode'} eq 'modifyuser') {
3324: $intcheck = '';
3325: }
3326: }
1.591 raeburn 3327: if (defined($in{'curr_autharg'})) {
1.586 raeburn 3328: $intarg = $in{'curr_autharg'};
3329: }
3330: } else {
3331: $result = &mt('Currently internally authenticated.');
3332: return $result;
1.165 raeburn 3333: }
3334: }
1.586 raeburn 3335: } else {
3336: if ($authnum == 1) {
1.784 bisitz 3337: $authtype = '<input type="hidden" name="login" value="int" />';
1.586 raeburn 3338: }
3339: }
3340: if (!$can_assign{'int'}) {
3341: return;
1.587 raeburn 3342: } elsif ($authtype eq '') {
1.591 raeburn 3343: if (defined($in{'mode'})) {
1.587 raeburn 3344: if ($in{'mode'} eq 'modifycourse') {
3345: if ($authnum == 1) {
1.1259 raeburn 3346: $authtype = '<input type="radio" name="login" value="int"'.$disabled.' />';
1.587 raeburn 3347: }
3348: }
3349: }
1.165 raeburn 3350: }
1.586 raeburn 3351: $jscall = "javascript:changed_radio('int',$in{'formname'});";
3352: if ($authtype eq '') {
3353: $authtype = '<input type="radio" name="login" value="int" '.$intcheck.
1.1259 raeburn 3354: ' onchange="'.$jscall.'" onclick="'.$jscall.'"'.$disabled.' />';
1.586 raeburn 3355: }
1.605 bisitz 3356: $autharg = '<input type="password" size="10" name="intarg" value="'.
1.1259 raeburn 3357: $intarg.'" onchange="'.$jscall.'"'.$disabled.' />';
1.586 raeburn 3358: $result = &mt
1.144 matthew 3359: ('[_1] Internally authenticated (with initial password [_2])',
1.586 raeburn 3360: '<label>'.$authtype,'</label>'.$autharg);
1.1259 raeburn 3361: $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 3362: return $result;
3363: }
3364:
1.1104 raeburn 3365: sub authform_local {
1.32 matthew 3366: my %in = (
3367: formname => 'document.cu',
3368: kerb_def_dom => 'MSU.EDU',
3369: @_,
3370: );
1.1259 raeburn 3371: my ($loccheck,$locarg,$result,$authtype,$autharg,$jscall,$disabled);
1.1106 raeburn 3372: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.1259 raeburn 3373: if ($in{'readonly'}) {
3374: $disabled = ' disabled="disabled"';
3375: }
1.591 raeburn 3376: if (defined($in{'curr_authtype'})) {
3377: if ($in{'curr_authtype'} eq 'loc') {
1.586 raeburn 3378: if ($can_assign{'loc'}) {
1.772 bisitz 3379: $loccheck = 'checked="checked" ';
1.623 raeburn 3380: if (defined($in{'mode'})) {
3381: if ($in{'mode'} eq 'modifyuser') {
3382: $loccheck = '';
3383: }
3384: }
1.591 raeburn 3385: if (defined($in{'curr_autharg'})) {
1.586 raeburn 3386: $locarg = $in{'curr_autharg'};
3387: }
3388: } else {
3389: $result = &mt('Currently using local (institutional) authentication.');
3390: return $result;
1.165 raeburn 3391: }
3392: }
1.586 raeburn 3393: } else {
3394: if ($authnum == 1) {
1.784 bisitz 3395: $authtype = '<input type="hidden" name="login" value="loc" />';
1.586 raeburn 3396: }
3397: }
3398: if (!$can_assign{'loc'}) {
3399: return;
1.587 raeburn 3400: } elsif ($authtype eq '') {
1.591 raeburn 3401: if (defined($in{'mode'})) {
1.587 raeburn 3402: if ($in{'mode'} eq 'modifycourse') {
3403: if ($authnum == 1) {
1.1259 raeburn 3404: $authtype = '<input type="radio" name="login" value="loc"'.$disabled.' />';
1.587 raeburn 3405: }
3406: }
3407: }
1.165 raeburn 3408: }
1.586 raeburn 3409: $jscall = "javascript:changed_radio('loc',$in{'formname'});";
3410: if ($authtype eq '') {
3411: $authtype = '<input type="radio" name="login" value="loc" '.
3412: $loccheck.' onchange="'.$jscall.'" onclick="'.
1.1259 raeburn 3413: $jscall.'"'.$disabled.' />';
1.586 raeburn 3414: }
3415: $autharg = '<input type="text" size="10" name="locarg" value="'.
1.1259 raeburn 3416: $locarg.'" onchange="'.$jscall.'"'.$disabled.' />';
1.586 raeburn 3417: $result = &mt('[_1] Local Authentication with argument [_2]',
3418: '<label>'.$authtype,'</label>'.$autharg);
1.32 matthew 3419: return $result;
3420: }
3421:
1.1106 raeburn 3422: sub authform_filesystem {
1.32 matthew 3423: my %in = (
3424: formname => 'document.cu',
3425: kerb_def_dom => 'MSU.EDU',
3426: @_,
3427: );
1.1259 raeburn 3428: my ($fsyscheck,$result,$authtype,$autharg,$jscall,$disabled);
1.1106 raeburn 3429: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.1259 raeburn 3430: if ($in{'readonly'}) {
3431: $disabled = ' disabled="disabled"';
3432: }
1.591 raeburn 3433: if (defined($in{'curr_authtype'})) {
3434: if ($in{'curr_authtype'} eq 'fsys') {
1.586 raeburn 3435: if ($can_assign{'fsys'}) {
1.772 bisitz 3436: $fsyscheck = 'checked="checked" ';
1.623 raeburn 3437: if (defined($in{'mode'})) {
3438: if ($in{'mode'} eq 'modifyuser') {
3439: $fsyscheck = '';
3440: }
3441: }
1.586 raeburn 3442: } else {
3443: $result = &mt('Currently Filesystem Authenticated.');
3444: return $result;
1.1259 raeburn 3445: }
1.586 raeburn 3446: }
3447: } else {
3448: if ($authnum == 1) {
1.784 bisitz 3449: $authtype = '<input type="hidden" name="login" value="fsys" />';
1.586 raeburn 3450: }
3451: }
3452: if (!$can_assign{'fsys'}) {
3453: return;
1.587 raeburn 3454: } elsif ($authtype eq '') {
1.591 raeburn 3455: if (defined($in{'mode'})) {
1.587 raeburn 3456: if ($in{'mode'} eq 'modifycourse') {
3457: if ($authnum == 1) {
1.1259 raeburn 3458: $authtype = '<input type="radio" name="login" value="fsys"'.$disabled.' />';
1.587 raeburn 3459: }
3460: }
3461: }
1.586 raeburn 3462: }
3463: $jscall = "javascript:changed_radio('fsys',$in{'formname'});";
3464: if ($authtype eq '') {
3465: $authtype = '<input type="radio" name="login" value="fsys" '.
3466: $fsyscheck.' onchange="'.$jscall.'" onclick="'.
1.1259 raeburn 3467: $jscall.'"'.$disabled.' />';
1.586 raeburn 3468: }
1.1310 raeburn 3469: $autharg = '<input type="password" size="10" name="fsysarg" value=""'.
1.1259 raeburn 3470: ' onchange="'.$jscall.'"'.$disabled.' />';
1.586 raeburn 3471: $result = &mt
1.144 matthew 3472: ('[_1] Filesystem Authenticated (with initial password [_2])',
1.1310 raeburn 3473: '<label>'.$authtype,'</label>'.$autharg);
3474: return $result;
3475: }
3476:
3477: sub authform_lti {
3478: my %in = (
3479: formname => 'document.cu',
3480: kerb_def_dom => 'MSU.EDU',
3481: @_,
3482: );
3483: my ($lticheck,$result,$authtype,$autharg,$jscall,$disabled);
3484: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
3485: if ($in{'readonly'}) {
3486: $disabled = ' disabled="disabled"';
3487: }
3488: if (defined($in{'curr_authtype'})) {
3489: if ($in{'curr_authtype'} eq 'lti') {
3490: if ($can_assign{'lti'}) {
3491: $lticheck = 'checked="checked" ';
3492: if (defined($in{'mode'})) {
3493: if ($in{'mode'} eq 'modifyuser') {
3494: $lticheck = '';
3495: }
3496: }
3497: } else {
3498: $result = &mt('Currently LTI Authenticated.');
3499: return $result;
3500: }
3501: }
3502: } else {
3503: if ($authnum == 1) {
3504: $authtype = '<input type="hidden" name="login" value="lti" />';
3505: }
3506: }
3507: if (!$can_assign{'lti'}) {
3508: return;
3509: } elsif ($authtype eq '') {
3510: if (defined($in{'mode'})) {
3511: if ($in{'mode'} eq 'modifycourse') {
3512: if ($authnum == 1) {
3513: $authtype = '<input type="radio" name="login" value="lti"'.$disabled.' />';
3514: }
3515: }
3516: }
3517: }
3518: $jscall = "javascript:changed_radio('lti',$in{'formname'});";
3519: if (($authtype eq '') && (($in{'mode'} eq 'modifycourse') || ($in{'curr_authtype'} ne 'lti'))) {
3520: $authtype = '<input type="radio" name="login" value="lti" '.
3521: $lticheck.' onchange="'.$jscall.'" onclick="'.
3522: $jscall.'"'.$disabled.' />';
3523: }
3524: $autharg = '<input type="hidden" name="ltiarg" value="" />';
3525: if ($authtype) {
3526: $result = &mt('[_1] LTI Authenticated',
3527: '<label>'.$authtype.'</label>'.$autharg);
3528: } else {
3529: $result = '<b>'.&mt('LTI Authenticated').'</b>'.
3530: $autharg;
3531: }
1.32 matthew 3532: return $result;
3533: }
3534:
1.586 raeburn 3535: sub get_assignable_auth {
3536: my ($dom) = @_;
3537: if ($dom eq '') {
3538: $dom = $env{'request.role.domain'};
3539: }
3540: my %can_assign = (
3541: krb4 => 1,
3542: krb5 => 1,
3543: int => 1,
3544: loc => 1,
1.1310 raeburn 3545: lti => 1,
1.586 raeburn 3546: );
3547: my %domconfig = &Apache::lonnet::get_dom('configuration',['usercreation'],$dom);
3548: if (ref($domconfig{'usercreation'}) eq 'HASH') {
3549: if (ref($domconfig{'usercreation'}{'authtypes'}) eq 'HASH') {
3550: my $authhash = $domconfig{'usercreation'}{'authtypes'};
3551: my $context;
3552: if ($env{'request.role'} =~ /^au/) {
3553: $context = 'author';
1.1259 raeburn 3554: } elsif ($env{'request.role'} =~ /^(dc|dh)/) {
1.586 raeburn 3555: $context = 'domain';
3556: } elsif ($env{'request.course.id'}) {
3557: $context = 'course';
3558: }
3559: if ($context) {
3560: if (ref($authhash->{$context}) eq 'HASH') {
3561: %can_assign = %{$authhash->{$context}};
3562: }
3563: }
3564: }
3565: }
3566: my $authnum = 0;
3567: foreach my $key (keys(%can_assign)) {
3568: if ($can_assign{$key}) {
3569: $authnum ++;
3570: }
3571: }
3572: if ($can_assign{'krb4'} && $can_assign{'krb5'}) {
3573: $authnum --;
3574: }
3575: return ($authnum,%can_assign);
3576: }
3577:
1.1331 raeburn 3578: sub check_passwd_rules {
3579: my ($domain,$plainpass) = @_;
3580: my %passwdconf = &Apache::lonnet::get_passwdconf($domain);
3581: my ($min,$max,@chars,@brokerule,$warning);
1.1333 raeburn 3582: $min = $Apache::lonnet::passwdmin;
1.1331 raeburn 3583: if (ref($passwdconf{'chars'}) eq 'ARRAY') {
3584: if ($passwdconf{'min'} =~ /^\d+$/) {
1.1333 raeburn 3585: if ($passwdconf{'min'} > $min) {
3586: $min = $passwdconf{'min'};
3587: }
1.1331 raeburn 3588: }
3589: if ($passwdconf{'max'} =~ /^\d+$/) {
3590: $max = $passwdconf{'max'};
3591: }
3592: @chars = @{$passwdconf{'chars'}};
3593: }
3594: if (($min) && (length($plainpass) < $min)) {
3595: push(@brokerule,'min');
3596: }
3597: if (($max) && (length($plainpass) > $max)) {
3598: push(@brokerule,'max');
3599: }
3600: if (@chars) {
3601: my %rules;
3602: map { $rules{$_} = 1; } @chars;
3603: if ($rules{'uc'}) {
3604: unless ($plainpass =~ /[A-Z]/) {
3605: push(@brokerule,'uc');
3606: }
3607: }
3608: if ($rules{'lc'}) {
1.1332 raeburn 3609: unless ($plainpass =~ /[a-z]/) {
1.1331 raeburn 3610: push(@brokerule,'lc');
3611: }
3612: }
3613: if ($rules{'num'}) {
3614: unless ($plainpass =~ /\d/) {
3615: push(@brokerule,'num');
3616: }
3617: }
3618: if ($rules{'spec'}) {
3619: unless ($plainpass =~ /[!"#$%&'()*+,\-.\/:;<=>?@[\\\]^_`{|}~]/) {
3620: push(@brokerule,'spec');
3621: }
3622: }
3623: }
3624: if (@brokerule) {
3625: my %rulenames = &Apache::lonlocal::texthash(
3626: uc => 'At least one upper case letter',
3627: lc => 'At least one lower case letter',
3628: num => 'At least one number',
3629: spec => 'At least one non-alphanumeric',
3630: );
3631: $rulenames{'uc'} .= ': ABCDEFGHIJKLMNOPQRSTUVWXYZ';
3632: $rulenames{'lc'} .= ': abcdefghijklmnopqrstuvwxyz';
3633: $rulenames{'num'} .= ': 0123456789';
3634: $rulenames{'spec'} .= ': !"\#$%&\'()*+,-./:;<=>?@[\]^_\`{|}~';
3635: $rulenames{'min'} = &mt('Minimum password length: [_1]',$min);
3636: $rulenames{'max'} = &mt('Maximum password length: [_1]',$max);
3637: $warning = &mt('Password did not satisfy the following:').'<ul>';
1.1336 raeburn 3638: foreach my $rule ('min','max','uc','lc','num','spec') {
1.1331 raeburn 3639: if (grep(/^$rule$/,@brokerule)) {
3640: $warning .= '<li>'.$rulenames{$rule}.'</li>';
3641: }
3642: }
3643: $warning .= '</ul>';
3644: }
1.1332 raeburn 3645: if (wantarray) {
3646: return @brokerule;
3647: }
1.1331 raeburn 3648: return $warning;
3649: }
3650:
1.80 albertel 3651: ###############################################################
3652: ## Get Kerberos Defaults for Domain ##
3653: ###############################################################
3654: ##
3655: ## Returns default kerberos version and an associated argument
3656: ## as listed in file domain.tab. If not listed, provides
3657: ## appropriate default domain and kerberos version.
3658: ##
3659: #-------------------------------------------
3660:
3661: =pod
3662:
1.648 raeburn 3663: =item * &get_kerberos_defaults()
1.80 albertel 3664:
3665: get_kerberos_defaults($target_domain) returns the default kerberos
1.641 raeburn 3666: version and domain. If not found, it defaults to version 4 and the
3667: domain of the server.
1.80 albertel 3668:
1.648 raeburn 3669: =over 4
3670:
1.80 albertel 3671: ($def_version, $def_krb_domain) = &get_kerberos_defaults($target_domain);
3672:
1.648 raeburn 3673: =back
3674:
3675: =back
3676:
1.80 albertel 3677: =cut
3678:
3679: #-------------------------------------------
3680: sub get_kerberos_defaults {
3681: my $domain=shift;
1.641 raeburn 3682: my ($krbdef,$krbdefdom);
3683: my %domdefaults = &Apache::lonnet::get_domain_defaults($domain);
3684: if (($domdefaults{'auth_def'} =~/^krb(4|5)$/) && ($domdefaults{'auth_arg_def'} ne '')) {
3685: $krbdef = $domdefaults{'auth_def'};
3686: $krbdefdom = $domdefaults{'auth_arg_def'};
3687: } else {
1.80 albertel 3688: $ENV{'SERVER_NAME'}=~/(\w+\.\w+)$/;
3689: my $krbdefdom=$1;
3690: $krbdefdom=~tr/a-z/A-Z/;
3691: $krbdef = "krb4";
3692: }
3693: return ($krbdef,$krbdefdom);
3694: }
1.112 bowersj2 3695:
1.32 matthew 3696:
1.46 matthew 3697: ###############################################################
3698: ## Thesaurus Functions ##
3699: ###############################################################
1.20 www 3700:
1.46 matthew 3701: =pod
1.20 www 3702:
1.112 bowersj2 3703: =head1 Thesaurus Functions
3704:
3705: =over 4
3706:
1.648 raeburn 3707: =item * &initialize_keywords()
1.46 matthew 3708:
3709: Initializes the package variable %Keywords if it is empty. Uses the
3710: package variable $thesaurus_db_file.
3711:
3712: =cut
3713:
3714: ###################################################
3715:
3716: sub initialize_keywords {
3717: return 1 if (scalar keys(%Keywords));
3718: # If we are here, %Keywords is empty, so fill it up
3719: # Make sure the file we need exists...
3720: if (! -e $thesaurus_db_file) {
3721: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file".
3722: " failed because it does not exist");
3723: return 0;
3724: }
3725: # Set up the hash as a database
3726: my %thesaurus_db;
3727: if (! tie(%thesaurus_db,'GDBM_File',
1.53 albertel 3728: $thesaurus_db_file,&GDBM_READER(),0640)){
1.46 matthew 3729: &Apache::lonnet::logthis("Could not tie \%thesaurus_db to ".
3730: $thesaurus_db_file);
3731: return 0;
3732: }
3733: # Get the average number of appearances of a word.
3734: my $avecount = $thesaurus_db{'average.count'};
3735: # Put keywords (those that appear > average) into %Keywords
3736: while (my ($word,$data)=each (%thesaurus_db)) {
3737: my ($count,undef) = split /:/,$data;
3738: $Keywords{$word}++ if ($count > $avecount);
3739: }
3740: untie %thesaurus_db;
3741: # Remove special values from %Keywords.
1.356 albertel 3742: foreach my $value ('total.count','average.count') {
3743: delete($Keywords{$value}) if (exists($Keywords{$value}));
1.586 raeburn 3744: }
1.46 matthew 3745: return 1;
3746: }
3747:
3748: ###################################################
3749:
3750: =pod
3751:
1.648 raeburn 3752: =item * &keyword($word)
1.46 matthew 3753:
3754: Returns true if $word is a keyword. A keyword is a word that appears more
3755: than the average number of times in the thesaurus database. Calls
3756: &initialize_keywords
3757:
3758: =cut
3759:
3760: ###################################################
1.20 www 3761:
3762: sub keyword {
1.46 matthew 3763: return if (!&initialize_keywords());
3764: my $word=lc(shift());
3765: $word=~s/\W//g;
3766: return exists($Keywords{$word});
1.20 www 3767: }
1.46 matthew 3768:
3769: ###############################################################
3770:
3771: =pod
1.20 www 3772:
1.648 raeburn 3773: =item * &get_related_words()
1.46 matthew 3774:
1.160 matthew 3775: Look up a word in the thesaurus. Takes a scalar argument and returns
1.46 matthew 3776: an array of words. If the keyword is not in the thesaurus, an empty array
3777: will be returned. The order of the words returned is determined by the
3778: database which holds them.
3779:
3780: Uses global $thesaurus_db_file.
3781:
1.1057 foxr 3782:
1.46 matthew 3783: =cut
3784:
3785: ###############################################################
3786: sub get_related_words {
3787: my $keyword = shift;
3788: my %thesaurus_db;
3789: if (! -e $thesaurus_db_file) {
3790: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file ".
3791: "failed because the file does not exist");
3792: return ();
3793: }
3794: if (! tie(%thesaurus_db,'GDBM_File',
1.53 albertel 3795: $thesaurus_db_file,&GDBM_READER(),0640)){
1.46 matthew 3796: return ();
3797: }
3798: my @Words=();
1.429 www 3799: my $count=0;
1.46 matthew 3800: if (exists($thesaurus_db{$keyword})) {
1.356 albertel 3801: # The first element is the number of times
3802: # the word appears. We do not need it now.
1.429 www 3803: my (undef,@RelatedWords) = (split(/:/,$thesaurus_db{$keyword}));
3804: my (undef,$mostfrequentcount)=split(/\,/,$RelatedWords[0]);
3805: my $threshold=$mostfrequentcount/10;
3806: foreach my $possibleword (@RelatedWords) {
3807: my ($word,$wordcount)=split(/\,/,$possibleword);
3808: if ($wordcount>$threshold) {
3809: push(@Words,$word);
3810: $count++;
3811: if ($count>10) { last; }
3812: }
1.20 www 3813: }
3814: }
1.46 matthew 3815: untie %thesaurus_db;
3816: return @Words;
1.14 harris41 3817: }
1.1090 foxr 3818: ###############################################################
3819: #
3820: # Spell checking
3821: #
3822:
3823: =pod
3824:
1.1142 raeburn 3825: =back
3826:
1.1090 foxr 3827: =head1 Spell checking
3828:
3829: =over 4
3830:
3831: =item * &check_spelling($wordlist $language)
3832:
3833: Takes a string containing words and feeds it to an external
3834: spellcheck program via a pipeline. Returns a string containing
3835: them mis-spelled words.
3836:
3837: Parameters:
3838:
3839: =over 4
3840:
3841: =item - $wordlist
3842:
3843: String that will be fed into the spellcheck program.
3844:
3845: =item - $language
3846:
3847: Language string that specifies the language for which the spell
3848: check will be performed.
3849:
3850: =back
3851:
3852: =back
3853:
3854: Note: This sub assumes that aspell is installed.
3855:
3856:
3857: =cut
3858:
1.46 matthew 3859:
1.1090 foxr 3860: sub check_spelling {
3861: my ($wordlist, $language) = @_;
1.1091 foxr 3862: my @misspellings;
3863:
3864: # Generate the speller and set the langauge.
3865: # if explicitly selected:
1.1090 foxr 3866:
1.1091 foxr 3867: my $speller = Text::Aspell->new;
1.1090 foxr 3868: if ($language) {
1.1091 foxr 3869: $speller->set_option('lang', $language);
1.1090 foxr 3870: }
3871:
1.1091 foxr 3872: # Turn the word list into an array of words by splittingon whitespace
1.1090 foxr 3873:
1.1091 foxr 3874: my @words = split(/\s+/, $wordlist);
1.1090 foxr 3875:
1.1091 foxr 3876: foreach my $word (@words) {
3877: if(! $speller->check($word)) {
3878: push(@misspellings, $word);
1.1090 foxr 3879: }
3880: }
1.1091 foxr 3881: return join(' ', @misspellings);
3882:
1.1090 foxr 3883: }
3884:
1.61 www 3885: # -------------------------------------------------------------- Plaintext name
1.81 albertel 3886: =pod
3887:
1.112 bowersj2 3888: =head1 User Name Functions
3889:
3890: =over 4
3891:
1.648 raeburn 3892: =item * &plainname($uname,$udom,$first)
1.81 albertel 3893:
1.112 bowersj2 3894: Takes a users logon name and returns it as a string in
1.226 albertel 3895: "first middle last generation" form
3896: if $first is set to 'lastname' then it returns it as
3897: 'lastname generation, firstname middlename' if their is a lastname
1.81 albertel 3898:
3899: =cut
1.61 www 3900:
1.295 www 3901:
1.81 albertel 3902: ###############################################################
1.61 www 3903: sub plainname {
1.226 albertel 3904: my ($uname,$udom,$first)=@_;
1.537 albertel 3905: return if (!defined($uname) || !defined($udom));
1.295 www 3906: my %names=&getnames($uname,$udom);
1.226 albertel 3907: my $name=&Apache::lonnet::format_name($names{'firstname'},
3908: $names{'middlename'},
3909: $names{'lastname'},
3910: $names{'generation'},$first);
3911: $name=~s/^\s+//;
1.62 www 3912: $name=~s/\s+$//;
3913: $name=~s/\s+/ /g;
1.353 albertel 3914: if ($name !~ /\S/) { $name=$uname.':'.$udom; }
1.62 www 3915: return $name;
1.61 www 3916: }
1.66 www 3917:
3918: # -------------------------------------------------------------------- Nickname
1.81 albertel 3919: =pod
3920:
1.648 raeburn 3921: =item * &nickname($uname,$udom)
1.81 albertel 3922:
3923: Gets a users name and returns it as a string as
3924:
3925: ""nickname""
1.66 www 3926:
1.81 albertel 3927: if the user has a nickname or
3928:
3929: "first middle last generation"
3930:
3931: if the user does not
3932:
3933: =cut
1.66 www 3934:
3935: sub nickname {
3936: my ($uname,$udom)=@_;
1.537 albertel 3937: return if (!defined($uname) || !defined($udom));
1.295 www 3938: my %names=&getnames($uname,$udom);
1.68 albertel 3939: my $name=$names{'nickname'};
1.66 www 3940: if ($name) {
3941: $name='"'.$name.'"';
3942: } else {
3943: $name=$names{'firstname'}.' '.$names{'middlename'}.' '.
3944: $names{'lastname'}.' '.$names{'generation'};
3945: $name=~s/\s+$//;
3946: $name=~s/\s+/ /g;
3947: }
3948: return $name;
3949: }
3950:
1.295 www 3951: sub getnames {
3952: my ($uname,$udom)=@_;
1.537 albertel 3953: return if (!defined($uname) || !defined($udom));
1.433 albertel 3954: if ($udom eq 'public' && $uname eq 'public') {
3955: return ('lastname' => &mt('Public'));
3956: }
1.295 www 3957: my $id=$uname.':'.$udom;
3958: my ($names,$cached)=&Apache::lonnet::is_cached_new('namescache',$id);
3959: if ($cached) {
3960: return %{$names};
3961: } else {
3962: my %loadnames=&Apache::lonnet::get('environment',
3963: ['firstname','middlename','lastname','generation','nickname'],
3964: $udom,$uname);
3965: &Apache::lonnet::do_cache_new('namescache',$id,\%loadnames);
3966: return %loadnames;
3967: }
3968: }
1.61 www 3969:
1.542 raeburn 3970: # -------------------------------------------------------------------- getemails
1.648 raeburn 3971:
1.542 raeburn 3972: =pod
3973:
1.648 raeburn 3974: =item * &getemails($uname,$udom)
1.542 raeburn 3975:
3976: Gets a user's email information and returns it as a hash with keys:
3977: notification, critnotification, permanentemail
3978:
3979: For notification and critnotification, values are comma-separated lists
1.648 raeburn 3980: of e-mail addresses; for permanentemail, value is a single e-mail address.
1.542 raeburn 3981:
1.648 raeburn 3982:
1.542 raeburn 3983: =cut
3984:
1.648 raeburn 3985:
1.466 albertel 3986: sub getemails {
3987: my ($uname,$udom)=@_;
3988: if ($udom eq 'public' && $uname eq 'public') {
3989: return;
3990: }
1.467 www 3991: if (!$udom) { $udom=$env{'user.domain'}; }
3992: if (!$uname) { $uname=$env{'user.name'}; }
1.466 albertel 3993: my $id=$uname.':'.$udom;
3994: my ($names,$cached)=&Apache::lonnet::is_cached_new('emailscache',$id);
3995: if ($cached) {
3996: return %{$names};
3997: } else {
3998: my %loadnames=&Apache::lonnet::get('environment',
3999: ['notification','critnotification',
4000: 'permanentemail'],
4001: $udom,$uname);
4002: &Apache::lonnet::do_cache_new('emailscache',$id,\%loadnames);
4003: return %loadnames;
4004: }
4005: }
4006:
1.551 albertel 4007: sub flush_email_cache {
4008: my ($uname,$udom)=@_;
4009: if (!$udom) { $udom =$env{'user.domain'}; }
4010: if (!$uname) { $uname=$env{'user.name'}; }
4011: return if ($udom eq 'public' && $uname eq 'public');
4012: my $id=$uname.':'.$udom;
4013: &Apache::lonnet::devalidate_cache_new('emailscache',$id);
4014: }
4015:
1.728 raeburn 4016: # -------------------------------------------------------------------- getlangs
4017:
4018: =pod
4019:
4020: =item * &getlangs($uname,$udom)
4021:
4022: Gets a user's language preference and returns it as a hash with key:
4023: language.
4024:
4025: =cut
4026:
4027:
4028: sub getlangs {
4029: my ($uname,$udom) = @_;
4030: if (!$udom) { $udom =$env{'user.domain'}; }
4031: if (!$uname) { $uname=$env{'user.name'}; }
4032: my $id=$uname.':'.$udom;
4033: my ($langs,$cached)=&Apache::lonnet::is_cached_new('userlangs',$id);
4034: if ($cached) {
4035: return %{$langs};
4036: } else {
4037: my %loadlangs=&Apache::lonnet::get('environment',['languages'],
4038: $udom,$uname);
4039: &Apache::lonnet::do_cache_new('userlangs',$id,\%loadlangs);
4040: return %loadlangs;
4041: }
4042: }
4043:
4044: sub flush_langs_cache {
4045: my ($uname,$udom)=@_;
4046: if (!$udom) { $udom =$env{'user.domain'}; }
4047: if (!$uname) { $uname=$env{'user.name'}; }
4048: return if ($udom eq 'public' && $uname eq 'public');
4049: my $id=$uname.':'.$udom;
4050: &Apache::lonnet::devalidate_cache_new('userlangs',$id);
4051: }
4052:
1.61 www 4053: # ------------------------------------------------------------------ Screenname
1.81 albertel 4054:
4055: =pod
4056:
1.648 raeburn 4057: =item * &screenname($uname,$udom)
1.81 albertel 4058:
4059: Gets a users screenname and returns it as a string
4060:
4061: =cut
1.61 www 4062:
4063: sub screenname {
4064: my ($uname,$udom)=@_;
1.258 albertel 4065: if ($uname eq $env{'user.name'} &&
4066: $udom eq $env{'user.domain'}) {return $env{'environment.screenname'};}
1.212 albertel 4067: my %names=&Apache::lonnet::get('environment',['screenname'],$udom,$uname);
1.68 albertel 4068: return $names{'screenname'};
1.62 www 4069: }
4070:
1.212 albertel 4071:
1.802 bisitz 4072: # ------------------------------------------------------------- Confirm Wrapper
4073: =pod
4074:
1.1142 raeburn 4075: =item * &confirmwrapper($message)
1.802 bisitz 4076:
4077: Wrap messages about completion of operation in box
4078:
4079: =cut
4080:
4081: sub confirmwrapper {
4082: my ($message)=@_;
4083: if ($message) {
4084: return "\n".'<div class="LC_confirm_box">'."\n"
4085: .$message."\n"
4086: .'</div>'."\n";
4087: } else {
4088: return $message;
4089: }
4090: }
4091:
1.62 www 4092: # ------------------------------------------------------------- Message Wrapper
4093:
4094: sub messagewrapper {
1.369 www 4095: my ($link,$username,$domain,$subject,$text)=@_;
1.62 www 4096: return
1.441 albertel 4097: '<a href="/adm/email?compose=individual&'.
4098: 'recname='.$username.'&recdom='.$domain.
4099: '&subject='.&escape($subject).'&text='.&escape($text).'" '.
1.200 matthew 4100: 'title="'.&mt('Send message').'">'.$link.'</a>';
1.74 www 4101: }
1.802 bisitz 4102:
1.74 www 4103: # --------------------------------------------------------------- Notes Wrapper
4104:
4105: sub noteswrapper {
4106: my ($link,$un,$do)=@_;
4107: return
1.896 amueller 4108: "<a href='/adm/email?recordftf=retrieve&recname=$un&recdom=$do'>$link</a>";
1.62 www 4109: }
1.802 bisitz 4110:
1.62 www 4111: # ------------------------------------------------------------- Aboutme Wrapper
4112:
4113: sub aboutmewrapper {
1.1070 raeburn 4114: my ($link,$username,$domain,$target,$class)=@_;
1.447 raeburn 4115: if (!defined($username) && !defined($domain)) {
4116: return;
4117: }
1.1096 raeburn 4118: return '<a href="/adm/'.$domain.'/'.$username.'/aboutme"'.
1.1070 raeburn 4119: ($target?' target="'.$target.'"':'').($class?' class="'.$class.'"':'').' title="'.&mt("View this user's personal information page").'">'.$link.'</a>';
1.62 www 4120: }
4121:
4122: # ------------------------------------------------------------ Syllabus Wrapper
4123:
4124: sub syllabuswrapper {
1.707 bisitz 4125: my ($linktext,$coursedir,$domain)=@_;
1.208 matthew 4126: return qq{<a href="/public/$domain/$coursedir/syllabus">$linktext</a>};
1.61 www 4127: }
1.14 harris41 4128:
1.802 bisitz 4129: # -----------------------------------------------------------------------------
4130:
1.208 matthew 4131: sub track_student_link {
1.887 raeburn 4132: my ($linktext,$sname,$sdom,$target,$start,$only_body) = @_;
1.268 albertel 4133: my $link ="/adm/trackstudent?";
1.208 matthew 4134: my $title = 'View recent activity';
4135: if (defined($sname) && $sname !~ /^\s*$/ &&
4136: defined($sdom) && $sdom !~ /^\s*$/) {
1.268 albertel 4137: $link .= "selected_student=$sname:$sdom";
1.208 matthew 4138: $title .= ' of this student';
1.268 albertel 4139: }
1.208 matthew 4140: if (defined($target) && $target !~ /^\s*$/) {
4141: $target = qq{target="$target"};
4142: } else {
4143: $target = '';
4144: }
1.268 albertel 4145: if ($start) { $link.='&start='.$start; }
1.887 raeburn 4146: if ($only_body) { $link .= '&only_body=1'; }
1.554 albertel 4147: $title = &mt($title);
4148: $linktext = &mt($linktext);
1.448 albertel 4149: return qq{<a href="$link" title="$title" $target>$linktext</a>}.
4150: &help_open_topic('View_recent_activity');
1.208 matthew 4151: }
4152:
1.781 raeburn 4153: sub slot_reservations_link {
4154: my ($linktext,$sname,$sdom,$target) = @_;
4155: my $link ="/adm/slotrequest?command=showresv&origin=aboutme";
4156: my $title = 'View slot reservation history';
4157: if (defined($sname) && $sname !~ /^\s*$/ &&
4158: defined($sdom) && $sdom !~ /^\s*$/) {
4159: $link .= "&uname=$sname&udom=$sdom";
4160: $title .= ' of this student';
4161: }
4162: if (defined($target) && $target !~ /^\s*$/) {
4163: $target = qq{target="$target"};
4164: } else {
4165: $target = '';
4166: }
4167: $title = &mt($title);
4168: $linktext = &mt($linktext);
4169: return qq{<a href="$link" title="$title" $target>$linktext</a>};
4170: # FIXME uncomment when help item created: &help_open_topic('Slot_Reservation_History');
4171:
4172: }
4173:
1.508 www 4174: # ===================================================== Display a student photo
4175:
4176:
1.509 albertel 4177: sub student_image_tag {
1.508 www 4178: my ($domain,$user)=@_;
4179: my $imgsrc=&Apache::lonnet::studentphoto($domain,$user,'jpg');
4180: if (($imgsrc) && ($imgsrc ne '/adm/lonKaputt/lonlogo_broken.gif')) {
4181: return '<img src="'.$imgsrc.'" align="right" />';
4182: } else {
4183: return '';
4184: }
4185: }
4186:
1.112 bowersj2 4187: =pod
4188:
4189: =back
4190:
4191: =head1 Access .tab File Data
4192:
4193: =over 4
4194:
1.648 raeburn 4195: =item * &languageids()
1.112 bowersj2 4196:
4197: returns list of all language ids
4198:
4199: =cut
4200:
1.14 harris41 4201: sub languageids {
1.16 harris41 4202: return sort(keys(%language));
1.14 harris41 4203: }
4204:
1.112 bowersj2 4205: =pod
4206:
1.648 raeburn 4207: =item * &languagedescription()
1.112 bowersj2 4208:
4209: returns description of a specified language id
4210:
4211: =cut
4212:
1.14 harris41 4213: sub languagedescription {
1.125 www 4214: my $code=shift;
4215: return ($supported_language{$code}?'* ':'').
4216: $language{$code}.
1.126 www 4217: ($supported_language{$code}?' ('.&mt('interface available').')':'');
1.145 www 4218: }
4219:
1.1048 foxr 4220: =pod
4221:
4222: =item * &plainlanguagedescription
4223:
4224: Returns both the plain language description (e.g. 'Creoles and Pidgins, English-based (Other)')
4225: and the language character encoding (e.g. ISO) separated by a ' - ' string.
4226:
4227: =cut
4228:
1.145 www 4229: sub plainlanguagedescription {
4230: my $code=shift;
4231: return $language{$code};
4232: }
4233:
1.1048 foxr 4234: =pod
4235:
4236: =item * &supportedlanguagecode
4237:
4238: Returns the supported language code (e.g. sptutf maps to pt) given a language
4239: code.
4240:
4241: =cut
4242:
1.145 www 4243: sub supportedlanguagecode {
4244: my $code=shift;
4245: return $supported_language{$code};
1.97 www 4246: }
4247:
1.112 bowersj2 4248: =pod
4249:
1.1048 foxr 4250: =item * &latexlanguage()
4251:
4252: Given a language key code returns the correspondnig language to use
4253: to select the correct hyphenation on LaTeX printouts. This is undef if there
4254: is no supported hyphenation for the language code.
4255:
4256: =cut
4257:
4258: sub latexlanguage {
4259: my $code = shift;
4260: return $latex_language{$code};
4261: }
4262:
4263: =pod
4264:
4265: =item * &latexhyphenation()
4266:
4267: Same as above but what's supplied is the language as it might be stored
4268: in the metadata.
4269:
4270: =cut
4271:
4272: sub latexhyphenation {
4273: my $key = shift;
4274: return $latex_language_bykey{$key};
4275: }
4276:
4277: =pod
4278:
1.648 raeburn 4279: =item * ©rightids()
1.112 bowersj2 4280:
4281: returns list of all copyrights
4282:
4283: =cut
4284:
4285: sub copyrightids {
4286: return sort(keys(%cprtag));
4287: }
4288:
4289: =pod
4290:
1.648 raeburn 4291: =item * ©rightdescription()
1.112 bowersj2 4292:
4293: returns description of a specified copyright id
4294:
4295: =cut
4296:
4297: sub copyrightdescription {
1.166 www 4298: return &mt($cprtag{shift(@_)});
1.112 bowersj2 4299: }
1.197 matthew 4300:
4301: =pod
4302:
1.648 raeburn 4303: =item * &source_copyrightids()
1.192 taceyjo1 4304:
4305: returns list of all source copyrights
4306:
4307: =cut
4308:
4309: sub source_copyrightids {
4310: return sort(keys(%scprtag));
4311: }
4312:
4313: =pod
4314:
1.648 raeburn 4315: =item * &source_copyrightdescription()
1.192 taceyjo1 4316:
4317: returns description of a specified source copyright id
4318:
4319: =cut
4320:
4321: sub source_copyrightdescription {
4322: return &mt($scprtag{shift(@_)});
4323: }
1.112 bowersj2 4324:
4325: =pod
4326:
1.648 raeburn 4327: =item * &filecategories()
1.112 bowersj2 4328:
4329: returns list of all file categories
4330:
4331: =cut
4332:
4333: sub filecategories {
4334: return sort(keys(%category_extensions));
4335: }
4336:
4337: =pod
4338:
1.648 raeburn 4339: =item * &filecategorytypes()
1.112 bowersj2 4340:
4341: returns list of file types belonging to a given file
4342: category
4343:
4344: =cut
4345:
4346: sub filecategorytypes {
1.356 albertel 4347: my ($cat) = @_;
1.1248 raeburn 4348: if (ref($category_extensions{lc($cat)}) eq 'ARRAY') {
4349: return @{$category_extensions{lc($cat)}};
4350: } else {
4351: return ();
4352: }
1.112 bowersj2 4353: }
4354:
4355: =pod
4356:
1.648 raeburn 4357: =item * &fileembstyle()
1.112 bowersj2 4358:
4359: returns embedding style for a specified file type
4360:
4361: =cut
4362:
4363: sub fileembstyle {
4364: return $fe{lc(shift(@_))};
1.169 www 4365: }
4366:
1.351 www 4367: sub filemimetype {
4368: return $fm{lc(shift(@_))};
4369: }
4370:
1.169 www 4371:
4372: sub filecategoryselect {
4373: my ($name,$value)=@_;
1.189 matthew 4374: return &select_form($value,$name,
1.970 raeburn 4375: {'' => &mt('Any category'), map { $_,$_ } sort(keys(%category_extensions))});
1.112 bowersj2 4376: }
4377:
4378: =pod
4379:
1.648 raeburn 4380: =item * &filedescription()
1.112 bowersj2 4381:
4382: returns description for a specified file type
4383:
4384: =cut
4385:
4386: sub filedescription {
1.188 matthew 4387: my $file_description = $fd{lc(shift())};
4388: $file_description =~ s:([\[\]]):~$1:g;
4389: return &mt($file_description);
1.112 bowersj2 4390: }
4391:
4392: =pod
4393:
1.648 raeburn 4394: =item * &filedescriptionex()
1.112 bowersj2 4395:
4396: returns description for a specified file type with
4397: extra formatting
4398:
4399: =cut
4400:
4401: sub filedescriptionex {
4402: my $ex=shift;
1.188 matthew 4403: my $file_description = $fd{lc($ex)};
4404: $file_description =~ s:([\[\]]):~$1:g;
4405: return '.'.$ex.' '.&mt($file_description);
1.112 bowersj2 4406: }
4407:
4408: # End of .tab access
4409: =pod
4410:
4411: =back
4412:
4413: =cut
4414:
4415: # ------------------------------------------------------------------ File Types
4416: sub fileextensions {
4417: return sort(keys(%fe));
4418: }
4419:
1.97 www 4420: # ----------------------------------------------------------- Display Languages
4421: # returns a hash with all desired display languages
4422: #
4423:
4424: sub display_languages {
4425: my %languages=();
1.695 raeburn 4426: foreach my $lang (&Apache::lonlocal::preferred_languages()) {
1.356 albertel 4427: $languages{$lang}=1;
1.97 www 4428: }
4429: &get_unprocessed_cgi($ENV{'QUERY_STRING'},['displaylanguage']);
1.258 albertel 4430: if ($env{'form.displaylanguage'}) {
1.356 albertel 4431: foreach my $lang (split(/\s*(\,|\;|\:)\s*/,$env{'form.displaylanguage'})) {
4432: $languages{$lang}=1;
1.97 www 4433: }
4434: }
4435: return %languages;
1.14 harris41 4436: }
4437:
1.582 albertel 4438: sub languages {
4439: my ($possible_langs) = @_;
1.695 raeburn 4440: my @preferred_langs = &Apache::lonlocal::preferred_languages();
1.582 albertel 4441: if (!ref($possible_langs)) {
4442: if( wantarray ) {
4443: return @preferred_langs;
4444: } else {
4445: return $preferred_langs[0];
4446: }
4447: }
4448: my %possibilities = map { $_ => 1 } (@$possible_langs);
4449: my @preferred_possibilities;
4450: foreach my $preferred_lang (@preferred_langs) {
4451: if (exists($possibilities{$preferred_lang})) {
4452: push(@preferred_possibilities, $preferred_lang);
4453: }
4454: }
4455: if( wantarray ) {
4456: return @preferred_possibilities;
4457: }
4458: return $preferred_possibilities[0];
4459: }
4460:
1.742 raeburn 4461: sub user_lang {
4462: my ($touname,$toudom,$fromcid) = @_;
4463: my @userlangs;
4464: if (($fromcid ne '') && ($env{'course.'.$fromcid.'.languages'} ne '')) {
4465: @userlangs=(@userlangs,split(/\s*(\,|\;|\:)\s*/,
4466: $env{'course.'.$fromcid.'.languages'}));
4467: } else {
4468: my %langhash = &getlangs($touname,$toudom);
4469: if ($langhash{'languages'} ne '') {
4470: @userlangs = split(/\s*(\,|\;|\:)\s*/,$langhash{'languages'});
4471: } else {
4472: my %domdefs = &Apache::lonnet::get_domain_defaults($toudom);
4473: if ($domdefs{'lang_def'} ne '') {
4474: @userlangs = ($domdefs{'lang_def'});
4475: }
4476: }
4477: }
4478: my @languages=&Apache::lonlocal::get_genlanguages(@userlangs);
4479: my $user_lh = Apache::localize->get_handle(@languages);
4480: return $user_lh;
4481: }
4482:
4483:
1.112 bowersj2 4484: ###############################################################
4485: ## Student Answer Attempts ##
4486: ###############################################################
4487:
4488: =pod
4489:
4490: =head1 Alternate Problem Views
4491:
4492: =over 4
4493:
1.648 raeburn 4494: =item * &get_previous_attempt($symb, $username, $domain, $course,
1.1199 raeburn 4495: $getattempt, $regexp, $gradesub, $usec, $identifier)
1.112 bowersj2 4496:
4497: Return string with previous attempt on problem. Arguments:
4498:
4499: =over 4
4500:
4501: =item * $symb: Problem, including path
4502:
4503: =item * $username: username of the desired student
4504:
4505: =item * $domain: domain of the desired student
1.14 harris41 4506:
1.112 bowersj2 4507: =item * $course: Course ID
1.14 harris41 4508:
1.112 bowersj2 4509: =item * $getattempt: Leave blank for all attempts, otherwise put
4510: something
1.14 harris41 4511:
1.112 bowersj2 4512: =item * $regexp: if string matches this regexp, the string will be
4513: sent to $gradesub
1.14 harris41 4514:
1.112 bowersj2 4515: =item * $gradesub: routine that processes the string if it matches $regexp
1.14 harris41 4516:
1.1199 raeburn 4517: =item * $usec: section of the desired student
4518:
4519: =item * $identifier: counter for student (multiple students one problem) or
4520: problem (one student; whole sequence).
4521:
1.112 bowersj2 4522: =back
1.14 harris41 4523:
1.112 bowersj2 4524: The output string is a table containing all desired attempts, if any.
1.16 harris41 4525:
1.112 bowersj2 4526: =cut
1.1 albertel 4527:
4528: sub get_previous_attempt {
1.1199 raeburn 4529: my ($symb,$username,$domain,$course,$getattempt,$regexp,$gradesub,$usec,$identifier)=@_;
1.1 albertel 4530: my $prevattempts='';
1.43 ng 4531: no strict 'refs';
1.1 albertel 4532: if ($symb) {
1.3 albertel 4533: my (%returnhash)=
4534: &Apache::lonnet::restore($symb,$course,$domain,$username);
1.1 albertel 4535: if ($returnhash{'version'}) {
4536: my %lasthash=();
4537: my $version;
4538: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.1212 raeburn 4539: foreach my $key (reverse(sort(split(/\:/,$returnhash{$version.':keys'})))) {
4540: if ($key =~ /\.rawrndseed$/) {
4541: my ($id) = ($key =~ /^(.+)\.rawrndseed$/);
4542: $lasthash{$id.'.rndseed'} = $returnhash{$version.':'.$key};
4543: } else {
4544: $lasthash{$key}=$returnhash{$version.':'.$key};
4545: }
1.19 harris41 4546: }
1.1 albertel 4547: }
1.596 albertel 4548: $prevattempts=&start_data_table().&start_data_table_header_row();
4549: $prevattempts.='<th>'.&mt('History').'</th>';
1.1199 raeburn 4550: my (%typeparts,%lasthidden,%regraded,%hidestatus);
1.945 raeburn 4551: my $showsurv=&Apache::lonnet::allowed('vas',$env{'request.course.id'});
1.356 albertel 4552: foreach my $key (sort(keys(%lasthash))) {
4553: my ($ign,@parts) = split(/\./,$key);
1.41 ng 4554: if ($#parts > 0) {
1.31 albertel 4555: my $data=$parts[-1];
1.989 raeburn 4556: next if ($data eq 'foilorder');
1.31 albertel 4557: pop(@parts);
1.1010 www 4558: $prevattempts.='<th>'.&mt('Part ').join('.',@parts).'<br />'.$data.' </th>';
1.945 raeburn 4559: if ($data eq 'type') {
4560: unless ($showsurv) {
4561: my $id = join(',',@parts);
4562: $typeparts{$ign.'.'.$id} = $lasthash{$key};
1.978 raeburn 4563: if (($lasthash{$key} eq 'anonsurvey') || ($lasthash{$key} eq 'anonsurveycred')) {
4564: $lasthidden{$ign.'.'.$id} = 1;
4565: }
1.945 raeburn 4566: }
1.1199 raeburn 4567: if ($identifier ne '') {
4568: my $id = join(',',@parts);
4569: if (&Apache::lonnet::EXT("resource.$id.problemstatus",$symb,
4570: $domain,$username,$usec,undef,$course) =~ /^no/) {
4571: $hidestatus{$ign.'.'.$id} = 1;
4572: }
4573: }
4574: } elsif ($data eq 'regrader') {
4575: if (($identifier ne '') && (@parts)) {
1.1200 raeburn 4576: my $id = join(',',@parts);
4577: $regraded{$ign.'.'.$id} = 1;
1.1199 raeburn 4578: }
1.1010 www 4579: }
1.31 albertel 4580: } else {
1.41 ng 4581: if ($#parts == 0) {
4582: $prevattempts.='<th>'.$parts[0].'</th>';
4583: } else {
4584: $prevattempts.='<th>'.$ign.'</th>';
4585: }
1.31 albertel 4586: }
1.16 harris41 4587: }
1.596 albertel 4588: $prevattempts.=&end_data_table_header_row();
1.40 ng 4589: if ($getattempt eq '') {
1.1199 raeburn 4590: my (%solved,%resets,%probstatus);
1.1200 raeburn 4591: if (($identifier ne '') && (keys(%regraded) > 0)) {
4592: for ($version=1;$version<=$returnhash{'version'};$version++) {
4593: foreach my $id (keys(%regraded)) {
4594: if (($returnhash{$version.':'.$id.'.regrader'}) &&
4595: ($returnhash{$version.':'.$id.'.tries'} eq '') &&
4596: ($returnhash{$version.':'.$id.'.award'} eq '')) {
4597: push(@{$resets{$id}},$version);
1.1199 raeburn 4598: }
4599: }
4600: }
1.1200 raeburn 4601: }
4602: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.1199 raeburn 4603: my (@hidden,@unsolved);
1.945 raeburn 4604: if (%typeparts) {
4605: foreach my $id (keys(%typeparts)) {
1.1199 raeburn 4606: if (($returnhash{$version.':'.$id.'.type'} eq 'anonsurvey') ||
4607: ($returnhash{$version.':'.$id.'.type'} eq 'anonsurveycred')) {
1.945 raeburn 4608: push(@hidden,$id);
1.1199 raeburn 4609: } elsif ($identifier ne '') {
4610: unless (($returnhash{$version.':'.$id.'.type'} eq 'survey') ||
4611: ($returnhash{$version.':'.$id.'.type'} eq 'surveycred') ||
4612: ($hidestatus{$id})) {
1.1200 raeburn 4613: next if ((ref($resets{$id}) eq 'ARRAY') && grep(/^\Q$version\E$/,@{$resets{$id}}));
1.1199 raeburn 4614: if ($returnhash{$version.':'.$id.'.solved'} eq 'correct_by_student') {
4615: push(@{$solved{$id}},$version);
4616: } elsif (($returnhash{$version.':'.$id.'.solved'} ne '') &&
4617: (ref($solved{$id}) eq 'ARRAY')) {
4618: my $skip;
4619: if (ref($resets{$id}) eq 'ARRAY') {
4620: foreach my $reset (@{$resets{$id}}) {
4621: if ($reset > $solved{$id}[-1]) {
4622: $skip=1;
4623: last;
4624: }
4625: }
4626: }
4627: unless ($skip) {
4628: my ($ign,$partslist) = split(/\./,$id,2);
4629: push(@unsolved,$partslist);
4630: }
4631: }
4632: }
1.945 raeburn 4633: }
4634: }
4635: }
4636: $prevattempts.=&start_data_table_row().
1.1199 raeburn 4637: '<td>'.&mt('Transaction [_1]',$version);
4638: if (@unsolved) {
4639: $prevattempts .= '<span class="LC_nobreak"><label>'.
4640: '<input type="checkbox" name="HIDE'.$identifier.'" value="'.$version.':'.join('_',@unsolved).'" />'.
4641: &mt('Hide').'</label></span>';
4642: }
4643: $prevattempts .= '</td>';
1.945 raeburn 4644: if (@hidden) {
4645: foreach my $key (sort(keys(%lasthash))) {
1.989 raeburn 4646: next if ($key =~ /\.foilorder$/);
1.945 raeburn 4647: my $hide;
4648: foreach my $id (@hidden) {
4649: if ($key =~ /^\Q$id\E/) {
4650: $hide = 1;
4651: last;
4652: }
4653: }
4654: if ($hide) {
4655: my ($id,$data) = ($key =~ /^(.+)\.([^.]+)$/);
4656: if (($data eq 'award') || ($data eq 'awarddetail')) {
4657: my $value = &format_previous_attempt_value($key,
4658: $returnhash{$version.':'.$key});
1.1173 kruse 4659: $prevattempts.='<td>'.$value.' </td>';
1.945 raeburn 4660: } else {
4661: $prevattempts.='<td> </td>';
4662: }
4663: } else {
4664: if ($key =~ /\./) {
1.1212 raeburn 4665: my $value = $returnhash{$version.':'.$key};
4666: if ($key =~ /\.rndseed$/) {
4667: my ($id) = ($key =~ /^(.+)\.[^.]+$/);
4668: if (exists($returnhash{$version.':'.$id.'.rawrndseed'})) {
4669: $value = $returnhash{$version.':'.$id.'.rawrndseed'};
4670: }
4671: }
4672: $prevattempts.='<td>'.&format_previous_attempt_value($key,$value).
4673: ' </td>';
1.945 raeburn 4674: } else {
4675: $prevattempts.='<td> </td>';
4676: }
4677: }
4678: }
4679: } else {
4680: foreach my $key (sort(keys(%lasthash))) {
1.989 raeburn 4681: next if ($key =~ /\.foilorder$/);
1.1212 raeburn 4682: my $value = $returnhash{$version.':'.$key};
4683: if ($key =~ /\.rndseed$/) {
4684: my ($id) = ($key =~ /^(.+)\.[^.]+$/);
4685: if (exists($returnhash{$version.':'.$id.'.rawrndseed'})) {
4686: $value = $returnhash{$version.':'.$id.'.rawrndseed'};
4687: }
4688: }
4689: $prevattempts.='<td>'.&format_previous_attempt_value($key,$value).
4690: ' </td>';
1.945 raeburn 4691: }
4692: }
4693: $prevattempts.=&end_data_table_row();
1.40 ng 4694: }
1.1 albertel 4695: }
1.945 raeburn 4696: my @currhidden = keys(%lasthidden);
1.596 albertel 4697: $prevattempts.=&start_data_table_row().'<td>'.&mt('Current').'</td>';
1.356 albertel 4698: foreach my $key (sort(keys(%lasthash))) {
1.989 raeburn 4699: next if ($key =~ /\.foilorder$/);
1.945 raeburn 4700: if (%typeparts) {
4701: my $hidden;
4702: foreach my $id (@currhidden) {
4703: if ($key =~ /^\Q$id\E/) {
4704: $hidden = 1;
4705: last;
4706: }
4707: }
4708: if ($hidden) {
4709: my ($id,$data) = ($key =~ /^(.+)\.([^.]+)$/);
4710: if (($data eq 'award') || ($data eq 'awarddetail')) {
4711: my $value = &format_previous_attempt_value($key,$lasthash{$key});
4712: if ($key =~/$regexp$/ && (defined &$gradesub)) {
4713: $value = &$gradesub($value);
4714: }
1.1173 kruse 4715: $prevattempts.='<td>'. $value.' </td>';
1.945 raeburn 4716: } else {
4717: $prevattempts.='<td> </td>';
4718: }
4719: } else {
4720: my $value = &format_previous_attempt_value($key,$lasthash{$key});
4721: if ($key =~/$regexp$/ && (defined &$gradesub)) {
4722: $value = &$gradesub($value);
4723: }
1.1173 kruse 4724: $prevattempts.='<td>'.$value.' </td>';
1.945 raeburn 4725: }
4726: } else {
4727: my $value = &format_previous_attempt_value($key,$lasthash{$key});
4728: if ($key =~/$regexp$/ && (defined &$gradesub)) {
4729: $value = &$gradesub($value);
4730: }
1.1173 kruse 4731: $prevattempts.='<td>'.$value.' </td>';
1.945 raeburn 4732: }
1.16 harris41 4733: }
1.596 albertel 4734: $prevattempts.= &end_data_table_row().&end_data_table();
1.1 albertel 4735: } else {
1.1305 raeburn 4736: my $msg;
4737: if ($symb =~ /ext\.tool$/) {
4738: $msg = &mt('No grade passed back.');
4739: } else {
4740: $msg = &mt('Nothing submitted - no attempts.');
4741: }
1.596 albertel 4742: $prevattempts=
4743: &start_data_table().&start_data_table_row().
1.1305 raeburn 4744: '<td>'.$msg.'</td>'.
1.596 albertel 4745: &end_data_table_row().&end_data_table();
1.1 albertel 4746: }
4747: } else {
1.596 albertel 4748: $prevattempts=
4749: &start_data_table().&start_data_table_row().
4750: '<td>'.&mt('No data.').'</td>'.
4751: &end_data_table_row().&end_data_table();
1.1 albertel 4752: }
1.10 albertel 4753: }
4754:
1.581 albertel 4755: sub format_previous_attempt_value {
4756: my ($key,$value) = @_;
1.1011 www 4757: if (($key =~ /timestamp/) || ($key=~/duedate/)) {
1.1173 kruse 4758: $value = &Apache::lonlocal::locallocaltime($value);
1.581 albertel 4759: } elsif (ref($value) eq 'ARRAY') {
1.1173 kruse 4760: $value = &HTML::Entities::encode('('.join(', ', @{ $value }).')','"<>&');
1.988 raeburn 4761: } elsif ($key =~ /answerstring$/) {
4762: my %answers = &Apache::lonnet::str2hash($value);
1.1173 kruse 4763: my @answer = %answers;
4764: %answers = map {&HTML::Entities::encode($_, '"<>&')} @answer;
1.988 raeburn 4765: my @anskeys = sort(keys(%answers));
4766: if (@anskeys == 1) {
4767: my $answer = $answers{$anskeys[0]};
1.1001 raeburn 4768: if ($answer =~ m{\0}) {
4769: $answer =~ s{\0}{,}g;
1.988 raeburn 4770: }
4771: my $tag_internal_answer_name = 'INTERNAL';
4772: if ($anskeys[0] eq $tag_internal_answer_name) {
4773: $value = $answer;
4774: } else {
4775: $value = $anskeys[0].'='.$answer;
4776: }
4777: } else {
4778: foreach my $ans (@anskeys) {
4779: my $answer = $answers{$ans};
1.1001 raeburn 4780: if ($answer =~ m{\0}) {
4781: $answer =~ s{\0}{,}g;
1.988 raeburn 4782: }
4783: $value .= $ans.'='.$answer.'<br />';;
4784: }
4785: }
1.581 albertel 4786: } else {
1.1173 kruse 4787: $value = &HTML::Entities::encode(&unescape($value), '"<>&');
1.581 albertel 4788: }
4789: return $value;
4790: }
4791:
4792:
1.107 albertel 4793: sub relative_to_absolute {
4794: my ($url,$output)=@_;
4795: my $parser=HTML::TokeParser->new(\$output);
4796: my $token;
4797: my $thisdir=$url;
4798: my @rlinks=();
4799: while ($token=$parser->get_token) {
4800: if ($token->[0] eq 'S') {
4801: if ($token->[1] eq 'a') {
4802: if ($token->[2]->{'href'}) {
4803: $rlinks[$#rlinks+1]=$token->[2]->{'href'};
4804: }
4805: } elsif ($token->[1] eq 'img' || $token->[1] eq 'embed' ) {
4806: $rlinks[$#rlinks+1]=$token->[2]->{'src'};
4807: } elsif ($token->[1] eq 'base') {
4808: $thisdir=$token->[2]->{'href'};
4809: }
4810: }
4811: }
4812: $thisdir=~s-/[^/]*$--;
1.356 albertel 4813: foreach my $link (@rlinks) {
1.726 raeburn 4814: unless (($link=~/^https?\:\/\//i) ||
1.356 albertel 4815: ($link=~/^\//) ||
4816: ($link=~/^javascript:/i) ||
4817: ($link=~/^mailto:/i) ||
4818: ($link=~/^\#/)) {
4819: my $newlocation=&Apache::lonnet::hreflocation($thisdir,$link);
4820: $output=~s/(\"|\'|\=\s*)\Q$link\E(\"|\'|\s|\>)/$1$newlocation$2/;
1.107 albertel 4821: }
4822: }
4823: # -------------------------------------------------- Deal with Applet codebases
4824: $output=~s/(\<applet[^\>]+)(codebase\=[^\S\>]+)*([^\>]*)\>/$1.($2?$2:' codebase="'.$thisdir.'"').$3.'>'/gei;
4825: return $output;
4826: }
4827:
1.112 bowersj2 4828: =pod
4829:
1.648 raeburn 4830: =item * &get_student_view()
1.112 bowersj2 4831:
4832: show a snapshot of what student was looking at
4833:
4834: =cut
4835:
1.10 albertel 4836: sub get_student_view {
1.186 albertel 4837: my ($symb,$username,$domain,$courseid,$target,$moreenv) = @_;
1.114 www 4838: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186 albertel 4839: my (%form);
1.10 albertel 4840: my @elements=('symb','courseid','domain','username');
4841: foreach my $element (@elements) {
1.186 albertel 4842: $form{'grade_'.$element}=eval '$'.$element #'
1.10 albertel 4843: }
1.186 albertel 4844: if (defined($moreenv)) {
4845: %form=(%form,%{$moreenv});
4846: }
1.236 albertel 4847: if (defined($target)) { $form{'grade_target'} = $target; }
1.107 albertel 4848: $feedurl=&Apache::lonnet::clutter($feedurl);
1.1306 raeburn 4849: if (($feedurl =~ /ext\.tool$/) && ($target eq 'tex')) {
4850: $feedurl =~ s{^/adm/wrapper}{};
4851: }
1.650 www 4852: my ($userview,$response)=&Apache::lonnet::ssi_body($feedurl,%form);
1.11 albertel 4853: $userview=~s/\<body[^\>]*\>//gi;
4854: $userview=~s/\<\/body\>//gi;
4855: $userview=~s/\<html\>//gi;
4856: $userview=~s/\<\/html\>//gi;
4857: $userview=~s/\<head\>//gi;
4858: $userview=~s/\<\/head\>//gi;
4859: $userview=~s/action\s*\=/would_be_action\=/gi;
1.107 albertel 4860: $userview=&relative_to_absolute($feedurl,$userview);
1.650 www 4861: if (wantarray) {
4862: return ($userview,$response);
4863: } else {
4864: return $userview;
4865: }
4866: }
4867:
4868: sub get_student_view_with_retries {
4869: my ($symb,$retries,$username,$domain,$courseid,$target,$moreenv) = @_;
4870:
4871: my $ok = 0; # True if we got a good response.
4872: my $content;
4873: my $response;
4874:
4875: # Try to get the student_view done. within the retries count:
4876:
4877: do {
4878: ($content, $response) = &get_student_view($symb,$username,$domain,$courseid,$target,$moreenv);
4879: $ok = $response->is_success;
4880: if (!$ok) {
4881: &Apache::lonnet::logthis("Failed get_student_view_with_retries on $symb: ".$response->is_success.', '.$response->code.', '.$response->message);
4882: }
4883: $retries--;
4884: } while (!$ok && ($retries > 0));
4885:
4886: if (!$ok) {
4887: $content = ''; # On error return an empty content.
4888: }
1.651 www 4889: if (wantarray) {
4890: return ($content, $response);
4891: } else {
4892: return $content;
4893: }
1.11 albertel 4894: }
4895:
1.1349 raeburn 4896: sub css_links {
4897: my ($currsymb,$level) = @_;
4898: my ($links,@symbs,%cssrefs,%httpref);
4899: if ($level eq 'map') {
4900: my $navmap = Apache::lonnavmaps::navmap->new();
4901: if (ref($navmap)) {
4902: my ($map,undef,$url)=&Apache::lonnet::decode_symb($currsymb);
4903: my @resources = $navmap->retrieveResources($map,sub { $_[0]->is_problem() },0,0);
4904: foreach my $res (@resources) {
4905: if (ref($res) && $res->symb()) {
4906: push(@symbs,$res->symb());
4907: }
4908: }
4909: }
4910: } else {
4911: @symbs = ($currsymb);
4912: }
4913: foreach my $symb (@symbs) {
4914: my $css_href = &Apache::lonnet::EXT('resource.0.cssfile',$symb);
4915: if ($css_href =~ /\S/) {
4916: unless ($css_href =~ m{https?://}) {
4917: my $url = (&Apache::lonnet::decode_symb($symb))[-1];
4918: my $proburl = &Apache::lonnet::clutter($url);
4919: my ($probdir) = ($proburl =~ m{(.+)/[^/]+$});
4920: unless ($css_href =~ m{^/}) {
4921: $css_href = &Apache::lonnet::hreflocation($probdir,$css_href);
4922: }
4923: if ($css_href =~ m{^/(res|uploaded)/}) {
4924: unless (($httpref{'httpref.'.$css_href}) ||
4925: (&Apache::lonnet::is_on_map($css_href))) {
4926: my $thisurl = $proburl;
4927: if ($env{'httpref.'.$proburl}) {
4928: $thisurl = $env{'httpref.'.$proburl};
4929: }
4930: $httpref{'httpref.'.$css_href} = $thisurl;
4931: }
4932: }
4933: }
4934: $cssrefs{$css_href} = 1;
4935: }
4936: }
4937: if (keys(%httpref)) {
4938: &Apache::lonnet::appenv(\%httpref);
4939: }
4940: if (keys(%cssrefs)) {
4941: foreach my $css_href (keys(%cssrefs)) {
4942: next unless ($css_href =~ m{^(/res/|/uploaded/|https?://)});
4943: $links .= '<link rel="stylesheet" type="text/css" href="'.$css_href.'" />'."\n";
4944: }
4945: }
4946: return $links;
4947: }
4948:
1.112 bowersj2 4949: =pod
4950:
1.648 raeburn 4951: =item * &get_student_answers()
1.112 bowersj2 4952:
4953: show a snapshot of how student was answering problem
4954:
4955: =cut
4956:
1.11 albertel 4957: sub get_student_answers {
1.100 sakharuk 4958: my ($symb,$username,$domain,$courseid,%form) = @_;
1.114 www 4959: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186 albertel 4960: my (%moreenv);
1.11 albertel 4961: my @elements=('symb','courseid','domain','username');
4962: foreach my $element (@elements) {
1.186 albertel 4963: $moreenv{'grade_'.$element}=eval '$'.$element #'
1.10 albertel 4964: }
1.186 albertel 4965: $moreenv{'grade_target'}='answer';
4966: %moreenv=(%form,%moreenv);
1.497 raeburn 4967: $feedurl = &Apache::lonnet::clutter($feedurl);
4968: my $userview=&Apache::lonnet::ssi($feedurl,%moreenv);
1.10 albertel 4969: return $userview;
1.1 albertel 4970: }
1.116 albertel 4971:
4972: =pod
4973:
4974: =item * &submlink()
4975:
1.242 albertel 4976: Inputs: $text $uname $udom $symb $target
1.116 albertel 4977:
4978: Returns: A link to grades.pm such as to see the SUBM view of a student
4979:
4980: =cut
4981:
4982: ###############################################
4983: sub submlink {
1.242 albertel 4984: my ($text,$uname,$udom,$symb,$target)=@_;
1.116 albertel 4985: if (!($uname && $udom)) {
4986: (my $cursymb, my $courseid,$udom,$uname)=
1.463 albertel 4987: &Apache::lonnet::whichuser($symb);
1.116 albertel 4988: if (!$symb) { $symb=$cursymb; }
4989: }
1.254 matthew 4990: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369 www 4991: $symb=&escape($symb);
1.960 bisitz 4992: if ($target) { $target=" target=\"$target\""; }
4993: return
4994: '<a href="/adm/grades?command=submission'.
4995: '&symb='.$symb.
4996: '&student='.$uname.
4997: '&userdom='.$udom.'"'.
4998: $target.'>'.$text.'</a>';
1.242 albertel 4999: }
5000: ##############################################
5001:
5002: =pod
5003:
5004: =item * &pgrdlink()
5005:
5006: Inputs: $text $uname $udom $symb $target
5007:
5008: Returns: A link to grades.pm such as to see the PGRD view of a student
5009:
5010: =cut
5011:
5012: ###############################################
5013: sub pgrdlink {
5014: my $link=&submlink(@_);
5015: $link=~s/(&command=submission)/$1&showgrading=yes/;
5016: return $link;
5017: }
5018: ##############################################
5019:
5020: =pod
5021:
5022: =item * &pprmlink()
5023:
5024: Inputs: $text $uname $udom $symb $target
5025:
5026: Returns: A link to parmset.pm such as to see the PPRM view of a
1.283 albertel 5027: student and a specific resource
1.242 albertel 5028:
5029: =cut
5030:
5031: ###############################################
5032: sub pprmlink {
5033: my ($text,$uname,$udom,$symb,$target)=@_;
5034: if (!($uname && $udom)) {
5035: (my $cursymb, my $courseid,$udom,$uname)=
1.463 albertel 5036: &Apache::lonnet::whichuser($symb);
1.242 albertel 5037: if (!$symb) { $symb=$cursymb; }
5038: }
1.254 matthew 5039: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369 www 5040: $symb=&escape($symb);
1.242 albertel 5041: if ($target) { $target="target=\"$target\""; }
1.595 albertel 5042: return '<a href="/adm/parmset?command=set&'.
5043: 'symb='.$symb.'&uname='.$uname.
5044: '&udom='.$udom.'" '.$target.'>'.$text.'</a>';
1.116 albertel 5045: }
5046: ##############################################
1.37 matthew 5047:
1.112 bowersj2 5048: =pod
5049:
5050: =back
5051:
5052: =cut
5053:
1.37 matthew 5054: ###############################################
1.51 www 5055:
5056:
5057: sub timehash {
1.687 raeburn 5058: my ($thistime) = @_;
5059: my $timezone = &Apache::lonlocal::gettimezone();
5060: my $dt = DateTime->from_epoch(epoch => $thistime)
5061: ->set_time_zone($timezone);
5062: my $wday = $dt->day_of_week();
5063: if ($wday == 7) { $wday = 0; }
5064: return ( 'second' => $dt->second(),
5065: 'minute' => $dt->minute(),
5066: 'hour' => $dt->hour(),
5067: 'day' => $dt->day_of_month(),
5068: 'month' => $dt->month(),
5069: 'year' => $dt->year(),
5070: 'weekday' => $wday,
5071: 'dayyear' => $dt->day_of_year(),
5072: 'dlsav' => $dt->is_dst() );
1.51 www 5073: }
5074:
1.370 www 5075: sub utc_string {
5076: my ($date)=@_;
1.371 www 5077: return strftime("%Y%m%dT%H%M%SZ",gmtime($date));
1.370 www 5078: }
5079:
1.51 www 5080: sub maketime {
5081: my %th=@_;
1.687 raeburn 5082: my ($epoch_time,$timezone,$dt);
5083: $timezone = &Apache::lonlocal::gettimezone();
5084: eval {
5085: $dt = DateTime->new( year => $th{'year'},
5086: month => $th{'month'},
5087: day => $th{'day'},
5088: hour => $th{'hour'},
5089: minute => $th{'minute'},
5090: second => $th{'second'},
5091: time_zone => $timezone,
5092: );
5093: };
5094: if (!$@) {
5095: $epoch_time = $dt->epoch;
5096: if ($epoch_time) {
5097: return $epoch_time;
5098: }
5099: }
1.51 www 5100: return POSIX::mktime(
5101: ($th{'seconds'},$th{'minutes'},$th{'hours'},
1.210 www 5102: $th{'day'},$th{'month'}-1,$th{'year'}-1900,0,0,-1));
1.70 www 5103: }
5104:
5105: #########################################
1.51 www 5106:
5107: sub findallcourses {
1.482 raeburn 5108: my ($roles,$uname,$udom) = @_;
1.355 albertel 5109: my %roles;
5110: if (ref($roles)) { %roles = map { $_ => 1 } @{$roles}; }
1.348 albertel 5111: my %courses;
1.51 www 5112: my $now=time;
1.482 raeburn 5113: if (!defined($uname)) {
5114: $uname = $env{'user.name'};
5115: }
5116: if (!defined($udom)) {
5117: $udom = $env{'user.domain'};
5118: }
5119: if (($uname ne $env{'user.name'}) || ($udom ne $env{'user.domain'})) {
1.1073 raeburn 5120: my %roleshash = &Apache::lonnet::dump('roles',$udom,$uname);
1.482 raeburn 5121: if (!%roles) {
5122: %roles = (
5123: cc => 1,
1.907 raeburn 5124: co => 1,
1.482 raeburn 5125: in => 1,
5126: ep => 1,
5127: ta => 1,
5128: cr => 1,
5129: st => 1,
5130: );
5131: }
5132: foreach my $entry (keys(%roleshash)) {
5133: my ($trole,$tend,$tstart) = split(/_/,$roleshash{$entry});
5134: if ($trole =~ /^cr/) {
5135: next if (!exists($roles{$trole}) && !exists($roles{'cr'}));
5136: } else {
5137: next if (!exists($roles{$trole}));
5138: }
5139: if ($tend) {
5140: next if ($tend < $now);
5141: }
5142: if ($tstart) {
5143: next if ($tstart > $now);
5144: }
1.1058 raeburn 5145: my ($cdom,$cnum,$sec,$cnumpart,$secpart,$role);
1.482 raeburn 5146: (undef,$cdom,$cnumpart,$secpart) = split(/\//,$entry);
1.1058 raeburn 5147: my $value = $trole.'/'.$cdom.'/';
1.482 raeburn 5148: if ($secpart eq '') {
5149: ($cnum,$role) = split(/_/,$cnumpart);
5150: $sec = 'none';
1.1058 raeburn 5151: $value .= $cnum.'/';
1.482 raeburn 5152: } else {
5153: $cnum = $cnumpart;
5154: ($sec,$role) = split(/_/,$secpart);
1.1058 raeburn 5155: $value .= $cnum.'/'.$sec;
5156: }
5157: if (ref($courses{$cdom.'_'.$cnum}{$sec}) eq 'ARRAY') {
5158: unless (grep(/^\Q$value\E$/,@{$courses{$cdom.'_'.$cnum}{$sec}})) {
5159: push(@{$courses{$cdom.'_'.$cnum}{$sec}},$value);
5160: }
5161: } else {
5162: @{$courses{$cdom.'_'.$cnum}{$sec}} = ($value);
1.490 raeburn 5163: }
1.482 raeburn 5164: }
5165: } else {
5166: foreach my $key (keys(%env)) {
1.483 albertel 5167: if ( $key=~m{^user\.role\.(\w+)\./($match_domain)/($match_courseid)/?(\w*)$} ||
5168: $key=~m{^user\.role\.(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_courseid)/?(\w*)$}) {
1.482 raeburn 5169: my ($role,$cdom,$cnum,$sec) = ($1,$2,$3,$4);
5170: next if ($role eq 'ca' || $role eq 'aa');
5171: next if (%roles && !exists($roles{$role}));
5172: my ($starttime,$endtime)=split(/\./,$env{$key});
5173: my $active=1;
5174: if ($starttime) {
5175: if ($now<$starttime) { $active=0; }
5176: }
5177: if ($endtime) {
5178: if ($now>$endtime) { $active=0; }
5179: }
5180: if ($active) {
1.1058 raeburn 5181: my $value = $role.'/'.$cdom.'/'.$cnum.'/';
1.482 raeburn 5182: if ($sec eq '') {
5183: $sec = 'none';
1.1058 raeburn 5184: } else {
5185: $value .= $sec;
5186: }
5187: if (ref($courses{$cdom.'_'.$cnum}{$sec}) eq 'ARRAY') {
5188: unless (grep(/^\Q$value\E$/,@{$courses{$cdom.'_'.$cnum}{$sec}})) {
5189: push(@{$courses{$cdom.'_'.$cnum}{$sec}},$value);
5190: }
5191: } else {
5192: @{$courses{$cdom.'_'.$cnum}{$sec}} = ($value);
1.482 raeburn 5193: }
1.474 raeburn 5194: }
5195: }
1.51 www 5196: }
5197: }
1.474 raeburn 5198: return %courses;
1.51 www 5199: }
1.37 matthew 5200:
1.54 www 5201: ###############################################
1.474 raeburn 5202:
5203: sub blockcheck {
1.1347 raeburn 5204: my ($setters,$activity,$uname,$udom,$url,$is_course,$symb,$caller) = @_;
1.490 raeburn 5205:
1.1189 raeburn 5206: if (defined($udom) && defined($uname)) {
5207: # If uname and udom are for a course, check for blocks in the course.
5208: if (($is_course) || (&Apache::lonnet::is_course($udom,$uname))) {
5209: my ($startblock,$endblock,$triggerblock) =
1.1347 raeburn 5210: &get_blocks($setters,$activity,$udom,$uname,$url,$symb,$caller);
1.1189 raeburn 5211: return ($startblock,$endblock,$triggerblock);
5212: }
5213: } else {
1.490 raeburn 5214: $udom = $env{'user.domain'};
5215: $uname = $env{'user.name'};
5216: }
5217:
1.502 raeburn 5218: my $startblock = 0;
5219: my $endblock = 0;
1.1062 raeburn 5220: my $triggerblock = '';
1.482 raeburn 5221: my %live_courses = &findallcourses(undef,$uname,$udom);
1.474 raeburn 5222:
1.490 raeburn 5223: # If uname is for a user, and activity is course-specific, i.e.,
5224: # boards, chat or groups, check for blocking in current course only.
1.474 raeburn 5225:
1.490 raeburn 5226: if (($activity eq 'boards' || $activity eq 'chat' ||
1.1282 raeburn 5227: $activity eq 'groups' || $activity eq 'printout' ||
1.1346 raeburn 5228: $activity eq 'search' || $activity eq 'reinit' ||
5229: $activity eq 'alert') &&
1.1189 raeburn 5230: ($env{'request.course.id'})) {
1.490 raeburn 5231: foreach my $key (keys(%live_courses)) {
5232: if ($key ne $env{'request.course.id'}) {
5233: delete($live_courses{$key});
5234: }
5235: }
5236: }
5237:
5238: my $otheruser = 0;
5239: my %own_courses;
5240: if ((($uname ne $env{'user.name'})) || ($udom ne $env{'user.domain'})) {
5241: # Resource belongs to user other than current user.
5242: $otheruser = 1;
5243: # Gather courses for current user
5244: %own_courses =
5245: &findallcourses(undef,$env{'user.name'},$env{'user.domain'});
5246: }
5247:
5248: # Gather active course roles - course coordinator, instructor,
5249: # exam proctor, ta, student, or custom role.
1.474 raeburn 5250:
5251: foreach my $course (keys(%live_courses)) {
1.482 raeburn 5252: my ($cdom,$cnum);
5253: if ((defined($env{'course.'.$course.'.domain'})) && (defined($env{'course.'.$course.'.num'}))) {
5254: $cdom = $env{'course.'.$course.'.domain'};
5255: $cnum = $env{'course.'.$course.'.num'};
5256: } else {
1.490 raeburn 5257: ($cdom,$cnum) = split(/_/,$course);
1.482 raeburn 5258: }
5259: my $no_ownblock = 0;
5260: my $no_userblock = 0;
1.533 raeburn 5261: if ($otheruser && $activity ne 'com') {
1.490 raeburn 5262: # Check if current user has 'evb' priv for this
5263: if (defined($own_courses{$course})) {
5264: foreach my $sec (keys(%{$own_courses{$course}})) {
5265: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
5266: if ($sec ne 'none') {
5267: $checkrole .= '/'.$sec;
5268: }
5269: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
5270: $no_ownblock = 1;
5271: last;
5272: }
5273: }
5274: }
5275: # if they have 'evb' priv and are currently not playing student
5276: next if (($no_ownblock) &&
5277: ($env{'request.role'} !~ m{^st\./$cdom/$cnum}));
5278: }
1.474 raeburn 5279: foreach my $sec (keys(%{$live_courses{$course}})) {
1.482 raeburn 5280: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
1.474 raeburn 5281: if ($sec ne 'none') {
1.482 raeburn 5282: $checkrole .= '/'.$sec;
1.474 raeburn 5283: }
1.490 raeburn 5284: if ($otheruser) {
5285: # Resource belongs to user other than current user.
5286: # Assemble privs for that user, and check for 'evb' priv.
1.1058 raeburn 5287: my (%allroles,%userroles);
5288: if (ref($live_courses{$course}{$sec}) eq 'ARRAY') {
5289: foreach my $entry (@{$live_courses{$course}{$sec}}) {
5290: my ($trole,$tdom,$tnum,$tsec);
5291: if ($entry =~ /^cr/) {
5292: ($trole,$tdom,$tnum,$tsec) =
5293: ($entry =~ m|^(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_username)/?(\w*)$|);
5294: } else {
5295: ($trole,$tdom,$tnum,$tsec) = split(/\//,$entry);
5296: }
5297: my ($spec,$area,$trest);
5298: $area = '/'.$tdom.'/'.$tnum;
5299: $trest = $tnum;
5300: if ($tsec ne '') {
5301: $area .= '/'.$tsec;
5302: $trest .= '/'.$tsec;
5303: }
5304: $spec = $trole.'.'.$area;
5305: if ($trole =~ /^cr/) {
5306: &Apache::lonnet::custom_roleprivs(\%allroles,$trole,
5307: $tdom,$spec,$trest,$area);
5308: } else {
5309: &Apache::lonnet::standard_roleprivs(\%allroles,$trole,
5310: $tdom,$spec,$trest,$area);
5311: }
5312: }
1.1276 raeburn 5313: my ($author,$adv,$rar) = &Apache::lonnet::set_userprivs(\%userroles,\%allroles);
1.1058 raeburn 5314: if ($userroles{'user.priv.'.$checkrole} =~ /evb\&([^\:]*)/) {
5315: if ($1) {
5316: $no_userblock = 1;
5317: last;
5318: }
1.486 raeburn 5319: }
5320: }
1.490 raeburn 5321: } else {
5322: # Resource belongs to current user
5323: # Check for 'evb' priv via lonnet::allowed().
1.482 raeburn 5324: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
5325: $no_ownblock = 1;
5326: last;
5327: }
1.474 raeburn 5328: }
5329: }
5330: # if they have the evb priv and are currently not playing student
1.482 raeburn 5331: next if (($no_ownblock) &&
1.491 albertel 5332: ($env{'request.role'} !~ m{^st\./\Q$cdom\E/\Q$cnum\E}));
1.482 raeburn 5333: next if ($no_userblock);
1.474 raeburn 5334:
1.1303 raeburn 5335: # Retrieve blocking times and identity of blocker for course
1.490 raeburn 5336: # of specified user, unless user has 'evb' privilege.
1.1284 raeburn 5337:
1.1062 raeburn 5338: my ($start,$end,$trigger) =
1.1347 raeburn 5339: &get_blocks($setters,$activity,$cdom,$cnum,$url,$symb,$caller);
1.502 raeburn 5340: if (($start != 0) &&
5341: (($startblock == 0) || ($startblock > $start))) {
5342: $startblock = $start;
1.1062 raeburn 5343: if ($trigger ne '') {
5344: $triggerblock = $trigger;
5345: }
1.502 raeburn 5346: }
5347: if (($end != 0) &&
5348: (($endblock == 0) || ($endblock < $end))) {
5349: $endblock = $end;
1.1062 raeburn 5350: if ($trigger ne '') {
5351: $triggerblock = $trigger;
5352: }
1.502 raeburn 5353: }
1.490 raeburn 5354: }
1.1062 raeburn 5355: return ($startblock,$endblock,$triggerblock);
1.490 raeburn 5356: }
5357:
5358: sub get_blocks {
1.1347 raeburn 5359: my ($setters,$activity,$cdom,$cnum,$url,$symb,$caller) = @_;
1.490 raeburn 5360: my $startblock = 0;
5361: my $endblock = 0;
1.1062 raeburn 5362: my $triggerblock = '';
1.490 raeburn 5363: my $course = $cdom.'_'.$cnum;
5364: $setters->{$course} = {};
5365: $setters->{$course}{'staff'} = [];
5366: $setters->{$course}{'times'} = [];
1.1062 raeburn 5367: $setters->{$course}{'triggers'} = [];
5368: my (@blockers,%triggered);
5369: my $now = time;
5370: my %commblocks = &Apache::lonnet::get_comm_blocks($cdom,$cnum);
5371: if ($activity eq 'docs') {
1.1348 raeburn 5372: my ($blocked,$nosymbcache,$noenccheck);
1.1347 raeburn 5373: if (($caller eq 'blockedaccess') || ($caller eq 'blockingstatus')) {
5374: $blocked = 1;
5375: $nosymbcache = 1;
1.1348 raeburn 5376: $noenccheck = 1;
1.1347 raeburn 5377: }
1.1348 raeburn 5378: @blockers = &Apache::lonnet::has_comm_blocking('bre',$symb,$url,$nosymbcache,$noenccheck,$blocked,\%commblocks);
1.1062 raeburn 5379: foreach my $block (@blockers) {
5380: if ($block =~ /^firstaccess____(.+)$/) {
5381: my $item = $1;
5382: my $type = 'map';
5383: my $timersymb = $item;
5384: if ($item eq 'course') {
5385: $type = 'course';
5386: } elsif ($item =~ /___\d+___/) {
5387: $type = 'resource';
5388: } else {
5389: $timersymb = &Apache::lonnet::symbread($item);
5390: }
5391: my $start = $env{'course.'.$cdom.'_'.$cnum.'.firstaccess.'.$timersymb};
5392: my $end = $start + $env{'course.'.$cdom.'_'.$cnum.'.timerinterval.'.$timersymb};
5393: $triggered{$block} = {
5394: start => $start,
5395: end => $end,
5396: type => $type,
5397: };
5398: }
5399: }
5400: } else {
5401: foreach my $block (keys(%commblocks)) {
5402: if ($block =~ m/^(\d+)____(\d+)$/) {
5403: my ($start,$end) = ($1,$2);
5404: if ($start <= time && $end >= time) {
5405: if (ref($commblocks{$block}) eq 'HASH') {
5406: if (ref($commblocks{$block}{'blocks'}) eq 'HASH') {
5407: if ($commblocks{$block}{'blocks'}{$activity} eq 'on') {
5408: unless(grep(/^\Q$block\E$/,@blockers)) {
5409: push(@blockers,$block);
5410: }
5411: }
5412: }
5413: }
5414: }
5415: } elsif ($block =~ /^firstaccess____(.+)$/) {
5416: my $item = $1;
5417: my $timersymb = $item;
5418: my $type = 'map';
5419: if ($item eq 'course') {
5420: $type = 'course';
5421: } elsif ($item =~ /___\d+___/) {
5422: $type = 'resource';
5423: } else {
5424: $timersymb = &Apache::lonnet::symbread($item);
5425: }
5426: my $start = $env{'course.'.$cdom.'_'.$cnum.'.firstaccess.'.$timersymb};
5427: my $end = $start + $env{'course.'.$cdom.'_'.$cnum.'.timerinterval.'.$timersymb};
5428: if ($start && $end) {
5429: if (($start <= time) && ($end >= time)) {
1.1281 raeburn 5430: if (ref($commblocks{$block}) eq 'HASH') {
5431: if (ref($commblocks{$block}{'blocks'}) eq 'HASH') {
5432: if ($commblocks{$block}{'blocks'}{$activity} eq 'on') {
5433: unless(grep(/^\Q$block\E$/,@blockers)) {
5434: push(@blockers,$block);
5435: $triggered{$block} = {
5436: start => $start,
5437: end => $end,
5438: type => $type,
5439: };
5440: }
5441: }
5442: }
1.1062 raeburn 5443: }
5444: }
1.490 raeburn 5445: }
1.1062 raeburn 5446: }
5447: }
5448: }
5449: foreach my $blocker (@blockers) {
5450: my ($staff_name,$staff_dom,$title,$blocks) =
5451: &parse_block_record($commblocks{$blocker});
5452: push(@{$$setters{$course}{'staff'}},[$staff_name,$staff_dom]);
5453: my ($start,$end,$triggertype);
5454: if ($blocker =~ m/^(\d+)____(\d+)$/) {
5455: ($start,$end) = ($1,$2);
5456: } elsif (ref($triggered{$blocker}) eq 'HASH') {
5457: $start = $triggered{$blocker}{'start'};
5458: $end = $triggered{$blocker}{'end'};
5459: $triggertype = $triggered{$blocker}{'type'};
5460: }
5461: if ($start) {
5462: push(@{$$setters{$course}{'times'}}, [$start,$end]);
5463: if ($triggertype) {
5464: push(@{$$setters{$course}{'triggers'}},$triggertype);
5465: } else {
5466: push(@{$$setters{$course}{'triggers'}},0);
5467: }
5468: if ( ($startblock == 0) || ($startblock > $start) ) {
5469: $startblock = $start;
5470: if ($triggertype) {
5471: $triggerblock = $blocker;
1.474 raeburn 5472: }
5473: }
1.1062 raeburn 5474: if ( ($endblock == 0) || ($endblock < $end) ) {
5475: $endblock = $end;
5476: if ($triggertype) {
5477: $triggerblock = $blocker;
5478: }
5479: }
1.474 raeburn 5480: }
5481: }
1.1062 raeburn 5482: return ($startblock,$endblock,$triggerblock);
1.474 raeburn 5483: }
5484:
5485: sub parse_block_record {
5486: my ($record) = @_;
5487: my ($setuname,$setudom,$title,$blocks);
5488: if (ref($record) eq 'HASH') {
5489: ($setuname,$setudom) = split(/:/,$record->{'setter'});
5490: $title = &unescape($record->{'event'});
5491: $blocks = $record->{'blocks'};
5492: } else {
5493: my @data = split(/:/,$record,3);
5494: if (scalar(@data) eq 2) {
5495: $title = $data[1];
5496: ($setuname,$setudom) = split(/@/,$data[0]);
5497: } else {
5498: ($setuname,$setudom,$title) = @data;
5499: }
5500: $blocks = { 'com' => 'on' };
5501: }
5502: return ($setuname,$setudom,$title,$blocks);
5503: }
5504:
1.854 kalberla 5505: sub blocking_status {
1.1347 raeburn 5506: my ($activity,$uname,$udom,$url,$is_course,$symb,$caller) = @_;
1.1061 raeburn 5507: my %setters;
1.890 droeschl 5508:
1.1061 raeburn 5509: # check for active blocking
1.1062 raeburn 5510: my ($startblock,$endblock,$triggerblock) =
1.1347 raeburn 5511: &blockcheck(\%setters,$activity,$uname,$udom,$url,$is_course,$symb,$caller);
1.1062 raeburn 5512: my $blocked = 0;
5513: if ($startblock && $endblock) {
5514: $blocked = 1;
5515: }
1.890 droeschl 5516:
1.1061 raeburn 5517: # caller just wants to know whether a block is active
5518: if (!wantarray) { return $blocked; }
5519:
5520: # build a link to a popup window containing the details
5521: my $querystring = "?activity=$activity";
1.1351 raeburn 5522: # $uname and $udom decide whose portfolio (or information page) the user is trying to look at
5523: if (($activity eq 'port') || ($activity eq 'about') || ($activity eq 'passwd')) {
1.1232 raeburn 5524: $querystring .= "&udom=$udom" if ($udom =~ /^$match_domain$/);
5525: $querystring .= "&uname=$uname" if ($uname =~ /^$match_username$/);
1.1062 raeburn 5526: } elsif ($activity eq 'docs') {
1.1347 raeburn 5527: my $showurl = &Apache::lonenc::check_encrypt($url);
5528: $querystring .= '&url='.&HTML::Entities::encode($showurl,'\'&"<>');
5529: if ($symb) {
5530: my $showsymb = &Apache::lonenc::check_encrypt($symb);
5531: $querystring .= '&symb='.&HTML::Entities::encode($showsymb,'\'&"<>');
5532: }
1.1062 raeburn 5533: }
1.1061 raeburn 5534:
5535: my $output .= <<'END_MYBLOCK';
5536: function openWindow(url, wdwName, w, h, toolbar,scrollbar) {
5537: var options = "width=" + w + ",height=" + h + ",";
5538: options += "resizable=yes,scrollbars="+scrollbar+",status=no,";
5539: options += "menubar=no,toolbar="+toolbar+",location=no,directories=no";
5540: var newWin = window.open(url, wdwName, options);
5541: newWin.focus();
5542: }
1.890 droeschl 5543: END_MYBLOCK
1.854 kalberla 5544:
1.1061 raeburn 5545: $output = Apache::lonhtmlcommon::scripttag($output);
1.890 droeschl 5546:
1.1061 raeburn 5547: my $popupUrl = "/adm/blockingstatus/$querystring";
1.1062 raeburn 5548: my $text = &mt('Communication Blocked');
1.1217 raeburn 5549: my $class = 'LC_comblock';
1.1062 raeburn 5550: if ($activity eq 'docs') {
5551: $text = &mt('Content Access Blocked');
1.1217 raeburn 5552: $class = '';
1.1063 raeburn 5553: } elsif ($activity eq 'printout') {
5554: $text = &mt('Printing Blocked');
1.1232 raeburn 5555: } elsif ($activity eq 'passwd') {
5556: $text = &mt('Password Changing Blocked');
1.1345 raeburn 5557: } elsif ($activity eq 'grades') {
5558: $text = &mt('Gradebook Blocked');
1.1346 raeburn 5559: } elsif ($activity eq 'search') {
5560: $text = &mt('Search Blocked');
1.1282 raeburn 5561: } elsif ($activity eq 'alert') {
5562: $text = &mt('Checking Critical Messages Blocked');
5563: } elsif ($activity eq 'reinit') {
5564: $text = &mt('Checking Course Update Blocked');
1.1351 raeburn 5565: } elsif ($activity eq 'about') {
5566: $text = &mt('Access to User Information Pages Blocked');
1.1062 raeburn 5567: }
1.1061 raeburn 5568: $output .= <<"END_BLOCK";
1.1217 raeburn 5569: <div class='$class'>
1.869 kalberla 5570: <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring'
1.890 droeschl 5571: title='$text'>
5572: <img class='LC_noBorder LC_middle' title='$text' src='/res/adm/pages/comblock.png' alt='$text'/></a>
1.869 kalberla 5573: <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring'
1.890 droeschl 5574: title='$text'>$text</a>
1.867 kalberla 5575: </div>
5576:
5577: END_BLOCK
1.474 raeburn 5578:
1.1061 raeburn 5579: return ($blocked, $output);
1.854 kalberla 5580: }
1.490 raeburn 5581:
1.60 matthew 5582: ###############################################
5583:
1.682 raeburn 5584: sub check_ip_acc {
1.1201 raeburn 5585: my ($acc,$clientip)=@_;
1.682 raeburn 5586: &Apache::lonxml::debug("acc is $acc");
5587: if (!defined($acc) || $acc =~ /^\s*$/ || $acc =~/^\s*no\s*$/i) {
5588: return 1;
5589: }
1.1339 raeburn 5590: my ($ip,$allowed);
5591: if (($ENV{'REMOTE_ADDR'} eq '127.0.0.1') ||
5592: ($ENV{'REMOTE_ADDR'} eq &Apache::lonnet::get_host_ip($Apache::lonnet::perlvar{'lonHostID'}))) {
5593: $ip = $env{'request.host'} || $ENV{'REMOTE_ADDR'} || $clientip;
5594: } else {
1.1350 raeburn 5595: my $remote_ip = &Apache::lonnet::get_requestor_ip();
5596: $ip = $remote_ip || $env{'request.host'} || $clientip;
1.1339 raeburn 5597: }
1.682 raeburn 5598:
5599: my $name;
1.1219 raeburn 5600: my %access = (
5601: allowfrom => 1,
5602: denyfrom => 0,
5603: );
5604: my @allows;
5605: my @denies;
5606: foreach my $item (split(',',$acc)) {
5607: $item =~ s/^\s*//;
5608: $item =~ s/\s*$//;
5609: my $pattern;
5610: if ($item =~ /^\!(.+)$/) {
5611: push(@denies,$1);
5612: } else {
5613: push(@allows,$item);
5614: }
5615: }
5616: my $numdenies = scalar(@denies);
5617: my $numallows = scalar(@allows);
5618: my $count = 0;
5619: foreach my $pattern (@denies,@allows) {
5620: $count ++;
5621: my $acctype = 'allowfrom';
5622: if ($count <= $numdenies) {
5623: $acctype = 'denyfrom';
5624: }
1.682 raeburn 5625: if ($pattern =~ /\*$/) {
5626: #35.8.*
5627: $pattern=~s/\*//;
1.1219 raeburn 5628: if ($ip =~ /^\Q$pattern\E/) { $allowed=$access{$acctype}; }
1.682 raeburn 5629: } elsif ($pattern =~ /(\d+\.\d+\.\d+)\.\[(\d+)-(\d+)\]$/) {
5630: #35.8.3.[34-56]
5631: my $low=$2;
5632: my $high=$3;
5633: $pattern=$1;
5634: if ($ip =~ /^\Q$pattern\E/) {
5635: my $last=(split(/\./,$ip))[3];
1.1219 raeburn 5636: if ($last <=$high && $last >=$low) { $allowed=$access{$acctype}; }
1.682 raeburn 5637: }
5638: } elsif ($pattern =~ /^\*/) {
5639: #*.msu.edu
5640: $pattern=~s/\*//;
5641: if (!defined($name)) {
5642: use Socket;
5643: my $netaddr=inet_aton($ip);
5644: ($name)=gethostbyaddr($netaddr,AF_INET);
5645: }
1.1219 raeburn 5646: if ($name =~ /\Q$pattern\E$/i) { $allowed=$access{$acctype}; }
1.682 raeburn 5647: } elsif ($pattern =~ /\d+\.\d+\.\d+\.\d+/) {
5648: #127.0.0.1
1.1219 raeburn 5649: if ($ip =~ /^\Q$pattern\E/) { $allowed=$access{$acctype}; }
1.682 raeburn 5650: } else {
5651: #some.name.com
5652: if (!defined($name)) {
5653: use Socket;
5654: my $netaddr=inet_aton($ip);
5655: ($name)=gethostbyaddr($netaddr,AF_INET);
5656: }
1.1219 raeburn 5657: if ($name =~ /\Q$pattern\E$/i) { $allowed=$access{$acctype}; }
5658: }
5659: if ($allowed =~ /^(0|1)$/) { last; }
5660: }
5661: if ($allowed eq '') {
5662: if ($numdenies && !$numallows) {
5663: $allowed = 1;
5664: } else {
5665: $allowed = 0;
1.682 raeburn 5666: }
5667: }
5668: return $allowed;
5669: }
5670:
5671: ###############################################
5672:
1.60 matthew 5673: =pod
5674:
1.112 bowersj2 5675: =head1 Domain Template Functions
5676:
5677: =over 4
5678:
5679: =item * &determinedomain()
1.60 matthew 5680:
5681: Inputs: $domain (usually will be undef)
5682:
1.63 www 5683: Returns: Determines which domain should be used for designs
1.60 matthew 5684:
5685: =cut
1.54 www 5686:
1.60 matthew 5687: ###############################################
1.63 www 5688: sub determinedomain {
5689: my $domain=shift;
1.531 albertel 5690: if (! $domain) {
1.60 matthew 5691: # Determine domain if we have not been given one
1.893 raeburn 5692: $domain = &Apache::lonnet::default_login_domain();
1.258 albertel 5693: if ($env{'user.domain'}) { $domain=$env{'user.domain'}; }
5694: if ($env{'request.role.domain'}) {
5695: $domain=$env{'request.role.domain'};
1.60 matthew 5696: }
5697: }
1.63 www 5698: return $domain;
5699: }
5700: ###############################################
1.517 raeburn 5701:
1.518 albertel 5702: sub devalidate_domconfig_cache {
5703: my ($udom)=@_;
5704: &Apache::lonnet::devalidate_cache_new('domainconfig',$udom);
5705: }
5706:
5707: # ---------------------- Get domain configuration for a domain
5708: sub get_domainconf {
5709: my ($udom) = @_;
5710: my $cachetime=1800;
5711: my ($result,$cached)=&Apache::lonnet::is_cached_new('domainconfig',$udom);
5712: if (defined($cached)) { return %{$result}; }
5713:
5714: my %domconfig = &Apache::lonnet::get_dom('configuration',
1.948 raeburn 5715: ['login','rolecolors','autoenroll'],$udom);
1.632 raeburn 5716: my (%designhash,%legacy);
1.518 albertel 5717: if (keys(%domconfig) > 0) {
5718: if (ref($domconfig{'login'}) eq 'HASH') {
1.632 raeburn 5719: if (keys(%{$domconfig{'login'}})) {
5720: foreach my $key (keys(%{$domconfig{'login'}})) {
1.699 raeburn 5721: if (ref($domconfig{'login'}{$key}) eq 'HASH') {
1.1208 raeburn 5722: if (($key eq 'loginvia') || ($key eq 'headtag')) {
5723: if (ref($domconfig{'login'}{$key}) eq 'HASH') {
5724: foreach my $hostname (keys(%{$domconfig{'login'}{$key}})) {
5725: if (ref($domconfig{'login'}{$key}{$hostname}) eq 'HASH') {
5726: if ($key eq 'loginvia') {
5727: if ($domconfig{'login'}{'loginvia'}{$hostname}{'server'}) {
5728: my $server = $domconfig{'login'}{'loginvia'}{$hostname}{'server'};
5729: $designhash{$udom.'.login.loginvia'} = $server;
5730: if ($domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'} eq 'custom') {
5731:
5732: $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'custompath'};
5733: } else {
5734: $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'};
5735: }
1.948 raeburn 5736: }
1.1208 raeburn 5737: } elsif ($key eq 'headtag') {
5738: if ($domconfig{'login'}{'headtag'}{$hostname}{'url'}) {
5739: $designhash{$udom.'.login.headtag_'.$hostname} = $domconfig{'login'}{'headtag'}{$hostname}{'url'};
1.948 raeburn 5740: }
1.946 raeburn 5741: }
1.1208 raeburn 5742: if ($domconfig{'login'}{$key}{$hostname}{'exempt'}) {
5743: $designhash{$udom.'.login.'.$key.'_exempt_'.$hostname} = $domconfig{'login'}{$key}{$hostname}{'exempt'};
5744: }
1.946 raeburn 5745: }
5746: }
5747: }
5748: } else {
5749: foreach my $img (keys(%{$domconfig{'login'}{$key}})) {
5750: $designhash{$udom.'.login.'.$key.'_'.$img} =
5751: $domconfig{'login'}{$key}{$img};
5752: }
1.699 raeburn 5753: }
5754: } else {
5755: $designhash{$udom.'.login.'.$key}=$domconfig{'login'}{$key};
5756: }
1.632 raeburn 5757: }
5758: } else {
5759: $legacy{'login'} = 1;
1.518 albertel 5760: }
1.632 raeburn 5761: } else {
5762: $legacy{'login'} = 1;
1.518 albertel 5763: }
5764: if (ref($domconfig{'rolecolors'}) eq 'HASH') {
1.632 raeburn 5765: if (keys(%{$domconfig{'rolecolors'}})) {
5766: foreach my $role (keys(%{$domconfig{'rolecolors'}})) {
5767: if (ref($domconfig{'rolecolors'}{$role}) eq 'HASH') {
5768: foreach my $item (keys(%{$domconfig{'rolecolors'}{$role}})) {
5769: $designhash{$udom.'.'.$role.'.'.$item}=$domconfig{'rolecolors'}{$role}{$item};
5770: }
1.518 albertel 5771: }
5772: }
1.632 raeburn 5773: } else {
5774: $legacy{'rolecolors'} = 1;
1.518 albertel 5775: }
1.632 raeburn 5776: } else {
5777: $legacy{'rolecolors'} = 1;
1.518 albertel 5778: }
1.948 raeburn 5779: if (ref($domconfig{'autoenroll'}) eq 'HASH') {
5780: if ($domconfig{'autoenroll'}{'co-owners'}) {
5781: $designhash{$udom.'.autoassign.co-owners'}=$domconfig{'autoenroll'}{'co-owners'};
5782: }
5783: }
1.632 raeburn 5784: if (keys(%legacy) > 0) {
5785: my %legacyhash = &get_legacy_domconf($udom);
5786: foreach my $item (keys(%legacyhash)) {
5787: if ($item =~ /^\Q$udom\E\.login/) {
5788: if ($legacy{'login'}) {
5789: $designhash{$item} = $legacyhash{$item};
5790: }
5791: } else {
5792: if ($legacy{'rolecolors'}) {
5793: $designhash{$item} = $legacyhash{$item};
5794: }
1.518 albertel 5795: }
5796: }
5797: }
1.632 raeburn 5798: } else {
5799: %designhash = &get_legacy_domconf($udom);
1.518 albertel 5800: }
5801: &Apache::lonnet::do_cache_new('domainconfig',$udom,\%designhash,
5802: $cachetime);
5803: return %designhash;
5804: }
5805:
1.632 raeburn 5806: sub get_legacy_domconf {
5807: my ($udom) = @_;
5808: my %legacyhash;
5809: my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
5810: my $designfile = $designdir.'/'.$udom.'.tab';
5811: if (-e $designfile) {
1.1317 raeburn 5812: if ( open (my $fh,'<',$designfile) ) {
1.632 raeburn 5813: while (my $line = <$fh>) {
5814: next if ($line =~ /^\#/);
5815: chomp($line);
5816: my ($key,$val)=(split(/\=/,$line));
5817: if ($val) { $legacyhash{$udom.'.'.$key}=$val; }
5818: }
5819: close($fh);
5820: }
5821: }
1.1026 raeburn 5822: if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/adm/lonDomLogos/'.$udom.'.gif') {
1.632 raeburn 5823: $legacyhash{$udom.'.login.domlogo'} = "/adm/lonDomLogos/$udom.gif";
5824: }
5825: return %legacyhash;
5826: }
5827:
1.63 www 5828: =pod
5829:
1.112 bowersj2 5830: =item * &domainlogo()
1.63 www 5831:
5832: Inputs: $domain (usually will be undef)
5833:
5834: Returns: A link to a domain logo, if the domain logo exists.
5835: If the domain logo does not exist, a description of the domain.
5836:
5837: =cut
1.112 bowersj2 5838:
1.63 www 5839: ###############################################
5840: sub domainlogo {
1.517 raeburn 5841: my $domain = &determinedomain(shift);
1.518 albertel 5842: my %designhash = &get_domainconf($domain);
1.517 raeburn 5843: # See if there is a logo
5844: if ($designhash{$domain.'.login.domlogo'} ne '') {
1.519 raeburn 5845: my $imgsrc = $designhash{$domain.'.login.domlogo'};
1.538 albertel 5846: if ($imgsrc =~ m{^/(adm|res)/}) {
5847: if ($imgsrc =~ m{^/res/}) {
5848: my $local_name = &Apache::lonnet::filelocation('',$imgsrc);
5849: &Apache::lonnet::repcopy($local_name);
5850: }
5851: $imgsrc = &lonhttpdurl($imgsrc);
1.519 raeburn 5852: }
5853: return '<img src="'.$imgsrc.'" alt="'.$domain.'" />';
1.514 albertel 5854: } elsif (defined(&Apache::lonnet::domain($domain,'description'))) {
5855: return &Apache::lonnet::domain($domain,'description');
1.59 www 5856: } else {
1.60 matthew 5857: return '';
1.59 www 5858: }
5859: }
1.63 www 5860: ##############################################
5861:
5862: =pod
5863:
1.112 bowersj2 5864: =item * &designparm()
1.63 www 5865:
5866: Inputs: $which parameter; $domain (usually will be undef)
5867:
5868: Returns: value of designparamter $which
5869:
5870: =cut
1.112 bowersj2 5871:
1.397 albertel 5872:
1.400 albertel 5873: ##############################################
1.397 albertel 5874: sub designparm {
5875: my ($which,$domain)=@_;
5876: if (exists($env{'environment.color.'.$which})) {
1.817 bisitz 5877: return $env{'environment.color.'.$which};
1.96 www 5878: }
1.63 www 5879: $domain=&determinedomain($domain);
1.1016 raeburn 5880: my %domdesign;
5881: unless ($domain eq 'public') {
5882: %domdesign = &get_domainconf($domain);
5883: }
1.520 raeburn 5884: my $output;
1.517 raeburn 5885: if ($domdesign{$domain.'.'.$which} ne '') {
1.817 bisitz 5886: $output = $domdesign{$domain.'.'.$which};
1.63 www 5887: } else {
1.520 raeburn 5888: $output = $defaultdesign{$which};
5889: }
5890: if (($which =~ /^(student|coordinator|author|admin)\.img$/) ||
1.635 raeburn 5891: ($which =~ /login\.(img|logo|domlogo|login)/)) {
1.538 albertel 5892: if ($output =~ m{^/(adm|res)/}) {
1.817 bisitz 5893: if ($output =~ m{^/res/}) {
5894: my $local_name = &Apache::lonnet::filelocation('',$output);
5895: &Apache::lonnet::repcopy($local_name);
5896: }
1.520 raeburn 5897: $output = &lonhttpdurl($output);
5898: }
1.63 www 5899: }
1.520 raeburn 5900: return $output;
1.63 www 5901: }
1.59 www 5902:
1.822 bisitz 5903: ##############################################
5904: =pod
5905:
1.832 bisitz 5906: =item * &authorspace()
5907:
1.1028 raeburn 5908: Inputs: $url (usually will be undef).
1.832 bisitz 5909:
1.1132 raeburn 5910: Returns: Path to Authoring Space containing the resource or
1.1028 raeburn 5911: directory being viewed (or for which action is being taken).
5912: If $url is provided, and begins /priv/<domain>/<uname>
5913: the path will be that portion of the $context argument.
5914: Otherwise the path will be for the author space of the current
5915: user when the current role is author, or for that of the
5916: co-author/assistant co-author space when the current role
5917: is co-author or assistant co-author.
1.832 bisitz 5918:
5919: =cut
5920:
5921: sub authorspace {
1.1028 raeburn 5922: my ($url) = @_;
5923: if ($url ne '') {
5924: if ($url =~ m{^(/priv/$match_domain/$match_username/)}) {
5925: return $1;
5926: }
5927: }
1.832 bisitz 5928: my $caname = '';
1.1024 www 5929: my $cadom = '';
1.1028 raeburn 5930: if ($env{'request.role'} =~ /^(?:ca|aa)/) {
1.1024 www 5931: ($cadom,$caname) =
1.832 bisitz 5932: ($env{'request.role'}=~/($match_domain)\/($match_username)$/);
1.1028 raeburn 5933: } elsif ($env{'request.role'} =~ m{^au\./($match_domain)/}) {
1.832 bisitz 5934: $caname = $env{'user.name'};
1.1024 www 5935: $cadom = $env{'user.domain'};
1.832 bisitz 5936: }
1.1028 raeburn 5937: if (($caname ne '') && ($cadom ne '')) {
5938: return "/priv/$cadom/$caname/";
5939: }
5940: return;
1.832 bisitz 5941: }
5942:
5943: ##############################################
5944: =pod
5945:
1.822 bisitz 5946: =item * &head_subbox()
5947:
5948: Inputs: $content (contains HTML code with page functions, etc.)
5949:
5950: Returns: HTML div with $content
5951: To be included in page header
5952:
5953: =cut
5954:
5955: sub head_subbox {
5956: my ($content)=@_;
5957: my $output =
1.993 raeburn 5958: '<div class="LC_head_subbox">'
1.822 bisitz 5959: .$content
5960: .'</div>'
5961: }
5962:
5963: ##############################################
5964: =pod
5965:
5966: =item * &CSTR_pageheader()
5967:
1.1026 raeburn 5968: Input: (optional) filename from which breadcrumb trail is built.
5969: In most cases no input as needed, as $env{'request.filename'}
5970: is appropriate for use in building the breadcrumb trail.
1.822 bisitz 5971:
5972: Returns: HTML div with CSTR path and recent box
1.1132 raeburn 5973: To be included on Authoring Space pages
1.822 bisitz 5974:
5975: =cut
5976:
5977: sub CSTR_pageheader {
1.1026 raeburn 5978: my ($trailfile) = @_;
5979: if ($trailfile eq '') {
5980: $trailfile = $env{'request.filename'};
5981: }
5982:
5983: # this is for resources; directories have customtitle, and crumbs
5984: # and select recent are created in lonpubdir.pm
5985:
5986: my $londocroot = $Apache::lonnet::perlvar{'lonDocRoot'};
1.1022 www 5987: my ($udom,$uname,$thisdisfn)=
1.1113 raeburn 5988: ($trailfile =~ m{^\Q$londocroot\E/priv/([^/]+)/([^/]+)(?:|/(.*))$});
1.1026 raeburn 5989: my $formaction = "/priv/$udom/$uname/$thisdisfn";
5990: $formaction =~ s{/+}{/}g;
1.822 bisitz 5991:
5992: my $parentpath = '';
5993: my $lastitem = '';
5994: if ($thisdisfn =~ m-(.+/)([^/]*)$-) {
5995: $parentpath = $1;
5996: $lastitem = $2;
5997: } else {
5998: $lastitem = $thisdisfn;
5999: }
1.921 bisitz 6000:
1.1246 raeburn 6001: my ($crsauthor,$title);
6002: if (($env{'request.course.id'}) &&
6003: ($env{'course.'.$env{'request.course.id'}.'.num'} eq $uname) &&
1.1247 raeburn 6004: ($env{'course.'.$env{'request.course.id'}.'.domain'} eq $udom)) {
1.1246 raeburn 6005: $crsauthor = 1;
6006: $title = &mt('Course Authoring Space');
6007: } else {
6008: $title = &mt('Authoring Space');
6009: }
6010:
1.1314 raeburn 6011: my ($target,$crumbtarget) = (' target="_top"','_top'); #FIXME lonpubdir: target="_parent"
1.1313 raeburn 6012: if (($env{'request.lti.login'}) && ($env{'request.lti.target'} eq 'iframe')) {
1.1314 raeburn 6013: $target = '';
6014: $crumbtarget = '';
1.1313 raeburn 6015: }
6016:
1.921 bisitz 6017: my $output =
1.822 bisitz 6018: '<div>'
6019: .&Apache::loncommon::help_open_menu('','',3,'Authoring') #FIXME: Broken? Where is it?
1.1246 raeburn 6020: .'<b>'.$title.'</b> '
1.1314 raeburn 6021: .'<form name="dirs" method="post" action="'.$formaction.'"'.$target.'>'
6022: .&Apache::lonhtmlcommon::crumbs($uname.'/'.$parentpath,$crumbtarget,'/priv/'.$udom,undef,undef);
1.921 bisitz 6023:
6024: if ($lastitem) {
6025: $output .=
6026: '<span class="LC_filename">'
6027: .$lastitem
6028: .'</span>';
6029: }
1.1245 raeburn 6030:
1.1246 raeburn 6031: if ($crsauthor) {
6032: $output .= '</form>'.&Apache::lonmenu::constspaceform();
6033: } else {
6034: $output .=
6035: '<br />'
1.1314 raeburn 6036: #FIXME lonpubdir: &Apache::lonhtmlcommon::crumbs($uname.$thisdisfn.'/',$crumbtarget,'/priv','','+1',1)."</b></tt><br />"
1.1246 raeburn 6037: .&Apache::lonhtmlcommon::select_recent('construct','recent','this.form.action=this.form.recent.value;this.form.submit()')
6038: .'</form>'
6039: .&Apache::lonmenu::constspaceform();
6040: }
6041: $output .= '</div>';
1.921 bisitz 6042:
6043: return $output;
1.822 bisitz 6044: }
6045:
1.60 matthew 6046: ###############################################
6047: ###############################################
6048:
6049: =pod
6050:
1.112 bowersj2 6051: =back
6052:
1.549 albertel 6053: =head1 HTML Helpers
1.112 bowersj2 6054:
6055: =over 4
6056:
6057: =item * &bodytag()
1.60 matthew 6058:
6059: Returns a uniform header for LON-CAPA web pages.
6060:
6061: Inputs:
6062:
1.112 bowersj2 6063: =over 4
6064:
6065: =item * $title, A title to be displayed on the page.
6066:
6067: =item * $function, the current role (can be undef).
6068:
6069: =item * $addentries, extra parameters for the <body> tag.
6070:
6071: =item * $bodyonly, if defined, only return the <body> tag.
6072:
6073: =item * $domain, if defined, force a given domain.
6074:
6075: =item * $forcereg, if page should register as content page (relevant for
1.86 www 6076: text interface only)
1.60 matthew 6077:
1.814 bisitz 6078: =item * $no_nav_bar, if true, keep the 'what is this' info but remove the
6079: navigational links
1.317 albertel 6080:
1.338 albertel 6081: =item * $bgcolor, used to override the bgcolor on a webpage to a specific value
6082:
1.460 albertel 6083: =item * $args, optional argument valid values are
6084: no_auto_mt_title -> prevents &mt()ing the title arg
1.1274 raeburn 6085: use_absolute -> for external resource or syllabus, this will
6086: contain https://<hostname> if server uses
6087: https (as per hosts.tab), but request is for http
6088: hostname -> hostname, from $r->hostname().
1.460 albertel 6089:
1.1096 raeburn 6090: =item * $advtoolsref, optional argument, ref to an array containing
6091: inlineremote items to be added in "Functions" menu below
6092: breadcrumbs.
6093:
1.1316 raeburn 6094: =item * $ltiscope, optional argument, will be one of: resource, map or
6095: course, if LON-CAPA is in LTI Provider context. Value is
6096: the scope of use, i.e., launch was for access to a single, a map
6097: or the entire course.
6098:
6099: =item * $ltiuri, optional argument, if LON-CAPA is in LTI Provider
6100: context, this will contain the URL for the landing item in
6101: the course, after launch from an LTI Consumer
6102:
1.1318 raeburn 6103: =item * $ltimenu, optional argument, if LON-CAPA is in LTI Provider
6104: context, this will contain a reference to hash of items
6105: to be included in the page header and/or inline menu.
6106:
1.112 bowersj2 6107: =back
6108:
1.60 matthew 6109: Returns: A uniform header for LON-CAPA web pages.
6110: If $bodyonly is nonzero, a string containing a <body> tag will be returned.
6111: If $bodyonly is undef or zero, an html string containing a <body> tag and
6112: other decorations will be returned.
6113:
6114: =cut
6115:
1.54 www 6116: sub bodytag {
1.831 bisitz 6117: my ($title,$function,$addentries,$bodyonly,$domain,$forcereg,
1.1359 raeburn 6118: $no_nav_bar,$bgcolor,$args,$advtoolsref,$ltiscope,$ltiuri,
6119: $ltimenu,$menucoll,$menuref)=@_;
1.339 albertel 6120:
1.954 raeburn 6121: my $public;
6122: if ((($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public'))
6123: || ($env{'user.name'} eq '') && ($env{'user.domain'} eq '')) {
6124: $public = 1;
6125: }
1.460 albertel 6126: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
1.1154 raeburn 6127: my $httphost = $args->{'use_absolute'};
1.1274 raeburn 6128: my $hostname = $args->{'hostname'};
1.339 albertel 6129:
1.183 matthew 6130: $function = &get_users_function() if (!$function);
1.339 albertel 6131: my $img = &designparm($function.'.img',$domain);
6132: my $font = &designparm($function.'.font',$domain);
6133: my $pgbg = $bgcolor || &designparm($function.'.pgbg',$domain);
6134:
1.803 bisitz 6135: my %design = ( 'style' => 'margin-top: 0',
1.535 albertel 6136: 'bgcolor' => $pgbg,
1.339 albertel 6137: 'text' => $font,
6138: 'alink' => &designparm($function.'.alink',$domain),
6139: 'vlink' => &designparm($function.'.vlink',$domain),
6140: 'link' => &designparm($function.'.link',$domain),);
1.438 albertel 6141: @design{keys(%$addentries)} = @$addentries{keys(%$addentries)};
1.339 albertel 6142:
1.63 www 6143: # role and realm
1.1178 raeburn 6144: my ($role,$realm) = split(m{\./},$env{'request.role'},2);
6145: if ($realm) {
6146: $realm = '/'.$realm;
6147: }
1.1357 raeburn 6148: if ($role eq 'ca') {
1.479 albertel 6149: my ($rdom,$rname) = ($realm =~ m{^/($match_domain)/($match_username)$});
1.500 albertel 6150: $realm = &plainname($rname,$rdom);
1.378 raeburn 6151: }
1.55 www 6152: # realm
1.1357 raeburn 6153: my ($cid,$sec);
1.258 albertel 6154: if ($env{'request.course.id'}) {
1.1357 raeburn 6155: $cid = $env{'request.course.id'};
6156: if ($env{'request.course.sec'}) {
6157: $sec = $env{'request.course.sec'};
6158: }
6159: } elsif ($realm =~ m{^/($match_domain)/($match_courseid)(?:|/(\w+))$}) {
6160: if (&Apache::lonnet::is_course($1,$2)) {
6161: $cid = $1.'_'.$2;
6162: $sec = $3;
6163: }
6164: }
6165: if ($cid) {
1.378 raeburn 6166: if ($env{'request.role'} !~ /^cr/) {
6167: $role = &Apache::lonnet::plaintext($role,&course_type());
1.1257 raeburn 6168: } elsif ($role =~ m{^cr/($match_domain)/\1-domainconfig/(\w+)$}) {
1.1269 raeburn 6169: if ($env{'request.role.desc'}) {
6170: $role = $env{'request.role.desc'};
6171: } else {
6172: $role = &mt('Helpdesk[_1]',' '.$2);
6173: }
1.1257 raeburn 6174: } else {
6175: $role = (split(/\//,$role,4))[-1];
1.378 raeburn 6176: }
1.1357 raeburn 6177: if ($sec) {
6178: $role .= (' 'x2).'- '.&mt('section:').' '.$sec;
1.898 raeburn 6179: }
1.1357 raeburn 6180: $realm = $env{'course.'.$cid.'.description'};
1.378 raeburn 6181: } else {
6182: $role = &Apache::lonnet::plaintext($role);
1.54 www 6183: }
1.433 albertel 6184:
1.359 albertel 6185: if (!$realm) { $realm=' '; }
1.330 albertel 6186:
1.438 albertel 6187: my $extra_body_attr = &make_attr_string($forcereg,\%design);
1.329 albertel 6188:
1.101 www 6189: # construct main body tag
1.359 albertel 6190: my $bodytag = "<body $extra_body_attr>".
1.1235 raeburn 6191: &Apache::lontexconvert::init_math_support();
1.252 albertel 6192:
1.1131 raeburn 6193: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
6194:
1.1130 raeburn 6195: if (($bodyonly) || ($no_nav_bar) || ($env{'form.inhibitmenu'} eq 'yes')) {
1.60 matthew 6196: return $bodytag;
1.1130 raeburn 6197: }
1.359 albertel 6198:
1.954 raeburn 6199: if ($public) {
1.433 albertel 6200: undef($role);
6201: }
1.1318 raeburn 6202:
1.1359 raeburn 6203: my $showcrstitle = 1;
1.1357 raeburn 6204: if (($cid) && ($env{'request.lti.login'})) {
1.1318 raeburn 6205: if (ref($ltimenu) eq 'HASH') {
6206: unless ($ltimenu->{'role'}) {
6207: undef($role);
6208: }
6209: unless ($ltimenu->{'coursetitle'}) {
6210: $realm=' ';
1.1359 raeburn 6211: $showcrstitle = 0;
6212: }
6213: }
6214: } elsif (($cid) && ($menucoll)) {
6215: if (ref($menuref) eq 'HASH') {
6216: unless ($menuref->{'role'}) {
6217: undef($role);
6218: }
6219: unless ($menuref->{'crs'}) {
6220: $realm=' ';
6221: $showcrstitle = 0;
1.1318 raeburn 6222: }
6223: }
6224: }
6225:
1.762 bisitz 6226: my $titleinfo = '<h1>'.$title.'</h1>';
1.359 albertel 6227: #
6228: # Extra info if you are the DC
6229: my $dc_info = '';
1.1359 raeburn 6230: if (($env{'user.adv'}) && ($env{'request.course.id'}) && $showcrstitle &&
1.1357 raeburn 6231: (exists($env{'user.role.dc./'.$env{'course.'.$cid.'.domain'}.'/'}))) {
1.917 raeburn 6232: $dc_info = $cid.' '.$env{'course.'.$cid.'.internal.coursecode'};
1.380 www 6233: $dc_info =~ s/\s+$//;
1.359 albertel 6234: }
6235:
1.1237 raeburn 6236: my $crstype;
1.1357 raeburn 6237: if ($cid) {
6238: $crstype = $env{'course.'.$cid.'.type'};
1.1237 raeburn 6239: } elsif ($args->{'crstype'}) {
6240: $crstype = $args->{'crstype'};
6241: }
6242: if (($crstype eq 'Placement') && (!$env{'request.role.adv'})) {
6243: undef($role);
6244: } else {
1.1242 raeburn 6245: $role = '<span class="LC_nobreak">('.$role.')</span>' if ($role && !$env{'browser.mobile'});
1.1237 raeburn 6246: }
1.853 droeschl 6247:
1.903 droeschl 6248: if ($env{'request.state'} eq 'construct') { $forcereg=1; }
6249:
6250: # if ($env{'request.state'} eq 'construct') {
6251: # $titleinfo = &CSTR_pageheader(); #FIXME: Will be removed once all scripts have their own calls
6252: # }
6253:
1.1130 raeburn 6254: $bodytag .= Apache::lonhtmlcommon::scripttag(
1.1154 raeburn 6255: Apache::lonmenu::utilityfunctions($httphost), 'start');
1.359 albertel 6256:
1.1318 raeburn 6257: unless ($args->{'no_primary_menu'}) {
1.1359 raeburn 6258: my ($left,$right) = Apache::lonmenu::primary_menu($crstype,$ltimenu,$menucoll,$menuref);
1.359 albertel 6259:
1.1318 raeburn 6260: if ($env{'request.noversionuri'} =~ m{^/res/adm/pages/}) {
6261: if ($dc_info) {
6262: $dc_info = qq|<span class="LC_cusr_subheading">$dc_info</span>|;
6263: }
6264: $bodytag .= qq|<div id="LC_nav_bar">$left $role<br />
6265: <em>$realm</em> $dc_info</div>|;
6266: return $bodytag;
6267: }
1.894 droeschl 6268:
1.1318 raeburn 6269: unless ($env{'request.symb'} =~ m/\.page___\d+___/) {
6270: $bodytag .= qq|<div id="LC_nav_bar">$left $role</div>|;
6271: }
1.916 droeschl 6272:
1.1318 raeburn 6273: $bodytag .= $right;
1.852 droeschl 6274:
1.1318 raeburn 6275: if ($dc_info) {
6276: $dc_info = &dc_courseid_toggle($dc_info);
6277: }
6278: $bodytag .= qq|<div id="LC_realm">$realm $dc_info</div>|;
1.917 raeburn 6279: }
1.916 droeschl 6280:
1.1169 raeburn 6281: #if directed to not display the secondary menu, don't.
1.1168 raeburn 6282: if ($args->{'no_secondary_menu'}) {
6283: return $bodytag;
6284: }
1.1169 raeburn 6285: #don't show menus for public users
1.954 raeburn 6286: if (!$public){
1.1318 raeburn 6287: unless ($args->{'no_inline_menu'}) {
6288: $bodytag .= Apache::lonmenu::secondary_menu($httphost,$ltiscope,$ltimenu,
1.1359 raeburn 6289: $args->{'no_primary_menu'},
6290: $menucoll,$menuref);
1.1318 raeburn 6291: }
1.903 droeschl 6292: $bodytag .= Apache::lonmenu::serverform();
1.920 raeburn 6293: $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
6294: if ($env{'request.state'} eq 'construct') {
1.962 droeschl 6295: $bodytag .= &Apache::lonmenu::innerregister($forcereg,
1.1316 raeburn 6296: $args->{'bread_crumbs'},'','',$hostname,$ltiscope,$ltiuri);
1.1096 raeburn 6297: } elsif ($forcereg) {
6298: $bodytag .= &Apache::lonmenu::innerregister($forcereg,undef,
1.1258 raeburn 6299: $args->{'group'},
1.1274 raeburn 6300: $args->{'hide_buttons'},
1.1316 raeburn 6301: $hostname,$ltiscope,$ltiuri);
1.1096 raeburn 6302: } else {
6303: $bodytag .=
6304: &Apache::lonmenu::prepare_functions($env{'request.noversionuri'},
6305: $forcereg,$args->{'group'},
6306: $args->{'bread_crumbs'},
1.1274 raeburn 6307: $advtoolsref,'',$hostname);
1.920 raeburn 6308: }
1.903 droeschl 6309: }else{
6310: # this is to seperate menu from content when there's no secondary
6311: # menu. Especially needed for public accessible ressources.
6312: $bodytag .= '<hr style="clear:both" />';
6313: $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
1.235 raeburn 6314: }
1.903 droeschl 6315:
1.235 raeburn 6316: return $bodytag;
1.182 matthew 6317: }
6318:
1.917 raeburn 6319: sub dc_courseid_toggle {
6320: my ($dc_info) = @_;
1.980 raeburn 6321: return ' <span id="dccidtext" class="LC_cusr_subheading LC_nobreak">'.
1.1069 raeburn 6322: '<a href="javascript:showCourseID();" class="LC_menubuttons_link">'.
1.917 raeburn 6323: &mt('(More ...)').'</a></span>'.
6324: '<div id="dccid" class="LC_dccid">'.$dc_info.'</div>';
6325: }
6326:
1.330 albertel 6327: sub make_attr_string {
6328: my ($register,$attr_ref) = @_;
6329:
6330: if ($attr_ref && !ref($attr_ref)) {
6331: die("addentries Must be a hash ref ".
6332: join(':',caller(1))." ".
6333: join(':',caller(0))." ");
6334: }
6335:
6336: if ($register) {
1.339 albertel 6337: my ($on_load,$on_unload);
6338: foreach my $key (keys(%{$attr_ref})) {
6339: if (lc($key) eq 'onload') {
6340: $on_load.=$attr_ref->{$key}.';';
6341: delete($attr_ref->{$key});
6342:
6343: } elsif (lc($key) eq 'onunload') {
6344: $on_unload.=$attr_ref->{$key}.';';
6345: delete($attr_ref->{$key});
6346: }
6347: }
1.953 droeschl 6348: $attr_ref->{'onload'} = $on_load;
6349: $attr_ref->{'onunload'}= $on_unload;
1.330 albertel 6350: }
1.339 albertel 6351:
1.330 albertel 6352: my $attr_string;
1.1159 raeburn 6353: foreach my $attr (sort(keys(%$attr_ref))) {
1.330 albertel 6354: $attr_string .= " $attr=\"".$attr_ref->{$attr}.'" ';
6355: }
6356: return $attr_string;
6357: }
6358:
6359:
1.182 matthew 6360: ###############################################
1.251 albertel 6361: ###############################################
6362:
6363: =pod
6364:
6365: =item * &endbodytag()
6366:
6367: Returns a uniform footer for LON-CAPA web pages.
6368:
1.635 raeburn 6369: Inputs: 1 - optional reference to an args hash
6370: If in the hash, key for noredirectlink has a value which evaluates to true,
6371: a 'Continue' link is not displayed if the page contains an
6372: internal redirect in the <head></head> section,
6373: i.e., $env{'internal.head.redirect'} exists
1.251 albertel 6374:
6375: =cut
6376:
6377: sub endbodytag {
1.635 raeburn 6378: my ($args) = @_;
1.1080 raeburn 6379: my $endbodytag;
6380: unless ((ref($args) eq 'HASH') && ($args->{'notbody'})) {
6381: $endbodytag='</body>';
6382: }
1.315 albertel 6383: if ( exists( $env{'internal.head.redirect'} ) ) {
1.635 raeburn 6384: if (!(ref($args) eq 'HASH' && $args->{'noredirectlink'})) {
6385: $endbodytag=
6386: "<br /><a href=\"$env{'internal.head.redirect'}\">".
6387: &mt('Continue').'</a>'.
6388: $endbodytag;
6389: }
1.315 albertel 6390: }
1.251 albertel 6391: return $endbodytag;
6392: }
6393:
1.352 albertel 6394: =pod
6395:
6396: =item * &standard_css()
6397:
6398: Returns a style sheet
6399:
6400: Inputs: (all optional)
6401: domain -> force to color decorate a page for a specific
6402: domain
6403: function -> force usage of a specific rolish color scheme
6404: bgcolor -> override the default page bgcolor
6405:
6406: =cut
6407:
1.343 albertel 6408: sub standard_css {
1.345 albertel 6409: my ($function,$domain,$bgcolor) = @_;
1.352 albertel 6410: $function = &get_users_function() if (!$function);
6411: my $img = &designparm($function.'.img', $domain);
6412: my $tabbg = &designparm($function.'.tabbg', $domain);
6413: my $font = &designparm($function.'.font', $domain);
1.801 tempelho 6414: my $fontmenu = &designparm($function.'.fontmenu', $domain);
1.791 tempelho 6415: #second colour for later usage
1.345 albertel 6416: my $sidebg = &designparm($function.'.sidebg',$domain);
1.382 albertel 6417: my $pgbg_or_bgcolor =
6418: $bgcolor ||
1.352 albertel 6419: &designparm($function.'.pgbg', $domain);
1.382 albertel 6420: my $pgbg = &designparm($function.'.pgbg', $domain);
1.352 albertel 6421: my $alink = &designparm($function.'.alink', $domain);
6422: my $vlink = &designparm($function.'.vlink', $domain);
6423: my $link = &designparm($function.'.link', $domain);
6424:
1.602 albertel 6425: my $sans = 'Verdana,Arial,Helvetica,sans-serif';
1.395 albertel 6426: my $mono = 'monospace';
1.850 bisitz 6427: my $data_table_head = $sidebg;
6428: my $data_table_light = '#FAFAFA';
1.1060 bisitz 6429: my $data_table_dark = '#E0E0E0';
1.470 banghart 6430: my $data_table_darker = '#CCCCCC';
1.349 albertel 6431: my $data_table_highlight = '#FFFF00';
1.352 albertel 6432: my $mail_new = '#FFBB77';
6433: my $mail_new_hover = '#DD9955';
6434: my $mail_read = '#BBBB77';
6435: my $mail_read_hover = '#999944';
6436: my $mail_replied = '#AAAA88';
6437: my $mail_replied_hover = '#888855';
6438: my $mail_other = '#99BBBB';
6439: my $mail_other_hover = '#669999';
1.391 albertel 6440: my $table_header = '#DDDDDD';
1.489 raeburn 6441: my $feedback_link_bg = '#BBBBBB';
1.911 bisitz 6442: my $lg_border_color = '#C8C8C8';
1.952 onken 6443: my $button_hover = '#BF2317';
1.392 albertel 6444:
1.608 albertel 6445: my $border = ($env{'browser.type'} eq 'explorer' ||
1.911 bisitz 6446: $env{'browser.type'} eq 'safari' ) ? '0 2px 0 2px'
6447: : '0 3px 0 4px';
1.448 albertel 6448:
1.523 albertel 6449:
1.343 albertel 6450: return <<END;
1.947 droeschl 6451:
6452: /* needed for iframe to allow 100% height in FF */
6453: body, html {
6454: margin: 0;
6455: padding: 0 0.5%;
6456: height: 99%; /* to avoid scrollbars */
6457: }
6458:
1.795 www 6459: body {
1.911 bisitz 6460: font-family: $sans;
6461: line-height:130%;
6462: font-size:0.83em;
6463: color:$font;
1.795 www 6464: }
6465:
1.959 onken 6466: a:focus,
6467: a:focus img {
1.795 www 6468: color: red;
6469: }
1.698 harmsja 6470:
1.911 bisitz 6471: form, .inline {
6472: display: inline;
1.795 www 6473: }
1.721 harmsja 6474:
1.795 www 6475: .LC_right {
1.911 bisitz 6476: text-align:right;
1.795 www 6477: }
6478:
6479: .LC_middle {
1.911 bisitz 6480: vertical-align:middle;
1.795 www 6481: }
1.721 harmsja 6482:
1.1130 raeburn 6483: .LC_floatleft {
6484: float: left;
6485: }
6486:
6487: .LC_floatright {
6488: float: right;
6489: }
6490:
1.911 bisitz 6491: .LC_400Box {
6492: width:400px;
6493: }
1.721 harmsja 6494:
1.947 droeschl 6495: .LC_iframecontainer {
6496: width: 98%;
6497: margin: 0;
6498: position: fixed;
6499: top: 8.5em;
6500: bottom: 0;
6501: }
6502:
6503: .LC_iframecontainer iframe{
6504: border: none;
6505: width: 100%;
6506: height: 100%;
6507: }
6508:
1.778 bisitz 6509: .LC_filename {
6510: font-family: $mono;
6511: white-space:pre;
1.921 bisitz 6512: font-size: 120%;
1.778 bisitz 6513: }
6514:
6515: .LC_fileicon {
6516: border: none;
6517: height: 1.3em;
6518: vertical-align: text-bottom;
6519: margin-right: 0.3em;
6520: text-decoration:none;
6521: }
6522:
1.1008 www 6523: .LC_setting {
6524: text-decoration:underline;
6525: }
6526:
1.350 albertel 6527: .LC_error {
6528: color: red;
6529: }
1.795 www 6530:
1.1097 bisitz 6531: .LC_warning {
6532: color: darkorange;
6533: }
6534:
1.457 albertel 6535: .LC_diff_removed {
1.733 bisitz 6536: color: red;
1.394 albertel 6537: }
1.532 albertel 6538:
6539: .LC_info,
1.457 albertel 6540: .LC_success,
6541: .LC_diff_added {
1.350 albertel 6542: color: green;
6543: }
1.795 www 6544:
1.802 bisitz 6545: div.LC_confirm_box {
6546: background-color: #FAFAFA;
6547: border: 1px solid $lg_border_color;
6548: margin-right: 0;
6549: padding: 5px;
6550: }
6551:
6552: div.LC_confirm_box .LC_error img,
6553: div.LC_confirm_box .LC_success img {
6554: vertical-align: middle;
6555: }
6556:
1.1242 raeburn 6557: .LC_maxwidth {
6558: max-width: 100%;
6559: height: auto;
6560: }
6561:
1.1243 raeburn 6562: .LC_textsize_mobile {
6563: \@media only screen and (max-device-width: 480px) {
6564: -webkit-text-size-adjust:100%; -moz-text-size-adjust:100%; -ms-text-size-adjust:100%;
6565: }
6566: }
6567:
1.440 albertel 6568: .LC_icon {
1.771 droeschl 6569: border: none;
1.790 droeschl 6570: vertical-align: middle;
1.771 droeschl 6571: }
6572:
1.543 albertel 6573: .LC_docs_spacer {
6574: width: 25px;
6575: height: 1px;
1.771 droeschl 6576: border: none;
1.543 albertel 6577: }
1.346 albertel 6578:
1.532 albertel 6579: .LC_internal_info {
1.735 bisitz 6580: color: #999999;
1.532 albertel 6581: }
6582:
1.794 www 6583: .LC_discussion {
1.1050 www 6584: background: $data_table_dark;
1.911 bisitz 6585: border: 1px solid black;
6586: margin: 2px;
1.794 www 6587: }
6588:
6589: .LC_disc_action_left {
1.1050 www 6590: background: $sidebg;
1.911 bisitz 6591: text-align: left;
1.1050 www 6592: padding: 4px;
6593: margin: 2px;
1.794 www 6594: }
6595:
6596: .LC_disc_action_right {
1.1050 www 6597: background: $sidebg;
1.911 bisitz 6598: text-align: right;
1.1050 www 6599: padding: 4px;
6600: margin: 2px;
1.794 www 6601: }
6602:
6603: .LC_disc_new_item {
1.911 bisitz 6604: background: white;
6605: border: 2px solid red;
1.1050 www 6606: margin: 4px;
6607: padding: 4px;
1.794 www 6608: }
6609:
6610: .LC_disc_old_item {
1.911 bisitz 6611: background: white;
1.1050 www 6612: margin: 4px;
6613: padding: 4px;
1.794 www 6614: }
6615:
1.458 albertel 6616: table.LC_pastsubmission {
6617: border: 1px solid black;
6618: margin: 2px;
6619: }
6620:
1.924 bisitz 6621: table#LC_menubuttons {
1.345 albertel 6622: width: 100%;
6623: background: $pgbg;
1.392 albertel 6624: border: 2px;
1.402 albertel 6625: border-collapse: separate;
1.803 bisitz 6626: padding: 0;
1.345 albertel 6627: }
1.392 albertel 6628:
1.801 tempelho 6629: table#LC_title_bar a {
6630: color: $fontmenu;
6631: }
1.836 bisitz 6632:
1.807 droeschl 6633: table#LC_title_bar {
1.819 tempelho 6634: clear: both;
1.836 bisitz 6635: display: none;
1.807 droeschl 6636: }
6637:
1.795 www 6638: table#LC_title_bar,
1.933 droeschl 6639: table.LC_breadcrumbs, /* obsolete? */
1.393 albertel 6640: table#LC_title_bar.LC_with_remote {
1.359 albertel 6641: width: 100%;
1.392 albertel 6642: border-color: $pgbg;
6643: border-style: solid;
6644: border-width: $border;
1.379 albertel 6645: background: $pgbg;
1.801 tempelho 6646: color: $fontmenu;
1.392 albertel 6647: border-collapse: collapse;
1.803 bisitz 6648: padding: 0;
1.819 tempelho 6649: margin: 0;
1.359 albertel 6650: }
1.795 www 6651:
1.933 droeschl 6652: ul.LC_breadcrumb_tools_outerlist {
1.913 droeschl 6653: margin: 0;
6654: padding: 0;
1.933 droeschl 6655: position: relative;
6656: list-style: none;
1.913 droeschl 6657: }
1.933 droeschl 6658: ul.LC_breadcrumb_tools_outerlist li {
1.913 droeschl 6659: display: inline;
6660: }
1.933 droeschl 6661:
6662: .LC_breadcrumb_tools_navigation {
1.913 droeschl 6663: padding: 0;
1.933 droeschl 6664: margin: 0;
6665: float: left;
1.913 droeschl 6666: }
1.933 droeschl 6667: .LC_breadcrumb_tools_tools {
6668: padding: 0;
6669: margin: 0;
1.913 droeschl 6670: float: right;
6671: }
6672:
1.1240 raeburn 6673: .LC_placement_prog {
6674: padding-right: 20px;
6675: font-weight: bold;
6676: font-size: 90%;
6677: }
6678:
1.359 albertel 6679: table#LC_title_bar td {
6680: background: $tabbg;
6681: }
1.795 www 6682:
1.911 bisitz 6683: table#LC_menubuttons img {
1.803 bisitz 6684: border: none;
1.346 albertel 6685: }
1.795 www 6686:
1.842 droeschl 6687: .LC_breadcrumbs_component {
1.911 bisitz 6688: float: right;
6689: margin: 0 1em;
1.357 albertel 6690: }
1.842 droeschl 6691: .LC_breadcrumbs_component img {
1.911 bisitz 6692: vertical-align: middle;
1.777 tempelho 6693: }
1.795 www 6694:
1.1243 raeburn 6695: .LC_breadcrumbs_hoverable {
6696: background: $sidebg;
6697: }
6698:
1.383 albertel 6699: td.LC_table_cell_checkbox {
6700: text-align: center;
6701: }
1.795 www 6702:
6703: .LC_fontsize_small {
1.911 bisitz 6704: font-size: 70%;
1.705 tempelho 6705: }
6706:
1.844 bisitz 6707: #LC_breadcrumbs {
1.911 bisitz 6708: clear:both;
6709: background: $sidebg;
6710: border-bottom: 1px solid $lg_border_color;
6711: line-height: 2.5em;
1.933 droeschl 6712: overflow: hidden;
1.911 bisitz 6713: margin: 0;
6714: padding: 0;
1.995 raeburn 6715: text-align: left;
1.819 tempelho 6716: }
1.862 bisitz 6717:
1.1098 bisitz 6718: .LC_head_subbox, .LC_actionbox {
1.911 bisitz 6719: clear:both;
6720: background: #F8F8F8; /* $sidebg; */
1.915 droeschl 6721: border: 1px solid $sidebg;
1.1098 bisitz 6722: margin: 0 0 10px 0;
1.966 bisitz 6723: padding: 3px;
1.995 raeburn 6724: text-align: left;
1.822 bisitz 6725: }
6726:
1.795 www 6727: .LC_fontsize_medium {
1.911 bisitz 6728: font-size: 85%;
1.705 tempelho 6729: }
6730:
1.795 www 6731: .LC_fontsize_large {
1.911 bisitz 6732: font-size: 120%;
1.705 tempelho 6733: }
6734:
1.346 albertel 6735: .LC_menubuttons_inline_text {
6736: color: $font;
1.698 harmsja 6737: font-size: 90%;
1.701 harmsja 6738: padding-left:3px;
1.346 albertel 6739: }
6740:
1.934 droeschl 6741: .LC_menubuttons_inline_text img{
6742: vertical-align: middle;
6743: }
6744:
1.1051 www 6745: li.LC_menubuttons_inline_text img {
1.951 onken 6746: cursor:pointer;
1.1002 droeschl 6747: text-decoration: none;
1.951 onken 6748: }
6749:
1.526 www 6750: .LC_menubuttons_link {
6751: text-decoration: none;
6752: }
1.795 www 6753:
1.522 albertel 6754: .LC_menubuttons_category {
1.521 www 6755: color: $font;
1.526 www 6756: background: $pgbg;
1.521 www 6757: font-size: larger;
6758: font-weight: bold;
6759: }
6760:
1.346 albertel 6761: td.LC_menubuttons_text {
1.911 bisitz 6762: color: $font;
1.346 albertel 6763: }
1.706 harmsja 6764:
1.346 albertel 6765: .LC_current_location {
6766: background: $tabbg;
6767: }
1.795 www 6768:
1.1286 raeburn 6769: td.LC_zero_height {
6770: line-height: 0;
6771: cellpadding: 0;
6772: }
6773:
1.938 bisitz 6774: table.LC_data_table {
1.347 albertel 6775: border: 1px solid #000000;
1.402 albertel 6776: border-collapse: separate;
1.426 albertel 6777: border-spacing: 1px;
1.610 albertel 6778: background: $pgbg;
1.347 albertel 6779: }
1.795 www 6780:
1.422 albertel 6781: .LC_data_table_dense {
6782: font-size: small;
6783: }
1.795 www 6784:
1.507 raeburn 6785: table.LC_nested_outer {
6786: border: 1px solid #000000;
1.589 raeburn 6787: border-collapse: collapse;
1.803 bisitz 6788: border-spacing: 0;
1.507 raeburn 6789: width: 100%;
6790: }
1.795 www 6791:
1.879 raeburn 6792: table.LC_innerpickbox,
1.507 raeburn 6793: table.LC_nested {
1.803 bisitz 6794: border: none;
1.589 raeburn 6795: border-collapse: collapse;
1.803 bisitz 6796: border-spacing: 0;
1.507 raeburn 6797: width: 100%;
6798: }
1.795 www 6799:
1.911 bisitz 6800: table.LC_data_table tr th,
6801: table.LC_calendar tr th,
1.879 raeburn 6802: table.LC_prior_tries tr th,
6803: table.LC_innerpickbox tr th {
1.349 albertel 6804: font-weight: bold;
6805: background-color: $data_table_head;
1.801 tempelho 6806: color:$fontmenu;
1.701 harmsja 6807: font-size:90%;
1.347 albertel 6808: }
1.795 www 6809:
1.879 raeburn 6810: table.LC_innerpickbox tr th,
6811: table.LC_innerpickbox tr td {
6812: vertical-align: top;
6813: }
6814:
1.711 raeburn 6815: table.LC_data_table tr.LC_info_row > td {
1.735 bisitz 6816: background-color: #CCCCCC;
1.711 raeburn 6817: font-weight: bold;
6818: text-align: left;
6819: }
1.795 www 6820:
1.912 bisitz 6821: table.LC_data_table tr.LC_odd_row > td {
6822: background-color: $data_table_light;
6823: padding: 2px;
6824: vertical-align: top;
6825: }
6826:
1.809 bisitz 6827: table.LC_pick_box tr > td.LC_odd_row {
1.349 albertel 6828: background-color: $data_table_light;
1.912 bisitz 6829: vertical-align: top;
6830: }
6831:
6832: table.LC_data_table tr.LC_even_row > td {
6833: background-color: $data_table_dark;
1.425 albertel 6834: padding: 2px;
1.900 bisitz 6835: vertical-align: top;
1.347 albertel 6836: }
1.795 www 6837:
1.809 bisitz 6838: table.LC_pick_box tr > td.LC_even_row {
1.349 albertel 6839: background-color: $data_table_dark;
1.900 bisitz 6840: vertical-align: top;
1.347 albertel 6841: }
1.795 www 6842:
1.425 albertel 6843: table.LC_data_table tr.LC_data_table_highlight td {
6844: background-color: $data_table_darker;
6845: }
1.795 www 6846:
1.639 raeburn 6847: table.LC_data_table tr td.LC_leftcol_header {
6848: background-color: $data_table_head;
6849: font-weight: bold;
6850: }
1.795 www 6851:
1.451 albertel 6852: table.LC_data_table tr.LC_empty_row td,
1.507 raeburn 6853: table.LC_nested tr.LC_empty_row td {
1.421 albertel 6854: font-weight: bold;
6855: font-style: italic;
6856: text-align: center;
6857: padding: 8px;
1.347 albertel 6858: }
1.795 www 6859:
1.1114 raeburn 6860: table.LC_data_table tr.LC_empty_row td,
6861: table.LC_data_table tr.LC_footer_row td {
1.940 bisitz 6862: background-color: $sidebg;
6863: }
6864:
6865: table.LC_nested tr.LC_empty_row td {
6866: background-color: #FFFFFF;
6867: }
6868:
1.890 droeschl 6869: table.LC_caption {
6870: }
6871:
1.507 raeburn 6872: table.LC_nested tr.LC_empty_row td {
1.465 albertel 6873: padding: 4ex
6874: }
1.795 www 6875:
1.507 raeburn 6876: table.LC_nested_outer tr th {
6877: font-weight: bold;
1.801 tempelho 6878: color:$fontmenu;
1.507 raeburn 6879: background-color: $data_table_head;
1.701 harmsja 6880: font-size: small;
1.507 raeburn 6881: border-bottom: 1px solid #000000;
6882: }
1.795 www 6883:
1.507 raeburn 6884: table.LC_nested_outer tr td.LC_subheader {
6885: background-color: $data_table_head;
6886: font-weight: bold;
6887: font-size: small;
6888: border-bottom: 1px solid #000000;
6889: text-align: right;
1.451 albertel 6890: }
1.795 www 6891:
1.507 raeburn 6892: table.LC_nested tr.LC_info_row td {
1.735 bisitz 6893: background-color: #CCCCCC;
1.451 albertel 6894: font-weight: bold;
6895: font-size: small;
1.507 raeburn 6896: text-align: center;
6897: }
1.795 www 6898:
1.589 raeburn 6899: table.LC_nested tr.LC_info_row td.LC_left_item,
6900: table.LC_nested_outer tr th.LC_left_item {
1.507 raeburn 6901: text-align: left;
1.451 albertel 6902: }
1.795 www 6903:
1.507 raeburn 6904: table.LC_nested td {
1.735 bisitz 6905: background-color: #FFFFFF;
1.451 albertel 6906: font-size: small;
1.507 raeburn 6907: }
1.795 www 6908:
1.507 raeburn 6909: table.LC_nested_outer tr th.LC_right_item,
6910: table.LC_nested tr.LC_info_row td.LC_right_item,
6911: table.LC_nested tr.LC_odd_row td.LC_right_item,
6912: table.LC_nested tr td.LC_right_item {
1.451 albertel 6913: text-align: right;
6914: }
6915:
1.507 raeburn 6916: table.LC_nested tr.LC_odd_row td {
1.735 bisitz 6917: background-color: #EEEEEE;
1.451 albertel 6918: }
6919:
1.473 raeburn 6920: table.LC_createuser {
6921: }
6922:
6923: table.LC_createuser tr.LC_section_row td {
1.701 harmsja 6924: font-size: small;
1.473 raeburn 6925: }
6926:
6927: table.LC_createuser tr.LC_info_row td {
1.735 bisitz 6928: background-color: #CCCCCC;
1.473 raeburn 6929: font-weight: bold;
6930: text-align: center;
6931: }
6932:
1.349 albertel 6933: table.LC_calendar {
6934: border: 1px solid #000000;
6935: border-collapse: collapse;
1.917 raeburn 6936: width: 98%;
1.349 albertel 6937: }
1.795 www 6938:
1.349 albertel 6939: table.LC_calendar_pickdate {
6940: font-size: xx-small;
6941: }
1.795 www 6942:
1.349 albertel 6943: table.LC_calendar tr td {
6944: border: 1px solid #000000;
6945: vertical-align: top;
1.917 raeburn 6946: width: 14%;
1.349 albertel 6947: }
1.795 www 6948:
1.349 albertel 6949: table.LC_calendar tr td.LC_calendar_day_empty {
6950: background-color: $data_table_dark;
6951: }
1.795 www 6952:
1.779 bisitz 6953: table.LC_calendar tr td.LC_calendar_day_current {
6954: background-color: $data_table_highlight;
1.777 tempelho 6955: }
1.795 www 6956:
1.938 bisitz 6957: table.LC_data_table tr td.LC_mail_new {
1.349 albertel 6958: background-color: $mail_new;
6959: }
1.795 www 6960:
1.938 bisitz 6961: table.LC_data_table tr.LC_mail_new:hover {
1.349 albertel 6962: background-color: $mail_new_hover;
6963: }
1.795 www 6964:
1.938 bisitz 6965: table.LC_data_table tr td.LC_mail_read {
1.349 albertel 6966: background-color: $mail_read;
6967: }
1.795 www 6968:
1.938 bisitz 6969: /*
6970: table.LC_data_table tr.LC_mail_read:hover {
1.349 albertel 6971: background-color: $mail_read_hover;
6972: }
1.938 bisitz 6973: */
1.795 www 6974:
1.938 bisitz 6975: table.LC_data_table tr td.LC_mail_replied {
1.349 albertel 6976: background-color: $mail_replied;
6977: }
1.795 www 6978:
1.938 bisitz 6979: /*
6980: table.LC_data_table tr.LC_mail_replied:hover {
1.349 albertel 6981: background-color: $mail_replied_hover;
6982: }
1.938 bisitz 6983: */
1.795 www 6984:
1.938 bisitz 6985: table.LC_data_table tr td.LC_mail_other {
1.349 albertel 6986: background-color: $mail_other;
6987: }
1.795 www 6988:
1.938 bisitz 6989: /*
6990: table.LC_data_table tr.LC_mail_other:hover {
1.349 albertel 6991: background-color: $mail_other_hover;
6992: }
1.938 bisitz 6993: */
1.494 raeburn 6994:
1.777 tempelho 6995: table.LC_data_table tr > td.LC_browser_file,
6996: table.LC_data_table tr > td.LC_browser_file_published {
1.899 bisitz 6997: background: #AAEE77;
1.389 albertel 6998: }
1.795 www 6999:
1.777 tempelho 7000: table.LC_data_table tr > td.LC_browser_file_locked,
7001: table.LC_data_table tr > td.LC_browser_file_unpublished {
1.389 albertel 7002: background: #FFAA99;
1.387 albertel 7003: }
1.795 www 7004:
1.777 tempelho 7005: table.LC_data_table tr > td.LC_browser_file_obsolete {
1.899 bisitz 7006: background: #888888;
1.779 bisitz 7007: }
1.795 www 7008:
1.777 tempelho 7009: table.LC_data_table tr > td.LC_browser_file_modified,
1.779 bisitz 7010: table.LC_data_table tr > td.LC_browser_file_metamodified {
1.899 bisitz 7011: background: #F8F866;
1.777 tempelho 7012: }
1.795 www 7013:
1.696 bisitz 7014: table.LC_data_table tr.LC_browser_folder > td {
1.899 bisitz 7015: background: #E0E8FF;
1.387 albertel 7016: }
1.696 bisitz 7017:
1.707 bisitz 7018: table.LC_data_table tr > td.LC_roles_is {
1.911 bisitz 7019: /* background: #77FF77; */
1.707 bisitz 7020: }
1.795 www 7021:
1.707 bisitz 7022: table.LC_data_table tr > td.LC_roles_future {
1.939 bisitz 7023: border-right: 8px solid #FFFF77;
1.707 bisitz 7024: }
1.795 www 7025:
1.707 bisitz 7026: table.LC_data_table tr > td.LC_roles_will {
1.939 bisitz 7027: border-right: 8px solid #FFAA77;
1.707 bisitz 7028: }
1.795 www 7029:
1.707 bisitz 7030: table.LC_data_table tr > td.LC_roles_expired {
1.939 bisitz 7031: border-right: 8px solid #FF7777;
1.707 bisitz 7032: }
1.795 www 7033:
1.707 bisitz 7034: table.LC_data_table tr > td.LC_roles_will_not {
1.939 bisitz 7035: border-right: 8px solid #AAFF77;
1.707 bisitz 7036: }
1.795 www 7037:
1.707 bisitz 7038: table.LC_data_table tr > td.LC_roles_selected {
1.939 bisitz 7039: border-right: 8px solid #11CC55;
1.707 bisitz 7040: }
7041:
1.388 albertel 7042: span.LC_current_location {
1.701 harmsja 7043: font-size:larger;
1.388 albertel 7044: background: $pgbg;
7045: }
1.387 albertel 7046:
1.1029 www 7047: span.LC_current_nav_location {
7048: font-weight:bold;
7049: background: $sidebg;
7050: }
7051:
1.395 albertel 7052: span.LC_parm_menu_item {
7053: font-size: larger;
7054: }
1.795 www 7055:
1.395 albertel 7056: span.LC_parm_scope_all {
7057: color: red;
7058: }
1.795 www 7059:
1.395 albertel 7060: span.LC_parm_scope_folder {
7061: color: green;
7062: }
1.795 www 7063:
1.395 albertel 7064: span.LC_parm_scope_resource {
7065: color: orange;
7066: }
1.795 www 7067:
1.395 albertel 7068: span.LC_parm_part {
7069: color: blue;
7070: }
1.795 www 7071:
1.911 bisitz 7072: span.LC_parm_folder,
7073: span.LC_parm_symb {
1.395 albertel 7074: font-size: x-small;
7075: font-family: $mono;
7076: color: #AAAAAA;
7077: }
7078:
1.977 bisitz 7079: ul.LC_parm_parmlist li {
7080: display: inline-block;
7081: padding: 0.3em 0.8em;
7082: vertical-align: top;
7083: width: 150px;
7084: border-top:1px solid $lg_border_color;
7085: }
7086:
1.795 www 7087: td.LC_parm_overview_level_menu,
7088: td.LC_parm_overview_map_menu,
7089: td.LC_parm_overview_parm_selectors,
7090: td.LC_parm_overview_restrictions {
1.396 albertel 7091: border: 1px solid black;
7092: border-collapse: collapse;
7093: }
1.795 www 7094:
1.1285 raeburn 7095: span.LC_parm_recursive,
7096: td.LC_parm_recursive {
7097: font-weight: bold;
7098: font-size: smaller;
7099: }
7100:
1.396 albertel 7101: table.LC_parm_overview_restrictions td {
7102: border-width: 1px 4px 1px 4px;
7103: border-style: solid;
7104: border-color: $pgbg;
7105: text-align: center;
7106: }
1.795 www 7107:
1.396 albertel 7108: table.LC_parm_overview_restrictions th {
7109: background: $tabbg;
7110: border-width: 1px 4px 1px 4px;
7111: border-style: solid;
7112: border-color: $pgbg;
7113: }
1.795 www 7114:
1.398 albertel 7115: table#LC_helpmenu {
1.803 bisitz 7116: border: none;
1.398 albertel 7117: height: 55px;
1.803 bisitz 7118: border-spacing: 0;
1.398 albertel 7119: }
7120:
7121: table#LC_helpmenu fieldset legend {
7122: font-size: larger;
7123: }
1.795 www 7124:
1.397 albertel 7125: table#LC_helpmenu_links {
7126: width: 100%;
7127: border: 1px solid black;
7128: background: $pgbg;
1.803 bisitz 7129: padding: 0;
1.397 albertel 7130: border-spacing: 1px;
7131: }
1.795 www 7132:
1.397 albertel 7133: table#LC_helpmenu_links tr td {
7134: padding: 1px;
7135: background: $tabbg;
1.399 albertel 7136: text-align: center;
7137: font-weight: bold;
1.397 albertel 7138: }
1.396 albertel 7139:
1.795 www 7140: table#LC_helpmenu_links a:link,
7141: table#LC_helpmenu_links a:visited,
1.397 albertel 7142: table#LC_helpmenu_links a:active {
7143: text-decoration: none;
7144: color: $font;
7145: }
1.795 www 7146:
1.397 albertel 7147: table#LC_helpmenu_links a:hover {
7148: text-decoration: underline;
7149: color: $vlink;
7150: }
1.396 albertel 7151:
1.417 albertel 7152: .LC_chrt_popup_exists {
7153: border: 1px solid #339933;
7154: margin: -1px;
7155: }
1.795 www 7156:
1.417 albertel 7157: .LC_chrt_popup_up {
7158: border: 1px solid yellow;
7159: margin: -1px;
7160: }
1.795 www 7161:
1.417 albertel 7162: .LC_chrt_popup {
7163: border: 1px solid #8888FF;
7164: background: #CCCCFF;
7165: }
1.795 www 7166:
1.421 albertel 7167: table.LC_pick_box {
7168: border-collapse: separate;
7169: background: white;
7170: border: 1px solid black;
7171: border-spacing: 1px;
7172: }
1.795 www 7173:
1.421 albertel 7174: table.LC_pick_box td.LC_pick_box_title {
1.850 bisitz 7175: background: $sidebg;
1.421 albertel 7176: font-weight: bold;
1.900 bisitz 7177: text-align: left;
1.740 bisitz 7178: vertical-align: top;
1.421 albertel 7179: width: 184px;
7180: padding: 8px;
7181: }
1.795 www 7182:
1.579 raeburn 7183: table.LC_pick_box td.LC_pick_box_value {
7184: text-align: left;
7185: padding: 8px;
7186: }
1.795 www 7187:
1.579 raeburn 7188: table.LC_pick_box td.LC_pick_box_select {
7189: text-align: left;
7190: padding: 8px;
7191: }
1.795 www 7192:
1.424 albertel 7193: table.LC_pick_box td.LC_pick_box_separator {
1.803 bisitz 7194: padding: 0;
1.421 albertel 7195: height: 1px;
7196: background: black;
7197: }
1.795 www 7198:
1.421 albertel 7199: table.LC_pick_box td.LC_pick_box_submit {
7200: text-align: right;
7201: }
1.795 www 7202:
1.579 raeburn 7203: table.LC_pick_box td.LC_evenrow_value {
7204: text-align: left;
7205: padding: 8px;
7206: background-color: $data_table_light;
7207: }
1.795 www 7208:
1.579 raeburn 7209: table.LC_pick_box td.LC_oddrow_value {
7210: text-align: left;
7211: padding: 8px;
7212: background-color: $data_table_light;
7213: }
1.795 www 7214:
1.579 raeburn 7215: span.LC_helpform_receipt_cat {
7216: font-weight: bold;
7217: }
1.795 www 7218:
1.424 albertel 7219: table.LC_group_priv_box {
7220: background: white;
7221: border: 1px solid black;
7222: border-spacing: 1px;
7223: }
1.795 www 7224:
1.424 albertel 7225: table.LC_group_priv_box td.LC_pick_box_title {
7226: background: $tabbg;
7227: font-weight: bold;
7228: text-align: right;
7229: width: 184px;
7230: }
1.795 www 7231:
1.424 albertel 7232: table.LC_group_priv_box td.LC_groups_fixed {
7233: background: $data_table_light;
7234: text-align: center;
7235: }
1.795 www 7236:
1.424 albertel 7237: table.LC_group_priv_box td.LC_groups_optional {
7238: background: $data_table_dark;
7239: text-align: center;
7240: }
1.795 www 7241:
1.424 albertel 7242: table.LC_group_priv_box td.LC_groups_functionality {
7243: background: $data_table_darker;
7244: text-align: center;
7245: font-weight: bold;
7246: }
1.795 www 7247:
1.424 albertel 7248: table.LC_group_priv td {
7249: text-align: left;
1.803 bisitz 7250: padding: 0;
1.424 albertel 7251: }
7252:
7253: .LC_navbuttons {
7254: margin: 2ex 0ex 2ex 0ex;
7255: }
1.795 www 7256:
1.423 albertel 7257: .LC_topic_bar {
7258: font-weight: bold;
7259: background: $tabbg;
1.918 wenzelju 7260: margin: 1em 0em 1em 2em;
1.805 bisitz 7261: padding: 3px;
1.918 wenzelju 7262: font-size: 1.2em;
1.423 albertel 7263: }
1.795 www 7264:
1.423 albertel 7265: .LC_topic_bar span {
1.918 wenzelju 7266: left: 0.5em;
7267: position: absolute;
1.423 albertel 7268: vertical-align: middle;
1.918 wenzelju 7269: font-size: 1.2em;
1.423 albertel 7270: }
1.795 www 7271:
1.423 albertel 7272: table.LC_course_group_status {
7273: margin: 20px;
7274: }
1.795 www 7275:
1.423 albertel 7276: table.LC_status_selector td {
7277: vertical-align: top;
7278: text-align: center;
1.424 albertel 7279: padding: 4px;
7280: }
1.795 www 7281:
1.599 albertel 7282: div.LC_feedback_link {
1.616 albertel 7283: clear: both;
1.829 kalberla 7284: background: $sidebg;
1.779 bisitz 7285: width: 100%;
1.829 kalberla 7286: padding-bottom: 10px;
7287: border: 1px $tabbg solid;
1.833 kalberla 7288: height: 22px;
7289: line-height: 22px;
7290: padding-top: 5px;
7291: }
7292:
7293: div.LC_feedback_link img {
7294: height: 22px;
1.867 kalberla 7295: vertical-align:middle;
1.829 kalberla 7296: }
7297:
1.911 bisitz 7298: div.LC_feedback_link a {
1.829 kalberla 7299: text-decoration: none;
1.489 raeburn 7300: }
1.795 www 7301:
1.867 kalberla 7302: div.LC_comblock {
1.911 bisitz 7303: display:inline;
1.867 kalberla 7304: color:$font;
7305: font-size:90%;
7306: }
7307:
7308: div.LC_feedback_link div.LC_comblock {
7309: padding-left:5px;
7310: }
7311:
7312: div.LC_feedback_link div.LC_comblock a {
7313: color:$font;
7314: }
7315:
1.489 raeburn 7316: span.LC_feedback_link {
1.858 bisitz 7317: /* background: $feedback_link_bg; */
1.599 albertel 7318: font-size: larger;
7319: }
1.795 www 7320:
1.599 albertel 7321: span.LC_message_link {
1.858 bisitz 7322: /* background: $feedback_link_bg; */
1.599 albertel 7323: font-size: larger;
7324: position: absolute;
7325: right: 1em;
1.489 raeburn 7326: }
1.421 albertel 7327:
1.515 albertel 7328: table.LC_prior_tries {
1.524 albertel 7329: border: 1px solid #000000;
7330: border-collapse: separate;
7331: border-spacing: 1px;
1.515 albertel 7332: }
1.523 albertel 7333:
1.515 albertel 7334: table.LC_prior_tries td {
1.524 albertel 7335: padding: 2px;
1.515 albertel 7336: }
1.523 albertel 7337:
7338: .LC_answer_correct {
1.795 www 7339: background: lightgreen;
7340: color: darkgreen;
7341: padding: 6px;
1.523 albertel 7342: }
1.795 www 7343:
1.523 albertel 7344: .LC_answer_charged_try {
1.797 www 7345: background: #FFAAAA;
1.795 www 7346: color: darkred;
7347: padding: 6px;
1.523 albertel 7348: }
1.795 www 7349:
1.779 bisitz 7350: .LC_answer_not_charged_try,
1.523 albertel 7351: .LC_answer_no_grade,
7352: .LC_answer_late {
1.795 www 7353: background: lightyellow;
1.523 albertel 7354: color: black;
1.795 www 7355: padding: 6px;
1.523 albertel 7356: }
1.795 www 7357:
1.523 albertel 7358: .LC_answer_previous {
1.795 www 7359: background: lightblue;
7360: color: darkblue;
7361: padding: 6px;
1.523 albertel 7362: }
1.795 www 7363:
1.779 bisitz 7364: .LC_answer_no_message {
1.777 tempelho 7365: background: #FFFFFF;
7366: color: black;
1.795 www 7367: padding: 6px;
1.779 bisitz 7368: }
1.795 www 7369:
1.1334 raeburn 7370: .LC_answer_unknown,
7371: .LC_answer_warning {
1.779 bisitz 7372: background: orange;
7373: color: black;
1.795 www 7374: padding: 6px;
1.777 tempelho 7375: }
1.795 www 7376:
1.529 albertel 7377: span.LC_prior_numerical,
7378: span.LC_prior_string,
7379: span.LC_prior_custom,
7380: span.LC_prior_reaction,
7381: span.LC_prior_math {
1.925 bisitz 7382: font-family: $mono;
1.523 albertel 7383: white-space: pre;
7384: }
7385:
1.525 albertel 7386: span.LC_prior_string {
1.925 bisitz 7387: font-family: $mono;
1.525 albertel 7388: white-space: pre;
7389: }
7390:
1.523 albertel 7391: table.LC_prior_option {
7392: width: 100%;
7393: border-collapse: collapse;
7394: }
1.795 www 7395:
1.911 bisitz 7396: table.LC_prior_rank,
1.795 www 7397: table.LC_prior_match {
1.528 albertel 7398: border-collapse: collapse;
7399: }
1.795 www 7400:
1.528 albertel 7401: table.LC_prior_option tr td,
7402: table.LC_prior_rank tr td,
7403: table.LC_prior_match tr td {
1.524 albertel 7404: border: 1px solid #000000;
1.515 albertel 7405: }
7406:
1.855 bisitz 7407: .LC_nobreak {
1.544 albertel 7408: white-space: nowrap;
1.519 raeburn 7409: }
7410:
1.576 raeburn 7411: span.LC_cusr_emph {
7412: font-style: italic;
7413: }
7414:
1.633 raeburn 7415: span.LC_cusr_subheading {
7416: font-weight: normal;
7417: font-size: 85%;
7418: }
7419:
1.861 bisitz 7420: div.LC_docs_entry_move {
1.859 bisitz 7421: border: 1px solid #BBBBBB;
1.545 albertel 7422: background: #DDDDDD;
1.861 bisitz 7423: width: 22px;
1.859 bisitz 7424: padding: 1px;
7425: margin: 0;
1.545 albertel 7426: }
7427:
1.861 bisitz 7428: table.LC_data_table tr > td.LC_docs_entry_commands,
7429: table.LC_data_table tr > td.LC_docs_entry_parameter {
1.545 albertel 7430: font-size: x-small;
7431: }
1.795 www 7432:
1.861 bisitz 7433: .LC_docs_entry_parameter {
7434: white-space: nowrap;
7435: }
7436:
1.544 albertel 7437: .LC_docs_copy {
1.545 albertel 7438: color: #000099;
1.544 albertel 7439: }
1.795 www 7440:
1.544 albertel 7441: .LC_docs_cut {
1.545 albertel 7442: color: #550044;
1.544 albertel 7443: }
1.795 www 7444:
1.544 albertel 7445: .LC_docs_rename {
1.545 albertel 7446: color: #009900;
1.544 albertel 7447: }
1.795 www 7448:
1.544 albertel 7449: .LC_docs_remove {
1.545 albertel 7450: color: #990000;
7451: }
7452:
1.1284 raeburn 7453: .LC_docs_alias {
7454: color: #440055;
7455: }
7456:
1.1286 raeburn 7457: .LC_domprefs_email,
1.1284 raeburn 7458: .LC_docs_alias_name,
1.547 albertel 7459: .LC_docs_reinit_warn,
7460: .LC_docs_ext_edit {
7461: font-size: x-small;
7462: }
7463:
1.545 albertel 7464: table.LC_docs_adddocs td,
7465: table.LC_docs_adddocs th {
7466: border: 1px solid #BBBBBB;
7467: padding: 4px;
7468: background: #DDDDDD;
1.543 albertel 7469: }
7470:
1.584 albertel 7471: table.LC_sty_begin {
7472: background: #BBFFBB;
7473: }
1.795 www 7474:
1.584 albertel 7475: table.LC_sty_end {
7476: background: #FFBBBB;
7477: }
7478:
1.589 raeburn 7479: table.LC_double_column {
1.803 bisitz 7480: border-width: 0;
1.589 raeburn 7481: border-collapse: collapse;
7482: width: 100%;
7483: padding: 2px;
7484: }
7485:
7486: table.LC_double_column tr td.LC_left_col {
1.590 raeburn 7487: top: 2px;
1.589 raeburn 7488: left: 2px;
7489: width: 47%;
7490: vertical-align: top;
7491: }
7492:
7493: table.LC_double_column tr td.LC_right_col {
7494: top: 2px;
1.779 bisitz 7495: right: 2px;
1.589 raeburn 7496: width: 47%;
7497: vertical-align: top;
7498: }
7499:
1.591 raeburn 7500: div.LC_left_float {
7501: float: left;
7502: padding-right: 5%;
1.597 albertel 7503: padding-bottom: 4px;
1.591 raeburn 7504: }
7505:
7506: div.LC_clear_float_header {
1.597 albertel 7507: padding-bottom: 2px;
1.591 raeburn 7508: }
7509:
7510: div.LC_clear_float_footer {
1.597 albertel 7511: padding-top: 10px;
1.591 raeburn 7512: clear: both;
7513: }
7514:
1.597 albertel 7515: div.LC_grade_show_user {
1.941 bisitz 7516: /* border-left: 5px solid $sidebg; */
7517: border-top: 5px solid #000000;
7518: margin: 50px 0 0 0;
1.936 bisitz 7519: padding: 15px 0 5px 10px;
1.597 albertel 7520: }
1.795 www 7521:
1.936 bisitz 7522: div.LC_grade_show_user_odd_row {
1.941 bisitz 7523: /* border-left: 5px solid #000000; */
7524: }
7525:
7526: div.LC_grade_show_user div.LC_Box {
7527: margin-right: 50px;
1.597 albertel 7528: }
7529:
7530: div.LC_grade_submissions,
7531: div.LC_grade_message_center,
1.936 bisitz 7532: div.LC_grade_info_links {
1.597 albertel 7533: margin: 5px;
7534: width: 99%;
7535: background: #FFFFFF;
7536: }
1.795 www 7537:
1.597 albertel 7538: div.LC_grade_submissions_header,
1.936 bisitz 7539: div.LC_grade_message_center_header {
1.705 tempelho 7540: font-weight: bold;
7541: font-size: large;
1.597 albertel 7542: }
1.795 www 7543:
1.597 albertel 7544: div.LC_grade_submissions_body,
1.936 bisitz 7545: div.LC_grade_message_center_body {
1.597 albertel 7546: border: 1px solid black;
7547: width: 99%;
7548: background: #FFFFFF;
7549: }
1.795 www 7550:
1.613 albertel 7551: table.LC_scantron_action {
7552: width: 100%;
7553: }
1.795 www 7554:
1.613 albertel 7555: table.LC_scantron_action tr th {
1.698 harmsja 7556: font-weight:bold;
7557: font-style:normal;
1.613 albertel 7558: }
1.795 www 7559:
1.779 bisitz 7560: .LC_edit_problem_header,
1.614 albertel 7561: div.LC_edit_problem_footer {
1.705 tempelho 7562: font-weight: normal;
7563: font-size: medium;
1.602 albertel 7564: margin: 2px;
1.1060 bisitz 7565: background-color: $sidebg;
1.600 albertel 7566: }
1.795 www 7567:
1.600 albertel 7568: div.LC_edit_problem_header,
1.602 albertel 7569: div.LC_edit_problem_header div,
1.614 albertel 7570: div.LC_edit_problem_footer,
7571: div.LC_edit_problem_footer div,
1.602 albertel 7572: div.LC_edit_problem_editxml_header,
7573: div.LC_edit_problem_editxml_header div {
1.1205 golterma 7574: z-index: 100;
1.600 albertel 7575: }
1.795 www 7576:
1.600 albertel 7577: div.LC_edit_problem_header_title {
1.705 tempelho 7578: font-weight: bold;
7579: font-size: larger;
1.602 albertel 7580: background: $tabbg;
7581: padding: 3px;
1.1060 bisitz 7582: margin: 0 0 5px 0;
1.602 albertel 7583: }
1.795 www 7584:
1.602 albertel 7585: table.LC_edit_problem_header_title {
7586: width: 100%;
1.600 albertel 7587: background: $tabbg;
1.602 albertel 7588: }
7589:
1.1205 golterma 7590: div.LC_edit_actionbar {
7591: background-color: $sidebg;
1.1218 droeschl 7592: margin: 0;
7593: padding: 0;
7594: line-height: 200%;
1.602 albertel 7595: }
1.795 www 7596:
1.1218 droeschl 7597: div.LC_edit_actionbar div{
7598: padding: 0;
7599: margin: 0;
7600: display: inline-block;
1.600 albertel 7601: }
1.795 www 7602:
1.1124 bisitz 7603: .LC_edit_opt {
7604: padding-left: 1em;
7605: white-space: nowrap;
7606: }
7607:
1.1152 golterma 7608: .LC_edit_problem_latexhelper{
7609: text-align: right;
7610: }
7611:
7612: #LC_edit_problem_colorful div{
7613: margin-left: 40px;
7614: }
7615:
1.1205 golterma 7616: #LC_edit_problem_codemirror div{
7617: margin-left: 0px;
7618: }
7619:
1.911 bisitz 7620: img.stift {
1.803 bisitz 7621: border-width: 0;
7622: vertical-align: middle;
1.677 riegler 7623: }
1.680 riegler 7624:
1.923 bisitz 7625: table td.LC_mainmenu_col_fieldset {
1.680 riegler 7626: vertical-align: top;
1.777 tempelho 7627: }
1.795 www 7628:
1.716 raeburn 7629: div.LC_createcourse {
1.911 bisitz 7630: margin: 10px 10px 10px 10px;
1.716 raeburn 7631: }
7632:
1.917 raeburn 7633: .LC_dccid {
1.1130 raeburn 7634: float: right;
1.917 raeburn 7635: margin: 0.2em 0 0 0;
7636: padding: 0;
7637: font-size: 90%;
7638: display:none;
7639: }
7640:
1.897 wenzelju 7641: ol.LC_primary_menu a:hover,
1.721 harmsja 7642: ol#LC_MenuBreadcrumbs a:hover,
7643: ol#LC_PathBreadcrumbs a:hover,
1.897 wenzelju 7644: ul#LC_secondary_menu a:hover,
1.721 harmsja 7645: .LC_FormSectionClearButton input:hover
1.795 www 7646: ul.LC_TabContent li:hover a {
1.952 onken 7647: color:$button_hover;
1.911 bisitz 7648: text-decoration:none;
1.693 droeschl 7649: }
7650:
1.779 bisitz 7651: h1 {
1.911 bisitz 7652: padding: 0;
7653: line-height:130%;
1.693 droeschl 7654: }
1.698 harmsja 7655:
1.911 bisitz 7656: h2,
7657: h3,
7658: h4,
7659: h5,
7660: h6 {
7661: margin: 5px 0 5px 0;
7662: padding: 0;
7663: line-height:130%;
1.693 droeschl 7664: }
1.795 www 7665:
7666: .LC_hcell {
1.911 bisitz 7667: padding:3px 15px 3px 15px;
7668: margin: 0;
7669: background-color:$tabbg;
7670: color:$fontmenu;
7671: border-bottom:solid 1px $lg_border_color;
1.693 droeschl 7672: }
1.795 www 7673:
1.840 bisitz 7674: .LC_Box > .LC_hcell {
1.911 bisitz 7675: margin: 0 -10px 10px -10px;
1.835 bisitz 7676: }
7677:
1.721 harmsja 7678: .LC_noBorder {
1.911 bisitz 7679: border: 0;
1.698 harmsja 7680: }
1.693 droeschl 7681:
1.721 harmsja 7682: .LC_FormSectionClearButton input {
1.911 bisitz 7683: background-color:transparent;
7684: border: none;
7685: cursor:pointer;
7686: text-decoration:underline;
1.693 droeschl 7687: }
1.763 bisitz 7688:
7689: .LC_help_open_topic {
1.911 bisitz 7690: color: #FFFFFF;
7691: background-color: #EEEEFF;
7692: margin: 1px;
7693: padding: 4px;
7694: border: 1px solid #000033;
7695: white-space: nowrap;
7696: /* vertical-align: middle; */
1.759 neumanie 7697: }
1.693 droeschl 7698:
1.911 bisitz 7699: dl,
7700: ul,
7701: div,
7702: fieldset {
7703: margin: 10px 10px 10px 0;
7704: /* overflow: hidden; */
1.693 droeschl 7705: }
1.795 www 7706:
1.1211 raeburn 7707: article.geogebraweb div {
7708: margin: 0;
7709: }
7710:
1.838 bisitz 7711: fieldset > legend {
1.911 bisitz 7712: font-weight: bold;
7713: padding: 0 5px 0 5px;
1.838 bisitz 7714: }
7715:
1.813 bisitz 7716: #LC_nav_bar {
1.911 bisitz 7717: float: left;
1.995 raeburn 7718: background-color: $pgbg_or_bgcolor;
1.966 bisitz 7719: margin: 0 0 2px 0;
1.807 droeschl 7720: }
7721:
1.916 droeschl 7722: #LC_realm {
7723: margin: 0.2em 0 0 0;
7724: padding: 0;
7725: font-weight: bold;
7726: text-align: center;
1.995 raeburn 7727: background-color: $pgbg_or_bgcolor;
1.916 droeschl 7728: }
7729:
1.911 bisitz 7730: #LC_nav_bar em {
7731: font-weight: bold;
7732: font-style: normal;
1.807 droeschl 7733: }
7734:
1.897 wenzelju 7735: ol.LC_primary_menu {
1.934 droeschl 7736: margin: 0;
1.1076 raeburn 7737: padding: 0;
1.807 droeschl 7738: }
7739:
1.852 droeschl 7740: ol#LC_PathBreadcrumbs {
1.911 bisitz 7741: margin: 0;
1.693 droeschl 7742: }
7743:
1.897 wenzelju 7744: ol.LC_primary_menu li {
1.1076 raeburn 7745: color: RGB(80, 80, 80);
7746: vertical-align: middle;
7747: text-align: left;
7748: list-style: none;
1.1205 golterma 7749: position: relative;
1.1076 raeburn 7750: float: left;
1.1205 golterma 7751: z-index: 100; /* will be displayed above codemirror and underneath the help-layer */
7752: line-height: 1.5em;
1.1076 raeburn 7753: }
7754:
1.1205 golterma 7755: ol.LC_primary_menu li a,
7756: ol.LC_primary_menu li p {
1.1076 raeburn 7757: display: block;
7758: margin: 0;
7759: padding: 0 5px 0 10px;
7760: text-decoration: none;
7761: }
7762:
1.1205 golterma 7763: ol.LC_primary_menu li p span.LC_primary_menu_innertitle {
7764: display: inline-block;
7765: width: 95%;
7766: text-align: left;
7767: }
7768:
7769: ol.LC_primary_menu li p span.LC_primary_menu_innerarrow {
7770: display: inline-block;
7771: width: 5%;
7772: float: right;
7773: text-align: right;
7774: font-size: 70%;
7775: }
7776:
7777: ol.LC_primary_menu ul {
1.1076 raeburn 7778: display: none;
1.1205 golterma 7779: width: 15em;
1.1076 raeburn 7780: background-color: $data_table_light;
1.1205 golterma 7781: position: absolute;
7782: top: 100%;
1.1076 raeburn 7783: }
7784:
1.1205 golterma 7785: ol.LC_primary_menu ul ul {
7786: left: 100%;
7787: top: 0;
7788: }
7789:
7790: ol.LC_primary_menu li:hover > ul, ol.LC_primary_menu li.hover > ul {
1.1076 raeburn 7791: display: block;
7792: position: absolute;
7793: margin: 0;
7794: padding: 0;
1.1078 raeburn 7795: z-index: 2;
1.1076 raeburn 7796: }
7797:
7798: ol.LC_primary_menu li:hover li, ol.LC_primary_menu li.hover li {
1.1205 golterma 7799: /* First Submenu -> size should be smaller than the menu title of the whole menu */
1.1076 raeburn 7800: font-size: 90%;
1.911 bisitz 7801: vertical-align: top;
1.1076 raeburn 7802: float: none;
1.1079 raeburn 7803: border-left: 1px solid black;
7804: border-right: 1px solid black;
1.1205 golterma 7805: /* A dark bottom border to visualize different menu options;
7806: overwritten in the create_submenu routine for the last border-bottom of the menu */
7807: border-bottom: 1px solid $data_table_dark;
1.1076 raeburn 7808: }
7809:
1.1205 golterma 7810: ol.LC_primary_menu li li p:hover {
7811: color:$button_hover;
7812: text-decoration:none;
7813: background-color:$data_table_dark;
1.1076 raeburn 7814: }
7815:
7816: ol.LC_primary_menu li li a:hover {
7817: color:$button_hover;
7818: background-color:$data_table_dark;
1.693 droeschl 7819: }
7820:
1.1205 golterma 7821: /* Font-size equal to the size of the predecessors*/
7822: ol.LC_primary_menu li:hover li li {
7823: font-size: 100%;
7824: }
7825:
1.897 wenzelju 7826: ol.LC_primary_menu li img {
1.911 bisitz 7827: vertical-align: bottom;
1.934 droeschl 7828: height: 1.1em;
1.1077 raeburn 7829: margin: 0.2em 0 0 0;
1.693 droeschl 7830: }
7831:
1.897 wenzelju 7832: ol.LC_primary_menu a {
1.911 bisitz 7833: color: RGB(80, 80, 80);
7834: text-decoration: none;
1.693 droeschl 7835: }
1.795 www 7836:
1.949 droeschl 7837: ol.LC_primary_menu a.LC_new_message {
7838: font-weight:bold;
7839: color: darkred;
7840: }
7841:
1.975 raeburn 7842: ol.LC_docs_parameters {
7843: margin-left: 0;
7844: padding: 0;
7845: list-style: none;
7846: }
7847:
7848: ol.LC_docs_parameters li {
7849: margin: 0;
7850: padding-right: 20px;
7851: display: inline;
7852: }
7853:
1.976 raeburn 7854: ol.LC_docs_parameters li:before {
7855: content: "\\002022 \\0020";
7856: }
7857:
7858: li.LC_docs_parameters_title {
7859: font-weight: bold;
7860: }
7861:
7862: ol.LC_docs_parameters li.LC_docs_parameters_title:before {
7863: content: "";
7864: }
7865:
1.897 wenzelju 7866: ul#LC_secondary_menu {
1.1107 raeburn 7867: clear: right;
1.911 bisitz 7868: color: $fontmenu;
7869: background: $tabbg;
7870: list-style: none;
7871: padding: 0;
7872: margin: 0;
7873: width: 100%;
1.995 raeburn 7874: text-align: left;
1.1107 raeburn 7875: float: left;
1.808 droeschl 7876: }
7877:
1.897 wenzelju 7878: ul#LC_secondary_menu li {
1.911 bisitz 7879: font-weight: bold;
7880: line-height: 1.8em;
1.1107 raeburn 7881: border-right: 1px solid black;
7882: float: left;
7883: }
7884:
7885: ul#LC_secondary_menu li.LC_hoverable:hover, ul#LC_secondary_menu li.hover {
7886: background-color: $data_table_light;
7887: }
7888:
7889: ul#LC_secondary_menu li a {
1.911 bisitz 7890: padding: 0 0.8em;
1.1107 raeburn 7891: }
7892:
7893: ul#LC_secondary_menu li ul {
7894: display: none;
7895: }
7896:
7897: ul#LC_secondary_menu li:hover ul, ul#LC_secondary_menu li.hover ul {
7898: display: block;
7899: position: absolute;
7900: margin: 0;
7901: padding: 0;
7902: list-style:none;
7903: float: none;
7904: background-color: $data_table_light;
7905: z-index: 2;
7906: margin-left: -1px;
7907: }
7908:
7909: ul#LC_secondary_menu li ul li {
7910: font-size: 90%;
7911: vertical-align: top;
7912: border-left: 1px solid black;
1.911 bisitz 7913: border-right: 1px solid black;
1.1119 raeburn 7914: background-color: $data_table_light;
1.1107 raeburn 7915: list-style:none;
7916: float: none;
7917: }
7918:
7919: ul#LC_secondary_menu li ul li:hover, ul#LC_secondary_menu li ul li.hover {
7920: background-color: $data_table_dark;
1.807 droeschl 7921: }
7922:
1.847 tempelho 7923: ul.LC_TabContent {
1.911 bisitz 7924: display:block;
7925: background: $sidebg;
7926: border-bottom: solid 1px $lg_border_color;
7927: list-style:none;
1.1020 raeburn 7928: margin: -1px -10px 0 -10px;
1.911 bisitz 7929: padding: 0;
1.693 droeschl 7930: }
7931:
1.795 www 7932: ul.LC_TabContent li,
7933: ul.LC_TabContentBigger li {
1.911 bisitz 7934: float:left;
1.741 harmsja 7935: }
1.795 www 7936:
1.897 wenzelju 7937: ul#LC_secondary_menu li a {
1.911 bisitz 7938: color: $fontmenu;
7939: text-decoration: none;
1.693 droeschl 7940: }
1.795 www 7941:
1.721 harmsja 7942: ul.LC_TabContent {
1.952 onken 7943: min-height:20px;
1.721 harmsja 7944: }
1.795 www 7945:
7946: ul.LC_TabContent li {
1.911 bisitz 7947: vertical-align:middle;
1.959 onken 7948: padding: 0 16px 0 10px;
1.911 bisitz 7949: background-color:$tabbg;
7950: border-bottom:solid 1px $lg_border_color;
1.1020 raeburn 7951: border-left: solid 1px $font;
1.721 harmsja 7952: }
1.795 www 7953:
1.847 tempelho 7954: ul.LC_TabContent .right {
1.911 bisitz 7955: float:right;
1.847 tempelho 7956: }
7957:
1.911 bisitz 7958: ul.LC_TabContent li a,
7959: ul.LC_TabContent li {
7960: color:rgb(47,47,47);
7961: text-decoration:none;
7962: font-size:95%;
7963: font-weight:bold;
1.952 onken 7964: min-height:20px;
7965: }
7966:
1.959 onken 7967: ul.LC_TabContent li a:hover,
7968: ul.LC_TabContent li a:focus {
1.952 onken 7969: color: $button_hover;
1.959 onken 7970: background:none;
7971: outline:none;
1.952 onken 7972: }
7973:
7974: ul.LC_TabContent li:hover {
7975: color: $button_hover;
7976: cursor:pointer;
1.721 harmsja 7977: }
1.795 www 7978:
1.911 bisitz 7979: ul.LC_TabContent li.active {
1.952 onken 7980: color: $font;
1.911 bisitz 7981: background:#FFFFFF url(/adm/lonIcons/open.gif) no-repeat scroll right center;
1.952 onken 7982: border-bottom:solid 1px #FFFFFF;
7983: cursor: default;
1.744 ehlerst 7984: }
1.795 www 7985:
1.959 onken 7986: ul.LC_TabContent li.active a {
7987: color:$font;
7988: background:#FFFFFF;
7989: outline: none;
7990: }
1.1047 raeburn 7991:
7992: ul.LC_TabContent li.goback {
7993: float: left;
7994: border-left: none;
7995: }
7996:
1.870 tempelho 7997: #maincoursedoc {
1.911 bisitz 7998: clear:both;
1.870 tempelho 7999: }
8000:
8001: ul.LC_TabContentBigger {
1.911 bisitz 8002: display:block;
8003: list-style:none;
8004: padding: 0;
1.870 tempelho 8005: }
8006:
1.795 www 8007: ul.LC_TabContentBigger li {
1.911 bisitz 8008: vertical-align:bottom;
8009: height: 30px;
8010: font-size:110%;
8011: font-weight:bold;
8012: color: #737373;
1.841 tempelho 8013: }
8014:
1.957 onken 8015: ul.LC_TabContentBigger li.active {
8016: position: relative;
8017: top: 1px;
8018: }
8019:
1.870 tempelho 8020: ul.LC_TabContentBigger li a {
1.911 bisitz 8021: background:url('/adm/lonIcons/tabbgleft.gif') left bottom no-repeat;
8022: height: 30px;
8023: line-height: 30px;
8024: text-align: center;
8025: display: block;
8026: text-decoration: none;
1.958 onken 8027: outline: none;
1.741 harmsja 8028: }
1.795 www 8029:
1.870 tempelho 8030: ul.LC_TabContentBigger li.active a {
1.911 bisitz 8031: background:url('/adm/lonIcons/tabbgleft.gif') left top no-repeat;
8032: color:$font;
1.744 ehlerst 8033: }
1.795 www 8034:
1.870 tempelho 8035: ul.LC_TabContentBigger li b {
1.911 bisitz 8036: background: url('/adm/lonIcons/tabbgright.gif') no-repeat right bottom;
8037: display: block;
8038: float: left;
8039: padding: 0 30px;
1.957 onken 8040: border-bottom: 1px solid $lg_border_color;
1.870 tempelho 8041: }
8042:
1.956 onken 8043: ul.LC_TabContentBigger li:hover b {
8044: color:$button_hover;
8045: }
8046:
1.870 tempelho 8047: ul.LC_TabContentBigger li.active b {
1.911 bisitz 8048: background:url('/adm/lonIcons/tabbgright.gif') right top no-repeat;
8049: color:$font;
1.957 onken 8050: border: 0;
1.741 harmsja 8051: }
1.693 droeschl 8052:
1.870 tempelho 8053:
1.862 bisitz 8054: ul.LC_CourseBreadcrumbs {
8055: background: $sidebg;
1.1020 raeburn 8056: height: 2em;
1.862 bisitz 8057: padding-left: 10px;
1.1020 raeburn 8058: margin: 0;
1.862 bisitz 8059: list-style-position: inside;
8060: }
8061:
1.911 bisitz 8062: ol#LC_MenuBreadcrumbs,
1.862 bisitz 8063: ol#LC_PathBreadcrumbs {
1.911 bisitz 8064: padding-left: 10px;
8065: margin: 0;
1.933 droeschl 8066: height: 2.5em; /* equal to #LC_breadcrumbs line-height */
1.693 droeschl 8067: }
8068:
1.911 bisitz 8069: ol#LC_MenuBreadcrumbs li,
8070: ol#LC_PathBreadcrumbs li,
1.862 bisitz 8071: ul.LC_CourseBreadcrumbs li {
1.911 bisitz 8072: display: inline;
1.933 droeschl 8073: white-space: normal;
1.693 droeschl 8074: }
8075:
1.823 bisitz 8076: ol#LC_MenuBreadcrumbs li a,
1.862 bisitz 8077: ul.LC_CourseBreadcrumbs li a {
1.911 bisitz 8078: text-decoration: none;
8079: font-size:90%;
1.693 droeschl 8080: }
1.795 www 8081:
1.969 droeschl 8082: ol#LC_MenuBreadcrumbs h1 {
8083: display: inline;
8084: font-size: 90%;
8085: line-height: 2.5em;
8086: margin: 0;
8087: padding: 0;
8088: }
8089:
1.795 www 8090: ol#LC_PathBreadcrumbs li a {
1.911 bisitz 8091: text-decoration:none;
8092: font-size:100%;
8093: font-weight:bold;
1.693 droeschl 8094: }
1.795 www 8095:
1.840 bisitz 8096: .LC_Box {
1.911 bisitz 8097: border: solid 1px $lg_border_color;
8098: padding: 0 10px 10px 10px;
1.746 neumanie 8099: }
1.795 www 8100:
1.1020 raeburn 8101: .LC_DocsBox {
8102: border: solid 1px $lg_border_color;
8103: padding: 0 0 10px 10px;
8104: }
8105:
1.795 www 8106: .LC_AboutMe_Image {
1.911 bisitz 8107: float:left;
8108: margin-right:10px;
1.747 neumanie 8109: }
1.795 www 8110:
8111: .LC_Clear_AboutMe_Image {
1.911 bisitz 8112: clear:left;
1.747 neumanie 8113: }
1.795 www 8114:
1.721 harmsja 8115: dl.LC_ListStyleClean dt {
1.911 bisitz 8116: padding-right: 5px;
8117: display: table-header-group;
1.693 droeschl 8118: }
8119:
1.721 harmsja 8120: dl.LC_ListStyleClean dd {
1.911 bisitz 8121: display: table-row;
1.693 droeschl 8122: }
8123:
1.721 harmsja 8124: .LC_ListStyleClean,
8125: .LC_ListStyleSimple,
8126: .LC_ListStyleNormal,
1.795 www 8127: .LC_ListStyleSpecial {
1.911 bisitz 8128: /* display:block; */
8129: list-style-position: inside;
8130: list-style-type: none;
8131: overflow: hidden;
8132: padding: 0;
1.693 droeschl 8133: }
8134:
1.721 harmsja 8135: .LC_ListStyleSimple li,
8136: .LC_ListStyleSimple dd,
8137: .LC_ListStyleNormal li,
8138: .LC_ListStyleNormal dd,
8139: .LC_ListStyleSpecial li,
1.795 www 8140: .LC_ListStyleSpecial dd {
1.911 bisitz 8141: margin: 0;
8142: padding: 5px 5px 5px 10px;
8143: clear: both;
1.693 droeschl 8144: }
8145:
1.721 harmsja 8146: .LC_ListStyleClean li,
8147: .LC_ListStyleClean dd {
1.911 bisitz 8148: padding-top: 0;
8149: padding-bottom: 0;
1.693 droeschl 8150: }
8151:
1.721 harmsja 8152: .LC_ListStyleSimple dd,
1.795 www 8153: .LC_ListStyleSimple li {
1.911 bisitz 8154: border-bottom: solid 1px $lg_border_color;
1.693 droeschl 8155: }
8156:
1.721 harmsja 8157: .LC_ListStyleSpecial li,
8158: .LC_ListStyleSpecial dd {
1.911 bisitz 8159: list-style-type: none;
8160: background-color: RGB(220, 220, 220);
8161: margin-bottom: 4px;
1.693 droeschl 8162: }
8163:
1.721 harmsja 8164: table.LC_SimpleTable {
1.911 bisitz 8165: margin:5px;
8166: border:solid 1px $lg_border_color;
1.795 www 8167: }
1.693 droeschl 8168:
1.721 harmsja 8169: table.LC_SimpleTable tr {
1.911 bisitz 8170: padding: 0;
8171: border:solid 1px $lg_border_color;
1.693 droeschl 8172: }
1.795 www 8173:
8174: table.LC_SimpleTable thead {
1.911 bisitz 8175: background:rgb(220,220,220);
1.693 droeschl 8176: }
8177:
1.721 harmsja 8178: div.LC_columnSection {
1.911 bisitz 8179: display: block;
8180: clear: both;
8181: overflow: hidden;
8182: margin: 0;
1.693 droeschl 8183: }
8184:
1.721 harmsja 8185: div.LC_columnSection>* {
1.911 bisitz 8186: float: left;
8187: margin: 10px 20px 10px 0;
8188: overflow:hidden;
1.693 droeschl 8189: }
1.721 harmsja 8190:
1.795 www 8191: table em {
1.911 bisitz 8192: font-weight: bold;
8193: font-style: normal;
1.748 schulted 8194: }
1.795 www 8195:
1.779 bisitz 8196: table.LC_tableBrowseRes,
1.795 www 8197: table.LC_tableOfContent {
1.911 bisitz 8198: border:none;
8199: border-spacing: 1px;
8200: padding: 3px;
8201: background-color: #FFFFFF;
8202: font-size: 90%;
1.753 droeschl 8203: }
1.789 droeschl 8204:
1.911 bisitz 8205: table.LC_tableOfContent {
8206: border-collapse: collapse;
1.789 droeschl 8207: }
8208:
1.771 droeschl 8209: table.LC_tableBrowseRes a,
1.768 schulted 8210: table.LC_tableOfContent a {
1.911 bisitz 8211: background-color: transparent;
8212: text-decoration: none;
1.753 droeschl 8213: }
8214:
1.795 www 8215: table.LC_tableOfContent img {
1.911 bisitz 8216: border: none;
8217: height: 1.3em;
8218: vertical-align: text-bottom;
8219: margin-right: 0.3em;
1.753 droeschl 8220: }
1.757 schulted 8221:
1.795 www 8222: a#LC_content_toolbar_firsthomework {
1.911 bisitz 8223: background-image:url(/res/adm/pages/open-first-problem.gif);
1.774 ehlerst 8224: }
8225:
1.795 www 8226: a#LC_content_toolbar_everything {
1.911 bisitz 8227: background-image:url(/res/adm/pages/show-all.gif);
1.774 ehlerst 8228: }
8229:
1.795 www 8230: a#LC_content_toolbar_uncompleted {
1.911 bisitz 8231: background-image:url(/res/adm/pages/show-incomplete-problems.gif);
1.774 ehlerst 8232: }
8233:
1.795 www 8234: #LC_content_toolbar_clearbubbles {
1.911 bisitz 8235: background-image:url(/res/adm/pages/mark-discussionentries-read.gif);
1.774 ehlerst 8236: }
8237:
1.795 www 8238: a#LC_content_toolbar_changefolder {
1.911 bisitz 8239: background : url(/res/adm/pages/close-all-folders.gif) top center ;
1.757 schulted 8240: }
8241:
1.795 www 8242: a#LC_content_toolbar_changefolder_toggled {
1.911 bisitz 8243: background-image:url(/res/adm/pages/open-all-folders.gif);
1.757 schulted 8244: }
8245:
1.1043 raeburn 8246: a#LC_content_toolbar_edittoplevel {
8247: background-image:url(/res/adm/pages/edittoplevel.gif);
8248: }
8249:
1.795 www 8250: ul#LC_toolbar li a:hover {
1.911 bisitz 8251: background-position: bottom center;
1.757 schulted 8252: }
8253:
1.795 www 8254: ul#LC_toolbar {
1.911 bisitz 8255: padding: 0;
8256: margin: 2px;
8257: list-style:none;
8258: position:relative;
8259: background-color:white;
1.1082 raeburn 8260: overflow: auto;
1.757 schulted 8261: }
8262:
1.795 www 8263: ul#LC_toolbar li {
1.911 bisitz 8264: border:1px solid white;
8265: padding: 0;
8266: margin: 0;
8267: float: left;
8268: display:inline;
8269: vertical-align:middle;
1.1082 raeburn 8270: white-space: nowrap;
1.911 bisitz 8271: }
1.757 schulted 8272:
1.783 amueller 8273:
1.795 www 8274: a.LC_toolbarItem {
1.911 bisitz 8275: display:block;
8276: padding: 0;
8277: margin: 0;
8278: height: 32px;
8279: width: 32px;
8280: color:white;
8281: border: none;
8282: background-repeat:no-repeat;
8283: background-color:transparent;
1.757 schulted 8284: }
8285:
1.915 droeschl 8286: ul.LC_funclist {
8287: margin: 0;
8288: padding: 0.5em 1em 0.5em 0;
8289: }
8290:
1.933 droeschl 8291: ul.LC_funclist > li:first-child {
8292: font-weight:bold;
8293: margin-left:0.8em;
8294: }
8295:
1.915 droeschl 8296: ul.LC_funclist + ul.LC_funclist {
8297: /*
8298: left border as a seperator if we have more than
8299: one list
8300: */
8301: border-left: 1px solid $sidebg;
8302: /*
8303: this hides the left border behind the border of the
8304: outer box if element is wrapped to the next 'line'
8305: */
8306: margin-left: -1px;
8307: }
8308:
1.843 bisitz 8309: ul.LC_funclist li {
1.915 droeschl 8310: display: inline;
1.782 bisitz 8311: white-space: nowrap;
1.915 droeschl 8312: margin: 0 0 0 25px;
8313: line-height: 150%;
1.782 bisitz 8314: }
8315:
1.974 wenzelju 8316: .LC_hidden {
8317: display: none;
8318: }
8319:
1.1030 www 8320: .LCmodal-overlay {
8321: position:fixed;
8322: top:0;
8323: right:0;
8324: bottom:0;
8325: left:0;
8326: height:100%;
8327: width:100%;
8328: margin:0;
8329: padding:0;
8330: background:#999;
8331: opacity:.75;
8332: filter: alpha(opacity=75);
8333: -moz-opacity: 0.75;
8334: z-index:101;
8335: }
8336:
8337: * html .LCmodal-overlay {
8338: position: absolute;
8339: height: expression(document.body.scrollHeight > document.body.offsetHeight ? document.body.scrollHeight : document.body.offsetHeight + 'px');
8340: }
8341:
8342: .LCmodal-window {
8343: position:fixed;
8344: top:50%;
8345: left:50%;
8346: margin:0;
8347: padding:0;
8348: z-index:102;
8349: }
8350:
8351: * html .LCmodal-window {
8352: position:absolute;
8353: }
8354:
8355: .LCclose-window {
8356: position:absolute;
8357: width:32px;
8358: height:32px;
8359: right:8px;
8360: top:8px;
8361: background:transparent url('/res/adm/pages/process-stop.png') no-repeat scroll right top;
8362: text-indent:-99999px;
8363: overflow:hidden;
8364: cursor:pointer;
8365: }
8366:
1.1335 raeburn 8367: pre.LC_wordwrap {
8368: white-space: pre-wrap;
8369: white-space: -moz-pre-wrap;
8370: white-space: -pre-wrap;
8371: white-space: -o-pre-wrap;
8372: word-wrap: break-word;
8373: }
8374:
1.1100 raeburn 8375: /*
1.1231 damieng 8376: styles used for response display
8377: */
8378: div.LC_radiofoil, div.LC_rankfoil {
8379: margin: .5em 0em .5em 0em;
8380: }
8381: table.LC_itemgroup {
8382: margin-top: 1em;
8383: }
8384:
8385: /*
1.1100 raeburn 8386: styles used by TTH when "Default set of options to pass to tth/m
8387: when converting TeX" in course settings has been set
8388:
8389: option passed: -t
8390:
8391: */
8392:
8393: td div.comp { margin-top: -0.6ex; margin-bottom: -1ex;}
8394: td div.comb { margin-top: -0.6ex; margin-bottom: -.6ex;}
8395: td div.hrcomp { line-height: 0.9; margin-top: -0.8ex; margin-bottom: -1ex;}
8396: td div.norm {line-height:normal;}
8397:
8398: /*
8399: option passed -y3
8400: */
8401:
8402: span.roman {font-family: serif; font-style: normal; font-weight: normal;}
8403: span.overacc2 {position: relative; left: .8em; top: -1.2ex;}
8404: span.overacc1 {position: relative; left: .6em; top: -1.2ex;}
8405:
1.1230 damieng 8406: /*
8407: sections with roles, for content only
8408: */
8409: section[class^="role-"] {
8410: padding-left: 10px;
8411: padding-right: 5px;
8412: margin-top: 8px;
8413: margin-bottom: 8px;
8414: border: 1px solid #2A4;
8415: border-radius: 5px;
8416: box-shadow: 0px 1px 1px #BBB;
8417: }
8418: section[class^="role-"]>h1 {
8419: position: relative;
8420: margin: 0px;
8421: padding-top: 10px;
8422: padding-left: 40px;
8423: }
8424: section[class^="role-"]>h1:before {
8425: position: absolute;
8426: left: -5px;
8427: top: 5px;
8428: }
8429: section.role-activity>h1:before {
8430: content:url('/adm/daxe/images/section_icons/activity.png');
8431: }
8432: section.role-advice>h1:before {
8433: content:url('/adm/daxe/images/section_icons/advice.png');
8434: }
8435: section.role-bibliography>h1:before {
8436: content:url('/adm/daxe/images/section_icons/bibliography.png');
8437: }
8438: section.role-citation>h1:before {
8439: content:url('/adm/daxe/images/section_icons/citation.png');
8440: }
8441: section.role-conclusion>h1:before {
8442: content:url('/adm/daxe/images/section_icons/conclusion.png');
8443: }
8444: section.role-definition>h1:before {
8445: content:url('/adm/daxe/images/section_icons/definition.png');
8446: }
8447: section.role-demonstration>h1:before {
8448: content:url('/adm/daxe/images/section_icons/demonstration.png');
8449: }
8450: section.role-example>h1:before {
8451: content:url('/adm/daxe/images/section_icons/example.png');
8452: }
8453: section.role-explanation>h1:before {
8454: content:url('/adm/daxe/images/section_icons/explanation.png');
8455: }
8456: section.role-introduction>h1:before {
8457: content:url('/adm/daxe/images/section_icons/introduction.png');
8458: }
8459: section.role-method>h1:before {
8460: content:url('/adm/daxe/images/section_icons/method.png');
8461: }
8462: section.role-more_information>h1:before {
8463: content:url('/adm/daxe/images/section_icons/more_information.png');
8464: }
8465: section.role-objectives>h1:before {
8466: content:url('/adm/daxe/images/section_icons/objectives.png');
8467: }
8468: section.role-prerequisites>h1:before {
8469: content:url('/adm/daxe/images/section_icons/prerequisites.png');
8470: }
8471: section.role-remark>h1:before {
8472: content:url('/adm/daxe/images/section_icons/remark.png');
8473: }
8474: section.role-reminder>h1:before {
8475: content:url('/adm/daxe/images/section_icons/reminder.png');
8476: }
8477: section.role-summary>h1:before {
8478: content:url('/adm/daxe/images/section_icons/summary.png');
8479: }
8480: section.role-syntax>h1:before {
8481: content:url('/adm/daxe/images/section_icons/syntax.png');
8482: }
8483: section.role-warning>h1:before {
8484: content:url('/adm/daxe/images/section_icons/warning.png');
8485: }
8486:
1.1269 raeburn 8487: #LC_minitab_header {
8488: float:left;
8489: width:100%;
8490: background:#DAE0D2 url("/res/adm/pages/minitabmenu_bg.gif") repeat-x bottom;
8491: font-size:93%;
8492: line-height:normal;
8493: margin: 0.5em 0 0.5em 0;
8494: }
8495: #LC_minitab_header ul {
8496: margin:0;
8497: padding:10px 10px 0;
8498: list-style:none;
8499: }
8500: #LC_minitab_header li {
8501: float:left;
8502: background:url("/res/adm/pages/minitabmenu_left.gif") no-repeat left top;
8503: margin:0;
8504: padding:0 0 0 9px;
8505: }
8506: #LC_minitab_header a {
8507: display:block;
8508: background:url("/res/adm/pages/minitabmenu_right.gif") no-repeat right top;
8509: padding:5px 15px 4px 6px;
8510: }
8511: #LC_minitab_header #LC_current_minitab {
8512: background-image:url("/res/adm/pages/minitabmenu_left_on.gif");
8513: }
8514: #LC_minitab_header #LC_current_minitab a {
8515: background-image:url("/res/adm/pages/minitabmenu_right_on.gif");
8516: padding-bottom:5px;
8517: }
8518:
8519:
1.343 albertel 8520: END
8521: }
8522:
1.306 albertel 8523: =pod
8524:
8525: =item * &headtag()
8526:
8527: Returns a uniform footer for LON-CAPA web pages.
8528:
1.307 albertel 8529: Inputs: $title - optional title for the head
8530: $head_extra - optional extra HTML to put inside the <head>
1.315 albertel 8531: $args - optional arguments
1.319 albertel 8532: force_register - if is true call registerurl so the remote is
8533: informed
1.415 albertel 8534: redirect -> array ref of
8535: 1- seconds before redirect occurs
8536: 2- url to redirect to
8537: 3- whether the side effect should occur
1.315 albertel 8538: (side effect of setting
8539: $env{'internal.head.redirect'} to the url
8540: redirected too)
1.352 albertel 8541: domain -> force to color decorate a page for a specific
8542: domain
8543: function -> force usage of a specific rolish color scheme
8544: bgcolor -> override the default page bgcolor
1.460 albertel 8545: no_auto_mt_title
8546: -> prevent &mt()ing the title arg
1.464 albertel 8547:
1.306 albertel 8548: =cut
8549:
8550: sub headtag {
1.313 albertel 8551: my ($title,$head_extra,$args) = @_;
1.306 albertel 8552:
1.363 albertel 8553: my $function = $args->{'function'} || &get_users_function();
8554: my $domain = $args->{'domain'} || &determinedomain();
8555: my $bgcolor = $args->{'bgcolor'} || &designparm($function.'.pgbg',$domain);
1.1154 raeburn 8556: my $httphost = $args->{'use_absolute'};
1.418 albertel 8557: my $url = join(':',$env{'user.name'},$env{'user.domain'},
1.458 albertel 8558: $Apache::lonnet::perlvar{'lonVersion'},
1.531 albertel 8559: #time(),
1.418 albertel 8560: $env{'environment.color.timestamp'},
1.363 albertel 8561: $function,$domain,$bgcolor);
8562:
1.369 www 8563: $url = '/adm/css/'.&escape($url).'.css';
1.363 albertel 8564:
1.308 albertel 8565: my $result =
8566: '<head>'.
1.1160 raeburn 8567: &font_settings($args);
1.319 albertel 8568:
1.1188 raeburn 8569: my $inhibitprint;
8570: if ($args->{'print_suppress'}) {
8571: $inhibitprint = &print_suppression();
8572: }
1.1064 raeburn 8573:
1.461 albertel 8574: if (!$args->{'frameset'}) {
8575: $result .= &Apache::lonhtmlcommon::htmlareaheaders();
8576: }
1.962 droeschl 8577: if ($args->{'force_register'} && $env{'request.noversionuri'} !~ m{^/res/adm/pages/}) {
8578: $result .= Apache::lonxml::display_title();
1.319 albertel 8579: }
1.436 albertel 8580: if (!$args->{'no_nav_bar'}
8581: && !$args->{'only_body'}
8582: && !$args->{'frameset'}) {
1.1154 raeburn 8583: $result .= &help_menu_js($httphost);
1.1032 www 8584: $result.=&modal_window();
1.1038 www 8585: $result.=&togglebox_script();
1.1034 www 8586: $result.=&wishlist_window();
1.1041 www 8587: $result.=&LCprogressbarUpdate_script();
1.1034 www 8588: } else {
8589: if ($args->{'add_modal'}) {
8590: $result.=&modal_window();
8591: }
8592: if ($args->{'add_wishlist'}) {
8593: $result.=&wishlist_window();
8594: }
1.1038 www 8595: if ($args->{'add_togglebox'}) {
8596: $result.=&togglebox_script();
8597: }
1.1041 www 8598: if ($args->{'add_progressbar'}) {
8599: $result.=&LCprogressbarUpdate_script();
8600: }
1.436 albertel 8601: }
1.314 albertel 8602: if (ref($args->{'redirect'})) {
1.414 albertel 8603: my ($time,$url,$inhibit_continue) = @{$args->{'redirect'}};
1.315 albertel 8604: $url = &Apache::lonenc::check_encrypt($url);
1.414 albertel 8605: if (!$inhibit_continue) {
8606: $env{'internal.head.redirect'} = $url;
8607: }
1.313 albertel 8608: $result.=<<ADDMETA
8609: <meta http-equiv="pragma" content="no-cache" />
1.344 albertel 8610: <meta http-equiv="Refresh" content="$time; url=$url" />
1.313 albertel 8611: ADDMETA
1.1210 raeburn 8612: } else {
8613: unless (($args->{'frameset'}) || ($args->{'js_ready'}) || ($args->{'only_body'}) || ($args->{'no_nav_bar'})) {
8614: my $requrl = $env{'request.uri'};
8615: if ($requrl eq '') {
8616: $requrl = $ENV{'REQUEST_URI'};
8617: $requrl =~ s/\?.+$//;
8618: }
8619: unless (($requrl =~ m{^/adm/(?:switchserver|login|authenticate|logout|groupsort|cleanup|helper|slotrequest|grades)(\?|$)}) ||
8620: (($requrl =~ m{^/res/}) && (($env{'form.submitted'} eq 'scantron') ||
8621: ($env{'form.grade_symb'}) || ($Apache::lonhomework::scantronmode)))) {
8622: my $dom_in_use = $Apache::lonnet::perlvar{'lonDefDomain'};
8623: unless (&Apache::lonnet::allowed('mau',$dom_in_use)) {
8624: my %domdefs = &Apache::lonnet::get_domain_defaults($dom_in_use);
1.1340 raeburn 8625: my $lonhost = $Apache::lonnet::perlvar{'lonHostID'};
1.1352 raeburn 8626: my ($offload,$offloadoth);
1.1210 raeburn 8627: if (ref($domdefs{'offloadnow'}) eq 'HASH') {
8628: if ($domdefs{'offloadnow'}{$lonhost}) {
1.1340 raeburn 8629: $offload = 1;
1.1353 raeburn 8630: if (($env{'user.domain'} ne '') && ($env{'user.domain'} ne $dom_in_use) &&
8631: (!(($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public')))) {
8632: unless (&Apache::lonnet::shared_institution($env{'user.domain'})) {
8633: $offloadoth = 1;
8634: $dom_in_use = $env{'user.domain'};
8635: }
8636: }
1.1340 raeburn 8637: }
8638: }
8639: unless ($offload) {
8640: if (ref($domdefs{'offloadoth'}) eq 'HASH') {
8641: if ($domdefs{'offloadoth'}{$lonhost}) {
8642: if (($env{'user.domain'} ne '') && ($env{'user.domain'} ne $dom_in_use) &&
8643: (!(($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public')))) {
8644: unless (&Apache::lonnet::shared_institution($env{'user.domain'})) {
8645: $offload = 1;
1.1352 raeburn 8646: $offloadoth = 1;
1.1340 raeburn 8647: $dom_in_use = $env{'user.domain'};
8648: }
1.1210 raeburn 8649: }
1.1340 raeburn 8650: }
8651: }
8652: }
8653: if ($offload) {
1.1358 raeburn 8654: my $newserver = &Apache::lonnet::spareserver(undef,30000,undef,1,$dom_in_use);
1.1352 raeburn 8655: if (($newserver eq '') && ($offloadoth)) {
8656: my @domains = &Apache::lonnet::current_machine_domains();
8657: if (($dom_in_use ne '') && (!grep(/^\Q$dom_in_use\E$/,@domains))) {
8658: ($newserver) = &Apache::lonnet::choose_server($dom_in_use);
8659: }
8660: }
1.1340 raeburn 8661: if (($newserver) && ($newserver ne $lonhost)) {
8662: my $numsec = 5;
8663: my $timeout = $numsec * 1000;
8664: my ($newurl,$locknum,%locks,$msg);
8665: if ($env{'request.role.adv'}) {
8666: ($locknum,%locks) = &Apache::lonnet::get_locks();
8667: }
8668: my $disable_submit = 0;
8669: if ($requrl =~ /$LONCAPA::assess_re/) {
8670: $disable_submit = 1;
8671: }
8672: if ($locknum) {
8673: my @lockinfo = sort(values(%locks));
1.1354 raeburn 8674: $msg = &mt('Once the following tasks are complete:')." \n".
1.1340 raeburn 8675: join(", ",sort(values(%locks)))."\n";
8676: if (&show_course()) {
8677: $msg .= &mt('your session will be transferred to a different server, after you click "Courses".');
8678: } else {
8679: $msg .= &mt('your session will be transferred to a different server, after you click "Roles".');
1.1210 raeburn 8680: }
1.1340 raeburn 8681: } else {
8682: if (($requrl =~ m{^/res/}) && ($env{'form.submitted'} =~ /^part_/)) {
8683: $msg = &mt('Your LON-CAPA submission has been recorded')."\n";
8684: }
8685: $msg .= &mt('Your current LON-CAPA session will be transferred to a different server in [quant,_1,second].',$numsec);
8686: $newurl = '/adm/switchserver?otherserver='.$newserver;
8687: if (($env{'request.role'}) && ($env{'request.role'} ne 'cm')) {
8688: $newurl .= '&role='.$env{'request.role'};
8689: }
8690: if ($env{'request.symb'}) {
8691: my $shownsymb = &Apache::lonenc::check_encrypt($env{'request.symb'});
8692: if ($shownsymb =~ m{^/enc/}) {
8693: my $reqdmajor = 2;
8694: my $reqdminor = 11;
8695: my $reqdsubminor = 3;
8696: my $newserverrev = &Apache::lonnet::get_server_loncaparev('',$newserver);
8697: my $remoterev = &Apache::lonnet::get_server_loncaparev(undef,$newserver);
8698: my ($major,$minor,$subminor) = ($remoterev =~ /^\'?(\d+)\.(\d+)\.(\d+|)[\w.\-]+\'?$/);
8699: if (($major eq '' && $minor eq '') ||
8700: (($reqdmajor > $major) || (($reqdmajor == $major) && ($reqdminor > $minor)) ||
8701: (($reqdmajor == $major) && ($reqdminor == $minor) && (($subminor eq '') ||
8702: ($reqdsubminor > $subminor))))) {
8703: undef($shownsymb);
8704: }
1.1210 raeburn 8705: }
1.1340 raeburn 8706: if ($shownsymb) {
8707: &js_escape(\$shownsymb);
8708: $newurl .= '&symb='.$shownsymb;
1.1210 raeburn 8709: }
1.1340 raeburn 8710: } else {
8711: my $shownurl = &Apache::lonenc::check_encrypt($requrl);
8712: &js_escape(\$shownurl);
8713: $newurl .= '&origurl='.$shownurl;
1.1210 raeburn 8714: }
1.1340 raeburn 8715: }
8716: &js_escape(\$msg);
8717: $result.=<<OFFLOAD
1.1210 raeburn 8718: <meta http-equiv="pragma" content="no-cache" />
8719: <script type="text/javascript">
1.1215 raeburn 8720: // <![CDATA[
1.1210 raeburn 8721: function LC_Offload_Now() {
8722: var dest = "$newurl";
8723: if (dest != '') {
8724: window.location.href="$newurl";
8725: }
8726: }
1.1214 raeburn 8727: \$(document).ready(function () {
8728: window.alert('$msg');
8729: if ($disable_submit) {
1.1210 raeburn 8730: \$(".LC_hwk_submit").prop("disabled", true);
8731: \$( ".LC_textline" ).prop( "readonly", "readonly");
1.1214 raeburn 8732: }
8733: setTimeout('LC_Offload_Now()', $timeout);
8734: });
1.1215 raeburn 8735: // ]]>
1.1210 raeburn 8736: </script>
8737: OFFLOAD
8738: }
8739: }
8740: }
8741: }
8742: }
1.313 albertel 8743: }
1.306 albertel 8744: if (!defined($title)) {
8745: $title = 'The LearningOnline Network with CAPA';
8746: }
1.460 albertel 8747: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
8748: $result .= '<title> LON-CAPA '.$title.'</title>'
1.1168 raeburn 8749: .'<link rel="stylesheet" type="text/css" href="'.$url.'"';
8750: if (!$args->{'frameset'}) {
8751: $result .= ' /';
8752: }
8753: $result .= '>'
1.1064 raeburn 8754: .$inhibitprint
1.414 albertel 8755: .$head_extra;
1.1242 raeburn 8756: my $clientmobile;
8757: if (($env{'user.name'} eq '') && ($env{'user.domain'} eq '')) {
8758: (undef,undef,undef,undef,undef,undef,$clientmobile) = &decode_user_agent();
8759: } else {
8760: $clientmobile = $env{'browser.mobile'};
8761: }
8762: if ($clientmobile) {
1.1137 raeburn 8763: $result .= '
8764: <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=0, minimum-scale=1.0, maximum-scale=1.0">
8765: <meta name="apple-mobile-web-app-capable" content="yes" />';
8766: }
1.1278 raeburn 8767: $result .= '<meta name="google" content="notranslate" />'."\n";
1.962 droeschl 8768: return $result.'</head>';
1.306 albertel 8769: }
8770:
8771: =pod
8772:
1.340 albertel 8773: =item * &font_settings()
8774:
8775: Returns neccessary <meta> to set the proper encoding
8776:
1.1160 raeburn 8777: Inputs: optional reference to HASH -- $args passed to &headtag()
1.340 albertel 8778:
8779: =cut
8780:
8781: sub font_settings {
1.1160 raeburn 8782: my ($args) = @_;
1.340 albertel 8783: my $headerstring='';
1.1160 raeburn 8784: if ((!$env{'browser.mathml'} && $env{'browser.unicode'}) ||
8785: ((ref($args) eq 'HASH') && ($args->{'browser.unicode'}))) {
1.1168 raeburn 8786: $headerstring.=
8787: '<meta http-equiv="Content-Type" content="text/html; charset=utf-8"';
8788: if (!$args->{'frameset'}) {
8789: $headerstring.= ' /';
8790: }
8791: $headerstring .= '>'."\n";
1.340 albertel 8792: }
8793: return $headerstring;
8794: }
8795:
1.341 albertel 8796: =pod
8797:
1.1064 raeburn 8798: =item * &print_suppression()
8799:
8800: In course context returns css which causes the body to be blank when media="print",
8801: if printout generation is unavailable for the current resource.
8802:
8803: This could be because:
8804:
8805: (a) printstartdate is in the future
8806:
8807: (b) printenddate is in the past
8808:
8809: (c) there is an active exam block with "printout"
8810: functionality blocked
8811:
8812: Users with pav, pfo or evb privileges are exempt.
8813:
8814: Inputs: none
8815:
8816: =cut
8817:
8818:
8819: sub print_suppression {
8820: my $noprint;
8821: if ($env{'request.course.id'}) {
8822: my $scope = $env{'request.course.id'};
8823: if ((&Apache::lonnet::allowed('pav',$scope)) ||
8824: (&Apache::lonnet::allowed('pfo',$scope))) {
8825: return;
8826: }
8827: if ($env{'request.course.sec'} ne '') {
8828: $scope .= "/$env{'request.course.sec'}";
8829: if ((&Apache::lonnet::allowed('pav',$scope)) ||
8830: (&Apache::lonnet::allowed('pfo',$scope))) {
1.1065 raeburn 8831: return;
1.1064 raeburn 8832: }
8833: }
8834: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
8835: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
1.1189 raeburn 8836: my $blocked = &blocking_status('printout',$cnum,$cdom,undef,1);
1.1064 raeburn 8837: if ($blocked) {
8838: my $checkrole = "cm./$cdom/$cnum";
8839: if ($env{'request.course.sec'} ne '') {
8840: $checkrole .= "/$env{'request.course.sec'}";
8841: }
8842: unless ((&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) &&
8843: ($env{'request.role'} !~ m{^st\./$cdom/$cnum})) {
8844: $noprint = 1;
8845: }
8846: }
8847: unless ($noprint) {
8848: my $symb = &Apache::lonnet::symbread();
8849: if ($symb ne '') {
8850: my $navmap = Apache::lonnavmaps::navmap->new();
8851: if (ref($navmap)) {
8852: my $res = $navmap->getBySymb($symb);
8853: if (ref($res)) {
8854: if (!$res->resprintable()) {
8855: $noprint = 1;
8856: }
8857: }
8858: }
8859: }
8860: }
8861: if ($noprint) {
8862: return <<"ENDSTYLE";
8863: <style type="text/css" media="print">
8864: body { display:none }
8865: </style>
8866: ENDSTYLE
8867: }
8868: }
8869: return;
8870: }
8871:
8872: =pod
8873:
1.341 albertel 8874: =item * &xml_begin()
8875:
8876: Returns the needed doctype and <html>
8877:
8878: Inputs: none
8879:
8880: =cut
8881:
8882: sub xml_begin {
1.1168 raeburn 8883: my ($is_frameset) = @_;
1.341 albertel 8884: my $output='';
8885:
8886: if ($env{'browser.mathml'}) {
8887: $output='<?xml version="1.0"?>'
8888: #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
8889: # .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
8890:
8891: # .'<!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">] >'
8892: .'<!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">'
8893: .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" '
8894: .'xmlns="http://www.w3.org/1999/xhtml">';
1.1168 raeburn 8895: } elsif ($is_frameset) {
8896: $output='<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN" "http://www.w3.org/TR/html4/frameset.dtd">'."\n".
8897: '<html>'."\n";
1.341 albertel 8898: } else {
1.1168 raeburn 8899: $output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">'."\n".
8900: '<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">'."\n";
1.341 albertel 8901: }
8902: return $output;
8903: }
1.340 albertel 8904:
8905: =pod
8906:
1.306 albertel 8907: =item * &start_page()
8908:
8909: Returns a complete <html> .. <body> section for LON-CAPA web pages.
8910:
1.648 raeburn 8911: Inputs:
8912:
8913: =over 4
8914:
8915: $title - optional title for the page
8916:
8917: $head_extra - optional extra HTML to incude inside the <head>
8918:
8919: $args - additional optional args supported are:
8920:
8921: =over 8
8922:
8923: only_body -> is true will set &bodytag() onlybodytag
1.317 albertel 8924: arg on
1.814 bisitz 8925: no_nav_bar -> is true will set &bodytag() no_nav_bar arg on
1.648 raeburn 8926: add_entries -> additional attributes to add to the <body>
8927: domain -> force to color decorate a page for a
1.317 albertel 8928: specific domain
1.648 raeburn 8929: function -> force usage of a specific rolish color
1.317 albertel 8930: scheme
1.648 raeburn 8931: redirect -> see &headtag()
8932: bgcolor -> override the default page bg color
8933: js_ready -> return a string ready for being used in
1.317 albertel 8934: a javascript writeln
1.648 raeburn 8935: html_encode -> return a string ready for being used in
1.320 albertel 8936: a html attribute
1.648 raeburn 8937: force_register -> if is true will turn on the &bodytag()
1.317 albertel 8938: $forcereg arg
1.648 raeburn 8939: frameset -> if true will start with a <frameset>
1.330 albertel 8940: rather than <body>
1.648 raeburn 8941: skip_phases -> hash ref of
1.338 albertel 8942: head -> skip the <html><head> generation
8943: body -> skip all <body> generation
1.648 raeburn 8944: no_auto_mt_title -> prevent &mt()ing the title arg
1.867 kalberla 8945: bread_crumbs -> Array containing breadcrumbs
1.983 raeburn 8946: bread_crumbs_component -> if exists show it as headline else show only the breadcrumbs
1.1272 raeburn 8947: bread_crumbs_nomenu -> if true will pass false as the value of $menulink
8948: to lonhtmlcommon::breadcrumbs
1.1096 raeburn 8949: group -> includes the current group, if page is for a
1.1274 raeburn 8950: specific group
8951: use_absolute -> for request for external resource or syllabus, this
8952: will contain https://<hostname> if server uses
8953: https (as per hosts.tab), but request is for http
8954: hostname -> hostname, originally from $r->hostname(), (optional).
1.361 albertel 8955:
1.648 raeburn 8956: =back
1.460 albertel 8957:
1.648 raeburn 8958: =back
1.562 albertel 8959:
1.306 albertel 8960: =cut
8961:
8962: sub start_page {
1.309 albertel 8963: my ($title,$head_extra,$args) = @_;
1.318 albertel 8964: #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
1.319 albertel 8965:
1.315 albertel 8966: $env{'internal.start_page'}++;
1.1359 raeburn 8967: my ($result,@advtools,$ltiscope,$ltiuri,%ltimenu,$menucoll,%menu);
1.964 droeschl 8968:
1.338 albertel 8969: if (! exists($args->{'skip_phases'}{'head'}) ) {
1.1168 raeburn 8970: $result .= &xml_begin($args->{'frameset'}) . &headtag($title, $head_extra, $args);
1.338 albertel 8971: }
1.1316 raeburn 8972:
8973: if (($env{'request.course.id'}) && ($env{'request.lti.login'})) {
1.1318 raeburn 8974: if ($env{'course.'.$env{'request.course.id'}.'.lti.override'}) {
8975: unless ($env{'course.'.$env{'request.course.id'}.'.lti.topmenu'}) {
8976: $args->{'no_primary_menu'} = 1;
8977: }
8978: unless ($env{'course.'.$env{'request.course.id'}.'.lti.inlinemenu'}) {
8979: $args->{'no_inline_menu'} = 1;
8980: }
8981: if ($env{'course.'.$env{'request.course.id'}.'.lti.lcmenu'}) {
8982: map { $ltimenu{$_} = 1; } split(/,/,$env{'course.'.$env{'request.course.id'}.'.lti.lcmenu'});
8983: }
8984: } else {
8985: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
8986: my %lti = &Apache::lonnet::get_domain_lti($cdom,'provider');
8987: if (ref($lti{$env{'request.lti.login'}}) eq 'HASH') {
8988: unless ($lti{$env{'request.lti.login'}}{'topmenu'}) {
8989: $args->{'no_primary_menu'} = 1;
8990: }
8991: unless ($lti{$env{'request.lti.login'}}{'inlinemenu'}) {
8992: $args->{'no_inline_menu'} = 1;
8993: }
8994: if (ref($lti{$env{'request.lti.login'}}{'lcmenu'}) eq 'ARRAY') {
8995: map { $ltimenu{$_} = 1; } @{$lti{$env{'request.lti.login'}}{'lcmenu'}};
8996: }
8997: }
8998: }
1.1316 raeburn 8999: ($ltiscope,$ltiuri) = &LONCAPA::ltiutils::lti_provider_scope($env{'request.lti.uri'},
9000: $env{'course.'.$env{'request.course.id'}.'.domain'},
9001: $env{'course.'.$env{'request.course.id'}.'.num'});
1.1359 raeburn 9002: } elsif ($env{'request.course.id'}) {
9003: my $expiretime=600;
9004: if ((time-$env{'course.'.$env{'request.course.id'}.'.last_cache'}) > $expiretime) {
9005: &Apache::lonnet::coursedescription($env{'request.course.id'},{'freshen_cache' => 1});
9006: }
9007: my ($deeplinkmenu,$menuref);
9008: ($menucoll,$deeplinkmenu,$menuref) = &menucoll_in_effect();
9009: if ($menucoll) {
9010: if (ref($menuref) eq 'HASH') {
9011: %menu = %{$menuref};
9012: }
9013: if ($menu{'top'} eq 'n') {
9014: $args->{'no_primary_menu'} = 1;
9015: }
9016: if ($menu{'inline'} eq 'n') {
9017: unless (&Apache::lonnet::allowed('opa')) {
9018: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
9019: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
9020: my $crstype = &course_type();
9021: my $now = time;
9022: my $ccrole;
9023: if ($crstype eq 'Community') {
9024: $ccrole = 'co';
9025: } else {
9026: $ccrole = 'cc';
9027: }
9028: if ($env{'user.role.'.$ccrole.'./'.$cdom.'/'.$cnum}) {
9029: my ($start,$end) = split(/\./,$env{'user.role.'.$ccrole.'./'.$cdom.'/'.$cnum});
9030: if ((($start) && ($start<0)) ||
9031: (($end) && ($end<$now)) ||
9032: (($start) && ($now<$start))) {
9033: $args->{'no_inline_menu'} = 1;
9034: }
9035: } else {
9036: $args->{'no_inline_menu'} = 1;
9037: }
9038: }
9039: }
9040: }
1.1316 raeburn 9041: }
1.1359 raeburn 9042:
1.338 albertel 9043: if (! exists($args->{'skip_phases'}{'body'}) ) {
9044: if ($args->{'frameset'}) {
9045: my $attr_string = &make_attr_string($args->{'force_register'},
9046: $args->{'add_entries'});
9047: $result .= "\n<frameset $attr_string>\n";
1.831 bisitz 9048: } else {
9049: $result .=
9050: &bodytag($title,
9051: $args->{'function'}, $args->{'add_entries'},
9052: $args->{'only_body'}, $args->{'domain'},
9053: $args->{'force_register'}, $args->{'no_nav_bar'},
1.1096 raeburn 9054: $args->{'bgcolor'}, $args,
1.1359 raeburn 9055: \@advtools,$ltiscope,$ltiuri,\%ltimenu,$menucoll,\%menu);
1.831 bisitz 9056: }
1.330 albertel 9057: }
1.338 albertel 9058:
1.315 albertel 9059: if ($args->{'js_ready'}) {
1.713 kaisler 9060: $result = &js_ready($result);
1.315 albertel 9061: }
1.320 albertel 9062: if ($args->{'html_encode'}) {
1.713 kaisler 9063: $result = &html_encode($result);
9064: }
9065:
1.813 bisitz 9066: # Preparation for new and consistent functionlist at top of screen
9067: # if ($args->{'functionlist'}) {
9068: # $result .= &build_functionlist();
9069: #}
9070:
1.964 droeschl 9071: # Don't add anything more if only_body wanted or in const space
9072: return $result if $args->{'only_body'}
9073: || $env{'request.state'} eq 'construct';
1.813 bisitz 9074:
9075: #Breadcrumbs
1.758 kaisler 9076: if (exists($args->{'bread_crumbs'}) or exists($args->{'bread_crumbs_component'})) {
9077: &Apache::lonhtmlcommon::clear_breadcrumbs();
9078: #if any br links exists, add them to the breadcrumbs
9079: if (exists($args->{'bread_crumbs'}) and ref($args->{'bread_crumbs'}) eq 'ARRAY') {
9080: foreach my $crumb (@{$args->{'bread_crumbs'}}){
9081: &Apache::lonhtmlcommon::add_breadcrumb($crumb);
9082: }
9083: }
1.1096 raeburn 9084: # if @advtools array contains items add then to the breadcrumbs
9085: if (@advtools > 0) {
9086: &Apache::lonmenu::advtools_crumbs(@advtools);
9087: }
1.1272 raeburn 9088: my $menulink;
9089: # if arg: bread_crumbs_nomenu is true pass 0 as $menulink item.
9090: if ((exists($args->{'bread_crumbs_nomenu'})) ||
1.1312 raeburn 9091: ($ltiscope eq 'map') || ($ltiscope eq 'resource') ||
1.1272 raeburn 9092: ((($args->{'crstype'} eq 'Placement') || (($env{'request.course.id'}) &&
9093: ($env{'course.'.$env{'request.course.id'}.'.type'} eq 'Placement'))) &&
9094: (!$env{'request.role.adv'}))) {
9095: $menulink = 0;
9096: } else {
9097: undef($menulink);
9098: }
1.758 kaisler 9099: #if bread_crumbs_component exists show it as headline else show only the breadcrumbs
9100: if(exists($args->{'bread_crumbs_component'})){
1.1272 raeburn 9101: $result .= &Apache::lonhtmlcommon::breadcrumbs($args->{'bread_crumbs_component'},'',$menulink);
1.1237 raeburn 9102: } else {
1.1272 raeburn 9103: $result .= &Apache::lonhtmlcommon::breadcrumbs('','',$menulink);
1.758 kaisler 9104: }
1.320 albertel 9105: }
1.315 albertel 9106: return $result;
1.306 albertel 9107: }
9108:
9109: sub end_page {
1.315 albertel 9110: my ($args) = @_;
9111: $env{'internal.end_page'}++;
1.330 albertel 9112: my $result;
1.335 albertel 9113: if ($args->{'discussion'}) {
9114: my ($target,$parser);
9115: if (ref($args->{'discussion'})) {
9116: ($target,$parser) =($args->{'discussion'}{'target'},
9117: $args->{'discussion'}{'parser'});
9118: }
9119: $result .= &Apache::lonxml::xmlend($target,$parser);
9120: }
1.330 albertel 9121: if ($args->{'frameset'}) {
9122: $result .= '</frameset>';
9123: } else {
1.635 raeburn 9124: $result .= &endbodytag($args);
1.330 albertel 9125: }
1.1080 raeburn 9126: unless ($args->{'notbody'}) {
9127: $result .= "\n</html>";
9128: }
1.330 albertel 9129:
1.315 albertel 9130: if ($args->{'js_ready'}) {
1.317 albertel 9131: $result = &js_ready($result);
1.315 albertel 9132: }
1.335 albertel 9133:
1.320 albertel 9134: if ($args->{'html_encode'}) {
9135: $result = &html_encode($result);
9136: }
1.335 albertel 9137:
1.315 albertel 9138: return $result;
9139: }
9140:
1.1359 raeburn 9141: sub menucoll_in_effect {
9142: my ($menucoll,$deeplinkmenu,%menu);
9143: if ($env{'request.course.id'}) {
9144: $menucoll = $env{'course.'.$env{'request.course.id'}.'.menudefault'};
1.1362 ! raeburn 9145: if ($env{'request.deeplink.login'}) {
! 9146: my ($deeplink_symb,$deeplink);
! 9147: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
! 9148: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
! 9149: if ($env{'request.noversionuri'} =~ m{^/(res|uploaded)/}) {
! 9150: if ($env{'request.noversionuri'} =~ /\.(page|sequence)$/) {
! 9151: my $navmap = Apache::lonnavmaps::navmap->new();
! 9152: if (ref($navmap)) {
! 9153: $deeplink = $navmap->get_mapparam(undef,
! 9154: &Apache::lonnet::declutter($env{'request.noversionuri'}),
! 9155: '0.deeplink');
! 9156: }
! 9157: } else {
! 9158: $deeplink = &Apache::lonnet::EXT('resource.0.deeplink');
! 9159: }
! 9160: } else {
! 9161: $deeplink_symb = &deeplink_login_symb($cnum,$cdom);
! 9162: if ($deeplink_symb =~ /\.(page|sequence)$/) {
! 9163: my $mapname = &Apache::lonnet::deversion((&Apache::lonnet::decode_symb($deeplink_symb))[2]);
! 9164: my $navmap = Apache::lonnavmaps::navmap->new();
! 9165: if (ref($navmap)) {
! 9166: $deeplink = $navmap->get_mapparam(undef,$mapname,'0.deeplink');
! 9167: }
! 9168: } else {
! 9169: $deeplink = &Apache::lonnet::EXT('resource.0.deeplink',$deeplink_symb);
! 9170: }
! 9171: }
1.1359 raeburn 9172: if ($deeplink ne '') {
9173: my ($listed,$scope,$access,$display) = split(/,/,$deeplink);
9174: if ($display =~ /^\d+$/) {
9175: $deeplinkmenu = 1;
9176: $menucoll = $display;
9177: }
9178: }
9179: }
9180: if ($menucoll) {
9181: %menu = &page_menu($env{'course.'.$env{'request.course.id'}.'.menucollections'},$menucoll);
9182: }
9183: }
9184: return ($menucoll,$deeplinkmenu,\%menu);
9185: }
9186:
1.1362 ! raeburn 9187: sub deeplink_login_symb {
! 9188: my ($cnum,$cdom) = @_;
! 9189: my $login_symb;
! 9190: if ($env{'request.deeplink.login'}) {
! 9191: if ($env{'request.deeplink.login'} =~ m{^\Q/tiny/$cdom/\E(\w+)$}) {
! 9192: my $key = $1;
! 9193: my ($tinyurl,$login);
! 9194: my ($result,$cached)=&Apache::lonnet::is_cached_new('tiny',$cdom."\0".$key);
! 9195: if (defined($cached)) {
! 9196: $tinyurl = $result;
! 9197: } else {
! 9198: my $configuname = &Apache::lonnet::get_domainconfiguser($cdom);
! 9199: my %currtiny = &Apache::lonnet::get('tiny',[$key],$cdom,$configuname);
! 9200: if ($currtiny{$key} ne '') {
! 9201: $tinyurl = $currtiny{$key};
! 9202: &Apache::lonnet::do_cache_new('tiny',$cdom."\0".$key,$currtiny{$key},600);
! 9203: }
! 9204: }
! 9205: if ($tinyurl ne '') {
! 9206: my ($cnumreq,$posslogin) = split(/\&/,$tinyurl);
! 9207: if ($cnumreq eq $cnum) {
! 9208: $login_symb = $posslogin;
! 9209: }
! 9210: }
! 9211: }
! 9212: }
! 9213: return $login_symb;
! 9214: }
! 9215:
1.1034 www 9216: sub wishlist_window {
9217: return(<<'ENDWISHLIST');
1.1046 raeburn 9218: <script type="text/javascript">
1.1034 www 9219: // <![CDATA[
9220: // <!-- BEGIN LON-CAPA Internal
9221: function set_wishlistlink(title, path) {
9222: if (!title) {
9223: title = document.title;
9224: title = title.replace(/^LON-CAPA /,'');
9225: }
1.1175 raeburn 9226: title = encodeURIComponent(title);
1.1203 raeburn 9227: title = title.replace("'","\\\'");
1.1034 www 9228: if (!path) {
9229: path = location.pathname;
9230: }
1.1175 raeburn 9231: path = encodeURIComponent(path);
1.1203 raeburn 9232: path = path.replace("'","\\\'");
1.1034 www 9233: Win = window.open('/adm/wishlist?mode=newLink&setTitle='+title+'&setPath='+path,
9234: 'wishlistNewLink','width=560,height=350,scrollbars=0');
9235: }
9236: // END LON-CAPA Internal -->
9237: // ]]>
9238: </script>
9239: ENDWISHLIST
9240: }
9241:
1.1030 www 9242: sub modal_window {
9243: return(<<'ENDMODAL');
1.1046 raeburn 9244: <script type="text/javascript">
1.1030 www 9245: // <![CDATA[
9246: // <!-- BEGIN LON-CAPA Internal
9247: var modalWindow = {
9248: parent:"body",
9249: windowId:null,
9250: content:null,
9251: width:null,
9252: height:null,
9253: close:function()
9254: {
9255: $(".LCmodal-window").remove();
9256: $(".LCmodal-overlay").remove();
9257: },
9258: open:function()
9259: {
9260: var modal = "";
9261: modal += "<div class=\"LCmodal-overlay\"></div>";
9262: 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;\">";
9263: modal += this.content;
9264: modal += "</div>";
9265:
9266: $(this.parent).append(modal);
9267:
9268: $(".LCmodal-window").append("<a class=\"LCclose-window\"></a>");
9269: $(".LCclose-window").click(function(){modalWindow.close();});
9270: $(".LCmodal-overlay").click(function(){modalWindow.close();});
9271: }
9272: };
1.1140 raeburn 9273: var openMyModal = function(source,width,height,scrolling,transparency,style)
1.1030 www 9274: {
1.1266 raeburn 9275: source = source.replace(/'/g,"'");
1.1030 www 9276: modalWindow.windowId = "myModal";
9277: modalWindow.width = width;
9278: modalWindow.height = height;
1.1196 raeburn 9279: modalWindow.content = "<iframe width='"+width+"' height='"+height+"' frameborder='0' scrolling='"+scrolling+"' allowtransparency='"+transparency+"' src='" + source + "' style='"+style+"'></iframe>";
1.1030 www 9280: modalWindow.open();
1.1208 raeburn 9281: };
1.1030 www 9282: // END LON-CAPA Internal -->
9283: // ]]>
9284: </script>
9285: ENDMODAL
9286: }
9287:
9288: sub modal_link {
1.1140 raeburn 9289: my ($link,$linktext,$width,$height,$target,$scrolling,$title,$transparency,$style)=@_;
1.1030 www 9290: unless ($width) { $width=480; }
9291: unless ($height) { $height=400; }
1.1031 www 9292: unless ($scrolling) { $scrolling='yes'; }
1.1140 raeburn 9293: unless ($transparency) { $transparency='true'; }
9294:
1.1074 raeburn 9295: my $target_attr;
9296: if (defined($target)) {
9297: $target_attr = 'target="'.$target.'"';
9298: }
9299: return <<"ENDLINK";
1.1336 raeburn 9300: <a href="$link" $target_attr title="$title" onclick="javascript:openMyModal('$link',$width,$height,'$scrolling','$transparency','$style'); return false;">$linktext</a>
1.1074 raeburn 9301: ENDLINK
1.1030 www 9302: }
9303:
1.1032 www 9304: sub modal_adhoc_script {
9305: my ($funcname,$width,$height,$content)=@_;
9306: return (<<ENDADHOC);
1.1046 raeburn 9307: <script type="text/javascript">
1.1032 www 9308: // <![CDATA[
9309: var $funcname = function()
9310: {
9311: modalWindow.windowId = "myModal";
9312: modalWindow.width = $width;
9313: modalWindow.height = $height;
9314: modalWindow.content = '$content';
9315: modalWindow.open();
9316: };
9317: // ]]>
9318: </script>
9319: ENDADHOC
9320: }
9321:
1.1041 www 9322: sub modal_adhoc_inner {
9323: my ($funcname,$width,$height,$content)=@_;
9324: my $innerwidth=$width-20;
9325: $content=&js_ready(
1.1140 raeburn 9326: &start_page('Dialog',undef,{'only_body'=>1,'bgcolor'=>'#FFFFFF'}).
9327: &start_scrollbox($width.'px',$innerwidth.'px',$height.'px','myModal','#FFFFFF',undef,1).
9328: $content.
1.1041 www 9329: &end_scrollbox().
1.1140 raeburn 9330: &end_page()
1.1041 www 9331: );
9332: return &modal_adhoc_script($funcname,$width,$height,$content);
9333: }
9334:
9335: sub modal_adhoc_window {
9336: my ($funcname,$width,$height,$content,$linktext)=@_;
9337: return &modal_adhoc_inner($funcname,$width,$height,$content).
9338: "<a href=\"javascript:$funcname();void(0);\">".$linktext."</a>";
9339: }
9340:
9341: sub modal_adhoc_launch {
9342: my ($funcname,$width,$height,$content)=@_;
9343: return &modal_adhoc_inner($funcname,$width,$height,$content).(<<ENDLAUNCH);
9344: <script type="text/javascript">
9345: // <![CDATA[
9346: $funcname();
9347: // ]]>
9348: </script>
9349: ENDLAUNCH
9350: }
9351:
9352: sub modal_adhoc_close {
9353: return (<<ENDCLOSE);
9354: <script type="text/javascript">
9355: // <![CDATA[
9356: modalWindow.close();
9357: // ]]>
9358: </script>
9359: ENDCLOSE
9360: }
9361:
1.1038 www 9362: sub togglebox_script {
9363: return(<<ENDTOGGLE);
9364: <script type="text/javascript">
9365: // <![CDATA[
9366: function LCtoggleDisplay(id,hidetext,showtext) {
9367: link = document.getElementById(id + "link").childNodes[0];
9368: with (document.getElementById(id).style) {
9369: if (display == "none" ) {
9370: display = "inline";
9371: link.nodeValue = hidetext;
9372: } else {
9373: display = "none";
9374: link.nodeValue = showtext;
9375: }
9376: }
9377: }
9378: // ]]>
9379: </script>
9380: ENDTOGGLE
9381: }
9382:
1.1039 www 9383: sub start_togglebox {
9384: my ($id,$heading,$headerbg,$hidetext,$showtext)=@_;
9385: unless ($heading) { $heading=''; } else { $heading.=' '; }
9386: unless ($showtext) { $showtext=&mt('show'); }
9387: unless ($hidetext) { $hidetext=&mt('hide'); }
9388: unless ($headerbg) { $headerbg='#FFFFFF'; }
9389: return &start_data_table().
9390: &start_data_table_header_row().
9391: '<td bgcolor="'.$headerbg.'">'.$heading.
9392: '[<a id="'.$id.'link" href="javascript:LCtoggleDisplay(\''.$id.'\',\''.$hidetext.'\',\''.
9393: $showtext.'\')">'.$showtext.'</a>]</td>'.
9394: &end_data_table_header_row().
9395: '<tr id="'.$id.'" style="display:none""><td>';
9396: }
9397:
9398: sub end_togglebox {
9399: return '</td></tr>'.&end_data_table();
9400: }
9401:
1.1041 www 9402: sub LCprogressbar_script {
1.1302 raeburn 9403: my ($id,$number_to_do)=@_;
9404: if ($number_to_do) {
9405: return(<<ENDPROGRESS);
1.1041 www 9406: <script type="text/javascript">
9407: // <![CDATA[
1.1045 www 9408: \$('#progressbar$id').progressbar({
1.1041 www 9409: value: 0,
9410: change: function(event, ui) {
9411: var newVal = \$(this).progressbar('option', 'value');
9412: \$('.pblabel', this).text(LCprogressTxt);
9413: }
9414: });
9415: // ]]>
9416: </script>
9417: ENDPROGRESS
1.1302 raeburn 9418: } else {
9419: return(<<ENDPROGRESS);
9420: <script type="text/javascript">
9421: // <![CDATA[
9422: \$('#progressbar$id').progressbar({
9423: value: false,
9424: create: function(event, ui) {
9425: \$('.ui-widget-header', this).css({'background':'#F0F0F0'});
9426: \$('.ui-progressbar-overlay', this).css({'margin':'0'});
9427: }
9428: });
9429: // ]]>
9430: </script>
9431: ENDPROGRESS
9432: }
1.1041 www 9433: }
9434:
9435: sub LCprogressbarUpdate_script {
9436: return(<<ENDPROGRESSUPDATE);
9437: <style type="text/css">
9438: .ui-progressbar { position:relative; }
1.1302 raeburn 9439: .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 9440: .pblabel { position: absolute; width: 100%; text-align: center; line-height: 1.9em; }
9441: </style>
9442: <script type="text/javascript">
9443: // <![CDATA[
1.1045 www 9444: var LCprogressTxt='---';
9445:
1.1302 raeburn 9446: function LCupdateProgress(percent,progresstext,id,maxnum) {
1.1041 www 9447: LCprogressTxt=progresstext;
1.1302 raeburn 9448: if ((maxnum == '') || (maxnum == undefined) || (maxnum == null)) {
9449: \$('#progressbar'+id).find('.progress-label').text(LCprogressTxt);
9450: } else if (percent === \$('#progressbar'+id).progressbar( "value" )) {
1.1301 raeburn 9451: \$('#progressbar'+id).find('.pblabel').text(LCprogressTxt);
9452: } else {
9453: \$('#progressbar'+id).progressbar('value',percent);
9454: }
1.1041 www 9455: }
9456: // ]]>
9457: </script>
9458: ENDPROGRESSUPDATE
9459: }
9460:
1.1042 www 9461: my $LClastpercent;
1.1045 www 9462: my $LCidcnt;
9463: my $LCcurrentid;
1.1042 www 9464:
1.1041 www 9465: sub LCprogressbar {
1.1302 raeburn 9466: my ($r,$number_to_do,$preamble)=@_;
1.1042 www 9467: $LClastpercent=0;
1.1045 www 9468: $LCidcnt++;
9469: $LCcurrentid=$$.'_'.$LCidcnt;
1.1302 raeburn 9470: my ($starting,$content);
9471: if ($number_to_do) {
9472: $starting=&mt('Starting');
9473: $content=(<<ENDPROGBAR);
9474: $preamble
1.1045 www 9475: <div id="progressbar$LCcurrentid">
1.1041 www 9476: <span class="pblabel">$starting</span>
9477: </div>
9478: ENDPROGBAR
1.1302 raeburn 9479: } else {
9480: $starting=&mt('Loading...');
9481: $LClastpercent='false';
9482: $content=(<<ENDPROGBAR);
9483: $preamble
9484: <div id="progressbar$LCcurrentid">
9485: <div class="progress-label">$starting</div>
9486: </div>
9487: ENDPROGBAR
9488: }
9489: &r_print($r,$content.&LCprogressbar_script($LCcurrentid,$number_to_do));
1.1041 www 9490: }
9491:
9492: sub LCprogressbarUpdate {
1.1302 raeburn 9493: my ($r,$val,$text,$number_to_do)=@_;
9494: if ($number_to_do) {
9495: unless ($val) {
9496: if ($LClastpercent) {
9497: $val=$LClastpercent;
9498: } else {
9499: $val=0;
9500: }
9501: }
9502: if ($val<0) { $val=0; }
9503: if ($val>100) { $val=0; }
9504: $LClastpercent=$val;
9505: unless ($text) { $text=$val.'%'; }
9506: } else {
9507: $val = 'false';
1.1042 www 9508: }
1.1041 www 9509: $text=&js_ready($text);
1.1044 www 9510: &r_print($r,<<ENDUPDATE);
1.1041 www 9511: <script type="text/javascript">
9512: // <![CDATA[
1.1302 raeburn 9513: LCupdateProgress($val,'$text','$LCcurrentid','$number_to_do');
1.1041 www 9514: // ]]>
9515: </script>
9516: ENDUPDATE
1.1035 www 9517: }
9518:
1.1042 www 9519: sub LCprogressbarClose {
9520: my ($r)=@_;
9521: $LClastpercent=0;
1.1044 www 9522: &r_print($r,<<ENDCLOSE);
1.1042 www 9523: <script type="text/javascript">
9524: // <![CDATA[
1.1045 www 9525: \$("#progressbar$LCcurrentid").hide('slow');
1.1042 www 9526: // ]]>
9527: </script>
9528: ENDCLOSE
1.1044 www 9529: }
9530:
9531: sub r_print {
9532: my ($r,$to_print)=@_;
9533: if ($r) {
9534: $r->print($to_print);
9535: $r->rflush();
9536: } else {
9537: print($to_print);
9538: }
1.1042 www 9539: }
9540:
1.320 albertel 9541: sub html_encode {
9542: my ($result) = @_;
9543:
1.322 albertel 9544: $result = &HTML::Entities::encode($result,'<>&"');
1.320 albertel 9545:
9546: return $result;
9547: }
1.1044 www 9548:
1.317 albertel 9549: sub js_ready {
9550: my ($result) = @_;
9551:
1.323 albertel 9552: $result =~ s/[\n\r]/ /xmsg;
9553: $result =~ s/\\/\\\\/xmsg;
9554: $result =~ s/'/\\'/xmsg;
1.372 albertel 9555: $result =~ s{</}{<\\/}xmsg;
1.317 albertel 9556:
9557: return $result;
9558: }
9559:
1.315 albertel 9560: sub validate_page {
9561: if ( exists($env{'internal.start_page'})
1.316 albertel 9562: && $env{'internal.start_page'} > 1) {
9563: &Apache::lonnet::logthis('start_page called multiple times '.
1.318 albertel 9564: $env{'internal.start_page'}.' '.
1.316 albertel 9565: $ENV{'request.filename'});
1.315 albertel 9566: }
9567: if ( exists($env{'internal.end_page'})
1.316 albertel 9568: && $env{'internal.end_page'} > 1) {
9569: &Apache::lonnet::logthis('end_page called multiple times '.
1.318 albertel 9570: $env{'internal.end_page'}.' '.
1.316 albertel 9571: $env{'request.filename'});
1.315 albertel 9572: }
9573: if ( exists($env{'internal.start_page'})
9574: && ! exists($env{'internal.end_page'})) {
1.316 albertel 9575: &Apache::lonnet::logthis('start_page called without end_page '.
9576: $env{'request.filename'});
1.315 albertel 9577: }
9578: if ( ! exists($env{'internal.start_page'})
9579: && exists($env{'internal.end_page'})) {
1.316 albertel 9580: &Apache::lonnet::logthis('end_page called without start_page'.
9581: $env{'request.filename'});
1.315 albertel 9582: }
1.306 albertel 9583: }
1.315 albertel 9584:
1.996 www 9585:
9586: sub start_scrollbox {
1.1140 raeburn 9587: my ($outerwidth,$width,$height,$id,$bgcolor,$cursor,$needjsready) = @_;
1.998 raeburn 9588: unless ($outerwidth) { $outerwidth='520px'; }
9589: unless ($width) { $width='500px'; }
9590: unless ($height) { $height='200px'; }
1.1075 raeburn 9591: my ($table_id,$div_id,$tdcol);
1.1018 raeburn 9592: if ($id ne '') {
1.1140 raeburn 9593: $table_id = ' id="table_'.$id.'"';
1.1137 raeburn 9594: $div_id = ' id="div_'.$id.'"';
1.1018 raeburn 9595: }
1.1075 raeburn 9596: if ($bgcolor ne '') {
9597: $tdcol = "background-color: $bgcolor;";
9598: }
1.1137 raeburn 9599: my $nicescroll_js;
9600: if ($env{'browser.mobile'}) {
1.1140 raeburn 9601: $nicescroll_js = &nicescroll_javascript('div_'.$id,$cursor,$needjsready);
9602: }
9603: return <<"END";
9604: $nicescroll_js
9605:
9606: <table style="width: $outerwidth; border: 1px solid none;"$table_id><tr><td style="width: $width;$tdcol">
9607: <div style="overflow:auto; width:$width; height:$height;"$div_id>
9608: END
9609: }
9610:
9611: sub end_scrollbox {
9612: return '</div></td></tr></table>';
9613: }
9614:
9615: sub nicescroll_javascript {
9616: my ($id,$cursor,$needjsready,$framecheck,$location) = @_;
9617: my %options;
9618: if (ref($cursor) eq 'HASH') {
9619: %options = %{$cursor};
9620: }
9621: unless ($options{'railalign'} =~ /^left|right$/) {
9622: $options{'railalign'} = 'left';
9623: }
9624: unless ($options{'cursorcolor'} =~ /^\#\w+$/) {
9625: my $function = &get_users_function();
9626: $options{'cursorcolor'} = &designparm($function.'.sidebg',$env{'request.role.domain'});
1.1138 raeburn 9627: unless ($options{'cursorcolor'} =~ /^\#\w+$/) {
1.1140 raeburn 9628: $options{'cursorcolor'} = '#00F';
1.1138 raeburn 9629: }
1.1140 raeburn 9630: }
9631: if ($options{'cursoropacity'} =~ /^[\d.]+$/) {
9632: unless ($options{'cursoropacity'} >= 0.0 && $options{'cursoropacity'} <=1.0) {
1.1138 raeburn 9633: $options{'cursoropacity'}='1.0';
9634: }
1.1140 raeburn 9635: } else {
9636: $options{'cursoropacity'}='1.0';
9637: }
9638: if ($options{'cursorfixedheight'} eq 'none') {
9639: delete($options{'cursorfixedheight'});
9640: } else {
9641: unless ($options{'cursorfixedheight'} =~ /^\d+$/) { $options{'cursorfixedheight'}='50'; }
9642: }
9643: unless ($options{'railoffset'} =~ /^{[\w\:\d\-,]+}$/) {
9644: delete($options{'railoffset'});
9645: }
9646: my @niceoptions;
9647: while (my($key,$value) = each(%options)) {
9648: if ($value =~ /^\{.+\}$/) {
9649: push(@niceoptions,$key.':'.$value);
1.1138 raeburn 9650: } else {
1.1140 raeburn 9651: push(@niceoptions,$key.':"'.$value.'"');
1.1138 raeburn 9652: }
1.1140 raeburn 9653: }
9654: my $nicescroll_js = '
1.1137 raeburn 9655: $(document).ready(
1.1140 raeburn 9656: function() {
9657: $("#'.$id.'").niceScroll({'.join(',',@niceoptions).'});
9658: }
1.1137 raeburn 9659: );
9660: ';
1.1140 raeburn 9661: if ($framecheck) {
9662: $nicescroll_js .= '
9663: function expand_div(caller) {
9664: if (top === self) {
9665: document.getElementById("'.$id.'").style.width = "auto";
9666: document.getElementById("'.$id.'").style.height = "auto";
9667: } else {
9668: try {
9669: if (parent.frames) {
9670: if (parent.frames.length > 1) {
9671: var framesrc = parent.frames[1].location.href;
9672: var currsrc = framesrc.replace(/\#.*$/,"");
9673: if ((caller == "search") || (currsrc == "'.$location.'")) {
9674: document.getElementById("'.$id.'").style.width = "auto";
9675: document.getElementById("'.$id.'").style.height = "auto";
9676: }
9677: }
9678: }
9679: } catch (e) {
9680: return;
9681: }
1.1137 raeburn 9682: }
1.1140 raeburn 9683: return;
1.996 www 9684: }
1.1140 raeburn 9685: ';
9686: }
9687: if ($needjsready) {
9688: $nicescroll_js = '
9689: <script type="text/javascript">'."\n".$nicescroll_js."\n</script>\n";
9690: } else {
9691: $nicescroll_js = &Apache::lonhtmlcommon::scripttag($nicescroll_js);
9692: }
9693: return $nicescroll_js;
1.996 www 9694: }
9695:
1.318 albertel 9696: sub simple_error_page {
1.1150 bisitz 9697: my ($r,$title,$msg,$args) = @_;
1.1304 raeburn 9698: my %displayargs;
1.1151 raeburn 9699: if (ref($args) eq 'HASH') {
9700: if (!$args->{'no_auto_mt_msg'}) { $msg = &mt($msg); }
1.1304 raeburn 9701: if ($args->{'only_body'}) {
9702: $displayargs{'only_body'} = 1;
9703: }
9704: if ($args->{'no_nav_bar'}) {
9705: $displayargs{'no_nav_bar'} = 1;
9706: }
1.1151 raeburn 9707: } else {
9708: $msg = &mt($msg);
9709: }
1.1150 bisitz 9710:
1.318 albertel 9711: my $page =
1.1304 raeburn 9712: &Apache::loncommon::start_page($title,'',\%displayargs).
1.1150 bisitz 9713: '<p class="LC_error">'.$msg.'</p>'.
1.318 albertel 9714: &Apache::loncommon::end_page();
9715: if (ref($r)) {
9716: $r->print($page);
1.327 albertel 9717: return;
1.318 albertel 9718: }
9719: return $page;
9720: }
1.347 albertel 9721:
9722: {
1.610 albertel 9723: my @row_count;
1.961 onken 9724:
9725: sub start_data_table_count {
9726: unshift(@row_count, 0);
9727: return;
9728: }
9729:
9730: sub end_data_table_count {
9731: shift(@row_count);
9732: return;
9733: }
9734:
1.347 albertel 9735: sub start_data_table {
1.1018 raeburn 9736: my ($add_class,$id) = @_;
1.422 albertel 9737: my $css_class = (join(' ','LC_data_table',$add_class));
1.1018 raeburn 9738: my $table_id;
9739: if (defined($id)) {
9740: $table_id = ' id="'.$id.'"';
9741: }
1.961 onken 9742: &start_data_table_count();
1.1018 raeburn 9743: return '<table class="'.$css_class.'"'.$table_id.'>'."\n";
1.347 albertel 9744: }
9745:
9746: sub end_data_table {
1.961 onken 9747: &end_data_table_count();
1.389 albertel 9748: return '</table>'."\n";;
1.347 albertel 9749: }
9750:
9751: sub start_data_table_row {
1.974 wenzelju 9752: my ($add_class, $id) = @_;
1.610 albertel 9753: $row_count[0]++;
9754: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.900 bisitz 9755: $css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
1.974 wenzelju 9756: $id = (' id="'.$id.'"') unless ($id eq '');
9757: return '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.347 albertel 9758: }
1.471 banghart 9759:
9760: sub continue_data_table_row {
1.974 wenzelju 9761: my ($add_class, $id) = @_;
1.610 albertel 9762: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.974 wenzelju 9763: $css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
9764: $id = (' id="'.$id.'"') unless ($id eq '');
9765: return '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.471 banghart 9766: }
1.347 albertel 9767:
9768: sub end_data_table_row {
1.389 albertel 9769: return '</tr>'."\n";;
1.347 albertel 9770: }
1.367 www 9771:
1.421 albertel 9772: sub start_data_table_empty_row {
1.707 bisitz 9773: # $row_count[0]++;
1.421 albertel 9774: return '<tr class="LC_empty_row" >'."\n";;
9775: }
9776:
9777: sub end_data_table_empty_row {
9778: return '</tr>'."\n";;
9779: }
9780:
1.367 www 9781: sub start_data_table_header_row {
1.389 albertel 9782: return '<tr class="LC_header_row">'."\n";;
1.367 www 9783: }
9784:
9785: sub end_data_table_header_row {
1.389 albertel 9786: return '</tr>'."\n";;
1.367 www 9787: }
1.890 droeschl 9788:
9789: sub data_table_caption {
9790: my $caption = shift;
9791: return "<caption class=\"LC_caption\">$caption</caption>";
9792: }
1.347 albertel 9793: }
9794:
1.548 albertel 9795: =pod
9796:
9797: =item * &inhibit_menu_check($arg)
9798:
9799: Checks for a inhibitmenu state and generates output to preserve it
9800:
9801: Inputs: $arg - can be any of
9802: - undef - in which case the return value is a string
9803: to add into arguments list of a uri
9804: - 'input' - in which case the return value is a HTML
9805: <form> <input> field of type hidden to
9806: preserve the value
9807: - a url - in which case the return value is the url with
9808: the neccesary cgi args added to preserve the
9809: inhibitmenu state
9810: - a ref to a url - no return value, but the string is
9811: updated to include the neccessary cgi
9812: args to preserve the inhibitmenu state
9813:
9814: =cut
9815:
9816: sub inhibit_menu_check {
9817: my ($arg) = @_;
9818: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
9819: if ($arg eq 'input') {
9820: if ($env{'form.inhibitmenu'}) {
9821: return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
9822: } else {
9823: return
9824: }
9825: }
9826: if ($env{'form.inhibitmenu'}) {
9827: if (ref($arg)) {
9828: $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
9829: } elsif ($arg eq '') {
9830: $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
9831: } else {
9832: $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
9833: }
9834: }
9835: if (!ref($arg)) {
9836: return $arg;
9837: }
9838: }
9839:
1.251 albertel 9840: ###############################################
1.182 matthew 9841:
9842: =pod
9843:
1.549 albertel 9844: =back
9845:
9846: =head1 User Information Routines
9847:
9848: =over 4
9849:
1.405 albertel 9850: =item * &get_users_function()
1.182 matthew 9851:
9852: Used by &bodytag to determine the current users primary role.
9853: Returns either 'student','coordinator','admin', or 'author'.
9854:
9855: =cut
9856:
9857: ###############################################
9858: sub get_users_function {
1.815 tempelho 9859: my $function = 'norole';
1.818 tempelho 9860: if ($env{'request.role'}=~/^(st)/) {
9861: $function='student';
9862: }
1.907 raeburn 9863: if ($env{'request.role'}=~/^(cc|co|in|ta|ep)/) {
1.182 matthew 9864: $function='coordinator';
9865: }
1.258 albertel 9866: if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182 matthew 9867: $function='admin';
9868: }
1.826 bisitz 9869: if (($env{'request.role'}=~/^(au|ca|aa)/) ||
1.1025 raeburn 9870: ($ENV{'REQUEST_URI'}=~ m{/^(/priv)})) {
1.182 matthew 9871: $function='author';
9872: }
9873: return $function;
1.54 www 9874: }
1.99 www 9875:
9876: ###############################################
9877:
1.233 raeburn 9878: =pod
9879:
1.821 raeburn 9880: =item * &show_course()
9881:
9882: Used by lonmenu.pm and lonroles.pm to determine whether to use the word
9883: 'Courses' or 'Roles' in inline navigation and on screen displaying user's roles.
9884:
9885: Inputs:
9886: None
9887:
9888: Outputs:
9889: Scalar: 1 if 'Course' to be used, 0 otherwise.
9890:
9891: =cut
9892:
9893: ###############################################
9894: sub show_course {
9895: my $course = !$env{'user.adv'};
9896: if (!$env{'user.adv'}) {
9897: foreach my $env (keys(%env)) {
9898: next if ($env !~ m/^user\.priv\./);
9899: if ($env !~ m/^user\.priv\.(?:st|cm)/) {
9900: $course = 0;
9901: last;
9902: }
9903: }
9904: }
9905: return $course;
9906: }
9907:
9908: ###############################################
9909:
9910: =pod
9911:
1.542 raeburn 9912: =item * &check_user_status()
1.274 raeburn 9913:
9914: Determines current status of supplied role for a
9915: specific user. Roles can be active, previous or future.
9916:
9917: Inputs:
9918: user's domain, user's username, course's domain,
1.375 raeburn 9919: course's number, optional section ID.
1.274 raeburn 9920:
9921: Outputs:
9922: role status: active, previous or future.
9923:
9924: =cut
9925:
9926: sub check_user_status {
1.412 raeburn 9927: my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
1.1073 raeburn 9928: my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname);
1.1202 raeburn 9929: my @uroles = keys(%userinfo);
1.274 raeburn 9930: my $srchstr;
9931: my $active_chk = 'none';
1.412 raeburn 9932: my $now = time;
1.274 raeburn 9933: if (@uroles > 0) {
1.908 raeburn 9934: if (($role eq 'cc') || ($role eq 'co') || ($sec eq '') || (!defined($sec))) {
1.274 raeburn 9935: $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
9936: } else {
1.412 raeburn 9937: $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
9938: }
9939: if (grep/^\Q$srchstr\E$/,@uroles) {
1.274 raeburn 9940: my $role_end = 0;
9941: my $role_start = 0;
9942: $active_chk = 'active';
1.412 raeburn 9943: if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
9944: $role_end = $1;
9945: if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
9946: $role_start = $1;
1.274 raeburn 9947: }
9948: }
9949: if ($role_start > 0) {
1.412 raeburn 9950: if ($now < $role_start) {
1.274 raeburn 9951: $active_chk = 'future';
9952: }
9953: }
9954: if ($role_end > 0) {
1.412 raeburn 9955: if ($now > $role_end) {
1.274 raeburn 9956: $active_chk = 'previous';
9957: }
9958: }
9959: }
9960: }
9961: return $active_chk;
9962: }
9963:
9964: ###############################################
9965:
9966: =pod
9967:
1.405 albertel 9968: =item * &get_sections()
1.233 raeburn 9969:
9970: Determines all the sections for a course including
9971: sections with students and sections containing other roles.
1.419 raeburn 9972: Incoming parameters:
9973:
9974: 1. domain
9975: 2. course number
9976: 3. reference to array containing roles for which sections should
9977: be gathered (optional).
9978: 4. reference to array containing status types for which sections
9979: should be gathered (optional).
9980:
9981: If the third argument is undefined, sections are gathered for any role.
9982: If the fourth argument is undefined, sections are gathered for any status.
9983: Permissible values are 'active' or 'future' or 'previous'.
1.233 raeburn 9984:
1.374 raeburn 9985: Returns section hash (keys are section IDs, values are
9986: number of users in each section), subject to the
1.419 raeburn 9987: optional roles filter, optional status filter
1.233 raeburn 9988:
9989: =cut
9990:
9991: ###############################################
9992: sub get_sections {
1.419 raeburn 9993: my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
1.366 albertel 9994: if (!defined($cdom) || !defined($cnum)) {
9995: my $cid = $env{'request.course.id'};
9996:
9997: return if (!defined($cid));
9998:
9999: $cdom = $env{'course.'.$cid.'.domain'};
10000: $cnum = $env{'course.'.$cid.'.num'};
10001: }
10002:
10003: my %sectioncount;
1.419 raeburn 10004: my $now = time;
1.240 albertel 10005:
1.1118 raeburn 10006: my $check_students = 1;
10007: my $only_students = 0;
10008: if (ref($possible_roles) eq 'ARRAY') {
10009: if (grep(/^st$/,@{$possible_roles})) {
10010: if (@{$possible_roles} == 1) {
10011: $only_students = 1;
10012: }
10013: } else {
10014: $check_students = 0;
10015: }
10016: }
10017:
10018: if ($check_students) {
1.276 albertel 10019: my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240 albertel 10020: my $sec_index = &Apache::loncoursedata::CL_SECTION();
10021: my $status_index = &Apache::loncoursedata::CL_STATUS();
1.419 raeburn 10022: my $start_index = &Apache::loncoursedata::CL_START();
10023: my $end_index = &Apache::loncoursedata::CL_END();
10024: my $status;
1.366 albertel 10025: while (my ($student,$data) = each(%$classlist)) {
1.419 raeburn 10026: my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
10027: $data->[$status_index],
10028: $data->[$start_index],
10029: $data->[$end_index]);
10030: if ($stu_status eq 'Active') {
10031: $status = 'active';
10032: } elsif ($end < $now) {
10033: $status = 'previous';
10034: } elsif ($start > $now) {
10035: $status = 'future';
10036: }
10037: if ($section ne '-1' && $section !~ /^\s*$/) {
10038: if ((!defined($possible_status)) || (($status ne '') &&
10039: (grep/^\Q$status\E$/,@{$possible_status}))) {
10040: $sectioncount{$section}++;
10041: }
1.240 albertel 10042: }
10043: }
10044: }
1.1118 raeburn 10045: if ($only_students) {
10046: return %sectioncount;
10047: }
1.240 albertel 10048: my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
10049: foreach my $user (sort(keys(%courseroles))) {
10050: if ($user !~ /^(\w{2})/) { next; }
10051: my ($role) = ($user =~ /^(\w{2})/);
10052: if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
1.419 raeburn 10053: my ($section,$status);
1.240 albertel 10054: if ($role eq 'cr' &&
10055: $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
10056: $section=$1;
10057: }
10058: if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
10059: if (!defined($section) || $section eq '-1') { next; }
1.419 raeburn 10060: my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
10061: if ($end == -1 && $start == -1) {
10062: next; #deleted role
10063: }
10064: if (!defined($possible_status)) {
10065: $sectioncount{$section}++;
10066: } else {
10067: if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
10068: $status = 'active';
10069: } elsif ($end < $now) {
10070: $status = 'future';
10071: } elsif ($start > $now) {
10072: $status = 'previous';
10073: }
10074: if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
10075: $sectioncount{$section}++;
10076: }
10077: }
1.233 raeburn 10078: }
1.366 albertel 10079: return %sectioncount;
1.233 raeburn 10080: }
10081:
1.274 raeburn 10082: ###############################################
1.294 raeburn 10083:
10084: =pod
1.405 albertel 10085:
10086: =item * &get_course_users()
10087:
1.275 raeburn 10088: Retrieves usernames:domains for users in the specified course
10089: with specific role(s), and access status.
10090:
10091: Incoming parameters:
1.277 albertel 10092: 1. course domain
10093: 2. course number
10094: 3. access status: users must have - either active,
1.275 raeburn 10095: previous, future, or all.
1.277 albertel 10096: 4. reference to array of permissible roles
1.288 raeburn 10097: 5. reference to array of section restrictions (optional)
10098: 6. reference to results object (hash of hashes).
10099: 7. reference to optional userdata hash
1.609 raeburn 10100: 8. reference to optional statushash
1.630 raeburn 10101: 9. flag if privileged users (except those set to unhide in
10102: course settings) should be excluded
1.609 raeburn 10103: Keys of top level results hash are roles.
1.275 raeburn 10104: Keys of inner hashes are username:domain, with
10105: values set to access type.
1.288 raeburn 10106: Optional userdata hash returns an array with arguments in the
10107: same order as loncoursedata::get_classlist() for student data.
10108:
1.609 raeburn 10109: Optional statushash returns
10110:
1.288 raeburn 10111: Entries for end, start, section and status are blank because
10112: of the possibility of multiple values for non-student roles.
10113:
1.275 raeburn 10114: =cut
1.405 albertel 10115:
1.275 raeburn 10116: ###############################################
1.405 albertel 10117:
1.275 raeburn 10118: sub get_course_users {
1.630 raeburn 10119: my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
1.288 raeburn 10120: my %idx = ();
1.419 raeburn 10121: my %seclists;
1.288 raeburn 10122:
10123: $idx{udom} = &Apache::loncoursedata::CL_SDOM();
10124: $idx{uname} = &Apache::loncoursedata::CL_SNAME();
10125: $idx{end} = &Apache::loncoursedata::CL_END();
10126: $idx{start} = &Apache::loncoursedata::CL_START();
10127: $idx{id} = &Apache::loncoursedata::CL_ID();
10128: $idx{section} = &Apache::loncoursedata::CL_SECTION();
10129: $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
10130: $idx{status} = &Apache::loncoursedata::CL_STATUS();
10131:
1.290 albertel 10132: if (grep(/^st$/,@{$roles})) {
1.276 albertel 10133: my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278 raeburn 10134: my $now = time;
1.277 albertel 10135: foreach my $student (keys(%{$classlist})) {
1.288 raeburn 10136: my $match = 0;
1.412 raeburn 10137: my $secmatch = 0;
1.419 raeburn 10138: my $section = $$classlist{$student}[$idx{section}];
1.609 raeburn 10139: my $status = $$classlist{$student}[$idx{status}];
1.419 raeburn 10140: if ($section eq '') {
10141: $section = 'none';
10142: }
1.291 albertel 10143: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 10144: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 10145: $secmatch = 1;
10146: } elsif ($$classlist{$student}[$idx{section}] eq '') {
1.420 albertel 10147: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 10148: $secmatch = 1;
10149: }
10150: } else {
1.419 raeburn 10151: if (grep(/^\Q$section\E$/,@{$sections})) {
1.412 raeburn 10152: $secmatch = 1;
10153: }
1.290 albertel 10154: }
1.412 raeburn 10155: if (!$secmatch) {
10156: next;
10157: }
1.419 raeburn 10158: }
1.275 raeburn 10159: if (defined($$types{'active'})) {
1.288 raeburn 10160: if ($$classlist{$student}[$idx{status}] eq 'Active') {
1.275 raeburn 10161: push(@{$$users{st}{$student}},'active');
1.288 raeburn 10162: $match = 1;
1.275 raeburn 10163: }
10164: }
10165: if (defined($$types{'previous'})) {
1.609 raeburn 10166: if ($$classlist{$student}[$idx{status}] eq 'Expired') {
1.275 raeburn 10167: push(@{$$users{st}{$student}},'previous');
1.288 raeburn 10168: $match = 1;
1.275 raeburn 10169: }
10170: }
10171: if (defined($$types{'future'})) {
1.609 raeburn 10172: if ($$classlist{$student}[$idx{status}] eq 'Future') {
1.275 raeburn 10173: push(@{$$users{st}{$student}},'future');
1.288 raeburn 10174: $match = 1;
1.275 raeburn 10175: }
10176: }
1.609 raeburn 10177: if ($match) {
10178: push(@{$seclists{$student}},$section);
10179: if (ref($userdata) eq 'HASH') {
10180: $$userdata{$student} = $$classlist{$student};
10181: }
10182: if (ref($statushash) eq 'HASH') {
10183: $statushash->{$student}{'st'}{$section} = $status;
10184: }
1.288 raeburn 10185: }
1.275 raeburn 10186: }
10187: }
1.412 raeburn 10188: if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
1.439 raeburn 10189: my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
10190: my $now = time;
1.609 raeburn 10191: my %displaystatus = ( previous => 'Expired',
10192: active => 'Active',
10193: future => 'Future',
10194: );
1.1121 raeburn 10195: my (%nothide,@possdoms);
1.630 raeburn 10196: if ($hidepriv) {
10197: my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
10198: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
10199: if ($user !~ /:/) {
10200: $nothide{join(':',split(/[\@]/,$user))}=1;
10201: } else {
10202: $nothide{$user} = 1;
10203: }
10204: }
1.1121 raeburn 10205: my @possdoms = ($cdom);
10206: if ($coursehash{'checkforpriv'}) {
10207: push(@possdoms,split(/,/,$coursehash{'checkforpriv'}));
10208: }
1.630 raeburn 10209: }
1.439 raeburn 10210: foreach my $person (sort(keys(%coursepersonnel))) {
1.288 raeburn 10211: my $match = 0;
1.412 raeburn 10212: my $secmatch = 0;
1.439 raeburn 10213: my $status;
1.412 raeburn 10214: my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
1.275 raeburn 10215: $user =~ s/:$//;
1.439 raeburn 10216: my ($end,$start) = split(/:/,$coursepersonnel{$person});
10217: if ($end == -1 || $start == -1) {
10218: next;
10219: }
10220: if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
10221: (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
1.412 raeburn 10222: my ($uname,$udom) = split(/:/,$user);
10223: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 10224: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 10225: $secmatch = 1;
10226: } elsif ($usec eq '') {
1.420 albertel 10227: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 10228: $secmatch = 1;
10229: }
10230: } else {
10231: if (grep(/^\Q$usec\E$/,@{$sections})) {
10232: $secmatch = 1;
10233: }
10234: }
10235: if (!$secmatch) {
10236: next;
10237: }
1.288 raeburn 10238: }
1.419 raeburn 10239: if ($usec eq '') {
10240: $usec = 'none';
10241: }
1.275 raeburn 10242: if ($uname ne '' && $udom ne '') {
1.630 raeburn 10243: if ($hidepriv) {
1.1121 raeburn 10244: if ((&Apache::lonnet::privileged($uname,$udom,\@possdoms)) &&
1.630 raeburn 10245: (!$nothide{$uname.':'.$udom})) {
10246: next;
10247: }
10248: }
1.503 raeburn 10249: if ($end > 0 && $end < $now) {
1.439 raeburn 10250: $status = 'previous';
10251: } elsif ($start > $now) {
10252: $status = 'future';
10253: } else {
10254: $status = 'active';
10255: }
1.277 albertel 10256: foreach my $type (keys(%{$types})) {
1.275 raeburn 10257: if ($status eq $type) {
1.420 albertel 10258: if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
1.419 raeburn 10259: push(@{$$users{$role}{$user}},$type);
10260: }
1.288 raeburn 10261: $match = 1;
10262: }
10263: }
1.419 raeburn 10264: if (($match) && (ref($userdata) eq 'HASH')) {
10265: if (!exists($$userdata{$uname.':'.$udom})) {
10266: &get_user_info($udom,$uname,\%idx,$userdata);
10267: }
1.420 albertel 10268: if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
1.419 raeburn 10269: push(@{$seclists{$uname.':'.$udom}},$usec);
10270: }
1.609 raeburn 10271: if (ref($statushash) eq 'HASH') {
10272: $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
10273: }
1.275 raeburn 10274: }
10275: }
10276: }
10277: }
1.290 albertel 10278: if (grep(/^ow$/,@{$roles})) {
1.279 raeburn 10279: if ((defined($cdom)) && (defined($cnum))) {
10280: my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
10281: if ( defined($csettings{'internal.courseowner'}) ) {
10282: my $owner = $csettings{'internal.courseowner'};
1.609 raeburn 10283: next if ($owner eq '');
10284: my ($ownername,$ownerdom);
10285: if ($owner =~ /^([^:]+):([^:]+)$/) {
10286: $ownername = $1;
10287: $ownerdom = $2;
10288: } else {
10289: $ownername = $owner;
10290: $ownerdom = $cdom;
10291: $owner = $ownername.':'.$ownerdom;
1.439 raeburn 10292: }
10293: @{$$users{'ow'}{$owner}} = 'any';
1.290 albertel 10294: if (defined($userdata) &&
1.609 raeburn 10295: !exists($$userdata{$owner})) {
10296: &get_user_info($ownerdom,$ownername,\%idx,$userdata);
10297: if (!grep(/^none$/,@{$seclists{$owner}})) {
10298: push(@{$seclists{$owner}},'none');
10299: }
10300: if (ref($statushash) eq 'HASH') {
10301: $statushash->{$owner}{'ow'}{'none'} = 'Any';
1.419 raeburn 10302: }
1.290 albertel 10303: }
1.279 raeburn 10304: }
10305: }
10306: }
1.419 raeburn 10307: foreach my $user (keys(%seclists)) {
10308: @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
10309: $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
10310: }
1.275 raeburn 10311: }
10312: return;
10313: }
10314:
1.288 raeburn 10315: sub get_user_info {
10316: my ($udom,$uname,$idx,$userdata) = @_;
1.289 albertel 10317: $$userdata{$uname.':'.$udom}[$$idx{fullname}] =
10318: &plainname($uname,$udom,'lastname');
1.291 albertel 10319: $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
1.297 raeburn 10320: $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
1.609 raeburn 10321: my %idhash = &Apache::lonnet::idrget($udom,($uname));
10322: $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname};
1.288 raeburn 10323: return;
10324: }
1.275 raeburn 10325:
1.472 raeburn 10326: ###############################################
10327:
10328: =pod
10329:
10330: =item * &get_user_quota()
10331:
1.1134 raeburn 10332: Retrieves quota assigned for storage of user files.
10333: Default is to report quota for portfolio files.
1.472 raeburn 10334:
10335: Incoming parameters:
10336: 1. user's username
10337: 2. user's domain
1.1134 raeburn 10338: 3. quota name - portfolio, author, or course
1.1136 raeburn 10339: (if no quota name provided, defaults to portfolio).
1.1237 raeburn 10340: 4. crstype - official, unofficial, textbook, placement or community,
10341: if quota name is course
1.472 raeburn 10342:
10343: Returns:
1.1163 raeburn 10344: 1. Disk quota (in MB) assigned to student.
1.536 raeburn 10345: 2. (Optional) Type of setting: custom or default
10346: (individually assigned or default for user's
10347: institutional status).
10348: 3. (Optional) - User's institutional status (e.g., faculty, staff
10349: or student - types as defined in localenroll::inst_usertypes
10350: for user's domain, which determines default quota for user.
10351: 4. (Optional) - Default quota which would apply to the user.
1.472 raeburn 10352:
10353: If a value has been stored in the user's environment,
1.536 raeburn 10354: it will return that, otherwise it returns the maximal default
1.1134 raeburn 10355: defined for the user's institutional status(es) in the domain.
1.472 raeburn 10356:
10357: =cut
10358:
10359: ###############################################
10360:
10361:
10362: sub get_user_quota {
1.1136 raeburn 10363: my ($uname,$udom,$quotaname,$crstype) = @_;
1.536 raeburn 10364: my ($quota,$quotatype,$settingstatus,$defquota);
1.472 raeburn 10365: if (!defined($udom)) {
10366: $udom = $env{'user.domain'};
10367: }
10368: if (!defined($uname)) {
10369: $uname = $env{'user.name'};
10370: }
10371: if (($udom eq '' || $uname eq '') ||
10372: ($udom eq 'public') && ($uname eq 'public')) {
10373: $quota = 0;
1.536 raeburn 10374: $quotatype = 'default';
10375: $defquota = 0;
1.472 raeburn 10376: } else {
1.536 raeburn 10377: my $inststatus;
1.1134 raeburn 10378: if ($quotaname eq 'course') {
10379: if (($env{'course.'.$udom.'_'.$uname.'.num'} eq $uname) &&
10380: ($env{'course.'.$udom.'_'.$uname.'.domain'} eq $udom)) {
10381: $quota = $env{'course.'.$udom.'_'.$uname.'.internal.uploadquota'};
10382: } else {
10383: my %cenv = &Apache::lonnet::coursedescription("$udom/$uname");
10384: $quota = $cenv{'internal.uploadquota'};
10385: }
1.536 raeburn 10386: } else {
1.1134 raeburn 10387: if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
10388: if ($quotaname eq 'author') {
10389: $quota = $env{'environment.authorquota'};
10390: } else {
10391: $quota = $env{'environment.portfolioquota'};
10392: }
10393: $inststatus = $env{'environment.inststatus'};
10394: } else {
10395: my %userenv =
10396: &Apache::lonnet::get('environment',['portfolioquota',
10397: 'authorquota','inststatus'],$udom,$uname);
10398: my ($tmp) = keys(%userenv);
10399: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
10400: if ($quotaname eq 'author') {
10401: $quota = $userenv{'authorquota'};
10402: } else {
10403: $quota = $userenv{'portfolioquota'};
10404: }
10405: $inststatus = $userenv{'inststatus'};
10406: } else {
10407: undef(%userenv);
10408: }
10409: }
10410: }
10411: if ($quota eq '' || wantarray) {
10412: if ($quotaname eq 'course') {
10413: my %domdefs = &Apache::lonnet::get_domain_defaults($udom);
1.1165 raeburn 10414: if (($crstype eq 'official') || ($crstype eq 'unofficial') ||
1.1237 raeburn 10415: ($crstype eq 'community') || ($crstype eq 'textbook') ||
10416: ($crstype eq 'placement')) {
1.1136 raeburn 10417: $defquota = $domdefs{$crstype.'quota'};
10418: }
10419: if ($defquota eq '') {
10420: $defquota = 500;
10421: }
1.1134 raeburn 10422: } else {
10423: ($defquota,$settingstatus) = &default_quota($udom,$inststatus,$quotaname);
10424: }
10425: if ($quota eq '') {
10426: $quota = $defquota;
10427: $quotatype = 'default';
10428: } else {
10429: $quotatype = 'custom';
10430: }
1.472 raeburn 10431: }
10432: }
1.536 raeburn 10433: if (wantarray) {
10434: return ($quota,$quotatype,$settingstatus,$defquota);
10435: } else {
10436: return $quota;
10437: }
1.472 raeburn 10438: }
10439:
10440: ###############################################
10441:
10442: =pod
10443:
10444: =item * &default_quota()
10445:
1.536 raeburn 10446: Retrieves default quota assigned for storage of user portfolio files,
10447: given an (optional) user's institutional status.
1.472 raeburn 10448:
10449: Incoming parameters:
1.1142 raeburn 10450:
1.472 raeburn 10451: 1. domain
1.536 raeburn 10452: 2. (Optional) institutional status(es). This is a : separated list of
10453: status types (e.g., faculty, staff, student etc.)
10454: which apply to the user for whom the default is being retrieved.
10455: If the institutional status string in undefined, the domain
1.1134 raeburn 10456: default quota will be returned.
10457: 3. quota name - portfolio, author, or course
10458: (if no quota name provided, defaults to portfolio).
1.472 raeburn 10459:
10460: Returns:
1.1142 raeburn 10461:
1.1163 raeburn 10462: 1. Default disk quota (in MB) for user portfolios in the domain.
1.536 raeburn 10463: 2. (Optional) institutional type which determined the value of the
10464: default quota.
1.472 raeburn 10465:
10466: If a value has been stored in the domain's configuration db,
10467: it will return that, otherwise it returns 20 (for backwards
10468: compatibility with domains which have not set up a configuration
1.1163 raeburn 10469: db file; the original statically defined portfolio quota was 20 MB).
1.472 raeburn 10470:
1.536 raeburn 10471: If the user's status includes multiple types (e.g., staff and student),
10472: the largest default quota which applies to the user determines the
10473: default quota returned.
10474:
1.472 raeburn 10475: =cut
10476:
10477: ###############################################
10478:
10479:
10480: sub default_quota {
1.1134 raeburn 10481: my ($udom,$inststatus,$quotaname) = @_;
1.536 raeburn 10482: my ($defquota,$settingstatus);
10483: my %quotahash = &Apache::lonnet::get_dom('configuration',
1.622 raeburn 10484: ['quotas'],$udom);
1.1134 raeburn 10485: my $key = 'defaultquota';
10486: if ($quotaname eq 'author') {
10487: $key = 'authorquota';
10488: }
1.622 raeburn 10489: if (ref($quotahash{'quotas'}) eq 'HASH') {
1.536 raeburn 10490: if ($inststatus ne '') {
1.765 raeburn 10491: my @statuses = map { &unescape($_); } split(/:/,$inststatus);
1.536 raeburn 10492: foreach my $item (@statuses) {
1.1134 raeburn 10493: if (ref($quotahash{'quotas'}{$key}) eq 'HASH') {
10494: if ($quotahash{'quotas'}{$key}{$item} ne '') {
1.711 raeburn 10495: if ($defquota eq '') {
1.1134 raeburn 10496: $defquota = $quotahash{'quotas'}{$key}{$item};
1.711 raeburn 10497: $settingstatus = $item;
1.1134 raeburn 10498: } elsif ($quotahash{'quotas'}{$key}{$item} > $defquota) {
10499: $defquota = $quotahash{'quotas'}{$key}{$item};
1.711 raeburn 10500: $settingstatus = $item;
10501: }
10502: }
1.1134 raeburn 10503: } elsif ($key eq 'defaultquota') {
1.711 raeburn 10504: if ($quotahash{'quotas'}{$item} ne '') {
10505: if ($defquota eq '') {
10506: $defquota = $quotahash{'quotas'}{$item};
10507: $settingstatus = $item;
10508: } elsif ($quotahash{'quotas'}{$item} > $defquota) {
10509: $defquota = $quotahash{'quotas'}{$item};
10510: $settingstatus = $item;
10511: }
1.536 raeburn 10512: }
10513: }
10514: }
10515: }
10516: if ($defquota eq '') {
1.1134 raeburn 10517: if (ref($quotahash{'quotas'}{$key}) eq 'HASH') {
10518: $defquota = $quotahash{'quotas'}{$key}{'default'};
10519: } elsif ($key eq 'defaultquota') {
1.711 raeburn 10520: $defquota = $quotahash{'quotas'}{'default'};
10521: }
1.536 raeburn 10522: $settingstatus = 'default';
1.1139 raeburn 10523: if ($defquota eq '') {
10524: if ($quotaname eq 'author') {
10525: $defquota = 500;
10526: }
10527: }
1.536 raeburn 10528: }
10529: } else {
10530: $settingstatus = 'default';
1.1134 raeburn 10531: if ($quotaname eq 'author') {
10532: $defquota = 500;
10533: } else {
10534: $defquota = 20;
10535: }
1.536 raeburn 10536: }
10537: if (wantarray) {
10538: return ($defquota,$settingstatus);
1.472 raeburn 10539: } else {
1.536 raeburn 10540: return $defquota;
1.472 raeburn 10541: }
10542: }
10543:
1.1135 raeburn 10544: ###############################################
10545:
10546: =pod
10547:
1.1136 raeburn 10548: =item * &excess_filesize_warning()
1.1135 raeburn 10549:
10550: Returns warning message if upload of file to authoring space, or copying
1.1136 raeburn 10551: of existing file within authoring space will cause quota for the authoring
1.1146 raeburn 10552: space to be exceeded.
1.1136 raeburn 10553:
10554: Same, if upload of a file directly to a course/community via Course Editor
1.1137 raeburn 10555: will cause quota for uploaded content for the course to be exceeded.
1.1135 raeburn 10556:
1.1165 raeburn 10557: Inputs: 7
1.1136 raeburn 10558: 1. username or coursenum
1.1135 raeburn 10559: 2. domain
1.1136 raeburn 10560: 3. context ('author' or 'course')
1.1135 raeburn 10561: 4. filename of file for which action is being requested
10562: 5. filesize (kB) of file
10563: 6. action being taken: copy or upload.
1.1237 raeburn 10564: 7. quotatype (in course context -- official, unofficial, textbook, placement or community).
1.1135 raeburn 10565:
10566: Returns: 1 scalar: HTML to display containing warning if quota would be exceeded,
1.1142 raeburn 10567: otherwise return null.
10568:
10569: =back
1.1135 raeburn 10570:
10571: =cut
10572:
1.1136 raeburn 10573: sub excess_filesize_warning {
1.1165 raeburn 10574: my ($uname,$udom,$context,$filename,$filesize,$action,$quotatype) = @_;
1.1136 raeburn 10575: my $current_disk_usage = 0;
1.1165 raeburn 10576: my $disk_quota = &get_user_quota($uname,$udom,$context,$quotatype); #expressed in MB
1.1136 raeburn 10577: if ($context eq 'author') {
10578: my $authorspace = $Apache::lonnet::perlvar{'lonDocRoot'}."/priv/$udom/$uname";
10579: $current_disk_usage = &Apache::lonnet::diskusage($udom,$uname,$authorspace);
10580: } else {
10581: foreach my $subdir ('docs','supplemental') {
10582: $current_disk_usage += &Apache::lonnet::diskusage($udom,$uname,"userfiles/$subdir",1);
10583: }
10584: }
1.1135 raeburn 10585: $disk_quota = int($disk_quota * 1000);
10586: if (($current_disk_usage + $filesize) > $disk_quota) {
1.1179 bisitz 10587: return '<p class="LC_warning">'.
1.1135 raeburn 10588: &mt("Unable to $action [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.",
1.1179 bisitz 10589: '<span class="LC_filename">'.$filename.'</span>',$filesize).'</p>'.
10590: '<p>'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',
1.1135 raeburn 10591: $disk_quota,$current_disk_usage).
10592: '</p>';
10593: }
10594: return;
10595: }
10596:
10597: ###############################################
10598:
10599:
1.1136 raeburn 10600:
10601:
1.384 raeburn 10602: sub get_secgrprole_info {
10603: my ($cdom,$cnum,$needroles,$type) = @_;
10604: my %sections_count = &get_sections($cdom,$cnum);
10605: my @sections = (sort {$a <=> $b} keys(%sections_count));
10606: my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
10607: my @groups = sort(keys(%curr_groups));
10608: my $allroles = [];
10609: my $rolehash;
10610: my $accesshash = {
10611: active => 'Currently has access',
10612: future => 'Will have future access',
10613: previous => 'Previously had access',
10614: };
10615: if ($needroles) {
10616: $rolehash = {'all' => 'all'};
1.385 albertel 10617: my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
10618: if (&Apache::lonnet::error(%user_roles)) {
10619: undef(%user_roles);
10620: }
10621: foreach my $item (keys(%user_roles)) {
1.384 raeburn 10622: my ($role)=split(/\:/,$item,2);
10623: if ($role eq 'cr') { next; }
10624: if ($role =~ /^cr/) {
10625: $$rolehash{$role} = (split('/',$role))[3];
10626: } else {
10627: $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
10628: }
10629: }
10630: foreach my $key (sort(keys(%{$rolehash}))) {
10631: push(@{$allroles},$key);
10632: }
10633: push (@{$allroles},'st');
10634: $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
10635: }
10636: return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
10637: }
10638:
1.555 raeburn 10639: sub user_picker {
1.1279 raeburn 10640: my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype,$context,$fixeddom,$noinstd) = @_;
1.555 raeburn 10641: my $currdom = $dom;
1.1253 raeburn 10642: my @alldoms = &Apache::lonnet::all_domains();
10643: if (@alldoms == 1) {
10644: my %domsrch = &Apache::lonnet::get_dom('configuration',
10645: ['directorysrch'],$alldoms[0]);
10646: my $domdesc = &Apache::lonnet::domain($alldoms[0],'description');
10647: my $showdom = $domdesc;
10648: if ($showdom eq '') {
10649: $showdom = $dom;
10650: }
10651: if (ref($domsrch{'directorysrch'}) eq 'HASH') {
10652: if ((!$domsrch{'directorysrch'}{'available'}) &&
10653: ($domsrch{'directorysrch'}{'lcavailable'} eq '0')) {
10654: return (&mt('LON-CAPA directory search is not available in domain: [_1]',$showdom),0);
10655: }
10656: }
10657: }
1.555 raeburn 10658: my %curr_selected = (
10659: srchin => 'dom',
1.580 raeburn 10660: srchby => 'lastname',
1.555 raeburn 10661: );
10662: my $srchterm;
1.625 raeburn 10663: if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
1.555 raeburn 10664: if ($srch->{'srchby'} ne '') {
10665: $curr_selected{'srchby'} = $srch->{'srchby'};
10666: }
10667: if ($srch->{'srchin'} ne '') {
10668: $curr_selected{'srchin'} = $srch->{'srchin'};
10669: }
10670: if ($srch->{'srchtype'} ne '') {
10671: $curr_selected{'srchtype'} = $srch->{'srchtype'};
10672: }
10673: if ($srch->{'srchdomain'} ne '') {
10674: $currdom = $srch->{'srchdomain'};
10675: }
10676: $srchterm = $srch->{'srchterm'};
10677: }
1.1222 damieng 10678: my %html_lt=&Apache::lonlocal::texthash(
1.573 raeburn 10679: 'usr' => 'Search criteria',
1.563 raeburn 10680: 'doma' => 'Domain/institution to search',
1.558 albertel 10681: 'uname' => 'username',
10682: 'lastname' => 'last name',
1.555 raeburn 10683: 'lastfirst' => 'last name, first name',
1.558 albertel 10684: 'crs' => 'in this course',
1.576 raeburn 10685: 'dom' => 'in selected LON-CAPA domain',
1.558 albertel 10686: 'alc' => 'all LON-CAPA',
1.573 raeburn 10687: 'instd' => 'in institutional directory for selected domain',
1.558 albertel 10688: 'exact' => 'is',
10689: 'contains' => 'contains',
1.569 raeburn 10690: 'begins' => 'begins with',
1.1222 damieng 10691: );
10692: my %js_lt=&Apache::lonlocal::texthash(
1.571 raeburn 10693: 'youm' => "You must include some text to search for.",
10694: 'thte' => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
10695: 'thet' => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
10696: 'yomc' => "You must choose a domain when using an institutional directory search.",
10697: 'ymcd' => "You must choose a domain when using a domain search.",
10698: 'whus' => "When using searching by last,first you must include a comma as separator between last name and first name.",
10699: 'whse' => "When searching by last,first you must include at least one character in the first name.",
10700: 'thfo' => "The following need to be corrected before the search can be run:",
1.555 raeburn 10701: );
1.1222 damieng 10702: &html_escape(\%html_lt);
10703: &js_escape(\%js_lt);
1.1255 raeburn 10704: my $domform;
1.1277 raeburn 10705: my $allow_blank = 1;
1.1255 raeburn 10706: if ($fixeddom) {
1.1277 raeburn 10707: $allow_blank = 0;
10708: $domform = &select_dom_form($currdom,'srchdomain',$allow_blank,1,undef,[$currdom]);
1.1255 raeburn 10709: } else {
1.1287 raeburn 10710: my $defdom = $env{'request.role.domain'};
1.1288 raeburn 10711: my ($trusted,$untrusted);
1.1287 raeburn 10712: if (($context eq 'requestcrs') || ($context eq 'course')) {
1.1288 raeburn 10713: ($trusted,$untrusted) = &Apache::lonnet::trusted_domains('enroll',$defdom);
1.1287 raeburn 10714: } elsif ($context eq 'author') {
1.1288 raeburn 10715: ($trusted,$untrusted) = &Apache::lonnet::trusted_domains('othcoau',$defdom);
1.1287 raeburn 10716: } elsif ($context eq 'domain') {
1.1288 raeburn 10717: ($trusted,$untrusted) = &Apache::lonnet::trusted_domains('domroles',$defdom);
1.1287 raeburn 10718: }
1.1288 raeburn 10719: $domform = &select_dom_form($currdom,'srchdomain',$allow_blank,1,undef,$trusted,$untrusted);
1.1255 raeburn 10720: }
1.563 raeburn 10721: my $srchinsel = ' <select name="srchin">';
1.555 raeburn 10722:
10723: my @srchins = ('crs','dom','alc','instd');
10724:
10725: foreach my $option (@srchins) {
10726: # FIXME 'alc' option unavailable until
10727: # loncreateuser::print_user_query_page()
10728: # has been completed.
10729: next if ($option eq 'alc');
1.880 raeburn 10730: next if (($option eq 'crs') && ($env{'form.form'} eq 'requestcrs'));
1.555 raeburn 10731: next if ($option eq 'crs' && !$env{'request.course.id'});
1.1279 raeburn 10732: next if (($option eq 'instd') && ($noinstd));
1.563 raeburn 10733: if ($curr_selected{'srchin'} eq $option) {
10734: $srchinsel .= '
1.1222 damieng 10735: <option value="'.$option.'" selected="selected">'.$html_lt{$option}.'</option>';
1.563 raeburn 10736: } else {
10737: $srchinsel .= '
1.1222 damieng 10738: <option value="'.$option.'">'.$html_lt{$option}.'</option>';
1.563 raeburn 10739: }
1.555 raeburn 10740: }
1.563 raeburn 10741: $srchinsel .= "\n </select>\n";
1.555 raeburn 10742:
10743: my $srchbysel = ' <select name="srchby">';
1.580 raeburn 10744: foreach my $option ('lastname','lastfirst','uname') {
1.555 raeburn 10745: if ($curr_selected{'srchby'} eq $option) {
10746: $srchbysel .= '
1.1222 damieng 10747: <option value="'.$option.'" selected="selected">'.$html_lt{$option}.'</option>';
1.555 raeburn 10748: } else {
10749: $srchbysel .= '
1.1222 damieng 10750: <option value="'.$option.'">'.$html_lt{$option}.'</option>';
1.555 raeburn 10751: }
10752: }
10753: $srchbysel .= "\n </select>\n";
10754:
10755: my $srchtypesel = ' <select name="srchtype">';
1.580 raeburn 10756: foreach my $option ('begins','contains','exact') {
1.555 raeburn 10757: if ($curr_selected{'srchtype'} eq $option) {
10758: $srchtypesel .= '
1.1222 damieng 10759: <option value="'.$option.'" selected="selected">'.$html_lt{$option}.'</option>';
1.555 raeburn 10760: } else {
10761: $srchtypesel .= '
1.1222 damieng 10762: <option value="'.$option.'">'.$html_lt{$option}.'</option>';
1.555 raeburn 10763: }
10764: }
10765: $srchtypesel .= "\n </select>\n";
10766:
1.558 albertel 10767: my ($newuserscript,$new_user_create);
1.994 raeburn 10768: my $context_dom = $env{'request.role.domain'};
10769: if ($context eq 'requestcrs') {
10770: if ($env{'form.coursedom'} ne '') {
10771: $context_dom = $env{'form.coursedom'};
10772: }
10773: }
1.556 raeburn 10774: if ($forcenewuser) {
1.576 raeburn 10775: if (ref($srch) eq 'HASH') {
1.994 raeburn 10776: if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $context_dom) {
1.627 raeburn 10777: if ($cancreate) {
10778: $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>';
10779: } else {
1.799 bisitz 10780: my $helplink = 'javascript:helpMenu('."'display'".')';
1.627 raeburn 10781: my %usertypetext = (
10782: official => 'institutional',
10783: unofficial => 'non-institutional',
10784: );
1.799 bisitz 10785: $new_user_create = '<p class="LC_warning">'
10786: .&mt("You are not authorized to create new $usertypetext{$usertype} users in this domain.")
10787: .' '
10788: .&mt('Please contact the [_1]helpdesk[_2] for assistance.'
10789: ,'<a href="'.$helplink.'">','</a>')
10790: .'</p><br />';
1.627 raeburn 10791: }
1.576 raeburn 10792: }
10793: }
10794:
1.556 raeburn 10795: $newuserscript = <<"ENDSCRIPT";
10796:
1.570 raeburn 10797: function setSearch(createnew,callingForm) {
1.556 raeburn 10798: if (createnew == 1) {
1.570 raeburn 10799: for (var i=0; i<callingForm.srchby.length; i++) {
10800: if (callingForm.srchby.options[i].value == 'uname') {
10801: callingForm.srchby.selectedIndex = i;
1.556 raeburn 10802: }
10803: }
1.570 raeburn 10804: for (var i=0; i<callingForm.srchin.length; i++) {
10805: if ( callingForm.srchin.options[i].value == 'dom') {
10806: callingForm.srchin.selectedIndex = i;
1.556 raeburn 10807: }
10808: }
1.570 raeburn 10809: for (var i=0; i<callingForm.srchtype.length; i++) {
10810: if (callingForm.srchtype.options[i].value == 'exact') {
10811: callingForm.srchtype.selectedIndex = i;
1.556 raeburn 10812: }
10813: }
1.570 raeburn 10814: for (var i=0; i<callingForm.srchdomain.length; i++) {
1.994 raeburn 10815: if (callingForm.srchdomain.options[i].value == '$context_dom') {
1.570 raeburn 10816: callingForm.srchdomain.selectedIndex = i;
1.556 raeburn 10817: }
10818: }
10819: }
10820: }
10821: ENDSCRIPT
1.558 albertel 10822:
1.556 raeburn 10823: }
10824:
1.555 raeburn 10825: my $output = <<"END_BLOCK";
1.556 raeburn 10826: <script type="text/javascript">
1.824 bisitz 10827: // <![CDATA[
1.570 raeburn 10828: function validateEntry(callingForm) {
1.558 albertel 10829:
1.556 raeburn 10830: var checkok = 1;
1.558 albertel 10831: var srchin;
1.570 raeburn 10832: for (var i=0; i<callingForm.srchin.length; i++) {
10833: if ( callingForm.srchin[i].checked ) {
10834: srchin = callingForm.srchin[i].value;
1.558 albertel 10835: }
10836: }
10837:
1.570 raeburn 10838: var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
10839: var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
10840: var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
10841: var srchterm = callingForm.srchterm.value;
10842: var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
1.556 raeburn 10843: var msg = "";
10844:
10845: if (srchterm == "") {
10846: checkok = 0;
1.1222 damieng 10847: msg += "$js_lt{'youm'}\\n";
1.556 raeburn 10848: }
10849:
1.569 raeburn 10850: if (srchtype== 'begins') {
10851: if (srchterm.length < 2) {
10852: checkok = 0;
1.1222 damieng 10853: msg += "$js_lt{'thte'}\\n";
1.569 raeburn 10854: }
10855: }
10856:
1.556 raeburn 10857: if (srchtype== 'contains') {
10858: if (srchterm.length < 3) {
10859: checkok = 0;
1.1222 damieng 10860: msg += "$js_lt{'thet'}\\n";
1.556 raeburn 10861: }
10862: }
10863: if (srchin == 'instd') {
10864: if (srchdomain == '') {
10865: checkok = 0;
1.1222 damieng 10866: msg += "$js_lt{'yomc'}\\n";
1.556 raeburn 10867: }
10868: }
10869: if (srchin == 'dom') {
10870: if (srchdomain == '') {
10871: checkok = 0;
1.1222 damieng 10872: msg += "$js_lt{'ymcd'}\\n";
1.556 raeburn 10873: }
10874: }
10875: if (srchby == 'lastfirst') {
10876: if (srchterm.indexOf(",") == -1) {
10877: checkok = 0;
1.1222 damieng 10878: msg += "$js_lt{'whus'}\\n";
1.556 raeburn 10879: }
10880: if (srchterm.indexOf(",") == srchterm.length -1) {
10881: checkok = 0;
1.1222 damieng 10882: msg += "$js_lt{'whse'}\\n";
1.556 raeburn 10883: }
10884: }
10885: if (checkok == 0) {
1.1222 damieng 10886: alert("$js_lt{'thfo'}\\n"+msg);
1.556 raeburn 10887: return;
10888: }
10889: if (checkok == 1) {
1.570 raeburn 10890: callingForm.submit();
1.556 raeburn 10891: }
10892: }
10893:
10894: $newuserscript
10895:
1.824 bisitz 10896: // ]]>
1.556 raeburn 10897: </script>
1.558 albertel 10898:
10899: $new_user_create
10900:
1.555 raeburn 10901: END_BLOCK
1.558 albertel 10902:
1.876 raeburn 10903: $output .= &Apache::lonhtmlcommon::start_pick_box().
1.1222 damieng 10904: &Apache::lonhtmlcommon::row_title($html_lt{'doma'}).
1.876 raeburn 10905: $domform.
10906: &Apache::lonhtmlcommon::row_closure().
1.1222 damieng 10907: &Apache::lonhtmlcommon::row_title($html_lt{'usr'}).
1.876 raeburn 10908: $srchbysel.
10909: $srchtypesel.
10910: '<input type="text" size="15" name="srchterm" value="'.$srchterm.'" />'.
10911: $srchinsel.
10912: &Apache::lonhtmlcommon::row_closure(1).
10913: &Apache::lonhtmlcommon::end_pick_box().
10914: '<br />';
1.1253 raeburn 10915: return ($output,1);
1.555 raeburn 10916: }
10917:
1.612 raeburn 10918: sub user_rule_check {
1.615 raeburn 10919: my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
1.1226 raeburn 10920: my ($response,%inst_response);
1.612 raeburn 10921: if (ref($usershash) eq 'HASH') {
1.1226 raeburn 10922: if (keys(%{$usershash}) > 1) {
10923: my (%by_username,%by_id,%userdoms);
10924: my $checkid;
10925: if (ref($checks) eq 'HASH') {
10926: if ((!defined($checks->{'username'})) && (defined($checks->{'id'}))) {
10927: $checkid = 1;
10928: }
10929: }
10930: foreach my $user (keys(%{$usershash})) {
10931: my ($uname,$udom) = split(/:/,$user);
10932: if ($checkid) {
10933: if (ref($usershash->{$user}) eq 'HASH') {
10934: if ($usershash->{$user}->{'id'} ne '') {
1.1227 raeburn 10935: $by_id{$udom}{$usershash->{$user}->{'id'}} = $uname;
1.1226 raeburn 10936: $userdoms{$udom} = 1;
1.1227 raeburn 10937: if (ref($inst_results) eq 'HASH') {
10938: $inst_results->{$uname.':'.$udom} = {};
10939: }
1.1226 raeburn 10940: }
10941: }
10942: } else {
10943: $by_username{$udom}{$uname} = 1;
10944: $userdoms{$udom} = 1;
1.1227 raeburn 10945: if (ref($inst_results) eq 'HASH') {
10946: $inst_results->{$uname.':'.$udom} = {};
10947: }
1.1226 raeburn 10948: }
10949: }
10950: foreach my $udom (keys(%userdoms)) {
10951: if (!$got_rules->{$udom}) {
10952: my %domconfig = &Apache::lonnet::get_dom('configuration',
10953: ['usercreation'],$udom);
10954: if (ref($domconfig{'usercreation'}) eq 'HASH') {
10955: foreach my $item ('username','id') {
10956: if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
1.1227 raeburn 10957: $$curr_rules{$udom}{$item} =
10958: $domconfig{'usercreation'}{$item.'_rule'};
1.1226 raeburn 10959: }
10960: }
10961: }
10962: $got_rules->{$udom} = 1;
10963: }
1.612 raeburn 10964: }
1.1226 raeburn 10965: if ($checkid) {
10966: foreach my $udom (keys(%by_id)) {
10967: my ($outcome,$results) = &Apache::lonnet::get_multiple_instusers($udom,$by_id{$udom},'id');
10968: if ($outcome eq 'ok') {
1.1227 raeburn 10969: foreach my $id (keys(%{$by_id{$udom}})) {
10970: my $uname = $by_id{$udom}{$id};
10971: $inst_response{$uname.':'.$udom} = $outcome;
10972: }
1.1226 raeburn 10973: if (ref($results) eq 'HASH') {
10974: foreach my $uname (keys(%{$results})) {
1.1227 raeburn 10975: if (exists($inst_response{$uname.':'.$udom})) {
10976: $inst_response{$uname.':'.$udom} = $outcome;
10977: $inst_results->{$uname.':'.$udom} = $results->{$uname};
10978: }
1.1226 raeburn 10979: }
10980: }
10981: }
1.612 raeburn 10982: }
1.615 raeburn 10983: } else {
1.1226 raeburn 10984: foreach my $udom (keys(%by_username)) {
10985: my ($outcome,$results) = &Apache::lonnet::get_multiple_instusers($udom,$by_username{$udom});
10986: if ($outcome eq 'ok') {
1.1227 raeburn 10987: foreach my $uname (keys(%{$by_username{$udom}})) {
10988: $inst_response{$uname.':'.$udom} = $outcome;
10989: }
1.1226 raeburn 10990: if (ref($results) eq 'HASH') {
10991: foreach my $uname (keys(%{$results})) {
10992: $inst_results->{$uname.':'.$udom} = $results->{$uname};
10993: }
10994: }
10995: }
10996: }
1.612 raeburn 10997: }
1.1226 raeburn 10998: } elsif (keys(%{$usershash}) == 1) {
10999: my $user = (keys(%{$usershash}))[0];
11000: my ($uname,$udom) = split(/:/,$user);
11001: if (($udom ne '') && ($uname ne '')) {
11002: if (ref($usershash->{$user}) eq 'HASH') {
11003: if (ref($checks) eq 'HASH') {
11004: if (defined($checks->{'username'})) {
11005: ($inst_response{$user},%{$inst_results->{$user}}) =
11006: &Apache::lonnet::get_instuser($udom,$uname);
11007: } elsif (defined($checks->{'id'})) {
11008: if ($usershash->{$user}->{'id'} ne '') {
11009: ($inst_response{$user},%{$inst_results->{$user}}) =
11010: &Apache::lonnet::get_instuser($udom,undef,
11011: $usershash->{$user}->{'id'});
11012: } else {
11013: ($inst_response{$user},%{$inst_results->{$user}}) =
11014: &Apache::lonnet::get_instuser($udom,$uname);
11015: }
1.585 raeburn 11016: }
1.1226 raeburn 11017: } else {
11018: ($inst_response{$user},%{$inst_results->{$user}}) =
11019: &Apache::lonnet::get_instuser($udom,$uname);
11020: return;
11021: }
11022: if (!$got_rules->{$udom}) {
11023: my %domconfig = &Apache::lonnet::get_dom('configuration',
11024: ['usercreation'],$udom);
11025: if (ref($domconfig{'usercreation'}) eq 'HASH') {
11026: foreach my $item ('username','id') {
11027: if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
11028: $$curr_rules{$udom}{$item} =
11029: $domconfig{'usercreation'}{$item.'_rule'};
11030: }
11031: }
11032: }
11033: $got_rules->{$udom} = 1;
1.585 raeburn 11034: }
11035: }
1.1226 raeburn 11036: } else {
11037: return;
11038: }
11039: } else {
11040: return;
11041: }
11042: foreach my $user (keys(%{$usershash})) {
11043: my ($uname,$udom) = split(/:/,$user);
11044: next if (($udom eq '') || ($uname eq ''));
11045: my $id;
1.1227 raeburn 11046: if (ref($inst_results) eq 'HASH') {
11047: if (ref($inst_results->{$user}) eq 'HASH') {
11048: $id = $inst_results->{$user}->{'id'};
11049: }
11050: }
11051: if ($id eq '') {
11052: if (ref($usershash->{$user})) {
11053: $id = $usershash->{$user}->{'id'};
11054: }
1.585 raeburn 11055: }
1.612 raeburn 11056: foreach my $item (keys(%{$checks})) {
11057: if (ref($$curr_rules{$udom}) eq 'HASH') {
11058: if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
11059: if (@{$$curr_rules{$udom}{$item}} > 0) {
1.1226 raeburn 11060: my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,
11061: $$curr_rules{$udom}{$item});
1.612 raeburn 11062: foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
11063: if ($rule_check{$rule}) {
11064: $$rulematch{$user}{$item} = $rule;
1.1226 raeburn 11065: if ($inst_response{$user} eq 'ok') {
1.615 raeburn 11066: if (ref($inst_results) eq 'HASH') {
11067: if (ref($inst_results->{$user}) eq 'HASH') {
11068: if (keys(%{$inst_results->{$user}}) == 0) {
11069: $$alerts{$item}{$udom}{$uname} = 1;
1.1227 raeburn 11070: } elsif ($item eq 'id') {
11071: if ($inst_results->{$user}->{'id'} eq '') {
11072: $$alerts{$item}{$udom}{$uname} = 1;
11073: }
1.615 raeburn 11074: }
1.612 raeburn 11075: }
11076: }
1.615 raeburn 11077: }
11078: last;
1.585 raeburn 11079: }
11080: }
11081: }
11082: }
11083: }
11084: }
11085: }
11086: }
1.612 raeburn 11087: return;
11088: }
11089:
11090: sub user_rule_formats {
11091: my ($domain,$domdesc,$curr_rules,$check) = @_;
11092: my %text = (
11093: 'username' => 'Usernames',
11094: 'id' => 'IDs',
11095: );
11096: my $output;
11097: my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
11098: if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
11099: if (@{$ruleorder} > 0) {
1.1102 raeburn 11100: $output = '<br />'.
11101: &mt($text{$check}.' with the following format(s) may [_1]only[_2] be used for verified users at [_3]:',
11102: '<span class="LC_cusr_emph">','</span>',$domdesc).
11103: ' <ul>';
1.612 raeburn 11104: foreach my $rule (@{$ruleorder}) {
11105: if (ref($curr_rules) eq 'ARRAY') {
11106: if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
11107: if (ref($rules->{$rule}) eq 'HASH') {
11108: $output .= '<li>'.$rules->{$rule}{'name'}.': '.
11109: $rules->{$rule}{'desc'}.'</li>';
11110: }
11111: }
11112: }
11113: }
11114: $output .= '</ul>';
11115: }
11116: }
11117: return $output;
11118: }
11119:
11120: sub instrule_disallow_msg {
1.615 raeburn 11121: my ($checkitem,$domdesc,$count,$mode) = @_;
1.612 raeburn 11122: my $response;
11123: my %text = (
11124: item => 'username',
11125: items => 'usernames',
11126: match => 'matches',
11127: do => 'does',
11128: action => 'a username',
11129: one => 'one',
11130: );
11131: if ($count > 1) {
11132: $text{'item'} = 'usernames';
11133: $text{'match'} ='match';
11134: $text{'do'} = 'do';
11135: $text{'action'} = 'usernames',
11136: $text{'one'} = 'ones';
11137: }
11138: if ($checkitem eq 'id') {
11139: $text{'items'} = 'IDs';
11140: $text{'item'} = 'ID';
11141: $text{'action'} = 'an ID';
1.615 raeburn 11142: if ($count > 1) {
11143: $text{'item'} = 'IDs';
11144: $text{'action'} = 'IDs';
11145: }
1.612 raeburn 11146: }
1.674 bisitz 11147: $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 11148: if ($mode eq 'upload') {
11149: if ($checkitem eq 'username') {
11150: $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'}.");
11151: } elsif ($checkitem eq 'id') {
1.674 bisitz 11152: $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 11153: }
1.669 raeburn 11154: } elsif ($mode eq 'selfcreate') {
11155: if ($checkitem eq 'id') {
11156: $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.");
11157: }
1.615 raeburn 11158: } else {
11159: if ($checkitem eq 'username') {
11160: $response .= &mt("You must choose $text{'action'} with a different format -- $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
11161: } elsif ($checkitem eq 'id') {
11162: $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.");
11163: }
1.612 raeburn 11164: }
11165: return $response;
1.585 raeburn 11166: }
11167:
1.624 raeburn 11168: sub personal_data_fieldtitles {
11169: my %fieldtitles = &Apache::lonlocal::texthash (
11170: id => 'Student/Employee ID',
11171: permanentemail => 'E-mail address',
11172: lastname => 'Last Name',
11173: firstname => 'First Name',
11174: middlename => 'Middle Name',
11175: generation => 'Generation',
11176: gen => 'Generation',
1.765 raeburn 11177: inststatus => 'Affiliation',
1.624 raeburn 11178: );
11179: return %fieldtitles;
11180: }
11181:
1.642 raeburn 11182: sub sorted_inst_types {
11183: my ($dom) = @_;
1.1185 raeburn 11184: my ($usertypes,$order);
11185: my %domdefaults = &Apache::lonnet::get_domain_defaults($dom);
11186: if (ref($domdefaults{'inststatus'}) eq 'HASH') {
11187: $usertypes = $domdefaults{'inststatus'}{'inststatustypes'};
11188: $order = $domdefaults{'inststatus'}{'inststatusorder'};
11189: } else {
11190: ($usertypes,$order) = &Apache::lonnet::retrieve_inst_usertypes($dom);
11191: }
1.642 raeburn 11192: my $othertitle = &mt('All users');
11193: if ($env{'request.course.id'}) {
1.668 raeburn 11194: $othertitle = &mt('Any users');
1.642 raeburn 11195: }
11196: my @types;
11197: if (ref($order) eq 'ARRAY') {
11198: @types = @{$order};
11199: }
11200: if (@types == 0) {
11201: if (ref($usertypes) eq 'HASH') {
11202: @types = sort(keys(%{$usertypes}));
11203: }
11204: }
11205: if (keys(%{$usertypes}) > 0) {
11206: $othertitle = &mt('Other users');
11207: }
11208: return ($othertitle,$usertypes,\@types);
11209: }
11210:
1.645 raeburn 11211: sub get_institutional_codes {
1.1361 raeburn 11212: my ($cdom,$crs,$settings,$allcourses,$LC_code) = @_;
1.645 raeburn 11213: # Get complete list of course sections to update
11214: my @currsections = ();
11215: my @currxlists = ();
1.1361 raeburn 11216: my (%unclutteredsec,%unclutteredlcsec);
1.645 raeburn 11217: my $coursecode = $$settings{'internal.coursecode'};
1.1361 raeburn 11218: my $crskey = $crs.':'.$coursecode;
11219: @{$unclutteredsec{$crskey}} = ();
11220: @{$unclutteredlcsec{$crskey}} = ();
1.645 raeburn 11221:
11222: if ($$settings{'internal.sectionnums'} ne '') {
11223: @currsections = split(/,/,$$settings{'internal.sectionnums'});
11224: }
11225:
11226: if ($$settings{'internal.crosslistings'} ne '') {
11227: @currxlists = split(/,/,$$settings{'internal.crosslistings'});
11228: }
11229:
11230: if (@currxlists > 0) {
1.1361 raeburn 11231: foreach my $xl (@currxlists) {
11232: if ($xl =~ /^([^:]+):(\w*)$/) {
1.645 raeburn 11233: unless (grep/^$1$/,@{$allcourses}) {
1.1263 raeburn 11234: push(@{$allcourses},$1);
1.645 raeburn 11235: $$LC_code{$1} = $2;
11236: }
11237: }
11238: }
11239: }
1.1361 raeburn 11240:
1.645 raeburn 11241: if (@currsections > 0) {
1.1361 raeburn 11242: foreach my $sec (@currsections) {
11243: if ($sec =~ m/^(\w+):(\w*)$/ ) {
11244: my $instsec = $1;
1.645 raeburn 11245: my $lc_sec = $2;
1.1361 raeburn 11246: unless (grep/^\Q$instsec\E$/,@{$unclutteredsec{$crskey}}) {
11247: push(@{$unclutteredsec{$crskey}},$instsec);
11248: push(@{$unclutteredlcsec{$crskey}},$lc_sec);
11249: }
11250: }
11251: }
11252: }
11253:
11254: if (@{$unclutteredsec{$crskey}} > 0) {
11255: my %formattedsec = &Apache::lonnet::auto_instsec_reformat($cdom,'clutter',\%unclutteredsec);
11256: if ((ref($formattedsec{$crskey}) eq 'ARRAY') && (ref($unclutteredlcsec{$crskey}) eq 'ARRAY')) {
11257: for (my $i=0; $i<@{$formattedsec{$crskey}}; $i++) {
11258: my $sec = $coursecode.$formattedsec{$crskey}[$i];
11259: unless (grep/^\Q$sec\E$/,@{$allcourses}) {
1.1263 raeburn 11260: push(@{$allcourses},$sec);
1.1361 raeburn 11261: $$LC_code{$sec} = $unclutteredlcsec{$crskey}[$i];
1.645 raeburn 11262: }
11263: }
11264: }
11265: }
11266: return;
11267: }
11268:
1.971 raeburn 11269: sub get_standard_codeitems {
11270: return ('Year','Semester','Department','Number','Section');
11271: }
11272:
1.112 bowersj2 11273: =pod
11274:
1.780 raeburn 11275: =head1 Slot Helpers
11276:
11277: =over 4
11278:
11279: =item * sorted_slots()
11280:
1.1040 raeburn 11281: Sorts an array of slot names in order of an optional sort key,
11282: default sort is by slot start time (earliest first).
1.780 raeburn 11283:
11284: Inputs:
11285:
11286: =over 4
11287:
11288: slotsarr - Reference to array of unsorted slot names.
11289:
11290: slots - Reference to hash of hash, where outer hash keys are slot names.
11291:
1.1040 raeburn 11292: sortkey - Name of key in inner hash to be sorted on (e.g., starttime).
11293:
1.549 albertel 11294: =back
11295:
1.780 raeburn 11296: Returns:
11297:
11298: =over 4
11299:
1.1040 raeburn 11300: sorted - An array of slot names sorted by a specified sort key
11301: (default sort key is start time of the slot).
1.780 raeburn 11302:
11303: =back
11304:
11305: =cut
11306:
11307:
11308: sub sorted_slots {
1.1040 raeburn 11309: my ($slotsarr,$slots,$sortkey) = @_;
11310: if ($sortkey eq '') {
11311: $sortkey = 'starttime';
11312: }
1.780 raeburn 11313: my @sorted;
11314: if ((ref($slotsarr) eq 'ARRAY') && (ref($slots) eq 'HASH')) {
11315: @sorted =
11316: sort {
11317: if (ref($slots->{$a}) && ref($slots->{$b})) {
1.1040 raeburn 11318: return $slots->{$a}{$sortkey} <=> $slots->{$b}{$sortkey}
1.780 raeburn 11319: }
11320: if (ref($slots->{$a})) { return -1;}
11321: if (ref($slots->{$b})) { return 1;}
11322: return 0;
11323: } @{$slotsarr};
11324: }
11325: return @sorted;
11326: }
11327:
1.1040 raeburn 11328: =pod
11329:
11330: =item * get_future_slots()
11331:
11332: Inputs:
11333:
11334: =over 4
11335:
11336: cnum - course number
11337:
11338: cdom - course domain
11339:
11340: now - current UNIX time
11341:
11342: symb - optional symb
11343:
11344: =back
11345:
11346: Returns:
11347:
11348: =over 4
11349:
11350: sorted_reservable - ref to array of student_schedulable slots currently
11351: reservable, ordered by end date of reservation period.
11352:
11353: reservable_now - ref to hash of student_schedulable slots currently
11354: reservable.
11355:
11356: Keys in inner hash are:
11357: (a) symb: either blank or symb to which slot use is restricted.
1.1250 raeburn 11358: (b) endreserve: end date of reservation period.
11359: (c) uniqueperiod: start,end dates when slot is to be uniquely
11360: selected.
1.1040 raeburn 11361:
11362: sorted_future - ref to array of student_schedulable slots reservable in
11363: the future, ordered by start date of reservation period.
11364:
11365: future_reservable - ref to hash of student_schedulable slots reservable
11366: in the future.
11367:
11368: Keys in inner hash are:
11369: (a) symb: either blank or symb to which slot use is restricted.
1.1250 raeburn 11370: (b) startreserve: start date of reservation period.
11371: (c) uniqueperiod: start,end dates when slot is to be uniquely
11372: selected.
1.1040 raeburn 11373:
11374: =back
11375:
11376: =cut
11377:
11378: sub get_future_slots {
11379: my ($cnum,$cdom,$now,$symb) = @_;
1.1229 raeburn 11380: my $map;
11381: if ($symb) {
11382: ($map) = &Apache::lonnet::decode_symb($symb);
11383: }
1.1040 raeburn 11384: my (%reservable_now,%future_reservable,@sorted_reservable,@sorted_future);
11385: my %slots = &Apache::lonnet::get_course_slots($cnum,$cdom);
11386: foreach my $slot (keys(%slots)) {
11387: next unless($slots{$slot}->{'type'} eq 'schedulable_student');
11388: if ($symb) {
1.1229 raeburn 11389: if ($slots{$slot}->{'symb'} ne '') {
11390: my $canuse;
11391: my %oksymbs;
11392: my @slotsymbs = split(/\s*,\s*/,$slots{$slot}->{'symb'});
11393: map { $oksymbs{$_} = 1; } @slotsymbs;
11394: if ($oksymbs{$symb}) {
11395: $canuse = 1;
11396: } else {
11397: foreach my $item (@slotsymbs) {
11398: if ($item =~ /\.(page|sequence)$/) {
11399: (undef,undef,my $sloturl) = &Apache::lonnet::decode_symb($item);
11400: if (($map ne '') && ($map eq $sloturl)) {
11401: $canuse = 1;
11402: last;
11403: }
11404: }
11405: }
11406: }
11407: next unless ($canuse);
11408: }
1.1040 raeburn 11409: }
11410: if (($slots{$slot}->{'starttime'} > $now) &&
11411: ($slots{$slot}->{'endtime'} > $now)) {
11412: if (($slots{$slot}->{'allowedsections'}) || ($slots{$slot}->{'allowedusers'})) {
11413: my $userallowed = 0;
11414: if ($slots{$slot}->{'allowedsections'}) {
11415: my @allowed_sec = split(',',$slots{$slot}->{'allowedsections'});
11416: if (!defined($env{'request.role.sec'})
11417: && grep(/^No section assigned$/,@allowed_sec)) {
11418: $userallowed=1;
11419: } else {
11420: if (grep(/^\Q$env{'request.role.sec'}\E$/,@allowed_sec)) {
11421: $userallowed=1;
11422: }
11423: }
11424: unless ($userallowed) {
11425: if (defined($env{'request.course.groups'})) {
11426: my @groups = split(/:/,$env{'request.course.groups'});
11427: foreach my $group (@groups) {
11428: if (grep(/^\Q$group\E$/,@allowed_sec)) {
11429: $userallowed=1;
11430: last;
11431: }
11432: }
11433: }
11434: }
11435: }
11436: if ($slots{$slot}->{'allowedusers'}) {
11437: my @allowed_users = split(',',$slots{$slot}->{'allowedusers'});
11438: my $user = $env{'user.name'}.':'.$env{'user.domain'};
11439: if (grep(/^\Q$user\E$/,@allowed_users)) {
11440: $userallowed = 1;
11441: }
11442: }
11443: next unless($userallowed);
11444: }
11445: my $startreserve = $slots{$slot}->{'startreserve'};
11446: my $endreserve = $slots{$slot}->{'endreserve'};
11447: my $symb = $slots{$slot}->{'symb'};
1.1250 raeburn 11448: my $uniqueperiod;
11449: if (ref($slots{$slot}->{'uniqueperiod'}) eq 'ARRAY') {
11450: $uniqueperiod = join(',',@{$slots{$slot}->{'uniqueperiod'}});
11451: }
1.1040 raeburn 11452: if (($startreserve < $now) &&
11453: (!$endreserve || $endreserve > $now)) {
11454: my $lastres = $endreserve;
11455: if (!$lastres) {
11456: $lastres = $slots{$slot}->{'starttime'};
11457: }
11458: $reservable_now{$slot} = {
11459: symb => $symb,
1.1250 raeburn 11460: endreserve => $lastres,
11461: uniqueperiod => $uniqueperiod,
1.1040 raeburn 11462: };
11463: } elsif (($startreserve > $now) &&
11464: (!$endreserve || $endreserve > $startreserve)) {
11465: $future_reservable{$slot} = {
11466: symb => $symb,
1.1250 raeburn 11467: startreserve => $startreserve,
11468: uniqueperiod => $uniqueperiod,
1.1040 raeburn 11469: };
11470: }
11471: }
11472: }
11473: my @unsorted_reservable = keys(%reservable_now);
11474: if (@unsorted_reservable > 0) {
11475: @sorted_reservable =
11476: &sorted_slots(\@unsorted_reservable,\%reservable_now,'endreserve');
11477: }
11478: my @unsorted_future = keys(%future_reservable);
11479: if (@unsorted_future > 0) {
11480: @sorted_future =
11481: &sorted_slots(\@unsorted_future,\%future_reservable,'startreserve');
11482: }
11483: return (\@sorted_reservable,\%reservable_now,\@sorted_future,\%future_reservable);
11484: }
1.780 raeburn 11485:
11486: =pod
11487:
1.1057 foxr 11488: =back
11489:
1.549 albertel 11490: =head1 HTTP Helpers
11491:
11492: =over 4
11493:
1.648 raeburn 11494: =item * &get_unprocessed_cgi($query,$possible_names)
1.112 bowersj2 11495:
1.258 albertel 11496: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112 bowersj2 11497: $query. The parameters listed in $possible_names (an array reference),
1.258 albertel 11498: will be set in $env{'form.name'} if they do not already exist.
1.112 bowersj2 11499:
11500: Typically called with $ENV{'QUERY_STRING'} as the first parameter.
11501: $possible_names is an ref to an array of form element names. As an example:
11502: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258 albertel 11503: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112 bowersj2 11504:
11505: =cut
1.1 albertel 11506:
1.6 albertel 11507: sub get_unprocessed_cgi {
1.25 albertel 11508: my ($query,$possible_names)= @_;
1.26 matthew 11509: # $Apache::lonxml::debug=1;
1.356 albertel 11510: foreach my $pair (split(/&/,$query)) {
11511: my ($name, $value) = split(/=/,$pair);
1.369 www 11512: $name = &unescape($name);
1.25 albertel 11513: if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
11514: $value =~ tr/+/ /;
11515: $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258 albertel 11516: unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25 albertel 11517: }
1.16 harris41 11518: }
1.6 albertel 11519: }
11520:
1.112 bowersj2 11521: =pod
11522:
1.648 raeburn 11523: =item * &cacheheader()
1.112 bowersj2 11524:
11525: returns cache-controlling header code
11526:
11527: =cut
11528:
1.7 albertel 11529: sub cacheheader {
1.258 albertel 11530: unless ($env{'request.method'} eq 'GET') { return ''; }
1.216 albertel 11531: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
11532: my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7 albertel 11533: <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
11534: <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216 albertel 11535: return $output;
1.7 albertel 11536: }
11537:
1.112 bowersj2 11538: =pod
11539:
1.648 raeburn 11540: =item * &no_cache($r)
1.112 bowersj2 11541:
11542: specifies header code to not have cache
11543:
11544: =cut
11545:
1.9 albertel 11546: sub no_cache {
1.216 albertel 11547: my ($r) = @_;
11548: if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258 albertel 11549: $env{'request.method'} ne 'GET') { return ''; }
1.216 albertel 11550: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
11551: $r->no_cache(1);
11552: $r->header_out("Expires" => $date);
11553: $r->header_out("Pragma" => "no-cache");
1.123 www 11554: }
11555:
11556: sub content_type {
1.181 albertel 11557: my ($r,$type,$charset) = @_;
1.299 foxr 11558: if ($r) {
11559: # Note that printout.pl calls this with undef for $r.
11560: &no_cache($r);
11561: }
1.258 albertel 11562: if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181 albertel 11563: unless ($charset) {
11564: $charset=&Apache::lonlocal::current_encoding;
11565: }
11566: if ($charset) { $type.='; charset='.$charset; }
11567: if ($r) {
11568: $r->content_type($type);
11569: } else {
11570: print("Content-type: $type\n\n");
11571: }
1.9 albertel 11572: }
1.25 albertel 11573:
1.112 bowersj2 11574: =pod
11575:
1.648 raeburn 11576: =item * &add_to_env($name,$value)
1.112 bowersj2 11577:
1.258 albertel 11578: adds $name to the %env hash with value
1.112 bowersj2 11579: $value, if $name already exists, the entry is converted to an array
11580: reference and $value is added to the array.
11581:
11582: =cut
11583:
1.25 albertel 11584: sub add_to_env {
11585: my ($name,$value)=@_;
1.258 albertel 11586: if (defined($env{$name})) {
11587: if (ref($env{$name})) {
1.25 albertel 11588: #already have multiple values
1.258 albertel 11589: push(@{ $env{$name} },$value);
1.25 albertel 11590: } else {
11591: #first time seeing multiple values, convert hash entry to an arrayref
1.258 albertel 11592: my $first=$env{$name};
11593: undef($env{$name});
11594: push(@{ $env{$name} },$first,$value);
1.25 albertel 11595: }
11596: } else {
1.258 albertel 11597: $env{$name}=$value;
1.25 albertel 11598: }
1.31 albertel 11599: }
1.149 albertel 11600:
11601: =pod
11602:
1.648 raeburn 11603: =item * &get_env_multiple($name)
1.149 albertel 11604:
1.258 albertel 11605: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149 albertel 11606: values may be defined and end up as an array ref.
11607:
11608: returns an array of values
11609:
11610: =cut
11611:
11612: sub get_env_multiple {
11613: my ($name) = @_;
11614: my @values;
1.258 albertel 11615: if (defined($env{$name})) {
1.149 albertel 11616: # exists is it an array
1.258 albertel 11617: if (ref($env{$name})) {
11618: @values=@{ $env{$name} };
1.149 albertel 11619: } else {
1.258 albertel 11620: $values[0]=$env{$name};
1.149 albertel 11621: }
11622: }
11623: return(@values);
11624: }
11625:
1.1249 damieng 11626: # Looks at given dependencies, and returns something depending on the context.
11627: # For coursedocs paste, returns (undef, $counter, $numpathchg, \%existing).
11628: # For syllabus rewrites, returns (undef, $counter, $numpathchg, \%existing, \%mapping).
11629: # For all other contexts, returns ($output, $counter, $numpathchg).
11630: # $output: string with the HTML output. Can contain missing dependencies with an upload form, existing dependencies, and dependencies no longer in use.
11631: # $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.
11632: # $numpathchg: integer with the number of cleaned up dependency paths.
11633: # \%existing: hash reference clean path -> 1 only for existing dependencies.
11634: # \%mapping: hash reference clean path -> original path for all dependencies.
11635: # @param {string} actionurl - The path to the handler, indicative of the context.
11636: # @param {string} state - Can contain HTML with hidden inputs that will be added to the output form.
11637: # @param {hash reference} allfiles - List of file info from lonnet::extract_embedded_items
11638: # @param {hash reference} codebase - undef, not modified by lonnet::extract_embedded_items ?
11639: # @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)
11640: # @return {Array} - array depending on the context (not a reference)
1.660 raeburn 11641: sub ask_for_embedded_content {
1.1249 damieng 11642: # NOTE: documentation was added afterwards, it could be wrong
1.660 raeburn 11643: my ($actionurl,$state,$allfiles,$codebase,$args)=@_;
1.1071 raeburn 11644: my (%subdependencies,%dependencies,%mapping,%existing,%newfiles,%pathchanges,
1.1085 raeburn 11645: %currsubfile,%unused,$rem);
1.1071 raeburn 11646: my $counter = 0;
11647: my $numnew = 0;
1.987 raeburn 11648: my $numremref = 0;
11649: my $numinvalid = 0;
11650: my $numpathchg = 0;
11651: my $numexisting = 0;
1.1071 raeburn 11652: my $numunused = 0;
11653: my ($output,$upload_output,$toplevel,$url,$udom,$uname,$getpropath,$cdom,$cnum,
1.1156 raeburn 11654: $fileloc,$filename,$delete_output,$modify_output,$title,$symb,$path,$navmap);
1.1071 raeburn 11655: my $heading = &mt('Upload embedded files');
11656: my $buttontext = &mt('Upload');
11657:
1.1249 damieng 11658: # fills these variables based on the context:
11659: # $navmap, $cdom, $cnum, $udom, $uname, $url, $toplevel, $getpropath,
11660: # $path, $fileloc, $title, $rem, $filename
1.1085 raeburn 11661: if ($env{'request.course.id'}) {
1.1123 raeburn 11662: if ($actionurl eq '/adm/dependencies') {
11663: $navmap = Apache::lonnavmaps::navmap->new();
11664: }
11665: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
11666: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
1.1085 raeburn 11667: }
1.1123 raeburn 11668: if (($actionurl eq '/adm/portfolio') ||
11669: ($actionurl eq '/adm/coursegrp_portfolio')) {
1.984 raeburn 11670: my $current_path='/';
11671: if ($env{'form.currentpath'}) {
11672: $current_path = $env{'form.currentpath'};
11673: }
11674: if ($actionurl eq '/adm/coursegrp_portfolio') {
1.1123 raeburn 11675: $udom = $cdom;
11676: $uname = $cnum;
1.984 raeburn 11677: $url = '/userfiles/groups/'.$env{'form.group'}.'/portfolio';
11678: } else {
11679: $udom = $env{'user.domain'};
11680: $uname = $env{'user.name'};
11681: $url = '/userfiles/portfolio';
11682: }
1.987 raeburn 11683: $toplevel = $url.'/';
1.984 raeburn 11684: $url .= $current_path;
11685: $getpropath = 1;
1.987 raeburn 11686: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') ||
11687: ($actionurl eq '/adm/imsimport')) {
1.1022 www 11688: my ($udom,$uname,$rest) = ($args->{'current_path'} =~ m{/priv/($match_domain)/($match_username)/?(.*)$});
1.1026 raeburn 11689: $url = $Apache::lonnet::perlvar{'lonDocRoot'}."/priv/$udom/$uname/";
1.987 raeburn 11690: $toplevel = $url;
1.984 raeburn 11691: if ($rest ne '') {
1.987 raeburn 11692: $url .= $rest;
11693: }
11694: } elsif ($actionurl eq '/adm/coursedocs') {
11695: if (ref($args) eq 'HASH') {
1.1071 raeburn 11696: $url = $args->{'docs_url'};
11697: $toplevel = $url;
1.1084 raeburn 11698: if ($args->{'context'} eq 'paste') {
11699: ($cdom,$cnum) = ($url =~ m{^\Q/uploaded/\E($match_domain)/($match_courseid)/});
11700: ($path) =
11701: ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/\E(?:docs|supplemental)/(?:default|\d+)/\d+)/});
11702: $fileloc = &Apache::lonnet::filelocation('',$toplevel);
11703: $fileloc =~ s{^/}{};
11704: }
1.1071 raeburn 11705: }
1.1084 raeburn 11706: } elsif ($actionurl eq '/adm/dependencies') {
1.1071 raeburn 11707: if ($env{'request.course.id'} ne '') {
11708: if (ref($args) eq 'HASH') {
11709: $url = $args->{'docs_url'};
11710: $title = $args->{'docs_title'};
1.1126 raeburn 11711: $toplevel = $url;
11712: unless ($toplevel =~ m{^/}) {
11713: $toplevel = "/$url";
11714: }
1.1085 raeburn 11715: ($rem) = ($toplevel =~ m{^(.+/)[^/]+$});
1.1126 raeburn 11716: if ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/portfolio/syllabus\E)}) {
11717: $path = $1;
11718: } else {
11719: ($path) =
11720: ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/\E(?:docs|supplemental)/(?:default|\d+)/\d+)/});
11721: }
1.1195 raeburn 11722: if ($toplevel=~/^\/*(uploaded|editupload)/) {
11723: $fileloc = $toplevel;
11724: $fileloc=~ s/^\s*(\S+)\s*$/$1/;
11725: my ($udom,$uname,$fname) =
11726: ($fileloc=~ m{^/+(?:uploaded|editupload)/+($match_domain)/+($match_name)/+(.*)$});
11727: $fileloc = propath($udom,$uname).'/userfiles/'.$fname;
11728: } else {
11729: $fileloc = &Apache::lonnet::filelocation('',$toplevel);
11730: }
1.1071 raeburn 11731: $fileloc =~ s{^/}{};
11732: ($filename) = ($fileloc =~ m{.+/([^/]+)$});
11733: $heading = &mt('Status of dependencies in [_1]',"$title ($filename)");
11734: }
1.987 raeburn 11735: }
1.1123 raeburn 11736: } elsif ($actionurl eq "/public/$cdom/$cnum/syllabus") {
11737: $udom = $cdom;
11738: $uname = $cnum;
11739: $url = "/uploaded/$cdom/$cnum/portfolio/syllabus";
11740: $toplevel = $url;
11741: $path = $url;
11742: $fileloc = &Apache::lonnet::filelocation('',$toplevel).'/';
11743: $fileloc =~ s{^/}{};
1.987 raeburn 11744: }
1.1249 damieng 11745:
11746: # parses the dependency paths to get some info
11747: # fills $newfiles, $mapping, $subdependencies, $dependencies
11748: # $newfiles: hash URL -> 1 for new files or external URLs
11749: # (will be completed later)
11750: # $mapping:
11751: # for external URLs: external URL -> external URL
11752: # for relative paths: clean path -> original path
11753: # $subdependencies: hash clean path -> clean file name -> 1 for relative paths in subdirectories
11754: # $dependencies: hash clean or not file name -> 1 for relative paths not in subdirectories
1.1126 raeburn 11755: foreach my $file (keys(%{$allfiles})) {
11756: my $embed_file;
11757: if (($path eq "/uploaded/$cdom/$cnum/portfolio/syllabus") && ($file =~ m{^\Q$path/\E(.+)$})) {
11758: $embed_file = $1;
11759: } else {
11760: $embed_file = $file;
11761: }
1.1158 raeburn 11762: my ($absolutepath,$cleaned_file);
11763: if ($embed_file =~ m{^\w+://}) {
11764: $cleaned_file = $embed_file;
1.1147 raeburn 11765: $newfiles{$cleaned_file} = 1;
11766: $mapping{$cleaned_file} = $embed_file;
1.987 raeburn 11767: } else {
1.1158 raeburn 11768: $cleaned_file = &clean_path($embed_file);
1.987 raeburn 11769: if ($embed_file =~ m{^/}) {
11770: $absolutepath = $embed_file;
11771: }
1.1147 raeburn 11772: if ($cleaned_file =~ m{/}) {
11773: my ($path,$fname) = ($cleaned_file =~ m{^(.+)/([^/]*)$});
1.987 raeburn 11774: $path = &check_for_traversal($path,$url,$toplevel);
11775: my $item = $fname;
11776: if ($path ne '') {
11777: $item = $path.'/'.$fname;
11778: $subdependencies{$path}{$fname} = 1;
11779: } else {
11780: $dependencies{$item} = 1;
11781: }
11782: if ($absolutepath) {
11783: $mapping{$item} = $absolutepath;
11784: } else {
11785: $mapping{$item} = $embed_file;
11786: }
11787: } else {
11788: $dependencies{$embed_file} = 1;
11789: if ($absolutepath) {
1.1147 raeburn 11790: $mapping{$cleaned_file} = $absolutepath;
1.987 raeburn 11791: } else {
1.1147 raeburn 11792: $mapping{$cleaned_file} = $embed_file;
1.987 raeburn 11793: }
11794: }
1.984 raeburn 11795: }
11796: }
1.1249 damieng 11797:
11798: # looks for all existing files in dependency subdirectories (from $subdependencies filled above)
11799: # and lists
11800: # fills $currsubfile, $pathchanges, $existing, $numexisting, $newfiles, $unused
11801: # $currsubfile: hash clean path -> file name -> 1 for all existing files in the path
11802: # $pathchanges: hash clean path -> 1 if the file in subdirectory exists and
11803: # the path had to be cleaned up
11804: # $existing: hash clean path -> 1 if the file exists
11805: # $numexisting: number of keys in $existing
11806: # $newfiles: updated with clean path -> 1 for files in subdirectories that do not exist
11807: # $unused: only for /adm/dependencies, hash clean path -> 1 for existing files in
11808: # dependency subdirectories that are
11809: # not listed as dependencies, with some exceptions using $rem
1.1071 raeburn 11810: my $dirptr = 16384;
1.984 raeburn 11811: foreach my $path (keys(%subdependencies)) {
1.1071 raeburn 11812: $currsubfile{$path} = {};
1.1123 raeburn 11813: if (($actionurl eq '/adm/portfolio') ||
11814: ($actionurl eq '/adm/coursegrp_portfolio')) {
1.1021 raeburn 11815: my ($sublistref,$listerror) =
11816: &Apache::lonnet::dirlist($url.$path,$udom,$uname,$getpropath);
11817: if (ref($sublistref) eq 'ARRAY') {
11818: foreach my $line (@{$sublistref}) {
11819: my ($file_name,$rest) = split(/\&/,$line,2);
1.1071 raeburn 11820: $currsubfile{$path}{$file_name} = 1;
1.1021 raeburn 11821: }
1.984 raeburn 11822: }
1.987 raeburn 11823: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984 raeburn 11824: if (opendir(my $dir,$url.'/'.$path)) {
11825: my @subdir_list = grep(!/^\./,readdir($dir));
1.1071 raeburn 11826: map {$currsubfile{$path}{$_} = 1;} @subdir_list;
11827: }
1.1084 raeburn 11828: } elsif (($actionurl eq '/adm/dependencies') ||
11829: (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
1.1123 raeburn 11830: ($args->{'context'} eq 'paste')) ||
11831: ($actionurl eq "/public/$cdom/$cnum/syllabus")) {
1.1071 raeburn 11832: if ($env{'request.course.id'} ne '') {
1.1123 raeburn 11833: my $dir;
11834: if ($actionurl eq "/public/$cdom/$cnum/syllabus") {
11835: $dir = $fileloc;
11836: } else {
11837: ($dir) = ($fileloc =~ m{^(.+/)[^/]+$});
11838: }
1.1071 raeburn 11839: if ($dir ne '') {
11840: my ($sublistref,$listerror) =
11841: &Apache::lonnet::dirlist($dir.$path,$cdom,$cnum,$getpropath,undef,'/');
11842: if (ref($sublistref) eq 'ARRAY') {
11843: foreach my $line (@{$sublistref}) {
11844: my ($file_name,$dom,undef,$testdir,undef,undef,undef,undef,$size,
11845: undef,$mtime)=split(/\&/,$line,12);
11846: unless (($testdir&$dirptr) ||
11847: ($file_name =~ /^\.\.?$/)) {
11848: $currsubfile{$path}{$file_name} = [$size,$mtime];
11849: }
11850: }
11851: }
11852: }
1.984 raeburn 11853: }
11854: }
11855: foreach my $file (keys(%{$subdependencies{$path}})) {
1.1071 raeburn 11856: if (exists($currsubfile{$path}{$file})) {
1.987 raeburn 11857: my $item = $path.'/'.$file;
11858: unless ($mapping{$item} eq $item) {
11859: $pathchanges{$item} = 1;
11860: }
11861: $existing{$item} = 1;
11862: $numexisting ++;
11863: } else {
11864: $newfiles{$path.'/'.$file} = 1;
1.984 raeburn 11865: }
11866: }
1.1071 raeburn 11867: if ($actionurl eq '/adm/dependencies') {
11868: foreach my $path (keys(%currsubfile)) {
11869: if (ref($currsubfile{$path}) eq 'HASH') {
11870: foreach my $file (keys(%{$currsubfile{$path}})) {
11871: unless ($subdependencies{$path}{$file}) {
1.1085 raeburn 11872: next if (($rem ne '') &&
11873: (($env{"httpref.$rem"."$path/$file"} ne '') ||
11874: (ref($navmap) &&
11875: (($navmap->getResourceByUrl($rem."$path/$file") ne '') ||
11876: (($file =~ /^(.*\.s?html?)\.bak$/i) &&
11877: ($navmap->getResourceByUrl($rem."$path/$1")))))));
1.1071 raeburn 11878: $unused{$path.'/'.$file} = 1;
11879: }
11880: }
11881: }
11882: }
11883: }
1.984 raeburn 11884: }
1.1249 damieng 11885:
11886: # fills $currfile, hash file name -> 1 or [$size,$mtime]
11887: # for files in $url or $fileloc (target directory) in some contexts
1.987 raeburn 11888: my %currfile;
1.1123 raeburn 11889: if (($actionurl eq '/adm/portfolio') ||
11890: ($actionurl eq '/adm/coursegrp_portfolio')) {
1.1021 raeburn 11891: my ($dirlistref,$listerror) =
11892: &Apache::lonnet::dirlist($url,$udom,$uname,$getpropath);
11893: if (ref($dirlistref) eq 'ARRAY') {
11894: foreach my $line (@{$dirlistref}) {
11895: my ($file_name,$rest) = split(/\&/,$line,2);
11896: $currfile{$file_name} = 1;
11897: }
1.984 raeburn 11898: }
1.987 raeburn 11899: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984 raeburn 11900: if (opendir(my $dir,$url)) {
1.987 raeburn 11901: my @dir_list = grep(!/^\./,readdir($dir));
1.984 raeburn 11902: map {$currfile{$_} = 1;} @dir_list;
11903: }
1.1084 raeburn 11904: } elsif (($actionurl eq '/adm/dependencies') ||
11905: (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
1.1123 raeburn 11906: ($args->{'context'} eq 'paste')) ||
11907: ($actionurl eq "/public/$cdom/$cnum/syllabus")) {
1.1071 raeburn 11908: if ($env{'request.course.id'} ne '') {
11909: my ($dir) = ($fileloc =~ m{^(.+/)[^/]+$});
11910: if ($dir ne '') {
11911: my ($dirlistref,$listerror) =
11912: &Apache::lonnet::dirlist($dir,$cdom,$cnum,$getpropath,undef,'/');
11913: if (ref($dirlistref) eq 'ARRAY') {
11914: foreach my $line (@{$dirlistref}) {
11915: my ($file_name,$dom,undef,$testdir,undef,undef,undef,undef,
11916: $size,undef,$mtime)=split(/\&/,$line,12);
11917: unless (($testdir&$dirptr) ||
11918: ($file_name =~ /^\.\.?$/)) {
11919: $currfile{$file_name} = [$size,$mtime];
11920: }
11921: }
11922: }
11923: }
11924: }
1.984 raeburn 11925: }
1.1249 damieng 11926: # updates $pathchanges, $existing, $numexisting, $newfiles and $unused for files that
11927: # are not in subdirectories, using $currfile
1.984 raeburn 11928: foreach my $file (keys(%dependencies)) {
1.1071 raeburn 11929: if (exists($currfile{$file})) {
1.987 raeburn 11930: unless ($mapping{$file} eq $file) {
11931: $pathchanges{$file} = 1;
11932: }
11933: $existing{$file} = 1;
11934: $numexisting ++;
11935: } else {
1.984 raeburn 11936: $newfiles{$file} = 1;
11937: }
11938: }
1.1071 raeburn 11939: foreach my $file (keys(%currfile)) {
11940: unless (($file eq $filename) ||
11941: ($file eq $filename.'.bak') ||
11942: ($dependencies{$file})) {
1.1085 raeburn 11943: if ($actionurl eq '/adm/dependencies') {
1.1126 raeburn 11944: unless ($toplevel =~ m{^\Q/uploaded/$cdom/$cnum/portfolio/syllabus\E}) {
11945: next if (($rem ne '') &&
11946: (($env{"httpref.$rem".$file} ne '') ||
11947: (ref($navmap) &&
11948: (($navmap->getResourceByUrl($rem.$file) ne '') ||
11949: (($file =~ /^(.*\.s?html?)\.bak$/i) &&
11950: ($navmap->getResourceByUrl($rem.$1)))))));
11951: }
1.1085 raeburn 11952: }
1.1071 raeburn 11953: $unused{$file} = 1;
11954: }
11955: }
1.1249 damieng 11956:
11957: # returns some results for coursedocs paste and syllabus rewrites ($output is undef)
1.1084 raeburn 11958: if (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
11959: ($args->{'context'} eq 'paste')) {
11960: $counter = scalar(keys(%existing));
11961: $numpathchg = scalar(keys(%pathchanges));
1.1123 raeburn 11962: return ($output,$counter,$numpathchg,\%existing);
11963: } elsif (($actionurl eq "/public/$cdom/$cnum/syllabus") &&
11964: (ref($args) eq 'HASH') && ($args->{'context'} eq 'rewrites')) {
11965: $counter = scalar(keys(%existing));
11966: $numpathchg = scalar(keys(%pathchanges));
11967: return ($output,$counter,$numpathchg,\%existing,\%mapping);
1.1084 raeburn 11968: }
1.1249 damieng 11969:
11970: # returns HTML otherwise, with dependency results and to ask for more uploads
11971:
11972: # $upload_output: missing dependencies (with upload form)
11973: # $modify_output: uploaded dependencies (in use)
11974: # $delete_output: files no longer in use (unused files are not listed for londocs, bug?)
1.984 raeburn 11975: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%newfiles)) {
1.1071 raeburn 11976: if ($actionurl eq '/adm/dependencies') {
11977: next if ($embed_file =~ m{^\w+://});
11978: }
1.660 raeburn 11979: $upload_output .= &start_data_table_row().
1.1123 raeburn 11980: '<td valign="top"><img src="'.&icon($embed_file).'" /> '.
1.1071 raeburn 11981: '<span class="LC_filename">'.$embed_file.'</span>';
1.987 raeburn 11982: unless ($mapping{$embed_file} eq $embed_file) {
1.1123 raeburn 11983: $upload_output .= '<br /><span class="LC_info" style="font-size:smaller;">'.
11984: &mt('changed from: [_1]',$mapping{$embed_file}).'</span>';
1.987 raeburn 11985: }
1.1123 raeburn 11986: $upload_output .= '</td>';
1.1071 raeburn 11987: if ($args->{'ignore_remote_references'} && $embed_file =~ m{^\w+://}) {
1.1123 raeburn 11988: $upload_output.='<td align="right">'.
11989: '<span class="LC_info LC_fontsize_medium">'.
11990: &mt("URL points to web address").'</span>';
1.987 raeburn 11991: $numremref++;
1.660 raeburn 11992: } elsif ($args->{'error_on_invalid_names'}
11993: && $embed_file ne &Apache::lonnet::clean_filename($embed_file,{'keep_path' => 1,})) {
1.1123 raeburn 11994: $upload_output.='<td align="right"><span class="LC_warning">'.
11995: &mt('Invalid characters').'</span>';
1.987 raeburn 11996: $numinvalid++;
1.660 raeburn 11997: } else {
1.1123 raeburn 11998: $upload_output .= '<td>'.
11999: &embedded_file_element('upload_embedded',$counter,
1.987 raeburn 12000: $embed_file,\%mapping,
1.1071 raeburn 12001: $allfiles,$codebase,'upload');
12002: $counter ++;
12003: $numnew ++;
1.987 raeburn 12004: }
12005: $upload_output .= '</td>'.&Apache::loncommon::end_data_table_row()."\n";
12006: }
12007: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%existing)) {
1.1071 raeburn 12008: if ($actionurl eq '/adm/dependencies') {
12009: my ($size,$mtime) = &get_dependency_details(\%currfile,\%currsubfile,$embed_file);
12010: $modify_output .= &start_data_table_row().
12011: '<td><a href="'.$path.'/'.$embed_file.'" style="text-decoration:none;">'.
12012: '<img src="'.&icon($embed_file).'" border="0" />'.
12013: ' <span class="LC_filename">'.$embed_file.'</span></a></td>'.
12014: '<td>'.$size.'</td>'.
12015: '<td>'.$mtime.'</td>'.
12016: '<td><label><input type="checkbox" name="mod_upload_dep" '.
12017: 'onclick="toggleBrowse('."'$counter'".')" id="mod_upload_dep_'.
12018: $counter.'" value="'.$counter.'" />'.&mt('Yes').'</label>'.
12019: '<div id="moduploaddep_'.$counter.'" style="display:none;">'.
12020: &embedded_file_element('upload_embedded',$counter,
12021: $embed_file,\%mapping,
12022: $allfiles,$codebase,'modify').
12023: '</div></td>'.
12024: &end_data_table_row()."\n";
12025: $counter ++;
12026: } else {
12027: $upload_output .= &start_data_table_row().
1.1123 raeburn 12028: '<td valign="top"><img src="'.&icon($embed_file).'" /> '.
12029: '<span class="LC_filename">'.$embed_file.'</span></td>'.
12030: '<td align="right"><span class="LC_info LC_fontsize_medium">'.&mt('Already exists').'</span></td>'.
1.1071 raeburn 12031: &Apache::loncommon::end_data_table_row()."\n";
12032: }
12033: }
12034: my $delidx = $counter;
12035: foreach my $oldfile (sort {lc($a) cmp lc($b)} keys(%unused)) {
12036: my ($size,$mtime) = &get_dependency_details(\%currfile,\%currsubfile,$oldfile);
12037: $delete_output .= &start_data_table_row().
12038: '<td><img src="'.&icon($oldfile).'" />'.
12039: ' <span class="LC_filename">'.$oldfile.'</span></td>'.
12040: '<td>'.$size.'</td>'.
12041: '<td>'.$mtime.'</td>'.
12042: '<td><label><input type="checkbox" name="del_upload_dep" '.
12043: ' value="'.$delidx.'" />'.&mt('Yes').'</label>'.
12044: &embedded_file_element('upload_embedded',$delidx,
12045: $oldfile,\%mapping,$allfiles,
12046: $codebase,'delete').'</td>'.
12047: &end_data_table_row()."\n";
12048: $numunused ++;
12049: $delidx ++;
1.987 raeburn 12050: }
12051: if ($upload_output) {
12052: $upload_output = &start_data_table().
12053: $upload_output.
12054: &end_data_table()."\n";
12055: }
1.1071 raeburn 12056: if ($modify_output) {
12057: $modify_output = &start_data_table().
12058: &start_data_table_header_row().
12059: '<th>'.&mt('File').'</th>'.
12060: '<th>'.&mt('Size (KB)').'</th>'.
12061: '<th>'.&mt('Modified').'</th>'.
12062: '<th>'.&mt('Upload replacement?').'</th>'.
12063: &end_data_table_header_row().
12064: $modify_output.
12065: &end_data_table()."\n";
12066: }
12067: if ($delete_output) {
12068: $delete_output = &start_data_table().
12069: &start_data_table_header_row().
12070: '<th>'.&mt('File').'</th>'.
12071: '<th>'.&mt('Size (KB)').'</th>'.
12072: '<th>'.&mt('Modified').'</th>'.
12073: '<th>'.&mt('Delete?').'</th>'.
12074: &end_data_table_header_row().
12075: $delete_output.
12076: &end_data_table()."\n";
12077: }
1.987 raeburn 12078: my $applies = 0;
12079: if ($numremref) {
12080: $applies ++;
12081: }
12082: if ($numinvalid) {
12083: $applies ++;
12084: }
12085: if ($numexisting) {
12086: $applies ++;
12087: }
1.1071 raeburn 12088: if ($counter || $numunused) {
1.987 raeburn 12089: $output = '<form name="upload_embedded" action="'.$actionurl.'"'.
12090: ' method="post" enctype="multipart/form-data">'."\n".
1.1071 raeburn 12091: $state.'<h3>'.$heading.'</h3>';
12092: if ($actionurl eq '/adm/dependencies') {
12093: if ($numnew) {
12094: $output .= '<h4>'.&mt('Missing dependencies').'</h4>'.
12095: '<p>'.&mt('The following files need to be uploaded.').'</p>'."\n".
12096: $upload_output.'<br />'."\n";
12097: }
12098: if ($numexisting) {
12099: $output .= '<h4>'.&mt('Uploaded dependencies (in use)').'</h4>'.
12100: '<p>'.&mt('Upload a new file to replace the one currently in use.').'</p>'."\n".
12101: $modify_output.'<br />'."\n";
12102: $buttontext = &mt('Save changes');
12103: }
12104: if ($numunused) {
12105: $output .= '<h4>'.&mt('Unused files').'</h4>'.
12106: '<p>'.&mt('The following uploaded files are no longer used.').'</p>'."\n".
12107: $delete_output.'<br />'."\n";
12108: $buttontext = &mt('Save changes');
12109: }
12110: } else {
12111: $output .= $upload_output.'<br />'."\n";
12112: }
12113: $output .= '<input type ="hidden" name="number_embedded_items" value="'.
12114: $counter.'" />'."\n";
12115: if ($actionurl eq '/adm/dependencies') {
12116: $output .= '<input type ="hidden" name="number_newemb_items" value="'.
12117: $numnew.'" />'."\n";
12118: } elsif ($actionurl eq '') {
1.987 raeburn 12119: $output .= '<input type="hidden" name="phase" value="three" />';
12120: }
12121: } elsif ($applies) {
12122: $output = '<b>'.&mt('Referenced files').'</b>:<br />';
12123: if ($applies > 1) {
12124: $output .=
1.1123 raeburn 12125: &mt('No dependencies need to be uploaded, as one of the following applies to each reference:').'<ul>';
1.987 raeburn 12126: if ($numremref) {
12127: $output .= '<li>'.&mt('reference is to a URL which points to another server').'</li>'."\n";
12128: }
12129: if ($numinvalid) {
12130: $output .= '<li>'.&mt('reference is to file with a name containing invalid characters').'</li>'."\n";
12131: }
12132: if ($numexisting) {
12133: $output .= '<li>'.&mt('reference is to an existing file at the specified location').'</li>'."\n";
12134: }
12135: $output .= '</ul><br />';
12136: } elsif ($numremref) {
12137: $output .= '<p>'.&mt('None to upload, as all references are to URLs pointing to another server.').'</p>';
12138: } elsif ($numinvalid) {
12139: $output .= '<p>'.&mt('None to upload, as all references are to files with names containing invalid characters.').'</p>';
12140: } elsif ($numexisting) {
12141: $output .= '<p>'.&mt('None to upload, as all references are to existing files.').'</p>';
12142: }
12143: $output .= $upload_output.'<br />';
12144: }
12145: my ($pathchange_output,$chgcount);
1.1071 raeburn 12146: $chgcount = $counter;
1.987 raeburn 12147: if (keys(%pathchanges) > 0) {
12148: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%pathchanges)) {
1.1071 raeburn 12149: if ($counter) {
1.987 raeburn 12150: $output .= &embedded_file_element('pathchange',$chgcount,
12151: $embed_file,\%mapping,
1.1071 raeburn 12152: $allfiles,$codebase,'change');
1.987 raeburn 12153: } else {
12154: $pathchange_output .=
12155: &start_data_table_row().
12156: '<td><input type ="checkbox" name="namechange" value="'.
12157: $chgcount.'" checked="checked" /></td>'.
12158: '<td>'.$mapping{$embed_file}.'</td>'.
12159: '<td>'.$embed_file.
12160: &embedded_file_element('pathchange',$numpathchg,$embed_file,
1.1071 raeburn 12161: \%mapping,$allfiles,$codebase,'change').
1.987 raeburn 12162: '</td>'.&end_data_table_row();
1.660 raeburn 12163: }
1.987 raeburn 12164: $numpathchg ++;
12165: $chgcount ++;
1.660 raeburn 12166: }
12167: }
1.1127 raeburn 12168: if (($counter) || ($numunused)) {
1.987 raeburn 12169: if ($numpathchg) {
12170: $output .= '<input type ="hidden" name="number_pathchange_items" value="'.
12171: $numpathchg.'" />'."\n";
12172: }
12173: if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') ||
12174: ($actionurl eq '/adm/imsimport')) {
12175: $output .= '<input type="hidden" name="phase" value="three" />'."\n";
12176: } elsif ($actionurl eq '/adm/portfolio' || $actionurl eq '/adm/coursegrp_portfolio') {
12177: $output .= '<input type="hidden" name="action" value="upload_embedded" />';
1.1071 raeburn 12178: } elsif ($actionurl eq '/adm/dependencies') {
12179: $output .= '<input type="hidden" name="action" value="process_changes" />';
1.987 raeburn 12180: }
1.1123 raeburn 12181: $output .= '<input type ="submit" value="'.$buttontext.'" />'."\n".'</form>'."\n";
1.987 raeburn 12182: } elsif ($numpathchg) {
12183: my %pathchange = ();
12184: $output .= &modify_html_form('pathchange',$actionurl,$state,\%pathchange,$pathchange_output);
12185: if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
12186: $output .= '<p>'.&mt('or').'</p>';
1.1123 raeburn 12187: }
1.987 raeburn 12188: }
1.1071 raeburn 12189: return ($output,$counter,$numpathchg);
1.987 raeburn 12190: }
12191:
1.1147 raeburn 12192: =pod
12193:
12194: =item * clean_path($name)
12195:
12196: Performs clean-up of directories, subdirectories and filename in an
12197: embedded object, referenced in an HTML file which is being uploaded
12198: to a course or portfolio, where
12199: "Upload embedded images/multimedia files if HTML file" checkbox was
12200: checked.
12201:
12202: Clean-up is similar to replacements in lonnet::clean_filename()
12203: except each / between sub-directory and next level is preserved.
12204:
12205: =cut
12206:
12207: sub clean_path {
12208: my ($embed_file) = @_;
12209: $embed_file =~s{^/+}{};
12210: my @contents;
12211: if ($embed_file =~ m{/}) {
12212: @contents = split(/\//,$embed_file);
12213: } else {
12214: @contents = ($embed_file);
12215: }
12216: my $lastidx = scalar(@contents)-1;
12217: for (my $i=0; $i<=$lastidx; $i++) {
12218: $contents[$i]=~s{\\}{/}g;
12219: $contents[$i]=~s/\s+/\_/g;
12220: $contents[$i]=~s{[^/\w\.\-]}{}g;
12221: if ($i == $lastidx) {
12222: $contents[$i]=~s/\.(\d+)(?=\.)/_$1/g;
12223: }
12224: }
12225: if ($lastidx > 0) {
12226: return join('/',@contents);
12227: } else {
12228: return $contents[0];
12229: }
12230: }
12231:
1.987 raeburn 12232: sub embedded_file_element {
1.1071 raeburn 12233: my ($context,$num,$embed_file,$mapping,$allfiles,$codebase,$type) = @_;
1.987 raeburn 12234: return unless ((ref($mapping) eq 'HASH') && (ref($allfiles) eq 'HASH') &&
12235: (ref($codebase) eq 'HASH'));
12236: my $output;
1.1071 raeburn 12237: if (($context eq 'upload_embedded') && ($type ne 'delete')) {
1.987 raeburn 12238: $output = '<input name="embedded_item_'.$num.'" type="file" value="" />'."\n";
12239: }
12240: $output .= '<input name="embedded_orig_'.$num.'" type="hidden" value="'.
12241: &escape($embed_file).'" />';
12242: unless (($context eq 'upload_embedded') &&
12243: ($mapping->{$embed_file} eq $embed_file)) {
12244: $output .='
12245: <input name="embedded_ref_'.$num.'" type="hidden" value="'.&escape($mapping->{$embed_file}).'" />';
12246: }
12247: my $attrib;
12248: if (ref($allfiles->{$mapping->{$embed_file}}) eq 'ARRAY') {
12249: $attrib = &escape(join(':',@{$allfiles->{$mapping->{$embed_file}}}));
12250: }
12251: $output .=
12252: "\n\t\t".
12253: '<input name="embedded_attrib_'.$num.'" type="hidden" value="'.
12254: $attrib.'" />';
12255: if (exists($codebase->{$mapping->{$embed_file}})) {
12256: $output .=
12257: "\n\t\t".
12258: '<input name="codebase_'.$num.'" type="hidden" value="'.
12259: &escape($codebase->{$mapping->{$embed_file}}).'" />';
1.984 raeburn 12260: }
1.987 raeburn 12261: return $output;
1.660 raeburn 12262: }
12263:
1.1071 raeburn 12264: sub get_dependency_details {
12265: my ($currfile,$currsubfile,$embed_file) = @_;
12266: my ($size,$mtime,$showsize,$showmtime);
12267: if ((ref($currfile) eq 'HASH') && (ref($currsubfile))) {
12268: if ($embed_file =~ m{/}) {
12269: my ($path,$fname) = split(/\//,$embed_file);
12270: if (ref($currsubfile->{$path}{$fname}) eq 'ARRAY') {
12271: ($size,$mtime) = @{$currsubfile->{$path}{$fname}};
12272: }
12273: } else {
12274: if (ref($currfile->{$embed_file}) eq 'ARRAY') {
12275: ($size,$mtime) = @{$currfile->{$embed_file}};
12276: }
12277: }
12278: $showsize = $size/1024.0;
12279: $showsize = sprintf("%.1f",$showsize);
12280: if ($mtime > 0) {
12281: $showmtime = &Apache::lonlocal::locallocaltime($mtime);
12282: }
12283: }
12284: return ($showsize,$showmtime);
12285: }
12286:
12287: sub ask_embedded_js {
12288: return <<"END";
12289: <script type="text/javascript"">
12290: // <![CDATA[
12291: function toggleBrowse(counter) {
12292: var chkboxid = document.getElementById('mod_upload_dep_'+counter);
12293: var fileid = document.getElementById('embedded_item_'+counter);
12294: var uploaddivid = document.getElementById('moduploaddep_'+counter);
12295: if (chkboxid.checked == true) {
12296: uploaddivid.style.display='block';
12297: } else {
12298: uploaddivid.style.display='none';
12299: fileid.value = '';
12300: }
12301: }
12302: // ]]>
12303: </script>
12304:
12305: END
12306: }
12307:
1.661 raeburn 12308: sub upload_embedded {
12309: my ($context,$dirpath,$uname,$udom,$dir_root,$url_root,$group,$disk_quota,
1.987 raeburn 12310: $current_disk_usage,$hiddenstate,$actionurl) = @_;
12311: my (%pathchange,$output,$modifyform,$footer,$returnflag);
1.661 raeburn 12312: for (my $i=0; $i<$env{'form.number_embedded_items'}; $i++) {
12313: next if (!exists($env{'form.embedded_item_'.$i.'.filename'}));
12314: my $orig_uploaded_filename =
12315: $env{'form.embedded_item_'.$i.'.filename'};
1.987 raeburn 12316: foreach my $type ('orig','ref','attrib','codebase') {
12317: if ($env{'form.embedded_'.$type.'_'.$i} ne '') {
12318: $env{'form.embedded_'.$type.'_'.$i} =
12319: &unescape($env{'form.embedded_'.$type.'_'.$i});
12320: }
12321: }
1.661 raeburn 12322: my ($path,$fname) =
12323: ($env{'form.embedded_orig_'.$i} =~ m{(.*/)([^/]*)});
12324: # no path, whole string is fname
12325: if (!$fname) { $fname = $env{'form.embedded_orig_'.$i} };
12326: $fname = &Apache::lonnet::clean_filename($fname);
12327: # See if there is anything left
12328: next if ($fname eq '');
12329:
12330: # Check if file already exists as a file or directory.
12331: my ($state,$msg);
12332: if ($context eq 'portfolio') {
12333: my $port_path = $dirpath;
12334: if ($group ne '') {
12335: $port_path = "groups/$group/$port_path";
12336: }
1.987 raeburn 12337: ($state,$msg) = &check_for_upload($env{'form.currentpath'}.$path,
12338: $fname,$group,'embedded_item_'.$i,
1.661 raeburn 12339: $dir_root,$port_path,$disk_quota,
12340: $current_disk_usage,$uname,$udom);
12341: if ($state eq 'will_exceed_quota'
1.984 raeburn 12342: || $state eq 'file_locked') {
1.661 raeburn 12343: $output .= $msg;
12344: next;
12345: }
12346: } elsif (($context eq 'author') || ($context eq 'testbank')) {
12347: ($state,$msg) = &check_for_existing($path,$fname,'embedded_item_'.$i);
12348: if ($state eq 'exists') {
12349: $output .= $msg;
12350: next;
12351: }
12352: }
12353: # Check if extension is valid
12354: if (($fname =~ /\.(\w+)$/) &&
12355: (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
1.1155 bisitz 12356: $output .= &mt('Invalid file extension ([_1]) - reserved for internal use.',$1)
12357: .' '.&mt('Rename the file with a different extension and re-upload.').'<br />';
1.661 raeburn 12358: next;
12359: } elsif (($fname =~ /\.(\w+)$/) &&
12360: (!defined(&Apache::loncommon::fileembstyle($1)))) {
1.987 raeburn 12361: $output .= &mt('Unrecognized file extension ([_1]) - rename the file with a proper extension and re-upload.',$1).'<br />';
1.661 raeburn 12362: next;
12363: } elsif ($fname=~/\.(\d+)\.(\w+)$/) {
1.1120 bisitz 12364: $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 12365: next;
12366: }
12367: $env{'form.embedded_item_'.$i.'.filename'}=$fname;
1.1123 raeburn 12368: my $subdir = $path;
12369: $subdir =~ s{/+$}{};
1.661 raeburn 12370: if ($context eq 'portfolio') {
1.984 raeburn 12371: my $result;
12372: if ($state eq 'existingfile') {
12373: $result=
12374: &Apache::lonnet::userfileupload('embedded_item_'.$i,'existingfile',
1.1123 raeburn 12375: $dirpath.$env{'form.currentpath'}.$subdir);
1.661 raeburn 12376: } else {
1.984 raeburn 12377: $result=
12378: &Apache::lonnet::userfileupload('embedded_item_'.$i,'',
1.987 raeburn 12379: $dirpath.
1.1123 raeburn 12380: $env{'form.currentpath'}.$subdir);
1.984 raeburn 12381: if ($result !~ m|^/uploaded/|) {
12382: $output .= '<span class="LC_error">'
12383: .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
12384: ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
12385: .'</span><br />';
12386: next;
12387: } else {
1.987 raeburn 12388: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
12389: $path.$fname.'</span>').'<br />';
1.984 raeburn 12390: }
1.661 raeburn 12391: }
1.1123 raeburn 12392: } elsif (($context eq 'coursedoc') || ($context eq 'syllabus')) {
1.1126 raeburn 12393: my $extendedsubdir = $dirpath.'/'.$subdir;
12394: $extendedsubdir =~ s{/+$}{};
1.987 raeburn 12395: my $result =
1.1126 raeburn 12396: &Apache::lonnet::userfileupload('embedded_item_'.$i,$context,$extendedsubdir);
1.987 raeburn 12397: if ($result !~ m|^/uploaded/|) {
12398: $output .= '<span class="LC_error">'
12399: .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
12400: ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
12401: .'</span><br />';
12402: next;
12403: } else {
12404: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
12405: $path.$fname.'</span>').'<br />';
1.1125 raeburn 12406: if ($context eq 'syllabus') {
12407: &Apache::lonnet::make_public_indefinitely($result);
12408: }
1.987 raeburn 12409: }
1.661 raeburn 12410: } else {
12411: # Save the file
12412: my $target = $env{'form.embedded_item_'.$i};
12413: my $fullpath = $dir_root.$dirpath.'/'.$path;
12414: my $dest = $fullpath.$fname;
12415: my $url = $url_root.$dirpath.'/'.$path.$fname;
1.1027 raeburn 12416: my @parts=split(/\//,"$dirpath/$path");
1.661 raeburn 12417: my $count;
12418: my $filepath = $dir_root;
1.1027 raeburn 12419: foreach my $subdir (@parts) {
12420: $filepath .= "/$subdir";
12421: if (!-e $filepath) {
1.661 raeburn 12422: mkdir($filepath,0770);
12423: }
12424: }
12425: my $fh;
12426: if (!open($fh,'>'.$dest)) {
12427: &Apache::lonnet::logthis('Failed to create '.$dest);
12428: $output .= '<span class="LC_error">'.
1.1071 raeburn 12429: &mt('An error occurred while trying to upload [_1] for embedded element [_2].',
12430: $orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
1.661 raeburn 12431: '</span><br />';
12432: } else {
12433: if (!print $fh $env{'form.embedded_item_'.$i}) {
12434: &Apache::lonnet::logthis('Failed to write to '.$dest);
12435: $output .= '<span class="LC_error">'.
1.1071 raeburn 12436: &mt('An error occurred while writing the file [_1] for embedded element [_2].',
12437: $orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
1.661 raeburn 12438: '</span><br />';
12439: } else {
1.987 raeburn 12440: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
12441: $url.'</span>').'<br />';
12442: unless ($context eq 'testbank') {
12443: $footer .= &mt('View embedded file: [_1]',
12444: '<a href="'.$url.'">'.$fname.'</a>').'<br />';
12445: }
12446: }
12447: close($fh);
12448: }
12449: }
12450: if ($env{'form.embedded_ref_'.$i}) {
12451: $pathchange{$i} = 1;
12452: }
12453: }
12454: if ($output) {
12455: $output = '<p>'.$output.'</p>';
12456: }
12457: $output .= &modify_html_form('upload_embedded',$actionurl,$hiddenstate,\%pathchange);
12458: $returnflag = 'ok';
1.1071 raeburn 12459: my $numpathchgs = scalar(keys(%pathchange));
12460: if ($numpathchgs > 0) {
1.987 raeburn 12461: if ($context eq 'portfolio') {
12462: $output .= '<p>'.&mt('or').'</p>';
12463: } elsif ($context eq 'testbank') {
1.1071 raeburn 12464: $output .= '<p>'.&mt('Or [_1]continue[_2] the testbank import without modifying the reference(s).',
12465: '<a href="javascript:document.testbankForm.submit();">','</a>').'</p>';
1.987 raeburn 12466: $returnflag = 'modify_orightml';
12467: }
12468: }
1.1071 raeburn 12469: return ($output.$footer,$returnflag,$numpathchgs);
1.987 raeburn 12470: }
12471:
12472: sub modify_html_form {
12473: my ($context,$actionurl,$hiddenstate,$pathchange,$pathchgtable) = @_;
12474: my $end = 0;
12475: my $modifyform;
12476: if ($context eq 'upload_embedded') {
12477: return unless (ref($pathchange) eq 'HASH');
12478: if ($env{'form.number_embedded_items'}) {
12479: $end += $env{'form.number_embedded_items'};
12480: }
12481: if ($env{'form.number_pathchange_items'}) {
12482: $end += $env{'form.number_pathchange_items'};
12483: }
12484: if ($end) {
12485: for (my $i=0; $i<$end; $i++) {
12486: if ($i < $env{'form.number_embedded_items'}) {
12487: next unless($pathchange->{$i});
12488: }
12489: $modifyform .=
12490: &start_data_table_row().
12491: '<td><input type ="checkbox" name="namechange" value="'.$i.'" '.
12492: 'checked="checked" /></td>'.
12493: '<td>'.$env{'form.embedded_ref_'.$i}.
12494: '<input type="hidden" name="embedded_ref_'.$i.'" value="'.
12495: &escape($env{'form.embedded_ref_'.$i}).'" />'.
12496: '<input type="hidden" name="embedded_codebase_'.$i.'" value="'.
12497: &escape($env{'form.embedded_codebase_'.$i}).'" />'.
12498: '<input type="hidden" name="embedded_attrib_'.$i.'" value="'.
12499: &escape($env{'form.embedded_attrib_'.$i}).'" /></td>'.
12500: '<td>'.$env{'form.embedded_orig_'.$i}.
12501: '<input type="hidden" name="embedded_orig_'.$i.'" value="'.
12502: &escape($env{'form.embedded_orig_'.$i}).'" /></td>'.
12503: &end_data_table_row();
1.1071 raeburn 12504: }
1.987 raeburn 12505: }
12506: } else {
12507: $modifyform = $pathchgtable;
12508: if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
12509: $hiddenstate .= '<input type="hidden" name="phase" value="four" />';
12510: } elsif (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
12511: $hiddenstate .= '<input type="hidden" name="action" value="modify_orightml" />';
12512: }
12513: }
12514: if ($modifyform) {
1.1071 raeburn 12515: if ($actionurl eq '/adm/dependencies') {
12516: $hiddenstate .= '<input type="hidden" name="action" value="modifyhrefs" />';
12517: }
1.987 raeburn 12518: return '<h3>'.&mt('Changes in content of HTML file required').'</h3>'."\n".
12519: '<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".
12520: '<li>'.&mt('For consistency between the reference(s) and the location of the corresponding stored file within LON-CAPA.').'</li>'."\n".
12521: '<li>'.&mt('To change absolute paths to relative paths, or replace directory traversal via "../" within the original reference.').'</li>'."\n".
12522: '</ol></p>'."\n".'<p>'.
12523: &mt('LON-CAPA can make the required changes to your HTML file.').'</p>'."\n".
12524: '<form method="post" name="refchanger" action="'.$actionurl.'">'.
12525: &start_data_table()."\n".
12526: &start_data_table_header_row().
12527: '<th>'.&mt('Change?').'</th>'.
12528: '<th>'.&mt('Current reference').'</th>'.
12529: '<th>'.&mt('Required reference').'</th>'.
12530: &end_data_table_header_row()."\n".
12531: $modifyform.
12532: &end_data_table().'<br />'."\n".$hiddenstate.
12533: '<input type="submit" name="pathchanges" value="'.&mt('Modify HTML file').'" />'.
12534: '</form>'."\n";
12535: }
12536: return;
12537: }
12538:
12539: sub modify_html_refs {
1.1123 raeburn 12540: my ($context,$dirpath,$uname,$udom,$dir_root,$url) = @_;
1.987 raeburn 12541: my $container;
12542: if ($context eq 'portfolio') {
12543: $container = $env{'form.container'};
12544: } elsif ($context eq 'coursedoc') {
12545: $container = $env{'form.primaryurl'};
1.1071 raeburn 12546: } elsif ($context eq 'manage_dependencies') {
12547: (undef,undef,$container) = &Apache::lonnet::decode_symb($env{'form.symb'});
12548: $container = "/$container";
1.1123 raeburn 12549: } elsif ($context eq 'syllabus') {
12550: $container = $url;
1.987 raeburn 12551: } else {
1.1027 raeburn 12552: $container = $Apache::lonnet::perlvar{'lonDocRoot'}.$env{'form.filename'};
1.987 raeburn 12553: }
12554: my (%allfiles,%codebase,$output,$content);
12555: my @changes = &get_env_multiple('form.namechange');
1.1126 raeburn 12556: unless ((@changes > 0) || ($context eq 'syllabus')) {
1.1071 raeburn 12557: if (wantarray) {
12558: return ('',0,0);
12559: } else {
12560: return;
12561: }
12562: }
12563: if (($context eq 'portfolio') || ($context eq 'coursedoc') ||
1.1123 raeburn 12564: ($context eq 'manage_dependencies') || ($context eq 'syllabus')) {
1.1071 raeburn 12565: unless ($container =~ m{^/uploaded/\Q$udom\E/\Q$uname\E/}) {
12566: if (wantarray) {
12567: return ('',0,0);
12568: } else {
12569: return;
12570: }
12571: }
1.987 raeburn 12572: $content = &Apache::lonnet::getfile($container);
1.1071 raeburn 12573: if ($content eq '-1') {
12574: if (wantarray) {
12575: return ('',0,0);
12576: } else {
12577: return;
12578: }
12579: }
1.987 raeburn 12580: } else {
1.1071 raeburn 12581: unless ($container =~ /^\Q$dir_root\E/) {
12582: if (wantarray) {
12583: return ('',0,0);
12584: } else {
12585: return;
12586: }
12587: }
1.1317 raeburn 12588: if (open(my $fh,'<',$container)) {
1.987 raeburn 12589: $content = join('', <$fh>);
12590: close($fh);
12591: } else {
1.1071 raeburn 12592: if (wantarray) {
12593: return ('',0,0);
12594: } else {
12595: return;
12596: }
1.987 raeburn 12597: }
12598: }
12599: my ($count,$codebasecount) = (0,0);
12600: my $mm = new File::MMagic;
12601: my $mime_type = $mm->checktype_contents($content);
12602: if ($mime_type eq 'text/html') {
12603: my $parse_result =
12604: &Apache::lonnet::extract_embedded_items($container,\%allfiles,
12605: \%codebase,\$content);
12606: if ($parse_result eq 'ok') {
12607: foreach my $i (@changes) {
12608: my $orig = &unescape($env{'form.embedded_orig_'.$i});
12609: my $ref = &unescape($env{'form.embedded_ref_'.$i});
12610: if ($allfiles{$ref}) {
12611: my $newname = $orig;
12612: my ($attrib_regexp,$codebase);
1.1006 raeburn 12613: $attrib_regexp = &unescape($env{'form.embedded_attrib_'.$i});
1.987 raeburn 12614: if ($attrib_regexp =~ /:/) {
12615: $attrib_regexp =~ s/\:/|/g;
12616: }
12617: if ($content =~ m{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}) {
12618: my $numchg = ($content =~ s{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}{$1$newname$2}gi);
12619: $count += $numchg;
1.1123 raeburn 12620: $allfiles{$newname} = $allfiles{$ref};
1.1148 raeburn 12621: delete($allfiles{$ref});
1.987 raeburn 12622: }
12623: if ($env{'form.embedded_codebase_'.$i} ne '') {
1.1006 raeburn 12624: $codebase = &unescape($env{'form.embedded_codebase_'.$i});
1.987 raeburn 12625: my $numchg = ($content =~ s/(codebase\s*=\s*["']?)\Q$codebase\E(["']?)/$1.$2/i); #' stupid emacs
12626: $codebasecount ++;
12627: }
12628: }
12629: }
1.1123 raeburn 12630: my $skiprewrites;
1.987 raeburn 12631: if ($count || $codebasecount) {
12632: my $saveresult;
1.1071 raeburn 12633: if (($context eq 'portfolio') || ($context eq 'coursedoc') ||
1.1123 raeburn 12634: ($context eq 'manage_dependencies') || ($context eq 'syllabus')) {
1.987 raeburn 12635: my $url = &Apache::lonnet::store_edited_file($container,$content,$udom,$uname,\$saveresult);
12636: if ($url eq $container) {
12637: my ($fname) = ($container =~ m{/([^/]+)$});
12638: $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
12639: $count,'<span class="LC_filename">'.
1.1071 raeburn 12640: $fname.'</span>').'</p>';
1.987 raeburn 12641: } else {
12642: $output = '<p class="LC_error">'.
12643: &mt('Error: update failed for: [_1].',
12644: '<span class="LC_filename">'.
12645: $container.'</span>').'</p>';
12646: }
1.1123 raeburn 12647: if ($context eq 'syllabus') {
12648: unless ($saveresult eq 'ok') {
12649: $skiprewrites = 1;
12650: }
12651: }
1.987 raeburn 12652: } else {
1.1317 raeburn 12653: if (open(my $fh,'>',$container)) {
1.987 raeburn 12654: print $fh $content;
12655: close($fh);
12656: $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
12657: $count,'<span class="LC_filename">'.
12658: $container.'</span>').'</p>';
1.661 raeburn 12659: } else {
1.987 raeburn 12660: $output = '<p class="LC_error">'.
12661: &mt('Error: could not update [_1].',
12662: '<span class="LC_filename">'.
12663: $container.'</span>').'</p>';
1.661 raeburn 12664: }
12665: }
12666: }
1.1123 raeburn 12667: if (($context eq 'syllabus') && (!$skiprewrites)) {
12668: my ($actionurl,$state);
12669: $actionurl = "/public/$udom/$uname/syllabus";
12670: my ($ignore,$num,$numpathchanges,$existing,$mapping) =
12671: &ask_for_embedded_content($actionurl,$state,\%allfiles,
12672: \%codebase,
12673: {'context' => 'rewrites',
12674: 'ignore_remote_references' => 1,});
12675: if (ref($mapping) eq 'HASH') {
12676: my $rewrites = 0;
12677: foreach my $key (keys(%{$mapping})) {
12678: next if ($key =~ m{^https?://});
12679: my $ref = $mapping->{$key};
12680: my $newname = "/uploaded/$udom/$uname/portfolio/syllabus/$key";
12681: my $attrib;
12682: if (ref($allfiles{$mapping->{$key}}) eq 'ARRAY') {
12683: $attrib = join('|',@{$allfiles{$mapping->{$key}}});
12684: }
12685: if ($content =~ m{($attrib\s*=\s*['"]?)\Q$ref\E(['"]?)}) {
12686: my $numchg = ($content =~ s{($attrib\s*=\s*['"]?)\Q$ref\E(['"]?)}{$1$newname$2}gi);
12687: $rewrites += $numchg;
12688: }
12689: }
12690: if ($rewrites) {
12691: my $saveresult;
12692: my $url = &Apache::lonnet::store_edited_file($container,$content,$udom,$uname,\$saveresult);
12693: if ($url eq $container) {
12694: my ($fname) = ($container =~ m{/([^/]+)$});
12695: $output .= '<p>'.&mt('Rewrote [quant,_1,link] as [quant,_1,absolute link] in [_2].',
12696: $count,'<span class="LC_filename">'.
12697: $fname.'</span>').'</p>';
12698: } else {
12699: $output .= '<p class="LC_error">'.
12700: &mt('Error: could not update links in [_1].',
12701: '<span class="LC_filename">'.
12702: $container.'</span>').'</p>';
12703:
12704: }
12705: }
12706: }
12707: }
1.987 raeburn 12708: } else {
12709: &logthis('Failed to parse '.$container.
12710: ' to modify references: '.$parse_result);
1.661 raeburn 12711: }
12712: }
1.1071 raeburn 12713: if (wantarray) {
12714: return ($output,$count,$codebasecount);
12715: } else {
12716: return $output;
12717: }
1.661 raeburn 12718: }
12719:
12720: sub check_for_existing {
12721: my ($path,$fname,$element) = @_;
12722: my ($state,$msg);
12723: if (-d $path.'/'.$fname) {
12724: $state = 'exists';
12725: $msg = &mt('Unable to upload [_1]. A directory by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
12726: } elsif (-e $path.'/'.$fname) {
12727: $state = 'exists';
12728: $msg = &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
12729: }
12730: if ($state eq 'exists') {
12731: $msg = '<span class="LC_error">'.$msg.'</span><br />';
12732: }
12733: return ($state,$msg);
12734: }
12735:
12736: sub check_for_upload {
12737: my ($path,$fname,$group,$element,$portfolio_root,$port_path,
12738: $disk_quota,$current_disk_usage,$uname,$udom) = @_;
1.985 raeburn 12739: my $filesize = length($env{'form.'.$element});
12740: if (!$filesize) {
12741: my $msg = '<span class="LC_error">'.
12742: &mt('Unable to upload [_1]. (size = [_2] bytes)',
12743: '<span class="LC_filename">'.$fname.'</span>',
12744: $filesize).'<br />'.
1.1007 raeburn 12745: &mt('Either the file you attempted to upload was empty, or your web browser was unable to read its contents.').'<br />'.
1.985 raeburn 12746: '</span>';
12747: return ('zero_bytes',$msg);
12748: }
12749: $filesize = $filesize/1000; #express in k (1024?)
1.661 raeburn 12750: my $getpropath = 1;
1.1021 raeburn 12751: my ($dirlistref,$listerror) =
12752: &Apache::lonnet::dirlist($portfolio_root.$path,$udom,$uname,$getpropath);
1.661 raeburn 12753: my $found_file = 0;
12754: my $locked_file = 0;
1.991 raeburn 12755: my @lockers;
12756: my $navmap;
12757: if ($env{'request.course.id'}) {
12758: $navmap = Apache::lonnavmaps::navmap->new();
12759: }
1.1021 raeburn 12760: if (ref($dirlistref) eq 'ARRAY') {
12761: foreach my $line (@{$dirlistref}) {
12762: my ($file_name,$rest)=split(/\&/,$line,2);
12763: if ($file_name eq $fname){
12764: $file_name = $path.$file_name;
12765: if ($group ne '') {
12766: $file_name = $group.$file_name;
12767: }
12768: $found_file = 1;
12769: if (&Apache::lonnet::is_locked($file_name,$udom,$uname,\@lockers) eq 'true') {
12770: foreach my $lock (@lockers) {
12771: if (ref($lock) eq 'ARRAY') {
12772: my ($symb,$crsid) = @{$lock};
12773: if ($crsid eq $env{'request.course.id'}) {
12774: if (ref($navmap)) {
12775: my $res = $navmap->getBySymb($symb);
12776: foreach my $part (@{$res->parts()}) {
12777: my ($slot_status,$slot_time,$slot_name)=$res->check_for_slot($part);
12778: unless (($slot_status == $res->RESERVED) ||
12779: ($slot_status == $res->RESERVED_LOCATION)) {
12780: $locked_file = 1;
12781: }
1.991 raeburn 12782: }
1.1021 raeburn 12783: } else {
12784: $locked_file = 1;
1.991 raeburn 12785: }
12786: } else {
12787: $locked_file = 1;
12788: }
12789: }
1.1021 raeburn 12790: }
12791: } else {
12792: my @info = split(/\&/,$rest);
12793: my $currsize = $info[6]/1000;
12794: if ($currsize < $filesize) {
12795: my $extra = $filesize - $currsize;
12796: if (($current_disk_usage + $extra) > $disk_quota) {
1.1179 bisitz 12797: my $msg = '<p class="LC_warning">'.
1.1021 raeburn 12798: &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 12799: '<span class="LC_filename">'.$fname.'</span>',$filesize,$currsize).'</p>'.
12800: '<p>'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',
12801: $disk_quota,$current_disk_usage).'</p>';
1.1021 raeburn 12802: return ('will_exceed_quota',$msg);
12803: }
1.984 raeburn 12804: }
12805: }
1.661 raeburn 12806: }
12807: }
12808: }
12809: if (($current_disk_usage + $filesize) > $disk_quota){
1.1179 bisitz 12810: my $msg = '<p class="LC_warning">'.
12811: &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.','<span class="LC_filename">'.$fname.'</span>',$filesize).'</p>'.
1.1184 raeburn 12812: '<p>'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',$disk_quota,$current_disk_usage).'</p>';
1.661 raeburn 12813: return ('will_exceed_quota',$msg);
12814: } elsif ($found_file) {
12815: if ($locked_file) {
1.1179 bisitz 12816: my $msg = '<p class="LC_warning">';
1.661 raeburn 12817: $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 12818: $msg .= '</p>';
1.661 raeburn 12819: $msg .= &mt('You will be able to rename or delete existing [_1] after a grade has been assigned.','<span class="LC_filename">'.$fname.'</span>');
12820: return ('file_locked',$msg);
12821: } else {
1.1179 bisitz 12822: my $msg = '<p class="LC_error">';
1.984 raeburn 12823: $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 12824: $msg .= '</p>';
1.984 raeburn 12825: return ('existingfile',$msg);
1.661 raeburn 12826: }
12827: }
12828: }
12829:
1.987 raeburn 12830: sub check_for_traversal {
12831: my ($path,$url,$toplevel) = @_;
12832: my @parts=split(/\//,$path);
12833: my $cleanpath;
12834: my $fullpath = $url;
12835: for (my $i=0;$i<@parts;$i++) {
12836: next if ($parts[$i] eq '.');
12837: if ($parts[$i] eq '..') {
12838: $fullpath =~ s{([^/]+/)$}{};
12839: } else {
12840: $fullpath .= $parts[$i].'/';
12841: }
12842: }
12843: if ($fullpath =~ /^\Q$url\E(.*)$/) {
12844: $cleanpath = $1;
12845: } elsif ($fullpath =~ /^\Q$toplevel\E(.*)$/) {
12846: my $curr_toprel = $1;
12847: my @parts = split(/\//,$curr_toprel);
12848: my ($url_toprel) = ($url =~ /^\Q$toplevel\E(.*)$/);
12849: my @urlparts = split(/\//,$url_toprel);
12850: my $doubledots;
12851: my $startdiff = -1;
12852: for (my $i=0; $i<@urlparts; $i++) {
12853: if ($startdiff == -1) {
12854: unless ($urlparts[$i] eq $parts[$i]) {
12855: $startdiff = $i;
12856: $doubledots .= '../';
12857: }
12858: } else {
12859: $doubledots .= '../';
12860: }
12861: }
12862: if ($startdiff > -1) {
12863: $cleanpath = $doubledots;
12864: for (my $i=$startdiff; $i<@parts; $i++) {
12865: $cleanpath .= $parts[$i].'/';
12866: }
12867: }
12868: }
12869: $cleanpath =~ s{(/)$}{};
12870: return $cleanpath;
12871: }
1.31 albertel 12872:
1.1053 raeburn 12873: sub is_archive_file {
12874: my ($mimetype) = @_;
12875: if (($mimetype eq 'application/octet-stream') ||
12876: ($mimetype eq 'application/x-stuffit') ||
12877: ($mimetype =~ m{^application/(x\-)?(compressed|tar|zip|tgz|gz|gtar|gzip|gunzip|bz|bz2|bzip2)})) {
12878: return 1;
12879: }
12880: return;
12881: }
12882:
12883: sub decompress_form {
1.1065 raeburn 12884: my ($mimetype,$archiveurl,$action,$noextract,$hiddenelements,$dirlist) = @_;
1.1053 raeburn 12885: my %lt = &Apache::lonlocal::texthash (
12886: this => 'This file is an archive file.',
1.1067 raeburn 12887: camt => 'This file is a Camtasia archive file.',
1.1065 raeburn 12888: itsc => 'Its contents are as follows:',
1.1053 raeburn 12889: youm => 'You may wish to extract its contents.',
12890: extr => 'Extract contents',
1.1067 raeburn 12891: auto => 'LON-CAPA can process the files automatically, or you can decide how each should be handled.',
12892: proa => 'Process automatically?',
1.1053 raeburn 12893: yes => 'Yes',
12894: no => 'No',
1.1067 raeburn 12895: fold => 'Title for folder containing movie',
12896: movi => 'Title for page containing embedded movie',
1.1053 raeburn 12897: );
1.1065 raeburn 12898: my $fileloc = &Apache::lonnet::filelocation(undef,$archiveurl);
1.1067 raeburn 12899: my ($is_camtasia,$topdir,%toplevel,@paths);
1.1065 raeburn 12900: my $info = &list_archive_contents($fileloc,\@paths);
12901: if (@paths) {
12902: foreach my $path (@paths) {
12903: $path =~ s{^/}{};
1.1067 raeburn 12904: if ($path =~ m{^([^/]+)/$}) {
12905: $topdir = $1;
12906: }
1.1065 raeburn 12907: if ($path =~ m{^([^/]+)/}) {
12908: $toplevel{$1} = $path;
12909: } else {
12910: $toplevel{$path} = $path;
12911: }
12912: }
12913: }
1.1067 raeburn 12914: if ($mimetype =~ m{^application/(x\-)?(compressed|zip)}) {
1.1164 raeburn 12915: my @camtasia6 = ("$topdir/","$topdir/index.html",
1.1067 raeburn 12916: "$topdir/media/",
12917: "$topdir/media/$topdir.mp4",
12918: "$topdir/media/FirstFrame.png",
12919: "$topdir/media/player.swf",
12920: "$topdir/media/swfobject.js",
12921: "$topdir/media/expressInstall.swf");
1.1197 raeburn 12922: my @camtasia8_1 = ("$topdir/","$topdir/$topdir.html",
1.1164 raeburn 12923: "$topdir/$topdir.mp4",
12924: "$topdir/$topdir\_config.xml",
12925: "$topdir/$topdir\_controller.swf",
12926: "$topdir/$topdir\_embed.css",
12927: "$topdir/$topdir\_First_Frame.png",
12928: "$topdir/$topdir\_player.html",
12929: "$topdir/$topdir\_Thumbnails.png",
12930: "$topdir/playerProductInstall.swf",
12931: "$topdir/scripts/",
12932: "$topdir/scripts/config_xml.js",
12933: "$topdir/scripts/handlebars.js",
12934: "$topdir/scripts/jquery-1.7.1.min.js",
12935: "$topdir/scripts/jquery-ui-1.8.15.custom.min.js",
12936: "$topdir/scripts/modernizr.js",
12937: "$topdir/scripts/player-min.js",
12938: "$topdir/scripts/swfobject.js",
12939: "$topdir/skins/",
12940: "$topdir/skins/configuration_express.xml",
12941: "$topdir/skins/express_show/",
12942: "$topdir/skins/express_show/player-min.css",
12943: "$topdir/skins/express_show/spritesheet.png");
1.1197 raeburn 12944: my @camtasia8_4 = ("$topdir/","$topdir/$topdir.html",
12945: "$topdir/$topdir.mp4",
12946: "$topdir/$topdir\_config.xml",
12947: "$topdir/$topdir\_controller.swf",
12948: "$topdir/$topdir\_embed.css",
12949: "$topdir/$topdir\_First_Frame.png",
12950: "$topdir/$topdir\_player.html",
12951: "$topdir/$topdir\_Thumbnails.png",
12952: "$topdir/playerProductInstall.swf",
12953: "$topdir/scripts/",
12954: "$topdir/scripts/config_xml.js",
12955: "$topdir/scripts/techsmith-smart-player.min.js",
12956: "$topdir/skins/",
12957: "$topdir/skins/configuration_express.xml",
12958: "$topdir/skins/express_show/",
12959: "$topdir/skins/express_show/spritesheet.min.css",
12960: "$topdir/skins/express_show/spritesheet.png",
12961: "$topdir/skins/express_show/techsmith-smart-player.min.css");
1.1164 raeburn 12962: my @diffs = &compare_arrays(\@paths,\@camtasia6);
1.1067 raeburn 12963: if (@diffs == 0) {
1.1164 raeburn 12964: $is_camtasia = 6;
12965: } else {
1.1197 raeburn 12966: @diffs = &compare_arrays(\@paths,\@camtasia8_1);
1.1164 raeburn 12967: if (@diffs == 0) {
12968: $is_camtasia = 8;
1.1197 raeburn 12969: } else {
12970: @diffs = &compare_arrays(\@paths,\@camtasia8_4);
12971: if (@diffs == 0) {
12972: $is_camtasia = 8;
12973: }
1.1164 raeburn 12974: }
1.1067 raeburn 12975: }
12976: }
12977: my $output;
12978: if ($is_camtasia) {
12979: $output = <<"ENDCAM";
12980: <script type="text/javascript" language="Javascript">
12981: // <![CDATA[
12982:
12983: function camtasiaToggle() {
12984: for (var i=0; i<document.uploaded_decompress.autoextract_camtasia.length; i++) {
12985: if (document.uploaded_decompress.autoextract_camtasia[i].checked) {
1.1164 raeburn 12986: if (document.uploaded_decompress.autoextract_camtasia[i].value == $is_camtasia) {
1.1067 raeburn 12987: document.getElementById('camtasia_titles').style.display='block';
12988: } else {
12989: document.getElementById('camtasia_titles').style.display='none';
12990: }
12991: }
12992: }
12993: return;
12994: }
12995:
12996: // ]]>
12997: </script>
12998: <p>$lt{'camt'}</p>
12999: ENDCAM
1.1065 raeburn 13000: } else {
1.1067 raeburn 13001: $output = '<p>'.$lt{'this'};
13002: if ($info eq '') {
13003: $output .= ' '.$lt{'youm'}.'</p>'."\n";
13004: } else {
13005: $output .= ' '.$lt{'itsc'}.'</p>'."\n".
13006: '<div><pre>'.$info.'</pre></div>';
13007: }
1.1065 raeburn 13008: }
1.1067 raeburn 13009: $output .= '<form name="uploaded_decompress" action="'.$action.'" method="post">'."\n";
1.1065 raeburn 13010: my $duplicates;
13011: my $num = 0;
13012: if (ref($dirlist) eq 'ARRAY') {
13013: foreach my $item (@{$dirlist}) {
13014: if (ref($item) eq 'ARRAY') {
13015: if (exists($toplevel{$item->[0]})) {
13016: $duplicates .=
13017: &start_data_table_row().
13018: '<td><label><input type="radio" name="archive_overwrite_'.$num.'" '.
13019: 'value="0" checked="checked" />'.&mt('No').'</label>'.
13020: ' <label><input type="radio" name="archive_overwrite_'.$num.'" '.
13021: 'value="1" />'.&mt('Yes').'</label>'.
13022: '<input type="hidden" name="archive_overwrite_name_'.$num.'" value="'.$item->[0].'" /></td>'."\n".
13023: '<td>'.$item->[0].'</td>';
13024: if ($item->[2]) {
13025: $duplicates .= '<td>'.&mt('Directory').'</td>';
13026: } else {
13027: $duplicates .= '<td>'.&mt('File').'</td>';
13028: }
13029: $duplicates .= '<td>'.$item->[3].'</td>'.
13030: '<td>'.
13031: &Apache::lonlocal::locallocaltime($item->[4]).
13032: '</td>'.
13033: &end_data_table_row();
13034: $num ++;
13035: }
13036: }
13037: }
13038: }
13039: my $itemcount;
13040: if (@paths > 0) {
13041: $itemcount = scalar(@paths);
13042: } else {
13043: $itemcount = 1;
13044: }
1.1067 raeburn 13045: if ($is_camtasia) {
13046: $output .= $lt{'auto'}.'<br />'.
13047: '<span class="LC_nobreak">'.$lt{'proa'}.'<label>'.
1.1164 raeburn 13048: '<input type="radio" name="autoextract_camtasia" value="'.$is_camtasia.'" onclick="javascript:camtasiaToggle();" checked="checked" />'.
1.1067 raeburn 13049: $lt{'yes'}.'</label> <label>'.
13050: '<input type="radio" name="autoextract_camtasia" value="0" onclick="javascript:camtasiaToggle();" />'.
13051: $lt{'no'}.'</label></span><br />'.
13052: '<div id="camtasia_titles" style="display:block">'.
13053: &Apache::lonhtmlcommon::start_pick_box().
13054: &Apache::lonhtmlcommon::row_title($lt{'fold'}).
13055: '<input type="textbox" name="camtasia_foldername" value="'.$env{'form.comment'}.'" />'."\n".
13056: &Apache::lonhtmlcommon::row_closure().
13057: &Apache::lonhtmlcommon::row_title($lt{'movi'}).
13058: '<input type="textbox" name="camtasia_moviename" value="" />'."\n".
13059: &Apache::lonhtmlcommon::row_closure(1).
13060: &Apache::lonhtmlcommon::end_pick_box().
13061: '</div>';
13062: }
1.1065 raeburn 13063: $output .=
13064: '<input type="hidden" name="archive_overwrite_total" value="'.$num.'" />'.
1.1067 raeburn 13065: '<input type="hidden" name="archive_itemcount" value="'.$itemcount.'" />'.
13066: "\n";
1.1065 raeburn 13067: if ($duplicates ne '') {
13068: $output .= '<p><span class="LC_warning">'.
13069: &mt('Warning: decompression of the archive will overwrite the following items which already exist:').'</span><br />'.
13070: &start_data_table().
13071: &start_data_table_header_row().
13072: '<th>'.&mt('Overwrite?').'</th>'.
13073: '<th>'.&mt('Name').'</th>'.
13074: '<th>'.&mt('Type').'</th>'.
13075: '<th>'.&mt('Size').'</th>'.
13076: '<th>'.&mt('Last modified').'</th>'.
13077: &end_data_table_header_row().
13078: $duplicates.
13079: &end_data_table().
13080: '</p>';
13081: }
1.1067 raeburn 13082: $output .= '<input type="hidden" name="archiveurl" value="'.$archiveurl.'" />'."\n";
1.1053 raeburn 13083: if (ref($hiddenelements) eq 'HASH') {
13084: foreach my $hidden (sort(keys(%{$hiddenelements}))) {
13085: $output .= '<input type="hidden" name="'.$hidden.'" value="'.$hiddenelements->{$hidden}.'" />'."\n";
13086: }
13087: }
13088: $output .= <<"END";
1.1067 raeburn 13089: <br />
1.1053 raeburn 13090: <input type="submit" name="decompress" value="$lt{'extr'}" />
13091: </form>
13092: $noextract
13093: END
13094: return $output;
13095: }
13096:
1.1065 raeburn 13097: sub decompression_utility {
13098: my ($program) = @_;
13099: my @utilities = ('tar','gunzip','bunzip2','unzip');
13100: my $location;
13101: if (grep(/^\Q$program\E$/,@utilities)) {
13102: foreach my $dir ('/bin/','/usr/bin/','/usr/local/bin/','/sbin/',
13103: '/usr/sbin/') {
13104: if (-x $dir.$program) {
13105: $location = $dir.$program;
13106: last;
13107: }
13108: }
13109: }
13110: return $location;
13111: }
13112:
13113: sub list_archive_contents {
13114: my ($file,$pathsref) = @_;
13115: my (@cmd,$output);
13116: my $needsregexp;
13117: if ($file =~ /\.zip$/) {
13118: @cmd = (&decompression_utility('unzip'),"-l");
13119: $needsregexp = 1;
13120: } elsif (($file =~ m/\.tar\.gz$/) ||
13121: ($file =~ /\.tgz$/)) {
13122: @cmd = (&decompression_utility('tar'),"-ztf");
13123: } elsif ($file =~ /\.tar\.bz2$/) {
13124: @cmd = (&decompression_utility('tar'),"-jtf");
13125: } elsif ($file =~ m|\.tar$|) {
13126: @cmd = (&decompression_utility('tar'),"-tf");
13127: }
13128: if (@cmd) {
13129: undef($!);
13130: undef($@);
13131: if (open(my $fh,"-|", @cmd, $file)) {
13132: while (my $line = <$fh>) {
13133: $output .= $line;
13134: chomp($line);
13135: my $item;
13136: if ($needsregexp) {
13137: ($item) = ($line =~ /^\s*\d+\s+[\d\-]+\s+[\d:]+\s*(.+)$/);
13138: } else {
13139: $item = $line;
13140: }
13141: if ($item ne '') {
13142: unless (grep(/^\Q$item\E$/,@{$pathsref})) {
13143: push(@{$pathsref},$item);
13144: }
13145: }
13146: }
13147: close($fh);
13148: }
13149: }
13150: return $output;
13151: }
13152:
1.1053 raeburn 13153: sub decompress_uploaded_file {
13154: my ($file,$dir) = @_;
13155: &Apache::lonnet::appenv({'cgi.file' => $file});
13156: &Apache::lonnet::appenv({'cgi.dir' => $dir});
13157: my $result = &Apache::lonnet::ssi_body('/cgi-bin/decompress.pl');
13158: my ($handle) = ($env{'user.environment'} =~m{/([^/]+)\.id$});
13159: my $lonidsdir = $Apache::lonnet::perlvar{'lonIDsDir'};
13160: &Apache::lonnet::transfer_profile_to_env($lonidsdir,$handle,1);
13161: my $decompressed = $env{'cgi.decompressed'};
13162: &Apache::lonnet::delenv('cgi.file');
13163: &Apache::lonnet::delenv('cgi.dir');
13164: &Apache::lonnet::delenv('cgi.decompressed');
13165: return ($decompressed,$result);
13166: }
13167:
1.1055 raeburn 13168: sub process_decompression {
13169: my ($docudom,$docuname,$file,$destination,$dir_root,$hiddenelem) = @_;
1.1292 raeburn 13170: unless (($dir_root eq '/userfiles') && ($destination =~ m{^(docs|supplemental)/(default|\d+)/\d+$})) {
13171: return '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
13172: &mt('Unexpected file path.').'</p>'."\n";
13173: }
13174: unless (($docudom =~ /^$match_domain$/) && ($docuname =~ /^$match_courseid$/)) {
13175: return '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
13176: &mt('Unexpected course context.').'</p>'."\n";
13177: }
1.1293 raeburn 13178: unless ($file eq &Apache::lonnet::clean_filename($file)) {
1.1292 raeburn 13179: return '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
13180: &mt('Filename contained unexpected characters.').'</p>'."\n";
13181: }
1.1055 raeburn 13182: my ($dir,$error,$warning,$output);
1.1180 raeburn 13183: if ($file !~ /\.(zip|tar|bz2|gz|tar.gz|tar.bz2|tgz)$/i) {
1.1120 bisitz 13184: $error = &mt('Filename not a supported archive file type.').
13185: '<br />'.&mt('Filename should end with one of: [_1].',
1.1055 raeburn 13186: '.zip, .tar, .bz2, .gz, .tar.gz, .tar.bz2, .tgz');
13187: } else {
13188: my $docuhome = &Apache::lonnet::homeserver($docuname,$docudom);
13189: if ($docuhome eq 'no_host') {
13190: $error = &mt('Could not determine home server for course.');
13191: } else {
13192: my @ids=&Apache::lonnet::current_machine_ids();
13193: my $currdir = "$dir_root/$destination";
13194: if (grep(/^\Q$docuhome\E$/,@ids)) {
13195: $dir = &LONCAPA::propath($docudom,$docuname).
13196: "$dir_root/$destination";
13197: } else {
13198: $dir = $Apache::lonnet::perlvar{'lonDocRoot'}.
13199: "$dir_root/$docudom/$docuname/$destination";
13200: unless (&Apache::lonnet::repcopy_userfile("$dir/$file") eq 'ok') {
13201: $error = &mt('Archive file not found.');
13202: }
13203: }
1.1065 raeburn 13204: my (@to_overwrite,@to_skip);
13205: if ($env{'form.archive_overwrite_total'} > 0) {
13206: my $total = $env{'form.archive_overwrite_total'};
13207: for (my $i=0; $i<$total; $i++) {
13208: if ($env{'form.archive_overwrite_'.$i} == 1) {
13209: push(@to_overwrite,$env{'form.archive_overwrite_name_'.$i});
13210: } elsif ($env{'form.archive_overwrite_'.$i} == 0) {
13211: push(@to_skip,$env{'form.archive_overwrite_name_'.$i});
13212: }
13213: }
13214: }
13215: my $numskip = scalar(@to_skip);
1.1292 raeburn 13216: my $numoverwrite = scalar(@to_overwrite);
13217: if (($numskip) && (!$numoverwrite)) {
1.1065 raeburn 13218: $warning = &mt('All items in the archive file already exist, and no overwriting of existing files has been requested.');
13219: } elsif ($dir eq '') {
1.1055 raeburn 13220: $error = &mt('Directory containing archive file unavailable.');
13221: } elsif (!$error) {
1.1065 raeburn 13222: my ($decompressed,$display);
1.1292 raeburn 13223: if (($numskip) || ($numoverwrite)) {
1.1065 raeburn 13224: my $tempdir = time.'_'.$$.int(rand(10000));
13225: mkdir("$dir/$tempdir",0755);
1.1292 raeburn 13226: if (&File::Copy::move("$dir/$file","$dir/$tempdir/$file")) {
13227: ($decompressed,$display) =
13228: &decompress_uploaded_file($file,"$dir/$tempdir");
13229: foreach my $item (@to_skip) {
13230: if (($item ne '') && ($item !~ /\.\./)) {
13231: if (-f "$dir/$tempdir/$item") {
13232: unlink("$dir/$tempdir/$item");
13233: } elsif (-d "$dir/$tempdir/$item") {
1.1300 raeburn 13234: &File::Path::remove_tree("$dir/$tempdir/$item",{ safe => 1 });
1.1292 raeburn 13235: }
13236: }
13237: }
13238: foreach my $item (@to_overwrite) {
13239: if ((-e "$dir/$tempdir/$item") && (-e "$dir/$item")) {
13240: if (($item ne '') && ($item !~ /\.\./)) {
13241: if (-f "$dir/$item") {
13242: unlink("$dir/$item");
13243: } elsif (-d "$dir/$item") {
1.1300 raeburn 13244: &File::Path::remove_tree("$dir/$item",{ safe => 1 });
1.1292 raeburn 13245: }
13246: &File::Copy::move("$dir/$tempdir/$item","$dir/$item");
13247: }
1.1065 raeburn 13248: }
13249: }
1.1292 raeburn 13250: if (&File::Copy::move("$dir/$tempdir/$file","$dir/$file")) {
1.1300 raeburn 13251: &File::Path::remove_tree("$dir/$tempdir",{ safe => 1 });
1.1292 raeburn 13252: }
1.1065 raeburn 13253: }
13254: } else {
13255: ($decompressed,$display) =
13256: &decompress_uploaded_file($file,$dir);
13257: }
1.1055 raeburn 13258: if ($decompressed eq 'ok') {
1.1065 raeburn 13259: $output = '<p class="LC_info">'.
13260: &mt('Files extracted successfully from archive.').
13261: '</p>'."\n";
1.1055 raeburn 13262: my ($warning,$result,@contents);
13263: my ($newdirlistref,$newlisterror) =
13264: &Apache::lonnet::dirlist($currdir,$docudom,
13265: $docuname,1);
13266: my (%is_dir,%changes,@newitems);
13267: my $dirptr = 16384;
1.1065 raeburn 13268: if (ref($newdirlistref) eq 'ARRAY') {
1.1055 raeburn 13269: foreach my $dir_line (@{$newdirlistref}) {
13270: my ($item,undef,undef,$testdir)=split(/\&/,$dir_line,5);
1.1292 raeburn 13271: unless (($item =~ /^\.+$/) || ($item eq $file)) {
1.1055 raeburn 13272: push(@newitems,$item);
13273: if ($dirptr&$testdir) {
13274: $is_dir{$item} = 1;
13275: }
13276: $changes{$item} = 1;
13277: }
13278: }
13279: }
13280: if (keys(%changes) > 0) {
13281: foreach my $item (sort(@newitems)) {
13282: if ($changes{$item}) {
13283: push(@contents,$item);
13284: }
13285: }
13286: }
13287: if (@contents > 0) {
1.1067 raeburn 13288: my $wantform;
13289: unless ($env{'form.autoextract_camtasia'}) {
13290: $wantform = 1;
13291: }
1.1056 raeburn 13292: my (%children,%parent,%dirorder,%titles);
1.1055 raeburn 13293: my ($count,$datatable) = &get_extracted($docudom,$docuname,
13294: $currdir,\%is_dir,
13295: \%children,\%parent,
1.1056 raeburn 13296: \@contents,\%dirorder,
13297: \%titles,$wantform);
1.1055 raeburn 13298: if ($datatable ne '') {
13299: $output .= &archive_options_form('decompressed',$datatable,
13300: $count,$hiddenelem);
1.1065 raeburn 13301: my $startcount = 6;
1.1055 raeburn 13302: $output .= &archive_javascript($startcount,$count,
1.1056 raeburn 13303: \%titles,\%children);
1.1055 raeburn 13304: }
1.1067 raeburn 13305: if ($env{'form.autoextract_camtasia'}) {
1.1164 raeburn 13306: my $version = $env{'form.autoextract_camtasia'};
1.1067 raeburn 13307: my %displayed;
13308: my $total = 1;
13309: $env{'form.archive_directory'} = [];
13310: foreach my $i (sort { $a <=> $b } keys(%dirorder)) {
13311: my $path = join('/',map { $titles{$_}; } @{$dirorder{$i}});
13312: $path =~ s{/$}{};
13313: my $item;
13314: if ($path ne '') {
13315: $item = "$path/$titles{$i}";
13316: } else {
13317: $item = $titles{$i};
13318: }
13319: $env{'form.archive_content_'.$i} = "$dir_root/$destination/$item";
13320: if ($item eq $contents[0]) {
13321: push(@{$env{'form.archive_directory'}},$i);
13322: $env{'form.archive_'.$i} = 'display';
13323: $env{'form.archive_title_'.$i} = $env{'form.camtasia_foldername'};
13324: $displayed{'folder'} = $i;
1.1164 raeburn 13325: } elsif ((($item eq "$contents[0]/index.html") && ($version == 6)) ||
13326: (($item eq "$contents[0]/$contents[0]".'.html') && ($version == 8))) {
1.1067 raeburn 13327: $env{'form.archive_'.$i} = 'display';
13328: $env{'form.archive_title_'.$i} = $env{'form.camtasia_moviename'};
13329: $displayed{'web'} = $i;
13330: } else {
1.1164 raeburn 13331: if ((($item eq "$contents[0]/media") && ($version == 6)) ||
13332: ((($item eq "$contents[0]/scripts") || ($item eq "$contents[0]/skins") ||
13333: ($item eq "$contents[0]/skins/express_show")) && ($version == 8))) {
1.1067 raeburn 13334: push(@{$env{'form.archive_directory'}},$i);
13335: }
13336: $env{'form.archive_'.$i} = 'dependency';
13337: }
13338: $total ++;
13339: }
13340: for (my $i=1; $i<$total; $i++) {
13341: next if ($i == $displayed{'web'});
13342: next if ($i == $displayed{'folder'});
13343: $env{'form.archive_dependent_on_'.$i} = $displayed{'web'};
13344: }
13345: $env{'form.phase'} = 'decompress_cleanup';
13346: $env{'form.archivedelete'} = 1;
13347: $env{'form.archive_count'} = $total-1;
13348: $output .=
13349: &process_extracted_files('coursedocs',$docudom,
13350: $docuname,$destination,
13351: $dir_root,$hiddenelem);
13352: }
1.1055 raeburn 13353: } else {
13354: $warning = &mt('No new items extracted from archive file.');
13355: }
13356: } else {
13357: $output = $display;
13358: $error = &mt('An error occurred during extraction from the archive file.');
13359: }
13360: }
13361: }
13362: }
13363: if ($error) {
13364: $output .= '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
13365: $error.'</p>'."\n";
13366: }
13367: if ($warning) {
13368: $output .= '<p class="LC_warning">'.$warning.'</p>'."\n";
13369: }
13370: return $output;
13371: }
13372:
13373: sub get_extracted {
1.1056 raeburn 13374: my ($docudom,$docuname,$currdir,$is_dir,$children,$parent,$contents,$dirorder,
13375: $titles,$wantform) = @_;
1.1055 raeburn 13376: my $count = 0;
13377: my $depth = 0;
13378: my $datatable;
1.1056 raeburn 13379: my @hierarchy;
1.1055 raeburn 13380: return unless ((ref($is_dir) eq 'HASH') && (ref($children) eq 'HASH') &&
1.1056 raeburn 13381: (ref($parent) eq 'HASH') && (ref($contents) eq 'ARRAY') &&
13382: (ref($dirorder) eq 'HASH') && (ref($titles) eq 'HASH'));
1.1055 raeburn 13383: foreach my $item (@{$contents}) {
13384: $count ++;
1.1056 raeburn 13385: @{$dirorder->{$count}} = @hierarchy;
13386: $titles->{$count} = $item;
1.1055 raeburn 13387: &archive_hierarchy($depth,$count,$parent,$children);
13388: if ($wantform) {
13389: $datatable .= &archive_row($is_dir->{$item},$item,
13390: $currdir,$depth,$count);
13391: }
13392: if ($is_dir->{$item}) {
13393: $depth ++;
1.1056 raeburn 13394: push(@hierarchy,$count);
13395: $parent->{$depth} = $count;
1.1055 raeburn 13396: $datatable .=
13397: &recurse_extracted_archive("$currdir/$item",$docudom,$docuname,
1.1056 raeburn 13398: \$depth,\$count,\@hierarchy,$dirorder,
13399: $children,$parent,$titles,$wantform);
1.1055 raeburn 13400: $depth --;
1.1056 raeburn 13401: pop(@hierarchy);
1.1055 raeburn 13402: }
13403: }
13404: return ($count,$datatable);
13405: }
13406:
13407: sub recurse_extracted_archive {
1.1056 raeburn 13408: my ($currdir,$docudom,$docuname,$depth,$count,$hierarchy,$dirorder,
13409: $children,$parent,$titles,$wantform) = @_;
1.1055 raeburn 13410: my $result='';
1.1056 raeburn 13411: unless ((ref($depth)) && (ref($count)) && (ref($hierarchy) eq 'ARRAY') &&
13412: (ref($children) eq 'HASH') && (ref($parent) eq 'HASH') &&
13413: (ref($dirorder) eq 'HASH')) {
1.1055 raeburn 13414: return $result;
13415: }
13416: my $dirptr = 16384;
13417: my ($newdirlistref,$newlisterror) =
13418: &Apache::lonnet::dirlist($currdir,$docudom,$docuname,1);
13419: if (ref($newdirlistref) eq 'ARRAY') {
13420: foreach my $dir_line (@{$newdirlistref}) {
13421: my ($item,undef,undef,$testdir)=split(/\&/,$dir_line,5);
13422: unless ($item =~ /^\.+$/) {
13423: $$count ++;
1.1056 raeburn 13424: @{$dirorder->{$$count}} = @{$hierarchy};
13425: $titles->{$$count} = $item;
1.1055 raeburn 13426: &archive_hierarchy($$depth,$$count,$parent,$children);
1.1056 raeburn 13427:
1.1055 raeburn 13428: my $is_dir;
13429: if ($dirptr&$testdir) {
13430: $is_dir = 1;
13431: }
13432: if ($wantform) {
13433: $result .= &archive_row($is_dir,$item,$currdir,$$depth,$$count);
13434: }
13435: if ($is_dir) {
13436: $$depth ++;
1.1056 raeburn 13437: push(@{$hierarchy},$$count);
13438: $parent->{$$depth} = $$count;
1.1055 raeburn 13439: $result .=
13440: &recurse_extracted_archive("$currdir/$item",$docudom,
13441: $docuname,$depth,$count,
1.1056 raeburn 13442: $hierarchy,$dirorder,$children,
13443: $parent,$titles,$wantform);
1.1055 raeburn 13444: $$depth --;
1.1056 raeburn 13445: pop(@{$hierarchy});
1.1055 raeburn 13446: }
13447: }
13448: }
13449: }
13450: return $result;
13451: }
13452:
13453: sub archive_hierarchy {
13454: my ($depth,$count,$parent,$children) =@_;
13455: if ((ref($parent) eq 'HASH') && (ref($children) eq 'HASH')) {
13456: if (exists($parent->{$depth})) {
13457: $children->{$parent->{$depth}} .= $count.':';
13458: }
13459: }
13460: return;
13461: }
13462:
13463: sub archive_row {
13464: my ($is_dir,$item,$currdir,$depth,$count) = @_;
13465: my ($name) = ($item =~ m{([^/]+)$});
13466: my %choices = &Apache::lonlocal::texthash (
1.1059 raeburn 13467: 'display' => 'Add as file',
1.1055 raeburn 13468: 'dependency' => 'Include as dependency',
13469: 'discard' => 'Discard',
13470: );
13471: if ($is_dir) {
1.1059 raeburn 13472: $choices{'display'} = &mt('Add as folder');
1.1055 raeburn 13473: }
1.1056 raeburn 13474: my $output = &start_data_table_row().'<td align="right">'.$count.'</td>'."\n";
13475: my $offset = 0;
1.1055 raeburn 13476: foreach my $action ('display','dependency','discard') {
1.1056 raeburn 13477: $offset ++;
1.1065 raeburn 13478: if ($action ne 'display') {
13479: $offset ++;
13480: }
1.1055 raeburn 13481: $output .= '<td><span class="LC_nobreak">'.
13482: '<label><input type="radio" name="archive_'.$count.
13483: '" id="archive_'.$action.'_'.$count.'" value="'.$action.'"';
13484: my $text = $choices{$action};
13485: if ($is_dir) {
13486: $output .= ' onclick="javascript:propagateCheck(this.form,'."'$count'".');"';
13487: if ($action eq 'display') {
1.1059 raeburn 13488: $text = &mt('Add as folder');
1.1055 raeburn 13489: }
1.1056 raeburn 13490: } else {
13491: $output .= ' onclick="javascript:dependencyCheck(this.form,'."$count,$offset".');"';
13492:
13493: }
13494: $output .= ' /> '.$choices{$action}.'</label></span>';
13495: if ($action eq 'dependency') {
13496: $output .= '<div id="arc_depon_'.$count.'" style="display:none;">'."\n".
13497: &mt('Used by:').' <select name="archive_dependent_on_'.$count.'" '.
13498: 'onchange="propagateSelect(this.form,'."$count,$offset".')">'."\n".
13499: '<option value=""></option>'."\n".
13500: '</select>'."\n".
13501: '</div>';
1.1059 raeburn 13502: } elsif ($action eq 'display') {
13503: $output .= '<div id="arc_title_'.$count.'" style="display:none;">'."\n".
13504: &mt('Title:').' <input type="text" name="archive_title_'.$count.'" id="archive_title_'.$count.'" />'."\n".
13505: '</div>';
1.1055 raeburn 13506: }
1.1056 raeburn 13507: $output .= '</td>';
1.1055 raeburn 13508: }
13509: $output .= '<td><input type="hidden" name="archive_content_'.$count.'" value="'.
13510: &HTML::Entities::encode("$currdir/$item",'"<>&').'" />'.(' ' x 2);
13511: for (my $i=0; $i<$depth; $i++) {
13512: $output .= ('<img src="/adm/lonIcons/whitespace1.gif" class="LC_docs_spacer" alt="" />' x2)."\n";
13513: }
13514: if ($is_dir) {
13515: $output .= '<img src="/adm/lonIcons/navmap.folder.open.gif" alt="" /> '."\n".
13516: '<input type="hidden" name="archive_directory" value="'.$count.'" />'."\n";
13517: } else {
13518: $output .= '<input type="hidden" name="archive_file" value="'.$count.'" />'."\n";
13519: }
13520: $output .= ' '.$name.'</td>'."\n".
13521: &end_data_table_row();
13522: return $output;
13523: }
13524:
13525: sub archive_options_form {
1.1065 raeburn 13526: my ($form,$display,$count,$hiddenelem) = @_;
13527: my %lt = &Apache::lonlocal::texthash(
13528: perm => 'Permanently remove archive file?',
13529: hows => 'How should each extracted item be incorporated in the course?',
13530: cont => 'Content actions for all',
13531: addf => 'Add as folder/file',
13532: incd => 'Include as dependency for a displayed file',
13533: disc => 'Discard',
13534: no => 'No',
13535: yes => 'Yes',
13536: save => 'Save',
13537: );
13538: my $output = <<"END";
13539: <form name="$form" method="post" action="">
13540: <p><span class="LC_nobreak">$lt{'perm'}
13541: <label>
13542: <input type="radio" name="archivedelete" value="0" checked="checked" />$lt{'no'}
13543: </label>
13544:
13545: <label>
13546: <input type="radio" name="archivedelete" value="1" />$lt{'yes'}</label>
13547: </span>
13548: </p>
13549: <input type="hidden" name="phase" value="decompress_cleanup" />
13550: <br />$lt{'hows'}
13551: <div class="LC_columnSection">
13552: <fieldset>
13553: <legend>$lt{'cont'}</legend>
13554: <input type="button" value="$lt{'addf'}" onclick="javascript:checkAll(document.$form,'display');" />
13555: <input type="button" value="$lt{'incd'}" onclick="javascript:checkAll(document.$form,'dependency');" />
13556: <input type="button" value="$lt{'disc'}" onclick="javascript:checkAll(document.$form,'discard');" />
13557: </fieldset>
13558: </div>
13559: END
13560: return $output.
1.1055 raeburn 13561: &start_data_table()."\n".
1.1065 raeburn 13562: $display."\n".
1.1055 raeburn 13563: &end_data_table()."\n".
13564: '<input type="hidden" name="archive_count" value="'.$count.'" />'.
13565: $hiddenelem.
1.1065 raeburn 13566: '<br /><input type="submit" name="archive_submit" value="'.$lt{'save'}.'" />'.
1.1055 raeburn 13567: '</form>';
13568: }
13569:
13570: sub archive_javascript {
1.1056 raeburn 13571: my ($startcount,$numitems,$titles,$children) = @_;
13572: return unless ((ref($titles) eq 'HASH') && (ref($children) eq 'HASH'));
1.1059 raeburn 13573: my $maintitle = $env{'form.comment'};
1.1055 raeburn 13574: my $scripttag = <<START;
13575: <script type="text/javascript">
13576: // <![CDATA[
13577:
13578: function checkAll(form,prefix) {
13579: var idstr = new RegExp("^archive_"+prefix+"_\\\\d+\$");
13580: for (var i=0; i < form.elements.length; i++) {
13581: var id = form.elements[i].id;
13582: if ((id != '') && (id != undefined)) {
13583: if (idstr.test(id)) {
13584: if (form.elements[i].type == 'radio') {
13585: form.elements[i].checked = true;
1.1056 raeburn 13586: var nostart = i-$startcount;
1.1059 raeburn 13587: var offset = nostart%7;
13588: var count = (nostart-offset)/7;
1.1056 raeburn 13589: dependencyCheck(form,count,offset);
1.1055 raeburn 13590: }
13591: }
13592: }
13593: }
13594: }
13595:
13596: function propagateCheck(form,count) {
13597: if (count > 0) {
1.1059 raeburn 13598: var startelement = $startcount + ((count-1) * 7);
13599: for (var j=1; j<6; j++) {
13600: if ((j != 2) && (j != 4)) {
1.1056 raeburn 13601: var item = startelement + j;
13602: if (form.elements[item].type == 'radio') {
13603: if (form.elements[item].checked) {
13604: containerCheck(form,count,j);
13605: break;
13606: }
1.1055 raeburn 13607: }
13608: }
13609: }
13610: }
13611: }
13612:
13613: numitems = $numitems
1.1056 raeburn 13614: var titles = new Array(numitems);
13615: var parents = new Array(numitems);
1.1055 raeburn 13616: for (var i=0; i<numitems; i++) {
1.1056 raeburn 13617: parents[i] = new Array;
1.1055 raeburn 13618: }
1.1059 raeburn 13619: var maintitle = '$maintitle';
1.1055 raeburn 13620:
13621: START
13622:
1.1056 raeburn 13623: foreach my $container (sort { $a <=> $b } (keys(%{$children}))) {
13624: my @contents = split(/:/,$children->{$container});
1.1055 raeburn 13625: for (my $i=0; $i<@contents; $i ++) {
13626: $scripttag .= 'parents['.$container.']['.$i.'] = '.$contents[$i]."\n";
13627: }
13628: }
13629:
1.1056 raeburn 13630: foreach my $key (sort { $a <=> $b } (keys(%{$titles}))) {
13631: $scripttag .= "titles[$key] = '".$titles->{$key}."';\n";
13632: }
13633:
1.1055 raeburn 13634: $scripttag .= <<END;
13635:
13636: function containerCheck(form,count,offset) {
13637: if (count > 0) {
1.1056 raeburn 13638: dependencyCheck(form,count,offset);
1.1059 raeburn 13639: var item = (offset+$startcount)+7*(count-1);
1.1055 raeburn 13640: form.elements[item].checked = true;
13641: if(Object.prototype.toString.call(parents[count]) === '[object Array]') {
13642: if (parents[count].length > 0) {
13643: for (var j=0; j<parents[count].length; j++) {
1.1056 raeburn 13644: containerCheck(form,parents[count][j],offset);
13645: }
13646: }
13647: }
13648: }
13649: }
13650:
13651: function dependencyCheck(form,count,offset) {
13652: if (count > 0) {
1.1059 raeburn 13653: var chosen = (offset+$startcount)+7*(count-1);
13654: var depitem = $startcount + ((count-1) * 7) + 4;
1.1056 raeburn 13655: var currtype = form.elements[depitem].type;
13656: if (form.elements[chosen].value == 'dependency') {
13657: document.getElementById('arc_depon_'+count).style.display='block';
13658: form.elements[depitem].options.length = 0;
13659: form.elements[depitem].options[0] = new Option('Select','',true,true);
1.1085 raeburn 13660: for (var i=1; i<=numitems; i++) {
13661: if (i == count) {
13662: continue;
13663: }
1.1059 raeburn 13664: var startelement = $startcount + (i-1) * 7;
13665: for (var j=1; j<6; j++) {
13666: if ((j != 2) && (j!= 4)) {
1.1056 raeburn 13667: var item = startelement + j;
13668: if (form.elements[item].type == 'radio') {
13669: if (form.elements[item].checked) {
13670: if (form.elements[item].value == 'display') {
13671: var n = form.elements[depitem].options.length;
13672: form.elements[depitem].options[n] = new Option(titles[i],i,false,false);
13673: }
13674: }
13675: }
13676: }
13677: }
13678: }
13679: } else {
13680: document.getElementById('arc_depon_'+count).style.display='none';
13681: form.elements[depitem].options.length = 0;
13682: form.elements[depitem].options[0] = new Option('Select','',true,true);
13683: }
1.1059 raeburn 13684: titleCheck(form,count,offset);
1.1056 raeburn 13685: }
13686: }
13687:
13688: function propagateSelect(form,count,offset) {
13689: if (count > 0) {
1.1065 raeburn 13690: var item = (1+offset+$startcount)+7*(count-1);
1.1056 raeburn 13691: var picked = form.elements[item].options[form.elements[item].selectedIndex].value;
13692: if (Object.prototype.toString.call(parents[count]) === '[object Array]') {
13693: if (parents[count].length > 0) {
13694: for (var j=0; j<parents[count].length; j++) {
13695: containerSelect(form,parents[count][j],offset,picked);
1.1055 raeburn 13696: }
13697: }
13698: }
13699: }
13700: }
1.1056 raeburn 13701:
13702: function containerSelect(form,count,offset,picked) {
13703: if (count > 0) {
1.1065 raeburn 13704: var item = (offset+$startcount)+7*(count-1);
1.1056 raeburn 13705: if (form.elements[item].type == 'radio') {
13706: if (form.elements[item].value == 'dependency') {
13707: if (form.elements[item+1].type == 'select-one') {
13708: for (var i=0; i<form.elements[item+1].options.length; i++) {
13709: if (form.elements[item+1].options[i].value == picked) {
13710: form.elements[item+1].selectedIndex = i;
13711: break;
13712: }
13713: }
13714: }
13715: if (Object.prototype.toString.call(parents[count]) === '[object Array]') {
13716: if (parents[count].length > 0) {
13717: for (var j=0; j<parents[count].length; j++) {
13718: containerSelect(form,parents[count][j],offset,picked);
13719: }
13720: }
13721: }
13722: }
13723: }
13724: }
13725: }
13726:
1.1059 raeburn 13727: function titleCheck(form,count,offset) {
13728: if (count > 0) {
13729: var chosen = (offset+$startcount)+7*(count-1);
13730: var depitem = $startcount + ((count-1) * 7) + 2;
13731: var currtype = form.elements[depitem].type;
13732: if (form.elements[chosen].value == 'display') {
13733: document.getElementById('arc_title_'+count).style.display='block';
13734: if ((count==1) && ((parents[count].length > 0) || (numitems == 1))) {
13735: document.getElementById('archive_title_'+count).value=maintitle;
13736: }
13737: } else {
13738: document.getElementById('arc_title_'+count).style.display='none';
13739: if (currtype == 'text') {
13740: document.getElementById('archive_title_'+count).value='';
13741: }
13742: }
13743: }
13744: return;
13745: }
13746:
1.1055 raeburn 13747: // ]]>
13748: </script>
13749: END
13750: return $scripttag;
13751: }
13752:
13753: sub process_extracted_files {
1.1067 raeburn 13754: my ($context,$docudom,$docuname,$destination,$dir_root,$hiddenelem) = @_;
1.1055 raeburn 13755: my $numitems = $env{'form.archive_count'};
1.1294 raeburn 13756: return if ((!$numitems) || ($numitems =~ /\D/));
1.1055 raeburn 13757: my @ids=&Apache::lonnet::current_machine_ids();
13758: my ($prefix,$pathtocheck,$dir,$ishome,$error,$warning,%toplevelitems,%is_dir,
1.1067 raeburn 13759: %folders,%containers,%mapinner,%prompttofetch);
1.1055 raeburn 13760: my $docuhome = &Apache::lonnet::homeserver($docuname,$docudom);
13761: if (grep(/^\Q$docuhome\E$/,@ids)) {
13762: $prefix = &LONCAPA::propath($docudom,$docuname);
13763: $pathtocheck = "$dir_root/$destination";
13764: $dir = $dir_root;
13765: $ishome = 1;
13766: } else {
13767: $prefix = $Apache::lonnet::perlvar{'lonDocRoot'};
13768: $pathtocheck = "$dir_root/$docudom/$docuname/$destination";
1.1294 raeburn 13769: $dir = "$dir_root/$docudom/$docuname";
1.1055 raeburn 13770: }
13771: my $currdir = "$dir_root/$destination";
13772: (my $docstype,$mapinner{'0'}) = ($destination =~ m{^(docs|supplemental)/(\w+)/});
13773: if ($env{'form.folderpath'}) {
13774: my @items = split('&',$env{'form.folderpath'});
13775: $folders{'0'} = $items[-2];
1.1099 raeburn 13776: if ($env{'form.folderpath'} =~ /\:1$/) {
13777: $containers{'0'}='page';
13778: } else {
13779: $containers{'0'}='sequence';
13780: }
1.1055 raeburn 13781: }
13782: my @archdirs = &get_env_multiple('form.archive_directory');
13783: if ($numitems) {
13784: for (my $i=1; $i<=$numitems; $i++) {
13785: my $path = $env{'form.archive_content_'.$i};
13786: if ($path =~ m{^\Q$pathtocheck\E/([^/]+)$}) {
13787: my $item = $1;
13788: $toplevelitems{$item} = $i;
13789: if (grep(/^\Q$i\E$/,@archdirs)) {
13790: $is_dir{$item} = 1;
13791: }
13792: }
13793: }
13794: }
1.1067 raeburn 13795: my ($output,%children,%parent,%titles,%dirorder,$result);
1.1055 raeburn 13796: if (keys(%toplevelitems) > 0) {
13797: my @contents = sort(keys(%toplevelitems));
1.1056 raeburn 13798: (my $count,undef) = &get_extracted($docudom,$docuname,$currdir,\%is_dir,\%children,
13799: \%parent,\@contents,\%dirorder,\%titles);
1.1055 raeburn 13800: }
1.1066 raeburn 13801: my (%referrer,%orphaned,%todelete,%todeletedir,%newdest,%newseqid);
1.1055 raeburn 13802: if ($numitems) {
13803: for (my $i=1; $i<=$numitems; $i++) {
1.1086 raeburn 13804: next if ($env{'form.archive_'.$i} eq 'dependency');
1.1055 raeburn 13805: my $path = $env{'form.archive_content_'.$i};
13806: if ($path =~ /^\Q$pathtocheck\E/) {
13807: if ($env{'form.archive_'.$i} eq 'discard') {
13808: if ($prefix ne '' && $path ne '') {
13809: if (-e $prefix.$path) {
1.1066 raeburn 13810: if ((@archdirs > 0) &&
13811: (grep(/^\Q$i\E$/,@archdirs))) {
13812: $todeletedir{$prefix.$path} = 1;
13813: } else {
13814: $todelete{$prefix.$path} = 1;
13815: }
1.1055 raeburn 13816: }
13817: }
13818: } elsif ($env{'form.archive_'.$i} eq 'display') {
1.1059 raeburn 13819: my ($docstitle,$title,$url,$outer);
1.1055 raeburn 13820: ($title) = ($path =~ m{/([^/]+)$});
1.1059 raeburn 13821: $docstitle = $env{'form.archive_title_'.$i};
13822: if ($docstitle eq '') {
13823: $docstitle = $title;
13824: }
1.1055 raeburn 13825: $outer = 0;
1.1056 raeburn 13826: if (ref($dirorder{$i}) eq 'ARRAY') {
13827: if (@{$dirorder{$i}} > 0) {
13828: foreach my $item (reverse(@{$dirorder{$i}})) {
1.1055 raeburn 13829: if ($env{'form.archive_'.$item} eq 'display') {
13830: $outer = $item;
13831: last;
13832: }
13833: }
13834: }
13835: }
13836: my ($errtext,$fatal) =
13837: &LONCAPA::map::mapread('/uploaded/'.$docudom.'/'.$docuname.
13838: '/'.$folders{$outer}.'.'.
13839: $containers{$outer});
13840: next if ($fatal);
13841: if ((@archdirs > 0) && (grep(/^\Q$i\E$/,@archdirs))) {
13842: if ($context eq 'coursedocs') {
1.1056 raeburn 13843: $mapinner{$i} = time;
1.1055 raeburn 13844: $folders{$i} = 'default_'.$mapinner{$i};
13845: $containers{$i} = 'sequence';
13846: my $url = '/uploaded/'.$docudom.'/'.$docuname.'/'.
13847: $folders{$i}.'.'.$containers{$i};
13848: my $newidx = &LONCAPA::map::getresidx();
13849: $LONCAPA::map::resources[$newidx]=
1.1059 raeburn 13850: $docstitle.':'.$url.':false:normal:res';
1.1055 raeburn 13851: push(@LONCAPA::map::order,$newidx);
13852: my ($outtext,$errtext) =
13853: &LONCAPA::map::storemap('/uploaded/'.$docudom.'/'.
13854: $docuname.'/'.$folders{$outer}.
1.1087 raeburn 13855: '.'.$containers{$outer},1,1);
1.1056 raeburn 13856: $newseqid{$i} = $newidx;
1.1067 raeburn 13857: unless ($errtext) {
1.1294 raeburn 13858: $result .= '<li>'.&mt('Folder: [_1] added to course',
13859: &HTML::Entities::encode($docstitle,'<>&"')).
13860: '</li>'."\n";
1.1067 raeburn 13861: }
1.1055 raeburn 13862: }
13863: } else {
13864: if ($context eq 'coursedocs') {
13865: my $newidx=&LONCAPA::map::getresidx();
13866: my $url = '/uploaded/'.$docudom.'/'.$docuname.'/'.
13867: $docstype.'/'.$mapinner{$outer}.'/'.$newidx.'/'.
13868: $title;
1.1294 raeburn 13869: if (($outer !~ /\D/) && ($mapinner{$outer} !~ /\D/) && ($newidx !~ /\D/)) {
13870: if (!-e "$prefix$dir/$docstype/$mapinner{$outer}") {
13871: mkdir("$prefix$dir/$docstype/$mapinner{$outer}",0755);
13872: }
13873: if (!-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx") {
13874: mkdir("$prefix$dir/$docstype/$mapinner{$outer}/$newidx");
13875: }
13876: if (-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx") {
13877: if (rename("$prefix$path","$prefix$dir/$docstype/$mapinner{$outer}/$newidx/$title")) {
13878: $newdest{$i} = "$prefix$dir/$docstype/$mapinner{$outer}/$newidx";
13879: unless ($ishome) {
13880: my $fetch = "$newdest{$i}/$title";
13881: $fetch =~ s/^\Q$prefix$dir\E//;
13882: $prompttofetch{$fetch} = 1;
13883: }
1.1292 raeburn 13884: }
1.1067 raeburn 13885: }
1.1294 raeburn 13886: $LONCAPA::map::resources[$newidx]=
13887: $docstitle.':'.$url.':false:normal:res';
13888: push(@LONCAPA::map::order, $newidx);
13889: my ($outtext,$errtext)=
13890: &LONCAPA::map::storemap('/uploaded/'.$docudom.'/'.
13891: $docuname.'/'.$folders{$outer}.
13892: '.'.$containers{$outer},1,1);
13893: unless ($errtext) {
13894: if (-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx/$title") {
13895: $result .= '<li>'.&mt('File: [_1] added to course',
13896: &HTML::Entities::encode($docstitle,'<>&"')).
13897: '</li>'."\n";
13898: }
1.1067 raeburn 13899: }
1.1294 raeburn 13900: } else {
13901: $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',
13902: &HTML::Entities::encode($path,'<>&"')).'<br />';
1.1296 raeburn 13903: }
1.1055 raeburn 13904: }
13905: }
1.1086 raeburn 13906: }
13907: } else {
1.1294 raeburn 13908: $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',
13909: &HTML::Entities::encode($path,'<>&"')).'<br />';
1.1086 raeburn 13910: }
13911: }
13912: for (my $i=1; $i<=$numitems; $i++) {
13913: next unless ($env{'form.archive_'.$i} eq 'dependency');
13914: my $path = $env{'form.archive_content_'.$i};
13915: if ($path =~ /^\Q$pathtocheck\E/) {
13916: my ($title) = ($path =~ m{/([^/]+)$});
13917: $referrer{$i} = $env{'form.archive_dependent_on_'.$i};
13918: if ($env{'form.archive_'.$referrer{$i}} eq 'display') {
13919: if (ref($dirorder{$i}) eq 'ARRAY') {
13920: my ($itemidx,$fullpath,$relpath);
13921: if (ref($dirorder{$referrer{$i}}) eq 'ARRAY') {
13922: my $container = $dirorder{$referrer{$i}}->[-1];
1.1056 raeburn 13923: for (my $j=0; $j<@{$dirorder{$i}}; $j++) {
1.1086 raeburn 13924: if ($dirorder{$i}->[$j] eq $container) {
13925: $itemidx = $j;
1.1056 raeburn 13926: }
13927: }
1.1086 raeburn 13928: }
13929: if ($itemidx eq '') {
13930: $itemidx = 0;
13931: }
13932: if (grep(/^\Q$referrer{$i}\E$/,@archdirs)) {
13933: if ($mapinner{$referrer{$i}}) {
13934: $fullpath = "$prefix$dir/$docstype/$mapinner{$referrer{$i}}";
13935: for (my $j=$itemidx; $j<@{$dirorder{$i}}; $j++) {
13936: if (grep(/^\Q$dirorder{$i}->[$j]\E$/,@archdirs)) {
13937: unless (defined($newseqid{$dirorder{$i}->[$j]})) {
13938: $fullpath .= '/'.$titles{$dirorder{$i}->[$j]};
13939: $relpath .= '/'.$titles{$dirorder{$i}->[$j]};
13940: if (!-e $fullpath) {
13941: mkdir($fullpath,0755);
1.1056 raeburn 13942: }
13943: }
1.1086 raeburn 13944: } else {
13945: last;
1.1056 raeburn 13946: }
1.1086 raeburn 13947: }
13948: }
13949: } elsif ($newdest{$referrer{$i}}) {
13950: $fullpath = $newdest{$referrer{$i}};
13951: for (my $j=$itemidx; $j<@{$dirorder{$i}}; $j++) {
13952: if ($env{'form.archive_'.$dirorder{$i}->[$j]} eq 'discard') {
13953: $orphaned{$i} = $env{'form.archive_'.$dirorder{$i}->[$j]};
13954: last;
13955: } elsif (grep(/^\Q$dirorder{$i}->[$j]\E$/,@archdirs)) {
13956: unless (defined($newseqid{$dirorder{$i}->[$j]})) {
13957: $fullpath .= '/'.$titles{$dirorder{$i}->[$j]};
13958: $relpath .= '/'.$titles{$dirorder{$i}->[$j]};
13959: if (!-e $fullpath) {
13960: mkdir($fullpath,0755);
1.1056 raeburn 13961: }
13962: }
1.1086 raeburn 13963: } else {
13964: last;
1.1056 raeburn 13965: }
1.1055 raeburn 13966: }
13967: }
1.1086 raeburn 13968: if ($fullpath ne '') {
13969: if (-e "$prefix$path") {
1.1292 raeburn 13970: unless (rename("$prefix$path","$fullpath/$title")) {
13971: $warning .= &mt('Failed to rename dependency').'<br />';
13972: }
1.1086 raeburn 13973: }
13974: if (-e "$fullpath/$title") {
13975: my $showpath;
13976: if ($relpath ne '') {
13977: $showpath = "$relpath/$title";
13978: } else {
13979: $showpath = "/$title";
13980: }
1.1294 raeburn 13981: $result .= '<li>'.&mt('[_1] included as a dependency',
13982: &HTML::Entities::encode($showpath,'<>&"')).
13983: '</li>'."\n";
1.1292 raeburn 13984: unless ($ishome) {
13985: my $fetch = "$fullpath/$title";
13986: $fetch =~ s/^\Q$prefix$dir\E//;
13987: $prompttofetch{$fetch} = 1;
13988: }
1.1086 raeburn 13989: }
13990: }
1.1055 raeburn 13991: }
1.1086 raeburn 13992: } elsif ($env{'form.archive_'.$referrer{$i}} eq 'discard') {
13993: $warning .= &mt('[_1] is a dependency of [_2], which was discarded.',
1.1294 raeburn 13994: &HTML::Entities::encode($path,'<>&"'),
13995: &HTML::Entities::encode($env{'form.archive_content_'.$referrer{$i}},'<>&"')).
13996: '<br />';
1.1055 raeburn 13997: }
13998: } else {
1.1294 raeburn 13999: $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',
1.1296 raeburn 14000: &HTML::Entities::encode($path)).'<br />';
1.1055 raeburn 14001: }
14002: }
14003: if (keys(%todelete)) {
14004: foreach my $key (keys(%todelete)) {
14005: unlink($key);
1.1066 raeburn 14006: }
14007: }
14008: if (keys(%todeletedir)) {
14009: foreach my $key (keys(%todeletedir)) {
14010: rmdir($key);
14011: }
14012: }
14013: foreach my $dir (sort(keys(%is_dir))) {
14014: if (($pathtocheck ne '') && ($dir ne '')) {
14015: &cleanup_empty_dirs($prefix."$pathtocheck/$dir");
1.1055 raeburn 14016: }
14017: }
1.1067 raeburn 14018: if ($result ne '') {
14019: $output .= '<ul>'."\n".
14020: $result."\n".
14021: '</ul>';
14022: }
14023: unless ($ishome) {
14024: my $replicationfail;
14025: foreach my $item (keys(%prompttofetch)) {
14026: my $fetchresult= &Apache::lonnet::reply('fetchuserfile:'.$item,$docuhome);
14027: unless ($fetchresult eq 'ok') {
14028: $replicationfail .= '<li>'.$item.'</li>'."\n";
14029: }
14030: }
14031: if ($replicationfail) {
14032: $output .= '<p class="LC_error">'.
14033: &mt('Course home server failed to retrieve:').'<ul>'.
14034: $replicationfail.
14035: '</ul></p>';
14036: }
14037: }
1.1055 raeburn 14038: } else {
14039: $warning = &mt('No items found in archive.');
14040: }
14041: if ($error) {
14042: $output .= '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
14043: $error.'</p>'."\n";
14044: }
14045: if ($warning) {
14046: $output .= '<p class="LC_warning">'.$warning.'</p>'."\n";
14047: }
14048: return $output;
14049: }
14050:
1.1066 raeburn 14051: sub cleanup_empty_dirs {
14052: my ($path) = @_;
14053: if (($path ne '') && (-d $path)) {
14054: if (opendir(my $dirh,$path)) {
14055: my @dircontents = grep(!/^\./,readdir($dirh));
14056: my $numitems = 0;
14057: foreach my $item (@dircontents) {
14058: if (-d "$path/$item") {
1.1111 raeburn 14059: &cleanup_empty_dirs("$path/$item");
1.1066 raeburn 14060: if (-e "$path/$item") {
14061: $numitems ++;
14062: }
14063: } else {
14064: $numitems ++;
14065: }
14066: }
14067: if ($numitems == 0) {
14068: rmdir($path);
14069: }
14070: closedir($dirh);
14071: }
14072: }
14073: return;
14074: }
14075:
1.41 ng 14076: =pod
1.45 matthew 14077:
1.1162 raeburn 14078: =item * &get_folder_hierarchy()
1.1068 raeburn 14079:
14080: Provides hierarchy of names of folders/sub-folders containing the current
14081: item,
14082:
14083: Inputs: 3
14084: - $navmap - navmaps object
14085:
14086: - $map - url for map (either the trigger itself, or map containing
14087: the resource, which is the trigger).
14088:
14089: - $showitem - 1 => show title for map itself; 0 => do not show.
14090:
14091: Outputs: 1 @pathitems - array of folder/subfolder names.
14092:
14093: =cut
14094:
14095: sub get_folder_hierarchy {
14096: my ($navmap,$map,$showitem) = @_;
14097: my @pathitems;
14098: if (ref($navmap)) {
14099: my $mapres = $navmap->getResourceByUrl($map);
14100: if (ref($mapres)) {
14101: my $pcslist = $mapres->map_hierarchy();
14102: if ($pcslist ne '') {
14103: my @pcs = split(/,/,$pcslist);
14104: foreach my $pc (@pcs) {
14105: if ($pc == 1) {
1.1129 raeburn 14106: push(@pathitems,&mt('Main Content'));
1.1068 raeburn 14107: } else {
14108: my $res = $navmap->getByMapPc($pc);
14109: if (ref($res)) {
14110: my $title = $res->compTitle();
14111: $title =~ s/\W+/_/g;
14112: if ($title ne '') {
14113: push(@pathitems,$title);
14114: }
14115: }
14116: }
14117: }
14118: }
1.1071 raeburn 14119: if ($showitem) {
14120: if ($mapres->{ID} eq '0.0') {
1.1129 raeburn 14121: push(@pathitems,&mt('Main Content'));
1.1071 raeburn 14122: } else {
14123: my $maptitle = $mapres->compTitle();
14124: $maptitle =~ s/\W+/_/g;
14125: if ($maptitle ne '') {
14126: push(@pathitems,$maptitle);
14127: }
1.1068 raeburn 14128: }
14129: }
14130: }
14131: }
14132: return @pathitems;
14133: }
14134:
14135: =pod
14136:
1.1015 raeburn 14137: =item * &get_turnedin_filepath()
14138:
14139: Determines path in a user's portfolio file for storage of files uploaded
14140: to a specific essayresponse or dropbox item.
14141:
14142: Inputs: 3 required + 1 optional.
14143: $symb is symb for resource, $uname and $udom are for current user (required).
14144: $caller is optional (can be "submission", if routine is called when storing
14145: an upoaded file when "Submit Answer" button was pressed).
14146:
14147: Returns array containing $path and $multiresp.
14148: $path is path in portfolio. $multiresp is 1 if this resource contains more
14149: than one file upload item. Callers of routine should append partid as a
14150: subdirectory to $path in cases where $multiresp is 1.
14151:
14152: Called by: homework/essayresponse.pm and homework/structuretags.pm
14153:
14154: =cut
14155:
14156: sub get_turnedin_filepath {
14157: my ($symb,$uname,$udom,$caller) = @_;
14158: my ($map,$resid,$resurl)=&Apache::lonnet::decode_symb($symb);
14159: my $turnindir;
14160: my %userhash = &Apache::lonnet::userenvironment($udom,$uname,'turnindir');
14161: $turnindir = $userhash{'turnindir'};
14162: my ($path,$multiresp);
14163: if ($turnindir eq '') {
14164: if ($caller eq 'submission') {
14165: $turnindir = &mt('turned in');
14166: $turnindir =~ s/\W+/_/g;
14167: my %newhash = (
14168: 'turnindir' => $turnindir,
14169: );
14170: &Apache::lonnet::put('environment',\%newhash,$udom,$uname);
14171: }
14172: }
14173: if ($turnindir ne '') {
14174: $path = '/'.$turnindir.'/';
14175: my ($multipart,$turnin,@pathitems);
14176: my $navmap = Apache::lonnavmaps::navmap->new();
14177: if (defined($navmap)) {
14178: my $mapres = $navmap->getResourceByUrl($map);
14179: if (ref($mapres)) {
14180: my $pcslist = $mapres->map_hierarchy();
14181: if ($pcslist ne '') {
14182: foreach my $pc (split(/,/,$pcslist)) {
14183: my $res = $navmap->getByMapPc($pc);
14184: if (ref($res)) {
14185: my $title = $res->compTitle();
14186: $title =~ s/\W+/_/g;
14187: if ($title ne '') {
1.1149 raeburn 14188: if (($pc > 1) && (length($title) > 12)) {
14189: $title = substr($title,0,12);
14190: }
1.1015 raeburn 14191: push(@pathitems,$title);
14192: }
14193: }
14194: }
14195: }
14196: my $maptitle = $mapres->compTitle();
14197: $maptitle =~ s/\W+/_/g;
14198: if ($maptitle ne '') {
1.1149 raeburn 14199: if (length($maptitle) > 12) {
14200: $maptitle = substr($maptitle,0,12);
14201: }
1.1015 raeburn 14202: push(@pathitems,$maptitle);
14203: }
14204: unless ($env{'request.state'} eq 'construct') {
14205: my $res = $navmap->getBySymb($symb);
14206: if (ref($res)) {
14207: my $partlist = $res->parts();
14208: my $totaluploads = 0;
14209: if (ref($partlist) eq 'ARRAY') {
14210: foreach my $part (@{$partlist}) {
14211: my @types = $res->responseType($part);
14212: my @ids = $res->responseIds($part);
14213: for (my $i=0; $i < scalar(@ids); $i++) {
14214: if ($types[$i] eq 'essay') {
14215: my $partid = $part.'_'.$ids[$i];
14216: if (&Apache::lonnet::EXT("resource.$partid.uploadedfiletypes") ne '') {
14217: $totaluploads ++;
14218: }
14219: }
14220: }
14221: }
14222: if ($totaluploads > 1) {
14223: $multiresp = 1;
14224: }
14225: }
14226: }
14227: }
14228: } else {
14229: return;
14230: }
14231: } else {
14232: return;
14233: }
14234: my $restitle=&Apache::lonnet::gettitle($symb);
14235: $restitle =~ s/\W+/_/g;
14236: if ($restitle eq '') {
14237: $restitle = ($resurl =~ m{/[^/]+$});
14238: if ($restitle eq '') {
14239: $restitle = time;
14240: }
14241: }
1.1149 raeburn 14242: if (length($restitle) > 12) {
14243: $restitle = substr($restitle,0,12);
14244: }
1.1015 raeburn 14245: push(@pathitems,$restitle);
14246: $path .= join('/',@pathitems);
14247: }
14248: return ($path,$multiresp);
14249: }
14250:
14251: =pod
14252:
1.464 albertel 14253: =back
1.41 ng 14254:
1.112 bowersj2 14255: =head1 CSV Upload/Handling functions
1.38 albertel 14256:
1.41 ng 14257: =over 4
14258:
1.648 raeburn 14259: =item * &upfile_store($r)
1.41 ng 14260:
14261: Store uploaded file, $r should be the HTTP Request object,
1.258 albertel 14262: needs $env{'form.upfile'}
1.41 ng 14263: returns $datatoken to be put into hidden field
14264:
14265: =cut
1.31 albertel 14266:
14267: sub upfile_store {
14268: my $r=shift;
1.258 albertel 14269: $env{'form.upfile'}=~s/\r/\n/gs;
14270: $env{'form.upfile'}=~s/\f/\n/gs;
14271: $env{'form.upfile'}=~s/\n+/\n/gs;
14272: $env{'form.upfile'}=~s/\n+$//gs;
1.31 albertel 14273:
1.1299 raeburn 14274: my $datatoken = &valid_datatoken($env{'user.name'}.'_'.$env{'user.domain'}.
14275: '_enroll_'.$env{'request.course.id'}.'_'.
14276: time.'_'.$$);
14277: return if ($datatoken eq '');
14278:
1.31 albertel 14279: {
1.158 raeburn 14280: my $datafile = $r->dir_config('lonDaemons').
14281: '/tmp/'.$datatoken.'.tmp';
1.1317 raeburn 14282: if ( open(my $fh,'>',$datafile) ) {
1.258 albertel 14283: print $fh $env{'form.upfile'};
1.158 raeburn 14284: close($fh);
14285: }
1.31 albertel 14286: }
14287: return $datatoken;
14288: }
14289:
1.56 matthew 14290: =pod
14291:
1.1290 raeburn 14292: =item * &load_tmp_file($r,$datatoken)
1.41 ng 14293:
14294: Load uploaded file from tmp, $r should be the HTTP Request object,
1.1290 raeburn 14295: $datatoken is the name to assign to the temporary file.
1.258 albertel 14296: sets $env{'form.upfile'} to the contents of the file
1.41 ng 14297:
14298: =cut
1.31 albertel 14299:
14300: sub load_tmp_file {
1.1290 raeburn 14301: my ($r,$datatoken) = @_;
14302: return if ($datatoken eq '');
1.31 albertel 14303: my @studentdata=();
14304: {
1.158 raeburn 14305: my $studentfile = $r->dir_config('lonDaemons').
1.1290 raeburn 14306: '/tmp/'.$datatoken.'.tmp';
1.1317 raeburn 14307: if ( open(my $fh,'<',$studentfile) ) {
1.158 raeburn 14308: @studentdata=<$fh>;
14309: close($fh);
14310: }
1.31 albertel 14311: }
1.258 albertel 14312: $env{'form.upfile'}=join('',@studentdata);
1.31 albertel 14313: }
14314:
1.1290 raeburn 14315: sub valid_datatoken {
14316: my ($datatoken) = @_;
1.1325 raeburn 14317: if ($datatoken =~ /^$match_username\_$match_domain\_enroll_(|$match_domain\_$match_courseid)\_\d+_\d+$/) {
1.1290 raeburn 14318: return $datatoken;
14319: }
14320: return;
14321: }
14322:
1.56 matthew 14323: =pod
14324:
1.648 raeburn 14325: =item * &upfile_record_sep()
1.41 ng 14326:
14327: Separate uploaded file into records
14328: returns array of records,
1.258 albertel 14329: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41 ng 14330:
14331: =cut
1.31 albertel 14332:
14333: sub upfile_record_sep {
1.258 albertel 14334: if ($env{'form.upfiletype'} eq 'xml') {
1.31 albertel 14335: } else {
1.248 albertel 14336: my @records;
1.258 albertel 14337: foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248 albertel 14338: if ($line=~/^\s*$/) { next; }
14339: push(@records,$line);
14340: }
14341: return @records;
1.31 albertel 14342: }
14343: }
14344:
1.56 matthew 14345: =pod
14346:
1.648 raeburn 14347: =item * &record_sep($record)
1.41 ng 14348:
1.258 albertel 14349: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41 ng 14350:
14351: =cut
14352:
1.263 www 14353: sub takeleft {
14354: my $index=shift;
14355: return substr('0000'.$index,-4,4);
14356: }
14357:
1.31 albertel 14358: sub record_sep {
14359: my $record=shift;
14360: my %components=();
1.258 albertel 14361: if ($env{'form.upfiletype'} eq 'xml') {
14362: } elsif ($env{'form.upfiletype'} eq 'space') {
1.31 albertel 14363: my $i=0;
1.356 albertel 14364: foreach my $field (split(/\s+/,$record)) {
1.31 albertel 14365: $field=~s/^(\"|\')//;
14366: $field=~s/(\"|\')$//;
1.263 www 14367: $components{&takeleft($i)}=$field;
1.31 albertel 14368: $i++;
14369: }
1.258 albertel 14370: } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31 albertel 14371: my $i=0;
1.356 albertel 14372: foreach my $field (split(/\t/,$record)) {
1.31 albertel 14373: $field=~s/^(\"|\')//;
14374: $field=~s/(\"|\')$//;
1.263 www 14375: $components{&takeleft($i)}=$field;
1.31 albertel 14376: $i++;
14377: }
14378: } else {
1.561 www 14379: my $separator=',';
1.480 banghart 14380: if ($env{'form.upfiletype'} eq 'semisv') {
1.561 www 14381: $separator=';';
1.480 banghart 14382: }
1.31 albertel 14383: my $i=0;
1.561 www 14384: # the character we are looking for to indicate the end of a quote or a record
14385: my $looking_for=$separator;
14386: # do not add the characters to the fields
14387: my $ignore=0;
14388: # we just encountered a separator (or the beginning of the record)
14389: my $just_found_separator=1;
14390: # store the field we are working on here
14391: my $field='';
14392: # work our way through all characters in record
14393: foreach my $character ($record=~/(.)/g) {
14394: if ($character eq $looking_for) {
14395: if ($character ne $separator) {
14396: # Found the end of a quote, again looking for separator
14397: $looking_for=$separator;
14398: $ignore=1;
14399: } else {
14400: # Found a separator, store away what we got
14401: $components{&takeleft($i)}=$field;
14402: $i++;
14403: $just_found_separator=1;
14404: $ignore=0;
14405: $field='';
14406: }
14407: next;
14408: }
14409: # single or double quotation marks after a separator indicate beginning of a quote
14410: # we are now looking for the end of the quote and need to ignore separators
14411: if ((($character eq '"') || ($character eq "'")) && ($just_found_separator)) {
14412: $looking_for=$character;
14413: next;
14414: }
14415: # ignore would be true after we reached the end of a quote
14416: if ($ignore) { next; }
14417: if (($just_found_separator) && ($character=~/\s/)) { next; }
14418: $field.=$character;
14419: $just_found_separator=0;
1.31 albertel 14420: }
1.561 www 14421: # catch the very last entry, since we never encountered the separator
14422: $components{&takeleft($i)}=$field;
1.31 albertel 14423: }
14424: return %components;
14425: }
14426:
1.144 matthew 14427: ######################################################
14428: ######################################################
14429:
1.56 matthew 14430: =pod
14431:
1.648 raeburn 14432: =item * &upfile_select_html()
1.41 ng 14433:
1.144 matthew 14434: Return HTML code to select a file from the users machine and specify
14435: the file type.
1.41 ng 14436:
14437: =cut
14438:
1.144 matthew 14439: ######################################################
14440: ######################################################
1.31 albertel 14441: sub upfile_select_html {
1.144 matthew 14442: my %Types = (
14443: csv => &mt('CSV (comma separated values, spreadsheet)'),
1.480 banghart 14444: semisv => &mt('Semicolon separated values'),
1.144 matthew 14445: space => &mt('Space separated'),
14446: tab => &mt('Tabulator separated'),
14447: # xml => &mt('HTML/XML'),
14448: );
14449: my $Str = '<input type="file" name="upfile" size="50" />'.
1.727 riegler 14450: '<br />'.&mt('Type').': <select name="upfiletype">';
1.144 matthew 14451: foreach my $type (sort(keys(%Types))) {
14452: $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
14453: }
14454: $Str .= "</select>\n";
14455: return $Str;
1.31 albertel 14456: }
14457:
1.301 albertel 14458: sub get_samples {
14459: my ($records,$toget) = @_;
14460: my @samples=({});
14461: my $got=0;
14462: foreach my $rec (@$records) {
14463: my %temp = &record_sep($rec);
14464: if (! grep(/\S/, values(%temp))) { next; }
14465: if (%temp) {
14466: $samples[$got]=\%temp;
14467: $got++;
14468: if ($got == $toget) { last; }
14469: }
14470: }
14471: return \@samples;
14472: }
14473:
1.144 matthew 14474: ######################################################
14475: ######################################################
14476:
1.56 matthew 14477: =pod
14478:
1.648 raeburn 14479: =item * &csv_print_samples($r,$records)
1.41 ng 14480:
14481: Prints a table of sample values from each column uploaded $r is an
14482: Apache Request ref, $records is an arrayref from
14483: &Apache::loncommon::upfile_record_sep
14484:
14485: =cut
14486:
1.144 matthew 14487: ######################################################
14488: ######################################################
1.31 albertel 14489: sub csv_print_samples {
14490: my ($r,$records) = @_;
1.662 bisitz 14491: my $samples = &get_samples($records,5);
1.301 albertel 14492:
1.594 raeburn 14493: $r->print(&mt('Samples').'<br />'.&start_data_table().
14494: &start_data_table_header_row());
1.356 albertel 14495: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.845 bisitz 14496: $r->print('<th>'.&mt('Column [_1]',($sample+1)).'</th>'); }
1.594 raeburn 14497: $r->print(&end_data_table_header_row());
1.301 albertel 14498: foreach my $hash (@$samples) {
1.594 raeburn 14499: $r->print(&start_data_table_row());
1.356 albertel 14500: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.31 albertel 14501: $r->print('<td>');
1.356 albertel 14502: if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
1.31 albertel 14503: $r->print('</td>');
14504: }
1.594 raeburn 14505: $r->print(&end_data_table_row());
1.31 albertel 14506: }
1.594 raeburn 14507: $r->print(&end_data_table().'<br />'."\n");
1.31 albertel 14508: }
14509:
1.144 matthew 14510: ######################################################
14511: ######################################################
14512:
1.56 matthew 14513: =pod
14514:
1.648 raeburn 14515: =item * &csv_print_select_table($r,$records,$d)
1.41 ng 14516:
14517: Prints a table to create associations between values and table columns.
1.144 matthew 14518:
1.41 ng 14519: $r is an Apache Request ref,
14520: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174 matthew 14521: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41 ng 14522:
14523: =cut
14524:
1.144 matthew 14525: ######################################################
14526: ######################################################
1.31 albertel 14527: sub csv_print_select_table {
14528: my ($r,$records,$d) = @_;
1.301 albertel 14529: my $i=0;
14530: my $samples = &get_samples($records,1);
1.144 matthew 14531: $r->print(&mt('Associate columns with student attributes.')."\n".
1.594 raeburn 14532: &start_data_table().&start_data_table_header_row().
1.144 matthew 14533: '<th>'.&mt('Attribute').'</th>'.
1.594 raeburn 14534: '<th>'.&mt('Column').'</th>'.
14535: &end_data_table_header_row()."\n");
1.356 albertel 14536: foreach my $array_ref (@$d) {
14537: my ($value,$display,$defaultcol)=@{ $array_ref };
1.729 raeburn 14538: $r->print(&start_data_table_row().'<td>'.$display.'</td>');
1.31 albertel 14539:
1.875 bisitz 14540: $r->print('<td><select name="f'.$i.'"'.
1.32 matthew 14541: ' onchange="javascript:flip(this.form,'.$i.');">');
1.31 albertel 14542: $r->print('<option value="none"></option>');
1.356 albertel 14543: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
14544: $r->print('<option value="'.$sample.'"'.
14545: ($sample eq $defaultcol ? ' selected="selected" ' : '').
1.662 bisitz 14546: '>'.&mt('Column [_1]',($sample+1)).'</option>');
1.31 albertel 14547: }
1.594 raeburn 14548: $r->print('</select></td>'.&end_data_table_row()."\n");
1.31 albertel 14549: $i++;
14550: }
1.594 raeburn 14551: $r->print(&end_data_table());
1.31 albertel 14552: $i--;
14553: return $i;
14554: }
1.56 matthew 14555:
1.144 matthew 14556: ######################################################
14557: ######################################################
14558:
1.56 matthew 14559: =pod
1.31 albertel 14560:
1.648 raeburn 14561: =item * &csv_samples_select_table($r,$records,$d)
1.41 ng 14562:
14563: Prints a table of sample values from the upload and can make associate samples to internal names.
14564:
14565: $r is an Apache Request ref,
14566: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
14567: $d is an array of 2 element arrays (internal name, displayed name)
14568:
14569: =cut
14570:
1.144 matthew 14571: ######################################################
14572: ######################################################
1.31 albertel 14573: sub csv_samples_select_table {
14574: my ($r,$records,$d) = @_;
14575: my $i=0;
1.144 matthew 14576: #
1.662 bisitz 14577: my $max_samples = 5;
14578: my $samples = &get_samples($records,$max_samples);
1.594 raeburn 14579: $r->print(&start_data_table().
14580: &start_data_table_header_row().'<th>'.
14581: &mt('Field').'</th><th>'.&mt('Samples').'</th>'.
14582: &end_data_table_header_row());
1.301 albertel 14583:
14584: foreach my $key (sort(keys(%{ $samples->[0] }))) {
1.594 raeburn 14585: $r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
1.32 matthew 14586: ' onchange="javascript:flip(this.form,'.$i.');">');
1.301 albertel 14587: foreach my $option (@$d) {
14588: my ($value,$display,$defaultcol)=@{ $option };
1.174 matthew 14589: $r->print('<option value="'.$value.'"'.
1.253 albertel 14590: ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174 matthew 14591: $display.'</option>');
1.31 albertel 14592: }
14593: $r->print('</select></td><td>');
1.662 bisitz 14594: foreach my $line (0..($max_samples-1)) {
1.301 albertel 14595: if (defined($samples->[$line]{$key})) {
14596: $r->print($samples->[$line]{$key}."<br />\n");
14597: }
14598: }
1.594 raeburn 14599: $r->print('</td>'.&end_data_table_row());
1.31 albertel 14600: $i++;
14601: }
1.594 raeburn 14602: $r->print(&end_data_table());
1.31 albertel 14603: $i--;
14604: return($i);
1.115 matthew 14605: }
14606:
1.144 matthew 14607: ######################################################
14608: ######################################################
14609:
1.115 matthew 14610: =pod
14611:
1.648 raeburn 14612: =item * &clean_excel_name($name)
1.115 matthew 14613:
14614: Returns a replacement for $name which does not contain any illegal characters.
14615:
14616: =cut
14617:
1.144 matthew 14618: ######################################################
14619: ######################################################
1.115 matthew 14620: sub clean_excel_name {
14621: my ($name) = @_;
14622: $name =~ s/[:\*\?\/\\]//g;
14623: if (length($name) > 31) {
14624: $name = substr($name,0,31);
14625: }
14626: return $name;
1.25 albertel 14627: }
1.84 albertel 14628:
1.85 albertel 14629: =pod
14630:
1.648 raeburn 14631: =item * &check_if_partid_hidden($id,$symb,$udom,$uname)
1.85 albertel 14632:
14633: Returns either 1 or undef
14634:
14635: 1 if the part is to be hidden, undef if it is to be shown
14636:
14637: Arguments are:
14638:
14639: $id the id of the part to be checked
14640: $symb, optional the symb of the resource to check
14641: $udom, optional the domain of the user to check for
14642: $uname, optional the username of the user to check for
14643:
14644: =cut
1.84 albertel 14645:
14646: sub check_if_partid_hidden {
14647: my ($id,$symb,$udom,$uname) = @_;
1.133 albertel 14648: my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84 albertel 14649: $symb,$udom,$uname);
1.141 albertel 14650: my $truth=1;
14651: #if the string starts with !, then the list is the list to show not hide
14652: if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84 albertel 14653: my @hiddenlist=split(/,/,$hiddenparts);
14654: foreach my $checkid (@hiddenlist) {
1.141 albertel 14655: if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84 albertel 14656: }
1.141 albertel 14657: return !$truth;
1.84 albertel 14658: }
1.127 matthew 14659:
1.138 matthew 14660:
14661: ############################################################
14662: ############################################################
14663:
14664: =pod
14665:
1.157 matthew 14666: =back
14667:
1.138 matthew 14668: =head1 cgi-bin script and graphing routines
14669:
1.157 matthew 14670: =over 4
14671:
1.648 raeburn 14672: =item * &get_cgi_id()
1.138 matthew 14673:
14674: Inputs: none
14675:
14676: Returns an id which can be used to pass environment variables
14677: to various cgi-bin scripts. These environment variables will
14678: be removed from the users environment after a given time by
14679: the routine &Apache::lonnet::transfer_profile_to_env.
14680:
14681: =cut
14682:
14683: ############################################################
14684: ############################################################
1.152 albertel 14685: my $uniq=0;
1.136 matthew 14686: sub get_cgi_id {
1.154 albertel 14687: $uniq=($uniq+1)%100000;
1.280 albertel 14688: return (time.'_'.$$.'_'.$uniq);
1.136 matthew 14689: }
14690:
1.127 matthew 14691: ############################################################
14692: ############################################################
14693:
14694: =pod
14695:
1.648 raeburn 14696: =item * &DrawBarGraph()
1.127 matthew 14697:
1.138 matthew 14698: Facilitates the plotting of data in a (stacked) bar graph.
14699: Puts plot definition data into the users environment in order for
14700: graph.png to plot it. Returns an <img> tag for the plot.
14701: The bars on the plot are labeled '1','2',...,'n'.
14702:
14703: Inputs:
14704:
14705: =over 4
14706:
14707: =item $Title: string, the title of the plot
14708:
14709: =item $xlabel: string, text describing the X-axis of the plot
14710:
14711: =item $ylabel: string, text describing the Y-axis of the plot
14712:
14713: =item $Max: scalar, the maximum Y value to use in the plot
14714: If $Max is < any data point, the graph will not be rendered.
14715:
1.140 matthew 14716: =item $colors: array ref holding the colors to be used for the data sets when
1.138 matthew 14717: they are plotted. If undefined, default values will be used.
14718:
1.178 matthew 14719: =item $labels: array ref holding the labels to use on the x-axis for the bars.
14720:
1.138 matthew 14721: =item @Values: An array of array references. Each array reference holds data
14722: to be plotted in a stacked bar chart.
14723:
1.239 matthew 14724: =item If the final element of @Values is a hash reference the key/value
14725: pairs will be added to the graph definition.
14726:
1.138 matthew 14727: =back
14728:
14729: Returns:
14730:
14731: An <img> tag which references graph.png and the appropriate identifying
14732: information for the plot.
14733:
1.127 matthew 14734: =cut
14735:
14736: ############################################################
14737: ############################################################
1.134 matthew 14738: sub DrawBarGraph {
1.178 matthew 14739: my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134 matthew 14740: #
14741: if (! defined($colors)) {
14742: $colors = ['#33ff00',
14743: '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
14744: '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
14745: ];
14746: }
1.228 matthew 14747: my $extra_settings = {};
14748: if (ref($Values[-1]) eq 'HASH') {
14749: $extra_settings = pop(@Values);
14750: }
1.127 matthew 14751: #
1.136 matthew 14752: my $identifier = &get_cgi_id();
14753: my $id = 'cgi.'.$identifier;
1.129 matthew 14754: if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127 matthew 14755: return '';
14756: }
1.225 matthew 14757: #
14758: my @Labels;
14759: if (defined($labels)) {
14760: @Labels = @$labels;
14761: } else {
14762: for (my $i=0;$i<@{$Values[0]};$i++) {
1.1263 raeburn 14763: push(@Labels,$i+1);
1.225 matthew 14764: }
14765: }
14766: #
1.129 matthew 14767: my $NumBars = scalar(@{$Values[0]});
1.225 matthew 14768: if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129 matthew 14769: my %ValuesHash;
14770: my $NumSets=1;
14771: foreach my $array (@Values) {
14772: next if (! ref($array));
1.136 matthew 14773: $ValuesHash{$id.'.data.'.$NumSets++} =
1.132 matthew 14774: join(',',@$array);
1.129 matthew 14775: }
1.127 matthew 14776: #
1.136 matthew 14777: my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225 matthew 14778: if ($NumBars < 3) {
14779: $width = 120+$NumBars*32;
1.220 matthew 14780: $xskip = 1;
1.225 matthew 14781: $bar_width = 30;
14782: } elsif ($NumBars < 5) {
14783: $width = 120+$NumBars*20;
14784: $xskip = 1;
14785: $bar_width = 20;
1.220 matthew 14786: } elsif ($NumBars < 10) {
1.136 matthew 14787: $width = 120+$NumBars*15;
14788: $xskip = 1;
14789: $bar_width = 15;
14790: } elsif ($NumBars <= 25) {
14791: $width = 120+$NumBars*11;
14792: $xskip = 5;
14793: $bar_width = 8;
14794: } elsif ($NumBars <= 50) {
14795: $width = 120+$NumBars*8;
14796: $xskip = 5;
14797: $bar_width = 4;
14798: } else {
14799: $width = 120+$NumBars*8;
14800: $xskip = 5;
14801: $bar_width = 4;
14802: }
14803: #
1.137 matthew 14804: $Max = 1 if ($Max < 1);
14805: if ( int($Max) < $Max ) {
14806: $Max++;
14807: $Max = int($Max);
14808: }
1.127 matthew 14809: $Title = '' if (! defined($Title));
14810: $xlabel = '' if (! defined($xlabel));
14811: $ylabel = '' if (! defined($ylabel));
1.369 www 14812: $ValuesHash{$id.'.title'} = &escape($Title);
14813: $ValuesHash{$id.'.xlabel'} = &escape($xlabel);
14814: $ValuesHash{$id.'.ylabel'} = &escape($ylabel);
1.137 matthew 14815: $ValuesHash{$id.'.y_max_value'} = $Max;
1.136 matthew 14816: $ValuesHash{$id.'.NumBars'} = $NumBars;
14817: $ValuesHash{$id.'.NumSets'} = $NumSets;
14818: $ValuesHash{$id.'.PlotType'} = 'bar';
14819: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
14820: $ValuesHash{$id.'.height'} = $height;
14821: $ValuesHash{$id.'.width'} = $width;
14822: $ValuesHash{$id.'.xskip'} = $xskip;
14823: $ValuesHash{$id.'.bar_width'} = $bar_width;
14824: $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127 matthew 14825: #
1.228 matthew 14826: # Deal with other parameters
14827: while (my ($key,$value) = each(%$extra_settings)) {
14828: $ValuesHash{$id.'.'.$key} = $value;
14829: }
14830: #
1.646 raeburn 14831: &Apache::lonnet::appenv(\%ValuesHash);
1.137 matthew 14832: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
14833: }
14834:
14835: ############################################################
14836: ############################################################
14837:
14838: =pod
14839:
1.648 raeburn 14840: =item * &DrawXYGraph()
1.137 matthew 14841:
1.138 matthew 14842: Facilitates the plotting of data in an XY graph.
14843: Puts plot definition data into the users environment in order for
14844: graph.png to plot it. Returns an <img> tag for the plot.
14845:
14846: Inputs:
14847:
14848: =over 4
14849:
14850: =item $Title: string, the title of the plot
14851:
14852: =item $xlabel: string, text describing the X-axis of the plot
14853:
14854: =item $ylabel: string, text describing the Y-axis of the plot
14855:
14856: =item $Max: scalar, the maximum Y value to use in the plot
14857: If $Max is < any data point, the graph will not be rendered.
14858:
14859: =item $colors: Array ref containing the hex color codes for the data to be
14860: plotted in. If undefined, default values will be used.
14861:
14862: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
14863:
14864: =item $Ydata: Array ref containing Array refs.
1.185 www 14865: Each of the contained arrays will be plotted as a separate curve.
1.138 matthew 14866:
14867: =item %Values: hash indicating or overriding any default values which are
14868: passed to graph.png.
14869: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
14870:
14871: =back
14872:
14873: Returns:
14874:
14875: An <img> tag which references graph.png and the appropriate identifying
14876: information for the plot.
14877:
1.137 matthew 14878: =cut
14879:
14880: ############################################################
14881: ############################################################
14882: sub DrawXYGraph {
14883: my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
14884: #
14885: # Create the identifier for the graph
14886: my $identifier = &get_cgi_id();
14887: my $id = 'cgi.'.$identifier;
14888: #
14889: $Title = '' if (! defined($Title));
14890: $xlabel = '' if (! defined($xlabel));
14891: $ylabel = '' if (! defined($ylabel));
14892: my %ValuesHash =
14893: (
1.369 www 14894: $id.'.title' => &escape($Title),
14895: $id.'.xlabel' => &escape($xlabel),
14896: $id.'.ylabel' => &escape($ylabel),
1.137 matthew 14897: $id.'.y_max_value'=> $Max,
14898: $id.'.labels' => join(',',@$Xlabels),
14899: $id.'.PlotType' => 'XY',
14900: );
14901: #
14902: if (defined($colors) && ref($colors) eq 'ARRAY') {
14903: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
14904: }
14905: #
14906: if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
14907: return '';
14908: }
14909: my $NumSets=1;
1.138 matthew 14910: foreach my $array (@{$Ydata}){
1.137 matthew 14911: next if (! ref($array));
14912: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
14913: }
1.138 matthew 14914: $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137 matthew 14915: #
14916: # Deal with other parameters
14917: while (my ($key,$value) = each(%Values)) {
14918: $ValuesHash{$id.'.'.$key} = $value;
1.127 matthew 14919: }
14920: #
1.646 raeburn 14921: &Apache::lonnet::appenv(\%ValuesHash);
1.136 matthew 14922: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
14923: }
14924:
14925: ############################################################
14926: ############################################################
14927:
14928: =pod
14929:
1.648 raeburn 14930: =item * &DrawXYYGraph()
1.138 matthew 14931:
14932: Facilitates the plotting of data in an XY graph with two Y axes.
14933: Puts plot definition data into the users environment in order for
14934: graph.png to plot it. Returns an <img> tag for the plot.
14935:
14936: Inputs:
14937:
14938: =over 4
14939:
14940: =item $Title: string, the title of the plot
14941:
14942: =item $xlabel: string, text describing the X-axis of the plot
14943:
14944: =item $ylabel: string, text describing the Y-axis of the plot
14945:
14946: =item $colors: Array ref containing the hex color codes for the data to be
14947: plotted in. If undefined, default values will be used.
14948:
14949: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
14950:
14951: =item $Ydata1: The first data set
14952:
14953: =item $Min1: The minimum value of the left Y-axis
14954:
14955: =item $Max1: The maximum value of the left Y-axis
14956:
14957: =item $Ydata2: The second data set
14958:
14959: =item $Min2: The minimum value of the right Y-axis
14960:
14961: =item $Max2: The maximum value of the left Y-axis
14962:
14963: =item %Values: hash indicating or overriding any default values which are
14964: passed to graph.png.
14965: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
14966:
14967: =back
14968:
14969: Returns:
14970:
14971: An <img> tag which references graph.png and the appropriate identifying
14972: information for the plot.
1.136 matthew 14973:
14974: =cut
14975:
14976: ############################################################
14977: ############################################################
1.137 matthew 14978: sub DrawXYYGraph {
14979: my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
14980: $Ydata2,$Min2,$Max2,%Values)=@_;
1.136 matthew 14981: #
14982: # Create the identifier for the graph
14983: my $identifier = &get_cgi_id();
14984: my $id = 'cgi.'.$identifier;
14985: #
14986: $Title = '' if (! defined($Title));
14987: $xlabel = '' if (! defined($xlabel));
14988: $ylabel = '' if (! defined($ylabel));
14989: my %ValuesHash =
14990: (
1.369 www 14991: $id.'.title' => &escape($Title),
14992: $id.'.xlabel' => &escape($xlabel),
14993: $id.'.ylabel' => &escape($ylabel),
1.136 matthew 14994: $id.'.labels' => join(',',@$Xlabels),
14995: $id.'.PlotType' => 'XY',
14996: $id.'.NumSets' => 2,
1.137 matthew 14997: $id.'.two_axes' => 1,
14998: $id.'.y1_max_value' => $Max1,
14999: $id.'.y1_min_value' => $Min1,
15000: $id.'.y2_max_value' => $Max2,
15001: $id.'.y2_min_value' => $Min2,
1.136 matthew 15002: );
15003: #
1.137 matthew 15004: if (defined($colors) && ref($colors) eq 'ARRAY') {
15005: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
15006: }
15007: #
15008: if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
15009: ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136 matthew 15010: return '';
15011: }
15012: my $NumSets=1;
1.137 matthew 15013: foreach my $array ($Ydata1,$Ydata2){
1.136 matthew 15014: next if (! ref($array));
15015: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137 matthew 15016: }
15017: #
15018: # Deal with other parameters
15019: while (my ($key,$value) = each(%Values)) {
15020: $ValuesHash{$id.'.'.$key} = $value;
1.136 matthew 15021: }
15022: #
1.646 raeburn 15023: &Apache::lonnet::appenv(\%ValuesHash);
1.130 albertel 15024: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139 matthew 15025: }
15026:
15027: ############################################################
15028: ############################################################
15029:
15030: =pod
15031:
1.157 matthew 15032: =back
15033:
1.139 matthew 15034: =head1 Statistics helper routines?
15035:
15036: Bad place for them but what the hell.
15037:
1.157 matthew 15038: =over 4
15039:
1.648 raeburn 15040: =item * &chartlink()
1.139 matthew 15041:
15042: Returns a link to the chart for a specific student.
15043:
15044: Inputs:
15045:
15046: =over 4
15047:
15048: =item $linktext: The text of the link
15049:
15050: =item $sname: The students username
15051:
15052: =item $sdomain: The students domain
15053:
15054: =back
15055:
1.157 matthew 15056: =back
15057:
1.139 matthew 15058: =cut
15059:
15060: ############################################################
15061: ############################################################
15062: sub chartlink {
15063: my ($linktext, $sname, $sdomain) = @_;
15064: my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.369 www 15065: '&SelectedStudent='.&escape($sname.':'.$sdomain).
1.219 albertel 15066: '&chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139 matthew 15067: '">'.$linktext.'</a>';
1.153 matthew 15068: }
15069:
15070: #######################################################
15071: #######################################################
15072:
15073: =pod
15074:
15075: =head1 Course Environment Routines
1.157 matthew 15076:
15077: =over 4
1.153 matthew 15078:
1.648 raeburn 15079: =item * &restore_course_settings()
1.153 matthew 15080:
1.648 raeburn 15081: =item * &store_course_settings()
1.153 matthew 15082:
15083: Restores/Store indicated form parameters from the course environment.
15084: Will not overwrite existing values of the form parameters.
15085:
15086: Inputs:
15087: a scalar describing the data (e.g. 'chart', 'problem_analysis')
15088:
15089: a hash ref describing the data to be stored. For example:
15090:
15091: %Save_Parameters = ('Status' => 'scalar',
15092: 'chartoutputmode' => 'scalar',
15093: 'chartoutputdata' => 'scalar',
15094: 'Section' => 'array',
1.373 raeburn 15095: 'Group' => 'array',
1.153 matthew 15096: 'StudentData' => 'array',
15097: 'Maps' => 'array');
15098:
15099: Returns: both routines return nothing
15100:
1.631 raeburn 15101: =back
15102:
1.153 matthew 15103: =cut
15104:
15105: #######################################################
15106: #######################################################
15107: sub store_course_settings {
1.496 albertel 15108: return &store_settings($env{'request.course.id'},@_);
15109: }
15110:
15111: sub store_settings {
1.153 matthew 15112: # save to the environment
15113: # appenv the same items, just to be safe
1.300 albertel 15114: my $udom = $env{'user.domain'};
15115: my $uname = $env{'user.name'};
1.496 albertel 15116: my ($context,$prefix,$Settings) = @_;
1.153 matthew 15117: my %SaveHash;
15118: my %AppHash;
15119: while (my ($setting,$type) = each(%$Settings)) {
1.496 albertel 15120: my $basename = join('.','internal',$context,$prefix,$setting);
1.300 albertel 15121: my $envname = 'environment.'.$basename;
1.258 albertel 15122: if (exists($env{'form.'.$setting})) {
1.153 matthew 15123: # Save this value away
15124: if ($type eq 'scalar' &&
1.258 albertel 15125: (! exists($env{$envname}) ||
15126: $env{$envname} ne $env{'form.'.$setting})) {
15127: $SaveHash{$basename} = $env{'form.'.$setting};
15128: $AppHash{$envname} = $env{'form.'.$setting};
1.153 matthew 15129: } elsif ($type eq 'array') {
15130: my $stored_form;
1.258 albertel 15131: if (ref($env{'form.'.$setting})) {
1.153 matthew 15132: $stored_form = join(',',
15133: map {
1.369 www 15134: &escape($_);
1.258 albertel 15135: } sort(@{$env{'form.'.$setting}}));
1.153 matthew 15136: } else {
15137: $stored_form =
1.369 www 15138: &escape($env{'form.'.$setting});
1.153 matthew 15139: }
15140: # Determine if the array contents are the same.
1.258 albertel 15141: if ($stored_form ne $env{$envname}) {
1.153 matthew 15142: $SaveHash{$basename} = $stored_form;
15143: $AppHash{$envname} = $stored_form;
15144: }
15145: }
15146: }
15147: }
15148: my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
1.300 albertel 15149: $udom,$uname);
1.153 matthew 15150: if ($put_result !~ /^(ok|delayed)/) {
15151: &Apache::lonnet::logthis('unable to save form parameters, '.
15152: 'got error:'.$put_result);
15153: }
15154: # Make sure these settings stick around in this session, too
1.646 raeburn 15155: &Apache::lonnet::appenv(\%AppHash);
1.153 matthew 15156: return;
15157: }
15158:
15159: sub restore_course_settings {
1.499 albertel 15160: return &restore_settings($env{'request.course.id'},@_);
1.496 albertel 15161: }
15162:
15163: sub restore_settings {
15164: my ($context,$prefix,$Settings) = @_;
1.153 matthew 15165: while (my ($setting,$type) = each(%$Settings)) {
1.258 albertel 15166: next if (exists($env{'form.'.$setting}));
1.496 albertel 15167: my $envname = 'environment.internal.'.$context.'.'.$prefix.
1.153 matthew 15168: '.'.$setting;
1.258 albertel 15169: if (exists($env{$envname})) {
1.153 matthew 15170: if ($type eq 'scalar') {
1.258 albertel 15171: $env{'form.'.$setting} = $env{$envname};
1.153 matthew 15172: } elsif ($type eq 'array') {
1.258 albertel 15173: $env{'form.'.$setting} = [
1.153 matthew 15174: map {
1.369 www 15175: &unescape($_);
1.258 albertel 15176: } split(',',$env{$envname})
1.153 matthew 15177: ];
15178: }
15179: }
15180: }
1.127 matthew 15181: }
15182:
1.618 raeburn 15183: #######################################################
15184: #######################################################
15185:
15186: =pod
15187:
15188: =head1 Domain E-mail Routines
15189:
15190: =over 4
15191:
1.648 raeburn 15192: =item * &build_recipient_list()
1.618 raeburn 15193:
1.1144 raeburn 15194: Build recipient lists for following types of e-mail:
1.766 raeburn 15195: (a) Error Reports, (b) Package Updates, (c) lonstatus warnings/errors
1.1144 raeburn 15196: (d) Help requests, (e) Course requests needing approval, (f) loncapa
15197: module change checking, student/employee ID conflict checks, as
15198: generated by lonerrorhandler.pm, CHECKRPMS, loncron,
15199: lonsupportreq.pm, loncoursequeueadmin.pm, searchcat.pl respectively.
1.618 raeburn 15200:
15201: Inputs:
1.619 raeburn 15202: defmail (scalar - email address of default recipient),
1.1144 raeburn 15203: mailing type (scalar: errormail, packagesmail, helpdeskmail,
15204: requestsmail, updatesmail, or idconflictsmail).
15205:
1.619 raeburn 15206: defdom (domain for which to retrieve configuration settings),
1.1144 raeburn 15207:
1.619 raeburn 15208: origmail (scalar - email address of recipient from loncapa.conf,
1.1297 raeburn 15209: i.e., predates configuration by DC via domainprefs.pm
15210:
15211: $requname username of requester (if mailing type is helpdeskmail)
15212:
15213: $requdom domain of requester (if mailing type is helpdeskmail)
15214:
15215: $reqemail e-mail address of requester (if mailing type is helpdeskmail)
15216:
1.618 raeburn 15217:
1.655 raeburn 15218: Returns: comma separated list of addresses to which to send e-mail.
15219:
15220: =back
1.618 raeburn 15221:
15222: =cut
15223:
15224: ############################################################
15225: ############################################################
15226: sub build_recipient_list {
1.1297 raeburn 15227: my ($defmail,$mailing,$defdom,$origmail,$requname,$requdom,$reqemail) = @_;
1.618 raeburn 15228: my @recipients;
1.1270 raeburn 15229: my ($otheremails,$lastresort,$allbcc,$addtext);
1.618 raeburn 15230: my %domconfig =
1.1270 raeburn 15231: &Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
1.618 raeburn 15232: if (ref($domconfig{'contacts'}) eq 'HASH') {
1.766 raeburn 15233: if (exists($domconfig{'contacts'}{$mailing})) {
15234: if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
15235: my @contacts = ('adminemail','supportemail');
15236: foreach my $item (@contacts) {
15237: if ($domconfig{'contacts'}{$mailing}{$item}) {
15238: my $addr = $domconfig{'contacts'}{$item};
15239: if (!grep(/^\Q$addr\E$/,@recipients)) {
15240: push(@recipients,$addr);
15241: }
1.619 raeburn 15242: }
1.1270 raeburn 15243: }
15244: $otheremails = $domconfig{'contacts'}{$mailing}{'others'};
15245: if ($mailing eq 'helpdeskmail') {
15246: if ($domconfig{'contacts'}{$mailing}{'bcc'}) {
15247: my @bccs = split(/,/,$domconfig{'contacts'}{$mailing}{'bcc'});
15248: my @ok_bccs;
15249: foreach my $bcc (@bccs) {
15250: $bcc =~ s/^\s+//g;
15251: $bcc =~ s/\s+$//g;
15252: if ($bcc =~ m/^[^\@]+\@[^\@]+$/) {
15253: if (!(grep(/^\Q$bcc\E$/,@ok_bccs))) {
15254: push(@ok_bccs,$bcc);
15255: }
15256: }
15257: }
15258: if (@ok_bccs > 0) {
15259: $allbcc = join(', ',@ok_bccs);
15260: }
15261: }
15262: $addtext = $domconfig{'contacts'}{$mailing}{'include'};
1.618 raeburn 15263: }
15264: }
1.766 raeburn 15265: } elsif ($origmail ne '') {
1.1270 raeburn 15266: $lastresort = $origmail;
1.618 raeburn 15267: }
1.1297 raeburn 15268: if ($mailing eq 'helpdeskmail') {
15269: if ((ref($domconfig{'contacts'}{'overrides'}) eq 'HASH') &&
15270: (keys(%{$domconfig{'contacts'}{'overrides'}}))) {
15271: my ($inststatus,$inststatus_checked);
15272: if (($env{'user.name'} ne '') && ($env{'user.domain'} ne '') &&
15273: ($env{'user.domain'} ne 'public')) {
15274: $inststatus_checked = 1;
15275: $inststatus = $env{'environment.inststatus'};
15276: }
15277: unless ($inststatus_checked) {
15278: if (($requname ne '') && ($requdom ne '')) {
15279: if (($requname =~ /^$match_username$/) &&
15280: ($requdom =~ /^$match_domain$/) &&
15281: (&Apache::lonnet::domain($requdom))) {
15282: my $requhome = &Apache::lonnet::homeserver($requname,
15283: $requdom);
15284: unless ($requhome eq 'no_host') {
15285: my %userenv = &Apache::lonnet::userenvironment($requdom,$requname,'inststatus');
15286: $inststatus = $userenv{'inststatus'};
15287: $inststatus_checked = 1;
15288: }
15289: }
15290: }
15291: }
15292: unless ($inststatus_checked) {
15293: if ($reqemail =~ /^[^\@]+\@[^\@]+$/) {
15294: my %srch = (srchby => 'email',
15295: srchdomain => $defdom,
15296: srchterm => $reqemail,
15297: srchtype => 'exact');
15298: my %srch_results = &Apache::lonnet::usersearch(\%srch);
15299: foreach my $uname (keys(%srch_results)) {
15300: if (ref($srch_results{$uname}{'inststatus'}) eq 'ARRAY') {
15301: $inststatus = join(',',@{$srch_results{$uname}{'inststatus'}});
15302: $inststatus_checked = 1;
15303: last;
15304: }
15305: }
15306: unless ($inststatus_checked) {
15307: my ($dirsrchres,%srch_results) = &Apache::lonnet::inst_directory_query(\%srch);
15308: if ($dirsrchres eq 'ok') {
15309: foreach my $uname (keys(%srch_results)) {
15310: if (ref($srch_results{$uname}{'inststatus'}) eq 'ARRAY') {
15311: $inststatus = join(',',@{$srch_results{$uname}{'inststatus'}});
15312: $inststatus_checked = 1;
15313: last;
15314: }
15315: }
15316: }
15317: }
15318: }
15319: }
15320: if ($inststatus ne '') {
15321: foreach my $status (split(/\:/,$inststatus)) {
15322: if (ref($domconfig{'contacts'}{'overrides'}{$status}) eq 'HASH') {
15323: my @contacts = ('adminemail','supportemail');
15324: foreach my $item (@contacts) {
15325: if ($domconfig{'contacts'}{'overrides'}{$status}{$item}) {
15326: my $addr = $domconfig{'contacts'}{'overrides'}{$status};
15327: if (!grep(/^\Q$addr\E$/,@recipients)) {
15328: push(@recipients,$addr);
15329: }
15330: }
15331: }
15332: $otheremails = $domconfig{'contacts'}{'overrides'}{$status}{'others'};
15333: if ($domconfig{'contacts'}{'overrides'}{$status}{'bcc'}) {
15334: my @bccs = split(/,/,$domconfig{'contacts'}{'overrides'}{$status}{'bcc'});
15335: my @ok_bccs;
15336: foreach my $bcc (@bccs) {
15337: $bcc =~ s/^\s+//g;
15338: $bcc =~ s/\s+$//g;
15339: if ($bcc =~ m/^[^\@]+\@[^\@]+$/) {
15340: if (!(grep(/^\Q$bcc\E$/,@ok_bccs))) {
15341: push(@ok_bccs,$bcc);
15342: }
15343: }
15344: }
15345: if (@ok_bccs > 0) {
15346: $allbcc = join(', ',@ok_bccs);
15347: }
15348: }
15349: $addtext = $domconfig{'contacts'}{'overrides'}{$status}{'include'};
15350: last;
15351: }
15352: }
15353: }
15354: }
15355: }
1.619 raeburn 15356: } elsif ($origmail ne '') {
1.1270 raeburn 15357: $lastresort = $origmail;
15358: }
1.1297 raeburn 15359: if (($mailing eq 'helpdeskmail') && ($lastresort ne '')) {
1.1270 raeburn 15360: unless (grep(/^\Q$defdom\E$/,&Apache::lonnet::current_machine_domains())) {
15361: my $lonhost = $Apache::lonnet::perlvar{'lonHostID'};
15362: my $machinedom = $Apache::lonnet::perlvar{'lonDefDomain'};
15363: my %what = (
15364: perlvar => 1,
15365: );
15366: my $primary = &Apache::lonnet::domain($defdom,'primary');
15367: if ($primary) {
15368: my $gotaddr;
15369: my ($result,$returnhash) =
15370: &Apache::lonnet::get_remote_globals($primary,{ perlvar => 1 });
15371: if (($result eq 'ok') && (ref($returnhash) eq 'HASH')) {
15372: if ($returnhash->{'lonSupportEMail'} =~ /^[^\@]+\@[^\@]+$/) {
15373: $lastresort = $returnhash->{'lonSupportEMail'};
15374: $gotaddr = 1;
15375: }
15376: }
15377: unless ($gotaddr) {
15378: my $uintdom = &Apache::lonnet::internet_dom($primary);
15379: my $intdom = &Apache::lonnet::internet_dom($lonhost);
15380: unless ($uintdom eq $intdom) {
15381: my %domconfig =
15382: &Apache::lonnet::get_dom('configuration',['contacts'],$machinedom);
15383: if (ref($domconfig{'contacts'}) eq 'HASH') {
15384: if (ref($domconfig{'contacts'}{'otherdomsmail'}) eq 'HASH') {
15385: my @contacts = ('adminemail','supportemail');
15386: foreach my $item (@contacts) {
15387: if ($domconfig{'contacts'}{'otherdomsmail'}{$item}) {
15388: my $addr = $domconfig{'contacts'}{$item};
15389: if (!grep(/^\Q$addr\E$/,@recipients)) {
15390: push(@recipients,$addr);
15391: }
15392: }
15393: }
15394: if ($domconfig{'contacts'}{'otherdomsmail'}{'others'}) {
15395: $otheremails = $domconfig{'contacts'}{'otherdomsmail'}{'others'};
15396: }
15397: if ($domconfig{'contacts'}{'otherdomsmail'}{'bcc'}) {
15398: my @bccs = split(/,/,$domconfig{'contacts'}{'otherdomsmail'}{'bcc'});
15399: my @ok_bccs;
15400: foreach my $bcc (@bccs) {
15401: $bcc =~ s/^\s+//g;
15402: $bcc =~ s/\s+$//g;
15403: if ($bcc =~ m/^[^\@]+\@[^\@]+$/) {
15404: if (!(grep(/^\Q$bcc\E$/,@ok_bccs))) {
15405: push(@ok_bccs,$bcc);
15406: }
15407: }
15408: }
15409: if (@ok_bccs > 0) {
15410: $allbcc = join(', ',@ok_bccs);
15411: }
15412: }
15413: $addtext = $domconfig{'contacts'}{'otherdomsmail'}{'include'};
15414: }
15415: }
15416: }
15417: }
15418: }
15419: }
1.618 raeburn 15420: }
1.688 raeburn 15421: if (defined($defmail)) {
15422: if ($defmail ne '') {
15423: push(@recipients,$defmail);
15424: }
1.618 raeburn 15425: }
15426: if ($otheremails) {
1.619 raeburn 15427: my @others;
15428: if ($otheremails =~ /,/) {
15429: @others = split(/,/,$otheremails);
1.618 raeburn 15430: } else {
1.619 raeburn 15431: push(@others,$otheremails);
15432: }
15433: foreach my $addr (@others) {
15434: if (!grep(/^\Q$addr\E$/,@recipients)) {
15435: push(@recipients,$addr);
15436: }
1.618 raeburn 15437: }
15438: }
1.1298 raeburn 15439: if ($mailing eq 'helpdeskmail') {
1.1270 raeburn 15440: if ((!@recipients) && ($lastresort ne '')) {
15441: push(@recipients,$lastresort);
15442: }
15443: } elsif ($lastresort ne '') {
15444: if (!grep(/^\Q$lastresort\E$/,@recipients)) {
15445: push(@recipients,$lastresort);
15446: }
15447: }
1.1271 raeburn 15448: my $recipientlist = join(',',@recipients);
1.1270 raeburn 15449: if (wantarray) {
15450: return ($recipientlist,$allbcc,$addtext);
15451: } else {
15452: return $recipientlist;
15453: }
1.618 raeburn 15454: }
15455:
1.127 matthew 15456: ############################################################
15457: ############################################################
1.154 albertel 15458:
1.655 raeburn 15459: =pod
15460:
1.1224 musolffc 15461: =over 4
15462:
1.1223 musolffc 15463: =item * &mime_email()
15464:
15465: Sends an email with a possible attachment
15466:
15467: Inputs:
15468:
15469: =over 4
15470:
15471: from - Sender's email address
15472:
1.1343 raeburn 15473: replyto - Reply-To email address
15474:
1.1223 musolffc 15475: to - Email address of recipient
15476:
15477: subject - Subject of email
15478:
15479: body - Body of email
15480:
15481: cc_string - Carbon copy email address
15482:
15483: bcc - Blind carbon copy email address
15484:
15485: attachment_path - Path of file to be attached
15486:
15487: file_name - Name of file to be attached
15488:
15489: attachment_text - The body of an attachment of type "TEXT"
15490:
15491: =back
15492:
15493: =back
15494:
15495: =cut
15496:
15497: ############################################################
15498: ############################################################
15499:
15500: sub mime_email {
1.1343 raeburn 15501: my ($from,$replyto,$to,$subject,$body,$cc_string,$bcc,$attachment_path,
15502: $file_name,$attachment_text) = @_;
15503:
1.1223 musolffc 15504: my $msg = MIME::Lite->new(
15505: From => $from,
15506: To => $to,
15507: Subject => $subject,
15508: Type =>'TEXT',
15509: Data => $body,
15510: );
1.1343 raeburn 15511: if ($replyto ne '') {
15512: $msg->add("Reply-To" => $replyto);
15513: }
1.1223 musolffc 15514: if ($cc_string ne '') {
15515: $msg->add("Cc" => $cc_string);
15516: }
15517: if ($bcc ne '') {
15518: $msg->add("Bcc" => $bcc);
15519: }
15520: $msg->attr("content-type" => "text/plain");
15521: $msg->attr("content-type.charset" => "UTF-8");
15522: # Attach file if given
15523: if ($attachment_path) {
15524: unless ($file_name) {
15525: if ($attachment_path =~ m-/([^/]+)$-) { $file_name = $1; }
15526: }
15527: my ($type, $encoding) = MIME::Types::by_suffix($attachment_path);
15528: $msg->attach(Type => $type,
15529: Path => $attachment_path,
15530: Filename => $file_name
15531: );
15532: # Otherwise attach text if given
15533: } elsif ($attachment_text) {
15534: $msg->attach(Type => 'TEXT',
15535: Data => $attachment_text);
15536: }
15537: # Send it
15538: $msg->send('sendmail');
15539: }
15540:
15541: ############################################################
15542: ############################################################
15543:
15544: =pod
15545:
1.655 raeburn 15546: =head1 Course Catalog Routines
15547:
15548: =over 4
15549:
15550: =item * &gather_categories()
15551:
15552: Converts category definitions - keys of categories hash stored in
15553: coursecategories in configuration.db on the primary library server in a
15554: domain - to an array. Also generates javascript and idx hash used to
15555: generate Domain Coordinator interface for editing Course Categories.
15556:
15557: Inputs:
1.663 raeburn 15558:
1.655 raeburn 15559: categories (reference to hash of category definitions).
1.663 raeburn 15560:
1.655 raeburn 15561: cats (reference to array of arrays/hashes which encapsulates hierarchy of
15562: categories and subcategories).
1.663 raeburn 15563:
1.655 raeburn 15564: idx (reference to hash of counters used in Domain Coordinator interface for
15565: editing Course Categories).
1.663 raeburn 15566:
1.655 raeburn 15567: jsarray (reference to array of categories used to create Javascript arrays for
15568: Domain Coordinator interface for editing Course Categories).
15569:
15570: Returns: nothing
15571:
15572: Side effects: populates cats, idx and jsarray.
15573:
15574: =cut
15575:
15576: sub gather_categories {
15577: my ($categories,$cats,$idx,$jsarray) = @_;
15578: my %counters;
15579: my $num = 0;
15580: foreach my $item (keys(%{$categories})) {
15581: my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item);
15582: if ($container eq '' && $depth == 0) {
15583: $cats->[$depth][$categories->{$item}] = $cat;
15584: } else {
15585: $cats->[$depth]{$container}[$categories->{$item}] = $cat;
15586: }
15587: my ($escitem,$tail) = split(/:/,$item,2);
15588: if ($counters{$tail} eq '') {
15589: $counters{$tail} = $num;
15590: $num ++;
15591: }
15592: if (ref($idx) eq 'HASH') {
15593: $idx->{$item} = $counters{$tail};
15594: }
15595: if (ref($jsarray) eq 'ARRAY') {
15596: push(@{$jsarray->[$counters{$tail}]},$item);
15597: }
15598: }
15599: return;
15600: }
15601:
15602: =pod
15603:
15604: =item * &extract_categories()
15605:
15606: Used to generate breadcrumb trails for course categories.
15607:
15608: Inputs:
1.663 raeburn 15609:
1.655 raeburn 15610: categories (reference to hash of category definitions).
1.663 raeburn 15611:
1.655 raeburn 15612: cats (reference to array of arrays/hashes which encapsulates hierarchy of
15613: categories and subcategories).
1.663 raeburn 15614:
1.655 raeburn 15615: trails (reference to array of breacrumb trails for each category).
1.663 raeburn 15616:
1.655 raeburn 15617: allitems (reference to hash - key is category key
15618: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 15619:
1.655 raeburn 15620: idx (reference to hash of counters used in Domain Coordinator interface for
15621: editing Course Categories).
1.663 raeburn 15622:
1.655 raeburn 15623: jsarray (reference to array of categories used to create Javascript arrays for
15624: Domain Coordinator interface for editing Course Categories).
15625:
1.665 raeburn 15626: subcats (reference to hash of arrays containing all subcategories within each
15627: category, -recursive)
15628:
1.1321 raeburn 15629: maxd (reference to hash used to hold max depth for all top-level categories).
15630:
1.655 raeburn 15631: Returns: nothing
15632:
15633: Side effects: populates trails and allitems hash references.
15634:
15635: =cut
15636:
15637: sub extract_categories {
1.1321 raeburn 15638: my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats,$maxd) = @_;
1.655 raeburn 15639: if (ref($categories) eq 'HASH') {
15640: &gather_categories($categories,$cats,$idx,$jsarray);
15641: if (ref($cats->[0]) eq 'ARRAY') {
15642: for (my $i=0; $i<@{$cats->[0]}; $i++) {
15643: my $name = $cats->[0][$i];
15644: my $item = &escape($name).'::0';
15645: my $trailstr;
15646: if ($name eq 'instcode') {
15647: $trailstr = &mt('Official courses (with institutional codes)');
1.919 raeburn 15648: } elsif ($name eq 'communities') {
15649: $trailstr = &mt('Communities');
1.1239 raeburn 15650: } elsif ($name eq 'placement') {
15651: $trailstr = &mt('Placement Tests');
1.655 raeburn 15652: } else {
15653: $trailstr = $name;
15654: }
15655: if ($allitems->{$item} eq '') {
15656: push(@{$trails},$trailstr);
15657: $allitems->{$item} = scalar(@{$trails})-1;
15658: }
15659: my @parents = ($name);
15660: if (ref($cats->[1]{$name}) eq 'ARRAY') {
15661: for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) {
15662: my $category = $cats->[1]{$name}[$j];
1.665 raeburn 15663: if (ref($subcats) eq 'HASH') {
15664: push(@{$subcats->{$item}},&escape($category).':'.&escape($name).':1');
15665: }
1.1321 raeburn 15666: &recurse_categories($cats,2,$category,$trails,$allitems,\@parents,$subcats,$maxd);
1.665 raeburn 15667: }
15668: } else {
15669: if (ref($subcats) eq 'HASH') {
15670: $subcats->{$item} = [];
1.655 raeburn 15671: }
1.1321 raeburn 15672: if (ref($maxd) eq 'HASH') {
15673: $maxd->{$name} = 1;
15674: }
1.655 raeburn 15675: }
15676: }
15677: }
15678: }
15679: return;
15680: }
15681:
15682: =pod
15683:
1.1162 raeburn 15684: =item * &recurse_categories()
1.655 raeburn 15685:
15686: Recursively used to generate breadcrumb trails for course categories.
15687:
15688: Inputs:
1.663 raeburn 15689:
1.655 raeburn 15690: cats (reference to array of arrays/hashes which encapsulates hierarchy of
15691: categories and subcategories).
1.663 raeburn 15692:
1.655 raeburn 15693: depth (current depth in hierarchy of categories and sub-categories - 0 indexed).
1.663 raeburn 15694:
15695: category (current course category, for which breadcrumb trail is being generated).
15696:
15697: trails (reference to array of breadcrumb trails for each category).
15698:
1.655 raeburn 15699: allitems (reference to hash - key is category key
15700: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 15701:
1.655 raeburn 15702: parents (array containing containers directories for current category,
15703: back to top level).
15704:
15705: Returns: nothing
15706:
15707: Side effects: populates trails and allitems hash references
15708:
15709: =cut
15710:
15711: sub recurse_categories {
1.1321 raeburn 15712: my ($cats,$depth,$category,$trails,$allitems,$parents,$subcats,$maxd) = @_;
1.655 raeburn 15713: my $shallower = $depth - 1;
15714: if (ref($cats->[$depth]{$category}) eq 'ARRAY') {
15715: for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) {
15716: my $name = $cats->[$depth]{$category}[$k];
15717: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
1.1321 raeburn 15718: my $trailstr = join(' » ',(@{$parents},$category));
1.655 raeburn 15719: if ($allitems->{$item} eq '') {
15720: push(@{$trails},$trailstr);
15721: $allitems->{$item} = scalar(@{$trails})-1;
15722: }
15723: my $deeper = $depth+1;
15724: push(@{$parents},$category);
1.665 raeburn 15725: if (ref($subcats) eq 'HASH') {
15726: my $subcat = &escape($name).':'.$category.':'.$depth;
15727: for (my $j=@{$parents}; $j>=0; $j--) {
15728: my $higher;
15729: if ($j > 0) {
15730: $higher = &escape($parents->[$j]).':'.
15731: &escape($parents->[$j-1]).':'.$j;
15732: } else {
15733: $higher = &escape($parents->[$j]).'::'.$j;
15734: }
15735: push(@{$subcats->{$higher}},$subcat);
15736: }
15737: }
15738: &recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents,
1.1321 raeburn 15739: $subcats,$maxd);
1.655 raeburn 15740: pop(@{$parents});
15741: }
15742: } else {
15743: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
1.1321 raeburn 15744: my $trailstr = join(' » ',(@{$parents},$category));
1.655 raeburn 15745: if ($allitems->{$item} eq '') {
15746: push(@{$trails},$trailstr);
15747: $allitems->{$item} = scalar(@{$trails})-1;
15748: }
1.1321 raeburn 15749: if (ref($maxd) eq 'HASH') {
15750: if ($depth > $maxd->{$parents->[0]}) {
15751: $maxd->{$parents->[0]} = $depth;
15752: }
15753: }
1.655 raeburn 15754: }
15755: return;
15756: }
15757:
1.663 raeburn 15758: =pod
15759:
1.1162 raeburn 15760: =item * &assign_categories_table()
1.663 raeburn 15761:
15762: Create a datatable for display of hierarchical categories in a domain,
15763: with checkboxes to allow a course to be categorized.
15764:
15765: Inputs:
15766:
15767: cathash - reference to hash of categories defined for the domain (from
15768: configuration.db)
15769:
15770: currcat - scalar with an & separated list of categories assigned to a course.
15771:
1.919 raeburn 15772: type - scalar contains course type (Course or Community).
15773:
1.1260 raeburn 15774: disabled - scalar (optional) contains disabled="disabled" if input elements are
15775: to be readonly (e.g., Domain Helpdesk role viewing course settings).
15776:
1.663 raeburn 15777: Returns: $output (markup to be displayed)
15778:
15779: =cut
15780:
15781: sub assign_categories_table {
1.1259 raeburn 15782: my ($cathash,$currcat,$type,$disabled) = @_;
1.663 raeburn 15783: my $output;
15784: if (ref($cathash) eq 'HASH') {
1.1321 raeburn 15785: my (@cats,@trails,%allitems,%idx,@jsarray,%maxd,@path,$maxdepth);
15786: &extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray,\%maxd);
1.663 raeburn 15787: $maxdepth = scalar(@cats);
15788: if (@cats > 0) {
15789: my $itemcount = 0;
15790: if (ref($cats[0]) eq 'ARRAY') {
15791: my @currcategories;
15792: if ($currcat ne '') {
15793: @currcategories = split('&',$currcat);
15794: }
1.919 raeburn 15795: my $table;
1.663 raeburn 15796: for (my $i=0; $i<@{$cats[0]}; $i++) {
15797: my $parent = $cats[0][$i];
1.919 raeburn 15798: next if ($parent eq 'instcode');
15799: if ($type eq 'Community') {
15800: next unless ($parent eq 'communities');
1.1239 raeburn 15801: } elsif ($type eq 'Placement') {
15802: next unless ($parent eq 'placement');
1.919 raeburn 15803: } else {
1.1239 raeburn 15804: next if (($parent eq 'communities') || ($parent eq 'placement'));
1.919 raeburn 15805: }
1.663 raeburn 15806: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
15807: my $item = &escape($parent).'::0';
15808: my $checked = '';
15809: if (@currcategories > 0) {
15810: if (grep(/^\Q$item\E$/,@currcategories)) {
1.772 bisitz 15811: $checked = ' checked="checked"';
1.663 raeburn 15812: }
15813: }
1.919 raeburn 15814: my $parent_title = $parent;
15815: if ($parent eq 'communities') {
15816: $parent_title = &mt('Communities');
1.1239 raeburn 15817: } elsif ($parent eq 'placement') {
15818: $parent_title = &mt('Placement Tests');
1.919 raeburn 15819: }
15820: $table .= '<tr '.$css_class.'><td><span class="LC_nobreak">'.
15821: '<input type="checkbox" name="usecategory" value="'.
1.1259 raeburn 15822: $item.'"'.$checked.$disabled.' />'.$parent_title.'</span>'.
1.919 raeburn 15823: '<input type="hidden" name="catname" value="'.$parent.'" /></td>';
1.663 raeburn 15824: my $depth = 1;
15825: push(@path,$parent);
1.1259 raeburn 15826: $table .= &assign_category_rows($itemcount,\@cats,$depth,$parent,\@path,\@currcategories,$disabled);
1.663 raeburn 15827: pop(@path);
1.919 raeburn 15828: $table .= '</tr><tr><td colspan="'.$maxdepth.'" class="LC_row_separator"></td></tr>';
1.663 raeburn 15829: $itemcount ++;
15830: }
1.919 raeburn 15831: if ($itemcount) {
15832: $output = &Apache::loncommon::start_data_table().
15833: $table.
15834: &Apache::loncommon::end_data_table();
15835: }
1.663 raeburn 15836: }
15837: }
15838: }
15839: return $output;
15840: }
15841:
15842: =pod
15843:
1.1162 raeburn 15844: =item * &assign_category_rows()
1.663 raeburn 15845:
15846: Create a datatable row for display of nested categories in a domain,
15847: with checkboxes to allow a course to be categorized,called recursively.
15848:
15849: Inputs:
15850:
15851: itemcount - track row number for alternating colors
15852:
15853: cats - reference to array of arrays/hashes which encapsulates hierarchy of
15854: categories and subcategories.
15855:
15856: depth - current depth in hierarchy of categories and sub-categories - 0 indexed.
15857:
15858: parent - parent of current category item
15859:
15860: path - Array containing all categories back up through the hierarchy from the
15861: current category to the top level.
15862:
15863: currcategories - reference to array of current categories assigned to the course
15864:
1.1260 raeburn 15865: disabled - scalar (optional) contains disabled="disabled" if input elements are
15866: to be readonly (e.g., Domain Helpdesk role viewing course settings).
15867:
1.663 raeburn 15868: Returns: $output (markup to be displayed).
15869:
15870: =cut
15871:
15872: sub assign_category_rows {
1.1259 raeburn 15873: my ($itemcount,$cats,$depth,$parent,$path,$currcategories,$disabled) = @_;
1.663 raeburn 15874: my ($text,$name,$item,$chgstr);
15875: if (ref($cats) eq 'ARRAY') {
15876: my $maxdepth = scalar(@{$cats});
15877: if (ref($cats->[$depth]) eq 'HASH') {
15878: if (ref($cats->[$depth]{$parent}) eq 'ARRAY') {
15879: my $numchildren = @{$cats->[$depth]{$parent}};
15880: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
1.1145 raeburn 15881: $text .= '<td><table class="LC_data_table">';
1.663 raeburn 15882: for (my $j=0; $j<$numchildren; $j++) {
15883: $name = $cats->[$depth]{$parent}[$j];
15884: $item = &escape($name).':'.&escape($parent).':'.$depth;
15885: my $deeper = $depth+1;
15886: my $checked = '';
15887: if (ref($currcategories) eq 'ARRAY') {
15888: if (@{$currcategories} > 0) {
15889: if (grep(/^\Q$item\E$/,@{$currcategories})) {
1.772 bisitz 15890: $checked = ' checked="checked"';
1.663 raeburn 15891: }
15892: }
15893: }
1.664 raeburn 15894: $text .= '<tr><td><span class="LC_nobreak"><label>'.
15895: '<input type="checkbox" name="usecategory" value="'.
1.1259 raeburn 15896: $item.'"'.$checked.$disabled.' />'.$name.'</label></span>'.
1.675 raeburn 15897: '<input type="hidden" name="catname" value="'.$name.'" />'.
15898: '</td><td>';
1.663 raeburn 15899: if (ref($path) eq 'ARRAY') {
15900: push(@{$path},$name);
1.1259 raeburn 15901: $text .= &assign_category_rows($itemcount,$cats,$deeper,$name,$path,$currcategories,$disabled);
1.663 raeburn 15902: pop(@{$path});
15903: }
15904: $text .= '</td></tr>';
15905: }
15906: $text .= '</table></td>';
15907: }
15908: }
15909: }
15910: return $text;
15911: }
15912:
1.1181 raeburn 15913: =pod
15914:
15915: =back
15916:
15917: =cut
15918:
1.655 raeburn 15919: ############################################################
15920: ############################################################
15921:
15922:
1.443 albertel 15923: sub commit_customrole {
1.664 raeburn 15924: my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context) = @_;
1.630 raeburn 15925: my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
1.443 albertel 15926: ($start?', '.&mt('starting').' '.localtime($start):'').
15927: ($end?', ending '.localtime($end):'').': <b>'.
15928: &Apache::lonnet::assigncustomrole(
1.664 raeburn 15929: $udom,$uname,$url,$three,$four,$five,$end,$start,undef,undef,$context).
1.443 albertel 15930: '</b><br />';
15931: return $output;
15932: }
15933:
15934: sub commit_standardrole {
1.1116 raeburn 15935: my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context,$credits) = @_;
1.541 raeburn 15936: my ($output,$logmsg,$linefeed);
15937: if ($context eq 'auto') {
15938: $linefeed = "\n";
15939: } else {
15940: $linefeed = "<br />\n";
15941: }
1.443 albertel 15942: if ($three eq 'st') {
1.541 raeburn 15943: my $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
1.1116 raeburn 15944: $one,$two,$sec,$context,$credits);
1.541 raeburn 15945: if (($result =~ /^error/) || ($result eq 'not_in_class') ||
1.626 raeburn 15946: ($result eq 'unknown_course') || ($result eq 'refused')) {
15947: $output = $logmsg.' '.&mt('Error: ').$result."\n";
1.443 albertel 15948: } else {
1.541 raeburn 15949: $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
1.443 albertel 15950: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 15951: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
15952: if ($context eq 'auto') {
15953: $output .= $result.$linefeed.&mt('Add to classlist').': ok';
15954: } else {
15955: $output .= '<b>'.$result.'</b>'.$linefeed.
15956: &mt('Add to classlist').': <b>ok</b>';
15957: }
15958: $output .= $linefeed;
1.443 albertel 15959: }
15960: } else {
15961: $output = &mt('Assigning').' '.$three.' in '.$url.
15962: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 15963: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
1.652 raeburn 15964: my $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,'','',$context);
1.541 raeburn 15965: if ($context eq 'auto') {
15966: $output .= $result.$linefeed;
15967: } else {
15968: $output .= '<b>'.$result.'</b>'.$linefeed;
15969: }
1.443 albertel 15970: }
15971: return $output;
15972: }
15973:
15974: sub commit_studentrole {
1.1116 raeburn 15975: my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context,
15976: $credits) = @_;
1.626 raeburn 15977: my ($result,$linefeed,$oldsecurl,$newsecurl);
1.541 raeburn 15978: if ($context eq 'auto') {
15979: $linefeed = "\n";
15980: } else {
15981: $linefeed = '<br />'."\n";
15982: }
1.443 albertel 15983: if (defined($one) && defined($two)) {
15984: my $cid=$one.'_'.$two;
15985: my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
15986: my $secchange = 0;
15987: my $expire_role_result;
15988: my $modify_section_result;
1.628 raeburn 15989: if ($oldsec ne '-1') {
15990: if ($oldsec ne $sec) {
1.443 albertel 15991: $secchange = 1;
1.628 raeburn 15992: my $now = time;
1.443 albertel 15993: my $uurl='/'.$cid;
15994: $uurl=~s/\_/\//g;
15995: if ($oldsec) {
15996: $uurl.='/'.$oldsec;
15997: }
1.626 raeburn 15998: $oldsecurl = $uurl;
1.628 raeburn 15999: $expire_role_result =
1.652 raeburn 16000: &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,'','',$context);
1.628 raeburn 16001: if ($env{'request.course.sec'} ne '') {
16002: if ($expire_role_result eq 'refused') {
16003: my @roles = ('st');
16004: my @statuses = ('previous');
16005: my @roledoms = ($one);
16006: my $withsec = 1;
16007: my %roleshash =
16008: &Apache::lonnet::get_my_roles($uname,$udom,'userroles',
16009: \@statuses,\@roles,\@roledoms,$withsec);
16010: if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
16011: my ($oldstart,$oldend) =
16012: split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
16013: if ($oldend > 0 && $oldend <= $now) {
16014: $expire_role_result = 'ok';
16015: }
16016: }
16017: }
16018: }
1.443 albertel 16019: $result = $expire_role_result;
16020: }
16021: }
16022: if (($expire_role_result eq 'ok') || ($secchange == 0)) {
1.1116 raeburn 16023: $modify_section_result =
16024: &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,
16025: undef,undef,undef,$sec,
16026: $end,$start,'','',$cid,
16027: '',$context,$credits);
1.443 albertel 16028: if ($modify_section_result =~ /^ok/) {
16029: if ($secchange == 1) {
1.628 raeburn 16030: if ($sec eq '') {
16031: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
16032: } else {
16033: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
16034: }
1.443 albertel 16035: } elsif ($oldsec eq '-1') {
1.628 raeburn 16036: if ($sec eq '') {
16037: $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
16038: } else {
16039: $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
16040: }
1.443 albertel 16041: } else {
1.628 raeburn 16042: if ($sec eq '') {
16043: $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
16044: } else {
16045: $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
16046: }
1.443 albertel 16047: }
16048: } else {
1.1115 raeburn 16049: if ($secchange) {
1.628 raeburn 16050: $$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;
16051: } else {
16052: $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
16053: }
1.443 albertel 16054: }
16055: $result = $modify_section_result;
16056: } elsif ($secchange == 1) {
1.628 raeburn 16057: if ($oldsec eq '') {
1.1103 raeburn 16058: $$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 16059: } else {
16060: $$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;
16061: }
1.626 raeburn 16062: if ($expire_role_result eq 'refused') {
16063: my $newsecurl = '/'.$cid;
16064: $newsecurl =~ s/\_/\//g;
16065: if ($sec ne '') {
16066: $newsecurl.='/'.$sec;
16067: }
16068: if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
16069: if ($sec eq '') {
16070: $$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;
16071: } else {
16072: $$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;
16073: }
16074: }
16075: }
1.443 albertel 16076: }
16077: } else {
1.626 raeburn 16078: $$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 16079: $result = "error: incomplete course id\n";
16080: }
16081: return $result;
16082: }
16083:
1.1108 raeburn 16084: sub show_role_extent {
16085: my ($scope,$context,$role) = @_;
16086: $scope =~ s{^/}{};
16087: my @courseroles = &Apache::lonuserutils::roles_by_context('course',1);
16088: push(@courseroles,'co');
16089: my @authorroles = &Apache::lonuserutils::roles_by_context('author');
16090: if (($context eq 'course') || (grep(/^\Q$role\E/,@courseroles))) {
16091: $scope =~ s{/}{_};
16092: return '<span class="LC_cusr_emph">'.$env{'course.'.$scope.'.description'}.'</span>';
16093: } elsif (($context eq 'author') || (grep(/^\Q$role\E/,@authorroles))) {
16094: my ($audom,$auname) = split(/\//,$scope);
16095: return &mt('[_1] Author Space','<span class="LC_cusr_emph">'.
16096: &Apache::loncommon::plainname($auname,$audom).'</span>');
16097: } else {
16098: $scope =~ s{/$}{};
16099: return &mt('Domain: [_1]','<span class="LC_cusr_emph">'.
16100: &Apache::lonnet::domain($scope,'description').'</span>');
16101: }
16102: }
16103:
1.443 albertel 16104: ############################################################
16105: ############################################################
16106:
1.566 albertel 16107: sub check_clone {
1.578 raeburn 16108: my ($args,$linefeed) = @_;
1.566 albertel 16109: my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
16110: my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
16111: my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
1.1344 raeburn 16112: my $clonetitle;
16113: my @clonemsg;
1.566 albertel 16114: my $can_clone = 0;
1.944 raeburn 16115: my $lctype = lc($args->{'crstype'});
1.908 raeburn 16116: if ($lctype ne 'community') {
16117: $lctype = 'course';
16118: }
1.566 albertel 16119: if ($clonehome eq 'no_host') {
1.944 raeburn 16120: if ($args->{'crstype'} eq 'Community') {
1.1344 raeburn 16121: push(@clonemsg,({
16122: mt => 'No new community created.',
16123: args => [],
16124: },
16125: {
16126: mt => 'A new community could not be cloned from the specified original - [_1] - because it is a non-existent community.',
16127: args => [$args->{'clonedomain'}.':'.$args->{'clonedomain'}],
16128: }));
1.908 raeburn 16129: } else {
1.1344 raeburn 16130: push(@clonemsg,({
16131: mt => 'No new course created.',
16132: args => [],
16133: },
16134: {
16135: mt => 'A new course could not be cloned from the specified original - [_1] - because it is a non-existent course.',
16136: args => [$args->{'clonecourse'}.':'.$args->{'clonedomain'}],
16137: }));
16138: }
1.566 albertel 16139: } else {
16140: my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
1.1344 raeburn 16141: $clonetitle = $clonedesc{'description'};
1.944 raeburn 16142: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 16143: if ($clonedesc{'type'} ne 'Community') {
1.1344 raeburn 16144: push(@clonemsg,({
16145: mt => 'No new community created.',
16146: args => [],
16147: },
16148: {
16149: mt => 'A new community could not be cloned from the specified original - [_1] - because it is a course not a community.',
16150: args => [$args->{'clonecourse'}.':'.$args->{'clonedomain'}],
16151: }));
16152: return ($can_clone,\@clonemsg,$cloneid,$clonehome);
1.908 raeburn 16153: }
16154: }
1.1262 raeburn 16155: if (($env{'request.role.domain'} eq $args->{'clonedomain'}) &&
1.882 raeburn 16156: (&Apache::lonnet::allowed('ccc',$env{'request.role.domain'}))) {
1.566 albertel 16157: $can_clone = 1;
16158: } else {
1.1221 raeburn 16159: my %clonehash = &Apache::lonnet::get('environment',['cloners','internal.coursecode'],
1.566 albertel 16160: $args->{'clonedomain'},$args->{'clonecourse'});
1.1221 raeburn 16161: if ($clonehash{'cloners'} eq '') {
16162: my %domdefs = &Apache::lonnet::get_domain_defaults($args->{'course_domain'});
16163: if ($domdefs{'canclone'}) {
16164: unless ($domdefs{'canclone'} eq 'none') {
16165: if ($domdefs{'canclone'} eq 'domain') {
16166: if ($args->{'ccdomain'} eq $args->{'clonedomain'}) {
16167: $can_clone = 1;
16168: }
16169: } elsif (($clonehash{'internal.coursecode'}) && ($args->{'crscode'}) &&
16170: ($args->{'clonedomain'} eq $args->{'course_domain'})) {
16171: if (&Apache::lonnet::default_instcode_cloning($args->{'clonedomain'},$domdefs{'canclone'},
16172: $clonehash{'internal.coursecode'},$args->{'crscode'})) {
16173: $can_clone = 1;
16174: }
16175: }
16176: }
16177: }
1.578 raeburn 16178: } else {
1.1221 raeburn 16179: my @cloners = split(/,/,$clonehash{'cloners'});
16180: if (grep(/^\*$/,@cloners)) {
1.942 raeburn 16181: $can_clone = 1;
1.1221 raeburn 16182: } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
1.942 raeburn 16183: $can_clone = 1;
1.1225 raeburn 16184: } elsif (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners)) {
16185: $can_clone = 1;
1.1221 raeburn 16186: }
16187: unless ($can_clone) {
1.1225 raeburn 16188: if (($clonehash{'internal.coursecode'}) && ($args->{'crscode'}) &&
16189: ($args->{'clonedomain'} eq $args->{'course_domain'})) {
1.1221 raeburn 16190: my (%gotdomdefaults,%gotcodedefaults);
16191: foreach my $cloner (@cloners) {
16192: if (($cloner ne '*') && ($cloner !~ /^\*\:$match_domain$/) &&
16193: ($cloner !~ /^$match_username\:$match_domain$/) && ($cloner ne '')) {
16194: my (%codedefaults,@code_order);
16195: if (ref($gotcodedefaults{$args->{'clonedomain'}}) eq 'HASH') {
16196: if (ref($gotcodedefaults{$args->{'clonedomain'}}{'defaults'}) eq 'HASH') {
16197: %codedefaults = %{$gotcodedefaults{$args->{'clonedomain'}}{'defaults'}};
16198: }
16199: if (ref($gotcodedefaults{$args->{'clonedomain'}}{'order'}) eq 'ARRAY') {
16200: @code_order = @{$gotcodedefaults{$args->{'clonedomain'}}{'order'}};
16201: }
16202: } else {
16203: &Apache::lonnet::auto_instcode_defaults($args->{'clonedomain'},
16204: \%codedefaults,
16205: \@code_order);
16206: $gotcodedefaults{$args->{'clonedomain'}}{'defaults'} = \%codedefaults;
16207: $gotcodedefaults{$args->{'clonedomain'}}{'order'} = \@code_order;
16208: }
16209: if (@code_order > 0) {
16210: if (&Apache::lonnet::check_instcode_cloning(\%codedefaults,\@code_order,
16211: $cloner,$clonehash{'internal.coursecode'},
16212: $args->{'crscode'})) {
16213: $can_clone = 1;
16214: last;
16215: }
16216: }
16217: }
16218: }
16219: }
1.1225 raeburn 16220: }
16221: }
16222: unless ($can_clone) {
16223: my $ccrole = 'cc';
16224: if ($args->{'crstype'} eq 'Community') {
16225: $ccrole = 'co';
16226: }
16227: my %roleshash =
16228: &Apache::lonnet::get_my_roles($args->{'ccuname'},
16229: $args->{'ccdomain'},
16230: 'userroles',['active'],[$ccrole],
16231: [$args->{'clonedomain'}]);
16232: if ($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':'.$ccrole}) {
16233: $can_clone = 1;
16234: } elsif (&Apache::lonnet::is_course_owner($args->{'clonedomain'},$args->{'clonecourse'},
16235: $args->{'ccuname'},$args->{'ccdomain'})) {
16236: $can_clone = 1;
1.1221 raeburn 16237: }
16238: }
16239: unless ($can_clone) {
16240: if ($args->{'crstype'} eq 'Community') {
1.1344 raeburn 16241: push(@clonemsg,({
16242: mt => 'No new community created.',
16243: args => [],
16244: },
16245: {
16246: 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]).',
16247: args => [$args->{'ccuname'}.':'.$args->{'ccdomain'},$clonedesc{'description'}],
16248: }));
1.942 raeburn 16249: } else {
1.1344 raeburn 16250: push(@clonemsg,({
16251: mt => 'No new course created.',
16252: args => [],
16253: },
16254: {
16255: 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]).',
16256: args => [$args->{'ccuname'}.':'.$args->{'ccdomain'},$clonedesc{'description'}],
16257: }));
1.1221 raeburn 16258: }
1.566 albertel 16259: }
1.578 raeburn 16260: }
1.566 albertel 16261: }
1.1344 raeburn 16262: return ($can_clone,\@clonemsg,$cloneid,$clonehome,$clonetitle);
1.566 albertel 16263: }
16264:
1.444 albertel 16265: sub construct_course {
1.1262 raeburn 16266: my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context,
1.1344 raeburn 16267: $cnum,$category,$coderef,$callercontext,$user_lh) = @_;
16268: my ($outcome,$msgref,$clonemsgref);
1.541 raeburn 16269: my $linefeed = '<br />'."\n";
16270: if ($context eq 'auto') {
16271: $linefeed = "\n";
16272: }
1.566 albertel 16273:
16274: #
16275: # Are we cloning?
16276: #
1.1344 raeburn 16277: my ($can_clone,$cloneid,$clonehome,$clonetitle);
1.566 albertel 16278: if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
1.1344 raeburn 16279: ($can_clone,$clonemsgref,$cloneid,$clonehome,$clonetitle) = &check_clone($args,$linefeed);
1.566 albertel 16280: if (!$can_clone) {
1.1344 raeburn 16281: return (0,$outcome,$clonemsgref);
1.566 albertel 16282: }
16283: }
16284:
1.444 albertel 16285: #
16286: # Open course
16287: #
1.1239 raeburn 16288: my $showncrstype;
16289: if ($args->{'crstype'} eq 'Placement') {
16290: $showncrstype = 'placement test';
16291: } else {
16292: $showncrstype = lc($args->{'crstype'});
16293: }
1.444 albertel 16294: my %cenv=();
16295: $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
16296: $args->{'cdescr'},
16297: $args->{'curl'},
16298: $args->{'course_home'},
16299: $args->{'nonstandard'},
16300: $args->{'crscode'},
16301: $args->{'ccuname'}.':'.
16302: $args->{'ccdomain'},
1.882 raeburn 16303: $args->{'crstype'},
1.1344 raeburn 16304: $cnum,$context,$category,
16305: $callercontext);
1.444 albertel 16306:
16307: # Note: The testing routines depend on this being output; see
16308: # Utils::Course. This needs to at least be output as a comment
16309: # if anyone ever decides to not show this, and Utils::Course::new
16310: # will need to be suitably modified.
1.1344 raeburn 16311: if (($callercontext eq 'auto') && ($user_lh ne '')) {
16312: $outcome .= &mt_user($user_lh,'New LON-CAPA [_1] ID: [_2]',$showncrstype,$$courseid).$linefeed;
16313: } else {
16314: $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$showncrstype,$$courseid).$linefeed;
16315: }
1.943 raeburn 16316: if ($$courseid =~ /^error:/) {
1.1344 raeburn 16317: return (0,$outcome,$clonemsgref);
1.943 raeburn 16318: }
16319:
1.444 albertel 16320: #
16321: # Check if created correctly
16322: #
1.479 albertel 16323: ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
1.444 albertel 16324: my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
1.943 raeburn 16325: if ($crsuhome eq 'no_host') {
1.1344 raeburn 16326: if (($callercontext eq 'auto') && ($user_lh ne '')) {
16327: $outcome .= &mt_user($user_lh,
16328: 'Course creation failed, unrecognized course home server.');
16329: } else {
16330: $outcome .= &mt('Course creation failed, unrecognized course home server.');
16331: }
16332: $outcome .= $linefeed;
16333: return (0,$outcome,$clonemsgref);
1.943 raeburn 16334: }
1.541 raeburn 16335: $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
1.566 albertel 16336:
1.444 albertel 16337: #
1.566 albertel 16338: # Do the cloning
16339: #
1.1344 raeburn 16340: my @clonemsg;
1.566 albertel 16341: if ($can_clone && $cloneid) {
1.1344 raeburn 16342: push(@clonemsg,
16343: {
16344: mt => 'Created [_1] by cloning from [_2]',
16345: args => [$showncrstype,$clonetitle],
16346: });
1.566 albertel 16347: my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
1.444 albertel 16348: # Copy all files
1.1344 raeburn 16349: my @info =
16350: &Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},
16351: $args->{'dateshift'},$args->{'crscode'},
16352: $args->{'ccuname'}.':'.$args->{'ccdomain'},
16353: $args->{'tinyurls'});
16354: if (@info) {
16355: push(@clonemsg,@info);
16356: }
1.444 albertel 16357: # Restore URL
1.566 albertel 16358: $cenv{'url'}=$oldcenv{'url'};
1.444 albertel 16359: # Restore title
1.566 albertel 16360: $cenv{'description'}=$oldcenv{'description'};
1.955 raeburn 16361: # Restore creation date, creator and creation context.
16362: $cenv{'internal.created'}=$oldcenv{'internal.created'};
16363: $cenv{'internal.creator'}=$oldcenv{'internal.creator'};
16364: $cenv{'internal.creationcontext'}=$oldcenv{'internal.creationcontext'};
1.444 albertel 16365: # Mark as cloned
1.566 albertel 16366: $cenv{'clonedfrom'}=$cloneid;
1.638 www 16367: # Need to clone grading mode
16368: my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum);
16369: $cenv{'grading'}=$newenv{'grading'};
16370: # Do not clone these environment entries
16371: &Apache::lonnet::del('environment',
16372: ['default_enrollment_start_date',
16373: 'default_enrollment_end_date',
16374: 'question.email',
16375: 'policy.email',
16376: 'comment.email',
16377: 'pch.users.denied',
1.725 raeburn 16378: 'plc.users.denied',
16379: 'hidefromcat',
1.1121 raeburn 16380: 'checkforpriv',
1.1355 raeburn 16381: 'categories'],
1.638 www 16382: $$crsudom,$$crsunum);
1.1170 raeburn 16383: if ($args->{'textbook'}) {
16384: $cenv{'internal.textbook'} = $args->{'textbook'};
16385: }
1.444 albertel 16386: }
1.566 albertel 16387:
1.444 albertel 16388: #
16389: # Set environment (will override cloned, if existing)
16390: #
16391: my @sections = ();
16392: my @xlists = ();
16393: if ($args->{'crstype'}) {
16394: $cenv{'type'}=$args->{'crstype'};
16395: }
16396: if ($args->{'crsid'}) {
16397: $cenv{'courseid'}=$args->{'crsid'};
16398: }
16399: if ($args->{'crscode'}) {
16400: $cenv{'internal.coursecode'}=$args->{'crscode'};
16401: }
16402: if ($args->{'crsquota'} ne '') {
16403: $cenv{'internal.coursequota'}=$args->{'crsquota'};
16404: } else {
16405: $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
16406: }
16407: if ($args->{'ccuname'}) {
16408: $cenv{'internal.courseowner'} = $args->{'ccuname'}.
16409: ':'.$args->{'ccdomain'};
16410: } else {
16411: $cenv{'internal.courseowner'} = $args->{'curruser'};
16412: }
1.1116 raeburn 16413: if ($args->{'defaultcredits'}) {
16414: $cenv{'internal.defaultcredits'} = $args->{'defaultcredits'};
16415: }
1.444 albertel 16416: my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
16417: if ($args->{'crssections'}) {
16418: $cenv{'internal.sectionnums'} = '';
16419: if ($args->{'crssections'} =~ m/,/) {
16420: @sections = split/,/,$args->{'crssections'};
16421: } else {
16422: $sections[0] = $args->{'crssections'};
16423: }
16424: if (@sections > 0) {
16425: foreach my $item (@sections) {
16426: my ($sec,$gp) = split/:/,$item;
16427: my $class = $args->{'crscode'}.$sec;
16428: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
16429: $cenv{'internal.sectionnums'} .= $item.',';
16430: unless ($addcheck eq 'ok') {
1.1263 raeburn 16431: push(@badclasses,$class);
1.444 albertel 16432: }
16433: }
16434: $cenv{'internal.sectionnums'} =~ s/,$//;
16435: }
16436: }
16437: # do not hide course coordinator from staff listing,
16438: # even if privileged
16439: $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
1.1121 raeburn 16440: # add course coordinator's domain to domains to check for privileged users
16441: # if different to course domain
16442: if ($$crsudom ne $args->{'ccdomain'}) {
16443: $cenv{'checkforpriv'} = $args->{'ccdomain'};
16444: }
1.444 albertel 16445: # add crosslistings
16446: if ($args->{'crsxlist'}) {
16447: $cenv{'internal.crosslistings'}='';
16448: if ($args->{'crsxlist'} =~ m/,/) {
16449: @xlists = split/,/,$args->{'crsxlist'};
16450: } else {
16451: $xlists[0] = $args->{'crsxlist'};
16452: }
16453: if (@xlists > 0) {
16454: foreach my $item (@xlists) {
16455: my ($xl,$gp) = split/:/,$item;
16456: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
16457: $cenv{'internal.crosslistings'} .= $item.',';
16458: unless ($addcheck eq 'ok') {
1.1263 raeburn 16459: push(@badclasses,$xl);
1.444 albertel 16460: }
16461: }
16462: $cenv{'internal.crosslistings'} =~ s/,$//;
16463: }
16464: }
16465: if ($args->{'autoadds'}) {
16466: $cenv{'internal.autoadds'}=$args->{'autoadds'};
16467: }
16468: if ($args->{'autodrops'}) {
16469: $cenv{'internal.autodrops'}=$args->{'autodrops'};
16470: }
16471: # check for notification of enrollment changes
16472: my @notified = ();
16473: if ($args->{'notify_owner'}) {
16474: if ($args->{'ccuname'} ne '') {
16475: push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
16476: }
16477: }
16478: if ($args->{'notify_dc'}) {
16479: if ($uname ne '') {
1.630 raeburn 16480: push(@notified,$uname.':'.$udom);
1.444 albertel 16481: }
16482: }
16483: if (@notified > 0) {
16484: my $notifylist;
16485: if (@notified > 1) {
16486: $notifylist = join(',',@notified);
16487: } else {
16488: $notifylist = $notified[0];
16489: }
16490: $cenv{'internal.notifylist'} = $notifylist;
16491: }
16492: if (@badclasses > 0) {
16493: my %lt=&Apache::lonlocal::texthash(
1.1264 raeburn 16494: 'tclb' => 'The courses listed below were included as sections or crosslistings affiliated with your new LON-CAPA course.',
16495: 'howi' => 'However, if automated course roster updates are enabled for this class, these particular sections/crosslistings are not guaranteed to contribute towards enrollment.',
16496: 'itis' => 'It is possible that rights to access enrollment for these classes will be available through assignment of co-owners.',
1.444 albertel 16497: );
1.1264 raeburn 16498: my $badclass_msg = $lt{'tclb'}.$linefeed.$lt{'howi'}.$linefeed.
16499: &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 16500: if ($context eq 'auto') {
16501: $outcome .= $badclass_msg.$linefeed;
1.1261 raeburn 16502: } else {
1.566 albertel 16503: $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
1.1261 raeburn 16504: }
16505: foreach my $item (@badclasses) {
1.541 raeburn 16506: if ($context eq 'auto') {
1.1261 raeburn 16507: $outcome .= " - $item\n";
1.541 raeburn 16508: } else {
1.1261 raeburn 16509: $outcome .= "<li>$item</li>\n";
1.541 raeburn 16510: }
1.1261 raeburn 16511: }
16512: if ($context eq 'auto') {
16513: $outcome .= $linefeed;
16514: } else {
16515: $outcome .= "</ul><br /><br /></div>\n";
1.541 raeburn 16516: }
1.444 albertel 16517: }
16518: if ($args->{'no_end_date'}) {
16519: $args->{'endaccess'} = 0;
16520: }
16521: $cenv{'internal.autostart'}=$args->{'enrollstart'};
16522: $cenv{'internal.autoend'}=$args->{'enrollend'};
16523: $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
16524: $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
16525: if ($args->{'showphotos'}) {
16526: $cenv{'internal.showphotos'}=$args->{'showphotos'};
16527: }
16528: $cenv{'internal.authtype'} = $args->{'authtype'};
16529: $cenv{'internal.autharg'} = $args->{'autharg'};
16530: if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
16531: if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'} eq '') {
1.541 raeburn 16532: 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');
16533: if ($context eq 'auto') {
16534: $outcome .= $krb_msg;
16535: } else {
1.566 albertel 16536: $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
1.541 raeburn 16537: }
16538: $outcome .= $linefeed;
1.444 albertel 16539: }
16540: }
16541: if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
16542: if ($args->{'setpolicy'}) {
16543: $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
16544: }
16545: if ($args->{'setcontent'}) {
16546: $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
16547: }
1.1251 raeburn 16548: if ($args->{'setcomment'}) {
16549: $cenv{'comment.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
16550: }
1.444 albertel 16551: }
16552: if ($args->{'reshome'}) {
16553: $cenv{'reshome'}=$args->{'reshome'}.'/';
16554: $cenv{'reshome'}=~s/\/+$/\//;
16555: }
16556: #
16557: # course has keyed access
16558: #
16559: if ($args->{'setkeys'}) {
16560: $cenv{'keyaccess'}='yes';
16561: }
16562: # if specified, key authority is not course, but user
16563: # only active if keyaccess is yes
16564: if ($args->{'keyauth'}) {
1.487 albertel 16565: my ($user,$domain) = split(':',$args->{'keyauth'});
16566: $user = &LONCAPA::clean_username($user);
16567: $domain = &LONCAPA::clean_username($domain);
1.488 foxr 16568: if ($user ne '' && $domain ne '') {
1.487 albertel 16569: $cenv{'keyauth'}=$user.':'.$domain;
1.444 albertel 16570: }
16571: }
16572:
1.1166 raeburn 16573: #
1.1167 raeburn 16574: # generate and store uniquecode (available to course requester), if course should have one.
1.1166 raeburn 16575: #
16576: if ($args->{'uniquecode'}) {
16577: my ($code,$error) = &make_unique_code($$crsudom,$$crsunum);
16578: if ($code) {
16579: $cenv{'internal.uniquecode'} = $code;
1.1167 raeburn 16580: my %crsinfo =
16581: &Apache::lonnet::courseiddump($$crsudom,'.',1,'.','.',$$crsunum,undef,undef,'.');
16582: if (ref($crsinfo{$$crsudom.'_'.$$crsunum}) eq 'HASH') {
16583: $crsinfo{$$crsudom.'_'.$$crsunum}{'uniquecode'} = $code;
16584: my $putres = &Apache::lonnet::courseidput($$crsudom,\%crsinfo,$crsuhome,'notime');
16585: }
1.1166 raeburn 16586: if (ref($coderef)) {
16587: $$coderef = $code;
16588: }
16589: }
16590: }
16591:
1.444 albertel 16592: if ($args->{'disresdis'}) {
16593: $cenv{'pch.roles.denied'}='st';
16594: }
16595: if ($args->{'disablechat'}) {
16596: $cenv{'plc.roles.denied'}='st';
16597: }
16598:
16599: # Record we've not yet viewed the Course Initialization Helper for this
16600: # course
16601: $cenv{'course.helper.not.run'} = 1;
16602: #
16603: # Use new Randomseed
16604: #
16605: $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
16606: $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
16607: #
16608: # The encryption code and receipt prefix for this course
16609: #
16610: $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
16611: $cenv{'internal.encpref'}=100+int(9*rand(99));
16612: #
16613: # By default, use standard grading
16614: if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
16615:
1.541 raeburn 16616: $outcome .= $linefeed.&mt('Setting environment').': '.
16617: &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 16618: #
16619: # Open all assignments
16620: #
16621: if ($args->{'openall'}) {
1.1341 raeburn 16622: my $opendate = time;
16623: if ($args->{'openallfrom'} =~ /^\d+$/) {
16624: $opendate = $args->{'openallfrom'};
16625: }
1.444 albertel 16626: my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
1.1341 raeburn 16627: my %storecontent = ($storeunder => $opendate,
1.444 albertel 16628: $storeunder.'.type' => 'date_start');
1.1341 raeburn 16629: $outcome .= &mt('All assignments open starting [_1]',
16630: &Apache::lonlocal::locallocaltime($opendate)).': '.
16631: &Apache::lonnet::cput
16632: ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 16633: }
16634: #
16635: # Set first page
16636: #
16637: unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
16638: || ($cloneid)) {
1.445 albertel 16639: use LONCAPA::map;
1.444 albertel 16640: $outcome .= &mt('Setting first resource').': ';
1.445 albertel 16641:
16642: my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
16643: my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
16644:
1.444 albertel 16645: $outcome .= ($fatal?$errtext:'read ok').' - ';
16646: my $title; my $url;
16647: if ($args->{'firstres'} eq 'syl') {
1.690 bisitz 16648: $title=&mt('Syllabus');
1.444 albertel 16649: $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
16650: } else {
1.963 raeburn 16651: $title=&mt('Table of Contents');
1.444 albertel 16652: $url='/adm/navmaps';
16653: }
1.445 albertel 16654:
16655: $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
16656: (my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
16657:
16658: if ($errtext) { $fatal=2; }
1.541 raeburn 16659: $outcome .= ($fatal?$errtext:'write ok').$linefeed;
1.444 albertel 16660: }
1.566 albertel 16661:
1.1237 raeburn 16662: #
16663: # Set params for Placement Tests
16664: #
1.1239 raeburn 16665: if ($args->{'crstype'} eq 'Placement') {
16666: my %storecontent;
16667: my $prefix=$$crsudom.'_'.$$crsunum.'.0.';
16668: my %defaults = (
16669: buttonshide => { value => 'yes',
16670: type => 'string_yesno',},
16671: type => { value => 'randomizetry',
16672: type => 'string_questiontype',},
16673: maxtries => { value => 1,
16674: type => 'int_pos',},
16675: problemstatus => { value => 'no',
16676: type => 'string_problemstatus',},
16677: );
16678: foreach my $key (keys(%defaults)) {
16679: $storecontent{$prefix.$key} = $defaults{$key}{'value'};
16680: $storecontent{$prefix.$key.'.type'} = $defaults{$key}{'type'};
16681: }
1.1237 raeburn 16682: &Apache::lonnet::cput
16683: ('resourcedata',\%storecontent,$$crsudom,$$crsunum);
16684: }
16685:
1.1344 raeburn 16686: return (1,$outcome,\@clonemsg);
1.444 albertel 16687: }
16688:
1.1166 raeburn 16689: sub make_unique_code {
16690: my ($cdom,$cnum) = @_;
16691: # get lock on uniquecodes db
16692: my $lockhash = {
16693: $cnum."\0".'uniquecodes' => $env{'user.name'}.
16694: ':'.$env{'user.domain'},
16695: };
16696: my $tries = 0;
16697: my $gotlock = &Apache::lonnet::newput_dom('uniquecodes',$lockhash,$cdom);
16698: my ($code,$error);
16699:
16700: while (($gotlock ne 'ok') && ($tries<3)) {
16701: $tries ++;
16702: sleep 1;
16703: $gotlock = &Apache::lonnet::newput_dom('uniquecodes',$lockhash,$cdom);
16704: }
16705: if ($gotlock eq 'ok') {
16706: my %currcodes = &Apache::lonnet::dump_dom('uniquecodes',$cdom);
16707: my $gotcode;
16708: my $attempts = 0;
16709: while ((!$gotcode) && ($attempts < 100)) {
16710: $code = &generate_code();
16711: if (!exists($currcodes{$code})) {
16712: $gotcode = 1;
16713: unless (&Apache::lonnet::newput_dom('uniquecodes',{ $code => $cnum },$cdom) eq 'ok') {
16714: $error = 'nostore';
16715: }
16716: }
16717: $attempts ++;
16718: }
16719: my @del_lock = ($cnum."\0".'uniquecodes');
16720: my $dellockoutcome = &Apache::lonnet::del_dom('uniquecodes',\@del_lock,$cdom);
16721: } else {
16722: $error = 'nolock';
16723: }
16724: return ($code,$error);
16725: }
16726:
16727: sub generate_code {
16728: my $code;
16729: my @letts = qw(B C D G H J K M N P Q R S T V W X Z);
16730: for (my $i=0; $i<6; $i++) {
16731: my $lettnum = int (rand 2);
16732: my $item = '';
16733: if ($lettnum) {
16734: $item = $letts[int( rand(18) )];
16735: } else {
16736: $item = 1+int( rand(8) );
16737: }
16738: $code .= $item;
16739: }
16740: return $code;
16741: }
16742:
1.444 albertel 16743: ############################################################
16744: ############################################################
16745:
1.1237 raeburn 16746: # Community, Course and Placement Test
1.378 raeburn 16747: sub course_type {
16748: my ($cid) = @_;
16749: if (!defined($cid)) {
16750: $cid = $env{'request.course.id'};
16751: }
1.404 albertel 16752: if (defined($env{'course.'.$cid.'.type'})) {
16753: return $env{'course.'.$cid.'.type'};
1.378 raeburn 16754: } else {
16755: return 'Course';
1.377 raeburn 16756: }
16757: }
1.156 albertel 16758:
1.406 raeburn 16759: sub group_term {
16760: my $crstype = &course_type();
16761: my %names = (
16762: 'Course' => 'group',
1.865 raeburn 16763: 'Community' => 'group',
1.1237 raeburn 16764: 'Placement' => 'group',
1.406 raeburn 16765: );
16766: return $names{$crstype};
16767: }
16768:
1.902 raeburn 16769: sub course_types {
1.1310 raeburn 16770: my @types = ('official','unofficial','community','textbook','placement','lti');
1.902 raeburn 16771: my %typename = (
16772: official => 'Official course',
16773: unofficial => 'Unofficial course',
16774: community => 'Community',
1.1165 raeburn 16775: textbook => 'Textbook course',
1.1237 raeburn 16776: placement => 'Placement test',
1.1310 raeburn 16777: lti => 'LTI provider',
1.902 raeburn 16778: );
16779: return (\@types,\%typename);
16780: }
16781:
1.156 albertel 16782: sub icon {
16783: my ($file)=@_;
1.505 albertel 16784: my $curfext = lc((split(/\./,$file))[-1]);
1.168 albertel 16785: my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156 albertel 16786: my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168 albertel 16787: if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
16788: if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
16789: $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
16790: $curfext.".gif") {
16791: $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
16792: $curfext.".gif";
16793: }
16794: }
1.249 albertel 16795: return &lonhttpdurl($iconname);
1.154 albertel 16796: }
1.84 albertel 16797:
1.575 albertel 16798: sub lonhttpdurl {
1.692 www 16799: #
16800: # Had been used for "small fry" static images on separate port 8080.
16801: # Modify here if lightweight http functionality desired again.
16802: # Currently eliminated due to increasing firewall issues.
16803: #
1.575 albertel 16804: my ($url)=@_;
1.692 www 16805: return $url;
1.215 albertel 16806: }
16807:
1.213 albertel 16808: sub connection_aborted {
16809: my ($r)=@_;
16810: $r->print(" ");$r->rflush();
16811: my $c = $r->connection;
16812: return $c->aborted();
16813: }
16814:
1.221 foxr 16815: # Escapes strings that may have embedded 's that will be put into
1.222 foxr 16816: # strings as 'strings'.
16817: sub escape_single {
1.221 foxr 16818: my ($input) = @_;
1.223 albertel 16819: $input =~ s/\\/\\\\/g; # Escape the \'s..(must be first)>
1.221 foxr 16820: $input =~ s/\'/\\\'/g; # Esacpe the 's....
16821: return $input;
16822: }
1.223 albertel 16823:
1.222 foxr 16824: # Same as escape_single, but escape's "'s This
16825: # can be used for "strings"
16826: sub escape_double {
16827: my ($input) = @_;
16828: $input =~ s/\\/\\\\/g; # Escape the /'s..(must be first)>
16829: $input =~ s/\"/\\\"/g; # Esacpe the "s....
16830: return $input;
16831: }
1.223 albertel 16832:
1.222 foxr 16833: # Escapes the last element of a full URL.
16834: sub escape_url {
16835: my ($url) = @_;
1.238 raeburn 16836: my @urlslices = split(/\//, $url,-1);
1.369 www 16837: my $lastitem = &escape(pop(@urlslices));
1.1203 raeburn 16838: return &HTML::Entities::encode(join('/',@urlslices),"'").'/'.$lastitem;
1.222 foxr 16839: }
1.462 albertel 16840:
1.820 raeburn 16841: sub compare_arrays {
16842: my ($arrayref1,$arrayref2) = @_;
16843: my (@difference,%count);
16844: @difference = ();
16845: %count = ();
16846: if ((ref($arrayref1) eq 'ARRAY') && (ref($arrayref2) eq 'ARRAY')) {
16847: foreach my $element (@{$arrayref1}, @{$arrayref2}) { $count{$element}++; }
16848: foreach my $element (keys(%count)) {
16849: if ($count{$element} == 1) {
16850: push(@difference,$element);
16851: }
16852: }
16853: }
16854: return @difference;
16855: }
16856:
1.1322 raeburn 16857: sub lon_status_items {
16858: my %defaults = (
16859: E => 100,
16860: W => 4,
16861: N => 1,
1.1324 raeburn 16862: U => 5,
1.1322 raeburn 16863: threshold => 200,
16864: sysmail => 2500,
16865: );
16866: my %names = (
16867: E => 'Errors',
16868: W => 'Warnings',
16869: N => 'Notices',
1.1324 raeburn 16870: U => 'Unsent',
1.1322 raeburn 16871: );
16872: return (\%defaults,\%names);
16873: }
16874:
1.817 bisitz 16875: # -------------------------------------------------------- Initialize user login
1.462 albertel 16876: sub init_user_environment {
1.463 albertel 16877: my ($r, $username, $domain, $authhost, $form, $args) = @_;
1.462 albertel 16878: my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
16879:
16880: my $public=($username eq 'public' && $domain eq 'public');
16881:
1.1062 raeburn 16882: my ($filename,$cookie,$userroles,$firstaccenv,$timerintenv);
1.462 albertel 16883: my $now=time;
16884:
16885: if ($public) {
16886: my $max_public=100;
16887: my $oldest;
16888: my $oldest_time=0;
16889: for(my $next=1;$next<=$max_public;$next++) {
16890: if (-e $lonids."/publicuser_$next.id") {
16891: my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
16892: if ($mtime<$oldest_time || !$oldest_time) {
16893: $oldest_time=$mtime;
16894: $oldest=$next;
16895: }
16896: } else {
16897: $cookie="publicuser_$next";
16898: last;
16899: }
16900: }
16901: if (!$cookie) { $cookie="publicuser_$oldest"; }
16902: } else {
1.1275 raeburn 16903: # See if old ID present, if so, remove if this isn't a robot,
16904: # killing any existing non-robot sessions
1.463 albertel 16905: if (!$args->{'robot'}) {
16906: opendir(DIR,$lonids);
16907: while ($filename=readdir(DIR)) {
16908: if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
1.1320 raeburn 16909: if (tie(my %oldenv,'GDBM_File',"$lonids/$filename",
16910: &GDBM_READER(),0640)) {
1.1295 raeburn 16911: my $linkedfile;
1.1320 raeburn 16912: if (exists($oldenv{'user.linkedenv'})) {
16913: $linkedfile = $oldenv{'user.linkedenv'};
1.1295 raeburn 16914: }
1.1320 raeburn 16915: untie(%oldenv);
16916: if (unlink("$lonids/$filename")) {
16917: if ($linkedfile =~ /^[a-f0-9]+_linked$/) {
16918: if (-l "$lonids/$linkedfile.id") {
16919: unlink("$lonids/$linkedfile.id");
16920: }
1.1295 raeburn 16921: }
16922: }
16923: } else {
16924: unlink($lonids.'/'.$filename);
16925: }
1.463 albertel 16926: }
1.462 albertel 16927: }
1.463 albertel 16928: closedir(DIR);
1.1204 raeburn 16929: # If there is a undeleted lockfile for the user's paste buffer remove it.
16930: my $namespace = 'nohist_courseeditor';
16931: my $lockingkey = 'paste'."\0".'locked_num';
16932: my %lockhash = &Apache::lonnet::get($namespace,[$lockingkey],
16933: $domain,$username);
16934: if (exists($lockhash{$lockingkey})) {
16935: my $delresult = &Apache::lonnet::del($namespace,[$lockingkey],$domain,$username);
16936: unless ($delresult eq 'ok') {
16937: &Apache::lonnet::logthis("Failed to delete paste buffer locking key in $namespace for ".$username.":".$domain." Result was: $delresult");
16938: }
16939: }
1.462 albertel 16940: }
16941: # Give them a new cookie
1.463 albertel 16942: my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
1.684 www 16943: : $now.$$.int(rand(10000)));
1.463 albertel 16944: $cookie="$username\_$id\_$domain\_$authhost";
1.462 albertel 16945:
16946: # Initialize roles
16947:
1.1062 raeburn 16948: ($userroles,$firstaccenv,$timerintenv) =
16949: &Apache::lonnet::rolesinit($domain,$username,$authhost);
1.462 albertel 16950: }
16951: # ------------------------------------ Check browser type and MathML capability
16952:
1.1194 raeburn 16953: my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,$clientunicode,
16954: $clientos,$clientmobile,$clientinfo,$clientosversion) = &decode_user_agent($r);
1.462 albertel 16955:
16956: # ------------------------------------------------------------- Get environment
16957:
16958: my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
16959: my ($tmp) = keys(%userenv);
1.1275 raeburn 16960: if ($tmp =~ /^(con_lost|error|no_such_host)/i) {
1.462 albertel 16961: undef(%userenv);
16962: }
16963: if (($userenv{'interface'}) && (!$form->{'interface'})) {
16964: $form->{'interface'}=$userenv{'interface'};
16965: }
16966: if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
16967:
16968: # --------------- Do not trust query string to be put directly into environment
1.817 bisitz 16969: foreach my $option ('interface','localpath','localres') {
16970: $form->{$option}=~s/[\n\r\=]//gs;
1.462 albertel 16971: }
16972: # --------------------------------------------------------- Write first profile
16973:
16974: {
1.1350 raeburn 16975: my $ip = &Apache::lonnet::get_requestor_ip($r);
1.462 albertel 16976: my %initial_env =
16977: ("user.name" => $username,
16978: "user.domain" => $domain,
16979: "user.home" => $authhost,
16980: "browser.type" => $clientbrowser,
16981: "browser.version" => $clientversion,
16982: "browser.mathml" => $clientmathml,
16983: "browser.unicode" => $clientunicode,
16984: "browser.os" => $clientos,
1.1137 raeburn 16985: "browser.mobile" => $clientmobile,
1.1141 raeburn 16986: "browser.info" => $clientinfo,
1.1194 raeburn 16987: "browser.osversion" => $clientosversion,
1.462 albertel 16988: "server.domain" => $Apache::lonnet::perlvar{'lonDefDomain'},
16989: "request.course.fn" => '',
16990: "request.course.uri" => '',
16991: "request.course.sec" => '',
16992: "request.role" => 'cm',
16993: "request.role.adv" => $env{'user.adv'},
1.1350 raeburn 16994: "request.host" => $ip,);
1.462 albertel 16995:
16996: if ($form->{'localpath'}) {
16997: $initial_env{"browser.localpath"} = $form->{'localpath'};
16998: $initial_env{"browser.localres"} = $form->{'localres'};
16999: }
17000:
17001: if ($form->{'interface'}) {
17002: $form->{'interface'}=~s/\W//gs;
17003: $initial_env{"browser.interface"} = $form->{'interface'};
17004: $env{'browser.interface'}=$form->{'interface'};
17005: }
17006:
1.1157 raeburn 17007: if ($form->{'iptoken'}) {
17008: my $lonhost = $r->dir_config('lonHostID');
17009: $initial_env{"user.noloadbalance"} = $lonhost;
17010: $env{'user.noloadbalance'} = $lonhost;
17011: }
17012:
1.1268 raeburn 17013: if ($form->{'noloadbalance'}) {
17014: my @hosts = &Apache::lonnet::current_machine_ids();
17015: my $hosthere = $form->{'noloadbalance'};
17016: if (grep(/^\Q$hosthere\E$/,@hosts)) {
17017: $initial_env{"user.noloadbalance"} = $hosthere;
17018: $env{'user.noloadbalance'} = $hosthere;
17019: }
17020: }
17021:
1.1016 raeburn 17022: unless ($domain eq 'public') {
1.1273 raeburn 17023: my %is_adv = ( is_adv => $env{'user.adv'} );
17024: my %domdef = &Apache::lonnet::get_domain_defaults($domain);
17025:
17026: foreach my $tool ('aboutme','blog','webdav','portfolio') {
17027: $userenv{'availabletools.'.$tool} =
17028: &Apache::lonnet::usertools_access($username,$domain,$tool,'reload',
17029: undef,\%userenv,\%domdef,\%is_adv);
17030: }
1.980 raeburn 17031:
1.1311 raeburn 17032: foreach my $crstype ('official','unofficial','community','textbook','placement','lti') {
1.1273 raeburn 17033: $userenv{'canrequest.'.$crstype} =
17034: &Apache::lonnet::usertools_access($username,$domain,$crstype,
17035: 'reload','requestcourses',
17036: \%userenv,\%domdef,\%is_adv);
17037: }
1.724 raeburn 17038:
1.1273 raeburn 17039: $userenv{'canrequest.author'} =
17040: &Apache::lonnet::usertools_access($username,$domain,'requestauthor',
17041: 'reload','requestauthor',
1.980 raeburn 17042: \%userenv,\%domdef,\%is_adv);
1.1273 raeburn 17043: my %reqauthor = &Apache::lonnet::get('requestauthor',['author_status','author'],
17044: $domain,$username);
17045: my $reqstatus = $reqauthor{'author_status'};
17046: if ($reqstatus eq 'approval' || $reqstatus eq 'approved') {
17047: if (ref($reqauthor{'author'}) eq 'HASH') {
17048: $userenv{'requestauthorqueued'} = $reqstatus.':'.
17049: $reqauthor{'author'}{'timestamp'};
17050: }
1.1092 raeburn 17051: }
1.1287 raeburn 17052: my ($types,$typename) = &course_types();
17053: if (ref($types) eq 'ARRAY') {
17054: my @options = ('approval','validate','autolimit');
17055: my $optregex = join('|',@options);
17056: my (%willtrust,%trustchecked);
17057: foreach my $type (@{$types}) {
17058: my $dom_str = $env{'environment.reqcrsotherdom.'.$type};
17059: if ($dom_str ne '') {
17060: my $updatedstr = '';
17061: my @possdomains = split(',',$dom_str);
17062: foreach my $entry (@possdomains) {
17063: my ($extdom,$extopt) = split(':',$entry);
17064: unless ($trustchecked{$extdom}) {
17065: $willtrust{$extdom} = &Apache::lonnet::will_trust('reqcrs',$domain,$extdom);
17066: $trustchecked{$extdom} = 1;
17067: }
17068: if ($willtrust{$extdom}) {
17069: $updatedstr .= $entry.',';
17070: }
17071: }
17072: $updatedstr =~ s/,$//;
17073: if ($updatedstr) {
17074: $userenv{'reqcrsotherdom.'.$type} = $updatedstr;
17075: } else {
17076: delete($userenv{'reqcrsotherdom.'.$type});
17077: }
17078: }
17079: }
17080: }
1.1092 raeburn 17081: }
1.462 albertel 17082: $env{'user.environment'} = "$lonids/$cookie.id";
1.1062 raeburn 17083:
1.462 albertel 17084: if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
17085: &GDBM_WRCREAT(),0640)) {
17086: &_add_to_env(\%disk_env,\%initial_env);
17087: &_add_to_env(\%disk_env,\%userenv,'environment.');
17088: &_add_to_env(\%disk_env,$userroles);
1.1062 raeburn 17089: if (ref($firstaccenv) eq 'HASH') {
17090: &_add_to_env(\%disk_env,$firstaccenv);
17091: }
17092: if (ref($timerintenv) eq 'HASH') {
17093: &_add_to_env(\%disk_env,$timerintenv);
17094: }
1.463 albertel 17095: if (ref($args->{'extra_env'})) {
17096: &_add_to_env(\%disk_env,$args->{'extra_env'});
17097: }
1.462 albertel 17098: untie(%disk_env);
17099: } else {
1.705 tempelho 17100: &Apache::lonnet::logthis("<span style=\"color:blue;\">WARNING: ".
17101: 'Could not create environment storage in lonauth: '.$!.'</span>');
1.462 albertel 17102: return 'error: '.$!;
17103: }
17104: }
17105: $env{'request.role'}='cm';
17106: $env{'request.role.adv'}=$env{'user.adv'};
17107: $env{'browser.type'}=$clientbrowser;
17108:
17109: return $cookie;
17110:
17111: }
17112:
17113: sub _add_to_env {
17114: my ($idf,$env_data,$prefix) = @_;
1.676 raeburn 17115: if (ref($env_data) eq 'HASH') {
17116: while (my ($key,$value) = each(%$env_data)) {
17117: $idf->{$prefix.$key} = $value;
17118: $env{$prefix.$key} = $value;
17119: }
1.462 albertel 17120: }
17121: }
17122:
1.685 tempelho 17123: # --- Get the symbolic name of a problem and the url
17124: sub get_symb {
17125: my ($request,$silent) = @_;
1.726 raeburn 17126: (my $url=$env{'form.url'}) =~ s-^https?\://($ENV{'SERVER_NAME'}|$ENV{'HTTP_HOST'})--;
1.685 tempelho 17127: my $symb=($env{'form.symb'} ne '' ? $env{'form.symb'} : (&Apache::lonnet::symbread($url)));
17128: if ($symb eq '') {
17129: if (!$silent) {
1.1071 raeburn 17130: if (ref($request)) {
17131: $request->print("Unable to handle ambiguous references:$url:.");
17132: }
1.685 tempelho 17133: return ();
17134: }
17135: }
17136: &Apache::lonenc::check_decrypt(\$symb);
17137: return ($symb);
17138: }
17139:
17140: # --------------------------------------------------------------Get annotation
17141:
17142: sub get_annotation {
17143: my ($symb,$enc) = @_;
17144:
17145: my $key = $symb;
17146: if (!$enc) {
17147: $key =
17148: &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]);
17149: }
17150: my %annotation=&Apache::lonnet::get('nohist_annotations',[$key]);
17151: return $annotation{$key};
17152: }
17153:
17154: sub clean_symb {
1.731 raeburn 17155: my ($symb,$delete_enc) = @_;
1.685 tempelho 17156:
17157: &Apache::lonenc::check_decrypt(\$symb);
17158: my $enc = $env{'request.enc'};
1.731 raeburn 17159: if ($delete_enc) {
1.730 raeburn 17160: delete($env{'request.enc'});
17161: }
1.685 tempelho 17162:
17163: return ($symb,$enc);
17164: }
1.462 albertel 17165:
1.1181 raeburn 17166: ############################################################
17167: ############################################################
17168:
17169: =pod
17170:
17171: =head1 Routines for building display used to search for courses
17172:
17173:
17174: =over 4
17175:
17176: =item * &build_filters()
17177:
17178: Create markup for a table used to set filters to use when selecting
1.1182 raeburn 17179: courses in a domain. Used by lonpickcourse.pm, lonmodifycourse.pm
17180: and quotacheck.pl
17181:
1.1181 raeburn 17182:
17183: Inputs:
17184:
17185: filterlist - anonymous array of fields to include as potential filters
17186:
17187: crstype - course type
17188:
17189: roleelement - fifth arg in selectcourse_link() populates fifth arg in javascript: opencrsbrowser() function, used
17190: to pop-open a course selector (will contain "extra element").
17191:
17192: multelement - if multiple course selections will be allowed, this will be a hidden form element: name: multiple; value: 1
17193:
17194: filter - anonymous hash of criteria and their values
17195:
17196: action - form action
17197:
17198: numfiltersref - ref to scalar (count of number of elements in institutional codes -- e.g., 4 for year, semester, department, and number)
17199:
1.1182 raeburn 17200: caller - caller context (e.g., set to 'modifycourse' when routine is called from lonmodifycourse.pm)
1.1181 raeburn 17201:
17202: cloneruname - username of owner of new course who wants to clone
17203:
17204: clonerudom - domain of owner of new course who wants to clone
17205:
17206: typeelem - text to use for left column in row containing course type (i.e., Course, Community or Course/Community)
17207:
17208: codetitlesref - reference to array of titles of components in institutional codes (official courses)
17209:
17210: codedom - domain
17211:
17212: formname - value of form element named "form".
17213:
17214: fixeddom - domain, if fixed.
17215:
17216: prevphase - value to assign to form element named "phase" when going back to the previous screen
17217:
17218: cnameelement - name of form element in form on opener page which will receive title of selected course
17219:
17220: cnumelement - name of form element in form on opener page which will receive courseID of selected course
17221:
17222: cdomelement - name of form element in form on opener page which will receive domain of selected course
17223:
17224: setroles - includes access constraint identifier when setting a roles-based condition for acces to a portfolio file
17225:
17226: clonetext - hidden form elements containing list of courses cloneable by intended course owner when DC creates a course
17227:
17228: clonewarning - warning message about missing information for intended course owner when DC creates a course
17229:
1.1182 raeburn 17230:
1.1181 raeburn 17231: Returns: $output - HTML for display of search criteria, and hidden form elements.
17232:
1.1182 raeburn 17233:
1.1181 raeburn 17234: Side Effects: None
17235:
17236: =cut
17237:
17238: # ---------------------------------------------- search for courses based on last activity etc.
17239:
17240: sub build_filters {
17241: my ($filterlist,$crstype,$roleelement,$multelement,$filter,$action,
17242: $numtitlesref,$caller,$cloneruname,$clonerudom,$typeelement,
17243: $codetitlesref,$codedom,$formname,$fixeddom,$prevphase,
17244: $cnameelement,$cnumelement,$cdomelement,$setroles,
17245: $clonetext,$clonewarning) = @_;
1.1182 raeburn 17246: my ($list,$jscript);
1.1181 raeburn 17247: my $onchange = 'javascript:updateFilters(this)';
17248: my ($domainselectform,$sincefilterform,$createdfilterform,
17249: $ownerdomselectform,$persondomselectform,$instcodeform,
17250: $typeselectform,$instcodetitle);
17251: if ($formname eq '') {
17252: $formname = $caller;
17253: }
17254: foreach my $item (@{$filterlist}) {
17255: unless (($item eq 'descriptfilter') || ($item eq 'instcodefilter') ||
17256: ($item eq 'sincefilter') || ($item eq 'createdfilter')) {
17257: if ($item eq 'domainfilter') {
17258: $filter->{$item} = &LONCAPA::clean_domain($filter->{$item});
17259: } elsif ($item eq 'coursefilter') {
17260: $filter->{$item} = &LONCAPA::clean_courseid($filter->{$item});
17261: } elsif ($item eq 'ownerfilter') {
17262: $filter->{$item} = &LONCAPA::clean_username($filter->{$item});
17263: } elsif ($item eq 'ownerdomfilter') {
17264: $filter->{'ownerdomfilter'} =
17265: &LONCAPA::clean_domain($filter->{$item});
17266: $ownerdomselectform = &select_dom_form($filter->{'ownerdomfilter'},
17267: 'ownerdomfilter',1);
17268: } elsif ($item eq 'personfilter') {
17269: $filter->{$item} = &LONCAPA::clean_username($filter->{$item});
17270: } elsif ($item eq 'persondomfilter') {
17271: $persondomselectform = &select_dom_form($filter->{'persondomfilter'},
17272: 'persondomfilter',1);
17273: } else {
17274: $filter->{$item} =~ s/\W//g;
17275: }
17276: if (!$filter->{$item}) {
17277: $filter->{$item} = '';
17278: }
17279: }
17280: if ($item eq 'domainfilter') {
17281: my $allow_blank = 1;
17282: if ($formname eq 'portform') {
17283: $allow_blank=0;
17284: } elsif ($formname eq 'studentform') {
17285: $allow_blank=0;
17286: }
17287: if ($fixeddom) {
17288: $domainselectform = '<input type="hidden" name="domainfilter"'.
17289: ' value="'.$codedom.'" />'.
17290: &Apache::lonnet::domain($codedom,'description');
17291: } else {
17292: $domainselectform = &select_dom_form($filter->{$item},
17293: 'domainfilter',
17294: $allow_blank,'',$onchange);
17295: }
17296: } else {
17297: $list->{$item} = &HTML::Entities::encode($filter->{$item},'<>&"');
17298: }
17299: }
17300:
17301: # last course activity filter and selection
17302: $sincefilterform = &timebased_select_form('sincefilter',$filter);
17303:
17304: # course created filter and selection
17305: if (exists($filter->{'createdfilter'})) {
17306: $createdfilterform = &timebased_select_form('createdfilter',$filter);
17307: }
17308:
1.1239 raeburn 17309: my $prefix = $crstype;
17310: if ($crstype eq 'Placement') {
17311: $prefix = 'Placement Test'
17312: }
1.1181 raeburn 17313: my %lt = &Apache::lonlocal::texthash(
1.1239 raeburn 17314: 'cac' => "$prefix Activity",
17315: 'ccr' => "$prefix Created",
17316: 'cde' => "$prefix Title",
17317: 'cdo' => "$prefix Domain",
1.1181 raeburn 17318: 'ins' => 'Institutional Code',
17319: 'inc' => 'Institutional Categorization',
1.1239 raeburn 17320: 'cow' => "$prefix Owner/Co-owner",
17321: 'cop' => "$prefix Personnel Includes",
1.1181 raeburn 17322: 'cog' => 'Type',
17323: );
17324:
17325: if (($formname eq 'ccrs') || ($formname eq 'requestcrs')) {
17326: my $typeval = 'Course';
17327: if ($crstype eq 'Community') {
17328: $typeval = 'Community';
1.1239 raeburn 17329: } elsif ($crstype eq 'Placement') {
17330: $typeval = 'Placement';
1.1181 raeburn 17331: }
17332: $typeselectform = '<input type="hidden" name="type" value="'.$typeval.'" />';
17333: } else {
17334: $typeselectform = '<select name="type" size="1"';
17335: if ($onchange) {
17336: $typeselectform .= ' onchange="'.$onchange.'"';
17337: }
17338: $typeselectform .= '>'."\n";
1.1237 raeburn 17339: foreach my $posstype ('Course','Community','Placement') {
1.1239 raeburn 17340: my $shown;
17341: if ($posstype eq 'Placement') {
17342: $shown = &mt('Placement Test');
17343: } else {
17344: $shown = &mt($posstype);
17345: }
1.1181 raeburn 17346: $typeselectform.='<option value="'.$posstype.'"'.
1.1239 raeburn 17347: ($posstype eq $crstype ? ' selected="selected" ' : ''). ">".$shown."</option>\n";
1.1181 raeburn 17348: }
17349: $typeselectform.="</select>";
17350: }
17351:
17352: my ($cloneableonlyform,$cloneabletitle);
17353: if (exists($filter->{'cloneableonly'})) {
17354: my $cloneableon = '';
17355: my $cloneableoff = ' checked="checked"';
17356: if ($filter->{'cloneableonly'}) {
17357: $cloneableon = $cloneableoff;
17358: $cloneableoff = '';
17359: }
17360: $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>';
17361: if ($formname eq 'ccrs') {
1.1187 bisitz 17362: $cloneabletitle = &mt('Cloneable for [_1]',$cloneruname.':'.$clonerudom);
1.1181 raeburn 17363: } else {
17364: $cloneabletitle = &mt('Cloneable by you');
17365: }
17366: }
17367: my $officialjs;
17368: if ($crstype eq 'Course') {
17369: if (exists($filter->{'instcodefilter'})) {
1.1182 raeburn 17370: # if (($fixeddom) || ($formname eq 'requestcrs') ||
17371: # ($formname eq 'modifycourse') || ($formname eq 'filterpicker')) {
17372: if ($codedom) {
1.1181 raeburn 17373: $officialjs = 1;
17374: ($instcodeform,$jscript,$$numtitlesref) =
17375: &Apache::courseclassifier::instcode_selectors($codedom,'filterpicker',
17376: $officialjs,$codetitlesref);
17377: if ($jscript) {
1.1182 raeburn 17378: $jscript = '<script type="text/javascript">'."\n".
17379: '// <![CDATA['."\n".
17380: $jscript."\n".
17381: '// ]]>'."\n".
17382: '</script>'."\n";
1.1181 raeburn 17383: }
17384: }
17385: if ($instcodeform eq '') {
17386: $instcodeform =
17387: '<input type="text" name="instcodefilter" size="10" value="'.
17388: $list->{'instcodefilter'}.'" />';
17389: $instcodetitle = $lt{'ins'};
17390: } else {
17391: $instcodetitle = $lt{'inc'};
17392: }
17393: if ($fixeddom) {
17394: $instcodetitle .= '<br />('.$codedom.')';
17395: }
17396: }
17397: }
17398: my $output = qq|
17399: <form method="post" name="filterpicker" action="$action">
17400: <input type="hidden" name="form" value="$formname" />
17401: |;
17402: if ($formname eq 'modifycourse') {
17403: $output .= '<input type="hidden" name="phase" value="courselist" />'."\n".
17404: '<input type="hidden" name="prevphase" value="'.
17405: $prevphase.'" />'."\n";
1.1198 musolffc 17406: } elsif ($formname eq 'quotacheck') {
17407: $output .= qq|
17408: <input type="hidden" name="sortby" value="" />
17409: <input type="hidden" name="sortorder" value="" />
17410: |;
17411: } else {
1.1181 raeburn 17412: my $name_input;
17413: if ($cnameelement ne '') {
17414: $name_input = '<input type="hidden" name="cnameelement" value="'.
17415: $cnameelement.'" />';
17416: }
17417: $output .= qq|
1.1182 raeburn 17418: <input type="hidden" name="cnumelement" value="$cnumelement" />
17419: <input type="hidden" name="cdomelement" value="$cdomelement" />
1.1181 raeburn 17420: $name_input
17421: $roleelement
17422: $multelement
17423: $typeelement
17424: |;
17425: if ($formname eq 'portform') {
17426: $output .= '<input type="hidden" name="setroles" value="'.$setroles.'" />'."\n";
17427: }
17428: }
17429: if ($fixeddom) {
17430: $output .= '<input type="hidden" name="fixeddom" value="'.$fixeddom.'" />'."\n";
17431: }
17432: $output .= "<br />\n".&Apache::lonhtmlcommon::start_pick_box();
17433: if ($sincefilterform) {
17434: $output .= &Apache::lonhtmlcommon::row_title($lt{'cac'})
17435: .$sincefilterform
17436: .&Apache::lonhtmlcommon::row_closure();
17437: }
17438: if ($createdfilterform) {
17439: $output .= &Apache::lonhtmlcommon::row_title($lt{'ccr'})
17440: .$createdfilterform
17441: .&Apache::lonhtmlcommon::row_closure();
17442: }
17443: if ($domainselectform) {
17444: $output .= &Apache::lonhtmlcommon::row_title($lt{'cdo'})
17445: .$domainselectform
17446: .&Apache::lonhtmlcommon::row_closure();
17447: }
17448: if ($typeselectform) {
17449: if (($formname eq 'ccrs') || ($formname eq 'requestcrs')) {
17450: $output .= $typeselectform;
17451: } else {
17452: $output .= &Apache::lonhtmlcommon::row_title($lt{'cog'})
17453: .$typeselectform
17454: .&Apache::lonhtmlcommon::row_closure();
17455: }
17456: }
17457: if ($instcodeform) {
17458: $output .= &Apache::lonhtmlcommon::row_title($instcodetitle)
17459: .$instcodeform
17460: .&Apache::lonhtmlcommon::row_closure();
17461: }
17462: if (exists($filter->{'ownerfilter'})) {
17463: $output .= &Apache::lonhtmlcommon::row_title($lt{'cow'}).
17464: '<table><tr><td>'.&mt('Username').'<br />'.
17465: '<input type="text" name="ownerfilter" size="20" value="'.
17466: $list->{'ownerfilter'}.'" /></td><td>'.&mt('Domain').'<br />'.
17467: $ownerdomselectform.'</td></tr></table>'.
17468: &Apache::lonhtmlcommon::row_closure();
17469: }
17470: if (exists($filter->{'personfilter'})) {
17471: $output .= &Apache::lonhtmlcommon::row_title($lt{'cop'}).
17472: '<table><tr><td>'.&mt('Username').'<br />'.
17473: '<input type="text" name="personfilter" size="20" value="'.
17474: $list->{'personfilter'}.'" /></td><td>'.&mt('Domain').'<br />'.
17475: $persondomselectform.'</td></tr></table>'.
17476: &Apache::lonhtmlcommon::row_closure();
17477: }
17478: if (exists($filter->{'coursefilter'})) {
17479: $output .= &Apache::lonhtmlcommon::row_title(&mt('LON-CAPA course ID'))
17480: .'<input type="text" name="coursefilter" size="25" value="'
17481: .$list->{'coursefilter'}.'" />'
17482: .&Apache::lonhtmlcommon::row_closure();
17483: }
17484: if ($cloneableonlyform) {
17485: $output .= &Apache::lonhtmlcommon::row_title($cloneabletitle).
17486: $cloneableonlyform.&Apache::lonhtmlcommon::row_closure();
17487: }
17488: if (exists($filter->{'descriptfilter'})) {
17489: $output .= &Apache::lonhtmlcommon::row_title($lt{'cde'})
17490: .'<input type="text" name="descriptfilter" size="40" value="'
17491: .$list->{'descriptfilter'}.'" />'
17492: .&Apache::lonhtmlcommon::row_closure(1);
17493: }
17494: $output .= &Apache::lonhtmlcommon::end_pick_box().'<p>'.$clonetext."\n".
17495: '<input type="hidden" name="updater" value="" />'."\n".
17496: '<input type="submit" name="gosearch" value="'.
17497: &mt('Search').'" /></p>'."\n".'</form>'."\n".'<hr />'."\n";
17498: return $jscript.$clonewarning.$output;
17499: }
17500:
17501: =pod
17502:
17503: =item * &timebased_select_form()
17504:
1.1182 raeburn 17505: Create markup for a dropdown list used to select a time-based
1.1181 raeburn 17506: filter e.g., Course Activity, Course Created, when searching for courses
17507: or communities
17508:
17509: Inputs:
17510:
17511: item - name of form element (sincefilter or createdfilter)
17512:
17513: filter - anonymous hash of criteria and their values
17514:
17515: Returns: HTML for a select box contained a blank, then six time selections,
17516: with value set in incoming form variables currently selected.
17517:
17518: Side Effects: None
17519:
17520: =cut
17521:
17522: sub timebased_select_form {
17523: my ($item,$filter) = @_;
17524: if (ref($filter) eq 'HASH') {
17525: $filter->{$item} =~ s/[^\d-]//g;
17526: if (!$filter->{$item}) { $filter->{$item}=-1; }
17527: return &select_form(
17528: $filter->{$item},
17529: $item,
17530: { '-1' => '',
17531: '86400' => &mt('today'),
17532: '604800' => &mt('last week'),
17533: '2592000' => &mt('last month'),
17534: '7776000' => &mt('last three months'),
17535: '15552000' => &mt('last six months'),
17536: '31104000' => &mt('last year'),
17537: 'select_form_order' =>
17538: ['-1','86400','604800','2592000','7776000',
17539: '15552000','31104000']});
17540: }
17541: }
17542:
17543: =pod
17544:
17545: =item * &js_changer()
17546:
17547: Create script tag containing Javascript used to submit course search form
1.1183 raeburn 17548: when course type or domain is changed, and also to hide 'Searching ...' on
17549: page load completion for page showing search result.
1.1181 raeburn 17550:
17551: Inputs: None
17552:
1.1183 raeburn 17553: Returns: markup containing updateFilters() and hideSearching() javascript functions.
1.1181 raeburn 17554:
17555: Side Effects: None
17556:
17557: =cut
17558:
17559: sub js_changer {
17560: return <<ENDJS;
17561: <script type="text/javascript">
17562: // <![CDATA[
17563: function updateFilters(caller) {
17564: if (typeof(caller) != "undefined") {
17565: document.filterpicker.updater.value = caller.name;
17566: }
17567: document.filterpicker.submit();
17568: }
1.1183 raeburn 17569:
17570: function hideSearching() {
17571: if (document.getElementById('searching')) {
17572: document.getElementById('searching').style.display = 'none';
17573: }
17574: return;
17575: }
17576:
1.1181 raeburn 17577: // ]]>
17578: </script>
17579:
17580: ENDJS
17581: }
17582:
17583: =pod
17584:
1.1182 raeburn 17585: =item * &search_courses()
17586:
17587: Process selected filters form course search form and pass to lonnet::courseiddump
17588: to retrieve a hash for which keys are courseIDs which match the selected filters.
17589:
17590: Inputs:
17591:
17592: dom - domain being searched
17593:
17594: type - course type ('Course' or 'Community' or '.' if any).
17595:
17596: filter - anonymous hash of criteria and their values
17597:
17598: numtitles - for institutional codes - number of categories
17599:
17600: cloneruname - optional username of new course owner
17601:
17602: clonerudom - optional domain of new course owner
17603:
1.1221 raeburn 17604: domcloner - optional "domcloner" flag; has value=1 if user has ccc priv in domain being filtered by,
1.1182 raeburn 17605: (used when DC is using course creation form)
17606:
17607: codetitles - reference to array of titles of components in institutional codes (official courses).
17608:
1.1221 raeburn 17609: cc_clone - escaped comma separated list of courses for which course cloner has active CC role
17610: (and so can clone automatically)
17611:
17612: reqcrsdom - domain of new course, where search_courses is used to identify potential courses to clone
17613:
17614: reqinstcode - institutional code of new course, where search_courses is used to identify potential
17615: courses to clone
1.1182 raeburn 17616:
17617: Returns: %courses - hash of courses satisfying search criteria, keys = course IDs, values are corresponding colon-separated escaped description, institutional code, owner and type.
17618:
17619:
17620: Side Effects: None
17621:
17622: =cut
17623:
17624:
17625: sub search_courses {
1.1221 raeburn 17626: my ($dom,$type,$filter,$numtitles,$cloneruname,$clonerudom,$domcloner,$codetitles,
17627: $cc_clone,$reqcrsdom,$reqinstcode) = @_;
1.1182 raeburn 17628: my (%courses,%showcourses,$cloner);
17629: if (($filter->{'ownerfilter'} ne '') ||
17630: ($filter->{'ownerdomfilter'} ne '')) {
17631: $filter->{'combownerfilter'} = $filter->{'ownerfilter'}.':'.
17632: $filter->{'ownerdomfilter'};
17633: }
17634: foreach my $item ('descriptfilter','coursefilter','combownerfilter') {
17635: if (!$filter->{$item}) {
17636: $filter->{$item}='.';
17637: }
17638: }
17639: my $now = time;
17640: my $timefilter =
17641: ($filter->{'sincefilter'}==-1?1:$now-$filter->{'sincefilter'});
17642: my ($createdbefore,$createdafter);
17643: if (($filter->{'createdfilter'} ne '') && ($filter->{'createdfilter'} !=-1)) {
17644: $createdbefore = $now;
17645: $createdafter = $now-$filter->{'createdfilter'};
17646: }
17647: my ($instcodefilter,$regexpok);
17648: if ($numtitles) {
17649: if ($env{'form.official'} eq 'on') {
17650: $instcodefilter =
17651: &Apache::courseclassifier::instcode_search_str($dom,$numtitles,$codetitles);
17652: $regexpok = 1;
17653: } elsif ($env{'form.official'} eq 'off') {
17654: $instcodefilter = &Apache::courseclassifier::instcode_search_str($dom,$numtitles,$codetitles);
17655: unless ($instcodefilter eq '') {
17656: $regexpok = -1;
17657: }
17658: }
17659: } else {
17660: $instcodefilter = $filter->{'instcodefilter'};
17661: }
17662: if ($instcodefilter eq '') { $instcodefilter = '.'; }
17663: if ($type eq '') { $type = '.'; }
17664:
17665: if (($clonerudom ne '') && ($cloneruname ne '')) {
17666: $cloner = $cloneruname.':'.$clonerudom;
17667: }
17668: %courses = &Apache::lonnet::courseiddump($dom,
17669: $filter->{'descriptfilter'},
17670: $timefilter,
17671: $instcodefilter,
17672: $filter->{'combownerfilter'},
17673: $filter->{'coursefilter'},
17674: undef,undef,$type,$regexpok,undef,undef,
1.1221 raeburn 17675: undef,undef,$cloner,$cc_clone,
1.1182 raeburn 17676: $filter->{'cloneableonly'},
17677: $createdbefore,$createdafter,undef,
1.1221 raeburn 17678: $domcloner,undef,$reqcrsdom,$reqinstcode);
1.1182 raeburn 17679: if (($filter->{'personfilter'} ne '') && ($filter->{'persondomfilter'} ne '')) {
17680: my $ccrole;
17681: if ($type eq 'Community') {
17682: $ccrole = 'co';
17683: } else {
17684: $ccrole = 'cc';
17685: }
17686: my %rolehash = &Apache::lonnet::get_my_roles($filter->{'personfilter'},
17687: $filter->{'persondomfilter'},
17688: 'userroles',undef,
17689: [$ccrole,'in','ad','ep','ta','cr'],
17690: $dom);
17691: foreach my $role (keys(%rolehash)) {
17692: my ($cnum,$cdom,$courserole) = split(':',$role);
17693: my $cid = $cdom.'_'.$cnum;
17694: if (exists($courses{$cid})) {
17695: if (ref($courses{$cid}) eq 'HASH') {
17696: if (ref($courses{$cid}{roles}) eq 'ARRAY') {
17697: if (!grep(/^\Q$courserole\E$/,@{$courses{$cid}{roles}})) {
1.1263 raeburn 17698: push(@{$courses{$cid}{roles}},$courserole);
1.1182 raeburn 17699: }
17700: } else {
17701: $courses{$cid}{roles} = [$courserole];
17702: }
17703: $showcourses{$cid} = $courses{$cid};
17704: }
17705: }
17706: }
17707: %courses = %showcourses;
17708: }
17709: return %courses;
17710: }
17711:
17712: =pod
17713:
1.1181 raeburn 17714: =back
17715:
1.1207 raeburn 17716: =head1 Routines for version requirements for current course.
17717:
17718: =over 4
17719:
17720: =item * &check_release_required()
17721:
17722: Compares required LON-CAPA version with version on server, and
17723: if required version is newer looks for a server with the required version.
17724:
17725: Looks first at servers in user's owen domain; if none suitable, looks at
17726: servers in course's domain are permitted to host sessions for user's domain.
17727:
17728: Inputs:
17729:
17730: $loncaparev - Version on current server (format: Major.Minor.Subrelease-datestamp)
17731:
17732: $courseid - Course ID of current course
17733:
17734: $rolecode - User's current role in course (for switchserver query string).
17735:
17736: $required - LON-CAPA version needed by course (format: Major.Minor).
17737:
17738:
17739: Returns:
17740:
17741: $switchserver - query string tp append to /adm/switchserver call (if
17742: current server's LON-CAPA version is too old.
17743:
17744: $warning - Message is displayed if no suitable server could be found.
17745:
17746: =cut
17747:
17748: sub check_release_required {
17749: my ($loncaparev,$courseid,$rolecode,$required) = @_;
17750: my ($switchserver,$warning);
17751: if ($required ne '') {
17752: my ($reqdmajor,$reqdminor) = ($required =~ /^(\d+)\.(\d+)$/);
17753: my ($major,$minor) = ($loncaparev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?$/);
17754: if ($reqdmajor ne '' && $reqdminor ne '') {
17755: my $otherserver;
17756: if (($major eq '' && $minor eq '') ||
17757: (($reqdmajor > $major) || (($reqdmajor == $major) && ($reqdminor > $minor)))) {
17758: my ($userdomserver) = &Apache::lonnet::choose_server($env{'user.domain'},undef,$required,1);
17759: my $switchlcrev =
17760: &Apache::lonnet::get_server_loncaparev($env{'user.domain'},
17761: $userdomserver);
17762: my ($swmajor,$swminor) = ($switchlcrev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?$/);
17763: if (($swmajor eq '' && $swminor eq '') || ($reqdmajor > $swmajor) ||
17764: (($reqdmajor == $swmajor) && ($reqdminor > $swminor))) {
17765: my $cdom = $env{'course.'.$courseid.'.domain'};
17766: if ($cdom ne $env{'user.domain'}) {
17767: my ($coursedomserver,$coursehostname) = &Apache::lonnet::choose_server($cdom,undef,$required,1);
17768: my $serverhomeID = &Apache::lonnet::get_server_homeID($coursehostname);
17769: my $serverhomedom = &Apache::lonnet::host_domain($serverhomeID);
17770: my %defdomdefaults = &Apache::lonnet::get_domain_defaults($serverhomedom);
17771: my %udomdefaults = &Apache::lonnet::get_domain_defaults($env{'user.domain'});
17772: my $remoterev = &Apache::lonnet::get_server_loncaparev($serverhomedom,$coursedomserver);
17773: my $canhost =
17774: &Apache::lonnet::can_host_session($env{'user.domain'},
17775: $coursedomserver,
17776: $remoterev,
17777: $udomdefaults{'remotesessions'},
17778: $defdomdefaults{'hostedsessions'});
17779:
17780: if ($canhost) {
17781: $otherserver = $coursedomserver;
17782: } else {
17783: $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.");
17784: }
17785: } else {
17786: $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).");
17787: }
17788: } else {
17789: $otherserver = $userdomserver;
17790: }
17791: }
17792: if ($otherserver ne '') {
17793: $switchserver = 'otherserver='.$otherserver.'&role='.$rolecode;
17794: }
17795: }
17796: }
17797: return ($switchserver,$warning);
17798: }
17799:
17800: =pod
17801:
17802: =item * &check_release_result()
17803:
17804: Inputs:
17805:
17806: $switchwarning - Warning message if no suitable server found to host session.
17807:
17808: $switchserver - query string to append to /adm/switchserver containing lonHostID
17809: and current role.
17810:
17811: Returns: HTML to display with information about requirement to switch server.
17812: Either displaying warning with link to Roles/Courses screen or
17813: display link to switchserver.
17814:
1.1181 raeburn 17815: =cut
17816:
1.1207 raeburn 17817: sub check_release_result {
17818: my ($switchwarning,$switchserver) = @_;
17819: my $output = &start_page('Selected course unavailable on this server').
17820: '<p class="LC_warning">';
17821: if ($switchwarning) {
17822: $output .= $switchwarning.'<br /><a href="/adm/roles">';
17823: if (&show_course()) {
17824: $output .= &mt('Display courses');
17825: } else {
17826: $output .= &mt('Display roles');
17827: }
17828: $output .= '</a>';
17829: } elsif ($switchserver) {
17830: $output .= &mt('This course requires a newer version of LON-CAPA than is installed on this server.').
17831: '<br />'.
17832: '<a href="/adm/switchserver?'.$switchserver.'">'.
17833: &mt('Switch Server').
17834: '</a>';
17835: }
17836: $output .= '</p>'.&end_page();
17837: return $output;
17838: }
17839:
17840: =pod
17841:
17842: =item * &needs_coursereinit()
17843:
17844: Determine if course contents stored for user's session needs to be
17845: refreshed, because content has changed since "Big Hash" last tied.
17846:
17847: Check for change is made if time last checked is more than 10 minutes ago
17848: (by default).
17849:
17850: Inputs:
17851:
17852: $loncaparev - Version on current server (format: Major.Minor.Subrelease-datestamp)
17853:
17854: $interval (optional) - Time which may elapse (in s) between last check for content
17855: change in current course. (default: 600 s).
17856:
17857: Returns: an array; first element is:
17858:
17859: =over 4
17860:
17861: 'switch' - if content updates mean user's session
17862: needs to be switched to a server running a newer LON-CAPA version
17863:
17864: 'update' - if course session needs to be refreshed (i.e., Big Hash needs to be reloaded)
17865: on current server hosting user's session
17866:
17867: '' - if no action required.
17868:
17869: =back
17870:
17871: If first item element is 'switch':
17872:
17873: second item is $switchwarning - Warning message if no suitable server found to host session.
17874:
17875: third item is $switchserver - query string to append to /adm/switchserver containing lonHostID
17876: and current role.
17877:
17878: otherwise: no other elements returned.
17879:
17880: =back
17881:
17882: =cut
17883:
17884: sub needs_coursereinit {
17885: my ($loncaparev,$interval) = @_;
17886: return() unless ($env{'request.course.id'} && $env{'request.course.tied'});
17887: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
17888: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
17889: my $now = time;
17890: if ($interval eq '') {
17891: $interval = 600;
17892: }
17893: if (($now-$env{'request.course.timechecked'})>$interval) {
1.1282 raeburn 17894: &Apache::lonnet::appenv({'request.course.timechecked'=>$now});
1.1283 raeburn 17895: my $blocked = &blocking_status('reinit',$cnum,$cdom,undef,1);
1.1282 raeburn 17896: if ($blocked) {
17897: return ();
17898: }
1.1207 raeburn 17899: my $lastchange = &Apache::lonnet::get_coursechange($cdom,$cnum);
17900: if ($lastchange > $env{'request.course.tied'}) {
17901: my %curr_reqd_hash = &Apache::lonnet::userenvironment($cdom,$cnum,'internal.releaserequired');
17902: if ($curr_reqd_hash{'internal.releaserequired'} ne '') {
17903: my $required = $env{'course.'.$cdom.'_'.$cnum.'.internal.releaserequired'};
17904: if ($curr_reqd_hash{'internal.releaserequired'} ne $required) {
17905: &Apache::lonnet::appenv({'course.'.$cdom.'_'.$cnum.'.internal.releaserequired' =>
17906: $curr_reqd_hash{'internal.releaserequired'}});
17907: my ($switchserver,$switchwarning) =
17908: &check_release_required($loncaparev,$cdom.'_'.$cnum,$env{'request.role'},
17909: $curr_reqd_hash{'internal.releaserequired'});
17910: if ($switchwarning ne '' || $switchserver ne '') {
17911: return ('switch',$switchwarning,$switchserver);
17912: }
17913: }
17914: }
17915: return ('update');
17916: }
17917: }
17918: return ();
17919: }
1.1181 raeburn 17920:
1.1083 raeburn 17921: sub update_content_constraints {
1.1326 raeburn 17922: my ($cdom,$cnum,$chome,$cid,$keeporder) = @_;
1.1083 raeburn 17923: my %curr_reqd_hash = &Apache::lonnet::userenvironment($cdom,$cnum,'internal.releaserequired');
17924: my ($reqdmajor,$reqdminor) = split(/\./,$curr_reqd_hash{'internal.releaserequired'});
1.1307 raeburn 17925: my (%checkresponsetypes,%checkcrsrestypes);
1.1083 raeburn 17926: foreach my $key (keys(%Apache::lonnet::needsrelease)) {
1.1236 raeburn 17927: my ($item,$name,$value) = split(/:/,$key);
1.1083 raeburn 17928: if ($item eq 'resourcetag') {
17929: if ($name eq 'responsetype') {
17930: $checkresponsetypes{$value} = $Apache::lonnet::needsrelease{$key}
17931: }
1.1307 raeburn 17932: } elsif ($item eq 'course') {
17933: if ($name eq 'courserestype') {
17934: $checkcrsrestypes{$value} = $Apache::lonnet::needsrelease{$key};
17935: }
1.1083 raeburn 17936: }
17937: }
17938: my $navmap = Apache::lonnavmaps::navmap->new();
17939: if (defined($navmap)) {
1.1307 raeburn 17940: my (%allresponses,%allcrsrestypes);
17941: foreach my $res ($navmap->retrieveResources(undef,sub { $_[0]->is_problem() || $_[0]->is_tool() },1,0)) {
17942: if ($res->is_tool()) {
17943: if ($allcrsrestypes{'exttool'}) {
17944: $allcrsrestypes{'exttool'} ++;
17945: } else {
17946: $allcrsrestypes{'exttool'} = 1;
17947: }
17948: next;
17949: }
1.1083 raeburn 17950: my %responses = $res->responseTypes();
17951: foreach my $key (keys(%responses)) {
17952: next unless(exists($checkresponsetypes{$key}));
17953: $allresponses{$key} += $responses{$key};
17954: }
17955: }
17956: foreach my $key (keys(%allresponses)) {
17957: my ($major,$minor) = split(/\./,$checkresponsetypes{$key});
17958: if (($major > $reqdmajor) || ($major == $reqdmajor && $minor > $reqdminor)) {
17959: ($reqdmajor,$reqdminor) = ($major,$minor);
17960: }
17961: }
1.1307 raeburn 17962: foreach my $key (keys(%allcrsrestypes)) {
1.1308 raeburn 17963: my ($major,$minor) = split(/\./,$checkcrsrestypes{$key});
1.1307 raeburn 17964: if (($major > $reqdmajor) || ($major == $reqdmajor && $minor > $reqdminor)) {
17965: ($reqdmajor,$reqdminor) = ($major,$minor);
17966: }
17967: }
1.1083 raeburn 17968: undef($navmap);
17969: }
1.1326 raeburn 17970: my (@resources,@order,@resparms,@zombies);
17971: if ($keeporder) {
17972: use LONCAPA::map;
17973: @resources = @LONCAPA::map::resources;
17974: @order = @LONCAPA::map::order;
17975: @resparms = @LONCAPA::map::resparms;
17976: @zombies = @LONCAPA::map::zombies;
17977: }
1.1308 raeburn 17978: my $suppmap = 'supplemental.sequence';
17979: my ($suppcount,$supptools,$errors) = (0,0,0);
17980: ($suppcount,$supptools,$errors) = &recurse_supplemental($cnum,$cdom,$suppmap,
17981: $suppcount,$supptools,$errors);
1.1326 raeburn 17982: if ($keeporder) {
17983: @LONCAPA::map::resources = @resources;
17984: @LONCAPA::map::order = @order;
17985: @LONCAPA::map::resparms = @resparms;
17986: @LONCAPA::map::zombies = @zombies;
17987: }
1.1308 raeburn 17988: if ($supptools) {
17989: my ($major,$minor) = split(/\./,$checkcrsrestypes{'exttool'});
17990: if (($major > $reqdmajor) || ($major == $reqdmajor && $minor > $reqdminor)) {
17991: ($reqdmajor,$reqdminor) = ($major,$minor);
17992: }
17993: }
1.1083 raeburn 17994: unless (($reqdmajor eq '') && ($reqdminor eq '')) {
17995: &Apache::lonnet::update_released_required($reqdmajor.'.'.$reqdminor,$cdom,$cnum,$chome,$cid);
17996: }
17997: return;
17998: }
17999:
1.1110 raeburn 18000: sub allmaps_incourse {
18001: my ($cdom,$cnum,$chome,$cid) = @_;
18002: if ($cdom eq '' || $cnum eq '' || $chome eq '' || $cid eq '') {
18003: $cid = $env{'request.course.id'};
18004: $cdom = $env{'course.'.$cid.'.domain'};
18005: $cnum = $env{'course.'.$cid.'.num'};
18006: $chome = $env{'course.'.$cid.'.home'};
18007: }
18008: my %allmaps = ();
18009: my $lastchange =
18010: &Apache::lonnet::get_coursechange($cdom,$cnum);
18011: if ($lastchange > $env{'request.course.tied'}) {
18012: my ($furl,$ferr) = &Apache::lonuserstate::readmap("$cdom/$cnum");
18013: unless ($ferr) {
1.1326 raeburn 18014: &update_content_constraints($cdom,$cnum,$chome,$cid,1);
1.1110 raeburn 18015: }
18016: }
18017: my $navmap = Apache::lonnavmaps::navmap->new();
18018: if (defined($navmap)) {
18019: foreach my $res ($navmap->retrieveResources(undef,sub { $_[0]->is_map() },1,0,1)) {
18020: $allmaps{$res->src()} = 1;
18021: }
18022: }
18023: return \%allmaps;
18024: }
18025:
1.1083 raeburn 18026: sub parse_supplemental_title {
18027: my ($title) = @_;
18028:
18029: my ($foldertitle,$renametitle);
18030: if ($title =~ /&&&/) {
18031: $title = &HTML::Entites::decode($title);
18032: }
18033: if ($title =~ m/^(\d+)___&&&___($match_username)___&&&___($match_domain)___&&&___(.*)$/) {
18034: $renametitle=$4;
18035: my ($time,$uname,$udom) = ($1,$2,$3);
18036: $foldertitle=&Apache::lontexconvert::msgtexconverted($4);
18037: my $name = &plainname($uname,$udom);
18038: $name = &HTML::Entities::encode($name,'"<>&\'');
18039: $renametitle = &HTML::Entities::encode($renametitle,'"<>&\'');
18040: $title='<i>'.&Apache::lonlocal::locallocaltime($time).'</i> '.
18041: $name.': <br />'.$foldertitle;
18042: }
18043: if (wantarray) {
18044: return ($title,$foldertitle,$renametitle);
18045: }
18046: return $title;
18047: }
18048:
1.1143 raeburn 18049: sub recurse_supplemental {
1.1308 raeburn 18050: my ($cnum,$cdom,$suppmap,$numfiles,$numexttools,$errors) = @_;
1.1143 raeburn 18051: if ($suppmap) {
18052: my ($errtext,$fatal) = &LONCAPA::map::mapread('/uploaded/'.$cdom.'/'.$cnum.'/'.$suppmap);
18053: if ($fatal) {
18054: $errors ++;
18055: } else {
18056: if ($#LONCAPA::map::resources > 0) {
18057: foreach my $res (@LONCAPA::map::resources) {
18058: my ($title,$src,$ext,$type,$status)=split(/\:/,$res);
18059: if (($src ne '') && ($status eq 'res')) {
1.1146 raeburn 18060: if ($src =~ m{^\Q/uploaded/$cdom/$cnum/\E(supplemental_\d+\.sequence)$}) {
1.1308 raeburn 18061: ($numfiles,$numexttools,$errors) = &recurse_supplemental($cnum,$cdom,$1,
18062: $numfiles,$numexttools,$errors);
1.1143 raeburn 18063: } else {
1.1308 raeburn 18064: if ($src =~ m{^/adm/$cdom/$cnum/\d+/ext\.tool$}) {
18065: $numexttools ++;
18066: }
1.1143 raeburn 18067: $numfiles ++;
18068: }
18069: }
18070: }
18071: }
18072: }
18073: }
1.1308 raeburn 18074: return ($numfiles,$numexttools,$errors);
1.1143 raeburn 18075: }
18076:
1.1101 raeburn 18077: sub symb_to_docspath {
1.1267 raeburn 18078: my ($symb,$navmapref) = @_;
18079: return unless ($symb && ref($navmapref));
1.1101 raeburn 18080: my ($mapurl,$id,$resurl) = &Apache::lonnet::decode_symb($symb);
18081: if ($resurl=~/\.(sequence|page)$/) {
18082: $mapurl=$resurl;
18083: } elsif ($resurl eq 'adm/navmaps') {
18084: $mapurl=$env{'course.'.$env{'request.course.id'}.'.url'};
18085: }
18086: my $mapresobj;
1.1267 raeburn 18087: unless (ref($$navmapref)) {
18088: $$navmapref = Apache::lonnavmaps::navmap->new();
18089: }
18090: if (ref($$navmapref)) {
18091: $mapresobj = $$navmapref->getResourceByUrl($mapurl);
1.1101 raeburn 18092: }
18093: $mapurl=~s{^.*/([^/]+)\.(\w+)$}{$1};
18094: my $type=$2;
18095: my $path;
18096: if (ref($mapresobj)) {
18097: my $pcslist = $mapresobj->map_hierarchy();
18098: if ($pcslist ne '') {
18099: foreach my $pc (split(/,/,$pcslist)) {
18100: next if ($pc <= 1);
1.1267 raeburn 18101: my $res = $$navmapref->getByMapPc($pc);
1.1101 raeburn 18102: if (ref($res)) {
18103: my $thisurl = $res->src();
18104: $thisurl=~s{^.*/([^/]+)\.\w+$}{$1};
18105: my $thistitle = $res->title();
18106: $path .= '&'.
18107: &Apache::lonhtmlcommon::entity_encode($thisurl).'&'.
1.1146 raeburn 18108: &escape($thistitle).
1.1101 raeburn 18109: ':'.$res->randompick().
18110: ':'.$res->randomout().
18111: ':'.$res->encrypted().
18112: ':'.$res->randomorder().
18113: ':'.$res->is_page();
18114: }
18115: }
18116: }
18117: $path =~ s/^\&//;
18118: my $maptitle = $mapresobj->title();
18119: if ($mapurl eq 'default') {
1.1129 raeburn 18120: $maptitle = 'Main Content';
1.1101 raeburn 18121: }
18122: $path .= (($path ne '')? '&' : '').
18123: &Apache::lonhtmlcommon::entity_encode($mapurl).'&'.
1.1146 raeburn 18124: &escape($maptitle).
1.1101 raeburn 18125: ':'.$mapresobj->randompick().
18126: ':'.$mapresobj->randomout().
18127: ':'.$mapresobj->encrypted().
18128: ':'.$mapresobj->randomorder().
18129: ':'.$mapresobj->is_page();
18130: } else {
18131: my $maptitle = &Apache::lonnet::gettitle($mapurl);
18132: my $ispage = (($type eq 'page')? 1 : '');
18133: if ($mapurl eq 'default') {
1.1129 raeburn 18134: $maptitle = 'Main Content';
1.1101 raeburn 18135: }
18136: $path = &Apache::lonhtmlcommon::entity_encode($mapurl).'&'.
1.1146 raeburn 18137: &escape($maptitle).':::::'.$ispage;
1.1101 raeburn 18138: }
18139: unless ($mapurl eq 'default') {
18140: $path = 'default&'.
1.1146 raeburn 18141: &escape('Main Content').
1.1101 raeburn 18142: ':::::&'.$path;
18143: }
18144: return $path;
18145: }
18146:
1.1094 raeburn 18147: sub captcha_display {
1.1327 raeburn 18148: my ($context,$lonhost,$defdom) = @_;
1.1094 raeburn 18149: my ($output,$error);
1.1234 raeburn 18150: my ($captcha,$pubkey,$privkey,$version) =
1.1327 raeburn 18151: &get_captcha_config($context,$lonhost,$defdom);
1.1095 raeburn 18152: if ($captcha eq 'original') {
1.1094 raeburn 18153: $output = &create_captcha();
18154: unless ($output) {
1.1172 raeburn 18155: $error = 'captcha';
1.1094 raeburn 18156: }
18157: } elsif ($captcha eq 'recaptcha') {
1.1234 raeburn 18158: $output = &create_recaptcha($pubkey,$version);
1.1094 raeburn 18159: unless ($output) {
1.1172 raeburn 18160: $error = 'recaptcha';
1.1094 raeburn 18161: }
18162: }
1.1234 raeburn 18163: return ($output,$error,$captcha,$version);
1.1094 raeburn 18164: }
18165:
18166: sub captcha_response {
1.1327 raeburn 18167: my ($context,$lonhost,$defdom) = @_;
1.1094 raeburn 18168: my ($captcha_chk,$captcha_error);
1.1327 raeburn 18169: my ($captcha,$pubkey,$privkey,$version) = &get_captcha_config($context,$lonhost,$defdom);
1.1095 raeburn 18170: if ($captcha eq 'original') {
1.1094 raeburn 18171: ($captcha_chk,$captcha_error) = &check_captcha();
18172: } elsif ($captcha eq 'recaptcha') {
1.1234 raeburn 18173: $captcha_chk = &check_recaptcha($privkey,$version);
1.1094 raeburn 18174: } else {
18175: $captcha_chk = 1;
18176: }
18177: return ($captcha_chk,$captcha_error);
18178: }
18179:
18180: sub get_captcha_config {
1.1327 raeburn 18181: my ($context,$lonhost,$dom_in_effect) = @_;
1.1234 raeburn 18182: my ($captcha,$pubkey,$privkey,$version,$hashtocheck);
1.1094 raeburn 18183: my $hostname = &Apache::lonnet::hostname($lonhost);
18184: my $serverhomeID = &Apache::lonnet::get_server_homeID($hostname);
18185: my $serverhomedom = &Apache::lonnet::host_domain($serverhomeID);
1.1095 raeburn 18186: if ($context eq 'usercreation') {
18187: my %domconfig = &Apache::lonnet::get_dom('configuration',[$context],$serverhomedom);
18188: if (ref($domconfig{$context}) eq 'HASH') {
18189: $hashtocheck = $domconfig{$context}{'cancreate'};
18190: if (ref($hashtocheck) eq 'HASH') {
18191: if ($hashtocheck->{'captcha'} eq 'recaptcha') {
18192: if (ref($hashtocheck->{'recaptchakeys'}) eq 'HASH') {
18193: $pubkey = $hashtocheck->{'recaptchakeys'}{'public'};
18194: $privkey = $hashtocheck->{'recaptchakeys'}{'private'};
18195: }
18196: if ($privkey && $pubkey) {
18197: $captcha = 'recaptcha';
1.1234 raeburn 18198: $version = $hashtocheck->{'recaptchaversion'};
18199: if ($version ne '2') {
18200: $version = 1;
18201: }
1.1095 raeburn 18202: } else {
18203: $captcha = 'original';
18204: }
18205: } elsif ($hashtocheck->{'captcha'} ne 'notused') {
18206: $captcha = 'original';
18207: }
1.1094 raeburn 18208: }
1.1095 raeburn 18209: } else {
18210: $captcha = 'captcha';
18211: }
18212: } elsif ($context eq 'login') {
18213: my %domconfhash = &Apache::loncommon::get_domainconf($serverhomedom);
18214: if ($domconfhash{$serverhomedom.'.login.captcha'} eq 'recaptcha') {
18215: $pubkey = $domconfhash{$serverhomedom.'.login.recaptchakeys_public'};
18216: $privkey = $domconfhash{$serverhomedom.'.login.recaptchakeys_private'};
1.1094 raeburn 18217: if ($privkey && $pubkey) {
18218: $captcha = 'recaptcha';
1.1234 raeburn 18219: $version = $domconfhash{$serverhomedom.'.login.recaptchaversion'};
18220: if ($version ne '2') {
18221: $version = 1;
18222: }
1.1095 raeburn 18223: } else {
18224: $captcha = 'original';
1.1094 raeburn 18225: }
1.1095 raeburn 18226: } elsif ($domconfhash{$serverhomedom.'.login.captcha'} eq 'original') {
18227: $captcha = 'original';
1.1094 raeburn 18228: }
1.1327 raeburn 18229: } elsif ($context eq 'passwords') {
18230: if ($dom_in_effect) {
18231: my %passwdconf = &Apache::lonnet::get_passwdconf($dom_in_effect);
18232: if ($passwdconf{'captcha'} eq 'recaptcha') {
18233: if (ref($passwdconf{'recaptchakeys'}) eq 'HASH') {
18234: $pubkey = $passwdconf{'recaptchakeys'}{'public'};
18235: $privkey = $passwdconf{'recaptchakeys'}{'private'};
18236: }
18237: if ($privkey && $pubkey) {
18238: $captcha = 'recaptcha';
18239: $version = $passwdconf{'recaptchaversion'};
18240: if ($version ne '2') {
18241: $version = 1;
18242: }
18243: } else {
18244: $captcha = 'original';
18245: }
18246: } elsif ($passwdconf{'captcha'} ne 'notused') {
18247: $captcha = 'original';
18248: }
18249: }
18250: }
1.1234 raeburn 18251: return ($captcha,$pubkey,$privkey,$version);
1.1094 raeburn 18252: }
18253:
18254: sub create_captcha {
18255: my %captcha_params = &captcha_settings();
18256: my ($output,$maxtries,$tries) = ('',10,0);
18257: while ($tries < $maxtries) {
18258: $tries ++;
18259: my $captcha = Authen::Captcha->new (
18260: output_folder => $captcha_params{'output_dir'},
18261: data_folder => $captcha_params{'db_dir'},
18262: );
18263: my $md5sum = $captcha->generate_code($captcha_params{'numchars'});
18264:
18265: if (-e $Apache::lonnet::perlvar{'lonCaptchaDir'}.'/'.$md5sum.'.png') {
18266: $output = '<input type="hidden" name="crypt" value="'.$md5sum.'" />'."\n".
18267: &mt('Type in the letters/numbers shown below').' '.
1.1176 raeburn 18268: '<input type="text" size="5" name="code" value="" autocomplete="off" />'.
18269: '<br />'.
18270: '<img src="'.$captcha_params{'www_output_dir'}.'/'.$md5sum.'.png" alt="captcha" />';
1.1094 raeburn 18271: last;
18272: }
18273: }
1.1323 raeburn 18274: if ($output eq '') {
18275: &Apache::lonnet::logthis("Failed to create Captcha code after $tries attempts.");
18276: }
1.1094 raeburn 18277: return $output;
18278: }
18279:
18280: sub captcha_settings {
18281: my %captcha_params = (
18282: output_dir => $Apache::lonnet::perlvar{'lonCaptchaDir'},
18283: www_output_dir => "/captchaspool",
18284: db_dir => $Apache::lonnet::perlvar{'lonCaptchaDb'},
18285: numchars => '5',
18286: );
18287: return %captcha_params;
18288: }
18289:
18290: sub check_captcha {
18291: my ($captcha_chk,$captcha_error);
18292: my $code = $env{'form.code'};
18293: my $md5sum = $env{'form.crypt'};
18294: my %captcha_params = &captcha_settings();
18295: my $captcha = Authen::Captcha->new(
18296: output_folder => $captcha_params{'output_dir'},
18297: data_folder => $captcha_params{'db_dir'},
18298: );
1.1109 raeburn 18299: $captcha_chk = $captcha->check_code($code,$md5sum);
1.1094 raeburn 18300: my %captcha_hash = (
18301: 0 => 'Code not checked (file error)',
18302: -1 => 'Failed: code expired',
18303: -2 => 'Failed: invalid code (not in database)',
18304: -3 => 'Failed: invalid code (code does not match crypt)',
18305: );
18306: if ($captcha_chk != 1) {
18307: $captcha_error = $captcha_hash{$captcha_chk}
18308: }
18309: return ($captcha_chk,$captcha_error);
18310: }
18311:
18312: sub create_recaptcha {
1.1234 raeburn 18313: my ($pubkey,$version) = @_;
18314: if ($version >= 2) {
18315: return '<div class="g-recaptcha" data-sitekey="'.$pubkey.'"></div>';
18316: } else {
18317: my $use_ssl;
18318: if ($ENV{'SERVER_PORT'} == 443) {
18319: $use_ssl = 1;
18320: }
18321: my $captcha = Captcha::reCAPTCHA->new;
18322: return $captcha->get_options_setter({theme => 'white'})."\n".
18323: $captcha->get_html($pubkey,undef,$use_ssl).
18324: &mt('If the text is hard to read, [_1] will replace them.',
18325: '<img src="/res/adm/pages/refresh.gif" alt="reCAPTCHA refresh" />').
18326: '<br /><br />';
18327: }
1.1094 raeburn 18328: }
18329:
18330: sub check_recaptcha {
1.1234 raeburn 18331: my ($privkey,$version) = @_;
1.1094 raeburn 18332: my $captcha_chk;
1.1350 raeburn 18333: my $ip = &Apache::lonnet::get_requestor_ip();
1.1234 raeburn 18334: if ($version >= 2) {
18335: my %info = (
18336: secret => $privkey,
18337: response => $env{'form.g-recaptcha-response'},
1.1350 raeburn 18338: remoteip => $ip,
1.1234 raeburn 18339: );
1.1280 raeburn 18340: my $request=new HTTP::Request('POST','https://www.google.com/recaptcha/api/siteverify');
18341: $request->content(join('&',map {
18342: my $name = escape($_);
18343: "$name=" . ( ref($info{$_}) eq 'ARRAY'
18344: ? join("&$name=", map {escape($_) } @{$info{$_}})
18345: : &escape($info{$_}) );
18346: } keys(%info)));
18347: my $response = &LONCAPA::LWPReq::makerequest('',$request,'','',10,1);
1.1234 raeburn 18348: if ($response->is_success) {
18349: my $data = JSON::DWIW->from_json($response->decoded_content);
18350: if (ref($data) eq 'HASH') {
18351: if ($data->{'success'}) {
18352: $captcha_chk = 1;
18353: }
18354: }
18355: }
18356: } else {
18357: my $captcha = Captcha::reCAPTCHA->new;
18358: my $captcha_result =
18359: $captcha->check_answer(
18360: $privkey,
1.1350 raeburn 18361: $ip,
1.1234 raeburn 18362: $env{'form.recaptcha_challenge_field'},
18363: $env{'form.recaptcha_response_field'},
18364: );
18365: if ($captcha_result->{is_valid}) {
18366: $captcha_chk = 1;
18367: }
1.1094 raeburn 18368: }
18369: return $captcha_chk;
18370: }
18371:
1.1174 raeburn 18372: sub emailusername_info {
1.1244 raeburn 18373: my @fields = ('firstname','lastname','institution','web','location','officialemail','id');
1.1174 raeburn 18374: my %titles = &Apache::lonlocal::texthash (
18375: lastname => 'Last Name',
18376: firstname => 'First Name',
18377: institution => 'School/college/university',
18378: location => "School's city, state/province, country",
18379: web => "School's web address",
18380: officialemail => 'E-mail address at institution (if different)',
1.1244 raeburn 18381: id => 'Student/Employee ID',
1.1174 raeburn 18382: );
18383: return (\@fields,\%titles);
18384: }
18385:
1.1161 raeburn 18386: sub cleanup_html {
18387: my ($incoming) = @_;
18388: my $outgoing;
18389: if ($incoming ne '') {
18390: $outgoing = $incoming;
18391: $outgoing =~ s/;/;/g;
18392: $outgoing =~ s/\#/#/g;
18393: $outgoing =~ s/\&/&/g;
18394: $outgoing =~ s/</</g;
18395: $outgoing =~ s/>/>/g;
18396: $outgoing =~ s/\(/(/g;
18397: $outgoing =~ s/\)/)/g;
18398: $outgoing =~ s/"/"/g;
18399: $outgoing =~ s/'/'/g;
18400: $outgoing =~ s/\$/$/g;
18401: $outgoing =~ s{/}{/}g;
18402: $outgoing =~ s/=/=/g;
18403: $outgoing =~ s/\\/\/g
18404: }
18405: return $outgoing;
18406: }
18407:
1.1190 musolffc 18408: # Checks for critical messages and returns a redirect url if one exists.
18409: # $interval indicates how often to check for messages.
1.1282 raeburn 18410: # $context is the calling context -- roles, grades, contents, menu or flip.
1.1190 musolffc 18411: sub critical_redirect {
1.1282 raeburn 18412: my ($interval,$context) = @_;
1.1356 raeburn 18413: unless (($env{'user.domain'} ne '') && ($env{'user.name'} ne '')) {
18414: return ();
18415: }
1.1190 musolffc 18416: if ((time-$env{'user.criticalcheck.time'})>$interval) {
1.1282 raeburn 18417: if (($env{'request.course.id'}) && (($context eq 'flip') || ($context eq 'contents'))) {
18418: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
18419: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
18420: my $blocked = &blocking_status('alert',$cnum,$cdom,undef,1);
18421: if ($blocked) {
18422: my $checkrole = "cm./$cdom/$cnum";
18423: if ($env{'request.course.sec'} ne '') {
18424: $checkrole .= "/$env{'request.course.sec'}";
18425: }
18426: unless ((&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) &&
18427: ($env{'request.role'} !~ m{^st\./$cdom/$cnum})) {
18428: return;
18429: }
18430: }
18431: }
1.1190 musolffc 18432: my @what=&Apache::lonnet::dump('critical', $env{'user.domain'},
18433: $env{'user.name'});
18434: &Apache::lonnet::appenv({'user.criticalcheck.time'=>time});
1.1191 raeburn 18435: my $redirecturl;
1.1190 musolffc 18436: if ($what[0]) {
1.1356 raeburn 18437: if (($what[0] ne 'con_lost') && ($what[0] ne 'no_such_host') && ($what[0]!~/^error\:/)) {
1.1190 musolffc 18438: $redirecturl='/adm/email?critical=display';
1.1191 raeburn 18439: my $url=&Apache::lonnet::absolute_url().$redirecturl;
18440: return (1, $url);
1.1190 musolffc 18441: }
1.1191 raeburn 18442: }
18443: }
18444: return ();
1.1190 musolffc 18445: }
18446:
1.1174 raeburn 18447: # Use:
18448: # my $answer=reply("encrypt:passwd:$udom:$uname:$upass",$tryserver);
18449: #
18450: ##################################################
18451: # password associated functions #
18452: ##################################################
18453: sub des_keys {
18454: # Make a new key for DES encryption.
18455: # Each key has two parts which are returned separately.
18456: # Please note: Each key must be passed through the &hex function
18457: # before it is output to the web browser. The hex versions cannot
18458: # be used to decrypt.
18459: my @hexstr=('0','1','2','3','4','5','6','7',
18460: '8','9','a','b','c','d','e','f');
18461: my $lkey='';
18462: for (0..7) {
18463: $lkey.=$hexstr[rand(15)];
18464: }
18465: my $ukey='';
18466: for (0..7) {
18467: $ukey.=$hexstr[rand(15)];
18468: }
18469: return ($lkey,$ukey);
18470: }
18471:
18472: sub des_decrypt {
18473: my ($key,$cyphertext) = @_;
18474: my $keybin=pack("H16",$key);
18475: my $cypher;
18476: if ($Crypt::DES::VERSION>=2.03) {
18477: $cypher=new Crypt::DES $keybin;
18478: } else {
18479: $cypher=new DES $keybin;
18480: }
1.1233 raeburn 18481: my $plaintext='';
18482: my $cypherlength = length($cyphertext);
18483: my $numchunks = int($cypherlength/32);
18484: for (my $j=0; $j<$numchunks; $j++) {
18485: my $start = $j*32;
18486: my $cypherblock = substr($cyphertext,$start,32);
18487: my $chunk =
18488: $cypher->decrypt(unpack("a8",pack("H16",substr($cypherblock,0,16))));
18489: $chunk .=
18490: $cypher->decrypt(unpack("a8",pack("H16",substr($cypherblock,16,16))));
18491: $chunk=substr($chunk,1,ord(substr($chunk,0,1)) );
18492: $plaintext .= $chunk;
18493: }
1.1174 raeburn 18494: return $plaintext;
18495: }
18496:
1.1344 raeburn 18497: sub get_requested_shorturls {
1.1309 raeburn 18498: my ($cdom,$cnum,$navmap) = @_;
18499: return unless (ref($navmap));
1.1344 raeburn 18500: my ($numnew,$errors);
1.1309 raeburn 18501: my @toshorten = &Apache::loncommon::get_env_multiple('form.addtiny');
18502: if (@toshorten) {
18503: my (%maps,%resources,%titles);
18504: &Apache::loncourserespicker::enumerate_course_contents($navmap,\%maps,\%resources,\%titles,
18505: 'shorturls',$cdom,$cnum);
18506: if (keys(%resources)) {
1.1344 raeburn 18507: my %tocreate;
1.1309 raeburn 18508: foreach my $item (sort {$a <=> $b} (@toshorten)) {
18509: my $symb = $resources{$item};
18510: if ($symb) {
18511: $tocreate{$cnum.'&'.$symb} = 1;
18512: }
18513: }
1.1344 raeburn 18514: if (keys(%tocreate)) {
18515: ($numnew,$errors) = &make_short_symbs($cdom,$cnum,
18516: \%tocreate);
18517: }
1.1309 raeburn 18518: }
1.1344 raeburn 18519: }
18520: return ($numnew,$errors);
18521: }
18522:
18523: sub make_short_symbs {
18524: my ($cdom,$cnum,$tocreateref,$lockuser) = @_;
18525: my ($numnew,@errors);
18526: if (ref($tocreateref) eq 'HASH') {
18527: my %tocreate = %{$tocreateref};
1.1309 raeburn 18528: if (keys(%tocreate)) {
18529: my %coursetiny = &Apache::lonnet::dump('tiny',$cdom,$cnum);
18530: my $su = Short::URL->new(no_vowels => 1);
18531: my $init = '';
18532: my (%newunique,%addcourse,%courseonly,%failed);
18533: # get lock on tiny db
18534: my $now = time;
1.1344 raeburn 18535: if ($lockuser eq '') {
18536: $lockuser = $env{'user.name'}.':'.$env{'user.domain'};
18537: }
1.1309 raeburn 18538: my $lockhash = {
1.1344 raeburn 18539: "lock\0$now" => $lockuser,
1.1309 raeburn 18540: };
18541: my $tries = 0;
18542: my $gotlock = &Apache::lonnet::newput_dom('tiny',$lockhash,$cdom);
18543: my ($code,$error);
18544: while (($gotlock ne 'ok') && ($tries<3)) {
18545: $tries ++;
18546: sleep 1;
1.1319 raeburn 18547: $gotlock = &Apache::lonnet::newput_dom('tiny',$lockhash,$cdom);
1.1309 raeburn 18548: }
18549: if ($gotlock eq 'ok') {
18550: $init = &shorten_symbs($cdom,$init,$su,\%coursetiny,\%tocreate,\%newunique,
18551: \%addcourse,\%courseonly,\%failed);
18552: if (keys(%failed)) {
18553: my $numfailed = scalar(keys(%failed));
18554: push(@errors,&mt('error: could not obtain unique six character URL for [quant,_1,resource]',$numfailed));
18555: }
18556: if (keys(%newunique)) {
18557: my $putres = &Apache::lonnet::newput_dom('tiny',\%newunique,$cdom);
18558: if ($putres eq 'ok') {
18559: $numnew = scalar(keys(%newunique));
18560: my $newputres = &Apache::lonnet::newput('tiny',\%addcourse,$cdom,$cnum);
18561: unless ($newputres eq 'ok') {
18562: push(@errors,&mt('error: could not store course look-up of short URLs'));
18563: }
18564: } else {
18565: push(@errors,&mt('error: could not store unique six character URLs'));
18566: }
18567: }
18568: my $dellockres = &Apache::lonnet::del_dom('tiny',["lock\0$now"],$cdom);
18569: unless ($dellockres eq 'ok') {
18570: push(@errors,&mt('error: could not release lockfile'));
18571: }
18572: } else {
18573: push(@errors,&mt('error: could not obtain lockfile'));
18574: }
18575: if (keys(%courseonly)) {
18576: my $result = &Apache::lonnet::newput('tiny',\%courseonly,$cdom,$cnum);
18577: if ($result ne 'ok') {
18578: push(@errors,&mt('error: could not update course look-up of short URLs'));
18579: }
18580: }
18581: }
18582: }
18583: return ($numnew,\@errors);
18584: }
18585:
18586: sub shorten_symbs {
18587: my ($cdom,$init,$su,$coursetiny,$tocreate,$newunique,$addcourse,$courseonly,$failed) = @_;
18588: return unless ((ref($su)) && (ref($coursetiny) eq 'HASH') && (ref($tocreate) eq 'HASH') &&
18589: (ref($newunique) eq 'HASH') && (ref($addcourse) eq 'HASH') &&
18590: (ref($courseonly) eq 'HASH') && (ref($failed) eq 'HASH'));
18591: my (%possibles,%collisions);
18592: foreach my $key (keys(%{$tocreate})) {
18593: my $num = String::CRC32::crc32($key);
18594: my $tiny = $su->encode($num,$init);
18595: if ($tiny) {
18596: $possibles{$tiny} = $key;
18597: }
18598: }
18599: if (!$init) {
18600: $init = 1;
18601: } else {
18602: $init ++;
18603: }
18604: if (keys(%possibles)) {
18605: my @posstiny = keys(%possibles);
18606: my $configuname = &Apache::lonnet::get_domainconfiguser($cdom);
18607: my %currtiny = &Apache::lonnet::get('tiny',\@posstiny,$cdom,$configuname);
18608: if (keys(%currtiny)) {
18609: foreach my $key (keys(%currtiny)) {
18610: next if ($currtiny{$key} eq '');
18611: if ($currtiny{$key} eq $possibles{$key}) {
18612: my ($tcnum,$tsymb) = split(/\&/,$currtiny{$key});
18613: unless (($coursetiny->{$tsymb} eq $key) || ($addcourse->{$tsymb} eq $key) || ($courseonly->{$tsymb} eq $key)) {
18614: $courseonly->{$tsymb} = $key;
18615: }
18616: } else {
18617: $collisions{$possibles{$key}} = 1;
18618: }
18619: delete($possibles{$key});
18620: }
18621: }
18622: foreach my $key (keys(%possibles)) {
18623: $newunique->{$key} = $possibles{$key};
18624: my ($tcnum,$tsymb) = split(/\&/,$possibles{$key});
18625: unless (($coursetiny->{$tsymb} eq $key) || ($addcourse->{$tsymb} eq $key) || ($courseonly->{$tsymb} eq $key)) {
18626: $addcourse->{$tsymb} = $key;
18627: }
18628: }
18629: }
18630: if (keys(%collisions)) {
18631: if ($init <5) {
18632: if (!$init) {
18633: $init = 1;
18634: } else {
18635: $init ++;
18636: }
18637: $init = &shorten_symbs($cdom,$init,$su,$coursetiny,\%collisions,
18638: $newunique,$addcourse,$courseonly,$failed);
18639: } else {
18640: foreach my $key (keys(%collisions)) {
18641: $failed->{$key} = 1;
18642: }
18643: }
18644: }
18645: return $init;
18646: }
18647:
1.1328 raeburn 18648: sub is_nonframeable {
1.1329 raeburn 18649: my ($url,$absolute,$hostname,$ip,$nocache) = @_;
18650: my ($remprotocol,$remhost) = ($url =~ m{^(https?)\://(([a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,})}i);
1.1330 raeburn 18651: return if (($remprotocol eq '') || ($remhost eq ''));
1.1329 raeburn 18652:
18653: $remprotocol = lc($remprotocol);
18654: $remhost = lc($remhost);
18655: my $remport = 80;
18656: if ($remprotocol eq 'https') {
18657: $remport = 443;
18658: }
1.1330 raeburn 18659: my ($result,$cached) = &Apache::lonnet::is_cached_new('noiframe',$remhost.':'.$remport);
1.1329 raeburn 18660: if ($cached) {
18661: unless ($nocache) {
18662: if ($result) {
18663: return 1;
18664: } else {
18665: return 0;
18666: }
18667: }
18668: }
1.1328 raeburn 18669: my $uselink;
18670: my $request = new HTTP::Request('HEAD',$url);
18671: my $response = &LONCAPA::LWPReq::makerequest('',$request,'','',5);
18672: if ($response->is_success()) {
18673: my $secpolicy = lc($response->header('content-security-policy'));
18674: my $xframeop = lc($response->header('x-frame-options'));
18675: $secpolicy =~ s/^\s+|\s+$//g;
18676: $xframeop =~ s/^\s+|\s+$//g;
18677: if (($secpolicy ne '') || ($xframeop ne '')) {
1.1329 raeburn 18678: my $remotehost = $remprotocol.'://'.$remhost;
1.1328 raeburn 18679: my ($origin,$protocol,$port);
18680: if ($ENV{'SERVER_PORT'} =~/^\d+$/) {
18681: $port = $ENV{'SERVER_PORT'};
18682: } else {
18683: $port = 80;
18684: }
18685: if ($absolute eq '') {
18686: $protocol = 'http:';
18687: if ($port == 443) {
18688: $protocol = 'https:';
18689: }
18690: $origin = $protocol.'//'.lc($hostname);
18691: } else {
18692: $origin = lc($absolute);
18693: ($protocol,$hostname) = ($absolute =~ m{^(https?:)//([^/]+)$});
18694: }
18695: if (($secpolicy) && ($secpolicy =~ /\Qframe-ancestors\E([^;]*)(;|$)/)) {
18696: my $framepolicy = $1;
18697: $framepolicy =~ s/^\s+|\s+$//g;
18698: my @policies = split(/\s+/,$framepolicy);
18699: if (@policies) {
18700: if (grep(/^\Q'none'\E$/,@policies)) {
18701: $uselink = 1;
18702: } else {
18703: $uselink = 1;
18704: if ((grep(/^\Q*\E$/,@policies)) || (grep(/^\Q$protocol\E$/,@policies)) ||
18705: (($origin ne '') && (grep(/^\Q$origin\E$/,@policies))) ||
18706: (($ip ne '') && (grep(/^\Q$ip\E$/,@policies)))) {
18707: undef($uselink);
18708: }
18709: if ($uselink) {
18710: if (grep(/^\Q'self'\E$/,@policies)) {
18711: if (($origin ne '') && ($remotehost eq $origin)) {
18712: undef($uselink);
18713: }
18714: }
18715: }
18716: if ($uselink) {
18717: my @possok;
18718: if ($ip ne '') {
18719: push(@possok,$ip);
18720: }
18721: my $hoststr = '';
18722: foreach my $part (reverse(split(/\./,$hostname))) {
18723: if ($hoststr eq '') {
18724: $hoststr = $part;
18725: } else {
18726: $hoststr = "$part.$hoststr";
18727: }
18728: if ($hoststr eq $hostname) {
18729: push(@possok,$hostname);
18730: } else {
18731: push(@possok,"*.$hoststr");
18732: }
18733: }
18734: if (@possok) {
18735: foreach my $poss (@possok) {
18736: last if (!$uselink);
18737: foreach my $policy (@policies) {
18738: if ($policy =~ m{^(\Q$protocol\E//|)\Q$poss\E(\Q:$port\E|)$}) {
18739: undef($uselink);
18740: last;
18741: }
18742: }
18743: }
18744: }
18745: }
18746: }
18747: }
18748: } elsif ($xframeop ne '') {
18749: $uselink = 1;
18750: my @policies = split(/\s*,\s*/,$xframeop);
18751: if (@policies) {
18752: unless (grep(/^deny$/,@policies)) {
18753: if ($origin ne '') {
18754: if (grep(/^sameorigin$/,@policies)) {
18755: if ($remotehost eq $origin) {
18756: undef($uselink);
18757: }
18758: }
18759: if ($uselink) {
18760: foreach my $policy (@policies) {
18761: if ($policy =~ /^allow-from\s*(.+)$/) {
18762: my $allowfrom = $1;
18763: if (($allowfrom ne '') && ($allowfrom eq $origin)) {
18764: undef($uselink);
18765: last;
18766: }
18767: }
18768: }
18769: }
18770: }
18771: }
18772: }
18773: }
18774: }
18775: }
1.1329 raeburn 18776: if ($nocache) {
18777: if ($cached) {
18778: my $devalidate;
18779: if ($uselink && !$result) {
18780: $devalidate = 1;
18781: } elsif (!$uselink && $result) {
18782: $devalidate = 1;
18783: }
18784: if ($devalidate) {
18785: &Apache::lonnet::devalidate_cache_new('noiframe',$remhost.':'.$remport);
18786: }
18787: }
18788: } else {
18789: if ($uselink) {
18790: $result = 1;
18791: } else {
18792: $result = 0;
18793: }
18794: &Apache::lonnet::do_cache_new('noiframe',$remhost.':'.$remport,$result,3600);
18795: }
1.1328 raeburn 18796: return $uselink;
18797: }
18798:
1.1359 raeburn 18799: sub page_menu {
18800: my ($menucolls,$menunum) = @_;
18801: my %menu;
18802: foreach my $item (split(/;/,$menucolls)) {
18803: my ($num,$value) = split(/\%/,$item);
18804: if ($num eq $menunum) {
18805: my @entries = split(/\&/,$value);
18806: foreach my $entry (@entries) {
18807: my ($name,$fields) = split(/=/,$entry);
18808: if (($name eq 'top') || ($name eq 'inline') || ($name eq 'main')) {
18809: $menu{$name} = $fields;
18810: } else {
18811: my @shown;
18812: if ($fields =~ /,/) {
18813: @shown = split(/,/,$fields);
18814: } else {
18815: @shown = ($fields);
18816: }
18817: if (@shown) {
18818: foreach my $field (@shown) {
18819: next if ($field eq '');
18820: $menu{$field} = 1;
18821: }
18822: }
18823: }
18824: }
18825: }
18826: }
18827: return %menu;
18828: }
18829:
1.112 bowersj2 18830: 1;
18831: __END__;
1.41 ng 18832:
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