Annotation of loncom/interface/loncommon.pm, revision 1.1350
1.10 albertel 1: # The LearningOnline Network with CAPA
1.1 albertel 2: # a pile of common routines
1.10 albertel 3: #
1.1350 ! raeburn 4: # $Id: loncommon.pm,v 1.1349 2020/11/10 17:19:17 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";
5522: # $uname and $udom decide whose portfolio the user is trying to look at
1.1232 raeburn 5523: if (($activity eq 'port') || ($activity eq 'passwd')) {
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.1062 raeburn 5565: }
1.1061 raeburn 5566: $output .= <<"END_BLOCK";
1.1217 raeburn 5567: <div class='$class'>
1.869 kalberla 5568: <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring'
1.890 droeschl 5569: title='$text'>
5570: <img class='LC_noBorder LC_middle' title='$text' src='/res/adm/pages/comblock.png' alt='$text'/></a>
1.869 kalberla 5571: <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring'
1.890 droeschl 5572: title='$text'>$text</a>
1.867 kalberla 5573: </div>
5574:
5575: END_BLOCK
1.474 raeburn 5576:
1.1061 raeburn 5577: return ($blocked, $output);
1.854 kalberla 5578: }
1.490 raeburn 5579:
1.60 matthew 5580: ###############################################
5581:
1.682 raeburn 5582: sub check_ip_acc {
1.1201 raeburn 5583: my ($acc,$clientip)=@_;
1.682 raeburn 5584: &Apache::lonxml::debug("acc is $acc");
5585: if (!defined($acc) || $acc =~ /^\s*$/ || $acc =~/^\s*no\s*$/i) {
5586: return 1;
5587: }
1.1339 raeburn 5588: my ($ip,$allowed);
5589: if (($ENV{'REMOTE_ADDR'} eq '127.0.0.1') ||
5590: ($ENV{'REMOTE_ADDR'} eq &Apache::lonnet::get_host_ip($Apache::lonnet::perlvar{'lonHostID'}))) {
5591: $ip = $env{'request.host'} || $ENV{'REMOTE_ADDR'} || $clientip;
5592: } else {
1.1350 ! raeburn 5593: my $remote_ip = &Apache::lonnet::get_requestor_ip();
! 5594: $ip = $remote_ip || $env{'request.host'} || $clientip;
1.1339 raeburn 5595: }
1.682 raeburn 5596:
5597: my $name;
1.1219 raeburn 5598: my %access = (
5599: allowfrom => 1,
5600: denyfrom => 0,
5601: );
5602: my @allows;
5603: my @denies;
5604: foreach my $item (split(',',$acc)) {
5605: $item =~ s/^\s*//;
5606: $item =~ s/\s*$//;
5607: my $pattern;
5608: if ($item =~ /^\!(.+)$/) {
5609: push(@denies,$1);
5610: } else {
5611: push(@allows,$item);
5612: }
5613: }
5614: my $numdenies = scalar(@denies);
5615: my $numallows = scalar(@allows);
5616: my $count = 0;
5617: foreach my $pattern (@denies,@allows) {
5618: $count ++;
5619: my $acctype = 'allowfrom';
5620: if ($count <= $numdenies) {
5621: $acctype = 'denyfrom';
5622: }
1.682 raeburn 5623: if ($pattern =~ /\*$/) {
5624: #35.8.*
5625: $pattern=~s/\*//;
1.1219 raeburn 5626: if ($ip =~ /^\Q$pattern\E/) { $allowed=$access{$acctype}; }
1.682 raeburn 5627: } elsif ($pattern =~ /(\d+\.\d+\.\d+)\.\[(\d+)-(\d+)\]$/) {
5628: #35.8.3.[34-56]
5629: my $low=$2;
5630: my $high=$3;
5631: $pattern=$1;
5632: if ($ip =~ /^\Q$pattern\E/) {
5633: my $last=(split(/\./,$ip))[3];
1.1219 raeburn 5634: if ($last <=$high && $last >=$low) { $allowed=$access{$acctype}; }
1.682 raeburn 5635: }
5636: } elsif ($pattern =~ /^\*/) {
5637: #*.msu.edu
5638: $pattern=~s/\*//;
5639: if (!defined($name)) {
5640: use Socket;
5641: my $netaddr=inet_aton($ip);
5642: ($name)=gethostbyaddr($netaddr,AF_INET);
5643: }
1.1219 raeburn 5644: if ($name =~ /\Q$pattern\E$/i) { $allowed=$access{$acctype}; }
1.682 raeburn 5645: } elsif ($pattern =~ /\d+\.\d+\.\d+\.\d+/) {
5646: #127.0.0.1
1.1219 raeburn 5647: if ($ip =~ /^\Q$pattern\E/) { $allowed=$access{$acctype}; }
1.682 raeburn 5648: } else {
5649: #some.name.com
5650: if (!defined($name)) {
5651: use Socket;
5652: my $netaddr=inet_aton($ip);
5653: ($name)=gethostbyaddr($netaddr,AF_INET);
5654: }
1.1219 raeburn 5655: if ($name =~ /\Q$pattern\E$/i) { $allowed=$access{$acctype}; }
5656: }
5657: if ($allowed =~ /^(0|1)$/) { last; }
5658: }
5659: if ($allowed eq '') {
5660: if ($numdenies && !$numallows) {
5661: $allowed = 1;
5662: } else {
5663: $allowed = 0;
1.682 raeburn 5664: }
5665: }
5666: return $allowed;
5667: }
5668:
5669: ###############################################
5670:
1.60 matthew 5671: =pod
5672:
1.112 bowersj2 5673: =head1 Domain Template Functions
5674:
5675: =over 4
5676:
5677: =item * &determinedomain()
1.60 matthew 5678:
5679: Inputs: $domain (usually will be undef)
5680:
1.63 www 5681: Returns: Determines which domain should be used for designs
1.60 matthew 5682:
5683: =cut
1.54 www 5684:
1.60 matthew 5685: ###############################################
1.63 www 5686: sub determinedomain {
5687: my $domain=shift;
1.531 albertel 5688: if (! $domain) {
1.60 matthew 5689: # Determine domain if we have not been given one
1.893 raeburn 5690: $domain = &Apache::lonnet::default_login_domain();
1.258 albertel 5691: if ($env{'user.domain'}) { $domain=$env{'user.domain'}; }
5692: if ($env{'request.role.domain'}) {
5693: $domain=$env{'request.role.domain'};
1.60 matthew 5694: }
5695: }
1.63 www 5696: return $domain;
5697: }
5698: ###############################################
1.517 raeburn 5699:
1.518 albertel 5700: sub devalidate_domconfig_cache {
5701: my ($udom)=@_;
5702: &Apache::lonnet::devalidate_cache_new('domainconfig',$udom);
5703: }
5704:
5705: # ---------------------- Get domain configuration for a domain
5706: sub get_domainconf {
5707: my ($udom) = @_;
5708: my $cachetime=1800;
5709: my ($result,$cached)=&Apache::lonnet::is_cached_new('domainconfig',$udom);
5710: if (defined($cached)) { return %{$result}; }
5711:
5712: my %domconfig = &Apache::lonnet::get_dom('configuration',
1.948 raeburn 5713: ['login','rolecolors','autoenroll'],$udom);
1.632 raeburn 5714: my (%designhash,%legacy);
1.518 albertel 5715: if (keys(%domconfig) > 0) {
5716: if (ref($domconfig{'login'}) eq 'HASH') {
1.632 raeburn 5717: if (keys(%{$domconfig{'login'}})) {
5718: foreach my $key (keys(%{$domconfig{'login'}})) {
1.699 raeburn 5719: if (ref($domconfig{'login'}{$key}) eq 'HASH') {
1.1208 raeburn 5720: if (($key eq 'loginvia') || ($key eq 'headtag')) {
5721: if (ref($domconfig{'login'}{$key}) eq 'HASH') {
5722: foreach my $hostname (keys(%{$domconfig{'login'}{$key}})) {
5723: if (ref($domconfig{'login'}{$key}{$hostname}) eq 'HASH') {
5724: if ($key eq 'loginvia') {
5725: if ($domconfig{'login'}{'loginvia'}{$hostname}{'server'}) {
5726: my $server = $domconfig{'login'}{'loginvia'}{$hostname}{'server'};
5727: $designhash{$udom.'.login.loginvia'} = $server;
5728: if ($domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'} eq 'custom') {
5729:
5730: $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'custompath'};
5731: } else {
5732: $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'};
5733: }
1.948 raeburn 5734: }
1.1208 raeburn 5735: } elsif ($key eq 'headtag') {
5736: if ($domconfig{'login'}{'headtag'}{$hostname}{'url'}) {
5737: $designhash{$udom.'.login.headtag_'.$hostname} = $domconfig{'login'}{'headtag'}{$hostname}{'url'};
1.948 raeburn 5738: }
1.946 raeburn 5739: }
1.1208 raeburn 5740: if ($domconfig{'login'}{$key}{$hostname}{'exempt'}) {
5741: $designhash{$udom.'.login.'.$key.'_exempt_'.$hostname} = $domconfig{'login'}{$key}{$hostname}{'exempt'};
5742: }
1.946 raeburn 5743: }
5744: }
5745: }
5746: } else {
5747: foreach my $img (keys(%{$domconfig{'login'}{$key}})) {
5748: $designhash{$udom.'.login.'.$key.'_'.$img} =
5749: $domconfig{'login'}{$key}{$img};
5750: }
1.699 raeburn 5751: }
5752: } else {
5753: $designhash{$udom.'.login.'.$key}=$domconfig{'login'}{$key};
5754: }
1.632 raeburn 5755: }
5756: } else {
5757: $legacy{'login'} = 1;
1.518 albertel 5758: }
1.632 raeburn 5759: } else {
5760: $legacy{'login'} = 1;
1.518 albertel 5761: }
5762: if (ref($domconfig{'rolecolors'}) eq 'HASH') {
1.632 raeburn 5763: if (keys(%{$domconfig{'rolecolors'}})) {
5764: foreach my $role (keys(%{$domconfig{'rolecolors'}})) {
5765: if (ref($domconfig{'rolecolors'}{$role}) eq 'HASH') {
5766: foreach my $item (keys(%{$domconfig{'rolecolors'}{$role}})) {
5767: $designhash{$udom.'.'.$role.'.'.$item}=$domconfig{'rolecolors'}{$role}{$item};
5768: }
1.518 albertel 5769: }
5770: }
1.632 raeburn 5771: } else {
5772: $legacy{'rolecolors'} = 1;
1.518 albertel 5773: }
1.632 raeburn 5774: } else {
5775: $legacy{'rolecolors'} = 1;
1.518 albertel 5776: }
1.948 raeburn 5777: if (ref($domconfig{'autoenroll'}) eq 'HASH') {
5778: if ($domconfig{'autoenroll'}{'co-owners'}) {
5779: $designhash{$udom.'.autoassign.co-owners'}=$domconfig{'autoenroll'}{'co-owners'};
5780: }
5781: }
1.632 raeburn 5782: if (keys(%legacy) > 0) {
5783: my %legacyhash = &get_legacy_domconf($udom);
5784: foreach my $item (keys(%legacyhash)) {
5785: if ($item =~ /^\Q$udom\E\.login/) {
5786: if ($legacy{'login'}) {
5787: $designhash{$item} = $legacyhash{$item};
5788: }
5789: } else {
5790: if ($legacy{'rolecolors'}) {
5791: $designhash{$item} = $legacyhash{$item};
5792: }
1.518 albertel 5793: }
5794: }
5795: }
1.632 raeburn 5796: } else {
5797: %designhash = &get_legacy_domconf($udom);
1.518 albertel 5798: }
5799: &Apache::lonnet::do_cache_new('domainconfig',$udom,\%designhash,
5800: $cachetime);
5801: return %designhash;
5802: }
5803:
1.632 raeburn 5804: sub get_legacy_domconf {
5805: my ($udom) = @_;
5806: my %legacyhash;
5807: my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
5808: my $designfile = $designdir.'/'.$udom.'.tab';
5809: if (-e $designfile) {
1.1317 raeburn 5810: if ( open (my $fh,'<',$designfile) ) {
1.632 raeburn 5811: while (my $line = <$fh>) {
5812: next if ($line =~ /^\#/);
5813: chomp($line);
5814: my ($key,$val)=(split(/\=/,$line));
5815: if ($val) { $legacyhash{$udom.'.'.$key}=$val; }
5816: }
5817: close($fh);
5818: }
5819: }
1.1026 raeburn 5820: if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/adm/lonDomLogos/'.$udom.'.gif') {
1.632 raeburn 5821: $legacyhash{$udom.'.login.domlogo'} = "/adm/lonDomLogos/$udom.gif";
5822: }
5823: return %legacyhash;
5824: }
5825:
1.63 www 5826: =pod
5827:
1.112 bowersj2 5828: =item * &domainlogo()
1.63 www 5829:
5830: Inputs: $domain (usually will be undef)
5831:
5832: Returns: A link to a domain logo, if the domain logo exists.
5833: If the domain logo does not exist, a description of the domain.
5834:
5835: =cut
1.112 bowersj2 5836:
1.63 www 5837: ###############################################
5838: sub domainlogo {
1.517 raeburn 5839: my $domain = &determinedomain(shift);
1.518 albertel 5840: my %designhash = &get_domainconf($domain);
1.517 raeburn 5841: # See if there is a logo
5842: if ($designhash{$domain.'.login.domlogo'} ne '') {
1.519 raeburn 5843: my $imgsrc = $designhash{$domain.'.login.domlogo'};
1.538 albertel 5844: if ($imgsrc =~ m{^/(adm|res)/}) {
5845: if ($imgsrc =~ m{^/res/}) {
5846: my $local_name = &Apache::lonnet::filelocation('',$imgsrc);
5847: &Apache::lonnet::repcopy($local_name);
5848: }
5849: $imgsrc = &lonhttpdurl($imgsrc);
1.519 raeburn 5850: }
5851: return '<img src="'.$imgsrc.'" alt="'.$domain.'" />';
1.514 albertel 5852: } elsif (defined(&Apache::lonnet::domain($domain,'description'))) {
5853: return &Apache::lonnet::domain($domain,'description');
1.59 www 5854: } else {
1.60 matthew 5855: return '';
1.59 www 5856: }
5857: }
1.63 www 5858: ##############################################
5859:
5860: =pod
5861:
1.112 bowersj2 5862: =item * &designparm()
1.63 www 5863:
5864: Inputs: $which parameter; $domain (usually will be undef)
5865:
5866: Returns: value of designparamter $which
5867:
5868: =cut
1.112 bowersj2 5869:
1.397 albertel 5870:
1.400 albertel 5871: ##############################################
1.397 albertel 5872: sub designparm {
5873: my ($which,$domain)=@_;
5874: if (exists($env{'environment.color.'.$which})) {
1.817 bisitz 5875: return $env{'environment.color.'.$which};
1.96 www 5876: }
1.63 www 5877: $domain=&determinedomain($domain);
1.1016 raeburn 5878: my %domdesign;
5879: unless ($domain eq 'public') {
5880: %domdesign = &get_domainconf($domain);
5881: }
1.520 raeburn 5882: my $output;
1.517 raeburn 5883: if ($domdesign{$domain.'.'.$which} ne '') {
1.817 bisitz 5884: $output = $domdesign{$domain.'.'.$which};
1.63 www 5885: } else {
1.520 raeburn 5886: $output = $defaultdesign{$which};
5887: }
5888: if (($which =~ /^(student|coordinator|author|admin)\.img$/) ||
1.635 raeburn 5889: ($which =~ /login\.(img|logo|domlogo|login)/)) {
1.538 albertel 5890: if ($output =~ m{^/(adm|res)/}) {
1.817 bisitz 5891: if ($output =~ m{^/res/}) {
5892: my $local_name = &Apache::lonnet::filelocation('',$output);
5893: &Apache::lonnet::repcopy($local_name);
5894: }
1.520 raeburn 5895: $output = &lonhttpdurl($output);
5896: }
1.63 www 5897: }
1.520 raeburn 5898: return $output;
1.63 www 5899: }
1.59 www 5900:
1.822 bisitz 5901: ##############################################
5902: =pod
5903:
1.832 bisitz 5904: =item * &authorspace()
5905:
1.1028 raeburn 5906: Inputs: $url (usually will be undef).
1.832 bisitz 5907:
1.1132 raeburn 5908: Returns: Path to Authoring Space containing the resource or
1.1028 raeburn 5909: directory being viewed (or for which action is being taken).
5910: If $url is provided, and begins /priv/<domain>/<uname>
5911: the path will be that portion of the $context argument.
5912: Otherwise the path will be for the author space of the current
5913: user when the current role is author, or for that of the
5914: co-author/assistant co-author space when the current role
5915: is co-author or assistant co-author.
1.832 bisitz 5916:
5917: =cut
5918:
5919: sub authorspace {
1.1028 raeburn 5920: my ($url) = @_;
5921: if ($url ne '') {
5922: if ($url =~ m{^(/priv/$match_domain/$match_username/)}) {
5923: return $1;
5924: }
5925: }
1.832 bisitz 5926: my $caname = '';
1.1024 www 5927: my $cadom = '';
1.1028 raeburn 5928: if ($env{'request.role'} =~ /^(?:ca|aa)/) {
1.1024 www 5929: ($cadom,$caname) =
1.832 bisitz 5930: ($env{'request.role'}=~/($match_domain)\/($match_username)$/);
1.1028 raeburn 5931: } elsif ($env{'request.role'} =~ m{^au\./($match_domain)/}) {
1.832 bisitz 5932: $caname = $env{'user.name'};
1.1024 www 5933: $cadom = $env{'user.domain'};
1.832 bisitz 5934: }
1.1028 raeburn 5935: if (($caname ne '') && ($cadom ne '')) {
5936: return "/priv/$cadom/$caname/";
5937: }
5938: return;
1.832 bisitz 5939: }
5940:
5941: ##############################################
5942: =pod
5943:
1.822 bisitz 5944: =item * &head_subbox()
5945:
5946: Inputs: $content (contains HTML code with page functions, etc.)
5947:
5948: Returns: HTML div with $content
5949: To be included in page header
5950:
5951: =cut
5952:
5953: sub head_subbox {
5954: my ($content)=@_;
5955: my $output =
1.993 raeburn 5956: '<div class="LC_head_subbox">'
1.822 bisitz 5957: .$content
5958: .'</div>'
5959: }
5960:
5961: ##############################################
5962: =pod
5963:
5964: =item * &CSTR_pageheader()
5965:
1.1026 raeburn 5966: Input: (optional) filename from which breadcrumb trail is built.
5967: In most cases no input as needed, as $env{'request.filename'}
5968: is appropriate for use in building the breadcrumb trail.
1.822 bisitz 5969:
5970: Returns: HTML div with CSTR path and recent box
1.1132 raeburn 5971: To be included on Authoring Space pages
1.822 bisitz 5972:
5973: =cut
5974:
5975: sub CSTR_pageheader {
1.1026 raeburn 5976: my ($trailfile) = @_;
5977: if ($trailfile eq '') {
5978: $trailfile = $env{'request.filename'};
5979: }
5980:
5981: # this is for resources; directories have customtitle, and crumbs
5982: # and select recent are created in lonpubdir.pm
5983:
5984: my $londocroot = $Apache::lonnet::perlvar{'lonDocRoot'};
1.1022 www 5985: my ($udom,$uname,$thisdisfn)=
1.1113 raeburn 5986: ($trailfile =~ m{^\Q$londocroot\E/priv/([^/]+)/([^/]+)(?:|/(.*))$});
1.1026 raeburn 5987: my $formaction = "/priv/$udom/$uname/$thisdisfn";
5988: $formaction =~ s{/+}{/}g;
1.822 bisitz 5989:
5990: my $parentpath = '';
5991: my $lastitem = '';
5992: if ($thisdisfn =~ m-(.+/)([^/]*)$-) {
5993: $parentpath = $1;
5994: $lastitem = $2;
5995: } else {
5996: $lastitem = $thisdisfn;
5997: }
1.921 bisitz 5998:
1.1246 raeburn 5999: my ($crsauthor,$title);
6000: if (($env{'request.course.id'}) &&
6001: ($env{'course.'.$env{'request.course.id'}.'.num'} eq $uname) &&
1.1247 raeburn 6002: ($env{'course.'.$env{'request.course.id'}.'.domain'} eq $udom)) {
1.1246 raeburn 6003: $crsauthor = 1;
6004: $title = &mt('Course Authoring Space');
6005: } else {
6006: $title = &mt('Authoring Space');
6007: }
6008:
1.1314 raeburn 6009: my ($target,$crumbtarget) = (' target="_top"','_top'); #FIXME lonpubdir: target="_parent"
1.1313 raeburn 6010: if (($env{'request.lti.login'}) && ($env{'request.lti.target'} eq 'iframe')) {
1.1314 raeburn 6011: $target = '';
6012: $crumbtarget = '';
1.1313 raeburn 6013: }
6014:
1.921 bisitz 6015: my $output =
1.822 bisitz 6016: '<div>'
6017: .&Apache::loncommon::help_open_menu('','',3,'Authoring') #FIXME: Broken? Where is it?
1.1246 raeburn 6018: .'<b>'.$title.'</b> '
1.1314 raeburn 6019: .'<form name="dirs" method="post" action="'.$formaction.'"'.$target.'>'
6020: .&Apache::lonhtmlcommon::crumbs($uname.'/'.$parentpath,$crumbtarget,'/priv/'.$udom,undef,undef);
1.921 bisitz 6021:
6022: if ($lastitem) {
6023: $output .=
6024: '<span class="LC_filename">'
6025: .$lastitem
6026: .'</span>';
6027: }
1.1245 raeburn 6028:
1.1246 raeburn 6029: if ($crsauthor) {
6030: $output .= '</form>'.&Apache::lonmenu::constspaceform();
6031: } else {
6032: $output .=
6033: '<br />'
1.1314 raeburn 6034: #FIXME lonpubdir: &Apache::lonhtmlcommon::crumbs($uname.$thisdisfn.'/',$crumbtarget,'/priv','','+1',1)."</b></tt><br />"
1.1246 raeburn 6035: .&Apache::lonhtmlcommon::select_recent('construct','recent','this.form.action=this.form.recent.value;this.form.submit()')
6036: .'</form>'
6037: .&Apache::lonmenu::constspaceform();
6038: }
6039: $output .= '</div>';
1.921 bisitz 6040:
6041: return $output;
1.822 bisitz 6042: }
6043:
1.60 matthew 6044: ###############################################
6045: ###############################################
6046:
6047: =pod
6048:
1.112 bowersj2 6049: =back
6050:
1.549 albertel 6051: =head1 HTML Helpers
1.112 bowersj2 6052:
6053: =over 4
6054:
6055: =item * &bodytag()
1.60 matthew 6056:
6057: Returns a uniform header for LON-CAPA web pages.
6058:
6059: Inputs:
6060:
1.112 bowersj2 6061: =over 4
6062:
6063: =item * $title, A title to be displayed on the page.
6064:
6065: =item * $function, the current role (can be undef).
6066:
6067: =item * $addentries, extra parameters for the <body> tag.
6068:
6069: =item * $bodyonly, if defined, only return the <body> tag.
6070:
6071: =item * $domain, if defined, force a given domain.
6072:
6073: =item * $forcereg, if page should register as content page (relevant for
1.86 www 6074: text interface only)
1.60 matthew 6075:
1.814 bisitz 6076: =item * $no_nav_bar, if true, keep the 'what is this' info but remove the
6077: navigational links
1.317 albertel 6078:
1.338 albertel 6079: =item * $bgcolor, used to override the bgcolor on a webpage to a specific value
6080:
1.460 albertel 6081: =item * $args, optional argument valid values are
6082: no_auto_mt_title -> prevents &mt()ing the title arg
1.1274 raeburn 6083: use_absolute -> for external resource or syllabus, this will
6084: contain https://<hostname> if server uses
6085: https (as per hosts.tab), but request is for http
6086: hostname -> hostname, from $r->hostname().
1.460 albertel 6087:
1.1096 raeburn 6088: =item * $advtoolsref, optional argument, ref to an array containing
6089: inlineremote items to be added in "Functions" menu below
6090: breadcrumbs.
6091:
1.1316 raeburn 6092: =item * $ltiscope, optional argument, will be one of: resource, map or
6093: course, if LON-CAPA is in LTI Provider context. Value is
6094: the scope of use, i.e., launch was for access to a single, a map
6095: or the entire course.
6096:
6097: =item * $ltiuri, optional argument, if LON-CAPA is in LTI Provider
6098: context, this will contain the URL for the landing item in
6099: the course, after launch from an LTI Consumer
6100:
1.1318 raeburn 6101: =item * $ltimenu, optional argument, if LON-CAPA is in LTI Provider
6102: context, this will contain a reference to hash of items
6103: to be included in the page header and/or inline menu.
6104:
1.112 bowersj2 6105: =back
6106:
1.60 matthew 6107: Returns: A uniform header for LON-CAPA web pages.
6108: If $bodyonly is nonzero, a string containing a <body> tag will be returned.
6109: If $bodyonly is undef or zero, an html string containing a <body> tag and
6110: other decorations will be returned.
6111:
6112: =cut
6113:
1.54 www 6114: sub bodytag {
1.831 bisitz 6115: my ($title,$function,$addentries,$bodyonly,$domain,$forcereg,
1.1318 raeburn 6116: $no_nav_bar,$bgcolor,$args,$advtoolsref,$ltiscope,$ltiuri,$ltimenu)=@_;
1.339 albertel 6117:
1.954 raeburn 6118: my $public;
6119: if ((($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public'))
6120: || ($env{'user.name'} eq '') && ($env{'user.domain'} eq '')) {
6121: $public = 1;
6122: }
1.460 albertel 6123: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
1.1154 raeburn 6124: my $httphost = $args->{'use_absolute'};
1.1274 raeburn 6125: my $hostname = $args->{'hostname'};
1.339 albertel 6126:
1.183 matthew 6127: $function = &get_users_function() if (!$function);
1.339 albertel 6128: my $img = &designparm($function.'.img',$domain);
6129: my $font = &designparm($function.'.font',$domain);
6130: my $pgbg = $bgcolor || &designparm($function.'.pgbg',$domain);
6131:
1.803 bisitz 6132: my %design = ( 'style' => 'margin-top: 0',
1.535 albertel 6133: 'bgcolor' => $pgbg,
1.339 albertel 6134: 'text' => $font,
6135: 'alink' => &designparm($function.'.alink',$domain),
6136: 'vlink' => &designparm($function.'.vlink',$domain),
6137: 'link' => &designparm($function.'.link',$domain),);
1.438 albertel 6138: @design{keys(%$addentries)} = @$addentries{keys(%$addentries)};
1.339 albertel 6139:
1.63 www 6140: # role and realm
1.1178 raeburn 6141: my ($role,$realm) = split(m{\./},$env{'request.role'},2);
6142: if ($realm) {
6143: $realm = '/'.$realm;
6144: }
1.378 raeburn 6145: if ($role eq 'ca') {
1.479 albertel 6146: my ($rdom,$rname) = ($realm =~ m{^/($match_domain)/($match_username)$});
1.500 albertel 6147: $realm = &plainname($rname,$rdom);
1.378 raeburn 6148: }
1.55 www 6149: # realm
1.258 albertel 6150: if ($env{'request.course.id'}) {
1.378 raeburn 6151: if ($env{'request.role'} !~ /^cr/) {
6152: $role = &Apache::lonnet::plaintext($role,&course_type());
1.1257 raeburn 6153: } elsif ($role =~ m{^cr/($match_domain)/\1-domainconfig/(\w+)$}) {
1.1269 raeburn 6154: if ($env{'request.role.desc'}) {
6155: $role = $env{'request.role.desc'};
6156: } else {
6157: $role = &mt('Helpdesk[_1]',' '.$2);
6158: }
1.1257 raeburn 6159: } else {
6160: $role = (split(/\//,$role,4))[-1];
1.378 raeburn 6161: }
1.898 raeburn 6162: if ($env{'request.course.sec'}) {
6163: $role .= (' 'x2).'- '.&mt('section:').' '.$env{'request.course.sec'};
6164: }
1.359 albertel 6165: $realm = $env{'course.'.$env{'request.course.id'}.'.description'};
1.378 raeburn 6166: } else {
6167: $role = &Apache::lonnet::plaintext($role);
1.54 www 6168: }
1.433 albertel 6169:
1.359 albertel 6170: if (!$realm) { $realm=' '; }
1.330 albertel 6171:
1.438 albertel 6172: my $extra_body_attr = &make_attr_string($forcereg,\%design);
1.329 albertel 6173:
1.101 www 6174: # construct main body tag
1.359 albertel 6175: my $bodytag = "<body $extra_body_attr>".
1.1235 raeburn 6176: &Apache::lontexconvert::init_math_support();
1.252 albertel 6177:
1.1131 raeburn 6178: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
6179:
1.1130 raeburn 6180: if (($bodyonly) || ($no_nav_bar) || ($env{'form.inhibitmenu'} eq 'yes')) {
1.60 matthew 6181: return $bodytag;
1.1130 raeburn 6182: }
1.359 albertel 6183:
1.954 raeburn 6184: if ($public) {
1.433 albertel 6185: undef($role);
6186: }
1.1318 raeburn 6187:
6188: if (($env{'request.course.id'}) && ($env{'request.lti.login'})) {
6189: if (ref($ltimenu) eq 'HASH') {
6190: unless ($ltimenu->{'role'}) {
6191: undef($role);
6192: }
6193: unless ($ltimenu->{'coursetitle'}) {
6194: $realm=' ';
6195: }
6196: }
6197: }
6198:
1.762 bisitz 6199: my $titleinfo = '<h1>'.$title.'</h1>';
1.359 albertel 6200: #
6201: # Extra info if you are the DC
6202: my $dc_info = '';
6203: if ($env{'user.adv'} && exists($env{'user.role.dc./'.
6204: $env{'course.'.$env{'request.course.id'}.
6205: '.domain'}.'/'})) {
6206: my $cid = $env{'request.course.id'};
1.917 raeburn 6207: $dc_info = $cid.' '.$env{'course.'.$cid.'.internal.coursecode'};
1.380 www 6208: $dc_info =~ s/\s+$//;
1.359 albertel 6209: }
6210:
1.1237 raeburn 6211: my $crstype;
6212: if ($env{'request.course.id'}) {
6213: $crstype = $env{'course.'.$env{'request.course.id'}.'.type'};
6214: } elsif ($args->{'crstype'}) {
6215: $crstype = $args->{'crstype'};
6216: }
6217: if (($crstype eq 'Placement') && (!$env{'request.role.adv'})) {
6218: undef($role);
6219: } else {
1.1242 raeburn 6220: $role = '<span class="LC_nobreak">('.$role.')</span>' if ($role && !$env{'browser.mobile'});
1.1237 raeburn 6221: }
1.853 droeschl 6222:
1.903 droeschl 6223: if ($env{'request.state'} eq 'construct') { $forcereg=1; }
6224:
6225: # if ($env{'request.state'} eq 'construct') {
6226: # $titleinfo = &CSTR_pageheader(); #FIXME: Will be removed once all scripts have their own calls
6227: # }
6228:
1.1130 raeburn 6229: $bodytag .= Apache::lonhtmlcommon::scripttag(
1.1154 raeburn 6230: Apache::lonmenu::utilityfunctions($httphost), 'start');
1.359 albertel 6231:
1.1318 raeburn 6232: unless ($args->{'no_primary_menu'}) {
6233: my ($left,$right) = Apache::lonmenu::primary_menu($crstype,$ltimenu);
1.359 albertel 6234:
1.1318 raeburn 6235: if ($env{'request.noversionuri'} =~ m{^/res/adm/pages/}) {
6236: if ($dc_info) {
6237: $dc_info = qq|<span class="LC_cusr_subheading">$dc_info</span>|;
6238: }
6239: $bodytag .= qq|<div id="LC_nav_bar">$left $role<br />
6240: <em>$realm</em> $dc_info</div>|;
6241: return $bodytag;
6242: }
1.894 droeschl 6243:
1.1318 raeburn 6244: unless ($env{'request.symb'} =~ m/\.page___\d+___/) {
6245: $bodytag .= qq|<div id="LC_nav_bar">$left $role</div>|;
6246: }
1.916 droeschl 6247:
1.1318 raeburn 6248: $bodytag .= $right;
1.852 droeschl 6249:
1.1318 raeburn 6250: if ($dc_info) {
6251: $dc_info = &dc_courseid_toggle($dc_info);
6252: }
6253: $bodytag .= qq|<div id="LC_realm">$realm $dc_info</div>|;
1.917 raeburn 6254: }
1.916 droeschl 6255:
1.1169 raeburn 6256: #if directed to not display the secondary menu, don't.
1.1168 raeburn 6257: if ($args->{'no_secondary_menu'}) {
6258: return $bodytag;
6259: }
1.1169 raeburn 6260: #don't show menus for public users
1.954 raeburn 6261: if (!$public){
1.1318 raeburn 6262: unless ($args->{'no_inline_menu'}) {
6263: $bodytag .= Apache::lonmenu::secondary_menu($httphost,$ltiscope,$ltimenu,
6264: $args->{'no_primary_menu'});
6265: }
1.903 droeschl 6266: $bodytag .= Apache::lonmenu::serverform();
1.920 raeburn 6267: $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
6268: if ($env{'request.state'} eq 'construct') {
1.962 droeschl 6269: $bodytag .= &Apache::lonmenu::innerregister($forcereg,
1.1316 raeburn 6270: $args->{'bread_crumbs'},'','',$hostname,$ltiscope,$ltiuri);
1.1096 raeburn 6271: } elsif ($forcereg) {
6272: $bodytag .= &Apache::lonmenu::innerregister($forcereg,undef,
1.1258 raeburn 6273: $args->{'group'},
1.1274 raeburn 6274: $args->{'hide_buttons'},
1.1316 raeburn 6275: $hostname,$ltiscope,$ltiuri);
1.1096 raeburn 6276: } else {
6277: $bodytag .=
6278: &Apache::lonmenu::prepare_functions($env{'request.noversionuri'},
6279: $forcereg,$args->{'group'},
6280: $args->{'bread_crumbs'},
1.1274 raeburn 6281: $advtoolsref,'',$hostname);
1.920 raeburn 6282: }
1.903 droeschl 6283: }else{
6284: # this is to seperate menu from content when there's no secondary
6285: # menu. Especially needed for public accessible ressources.
6286: $bodytag .= '<hr style="clear:both" />';
6287: $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
1.235 raeburn 6288: }
1.903 droeschl 6289:
1.235 raeburn 6290: return $bodytag;
1.182 matthew 6291: }
6292:
1.917 raeburn 6293: sub dc_courseid_toggle {
6294: my ($dc_info) = @_;
1.980 raeburn 6295: return ' <span id="dccidtext" class="LC_cusr_subheading LC_nobreak">'.
1.1069 raeburn 6296: '<a href="javascript:showCourseID();" class="LC_menubuttons_link">'.
1.917 raeburn 6297: &mt('(More ...)').'</a></span>'.
6298: '<div id="dccid" class="LC_dccid">'.$dc_info.'</div>';
6299: }
6300:
1.330 albertel 6301: sub make_attr_string {
6302: my ($register,$attr_ref) = @_;
6303:
6304: if ($attr_ref && !ref($attr_ref)) {
6305: die("addentries Must be a hash ref ".
6306: join(':',caller(1))." ".
6307: join(':',caller(0))." ");
6308: }
6309:
6310: if ($register) {
1.339 albertel 6311: my ($on_load,$on_unload);
6312: foreach my $key (keys(%{$attr_ref})) {
6313: if (lc($key) eq 'onload') {
6314: $on_load.=$attr_ref->{$key}.';';
6315: delete($attr_ref->{$key});
6316:
6317: } elsif (lc($key) eq 'onunload') {
6318: $on_unload.=$attr_ref->{$key}.';';
6319: delete($attr_ref->{$key});
6320: }
6321: }
1.953 droeschl 6322: $attr_ref->{'onload'} = $on_load;
6323: $attr_ref->{'onunload'}= $on_unload;
1.330 albertel 6324: }
1.339 albertel 6325:
1.330 albertel 6326: my $attr_string;
1.1159 raeburn 6327: foreach my $attr (sort(keys(%$attr_ref))) {
1.330 albertel 6328: $attr_string .= " $attr=\"".$attr_ref->{$attr}.'" ';
6329: }
6330: return $attr_string;
6331: }
6332:
6333:
1.182 matthew 6334: ###############################################
1.251 albertel 6335: ###############################################
6336:
6337: =pod
6338:
6339: =item * &endbodytag()
6340:
6341: Returns a uniform footer for LON-CAPA web pages.
6342:
1.635 raeburn 6343: Inputs: 1 - optional reference to an args hash
6344: If in the hash, key for noredirectlink has a value which evaluates to true,
6345: a 'Continue' link is not displayed if the page contains an
6346: internal redirect in the <head></head> section,
6347: i.e., $env{'internal.head.redirect'} exists
1.251 albertel 6348:
6349: =cut
6350:
6351: sub endbodytag {
1.635 raeburn 6352: my ($args) = @_;
1.1080 raeburn 6353: my $endbodytag;
6354: unless ((ref($args) eq 'HASH') && ($args->{'notbody'})) {
6355: $endbodytag='</body>';
6356: }
1.315 albertel 6357: if ( exists( $env{'internal.head.redirect'} ) ) {
1.635 raeburn 6358: if (!(ref($args) eq 'HASH' && $args->{'noredirectlink'})) {
6359: $endbodytag=
6360: "<br /><a href=\"$env{'internal.head.redirect'}\">".
6361: &mt('Continue').'</a>'.
6362: $endbodytag;
6363: }
1.315 albertel 6364: }
1.251 albertel 6365: return $endbodytag;
6366: }
6367:
1.352 albertel 6368: =pod
6369:
6370: =item * &standard_css()
6371:
6372: Returns a style sheet
6373:
6374: Inputs: (all optional)
6375: domain -> force to color decorate a page for a specific
6376: domain
6377: function -> force usage of a specific rolish color scheme
6378: bgcolor -> override the default page bgcolor
6379:
6380: =cut
6381:
1.343 albertel 6382: sub standard_css {
1.345 albertel 6383: my ($function,$domain,$bgcolor) = @_;
1.352 albertel 6384: $function = &get_users_function() if (!$function);
6385: my $img = &designparm($function.'.img', $domain);
6386: my $tabbg = &designparm($function.'.tabbg', $domain);
6387: my $font = &designparm($function.'.font', $domain);
1.801 tempelho 6388: my $fontmenu = &designparm($function.'.fontmenu', $domain);
1.791 tempelho 6389: #second colour for later usage
1.345 albertel 6390: my $sidebg = &designparm($function.'.sidebg',$domain);
1.382 albertel 6391: my $pgbg_or_bgcolor =
6392: $bgcolor ||
1.352 albertel 6393: &designparm($function.'.pgbg', $domain);
1.382 albertel 6394: my $pgbg = &designparm($function.'.pgbg', $domain);
1.352 albertel 6395: my $alink = &designparm($function.'.alink', $domain);
6396: my $vlink = &designparm($function.'.vlink', $domain);
6397: my $link = &designparm($function.'.link', $domain);
6398:
1.602 albertel 6399: my $sans = 'Verdana,Arial,Helvetica,sans-serif';
1.395 albertel 6400: my $mono = 'monospace';
1.850 bisitz 6401: my $data_table_head = $sidebg;
6402: my $data_table_light = '#FAFAFA';
1.1060 bisitz 6403: my $data_table_dark = '#E0E0E0';
1.470 banghart 6404: my $data_table_darker = '#CCCCCC';
1.349 albertel 6405: my $data_table_highlight = '#FFFF00';
1.352 albertel 6406: my $mail_new = '#FFBB77';
6407: my $mail_new_hover = '#DD9955';
6408: my $mail_read = '#BBBB77';
6409: my $mail_read_hover = '#999944';
6410: my $mail_replied = '#AAAA88';
6411: my $mail_replied_hover = '#888855';
6412: my $mail_other = '#99BBBB';
6413: my $mail_other_hover = '#669999';
1.391 albertel 6414: my $table_header = '#DDDDDD';
1.489 raeburn 6415: my $feedback_link_bg = '#BBBBBB';
1.911 bisitz 6416: my $lg_border_color = '#C8C8C8';
1.952 onken 6417: my $button_hover = '#BF2317';
1.392 albertel 6418:
1.608 albertel 6419: my $border = ($env{'browser.type'} eq 'explorer' ||
1.911 bisitz 6420: $env{'browser.type'} eq 'safari' ) ? '0 2px 0 2px'
6421: : '0 3px 0 4px';
1.448 albertel 6422:
1.523 albertel 6423:
1.343 albertel 6424: return <<END;
1.947 droeschl 6425:
6426: /* needed for iframe to allow 100% height in FF */
6427: body, html {
6428: margin: 0;
6429: padding: 0 0.5%;
6430: height: 99%; /* to avoid scrollbars */
6431: }
6432:
1.795 www 6433: body {
1.911 bisitz 6434: font-family: $sans;
6435: line-height:130%;
6436: font-size:0.83em;
6437: color:$font;
1.795 www 6438: }
6439:
1.959 onken 6440: a:focus,
6441: a:focus img {
1.795 www 6442: color: red;
6443: }
1.698 harmsja 6444:
1.911 bisitz 6445: form, .inline {
6446: display: inline;
1.795 www 6447: }
1.721 harmsja 6448:
1.795 www 6449: .LC_right {
1.911 bisitz 6450: text-align:right;
1.795 www 6451: }
6452:
6453: .LC_middle {
1.911 bisitz 6454: vertical-align:middle;
1.795 www 6455: }
1.721 harmsja 6456:
1.1130 raeburn 6457: .LC_floatleft {
6458: float: left;
6459: }
6460:
6461: .LC_floatright {
6462: float: right;
6463: }
6464:
1.911 bisitz 6465: .LC_400Box {
6466: width:400px;
6467: }
1.721 harmsja 6468:
1.947 droeschl 6469: .LC_iframecontainer {
6470: width: 98%;
6471: margin: 0;
6472: position: fixed;
6473: top: 8.5em;
6474: bottom: 0;
6475: }
6476:
6477: .LC_iframecontainer iframe{
6478: border: none;
6479: width: 100%;
6480: height: 100%;
6481: }
6482:
1.778 bisitz 6483: .LC_filename {
6484: font-family: $mono;
6485: white-space:pre;
1.921 bisitz 6486: font-size: 120%;
1.778 bisitz 6487: }
6488:
6489: .LC_fileicon {
6490: border: none;
6491: height: 1.3em;
6492: vertical-align: text-bottom;
6493: margin-right: 0.3em;
6494: text-decoration:none;
6495: }
6496:
1.1008 www 6497: .LC_setting {
6498: text-decoration:underline;
6499: }
6500:
1.350 albertel 6501: .LC_error {
6502: color: red;
6503: }
1.795 www 6504:
1.1097 bisitz 6505: .LC_warning {
6506: color: darkorange;
6507: }
6508:
1.457 albertel 6509: .LC_diff_removed {
1.733 bisitz 6510: color: red;
1.394 albertel 6511: }
1.532 albertel 6512:
6513: .LC_info,
1.457 albertel 6514: .LC_success,
6515: .LC_diff_added {
1.350 albertel 6516: color: green;
6517: }
1.795 www 6518:
1.802 bisitz 6519: div.LC_confirm_box {
6520: background-color: #FAFAFA;
6521: border: 1px solid $lg_border_color;
6522: margin-right: 0;
6523: padding: 5px;
6524: }
6525:
6526: div.LC_confirm_box .LC_error img,
6527: div.LC_confirm_box .LC_success img {
6528: vertical-align: middle;
6529: }
6530:
1.1242 raeburn 6531: .LC_maxwidth {
6532: max-width: 100%;
6533: height: auto;
6534: }
6535:
1.1243 raeburn 6536: .LC_textsize_mobile {
6537: \@media only screen and (max-device-width: 480px) {
6538: -webkit-text-size-adjust:100%; -moz-text-size-adjust:100%; -ms-text-size-adjust:100%;
6539: }
6540: }
6541:
1.440 albertel 6542: .LC_icon {
1.771 droeschl 6543: border: none;
1.790 droeschl 6544: vertical-align: middle;
1.771 droeschl 6545: }
6546:
1.543 albertel 6547: .LC_docs_spacer {
6548: width: 25px;
6549: height: 1px;
1.771 droeschl 6550: border: none;
1.543 albertel 6551: }
1.346 albertel 6552:
1.532 albertel 6553: .LC_internal_info {
1.735 bisitz 6554: color: #999999;
1.532 albertel 6555: }
6556:
1.794 www 6557: .LC_discussion {
1.1050 www 6558: background: $data_table_dark;
1.911 bisitz 6559: border: 1px solid black;
6560: margin: 2px;
1.794 www 6561: }
6562:
6563: .LC_disc_action_left {
1.1050 www 6564: background: $sidebg;
1.911 bisitz 6565: text-align: left;
1.1050 www 6566: padding: 4px;
6567: margin: 2px;
1.794 www 6568: }
6569:
6570: .LC_disc_action_right {
1.1050 www 6571: background: $sidebg;
1.911 bisitz 6572: text-align: right;
1.1050 www 6573: padding: 4px;
6574: margin: 2px;
1.794 www 6575: }
6576:
6577: .LC_disc_new_item {
1.911 bisitz 6578: background: white;
6579: border: 2px solid red;
1.1050 www 6580: margin: 4px;
6581: padding: 4px;
1.794 www 6582: }
6583:
6584: .LC_disc_old_item {
1.911 bisitz 6585: background: white;
1.1050 www 6586: margin: 4px;
6587: padding: 4px;
1.794 www 6588: }
6589:
1.458 albertel 6590: table.LC_pastsubmission {
6591: border: 1px solid black;
6592: margin: 2px;
6593: }
6594:
1.924 bisitz 6595: table#LC_menubuttons {
1.345 albertel 6596: width: 100%;
6597: background: $pgbg;
1.392 albertel 6598: border: 2px;
1.402 albertel 6599: border-collapse: separate;
1.803 bisitz 6600: padding: 0;
1.345 albertel 6601: }
1.392 albertel 6602:
1.801 tempelho 6603: table#LC_title_bar a {
6604: color: $fontmenu;
6605: }
1.836 bisitz 6606:
1.807 droeschl 6607: table#LC_title_bar {
1.819 tempelho 6608: clear: both;
1.836 bisitz 6609: display: none;
1.807 droeschl 6610: }
6611:
1.795 www 6612: table#LC_title_bar,
1.933 droeschl 6613: table.LC_breadcrumbs, /* obsolete? */
1.393 albertel 6614: table#LC_title_bar.LC_with_remote {
1.359 albertel 6615: width: 100%;
1.392 albertel 6616: border-color: $pgbg;
6617: border-style: solid;
6618: border-width: $border;
1.379 albertel 6619: background: $pgbg;
1.801 tempelho 6620: color: $fontmenu;
1.392 albertel 6621: border-collapse: collapse;
1.803 bisitz 6622: padding: 0;
1.819 tempelho 6623: margin: 0;
1.359 albertel 6624: }
1.795 www 6625:
1.933 droeschl 6626: ul.LC_breadcrumb_tools_outerlist {
1.913 droeschl 6627: margin: 0;
6628: padding: 0;
1.933 droeschl 6629: position: relative;
6630: list-style: none;
1.913 droeschl 6631: }
1.933 droeschl 6632: ul.LC_breadcrumb_tools_outerlist li {
1.913 droeschl 6633: display: inline;
6634: }
1.933 droeschl 6635:
6636: .LC_breadcrumb_tools_navigation {
1.913 droeschl 6637: padding: 0;
1.933 droeschl 6638: margin: 0;
6639: float: left;
1.913 droeschl 6640: }
1.933 droeschl 6641: .LC_breadcrumb_tools_tools {
6642: padding: 0;
6643: margin: 0;
1.913 droeschl 6644: float: right;
6645: }
6646:
1.1240 raeburn 6647: .LC_placement_prog {
6648: padding-right: 20px;
6649: font-weight: bold;
6650: font-size: 90%;
6651: }
6652:
1.359 albertel 6653: table#LC_title_bar td {
6654: background: $tabbg;
6655: }
1.795 www 6656:
1.911 bisitz 6657: table#LC_menubuttons img {
1.803 bisitz 6658: border: none;
1.346 albertel 6659: }
1.795 www 6660:
1.842 droeschl 6661: .LC_breadcrumbs_component {
1.911 bisitz 6662: float: right;
6663: margin: 0 1em;
1.357 albertel 6664: }
1.842 droeschl 6665: .LC_breadcrumbs_component img {
1.911 bisitz 6666: vertical-align: middle;
1.777 tempelho 6667: }
1.795 www 6668:
1.1243 raeburn 6669: .LC_breadcrumbs_hoverable {
6670: background: $sidebg;
6671: }
6672:
1.383 albertel 6673: td.LC_table_cell_checkbox {
6674: text-align: center;
6675: }
1.795 www 6676:
6677: .LC_fontsize_small {
1.911 bisitz 6678: font-size: 70%;
1.705 tempelho 6679: }
6680:
1.844 bisitz 6681: #LC_breadcrumbs {
1.911 bisitz 6682: clear:both;
6683: background: $sidebg;
6684: border-bottom: 1px solid $lg_border_color;
6685: line-height: 2.5em;
1.933 droeschl 6686: overflow: hidden;
1.911 bisitz 6687: margin: 0;
6688: padding: 0;
1.995 raeburn 6689: text-align: left;
1.819 tempelho 6690: }
1.862 bisitz 6691:
1.1098 bisitz 6692: .LC_head_subbox, .LC_actionbox {
1.911 bisitz 6693: clear:both;
6694: background: #F8F8F8; /* $sidebg; */
1.915 droeschl 6695: border: 1px solid $sidebg;
1.1098 bisitz 6696: margin: 0 0 10px 0;
1.966 bisitz 6697: padding: 3px;
1.995 raeburn 6698: text-align: left;
1.822 bisitz 6699: }
6700:
1.795 www 6701: .LC_fontsize_medium {
1.911 bisitz 6702: font-size: 85%;
1.705 tempelho 6703: }
6704:
1.795 www 6705: .LC_fontsize_large {
1.911 bisitz 6706: font-size: 120%;
1.705 tempelho 6707: }
6708:
1.346 albertel 6709: .LC_menubuttons_inline_text {
6710: color: $font;
1.698 harmsja 6711: font-size: 90%;
1.701 harmsja 6712: padding-left:3px;
1.346 albertel 6713: }
6714:
1.934 droeschl 6715: .LC_menubuttons_inline_text img{
6716: vertical-align: middle;
6717: }
6718:
1.1051 www 6719: li.LC_menubuttons_inline_text img {
1.951 onken 6720: cursor:pointer;
1.1002 droeschl 6721: text-decoration: none;
1.951 onken 6722: }
6723:
1.526 www 6724: .LC_menubuttons_link {
6725: text-decoration: none;
6726: }
1.795 www 6727:
1.522 albertel 6728: .LC_menubuttons_category {
1.521 www 6729: color: $font;
1.526 www 6730: background: $pgbg;
1.521 www 6731: font-size: larger;
6732: font-weight: bold;
6733: }
6734:
1.346 albertel 6735: td.LC_menubuttons_text {
1.911 bisitz 6736: color: $font;
1.346 albertel 6737: }
1.706 harmsja 6738:
1.346 albertel 6739: .LC_current_location {
6740: background: $tabbg;
6741: }
1.795 www 6742:
1.1286 raeburn 6743: td.LC_zero_height {
6744: line-height: 0;
6745: cellpadding: 0;
6746: }
6747:
1.938 bisitz 6748: table.LC_data_table {
1.347 albertel 6749: border: 1px solid #000000;
1.402 albertel 6750: border-collapse: separate;
1.426 albertel 6751: border-spacing: 1px;
1.610 albertel 6752: background: $pgbg;
1.347 albertel 6753: }
1.795 www 6754:
1.422 albertel 6755: .LC_data_table_dense {
6756: font-size: small;
6757: }
1.795 www 6758:
1.507 raeburn 6759: table.LC_nested_outer {
6760: border: 1px solid #000000;
1.589 raeburn 6761: border-collapse: collapse;
1.803 bisitz 6762: border-spacing: 0;
1.507 raeburn 6763: width: 100%;
6764: }
1.795 www 6765:
1.879 raeburn 6766: table.LC_innerpickbox,
1.507 raeburn 6767: table.LC_nested {
1.803 bisitz 6768: border: none;
1.589 raeburn 6769: border-collapse: collapse;
1.803 bisitz 6770: border-spacing: 0;
1.507 raeburn 6771: width: 100%;
6772: }
1.795 www 6773:
1.911 bisitz 6774: table.LC_data_table tr th,
6775: table.LC_calendar tr th,
1.879 raeburn 6776: table.LC_prior_tries tr th,
6777: table.LC_innerpickbox tr th {
1.349 albertel 6778: font-weight: bold;
6779: background-color: $data_table_head;
1.801 tempelho 6780: color:$fontmenu;
1.701 harmsja 6781: font-size:90%;
1.347 albertel 6782: }
1.795 www 6783:
1.879 raeburn 6784: table.LC_innerpickbox tr th,
6785: table.LC_innerpickbox tr td {
6786: vertical-align: top;
6787: }
6788:
1.711 raeburn 6789: table.LC_data_table tr.LC_info_row > td {
1.735 bisitz 6790: background-color: #CCCCCC;
1.711 raeburn 6791: font-weight: bold;
6792: text-align: left;
6793: }
1.795 www 6794:
1.912 bisitz 6795: table.LC_data_table tr.LC_odd_row > td {
6796: background-color: $data_table_light;
6797: padding: 2px;
6798: vertical-align: top;
6799: }
6800:
1.809 bisitz 6801: table.LC_pick_box tr > td.LC_odd_row {
1.349 albertel 6802: background-color: $data_table_light;
1.912 bisitz 6803: vertical-align: top;
6804: }
6805:
6806: table.LC_data_table tr.LC_even_row > td {
6807: background-color: $data_table_dark;
1.425 albertel 6808: padding: 2px;
1.900 bisitz 6809: vertical-align: top;
1.347 albertel 6810: }
1.795 www 6811:
1.809 bisitz 6812: table.LC_pick_box tr > td.LC_even_row {
1.349 albertel 6813: background-color: $data_table_dark;
1.900 bisitz 6814: vertical-align: top;
1.347 albertel 6815: }
1.795 www 6816:
1.425 albertel 6817: table.LC_data_table tr.LC_data_table_highlight td {
6818: background-color: $data_table_darker;
6819: }
1.795 www 6820:
1.639 raeburn 6821: table.LC_data_table tr td.LC_leftcol_header {
6822: background-color: $data_table_head;
6823: font-weight: bold;
6824: }
1.795 www 6825:
1.451 albertel 6826: table.LC_data_table tr.LC_empty_row td,
1.507 raeburn 6827: table.LC_nested tr.LC_empty_row td {
1.421 albertel 6828: font-weight: bold;
6829: font-style: italic;
6830: text-align: center;
6831: padding: 8px;
1.347 albertel 6832: }
1.795 www 6833:
1.1114 raeburn 6834: table.LC_data_table tr.LC_empty_row td,
6835: table.LC_data_table tr.LC_footer_row td {
1.940 bisitz 6836: background-color: $sidebg;
6837: }
6838:
6839: table.LC_nested tr.LC_empty_row td {
6840: background-color: #FFFFFF;
6841: }
6842:
1.890 droeschl 6843: table.LC_caption {
6844: }
6845:
1.507 raeburn 6846: table.LC_nested tr.LC_empty_row td {
1.465 albertel 6847: padding: 4ex
6848: }
1.795 www 6849:
1.507 raeburn 6850: table.LC_nested_outer tr th {
6851: font-weight: bold;
1.801 tempelho 6852: color:$fontmenu;
1.507 raeburn 6853: background-color: $data_table_head;
1.701 harmsja 6854: font-size: small;
1.507 raeburn 6855: border-bottom: 1px solid #000000;
6856: }
1.795 www 6857:
1.507 raeburn 6858: table.LC_nested_outer tr td.LC_subheader {
6859: background-color: $data_table_head;
6860: font-weight: bold;
6861: font-size: small;
6862: border-bottom: 1px solid #000000;
6863: text-align: right;
1.451 albertel 6864: }
1.795 www 6865:
1.507 raeburn 6866: table.LC_nested tr.LC_info_row td {
1.735 bisitz 6867: background-color: #CCCCCC;
1.451 albertel 6868: font-weight: bold;
6869: font-size: small;
1.507 raeburn 6870: text-align: center;
6871: }
1.795 www 6872:
1.589 raeburn 6873: table.LC_nested tr.LC_info_row td.LC_left_item,
6874: table.LC_nested_outer tr th.LC_left_item {
1.507 raeburn 6875: text-align: left;
1.451 albertel 6876: }
1.795 www 6877:
1.507 raeburn 6878: table.LC_nested td {
1.735 bisitz 6879: background-color: #FFFFFF;
1.451 albertel 6880: font-size: small;
1.507 raeburn 6881: }
1.795 www 6882:
1.507 raeburn 6883: table.LC_nested_outer tr th.LC_right_item,
6884: table.LC_nested tr.LC_info_row td.LC_right_item,
6885: table.LC_nested tr.LC_odd_row td.LC_right_item,
6886: table.LC_nested tr td.LC_right_item {
1.451 albertel 6887: text-align: right;
6888: }
6889:
1.507 raeburn 6890: table.LC_nested tr.LC_odd_row td {
1.735 bisitz 6891: background-color: #EEEEEE;
1.451 albertel 6892: }
6893:
1.473 raeburn 6894: table.LC_createuser {
6895: }
6896:
6897: table.LC_createuser tr.LC_section_row td {
1.701 harmsja 6898: font-size: small;
1.473 raeburn 6899: }
6900:
6901: table.LC_createuser tr.LC_info_row td {
1.735 bisitz 6902: background-color: #CCCCCC;
1.473 raeburn 6903: font-weight: bold;
6904: text-align: center;
6905: }
6906:
1.349 albertel 6907: table.LC_calendar {
6908: border: 1px solid #000000;
6909: border-collapse: collapse;
1.917 raeburn 6910: width: 98%;
1.349 albertel 6911: }
1.795 www 6912:
1.349 albertel 6913: table.LC_calendar_pickdate {
6914: font-size: xx-small;
6915: }
1.795 www 6916:
1.349 albertel 6917: table.LC_calendar tr td {
6918: border: 1px solid #000000;
6919: vertical-align: top;
1.917 raeburn 6920: width: 14%;
1.349 albertel 6921: }
1.795 www 6922:
1.349 albertel 6923: table.LC_calendar tr td.LC_calendar_day_empty {
6924: background-color: $data_table_dark;
6925: }
1.795 www 6926:
1.779 bisitz 6927: table.LC_calendar tr td.LC_calendar_day_current {
6928: background-color: $data_table_highlight;
1.777 tempelho 6929: }
1.795 www 6930:
1.938 bisitz 6931: table.LC_data_table tr td.LC_mail_new {
1.349 albertel 6932: background-color: $mail_new;
6933: }
1.795 www 6934:
1.938 bisitz 6935: table.LC_data_table tr.LC_mail_new:hover {
1.349 albertel 6936: background-color: $mail_new_hover;
6937: }
1.795 www 6938:
1.938 bisitz 6939: table.LC_data_table tr td.LC_mail_read {
1.349 albertel 6940: background-color: $mail_read;
6941: }
1.795 www 6942:
1.938 bisitz 6943: /*
6944: table.LC_data_table tr.LC_mail_read:hover {
1.349 albertel 6945: background-color: $mail_read_hover;
6946: }
1.938 bisitz 6947: */
1.795 www 6948:
1.938 bisitz 6949: table.LC_data_table tr td.LC_mail_replied {
1.349 albertel 6950: background-color: $mail_replied;
6951: }
1.795 www 6952:
1.938 bisitz 6953: /*
6954: table.LC_data_table tr.LC_mail_replied:hover {
1.349 albertel 6955: background-color: $mail_replied_hover;
6956: }
1.938 bisitz 6957: */
1.795 www 6958:
1.938 bisitz 6959: table.LC_data_table tr td.LC_mail_other {
1.349 albertel 6960: background-color: $mail_other;
6961: }
1.795 www 6962:
1.938 bisitz 6963: /*
6964: table.LC_data_table tr.LC_mail_other:hover {
1.349 albertel 6965: background-color: $mail_other_hover;
6966: }
1.938 bisitz 6967: */
1.494 raeburn 6968:
1.777 tempelho 6969: table.LC_data_table tr > td.LC_browser_file,
6970: table.LC_data_table tr > td.LC_browser_file_published {
1.899 bisitz 6971: background: #AAEE77;
1.389 albertel 6972: }
1.795 www 6973:
1.777 tempelho 6974: table.LC_data_table tr > td.LC_browser_file_locked,
6975: table.LC_data_table tr > td.LC_browser_file_unpublished {
1.389 albertel 6976: background: #FFAA99;
1.387 albertel 6977: }
1.795 www 6978:
1.777 tempelho 6979: table.LC_data_table tr > td.LC_browser_file_obsolete {
1.899 bisitz 6980: background: #888888;
1.779 bisitz 6981: }
1.795 www 6982:
1.777 tempelho 6983: table.LC_data_table tr > td.LC_browser_file_modified,
1.779 bisitz 6984: table.LC_data_table tr > td.LC_browser_file_metamodified {
1.899 bisitz 6985: background: #F8F866;
1.777 tempelho 6986: }
1.795 www 6987:
1.696 bisitz 6988: table.LC_data_table tr.LC_browser_folder > td {
1.899 bisitz 6989: background: #E0E8FF;
1.387 albertel 6990: }
1.696 bisitz 6991:
1.707 bisitz 6992: table.LC_data_table tr > td.LC_roles_is {
1.911 bisitz 6993: /* background: #77FF77; */
1.707 bisitz 6994: }
1.795 www 6995:
1.707 bisitz 6996: table.LC_data_table tr > td.LC_roles_future {
1.939 bisitz 6997: border-right: 8px solid #FFFF77;
1.707 bisitz 6998: }
1.795 www 6999:
1.707 bisitz 7000: table.LC_data_table tr > td.LC_roles_will {
1.939 bisitz 7001: border-right: 8px solid #FFAA77;
1.707 bisitz 7002: }
1.795 www 7003:
1.707 bisitz 7004: table.LC_data_table tr > td.LC_roles_expired {
1.939 bisitz 7005: border-right: 8px solid #FF7777;
1.707 bisitz 7006: }
1.795 www 7007:
1.707 bisitz 7008: table.LC_data_table tr > td.LC_roles_will_not {
1.939 bisitz 7009: border-right: 8px solid #AAFF77;
1.707 bisitz 7010: }
1.795 www 7011:
1.707 bisitz 7012: table.LC_data_table tr > td.LC_roles_selected {
1.939 bisitz 7013: border-right: 8px solid #11CC55;
1.707 bisitz 7014: }
7015:
1.388 albertel 7016: span.LC_current_location {
1.701 harmsja 7017: font-size:larger;
1.388 albertel 7018: background: $pgbg;
7019: }
1.387 albertel 7020:
1.1029 www 7021: span.LC_current_nav_location {
7022: font-weight:bold;
7023: background: $sidebg;
7024: }
7025:
1.395 albertel 7026: span.LC_parm_menu_item {
7027: font-size: larger;
7028: }
1.795 www 7029:
1.395 albertel 7030: span.LC_parm_scope_all {
7031: color: red;
7032: }
1.795 www 7033:
1.395 albertel 7034: span.LC_parm_scope_folder {
7035: color: green;
7036: }
1.795 www 7037:
1.395 albertel 7038: span.LC_parm_scope_resource {
7039: color: orange;
7040: }
1.795 www 7041:
1.395 albertel 7042: span.LC_parm_part {
7043: color: blue;
7044: }
1.795 www 7045:
1.911 bisitz 7046: span.LC_parm_folder,
7047: span.LC_parm_symb {
1.395 albertel 7048: font-size: x-small;
7049: font-family: $mono;
7050: color: #AAAAAA;
7051: }
7052:
1.977 bisitz 7053: ul.LC_parm_parmlist li {
7054: display: inline-block;
7055: padding: 0.3em 0.8em;
7056: vertical-align: top;
7057: width: 150px;
7058: border-top:1px solid $lg_border_color;
7059: }
7060:
1.795 www 7061: td.LC_parm_overview_level_menu,
7062: td.LC_parm_overview_map_menu,
7063: td.LC_parm_overview_parm_selectors,
7064: td.LC_parm_overview_restrictions {
1.396 albertel 7065: border: 1px solid black;
7066: border-collapse: collapse;
7067: }
1.795 www 7068:
1.1285 raeburn 7069: span.LC_parm_recursive,
7070: td.LC_parm_recursive {
7071: font-weight: bold;
7072: font-size: smaller;
7073: }
7074:
1.396 albertel 7075: table.LC_parm_overview_restrictions td {
7076: border-width: 1px 4px 1px 4px;
7077: border-style: solid;
7078: border-color: $pgbg;
7079: text-align: center;
7080: }
1.795 www 7081:
1.396 albertel 7082: table.LC_parm_overview_restrictions th {
7083: background: $tabbg;
7084: border-width: 1px 4px 1px 4px;
7085: border-style: solid;
7086: border-color: $pgbg;
7087: }
1.795 www 7088:
1.398 albertel 7089: table#LC_helpmenu {
1.803 bisitz 7090: border: none;
1.398 albertel 7091: height: 55px;
1.803 bisitz 7092: border-spacing: 0;
1.398 albertel 7093: }
7094:
7095: table#LC_helpmenu fieldset legend {
7096: font-size: larger;
7097: }
1.795 www 7098:
1.397 albertel 7099: table#LC_helpmenu_links {
7100: width: 100%;
7101: border: 1px solid black;
7102: background: $pgbg;
1.803 bisitz 7103: padding: 0;
1.397 albertel 7104: border-spacing: 1px;
7105: }
1.795 www 7106:
1.397 albertel 7107: table#LC_helpmenu_links tr td {
7108: padding: 1px;
7109: background: $tabbg;
1.399 albertel 7110: text-align: center;
7111: font-weight: bold;
1.397 albertel 7112: }
1.396 albertel 7113:
1.795 www 7114: table#LC_helpmenu_links a:link,
7115: table#LC_helpmenu_links a:visited,
1.397 albertel 7116: table#LC_helpmenu_links a:active {
7117: text-decoration: none;
7118: color: $font;
7119: }
1.795 www 7120:
1.397 albertel 7121: table#LC_helpmenu_links a:hover {
7122: text-decoration: underline;
7123: color: $vlink;
7124: }
1.396 albertel 7125:
1.417 albertel 7126: .LC_chrt_popup_exists {
7127: border: 1px solid #339933;
7128: margin: -1px;
7129: }
1.795 www 7130:
1.417 albertel 7131: .LC_chrt_popup_up {
7132: border: 1px solid yellow;
7133: margin: -1px;
7134: }
1.795 www 7135:
1.417 albertel 7136: .LC_chrt_popup {
7137: border: 1px solid #8888FF;
7138: background: #CCCCFF;
7139: }
1.795 www 7140:
1.421 albertel 7141: table.LC_pick_box {
7142: border-collapse: separate;
7143: background: white;
7144: border: 1px solid black;
7145: border-spacing: 1px;
7146: }
1.795 www 7147:
1.421 albertel 7148: table.LC_pick_box td.LC_pick_box_title {
1.850 bisitz 7149: background: $sidebg;
1.421 albertel 7150: font-weight: bold;
1.900 bisitz 7151: text-align: left;
1.740 bisitz 7152: vertical-align: top;
1.421 albertel 7153: width: 184px;
7154: padding: 8px;
7155: }
1.795 www 7156:
1.579 raeburn 7157: table.LC_pick_box td.LC_pick_box_value {
7158: text-align: left;
7159: padding: 8px;
7160: }
1.795 www 7161:
1.579 raeburn 7162: table.LC_pick_box td.LC_pick_box_select {
7163: text-align: left;
7164: padding: 8px;
7165: }
1.795 www 7166:
1.424 albertel 7167: table.LC_pick_box td.LC_pick_box_separator {
1.803 bisitz 7168: padding: 0;
1.421 albertel 7169: height: 1px;
7170: background: black;
7171: }
1.795 www 7172:
1.421 albertel 7173: table.LC_pick_box td.LC_pick_box_submit {
7174: text-align: right;
7175: }
1.795 www 7176:
1.579 raeburn 7177: table.LC_pick_box td.LC_evenrow_value {
7178: text-align: left;
7179: padding: 8px;
7180: background-color: $data_table_light;
7181: }
1.795 www 7182:
1.579 raeburn 7183: table.LC_pick_box td.LC_oddrow_value {
7184: text-align: left;
7185: padding: 8px;
7186: background-color: $data_table_light;
7187: }
1.795 www 7188:
1.579 raeburn 7189: span.LC_helpform_receipt_cat {
7190: font-weight: bold;
7191: }
1.795 www 7192:
1.424 albertel 7193: table.LC_group_priv_box {
7194: background: white;
7195: border: 1px solid black;
7196: border-spacing: 1px;
7197: }
1.795 www 7198:
1.424 albertel 7199: table.LC_group_priv_box td.LC_pick_box_title {
7200: background: $tabbg;
7201: font-weight: bold;
7202: text-align: right;
7203: width: 184px;
7204: }
1.795 www 7205:
1.424 albertel 7206: table.LC_group_priv_box td.LC_groups_fixed {
7207: background: $data_table_light;
7208: text-align: center;
7209: }
1.795 www 7210:
1.424 albertel 7211: table.LC_group_priv_box td.LC_groups_optional {
7212: background: $data_table_dark;
7213: text-align: center;
7214: }
1.795 www 7215:
1.424 albertel 7216: table.LC_group_priv_box td.LC_groups_functionality {
7217: background: $data_table_darker;
7218: text-align: center;
7219: font-weight: bold;
7220: }
1.795 www 7221:
1.424 albertel 7222: table.LC_group_priv td {
7223: text-align: left;
1.803 bisitz 7224: padding: 0;
1.424 albertel 7225: }
7226:
7227: .LC_navbuttons {
7228: margin: 2ex 0ex 2ex 0ex;
7229: }
1.795 www 7230:
1.423 albertel 7231: .LC_topic_bar {
7232: font-weight: bold;
7233: background: $tabbg;
1.918 wenzelju 7234: margin: 1em 0em 1em 2em;
1.805 bisitz 7235: padding: 3px;
1.918 wenzelju 7236: font-size: 1.2em;
1.423 albertel 7237: }
1.795 www 7238:
1.423 albertel 7239: .LC_topic_bar span {
1.918 wenzelju 7240: left: 0.5em;
7241: position: absolute;
1.423 albertel 7242: vertical-align: middle;
1.918 wenzelju 7243: font-size: 1.2em;
1.423 albertel 7244: }
1.795 www 7245:
1.423 albertel 7246: table.LC_course_group_status {
7247: margin: 20px;
7248: }
1.795 www 7249:
1.423 albertel 7250: table.LC_status_selector td {
7251: vertical-align: top;
7252: text-align: center;
1.424 albertel 7253: padding: 4px;
7254: }
1.795 www 7255:
1.599 albertel 7256: div.LC_feedback_link {
1.616 albertel 7257: clear: both;
1.829 kalberla 7258: background: $sidebg;
1.779 bisitz 7259: width: 100%;
1.829 kalberla 7260: padding-bottom: 10px;
7261: border: 1px $tabbg solid;
1.833 kalberla 7262: height: 22px;
7263: line-height: 22px;
7264: padding-top: 5px;
7265: }
7266:
7267: div.LC_feedback_link img {
7268: height: 22px;
1.867 kalberla 7269: vertical-align:middle;
1.829 kalberla 7270: }
7271:
1.911 bisitz 7272: div.LC_feedback_link a {
1.829 kalberla 7273: text-decoration: none;
1.489 raeburn 7274: }
1.795 www 7275:
1.867 kalberla 7276: div.LC_comblock {
1.911 bisitz 7277: display:inline;
1.867 kalberla 7278: color:$font;
7279: font-size:90%;
7280: }
7281:
7282: div.LC_feedback_link div.LC_comblock {
7283: padding-left:5px;
7284: }
7285:
7286: div.LC_feedback_link div.LC_comblock a {
7287: color:$font;
7288: }
7289:
1.489 raeburn 7290: span.LC_feedback_link {
1.858 bisitz 7291: /* background: $feedback_link_bg; */
1.599 albertel 7292: font-size: larger;
7293: }
1.795 www 7294:
1.599 albertel 7295: span.LC_message_link {
1.858 bisitz 7296: /* background: $feedback_link_bg; */
1.599 albertel 7297: font-size: larger;
7298: position: absolute;
7299: right: 1em;
1.489 raeburn 7300: }
1.421 albertel 7301:
1.515 albertel 7302: table.LC_prior_tries {
1.524 albertel 7303: border: 1px solid #000000;
7304: border-collapse: separate;
7305: border-spacing: 1px;
1.515 albertel 7306: }
1.523 albertel 7307:
1.515 albertel 7308: table.LC_prior_tries td {
1.524 albertel 7309: padding: 2px;
1.515 albertel 7310: }
1.523 albertel 7311:
7312: .LC_answer_correct {
1.795 www 7313: background: lightgreen;
7314: color: darkgreen;
7315: padding: 6px;
1.523 albertel 7316: }
1.795 www 7317:
1.523 albertel 7318: .LC_answer_charged_try {
1.797 www 7319: background: #FFAAAA;
1.795 www 7320: color: darkred;
7321: padding: 6px;
1.523 albertel 7322: }
1.795 www 7323:
1.779 bisitz 7324: .LC_answer_not_charged_try,
1.523 albertel 7325: .LC_answer_no_grade,
7326: .LC_answer_late {
1.795 www 7327: background: lightyellow;
1.523 albertel 7328: color: black;
1.795 www 7329: padding: 6px;
1.523 albertel 7330: }
1.795 www 7331:
1.523 albertel 7332: .LC_answer_previous {
1.795 www 7333: background: lightblue;
7334: color: darkblue;
7335: padding: 6px;
1.523 albertel 7336: }
1.795 www 7337:
1.779 bisitz 7338: .LC_answer_no_message {
1.777 tempelho 7339: background: #FFFFFF;
7340: color: black;
1.795 www 7341: padding: 6px;
1.779 bisitz 7342: }
1.795 www 7343:
1.1334 raeburn 7344: .LC_answer_unknown,
7345: .LC_answer_warning {
1.779 bisitz 7346: background: orange;
7347: color: black;
1.795 www 7348: padding: 6px;
1.777 tempelho 7349: }
1.795 www 7350:
1.529 albertel 7351: span.LC_prior_numerical,
7352: span.LC_prior_string,
7353: span.LC_prior_custom,
7354: span.LC_prior_reaction,
7355: span.LC_prior_math {
1.925 bisitz 7356: font-family: $mono;
1.523 albertel 7357: white-space: pre;
7358: }
7359:
1.525 albertel 7360: span.LC_prior_string {
1.925 bisitz 7361: font-family: $mono;
1.525 albertel 7362: white-space: pre;
7363: }
7364:
1.523 albertel 7365: table.LC_prior_option {
7366: width: 100%;
7367: border-collapse: collapse;
7368: }
1.795 www 7369:
1.911 bisitz 7370: table.LC_prior_rank,
1.795 www 7371: table.LC_prior_match {
1.528 albertel 7372: border-collapse: collapse;
7373: }
1.795 www 7374:
1.528 albertel 7375: table.LC_prior_option tr td,
7376: table.LC_prior_rank tr td,
7377: table.LC_prior_match tr td {
1.524 albertel 7378: border: 1px solid #000000;
1.515 albertel 7379: }
7380:
1.855 bisitz 7381: .LC_nobreak {
1.544 albertel 7382: white-space: nowrap;
1.519 raeburn 7383: }
7384:
1.576 raeburn 7385: span.LC_cusr_emph {
7386: font-style: italic;
7387: }
7388:
1.633 raeburn 7389: span.LC_cusr_subheading {
7390: font-weight: normal;
7391: font-size: 85%;
7392: }
7393:
1.861 bisitz 7394: div.LC_docs_entry_move {
1.859 bisitz 7395: border: 1px solid #BBBBBB;
1.545 albertel 7396: background: #DDDDDD;
1.861 bisitz 7397: width: 22px;
1.859 bisitz 7398: padding: 1px;
7399: margin: 0;
1.545 albertel 7400: }
7401:
1.861 bisitz 7402: table.LC_data_table tr > td.LC_docs_entry_commands,
7403: table.LC_data_table tr > td.LC_docs_entry_parameter {
1.545 albertel 7404: font-size: x-small;
7405: }
1.795 www 7406:
1.861 bisitz 7407: .LC_docs_entry_parameter {
7408: white-space: nowrap;
7409: }
7410:
1.544 albertel 7411: .LC_docs_copy {
1.545 albertel 7412: color: #000099;
1.544 albertel 7413: }
1.795 www 7414:
1.544 albertel 7415: .LC_docs_cut {
1.545 albertel 7416: color: #550044;
1.544 albertel 7417: }
1.795 www 7418:
1.544 albertel 7419: .LC_docs_rename {
1.545 albertel 7420: color: #009900;
1.544 albertel 7421: }
1.795 www 7422:
1.544 albertel 7423: .LC_docs_remove {
1.545 albertel 7424: color: #990000;
7425: }
7426:
1.1284 raeburn 7427: .LC_docs_alias {
7428: color: #440055;
7429: }
7430:
1.1286 raeburn 7431: .LC_domprefs_email,
1.1284 raeburn 7432: .LC_docs_alias_name,
1.547 albertel 7433: .LC_docs_reinit_warn,
7434: .LC_docs_ext_edit {
7435: font-size: x-small;
7436: }
7437:
1.545 albertel 7438: table.LC_docs_adddocs td,
7439: table.LC_docs_adddocs th {
7440: border: 1px solid #BBBBBB;
7441: padding: 4px;
7442: background: #DDDDDD;
1.543 albertel 7443: }
7444:
1.584 albertel 7445: table.LC_sty_begin {
7446: background: #BBFFBB;
7447: }
1.795 www 7448:
1.584 albertel 7449: table.LC_sty_end {
7450: background: #FFBBBB;
7451: }
7452:
1.589 raeburn 7453: table.LC_double_column {
1.803 bisitz 7454: border-width: 0;
1.589 raeburn 7455: border-collapse: collapse;
7456: width: 100%;
7457: padding: 2px;
7458: }
7459:
7460: table.LC_double_column tr td.LC_left_col {
1.590 raeburn 7461: top: 2px;
1.589 raeburn 7462: left: 2px;
7463: width: 47%;
7464: vertical-align: top;
7465: }
7466:
7467: table.LC_double_column tr td.LC_right_col {
7468: top: 2px;
1.779 bisitz 7469: right: 2px;
1.589 raeburn 7470: width: 47%;
7471: vertical-align: top;
7472: }
7473:
1.591 raeburn 7474: div.LC_left_float {
7475: float: left;
7476: padding-right: 5%;
1.597 albertel 7477: padding-bottom: 4px;
1.591 raeburn 7478: }
7479:
7480: div.LC_clear_float_header {
1.597 albertel 7481: padding-bottom: 2px;
1.591 raeburn 7482: }
7483:
7484: div.LC_clear_float_footer {
1.597 albertel 7485: padding-top: 10px;
1.591 raeburn 7486: clear: both;
7487: }
7488:
1.597 albertel 7489: div.LC_grade_show_user {
1.941 bisitz 7490: /* border-left: 5px solid $sidebg; */
7491: border-top: 5px solid #000000;
7492: margin: 50px 0 0 0;
1.936 bisitz 7493: padding: 15px 0 5px 10px;
1.597 albertel 7494: }
1.795 www 7495:
1.936 bisitz 7496: div.LC_grade_show_user_odd_row {
1.941 bisitz 7497: /* border-left: 5px solid #000000; */
7498: }
7499:
7500: div.LC_grade_show_user div.LC_Box {
7501: margin-right: 50px;
1.597 albertel 7502: }
7503:
7504: div.LC_grade_submissions,
7505: div.LC_grade_message_center,
1.936 bisitz 7506: div.LC_grade_info_links {
1.597 albertel 7507: margin: 5px;
7508: width: 99%;
7509: background: #FFFFFF;
7510: }
1.795 www 7511:
1.597 albertel 7512: div.LC_grade_submissions_header,
1.936 bisitz 7513: div.LC_grade_message_center_header {
1.705 tempelho 7514: font-weight: bold;
7515: font-size: large;
1.597 albertel 7516: }
1.795 www 7517:
1.597 albertel 7518: div.LC_grade_submissions_body,
1.936 bisitz 7519: div.LC_grade_message_center_body {
1.597 albertel 7520: border: 1px solid black;
7521: width: 99%;
7522: background: #FFFFFF;
7523: }
1.795 www 7524:
1.613 albertel 7525: table.LC_scantron_action {
7526: width: 100%;
7527: }
1.795 www 7528:
1.613 albertel 7529: table.LC_scantron_action tr th {
1.698 harmsja 7530: font-weight:bold;
7531: font-style:normal;
1.613 albertel 7532: }
1.795 www 7533:
1.779 bisitz 7534: .LC_edit_problem_header,
1.614 albertel 7535: div.LC_edit_problem_footer {
1.705 tempelho 7536: font-weight: normal;
7537: font-size: medium;
1.602 albertel 7538: margin: 2px;
1.1060 bisitz 7539: background-color: $sidebg;
1.600 albertel 7540: }
1.795 www 7541:
1.600 albertel 7542: div.LC_edit_problem_header,
1.602 albertel 7543: div.LC_edit_problem_header div,
1.614 albertel 7544: div.LC_edit_problem_footer,
7545: div.LC_edit_problem_footer div,
1.602 albertel 7546: div.LC_edit_problem_editxml_header,
7547: div.LC_edit_problem_editxml_header div {
1.1205 golterma 7548: z-index: 100;
1.600 albertel 7549: }
1.795 www 7550:
1.600 albertel 7551: div.LC_edit_problem_header_title {
1.705 tempelho 7552: font-weight: bold;
7553: font-size: larger;
1.602 albertel 7554: background: $tabbg;
7555: padding: 3px;
1.1060 bisitz 7556: margin: 0 0 5px 0;
1.602 albertel 7557: }
1.795 www 7558:
1.602 albertel 7559: table.LC_edit_problem_header_title {
7560: width: 100%;
1.600 albertel 7561: background: $tabbg;
1.602 albertel 7562: }
7563:
1.1205 golterma 7564: div.LC_edit_actionbar {
7565: background-color: $sidebg;
1.1218 droeschl 7566: margin: 0;
7567: padding: 0;
7568: line-height: 200%;
1.602 albertel 7569: }
1.795 www 7570:
1.1218 droeschl 7571: div.LC_edit_actionbar div{
7572: padding: 0;
7573: margin: 0;
7574: display: inline-block;
1.600 albertel 7575: }
1.795 www 7576:
1.1124 bisitz 7577: .LC_edit_opt {
7578: padding-left: 1em;
7579: white-space: nowrap;
7580: }
7581:
1.1152 golterma 7582: .LC_edit_problem_latexhelper{
7583: text-align: right;
7584: }
7585:
7586: #LC_edit_problem_colorful div{
7587: margin-left: 40px;
7588: }
7589:
1.1205 golterma 7590: #LC_edit_problem_codemirror div{
7591: margin-left: 0px;
7592: }
7593:
1.911 bisitz 7594: img.stift {
1.803 bisitz 7595: border-width: 0;
7596: vertical-align: middle;
1.677 riegler 7597: }
1.680 riegler 7598:
1.923 bisitz 7599: table td.LC_mainmenu_col_fieldset {
1.680 riegler 7600: vertical-align: top;
1.777 tempelho 7601: }
1.795 www 7602:
1.716 raeburn 7603: div.LC_createcourse {
1.911 bisitz 7604: margin: 10px 10px 10px 10px;
1.716 raeburn 7605: }
7606:
1.917 raeburn 7607: .LC_dccid {
1.1130 raeburn 7608: float: right;
1.917 raeburn 7609: margin: 0.2em 0 0 0;
7610: padding: 0;
7611: font-size: 90%;
7612: display:none;
7613: }
7614:
1.897 wenzelju 7615: ol.LC_primary_menu a:hover,
1.721 harmsja 7616: ol#LC_MenuBreadcrumbs a:hover,
7617: ol#LC_PathBreadcrumbs a:hover,
1.897 wenzelju 7618: ul#LC_secondary_menu a:hover,
1.721 harmsja 7619: .LC_FormSectionClearButton input:hover
1.795 www 7620: ul.LC_TabContent li:hover a {
1.952 onken 7621: color:$button_hover;
1.911 bisitz 7622: text-decoration:none;
1.693 droeschl 7623: }
7624:
1.779 bisitz 7625: h1 {
1.911 bisitz 7626: padding: 0;
7627: line-height:130%;
1.693 droeschl 7628: }
1.698 harmsja 7629:
1.911 bisitz 7630: h2,
7631: h3,
7632: h4,
7633: h5,
7634: h6 {
7635: margin: 5px 0 5px 0;
7636: padding: 0;
7637: line-height:130%;
1.693 droeschl 7638: }
1.795 www 7639:
7640: .LC_hcell {
1.911 bisitz 7641: padding:3px 15px 3px 15px;
7642: margin: 0;
7643: background-color:$tabbg;
7644: color:$fontmenu;
7645: border-bottom:solid 1px $lg_border_color;
1.693 droeschl 7646: }
1.795 www 7647:
1.840 bisitz 7648: .LC_Box > .LC_hcell {
1.911 bisitz 7649: margin: 0 -10px 10px -10px;
1.835 bisitz 7650: }
7651:
1.721 harmsja 7652: .LC_noBorder {
1.911 bisitz 7653: border: 0;
1.698 harmsja 7654: }
1.693 droeschl 7655:
1.721 harmsja 7656: .LC_FormSectionClearButton input {
1.911 bisitz 7657: background-color:transparent;
7658: border: none;
7659: cursor:pointer;
7660: text-decoration:underline;
1.693 droeschl 7661: }
1.763 bisitz 7662:
7663: .LC_help_open_topic {
1.911 bisitz 7664: color: #FFFFFF;
7665: background-color: #EEEEFF;
7666: margin: 1px;
7667: padding: 4px;
7668: border: 1px solid #000033;
7669: white-space: nowrap;
7670: /* vertical-align: middle; */
1.759 neumanie 7671: }
1.693 droeschl 7672:
1.911 bisitz 7673: dl,
7674: ul,
7675: div,
7676: fieldset {
7677: margin: 10px 10px 10px 0;
7678: /* overflow: hidden; */
1.693 droeschl 7679: }
1.795 www 7680:
1.1211 raeburn 7681: article.geogebraweb div {
7682: margin: 0;
7683: }
7684:
1.838 bisitz 7685: fieldset > legend {
1.911 bisitz 7686: font-weight: bold;
7687: padding: 0 5px 0 5px;
1.838 bisitz 7688: }
7689:
1.813 bisitz 7690: #LC_nav_bar {
1.911 bisitz 7691: float: left;
1.995 raeburn 7692: background-color: $pgbg_or_bgcolor;
1.966 bisitz 7693: margin: 0 0 2px 0;
1.807 droeschl 7694: }
7695:
1.916 droeschl 7696: #LC_realm {
7697: margin: 0.2em 0 0 0;
7698: padding: 0;
7699: font-weight: bold;
7700: text-align: center;
1.995 raeburn 7701: background-color: $pgbg_or_bgcolor;
1.916 droeschl 7702: }
7703:
1.911 bisitz 7704: #LC_nav_bar em {
7705: font-weight: bold;
7706: font-style: normal;
1.807 droeschl 7707: }
7708:
1.897 wenzelju 7709: ol.LC_primary_menu {
1.934 droeschl 7710: margin: 0;
1.1076 raeburn 7711: padding: 0;
1.807 droeschl 7712: }
7713:
1.852 droeschl 7714: ol#LC_PathBreadcrumbs {
1.911 bisitz 7715: margin: 0;
1.693 droeschl 7716: }
7717:
1.897 wenzelju 7718: ol.LC_primary_menu li {
1.1076 raeburn 7719: color: RGB(80, 80, 80);
7720: vertical-align: middle;
7721: text-align: left;
7722: list-style: none;
1.1205 golterma 7723: position: relative;
1.1076 raeburn 7724: float: left;
1.1205 golterma 7725: z-index: 100; /* will be displayed above codemirror and underneath the help-layer */
7726: line-height: 1.5em;
1.1076 raeburn 7727: }
7728:
1.1205 golterma 7729: ol.LC_primary_menu li a,
7730: ol.LC_primary_menu li p {
1.1076 raeburn 7731: display: block;
7732: margin: 0;
7733: padding: 0 5px 0 10px;
7734: text-decoration: none;
7735: }
7736:
1.1205 golterma 7737: ol.LC_primary_menu li p span.LC_primary_menu_innertitle {
7738: display: inline-block;
7739: width: 95%;
7740: text-align: left;
7741: }
7742:
7743: ol.LC_primary_menu li p span.LC_primary_menu_innerarrow {
7744: display: inline-block;
7745: width: 5%;
7746: float: right;
7747: text-align: right;
7748: font-size: 70%;
7749: }
7750:
7751: ol.LC_primary_menu ul {
1.1076 raeburn 7752: display: none;
1.1205 golterma 7753: width: 15em;
1.1076 raeburn 7754: background-color: $data_table_light;
1.1205 golterma 7755: position: absolute;
7756: top: 100%;
1.1076 raeburn 7757: }
7758:
1.1205 golterma 7759: ol.LC_primary_menu ul ul {
7760: left: 100%;
7761: top: 0;
7762: }
7763:
7764: ol.LC_primary_menu li:hover > ul, ol.LC_primary_menu li.hover > ul {
1.1076 raeburn 7765: display: block;
7766: position: absolute;
7767: margin: 0;
7768: padding: 0;
1.1078 raeburn 7769: z-index: 2;
1.1076 raeburn 7770: }
7771:
7772: ol.LC_primary_menu li:hover li, ol.LC_primary_menu li.hover li {
1.1205 golterma 7773: /* First Submenu -> size should be smaller than the menu title of the whole menu */
1.1076 raeburn 7774: font-size: 90%;
1.911 bisitz 7775: vertical-align: top;
1.1076 raeburn 7776: float: none;
1.1079 raeburn 7777: border-left: 1px solid black;
7778: border-right: 1px solid black;
1.1205 golterma 7779: /* A dark bottom border to visualize different menu options;
7780: overwritten in the create_submenu routine for the last border-bottom of the menu */
7781: border-bottom: 1px solid $data_table_dark;
1.1076 raeburn 7782: }
7783:
1.1205 golterma 7784: ol.LC_primary_menu li li p:hover {
7785: color:$button_hover;
7786: text-decoration:none;
7787: background-color:$data_table_dark;
1.1076 raeburn 7788: }
7789:
7790: ol.LC_primary_menu li li a:hover {
7791: color:$button_hover;
7792: background-color:$data_table_dark;
1.693 droeschl 7793: }
7794:
1.1205 golterma 7795: /* Font-size equal to the size of the predecessors*/
7796: ol.LC_primary_menu li:hover li li {
7797: font-size: 100%;
7798: }
7799:
1.897 wenzelju 7800: ol.LC_primary_menu li img {
1.911 bisitz 7801: vertical-align: bottom;
1.934 droeschl 7802: height: 1.1em;
1.1077 raeburn 7803: margin: 0.2em 0 0 0;
1.693 droeschl 7804: }
7805:
1.897 wenzelju 7806: ol.LC_primary_menu a {
1.911 bisitz 7807: color: RGB(80, 80, 80);
7808: text-decoration: none;
1.693 droeschl 7809: }
1.795 www 7810:
1.949 droeschl 7811: ol.LC_primary_menu a.LC_new_message {
7812: font-weight:bold;
7813: color: darkred;
7814: }
7815:
1.975 raeburn 7816: ol.LC_docs_parameters {
7817: margin-left: 0;
7818: padding: 0;
7819: list-style: none;
7820: }
7821:
7822: ol.LC_docs_parameters li {
7823: margin: 0;
7824: padding-right: 20px;
7825: display: inline;
7826: }
7827:
1.976 raeburn 7828: ol.LC_docs_parameters li:before {
7829: content: "\\002022 \\0020";
7830: }
7831:
7832: li.LC_docs_parameters_title {
7833: font-weight: bold;
7834: }
7835:
7836: ol.LC_docs_parameters li.LC_docs_parameters_title:before {
7837: content: "";
7838: }
7839:
1.897 wenzelju 7840: ul#LC_secondary_menu {
1.1107 raeburn 7841: clear: right;
1.911 bisitz 7842: color: $fontmenu;
7843: background: $tabbg;
7844: list-style: none;
7845: padding: 0;
7846: margin: 0;
7847: width: 100%;
1.995 raeburn 7848: text-align: left;
1.1107 raeburn 7849: float: left;
1.808 droeschl 7850: }
7851:
1.897 wenzelju 7852: ul#LC_secondary_menu li {
1.911 bisitz 7853: font-weight: bold;
7854: line-height: 1.8em;
1.1107 raeburn 7855: border-right: 1px solid black;
7856: float: left;
7857: }
7858:
7859: ul#LC_secondary_menu li.LC_hoverable:hover, ul#LC_secondary_menu li.hover {
7860: background-color: $data_table_light;
7861: }
7862:
7863: ul#LC_secondary_menu li a {
1.911 bisitz 7864: padding: 0 0.8em;
1.1107 raeburn 7865: }
7866:
7867: ul#LC_secondary_menu li ul {
7868: display: none;
7869: }
7870:
7871: ul#LC_secondary_menu li:hover ul, ul#LC_secondary_menu li.hover ul {
7872: display: block;
7873: position: absolute;
7874: margin: 0;
7875: padding: 0;
7876: list-style:none;
7877: float: none;
7878: background-color: $data_table_light;
7879: z-index: 2;
7880: margin-left: -1px;
7881: }
7882:
7883: ul#LC_secondary_menu li ul li {
7884: font-size: 90%;
7885: vertical-align: top;
7886: border-left: 1px solid black;
1.911 bisitz 7887: border-right: 1px solid black;
1.1119 raeburn 7888: background-color: $data_table_light;
1.1107 raeburn 7889: list-style:none;
7890: float: none;
7891: }
7892:
7893: ul#LC_secondary_menu li ul li:hover, ul#LC_secondary_menu li ul li.hover {
7894: background-color: $data_table_dark;
1.807 droeschl 7895: }
7896:
1.847 tempelho 7897: ul.LC_TabContent {
1.911 bisitz 7898: display:block;
7899: background: $sidebg;
7900: border-bottom: solid 1px $lg_border_color;
7901: list-style:none;
1.1020 raeburn 7902: margin: -1px -10px 0 -10px;
1.911 bisitz 7903: padding: 0;
1.693 droeschl 7904: }
7905:
1.795 www 7906: ul.LC_TabContent li,
7907: ul.LC_TabContentBigger li {
1.911 bisitz 7908: float:left;
1.741 harmsja 7909: }
1.795 www 7910:
1.897 wenzelju 7911: ul#LC_secondary_menu li a {
1.911 bisitz 7912: color: $fontmenu;
7913: text-decoration: none;
1.693 droeschl 7914: }
1.795 www 7915:
1.721 harmsja 7916: ul.LC_TabContent {
1.952 onken 7917: min-height:20px;
1.721 harmsja 7918: }
1.795 www 7919:
7920: ul.LC_TabContent li {
1.911 bisitz 7921: vertical-align:middle;
1.959 onken 7922: padding: 0 16px 0 10px;
1.911 bisitz 7923: background-color:$tabbg;
7924: border-bottom:solid 1px $lg_border_color;
1.1020 raeburn 7925: border-left: solid 1px $font;
1.721 harmsja 7926: }
1.795 www 7927:
1.847 tempelho 7928: ul.LC_TabContent .right {
1.911 bisitz 7929: float:right;
1.847 tempelho 7930: }
7931:
1.911 bisitz 7932: ul.LC_TabContent li a,
7933: ul.LC_TabContent li {
7934: color:rgb(47,47,47);
7935: text-decoration:none;
7936: font-size:95%;
7937: font-weight:bold;
1.952 onken 7938: min-height:20px;
7939: }
7940:
1.959 onken 7941: ul.LC_TabContent li a:hover,
7942: ul.LC_TabContent li a:focus {
1.952 onken 7943: color: $button_hover;
1.959 onken 7944: background:none;
7945: outline:none;
1.952 onken 7946: }
7947:
7948: ul.LC_TabContent li:hover {
7949: color: $button_hover;
7950: cursor:pointer;
1.721 harmsja 7951: }
1.795 www 7952:
1.911 bisitz 7953: ul.LC_TabContent li.active {
1.952 onken 7954: color: $font;
1.911 bisitz 7955: background:#FFFFFF url(/adm/lonIcons/open.gif) no-repeat scroll right center;
1.952 onken 7956: border-bottom:solid 1px #FFFFFF;
7957: cursor: default;
1.744 ehlerst 7958: }
1.795 www 7959:
1.959 onken 7960: ul.LC_TabContent li.active a {
7961: color:$font;
7962: background:#FFFFFF;
7963: outline: none;
7964: }
1.1047 raeburn 7965:
7966: ul.LC_TabContent li.goback {
7967: float: left;
7968: border-left: none;
7969: }
7970:
1.870 tempelho 7971: #maincoursedoc {
1.911 bisitz 7972: clear:both;
1.870 tempelho 7973: }
7974:
7975: ul.LC_TabContentBigger {
1.911 bisitz 7976: display:block;
7977: list-style:none;
7978: padding: 0;
1.870 tempelho 7979: }
7980:
1.795 www 7981: ul.LC_TabContentBigger li {
1.911 bisitz 7982: vertical-align:bottom;
7983: height: 30px;
7984: font-size:110%;
7985: font-weight:bold;
7986: color: #737373;
1.841 tempelho 7987: }
7988:
1.957 onken 7989: ul.LC_TabContentBigger li.active {
7990: position: relative;
7991: top: 1px;
7992: }
7993:
1.870 tempelho 7994: ul.LC_TabContentBigger li a {
1.911 bisitz 7995: background:url('/adm/lonIcons/tabbgleft.gif') left bottom no-repeat;
7996: height: 30px;
7997: line-height: 30px;
7998: text-align: center;
7999: display: block;
8000: text-decoration: none;
1.958 onken 8001: outline: none;
1.741 harmsja 8002: }
1.795 www 8003:
1.870 tempelho 8004: ul.LC_TabContentBigger li.active a {
1.911 bisitz 8005: background:url('/adm/lonIcons/tabbgleft.gif') left top no-repeat;
8006: color:$font;
1.744 ehlerst 8007: }
1.795 www 8008:
1.870 tempelho 8009: ul.LC_TabContentBigger li b {
1.911 bisitz 8010: background: url('/adm/lonIcons/tabbgright.gif') no-repeat right bottom;
8011: display: block;
8012: float: left;
8013: padding: 0 30px;
1.957 onken 8014: border-bottom: 1px solid $lg_border_color;
1.870 tempelho 8015: }
8016:
1.956 onken 8017: ul.LC_TabContentBigger li:hover b {
8018: color:$button_hover;
8019: }
8020:
1.870 tempelho 8021: ul.LC_TabContentBigger li.active b {
1.911 bisitz 8022: background:url('/adm/lonIcons/tabbgright.gif') right top no-repeat;
8023: color:$font;
1.957 onken 8024: border: 0;
1.741 harmsja 8025: }
1.693 droeschl 8026:
1.870 tempelho 8027:
1.862 bisitz 8028: ul.LC_CourseBreadcrumbs {
8029: background: $sidebg;
1.1020 raeburn 8030: height: 2em;
1.862 bisitz 8031: padding-left: 10px;
1.1020 raeburn 8032: margin: 0;
1.862 bisitz 8033: list-style-position: inside;
8034: }
8035:
1.911 bisitz 8036: ol#LC_MenuBreadcrumbs,
1.862 bisitz 8037: ol#LC_PathBreadcrumbs {
1.911 bisitz 8038: padding-left: 10px;
8039: margin: 0;
1.933 droeschl 8040: height: 2.5em; /* equal to #LC_breadcrumbs line-height */
1.693 droeschl 8041: }
8042:
1.911 bisitz 8043: ol#LC_MenuBreadcrumbs li,
8044: ol#LC_PathBreadcrumbs li,
1.862 bisitz 8045: ul.LC_CourseBreadcrumbs li {
1.911 bisitz 8046: display: inline;
1.933 droeschl 8047: white-space: normal;
1.693 droeschl 8048: }
8049:
1.823 bisitz 8050: ol#LC_MenuBreadcrumbs li a,
1.862 bisitz 8051: ul.LC_CourseBreadcrumbs li a {
1.911 bisitz 8052: text-decoration: none;
8053: font-size:90%;
1.693 droeschl 8054: }
1.795 www 8055:
1.969 droeschl 8056: ol#LC_MenuBreadcrumbs h1 {
8057: display: inline;
8058: font-size: 90%;
8059: line-height: 2.5em;
8060: margin: 0;
8061: padding: 0;
8062: }
8063:
1.795 www 8064: ol#LC_PathBreadcrumbs li a {
1.911 bisitz 8065: text-decoration:none;
8066: font-size:100%;
8067: font-weight:bold;
1.693 droeschl 8068: }
1.795 www 8069:
1.840 bisitz 8070: .LC_Box {
1.911 bisitz 8071: border: solid 1px $lg_border_color;
8072: padding: 0 10px 10px 10px;
1.746 neumanie 8073: }
1.795 www 8074:
1.1020 raeburn 8075: .LC_DocsBox {
8076: border: solid 1px $lg_border_color;
8077: padding: 0 0 10px 10px;
8078: }
8079:
1.795 www 8080: .LC_AboutMe_Image {
1.911 bisitz 8081: float:left;
8082: margin-right:10px;
1.747 neumanie 8083: }
1.795 www 8084:
8085: .LC_Clear_AboutMe_Image {
1.911 bisitz 8086: clear:left;
1.747 neumanie 8087: }
1.795 www 8088:
1.721 harmsja 8089: dl.LC_ListStyleClean dt {
1.911 bisitz 8090: padding-right: 5px;
8091: display: table-header-group;
1.693 droeschl 8092: }
8093:
1.721 harmsja 8094: dl.LC_ListStyleClean dd {
1.911 bisitz 8095: display: table-row;
1.693 droeschl 8096: }
8097:
1.721 harmsja 8098: .LC_ListStyleClean,
8099: .LC_ListStyleSimple,
8100: .LC_ListStyleNormal,
1.795 www 8101: .LC_ListStyleSpecial {
1.911 bisitz 8102: /* display:block; */
8103: list-style-position: inside;
8104: list-style-type: none;
8105: overflow: hidden;
8106: padding: 0;
1.693 droeschl 8107: }
8108:
1.721 harmsja 8109: .LC_ListStyleSimple li,
8110: .LC_ListStyleSimple dd,
8111: .LC_ListStyleNormal li,
8112: .LC_ListStyleNormal dd,
8113: .LC_ListStyleSpecial li,
1.795 www 8114: .LC_ListStyleSpecial dd {
1.911 bisitz 8115: margin: 0;
8116: padding: 5px 5px 5px 10px;
8117: clear: both;
1.693 droeschl 8118: }
8119:
1.721 harmsja 8120: .LC_ListStyleClean li,
8121: .LC_ListStyleClean dd {
1.911 bisitz 8122: padding-top: 0;
8123: padding-bottom: 0;
1.693 droeschl 8124: }
8125:
1.721 harmsja 8126: .LC_ListStyleSimple dd,
1.795 www 8127: .LC_ListStyleSimple li {
1.911 bisitz 8128: border-bottom: solid 1px $lg_border_color;
1.693 droeschl 8129: }
8130:
1.721 harmsja 8131: .LC_ListStyleSpecial li,
8132: .LC_ListStyleSpecial dd {
1.911 bisitz 8133: list-style-type: none;
8134: background-color: RGB(220, 220, 220);
8135: margin-bottom: 4px;
1.693 droeschl 8136: }
8137:
1.721 harmsja 8138: table.LC_SimpleTable {
1.911 bisitz 8139: margin:5px;
8140: border:solid 1px $lg_border_color;
1.795 www 8141: }
1.693 droeschl 8142:
1.721 harmsja 8143: table.LC_SimpleTable tr {
1.911 bisitz 8144: padding: 0;
8145: border:solid 1px $lg_border_color;
1.693 droeschl 8146: }
1.795 www 8147:
8148: table.LC_SimpleTable thead {
1.911 bisitz 8149: background:rgb(220,220,220);
1.693 droeschl 8150: }
8151:
1.721 harmsja 8152: div.LC_columnSection {
1.911 bisitz 8153: display: block;
8154: clear: both;
8155: overflow: hidden;
8156: margin: 0;
1.693 droeschl 8157: }
8158:
1.721 harmsja 8159: div.LC_columnSection>* {
1.911 bisitz 8160: float: left;
8161: margin: 10px 20px 10px 0;
8162: overflow:hidden;
1.693 droeschl 8163: }
1.721 harmsja 8164:
1.795 www 8165: table em {
1.911 bisitz 8166: font-weight: bold;
8167: font-style: normal;
1.748 schulted 8168: }
1.795 www 8169:
1.779 bisitz 8170: table.LC_tableBrowseRes,
1.795 www 8171: table.LC_tableOfContent {
1.911 bisitz 8172: border:none;
8173: border-spacing: 1px;
8174: padding: 3px;
8175: background-color: #FFFFFF;
8176: font-size: 90%;
1.753 droeschl 8177: }
1.789 droeschl 8178:
1.911 bisitz 8179: table.LC_tableOfContent {
8180: border-collapse: collapse;
1.789 droeschl 8181: }
8182:
1.771 droeschl 8183: table.LC_tableBrowseRes a,
1.768 schulted 8184: table.LC_tableOfContent a {
1.911 bisitz 8185: background-color: transparent;
8186: text-decoration: none;
1.753 droeschl 8187: }
8188:
1.795 www 8189: table.LC_tableOfContent img {
1.911 bisitz 8190: border: none;
8191: height: 1.3em;
8192: vertical-align: text-bottom;
8193: margin-right: 0.3em;
1.753 droeschl 8194: }
1.757 schulted 8195:
1.795 www 8196: a#LC_content_toolbar_firsthomework {
1.911 bisitz 8197: background-image:url(/res/adm/pages/open-first-problem.gif);
1.774 ehlerst 8198: }
8199:
1.795 www 8200: a#LC_content_toolbar_everything {
1.911 bisitz 8201: background-image:url(/res/adm/pages/show-all.gif);
1.774 ehlerst 8202: }
8203:
1.795 www 8204: a#LC_content_toolbar_uncompleted {
1.911 bisitz 8205: background-image:url(/res/adm/pages/show-incomplete-problems.gif);
1.774 ehlerst 8206: }
8207:
1.795 www 8208: #LC_content_toolbar_clearbubbles {
1.911 bisitz 8209: background-image:url(/res/adm/pages/mark-discussionentries-read.gif);
1.774 ehlerst 8210: }
8211:
1.795 www 8212: a#LC_content_toolbar_changefolder {
1.911 bisitz 8213: background : url(/res/adm/pages/close-all-folders.gif) top center ;
1.757 schulted 8214: }
8215:
1.795 www 8216: a#LC_content_toolbar_changefolder_toggled {
1.911 bisitz 8217: background-image:url(/res/adm/pages/open-all-folders.gif);
1.757 schulted 8218: }
8219:
1.1043 raeburn 8220: a#LC_content_toolbar_edittoplevel {
8221: background-image:url(/res/adm/pages/edittoplevel.gif);
8222: }
8223:
1.795 www 8224: ul#LC_toolbar li a:hover {
1.911 bisitz 8225: background-position: bottom center;
1.757 schulted 8226: }
8227:
1.795 www 8228: ul#LC_toolbar {
1.911 bisitz 8229: padding: 0;
8230: margin: 2px;
8231: list-style:none;
8232: position:relative;
8233: background-color:white;
1.1082 raeburn 8234: overflow: auto;
1.757 schulted 8235: }
8236:
1.795 www 8237: ul#LC_toolbar li {
1.911 bisitz 8238: border:1px solid white;
8239: padding: 0;
8240: margin: 0;
8241: float: left;
8242: display:inline;
8243: vertical-align:middle;
1.1082 raeburn 8244: white-space: nowrap;
1.911 bisitz 8245: }
1.757 schulted 8246:
1.783 amueller 8247:
1.795 www 8248: a.LC_toolbarItem {
1.911 bisitz 8249: display:block;
8250: padding: 0;
8251: margin: 0;
8252: height: 32px;
8253: width: 32px;
8254: color:white;
8255: border: none;
8256: background-repeat:no-repeat;
8257: background-color:transparent;
1.757 schulted 8258: }
8259:
1.915 droeschl 8260: ul.LC_funclist {
8261: margin: 0;
8262: padding: 0.5em 1em 0.5em 0;
8263: }
8264:
1.933 droeschl 8265: ul.LC_funclist > li:first-child {
8266: font-weight:bold;
8267: margin-left:0.8em;
8268: }
8269:
1.915 droeschl 8270: ul.LC_funclist + ul.LC_funclist {
8271: /*
8272: left border as a seperator if we have more than
8273: one list
8274: */
8275: border-left: 1px solid $sidebg;
8276: /*
8277: this hides the left border behind the border of the
8278: outer box if element is wrapped to the next 'line'
8279: */
8280: margin-left: -1px;
8281: }
8282:
1.843 bisitz 8283: ul.LC_funclist li {
1.915 droeschl 8284: display: inline;
1.782 bisitz 8285: white-space: nowrap;
1.915 droeschl 8286: margin: 0 0 0 25px;
8287: line-height: 150%;
1.782 bisitz 8288: }
8289:
1.974 wenzelju 8290: .LC_hidden {
8291: display: none;
8292: }
8293:
1.1030 www 8294: .LCmodal-overlay {
8295: position:fixed;
8296: top:0;
8297: right:0;
8298: bottom:0;
8299: left:0;
8300: height:100%;
8301: width:100%;
8302: margin:0;
8303: padding:0;
8304: background:#999;
8305: opacity:.75;
8306: filter: alpha(opacity=75);
8307: -moz-opacity: 0.75;
8308: z-index:101;
8309: }
8310:
8311: * html .LCmodal-overlay {
8312: position: absolute;
8313: height: expression(document.body.scrollHeight > document.body.offsetHeight ? document.body.scrollHeight : document.body.offsetHeight + 'px');
8314: }
8315:
8316: .LCmodal-window {
8317: position:fixed;
8318: top:50%;
8319: left:50%;
8320: margin:0;
8321: padding:0;
8322: z-index:102;
8323: }
8324:
8325: * html .LCmodal-window {
8326: position:absolute;
8327: }
8328:
8329: .LCclose-window {
8330: position:absolute;
8331: width:32px;
8332: height:32px;
8333: right:8px;
8334: top:8px;
8335: background:transparent url('/res/adm/pages/process-stop.png') no-repeat scroll right top;
8336: text-indent:-99999px;
8337: overflow:hidden;
8338: cursor:pointer;
8339: }
8340:
1.1335 raeburn 8341: pre.LC_wordwrap {
8342: white-space: pre-wrap;
8343: white-space: -moz-pre-wrap;
8344: white-space: -pre-wrap;
8345: white-space: -o-pre-wrap;
8346: word-wrap: break-word;
8347: }
8348:
1.1100 raeburn 8349: /*
1.1231 damieng 8350: styles used for response display
8351: */
8352: div.LC_radiofoil, div.LC_rankfoil {
8353: margin: .5em 0em .5em 0em;
8354: }
8355: table.LC_itemgroup {
8356: margin-top: 1em;
8357: }
8358:
8359: /*
1.1100 raeburn 8360: styles used by TTH when "Default set of options to pass to tth/m
8361: when converting TeX" in course settings has been set
8362:
8363: option passed: -t
8364:
8365: */
8366:
8367: td div.comp { margin-top: -0.6ex; margin-bottom: -1ex;}
8368: td div.comb { margin-top: -0.6ex; margin-bottom: -.6ex;}
8369: td div.hrcomp { line-height: 0.9; margin-top: -0.8ex; margin-bottom: -1ex;}
8370: td div.norm {line-height:normal;}
8371:
8372: /*
8373: option passed -y3
8374: */
8375:
8376: span.roman {font-family: serif; font-style: normal; font-weight: normal;}
8377: span.overacc2 {position: relative; left: .8em; top: -1.2ex;}
8378: span.overacc1 {position: relative; left: .6em; top: -1.2ex;}
8379:
1.1230 damieng 8380: /*
8381: sections with roles, for content only
8382: */
8383: section[class^="role-"] {
8384: padding-left: 10px;
8385: padding-right: 5px;
8386: margin-top: 8px;
8387: margin-bottom: 8px;
8388: border: 1px solid #2A4;
8389: border-radius: 5px;
8390: box-shadow: 0px 1px 1px #BBB;
8391: }
8392: section[class^="role-"]>h1 {
8393: position: relative;
8394: margin: 0px;
8395: padding-top: 10px;
8396: padding-left: 40px;
8397: }
8398: section[class^="role-"]>h1:before {
8399: position: absolute;
8400: left: -5px;
8401: top: 5px;
8402: }
8403: section.role-activity>h1:before {
8404: content:url('/adm/daxe/images/section_icons/activity.png');
8405: }
8406: section.role-advice>h1:before {
8407: content:url('/adm/daxe/images/section_icons/advice.png');
8408: }
8409: section.role-bibliography>h1:before {
8410: content:url('/adm/daxe/images/section_icons/bibliography.png');
8411: }
8412: section.role-citation>h1:before {
8413: content:url('/adm/daxe/images/section_icons/citation.png');
8414: }
8415: section.role-conclusion>h1:before {
8416: content:url('/adm/daxe/images/section_icons/conclusion.png');
8417: }
8418: section.role-definition>h1:before {
8419: content:url('/adm/daxe/images/section_icons/definition.png');
8420: }
8421: section.role-demonstration>h1:before {
8422: content:url('/adm/daxe/images/section_icons/demonstration.png');
8423: }
8424: section.role-example>h1:before {
8425: content:url('/adm/daxe/images/section_icons/example.png');
8426: }
8427: section.role-explanation>h1:before {
8428: content:url('/adm/daxe/images/section_icons/explanation.png');
8429: }
8430: section.role-introduction>h1:before {
8431: content:url('/adm/daxe/images/section_icons/introduction.png');
8432: }
8433: section.role-method>h1:before {
8434: content:url('/adm/daxe/images/section_icons/method.png');
8435: }
8436: section.role-more_information>h1:before {
8437: content:url('/adm/daxe/images/section_icons/more_information.png');
8438: }
8439: section.role-objectives>h1:before {
8440: content:url('/adm/daxe/images/section_icons/objectives.png');
8441: }
8442: section.role-prerequisites>h1:before {
8443: content:url('/adm/daxe/images/section_icons/prerequisites.png');
8444: }
8445: section.role-remark>h1:before {
8446: content:url('/adm/daxe/images/section_icons/remark.png');
8447: }
8448: section.role-reminder>h1:before {
8449: content:url('/adm/daxe/images/section_icons/reminder.png');
8450: }
8451: section.role-summary>h1:before {
8452: content:url('/adm/daxe/images/section_icons/summary.png');
8453: }
8454: section.role-syntax>h1:before {
8455: content:url('/adm/daxe/images/section_icons/syntax.png');
8456: }
8457: section.role-warning>h1:before {
8458: content:url('/adm/daxe/images/section_icons/warning.png');
8459: }
8460:
1.1269 raeburn 8461: #LC_minitab_header {
8462: float:left;
8463: width:100%;
8464: background:#DAE0D2 url("/res/adm/pages/minitabmenu_bg.gif") repeat-x bottom;
8465: font-size:93%;
8466: line-height:normal;
8467: margin: 0.5em 0 0.5em 0;
8468: }
8469: #LC_minitab_header ul {
8470: margin:0;
8471: padding:10px 10px 0;
8472: list-style:none;
8473: }
8474: #LC_minitab_header li {
8475: float:left;
8476: background:url("/res/adm/pages/minitabmenu_left.gif") no-repeat left top;
8477: margin:0;
8478: padding:0 0 0 9px;
8479: }
8480: #LC_minitab_header a {
8481: display:block;
8482: background:url("/res/adm/pages/minitabmenu_right.gif") no-repeat right top;
8483: padding:5px 15px 4px 6px;
8484: }
8485: #LC_minitab_header #LC_current_minitab {
8486: background-image:url("/res/adm/pages/minitabmenu_left_on.gif");
8487: }
8488: #LC_minitab_header #LC_current_minitab a {
8489: background-image:url("/res/adm/pages/minitabmenu_right_on.gif");
8490: padding-bottom:5px;
8491: }
8492:
8493:
1.343 albertel 8494: END
8495: }
8496:
1.306 albertel 8497: =pod
8498:
8499: =item * &headtag()
8500:
8501: Returns a uniform footer for LON-CAPA web pages.
8502:
1.307 albertel 8503: Inputs: $title - optional title for the head
8504: $head_extra - optional extra HTML to put inside the <head>
1.315 albertel 8505: $args - optional arguments
1.319 albertel 8506: force_register - if is true call registerurl so the remote is
8507: informed
1.415 albertel 8508: redirect -> array ref of
8509: 1- seconds before redirect occurs
8510: 2- url to redirect to
8511: 3- whether the side effect should occur
1.315 albertel 8512: (side effect of setting
8513: $env{'internal.head.redirect'} to the url
8514: redirected too)
1.352 albertel 8515: domain -> force to color decorate a page for a specific
8516: domain
8517: function -> force usage of a specific rolish color scheme
8518: bgcolor -> override the default page bgcolor
1.460 albertel 8519: no_auto_mt_title
8520: -> prevent &mt()ing the title arg
1.464 albertel 8521:
1.306 albertel 8522: =cut
8523:
8524: sub headtag {
1.313 albertel 8525: my ($title,$head_extra,$args) = @_;
1.306 albertel 8526:
1.363 albertel 8527: my $function = $args->{'function'} || &get_users_function();
8528: my $domain = $args->{'domain'} || &determinedomain();
8529: my $bgcolor = $args->{'bgcolor'} || &designparm($function.'.pgbg',$domain);
1.1154 raeburn 8530: my $httphost = $args->{'use_absolute'};
1.418 albertel 8531: my $url = join(':',$env{'user.name'},$env{'user.domain'},
1.458 albertel 8532: $Apache::lonnet::perlvar{'lonVersion'},
1.531 albertel 8533: #time(),
1.418 albertel 8534: $env{'environment.color.timestamp'},
1.363 albertel 8535: $function,$domain,$bgcolor);
8536:
1.369 www 8537: $url = '/adm/css/'.&escape($url).'.css';
1.363 albertel 8538:
1.308 albertel 8539: my $result =
8540: '<head>'.
1.1160 raeburn 8541: &font_settings($args);
1.319 albertel 8542:
1.1188 raeburn 8543: my $inhibitprint;
8544: if ($args->{'print_suppress'}) {
8545: $inhibitprint = &print_suppression();
8546: }
1.1064 raeburn 8547:
1.461 albertel 8548: if (!$args->{'frameset'}) {
8549: $result .= &Apache::lonhtmlcommon::htmlareaheaders();
8550: }
1.962 droeschl 8551: if ($args->{'force_register'} && $env{'request.noversionuri'} !~ m{^/res/adm/pages/}) {
8552: $result .= Apache::lonxml::display_title();
1.319 albertel 8553: }
1.436 albertel 8554: if (!$args->{'no_nav_bar'}
8555: && !$args->{'only_body'}
8556: && !$args->{'frameset'}) {
1.1154 raeburn 8557: $result .= &help_menu_js($httphost);
1.1032 www 8558: $result.=&modal_window();
1.1038 www 8559: $result.=&togglebox_script();
1.1034 www 8560: $result.=&wishlist_window();
1.1041 www 8561: $result.=&LCprogressbarUpdate_script();
1.1034 www 8562: } else {
8563: if ($args->{'add_modal'}) {
8564: $result.=&modal_window();
8565: }
8566: if ($args->{'add_wishlist'}) {
8567: $result.=&wishlist_window();
8568: }
1.1038 www 8569: if ($args->{'add_togglebox'}) {
8570: $result.=&togglebox_script();
8571: }
1.1041 www 8572: if ($args->{'add_progressbar'}) {
8573: $result.=&LCprogressbarUpdate_script();
8574: }
1.436 albertel 8575: }
1.314 albertel 8576: if (ref($args->{'redirect'})) {
1.414 albertel 8577: my ($time,$url,$inhibit_continue) = @{$args->{'redirect'}};
1.315 albertel 8578: $url = &Apache::lonenc::check_encrypt($url);
1.414 albertel 8579: if (!$inhibit_continue) {
8580: $env{'internal.head.redirect'} = $url;
8581: }
1.313 albertel 8582: $result.=<<ADDMETA
8583: <meta http-equiv="pragma" content="no-cache" />
1.344 albertel 8584: <meta http-equiv="Refresh" content="$time; url=$url" />
1.313 albertel 8585: ADDMETA
1.1210 raeburn 8586: } else {
8587: unless (($args->{'frameset'}) || ($args->{'js_ready'}) || ($args->{'only_body'}) || ($args->{'no_nav_bar'})) {
8588: my $requrl = $env{'request.uri'};
8589: if ($requrl eq '') {
8590: $requrl = $ENV{'REQUEST_URI'};
8591: $requrl =~ s/\?.+$//;
8592: }
8593: unless (($requrl =~ m{^/adm/(?:switchserver|login|authenticate|logout|groupsort|cleanup|helper|slotrequest|grades)(\?|$)}) ||
8594: (($requrl =~ m{^/res/}) && (($env{'form.submitted'} eq 'scantron') ||
8595: ($env{'form.grade_symb'}) || ($Apache::lonhomework::scantronmode)))) {
8596: my $dom_in_use = $Apache::lonnet::perlvar{'lonDefDomain'};
8597: unless (&Apache::lonnet::allowed('mau',$dom_in_use)) {
8598: my %domdefs = &Apache::lonnet::get_domain_defaults($dom_in_use);
1.1340 raeburn 8599: my $lonhost = $Apache::lonnet::perlvar{'lonHostID'};
8600: my $offload;
1.1210 raeburn 8601: if (ref($domdefs{'offloadnow'}) eq 'HASH') {
8602: if ($domdefs{'offloadnow'}{$lonhost}) {
1.1340 raeburn 8603: $offload = 1;
8604: }
8605: }
8606: unless ($offload) {
8607: if (ref($domdefs{'offloadoth'}) eq 'HASH') {
8608: if ($domdefs{'offloadoth'}{$lonhost}) {
8609: if (($env{'user.domain'} ne '') && ($env{'user.domain'} ne $dom_in_use) &&
8610: (!(($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public')))) {
8611: unless (&Apache::lonnet::shared_institution($env{'user.domain'})) {
8612: $offload = 1;
8613: $dom_in_use = $env{'user.domain'};
8614: }
1.1210 raeburn 8615: }
1.1340 raeburn 8616: }
8617: }
8618: }
8619: if ($offload) {
8620: my $newserver = &Apache::lonnet::spareserver(30000,undef,1,$dom_in_use);
8621: if (($newserver) && ($newserver ne $lonhost)) {
8622: my $numsec = 5;
8623: my $timeout = $numsec * 1000;
8624: my ($newurl,$locknum,%locks,$msg);
8625: if ($env{'request.role.adv'}) {
8626: ($locknum,%locks) = &Apache::lonnet::get_locks();
8627: }
8628: my $disable_submit = 0;
8629: if ($requrl =~ /$LONCAPA::assess_re/) {
8630: $disable_submit = 1;
8631: }
8632: if ($locknum) {
8633: my @lockinfo = sort(values(%locks));
8634: $msg = &mt('Once the following tasks are complete: ')."\n".
8635: join(", ",sort(values(%locks)))."\n";
8636: if (&show_course()) {
8637: $msg .= &mt('your session will be transferred to a different server, after you click "Courses".');
8638: } else {
8639: $msg .= &mt('your session will be transferred to a different server, after you click "Roles".');
1.1210 raeburn 8640: }
1.1340 raeburn 8641: } else {
8642: if (($requrl =~ m{^/res/}) && ($env{'form.submitted'} =~ /^part_/)) {
8643: $msg = &mt('Your LON-CAPA submission has been recorded')."\n";
8644: }
8645: $msg .= &mt('Your current LON-CAPA session will be transferred to a different server in [quant,_1,second].',$numsec);
8646: $newurl = '/adm/switchserver?otherserver='.$newserver;
8647: if (($env{'request.role'}) && ($env{'request.role'} ne 'cm')) {
8648: $newurl .= '&role='.$env{'request.role'};
8649: }
8650: if ($env{'request.symb'}) {
8651: my $shownsymb = &Apache::lonenc::check_encrypt($env{'request.symb'});
8652: if ($shownsymb =~ m{^/enc/}) {
8653: my $reqdmajor = 2;
8654: my $reqdminor = 11;
8655: my $reqdsubminor = 3;
8656: my $newserverrev = &Apache::lonnet::get_server_loncaparev('',$newserver);
8657: my $remoterev = &Apache::lonnet::get_server_loncaparev(undef,$newserver);
8658: my ($major,$minor,$subminor) = ($remoterev =~ /^\'?(\d+)\.(\d+)\.(\d+|)[\w.\-]+\'?$/);
8659: if (($major eq '' && $minor eq '') ||
8660: (($reqdmajor > $major) || (($reqdmajor == $major) && ($reqdminor > $minor)) ||
8661: (($reqdmajor == $major) && ($reqdminor == $minor) && (($subminor eq '') ||
8662: ($reqdsubminor > $subminor))))) {
8663: undef($shownsymb);
8664: }
1.1210 raeburn 8665: }
1.1340 raeburn 8666: if ($shownsymb) {
8667: &js_escape(\$shownsymb);
8668: $newurl .= '&symb='.$shownsymb;
1.1210 raeburn 8669: }
1.1340 raeburn 8670: } else {
8671: my $shownurl = &Apache::lonenc::check_encrypt($requrl);
8672: &js_escape(\$shownurl);
8673: $newurl .= '&origurl='.$shownurl;
1.1210 raeburn 8674: }
1.1340 raeburn 8675: }
8676: &js_escape(\$msg);
8677: $result.=<<OFFLOAD
1.1210 raeburn 8678: <meta http-equiv="pragma" content="no-cache" />
8679: <script type="text/javascript">
1.1215 raeburn 8680: // <![CDATA[
1.1210 raeburn 8681: function LC_Offload_Now() {
8682: var dest = "$newurl";
8683: if (dest != '') {
8684: window.location.href="$newurl";
8685: }
8686: }
1.1214 raeburn 8687: \$(document).ready(function () {
8688: window.alert('$msg');
8689: if ($disable_submit) {
1.1210 raeburn 8690: \$(".LC_hwk_submit").prop("disabled", true);
8691: \$( ".LC_textline" ).prop( "readonly", "readonly");
1.1214 raeburn 8692: }
8693: setTimeout('LC_Offload_Now()', $timeout);
8694: });
1.1215 raeburn 8695: // ]]>
1.1210 raeburn 8696: </script>
8697: OFFLOAD
8698: }
8699: }
8700: }
8701: }
8702: }
1.313 albertel 8703: }
1.306 albertel 8704: if (!defined($title)) {
8705: $title = 'The LearningOnline Network with CAPA';
8706: }
1.460 albertel 8707: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
8708: $result .= '<title> LON-CAPA '.$title.'</title>'
1.1168 raeburn 8709: .'<link rel="stylesheet" type="text/css" href="'.$url.'"';
8710: if (!$args->{'frameset'}) {
8711: $result .= ' /';
8712: }
8713: $result .= '>'
1.1064 raeburn 8714: .$inhibitprint
1.414 albertel 8715: .$head_extra;
1.1242 raeburn 8716: my $clientmobile;
8717: if (($env{'user.name'} eq '') && ($env{'user.domain'} eq '')) {
8718: (undef,undef,undef,undef,undef,undef,$clientmobile) = &decode_user_agent();
8719: } else {
8720: $clientmobile = $env{'browser.mobile'};
8721: }
8722: if ($clientmobile) {
1.1137 raeburn 8723: $result .= '
8724: <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=0, minimum-scale=1.0, maximum-scale=1.0">
8725: <meta name="apple-mobile-web-app-capable" content="yes" />';
8726: }
1.1278 raeburn 8727: $result .= '<meta name="google" content="notranslate" />'."\n";
1.962 droeschl 8728: return $result.'</head>';
1.306 albertel 8729: }
8730:
8731: =pod
8732:
1.340 albertel 8733: =item * &font_settings()
8734:
8735: Returns neccessary <meta> to set the proper encoding
8736:
1.1160 raeburn 8737: Inputs: optional reference to HASH -- $args passed to &headtag()
1.340 albertel 8738:
8739: =cut
8740:
8741: sub font_settings {
1.1160 raeburn 8742: my ($args) = @_;
1.340 albertel 8743: my $headerstring='';
1.1160 raeburn 8744: if ((!$env{'browser.mathml'} && $env{'browser.unicode'}) ||
8745: ((ref($args) eq 'HASH') && ($args->{'browser.unicode'}))) {
1.1168 raeburn 8746: $headerstring.=
8747: '<meta http-equiv="Content-Type" content="text/html; charset=utf-8"';
8748: if (!$args->{'frameset'}) {
8749: $headerstring.= ' /';
8750: }
8751: $headerstring .= '>'."\n";
1.340 albertel 8752: }
8753: return $headerstring;
8754: }
8755:
1.341 albertel 8756: =pod
8757:
1.1064 raeburn 8758: =item * &print_suppression()
8759:
8760: In course context returns css which causes the body to be blank when media="print",
8761: if printout generation is unavailable for the current resource.
8762:
8763: This could be because:
8764:
8765: (a) printstartdate is in the future
8766:
8767: (b) printenddate is in the past
8768:
8769: (c) there is an active exam block with "printout"
8770: functionality blocked
8771:
8772: Users with pav, pfo or evb privileges are exempt.
8773:
8774: Inputs: none
8775:
8776: =cut
8777:
8778:
8779: sub print_suppression {
8780: my $noprint;
8781: if ($env{'request.course.id'}) {
8782: my $scope = $env{'request.course.id'};
8783: if ((&Apache::lonnet::allowed('pav',$scope)) ||
8784: (&Apache::lonnet::allowed('pfo',$scope))) {
8785: return;
8786: }
8787: if ($env{'request.course.sec'} ne '') {
8788: $scope .= "/$env{'request.course.sec'}";
8789: if ((&Apache::lonnet::allowed('pav',$scope)) ||
8790: (&Apache::lonnet::allowed('pfo',$scope))) {
1.1065 raeburn 8791: return;
1.1064 raeburn 8792: }
8793: }
8794: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
8795: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
1.1189 raeburn 8796: my $blocked = &blocking_status('printout',$cnum,$cdom,undef,1);
1.1064 raeburn 8797: if ($blocked) {
8798: my $checkrole = "cm./$cdom/$cnum";
8799: if ($env{'request.course.sec'} ne '') {
8800: $checkrole .= "/$env{'request.course.sec'}";
8801: }
8802: unless ((&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) &&
8803: ($env{'request.role'} !~ m{^st\./$cdom/$cnum})) {
8804: $noprint = 1;
8805: }
8806: }
8807: unless ($noprint) {
8808: my $symb = &Apache::lonnet::symbread();
8809: if ($symb ne '') {
8810: my $navmap = Apache::lonnavmaps::navmap->new();
8811: if (ref($navmap)) {
8812: my $res = $navmap->getBySymb($symb);
8813: if (ref($res)) {
8814: if (!$res->resprintable()) {
8815: $noprint = 1;
8816: }
8817: }
8818: }
8819: }
8820: }
8821: if ($noprint) {
8822: return <<"ENDSTYLE";
8823: <style type="text/css" media="print">
8824: body { display:none }
8825: </style>
8826: ENDSTYLE
8827: }
8828: }
8829: return;
8830: }
8831:
8832: =pod
8833:
1.341 albertel 8834: =item * &xml_begin()
8835:
8836: Returns the needed doctype and <html>
8837:
8838: Inputs: none
8839:
8840: =cut
8841:
8842: sub xml_begin {
1.1168 raeburn 8843: my ($is_frameset) = @_;
1.341 albertel 8844: my $output='';
8845:
8846: if ($env{'browser.mathml'}) {
8847: $output='<?xml version="1.0"?>'
8848: #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
8849: # .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
8850:
8851: # .'<!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">] >'
8852: .'<!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">'
8853: .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" '
8854: .'xmlns="http://www.w3.org/1999/xhtml">';
1.1168 raeburn 8855: } elsif ($is_frameset) {
8856: $output='<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN" "http://www.w3.org/TR/html4/frameset.dtd">'."\n".
8857: '<html>'."\n";
1.341 albertel 8858: } else {
1.1168 raeburn 8859: $output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">'."\n".
8860: '<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">'."\n";
1.341 albertel 8861: }
8862: return $output;
8863: }
1.340 albertel 8864:
8865: =pod
8866:
1.306 albertel 8867: =item * &start_page()
8868:
8869: Returns a complete <html> .. <body> section for LON-CAPA web pages.
8870:
1.648 raeburn 8871: Inputs:
8872:
8873: =over 4
8874:
8875: $title - optional title for the page
8876:
8877: $head_extra - optional extra HTML to incude inside the <head>
8878:
8879: $args - additional optional args supported are:
8880:
8881: =over 8
8882:
8883: only_body -> is true will set &bodytag() onlybodytag
1.317 albertel 8884: arg on
1.814 bisitz 8885: no_nav_bar -> is true will set &bodytag() no_nav_bar arg on
1.648 raeburn 8886: add_entries -> additional attributes to add to the <body>
8887: domain -> force to color decorate a page for a
1.317 albertel 8888: specific domain
1.648 raeburn 8889: function -> force usage of a specific rolish color
1.317 albertel 8890: scheme
1.648 raeburn 8891: redirect -> see &headtag()
8892: bgcolor -> override the default page bg color
8893: js_ready -> return a string ready for being used in
1.317 albertel 8894: a javascript writeln
1.648 raeburn 8895: html_encode -> return a string ready for being used in
1.320 albertel 8896: a html attribute
1.648 raeburn 8897: force_register -> if is true will turn on the &bodytag()
1.317 albertel 8898: $forcereg arg
1.648 raeburn 8899: frameset -> if true will start with a <frameset>
1.330 albertel 8900: rather than <body>
1.648 raeburn 8901: skip_phases -> hash ref of
1.338 albertel 8902: head -> skip the <html><head> generation
8903: body -> skip all <body> generation
1.648 raeburn 8904: no_auto_mt_title -> prevent &mt()ing the title arg
1.867 kalberla 8905: bread_crumbs -> Array containing breadcrumbs
1.983 raeburn 8906: bread_crumbs_component -> if exists show it as headline else show only the breadcrumbs
1.1272 raeburn 8907: bread_crumbs_nomenu -> if true will pass false as the value of $menulink
8908: to lonhtmlcommon::breadcrumbs
1.1096 raeburn 8909: group -> includes the current group, if page is for a
1.1274 raeburn 8910: specific group
8911: use_absolute -> for request for external resource or syllabus, this
8912: will contain https://<hostname> if server uses
8913: https (as per hosts.tab), but request is for http
8914: hostname -> hostname, originally from $r->hostname(), (optional).
1.361 albertel 8915:
1.648 raeburn 8916: =back
1.460 albertel 8917:
1.648 raeburn 8918: =back
1.562 albertel 8919:
1.306 albertel 8920: =cut
8921:
8922: sub start_page {
1.309 albertel 8923: my ($title,$head_extra,$args) = @_;
1.318 albertel 8924: #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
1.319 albertel 8925:
1.315 albertel 8926: $env{'internal.start_page'}++;
1.1318 raeburn 8927: my ($result,@advtools,$ltiscope,$ltiuri,%ltimenu);
1.964 droeschl 8928:
1.338 albertel 8929: if (! exists($args->{'skip_phases'}{'head'}) ) {
1.1168 raeburn 8930: $result .= &xml_begin($args->{'frameset'}) . &headtag($title, $head_extra, $args);
1.338 albertel 8931: }
1.1316 raeburn 8932:
8933: if (($env{'request.course.id'}) && ($env{'request.lti.login'})) {
1.1318 raeburn 8934: if ($env{'course.'.$env{'request.course.id'}.'.lti.override'}) {
8935: unless ($env{'course.'.$env{'request.course.id'}.'.lti.topmenu'}) {
8936: $args->{'no_primary_menu'} = 1;
8937: }
8938: unless ($env{'course.'.$env{'request.course.id'}.'.lti.inlinemenu'}) {
8939: $args->{'no_inline_menu'} = 1;
8940: }
8941: if ($env{'course.'.$env{'request.course.id'}.'.lti.lcmenu'}) {
8942: map { $ltimenu{$_} = 1; } split(/,/,$env{'course.'.$env{'request.course.id'}.'.lti.lcmenu'});
8943: }
8944: } else {
8945: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
8946: my %lti = &Apache::lonnet::get_domain_lti($cdom,'provider');
8947: if (ref($lti{$env{'request.lti.login'}}) eq 'HASH') {
8948: unless ($lti{$env{'request.lti.login'}}{'topmenu'}) {
8949: $args->{'no_primary_menu'} = 1;
8950: }
8951: unless ($lti{$env{'request.lti.login'}}{'inlinemenu'}) {
8952: $args->{'no_inline_menu'} = 1;
8953: }
8954: if (ref($lti{$env{'request.lti.login'}}{'lcmenu'}) eq 'ARRAY') {
8955: map { $ltimenu{$_} = 1; } @{$lti{$env{'request.lti.login'}}{'lcmenu'}};
8956: }
8957: }
8958: }
1.1316 raeburn 8959: ($ltiscope,$ltiuri) = &LONCAPA::ltiutils::lti_provider_scope($env{'request.lti.uri'},
8960: $env{'course.'.$env{'request.course.id'}.'.domain'},
8961: $env{'course.'.$env{'request.course.id'}.'.num'});
8962: }
1.338 albertel 8963:
8964: if (! exists($args->{'skip_phases'}{'body'}) ) {
8965: if ($args->{'frameset'}) {
8966: my $attr_string = &make_attr_string($args->{'force_register'},
8967: $args->{'add_entries'});
8968: $result .= "\n<frameset $attr_string>\n";
1.831 bisitz 8969: } else {
8970: $result .=
8971: &bodytag($title,
8972: $args->{'function'}, $args->{'add_entries'},
8973: $args->{'only_body'}, $args->{'domain'},
8974: $args->{'force_register'}, $args->{'no_nav_bar'},
1.1096 raeburn 8975: $args->{'bgcolor'}, $args,
1.1318 raeburn 8976: \@advtools,$ltiscope,$ltiuri,\%ltimenu);
1.831 bisitz 8977: }
1.330 albertel 8978: }
1.338 albertel 8979:
1.315 albertel 8980: if ($args->{'js_ready'}) {
1.713 kaisler 8981: $result = &js_ready($result);
1.315 albertel 8982: }
1.320 albertel 8983: if ($args->{'html_encode'}) {
1.713 kaisler 8984: $result = &html_encode($result);
8985: }
8986:
1.813 bisitz 8987: # Preparation for new and consistent functionlist at top of screen
8988: # if ($args->{'functionlist'}) {
8989: # $result .= &build_functionlist();
8990: #}
8991:
1.964 droeschl 8992: # Don't add anything more if only_body wanted or in const space
8993: return $result if $args->{'only_body'}
8994: || $env{'request.state'} eq 'construct';
1.813 bisitz 8995:
8996: #Breadcrumbs
1.758 kaisler 8997: if (exists($args->{'bread_crumbs'}) or exists($args->{'bread_crumbs_component'})) {
8998: &Apache::lonhtmlcommon::clear_breadcrumbs();
8999: #if any br links exists, add them to the breadcrumbs
9000: if (exists($args->{'bread_crumbs'}) and ref($args->{'bread_crumbs'}) eq 'ARRAY') {
9001: foreach my $crumb (@{$args->{'bread_crumbs'}}){
9002: &Apache::lonhtmlcommon::add_breadcrumb($crumb);
9003: }
9004: }
1.1096 raeburn 9005: # if @advtools array contains items add then to the breadcrumbs
9006: if (@advtools > 0) {
9007: &Apache::lonmenu::advtools_crumbs(@advtools);
9008: }
1.1272 raeburn 9009: my $menulink;
9010: # if arg: bread_crumbs_nomenu is true pass 0 as $menulink item.
9011: if ((exists($args->{'bread_crumbs_nomenu'})) ||
1.1312 raeburn 9012: ($ltiscope eq 'map') || ($ltiscope eq 'resource') ||
1.1272 raeburn 9013: ((($args->{'crstype'} eq 'Placement') || (($env{'request.course.id'}) &&
9014: ($env{'course.'.$env{'request.course.id'}.'.type'} eq 'Placement'))) &&
9015: (!$env{'request.role.adv'}))) {
9016: $menulink = 0;
9017: } else {
9018: undef($menulink);
9019: }
1.758 kaisler 9020: #if bread_crumbs_component exists show it as headline else show only the breadcrumbs
9021: if(exists($args->{'bread_crumbs_component'})){
1.1272 raeburn 9022: $result .= &Apache::lonhtmlcommon::breadcrumbs($args->{'bread_crumbs_component'},'',$menulink);
1.1237 raeburn 9023: } else {
1.1272 raeburn 9024: $result .= &Apache::lonhtmlcommon::breadcrumbs('','',$menulink);
1.758 kaisler 9025: }
1.320 albertel 9026: }
1.315 albertel 9027: return $result;
1.306 albertel 9028: }
9029:
9030: sub end_page {
1.315 albertel 9031: my ($args) = @_;
9032: $env{'internal.end_page'}++;
1.330 albertel 9033: my $result;
1.335 albertel 9034: if ($args->{'discussion'}) {
9035: my ($target,$parser);
9036: if (ref($args->{'discussion'})) {
9037: ($target,$parser) =($args->{'discussion'}{'target'},
9038: $args->{'discussion'}{'parser'});
9039: }
9040: $result .= &Apache::lonxml::xmlend($target,$parser);
9041: }
1.330 albertel 9042: if ($args->{'frameset'}) {
9043: $result .= '</frameset>';
9044: } else {
1.635 raeburn 9045: $result .= &endbodytag($args);
1.330 albertel 9046: }
1.1080 raeburn 9047: unless ($args->{'notbody'}) {
9048: $result .= "\n</html>";
9049: }
1.330 albertel 9050:
1.315 albertel 9051: if ($args->{'js_ready'}) {
1.317 albertel 9052: $result = &js_ready($result);
1.315 albertel 9053: }
1.335 albertel 9054:
1.320 albertel 9055: if ($args->{'html_encode'}) {
9056: $result = &html_encode($result);
9057: }
1.335 albertel 9058:
1.315 albertel 9059: return $result;
9060: }
9061:
1.1034 www 9062: sub wishlist_window {
9063: return(<<'ENDWISHLIST');
1.1046 raeburn 9064: <script type="text/javascript">
1.1034 www 9065: // <![CDATA[
9066: // <!-- BEGIN LON-CAPA Internal
9067: function set_wishlistlink(title, path) {
9068: if (!title) {
9069: title = document.title;
9070: title = title.replace(/^LON-CAPA /,'');
9071: }
1.1175 raeburn 9072: title = encodeURIComponent(title);
1.1203 raeburn 9073: title = title.replace("'","\\\'");
1.1034 www 9074: if (!path) {
9075: path = location.pathname;
9076: }
1.1175 raeburn 9077: path = encodeURIComponent(path);
1.1203 raeburn 9078: path = path.replace("'","\\\'");
1.1034 www 9079: Win = window.open('/adm/wishlist?mode=newLink&setTitle='+title+'&setPath='+path,
9080: 'wishlistNewLink','width=560,height=350,scrollbars=0');
9081: }
9082: // END LON-CAPA Internal -->
9083: // ]]>
9084: </script>
9085: ENDWISHLIST
9086: }
9087:
1.1030 www 9088: sub modal_window {
9089: return(<<'ENDMODAL');
1.1046 raeburn 9090: <script type="text/javascript">
1.1030 www 9091: // <![CDATA[
9092: // <!-- BEGIN LON-CAPA Internal
9093: var modalWindow = {
9094: parent:"body",
9095: windowId:null,
9096: content:null,
9097: width:null,
9098: height:null,
9099: close:function()
9100: {
9101: $(".LCmodal-window").remove();
9102: $(".LCmodal-overlay").remove();
9103: },
9104: open:function()
9105: {
9106: var modal = "";
9107: modal += "<div class=\"LCmodal-overlay\"></div>";
9108: 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;\">";
9109: modal += this.content;
9110: modal += "</div>";
9111:
9112: $(this.parent).append(modal);
9113:
9114: $(".LCmodal-window").append("<a class=\"LCclose-window\"></a>");
9115: $(".LCclose-window").click(function(){modalWindow.close();});
9116: $(".LCmodal-overlay").click(function(){modalWindow.close();});
9117: }
9118: };
1.1140 raeburn 9119: var openMyModal = function(source,width,height,scrolling,transparency,style)
1.1030 www 9120: {
1.1266 raeburn 9121: source = source.replace(/'/g,"'");
1.1030 www 9122: modalWindow.windowId = "myModal";
9123: modalWindow.width = width;
9124: modalWindow.height = height;
1.1196 raeburn 9125: modalWindow.content = "<iframe width='"+width+"' height='"+height+"' frameborder='0' scrolling='"+scrolling+"' allowtransparency='"+transparency+"' src='" + source + "' style='"+style+"'></iframe>";
1.1030 www 9126: modalWindow.open();
1.1208 raeburn 9127: };
1.1030 www 9128: // END LON-CAPA Internal -->
9129: // ]]>
9130: </script>
9131: ENDMODAL
9132: }
9133:
9134: sub modal_link {
1.1140 raeburn 9135: my ($link,$linktext,$width,$height,$target,$scrolling,$title,$transparency,$style)=@_;
1.1030 www 9136: unless ($width) { $width=480; }
9137: unless ($height) { $height=400; }
1.1031 www 9138: unless ($scrolling) { $scrolling='yes'; }
1.1140 raeburn 9139: unless ($transparency) { $transparency='true'; }
9140:
1.1074 raeburn 9141: my $target_attr;
9142: if (defined($target)) {
9143: $target_attr = 'target="'.$target.'"';
9144: }
9145: return <<"ENDLINK";
1.1336 raeburn 9146: <a href="$link" $target_attr title="$title" onclick="javascript:openMyModal('$link',$width,$height,'$scrolling','$transparency','$style'); return false;">$linktext</a>
1.1074 raeburn 9147: ENDLINK
1.1030 www 9148: }
9149:
1.1032 www 9150: sub modal_adhoc_script {
9151: my ($funcname,$width,$height,$content)=@_;
9152: return (<<ENDADHOC);
1.1046 raeburn 9153: <script type="text/javascript">
1.1032 www 9154: // <![CDATA[
9155: var $funcname = function()
9156: {
9157: modalWindow.windowId = "myModal";
9158: modalWindow.width = $width;
9159: modalWindow.height = $height;
9160: modalWindow.content = '$content';
9161: modalWindow.open();
9162: };
9163: // ]]>
9164: </script>
9165: ENDADHOC
9166: }
9167:
1.1041 www 9168: sub modal_adhoc_inner {
9169: my ($funcname,$width,$height,$content)=@_;
9170: my $innerwidth=$width-20;
9171: $content=&js_ready(
1.1140 raeburn 9172: &start_page('Dialog',undef,{'only_body'=>1,'bgcolor'=>'#FFFFFF'}).
9173: &start_scrollbox($width.'px',$innerwidth.'px',$height.'px','myModal','#FFFFFF',undef,1).
9174: $content.
1.1041 www 9175: &end_scrollbox().
1.1140 raeburn 9176: &end_page()
1.1041 www 9177: );
9178: return &modal_adhoc_script($funcname,$width,$height,$content);
9179: }
9180:
9181: sub modal_adhoc_window {
9182: my ($funcname,$width,$height,$content,$linktext)=@_;
9183: return &modal_adhoc_inner($funcname,$width,$height,$content).
9184: "<a href=\"javascript:$funcname();void(0);\">".$linktext."</a>";
9185: }
9186:
9187: sub modal_adhoc_launch {
9188: my ($funcname,$width,$height,$content)=@_;
9189: return &modal_adhoc_inner($funcname,$width,$height,$content).(<<ENDLAUNCH);
9190: <script type="text/javascript">
9191: // <![CDATA[
9192: $funcname();
9193: // ]]>
9194: </script>
9195: ENDLAUNCH
9196: }
9197:
9198: sub modal_adhoc_close {
9199: return (<<ENDCLOSE);
9200: <script type="text/javascript">
9201: // <![CDATA[
9202: modalWindow.close();
9203: // ]]>
9204: </script>
9205: ENDCLOSE
9206: }
9207:
1.1038 www 9208: sub togglebox_script {
9209: return(<<ENDTOGGLE);
9210: <script type="text/javascript">
9211: // <![CDATA[
9212: function LCtoggleDisplay(id,hidetext,showtext) {
9213: link = document.getElementById(id + "link").childNodes[0];
9214: with (document.getElementById(id).style) {
9215: if (display == "none" ) {
9216: display = "inline";
9217: link.nodeValue = hidetext;
9218: } else {
9219: display = "none";
9220: link.nodeValue = showtext;
9221: }
9222: }
9223: }
9224: // ]]>
9225: </script>
9226: ENDTOGGLE
9227: }
9228:
1.1039 www 9229: sub start_togglebox {
9230: my ($id,$heading,$headerbg,$hidetext,$showtext)=@_;
9231: unless ($heading) { $heading=''; } else { $heading.=' '; }
9232: unless ($showtext) { $showtext=&mt('show'); }
9233: unless ($hidetext) { $hidetext=&mt('hide'); }
9234: unless ($headerbg) { $headerbg='#FFFFFF'; }
9235: return &start_data_table().
9236: &start_data_table_header_row().
9237: '<td bgcolor="'.$headerbg.'">'.$heading.
9238: '[<a id="'.$id.'link" href="javascript:LCtoggleDisplay(\''.$id.'\',\''.$hidetext.'\',\''.
9239: $showtext.'\')">'.$showtext.'</a>]</td>'.
9240: &end_data_table_header_row().
9241: '<tr id="'.$id.'" style="display:none""><td>';
9242: }
9243:
9244: sub end_togglebox {
9245: return '</td></tr>'.&end_data_table();
9246: }
9247:
1.1041 www 9248: sub LCprogressbar_script {
1.1302 raeburn 9249: my ($id,$number_to_do)=@_;
9250: if ($number_to_do) {
9251: return(<<ENDPROGRESS);
1.1041 www 9252: <script type="text/javascript">
9253: // <![CDATA[
1.1045 www 9254: \$('#progressbar$id').progressbar({
1.1041 www 9255: value: 0,
9256: change: function(event, ui) {
9257: var newVal = \$(this).progressbar('option', 'value');
9258: \$('.pblabel', this).text(LCprogressTxt);
9259: }
9260: });
9261: // ]]>
9262: </script>
9263: ENDPROGRESS
1.1302 raeburn 9264: } else {
9265: return(<<ENDPROGRESS);
9266: <script type="text/javascript">
9267: // <![CDATA[
9268: \$('#progressbar$id').progressbar({
9269: value: false,
9270: create: function(event, ui) {
9271: \$('.ui-widget-header', this).css({'background':'#F0F0F0'});
9272: \$('.ui-progressbar-overlay', this).css({'margin':'0'});
9273: }
9274: });
9275: // ]]>
9276: </script>
9277: ENDPROGRESS
9278: }
1.1041 www 9279: }
9280:
9281: sub LCprogressbarUpdate_script {
9282: return(<<ENDPROGRESSUPDATE);
9283: <style type="text/css">
9284: .ui-progressbar { position:relative; }
1.1302 raeburn 9285: .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 9286: .pblabel { position: absolute; width: 100%; text-align: center; line-height: 1.9em; }
9287: </style>
9288: <script type="text/javascript">
9289: // <![CDATA[
1.1045 www 9290: var LCprogressTxt='---';
9291:
1.1302 raeburn 9292: function LCupdateProgress(percent,progresstext,id,maxnum) {
1.1041 www 9293: LCprogressTxt=progresstext;
1.1302 raeburn 9294: if ((maxnum == '') || (maxnum == undefined) || (maxnum == null)) {
9295: \$('#progressbar'+id).find('.progress-label').text(LCprogressTxt);
9296: } else if (percent === \$('#progressbar'+id).progressbar( "value" )) {
1.1301 raeburn 9297: \$('#progressbar'+id).find('.pblabel').text(LCprogressTxt);
9298: } else {
9299: \$('#progressbar'+id).progressbar('value',percent);
9300: }
1.1041 www 9301: }
9302: // ]]>
9303: </script>
9304: ENDPROGRESSUPDATE
9305: }
9306:
1.1042 www 9307: my $LClastpercent;
1.1045 www 9308: my $LCidcnt;
9309: my $LCcurrentid;
1.1042 www 9310:
1.1041 www 9311: sub LCprogressbar {
1.1302 raeburn 9312: my ($r,$number_to_do,$preamble)=@_;
1.1042 www 9313: $LClastpercent=0;
1.1045 www 9314: $LCidcnt++;
9315: $LCcurrentid=$$.'_'.$LCidcnt;
1.1302 raeburn 9316: my ($starting,$content);
9317: if ($number_to_do) {
9318: $starting=&mt('Starting');
9319: $content=(<<ENDPROGBAR);
9320: $preamble
1.1045 www 9321: <div id="progressbar$LCcurrentid">
1.1041 www 9322: <span class="pblabel">$starting</span>
9323: </div>
9324: ENDPROGBAR
1.1302 raeburn 9325: } else {
9326: $starting=&mt('Loading...');
9327: $LClastpercent='false';
9328: $content=(<<ENDPROGBAR);
9329: $preamble
9330: <div id="progressbar$LCcurrentid">
9331: <div class="progress-label">$starting</div>
9332: </div>
9333: ENDPROGBAR
9334: }
9335: &r_print($r,$content.&LCprogressbar_script($LCcurrentid,$number_to_do));
1.1041 www 9336: }
9337:
9338: sub LCprogressbarUpdate {
1.1302 raeburn 9339: my ($r,$val,$text,$number_to_do)=@_;
9340: if ($number_to_do) {
9341: unless ($val) {
9342: if ($LClastpercent) {
9343: $val=$LClastpercent;
9344: } else {
9345: $val=0;
9346: }
9347: }
9348: if ($val<0) { $val=0; }
9349: if ($val>100) { $val=0; }
9350: $LClastpercent=$val;
9351: unless ($text) { $text=$val.'%'; }
9352: } else {
9353: $val = 'false';
1.1042 www 9354: }
1.1041 www 9355: $text=&js_ready($text);
1.1044 www 9356: &r_print($r,<<ENDUPDATE);
1.1041 www 9357: <script type="text/javascript">
9358: // <![CDATA[
1.1302 raeburn 9359: LCupdateProgress($val,'$text','$LCcurrentid','$number_to_do');
1.1041 www 9360: // ]]>
9361: </script>
9362: ENDUPDATE
1.1035 www 9363: }
9364:
1.1042 www 9365: sub LCprogressbarClose {
9366: my ($r)=@_;
9367: $LClastpercent=0;
1.1044 www 9368: &r_print($r,<<ENDCLOSE);
1.1042 www 9369: <script type="text/javascript">
9370: // <![CDATA[
1.1045 www 9371: \$("#progressbar$LCcurrentid").hide('slow');
1.1042 www 9372: // ]]>
9373: </script>
9374: ENDCLOSE
1.1044 www 9375: }
9376:
9377: sub r_print {
9378: my ($r,$to_print)=@_;
9379: if ($r) {
9380: $r->print($to_print);
9381: $r->rflush();
9382: } else {
9383: print($to_print);
9384: }
1.1042 www 9385: }
9386:
1.320 albertel 9387: sub html_encode {
9388: my ($result) = @_;
9389:
1.322 albertel 9390: $result = &HTML::Entities::encode($result,'<>&"');
1.320 albertel 9391:
9392: return $result;
9393: }
1.1044 www 9394:
1.317 albertel 9395: sub js_ready {
9396: my ($result) = @_;
9397:
1.323 albertel 9398: $result =~ s/[\n\r]/ /xmsg;
9399: $result =~ s/\\/\\\\/xmsg;
9400: $result =~ s/'/\\'/xmsg;
1.372 albertel 9401: $result =~ s{</}{<\\/}xmsg;
1.317 albertel 9402:
9403: return $result;
9404: }
9405:
1.315 albertel 9406: sub validate_page {
9407: if ( exists($env{'internal.start_page'})
1.316 albertel 9408: && $env{'internal.start_page'} > 1) {
9409: &Apache::lonnet::logthis('start_page called multiple times '.
1.318 albertel 9410: $env{'internal.start_page'}.' '.
1.316 albertel 9411: $ENV{'request.filename'});
1.315 albertel 9412: }
9413: if ( exists($env{'internal.end_page'})
1.316 albertel 9414: && $env{'internal.end_page'} > 1) {
9415: &Apache::lonnet::logthis('end_page called multiple times '.
1.318 albertel 9416: $env{'internal.end_page'}.' '.
1.316 albertel 9417: $env{'request.filename'});
1.315 albertel 9418: }
9419: if ( exists($env{'internal.start_page'})
9420: && ! exists($env{'internal.end_page'})) {
1.316 albertel 9421: &Apache::lonnet::logthis('start_page called without end_page '.
9422: $env{'request.filename'});
1.315 albertel 9423: }
9424: if ( ! exists($env{'internal.start_page'})
9425: && exists($env{'internal.end_page'})) {
1.316 albertel 9426: &Apache::lonnet::logthis('end_page called without start_page'.
9427: $env{'request.filename'});
1.315 albertel 9428: }
1.306 albertel 9429: }
1.315 albertel 9430:
1.996 www 9431:
9432: sub start_scrollbox {
1.1140 raeburn 9433: my ($outerwidth,$width,$height,$id,$bgcolor,$cursor,$needjsready) = @_;
1.998 raeburn 9434: unless ($outerwidth) { $outerwidth='520px'; }
9435: unless ($width) { $width='500px'; }
9436: unless ($height) { $height='200px'; }
1.1075 raeburn 9437: my ($table_id,$div_id,$tdcol);
1.1018 raeburn 9438: if ($id ne '') {
1.1140 raeburn 9439: $table_id = ' id="table_'.$id.'"';
1.1137 raeburn 9440: $div_id = ' id="div_'.$id.'"';
1.1018 raeburn 9441: }
1.1075 raeburn 9442: if ($bgcolor ne '') {
9443: $tdcol = "background-color: $bgcolor;";
9444: }
1.1137 raeburn 9445: my $nicescroll_js;
9446: if ($env{'browser.mobile'}) {
1.1140 raeburn 9447: $nicescroll_js = &nicescroll_javascript('div_'.$id,$cursor,$needjsready);
9448: }
9449: return <<"END";
9450: $nicescroll_js
9451:
9452: <table style="width: $outerwidth; border: 1px solid none;"$table_id><tr><td style="width: $width;$tdcol">
9453: <div style="overflow:auto; width:$width; height:$height;"$div_id>
9454: END
9455: }
9456:
9457: sub end_scrollbox {
9458: return '</div></td></tr></table>';
9459: }
9460:
9461: sub nicescroll_javascript {
9462: my ($id,$cursor,$needjsready,$framecheck,$location) = @_;
9463: my %options;
9464: if (ref($cursor) eq 'HASH') {
9465: %options = %{$cursor};
9466: }
9467: unless ($options{'railalign'} =~ /^left|right$/) {
9468: $options{'railalign'} = 'left';
9469: }
9470: unless ($options{'cursorcolor'} =~ /^\#\w+$/) {
9471: my $function = &get_users_function();
9472: $options{'cursorcolor'} = &designparm($function.'.sidebg',$env{'request.role.domain'});
1.1138 raeburn 9473: unless ($options{'cursorcolor'} =~ /^\#\w+$/) {
1.1140 raeburn 9474: $options{'cursorcolor'} = '#00F';
1.1138 raeburn 9475: }
1.1140 raeburn 9476: }
9477: if ($options{'cursoropacity'} =~ /^[\d.]+$/) {
9478: unless ($options{'cursoropacity'} >= 0.0 && $options{'cursoropacity'} <=1.0) {
1.1138 raeburn 9479: $options{'cursoropacity'}='1.0';
9480: }
1.1140 raeburn 9481: } else {
9482: $options{'cursoropacity'}='1.0';
9483: }
9484: if ($options{'cursorfixedheight'} eq 'none') {
9485: delete($options{'cursorfixedheight'});
9486: } else {
9487: unless ($options{'cursorfixedheight'} =~ /^\d+$/) { $options{'cursorfixedheight'}='50'; }
9488: }
9489: unless ($options{'railoffset'} =~ /^{[\w\:\d\-,]+}$/) {
9490: delete($options{'railoffset'});
9491: }
9492: my @niceoptions;
9493: while (my($key,$value) = each(%options)) {
9494: if ($value =~ /^\{.+\}$/) {
9495: push(@niceoptions,$key.':'.$value);
1.1138 raeburn 9496: } else {
1.1140 raeburn 9497: push(@niceoptions,$key.':"'.$value.'"');
1.1138 raeburn 9498: }
1.1140 raeburn 9499: }
9500: my $nicescroll_js = '
1.1137 raeburn 9501: $(document).ready(
1.1140 raeburn 9502: function() {
9503: $("#'.$id.'").niceScroll({'.join(',',@niceoptions).'});
9504: }
1.1137 raeburn 9505: );
9506: ';
1.1140 raeburn 9507: if ($framecheck) {
9508: $nicescroll_js .= '
9509: function expand_div(caller) {
9510: if (top === self) {
9511: document.getElementById("'.$id.'").style.width = "auto";
9512: document.getElementById("'.$id.'").style.height = "auto";
9513: } else {
9514: try {
9515: if (parent.frames) {
9516: if (parent.frames.length > 1) {
9517: var framesrc = parent.frames[1].location.href;
9518: var currsrc = framesrc.replace(/\#.*$/,"");
9519: if ((caller == "search") || (currsrc == "'.$location.'")) {
9520: document.getElementById("'.$id.'").style.width = "auto";
9521: document.getElementById("'.$id.'").style.height = "auto";
9522: }
9523: }
9524: }
9525: } catch (e) {
9526: return;
9527: }
1.1137 raeburn 9528: }
1.1140 raeburn 9529: return;
1.996 www 9530: }
1.1140 raeburn 9531: ';
9532: }
9533: if ($needjsready) {
9534: $nicescroll_js = '
9535: <script type="text/javascript">'."\n".$nicescroll_js."\n</script>\n";
9536: } else {
9537: $nicescroll_js = &Apache::lonhtmlcommon::scripttag($nicescroll_js);
9538: }
9539: return $nicescroll_js;
1.996 www 9540: }
9541:
1.318 albertel 9542: sub simple_error_page {
1.1150 bisitz 9543: my ($r,$title,$msg,$args) = @_;
1.1304 raeburn 9544: my %displayargs;
1.1151 raeburn 9545: if (ref($args) eq 'HASH') {
9546: if (!$args->{'no_auto_mt_msg'}) { $msg = &mt($msg); }
1.1304 raeburn 9547: if ($args->{'only_body'}) {
9548: $displayargs{'only_body'} = 1;
9549: }
9550: if ($args->{'no_nav_bar'}) {
9551: $displayargs{'no_nav_bar'} = 1;
9552: }
1.1151 raeburn 9553: } else {
9554: $msg = &mt($msg);
9555: }
1.1150 bisitz 9556:
1.318 albertel 9557: my $page =
1.1304 raeburn 9558: &Apache::loncommon::start_page($title,'',\%displayargs).
1.1150 bisitz 9559: '<p class="LC_error">'.$msg.'</p>'.
1.318 albertel 9560: &Apache::loncommon::end_page();
9561: if (ref($r)) {
9562: $r->print($page);
1.327 albertel 9563: return;
1.318 albertel 9564: }
9565: return $page;
9566: }
1.347 albertel 9567:
9568: {
1.610 albertel 9569: my @row_count;
1.961 onken 9570:
9571: sub start_data_table_count {
9572: unshift(@row_count, 0);
9573: return;
9574: }
9575:
9576: sub end_data_table_count {
9577: shift(@row_count);
9578: return;
9579: }
9580:
1.347 albertel 9581: sub start_data_table {
1.1018 raeburn 9582: my ($add_class,$id) = @_;
1.422 albertel 9583: my $css_class = (join(' ','LC_data_table',$add_class));
1.1018 raeburn 9584: my $table_id;
9585: if (defined($id)) {
9586: $table_id = ' id="'.$id.'"';
9587: }
1.961 onken 9588: &start_data_table_count();
1.1018 raeburn 9589: return '<table class="'.$css_class.'"'.$table_id.'>'."\n";
1.347 albertel 9590: }
9591:
9592: sub end_data_table {
1.961 onken 9593: &end_data_table_count();
1.389 albertel 9594: return '</table>'."\n";;
1.347 albertel 9595: }
9596:
9597: sub start_data_table_row {
1.974 wenzelju 9598: my ($add_class, $id) = @_;
1.610 albertel 9599: $row_count[0]++;
9600: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.900 bisitz 9601: $css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
1.974 wenzelju 9602: $id = (' id="'.$id.'"') unless ($id eq '');
9603: return '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.347 albertel 9604: }
1.471 banghart 9605:
9606: sub continue_data_table_row {
1.974 wenzelju 9607: my ($add_class, $id) = @_;
1.610 albertel 9608: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.974 wenzelju 9609: $css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
9610: $id = (' id="'.$id.'"') unless ($id eq '');
9611: return '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.471 banghart 9612: }
1.347 albertel 9613:
9614: sub end_data_table_row {
1.389 albertel 9615: return '</tr>'."\n";;
1.347 albertel 9616: }
1.367 www 9617:
1.421 albertel 9618: sub start_data_table_empty_row {
1.707 bisitz 9619: # $row_count[0]++;
1.421 albertel 9620: return '<tr class="LC_empty_row" >'."\n";;
9621: }
9622:
9623: sub end_data_table_empty_row {
9624: return '</tr>'."\n";;
9625: }
9626:
1.367 www 9627: sub start_data_table_header_row {
1.389 albertel 9628: return '<tr class="LC_header_row">'."\n";;
1.367 www 9629: }
9630:
9631: sub end_data_table_header_row {
1.389 albertel 9632: return '</tr>'."\n";;
1.367 www 9633: }
1.890 droeschl 9634:
9635: sub data_table_caption {
9636: my $caption = shift;
9637: return "<caption class=\"LC_caption\">$caption</caption>";
9638: }
1.347 albertel 9639: }
9640:
1.548 albertel 9641: =pod
9642:
9643: =item * &inhibit_menu_check($arg)
9644:
9645: Checks for a inhibitmenu state and generates output to preserve it
9646:
9647: Inputs: $arg - can be any of
9648: - undef - in which case the return value is a string
9649: to add into arguments list of a uri
9650: - 'input' - in which case the return value is a HTML
9651: <form> <input> field of type hidden to
9652: preserve the value
9653: - a url - in which case the return value is the url with
9654: the neccesary cgi args added to preserve the
9655: inhibitmenu state
9656: - a ref to a url - no return value, but the string is
9657: updated to include the neccessary cgi
9658: args to preserve the inhibitmenu state
9659:
9660: =cut
9661:
9662: sub inhibit_menu_check {
9663: my ($arg) = @_;
9664: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
9665: if ($arg eq 'input') {
9666: if ($env{'form.inhibitmenu'}) {
9667: return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
9668: } else {
9669: return
9670: }
9671: }
9672: if ($env{'form.inhibitmenu'}) {
9673: if (ref($arg)) {
9674: $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
9675: } elsif ($arg eq '') {
9676: $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
9677: } else {
9678: $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
9679: }
9680: }
9681: if (!ref($arg)) {
9682: return $arg;
9683: }
9684: }
9685:
1.251 albertel 9686: ###############################################
1.182 matthew 9687:
9688: =pod
9689:
1.549 albertel 9690: =back
9691:
9692: =head1 User Information Routines
9693:
9694: =over 4
9695:
1.405 albertel 9696: =item * &get_users_function()
1.182 matthew 9697:
9698: Used by &bodytag to determine the current users primary role.
9699: Returns either 'student','coordinator','admin', or 'author'.
9700:
9701: =cut
9702:
9703: ###############################################
9704: sub get_users_function {
1.815 tempelho 9705: my $function = 'norole';
1.818 tempelho 9706: if ($env{'request.role'}=~/^(st)/) {
9707: $function='student';
9708: }
1.907 raeburn 9709: if ($env{'request.role'}=~/^(cc|co|in|ta|ep)/) {
1.182 matthew 9710: $function='coordinator';
9711: }
1.258 albertel 9712: if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182 matthew 9713: $function='admin';
9714: }
1.826 bisitz 9715: if (($env{'request.role'}=~/^(au|ca|aa)/) ||
1.1025 raeburn 9716: ($ENV{'REQUEST_URI'}=~ m{/^(/priv)})) {
1.182 matthew 9717: $function='author';
9718: }
9719: return $function;
1.54 www 9720: }
1.99 www 9721:
9722: ###############################################
9723:
1.233 raeburn 9724: =pod
9725:
1.821 raeburn 9726: =item * &show_course()
9727:
9728: Used by lonmenu.pm and lonroles.pm to determine whether to use the word
9729: 'Courses' or 'Roles' in inline navigation and on screen displaying user's roles.
9730:
9731: Inputs:
9732: None
9733:
9734: Outputs:
9735: Scalar: 1 if 'Course' to be used, 0 otherwise.
9736:
9737: =cut
9738:
9739: ###############################################
9740: sub show_course {
9741: my $course = !$env{'user.adv'};
9742: if (!$env{'user.adv'}) {
9743: foreach my $env (keys(%env)) {
9744: next if ($env !~ m/^user\.priv\./);
9745: if ($env !~ m/^user\.priv\.(?:st|cm)/) {
9746: $course = 0;
9747: last;
9748: }
9749: }
9750: }
9751: return $course;
9752: }
9753:
9754: ###############################################
9755:
9756: =pod
9757:
1.542 raeburn 9758: =item * &check_user_status()
1.274 raeburn 9759:
9760: Determines current status of supplied role for a
9761: specific user. Roles can be active, previous or future.
9762:
9763: Inputs:
9764: user's domain, user's username, course's domain,
1.375 raeburn 9765: course's number, optional section ID.
1.274 raeburn 9766:
9767: Outputs:
9768: role status: active, previous or future.
9769:
9770: =cut
9771:
9772: sub check_user_status {
1.412 raeburn 9773: my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
1.1073 raeburn 9774: my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname);
1.1202 raeburn 9775: my @uroles = keys(%userinfo);
1.274 raeburn 9776: my $srchstr;
9777: my $active_chk = 'none';
1.412 raeburn 9778: my $now = time;
1.274 raeburn 9779: if (@uroles > 0) {
1.908 raeburn 9780: if (($role eq 'cc') || ($role eq 'co') || ($sec eq '') || (!defined($sec))) {
1.274 raeburn 9781: $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
9782: } else {
1.412 raeburn 9783: $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
9784: }
9785: if (grep/^\Q$srchstr\E$/,@uroles) {
1.274 raeburn 9786: my $role_end = 0;
9787: my $role_start = 0;
9788: $active_chk = 'active';
1.412 raeburn 9789: if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
9790: $role_end = $1;
9791: if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
9792: $role_start = $1;
1.274 raeburn 9793: }
9794: }
9795: if ($role_start > 0) {
1.412 raeburn 9796: if ($now < $role_start) {
1.274 raeburn 9797: $active_chk = 'future';
9798: }
9799: }
9800: if ($role_end > 0) {
1.412 raeburn 9801: if ($now > $role_end) {
1.274 raeburn 9802: $active_chk = 'previous';
9803: }
9804: }
9805: }
9806: }
9807: return $active_chk;
9808: }
9809:
9810: ###############################################
9811:
9812: =pod
9813:
1.405 albertel 9814: =item * &get_sections()
1.233 raeburn 9815:
9816: Determines all the sections for a course including
9817: sections with students and sections containing other roles.
1.419 raeburn 9818: Incoming parameters:
9819:
9820: 1. domain
9821: 2. course number
9822: 3. reference to array containing roles for which sections should
9823: be gathered (optional).
9824: 4. reference to array containing status types for which sections
9825: should be gathered (optional).
9826:
9827: If the third argument is undefined, sections are gathered for any role.
9828: If the fourth argument is undefined, sections are gathered for any status.
9829: Permissible values are 'active' or 'future' or 'previous'.
1.233 raeburn 9830:
1.374 raeburn 9831: Returns section hash (keys are section IDs, values are
9832: number of users in each section), subject to the
1.419 raeburn 9833: optional roles filter, optional status filter
1.233 raeburn 9834:
9835: =cut
9836:
9837: ###############################################
9838: sub get_sections {
1.419 raeburn 9839: my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
1.366 albertel 9840: if (!defined($cdom) || !defined($cnum)) {
9841: my $cid = $env{'request.course.id'};
9842:
9843: return if (!defined($cid));
9844:
9845: $cdom = $env{'course.'.$cid.'.domain'};
9846: $cnum = $env{'course.'.$cid.'.num'};
9847: }
9848:
9849: my %sectioncount;
1.419 raeburn 9850: my $now = time;
1.240 albertel 9851:
1.1118 raeburn 9852: my $check_students = 1;
9853: my $only_students = 0;
9854: if (ref($possible_roles) eq 'ARRAY') {
9855: if (grep(/^st$/,@{$possible_roles})) {
9856: if (@{$possible_roles} == 1) {
9857: $only_students = 1;
9858: }
9859: } else {
9860: $check_students = 0;
9861: }
9862: }
9863:
9864: if ($check_students) {
1.276 albertel 9865: my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240 albertel 9866: my $sec_index = &Apache::loncoursedata::CL_SECTION();
9867: my $status_index = &Apache::loncoursedata::CL_STATUS();
1.419 raeburn 9868: my $start_index = &Apache::loncoursedata::CL_START();
9869: my $end_index = &Apache::loncoursedata::CL_END();
9870: my $status;
1.366 albertel 9871: while (my ($student,$data) = each(%$classlist)) {
1.419 raeburn 9872: my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
9873: $data->[$status_index],
9874: $data->[$start_index],
9875: $data->[$end_index]);
9876: if ($stu_status eq 'Active') {
9877: $status = 'active';
9878: } elsif ($end < $now) {
9879: $status = 'previous';
9880: } elsif ($start > $now) {
9881: $status = 'future';
9882: }
9883: if ($section ne '-1' && $section !~ /^\s*$/) {
9884: if ((!defined($possible_status)) || (($status ne '') &&
9885: (grep/^\Q$status\E$/,@{$possible_status}))) {
9886: $sectioncount{$section}++;
9887: }
1.240 albertel 9888: }
9889: }
9890: }
1.1118 raeburn 9891: if ($only_students) {
9892: return %sectioncount;
9893: }
1.240 albertel 9894: my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
9895: foreach my $user (sort(keys(%courseroles))) {
9896: if ($user !~ /^(\w{2})/) { next; }
9897: my ($role) = ($user =~ /^(\w{2})/);
9898: if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
1.419 raeburn 9899: my ($section,$status);
1.240 albertel 9900: if ($role eq 'cr' &&
9901: $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
9902: $section=$1;
9903: }
9904: if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
9905: if (!defined($section) || $section eq '-1') { next; }
1.419 raeburn 9906: my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
9907: if ($end == -1 && $start == -1) {
9908: next; #deleted role
9909: }
9910: if (!defined($possible_status)) {
9911: $sectioncount{$section}++;
9912: } else {
9913: if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
9914: $status = 'active';
9915: } elsif ($end < $now) {
9916: $status = 'future';
9917: } elsif ($start > $now) {
9918: $status = 'previous';
9919: }
9920: if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
9921: $sectioncount{$section}++;
9922: }
9923: }
1.233 raeburn 9924: }
1.366 albertel 9925: return %sectioncount;
1.233 raeburn 9926: }
9927:
1.274 raeburn 9928: ###############################################
1.294 raeburn 9929:
9930: =pod
1.405 albertel 9931:
9932: =item * &get_course_users()
9933:
1.275 raeburn 9934: Retrieves usernames:domains for users in the specified course
9935: with specific role(s), and access status.
9936:
9937: Incoming parameters:
1.277 albertel 9938: 1. course domain
9939: 2. course number
9940: 3. access status: users must have - either active,
1.275 raeburn 9941: previous, future, or all.
1.277 albertel 9942: 4. reference to array of permissible roles
1.288 raeburn 9943: 5. reference to array of section restrictions (optional)
9944: 6. reference to results object (hash of hashes).
9945: 7. reference to optional userdata hash
1.609 raeburn 9946: 8. reference to optional statushash
1.630 raeburn 9947: 9. flag if privileged users (except those set to unhide in
9948: course settings) should be excluded
1.609 raeburn 9949: Keys of top level results hash are roles.
1.275 raeburn 9950: Keys of inner hashes are username:domain, with
9951: values set to access type.
1.288 raeburn 9952: Optional userdata hash returns an array with arguments in the
9953: same order as loncoursedata::get_classlist() for student data.
9954:
1.609 raeburn 9955: Optional statushash returns
9956:
1.288 raeburn 9957: Entries for end, start, section and status are blank because
9958: of the possibility of multiple values for non-student roles.
9959:
1.275 raeburn 9960: =cut
1.405 albertel 9961:
1.275 raeburn 9962: ###############################################
1.405 albertel 9963:
1.275 raeburn 9964: sub get_course_users {
1.630 raeburn 9965: my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
1.288 raeburn 9966: my %idx = ();
1.419 raeburn 9967: my %seclists;
1.288 raeburn 9968:
9969: $idx{udom} = &Apache::loncoursedata::CL_SDOM();
9970: $idx{uname} = &Apache::loncoursedata::CL_SNAME();
9971: $idx{end} = &Apache::loncoursedata::CL_END();
9972: $idx{start} = &Apache::loncoursedata::CL_START();
9973: $idx{id} = &Apache::loncoursedata::CL_ID();
9974: $idx{section} = &Apache::loncoursedata::CL_SECTION();
9975: $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
9976: $idx{status} = &Apache::loncoursedata::CL_STATUS();
9977:
1.290 albertel 9978: if (grep(/^st$/,@{$roles})) {
1.276 albertel 9979: my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278 raeburn 9980: my $now = time;
1.277 albertel 9981: foreach my $student (keys(%{$classlist})) {
1.288 raeburn 9982: my $match = 0;
1.412 raeburn 9983: my $secmatch = 0;
1.419 raeburn 9984: my $section = $$classlist{$student}[$idx{section}];
1.609 raeburn 9985: my $status = $$classlist{$student}[$idx{status}];
1.419 raeburn 9986: if ($section eq '') {
9987: $section = 'none';
9988: }
1.291 albertel 9989: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 9990: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 9991: $secmatch = 1;
9992: } elsif ($$classlist{$student}[$idx{section}] eq '') {
1.420 albertel 9993: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 9994: $secmatch = 1;
9995: }
9996: } else {
1.419 raeburn 9997: if (grep(/^\Q$section\E$/,@{$sections})) {
1.412 raeburn 9998: $secmatch = 1;
9999: }
1.290 albertel 10000: }
1.412 raeburn 10001: if (!$secmatch) {
10002: next;
10003: }
1.419 raeburn 10004: }
1.275 raeburn 10005: if (defined($$types{'active'})) {
1.288 raeburn 10006: if ($$classlist{$student}[$idx{status}] eq 'Active') {
1.275 raeburn 10007: push(@{$$users{st}{$student}},'active');
1.288 raeburn 10008: $match = 1;
1.275 raeburn 10009: }
10010: }
10011: if (defined($$types{'previous'})) {
1.609 raeburn 10012: if ($$classlist{$student}[$idx{status}] eq 'Expired') {
1.275 raeburn 10013: push(@{$$users{st}{$student}},'previous');
1.288 raeburn 10014: $match = 1;
1.275 raeburn 10015: }
10016: }
10017: if (defined($$types{'future'})) {
1.609 raeburn 10018: if ($$classlist{$student}[$idx{status}] eq 'Future') {
1.275 raeburn 10019: push(@{$$users{st}{$student}},'future');
1.288 raeburn 10020: $match = 1;
1.275 raeburn 10021: }
10022: }
1.609 raeburn 10023: if ($match) {
10024: push(@{$seclists{$student}},$section);
10025: if (ref($userdata) eq 'HASH') {
10026: $$userdata{$student} = $$classlist{$student};
10027: }
10028: if (ref($statushash) eq 'HASH') {
10029: $statushash->{$student}{'st'}{$section} = $status;
10030: }
1.288 raeburn 10031: }
1.275 raeburn 10032: }
10033: }
1.412 raeburn 10034: if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
1.439 raeburn 10035: my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
10036: my $now = time;
1.609 raeburn 10037: my %displaystatus = ( previous => 'Expired',
10038: active => 'Active',
10039: future => 'Future',
10040: );
1.1121 raeburn 10041: my (%nothide,@possdoms);
1.630 raeburn 10042: if ($hidepriv) {
10043: my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
10044: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
10045: if ($user !~ /:/) {
10046: $nothide{join(':',split(/[\@]/,$user))}=1;
10047: } else {
10048: $nothide{$user} = 1;
10049: }
10050: }
1.1121 raeburn 10051: my @possdoms = ($cdom);
10052: if ($coursehash{'checkforpriv'}) {
10053: push(@possdoms,split(/,/,$coursehash{'checkforpriv'}));
10054: }
1.630 raeburn 10055: }
1.439 raeburn 10056: foreach my $person (sort(keys(%coursepersonnel))) {
1.288 raeburn 10057: my $match = 0;
1.412 raeburn 10058: my $secmatch = 0;
1.439 raeburn 10059: my $status;
1.412 raeburn 10060: my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
1.275 raeburn 10061: $user =~ s/:$//;
1.439 raeburn 10062: my ($end,$start) = split(/:/,$coursepersonnel{$person});
10063: if ($end == -1 || $start == -1) {
10064: next;
10065: }
10066: if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
10067: (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
1.412 raeburn 10068: my ($uname,$udom) = split(/:/,$user);
10069: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 10070: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 10071: $secmatch = 1;
10072: } elsif ($usec eq '') {
1.420 albertel 10073: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 10074: $secmatch = 1;
10075: }
10076: } else {
10077: if (grep(/^\Q$usec\E$/,@{$sections})) {
10078: $secmatch = 1;
10079: }
10080: }
10081: if (!$secmatch) {
10082: next;
10083: }
1.288 raeburn 10084: }
1.419 raeburn 10085: if ($usec eq '') {
10086: $usec = 'none';
10087: }
1.275 raeburn 10088: if ($uname ne '' && $udom ne '') {
1.630 raeburn 10089: if ($hidepriv) {
1.1121 raeburn 10090: if ((&Apache::lonnet::privileged($uname,$udom,\@possdoms)) &&
1.630 raeburn 10091: (!$nothide{$uname.':'.$udom})) {
10092: next;
10093: }
10094: }
1.503 raeburn 10095: if ($end > 0 && $end < $now) {
1.439 raeburn 10096: $status = 'previous';
10097: } elsif ($start > $now) {
10098: $status = 'future';
10099: } else {
10100: $status = 'active';
10101: }
1.277 albertel 10102: foreach my $type (keys(%{$types})) {
1.275 raeburn 10103: if ($status eq $type) {
1.420 albertel 10104: if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
1.419 raeburn 10105: push(@{$$users{$role}{$user}},$type);
10106: }
1.288 raeburn 10107: $match = 1;
10108: }
10109: }
1.419 raeburn 10110: if (($match) && (ref($userdata) eq 'HASH')) {
10111: if (!exists($$userdata{$uname.':'.$udom})) {
10112: &get_user_info($udom,$uname,\%idx,$userdata);
10113: }
1.420 albertel 10114: if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
1.419 raeburn 10115: push(@{$seclists{$uname.':'.$udom}},$usec);
10116: }
1.609 raeburn 10117: if (ref($statushash) eq 'HASH') {
10118: $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
10119: }
1.275 raeburn 10120: }
10121: }
10122: }
10123: }
1.290 albertel 10124: if (grep(/^ow$/,@{$roles})) {
1.279 raeburn 10125: if ((defined($cdom)) && (defined($cnum))) {
10126: my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
10127: if ( defined($csettings{'internal.courseowner'}) ) {
10128: my $owner = $csettings{'internal.courseowner'};
1.609 raeburn 10129: next if ($owner eq '');
10130: my ($ownername,$ownerdom);
10131: if ($owner =~ /^([^:]+):([^:]+)$/) {
10132: $ownername = $1;
10133: $ownerdom = $2;
10134: } else {
10135: $ownername = $owner;
10136: $ownerdom = $cdom;
10137: $owner = $ownername.':'.$ownerdom;
1.439 raeburn 10138: }
10139: @{$$users{'ow'}{$owner}} = 'any';
1.290 albertel 10140: if (defined($userdata) &&
1.609 raeburn 10141: !exists($$userdata{$owner})) {
10142: &get_user_info($ownerdom,$ownername,\%idx,$userdata);
10143: if (!grep(/^none$/,@{$seclists{$owner}})) {
10144: push(@{$seclists{$owner}},'none');
10145: }
10146: if (ref($statushash) eq 'HASH') {
10147: $statushash->{$owner}{'ow'}{'none'} = 'Any';
1.419 raeburn 10148: }
1.290 albertel 10149: }
1.279 raeburn 10150: }
10151: }
10152: }
1.419 raeburn 10153: foreach my $user (keys(%seclists)) {
10154: @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
10155: $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
10156: }
1.275 raeburn 10157: }
10158: return;
10159: }
10160:
1.288 raeburn 10161: sub get_user_info {
10162: my ($udom,$uname,$idx,$userdata) = @_;
1.289 albertel 10163: $$userdata{$uname.':'.$udom}[$$idx{fullname}] =
10164: &plainname($uname,$udom,'lastname');
1.291 albertel 10165: $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
1.297 raeburn 10166: $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
1.609 raeburn 10167: my %idhash = &Apache::lonnet::idrget($udom,($uname));
10168: $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname};
1.288 raeburn 10169: return;
10170: }
1.275 raeburn 10171:
1.472 raeburn 10172: ###############################################
10173:
10174: =pod
10175:
10176: =item * &get_user_quota()
10177:
1.1134 raeburn 10178: Retrieves quota assigned for storage of user files.
10179: Default is to report quota for portfolio files.
1.472 raeburn 10180:
10181: Incoming parameters:
10182: 1. user's username
10183: 2. user's domain
1.1134 raeburn 10184: 3. quota name - portfolio, author, or course
1.1136 raeburn 10185: (if no quota name provided, defaults to portfolio).
1.1237 raeburn 10186: 4. crstype - official, unofficial, textbook, placement or community,
10187: if quota name is course
1.472 raeburn 10188:
10189: Returns:
1.1163 raeburn 10190: 1. Disk quota (in MB) assigned to student.
1.536 raeburn 10191: 2. (Optional) Type of setting: custom or default
10192: (individually assigned or default for user's
10193: institutional status).
10194: 3. (Optional) - User's institutional status (e.g., faculty, staff
10195: or student - types as defined in localenroll::inst_usertypes
10196: for user's domain, which determines default quota for user.
10197: 4. (Optional) - Default quota which would apply to the user.
1.472 raeburn 10198:
10199: If a value has been stored in the user's environment,
1.536 raeburn 10200: it will return that, otherwise it returns the maximal default
1.1134 raeburn 10201: defined for the user's institutional status(es) in the domain.
1.472 raeburn 10202:
10203: =cut
10204:
10205: ###############################################
10206:
10207:
10208: sub get_user_quota {
1.1136 raeburn 10209: my ($uname,$udom,$quotaname,$crstype) = @_;
1.536 raeburn 10210: my ($quota,$quotatype,$settingstatus,$defquota);
1.472 raeburn 10211: if (!defined($udom)) {
10212: $udom = $env{'user.domain'};
10213: }
10214: if (!defined($uname)) {
10215: $uname = $env{'user.name'};
10216: }
10217: if (($udom eq '' || $uname eq '') ||
10218: ($udom eq 'public') && ($uname eq 'public')) {
10219: $quota = 0;
1.536 raeburn 10220: $quotatype = 'default';
10221: $defquota = 0;
1.472 raeburn 10222: } else {
1.536 raeburn 10223: my $inststatus;
1.1134 raeburn 10224: if ($quotaname eq 'course') {
10225: if (($env{'course.'.$udom.'_'.$uname.'.num'} eq $uname) &&
10226: ($env{'course.'.$udom.'_'.$uname.'.domain'} eq $udom)) {
10227: $quota = $env{'course.'.$udom.'_'.$uname.'.internal.uploadquota'};
10228: } else {
10229: my %cenv = &Apache::lonnet::coursedescription("$udom/$uname");
10230: $quota = $cenv{'internal.uploadquota'};
10231: }
1.536 raeburn 10232: } else {
1.1134 raeburn 10233: if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
10234: if ($quotaname eq 'author') {
10235: $quota = $env{'environment.authorquota'};
10236: } else {
10237: $quota = $env{'environment.portfolioquota'};
10238: }
10239: $inststatus = $env{'environment.inststatus'};
10240: } else {
10241: my %userenv =
10242: &Apache::lonnet::get('environment',['portfolioquota',
10243: 'authorquota','inststatus'],$udom,$uname);
10244: my ($tmp) = keys(%userenv);
10245: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
10246: if ($quotaname eq 'author') {
10247: $quota = $userenv{'authorquota'};
10248: } else {
10249: $quota = $userenv{'portfolioquota'};
10250: }
10251: $inststatus = $userenv{'inststatus'};
10252: } else {
10253: undef(%userenv);
10254: }
10255: }
10256: }
10257: if ($quota eq '' || wantarray) {
10258: if ($quotaname eq 'course') {
10259: my %domdefs = &Apache::lonnet::get_domain_defaults($udom);
1.1165 raeburn 10260: if (($crstype eq 'official') || ($crstype eq 'unofficial') ||
1.1237 raeburn 10261: ($crstype eq 'community') || ($crstype eq 'textbook') ||
10262: ($crstype eq 'placement')) {
1.1136 raeburn 10263: $defquota = $domdefs{$crstype.'quota'};
10264: }
10265: if ($defquota eq '') {
10266: $defquota = 500;
10267: }
1.1134 raeburn 10268: } else {
10269: ($defquota,$settingstatus) = &default_quota($udom,$inststatus,$quotaname);
10270: }
10271: if ($quota eq '') {
10272: $quota = $defquota;
10273: $quotatype = 'default';
10274: } else {
10275: $quotatype = 'custom';
10276: }
1.472 raeburn 10277: }
10278: }
1.536 raeburn 10279: if (wantarray) {
10280: return ($quota,$quotatype,$settingstatus,$defquota);
10281: } else {
10282: return $quota;
10283: }
1.472 raeburn 10284: }
10285:
10286: ###############################################
10287:
10288: =pod
10289:
10290: =item * &default_quota()
10291:
1.536 raeburn 10292: Retrieves default quota assigned for storage of user portfolio files,
10293: given an (optional) user's institutional status.
1.472 raeburn 10294:
10295: Incoming parameters:
1.1142 raeburn 10296:
1.472 raeburn 10297: 1. domain
1.536 raeburn 10298: 2. (Optional) institutional status(es). This is a : separated list of
10299: status types (e.g., faculty, staff, student etc.)
10300: which apply to the user for whom the default is being retrieved.
10301: If the institutional status string in undefined, the domain
1.1134 raeburn 10302: default quota will be returned.
10303: 3. quota name - portfolio, author, or course
10304: (if no quota name provided, defaults to portfolio).
1.472 raeburn 10305:
10306: Returns:
1.1142 raeburn 10307:
1.1163 raeburn 10308: 1. Default disk quota (in MB) for user portfolios in the domain.
1.536 raeburn 10309: 2. (Optional) institutional type which determined the value of the
10310: default quota.
1.472 raeburn 10311:
10312: If a value has been stored in the domain's configuration db,
10313: it will return that, otherwise it returns 20 (for backwards
10314: compatibility with domains which have not set up a configuration
1.1163 raeburn 10315: db file; the original statically defined portfolio quota was 20 MB).
1.472 raeburn 10316:
1.536 raeburn 10317: If the user's status includes multiple types (e.g., staff and student),
10318: the largest default quota which applies to the user determines the
10319: default quota returned.
10320:
1.472 raeburn 10321: =cut
10322:
10323: ###############################################
10324:
10325:
10326: sub default_quota {
1.1134 raeburn 10327: my ($udom,$inststatus,$quotaname) = @_;
1.536 raeburn 10328: my ($defquota,$settingstatus);
10329: my %quotahash = &Apache::lonnet::get_dom('configuration',
1.622 raeburn 10330: ['quotas'],$udom);
1.1134 raeburn 10331: my $key = 'defaultquota';
10332: if ($quotaname eq 'author') {
10333: $key = 'authorquota';
10334: }
1.622 raeburn 10335: if (ref($quotahash{'quotas'}) eq 'HASH') {
1.536 raeburn 10336: if ($inststatus ne '') {
1.765 raeburn 10337: my @statuses = map { &unescape($_); } split(/:/,$inststatus);
1.536 raeburn 10338: foreach my $item (@statuses) {
1.1134 raeburn 10339: if (ref($quotahash{'quotas'}{$key}) eq 'HASH') {
10340: if ($quotahash{'quotas'}{$key}{$item} ne '') {
1.711 raeburn 10341: if ($defquota eq '') {
1.1134 raeburn 10342: $defquota = $quotahash{'quotas'}{$key}{$item};
1.711 raeburn 10343: $settingstatus = $item;
1.1134 raeburn 10344: } elsif ($quotahash{'quotas'}{$key}{$item} > $defquota) {
10345: $defquota = $quotahash{'quotas'}{$key}{$item};
1.711 raeburn 10346: $settingstatus = $item;
10347: }
10348: }
1.1134 raeburn 10349: } elsif ($key eq 'defaultquota') {
1.711 raeburn 10350: if ($quotahash{'quotas'}{$item} ne '') {
10351: if ($defquota eq '') {
10352: $defquota = $quotahash{'quotas'}{$item};
10353: $settingstatus = $item;
10354: } elsif ($quotahash{'quotas'}{$item} > $defquota) {
10355: $defquota = $quotahash{'quotas'}{$item};
10356: $settingstatus = $item;
10357: }
1.536 raeburn 10358: }
10359: }
10360: }
10361: }
10362: if ($defquota eq '') {
1.1134 raeburn 10363: if (ref($quotahash{'quotas'}{$key}) eq 'HASH') {
10364: $defquota = $quotahash{'quotas'}{$key}{'default'};
10365: } elsif ($key eq 'defaultquota') {
1.711 raeburn 10366: $defquota = $quotahash{'quotas'}{'default'};
10367: }
1.536 raeburn 10368: $settingstatus = 'default';
1.1139 raeburn 10369: if ($defquota eq '') {
10370: if ($quotaname eq 'author') {
10371: $defquota = 500;
10372: }
10373: }
1.536 raeburn 10374: }
10375: } else {
10376: $settingstatus = 'default';
1.1134 raeburn 10377: if ($quotaname eq 'author') {
10378: $defquota = 500;
10379: } else {
10380: $defquota = 20;
10381: }
1.536 raeburn 10382: }
10383: if (wantarray) {
10384: return ($defquota,$settingstatus);
1.472 raeburn 10385: } else {
1.536 raeburn 10386: return $defquota;
1.472 raeburn 10387: }
10388: }
10389:
1.1135 raeburn 10390: ###############################################
10391:
10392: =pod
10393:
1.1136 raeburn 10394: =item * &excess_filesize_warning()
1.1135 raeburn 10395:
10396: Returns warning message if upload of file to authoring space, or copying
1.1136 raeburn 10397: of existing file within authoring space will cause quota for the authoring
1.1146 raeburn 10398: space to be exceeded.
1.1136 raeburn 10399:
10400: Same, if upload of a file directly to a course/community via Course Editor
1.1137 raeburn 10401: will cause quota for uploaded content for the course to be exceeded.
1.1135 raeburn 10402:
1.1165 raeburn 10403: Inputs: 7
1.1136 raeburn 10404: 1. username or coursenum
1.1135 raeburn 10405: 2. domain
1.1136 raeburn 10406: 3. context ('author' or 'course')
1.1135 raeburn 10407: 4. filename of file for which action is being requested
10408: 5. filesize (kB) of file
10409: 6. action being taken: copy or upload.
1.1237 raeburn 10410: 7. quotatype (in course context -- official, unofficial, textbook, placement or community).
1.1135 raeburn 10411:
10412: Returns: 1 scalar: HTML to display containing warning if quota would be exceeded,
1.1142 raeburn 10413: otherwise return null.
10414:
10415: =back
1.1135 raeburn 10416:
10417: =cut
10418:
1.1136 raeburn 10419: sub excess_filesize_warning {
1.1165 raeburn 10420: my ($uname,$udom,$context,$filename,$filesize,$action,$quotatype) = @_;
1.1136 raeburn 10421: my $current_disk_usage = 0;
1.1165 raeburn 10422: my $disk_quota = &get_user_quota($uname,$udom,$context,$quotatype); #expressed in MB
1.1136 raeburn 10423: if ($context eq 'author') {
10424: my $authorspace = $Apache::lonnet::perlvar{'lonDocRoot'}."/priv/$udom/$uname";
10425: $current_disk_usage = &Apache::lonnet::diskusage($udom,$uname,$authorspace);
10426: } else {
10427: foreach my $subdir ('docs','supplemental') {
10428: $current_disk_usage += &Apache::lonnet::diskusage($udom,$uname,"userfiles/$subdir",1);
10429: }
10430: }
1.1135 raeburn 10431: $disk_quota = int($disk_quota * 1000);
10432: if (($current_disk_usage + $filesize) > $disk_quota) {
1.1179 bisitz 10433: return '<p class="LC_warning">'.
1.1135 raeburn 10434: &mt("Unable to $action [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.",
1.1179 bisitz 10435: '<span class="LC_filename">'.$filename.'</span>',$filesize).'</p>'.
10436: '<p>'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',
1.1135 raeburn 10437: $disk_quota,$current_disk_usage).
10438: '</p>';
10439: }
10440: return;
10441: }
10442:
10443: ###############################################
10444:
10445:
1.1136 raeburn 10446:
10447:
1.384 raeburn 10448: sub get_secgrprole_info {
10449: my ($cdom,$cnum,$needroles,$type) = @_;
10450: my %sections_count = &get_sections($cdom,$cnum);
10451: my @sections = (sort {$a <=> $b} keys(%sections_count));
10452: my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
10453: my @groups = sort(keys(%curr_groups));
10454: my $allroles = [];
10455: my $rolehash;
10456: my $accesshash = {
10457: active => 'Currently has access',
10458: future => 'Will have future access',
10459: previous => 'Previously had access',
10460: };
10461: if ($needroles) {
10462: $rolehash = {'all' => 'all'};
1.385 albertel 10463: my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
10464: if (&Apache::lonnet::error(%user_roles)) {
10465: undef(%user_roles);
10466: }
10467: foreach my $item (keys(%user_roles)) {
1.384 raeburn 10468: my ($role)=split(/\:/,$item,2);
10469: if ($role eq 'cr') { next; }
10470: if ($role =~ /^cr/) {
10471: $$rolehash{$role} = (split('/',$role))[3];
10472: } else {
10473: $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
10474: }
10475: }
10476: foreach my $key (sort(keys(%{$rolehash}))) {
10477: push(@{$allroles},$key);
10478: }
10479: push (@{$allroles},'st');
10480: $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
10481: }
10482: return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
10483: }
10484:
1.555 raeburn 10485: sub user_picker {
1.1279 raeburn 10486: my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype,$context,$fixeddom,$noinstd) = @_;
1.555 raeburn 10487: my $currdom = $dom;
1.1253 raeburn 10488: my @alldoms = &Apache::lonnet::all_domains();
10489: if (@alldoms == 1) {
10490: my %domsrch = &Apache::lonnet::get_dom('configuration',
10491: ['directorysrch'],$alldoms[0]);
10492: my $domdesc = &Apache::lonnet::domain($alldoms[0],'description');
10493: my $showdom = $domdesc;
10494: if ($showdom eq '') {
10495: $showdom = $dom;
10496: }
10497: if (ref($domsrch{'directorysrch'}) eq 'HASH') {
10498: if ((!$domsrch{'directorysrch'}{'available'}) &&
10499: ($domsrch{'directorysrch'}{'lcavailable'} eq '0')) {
10500: return (&mt('LON-CAPA directory search is not available in domain: [_1]',$showdom),0);
10501: }
10502: }
10503: }
1.555 raeburn 10504: my %curr_selected = (
10505: srchin => 'dom',
1.580 raeburn 10506: srchby => 'lastname',
1.555 raeburn 10507: );
10508: my $srchterm;
1.625 raeburn 10509: if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
1.555 raeburn 10510: if ($srch->{'srchby'} ne '') {
10511: $curr_selected{'srchby'} = $srch->{'srchby'};
10512: }
10513: if ($srch->{'srchin'} ne '') {
10514: $curr_selected{'srchin'} = $srch->{'srchin'};
10515: }
10516: if ($srch->{'srchtype'} ne '') {
10517: $curr_selected{'srchtype'} = $srch->{'srchtype'};
10518: }
10519: if ($srch->{'srchdomain'} ne '') {
10520: $currdom = $srch->{'srchdomain'};
10521: }
10522: $srchterm = $srch->{'srchterm'};
10523: }
1.1222 damieng 10524: my %html_lt=&Apache::lonlocal::texthash(
1.573 raeburn 10525: 'usr' => 'Search criteria',
1.563 raeburn 10526: 'doma' => 'Domain/institution to search',
1.558 albertel 10527: 'uname' => 'username',
10528: 'lastname' => 'last name',
1.555 raeburn 10529: 'lastfirst' => 'last name, first name',
1.558 albertel 10530: 'crs' => 'in this course',
1.576 raeburn 10531: 'dom' => 'in selected LON-CAPA domain',
1.558 albertel 10532: 'alc' => 'all LON-CAPA',
1.573 raeburn 10533: 'instd' => 'in institutional directory for selected domain',
1.558 albertel 10534: 'exact' => 'is',
10535: 'contains' => 'contains',
1.569 raeburn 10536: 'begins' => 'begins with',
1.1222 damieng 10537: );
10538: my %js_lt=&Apache::lonlocal::texthash(
1.571 raeburn 10539: 'youm' => "You must include some text to search for.",
10540: 'thte' => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
10541: 'thet' => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
10542: 'yomc' => "You must choose a domain when using an institutional directory search.",
10543: 'ymcd' => "You must choose a domain when using a domain search.",
10544: 'whus' => "When using searching by last,first you must include a comma as separator between last name and first name.",
10545: 'whse' => "When searching by last,first you must include at least one character in the first name.",
10546: 'thfo' => "The following need to be corrected before the search can be run:",
1.555 raeburn 10547: );
1.1222 damieng 10548: &html_escape(\%html_lt);
10549: &js_escape(\%js_lt);
1.1255 raeburn 10550: my $domform;
1.1277 raeburn 10551: my $allow_blank = 1;
1.1255 raeburn 10552: if ($fixeddom) {
1.1277 raeburn 10553: $allow_blank = 0;
10554: $domform = &select_dom_form($currdom,'srchdomain',$allow_blank,1,undef,[$currdom]);
1.1255 raeburn 10555: } else {
1.1287 raeburn 10556: my $defdom = $env{'request.role.domain'};
1.1288 raeburn 10557: my ($trusted,$untrusted);
1.1287 raeburn 10558: if (($context eq 'requestcrs') || ($context eq 'course')) {
1.1288 raeburn 10559: ($trusted,$untrusted) = &Apache::lonnet::trusted_domains('enroll',$defdom);
1.1287 raeburn 10560: } elsif ($context eq 'author') {
1.1288 raeburn 10561: ($trusted,$untrusted) = &Apache::lonnet::trusted_domains('othcoau',$defdom);
1.1287 raeburn 10562: } elsif ($context eq 'domain') {
1.1288 raeburn 10563: ($trusted,$untrusted) = &Apache::lonnet::trusted_domains('domroles',$defdom);
1.1287 raeburn 10564: }
1.1288 raeburn 10565: $domform = &select_dom_form($currdom,'srchdomain',$allow_blank,1,undef,$trusted,$untrusted);
1.1255 raeburn 10566: }
1.563 raeburn 10567: my $srchinsel = ' <select name="srchin">';
1.555 raeburn 10568:
10569: my @srchins = ('crs','dom','alc','instd');
10570:
10571: foreach my $option (@srchins) {
10572: # FIXME 'alc' option unavailable until
10573: # loncreateuser::print_user_query_page()
10574: # has been completed.
10575: next if ($option eq 'alc');
1.880 raeburn 10576: next if (($option eq 'crs') && ($env{'form.form'} eq 'requestcrs'));
1.555 raeburn 10577: next if ($option eq 'crs' && !$env{'request.course.id'});
1.1279 raeburn 10578: next if (($option eq 'instd') && ($noinstd));
1.563 raeburn 10579: if ($curr_selected{'srchin'} eq $option) {
10580: $srchinsel .= '
1.1222 damieng 10581: <option value="'.$option.'" selected="selected">'.$html_lt{$option}.'</option>';
1.563 raeburn 10582: } else {
10583: $srchinsel .= '
1.1222 damieng 10584: <option value="'.$option.'">'.$html_lt{$option}.'</option>';
1.563 raeburn 10585: }
1.555 raeburn 10586: }
1.563 raeburn 10587: $srchinsel .= "\n </select>\n";
1.555 raeburn 10588:
10589: my $srchbysel = ' <select name="srchby">';
1.580 raeburn 10590: foreach my $option ('lastname','lastfirst','uname') {
1.555 raeburn 10591: if ($curr_selected{'srchby'} eq $option) {
10592: $srchbysel .= '
1.1222 damieng 10593: <option value="'.$option.'" selected="selected">'.$html_lt{$option}.'</option>';
1.555 raeburn 10594: } else {
10595: $srchbysel .= '
1.1222 damieng 10596: <option value="'.$option.'">'.$html_lt{$option}.'</option>';
1.555 raeburn 10597: }
10598: }
10599: $srchbysel .= "\n </select>\n";
10600:
10601: my $srchtypesel = ' <select name="srchtype">';
1.580 raeburn 10602: foreach my $option ('begins','contains','exact') {
1.555 raeburn 10603: if ($curr_selected{'srchtype'} eq $option) {
10604: $srchtypesel .= '
1.1222 damieng 10605: <option value="'.$option.'" selected="selected">'.$html_lt{$option}.'</option>';
1.555 raeburn 10606: } else {
10607: $srchtypesel .= '
1.1222 damieng 10608: <option value="'.$option.'">'.$html_lt{$option}.'</option>';
1.555 raeburn 10609: }
10610: }
10611: $srchtypesel .= "\n </select>\n";
10612:
1.558 albertel 10613: my ($newuserscript,$new_user_create);
1.994 raeburn 10614: my $context_dom = $env{'request.role.domain'};
10615: if ($context eq 'requestcrs') {
10616: if ($env{'form.coursedom'} ne '') {
10617: $context_dom = $env{'form.coursedom'};
10618: }
10619: }
1.556 raeburn 10620: if ($forcenewuser) {
1.576 raeburn 10621: if (ref($srch) eq 'HASH') {
1.994 raeburn 10622: if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $context_dom) {
1.627 raeburn 10623: if ($cancreate) {
10624: $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>';
10625: } else {
1.799 bisitz 10626: my $helplink = 'javascript:helpMenu('."'display'".')';
1.627 raeburn 10627: my %usertypetext = (
10628: official => 'institutional',
10629: unofficial => 'non-institutional',
10630: );
1.799 bisitz 10631: $new_user_create = '<p class="LC_warning">'
10632: .&mt("You are not authorized to create new $usertypetext{$usertype} users in this domain.")
10633: .' '
10634: .&mt('Please contact the [_1]helpdesk[_2] for assistance.'
10635: ,'<a href="'.$helplink.'">','</a>')
10636: .'</p><br />';
1.627 raeburn 10637: }
1.576 raeburn 10638: }
10639: }
10640:
1.556 raeburn 10641: $newuserscript = <<"ENDSCRIPT";
10642:
1.570 raeburn 10643: function setSearch(createnew,callingForm) {
1.556 raeburn 10644: if (createnew == 1) {
1.570 raeburn 10645: for (var i=0; i<callingForm.srchby.length; i++) {
10646: if (callingForm.srchby.options[i].value == 'uname') {
10647: callingForm.srchby.selectedIndex = i;
1.556 raeburn 10648: }
10649: }
1.570 raeburn 10650: for (var i=0; i<callingForm.srchin.length; i++) {
10651: if ( callingForm.srchin.options[i].value == 'dom') {
10652: callingForm.srchin.selectedIndex = i;
1.556 raeburn 10653: }
10654: }
1.570 raeburn 10655: for (var i=0; i<callingForm.srchtype.length; i++) {
10656: if (callingForm.srchtype.options[i].value == 'exact') {
10657: callingForm.srchtype.selectedIndex = i;
1.556 raeburn 10658: }
10659: }
1.570 raeburn 10660: for (var i=0; i<callingForm.srchdomain.length; i++) {
1.994 raeburn 10661: if (callingForm.srchdomain.options[i].value == '$context_dom') {
1.570 raeburn 10662: callingForm.srchdomain.selectedIndex = i;
1.556 raeburn 10663: }
10664: }
10665: }
10666: }
10667: ENDSCRIPT
1.558 albertel 10668:
1.556 raeburn 10669: }
10670:
1.555 raeburn 10671: my $output = <<"END_BLOCK";
1.556 raeburn 10672: <script type="text/javascript">
1.824 bisitz 10673: // <![CDATA[
1.570 raeburn 10674: function validateEntry(callingForm) {
1.558 albertel 10675:
1.556 raeburn 10676: var checkok = 1;
1.558 albertel 10677: var srchin;
1.570 raeburn 10678: for (var i=0; i<callingForm.srchin.length; i++) {
10679: if ( callingForm.srchin[i].checked ) {
10680: srchin = callingForm.srchin[i].value;
1.558 albertel 10681: }
10682: }
10683:
1.570 raeburn 10684: var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
10685: var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
10686: var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
10687: var srchterm = callingForm.srchterm.value;
10688: var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
1.556 raeburn 10689: var msg = "";
10690:
10691: if (srchterm == "") {
10692: checkok = 0;
1.1222 damieng 10693: msg += "$js_lt{'youm'}\\n";
1.556 raeburn 10694: }
10695:
1.569 raeburn 10696: if (srchtype== 'begins') {
10697: if (srchterm.length < 2) {
10698: checkok = 0;
1.1222 damieng 10699: msg += "$js_lt{'thte'}\\n";
1.569 raeburn 10700: }
10701: }
10702:
1.556 raeburn 10703: if (srchtype== 'contains') {
10704: if (srchterm.length < 3) {
10705: checkok = 0;
1.1222 damieng 10706: msg += "$js_lt{'thet'}\\n";
1.556 raeburn 10707: }
10708: }
10709: if (srchin == 'instd') {
10710: if (srchdomain == '') {
10711: checkok = 0;
1.1222 damieng 10712: msg += "$js_lt{'yomc'}\\n";
1.556 raeburn 10713: }
10714: }
10715: if (srchin == 'dom') {
10716: if (srchdomain == '') {
10717: checkok = 0;
1.1222 damieng 10718: msg += "$js_lt{'ymcd'}\\n";
1.556 raeburn 10719: }
10720: }
10721: if (srchby == 'lastfirst') {
10722: if (srchterm.indexOf(",") == -1) {
10723: checkok = 0;
1.1222 damieng 10724: msg += "$js_lt{'whus'}\\n";
1.556 raeburn 10725: }
10726: if (srchterm.indexOf(",") == srchterm.length -1) {
10727: checkok = 0;
1.1222 damieng 10728: msg += "$js_lt{'whse'}\\n";
1.556 raeburn 10729: }
10730: }
10731: if (checkok == 0) {
1.1222 damieng 10732: alert("$js_lt{'thfo'}\\n"+msg);
1.556 raeburn 10733: return;
10734: }
10735: if (checkok == 1) {
1.570 raeburn 10736: callingForm.submit();
1.556 raeburn 10737: }
10738: }
10739:
10740: $newuserscript
10741:
1.824 bisitz 10742: // ]]>
1.556 raeburn 10743: </script>
1.558 albertel 10744:
10745: $new_user_create
10746:
1.555 raeburn 10747: END_BLOCK
1.558 albertel 10748:
1.876 raeburn 10749: $output .= &Apache::lonhtmlcommon::start_pick_box().
1.1222 damieng 10750: &Apache::lonhtmlcommon::row_title($html_lt{'doma'}).
1.876 raeburn 10751: $domform.
10752: &Apache::lonhtmlcommon::row_closure().
1.1222 damieng 10753: &Apache::lonhtmlcommon::row_title($html_lt{'usr'}).
1.876 raeburn 10754: $srchbysel.
10755: $srchtypesel.
10756: '<input type="text" size="15" name="srchterm" value="'.$srchterm.'" />'.
10757: $srchinsel.
10758: &Apache::lonhtmlcommon::row_closure(1).
10759: &Apache::lonhtmlcommon::end_pick_box().
10760: '<br />';
1.1253 raeburn 10761: return ($output,1);
1.555 raeburn 10762: }
10763:
1.612 raeburn 10764: sub user_rule_check {
1.615 raeburn 10765: my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
1.1226 raeburn 10766: my ($response,%inst_response);
1.612 raeburn 10767: if (ref($usershash) eq 'HASH') {
1.1226 raeburn 10768: if (keys(%{$usershash}) > 1) {
10769: my (%by_username,%by_id,%userdoms);
10770: my $checkid;
10771: if (ref($checks) eq 'HASH') {
10772: if ((!defined($checks->{'username'})) && (defined($checks->{'id'}))) {
10773: $checkid = 1;
10774: }
10775: }
10776: foreach my $user (keys(%{$usershash})) {
10777: my ($uname,$udom) = split(/:/,$user);
10778: if ($checkid) {
10779: if (ref($usershash->{$user}) eq 'HASH') {
10780: if ($usershash->{$user}->{'id'} ne '') {
1.1227 raeburn 10781: $by_id{$udom}{$usershash->{$user}->{'id'}} = $uname;
1.1226 raeburn 10782: $userdoms{$udom} = 1;
1.1227 raeburn 10783: if (ref($inst_results) eq 'HASH') {
10784: $inst_results->{$uname.':'.$udom} = {};
10785: }
1.1226 raeburn 10786: }
10787: }
10788: } else {
10789: $by_username{$udom}{$uname} = 1;
10790: $userdoms{$udom} = 1;
1.1227 raeburn 10791: if (ref($inst_results) eq 'HASH') {
10792: $inst_results->{$uname.':'.$udom} = {};
10793: }
1.1226 raeburn 10794: }
10795: }
10796: foreach my $udom (keys(%userdoms)) {
10797: if (!$got_rules->{$udom}) {
10798: my %domconfig = &Apache::lonnet::get_dom('configuration',
10799: ['usercreation'],$udom);
10800: if (ref($domconfig{'usercreation'}) eq 'HASH') {
10801: foreach my $item ('username','id') {
10802: if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
1.1227 raeburn 10803: $$curr_rules{$udom}{$item} =
10804: $domconfig{'usercreation'}{$item.'_rule'};
1.1226 raeburn 10805: }
10806: }
10807: }
10808: $got_rules->{$udom} = 1;
10809: }
1.612 raeburn 10810: }
1.1226 raeburn 10811: if ($checkid) {
10812: foreach my $udom (keys(%by_id)) {
10813: my ($outcome,$results) = &Apache::lonnet::get_multiple_instusers($udom,$by_id{$udom},'id');
10814: if ($outcome eq 'ok') {
1.1227 raeburn 10815: foreach my $id (keys(%{$by_id{$udom}})) {
10816: my $uname = $by_id{$udom}{$id};
10817: $inst_response{$uname.':'.$udom} = $outcome;
10818: }
1.1226 raeburn 10819: if (ref($results) eq 'HASH') {
10820: foreach my $uname (keys(%{$results})) {
1.1227 raeburn 10821: if (exists($inst_response{$uname.':'.$udom})) {
10822: $inst_response{$uname.':'.$udom} = $outcome;
10823: $inst_results->{$uname.':'.$udom} = $results->{$uname};
10824: }
1.1226 raeburn 10825: }
10826: }
10827: }
1.612 raeburn 10828: }
1.615 raeburn 10829: } else {
1.1226 raeburn 10830: foreach my $udom (keys(%by_username)) {
10831: my ($outcome,$results) = &Apache::lonnet::get_multiple_instusers($udom,$by_username{$udom});
10832: if ($outcome eq 'ok') {
1.1227 raeburn 10833: foreach my $uname (keys(%{$by_username{$udom}})) {
10834: $inst_response{$uname.':'.$udom} = $outcome;
10835: }
1.1226 raeburn 10836: if (ref($results) eq 'HASH') {
10837: foreach my $uname (keys(%{$results})) {
10838: $inst_results->{$uname.':'.$udom} = $results->{$uname};
10839: }
10840: }
10841: }
10842: }
1.612 raeburn 10843: }
1.1226 raeburn 10844: } elsif (keys(%{$usershash}) == 1) {
10845: my $user = (keys(%{$usershash}))[0];
10846: my ($uname,$udom) = split(/:/,$user);
10847: if (($udom ne '') && ($uname ne '')) {
10848: if (ref($usershash->{$user}) eq 'HASH') {
10849: if (ref($checks) eq 'HASH') {
10850: if (defined($checks->{'username'})) {
10851: ($inst_response{$user},%{$inst_results->{$user}}) =
10852: &Apache::lonnet::get_instuser($udom,$uname);
10853: } elsif (defined($checks->{'id'})) {
10854: if ($usershash->{$user}->{'id'} ne '') {
10855: ($inst_response{$user},%{$inst_results->{$user}}) =
10856: &Apache::lonnet::get_instuser($udom,undef,
10857: $usershash->{$user}->{'id'});
10858: } else {
10859: ($inst_response{$user},%{$inst_results->{$user}}) =
10860: &Apache::lonnet::get_instuser($udom,$uname);
10861: }
1.585 raeburn 10862: }
1.1226 raeburn 10863: } else {
10864: ($inst_response{$user},%{$inst_results->{$user}}) =
10865: &Apache::lonnet::get_instuser($udom,$uname);
10866: return;
10867: }
10868: if (!$got_rules->{$udom}) {
10869: my %domconfig = &Apache::lonnet::get_dom('configuration',
10870: ['usercreation'],$udom);
10871: if (ref($domconfig{'usercreation'}) eq 'HASH') {
10872: foreach my $item ('username','id') {
10873: if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
10874: $$curr_rules{$udom}{$item} =
10875: $domconfig{'usercreation'}{$item.'_rule'};
10876: }
10877: }
10878: }
10879: $got_rules->{$udom} = 1;
1.585 raeburn 10880: }
10881: }
1.1226 raeburn 10882: } else {
10883: return;
10884: }
10885: } else {
10886: return;
10887: }
10888: foreach my $user (keys(%{$usershash})) {
10889: my ($uname,$udom) = split(/:/,$user);
10890: next if (($udom eq '') || ($uname eq ''));
10891: my $id;
1.1227 raeburn 10892: if (ref($inst_results) eq 'HASH') {
10893: if (ref($inst_results->{$user}) eq 'HASH') {
10894: $id = $inst_results->{$user}->{'id'};
10895: }
10896: }
10897: if ($id eq '') {
10898: if (ref($usershash->{$user})) {
10899: $id = $usershash->{$user}->{'id'};
10900: }
1.585 raeburn 10901: }
1.612 raeburn 10902: foreach my $item (keys(%{$checks})) {
10903: if (ref($$curr_rules{$udom}) eq 'HASH') {
10904: if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
10905: if (@{$$curr_rules{$udom}{$item}} > 0) {
1.1226 raeburn 10906: my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,
10907: $$curr_rules{$udom}{$item});
1.612 raeburn 10908: foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
10909: if ($rule_check{$rule}) {
10910: $$rulematch{$user}{$item} = $rule;
1.1226 raeburn 10911: if ($inst_response{$user} eq 'ok') {
1.615 raeburn 10912: if (ref($inst_results) eq 'HASH') {
10913: if (ref($inst_results->{$user}) eq 'HASH') {
10914: if (keys(%{$inst_results->{$user}}) == 0) {
10915: $$alerts{$item}{$udom}{$uname} = 1;
1.1227 raeburn 10916: } elsif ($item eq 'id') {
10917: if ($inst_results->{$user}->{'id'} eq '') {
10918: $$alerts{$item}{$udom}{$uname} = 1;
10919: }
1.615 raeburn 10920: }
1.612 raeburn 10921: }
10922: }
1.615 raeburn 10923: }
10924: last;
1.585 raeburn 10925: }
10926: }
10927: }
10928: }
10929: }
10930: }
10931: }
10932: }
1.612 raeburn 10933: return;
10934: }
10935:
10936: sub user_rule_formats {
10937: my ($domain,$domdesc,$curr_rules,$check) = @_;
10938: my %text = (
10939: 'username' => 'Usernames',
10940: 'id' => 'IDs',
10941: );
10942: my $output;
10943: my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
10944: if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
10945: if (@{$ruleorder} > 0) {
1.1102 raeburn 10946: $output = '<br />'.
10947: &mt($text{$check}.' with the following format(s) may [_1]only[_2] be used for verified users at [_3]:',
10948: '<span class="LC_cusr_emph">','</span>',$domdesc).
10949: ' <ul>';
1.612 raeburn 10950: foreach my $rule (@{$ruleorder}) {
10951: if (ref($curr_rules) eq 'ARRAY') {
10952: if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
10953: if (ref($rules->{$rule}) eq 'HASH') {
10954: $output .= '<li>'.$rules->{$rule}{'name'}.': '.
10955: $rules->{$rule}{'desc'}.'</li>';
10956: }
10957: }
10958: }
10959: }
10960: $output .= '</ul>';
10961: }
10962: }
10963: return $output;
10964: }
10965:
10966: sub instrule_disallow_msg {
1.615 raeburn 10967: my ($checkitem,$domdesc,$count,$mode) = @_;
1.612 raeburn 10968: my $response;
10969: my %text = (
10970: item => 'username',
10971: items => 'usernames',
10972: match => 'matches',
10973: do => 'does',
10974: action => 'a username',
10975: one => 'one',
10976: );
10977: if ($count > 1) {
10978: $text{'item'} = 'usernames';
10979: $text{'match'} ='match';
10980: $text{'do'} = 'do';
10981: $text{'action'} = 'usernames',
10982: $text{'one'} = 'ones';
10983: }
10984: if ($checkitem eq 'id') {
10985: $text{'items'} = 'IDs';
10986: $text{'item'} = 'ID';
10987: $text{'action'} = 'an ID';
1.615 raeburn 10988: if ($count > 1) {
10989: $text{'item'} = 'IDs';
10990: $text{'action'} = 'IDs';
10991: }
1.612 raeburn 10992: }
1.674 bisitz 10993: $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 10994: if ($mode eq 'upload') {
10995: if ($checkitem eq 'username') {
10996: $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'}.");
10997: } elsif ($checkitem eq 'id') {
1.674 bisitz 10998: $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 10999: }
1.669 raeburn 11000: } elsif ($mode eq 'selfcreate') {
11001: if ($checkitem eq 'id') {
11002: $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.");
11003: }
1.615 raeburn 11004: } else {
11005: if ($checkitem eq 'username') {
11006: $response .= &mt("You must choose $text{'action'} with a different format -- $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
11007: } elsif ($checkitem eq 'id') {
11008: $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.");
11009: }
1.612 raeburn 11010: }
11011: return $response;
1.585 raeburn 11012: }
11013:
1.624 raeburn 11014: sub personal_data_fieldtitles {
11015: my %fieldtitles = &Apache::lonlocal::texthash (
11016: id => 'Student/Employee ID',
11017: permanentemail => 'E-mail address',
11018: lastname => 'Last Name',
11019: firstname => 'First Name',
11020: middlename => 'Middle Name',
11021: generation => 'Generation',
11022: gen => 'Generation',
1.765 raeburn 11023: inststatus => 'Affiliation',
1.624 raeburn 11024: );
11025: return %fieldtitles;
11026: }
11027:
1.642 raeburn 11028: sub sorted_inst_types {
11029: my ($dom) = @_;
1.1185 raeburn 11030: my ($usertypes,$order);
11031: my %domdefaults = &Apache::lonnet::get_domain_defaults($dom);
11032: if (ref($domdefaults{'inststatus'}) eq 'HASH') {
11033: $usertypes = $domdefaults{'inststatus'}{'inststatustypes'};
11034: $order = $domdefaults{'inststatus'}{'inststatusorder'};
11035: } else {
11036: ($usertypes,$order) = &Apache::lonnet::retrieve_inst_usertypes($dom);
11037: }
1.642 raeburn 11038: my $othertitle = &mt('All users');
11039: if ($env{'request.course.id'}) {
1.668 raeburn 11040: $othertitle = &mt('Any users');
1.642 raeburn 11041: }
11042: my @types;
11043: if (ref($order) eq 'ARRAY') {
11044: @types = @{$order};
11045: }
11046: if (@types == 0) {
11047: if (ref($usertypes) eq 'HASH') {
11048: @types = sort(keys(%{$usertypes}));
11049: }
11050: }
11051: if (keys(%{$usertypes}) > 0) {
11052: $othertitle = &mt('Other users');
11053: }
11054: return ($othertitle,$usertypes,\@types);
11055: }
11056:
1.645 raeburn 11057: sub get_institutional_codes {
11058: my ($settings,$allcourses,$LC_code) = @_;
11059: # Get complete list of course sections to update
11060: my @currsections = ();
11061: my @currxlists = ();
11062: my $coursecode = $$settings{'internal.coursecode'};
11063:
11064: if ($$settings{'internal.sectionnums'} ne '') {
11065: @currsections = split(/,/,$$settings{'internal.sectionnums'});
11066: }
11067:
11068: if ($$settings{'internal.crosslistings'} ne '') {
11069: @currxlists = split(/,/,$$settings{'internal.crosslistings'});
11070: }
11071:
11072: if (@currxlists > 0) {
11073: foreach (@currxlists) {
11074: if (m/^([^:]+):(\w*)$/) {
11075: unless (grep/^$1$/,@{$allcourses}) {
1.1263 raeburn 11076: push(@{$allcourses},$1);
1.645 raeburn 11077: $$LC_code{$1} = $2;
11078: }
11079: }
11080: }
11081: }
11082:
11083: if (@currsections > 0) {
11084: foreach (@currsections) {
11085: if (m/^(\w+):(\w*)$/) {
11086: my $sec = $coursecode.$1;
11087: my $lc_sec = $2;
11088: unless (grep/^$sec$/,@{$allcourses}) {
1.1263 raeburn 11089: push(@{$allcourses},$sec);
1.645 raeburn 11090: $$LC_code{$sec} = $lc_sec;
11091: }
11092: }
11093: }
11094: }
11095: return;
11096: }
11097:
1.971 raeburn 11098: sub get_standard_codeitems {
11099: return ('Year','Semester','Department','Number','Section');
11100: }
11101:
1.112 bowersj2 11102: =pod
11103:
1.780 raeburn 11104: =head1 Slot Helpers
11105:
11106: =over 4
11107:
11108: =item * sorted_slots()
11109:
1.1040 raeburn 11110: Sorts an array of slot names in order of an optional sort key,
11111: default sort is by slot start time (earliest first).
1.780 raeburn 11112:
11113: Inputs:
11114:
11115: =over 4
11116:
11117: slotsarr - Reference to array of unsorted slot names.
11118:
11119: slots - Reference to hash of hash, where outer hash keys are slot names.
11120:
1.1040 raeburn 11121: sortkey - Name of key in inner hash to be sorted on (e.g., starttime).
11122:
1.549 albertel 11123: =back
11124:
1.780 raeburn 11125: Returns:
11126:
11127: =over 4
11128:
1.1040 raeburn 11129: sorted - An array of slot names sorted by a specified sort key
11130: (default sort key is start time of the slot).
1.780 raeburn 11131:
11132: =back
11133:
11134: =cut
11135:
11136:
11137: sub sorted_slots {
1.1040 raeburn 11138: my ($slotsarr,$slots,$sortkey) = @_;
11139: if ($sortkey eq '') {
11140: $sortkey = 'starttime';
11141: }
1.780 raeburn 11142: my @sorted;
11143: if ((ref($slotsarr) eq 'ARRAY') && (ref($slots) eq 'HASH')) {
11144: @sorted =
11145: sort {
11146: if (ref($slots->{$a}) && ref($slots->{$b})) {
1.1040 raeburn 11147: return $slots->{$a}{$sortkey} <=> $slots->{$b}{$sortkey}
1.780 raeburn 11148: }
11149: if (ref($slots->{$a})) { return -1;}
11150: if (ref($slots->{$b})) { return 1;}
11151: return 0;
11152: } @{$slotsarr};
11153: }
11154: return @sorted;
11155: }
11156:
1.1040 raeburn 11157: =pod
11158:
11159: =item * get_future_slots()
11160:
11161: Inputs:
11162:
11163: =over 4
11164:
11165: cnum - course number
11166:
11167: cdom - course domain
11168:
11169: now - current UNIX time
11170:
11171: symb - optional symb
11172:
11173: =back
11174:
11175: Returns:
11176:
11177: =over 4
11178:
11179: sorted_reservable - ref to array of student_schedulable slots currently
11180: reservable, ordered by end date of reservation period.
11181:
11182: reservable_now - ref to hash of student_schedulable slots currently
11183: reservable.
11184:
11185: Keys in inner hash are:
11186: (a) symb: either blank or symb to which slot use is restricted.
1.1250 raeburn 11187: (b) endreserve: end date of reservation period.
11188: (c) uniqueperiod: start,end dates when slot is to be uniquely
11189: selected.
1.1040 raeburn 11190:
11191: sorted_future - ref to array of student_schedulable slots reservable in
11192: the future, ordered by start date of reservation period.
11193:
11194: future_reservable - ref to hash of student_schedulable slots reservable
11195: in the future.
11196:
11197: Keys in inner hash are:
11198: (a) symb: either blank or symb to which slot use is restricted.
1.1250 raeburn 11199: (b) startreserve: start date of reservation period.
11200: (c) uniqueperiod: start,end dates when slot is to be uniquely
11201: selected.
1.1040 raeburn 11202:
11203: =back
11204:
11205: =cut
11206:
11207: sub get_future_slots {
11208: my ($cnum,$cdom,$now,$symb) = @_;
1.1229 raeburn 11209: my $map;
11210: if ($symb) {
11211: ($map) = &Apache::lonnet::decode_symb($symb);
11212: }
1.1040 raeburn 11213: my (%reservable_now,%future_reservable,@sorted_reservable,@sorted_future);
11214: my %slots = &Apache::lonnet::get_course_slots($cnum,$cdom);
11215: foreach my $slot (keys(%slots)) {
11216: next unless($slots{$slot}->{'type'} eq 'schedulable_student');
11217: if ($symb) {
1.1229 raeburn 11218: if ($slots{$slot}->{'symb'} ne '') {
11219: my $canuse;
11220: my %oksymbs;
11221: my @slotsymbs = split(/\s*,\s*/,$slots{$slot}->{'symb'});
11222: map { $oksymbs{$_} = 1; } @slotsymbs;
11223: if ($oksymbs{$symb}) {
11224: $canuse = 1;
11225: } else {
11226: foreach my $item (@slotsymbs) {
11227: if ($item =~ /\.(page|sequence)$/) {
11228: (undef,undef,my $sloturl) = &Apache::lonnet::decode_symb($item);
11229: if (($map ne '') && ($map eq $sloturl)) {
11230: $canuse = 1;
11231: last;
11232: }
11233: }
11234: }
11235: }
11236: next unless ($canuse);
11237: }
1.1040 raeburn 11238: }
11239: if (($slots{$slot}->{'starttime'} > $now) &&
11240: ($slots{$slot}->{'endtime'} > $now)) {
11241: if (($slots{$slot}->{'allowedsections'}) || ($slots{$slot}->{'allowedusers'})) {
11242: my $userallowed = 0;
11243: if ($slots{$slot}->{'allowedsections'}) {
11244: my @allowed_sec = split(',',$slots{$slot}->{'allowedsections'});
11245: if (!defined($env{'request.role.sec'})
11246: && grep(/^No section assigned$/,@allowed_sec)) {
11247: $userallowed=1;
11248: } else {
11249: if (grep(/^\Q$env{'request.role.sec'}\E$/,@allowed_sec)) {
11250: $userallowed=1;
11251: }
11252: }
11253: unless ($userallowed) {
11254: if (defined($env{'request.course.groups'})) {
11255: my @groups = split(/:/,$env{'request.course.groups'});
11256: foreach my $group (@groups) {
11257: if (grep(/^\Q$group\E$/,@allowed_sec)) {
11258: $userallowed=1;
11259: last;
11260: }
11261: }
11262: }
11263: }
11264: }
11265: if ($slots{$slot}->{'allowedusers'}) {
11266: my @allowed_users = split(',',$slots{$slot}->{'allowedusers'});
11267: my $user = $env{'user.name'}.':'.$env{'user.domain'};
11268: if (grep(/^\Q$user\E$/,@allowed_users)) {
11269: $userallowed = 1;
11270: }
11271: }
11272: next unless($userallowed);
11273: }
11274: my $startreserve = $slots{$slot}->{'startreserve'};
11275: my $endreserve = $slots{$slot}->{'endreserve'};
11276: my $symb = $slots{$slot}->{'symb'};
1.1250 raeburn 11277: my $uniqueperiod;
11278: if (ref($slots{$slot}->{'uniqueperiod'}) eq 'ARRAY') {
11279: $uniqueperiod = join(',',@{$slots{$slot}->{'uniqueperiod'}});
11280: }
1.1040 raeburn 11281: if (($startreserve < $now) &&
11282: (!$endreserve || $endreserve > $now)) {
11283: my $lastres = $endreserve;
11284: if (!$lastres) {
11285: $lastres = $slots{$slot}->{'starttime'};
11286: }
11287: $reservable_now{$slot} = {
11288: symb => $symb,
1.1250 raeburn 11289: endreserve => $lastres,
11290: uniqueperiod => $uniqueperiod,
1.1040 raeburn 11291: };
11292: } elsif (($startreserve > $now) &&
11293: (!$endreserve || $endreserve > $startreserve)) {
11294: $future_reservable{$slot} = {
11295: symb => $symb,
1.1250 raeburn 11296: startreserve => $startreserve,
11297: uniqueperiod => $uniqueperiod,
1.1040 raeburn 11298: };
11299: }
11300: }
11301: }
11302: my @unsorted_reservable = keys(%reservable_now);
11303: if (@unsorted_reservable > 0) {
11304: @sorted_reservable =
11305: &sorted_slots(\@unsorted_reservable,\%reservable_now,'endreserve');
11306: }
11307: my @unsorted_future = keys(%future_reservable);
11308: if (@unsorted_future > 0) {
11309: @sorted_future =
11310: &sorted_slots(\@unsorted_future,\%future_reservable,'startreserve');
11311: }
11312: return (\@sorted_reservable,\%reservable_now,\@sorted_future,\%future_reservable);
11313: }
1.780 raeburn 11314:
11315: =pod
11316:
1.1057 foxr 11317: =back
11318:
1.549 albertel 11319: =head1 HTTP Helpers
11320:
11321: =over 4
11322:
1.648 raeburn 11323: =item * &get_unprocessed_cgi($query,$possible_names)
1.112 bowersj2 11324:
1.258 albertel 11325: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112 bowersj2 11326: $query. The parameters listed in $possible_names (an array reference),
1.258 albertel 11327: will be set in $env{'form.name'} if they do not already exist.
1.112 bowersj2 11328:
11329: Typically called with $ENV{'QUERY_STRING'} as the first parameter.
11330: $possible_names is an ref to an array of form element names. As an example:
11331: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258 albertel 11332: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112 bowersj2 11333:
11334: =cut
1.1 albertel 11335:
1.6 albertel 11336: sub get_unprocessed_cgi {
1.25 albertel 11337: my ($query,$possible_names)= @_;
1.26 matthew 11338: # $Apache::lonxml::debug=1;
1.356 albertel 11339: foreach my $pair (split(/&/,$query)) {
11340: my ($name, $value) = split(/=/,$pair);
1.369 www 11341: $name = &unescape($name);
1.25 albertel 11342: if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
11343: $value =~ tr/+/ /;
11344: $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258 albertel 11345: unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25 albertel 11346: }
1.16 harris41 11347: }
1.6 albertel 11348: }
11349:
1.112 bowersj2 11350: =pod
11351:
1.648 raeburn 11352: =item * &cacheheader()
1.112 bowersj2 11353:
11354: returns cache-controlling header code
11355:
11356: =cut
11357:
1.7 albertel 11358: sub cacheheader {
1.258 albertel 11359: unless ($env{'request.method'} eq 'GET') { return ''; }
1.216 albertel 11360: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
11361: my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7 albertel 11362: <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
11363: <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216 albertel 11364: return $output;
1.7 albertel 11365: }
11366:
1.112 bowersj2 11367: =pod
11368:
1.648 raeburn 11369: =item * &no_cache($r)
1.112 bowersj2 11370:
11371: specifies header code to not have cache
11372:
11373: =cut
11374:
1.9 albertel 11375: sub no_cache {
1.216 albertel 11376: my ($r) = @_;
11377: if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258 albertel 11378: $env{'request.method'} ne 'GET') { return ''; }
1.216 albertel 11379: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
11380: $r->no_cache(1);
11381: $r->header_out("Expires" => $date);
11382: $r->header_out("Pragma" => "no-cache");
1.123 www 11383: }
11384:
11385: sub content_type {
1.181 albertel 11386: my ($r,$type,$charset) = @_;
1.299 foxr 11387: if ($r) {
11388: # Note that printout.pl calls this with undef for $r.
11389: &no_cache($r);
11390: }
1.258 albertel 11391: if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181 albertel 11392: unless ($charset) {
11393: $charset=&Apache::lonlocal::current_encoding;
11394: }
11395: if ($charset) { $type.='; charset='.$charset; }
11396: if ($r) {
11397: $r->content_type($type);
11398: } else {
11399: print("Content-type: $type\n\n");
11400: }
1.9 albertel 11401: }
1.25 albertel 11402:
1.112 bowersj2 11403: =pod
11404:
1.648 raeburn 11405: =item * &add_to_env($name,$value)
1.112 bowersj2 11406:
1.258 albertel 11407: adds $name to the %env hash with value
1.112 bowersj2 11408: $value, if $name already exists, the entry is converted to an array
11409: reference and $value is added to the array.
11410:
11411: =cut
11412:
1.25 albertel 11413: sub add_to_env {
11414: my ($name,$value)=@_;
1.258 albertel 11415: if (defined($env{$name})) {
11416: if (ref($env{$name})) {
1.25 albertel 11417: #already have multiple values
1.258 albertel 11418: push(@{ $env{$name} },$value);
1.25 albertel 11419: } else {
11420: #first time seeing multiple values, convert hash entry to an arrayref
1.258 albertel 11421: my $first=$env{$name};
11422: undef($env{$name});
11423: push(@{ $env{$name} },$first,$value);
1.25 albertel 11424: }
11425: } else {
1.258 albertel 11426: $env{$name}=$value;
1.25 albertel 11427: }
1.31 albertel 11428: }
1.149 albertel 11429:
11430: =pod
11431:
1.648 raeburn 11432: =item * &get_env_multiple($name)
1.149 albertel 11433:
1.258 albertel 11434: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149 albertel 11435: values may be defined and end up as an array ref.
11436:
11437: returns an array of values
11438:
11439: =cut
11440:
11441: sub get_env_multiple {
11442: my ($name) = @_;
11443: my @values;
1.258 albertel 11444: if (defined($env{$name})) {
1.149 albertel 11445: # exists is it an array
1.258 albertel 11446: if (ref($env{$name})) {
11447: @values=@{ $env{$name} };
1.149 albertel 11448: } else {
1.258 albertel 11449: $values[0]=$env{$name};
1.149 albertel 11450: }
11451: }
11452: return(@values);
11453: }
11454:
1.1249 damieng 11455: # Looks at given dependencies, and returns something depending on the context.
11456: # For coursedocs paste, returns (undef, $counter, $numpathchg, \%existing).
11457: # For syllabus rewrites, returns (undef, $counter, $numpathchg, \%existing, \%mapping).
11458: # For all other contexts, returns ($output, $counter, $numpathchg).
11459: # $output: string with the HTML output. Can contain missing dependencies with an upload form, existing dependencies, and dependencies no longer in use.
11460: # $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.
11461: # $numpathchg: integer with the number of cleaned up dependency paths.
11462: # \%existing: hash reference clean path -> 1 only for existing dependencies.
11463: # \%mapping: hash reference clean path -> original path for all dependencies.
11464: # @param {string} actionurl - The path to the handler, indicative of the context.
11465: # @param {string} state - Can contain HTML with hidden inputs that will be added to the output form.
11466: # @param {hash reference} allfiles - List of file info from lonnet::extract_embedded_items
11467: # @param {hash reference} codebase - undef, not modified by lonnet::extract_embedded_items ?
11468: # @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)
11469: # @return {Array} - array depending on the context (not a reference)
1.660 raeburn 11470: sub ask_for_embedded_content {
1.1249 damieng 11471: # NOTE: documentation was added afterwards, it could be wrong
1.660 raeburn 11472: my ($actionurl,$state,$allfiles,$codebase,$args)=@_;
1.1071 raeburn 11473: my (%subdependencies,%dependencies,%mapping,%existing,%newfiles,%pathchanges,
1.1085 raeburn 11474: %currsubfile,%unused,$rem);
1.1071 raeburn 11475: my $counter = 0;
11476: my $numnew = 0;
1.987 raeburn 11477: my $numremref = 0;
11478: my $numinvalid = 0;
11479: my $numpathchg = 0;
11480: my $numexisting = 0;
1.1071 raeburn 11481: my $numunused = 0;
11482: my ($output,$upload_output,$toplevel,$url,$udom,$uname,$getpropath,$cdom,$cnum,
1.1156 raeburn 11483: $fileloc,$filename,$delete_output,$modify_output,$title,$symb,$path,$navmap);
1.1071 raeburn 11484: my $heading = &mt('Upload embedded files');
11485: my $buttontext = &mt('Upload');
11486:
1.1249 damieng 11487: # fills these variables based on the context:
11488: # $navmap, $cdom, $cnum, $udom, $uname, $url, $toplevel, $getpropath,
11489: # $path, $fileloc, $title, $rem, $filename
1.1085 raeburn 11490: if ($env{'request.course.id'}) {
1.1123 raeburn 11491: if ($actionurl eq '/adm/dependencies') {
11492: $navmap = Apache::lonnavmaps::navmap->new();
11493: }
11494: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
11495: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
1.1085 raeburn 11496: }
1.1123 raeburn 11497: if (($actionurl eq '/adm/portfolio') ||
11498: ($actionurl eq '/adm/coursegrp_portfolio')) {
1.984 raeburn 11499: my $current_path='/';
11500: if ($env{'form.currentpath'}) {
11501: $current_path = $env{'form.currentpath'};
11502: }
11503: if ($actionurl eq '/adm/coursegrp_portfolio') {
1.1123 raeburn 11504: $udom = $cdom;
11505: $uname = $cnum;
1.984 raeburn 11506: $url = '/userfiles/groups/'.$env{'form.group'}.'/portfolio';
11507: } else {
11508: $udom = $env{'user.domain'};
11509: $uname = $env{'user.name'};
11510: $url = '/userfiles/portfolio';
11511: }
1.987 raeburn 11512: $toplevel = $url.'/';
1.984 raeburn 11513: $url .= $current_path;
11514: $getpropath = 1;
1.987 raeburn 11515: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') ||
11516: ($actionurl eq '/adm/imsimport')) {
1.1022 www 11517: my ($udom,$uname,$rest) = ($args->{'current_path'} =~ m{/priv/($match_domain)/($match_username)/?(.*)$});
1.1026 raeburn 11518: $url = $Apache::lonnet::perlvar{'lonDocRoot'}."/priv/$udom/$uname/";
1.987 raeburn 11519: $toplevel = $url;
1.984 raeburn 11520: if ($rest ne '') {
1.987 raeburn 11521: $url .= $rest;
11522: }
11523: } elsif ($actionurl eq '/adm/coursedocs') {
11524: if (ref($args) eq 'HASH') {
1.1071 raeburn 11525: $url = $args->{'docs_url'};
11526: $toplevel = $url;
1.1084 raeburn 11527: if ($args->{'context'} eq 'paste') {
11528: ($cdom,$cnum) = ($url =~ m{^\Q/uploaded/\E($match_domain)/($match_courseid)/});
11529: ($path) =
11530: ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/\E(?:docs|supplemental)/(?:default|\d+)/\d+)/});
11531: $fileloc = &Apache::lonnet::filelocation('',$toplevel);
11532: $fileloc =~ s{^/}{};
11533: }
1.1071 raeburn 11534: }
1.1084 raeburn 11535: } elsif ($actionurl eq '/adm/dependencies') {
1.1071 raeburn 11536: if ($env{'request.course.id'} ne '') {
11537: if (ref($args) eq 'HASH') {
11538: $url = $args->{'docs_url'};
11539: $title = $args->{'docs_title'};
1.1126 raeburn 11540: $toplevel = $url;
11541: unless ($toplevel =~ m{^/}) {
11542: $toplevel = "/$url";
11543: }
1.1085 raeburn 11544: ($rem) = ($toplevel =~ m{^(.+/)[^/]+$});
1.1126 raeburn 11545: if ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/portfolio/syllabus\E)}) {
11546: $path = $1;
11547: } else {
11548: ($path) =
11549: ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/\E(?:docs|supplemental)/(?:default|\d+)/\d+)/});
11550: }
1.1195 raeburn 11551: if ($toplevel=~/^\/*(uploaded|editupload)/) {
11552: $fileloc = $toplevel;
11553: $fileloc=~ s/^\s*(\S+)\s*$/$1/;
11554: my ($udom,$uname,$fname) =
11555: ($fileloc=~ m{^/+(?:uploaded|editupload)/+($match_domain)/+($match_name)/+(.*)$});
11556: $fileloc = propath($udom,$uname).'/userfiles/'.$fname;
11557: } else {
11558: $fileloc = &Apache::lonnet::filelocation('',$toplevel);
11559: }
1.1071 raeburn 11560: $fileloc =~ s{^/}{};
11561: ($filename) = ($fileloc =~ m{.+/([^/]+)$});
11562: $heading = &mt('Status of dependencies in [_1]',"$title ($filename)");
11563: }
1.987 raeburn 11564: }
1.1123 raeburn 11565: } elsif ($actionurl eq "/public/$cdom/$cnum/syllabus") {
11566: $udom = $cdom;
11567: $uname = $cnum;
11568: $url = "/uploaded/$cdom/$cnum/portfolio/syllabus";
11569: $toplevel = $url;
11570: $path = $url;
11571: $fileloc = &Apache::lonnet::filelocation('',$toplevel).'/';
11572: $fileloc =~ s{^/}{};
1.987 raeburn 11573: }
1.1249 damieng 11574:
11575: # parses the dependency paths to get some info
11576: # fills $newfiles, $mapping, $subdependencies, $dependencies
11577: # $newfiles: hash URL -> 1 for new files or external URLs
11578: # (will be completed later)
11579: # $mapping:
11580: # for external URLs: external URL -> external URL
11581: # for relative paths: clean path -> original path
11582: # $subdependencies: hash clean path -> clean file name -> 1 for relative paths in subdirectories
11583: # $dependencies: hash clean or not file name -> 1 for relative paths not in subdirectories
1.1126 raeburn 11584: foreach my $file (keys(%{$allfiles})) {
11585: my $embed_file;
11586: if (($path eq "/uploaded/$cdom/$cnum/portfolio/syllabus") && ($file =~ m{^\Q$path/\E(.+)$})) {
11587: $embed_file = $1;
11588: } else {
11589: $embed_file = $file;
11590: }
1.1158 raeburn 11591: my ($absolutepath,$cleaned_file);
11592: if ($embed_file =~ m{^\w+://}) {
11593: $cleaned_file = $embed_file;
1.1147 raeburn 11594: $newfiles{$cleaned_file} = 1;
11595: $mapping{$cleaned_file} = $embed_file;
1.987 raeburn 11596: } else {
1.1158 raeburn 11597: $cleaned_file = &clean_path($embed_file);
1.987 raeburn 11598: if ($embed_file =~ m{^/}) {
11599: $absolutepath = $embed_file;
11600: }
1.1147 raeburn 11601: if ($cleaned_file =~ m{/}) {
11602: my ($path,$fname) = ($cleaned_file =~ m{^(.+)/([^/]*)$});
1.987 raeburn 11603: $path = &check_for_traversal($path,$url,$toplevel);
11604: my $item = $fname;
11605: if ($path ne '') {
11606: $item = $path.'/'.$fname;
11607: $subdependencies{$path}{$fname} = 1;
11608: } else {
11609: $dependencies{$item} = 1;
11610: }
11611: if ($absolutepath) {
11612: $mapping{$item} = $absolutepath;
11613: } else {
11614: $mapping{$item} = $embed_file;
11615: }
11616: } else {
11617: $dependencies{$embed_file} = 1;
11618: if ($absolutepath) {
1.1147 raeburn 11619: $mapping{$cleaned_file} = $absolutepath;
1.987 raeburn 11620: } else {
1.1147 raeburn 11621: $mapping{$cleaned_file} = $embed_file;
1.987 raeburn 11622: }
11623: }
1.984 raeburn 11624: }
11625: }
1.1249 damieng 11626:
11627: # looks for all existing files in dependency subdirectories (from $subdependencies filled above)
11628: # and lists
11629: # fills $currsubfile, $pathchanges, $existing, $numexisting, $newfiles, $unused
11630: # $currsubfile: hash clean path -> file name -> 1 for all existing files in the path
11631: # $pathchanges: hash clean path -> 1 if the file in subdirectory exists and
11632: # the path had to be cleaned up
11633: # $existing: hash clean path -> 1 if the file exists
11634: # $numexisting: number of keys in $existing
11635: # $newfiles: updated with clean path -> 1 for files in subdirectories that do not exist
11636: # $unused: only for /adm/dependencies, hash clean path -> 1 for existing files in
11637: # dependency subdirectories that are
11638: # not listed as dependencies, with some exceptions using $rem
1.1071 raeburn 11639: my $dirptr = 16384;
1.984 raeburn 11640: foreach my $path (keys(%subdependencies)) {
1.1071 raeburn 11641: $currsubfile{$path} = {};
1.1123 raeburn 11642: if (($actionurl eq '/adm/portfolio') ||
11643: ($actionurl eq '/adm/coursegrp_portfolio')) {
1.1021 raeburn 11644: my ($sublistref,$listerror) =
11645: &Apache::lonnet::dirlist($url.$path,$udom,$uname,$getpropath);
11646: if (ref($sublistref) eq 'ARRAY') {
11647: foreach my $line (@{$sublistref}) {
11648: my ($file_name,$rest) = split(/\&/,$line,2);
1.1071 raeburn 11649: $currsubfile{$path}{$file_name} = 1;
1.1021 raeburn 11650: }
1.984 raeburn 11651: }
1.987 raeburn 11652: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984 raeburn 11653: if (opendir(my $dir,$url.'/'.$path)) {
11654: my @subdir_list = grep(!/^\./,readdir($dir));
1.1071 raeburn 11655: map {$currsubfile{$path}{$_} = 1;} @subdir_list;
11656: }
1.1084 raeburn 11657: } elsif (($actionurl eq '/adm/dependencies') ||
11658: (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
1.1123 raeburn 11659: ($args->{'context'} eq 'paste')) ||
11660: ($actionurl eq "/public/$cdom/$cnum/syllabus")) {
1.1071 raeburn 11661: if ($env{'request.course.id'} ne '') {
1.1123 raeburn 11662: my $dir;
11663: if ($actionurl eq "/public/$cdom/$cnum/syllabus") {
11664: $dir = $fileloc;
11665: } else {
11666: ($dir) = ($fileloc =~ m{^(.+/)[^/]+$});
11667: }
1.1071 raeburn 11668: if ($dir ne '') {
11669: my ($sublistref,$listerror) =
11670: &Apache::lonnet::dirlist($dir.$path,$cdom,$cnum,$getpropath,undef,'/');
11671: if (ref($sublistref) eq 'ARRAY') {
11672: foreach my $line (@{$sublistref}) {
11673: my ($file_name,$dom,undef,$testdir,undef,undef,undef,undef,$size,
11674: undef,$mtime)=split(/\&/,$line,12);
11675: unless (($testdir&$dirptr) ||
11676: ($file_name =~ /^\.\.?$/)) {
11677: $currsubfile{$path}{$file_name} = [$size,$mtime];
11678: }
11679: }
11680: }
11681: }
1.984 raeburn 11682: }
11683: }
11684: foreach my $file (keys(%{$subdependencies{$path}})) {
1.1071 raeburn 11685: if (exists($currsubfile{$path}{$file})) {
1.987 raeburn 11686: my $item = $path.'/'.$file;
11687: unless ($mapping{$item} eq $item) {
11688: $pathchanges{$item} = 1;
11689: }
11690: $existing{$item} = 1;
11691: $numexisting ++;
11692: } else {
11693: $newfiles{$path.'/'.$file} = 1;
1.984 raeburn 11694: }
11695: }
1.1071 raeburn 11696: if ($actionurl eq '/adm/dependencies') {
11697: foreach my $path (keys(%currsubfile)) {
11698: if (ref($currsubfile{$path}) eq 'HASH') {
11699: foreach my $file (keys(%{$currsubfile{$path}})) {
11700: unless ($subdependencies{$path}{$file}) {
1.1085 raeburn 11701: next if (($rem ne '') &&
11702: (($env{"httpref.$rem"."$path/$file"} ne '') ||
11703: (ref($navmap) &&
11704: (($navmap->getResourceByUrl($rem."$path/$file") ne '') ||
11705: (($file =~ /^(.*\.s?html?)\.bak$/i) &&
11706: ($navmap->getResourceByUrl($rem."$path/$1")))))));
1.1071 raeburn 11707: $unused{$path.'/'.$file} = 1;
11708: }
11709: }
11710: }
11711: }
11712: }
1.984 raeburn 11713: }
1.1249 damieng 11714:
11715: # fills $currfile, hash file name -> 1 or [$size,$mtime]
11716: # for files in $url or $fileloc (target directory) in some contexts
1.987 raeburn 11717: my %currfile;
1.1123 raeburn 11718: if (($actionurl eq '/adm/portfolio') ||
11719: ($actionurl eq '/adm/coursegrp_portfolio')) {
1.1021 raeburn 11720: my ($dirlistref,$listerror) =
11721: &Apache::lonnet::dirlist($url,$udom,$uname,$getpropath);
11722: if (ref($dirlistref) eq 'ARRAY') {
11723: foreach my $line (@{$dirlistref}) {
11724: my ($file_name,$rest) = split(/\&/,$line,2);
11725: $currfile{$file_name} = 1;
11726: }
1.984 raeburn 11727: }
1.987 raeburn 11728: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984 raeburn 11729: if (opendir(my $dir,$url)) {
1.987 raeburn 11730: my @dir_list = grep(!/^\./,readdir($dir));
1.984 raeburn 11731: map {$currfile{$_} = 1;} @dir_list;
11732: }
1.1084 raeburn 11733: } elsif (($actionurl eq '/adm/dependencies') ||
11734: (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
1.1123 raeburn 11735: ($args->{'context'} eq 'paste')) ||
11736: ($actionurl eq "/public/$cdom/$cnum/syllabus")) {
1.1071 raeburn 11737: if ($env{'request.course.id'} ne '') {
11738: my ($dir) = ($fileloc =~ m{^(.+/)[^/]+$});
11739: if ($dir ne '') {
11740: my ($dirlistref,$listerror) =
11741: &Apache::lonnet::dirlist($dir,$cdom,$cnum,$getpropath,undef,'/');
11742: if (ref($dirlistref) eq 'ARRAY') {
11743: foreach my $line (@{$dirlistref}) {
11744: my ($file_name,$dom,undef,$testdir,undef,undef,undef,undef,
11745: $size,undef,$mtime)=split(/\&/,$line,12);
11746: unless (($testdir&$dirptr) ||
11747: ($file_name =~ /^\.\.?$/)) {
11748: $currfile{$file_name} = [$size,$mtime];
11749: }
11750: }
11751: }
11752: }
11753: }
1.984 raeburn 11754: }
1.1249 damieng 11755: # updates $pathchanges, $existing, $numexisting, $newfiles and $unused for files that
11756: # are not in subdirectories, using $currfile
1.984 raeburn 11757: foreach my $file (keys(%dependencies)) {
1.1071 raeburn 11758: if (exists($currfile{$file})) {
1.987 raeburn 11759: unless ($mapping{$file} eq $file) {
11760: $pathchanges{$file} = 1;
11761: }
11762: $existing{$file} = 1;
11763: $numexisting ++;
11764: } else {
1.984 raeburn 11765: $newfiles{$file} = 1;
11766: }
11767: }
1.1071 raeburn 11768: foreach my $file (keys(%currfile)) {
11769: unless (($file eq $filename) ||
11770: ($file eq $filename.'.bak') ||
11771: ($dependencies{$file})) {
1.1085 raeburn 11772: if ($actionurl eq '/adm/dependencies') {
1.1126 raeburn 11773: unless ($toplevel =~ m{^\Q/uploaded/$cdom/$cnum/portfolio/syllabus\E}) {
11774: next if (($rem ne '') &&
11775: (($env{"httpref.$rem".$file} ne '') ||
11776: (ref($navmap) &&
11777: (($navmap->getResourceByUrl($rem.$file) ne '') ||
11778: (($file =~ /^(.*\.s?html?)\.bak$/i) &&
11779: ($navmap->getResourceByUrl($rem.$1)))))));
11780: }
1.1085 raeburn 11781: }
1.1071 raeburn 11782: $unused{$file} = 1;
11783: }
11784: }
1.1249 damieng 11785:
11786: # returns some results for coursedocs paste and syllabus rewrites ($output is undef)
1.1084 raeburn 11787: if (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
11788: ($args->{'context'} eq 'paste')) {
11789: $counter = scalar(keys(%existing));
11790: $numpathchg = scalar(keys(%pathchanges));
1.1123 raeburn 11791: return ($output,$counter,$numpathchg,\%existing);
11792: } elsif (($actionurl eq "/public/$cdom/$cnum/syllabus") &&
11793: (ref($args) eq 'HASH') && ($args->{'context'} eq 'rewrites')) {
11794: $counter = scalar(keys(%existing));
11795: $numpathchg = scalar(keys(%pathchanges));
11796: return ($output,$counter,$numpathchg,\%existing,\%mapping);
1.1084 raeburn 11797: }
1.1249 damieng 11798:
11799: # returns HTML otherwise, with dependency results and to ask for more uploads
11800:
11801: # $upload_output: missing dependencies (with upload form)
11802: # $modify_output: uploaded dependencies (in use)
11803: # $delete_output: files no longer in use (unused files are not listed for londocs, bug?)
1.984 raeburn 11804: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%newfiles)) {
1.1071 raeburn 11805: if ($actionurl eq '/adm/dependencies') {
11806: next if ($embed_file =~ m{^\w+://});
11807: }
1.660 raeburn 11808: $upload_output .= &start_data_table_row().
1.1123 raeburn 11809: '<td valign="top"><img src="'.&icon($embed_file).'" /> '.
1.1071 raeburn 11810: '<span class="LC_filename">'.$embed_file.'</span>';
1.987 raeburn 11811: unless ($mapping{$embed_file} eq $embed_file) {
1.1123 raeburn 11812: $upload_output .= '<br /><span class="LC_info" style="font-size:smaller;">'.
11813: &mt('changed from: [_1]',$mapping{$embed_file}).'</span>';
1.987 raeburn 11814: }
1.1123 raeburn 11815: $upload_output .= '</td>';
1.1071 raeburn 11816: if ($args->{'ignore_remote_references'} && $embed_file =~ m{^\w+://}) {
1.1123 raeburn 11817: $upload_output.='<td align="right">'.
11818: '<span class="LC_info LC_fontsize_medium">'.
11819: &mt("URL points to web address").'</span>';
1.987 raeburn 11820: $numremref++;
1.660 raeburn 11821: } elsif ($args->{'error_on_invalid_names'}
11822: && $embed_file ne &Apache::lonnet::clean_filename($embed_file,{'keep_path' => 1,})) {
1.1123 raeburn 11823: $upload_output.='<td align="right"><span class="LC_warning">'.
11824: &mt('Invalid characters').'</span>';
1.987 raeburn 11825: $numinvalid++;
1.660 raeburn 11826: } else {
1.1123 raeburn 11827: $upload_output .= '<td>'.
11828: &embedded_file_element('upload_embedded',$counter,
1.987 raeburn 11829: $embed_file,\%mapping,
1.1071 raeburn 11830: $allfiles,$codebase,'upload');
11831: $counter ++;
11832: $numnew ++;
1.987 raeburn 11833: }
11834: $upload_output .= '</td>'.&Apache::loncommon::end_data_table_row()."\n";
11835: }
11836: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%existing)) {
1.1071 raeburn 11837: if ($actionurl eq '/adm/dependencies') {
11838: my ($size,$mtime) = &get_dependency_details(\%currfile,\%currsubfile,$embed_file);
11839: $modify_output .= &start_data_table_row().
11840: '<td><a href="'.$path.'/'.$embed_file.'" style="text-decoration:none;">'.
11841: '<img src="'.&icon($embed_file).'" border="0" />'.
11842: ' <span class="LC_filename">'.$embed_file.'</span></a></td>'.
11843: '<td>'.$size.'</td>'.
11844: '<td>'.$mtime.'</td>'.
11845: '<td><label><input type="checkbox" name="mod_upload_dep" '.
11846: 'onclick="toggleBrowse('."'$counter'".')" id="mod_upload_dep_'.
11847: $counter.'" value="'.$counter.'" />'.&mt('Yes').'</label>'.
11848: '<div id="moduploaddep_'.$counter.'" style="display:none;">'.
11849: &embedded_file_element('upload_embedded',$counter,
11850: $embed_file,\%mapping,
11851: $allfiles,$codebase,'modify').
11852: '</div></td>'.
11853: &end_data_table_row()."\n";
11854: $counter ++;
11855: } else {
11856: $upload_output .= &start_data_table_row().
1.1123 raeburn 11857: '<td valign="top"><img src="'.&icon($embed_file).'" /> '.
11858: '<span class="LC_filename">'.$embed_file.'</span></td>'.
11859: '<td align="right"><span class="LC_info LC_fontsize_medium">'.&mt('Already exists').'</span></td>'.
1.1071 raeburn 11860: &Apache::loncommon::end_data_table_row()."\n";
11861: }
11862: }
11863: my $delidx = $counter;
11864: foreach my $oldfile (sort {lc($a) cmp lc($b)} keys(%unused)) {
11865: my ($size,$mtime) = &get_dependency_details(\%currfile,\%currsubfile,$oldfile);
11866: $delete_output .= &start_data_table_row().
11867: '<td><img src="'.&icon($oldfile).'" />'.
11868: ' <span class="LC_filename">'.$oldfile.'</span></td>'.
11869: '<td>'.$size.'</td>'.
11870: '<td>'.$mtime.'</td>'.
11871: '<td><label><input type="checkbox" name="del_upload_dep" '.
11872: ' value="'.$delidx.'" />'.&mt('Yes').'</label>'.
11873: &embedded_file_element('upload_embedded',$delidx,
11874: $oldfile,\%mapping,$allfiles,
11875: $codebase,'delete').'</td>'.
11876: &end_data_table_row()."\n";
11877: $numunused ++;
11878: $delidx ++;
1.987 raeburn 11879: }
11880: if ($upload_output) {
11881: $upload_output = &start_data_table().
11882: $upload_output.
11883: &end_data_table()."\n";
11884: }
1.1071 raeburn 11885: if ($modify_output) {
11886: $modify_output = &start_data_table().
11887: &start_data_table_header_row().
11888: '<th>'.&mt('File').'</th>'.
11889: '<th>'.&mt('Size (KB)').'</th>'.
11890: '<th>'.&mt('Modified').'</th>'.
11891: '<th>'.&mt('Upload replacement?').'</th>'.
11892: &end_data_table_header_row().
11893: $modify_output.
11894: &end_data_table()."\n";
11895: }
11896: if ($delete_output) {
11897: $delete_output = &start_data_table().
11898: &start_data_table_header_row().
11899: '<th>'.&mt('File').'</th>'.
11900: '<th>'.&mt('Size (KB)').'</th>'.
11901: '<th>'.&mt('Modified').'</th>'.
11902: '<th>'.&mt('Delete?').'</th>'.
11903: &end_data_table_header_row().
11904: $delete_output.
11905: &end_data_table()."\n";
11906: }
1.987 raeburn 11907: my $applies = 0;
11908: if ($numremref) {
11909: $applies ++;
11910: }
11911: if ($numinvalid) {
11912: $applies ++;
11913: }
11914: if ($numexisting) {
11915: $applies ++;
11916: }
1.1071 raeburn 11917: if ($counter || $numunused) {
1.987 raeburn 11918: $output = '<form name="upload_embedded" action="'.$actionurl.'"'.
11919: ' method="post" enctype="multipart/form-data">'."\n".
1.1071 raeburn 11920: $state.'<h3>'.$heading.'</h3>';
11921: if ($actionurl eq '/adm/dependencies') {
11922: if ($numnew) {
11923: $output .= '<h4>'.&mt('Missing dependencies').'</h4>'.
11924: '<p>'.&mt('The following files need to be uploaded.').'</p>'."\n".
11925: $upload_output.'<br />'."\n";
11926: }
11927: if ($numexisting) {
11928: $output .= '<h4>'.&mt('Uploaded dependencies (in use)').'</h4>'.
11929: '<p>'.&mt('Upload a new file to replace the one currently in use.').'</p>'."\n".
11930: $modify_output.'<br />'."\n";
11931: $buttontext = &mt('Save changes');
11932: }
11933: if ($numunused) {
11934: $output .= '<h4>'.&mt('Unused files').'</h4>'.
11935: '<p>'.&mt('The following uploaded files are no longer used.').'</p>'."\n".
11936: $delete_output.'<br />'."\n";
11937: $buttontext = &mt('Save changes');
11938: }
11939: } else {
11940: $output .= $upload_output.'<br />'."\n";
11941: }
11942: $output .= '<input type ="hidden" name="number_embedded_items" value="'.
11943: $counter.'" />'."\n";
11944: if ($actionurl eq '/adm/dependencies') {
11945: $output .= '<input type ="hidden" name="number_newemb_items" value="'.
11946: $numnew.'" />'."\n";
11947: } elsif ($actionurl eq '') {
1.987 raeburn 11948: $output .= '<input type="hidden" name="phase" value="three" />';
11949: }
11950: } elsif ($applies) {
11951: $output = '<b>'.&mt('Referenced files').'</b>:<br />';
11952: if ($applies > 1) {
11953: $output .=
1.1123 raeburn 11954: &mt('No dependencies need to be uploaded, as one of the following applies to each reference:').'<ul>';
1.987 raeburn 11955: if ($numremref) {
11956: $output .= '<li>'.&mt('reference is to a URL which points to another server').'</li>'."\n";
11957: }
11958: if ($numinvalid) {
11959: $output .= '<li>'.&mt('reference is to file with a name containing invalid characters').'</li>'."\n";
11960: }
11961: if ($numexisting) {
11962: $output .= '<li>'.&mt('reference is to an existing file at the specified location').'</li>'."\n";
11963: }
11964: $output .= '</ul><br />';
11965: } elsif ($numremref) {
11966: $output .= '<p>'.&mt('None to upload, as all references are to URLs pointing to another server.').'</p>';
11967: } elsif ($numinvalid) {
11968: $output .= '<p>'.&mt('None to upload, as all references are to files with names containing invalid characters.').'</p>';
11969: } elsif ($numexisting) {
11970: $output .= '<p>'.&mt('None to upload, as all references are to existing files.').'</p>';
11971: }
11972: $output .= $upload_output.'<br />';
11973: }
11974: my ($pathchange_output,$chgcount);
1.1071 raeburn 11975: $chgcount = $counter;
1.987 raeburn 11976: if (keys(%pathchanges) > 0) {
11977: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%pathchanges)) {
1.1071 raeburn 11978: if ($counter) {
1.987 raeburn 11979: $output .= &embedded_file_element('pathchange',$chgcount,
11980: $embed_file,\%mapping,
1.1071 raeburn 11981: $allfiles,$codebase,'change');
1.987 raeburn 11982: } else {
11983: $pathchange_output .=
11984: &start_data_table_row().
11985: '<td><input type ="checkbox" name="namechange" value="'.
11986: $chgcount.'" checked="checked" /></td>'.
11987: '<td>'.$mapping{$embed_file}.'</td>'.
11988: '<td>'.$embed_file.
11989: &embedded_file_element('pathchange',$numpathchg,$embed_file,
1.1071 raeburn 11990: \%mapping,$allfiles,$codebase,'change').
1.987 raeburn 11991: '</td>'.&end_data_table_row();
1.660 raeburn 11992: }
1.987 raeburn 11993: $numpathchg ++;
11994: $chgcount ++;
1.660 raeburn 11995: }
11996: }
1.1127 raeburn 11997: if (($counter) || ($numunused)) {
1.987 raeburn 11998: if ($numpathchg) {
11999: $output .= '<input type ="hidden" name="number_pathchange_items" value="'.
12000: $numpathchg.'" />'."\n";
12001: }
12002: if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') ||
12003: ($actionurl eq '/adm/imsimport')) {
12004: $output .= '<input type="hidden" name="phase" value="three" />'."\n";
12005: } elsif ($actionurl eq '/adm/portfolio' || $actionurl eq '/adm/coursegrp_portfolio') {
12006: $output .= '<input type="hidden" name="action" value="upload_embedded" />';
1.1071 raeburn 12007: } elsif ($actionurl eq '/adm/dependencies') {
12008: $output .= '<input type="hidden" name="action" value="process_changes" />';
1.987 raeburn 12009: }
1.1123 raeburn 12010: $output .= '<input type ="submit" value="'.$buttontext.'" />'."\n".'</form>'."\n";
1.987 raeburn 12011: } elsif ($numpathchg) {
12012: my %pathchange = ();
12013: $output .= &modify_html_form('pathchange',$actionurl,$state,\%pathchange,$pathchange_output);
12014: if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
12015: $output .= '<p>'.&mt('or').'</p>';
1.1123 raeburn 12016: }
1.987 raeburn 12017: }
1.1071 raeburn 12018: return ($output,$counter,$numpathchg);
1.987 raeburn 12019: }
12020:
1.1147 raeburn 12021: =pod
12022:
12023: =item * clean_path($name)
12024:
12025: Performs clean-up of directories, subdirectories and filename in an
12026: embedded object, referenced in an HTML file which is being uploaded
12027: to a course or portfolio, where
12028: "Upload embedded images/multimedia files if HTML file" checkbox was
12029: checked.
12030:
12031: Clean-up is similar to replacements in lonnet::clean_filename()
12032: except each / between sub-directory and next level is preserved.
12033:
12034: =cut
12035:
12036: sub clean_path {
12037: my ($embed_file) = @_;
12038: $embed_file =~s{^/+}{};
12039: my @contents;
12040: if ($embed_file =~ m{/}) {
12041: @contents = split(/\//,$embed_file);
12042: } else {
12043: @contents = ($embed_file);
12044: }
12045: my $lastidx = scalar(@contents)-1;
12046: for (my $i=0; $i<=$lastidx; $i++) {
12047: $contents[$i]=~s{\\}{/}g;
12048: $contents[$i]=~s/\s+/\_/g;
12049: $contents[$i]=~s{[^/\w\.\-]}{}g;
12050: if ($i == $lastidx) {
12051: $contents[$i]=~s/\.(\d+)(?=\.)/_$1/g;
12052: }
12053: }
12054: if ($lastidx > 0) {
12055: return join('/',@contents);
12056: } else {
12057: return $contents[0];
12058: }
12059: }
12060:
1.987 raeburn 12061: sub embedded_file_element {
1.1071 raeburn 12062: my ($context,$num,$embed_file,$mapping,$allfiles,$codebase,$type) = @_;
1.987 raeburn 12063: return unless ((ref($mapping) eq 'HASH') && (ref($allfiles) eq 'HASH') &&
12064: (ref($codebase) eq 'HASH'));
12065: my $output;
1.1071 raeburn 12066: if (($context eq 'upload_embedded') && ($type ne 'delete')) {
1.987 raeburn 12067: $output = '<input name="embedded_item_'.$num.'" type="file" value="" />'."\n";
12068: }
12069: $output .= '<input name="embedded_orig_'.$num.'" type="hidden" value="'.
12070: &escape($embed_file).'" />';
12071: unless (($context eq 'upload_embedded') &&
12072: ($mapping->{$embed_file} eq $embed_file)) {
12073: $output .='
12074: <input name="embedded_ref_'.$num.'" type="hidden" value="'.&escape($mapping->{$embed_file}).'" />';
12075: }
12076: my $attrib;
12077: if (ref($allfiles->{$mapping->{$embed_file}}) eq 'ARRAY') {
12078: $attrib = &escape(join(':',@{$allfiles->{$mapping->{$embed_file}}}));
12079: }
12080: $output .=
12081: "\n\t\t".
12082: '<input name="embedded_attrib_'.$num.'" type="hidden" value="'.
12083: $attrib.'" />';
12084: if (exists($codebase->{$mapping->{$embed_file}})) {
12085: $output .=
12086: "\n\t\t".
12087: '<input name="codebase_'.$num.'" type="hidden" value="'.
12088: &escape($codebase->{$mapping->{$embed_file}}).'" />';
1.984 raeburn 12089: }
1.987 raeburn 12090: return $output;
1.660 raeburn 12091: }
12092:
1.1071 raeburn 12093: sub get_dependency_details {
12094: my ($currfile,$currsubfile,$embed_file) = @_;
12095: my ($size,$mtime,$showsize,$showmtime);
12096: if ((ref($currfile) eq 'HASH') && (ref($currsubfile))) {
12097: if ($embed_file =~ m{/}) {
12098: my ($path,$fname) = split(/\//,$embed_file);
12099: if (ref($currsubfile->{$path}{$fname}) eq 'ARRAY') {
12100: ($size,$mtime) = @{$currsubfile->{$path}{$fname}};
12101: }
12102: } else {
12103: if (ref($currfile->{$embed_file}) eq 'ARRAY') {
12104: ($size,$mtime) = @{$currfile->{$embed_file}};
12105: }
12106: }
12107: $showsize = $size/1024.0;
12108: $showsize = sprintf("%.1f",$showsize);
12109: if ($mtime > 0) {
12110: $showmtime = &Apache::lonlocal::locallocaltime($mtime);
12111: }
12112: }
12113: return ($showsize,$showmtime);
12114: }
12115:
12116: sub ask_embedded_js {
12117: return <<"END";
12118: <script type="text/javascript"">
12119: // <![CDATA[
12120: function toggleBrowse(counter) {
12121: var chkboxid = document.getElementById('mod_upload_dep_'+counter);
12122: var fileid = document.getElementById('embedded_item_'+counter);
12123: var uploaddivid = document.getElementById('moduploaddep_'+counter);
12124: if (chkboxid.checked == true) {
12125: uploaddivid.style.display='block';
12126: } else {
12127: uploaddivid.style.display='none';
12128: fileid.value = '';
12129: }
12130: }
12131: // ]]>
12132: </script>
12133:
12134: END
12135: }
12136:
1.661 raeburn 12137: sub upload_embedded {
12138: my ($context,$dirpath,$uname,$udom,$dir_root,$url_root,$group,$disk_quota,
1.987 raeburn 12139: $current_disk_usage,$hiddenstate,$actionurl) = @_;
12140: my (%pathchange,$output,$modifyform,$footer,$returnflag);
1.661 raeburn 12141: for (my $i=0; $i<$env{'form.number_embedded_items'}; $i++) {
12142: next if (!exists($env{'form.embedded_item_'.$i.'.filename'}));
12143: my $orig_uploaded_filename =
12144: $env{'form.embedded_item_'.$i.'.filename'};
1.987 raeburn 12145: foreach my $type ('orig','ref','attrib','codebase') {
12146: if ($env{'form.embedded_'.$type.'_'.$i} ne '') {
12147: $env{'form.embedded_'.$type.'_'.$i} =
12148: &unescape($env{'form.embedded_'.$type.'_'.$i});
12149: }
12150: }
1.661 raeburn 12151: my ($path,$fname) =
12152: ($env{'form.embedded_orig_'.$i} =~ m{(.*/)([^/]*)});
12153: # no path, whole string is fname
12154: if (!$fname) { $fname = $env{'form.embedded_orig_'.$i} };
12155: $fname = &Apache::lonnet::clean_filename($fname);
12156: # See if there is anything left
12157: next if ($fname eq '');
12158:
12159: # Check if file already exists as a file or directory.
12160: my ($state,$msg);
12161: if ($context eq 'portfolio') {
12162: my $port_path = $dirpath;
12163: if ($group ne '') {
12164: $port_path = "groups/$group/$port_path";
12165: }
1.987 raeburn 12166: ($state,$msg) = &check_for_upload($env{'form.currentpath'}.$path,
12167: $fname,$group,'embedded_item_'.$i,
1.661 raeburn 12168: $dir_root,$port_path,$disk_quota,
12169: $current_disk_usage,$uname,$udom);
12170: if ($state eq 'will_exceed_quota'
1.984 raeburn 12171: || $state eq 'file_locked') {
1.661 raeburn 12172: $output .= $msg;
12173: next;
12174: }
12175: } elsif (($context eq 'author') || ($context eq 'testbank')) {
12176: ($state,$msg) = &check_for_existing($path,$fname,'embedded_item_'.$i);
12177: if ($state eq 'exists') {
12178: $output .= $msg;
12179: next;
12180: }
12181: }
12182: # Check if extension is valid
12183: if (($fname =~ /\.(\w+)$/) &&
12184: (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
1.1155 bisitz 12185: $output .= &mt('Invalid file extension ([_1]) - reserved for internal use.',$1)
12186: .' '.&mt('Rename the file with a different extension and re-upload.').'<br />';
1.661 raeburn 12187: next;
12188: } elsif (($fname =~ /\.(\w+)$/) &&
12189: (!defined(&Apache::loncommon::fileembstyle($1)))) {
1.987 raeburn 12190: $output .= &mt('Unrecognized file extension ([_1]) - rename the file with a proper extension and re-upload.',$1).'<br />';
1.661 raeburn 12191: next;
12192: } elsif ($fname=~/\.(\d+)\.(\w+)$/) {
1.1120 bisitz 12193: $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 12194: next;
12195: }
12196: $env{'form.embedded_item_'.$i.'.filename'}=$fname;
1.1123 raeburn 12197: my $subdir = $path;
12198: $subdir =~ s{/+$}{};
1.661 raeburn 12199: if ($context eq 'portfolio') {
1.984 raeburn 12200: my $result;
12201: if ($state eq 'existingfile') {
12202: $result=
12203: &Apache::lonnet::userfileupload('embedded_item_'.$i,'existingfile',
1.1123 raeburn 12204: $dirpath.$env{'form.currentpath'}.$subdir);
1.661 raeburn 12205: } else {
1.984 raeburn 12206: $result=
12207: &Apache::lonnet::userfileupload('embedded_item_'.$i,'',
1.987 raeburn 12208: $dirpath.
1.1123 raeburn 12209: $env{'form.currentpath'}.$subdir);
1.984 raeburn 12210: if ($result !~ m|^/uploaded/|) {
12211: $output .= '<span class="LC_error">'
12212: .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
12213: ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
12214: .'</span><br />';
12215: next;
12216: } else {
1.987 raeburn 12217: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
12218: $path.$fname.'</span>').'<br />';
1.984 raeburn 12219: }
1.661 raeburn 12220: }
1.1123 raeburn 12221: } elsif (($context eq 'coursedoc') || ($context eq 'syllabus')) {
1.1126 raeburn 12222: my $extendedsubdir = $dirpath.'/'.$subdir;
12223: $extendedsubdir =~ s{/+$}{};
1.987 raeburn 12224: my $result =
1.1126 raeburn 12225: &Apache::lonnet::userfileupload('embedded_item_'.$i,$context,$extendedsubdir);
1.987 raeburn 12226: if ($result !~ m|^/uploaded/|) {
12227: $output .= '<span class="LC_error">'
12228: .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
12229: ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
12230: .'</span><br />';
12231: next;
12232: } else {
12233: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
12234: $path.$fname.'</span>').'<br />';
1.1125 raeburn 12235: if ($context eq 'syllabus') {
12236: &Apache::lonnet::make_public_indefinitely($result);
12237: }
1.987 raeburn 12238: }
1.661 raeburn 12239: } else {
12240: # Save the file
12241: my $target = $env{'form.embedded_item_'.$i};
12242: my $fullpath = $dir_root.$dirpath.'/'.$path;
12243: my $dest = $fullpath.$fname;
12244: my $url = $url_root.$dirpath.'/'.$path.$fname;
1.1027 raeburn 12245: my @parts=split(/\//,"$dirpath/$path");
1.661 raeburn 12246: my $count;
12247: my $filepath = $dir_root;
1.1027 raeburn 12248: foreach my $subdir (@parts) {
12249: $filepath .= "/$subdir";
12250: if (!-e $filepath) {
1.661 raeburn 12251: mkdir($filepath,0770);
12252: }
12253: }
12254: my $fh;
12255: if (!open($fh,'>'.$dest)) {
12256: &Apache::lonnet::logthis('Failed to create '.$dest);
12257: $output .= '<span class="LC_error">'.
1.1071 raeburn 12258: &mt('An error occurred while trying to upload [_1] for embedded element [_2].',
12259: $orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
1.661 raeburn 12260: '</span><br />';
12261: } else {
12262: if (!print $fh $env{'form.embedded_item_'.$i}) {
12263: &Apache::lonnet::logthis('Failed to write to '.$dest);
12264: $output .= '<span class="LC_error">'.
1.1071 raeburn 12265: &mt('An error occurred while writing the file [_1] for embedded element [_2].',
12266: $orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
1.661 raeburn 12267: '</span><br />';
12268: } else {
1.987 raeburn 12269: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
12270: $url.'</span>').'<br />';
12271: unless ($context eq 'testbank') {
12272: $footer .= &mt('View embedded file: [_1]',
12273: '<a href="'.$url.'">'.$fname.'</a>').'<br />';
12274: }
12275: }
12276: close($fh);
12277: }
12278: }
12279: if ($env{'form.embedded_ref_'.$i}) {
12280: $pathchange{$i} = 1;
12281: }
12282: }
12283: if ($output) {
12284: $output = '<p>'.$output.'</p>';
12285: }
12286: $output .= &modify_html_form('upload_embedded',$actionurl,$hiddenstate,\%pathchange);
12287: $returnflag = 'ok';
1.1071 raeburn 12288: my $numpathchgs = scalar(keys(%pathchange));
12289: if ($numpathchgs > 0) {
1.987 raeburn 12290: if ($context eq 'portfolio') {
12291: $output .= '<p>'.&mt('or').'</p>';
12292: } elsif ($context eq 'testbank') {
1.1071 raeburn 12293: $output .= '<p>'.&mt('Or [_1]continue[_2] the testbank import without modifying the reference(s).',
12294: '<a href="javascript:document.testbankForm.submit();">','</a>').'</p>';
1.987 raeburn 12295: $returnflag = 'modify_orightml';
12296: }
12297: }
1.1071 raeburn 12298: return ($output.$footer,$returnflag,$numpathchgs);
1.987 raeburn 12299: }
12300:
12301: sub modify_html_form {
12302: my ($context,$actionurl,$hiddenstate,$pathchange,$pathchgtable) = @_;
12303: my $end = 0;
12304: my $modifyform;
12305: if ($context eq 'upload_embedded') {
12306: return unless (ref($pathchange) eq 'HASH');
12307: if ($env{'form.number_embedded_items'}) {
12308: $end += $env{'form.number_embedded_items'};
12309: }
12310: if ($env{'form.number_pathchange_items'}) {
12311: $end += $env{'form.number_pathchange_items'};
12312: }
12313: if ($end) {
12314: for (my $i=0; $i<$end; $i++) {
12315: if ($i < $env{'form.number_embedded_items'}) {
12316: next unless($pathchange->{$i});
12317: }
12318: $modifyform .=
12319: &start_data_table_row().
12320: '<td><input type ="checkbox" name="namechange" value="'.$i.'" '.
12321: 'checked="checked" /></td>'.
12322: '<td>'.$env{'form.embedded_ref_'.$i}.
12323: '<input type="hidden" name="embedded_ref_'.$i.'" value="'.
12324: &escape($env{'form.embedded_ref_'.$i}).'" />'.
12325: '<input type="hidden" name="embedded_codebase_'.$i.'" value="'.
12326: &escape($env{'form.embedded_codebase_'.$i}).'" />'.
12327: '<input type="hidden" name="embedded_attrib_'.$i.'" value="'.
12328: &escape($env{'form.embedded_attrib_'.$i}).'" /></td>'.
12329: '<td>'.$env{'form.embedded_orig_'.$i}.
12330: '<input type="hidden" name="embedded_orig_'.$i.'" value="'.
12331: &escape($env{'form.embedded_orig_'.$i}).'" /></td>'.
12332: &end_data_table_row();
1.1071 raeburn 12333: }
1.987 raeburn 12334: }
12335: } else {
12336: $modifyform = $pathchgtable;
12337: if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
12338: $hiddenstate .= '<input type="hidden" name="phase" value="four" />';
12339: } elsif (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
12340: $hiddenstate .= '<input type="hidden" name="action" value="modify_orightml" />';
12341: }
12342: }
12343: if ($modifyform) {
1.1071 raeburn 12344: if ($actionurl eq '/adm/dependencies') {
12345: $hiddenstate .= '<input type="hidden" name="action" value="modifyhrefs" />';
12346: }
1.987 raeburn 12347: return '<h3>'.&mt('Changes in content of HTML file required').'</h3>'."\n".
12348: '<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".
12349: '<li>'.&mt('For consistency between the reference(s) and the location of the corresponding stored file within LON-CAPA.').'</li>'."\n".
12350: '<li>'.&mt('To change absolute paths to relative paths, or replace directory traversal via "../" within the original reference.').'</li>'."\n".
12351: '</ol></p>'."\n".'<p>'.
12352: &mt('LON-CAPA can make the required changes to your HTML file.').'</p>'."\n".
12353: '<form method="post" name="refchanger" action="'.$actionurl.'">'.
12354: &start_data_table()."\n".
12355: &start_data_table_header_row().
12356: '<th>'.&mt('Change?').'</th>'.
12357: '<th>'.&mt('Current reference').'</th>'.
12358: '<th>'.&mt('Required reference').'</th>'.
12359: &end_data_table_header_row()."\n".
12360: $modifyform.
12361: &end_data_table().'<br />'."\n".$hiddenstate.
12362: '<input type="submit" name="pathchanges" value="'.&mt('Modify HTML file').'" />'.
12363: '</form>'."\n";
12364: }
12365: return;
12366: }
12367:
12368: sub modify_html_refs {
1.1123 raeburn 12369: my ($context,$dirpath,$uname,$udom,$dir_root,$url) = @_;
1.987 raeburn 12370: my $container;
12371: if ($context eq 'portfolio') {
12372: $container = $env{'form.container'};
12373: } elsif ($context eq 'coursedoc') {
12374: $container = $env{'form.primaryurl'};
1.1071 raeburn 12375: } elsif ($context eq 'manage_dependencies') {
12376: (undef,undef,$container) = &Apache::lonnet::decode_symb($env{'form.symb'});
12377: $container = "/$container";
1.1123 raeburn 12378: } elsif ($context eq 'syllabus') {
12379: $container = $url;
1.987 raeburn 12380: } else {
1.1027 raeburn 12381: $container = $Apache::lonnet::perlvar{'lonDocRoot'}.$env{'form.filename'};
1.987 raeburn 12382: }
12383: my (%allfiles,%codebase,$output,$content);
12384: my @changes = &get_env_multiple('form.namechange');
1.1126 raeburn 12385: unless ((@changes > 0) || ($context eq 'syllabus')) {
1.1071 raeburn 12386: if (wantarray) {
12387: return ('',0,0);
12388: } else {
12389: return;
12390: }
12391: }
12392: if (($context eq 'portfolio') || ($context eq 'coursedoc') ||
1.1123 raeburn 12393: ($context eq 'manage_dependencies') || ($context eq 'syllabus')) {
1.1071 raeburn 12394: unless ($container =~ m{^/uploaded/\Q$udom\E/\Q$uname\E/}) {
12395: if (wantarray) {
12396: return ('',0,0);
12397: } else {
12398: return;
12399: }
12400: }
1.987 raeburn 12401: $content = &Apache::lonnet::getfile($container);
1.1071 raeburn 12402: if ($content eq '-1') {
12403: if (wantarray) {
12404: return ('',0,0);
12405: } else {
12406: return;
12407: }
12408: }
1.987 raeburn 12409: } else {
1.1071 raeburn 12410: unless ($container =~ /^\Q$dir_root\E/) {
12411: if (wantarray) {
12412: return ('',0,0);
12413: } else {
12414: return;
12415: }
12416: }
1.1317 raeburn 12417: if (open(my $fh,'<',$container)) {
1.987 raeburn 12418: $content = join('', <$fh>);
12419: close($fh);
12420: } else {
1.1071 raeburn 12421: if (wantarray) {
12422: return ('',0,0);
12423: } else {
12424: return;
12425: }
1.987 raeburn 12426: }
12427: }
12428: my ($count,$codebasecount) = (0,0);
12429: my $mm = new File::MMagic;
12430: my $mime_type = $mm->checktype_contents($content);
12431: if ($mime_type eq 'text/html') {
12432: my $parse_result =
12433: &Apache::lonnet::extract_embedded_items($container,\%allfiles,
12434: \%codebase,\$content);
12435: if ($parse_result eq 'ok') {
12436: foreach my $i (@changes) {
12437: my $orig = &unescape($env{'form.embedded_orig_'.$i});
12438: my $ref = &unescape($env{'form.embedded_ref_'.$i});
12439: if ($allfiles{$ref}) {
12440: my $newname = $orig;
12441: my ($attrib_regexp,$codebase);
1.1006 raeburn 12442: $attrib_regexp = &unescape($env{'form.embedded_attrib_'.$i});
1.987 raeburn 12443: if ($attrib_regexp =~ /:/) {
12444: $attrib_regexp =~ s/\:/|/g;
12445: }
12446: if ($content =~ m{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}) {
12447: my $numchg = ($content =~ s{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}{$1$newname$2}gi);
12448: $count += $numchg;
1.1123 raeburn 12449: $allfiles{$newname} = $allfiles{$ref};
1.1148 raeburn 12450: delete($allfiles{$ref});
1.987 raeburn 12451: }
12452: if ($env{'form.embedded_codebase_'.$i} ne '') {
1.1006 raeburn 12453: $codebase = &unescape($env{'form.embedded_codebase_'.$i});
1.987 raeburn 12454: my $numchg = ($content =~ s/(codebase\s*=\s*["']?)\Q$codebase\E(["']?)/$1.$2/i); #' stupid emacs
12455: $codebasecount ++;
12456: }
12457: }
12458: }
1.1123 raeburn 12459: my $skiprewrites;
1.987 raeburn 12460: if ($count || $codebasecount) {
12461: my $saveresult;
1.1071 raeburn 12462: if (($context eq 'portfolio') || ($context eq 'coursedoc') ||
1.1123 raeburn 12463: ($context eq 'manage_dependencies') || ($context eq 'syllabus')) {
1.987 raeburn 12464: my $url = &Apache::lonnet::store_edited_file($container,$content,$udom,$uname,\$saveresult);
12465: if ($url eq $container) {
12466: my ($fname) = ($container =~ m{/([^/]+)$});
12467: $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
12468: $count,'<span class="LC_filename">'.
1.1071 raeburn 12469: $fname.'</span>').'</p>';
1.987 raeburn 12470: } else {
12471: $output = '<p class="LC_error">'.
12472: &mt('Error: update failed for: [_1].',
12473: '<span class="LC_filename">'.
12474: $container.'</span>').'</p>';
12475: }
1.1123 raeburn 12476: if ($context eq 'syllabus') {
12477: unless ($saveresult eq 'ok') {
12478: $skiprewrites = 1;
12479: }
12480: }
1.987 raeburn 12481: } else {
1.1317 raeburn 12482: if (open(my $fh,'>',$container)) {
1.987 raeburn 12483: print $fh $content;
12484: close($fh);
12485: $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
12486: $count,'<span class="LC_filename">'.
12487: $container.'</span>').'</p>';
1.661 raeburn 12488: } else {
1.987 raeburn 12489: $output = '<p class="LC_error">'.
12490: &mt('Error: could not update [_1].',
12491: '<span class="LC_filename">'.
12492: $container.'</span>').'</p>';
1.661 raeburn 12493: }
12494: }
12495: }
1.1123 raeburn 12496: if (($context eq 'syllabus') && (!$skiprewrites)) {
12497: my ($actionurl,$state);
12498: $actionurl = "/public/$udom/$uname/syllabus";
12499: my ($ignore,$num,$numpathchanges,$existing,$mapping) =
12500: &ask_for_embedded_content($actionurl,$state,\%allfiles,
12501: \%codebase,
12502: {'context' => 'rewrites',
12503: 'ignore_remote_references' => 1,});
12504: if (ref($mapping) eq 'HASH') {
12505: my $rewrites = 0;
12506: foreach my $key (keys(%{$mapping})) {
12507: next if ($key =~ m{^https?://});
12508: my $ref = $mapping->{$key};
12509: my $newname = "/uploaded/$udom/$uname/portfolio/syllabus/$key";
12510: my $attrib;
12511: if (ref($allfiles{$mapping->{$key}}) eq 'ARRAY') {
12512: $attrib = join('|',@{$allfiles{$mapping->{$key}}});
12513: }
12514: if ($content =~ m{($attrib\s*=\s*['"]?)\Q$ref\E(['"]?)}) {
12515: my $numchg = ($content =~ s{($attrib\s*=\s*['"]?)\Q$ref\E(['"]?)}{$1$newname$2}gi);
12516: $rewrites += $numchg;
12517: }
12518: }
12519: if ($rewrites) {
12520: my $saveresult;
12521: my $url = &Apache::lonnet::store_edited_file($container,$content,$udom,$uname,\$saveresult);
12522: if ($url eq $container) {
12523: my ($fname) = ($container =~ m{/([^/]+)$});
12524: $output .= '<p>'.&mt('Rewrote [quant,_1,link] as [quant,_1,absolute link] in [_2].',
12525: $count,'<span class="LC_filename">'.
12526: $fname.'</span>').'</p>';
12527: } else {
12528: $output .= '<p class="LC_error">'.
12529: &mt('Error: could not update links in [_1].',
12530: '<span class="LC_filename">'.
12531: $container.'</span>').'</p>';
12532:
12533: }
12534: }
12535: }
12536: }
1.987 raeburn 12537: } else {
12538: &logthis('Failed to parse '.$container.
12539: ' to modify references: '.$parse_result);
1.661 raeburn 12540: }
12541: }
1.1071 raeburn 12542: if (wantarray) {
12543: return ($output,$count,$codebasecount);
12544: } else {
12545: return $output;
12546: }
1.661 raeburn 12547: }
12548:
12549: sub check_for_existing {
12550: my ($path,$fname,$element) = @_;
12551: my ($state,$msg);
12552: if (-d $path.'/'.$fname) {
12553: $state = 'exists';
12554: $msg = &mt('Unable to upload [_1]. A directory by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
12555: } elsif (-e $path.'/'.$fname) {
12556: $state = 'exists';
12557: $msg = &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
12558: }
12559: if ($state eq 'exists') {
12560: $msg = '<span class="LC_error">'.$msg.'</span><br />';
12561: }
12562: return ($state,$msg);
12563: }
12564:
12565: sub check_for_upload {
12566: my ($path,$fname,$group,$element,$portfolio_root,$port_path,
12567: $disk_quota,$current_disk_usage,$uname,$udom) = @_;
1.985 raeburn 12568: my $filesize = length($env{'form.'.$element});
12569: if (!$filesize) {
12570: my $msg = '<span class="LC_error">'.
12571: &mt('Unable to upload [_1]. (size = [_2] bytes)',
12572: '<span class="LC_filename">'.$fname.'</span>',
12573: $filesize).'<br />'.
1.1007 raeburn 12574: &mt('Either the file you attempted to upload was empty, or your web browser was unable to read its contents.').'<br />'.
1.985 raeburn 12575: '</span>';
12576: return ('zero_bytes',$msg);
12577: }
12578: $filesize = $filesize/1000; #express in k (1024?)
1.661 raeburn 12579: my $getpropath = 1;
1.1021 raeburn 12580: my ($dirlistref,$listerror) =
12581: &Apache::lonnet::dirlist($portfolio_root.$path,$udom,$uname,$getpropath);
1.661 raeburn 12582: my $found_file = 0;
12583: my $locked_file = 0;
1.991 raeburn 12584: my @lockers;
12585: my $navmap;
12586: if ($env{'request.course.id'}) {
12587: $navmap = Apache::lonnavmaps::navmap->new();
12588: }
1.1021 raeburn 12589: if (ref($dirlistref) eq 'ARRAY') {
12590: foreach my $line (@{$dirlistref}) {
12591: my ($file_name,$rest)=split(/\&/,$line,2);
12592: if ($file_name eq $fname){
12593: $file_name = $path.$file_name;
12594: if ($group ne '') {
12595: $file_name = $group.$file_name;
12596: }
12597: $found_file = 1;
12598: if (&Apache::lonnet::is_locked($file_name,$udom,$uname,\@lockers) eq 'true') {
12599: foreach my $lock (@lockers) {
12600: if (ref($lock) eq 'ARRAY') {
12601: my ($symb,$crsid) = @{$lock};
12602: if ($crsid eq $env{'request.course.id'}) {
12603: if (ref($navmap)) {
12604: my $res = $navmap->getBySymb($symb);
12605: foreach my $part (@{$res->parts()}) {
12606: my ($slot_status,$slot_time,$slot_name)=$res->check_for_slot($part);
12607: unless (($slot_status == $res->RESERVED) ||
12608: ($slot_status == $res->RESERVED_LOCATION)) {
12609: $locked_file = 1;
12610: }
1.991 raeburn 12611: }
1.1021 raeburn 12612: } else {
12613: $locked_file = 1;
1.991 raeburn 12614: }
12615: } else {
12616: $locked_file = 1;
12617: }
12618: }
1.1021 raeburn 12619: }
12620: } else {
12621: my @info = split(/\&/,$rest);
12622: my $currsize = $info[6]/1000;
12623: if ($currsize < $filesize) {
12624: my $extra = $filesize - $currsize;
12625: if (($current_disk_usage + $extra) > $disk_quota) {
1.1179 bisitz 12626: my $msg = '<p class="LC_warning">'.
1.1021 raeburn 12627: &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 12628: '<span class="LC_filename">'.$fname.'</span>',$filesize,$currsize).'</p>'.
12629: '<p>'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',
12630: $disk_quota,$current_disk_usage).'</p>';
1.1021 raeburn 12631: return ('will_exceed_quota',$msg);
12632: }
1.984 raeburn 12633: }
12634: }
1.661 raeburn 12635: }
12636: }
12637: }
12638: if (($current_disk_usage + $filesize) > $disk_quota){
1.1179 bisitz 12639: my $msg = '<p class="LC_warning">'.
12640: &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.','<span class="LC_filename">'.$fname.'</span>',$filesize).'</p>'.
1.1184 raeburn 12641: '<p>'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',$disk_quota,$current_disk_usage).'</p>';
1.661 raeburn 12642: return ('will_exceed_quota',$msg);
12643: } elsif ($found_file) {
12644: if ($locked_file) {
1.1179 bisitz 12645: my $msg = '<p class="LC_warning">';
1.661 raeburn 12646: $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 12647: $msg .= '</p>';
1.661 raeburn 12648: $msg .= &mt('You will be able to rename or delete existing [_1] after a grade has been assigned.','<span class="LC_filename">'.$fname.'</span>');
12649: return ('file_locked',$msg);
12650: } else {
1.1179 bisitz 12651: my $msg = '<p class="LC_error">';
1.984 raeburn 12652: $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 12653: $msg .= '</p>';
1.984 raeburn 12654: return ('existingfile',$msg);
1.661 raeburn 12655: }
12656: }
12657: }
12658:
1.987 raeburn 12659: sub check_for_traversal {
12660: my ($path,$url,$toplevel) = @_;
12661: my @parts=split(/\//,$path);
12662: my $cleanpath;
12663: my $fullpath = $url;
12664: for (my $i=0;$i<@parts;$i++) {
12665: next if ($parts[$i] eq '.');
12666: if ($parts[$i] eq '..') {
12667: $fullpath =~ s{([^/]+/)$}{};
12668: } else {
12669: $fullpath .= $parts[$i].'/';
12670: }
12671: }
12672: if ($fullpath =~ /^\Q$url\E(.*)$/) {
12673: $cleanpath = $1;
12674: } elsif ($fullpath =~ /^\Q$toplevel\E(.*)$/) {
12675: my $curr_toprel = $1;
12676: my @parts = split(/\//,$curr_toprel);
12677: my ($url_toprel) = ($url =~ /^\Q$toplevel\E(.*)$/);
12678: my @urlparts = split(/\//,$url_toprel);
12679: my $doubledots;
12680: my $startdiff = -1;
12681: for (my $i=0; $i<@urlparts; $i++) {
12682: if ($startdiff == -1) {
12683: unless ($urlparts[$i] eq $parts[$i]) {
12684: $startdiff = $i;
12685: $doubledots .= '../';
12686: }
12687: } else {
12688: $doubledots .= '../';
12689: }
12690: }
12691: if ($startdiff > -1) {
12692: $cleanpath = $doubledots;
12693: for (my $i=$startdiff; $i<@parts; $i++) {
12694: $cleanpath .= $parts[$i].'/';
12695: }
12696: }
12697: }
12698: $cleanpath =~ s{(/)$}{};
12699: return $cleanpath;
12700: }
1.31 albertel 12701:
1.1053 raeburn 12702: sub is_archive_file {
12703: my ($mimetype) = @_;
12704: if (($mimetype eq 'application/octet-stream') ||
12705: ($mimetype eq 'application/x-stuffit') ||
12706: ($mimetype =~ m{^application/(x\-)?(compressed|tar|zip|tgz|gz|gtar|gzip|gunzip|bz|bz2|bzip2)})) {
12707: return 1;
12708: }
12709: return;
12710: }
12711:
12712: sub decompress_form {
1.1065 raeburn 12713: my ($mimetype,$archiveurl,$action,$noextract,$hiddenelements,$dirlist) = @_;
1.1053 raeburn 12714: my %lt = &Apache::lonlocal::texthash (
12715: this => 'This file is an archive file.',
1.1067 raeburn 12716: camt => 'This file is a Camtasia archive file.',
1.1065 raeburn 12717: itsc => 'Its contents are as follows:',
1.1053 raeburn 12718: youm => 'You may wish to extract its contents.',
12719: extr => 'Extract contents',
1.1067 raeburn 12720: auto => 'LON-CAPA can process the files automatically, or you can decide how each should be handled.',
12721: proa => 'Process automatically?',
1.1053 raeburn 12722: yes => 'Yes',
12723: no => 'No',
1.1067 raeburn 12724: fold => 'Title for folder containing movie',
12725: movi => 'Title for page containing embedded movie',
1.1053 raeburn 12726: );
1.1065 raeburn 12727: my $fileloc = &Apache::lonnet::filelocation(undef,$archiveurl);
1.1067 raeburn 12728: my ($is_camtasia,$topdir,%toplevel,@paths);
1.1065 raeburn 12729: my $info = &list_archive_contents($fileloc,\@paths);
12730: if (@paths) {
12731: foreach my $path (@paths) {
12732: $path =~ s{^/}{};
1.1067 raeburn 12733: if ($path =~ m{^([^/]+)/$}) {
12734: $topdir = $1;
12735: }
1.1065 raeburn 12736: if ($path =~ m{^([^/]+)/}) {
12737: $toplevel{$1} = $path;
12738: } else {
12739: $toplevel{$path} = $path;
12740: }
12741: }
12742: }
1.1067 raeburn 12743: if ($mimetype =~ m{^application/(x\-)?(compressed|zip)}) {
1.1164 raeburn 12744: my @camtasia6 = ("$topdir/","$topdir/index.html",
1.1067 raeburn 12745: "$topdir/media/",
12746: "$topdir/media/$topdir.mp4",
12747: "$topdir/media/FirstFrame.png",
12748: "$topdir/media/player.swf",
12749: "$topdir/media/swfobject.js",
12750: "$topdir/media/expressInstall.swf");
1.1197 raeburn 12751: my @camtasia8_1 = ("$topdir/","$topdir/$topdir.html",
1.1164 raeburn 12752: "$topdir/$topdir.mp4",
12753: "$topdir/$topdir\_config.xml",
12754: "$topdir/$topdir\_controller.swf",
12755: "$topdir/$topdir\_embed.css",
12756: "$topdir/$topdir\_First_Frame.png",
12757: "$topdir/$topdir\_player.html",
12758: "$topdir/$topdir\_Thumbnails.png",
12759: "$topdir/playerProductInstall.swf",
12760: "$topdir/scripts/",
12761: "$topdir/scripts/config_xml.js",
12762: "$topdir/scripts/handlebars.js",
12763: "$topdir/scripts/jquery-1.7.1.min.js",
12764: "$topdir/scripts/jquery-ui-1.8.15.custom.min.js",
12765: "$topdir/scripts/modernizr.js",
12766: "$topdir/scripts/player-min.js",
12767: "$topdir/scripts/swfobject.js",
12768: "$topdir/skins/",
12769: "$topdir/skins/configuration_express.xml",
12770: "$topdir/skins/express_show/",
12771: "$topdir/skins/express_show/player-min.css",
12772: "$topdir/skins/express_show/spritesheet.png");
1.1197 raeburn 12773: my @camtasia8_4 = ("$topdir/","$topdir/$topdir.html",
12774: "$topdir/$topdir.mp4",
12775: "$topdir/$topdir\_config.xml",
12776: "$topdir/$topdir\_controller.swf",
12777: "$topdir/$topdir\_embed.css",
12778: "$topdir/$topdir\_First_Frame.png",
12779: "$topdir/$topdir\_player.html",
12780: "$topdir/$topdir\_Thumbnails.png",
12781: "$topdir/playerProductInstall.swf",
12782: "$topdir/scripts/",
12783: "$topdir/scripts/config_xml.js",
12784: "$topdir/scripts/techsmith-smart-player.min.js",
12785: "$topdir/skins/",
12786: "$topdir/skins/configuration_express.xml",
12787: "$topdir/skins/express_show/",
12788: "$topdir/skins/express_show/spritesheet.min.css",
12789: "$topdir/skins/express_show/spritesheet.png",
12790: "$topdir/skins/express_show/techsmith-smart-player.min.css");
1.1164 raeburn 12791: my @diffs = &compare_arrays(\@paths,\@camtasia6);
1.1067 raeburn 12792: if (@diffs == 0) {
1.1164 raeburn 12793: $is_camtasia = 6;
12794: } else {
1.1197 raeburn 12795: @diffs = &compare_arrays(\@paths,\@camtasia8_1);
1.1164 raeburn 12796: if (@diffs == 0) {
12797: $is_camtasia = 8;
1.1197 raeburn 12798: } else {
12799: @diffs = &compare_arrays(\@paths,\@camtasia8_4);
12800: if (@diffs == 0) {
12801: $is_camtasia = 8;
12802: }
1.1164 raeburn 12803: }
1.1067 raeburn 12804: }
12805: }
12806: my $output;
12807: if ($is_camtasia) {
12808: $output = <<"ENDCAM";
12809: <script type="text/javascript" language="Javascript">
12810: // <![CDATA[
12811:
12812: function camtasiaToggle() {
12813: for (var i=0; i<document.uploaded_decompress.autoextract_camtasia.length; i++) {
12814: if (document.uploaded_decompress.autoextract_camtasia[i].checked) {
1.1164 raeburn 12815: if (document.uploaded_decompress.autoextract_camtasia[i].value == $is_camtasia) {
1.1067 raeburn 12816: document.getElementById('camtasia_titles').style.display='block';
12817: } else {
12818: document.getElementById('camtasia_titles').style.display='none';
12819: }
12820: }
12821: }
12822: return;
12823: }
12824:
12825: // ]]>
12826: </script>
12827: <p>$lt{'camt'}</p>
12828: ENDCAM
1.1065 raeburn 12829: } else {
1.1067 raeburn 12830: $output = '<p>'.$lt{'this'};
12831: if ($info eq '') {
12832: $output .= ' '.$lt{'youm'}.'</p>'."\n";
12833: } else {
12834: $output .= ' '.$lt{'itsc'}.'</p>'."\n".
12835: '<div><pre>'.$info.'</pre></div>';
12836: }
1.1065 raeburn 12837: }
1.1067 raeburn 12838: $output .= '<form name="uploaded_decompress" action="'.$action.'" method="post">'."\n";
1.1065 raeburn 12839: my $duplicates;
12840: my $num = 0;
12841: if (ref($dirlist) eq 'ARRAY') {
12842: foreach my $item (@{$dirlist}) {
12843: if (ref($item) eq 'ARRAY') {
12844: if (exists($toplevel{$item->[0]})) {
12845: $duplicates .=
12846: &start_data_table_row().
12847: '<td><label><input type="radio" name="archive_overwrite_'.$num.'" '.
12848: 'value="0" checked="checked" />'.&mt('No').'</label>'.
12849: ' <label><input type="radio" name="archive_overwrite_'.$num.'" '.
12850: 'value="1" />'.&mt('Yes').'</label>'.
12851: '<input type="hidden" name="archive_overwrite_name_'.$num.'" value="'.$item->[0].'" /></td>'."\n".
12852: '<td>'.$item->[0].'</td>';
12853: if ($item->[2]) {
12854: $duplicates .= '<td>'.&mt('Directory').'</td>';
12855: } else {
12856: $duplicates .= '<td>'.&mt('File').'</td>';
12857: }
12858: $duplicates .= '<td>'.$item->[3].'</td>'.
12859: '<td>'.
12860: &Apache::lonlocal::locallocaltime($item->[4]).
12861: '</td>'.
12862: &end_data_table_row();
12863: $num ++;
12864: }
12865: }
12866: }
12867: }
12868: my $itemcount;
12869: if (@paths > 0) {
12870: $itemcount = scalar(@paths);
12871: } else {
12872: $itemcount = 1;
12873: }
1.1067 raeburn 12874: if ($is_camtasia) {
12875: $output .= $lt{'auto'}.'<br />'.
12876: '<span class="LC_nobreak">'.$lt{'proa'}.'<label>'.
1.1164 raeburn 12877: '<input type="radio" name="autoextract_camtasia" value="'.$is_camtasia.'" onclick="javascript:camtasiaToggle();" checked="checked" />'.
1.1067 raeburn 12878: $lt{'yes'}.'</label> <label>'.
12879: '<input type="radio" name="autoextract_camtasia" value="0" onclick="javascript:camtasiaToggle();" />'.
12880: $lt{'no'}.'</label></span><br />'.
12881: '<div id="camtasia_titles" style="display:block">'.
12882: &Apache::lonhtmlcommon::start_pick_box().
12883: &Apache::lonhtmlcommon::row_title($lt{'fold'}).
12884: '<input type="textbox" name="camtasia_foldername" value="'.$env{'form.comment'}.'" />'."\n".
12885: &Apache::lonhtmlcommon::row_closure().
12886: &Apache::lonhtmlcommon::row_title($lt{'movi'}).
12887: '<input type="textbox" name="camtasia_moviename" value="" />'."\n".
12888: &Apache::lonhtmlcommon::row_closure(1).
12889: &Apache::lonhtmlcommon::end_pick_box().
12890: '</div>';
12891: }
1.1065 raeburn 12892: $output .=
12893: '<input type="hidden" name="archive_overwrite_total" value="'.$num.'" />'.
1.1067 raeburn 12894: '<input type="hidden" name="archive_itemcount" value="'.$itemcount.'" />'.
12895: "\n";
1.1065 raeburn 12896: if ($duplicates ne '') {
12897: $output .= '<p><span class="LC_warning">'.
12898: &mt('Warning: decompression of the archive will overwrite the following items which already exist:').'</span><br />'.
12899: &start_data_table().
12900: &start_data_table_header_row().
12901: '<th>'.&mt('Overwrite?').'</th>'.
12902: '<th>'.&mt('Name').'</th>'.
12903: '<th>'.&mt('Type').'</th>'.
12904: '<th>'.&mt('Size').'</th>'.
12905: '<th>'.&mt('Last modified').'</th>'.
12906: &end_data_table_header_row().
12907: $duplicates.
12908: &end_data_table().
12909: '</p>';
12910: }
1.1067 raeburn 12911: $output .= '<input type="hidden" name="archiveurl" value="'.$archiveurl.'" />'."\n";
1.1053 raeburn 12912: if (ref($hiddenelements) eq 'HASH') {
12913: foreach my $hidden (sort(keys(%{$hiddenelements}))) {
12914: $output .= '<input type="hidden" name="'.$hidden.'" value="'.$hiddenelements->{$hidden}.'" />'."\n";
12915: }
12916: }
12917: $output .= <<"END";
1.1067 raeburn 12918: <br />
1.1053 raeburn 12919: <input type="submit" name="decompress" value="$lt{'extr'}" />
12920: </form>
12921: $noextract
12922: END
12923: return $output;
12924: }
12925:
1.1065 raeburn 12926: sub decompression_utility {
12927: my ($program) = @_;
12928: my @utilities = ('tar','gunzip','bunzip2','unzip');
12929: my $location;
12930: if (grep(/^\Q$program\E$/,@utilities)) {
12931: foreach my $dir ('/bin/','/usr/bin/','/usr/local/bin/','/sbin/',
12932: '/usr/sbin/') {
12933: if (-x $dir.$program) {
12934: $location = $dir.$program;
12935: last;
12936: }
12937: }
12938: }
12939: return $location;
12940: }
12941:
12942: sub list_archive_contents {
12943: my ($file,$pathsref) = @_;
12944: my (@cmd,$output);
12945: my $needsregexp;
12946: if ($file =~ /\.zip$/) {
12947: @cmd = (&decompression_utility('unzip'),"-l");
12948: $needsregexp = 1;
12949: } elsif (($file =~ m/\.tar\.gz$/) ||
12950: ($file =~ /\.tgz$/)) {
12951: @cmd = (&decompression_utility('tar'),"-ztf");
12952: } elsif ($file =~ /\.tar\.bz2$/) {
12953: @cmd = (&decompression_utility('tar'),"-jtf");
12954: } elsif ($file =~ m|\.tar$|) {
12955: @cmd = (&decompression_utility('tar'),"-tf");
12956: }
12957: if (@cmd) {
12958: undef($!);
12959: undef($@);
12960: if (open(my $fh,"-|", @cmd, $file)) {
12961: while (my $line = <$fh>) {
12962: $output .= $line;
12963: chomp($line);
12964: my $item;
12965: if ($needsregexp) {
12966: ($item) = ($line =~ /^\s*\d+\s+[\d\-]+\s+[\d:]+\s*(.+)$/);
12967: } else {
12968: $item = $line;
12969: }
12970: if ($item ne '') {
12971: unless (grep(/^\Q$item\E$/,@{$pathsref})) {
12972: push(@{$pathsref},$item);
12973: }
12974: }
12975: }
12976: close($fh);
12977: }
12978: }
12979: return $output;
12980: }
12981:
1.1053 raeburn 12982: sub decompress_uploaded_file {
12983: my ($file,$dir) = @_;
12984: &Apache::lonnet::appenv({'cgi.file' => $file});
12985: &Apache::lonnet::appenv({'cgi.dir' => $dir});
12986: my $result = &Apache::lonnet::ssi_body('/cgi-bin/decompress.pl');
12987: my ($handle) = ($env{'user.environment'} =~m{/([^/]+)\.id$});
12988: my $lonidsdir = $Apache::lonnet::perlvar{'lonIDsDir'};
12989: &Apache::lonnet::transfer_profile_to_env($lonidsdir,$handle,1);
12990: my $decompressed = $env{'cgi.decompressed'};
12991: &Apache::lonnet::delenv('cgi.file');
12992: &Apache::lonnet::delenv('cgi.dir');
12993: &Apache::lonnet::delenv('cgi.decompressed');
12994: return ($decompressed,$result);
12995: }
12996:
1.1055 raeburn 12997: sub process_decompression {
12998: my ($docudom,$docuname,$file,$destination,$dir_root,$hiddenelem) = @_;
1.1292 raeburn 12999: unless (($dir_root eq '/userfiles') && ($destination =~ m{^(docs|supplemental)/(default|\d+)/\d+$})) {
13000: return '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
13001: &mt('Unexpected file path.').'</p>'."\n";
13002: }
13003: unless (($docudom =~ /^$match_domain$/) && ($docuname =~ /^$match_courseid$/)) {
13004: return '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
13005: &mt('Unexpected course context.').'</p>'."\n";
13006: }
1.1293 raeburn 13007: unless ($file eq &Apache::lonnet::clean_filename($file)) {
1.1292 raeburn 13008: return '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
13009: &mt('Filename contained unexpected characters.').'</p>'."\n";
13010: }
1.1055 raeburn 13011: my ($dir,$error,$warning,$output);
1.1180 raeburn 13012: if ($file !~ /\.(zip|tar|bz2|gz|tar.gz|tar.bz2|tgz)$/i) {
1.1120 bisitz 13013: $error = &mt('Filename not a supported archive file type.').
13014: '<br />'.&mt('Filename should end with one of: [_1].',
1.1055 raeburn 13015: '.zip, .tar, .bz2, .gz, .tar.gz, .tar.bz2, .tgz');
13016: } else {
13017: my $docuhome = &Apache::lonnet::homeserver($docuname,$docudom);
13018: if ($docuhome eq 'no_host') {
13019: $error = &mt('Could not determine home server for course.');
13020: } else {
13021: my @ids=&Apache::lonnet::current_machine_ids();
13022: my $currdir = "$dir_root/$destination";
13023: if (grep(/^\Q$docuhome\E$/,@ids)) {
13024: $dir = &LONCAPA::propath($docudom,$docuname).
13025: "$dir_root/$destination";
13026: } else {
13027: $dir = $Apache::lonnet::perlvar{'lonDocRoot'}.
13028: "$dir_root/$docudom/$docuname/$destination";
13029: unless (&Apache::lonnet::repcopy_userfile("$dir/$file") eq 'ok') {
13030: $error = &mt('Archive file not found.');
13031: }
13032: }
1.1065 raeburn 13033: my (@to_overwrite,@to_skip);
13034: if ($env{'form.archive_overwrite_total'} > 0) {
13035: my $total = $env{'form.archive_overwrite_total'};
13036: for (my $i=0; $i<$total; $i++) {
13037: if ($env{'form.archive_overwrite_'.$i} == 1) {
13038: push(@to_overwrite,$env{'form.archive_overwrite_name_'.$i});
13039: } elsif ($env{'form.archive_overwrite_'.$i} == 0) {
13040: push(@to_skip,$env{'form.archive_overwrite_name_'.$i});
13041: }
13042: }
13043: }
13044: my $numskip = scalar(@to_skip);
1.1292 raeburn 13045: my $numoverwrite = scalar(@to_overwrite);
13046: if (($numskip) && (!$numoverwrite)) {
1.1065 raeburn 13047: $warning = &mt('All items in the archive file already exist, and no overwriting of existing files has been requested.');
13048: } elsif ($dir eq '') {
1.1055 raeburn 13049: $error = &mt('Directory containing archive file unavailable.');
13050: } elsif (!$error) {
1.1065 raeburn 13051: my ($decompressed,$display);
1.1292 raeburn 13052: if (($numskip) || ($numoverwrite)) {
1.1065 raeburn 13053: my $tempdir = time.'_'.$$.int(rand(10000));
13054: mkdir("$dir/$tempdir",0755);
1.1292 raeburn 13055: if (&File::Copy::move("$dir/$file","$dir/$tempdir/$file")) {
13056: ($decompressed,$display) =
13057: &decompress_uploaded_file($file,"$dir/$tempdir");
13058: foreach my $item (@to_skip) {
13059: if (($item ne '') && ($item !~ /\.\./)) {
13060: if (-f "$dir/$tempdir/$item") {
13061: unlink("$dir/$tempdir/$item");
13062: } elsif (-d "$dir/$tempdir/$item") {
1.1300 raeburn 13063: &File::Path::remove_tree("$dir/$tempdir/$item",{ safe => 1 });
1.1292 raeburn 13064: }
13065: }
13066: }
13067: foreach my $item (@to_overwrite) {
13068: if ((-e "$dir/$tempdir/$item") && (-e "$dir/$item")) {
13069: if (($item ne '') && ($item !~ /\.\./)) {
13070: if (-f "$dir/$item") {
13071: unlink("$dir/$item");
13072: } elsif (-d "$dir/$item") {
1.1300 raeburn 13073: &File::Path::remove_tree("$dir/$item",{ safe => 1 });
1.1292 raeburn 13074: }
13075: &File::Copy::move("$dir/$tempdir/$item","$dir/$item");
13076: }
1.1065 raeburn 13077: }
13078: }
1.1292 raeburn 13079: if (&File::Copy::move("$dir/$tempdir/$file","$dir/$file")) {
1.1300 raeburn 13080: &File::Path::remove_tree("$dir/$tempdir",{ safe => 1 });
1.1292 raeburn 13081: }
1.1065 raeburn 13082: }
13083: } else {
13084: ($decompressed,$display) =
13085: &decompress_uploaded_file($file,$dir);
13086: }
1.1055 raeburn 13087: if ($decompressed eq 'ok') {
1.1065 raeburn 13088: $output = '<p class="LC_info">'.
13089: &mt('Files extracted successfully from archive.').
13090: '</p>'."\n";
1.1055 raeburn 13091: my ($warning,$result,@contents);
13092: my ($newdirlistref,$newlisterror) =
13093: &Apache::lonnet::dirlist($currdir,$docudom,
13094: $docuname,1);
13095: my (%is_dir,%changes,@newitems);
13096: my $dirptr = 16384;
1.1065 raeburn 13097: if (ref($newdirlistref) eq 'ARRAY') {
1.1055 raeburn 13098: foreach my $dir_line (@{$newdirlistref}) {
13099: my ($item,undef,undef,$testdir)=split(/\&/,$dir_line,5);
1.1292 raeburn 13100: unless (($item =~ /^\.+$/) || ($item eq $file)) {
1.1055 raeburn 13101: push(@newitems,$item);
13102: if ($dirptr&$testdir) {
13103: $is_dir{$item} = 1;
13104: }
13105: $changes{$item} = 1;
13106: }
13107: }
13108: }
13109: if (keys(%changes) > 0) {
13110: foreach my $item (sort(@newitems)) {
13111: if ($changes{$item}) {
13112: push(@contents,$item);
13113: }
13114: }
13115: }
13116: if (@contents > 0) {
1.1067 raeburn 13117: my $wantform;
13118: unless ($env{'form.autoextract_camtasia'}) {
13119: $wantform = 1;
13120: }
1.1056 raeburn 13121: my (%children,%parent,%dirorder,%titles);
1.1055 raeburn 13122: my ($count,$datatable) = &get_extracted($docudom,$docuname,
13123: $currdir,\%is_dir,
13124: \%children,\%parent,
1.1056 raeburn 13125: \@contents,\%dirorder,
13126: \%titles,$wantform);
1.1055 raeburn 13127: if ($datatable ne '') {
13128: $output .= &archive_options_form('decompressed',$datatable,
13129: $count,$hiddenelem);
1.1065 raeburn 13130: my $startcount = 6;
1.1055 raeburn 13131: $output .= &archive_javascript($startcount,$count,
1.1056 raeburn 13132: \%titles,\%children);
1.1055 raeburn 13133: }
1.1067 raeburn 13134: if ($env{'form.autoextract_camtasia'}) {
1.1164 raeburn 13135: my $version = $env{'form.autoextract_camtasia'};
1.1067 raeburn 13136: my %displayed;
13137: my $total = 1;
13138: $env{'form.archive_directory'} = [];
13139: foreach my $i (sort { $a <=> $b } keys(%dirorder)) {
13140: my $path = join('/',map { $titles{$_}; } @{$dirorder{$i}});
13141: $path =~ s{/$}{};
13142: my $item;
13143: if ($path ne '') {
13144: $item = "$path/$titles{$i}";
13145: } else {
13146: $item = $titles{$i};
13147: }
13148: $env{'form.archive_content_'.$i} = "$dir_root/$destination/$item";
13149: if ($item eq $contents[0]) {
13150: push(@{$env{'form.archive_directory'}},$i);
13151: $env{'form.archive_'.$i} = 'display';
13152: $env{'form.archive_title_'.$i} = $env{'form.camtasia_foldername'};
13153: $displayed{'folder'} = $i;
1.1164 raeburn 13154: } elsif ((($item eq "$contents[0]/index.html") && ($version == 6)) ||
13155: (($item eq "$contents[0]/$contents[0]".'.html') && ($version == 8))) {
1.1067 raeburn 13156: $env{'form.archive_'.$i} = 'display';
13157: $env{'form.archive_title_'.$i} = $env{'form.camtasia_moviename'};
13158: $displayed{'web'} = $i;
13159: } else {
1.1164 raeburn 13160: if ((($item eq "$contents[0]/media") && ($version == 6)) ||
13161: ((($item eq "$contents[0]/scripts") || ($item eq "$contents[0]/skins") ||
13162: ($item eq "$contents[0]/skins/express_show")) && ($version == 8))) {
1.1067 raeburn 13163: push(@{$env{'form.archive_directory'}},$i);
13164: }
13165: $env{'form.archive_'.$i} = 'dependency';
13166: }
13167: $total ++;
13168: }
13169: for (my $i=1; $i<$total; $i++) {
13170: next if ($i == $displayed{'web'});
13171: next if ($i == $displayed{'folder'});
13172: $env{'form.archive_dependent_on_'.$i} = $displayed{'web'};
13173: }
13174: $env{'form.phase'} = 'decompress_cleanup';
13175: $env{'form.archivedelete'} = 1;
13176: $env{'form.archive_count'} = $total-1;
13177: $output .=
13178: &process_extracted_files('coursedocs',$docudom,
13179: $docuname,$destination,
13180: $dir_root,$hiddenelem);
13181: }
1.1055 raeburn 13182: } else {
13183: $warning = &mt('No new items extracted from archive file.');
13184: }
13185: } else {
13186: $output = $display;
13187: $error = &mt('An error occurred during extraction from the archive file.');
13188: }
13189: }
13190: }
13191: }
13192: if ($error) {
13193: $output .= '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
13194: $error.'</p>'."\n";
13195: }
13196: if ($warning) {
13197: $output .= '<p class="LC_warning">'.$warning.'</p>'."\n";
13198: }
13199: return $output;
13200: }
13201:
13202: sub get_extracted {
1.1056 raeburn 13203: my ($docudom,$docuname,$currdir,$is_dir,$children,$parent,$contents,$dirorder,
13204: $titles,$wantform) = @_;
1.1055 raeburn 13205: my $count = 0;
13206: my $depth = 0;
13207: my $datatable;
1.1056 raeburn 13208: my @hierarchy;
1.1055 raeburn 13209: return unless ((ref($is_dir) eq 'HASH') && (ref($children) eq 'HASH') &&
1.1056 raeburn 13210: (ref($parent) eq 'HASH') && (ref($contents) eq 'ARRAY') &&
13211: (ref($dirorder) eq 'HASH') && (ref($titles) eq 'HASH'));
1.1055 raeburn 13212: foreach my $item (@{$contents}) {
13213: $count ++;
1.1056 raeburn 13214: @{$dirorder->{$count}} = @hierarchy;
13215: $titles->{$count} = $item;
1.1055 raeburn 13216: &archive_hierarchy($depth,$count,$parent,$children);
13217: if ($wantform) {
13218: $datatable .= &archive_row($is_dir->{$item},$item,
13219: $currdir,$depth,$count);
13220: }
13221: if ($is_dir->{$item}) {
13222: $depth ++;
1.1056 raeburn 13223: push(@hierarchy,$count);
13224: $parent->{$depth} = $count;
1.1055 raeburn 13225: $datatable .=
13226: &recurse_extracted_archive("$currdir/$item",$docudom,$docuname,
1.1056 raeburn 13227: \$depth,\$count,\@hierarchy,$dirorder,
13228: $children,$parent,$titles,$wantform);
1.1055 raeburn 13229: $depth --;
1.1056 raeburn 13230: pop(@hierarchy);
1.1055 raeburn 13231: }
13232: }
13233: return ($count,$datatable);
13234: }
13235:
13236: sub recurse_extracted_archive {
1.1056 raeburn 13237: my ($currdir,$docudom,$docuname,$depth,$count,$hierarchy,$dirorder,
13238: $children,$parent,$titles,$wantform) = @_;
1.1055 raeburn 13239: my $result='';
1.1056 raeburn 13240: unless ((ref($depth)) && (ref($count)) && (ref($hierarchy) eq 'ARRAY') &&
13241: (ref($children) eq 'HASH') && (ref($parent) eq 'HASH') &&
13242: (ref($dirorder) eq 'HASH')) {
1.1055 raeburn 13243: return $result;
13244: }
13245: my $dirptr = 16384;
13246: my ($newdirlistref,$newlisterror) =
13247: &Apache::lonnet::dirlist($currdir,$docudom,$docuname,1);
13248: if (ref($newdirlistref) eq 'ARRAY') {
13249: foreach my $dir_line (@{$newdirlistref}) {
13250: my ($item,undef,undef,$testdir)=split(/\&/,$dir_line,5);
13251: unless ($item =~ /^\.+$/) {
13252: $$count ++;
1.1056 raeburn 13253: @{$dirorder->{$$count}} = @{$hierarchy};
13254: $titles->{$$count} = $item;
1.1055 raeburn 13255: &archive_hierarchy($$depth,$$count,$parent,$children);
1.1056 raeburn 13256:
1.1055 raeburn 13257: my $is_dir;
13258: if ($dirptr&$testdir) {
13259: $is_dir = 1;
13260: }
13261: if ($wantform) {
13262: $result .= &archive_row($is_dir,$item,$currdir,$$depth,$$count);
13263: }
13264: if ($is_dir) {
13265: $$depth ++;
1.1056 raeburn 13266: push(@{$hierarchy},$$count);
13267: $parent->{$$depth} = $$count;
1.1055 raeburn 13268: $result .=
13269: &recurse_extracted_archive("$currdir/$item",$docudom,
13270: $docuname,$depth,$count,
1.1056 raeburn 13271: $hierarchy,$dirorder,$children,
13272: $parent,$titles,$wantform);
1.1055 raeburn 13273: $$depth --;
1.1056 raeburn 13274: pop(@{$hierarchy});
1.1055 raeburn 13275: }
13276: }
13277: }
13278: }
13279: return $result;
13280: }
13281:
13282: sub archive_hierarchy {
13283: my ($depth,$count,$parent,$children) =@_;
13284: if ((ref($parent) eq 'HASH') && (ref($children) eq 'HASH')) {
13285: if (exists($parent->{$depth})) {
13286: $children->{$parent->{$depth}} .= $count.':';
13287: }
13288: }
13289: return;
13290: }
13291:
13292: sub archive_row {
13293: my ($is_dir,$item,$currdir,$depth,$count) = @_;
13294: my ($name) = ($item =~ m{([^/]+)$});
13295: my %choices = &Apache::lonlocal::texthash (
1.1059 raeburn 13296: 'display' => 'Add as file',
1.1055 raeburn 13297: 'dependency' => 'Include as dependency',
13298: 'discard' => 'Discard',
13299: );
13300: if ($is_dir) {
1.1059 raeburn 13301: $choices{'display'} = &mt('Add as folder');
1.1055 raeburn 13302: }
1.1056 raeburn 13303: my $output = &start_data_table_row().'<td align="right">'.$count.'</td>'."\n";
13304: my $offset = 0;
1.1055 raeburn 13305: foreach my $action ('display','dependency','discard') {
1.1056 raeburn 13306: $offset ++;
1.1065 raeburn 13307: if ($action ne 'display') {
13308: $offset ++;
13309: }
1.1055 raeburn 13310: $output .= '<td><span class="LC_nobreak">'.
13311: '<label><input type="radio" name="archive_'.$count.
13312: '" id="archive_'.$action.'_'.$count.'" value="'.$action.'"';
13313: my $text = $choices{$action};
13314: if ($is_dir) {
13315: $output .= ' onclick="javascript:propagateCheck(this.form,'."'$count'".');"';
13316: if ($action eq 'display') {
1.1059 raeburn 13317: $text = &mt('Add as folder');
1.1055 raeburn 13318: }
1.1056 raeburn 13319: } else {
13320: $output .= ' onclick="javascript:dependencyCheck(this.form,'."$count,$offset".');"';
13321:
13322: }
13323: $output .= ' /> '.$choices{$action}.'</label></span>';
13324: if ($action eq 'dependency') {
13325: $output .= '<div id="arc_depon_'.$count.'" style="display:none;">'."\n".
13326: &mt('Used by:').' <select name="archive_dependent_on_'.$count.'" '.
13327: 'onchange="propagateSelect(this.form,'."$count,$offset".')">'."\n".
13328: '<option value=""></option>'."\n".
13329: '</select>'."\n".
13330: '</div>';
1.1059 raeburn 13331: } elsif ($action eq 'display') {
13332: $output .= '<div id="arc_title_'.$count.'" style="display:none;">'."\n".
13333: &mt('Title:').' <input type="text" name="archive_title_'.$count.'" id="archive_title_'.$count.'" />'."\n".
13334: '</div>';
1.1055 raeburn 13335: }
1.1056 raeburn 13336: $output .= '</td>';
1.1055 raeburn 13337: }
13338: $output .= '<td><input type="hidden" name="archive_content_'.$count.'" value="'.
13339: &HTML::Entities::encode("$currdir/$item",'"<>&').'" />'.(' ' x 2);
13340: for (my $i=0; $i<$depth; $i++) {
13341: $output .= ('<img src="/adm/lonIcons/whitespace1.gif" class="LC_docs_spacer" alt="" />' x2)."\n";
13342: }
13343: if ($is_dir) {
13344: $output .= '<img src="/adm/lonIcons/navmap.folder.open.gif" alt="" /> '."\n".
13345: '<input type="hidden" name="archive_directory" value="'.$count.'" />'."\n";
13346: } else {
13347: $output .= '<input type="hidden" name="archive_file" value="'.$count.'" />'."\n";
13348: }
13349: $output .= ' '.$name.'</td>'."\n".
13350: &end_data_table_row();
13351: return $output;
13352: }
13353:
13354: sub archive_options_form {
1.1065 raeburn 13355: my ($form,$display,$count,$hiddenelem) = @_;
13356: my %lt = &Apache::lonlocal::texthash(
13357: perm => 'Permanently remove archive file?',
13358: hows => 'How should each extracted item be incorporated in the course?',
13359: cont => 'Content actions for all',
13360: addf => 'Add as folder/file',
13361: incd => 'Include as dependency for a displayed file',
13362: disc => 'Discard',
13363: no => 'No',
13364: yes => 'Yes',
13365: save => 'Save',
13366: );
13367: my $output = <<"END";
13368: <form name="$form" method="post" action="">
13369: <p><span class="LC_nobreak">$lt{'perm'}
13370: <label>
13371: <input type="radio" name="archivedelete" value="0" checked="checked" />$lt{'no'}
13372: </label>
13373:
13374: <label>
13375: <input type="radio" name="archivedelete" value="1" />$lt{'yes'}</label>
13376: </span>
13377: </p>
13378: <input type="hidden" name="phase" value="decompress_cleanup" />
13379: <br />$lt{'hows'}
13380: <div class="LC_columnSection">
13381: <fieldset>
13382: <legend>$lt{'cont'}</legend>
13383: <input type="button" value="$lt{'addf'}" onclick="javascript:checkAll(document.$form,'display');" />
13384: <input type="button" value="$lt{'incd'}" onclick="javascript:checkAll(document.$form,'dependency');" />
13385: <input type="button" value="$lt{'disc'}" onclick="javascript:checkAll(document.$form,'discard');" />
13386: </fieldset>
13387: </div>
13388: END
13389: return $output.
1.1055 raeburn 13390: &start_data_table()."\n".
1.1065 raeburn 13391: $display."\n".
1.1055 raeburn 13392: &end_data_table()."\n".
13393: '<input type="hidden" name="archive_count" value="'.$count.'" />'.
13394: $hiddenelem.
1.1065 raeburn 13395: '<br /><input type="submit" name="archive_submit" value="'.$lt{'save'}.'" />'.
1.1055 raeburn 13396: '</form>';
13397: }
13398:
13399: sub archive_javascript {
1.1056 raeburn 13400: my ($startcount,$numitems,$titles,$children) = @_;
13401: return unless ((ref($titles) eq 'HASH') && (ref($children) eq 'HASH'));
1.1059 raeburn 13402: my $maintitle = $env{'form.comment'};
1.1055 raeburn 13403: my $scripttag = <<START;
13404: <script type="text/javascript">
13405: // <![CDATA[
13406:
13407: function checkAll(form,prefix) {
13408: var idstr = new RegExp("^archive_"+prefix+"_\\\\d+\$");
13409: for (var i=0; i < form.elements.length; i++) {
13410: var id = form.elements[i].id;
13411: if ((id != '') && (id != undefined)) {
13412: if (idstr.test(id)) {
13413: if (form.elements[i].type == 'radio') {
13414: form.elements[i].checked = true;
1.1056 raeburn 13415: var nostart = i-$startcount;
1.1059 raeburn 13416: var offset = nostart%7;
13417: var count = (nostart-offset)/7;
1.1056 raeburn 13418: dependencyCheck(form,count,offset);
1.1055 raeburn 13419: }
13420: }
13421: }
13422: }
13423: }
13424:
13425: function propagateCheck(form,count) {
13426: if (count > 0) {
1.1059 raeburn 13427: var startelement = $startcount + ((count-1) * 7);
13428: for (var j=1; j<6; j++) {
13429: if ((j != 2) && (j != 4)) {
1.1056 raeburn 13430: var item = startelement + j;
13431: if (form.elements[item].type == 'radio') {
13432: if (form.elements[item].checked) {
13433: containerCheck(form,count,j);
13434: break;
13435: }
1.1055 raeburn 13436: }
13437: }
13438: }
13439: }
13440: }
13441:
13442: numitems = $numitems
1.1056 raeburn 13443: var titles = new Array(numitems);
13444: var parents = new Array(numitems);
1.1055 raeburn 13445: for (var i=0; i<numitems; i++) {
1.1056 raeburn 13446: parents[i] = new Array;
1.1055 raeburn 13447: }
1.1059 raeburn 13448: var maintitle = '$maintitle';
1.1055 raeburn 13449:
13450: START
13451:
1.1056 raeburn 13452: foreach my $container (sort { $a <=> $b } (keys(%{$children}))) {
13453: my @contents = split(/:/,$children->{$container});
1.1055 raeburn 13454: for (my $i=0; $i<@contents; $i ++) {
13455: $scripttag .= 'parents['.$container.']['.$i.'] = '.$contents[$i]."\n";
13456: }
13457: }
13458:
1.1056 raeburn 13459: foreach my $key (sort { $a <=> $b } (keys(%{$titles}))) {
13460: $scripttag .= "titles[$key] = '".$titles->{$key}."';\n";
13461: }
13462:
1.1055 raeburn 13463: $scripttag .= <<END;
13464:
13465: function containerCheck(form,count,offset) {
13466: if (count > 0) {
1.1056 raeburn 13467: dependencyCheck(form,count,offset);
1.1059 raeburn 13468: var item = (offset+$startcount)+7*(count-1);
1.1055 raeburn 13469: form.elements[item].checked = true;
13470: if(Object.prototype.toString.call(parents[count]) === '[object Array]') {
13471: if (parents[count].length > 0) {
13472: for (var j=0; j<parents[count].length; j++) {
1.1056 raeburn 13473: containerCheck(form,parents[count][j],offset);
13474: }
13475: }
13476: }
13477: }
13478: }
13479:
13480: function dependencyCheck(form,count,offset) {
13481: if (count > 0) {
1.1059 raeburn 13482: var chosen = (offset+$startcount)+7*(count-1);
13483: var depitem = $startcount + ((count-1) * 7) + 4;
1.1056 raeburn 13484: var currtype = form.elements[depitem].type;
13485: if (form.elements[chosen].value == 'dependency') {
13486: document.getElementById('arc_depon_'+count).style.display='block';
13487: form.elements[depitem].options.length = 0;
13488: form.elements[depitem].options[0] = new Option('Select','',true,true);
1.1085 raeburn 13489: for (var i=1; i<=numitems; i++) {
13490: if (i == count) {
13491: continue;
13492: }
1.1059 raeburn 13493: var startelement = $startcount + (i-1) * 7;
13494: for (var j=1; j<6; j++) {
13495: if ((j != 2) && (j!= 4)) {
1.1056 raeburn 13496: var item = startelement + j;
13497: if (form.elements[item].type == 'radio') {
13498: if (form.elements[item].checked) {
13499: if (form.elements[item].value == 'display') {
13500: var n = form.elements[depitem].options.length;
13501: form.elements[depitem].options[n] = new Option(titles[i],i,false,false);
13502: }
13503: }
13504: }
13505: }
13506: }
13507: }
13508: } else {
13509: document.getElementById('arc_depon_'+count).style.display='none';
13510: form.elements[depitem].options.length = 0;
13511: form.elements[depitem].options[0] = new Option('Select','',true,true);
13512: }
1.1059 raeburn 13513: titleCheck(form,count,offset);
1.1056 raeburn 13514: }
13515: }
13516:
13517: function propagateSelect(form,count,offset) {
13518: if (count > 0) {
1.1065 raeburn 13519: var item = (1+offset+$startcount)+7*(count-1);
1.1056 raeburn 13520: var picked = form.elements[item].options[form.elements[item].selectedIndex].value;
13521: if (Object.prototype.toString.call(parents[count]) === '[object Array]') {
13522: if (parents[count].length > 0) {
13523: for (var j=0; j<parents[count].length; j++) {
13524: containerSelect(form,parents[count][j],offset,picked);
1.1055 raeburn 13525: }
13526: }
13527: }
13528: }
13529: }
1.1056 raeburn 13530:
13531: function containerSelect(form,count,offset,picked) {
13532: if (count > 0) {
1.1065 raeburn 13533: var item = (offset+$startcount)+7*(count-1);
1.1056 raeburn 13534: if (form.elements[item].type == 'radio') {
13535: if (form.elements[item].value == 'dependency') {
13536: if (form.elements[item+1].type == 'select-one') {
13537: for (var i=0; i<form.elements[item+1].options.length; i++) {
13538: if (form.elements[item+1].options[i].value == picked) {
13539: form.elements[item+1].selectedIndex = i;
13540: break;
13541: }
13542: }
13543: }
13544: if (Object.prototype.toString.call(parents[count]) === '[object Array]') {
13545: if (parents[count].length > 0) {
13546: for (var j=0; j<parents[count].length; j++) {
13547: containerSelect(form,parents[count][j],offset,picked);
13548: }
13549: }
13550: }
13551: }
13552: }
13553: }
13554: }
13555:
1.1059 raeburn 13556: function titleCheck(form,count,offset) {
13557: if (count > 0) {
13558: var chosen = (offset+$startcount)+7*(count-1);
13559: var depitem = $startcount + ((count-1) * 7) + 2;
13560: var currtype = form.elements[depitem].type;
13561: if (form.elements[chosen].value == 'display') {
13562: document.getElementById('arc_title_'+count).style.display='block';
13563: if ((count==1) && ((parents[count].length > 0) || (numitems == 1))) {
13564: document.getElementById('archive_title_'+count).value=maintitle;
13565: }
13566: } else {
13567: document.getElementById('arc_title_'+count).style.display='none';
13568: if (currtype == 'text') {
13569: document.getElementById('archive_title_'+count).value='';
13570: }
13571: }
13572: }
13573: return;
13574: }
13575:
1.1055 raeburn 13576: // ]]>
13577: </script>
13578: END
13579: return $scripttag;
13580: }
13581:
13582: sub process_extracted_files {
1.1067 raeburn 13583: my ($context,$docudom,$docuname,$destination,$dir_root,$hiddenelem) = @_;
1.1055 raeburn 13584: my $numitems = $env{'form.archive_count'};
1.1294 raeburn 13585: return if ((!$numitems) || ($numitems =~ /\D/));
1.1055 raeburn 13586: my @ids=&Apache::lonnet::current_machine_ids();
13587: my ($prefix,$pathtocheck,$dir,$ishome,$error,$warning,%toplevelitems,%is_dir,
1.1067 raeburn 13588: %folders,%containers,%mapinner,%prompttofetch);
1.1055 raeburn 13589: my $docuhome = &Apache::lonnet::homeserver($docuname,$docudom);
13590: if (grep(/^\Q$docuhome\E$/,@ids)) {
13591: $prefix = &LONCAPA::propath($docudom,$docuname);
13592: $pathtocheck = "$dir_root/$destination";
13593: $dir = $dir_root;
13594: $ishome = 1;
13595: } else {
13596: $prefix = $Apache::lonnet::perlvar{'lonDocRoot'};
13597: $pathtocheck = "$dir_root/$docudom/$docuname/$destination";
1.1294 raeburn 13598: $dir = "$dir_root/$docudom/$docuname";
1.1055 raeburn 13599: }
13600: my $currdir = "$dir_root/$destination";
13601: (my $docstype,$mapinner{'0'}) = ($destination =~ m{^(docs|supplemental)/(\w+)/});
13602: if ($env{'form.folderpath'}) {
13603: my @items = split('&',$env{'form.folderpath'});
13604: $folders{'0'} = $items[-2];
1.1099 raeburn 13605: if ($env{'form.folderpath'} =~ /\:1$/) {
13606: $containers{'0'}='page';
13607: } else {
13608: $containers{'0'}='sequence';
13609: }
1.1055 raeburn 13610: }
13611: my @archdirs = &get_env_multiple('form.archive_directory');
13612: if ($numitems) {
13613: for (my $i=1; $i<=$numitems; $i++) {
13614: my $path = $env{'form.archive_content_'.$i};
13615: if ($path =~ m{^\Q$pathtocheck\E/([^/]+)$}) {
13616: my $item = $1;
13617: $toplevelitems{$item} = $i;
13618: if (grep(/^\Q$i\E$/,@archdirs)) {
13619: $is_dir{$item} = 1;
13620: }
13621: }
13622: }
13623: }
1.1067 raeburn 13624: my ($output,%children,%parent,%titles,%dirorder,$result);
1.1055 raeburn 13625: if (keys(%toplevelitems) > 0) {
13626: my @contents = sort(keys(%toplevelitems));
1.1056 raeburn 13627: (my $count,undef) = &get_extracted($docudom,$docuname,$currdir,\%is_dir,\%children,
13628: \%parent,\@contents,\%dirorder,\%titles);
1.1055 raeburn 13629: }
1.1066 raeburn 13630: my (%referrer,%orphaned,%todelete,%todeletedir,%newdest,%newseqid);
1.1055 raeburn 13631: if ($numitems) {
13632: for (my $i=1; $i<=$numitems; $i++) {
1.1086 raeburn 13633: next if ($env{'form.archive_'.$i} eq 'dependency');
1.1055 raeburn 13634: my $path = $env{'form.archive_content_'.$i};
13635: if ($path =~ /^\Q$pathtocheck\E/) {
13636: if ($env{'form.archive_'.$i} eq 'discard') {
13637: if ($prefix ne '' && $path ne '') {
13638: if (-e $prefix.$path) {
1.1066 raeburn 13639: if ((@archdirs > 0) &&
13640: (grep(/^\Q$i\E$/,@archdirs))) {
13641: $todeletedir{$prefix.$path} = 1;
13642: } else {
13643: $todelete{$prefix.$path} = 1;
13644: }
1.1055 raeburn 13645: }
13646: }
13647: } elsif ($env{'form.archive_'.$i} eq 'display') {
1.1059 raeburn 13648: my ($docstitle,$title,$url,$outer);
1.1055 raeburn 13649: ($title) = ($path =~ m{/([^/]+)$});
1.1059 raeburn 13650: $docstitle = $env{'form.archive_title_'.$i};
13651: if ($docstitle eq '') {
13652: $docstitle = $title;
13653: }
1.1055 raeburn 13654: $outer = 0;
1.1056 raeburn 13655: if (ref($dirorder{$i}) eq 'ARRAY') {
13656: if (@{$dirorder{$i}} > 0) {
13657: foreach my $item (reverse(@{$dirorder{$i}})) {
1.1055 raeburn 13658: if ($env{'form.archive_'.$item} eq 'display') {
13659: $outer = $item;
13660: last;
13661: }
13662: }
13663: }
13664: }
13665: my ($errtext,$fatal) =
13666: &LONCAPA::map::mapread('/uploaded/'.$docudom.'/'.$docuname.
13667: '/'.$folders{$outer}.'.'.
13668: $containers{$outer});
13669: next if ($fatal);
13670: if ((@archdirs > 0) && (grep(/^\Q$i\E$/,@archdirs))) {
13671: if ($context eq 'coursedocs') {
1.1056 raeburn 13672: $mapinner{$i} = time;
1.1055 raeburn 13673: $folders{$i} = 'default_'.$mapinner{$i};
13674: $containers{$i} = 'sequence';
13675: my $url = '/uploaded/'.$docudom.'/'.$docuname.'/'.
13676: $folders{$i}.'.'.$containers{$i};
13677: my $newidx = &LONCAPA::map::getresidx();
13678: $LONCAPA::map::resources[$newidx]=
1.1059 raeburn 13679: $docstitle.':'.$url.':false:normal:res';
1.1055 raeburn 13680: push(@LONCAPA::map::order,$newidx);
13681: my ($outtext,$errtext) =
13682: &LONCAPA::map::storemap('/uploaded/'.$docudom.'/'.
13683: $docuname.'/'.$folders{$outer}.
1.1087 raeburn 13684: '.'.$containers{$outer},1,1);
1.1056 raeburn 13685: $newseqid{$i} = $newidx;
1.1067 raeburn 13686: unless ($errtext) {
1.1294 raeburn 13687: $result .= '<li>'.&mt('Folder: [_1] added to course',
13688: &HTML::Entities::encode($docstitle,'<>&"')).
13689: '</li>'."\n";
1.1067 raeburn 13690: }
1.1055 raeburn 13691: }
13692: } else {
13693: if ($context eq 'coursedocs') {
13694: my $newidx=&LONCAPA::map::getresidx();
13695: my $url = '/uploaded/'.$docudom.'/'.$docuname.'/'.
13696: $docstype.'/'.$mapinner{$outer}.'/'.$newidx.'/'.
13697: $title;
1.1294 raeburn 13698: if (($outer !~ /\D/) && ($mapinner{$outer} !~ /\D/) && ($newidx !~ /\D/)) {
13699: if (!-e "$prefix$dir/$docstype/$mapinner{$outer}") {
13700: mkdir("$prefix$dir/$docstype/$mapinner{$outer}",0755);
13701: }
13702: if (!-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx") {
13703: mkdir("$prefix$dir/$docstype/$mapinner{$outer}/$newidx");
13704: }
13705: if (-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx") {
13706: if (rename("$prefix$path","$prefix$dir/$docstype/$mapinner{$outer}/$newidx/$title")) {
13707: $newdest{$i} = "$prefix$dir/$docstype/$mapinner{$outer}/$newidx";
13708: unless ($ishome) {
13709: my $fetch = "$newdest{$i}/$title";
13710: $fetch =~ s/^\Q$prefix$dir\E//;
13711: $prompttofetch{$fetch} = 1;
13712: }
1.1292 raeburn 13713: }
1.1067 raeburn 13714: }
1.1294 raeburn 13715: $LONCAPA::map::resources[$newidx]=
13716: $docstitle.':'.$url.':false:normal:res';
13717: push(@LONCAPA::map::order, $newidx);
13718: my ($outtext,$errtext)=
13719: &LONCAPA::map::storemap('/uploaded/'.$docudom.'/'.
13720: $docuname.'/'.$folders{$outer}.
13721: '.'.$containers{$outer},1,1);
13722: unless ($errtext) {
13723: if (-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx/$title") {
13724: $result .= '<li>'.&mt('File: [_1] added to course',
13725: &HTML::Entities::encode($docstitle,'<>&"')).
13726: '</li>'."\n";
13727: }
1.1067 raeburn 13728: }
1.1294 raeburn 13729: } else {
13730: $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',
13731: &HTML::Entities::encode($path,'<>&"')).'<br />';
1.1296 raeburn 13732: }
1.1055 raeburn 13733: }
13734: }
1.1086 raeburn 13735: }
13736: } else {
1.1294 raeburn 13737: $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',
13738: &HTML::Entities::encode($path,'<>&"')).'<br />';
1.1086 raeburn 13739: }
13740: }
13741: for (my $i=1; $i<=$numitems; $i++) {
13742: next unless ($env{'form.archive_'.$i} eq 'dependency');
13743: my $path = $env{'form.archive_content_'.$i};
13744: if ($path =~ /^\Q$pathtocheck\E/) {
13745: my ($title) = ($path =~ m{/([^/]+)$});
13746: $referrer{$i} = $env{'form.archive_dependent_on_'.$i};
13747: if ($env{'form.archive_'.$referrer{$i}} eq 'display') {
13748: if (ref($dirorder{$i}) eq 'ARRAY') {
13749: my ($itemidx,$fullpath,$relpath);
13750: if (ref($dirorder{$referrer{$i}}) eq 'ARRAY') {
13751: my $container = $dirorder{$referrer{$i}}->[-1];
1.1056 raeburn 13752: for (my $j=0; $j<@{$dirorder{$i}}; $j++) {
1.1086 raeburn 13753: if ($dirorder{$i}->[$j] eq $container) {
13754: $itemidx = $j;
1.1056 raeburn 13755: }
13756: }
1.1086 raeburn 13757: }
13758: if ($itemidx eq '') {
13759: $itemidx = 0;
13760: }
13761: if (grep(/^\Q$referrer{$i}\E$/,@archdirs)) {
13762: if ($mapinner{$referrer{$i}}) {
13763: $fullpath = "$prefix$dir/$docstype/$mapinner{$referrer{$i}}";
13764: for (my $j=$itemidx; $j<@{$dirorder{$i}}; $j++) {
13765: if (grep(/^\Q$dirorder{$i}->[$j]\E$/,@archdirs)) {
13766: unless (defined($newseqid{$dirorder{$i}->[$j]})) {
13767: $fullpath .= '/'.$titles{$dirorder{$i}->[$j]};
13768: $relpath .= '/'.$titles{$dirorder{$i}->[$j]};
13769: if (!-e $fullpath) {
13770: mkdir($fullpath,0755);
1.1056 raeburn 13771: }
13772: }
1.1086 raeburn 13773: } else {
13774: last;
1.1056 raeburn 13775: }
1.1086 raeburn 13776: }
13777: }
13778: } elsif ($newdest{$referrer{$i}}) {
13779: $fullpath = $newdest{$referrer{$i}};
13780: for (my $j=$itemidx; $j<@{$dirorder{$i}}; $j++) {
13781: if ($env{'form.archive_'.$dirorder{$i}->[$j]} eq 'discard') {
13782: $orphaned{$i} = $env{'form.archive_'.$dirorder{$i}->[$j]};
13783: last;
13784: } elsif (grep(/^\Q$dirorder{$i}->[$j]\E$/,@archdirs)) {
13785: unless (defined($newseqid{$dirorder{$i}->[$j]})) {
13786: $fullpath .= '/'.$titles{$dirorder{$i}->[$j]};
13787: $relpath .= '/'.$titles{$dirorder{$i}->[$j]};
13788: if (!-e $fullpath) {
13789: mkdir($fullpath,0755);
1.1056 raeburn 13790: }
13791: }
1.1086 raeburn 13792: } else {
13793: last;
1.1056 raeburn 13794: }
1.1055 raeburn 13795: }
13796: }
1.1086 raeburn 13797: if ($fullpath ne '') {
13798: if (-e "$prefix$path") {
1.1292 raeburn 13799: unless (rename("$prefix$path","$fullpath/$title")) {
13800: $warning .= &mt('Failed to rename dependency').'<br />';
13801: }
1.1086 raeburn 13802: }
13803: if (-e "$fullpath/$title") {
13804: my $showpath;
13805: if ($relpath ne '') {
13806: $showpath = "$relpath/$title";
13807: } else {
13808: $showpath = "/$title";
13809: }
1.1294 raeburn 13810: $result .= '<li>'.&mt('[_1] included as a dependency',
13811: &HTML::Entities::encode($showpath,'<>&"')).
13812: '</li>'."\n";
1.1292 raeburn 13813: unless ($ishome) {
13814: my $fetch = "$fullpath/$title";
13815: $fetch =~ s/^\Q$prefix$dir\E//;
13816: $prompttofetch{$fetch} = 1;
13817: }
1.1086 raeburn 13818: }
13819: }
1.1055 raeburn 13820: }
1.1086 raeburn 13821: } elsif ($env{'form.archive_'.$referrer{$i}} eq 'discard') {
13822: $warning .= &mt('[_1] is a dependency of [_2], which was discarded.',
1.1294 raeburn 13823: &HTML::Entities::encode($path,'<>&"'),
13824: &HTML::Entities::encode($env{'form.archive_content_'.$referrer{$i}},'<>&"')).
13825: '<br />';
1.1055 raeburn 13826: }
13827: } else {
1.1294 raeburn 13828: $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',
1.1296 raeburn 13829: &HTML::Entities::encode($path)).'<br />';
1.1055 raeburn 13830: }
13831: }
13832: if (keys(%todelete)) {
13833: foreach my $key (keys(%todelete)) {
13834: unlink($key);
1.1066 raeburn 13835: }
13836: }
13837: if (keys(%todeletedir)) {
13838: foreach my $key (keys(%todeletedir)) {
13839: rmdir($key);
13840: }
13841: }
13842: foreach my $dir (sort(keys(%is_dir))) {
13843: if (($pathtocheck ne '') && ($dir ne '')) {
13844: &cleanup_empty_dirs($prefix."$pathtocheck/$dir");
1.1055 raeburn 13845: }
13846: }
1.1067 raeburn 13847: if ($result ne '') {
13848: $output .= '<ul>'."\n".
13849: $result."\n".
13850: '</ul>';
13851: }
13852: unless ($ishome) {
13853: my $replicationfail;
13854: foreach my $item (keys(%prompttofetch)) {
13855: my $fetchresult= &Apache::lonnet::reply('fetchuserfile:'.$item,$docuhome);
13856: unless ($fetchresult eq 'ok') {
13857: $replicationfail .= '<li>'.$item.'</li>'."\n";
13858: }
13859: }
13860: if ($replicationfail) {
13861: $output .= '<p class="LC_error">'.
13862: &mt('Course home server failed to retrieve:').'<ul>'.
13863: $replicationfail.
13864: '</ul></p>';
13865: }
13866: }
1.1055 raeburn 13867: } else {
13868: $warning = &mt('No items found in archive.');
13869: }
13870: if ($error) {
13871: $output .= '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
13872: $error.'</p>'."\n";
13873: }
13874: if ($warning) {
13875: $output .= '<p class="LC_warning">'.$warning.'</p>'."\n";
13876: }
13877: return $output;
13878: }
13879:
1.1066 raeburn 13880: sub cleanup_empty_dirs {
13881: my ($path) = @_;
13882: if (($path ne '') && (-d $path)) {
13883: if (opendir(my $dirh,$path)) {
13884: my @dircontents = grep(!/^\./,readdir($dirh));
13885: my $numitems = 0;
13886: foreach my $item (@dircontents) {
13887: if (-d "$path/$item") {
1.1111 raeburn 13888: &cleanup_empty_dirs("$path/$item");
1.1066 raeburn 13889: if (-e "$path/$item") {
13890: $numitems ++;
13891: }
13892: } else {
13893: $numitems ++;
13894: }
13895: }
13896: if ($numitems == 0) {
13897: rmdir($path);
13898: }
13899: closedir($dirh);
13900: }
13901: }
13902: return;
13903: }
13904:
1.41 ng 13905: =pod
1.45 matthew 13906:
1.1162 raeburn 13907: =item * &get_folder_hierarchy()
1.1068 raeburn 13908:
13909: Provides hierarchy of names of folders/sub-folders containing the current
13910: item,
13911:
13912: Inputs: 3
13913: - $navmap - navmaps object
13914:
13915: - $map - url for map (either the trigger itself, or map containing
13916: the resource, which is the trigger).
13917:
13918: - $showitem - 1 => show title for map itself; 0 => do not show.
13919:
13920: Outputs: 1 @pathitems - array of folder/subfolder names.
13921:
13922: =cut
13923:
13924: sub get_folder_hierarchy {
13925: my ($navmap,$map,$showitem) = @_;
13926: my @pathitems;
13927: if (ref($navmap)) {
13928: my $mapres = $navmap->getResourceByUrl($map);
13929: if (ref($mapres)) {
13930: my $pcslist = $mapres->map_hierarchy();
13931: if ($pcslist ne '') {
13932: my @pcs = split(/,/,$pcslist);
13933: foreach my $pc (@pcs) {
13934: if ($pc == 1) {
1.1129 raeburn 13935: push(@pathitems,&mt('Main Content'));
1.1068 raeburn 13936: } else {
13937: my $res = $navmap->getByMapPc($pc);
13938: if (ref($res)) {
13939: my $title = $res->compTitle();
13940: $title =~ s/\W+/_/g;
13941: if ($title ne '') {
13942: push(@pathitems,$title);
13943: }
13944: }
13945: }
13946: }
13947: }
1.1071 raeburn 13948: if ($showitem) {
13949: if ($mapres->{ID} eq '0.0') {
1.1129 raeburn 13950: push(@pathitems,&mt('Main Content'));
1.1071 raeburn 13951: } else {
13952: my $maptitle = $mapres->compTitle();
13953: $maptitle =~ s/\W+/_/g;
13954: if ($maptitle ne '') {
13955: push(@pathitems,$maptitle);
13956: }
1.1068 raeburn 13957: }
13958: }
13959: }
13960: }
13961: return @pathitems;
13962: }
13963:
13964: =pod
13965:
1.1015 raeburn 13966: =item * &get_turnedin_filepath()
13967:
13968: Determines path in a user's portfolio file for storage of files uploaded
13969: to a specific essayresponse or dropbox item.
13970:
13971: Inputs: 3 required + 1 optional.
13972: $symb is symb for resource, $uname and $udom are for current user (required).
13973: $caller is optional (can be "submission", if routine is called when storing
13974: an upoaded file when "Submit Answer" button was pressed).
13975:
13976: Returns array containing $path and $multiresp.
13977: $path is path in portfolio. $multiresp is 1 if this resource contains more
13978: than one file upload item. Callers of routine should append partid as a
13979: subdirectory to $path in cases where $multiresp is 1.
13980:
13981: Called by: homework/essayresponse.pm and homework/structuretags.pm
13982:
13983: =cut
13984:
13985: sub get_turnedin_filepath {
13986: my ($symb,$uname,$udom,$caller) = @_;
13987: my ($map,$resid,$resurl)=&Apache::lonnet::decode_symb($symb);
13988: my $turnindir;
13989: my %userhash = &Apache::lonnet::userenvironment($udom,$uname,'turnindir');
13990: $turnindir = $userhash{'turnindir'};
13991: my ($path,$multiresp);
13992: if ($turnindir eq '') {
13993: if ($caller eq 'submission') {
13994: $turnindir = &mt('turned in');
13995: $turnindir =~ s/\W+/_/g;
13996: my %newhash = (
13997: 'turnindir' => $turnindir,
13998: );
13999: &Apache::lonnet::put('environment',\%newhash,$udom,$uname);
14000: }
14001: }
14002: if ($turnindir ne '') {
14003: $path = '/'.$turnindir.'/';
14004: my ($multipart,$turnin,@pathitems);
14005: my $navmap = Apache::lonnavmaps::navmap->new();
14006: if (defined($navmap)) {
14007: my $mapres = $navmap->getResourceByUrl($map);
14008: if (ref($mapres)) {
14009: my $pcslist = $mapres->map_hierarchy();
14010: if ($pcslist ne '') {
14011: foreach my $pc (split(/,/,$pcslist)) {
14012: my $res = $navmap->getByMapPc($pc);
14013: if (ref($res)) {
14014: my $title = $res->compTitle();
14015: $title =~ s/\W+/_/g;
14016: if ($title ne '') {
1.1149 raeburn 14017: if (($pc > 1) && (length($title) > 12)) {
14018: $title = substr($title,0,12);
14019: }
1.1015 raeburn 14020: push(@pathitems,$title);
14021: }
14022: }
14023: }
14024: }
14025: my $maptitle = $mapres->compTitle();
14026: $maptitle =~ s/\W+/_/g;
14027: if ($maptitle ne '') {
1.1149 raeburn 14028: if (length($maptitle) > 12) {
14029: $maptitle = substr($maptitle,0,12);
14030: }
1.1015 raeburn 14031: push(@pathitems,$maptitle);
14032: }
14033: unless ($env{'request.state'} eq 'construct') {
14034: my $res = $navmap->getBySymb($symb);
14035: if (ref($res)) {
14036: my $partlist = $res->parts();
14037: my $totaluploads = 0;
14038: if (ref($partlist) eq 'ARRAY') {
14039: foreach my $part (@{$partlist}) {
14040: my @types = $res->responseType($part);
14041: my @ids = $res->responseIds($part);
14042: for (my $i=0; $i < scalar(@ids); $i++) {
14043: if ($types[$i] eq 'essay') {
14044: my $partid = $part.'_'.$ids[$i];
14045: if (&Apache::lonnet::EXT("resource.$partid.uploadedfiletypes") ne '') {
14046: $totaluploads ++;
14047: }
14048: }
14049: }
14050: }
14051: if ($totaluploads > 1) {
14052: $multiresp = 1;
14053: }
14054: }
14055: }
14056: }
14057: } else {
14058: return;
14059: }
14060: } else {
14061: return;
14062: }
14063: my $restitle=&Apache::lonnet::gettitle($symb);
14064: $restitle =~ s/\W+/_/g;
14065: if ($restitle eq '') {
14066: $restitle = ($resurl =~ m{/[^/]+$});
14067: if ($restitle eq '') {
14068: $restitle = time;
14069: }
14070: }
1.1149 raeburn 14071: if (length($restitle) > 12) {
14072: $restitle = substr($restitle,0,12);
14073: }
1.1015 raeburn 14074: push(@pathitems,$restitle);
14075: $path .= join('/',@pathitems);
14076: }
14077: return ($path,$multiresp);
14078: }
14079:
14080: =pod
14081:
1.464 albertel 14082: =back
1.41 ng 14083:
1.112 bowersj2 14084: =head1 CSV Upload/Handling functions
1.38 albertel 14085:
1.41 ng 14086: =over 4
14087:
1.648 raeburn 14088: =item * &upfile_store($r)
1.41 ng 14089:
14090: Store uploaded file, $r should be the HTTP Request object,
1.258 albertel 14091: needs $env{'form.upfile'}
1.41 ng 14092: returns $datatoken to be put into hidden field
14093:
14094: =cut
1.31 albertel 14095:
14096: sub upfile_store {
14097: my $r=shift;
1.258 albertel 14098: $env{'form.upfile'}=~s/\r/\n/gs;
14099: $env{'form.upfile'}=~s/\f/\n/gs;
14100: $env{'form.upfile'}=~s/\n+/\n/gs;
14101: $env{'form.upfile'}=~s/\n+$//gs;
1.31 albertel 14102:
1.1299 raeburn 14103: my $datatoken = &valid_datatoken($env{'user.name'}.'_'.$env{'user.domain'}.
14104: '_enroll_'.$env{'request.course.id'}.'_'.
14105: time.'_'.$$);
14106: return if ($datatoken eq '');
14107:
1.31 albertel 14108: {
1.158 raeburn 14109: my $datafile = $r->dir_config('lonDaemons').
14110: '/tmp/'.$datatoken.'.tmp';
1.1317 raeburn 14111: if ( open(my $fh,'>',$datafile) ) {
1.258 albertel 14112: print $fh $env{'form.upfile'};
1.158 raeburn 14113: close($fh);
14114: }
1.31 albertel 14115: }
14116: return $datatoken;
14117: }
14118:
1.56 matthew 14119: =pod
14120:
1.1290 raeburn 14121: =item * &load_tmp_file($r,$datatoken)
1.41 ng 14122:
14123: Load uploaded file from tmp, $r should be the HTTP Request object,
1.1290 raeburn 14124: $datatoken is the name to assign to the temporary file.
1.258 albertel 14125: sets $env{'form.upfile'} to the contents of the file
1.41 ng 14126:
14127: =cut
1.31 albertel 14128:
14129: sub load_tmp_file {
1.1290 raeburn 14130: my ($r,$datatoken) = @_;
14131: return if ($datatoken eq '');
1.31 albertel 14132: my @studentdata=();
14133: {
1.158 raeburn 14134: my $studentfile = $r->dir_config('lonDaemons').
1.1290 raeburn 14135: '/tmp/'.$datatoken.'.tmp';
1.1317 raeburn 14136: if ( open(my $fh,'<',$studentfile) ) {
1.158 raeburn 14137: @studentdata=<$fh>;
14138: close($fh);
14139: }
1.31 albertel 14140: }
1.258 albertel 14141: $env{'form.upfile'}=join('',@studentdata);
1.31 albertel 14142: }
14143:
1.1290 raeburn 14144: sub valid_datatoken {
14145: my ($datatoken) = @_;
1.1325 raeburn 14146: if ($datatoken =~ /^$match_username\_$match_domain\_enroll_(|$match_domain\_$match_courseid)\_\d+_\d+$/) {
1.1290 raeburn 14147: return $datatoken;
14148: }
14149: return;
14150: }
14151:
1.56 matthew 14152: =pod
14153:
1.648 raeburn 14154: =item * &upfile_record_sep()
1.41 ng 14155:
14156: Separate uploaded file into records
14157: returns array of records,
1.258 albertel 14158: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41 ng 14159:
14160: =cut
1.31 albertel 14161:
14162: sub upfile_record_sep {
1.258 albertel 14163: if ($env{'form.upfiletype'} eq 'xml') {
1.31 albertel 14164: } else {
1.248 albertel 14165: my @records;
1.258 albertel 14166: foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248 albertel 14167: if ($line=~/^\s*$/) { next; }
14168: push(@records,$line);
14169: }
14170: return @records;
1.31 albertel 14171: }
14172: }
14173:
1.56 matthew 14174: =pod
14175:
1.648 raeburn 14176: =item * &record_sep($record)
1.41 ng 14177:
1.258 albertel 14178: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41 ng 14179:
14180: =cut
14181:
1.263 www 14182: sub takeleft {
14183: my $index=shift;
14184: return substr('0000'.$index,-4,4);
14185: }
14186:
1.31 albertel 14187: sub record_sep {
14188: my $record=shift;
14189: my %components=();
1.258 albertel 14190: if ($env{'form.upfiletype'} eq 'xml') {
14191: } elsif ($env{'form.upfiletype'} eq 'space') {
1.31 albertel 14192: my $i=0;
1.356 albertel 14193: foreach my $field (split(/\s+/,$record)) {
1.31 albertel 14194: $field=~s/^(\"|\')//;
14195: $field=~s/(\"|\')$//;
1.263 www 14196: $components{&takeleft($i)}=$field;
1.31 albertel 14197: $i++;
14198: }
1.258 albertel 14199: } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31 albertel 14200: my $i=0;
1.356 albertel 14201: foreach my $field (split(/\t/,$record)) {
1.31 albertel 14202: $field=~s/^(\"|\')//;
14203: $field=~s/(\"|\')$//;
1.263 www 14204: $components{&takeleft($i)}=$field;
1.31 albertel 14205: $i++;
14206: }
14207: } else {
1.561 www 14208: my $separator=',';
1.480 banghart 14209: if ($env{'form.upfiletype'} eq 'semisv') {
1.561 www 14210: $separator=';';
1.480 banghart 14211: }
1.31 albertel 14212: my $i=0;
1.561 www 14213: # the character we are looking for to indicate the end of a quote or a record
14214: my $looking_for=$separator;
14215: # do not add the characters to the fields
14216: my $ignore=0;
14217: # we just encountered a separator (or the beginning of the record)
14218: my $just_found_separator=1;
14219: # store the field we are working on here
14220: my $field='';
14221: # work our way through all characters in record
14222: foreach my $character ($record=~/(.)/g) {
14223: if ($character eq $looking_for) {
14224: if ($character ne $separator) {
14225: # Found the end of a quote, again looking for separator
14226: $looking_for=$separator;
14227: $ignore=1;
14228: } else {
14229: # Found a separator, store away what we got
14230: $components{&takeleft($i)}=$field;
14231: $i++;
14232: $just_found_separator=1;
14233: $ignore=0;
14234: $field='';
14235: }
14236: next;
14237: }
14238: # single or double quotation marks after a separator indicate beginning of a quote
14239: # we are now looking for the end of the quote and need to ignore separators
14240: if ((($character eq '"') || ($character eq "'")) && ($just_found_separator)) {
14241: $looking_for=$character;
14242: next;
14243: }
14244: # ignore would be true after we reached the end of a quote
14245: if ($ignore) { next; }
14246: if (($just_found_separator) && ($character=~/\s/)) { next; }
14247: $field.=$character;
14248: $just_found_separator=0;
1.31 albertel 14249: }
1.561 www 14250: # catch the very last entry, since we never encountered the separator
14251: $components{&takeleft($i)}=$field;
1.31 albertel 14252: }
14253: return %components;
14254: }
14255:
1.144 matthew 14256: ######################################################
14257: ######################################################
14258:
1.56 matthew 14259: =pod
14260:
1.648 raeburn 14261: =item * &upfile_select_html()
1.41 ng 14262:
1.144 matthew 14263: Return HTML code to select a file from the users machine and specify
14264: the file type.
1.41 ng 14265:
14266: =cut
14267:
1.144 matthew 14268: ######################################################
14269: ######################################################
1.31 albertel 14270: sub upfile_select_html {
1.144 matthew 14271: my %Types = (
14272: csv => &mt('CSV (comma separated values, spreadsheet)'),
1.480 banghart 14273: semisv => &mt('Semicolon separated values'),
1.144 matthew 14274: space => &mt('Space separated'),
14275: tab => &mt('Tabulator separated'),
14276: # xml => &mt('HTML/XML'),
14277: );
14278: my $Str = '<input type="file" name="upfile" size="50" />'.
1.727 riegler 14279: '<br />'.&mt('Type').': <select name="upfiletype">';
1.144 matthew 14280: foreach my $type (sort(keys(%Types))) {
14281: $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
14282: }
14283: $Str .= "</select>\n";
14284: return $Str;
1.31 albertel 14285: }
14286:
1.301 albertel 14287: sub get_samples {
14288: my ($records,$toget) = @_;
14289: my @samples=({});
14290: my $got=0;
14291: foreach my $rec (@$records) {
14292: my %temp = &record_sep($rec);
14293: if (! grep(/\S/, values(%temp))) { next; }
14294: if (%temp) {
14295: $samples[$got]=\%temp;
14296: $got++;
14297: if ($got == $toget) { last; }
14298: }
14299: }
14300: return \@samples;
14301: }
14302:
1.144 matthew 14303: ######################################################
14304: ######################################################
14305:
1.56 matthew 14306: =pod
14307:
1.648 raeburn 14308: =item * &csv_print_samples($r,$records)
1.41 ng 14309:
14310: Prints a table of sample values from each column uploaded $r is an
14311: Apache Request ref, $records is an arrayref from
14312: &Apache::loncommon::upfile_record_sep
14313:
14314: =cut
14315:
1.144 matthew 14316: ######################################################
14317: ######################################################
1.31 albertel 14318: sub csv_print_samples {
14319: my ($r,$records) = @_;
1.662 bisitz 14320: my $samples = &get_samples($records,5);
1.301 albertel 14321:
1.594 raeburn 14322: $r->print(&mt('Samples').'<br />'.&start_data_table().
14323: &start_data_table_header_row());
1.356 albertel 14324: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.845 bisitz 14325: $r->print('<th>'.&mt('Column [_1]',($sample+1)).'</th>'); }
1.594 raeburn 14326: $r->print(&end_data_table_header_row());
1.301 albertel 14327: foreach my $hash (@$samples) {
1.594 raeburn 14328: $r->print(&start_data_table_row());
1.356 albertel 14329: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.31 albertel 14330: $r->print('<td>');
1.356 albertel 14331: if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
1.31 albertel 14332: $r->print('</td>');
14333: }
1.594 raeburn 14334: $r->print(&end_data_table_row());
1.31 albertel 14335: }
1.594 raeburn 14336: $r->print(&end_data_table().'<br />'."\n");
1.31 albertel 14337: }
14338:
1.144 matthew 14339: ######################################################
14340: ######################################################
14341:
1.56 matthew 14342: =pod
14343:
1.648 raeburn 14344: =item * &csv_print_select_table($r,$records,$d)
1.41 ng 14345:
14346: Prints a table to create associations between values and table columns.
1.144 matthew 14347:
1.41 ng 14348: $r is an Apache Request ref,
14349: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174 matthew 14350: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41 ng 14351:
14352: =cut
14353:
1.144 matthew 14354: ######################################################
14355: ######################################################
1.31 albertel 14356: sub csv_print_select_table {
14357: my ($r,$records,$d) = @_;
1.301 albertel 14358: my $i=0;
14359: my $samples = &get_samples($records,1);
1.144 matthew 14360: $r->print(&mt('Associate columns with student attributes.')."\n".
1.594 raeburn 14361: &start_data_table().&start_data_table_header_row().
1.144 matthew 14362: '<th>'.&mt('Attribute').'</th>'.
1.594 raeburn 14363: '<th>'.&mt('Column').'</th>'.
14364: &end_data_table_header_row()."\n");
1.356 albertel 14365: foreach my $array_ref (@$d) {
14366: my ($value,$display,$defaultcol)=@{ $array_ref };
1.729 raeburn 14367: $r->print(&start_data_table_row().'<td>'.$display.'</td>');
1.31 albertel 14368:
1.875 bisitz 14369: $r->print('<td><select name="f'.$i.'"'.
1.32 matthew 14370: ' onchange="javascript:flip(this.form,'.$i.');">');
1.31 albertel 14371: $r->print('<option value="none"></option>');
1.356 albertel 14372: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
14373: $r->print('<option value="'.$sample.'"'.
14374: ($sample eq $defaultcol ? ' selected="selected" ' : '').
1.662 bisitz 14375: '>'.&mt('Column [_1]',($sample+1)).'</option>');
1.31 albertel 14376: }
1.594 raeburn 14377: $r->print('</select></td>'.&end_data_table_row()."\n");
1.31 albertel 14378: $i++;
14379: }
1.594 raeburn 14380: $r->print(&end_data_table());
1.31 albertel 14381: $i--;
14382: return $i;
14383: }
1.56 matthew 14384:
1.144 matthew 14385: ######################################################
14386: ######################################################
14387:
1.56 matthew 14388: =pod
1.31 albertel 14389:
1.648 raeburn 14390: =item * &csv_samples_select_table($r,$records,$d)
1.41 ng 14391:
14392: Prints a table of sample values from the upload and can make associate samples to internal names.
14393:
14394: $r is an Apache Request ref,
14395: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
14396: $d is an array of 2 element arrays (internal name, displayed name)
14397:
14398: =cut
14399:
1.144 matthew 14400: ######################################################
14401: ######################################################
1.31 albertel 14402: sub csv_samples_select_table {
14403: my ($r,$records,$d) = @_;
14404: my $i=0;
1.144 matthew 14405: #
1.662 bisitz 14406: my $max_samples = 5;
14407: my $samples = &get_samples($records,$max_samples);
1.594 raeburn 14408: $r->print(&start_data_table().
14409: &start_data_table_header_row().'<th>'.
14410: &mt('Field').'</th><th>'.&mt('Samples').'</th>'.
14411: &end_data_table_header_row());
1.301 albertel 14412:
14413: foreach my $key (sort(keys(%{ $samples->[0] }))) {
1.594 raeburn 14414: $r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
1.32 matthew 14415: ' onchange="javascript:flip(this.form,'.$i.');">');
1.301 albertel 14416: foreach my $option (@$d) {
14417: my ($value,$display,$defaultcol)=@{ $option };
1.174 matthew 14418: $r->print('<option value="'.$value.'"'.
1.253 albertel 14419: ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174 matthew 14420: $display.'</option>');
1.31 albertel 14421: }
14422: $r->print('</select></td><td>');
1.662 bisitz 14423: foreach my $line (0..($max_samples-1)) {
1.301 albertel 14424: if (defined($samples->[$line]{$key})) {
14425: $r->print($samples->[$line]{$key}."<br />\n");
14426: }
14427: }
1.594 raeburn 14428: $r->print('</td>'.&end_data_table_row());
1.31 albertel 14429: $i++;
14430: }
1.594 raeburn 14431: $r->print(&end_data_table());
1.31 albertel 14432: $i--;
14433: return($i);
1.115 matthew 14434: }
14435:
1.144 matthew 14436: ######################################################
14437: ######################################################
14438:
1.115 matthew 14439: =pod
14440:
1.648 raeburn 14441: =item * &clean_excel_name($name)
1.115 matthew 14442:
14443: Returns a replacement for $name which does not contain any illegal characters.
14444:
14445: =cut
14446:
1.144 matthew 14447: ######################################################
14448: ######################################################
1.115 matthew 14449: sub clean_excel_name {
14450: my ($name) = @_;
14451: $name =~ s/[:\*\?\/\\]//g;
14452: if (length($name) > 31) {
14453: $name = substr($name,0,31);
14454: }
14455: return $name;
1.25 albertel 14456: }
1.84 albertel 14457:
1.85 albertel 14458: =pod
14459:
1.648 raeburn 14460: =item * &check_if_partid_hidden($id,$symb,$udom,$uname)
1.85 albertel 14461:
14462: Returns either 1 or undef
14463:
14464: 1 if the part is to be hidden, undef if it is to be shown
14465:
14466: Arguments are:
14467:
14468: $id the id of the part to be checked
14469: $symb, optional the symb of the resource to check
14470: $udom, optional the domain of the user to check for
14471: $uname, optional the username of the user to check for
14472:
14473: =cut
1.84 albertel 14474:
14475: sub check_if_partid_hidden {
14476: my ($id,$symb,$udom,$uname) = @_;
1.133 albertel 14477: my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84 albertel 14478: $symb,$udom,$uname);
1.141 albertel 14479: my $truth=1;
14480: #if the string starts with !, then the list is the list to show not hide
14481: if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84 albertel 14482: my @hiddenlist=split(/,/,$hiddenparts);
14483: foreach my $checkid (@hiddenlist) {
1.141 albertel 14484: if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84 albertel 14485: }
1.141 albertel 14486: return !$truth;
1.84 albertel 14487: }
1.127 matthew 14488:
1.138 matthew 14489:
14490: ############################################################
14491: ############################################################
14492:
14493: =pod
14494:
1.157 matthew 14495: =back
14496:
1.138 matthew 14497: =head1 cgi-bin script and graphing routines
14498:
1.157 matthew 14499: =over 4
14500:
1.648 raeburn 14501: =item * &get_cgi_id()
1.138 matthew 14502:
14503: Inputs: none
14504:
14505: Returns an id which can be used to pass environment variables
14506: to various cgi-bin scripts. These environment variables will
14507: be removed from the users environment after a given time by
14508: the routine &Apache::lonnet::transfer_profile_to_env.
14509:
14510: =cut
14511:
14512: ############################################################
14513: ############################################################
1.152 albertel 14514: my $uniq=0;
1.136 matthew 14515: sub get_cgi_id {
1.154 albertel 14516: $uniq=($uniq+1)%100000;
1.280 albertel 14517: return (time.'_'.$$.'_'.$uniq);
1.136 matthew 14518: }
14519:
1.127 matthew 14520: ############################################################
14521: ############################################################
14522:
14523: =pod
14524:
1.648 raeburn 14525: =item * &DrawBarGraph()
1.127 matthew 14526:
1.138 matthew 14527: Facilitates the plotting of data in a (stacked) bar graph.
14528: Puts plot definition data into the users environment in order for
14529: graph.png to plot it. Returns an <img> tag for the plot.
14530: The bars on the plot are labeled '1','2',...,'n'.
14531:
14532: Inputs:
14533:
14534: =over 4
14535:
14536: =item $Title: string, the title of the plot
14537:
14538: =item $xlabel: string, text describing the X-axis of the plot
14539:
14540: =item $ylabel: string, text describing the Y-axis of the plot
14541:
14542: =item $Max: scalar, the maximum Y value to use in the plot
14543: If $Max is < any data point, the graph will not be rendered.
14544:
1.140 matthew 14545: =item $colors: array ref holding the colors to be used for the data sets when
1.138 matthew 14546: they are plotted. If undefined, default values will be used.
14547:
1.178 matthew 14548: =item $labels: array ref holding the labels to use on the x-axis for the bars.
14549:
1.138 matthew 14550: =item @Values: An array of array references. Each array reference holds data
14551: to be plotted in a stacked bar chart.
14552:
1.239 matthew 14553: =item If the final element of @Values is a hash reference the key/value
14554: pairs will be added to the graph definition.
14555:
1.138 matthew 14556: =back
14557:
14558: Returns:
14559:
14560: An <img> tag which references graph.png and the appropriate identifying
14561: information for the plot.
14562:
1.127 matthew 14563: =cut
14564:
14565: ############################################################
14566: ############################################################
1.134 matthew 14567: sub DrawBarGraph {
1.178 matthew 14568: my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134 matthew 14569: #
14570: if (! defined($colors)) {
14571: $colors = ['#33ff00',
14572: '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
14573: '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
14574: ];
14575: }
1.228 matthew 14576: my $extra_settings = {};
14577: if (ref($Values[-1]) eq 'HASH') {
14578: $extra_settings = pop(@Values);
14579: }
1.127 matthew 14580: #
1.136 matthew 14581: my $identifier = &get_cgi_id();
14582: my $id = 'cgi.'.$identifier;
1.129 matthew 14583: if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127 matthew 14584: return '';
14585: }
1.225 matthew 14586: #
14587: my @Labels;
14588: if (defined($labels)) {
14589: @Labels = @$labels;
14590: } else {
14591: for (my $i=0;$i<@{$Values[0]};$i++) {
1.1263 raeburn 14592: push(@Labels,$i+1);
1.225 matthew 14593: }
14594: }
14595: #
1.129 matthew 14596: my $NumBars = scalar(@{$Values[0]});
1.225 matthew 14597: if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129 matthew 14598: my %ValuesHash;
14599: my $NumSets=1;
14600: foreach my $array (@Values) {
14601: next if (! ref($array));
1.136 matthew 14602: $ValuesHash{$id.'.data.'.$NumSets++} =
1.132 matthew 14603: join(',',@$array);
1.129 matthew 14604: }
1.127 matthew 14605: #
1.136 matthew 14606: my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225 matthew 14607: if ($NumBars < 3) {
14608: $width = 120+$NumBars*32;
1.220 matthew 14609: $xskip = 1;
1.225 matthew 14610: $bar_width = 30;
14611: } elsif ($NumBars < 5) {
14612: $width = 120+$NumBars*20;
14613: $xskip = 1;
14614: $bar_width = 20;
1.220 matthew 14615: } elsif ($NumBars < 10) {
1.136 matthew 14616: $width = 120+$NumBars*15;
14617: $xskip = 1;
14618: $bar_width = 15;
14619: } elsif ($NumBars <= 25) {
14620: $width = 120+$NumBars*11;
14621: $xskip = 5;
14622: $bar_width = 8;
14623: } elsif ($NumBars <= 50) {
14624: $width = 120+$NumBars*8;
14625: $xskip = 5;
14626: $bar_width = 4;
14627: } else {
14628: $width = 120+$NumBars*8;
14629: $xskip = 5;
14630: $bar_width = 4;
14631: }
14632: #
1.137 matthew 14633: $Max = 1 if ($Max < 1);
14634: if ( int($Max) < $Max ) {
14635: $Max++;
14636: $Max = int($Max);
14637: }
1.127 matthew 14638: $Title = '' if (! defined($Title));
14639: $xlabel = '' if (! defined($xlabel));
14640: $ylabel = '' if (! defined($ylabel));
1.369 www 14641: $ValuesHash{$id.'.title'} = &escape($Title);
14642: $ValuesHash{$id.'.xlabel'} = &escape($xlabel);
14643: $ValuesHash{$id.'.ylabel'} = &escape($ylabel);
1.137 matthew 14644: $ValuesHash{$id.'.y_max_value'} = $Max;
1.136 matthew 14645: $ValuesHash{$id.'.NumBars'} = $NumBars;
14646: $ValuesHash{$id.'.NumSets'} = $NumSets;
14647: $ValuesHash{$id.'.PlotType'} = 'bar';
14648: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
14649: $ValuesHash{$id.'.height'} = $height;
14650: $ValuesHash{$id.'.width'} = $width;
14651: $ValuesHash{$id.'.xskip'} = $xskip;
14652: $ValuesHash{$id.'.bar_width'} = $bar_width;
14653: $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127 matthew 14654: #
1.228 matthew 14655: # Deal with other parameters
14656: while (my ($key,$value) = each(%$extra_settings)) {
14657: $ValuesHash{$id.'.'.$key} = $value;
14658: }
14659: #
1.646 raeburn 14660: &Apache::lonnet::appenv(\%ValuesHash);
1.137 matthew 14661: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
14662: }
14663:
14664: ############################################################
14665: ############################################################
14666:
14667: =pod
14668:
1.648 raeburn 14669: =item * &DrawXYGraph()
1.137 matthew 14670:
1.138 matthew 14671: Facilitates the plotting of data in an XY graph.
14672: Puts plot definition data into the users environment in order for
14673: graph.png to plot it. Returns an <img> tag for the plot.
14674:
14675: Inputs:
14676:
14677: =over 4
14678:
14679: =item $Title: string, the title of the plot
14680:
14681: =item $xlabel: string, text describing the X-axis of the plot
14682:
14683: =item $ylabel: string, text describing the Y-axis of the plot
14684:
14685: =item $Max: scalar, the maximum Y value to use in the plot
14686: If $Max is < any data point, the graph will not be rendered.
14687:
14688: =item $colors: Array ref containing the hex color codes for the data to be
14689: plotted in. If undefined, default values will be used.
14690:
14691: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
14692:
14693: =item $Ydata: Array ref containing Array refs.
1.185 www 14694: Each of the contained arrays will be plotted as a separate curve.
1.138 matthew 14695:
14696: =item %Values: hash indicating or overriding any default values which are
14697: passed to graph.png.
14698: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
14699:
14700: =back
14701:
14702: Returns:
14703:
14704: An <img> tag which references graph.png and the appropriate identifying
14705: information for the plot.
14706:
1.137 matthew 14707: =cut
14708:
14709: ############################################################
14710: ############################################################
14711: sub DrawXYGraph {
14712: my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
14713: #
14714: # Create the identifier for the graph
14715: my $identifier = &get_cgi_id();
14716: my $id = 'cgi.'.$identifier;
14717: #
14718: $Title = '' if (! defined($Title));
14719: $xlabel = '' if (! defined($xlabel));
14720: $ylabel = '' if (! defined($ylabel));
14721: my %ValuesHash =
14722: (
1.369 www 14723: $id.'.title' => &escape($Title),
14724: $id.'.xlabel' => &escape($xlabel),
14725: $id.'.ylabel' => &escape($ylabel),
1.137 matthew 14726: $id.'.y_max_value'=> $Max,
14727: $id.'.labels' => join(',',@$Xlabels),
14728: $id.'.PlotType' => 'XY',
14729: );
14730: #
14731: if (defined($colors) && ref($colors) eq 'ARRAY') {
14732: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
14733: }
14734: #
14735: if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
14736: return '';
14737: }
14738: my $NumSets=1;
1.138 matthew 14739: foreach my $array (@{$Ydata}){
1.137 matthew 14740: next if (! ref($array));
14741: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
14742: }
1.138 matthew 14743: $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137 matthew 14744: #
14745: # Deal with other parameters
14746: while (my ($key,$value) = each(%Values)) {
14747: $ValuesHash{$id.'.'.$key} = $value;
1.127 matthew 14748: }
14749: #
1.646 raeburn 14750: &Apache::lonnet::appenv(\%ValuesHash);
1.136 matthew 14751: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
14752: }
14753:
14754: ############################################################
14755: ############################################################
14756:
14757: =pod
14758:
1.648 raeburn 14759: =item * &DrawXYYGraph()
1.138 matthew 14760:
14761: Facilitates the plotting of data in an XY graph with two Y axes.
14762: Puts plot definition data into the users environment in order for
14763: graph.png to plot it. Returns an <img> tag for the plot.
14764:
14765: Inputs:
14766:
14767: =over 4
14768:
14769: =item $Title: string, the title of the plot
14770:
14771: =item $xlabel: string, text describing the X-axis of the plot
14772:
14773: =item $ylabel: string, text describing the Y-axis of the plot
14774:
14775: =item $colors: Array ref containing the hex color codes for the data to be
14776: plotted in. If undefined, default values will be used.
14777:
14778: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
14779:
14780: =item $Ydata1: The first data set
14781:
14782: =item $Min1: The minimum value of the left Y-axis
14783:
14784: =item $Max1: The maximum value of the left Y-axis
14785:
14786: =item $Ydata2: The second data set
14787:
14788: =item $Min2: The minimum value of the right Y-axis
14789:
14790: =item $Max2: The maximum value of the left Y-axis
14791:
14792: =item %Values: hash indicating or overriding any default values which are
14793: passed to graph.png.
14794: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
14795:
14796: =back
14797:
14798: Returns:
14799:
14800: An <img> tag which references graph.png and the appropriate identifying
14801: information for the plot.
1.136 matthew 14802:
14803: =cut
14804:
14805: ############################################################
14806: ############################################################
1.137 matthew 14807: sub DrawXYYGraph {
14808: my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
14809: $Ydata2,$Min2,$Max2,%Values)=@_;
1.136 matthew 14810: #
14811: # Create the identifier for the graph
14812: my $identifier = &get_cgi_id();
14813: my $id = 'cgi.'.$identifier;
14814: #
14815: $Title = '' if (! defined($Title));
14816: $xlabel = '' if (! defined($xlabel));
14817: $ylabel = '' if (! defined($ylabel));
14818: my %ValuesHash =
14819: (
1.369 www 14820: $id.'.title' => &escape($Title),
14821: $id.'.xlabel' => &escape($xlabel),
14822: $id.'.ylabel' => &escape($ylabel),
1.136 matthew 14823: $id.'.labels' => join(',',@$Xlabels),
14824: $id.'.PlotType' => 'XY',
14825: $id.'.NumSets' => 2,
1.137 matthew 14826: $id.'.two_axes' => 1,
14827: $id.'.y1_max_value' => $Max1,
14828: $id.'.y1_min_value' => $Min1,
14829: $id.'.y2_max_value' => $Max2,
14830: $id.'.y2_min_value' => $Min2,
1.136 matthew 14831: );
14832: #
1.137 matthew 14833: if (defined($colors) && ref($colors) eq 'ARRAY') {
14834: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
14835: }
14836: #
14837: if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
14838: ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136 matthew 14839: return '';
14840: }
14841: my $NumSets=1;
1.137 matthew 14842: foreach my $array ($Ydata1,$Ydata2){
1.136 matthew 14843: next if (! ref($array));
14844: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137 matthew 14845: }
14846: #
14847: # Deal with other parameters
14848: while (my ($key,$value) = each(%Values)) {
14849: $ValuesHash{$id.'.'.$key} = $value;
1.136 matthew 14850: }
14851: #
1.646 raeburn 14852: &Apache::lonnet::appenv(\%ValuesHash);
1.130 albertel 14853: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139 matthew 14854: }
14855:
14856: ############################################################
14857: ############################################################
14858:
14859: =pod
14860:
1.157 matthew 14861: =back
14862:
1.139 matthew 14863: =head1 Statistics helper routines?
14864:
14865: Bad place for them but what the hell.
14866:
1.157 matthew 14867: =over 4
14868:
1.648 raeburn 14869: =item * &chartlink()
1.139 matthew 14870:
14871: Returns a link to the chart for a specific student.
14872:
14873: Inputs:
14874:
14875: =over 4
14876:
14877: =item $linktext: The text of the link
14878:
14879: =item $sname: The students username
14880:
14881: =item $sdomain: The students domain
14882:
14883: =back
14884:
1.157 matthew 14885: =back
14886:
1.139 matthew 14887: =cut
14888:
14889: ############################################################
14890: ############################################################
14891: sub chartlink {
14892: my ($linktext, $sname, $sdomain) = @_;
14893: my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.369 www 14894: '&SelectedStudent='.&escape($sname.':'.$sdomain).
1.219 albertel 14895: '&chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139 matthew 14896: '">'.$linktext.'</a>';
1.153 matthew 14897: }
14898:
14899: #######################################################
14900: #######################################################
14901:
14902: =pod
14903:
14904: =head1 Course Environment Routines
1.157 matthew 14905:
14906: =over 4
1.153 matthew 14907:
1.648 raeburn 14908: =item * &restore_course_settings()
1.153 matthew 14909:
1.648 raeburn 14910: =item * &store_course_settings()
1.153 matthew 14911:
14912: Restores/Store indicated form parameters from the course environment.
14913: Will not overwrite existing values of the form parameters.
14914:
14915: Inputs:
14916: a scalar describing the data (e.g. 'chart', 'problem_analysis')
14917:
14918: a hash ref describing the data to be stored. For example:
14919:
14920: %Save_Parameters = ('Status' => 'scalar',
14921: 'chartoutputmode' => 'scalar',
14922: 'chartoutputdata' => 'scalar',
14923: 'Section' => 'array',
1.373 raeburn 14924: 'Group' => 'array',
1.153 matthew 14925: 'StudentData' => 'array',
14926: 'Maps' => 'array');
14927:
14928: Returns: both routines return nothing
14929:
1.631 raeburn 14930: =back
14931:
1.153 matthew 14932: =cut
14933:
14934: #######################################################
14935: #######################################################
14936: sub store_course_settings {
1.496 albertel 14937: return &store_settings($env{'request.course.id'},@_);
14938: }
14939:
14940: sub store_settings {
1.153 matthew 14941: # save to the environment
14942: # appenv the same items, just to be safe
1.300 albertel 14943: my $udom = $env{'user.domain'};
14944: my $uname = $env{'user.name'};
1.496 albertel 14945: my ($context,$prefix,$Settings) = @_;
1.153 matthew 14946: my %SaveHash;
14947: my %AppHash;
14948: while (my ($setting,$type) = each(%$Settings)) {
1.496 albertel 14949: my $basename = join('.','internal',$context,$prefix,$setting);
1.300 albertel 14950: my $envname = 'environment.'.$basename;
1.258 albertel 14951: if (exists($env{'form.'.$setting})) {
1.153 matthew 14952: # Save this value away
14953: if ($type eq 'scalar' &&
1.258 albertel 14954: (! exists($env{$envname}) ||
14955: $env{$envname} ne $env{'form.'.$setting})) {
14956: $SaveHash{$basename} = $env{'form.'.$setting};
14957: $AppHash{$envname} = $env{'form.'.$setting};
1.153 matthew 14958: } elsif ($type eq 'array') {
14959: my $stored_form;
1.258 albertel 14960: if (ref($env{'form.'.$setting})) {
1.153 matthew 14961: $stored_form = join(',',
14962: map {
1.369 www 14963: &escape($_);
1.258 albertel 14964: } sort(@{$env{'form.'.$setting}}));
1.153 matthew 14965: } else {
14966: $stored_form =
1.369 www 14967: &escape($env{'form.'.$setting});
1.153 matthew 14968: }
14969: # Determine if the array contents are the same.
1.258 albertel 14970: if ($stored_form ne $env{$envname}) {
1.153 matthew 14971: $SaveHash{$basename} = $stored_form;
14972: $AppHash{$envname} = $stored_form;
14973: }
14974: }
14975: }
14976: }
14977: my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
1.300 albertel 14978: $udom,$uname);
1.153 matthew 14979: if ($put_result !~ /^(ok|delayed)/) {
14980: &Apache::lonnet::logthis('unable to save form parameters, '.
14981: 'got error:'.$put_result);
14982: }
14983: # Make sure these settings stick around in this session, too
1.646 raeburn 14984: &Apache::lonnet::appenv(\%AppHash);
1.153 matthew 14985: return;
14986: }
14987:
14988: sub restore_course_settings {
1.499 albertel 14989: return &restore_settings($env{'request.course.id'},@_);
1.496 albertel 14990: }
14991:
14992: sub restore_settings {
14993: my ($context,$prefix,$Settings) = @_;
1.153 matthew 14994: while (my ($setting,$type) = each(%$Settings)) {
1.258 albertel 14995: next if (exists($env{'form.'.$setting}));
1.496 albertel 14996: my $envname = 'environment.internal.'.$context.'.'.$prefix.
1.153 matthew 14997: '.'.$setting;
1.258 albertel 14998: if (exists($env{$envname})) {
1.153 matthew 14999: if ($type eq 'scalar') {
1.258 albertel 15000: $env{'form.'.$setting} = $env{$envname};
1.153 matthew 15001: } elsif ($type eq 'array') {
1.258 albertel 15002: $env{'form.'.$setting} = [
1.153 matthew 15003: map {
1.369 www 15004: &unescape($_);
1.258 albertel 15005: } split(',',$env{$envname})
1.153 matthew 15006: ];
15007: }
15008: }
15009: }
1.127 matthew 15010: }
15011:
1.618 raeburn 15012: #######################################################
15013: #######################################################
15014:
15015: =pod
15016:
15017: =head1 Domain E-mail Routines
15018:
15019: =over 4
15020:
1.648 raeburn 15021: =item * &build_recipient_list()
1.618 raeburn 15022:
1.1144 raeburn 15023: Build recipient lists for following types of e-mail:
1.766 raeburn 15024: (a) Error Reports, (b) Package Updates, (c) lonstatus warnings/errors
1.1144 raeburn 15025: (d) Help requests, (e) Course requests needing approval, (f) loncapa
15026: module change checking, student/employee ID conflict checks, as
15027: generated by lonerrorhandler.pm, CHECKRPMS, loncron,
15028: lonsupportreq.pm, loncoursequeueadmin.pm, searchcat.pl respectively.
1.618 raeburn 15029:
15030: Inputs:
1.619 raeburn 15031: defmail (scalar - email address of default recipient),
1.1144 raeburn 15032: mailing type (scalar: errormail, packagesmail, helpdeskmail,
15033: requestsmail, updatesmail, or idconflictsmail).
15034:
1.619 raeburn 15035: defdom (domain for which to retrieve configuration settings),
1.1144 raeburn 15036:
1.619 raeburn 15037: origmail (scalar - email address of recipient from loncapa.conf,
1.1297 raeburn 15038: i.e., predates configuration by DC via domainprefs.pm
15039:
15040: $requname username of requester (if mailing type is helpdeskmail)
15041:
15042: $requdom domain of requester (if mailing type is helpdeskmail)
15043:
15044: $reqemail e-mail address of requester (if mailing type is helpdeskmail)
15045:
1.618 raeburn 15046:
1.655 raeburn 15047: Returns: comma separated list of addresses to which to send e-mail.
15048:
15049: =back
1.618 raeburn 15050:
15051: =cut
15052:
15053: ############################################################
15054: ############################################################
15055: sub build_recipient_list {
1.1297 raeburn 15056: my ($defmail,$mailing,$defdom,$origmail,$requname,$requdom,$reqemail) = @_;
1.618 raeburn 15057: my @recipients;
1.1270 raeburn 15058: my ($otheremails,$lastresort,$allbcc,$addtext);
1.618 raeburn 15059: my %domconfig =
1.1270 raeburn 15060: &Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
1.618 raeburn 15061: if (ref($domconfig{'contacts'}) eq 'HASH') {
1.766 raeburn 15062: if (exists($domconfig{'contacts'}{$mailing})) {
15063: if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
15064: my @contacts = ('adminemail','supportemail');
15065: foreach my $item (@contacts) {
15066: if ($domconfig{'contacts'}{$mailing}{$item}) {
15067: my $addr = $domconfig{'contacts'}{$item};
15068: if (!grep(/^\Q$addr\E$/,@recipients)) {
15069: push(@recipients,$addr);
15070: }
1.619 raeburn 15071: }
1.1270 raeburn 15072: }
15073: $otheremails = $domconfig{'contacts'}{$mailing}{'others'};
15074: if ($mailing eq 'helpdeskmail') {
15075: if ($domconfig{'contacts'}{$mailing}{'bcc'}) {
15076: my @bccs = split(/,/,$domconfig{'contacts'}{$mailing}{'bcc'});
15077: my @ok_bccs;
15078: foreach my $bcc (@bccs) {
15079: $bcc =~ s/^\s+//g;
15080: $bcc =~ s/\s+$//g;
15081: if ($bcc =~ m/^[^\@]+\@[^\@]+$/) {
15082: if (!(grep(/^\Q$bcc\E$/,@ok_bccs))) {
15083: push(@ok_bccs,$bcc);
15084: }
15085: }
15086: }
15087: if (@ok_bccs > 0) {
15088: $allbcc = join(', ',@ok_bccs);
15089: }
15090: }
15091: $addtext = $domconfig{'contacts'}{$mailing}{'include'};
1.618 raeburn 15092: }
15093: }
1.766 raeburn 15094: } elsif ($origmail ne '') {
1.1270 raeburn 15095: $lastresort = $origmail;
1.618 raeburn 15096: }
1.1297 raeburn 15097: if ($mailing eq 'helpdeskmail') {
15098: if ((ref($domconfig{'contacts'}{'overrides'}) eq 'HASH') &&
15099: (keys(%{$domconfig{'contacts'}{'overrides'}}))) {
15100: my ($inststatus,$inststatus_checked);
15101: if (($env{'user.name'} ne '') && ($env{'user.domain'} ne '') &&
15102: ($env{'user.domain'} ne 'public')) {
15103: $inststatus_checked = 1;
15104: $inststatus = $env{'environment.inststatus'};
15105: }
15106: unless ($inststatus_checked) {
15107: if (($requname ne '') && ($requdom ne '')) {
15108: if (($requname =~ /^$match_username$/) &&
15109: ($requdom =~ /^$match_domain$/) &&
15110: (&Apache::lonnet::domain($requdom))) {
15111: my $requhome = &Apache::lonnet::homeserver($requname,
15112: $requdom);
15113: unless ($requhome eq 'no_host') {
15114: my %userenv = &Apache::lonnet::userenvironment($requdom,$requname,'inststatus');
15115: $inststatus = $userenv{'inststatus'};
15116: $inststatus_checked = 1;
15117: }
15118: }
15119: }
15120: }
15121: unless ($inststatus_checked) {
15122: if ($reqemail =~ /^[^\@]+\@[^\@]+$/) {
15123: my %srch = (srchby => 'email',
15124: srchdomain => $defdom,
15125: srchterm => $reqemail,
15126: srchtype => 'exact');
15127: my %srch_results = &Apache::lonnet::usersearch(\%srch);
15128: foreach my $uname (keys(%srch_results)) {
15129: if (ref($srch_results{$uname}{'inststatus'}) eq 'ARRAY') {
15130: $inststatus = join(',',@{$srch_results{$uname}{'inststatus'}});
15131: $inststatus_checked = 1;
15132: last;
15133: }
15134: }
15135: unless ($inststatus_checked) {
15136: my ($dirsrchres,%srch_results) = &Apache::lonnet::inst_directory_query(\%srch);
15137: if ($dirsrchres eq 'ok') {
15138: foreach my $uname (keys(%srch_results)) {
15139: if (ref($srch_results{$uname}{'inststatus'}) eq 'ARRAY') {
15140: $inststatus = join(',',@{$srch_results{$uname}{'inststatus'}});
15141: $inststatus_checked = 1;
15142: last;
15143: }
15144: }
15145: }
15146: }
15147: }
15148: }
15149: if ($inststatus ne '') {
15150: foreach my $status (split(/\:/,$inststatus)) {
15151: if (ref($domconfig{'contacts'}{'overrides'}{$status}) eq 'HASH') {
15152: my @contacts = ('adminemail','supportemail');
15153: foreach my $item (@contacts) {
15154: if ($domconfig{'contacts'}{'overrides'}{$status}{$item}) {
15155: my $addr = $domconfig{'contacts'}{'overrides'}{$status};
15156: if (!grep(/^\Q$addr\E$/,@recipients)) {
15157: push(@recipients,$addr);
15158: }
15159: }
15160: }
15161: $otheremails = $domconfig{'contacts'}{'overrides'}{$status}{'others'};
15162: if ($domconfig{'contacts'}{'overrides'}{$status}{'bcc'}) {
15163: my @bccs = split(/,/,$domconfig{'contacts'}{'overrides'}{$status}{'bcc'});
15164: my @ok_bccs;
15165: foreach my $bcc (@bccs) {
15166: $bcc =~ s/^\s+//g;
15167: $bcc =~ s/\s+$//g;
15168: if ($bcc =~ m/^[^\@]+\@[^\@]+$/) {
15169: if (!(grep(/^\Q$bcc\E$/,@ok_bccs))) {
15170: push(@ok_bccs,$bcc);
15171: }
15172: }
15173: }
15174: if (@ok_bccs > 0) {
15175: $allbcc = join(', ',@ok_bccs);
15176: }
15177: }
15178: $addtext = $domconfig{'contacts'}{'overrides'}{$status}{'include'};
15179: last;
15180: }
15181: }
15182: }
15183: }
15184: }
1.619 raeburn 15185: } elsif ($origmail ne '') {
1.1270 raeburn 15186: $lastresort = $origmail;
15187: }
1.1297 raeburn 15188: if (($mailing eq 'helpdeskmail') && ($lastresort ne '')) {
1.1270 raeburn 15189: unless (grep(/^\Q$defdom\E$/,&Apache::lonnet::current_machine_domains())) {
15190: my $lonhost = $Apache::lonnet::perlvar{'lonHostID'};
15191: my $machinedom = $Apache::lonnet::perlvar{'lonDefDomain'};
15192: my %what = (
15193: perlvar => 1,
15194: );
15195: my $primary = &Apache::lonnet::domain($defdom,'primary');
15196: if ($primary) {
15197: my $gotaddr;
15198: my ($result,$returnhash) =
15199: &Apache::lonnet::get_remote_globals($primary,{ perlvar => 1 });
15200: if (($result eq 'ok') && (ref($returnhash) eq 'HASH')) {
15201: if ($returnhash->{'lonSupportEMail'} =~ /^[^\@]+\@[^\@]+$/) {
15202: $lastresort = $returnhash->{'lonSupportEMail'};
15203: $gotaddr = 1;
15204: }
15205: }
15206: unless ($gotaddr) {
15207: my $uintdom = &Apache::lonnet::internet_dom($primary);
15208: my $intdom = &Apache::lonnet::internet_dom($lonhost);
15209: unless ($uintdom eq $intdom) {
15210: my %domconfig =
15211: &Apache::lonnet::get_dom('configuration',['contacts'],$machinedom);
15212: if (ref($domconfig{'contacts'}) eq 'HASH') {
15213: if (ref($domconfig{'contacts'}{'otherdomsmail'}) eq 'HASH') {
15214: my @contacts = ('adminemail','supportemail');
15215: foreach my $item (@contacts) {
15216: if ($domconfig{'contacts'}{'otherdomsmail'}{$item}) {
15217: my $addr = $domconfig{'contacts'}{$item};
15218: if (!grep(/^\Q$addr\E$/,@recipients)) {
15219: push(@recipients,$addr);
15220: }
15221: }
15222: }
15223: if ($domconfig{'contacts'}{'otherdomsmail'}{'others'}) {
15224: $otheremails = $domconfig{'contacts'}{'otherdomsmail'}{'others'};
15225: }
15226: if ($domconfig{'contacts'}{'otherdomsmail'}{'bcc'}) {
15227: my @bccs = split(/,/,$domconfig{'contacts'}{'otherdomsmail'}{'bcc'});
15228: my @ok_bccs;
15229: foreach my $bcc (@bccs) {
15230: $bcc =~ s/^\s+//g;
15231: $bcc =~ s/\s+$//g;
15232: if ($bcc =~ m/^[^\@]+\@[^\@]+$/) {
15233: if (!(grep(/^\Q$bcc\E$/,@ok_bccs))) {
15234: push(@ok_bccs,$bcc);
15235: }
15236: }
15237: }
15238: if (@ok_bccs > 0) {
15239: $allbcc = join(', ',@ok_bccs);
15240: }
15241: }
15242: $addtext = $domconfig{'contacts'}{'otherdomsmail'}{'include'};
15243: }
15244: }
15245: }
15246: }
15247: }
15248: }
1.618 raeburn 15249: }
1.688 raeburn 15250: if (defined($defmail)) {
15251: if ($defmail ne '') {
15252: push(@recipients,$defmail);
15253: }
1.618 raeburn 15254: }
15255: if ($otheremails) {
1.619 raeburn 15256: my @others;
15257: if ($otheremails =~ /,/) {
15258: @others = split(/,/,$otheremails);
1.618 raeburn 15259: } else {
1.619 raeburn 15260: push(@others,$otheremails);
15261: }
15262: foreach my $addr (@others) {
15263: if (!grep(/^\Q$addr\E$/,@recipients)) {
15264: push(@recipients,$addr);
15265: }
1.618 raeburn 15266: }
15267: }
1.1298 raeburn 15268: if ($mailing eq 'helpdeskmail') {
1.1270 raeburn 15269: if ((!@recipients) && ($lastresort ne '')) {
15270: push(@recipients,$lastresort);
15271: }
15272: } elsif ($lastresort ne '') {
15273: if (!grep(/^\Q$lastresort\E$/,@recipients)) {
15274: push(@recipients,$lastresort);
15275: }
15276: }
1.1271 raeburn 15277: my $recipientlist = join(',',@recipients);
1.1270 raeburn 15278: if (wantarray) {
15279: return ($recipientlist,$allbcc,$addtext);
15280: } else {
15281: return $recipientlist;
15282: }
1.618 raeburn 15283: }
15284:
1.127 matthew 15285: ############################################################
15286: ############################################################
1.154 albertel 15287:
1.655 raeburn 15288: =pod
15289:
1.1224 musolffc 15290: =over 4
15291:
1.1223 musolffc 15292: =item * &mime_email()
15293:
15294: Sends an email with a possible attachment
15295:
15296: Inputs:
15297:
15298: =over 4
15299:
15300: from - Sender's email address
15301:
1.1343 raeburn 15302: replyto - Reply-To email address
15303:
1.1223 musolffc 15304: to - Email address of recipient
15305:
15306: subject - Subject of email
15307:
15308: body - Body of email
15309:
15310: cc_string - Carbon copy email address
15311:
15312: bcc - Blind carbon copy email address
15313:
15314: attachment_path - Path of file to be attached
15315:
15316: file_name - Name of file to be attached
15317:
15318: attachment_text - The body of an attachment of type "TEXT"
15319:
15320: =back
15321:
15322: =back
15323:
15324: =cut
15325:
15326: ############################################################
15327: ############################################################
15328:
15329: sub mime_email {
1.1343 raeburn 15330: my ($from,$replyto,$to,$subject,$body,$cc_string,$bcc,$attachment_path,
15331: $file_name,$attachment_text) = @_;
15332:
1.1223 musolffc 15333: my $msg = MIME::Lite->new(
15334: From => $from,
15335: To => $to,
15336: Subject => $subject,
15337: Type =>'TEXT',
15338: Data => $body,
15339: );
1.1343 raeburn 15340: if ($replyto ne '') {
15341: $msg->add("Reply-To" => $replyto);
15342: }
1.1223 musolffc 15343: if ($cc_string ne '') {
15344: $msg->add("Cc" => $cc_string);
15345: }
15346: if ($bcc ne '') {
15347: $msg->add("Bcc" => $bcc);
15348: }
15349: $msg->attr("content-type" => "text/plain");
15350: $msg->attr("content-type.charset" => "UTF-8");
15351: # Attach file if given
15352: if ($attachment_path) {
15353: unless ($file_name) {
15354: if ($attachment_path =~ m-/([^/]+)$-) { $file_name = $1; }
15355: }
15356: my ($type, $encoding) = MIME::Types::by_suffix($attachment_path);
15357: $msg->attach(Type => $type,
15358: Path => $attachment_path,
15359: Filename => $file_name
15360: );
15361: # Otherwise attach text if given
15362: } elsif ($attachment_text) {
15363: $msg->attach(Type => 'TEXT',
15364: Data => $attachment_text);
15365: }
15366: # Send it
15367: $msg->send('sendmail');
15368: }
15369:
15370: ############################################################
15371: ############################################################
15372:
15373: =pod
15374:
1.655 raeburn 15375: =head1 Course Catalog Routines
15376:
15377: =over 4
15378:
15379: =item * &gather_categories()
15380:
15381: Converts category definitions - keys of categories hash stored in
15382: coursecategories in configuration.db on the primary library server in a
15383: domain - to an array. Also generates javascript and idx hash used to
15384: generate Domain Coordinator interface for editing Course Categories.
15385:
15386: Inputs:
1.663 raeburn 15387:
1.655 raeburn 15388: categories (reference to hash of category definitions).
1.663 raeburn 15389:
1.655 raeburn 15390: cats (reference to array of arrays/hashes which encapsulates hierarchy of
15391: categories and subcategories).
1.663 raeburn 15392:
1.655 raeburn 15393: idx (reference to hash of counters used in Domain Coordinator interface for
15394: editing Course Categories).
1.663 raeburn 15395:
1.655 raeburn 15396: jsarray (reference to array of categories used to create Javascript arrays for
15397: Domain Coordinator interface for editing Course Categories).
15398:
15399: Returns: nothing
15400:
15401: Side effects: populates cats, idx and jsarray.
15402:
15403: =cut
15404:
15405: sub gather_categories {
15406: my ($categories,$cats,$idx,$jsarray) = @_;
15407: my %counters;
15408: my $num = 0;
15409: foreach my $item (keys(%{$categories})) {
15410: my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item);
15411: if ($container eq '' && $depth == 0) {
15412: $cats->[$depth][$categories->{$item}] = $cat;
15413: } else {
15414: $cats->[$depth]{$container}[$categories->{$item}] = $cat;
15415: }
15416: my ($escitem,$tail) = split(/:/,$item,2);
15417: if ($counters{$tail} eq '') {
15418: $counters{$tail} = $num;
15419: $num ++;
15420: }
15421: if (ref($idx) eq 'HASH') {
15422: $idx->{$item} = $counters{$tail};
15423: }
15424: if (ref($jsarray) eq 'ARRAY') {
15425: push(@{$jsarray->[$counters{$tail}]},$item);
15426: }
15427: }
15428: return;
15429: }
15430:
15431: =pod
15432:
15433: =item * &extract_categories()
15434:
15435: Used to generate breadcrumb trails for course categories.
15436:
15437: Inputs:
1.663 raeburn 15438:
1.655 raeburn 15439: categories (reference to hash of category definitions).
1.663 raeburn 15440:
1.655 raeburn 15441: cats (reference to array of arrays/hashes which encapsulates hierarchy of
15442: categories and subcategories).
1.663 raeburn 15443:
1.655 raeburn 15444: trails (reference to array of breacrumb trails for each category).
1.663 raeburn 15445:
1.655 raeburn 15446: allitems (reference to hash - key is category key
15447: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 15448:
1.655 raeburn 15449: idx (reference to hash of counters used in Domain Coordinator interface for
15450: editing Course Categories).
1.663 raeburn 15451:
1.655 raeburn 15452: jsarray (reference to array of categories used to create Javascript arrays for
15453: Domain Coordinator interface for editing Course Categories).
15454:
1.665 raeburn 15455: subcats (reference to hash of arrays containing all subcategories within each
15456: category, -recursive)
15457:
1.1321 raeburn 15458: maxd (reference to hash used to hold max depth for all top-level categories).
15459:
1.655 raeburn 15460: Returns: nothing
15461:
15462: Side effects: populates trails and allitems hash references.
15463:
15464: =cut
15465:
15466: sub extract_categories {
1.1321 raeburn 15467: my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats,$maxd) = @_;
1.655 raeburn 15468: if (ref($categories) eq 'HASH') {
15469: &gather_categories($categories,$cats,$idx,$jsarray);
15470: if (ref($cats->[0]) eq 'ARRAY') {
15471: for (my $i=0; $i<@{$cats->[0]}; $i++) {
15472: my $name = $cats->[0][$i];
15473: my $item = &escape($name).'::0';
15474: my $trailstr;
15475: if ($name eq 'instcode') {
15476: $trailstr = &mt('Official courses (with institutional codes)');
1.919 raeburn 15477: } elsif ($name eq 'communities') {
15478: $trailstr = &mt('Communities');
1.1239 raeburn 15479: } elsif ($name eq 'placement') {
15480: $trailstr = &mt('Placement Tests');
1.655 raeburn 15481: } else {
15482: $trailstr = $name;
15483: }
15484: if ($allitems->{$item} eq '') {
15485: push(@{$trails},$trailstr);
15486: $allitems->{$item} = scalar(@{$trails})-1;
15487: }
15488: my @parents = ($name);
15489: if (ref($cats->[1]{$name}) eq 'ARRAY') {
15490: for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) {
15491: my $category = $cats->[1]{$name}[$j];
1.665 raeburn 15492: if (ref($subcats) eq 'HASH') {
15493: push(@{$subcats->{$item}},&escape($category).':'.&escape($name).':1');
15494: }
1.1321 raeburn 15495: &recurse_categories($cats,2,$category,$trails,$allitems,\@parents,$subcats,$maxd);
1.665 raeburn 15496: }
15497: } else {
15498: if (ref($subcats) eq 'HASH') {
15499: $subcats->{$item} = [];
1.655 raeburn 15500: }
1.1321 raeburn 15501: if (ref($maxd) eq 'HASH') {
15502: $maxd->{$name} = 1;
15503: }
1.655 raeburn 15504: }
15505: }
15506: }
15507: }
15508: return;
15509: }
15510:
15511: =pod
15512:
1.1162 raeburn 15513: =item * &recurse_categories()
1.655 raeburn 15514:
15515: Recursively used to generate breadcrumb trails for course categories.
15516:
15517: Inputs:
1.663 raeburn 15518:
1.655 raeburn 15519: cats (reference to array of arrays/hashes which encapsulates hierarchy of
15520: categories and subcategories).
1.663 raeburn 15521:
1.655 raeburn 15522: depth (current depth in hierarchy of categories and sub-categories - 0 indexed).
1.663 raeburn 15523:
15524: category (current course category, for which breadcrumb trail is being generated).
15525:
15526: trails (reference to array of breadcrumb trails for each category).
15527:
1.655 raeburn 15528: allitems (reference to hash - key is category key
15529: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 15530:
1.655 raeburn 15531: parents (array containing containers directories for current category,
15532: back to top level).
15533:
15534: Returns: nothing
15535:
15536: Side effects: populates trails and allitems hash references
15537:
15538: =cut
15539:
15540: sub recurse_categories {
1.1321 raeburn 15541: my ($cats,$depth,$category,$trails,$allitems,$parents,$subcats,$maxd) = @_;
1.655 raeburn 15542: my $shallower = $depth - 1;
15543: if (ref($cats->[$depth]{$category}) eq 'ARRAY') {
15544: for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) {
15545: my $name = $cats->[$depth]{$category}[$k];
15546: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
1.1321 raeburn 15547: my $trailstr = join(' » ',(@{$parents},$category));
1.655 raeburn 15548: if ($allitems->{$item} eq '') {
15549: push(@{$trails},$trailstr);
15550: $allitems->{$item} = scalar(@{$trails})-1;
15551: }
15552: my $deeper = $depth+1;
15553: push(@{$parents},$category);
1.665 raeburn 15554: if (ref($subcats) eq 'HASH') {
15555: my $subcat = &escape($name).':'.$category.':'.$depth;
15556: for (my $j=@{$parents}; $j>=0; $j--) {
15557: my $higher;
15558: if ($j > 0) {
15559: $higher = &escape($parents->[$j]).':'.
15560: &escape($parents->[$j-1]).':'.$j;
15561: } else {
15562: $higher = &escape($parents->[$j]).'::'.$j;
15563: }
15564: push(@{$subcats->{$higher}},$subcat);
15565: }
15566: }
15567: &recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents,
1.1321 raeburn 15568: $subcats,$maxd);
1.655 raeburn 15569: pop(@{$parents});
15570: }
15571: } else {
15572: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
1.1321 raeburn 15573: my $trailstr = join(' » ',(@{$parents},$category));
1.655 raeburn 15574: if ($allitems->{$item} eq '') {
15575: push(@{$trails},$trailstr);
15576: $allitems->{$item} = scalar(@{$trails})-1;
15577: }
1.1321 raeburn 15578: if (ref($maxd) eq 'HASH') {
15579: if ($depth > $maxd->{$parents->[0]}) {
15580: $maxd->{$parents->[0]} = $depth;
15581: }
15582: }
1.655 raeburn 15583: }
15584: return;
15585: }
15586:
1.663 raeburn 15587: =pod
15588:
1.1162 raeburn 15589: =item * &assign_categories_table()
1.663 raeburn 15590:
15591: Create a datatable for display of hierarchical categories in a domain,
15592: with checkboxes to allow a course to be categorized.
15593:
15594: Inputs:
15595:
15596: cathash - reference to hash of categories defined for the domain (from
15597: configuration.db)
15598:
15599: currcat - scalar with an & separated list of categories assigned to a course.
15600:
1.919 raeburn 15601: type - scalar contains course type (Course or Community).
15602:
1.1260 raeburn 15603: disabled - scalar (optional) contains disabled="disabled" if input elements are
15604: to be readonly (e.g., Domain Helpdesk role viewing course settings).
15605:
1.663 raeburn 15606: Returns: $output (markup to be displayed)
15607:
15608: =cut
15609:
15610: sub assign_categories_table {
1.1259 raeburn 15611: my ($cathash,$currcat,$type,$disabled) = @_;
1.663 raeburn 15612: my $output;
15613: if (ref($cathash) eq 'HASH') {
1.1321 raeburn 15614: my (@cats,@trails,%allitems,%idx,@jsarray,%maxd,@path,$maxdepth);
15615: &extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray,\%maxd);
1.663 raeburn 15616: $maxdepth = scalar(@cats);
15617: if (@cats > 0) {
15618: my $itemcount = 0;
15619: if (ref($cats[0]) eq 'ARRAY') {
15620: my @currcategories;
15621: if ($currcat ne '') {
15622: @currcategories = split('&',$currcat);
15623: }
1.919 raeburn 15624: my $table;
1.663 raeburn 15625: for (my $i=0; $i<@{$cats[0]}; $i++) {
15626: my $parent = $cats[0][$i];
1.919 raeburn 15627: next if ($parent eq 'instcode');
15628: if ($type eq 'Community') {
15629: next unless ($parent eq 'communities');
1.1239 raeburn 15630: } elsif ($type eq 'Placement') {
15631: next unless ($parent eq 'placement');
1.919 raeburn 15632: } else {
1.1239 raeburn 15633: next if (($parent eq 'communities') || ($parent eq 'placement'));
1.919 raeburn 15634: }
1.663 raeburn 15635: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
15636: my $item = &escape($parent).'::0';
15637: my $checked = '';
15638: if (@currcategories > 0) {
15639: if (grep(/^\Q$item\E$/,@currcategories)) {
1.772 bisitz 15640: $checked = ' checked="checked"';
1.663 raeburn 15641: }
15642: }
1.919 raeburn 15643: my $parent_title = $parent;
15644: if ($parent eq 'communities') {
15645: $parent_title = &mt('Communities');
1.1239 raeburn 15646: } elsif ($parent eq 'placement') {
15647: $parent_title = &mt('Placement Tests');
1.919 raeburn 15648: }
15649: $table .= '<tr '.$css_class.'><td><span class="LC_nobreak">'.
15650: '<input type="checkbox" name="usecategory" value="'.
1.1259 raeburn 15651: $item.'"'.$checked.$disabled.' />'.$parent_title.'</span>'.
1.919 raeburn 15652: '<input type="hidden" name="catname" value="'.$parent.'" /></td>';
1.663 raeburn 15653: my $depth = 1;
15654: push(@path,$parent);
1.1259 raeburn 15655: $table .= &assign_category_rows($itemcount,\@cats,$depth,$parent,\@path,\@currcategories,$disabled);
1.663 raeburn 15656: pop(@path);
1.919 raeburn 15657: $table .= '</tr><tr><td colspan="'.$maxdepth.'" class="LC_row_separator"></td></tr>';
1.663 raeburn 15658: $itemcount ++;
15659: }
1.919 raeburn 15660: if ($itemcount) {
15661: $output = &Apache::loncommon::start_data_table().
15662: $table.
15663: &Apache::loncommon::end_data_table();
15664: }
1.663 raeburn 15665: }
15666: }
15667: }
15668: return $output;
15669: }
15670:
15671: =pod
15672:
1.1162 raeburn 15673: =item * &assign_category_rows()
1.663 raeburn 15674:
15675: Create a datatable row for display of nested categories in a domain,
15676: with checkboxes to allow a course to be categorized,called recursively.
15677:
15678: Inputs:
15679:
15680: itemcount - track row number for alternating colors
15681:
15682: cats - reference to array of arrays/hashes which encapsulates hierarchy of
15683: categories and subcategories.
15684:
15685: depth - current depth in hierarchy of categories and sub-categories - 0 indexed.
15686:
15687: parent - parent of current category item
15688:
15689: path - Array containing all categories back up through the hierarchy from the
15690: current category to the top level.
15691:
15692: currcategories - reference to array of current categories assigned to the course
15693:
1.1260 raeburn 15694: disabled - scalar (optional) contains disabled="disabled" if input elements are
15695: to be readonly (e.g., Domain Helpdesk role viewing course settings).
15696:
1.663 raeburn 15697: Returns: $output (markup to be displayed).
15698:
15699: =cut
15700:
15701: sub assign_category_rows {
1.1259 raeburn 15702: my ($itemcount,$cats,$depth,$parent,$path,$currcategories,$disabled) = @_;
1.663 raeburn 15703: my ($text,$name,$item,$chgstr);
15704: if (ref($cats) eq 'ARRAY') {
15705: my $maxdepth = scalar(@{$cats});
15706: if (ref($cats->[$depth]) eq 'HASH') {
15707: if (ref($cats->[$depth]{$parent}) eq 'ARRAY') {
15708: my $numchildren = @{$cats->[$depth]{$parent}};
15709: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
1.1145 raeburn 15710: $text .= '<td><table class="LC_data_table">';
1.663 raeburn 15711: for (my $j=0; $j<$numchildren; $j++) {
15712: $name = $cats->[$depth]{$parent}[$j];
15713: $item = &escape($name).':'.&escape($parent).':'.$depth;
15714: my $deeper = $depth+1;
15715: my $checked = '';
15716: if (ref($currcategories) eq 'ARRAY') {
15717: if (@{$currcategories} > 0) {
15718: if (grep(/^\Q$item\E$/,@{$currcategories})) {
1.772 bisitz 15719: $checked = ' checked="checked"';
1.663 raeburn 15720: }
15721: }
15722: }
1.664 raeburn 15723: $text .= '<tr><td><span class="LC_nobreak"><label>'.
15724: '<input type="checkbox" name="usecategory" value="'.
1.1259 raeburn 15725: $item.'"'.$checked.$disabled.' />'.$name.'</label></span>'.
1.675 raeburn 15726: '<input type="hidden" name="catname" value="'.$name.'" />'.
15727: '</td><td>';
1.663 raeburn 15728: if (ref($path) eq 'ARRAY') {
15729: push(@{$path},$name);
1.1259 raeburn 15730: $text .= &assign_category_rows($itemcount,$cats,$deeper,$name,$path,$currcategories,$disabled);
1.663 raeburn 15731: pop(@{$path});
15732: }
15733: $text .= '</td></tr>';
15734: }
15735: $text .= '</table></td>';
15736: }
15737: }
15738: }
15739: return $text;
15740: }
15741:
1.1181 raeburn 15742: =pod
15743:
15744: =back
15745:
15746: =cut
15747:
1.655 raeburn 15748: ############################################################
15749: ############################################################
15750:
15751:
1.443 albertel 15752: sub commit_customrole {
1.664 raeburn 15753: my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context) = @_;
1.630 raeburn 15754: my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
1.443 albertel 15755: ($start?', '.&mt('starting').' '.localtime($start):'').
15756: ($end?', ending '.localtime($end):'').': <b>'.
15757: &Apache::lonnet::assigncustomrole(
1.664 raeburn 15758: $udom,$uname,$url,$three,$four,$five,$end,$start,undef,undef,$context).
1.443 albertel 15759: '</b><br />';
15760: return $output;
15761: }
15762:
15763: sub commit_standardrole {
1.1116 raeburn 15764: my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context,$credits) = @_;
1.541 raeburn 15765: my ($output,$logmsg,$linefeed);
15766: if ($context eq 'auto') {
15767: $linefeed = "\n";
15768: } else {
15769: $linefeed = "<br />\n";
15770: }
1.443 albertel 15771: if ($three eq 'st') {
1.541 raeburn 15772: my $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
1.1116 raeburn 15773: $one,$two,$sec,$context,$credits);
1.541 raeburn 15774: if (($result =~ /^error/) || ($result eq 'not_in_class') ||
1.626 raeburn 15775: ($result eq 'unknown_course') || ($result eq 'refused')) {
15776: $output = $logmsg.' '.&mt('Error: ').$result."\n";
1.443 albertel 15777: } else {
1.541 raeburn 15778: $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
1.443 albertel 15779: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 15780: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
15781: if ($context eq 'auto') {
15782: $output .= $result.$linefeed.&mt('Add to classlist').': ok';
15783: } else {
15784: $output .= '<b>'.$result.'</b>'.$linefeed.
15785: &mt('Add to classlist').': <b>ok</b>';
15786: }
15787: $output .= $linefeed;
1.443 albertel 15788: }
15789: } else {
15790: $output = &mt('Assigning').' '.$three.' in '.$url.
15791: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 15792: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
1.652 raeburn 15793: my $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,'','',$context);
1.541 raeburn 15794: if ($context eq 'auto') {
15795: $output .= $result.$linefeed;
15796: } else {
15797: $output .= '<b>'.$result.'</b>'.$linefeed;
15798: }
1.443 albertel 15799: }
15800: return $output;
15801: }
15802:
15803: sub commit_studentrole {
1.1116 raeburn 15804: my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context,
15805: $credits) = @_;
1.626 raeburn 15806: my ($result,$linefeed,$oldsecurl,$newsecurl);
1.541 raeburn 15807: if ($context eq 'auto') {
15808: $linefeed = "\n";
15809: } else {
15810: $linefeed = '<br />'."\n";
15811: }
1.443 albertel 15812: if (defined($one) && defined($two)) {
15813: my $cid=$one.'_'.$two;
15814: my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
15815: my $secchange = 0;
15816: my $expire_role_result;
15817: my $modify_section_result;
1.628 raeburn 15818: if ($oldsec ne '-1') {
15819: if ($oldsec ne $sec) {
1.443 albertel 15820: $secchange = 1;
1.628 raeburn 15821: my $now = time;
1.443 albertel 15822: my $uurl='/'.$cid;
15823: $uurl=~s/\_/\//g;
15824: if ($oldsec) {
15825: $uurl.='/'.$oldsec;
15826: }
1.626 raeburn 15827: $oldsecurl = $uurl;
1.628 raeburn 15828: $expire_role_result =
1.652 raeburn 15829: &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,'','',$context);
1.628 raeburn 15830: if ($env{'request.course.sec'} ne '') {
15831: if ($expire_role_result eq 'refused') {
15832: my @roles = ('st');
15833: my @statuses = ('previous');
15834: my @roledoms = ($one);
15835: my $withsec = 1;
15836: my %roleshash =
15837: &Apache::lonnet::get_my_roles($uname,$udom,'userroles',
15838: \@statuses,\@roles,\@roledoms,$withsec);
15839: if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
15840: my ($oldstart,$oldend) =
15841: split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
15842: if ($oldend > 0 && $oldend <= $now) {
15843: $expire_role_result = 'ok';
15844: }
15845: }
15846: }
15847: }
1.443 albertel 15848: $result = $expire_role_result;
15849: }
15850: }
15851: if (($expire_role_result eq 'ok') || ($secchange == 0)) {
1.1116 raeburn 15852: $modify_section_result =
15853: &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,
15854: undef,undef,undef,$sec,
15855: $end,$start,'','',$cid,
15856: '',$context,$credits);
1.443 albertel 15857: if ($modify_section_result =~ /^ok/) {
15858: if ($secchange == 1) {
1.628 raeburn 15859: if ($sec eq '') {
15860: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
15861: } else {
15862: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
15863: }
1.443 albertel 15864: } elsif ($oldsec eq '-1') {
1.628 raeburn 15865: if ($sec eq '') {
15866: $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
15867: } else {
15868: $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
15869: }
1.443 albertel 15870: } else {
1.628 raeburn 15871: if ($sec eq '') {
15872: $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
15873: } else {
15874: $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
15875: }
1.443 albertel 15876: }
15877: } else {
1.1115 raeburn 15878: if ($secchange) {
1.628 raeburn 15879: $$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;
15880: } else {
15881: $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
15882: }
1.443 albertel 15883: }
15884: $result = $modify_section_result;
15885: } elsif ($secchange == 1) {
1.628 raeburn 15886: if ($oldsec eq '') {
1.1103 raeburn 15887: $$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 15888: } else {
15889: $$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;
15890: }
1.626 raeburn 15891: if ($expire_role_result eq 'refused') {
15892: my $newsecurl = '/'.$cid;
15893: $newsecurl =~ s/\_/\//g;
15894: if ($sec ne '') {
15895: $newsecurl.='/'.$sec;
15896: }
15897: if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
15898: if ($sec eq '') {
15899: $$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;
15900: } else {
15901: $$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;
15902: }
15903: }
15904: }
1.443 albertel 15905: }
15906: } else {
1.626 raeburn 15907: $$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 15908: $result = "error: incomplete course id\n";
15909: }
15910: return $result;
15911: }
15912:
1.1108 raeburn 15913: sub show_role_extent {
15914: my ($scope,$context,$role) = @_;
15915: $scope =~ s{^/}{};
15916: my @courseroles = &Apache::lonuserutils::roles_by_context('course',1);
15917: push(@courseroles,'co');
15918: my @authorroles = &Apache::lonuserutils::roles_by_context('author');
15919: if (($context eq 'course') || (grep(/^\Q$role\E/,@courseroles))) {
15920: $scope =~ s{/}{_};
15921: return '<span class="LC_cusr_emph">'.$env{'course.'.$scope.'.description'}.'</span>';
15922: } elsif (($context eq 'author') || (grep(/^\Q$role\E/,@authorroles))) {
15923: my ($audom,$auname) = split(/\//,$scope);
15924: return &mt('[_1] Author Space','<span class="LC_cusr_emph">'.
15925: &Apache::loncommon::plainname($auname,$audom).'</span>');
15926: } else {
15927: $scope =~ s{/$}{};
15928: return &mt('Domain: [_1]','<span class="LC_cusr_emph">'.
15929: &Apache::lonnet::domain($scope,'description').'</span>');
15930: }
15931: }
15932:
1.443 albertel 15933: ############################################################
15934: ############################################################
15935:
1.566 albertel 15936: sub check_clone {
1.578 raeburn 15937: my ($args,$linefeed) = @_;
1.566 albertel 15938: my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
15939: my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
15940: my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
1.1344 raeburn 15941: my $clonetitle;
15942: my @clonemsg;
1.566 albertel 15943: my $can_clone = 0;
1.944 raeburn 15944: my $lctype = lc($args->{'crstype'});
1.908 raeburn 15945: if ($lctype ne 'community') {
15946: $lctype = 'course';
15947: }
1.566 albertel 15948: if ($clonehome eq 'no_host') {
1.944 raeburn 15949: if ($args->{'crstype'} eq 'Community') {
1.1344 raeburn 15950: push(@clonemsg,({
15951: mt => 'No new community created.',
15952: args => [],
15953: },
15954: {
15955: mt => 'A new community could not be cloned from the specified original - [_1] - because it is a non-existent community.',
15956: args => [$args->{'clonedomain'}.':'.$args->{'clonedomain'}],
15957: }));
1.908 raeburn 15958: } else {
1.1344 raeburn 15959: push(@clonemsg,({
15960: mt => 'No new course created.',
15961: args => [],
15962: },
15963: {
15964: mt => 'A new course could not be cloned from the specified original - [_1] - because it is a non-existent course.',
15965: args => [$args->{'clonecourse'}.':'.$args->{'clonedomain'}],
15966: }));
15967: }
1.566 albertel 15968: } else {
15969: my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
1.1344 raeburn 15970: $clonetitle = $clonedesc{'description'};
1.944 raeburn 15971: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 15972: if ($clonedesc{'type'} ne 'Community') {
1.1344 raeburn 15973: push(@clonemsg,({
15974: mt => 'No new community created.',
15975: args => [],
15976: },
15977: {
15978: mt => 'A new community could not be cloned from the specified original - [_1] - because it is a course not a community.',
15979: args => [$args->{'clonecourse'}.':'.$args->{'clonedomain'}],
15980: }));
15981: return ($can_clone,\@clonemsg,$cloneid,$clonehome);
1.908 raeburn 15982: }
15983: }
1.1262 raeburn 15984: if (($env{'request.role.domain'} eq $args->{'clonedomain'}) &&
1.882 raeburn 15985: (&Apache::lonnet::allowed('ccc',$env{'request.role.domain'}))) {
1.566 albertel 15986: $can_clone = 1;
15987: } else {
1.1221 raeburn 15988: my %clonehash = &Apache::lonnet::get('environment',['cloners','internal.coursecode'],
1.566 albertel 15989: $args->{'clonedomain'},$args->{'clonecourse'});
1.1221 raeburn 15990: if ($clonehash{'cloners'} eq '') {
15991: my %domdefs = &Apache::lonnet::get_domain_defaults($args->{'course_domain'});
15992: if ($domdefs{'canclone'}) {
15993: unless ($domdefs{'canclone'} eq 'none') {
15994: if ($domdefs{'canclone'} eq 'domain') {
15995: if ($args->{'ccdomain'} eq $args->{'clonedomain'}) {
15996: $can_clone = 1;
15997: }
15998: } elsif (($clonehash{'internal.coursecode'}) && ($args->{'crscode'}) &&
15999: ($args->{'clonedomain'} eq $args->{'course_domain'})) {
16000: if (&Apache::lonnet::default_instcode_cloning($args->{'clonedomain'},$domdefs{'canclone'},
16001: $clonehash{'internal.coursecode'},$args->{'crscode'})) {
16002: $can_clone = 1;
16003: }
16004: }
16005: }
16006: }
1.578 raeburn 16007: } else {
1.1221 raeburn 16008: my @cloners = split(/,/,$clonehash{'cloners'});
16009: if (grep(/^\*$/,@cloners)) {
1.942 raeburn 16010: $can_clone = 1;
1.1221 raeburn 16011: } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
1.942 raeburn 16012: $can_clone = 1;
1.1225 raeburn 16013: } elsif (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners)) {
16014: $can_clone = 1;
1.1221 raeburn 16015: }
16016: unless ($can_clone) {
1.1225 raeburn 16017: if (($clonehash{'internal.coursecode'}) && ($args->{'crscode'}) &&
16018: ($args->{'clonedomain'} eq $args->{'course_domain'})) {
1.1221 raeburn 16019: my (%gotdomdefaults,%gotcodedefaults);
16020: foreach my $cloner (@cloners) {
16021: if (($cloner ne '*') && ($cloner !~ /^\*\:$match_domain$/) &&
16022: ($cloner !~ /^$match_username\:$match_domain$/) && ($cloner ne '')) {
16023: my (%codedefaults,@code_order);
16024: if (ref($gotcodedefaults{$args->{'clonedomain'}}) eq 'HASH') {
16025: if (ref($gotcodedefaults{$args->{'clonedomain'}}{'defaults'}) eq 'HASH') {
16026: %codedefaults = %{$gotcodedefaults{$args->{'clonedomain'}}{'defaults'}};
16027: }
16028: if (ref($gotcodedefaults{$args->{'clonedomain'}}{'order'}) eq 'ARRAY') {
16029: @code_order = @{$gotcodedefaults{$args->{'clonedomain'}}{'order'}};
16030: }
16031: } else {
16032: &Apache::lonnet::auto_instcode_defaults($args->{'clonedomain'},
16033: \%codedefaults,
16034: \@code_order);
16035: $gotcodedefaults{$args->{'clonedomain'}}{'defaults'} = \%codedefaults;
16036: $gotcodedefaults{$args->{'clonedomain'}}{'order'} = \@code_order;
16037: }
16038: if (@code_order > 0) {
16039: if (&Apache::lonnet::check_instcode_cloning(\%codedefaults,\@code_order,
16040: $cloner,$clonehash{'internal.coursecode'},
16041: $args->{'crscode'})) {
16042: $can_clone = 1;
16043: last;
16044: }
16045: }
16046: }
16047: }
16048: }
1.1225 raeburn 16049: }
16050: }
16051: unless ($can_clone) {
16052: my $ccrole = 'cc';
16053: if ($args->{'crstype'} eq 'Community') {
16054: $ccrole = 'co';
16055: }
16056: my %roleshash =
16057: &Apache::lonnet::get_my_roles($args->{'ccuname'},
16058: $args->{'ccdomain'},
16059: 'userroles',['active'],[$ccrole],
16060: [$args->{'clonedomain'}]);
16061: if ($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':'.$ccrole}) {
16062: $can_clone = 1;
16063: } elsif (&Apache::lonnet::is_course_owner($args->{'clonedomain'},$args->{'clonecourse'},
16064: $args->{'ccuname'},$args->{'ccdomain'})) {
16065: $can_clone = 1;
1.1221 raeburn 16066: }
16067: }
16068: unless ($can_clone) {
16069: if ($args->{'crstype'} eq 'Community') {
1.1344 raeburn 16070: push(@clonemsg,({
16071: mt => 'No new community created.',
16072: args => [],
16073: },
16074: {
16075: 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]).',
16076: args => [$args->{'ccuname'}.':'.$args->{'ccdomain'},$clonedesc{'description'}],
16077: }));
1.942 raeburn 16078: } else {
1.1344 raeburn 16079: push(@clonemsg,({
16080: mt => 'No new course created.',
16081: args => [],
16082: },
16083: {
16084: 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]).',
16085: args => [$args->{'ccuname'}.':'.$args->{'ccdomain'},$clonedesc{'description'}],
16086: }));
1.1221 raeburn 16087: }
1.566 albertel 16088: }
1.578 raeburn 16089: }
1.566 albertel 16090: }
1.1344 raeburn 16091: return ($can_clone,\@clonemsg,$cloneid,$clonehome,$clonetitle);
1.566 albertel 16092: }
16093:
1.444 albertel 16094: sub construct_course {
1.1262 raeburn 16095: my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context,
1.1344 raeburn 16096: $cnum,$category,$coderef,$callercontext,$user_lh) = @_;
16097: my ($outcome,$msgref,$clonemsgref);
1.541 raeburn 16098: my $linefeed = '<br />'."\n";
16099: if ($context eq 'auto') {
16100: $linefeed = "\n";
16101: }
1.566 albertel 16102:
16103: #
16104: # Are we cloning?
16105: #
1.1344 raeburn 16106: my ($can_clone,$cloneid,$clonehome,$clonetitle);
1.566 albertel 16107: if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
1.1344 raeburn 16108: ($can_clone,$clonemsgref,$cloneid,$clonehome,$clonetitle) = &check_clone($args,$linefeed);
1.566 albertel 16109: if (!$can_clone) {
1.1344 raeburn 16110: return (0,$outcome,$clonemsgref);
1.566 albertel 16111: }
16112: }
16113:
1.444 albertel 16114: #
16115: # Open course
16116: #
1.1239 raeburn 16117: my $showncrstype;
16118: if ($args->{'crstype'} eq 'Placement') {
16119: $showncrstype = 'placement test';
16120: } else {
16121: $showncrstype = lc($args->{'crstype'});
16122: }
1.444 albertel 16123: my %cenv=();
16124: $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
16125: $args->{'cdescr'},
16126: $args->{'curl'},
16127: $args->{'course_home'},
16128: $args->{'nonstandard'},
16129: $args->{'crscode'},
16130: $args->{'ccuname'}.':'.
16131: $args->{'ccdomain'},
1.882 raeburn 16132: $args->{'crstype'},
1.1344 raeburn 16133: $cnum,$context,$category,
16134: $callercontext);
1.444 albertel 16135:
16136: # Note: The testing routines depend on this being output; see
16137: # Utils::Course. This needs to at least be output as a comment
16138: # if anyone ever decides to not show this, and Utils::Course::new
16139: # will need to be suitably modified.
1.1344 raeburn 16140: if (($callercontext eq 'auto') && ($user_lh ne '')) {
16141: $outcome .= &mt_user($user_lh,'New LON-CAPA [_1] ID: [_2]',$showncrstype,$$courseid).$linefeed;
16142: } else {
16143: $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$showncrstype,$$courseid).$linefeed;
16144: }
1.943 raeburn 16145: if ($$courseid =~ /^error:/) {
1.1344 raeburn 16146: return (0,$outcome,$clonemsgref);
1.943 raeburn 16147: }
16148:
1.444 albertel 16149: #
16150: # Check if created correctly
16151: #
1.479 albertel 16152: ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
1.444 albertel 16153: my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
1.943 raeburn 16154: if ($crsuhome eq 'no_host') {
1.1344 raeburn 16155: if (($callercontext eq 'auto') && ($user_lh ne '')) {
16156: $outcome .= &mt_user($user_lh,
16157: 'Course creation failed, unrecognized course home server.');
16158: } else {
16159: $outcome .= &mt('Course creation failed, unrecognized course home server.');
16160: }
16161: $outcome .= $linefeed;
16162: return (0,$outcome,$clonemsgref);
1.943 raeburn 16163: }
1.541 raeburn 16164: $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
1.566 albertel 16165:
1.444 albertel 16166: #
1.566 albertel 16167: # Do the cloning
16168: #
1.1344 raeburn 16169: my @clonemsg;
1.566 albertel 16170: if ($can_clone && $cloneid) {
1.1344 raeburn 16171: push(@clonemsg,
16172: {
16173: mt => 'Created [_1] by cloning from [_2]',
16174: args => [$showncrstype,$clonetitle],
16175: });
1.566 albertel 16176: my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
1.444 albertel 16177: # Copy all files
1.1344 raeburn 16178: my @info =
16179: &Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},
16180: $args->{'dateshift'},$args->{'crscode'},
16181: $args->{'ccuname'}.':'.$args->{'ccdomain'},
16182: $args->{'tinyurls'});
16183: if (@info) {
16184: push(@clonemsg,@info);
16185: }
1.444 albertel 16186: # Restore URL
1.566 albertel 16187: $cenv{'url'}=$oldcenv{'url'};
1.444 albertel 16188: # Restore title
1.566 albertel 16189: $cenv{'description'}=$oldcenv{'description'};
1.955 raeburn 16190: # Restore creation date, creator and creation context.
16191: $cenv{'internal.created'}=$oldcenv{'internal.created'};
16192: $cenv{'internal.creator'}=$oldcenv{'internal.creator'};
16193: $cenv{'internal.creationcontext'}=$oldcenv{'internal.creationcontext'};
1.444 albertel 16194: # Mark as cloned
1.566 albertel 16195: $cenv{'clonedfrom'}=$cloneid;
1.638 www 16196: # Need to clone grading mode
16197: my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum);
16198: $cenv{'grading'}=$newenv{'grading'};
16199: # Do not clone these environment entries
16200: &Apache::lonnet::del('environment',
16201: ['default_enrollment_start_date',
16202: 'default_enrollment_end_date',
16203: 'question.email',
16204: 'policy.email',
16205: 'comment.email',
16206: 'pch.users.denied',
1.725 raeburn 16207: 'plc.users.denied',
16208: 'hidefromcat',
1.1121 raeburn 16209: 'checkforpriv',
1.1166 raeburn 16210: 'categories',
16211: 'internal.uniquecode'],
1.638 www 16212: $$crsudom,$$crsunum);
1.1170 raeburn 16213: if ($args->{'textbook'}) {
16214: $cenv{'internal.textbook'} = $args->{'textbook'};
16215: }
1.444 albertel 16216: }
1.566 albertel 16217:
1.444 albertel 16218: #
16219: # Set environment (will override cloned, if existing)
16220: #
16221: my @sections = ();
16222: my @xlists = ();
16223: if ($args->{'crstype'}) {
16224: $cenv{'type'}=$args->{'crstype'};
16225: }
16226: if ($args->{'crsid'}) {
16227: $cenv{'courseid'}=$args->{'crsid'};
16228: }
16229: if ($args->{'crscode'}) {
16230: $cenv{'internal.coursecode'}=$args->{'crscode'};
16231: }
16232: if ($args->{'crsquota'} ne '') {
16233: $cenv{'internal.coursequota'}=$args->{'crsquota'};
16234: } else {
16235: $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
16236: }
16237: if ($args->{'ccuname'}) {
16238: $cenv{'internal.courseowner'} = $args->{'ccuname'}.
16239: ':'.$args->{'ccdomain'};
16240: } else {
16241: $cenv{'internal.courseowner'} = $args->{'curruser'};
16242: }
1.1116 raeburn 16243: if ($args->{'defaultcredits'}) {
16244: $cenv{'internal.defaultcredits'} = $args->{'defaultcredits'};
16245: }
1.444 albertel 16246: my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
16247: if ($args->{'crssections'}) {
16248: $cenv{'internal.sectionnums'} = '';
16249: if ($args->{'crssections'} =~ m/,/) {
16250: @sections = split/,/,$args->{'crssections'};
16251: } else {
16252: $sections[0] = $args->{'crssections'};
16253: }
16254: if (@sections > 0) {
16255: foreach my $item (@sections) {
16256: my ($sec,$gp) = split/:/,$item;
16257: my $class = $args->{'crscode'}.$sec;
16258: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
16259: $cenv{'internal.sectionnums'} .= $item.',';
16260: unless ($addcheck eq 'ok') {
1.1263 raeburn 16261: push(@badclasses,$class);
1.444 albertel 16262: }
16263: }
16264: $cenv{'internal.sectionnums'} =~ s/,$//;
16265: }
16266: }
16267: # do not hide course coordinator from staff listing,
16268: # even if privileged
16269: $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
1.1121 raeburn 16270: # add course coordinator's domain to domains to check for privileged users
16271: # if different to course domain
16272: if ($$crsudom ne $args->{'ccdomain'}) {
16273: $cenv{'checkforpriv'} = $args->{'ccdomain'};
16274: }
1.444 albertel 16275: # add crosslistings
16276: if ($args->{'crsxlist'}) {
16277: $cenv{'internal.crosslistings'}='';
16278: if ($args->{'crsxlist'} =~ m/,/) {
16279: @xlists = split/,/,$args->{'crsxlist'};
16280: } else {
16281: $xlists[0] = $args->{'crsxlist'};
16282: }
16283: if (@xlists > 0) {
16284: foreach my $item (@xlists) {
16285: my ($xl,$gp) = split/:/,$item;
16286: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
16287: $cenv{'internal.crosslistings'} .= $item.',';
16288: unless ($addcheck eq 'ok') {
1.1263 raeburn 16289: push(@badclasses,$xl);
1.444 albertel 16290: }
16291: }
16292: $cenv{'internal.crosslistings'} =~ s/,$//;
16293: }
16294: }
16295: if ($args->{'autoadds'}) {
16296: $cenv{'internal.autoadds'}=$args->{'autoadds'};
16297: }
16298: if ($args->{'autodrops'}) {
16299: $cenv{'internal.autodrops'}=$args->{'autodrops'};
16300: }
16301: # check for notification of enrollment changes
16302: my @notified = ();
16303: if ($args->{'notify_owner'}) {
16304: if ($args->{'ccuname'} ne '') {
16305: push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
16306: }
16307: }
16308: if ($args->{'notify_dc'}) {
16309: if ($uname ne '') {
1.630 raeburn 16310: push(@notified,$uname.':'.$udom);
1.444 albertel 16311: }
16312: }
16313: if (@notified > 0) {
16314: my $notifylist;
16315: if (@notified > 1) {
16316: $notifylist = join(',',@notified);
16317: } else {
16318: $notifylist = $notified[0];
16319: }
16320: $cenv{'internal.notifylist'} = $notifylist;
16321: }
16322: if (@badclasses > 0) {
16323: my %lt=&Apache::lonlocal::texthash(
1.1264 raeburn 16324: 'tclb' => 'The courses listed below were included as sections or crosslistings affiliated with your new LON-CAPA course.',
16325: 'howi' => 'However, if automated course roster updates are enabled for this class, these particular sections/crosslistings are not guaranteed to contribute towards enrollment.',
16326: 'itis' => 'It is possible that rights to access enrollment for these classes will be available through assignment of co-owners.',
1.444 albertel 16327: );
1.1264 raeburn 16328: my $badclass_msg = $lt{'tclb'}.$linefeed.$lt{'howi'}.$linefeed.
16329: &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 16330: if ($context eq 'auto') {
16331: $outcome .= $badclass_msg.$linefeed;
1.1261 raeburn 16332: } else {
1.566 albertel 16333: $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
1.1261 raeburn 16334: }
16335: foreach my $item (@badclasses) {
1.541 raeburn 16336: if ($context eq 'auto') {
1.1261 raeburn 16337: $outcome .= " - $item\n";
1.541 raeburn 16338: } else {
1.1261 raeburn 16339: $outcome .= "<li>$item</li>\n";
1.541 raeburn 16340: }
1.1261 raeburn 16341: }
16342: if ($context eq 'auto') {
16343: $outcome .= $linefeed;
16344: } else {
16345: $outcome .= "</ul><br /><br /></div>\n";
1.541 raeburn 16346: }
1.444 albertel 16347: }
16348: if ($args->{'no_end_date'}) {
16349: $args->{'endaccess'} = 0;
16350: }
16351: $cenv{'internal.autostart'}=$args->{'enrollstart'};
16352: $cenv{'internal.autoend'}=$args->{'enrollend'};
16353: $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
16354: $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
16355: if ($args->{'showphotos'}) {
16356: $cenv{'internal.showphotos'}=$args->{'showphotos'};
16357: }
16358: $cenv{'internal.authtype'} = $args->{'authtype'};
16359: $cenv{'internal.autharg'} = $args->{'autharg'};
16360: if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
16361: if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'} eq '') {
1.541 raeburn 16362: 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');
16363: if ($context eq 'auto') {
16364: $outcome .= $krb_msg;
16365: } else {
1.566 albertel 16366: $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
1.541 raeburn 16367: }
16368: $outcome .= $linefeed;
1.444 albertel 16369: }
16370: }
16371: if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
16372: if ($args->{'setpolicy'}) {
16373: $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
16374: }
16375: if ($args->{'setcontent'}) {
16376: $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
16377: }
1.1251 raeburn 16378: if ($args->{'setcomment'}) {
16379: $cenv{'comment.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
16380: }
1.444 albertel 16381: }
16382: if ($args->{'reshome'}) {
16383: $cenv{'reshome'}=$args->{'reshome'}.'/';
16384: $cenv{'reshome'}=~s/\/+$/\//;
16385: }
16386: #
16387: # course has keyed access
16388: #
16389: if ($args->{'setkeys'}) {
16390: $cenv{'keyaccess'}='yes';
16391: }
16392: # if specified, key authority is not course, but user
16393: # only active if keyaccess is yes
16394: if ($args->{'keyauth'}) {
1.487 albertel 16395: my ($user,$domain) = split(':',$args->{'keyauth'});
16396: $user = &LONCAPA::clean_username($user);
16397: $domain = &LONCAPA::clean_username($domain);
1.488 foxr 16398: if ($user ne '' && $domain ne '') {
1.487 albertel 16399: $cenv{'keyauth'}=$user.':'.$domain;
1.444 albertel 16400: }
16401: }
16402:
1.1166 raeburn 16403: #
1.1167 raeburn 16404: # generate and store uniquecode (available to course requester), if course should have one.
1.1166 raeburn 16405: #
16406: if ($args->{'uniquecode'}) {
16407: my ($code,$error) = &make_unique_code($$crsudom,$$crsunum);
16408: if ($code) {
16409: $cenv{'internal.uniquecode'} = $code;
1.1167 raeburn 16410: my %crsinfo =
16411: &Apache::lonnet::courseiddump($$crsudom,'.',1,'.','.',$$crsunum,undef,undef,'.');
16412: if (ref($crsinfo{$$crsudom.'_'.$$crsunum}) eq 'HASH') {
16413: $crsinfo{$$crsudom.'_'.$$crsunum}{'uniquecode'} = $code;
16414: my $putres = &Apache::lonnet::courseidput($$crsudom,\%crsinfo,$crsuhome,'notime');
16415: }
1.1166 raeburn 16416: if (ref($coderef)) {
16417: $$coderef = $code;
16418: }
16419: }
16420: }
16421:
1.444 albertel 16422: if ($args->{'disresdis'}) {
16423: $cenv{'pch.roles.denied'}='st';
16424: }
16425: if ($args->{'disablechat'}) {
16426: $cenv{'plc.roles.denied'}='st';
16427: }
16428:
16429: # Record we've not yet viewed the Course Initialization Helper for this
16430: # course
16431: $cenv{'course.helper.not.run'} = 1;
16432: #
16433: # Use new Randomseed
16434: #
16435: $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
16436: $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
16437: #
16438: # The encryption code and receipt prefix for this course
16439: #
16440: $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
16441: $cenv{'internal.encpref'}=100+int(9*rand(99));
16442: #
16443: # By default, use standard grading
16444: if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
16445:
1.541 raeburn 16446: $outcome .= $linefeed.&mt('Setting environment').': '.
16447: &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 16448: #
16449: # Open all assignments
16450: #
16451: if ($args->{'openall'}) {
1.1341 raeburn 16452: my $opendate = time;
16453: if ($args->{'openallfrom'} =~ /^\d+$/) {
16454: $opendate = $args->{'openallfrom'};
16455: }
1.444 albertel 16456: my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
1.1341 raeburn 16457: my %storecontent = ($storeunder => $opendate,
1.444 albertel 16458: $storeunder.'.type' => 'date_start');
1.1341 raeburn 16459: $outcome .= &mt('All assignments open starting [_1]',
16460: &Apache::lonlocal::locallocaltime($opendate)).': '.
16461: &Apache::lonnet::cput
16462: ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 16463: }
16464: #
16465: # Set first page
16466: #
16467: unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
16468: || ($cloneid)) {
1.445 albertel 16469: use LONCAPA::map;
1.444 albertel 16470: $outcome .= &mt('Setting first resource').': ';
1.445 albertel 16471:
16472: my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
16473: my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
16474:
1.444 albertel 16475: $outcome .= ($fatal?$errtext:'read ok').' - ';
16476: my $title; my $url;
16477: if ($args->{'firstres'} eq 'syl') {
1.690 bisitz 16478: $title=&mt('Syllabus');
1.444 albertel 16479: $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
16480: } else {
1.963 raeburn 16481: $title=&mt('Table of Contents');
1.444 albertel 16482: $url='/adm/navmaps';
16483: }
1.445 albertel 16484:
16485: $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
16486: (my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
16487:
16488: if ($errtext) { $fatal=2; }
1.541 raeburn 16489: $outcome .= ($fatal?$errtext:'write ok').$linefeed;
1.444 albertel 16490: }
1.566 albertel 16491:
1.1237 raeburn 16492: #
16493: # Set params for Placement Tests
16494: #
1.1239 raeburn 16495: if ($args->{'crstype'} eq 'Placement') {
16496: my %storecontent;
16497: my $prefix=$$crsudom.'_'.$$crsunum.'.0.';
16498: my %defaults = (
16499: buttonshide => { value => 'yes',
16500: type => 'string_yesno',},
16501: type => { value => 'randomizetry',
16502: type => 'string_questiontype',},
16503: maxtries => { value => 1,
16504: type => 'int_pos',},
16505: problemstatus => { value => 'no',
16506: type => 'string_problemstatus',},
16507: );
16508: foreach my $key (keys(%defaults)) {
16509: $storecontent{$prefix.$key} = $defaults{$key}{'value'};
16510: $storecontent{$prefix.$key.'.type'} = $defaults{$key}{'type'};
16511: }
1.1237 raeburn 16512: &Apache::lonnet::cput
16513: ('resourcedata',\%storecontent,$$crsudom,$$crsunum);
16514: }
16515:
1.1344 raeburn 16516: return (1,$outcome,\@clonemsg);
1.444 albertel 16517: }
16518:
1.1166 raeburn 16519: sub make_unique_code {
16520: my ($cdom,$cnum) = @_;
16521: # get lock on uniquecodes db
16522: my $lockhash = {
16523: $cnum."\0".'uniquecodes' => $env{'user.name'}.
16524: ':'.$env{'user.domain'},
16525: };
16526: my $tries = 0;
16527: my $gotlock = &Apache::lonnet::newput_dom('uniquecodes',$lockhash,$cdom);
16528: my ($code,$error);
16529:
16530: while (($gotlock ne 'ok') && ($tries<3)) {
16531: $tries ++;
16532: sleep 1;
16533: $gotlock = &Apache::lonnet::newput_dom('uniquecodes',$lockhash,$cdom);
16534: }
16535: if ($gotlock eq 'ok') {
16536: my %currcodes = &Apache::lonnet::dump_dom('uniquecodes',$cdom);
16537: my $gotcode;
16538: my $attempts = 0;
16539: while ((!$gotcode) && ($attempts < 100)) {
16540: $code = &generate_code();
16541: if (!exists($currcodes{$code})) {
16542: $gotcode = 1;
16543: unless (&Apache::lonnet::newput_dom('uniquecodes',{ $code => $cnum },$cdom) eq 'ok') {
16544: $error = 'nostore';
16545: }
16546: }
16547: $attempts ++;
16548: }
16549: my @del_lock = ($cnum."\0".'uniquecodes');
16550: my $dellockoutcome = &Apache::lonnet::del_dom('uniquecodes',\@del_lock,$cdom);
16551: } else {
16552: $error = 'nolock';
16553: }
16554: return ($code,$error);
16555: }
16556:
16557: sub generate_code {
16558: my $code;
16559: my @letts = qw(B C D G H J K M N P Q R S T V W X Z);
16560: for (my $i=0; $i<6; $i++) {
16561: my $lettnum = int (rand 2);
16562: my $item = '';
16563: if ($lettnum) {
16564: $item = $letts[int( rand(18) )];
16565: } else {
16566: $item = 1+int( rand(8) );
16567: }
16568: $code .= $item;
16569: }
16570: return $code;
16571: }
16572:
1.444 albertel 16573: ############################################################
16574: ############################################################
16575:
1.1237 raeburn 16576: # Community, Course and Placement Test
1.378 raeburn 16577: sub course_type {
16578: my ($cid) = @_;
16579: if (!defined($cid)) {
16580: $cid = $env{'request.course.id'};
16581: }
1.404 albertel 16582: if (defined($env{'course.'.$cid.'.type'})) {
16583: return $env{'course.'.$cid.'.type'};
1.378 raeburn 16584: } else {
16585: return 'Course';
1.377 raeburn 16586: }
16587: }
1.156 albertel 16588:
1.406 raeburn 16589: sub group_term {
16590: my $crstype = &course_type();
16591: my %names = (
16592: 'Course' => 'group',
1.865 raeburn 16593: 'Community' => 'group',
1.1237 raeburn 16594: 'Placement' => 'group',
1.406 raeburn 16595: );
16596: return $names{$crstype};
16597: }
16598:
1.902 raeburn 16599: sub course_types {
1.1310 raeburn 16600: my @types = ('official','unofficial','community','textbook','placement','lti');
1.902 raeburn 16601: my %typename = (
16602: official => 'Official course',
16603: unofficial => 'Unofficial course',
16604: community => 'Community',
1.1165 raeburn 16605: textbook => 'Textbook course',
1.1237 raeburn 16606: placement => 'Placement test',
1.1310 raeburn 16607: lti => 'LTI provider',
1.902 raeburn 16608: );
16609: return (\@types,\%typename);
16610: }
16611:
1.156 albertel 16612: sub icon {
16613: my ($file)=@_;
1.505 albertel 16614: my $curfext = lc((split(/\./,$file))[-1]);
1.168 albertel 16615: my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156 albertel 16616: my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168 albertel 16617: if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
16618: if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
16619: $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
16620: $curfext.".gif") {
16621: $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
16622: $curfext.".gif";
16623: }
16624: }
1.249 albertel 16625: return &lonhttpdurl($iconname);
1.154 albertel 16626: }
1.84 albertel 16627:
1.575 albertel 16628: sub lonhttpdurl {
1.692 www 16629: #
16630: # Had been used for "small fry" static images on separate port 8080.
16631: # Modify here if lightweight http functionality desired again.
16632: # Currently eliminated due to increasing firewall issues.
16633: #
1.575 albertel 16634: my ($url)=@_;
1.692 www 16635: return $url;
1.215 albertel 16636: }
16637:
1.213 albertel 16638: sub connection_aborted {
16639: my ($r)=@_;
16640: $r->print(" ");$r->rflush();
16641: my $c = $r->connection;
16642: return $c->aborted();
16643: }
16644:
1.221 foxr 16645: # Escapes strings that may have embedded 's that will be put into
1.222 foxr 16646: # strings as 'strings'.
16647: sub escape_single {
1.221 foxr 16648: my ($input) = @_;
1.223 albertel 16649: $input =~ s/\\/\\\\/g; # Escape the \'s..(must be first)>
1.221 foxr 16650: $input =~ s/\'/\\\'/g; # Esacpe the 's....
16651: return $input;
16652: }
1.223 albertel 16653:
1.222 foxr 16654: # Same as escape_single, but escape's "'s This
16655: # can be used for "strings"
16656: sub escape_double {
16657: my ($input) = @_;
16658: $input =~ s/\\/\\\\/g; # Escape the /'s..(must be first)>
16659: $input =~ s/\"/\\\"/g; # Esacpe the "s....
16660: return $input;
16661: }
1.223 albertel 16662:
1.222 foxr 16663: # Escapes the last element of a full URL.
16664: sub escape_url {
16665: my ($url) = @_;
1.238 raeburn 16666: my @urlslices = split(/\//, $url,-1);
1.369 www 16667: my $lastitem = &escape(pop(@urlslices));
1.1203 raeburn 16668: return &HTML::Entities::encode(join('/',@urlslices),"'").'/'.$lastitem;
1.222 foxr 16669: }
1.462 albertel 16670:
1.820 raeburn 16671: sub compare_arrays {
16672: my ($arrayref1,$arrayref2) = @_;
16673: my (@difference,%count);
16674: @difference = ();
16675: %count = ();
16676: if ((ref($arrayref1) eq 'ARRAY') && (ref($arrayref2) eq 'ARRAY')) {
16677: foreach my $element (@{$arrayref1}, @{$arrayref2}) { $count{$element}++; }
16678: foreach my $element (keys(%count)) {
16679: if ($count{$element} == 1) {
16680: push(@difference,$element);
16681: }
16682: }
16683: }
16684: return @difference;
16685: }
16686:
1.1322 raeburn 16687: sub lon_status_items {
16688: my %defaults = (
16689: E => 100,
16690: W => 4,
16691: N => 1,
1.1324 raeburn 16692: U => 5,
1.1322 raeburn 16693: threshold => 200,
16694: sysmail => 2500,
16695: );
16696: my %names = (
16697: E => 'Errors',
16698: W => 'Warnings',
16699: N => 'Notices',
1.1324 raeburn 16700: U => 'Unsent',
1.1322 raeburn 16701: );
16702: return (\%defaults,\%names);
16703: }
16704:
1.817 bisitz 16705: # -------------------------------------------------------- Initialize user login
1.462 albertel 16706: sub init_user_environment {
1.463 albertel 16707: my ($r, $username, $domain, $authhost, $form, $args) = @_;
1.462 albertel 16708: my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
16709:
16710: my $public=($username eq 'public' && $domain eq 'public');
16711:
1.1062 raeburn 16712: my ($filename,$cookie,$userroles,$firstaccenv,$timerintenv);
1.462 albertel 16713: my $now=time;
16714:
16715: if ($public) {
16716: my $max_public=100;
16717: my $oldest;
16718: my $oldest_time=0;
16719: for(my $next=1;$next<=$max_public;$next++) {
16720: if (-e $lonids."/publicuser_$next.id") {
16721: my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
16722: if ($mtime<$oldest_time || !$oldest_time) {
16723: $oldest_time=$mtime;
16724: $oldest=$next;
16725: }
16726: } else {
16727: $cookie="publicuser_$next";
16728: last;
16729: }
16730: }
16731: if (!$cookie) { $cookie="publicuser_$oldest"; }
16732: } else {
1.1275 raeburn 16733: # See if old ID present, if so, remove if this isn't a robot,
16734: # killing any existing non-robot sessions
1.463 albertel 16735: if (!$args->{'robot'}) {
16736: opendir(DIR,$lonids);
16737: while ($filename=readdir(DIR)) {
16738: if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
1.1320 raeburn 16739: if (tie(my %oldenv,'GDBM_File',"$lonids/$filename",
16740: &GDBM_READER(),0640)) {
1.1295 raeburn 16741: my $linkedfile;
1.1320 raeburn 16742: if (exists($oldenv{'user.linkedenv'})) {
16743: $linkedfile = $oldenv{'user.linkedenv'};
1.1295 raeburn 16744: }
1.1320 raeburn 16745: untie(%oldenv);
16746: if (unlink("$lonids/$filename")) {
16747: if ($linkedfile =~ /^[a-f0-9]+_linked$/) {
16748: if (-l "$lonids/$linkedfile.id") {
16749: unlink("$lonids/$linkedfile.id");
16750: }
1.1295 raeburn 16751: }
16752: }
16753: } else {
16754: unlink($lonids.'/'.$filename);
16755: }
1.463 albertel 16756: }
1.462 albertel 16757: }
1.463 albertel 16758: closedir(DIR);
1.1204 raeburn 16759: # If there is a undeleted lockfile for the user's paste buffer remove it.
16760: my $namespace = 'nohist_courseeditor';
16761: my $lockingkey = 'paste'."\0".'locked_num';
16762: my %lockhash = &Apache::lonnet::get($namespace,[$lockingkey],
16763: $domain,$username);
16764: if (exists($lockhash{$lockingkey})) {
16765: my $delresult = &Apache::lonnet::del($namespace,[$lockingkey],$domain,$username);
16766: unless ($delresult eq 'ok') {
16767: &Apache::lonnet::logthis("Failed to delete paste buffer locking key in $namespace for ".$username.":".$domain." Result was: $delresult");
16768: }
16769: }
1.462 albertel 16770: }
16771: # Give them a new cookie
1.463 albertel 16772: my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
1.684 www 16773: : $now.$$.int(rand(10000)));
1.463 albertel 16774: $cookie="$username\_$id\_$domain\_$authhost";
1.462 albertel 16775:
16776: # Initialize roles
16777:
1.1062 raeburn 16778: ($userroles,$firstaccenv,$timerintenv) =
16779: &Apache::lonnet::rolesinit($domain,$username,$authhost);
1.462 albertel 16780: }
16781: # ------------------------------------ Check browser type and MathML capability
16782:
1.1194 raeburn 16783: my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,$clientunicode,
16784: $clientos,$clientmobile,$clientinfo,$clientosversion) = &decode_user_agent($r);
1.462 albertel 16785:
16786: # ------------------------------------------------------------- Get environment
16787:
16788: my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
16789: my ($tmp) = keys(%userenv);
1.1275 raeburn 16790: if ($tmp =~ /^(con_lost|error|no_such_host)/i) {
1.462 albertel 16791: undef(%userenv);
16792: }
16793: if (($userenv{'interface'}) && (!$form->{'interface'})) {
16794: $form->{'interface'}=$userenv{'interface'};
16795: }
16796: if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
16797:
16798: # --------------- Do not trust query string to be put directly into environment
1.817 bisitz 16799: foreach my $option ('interface','localpath','localres') {
16800: $form->{$option}=~s/[\n\r\=]//gs;
1.462 albertel 16801: }
16802: # --------------------------------------------------------- Write first profile
16803:
16804: {
1.1350 ! raeburn 16805: my $ip = &Apache::lonnet::get_requestor_ip($r);
1.462 albertel 16806: my %initial_env =
16807: ("user.name" => $username,
16808: "user.domain" => $domain,
16809: "user.home" => $authhost,
16810: "browser.type" => $clientbrowser,
16811: "browser.version" => $clientversion,
16812: "browser.mathml" => $clientmathml,
16813: "browser.unicode" => $clientunicode,
16814: "browser.os" => $clientos,
1.1137 raeburn 16815: "browser.mobile" => $clientmobile,
1.1141 raeburn 16816: "browser.info" => $clientinfo,
1.1194 raeburn 16817: "browser.osversion" => $clientosversion,
1.462 albertel 16818: "server.domain" => $Apache::lonnet::perlvar{'lonDefDomain'},
16819: "request.course.fn" => '',
16820: "request.course.uri" => '',
16821: "request.course.sec" => '',
16822: "request.role" => 'cm',
16823: "request.role.adv" => $env{'user.adv'},
1.1350 ! raeburn 16824: "request.host" => $ip,);
1.462 albertel 16825:
16826: if ($form->{'localpath'}) {
16827: $initial_env{"browser.localpath"} = $form->{'localpath'};
16828: $initial_env{"browser.localres"} = $form->{'localres'};
16829: }
16830:
16831: if ($form->{'interface'}) {
16832: $form->{'interface'}=~s/\W//gs;
16833: $initial_env{"browser.interface"} = $form->{'interface'};
16834: $env{'browser.interface'}=$form->{'interface'};
16835: }
16836:
1.1157 raeburn 16837: if ($form->{'iptoken'}) {
16838: my $lonhost = $r->dir_config('lonHostID');
16839: $initial_env{"user.noloadbalance"} = $lonhost;
16840: $env{'user.noloadbalance'} = $lonhost;
16841: }
16842:
1.1268 raeburn 16843: if ($form->{'noloadbalance'}) {
16844: my @hosts = &Apache::lonnet::current_machine_ids();
16845: my $hosthere = $form->{'noloadbalance'};
16846: if (grep(/^\Q$hosthere\E$/,@hosts)) {
16847: $initial_env{"user.noloadbalance"} = $hosthere;
16848: $env{'user.noloadbalance'} = $hosthere;
16849: }
16850: }
16851:
1.1016 raeburn 16852: unless ($domain eq 'public') {
1.1273 raeburn 16853: my %is_adv = ( is_adv => $env{'user.adv'} );
16854: my %domdef = &Apache::lonnet::get_domain_defaults($domain);
16855:
16856: foreach my $tool ('aboutme','blog','webdav','portfolio') {
16857: $userenv{'availabletools.'.$tool} =
16858: &Apache::lonnet::usertools_access($username,$domain,$tool,'reload',
16859: undef,\%userenv,\%domdef,\%is_adv);
16860: }
1.980 raeburn 16861:
1.1311 raeburn 16862: foreach my $crstype ('official','unofficial','community','textbook','placement','lti') {
1.1273 raeburn 16863: $userenv{'canrequest.'.$crstype} =
16864: &Apache::lonnet::usertools_access($username,$domain,$crstype,
16865: 'reload','requestcourses',
16866: \%userenv,\%domdef,\%is_adv);
16867: }
1.724 raeburn 16868:
1.1273 raeburn 16869: $userenv{'canrequest.author'} =
16870: &Apache::lonnet::usertools_access($username,$domain,'requestauthor',
16871: 'reload','requestauthor',
1.980 raeburn 16872: \%userenv,\%domdef,\%is_adv);
1.1273 raeburn 16873: my %reqauthor = &Apache::lonnet::get('requestauthor',['author_status','author'],
16874: $domain,$username);
16875: my $reqstatus = $reqauthor{'author_status'};
16876: if ($reqstatus eq 'approval' || $reqstatus eq 'approved') {
16877: if (ref($reqauthor{'author'}) eq 'HASH') {
16878: $userenv{'requestauthorqueued'} = $reqstatus.':'.
16879: $reqauthor{'author'}{'timestamp'};
16880: }
1.1092 raeburn 16881: }
1.1287 raeburn 16882: my ($types,$typename) = &course_types();
16883: if (ref($types) eq 'ARRAY') {
16884: my @options = ('approval','validate','autolimit');
16885: my $optregex = join('|',@options);
16886: my (%willtrust,%trustchecked);
16887: foreach my $type (@{$types}) {
16888: my $dom_str = $env{'environment.reqcrsotherdom.'.$type};
16889: if ($dom_str ne '') {
16890: my $updatedstr = '';
16891: my @possdomains = split(',',$dom_str);
16892: foreach my $entry (@possdomains) {
16893: my ($extdom,$extopt) = split(':',$entry);
16894: unless ($trustchecked{$extdom}) {
16895: $willtrust{$extdom} = &Apache::lonnet::will_trust('reqcrs',$domain,$extdom);
16896: $trustchecked{$extdom} = 1;
16897: }
16898: if ($willtrust{$extdom}) {
16899: $updatedstr .= $entry.',';
16900: }
16901: }
16902: $updatedstr =~ s/,$//;
16903: if ($updatedstr) {
16904: $userenv{'reqcrsotherdom.'.$type} = $updatedstr;
16905: } else {
16906: delete($userenv{'reqcrsotherdom.'.$type});
16907: }
16908: }
16909: }
16910: }
1.1092 raeburn 16911: }
1.462 albertel 16912: $env{'user.environment'} = "$lonids/$cookie.id";
1.1062 raeburn 16913:
1.462 albertel 16914: if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
16915: &GDBM_WRCREAT(),0640)) {
16916: &_add_to_env(\%disk_env,\%initial_env);
16917: &_add_to_env(\%disk_env,\%userenv,'environment.');
16918: &_add_to_env(\%disk_env,$userroles);
1.1062 raeburn 16919: if (ref($firstaccenv) eq 'HASH') {
16920: &_add_to_env(\%disk_env,$firstaccenv);
16921: }
16922: if (ref($timerintenv) eq 'HASH') {
16923: &_add_to_env(\%disk_env,$timerintenv);
16924: }
1.463 albertel 16925: if (ref($args->{'extra_env'})) {
16926: &_add_to_env(\%disk_env,$args->{'extra_env'});
16927: }
1.462 albertel 16928: untie(%disk_env);
16929: } else {
1.705 tempelho 16930: &Apache::lonnet::logthis("<span style=\"color:blue;\">WARNING: ".
16931: 'Could not create environment storage in lonauth: '.$!.'</span>');
1.462 albertel 16932: return 'error: '.$!;
16933: }
16934: }
16935: $env{'request.role'}='cm';
16936: $env{'request.role.adv'}=$env{'user.adv'};
16937: $env{'browser.type'}=$clientbrowser;
16938:
16939: return $cookie;
16940:
16941: }
16942:
16943: sub _add_to_env {
16944: my ($idf,$env_data,$prefix) = @_;
1.676 raeburn 16945: if (ref($env_data) eq 'HASH') {
16946: while (my ($key,$value) = each(%$env_data)) {
16947: $idf->{$prefix.$key} = $value;
16948: $env{$prefix.$key} = $value;
16949: }
1.462 albertel 16950: }
16951: }
16952:
1.685 tempelho 16953: # --- Get the symbolic name of a problem and the url
16954: sub get_symb {
16955: my ($request,$silent) = @_;
1.726 raeburn 16956: (my $url=$env{'form.url'}) =~ s-^https?\://($ENV{'SERVER_NAME'}|$ENV{'HTTP_HOST'})--;
1.685 tempelho 16957: my $symb=($env{'form.symb'} ne '' ? $env{'form.symb'} : (&Apache::lonnet::symbread($url)));
16958: if ($symb eq '') {
16959: if (!$silent) {
1.1071 raeburn 16960: if (ref($request)) {
16961: $request->print("Unable to handle ambiguous references:$url:.");
16962: }
1.685 tempelho 16963: return ();
16964: }
16965: }
16966: &Apache::lonenc::check_decrypt(\$symb);
16967: return ($symb);
16968: }
16969:
16970: # --------------------------------------------------------------Get annotation
16971:
16972: sub get_annotation {
16973: my ($symb,$enc) = @_;
16974:
16975: my $key = $symb;
16976: if (!$enc) {
16977: $key =
16978: &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]);
16979: }
16980: my %annotation=&Apache::lonnet::get('nohist_annotations',[$key]);
16981: return $annotation{$key};
16982: }
16983:
16984: sub clean_symb {
1.731 raeburn 16985: my ($symb,$delete_enc) = @_;
1.685 tempelho 16986:
16987: &Apache::lonenc::check_decrypt(\$symb);
16988: my $enc = $env{'request.enc'};
1.731 raeburn 16989: if ($delete_enc) {
1.730 raeburn 16990: delete($env{'request.enc'});
16991: }
1.685 tempelho 16992:
16993: return ($symb,$enc);
16994: }
1.462 albertel 16995:
1.1181 raeburn 16996: ############################################################
16997: ############################################################
16998:
16999: =pod
17000:
17001: =head1 Routines for building display used to search for courses
17002:
17003:
17004: =over 4
17005:
17006: =item * &build_filters()
17007:
17008: Create markup for a table used to set filters to use when selecting
1.1182 raeburn 17009: courses in a domain. Used by lonpickcourse.pm, lonmodifycourse.pm
17010: and quotacheck.pl
17011:
1.1181 raeburn 17012:
17013: Inputs:
17014:
17015: filterlist - anonymous array of fields to include as potential filters
17016:
17017: crstype - course type
17018:
17019: roleelement - fifth arg in selectcourse_link() populates fifth arg in javascript: opencrsbrowser() function, used
17020: to pop-open a course selector (will contain "extra element").
17021:
17022: multelement - if multiple course selections will be allowed, this will be a hidden form element: name: multiple; value: 1
17023:
17024: filter - anonymous hash of criteria and their values
17025:
17026: action - form action
17027:
17028: numfiltersref - ref to scalar (count of number of elements in institutional codes -- e.g., 4 for year, semester, department, and number)
17029:
1.1182 raeburn 17030: caller - caller context (e.g., set to 'modifycourse' when routine is called from lonmodifycourse.pm)
1.1181 raeburn 17031:
17032: cloneruname - username of owner of new course who wants to clone
17033:
17034: clonerudom - domain of owner of new course who wants to clone
17035:
17036: typeelem - text to use for left column in row containing course type (i.e., Course, Community or Course/Community)
17037:
17038: codetitlesref - reference to array of titles of components in institutional codes (official courses)
17039:
17040: codedom - domain
17041:
17042: formname - value of form element named "form".
17043:
17044: fixeddom - domain, if fixed.
17045:
17046: prevphase - value to assign to form element named "phase" when going back to the previous screen
17047:
17048: cnameelement - name of form element in form on opener page which will receive title of selected course
17049:
17050: cnumelement - name of form element in form on opener page which will receive courseID of selected course
17051:
17052: cdomelement - name of form element in form on opener page which will receive domain of selected course
17053:
17054: setroles - includes access constraint identifier when setting a roles-based condition for acces to a portfolio file
17055:
17056: clonetext - hidden form elements containing list of courses cloneable by intended course owner when DC creates a course
17057:
17058: clonewarning - warning message about missing information for intended course owner when DC creates a course
17059:
1.1182 raeburn 17060:
1.1181 raeburn 17061: Returns: $output - HTML for display of search criteria, and hidden form elements.
17062:
1.1182 raeburn 17063:
1.1181 raeburn 17064: Side Effects: None
17065:
17066: =cut
17067:
17068: # ---------------------------------------------- search for courses based on last activity etc.
17069:
17070: sub build_filters {
17071: my ($filterlist,$crstype,$roleelement,$multelement,$filter,$action,
17072: $numtitlesref,$caller,$cloneruname,$clonerudom,$typeelement,
17073: $codetitlesref,$codedom,$formname,$fixeddom,$prevphase,
17074: $cnameelement,$cnumelement,$cdomelement,$setroles,
17075: $clonetext,$clonewarning) = @_;
1.1182 raeburn 17076: my ($list,$jscript);
1.1181 raeburn 17077: my $onchange = 'javascript:updateFilters(this)';
17078: my ($domainselectform,$sincefilterform,$createdfilterform,
17079: $ownerdomselectform,$persondomselectform,$instcodeform,
17080: $typeselectform,$instcodetitle);
17081: if ($formname eq '') {
17082: $formname = $caller;
17083: }
17084: foreach my $item (@{$filterlist}) {
17085: unless (($item eq 'descriptfilter') || ($item eq 'instcodefilter') ||
17086: ($item eq 'sincefilter') || ($item eq 'createdfilter')) {
17087: if ($item eq 'domainfilter') {
17088: $filter->{$item} = &LONCAPA::clean_domain($filter->{$item});
17089: } elsif ($item eq 'coursefilter') {
17090: $filter->{$item} = &LONCAPA::clean_courseid($filter->{$item});
17091: } elsif ($item eq 'ownerfilter') {
17092: $filter->{$item} = &LONCAPA::clean_username($filter->{$item});
17093: } elsif ($item eq 'ownerdomfilter') {
17094: $filter->{'ownerdomfilter'} =
17095: &LONCAPA::clean_domain($filter->{$item});
17096: $ownerdomselectform = &select_dom_form($filter->{'ownerdomfilter'},
17097: 'ownerdomfilter',1);
17098: } elsif ($item eq 'personfilter') {
17099: $filter->{$item} = &LONCAPA::clean_username($filter->{$item});
17100: } elsif ($item eq 'persondomfilter') {
17101: $persondomselectform = &select_dom_form($filter->{'persondomfilter'},
17102: 'persondomfilter',1);
17103: } else {
17104: $filter->{$item} =~ s/\W//g;
17105: }
17106: if (!$filter->{$item}) {
17107: $filter->{$item} = '';
17108: }
17109: }
17110: if ($item eq 'domainfilter') {
17111: my $allow_blank = 1;
17112: if ($formname eq 'portform') {
17113: $allow_blank=0;
17114: } elsif ($formname eq 'studentform') {
17115: $allow_blank=0;
17116: }
17117: if ($fixeddom) {
17118: $domainselectform = '<input type="hidden" name="domainfilter"'.
17119: ' value="'.$codedom.'" />'.
17120: &Apache::lonnet::domain($codedom,'description');
17121: } else {
17122: $domainselectform = &select_dom_form($filter->{$item},
17123: 'domainfilter',
17124: $allow_blank,'',$onchange);
17125: }
17126: } else {
17127: $list->{$item} = &HTML::Entities::encode($filter->{$item},'<>&"');
17128: }
17129: }
17130:
17131: # last course activity filter and selection
17132: $sincefilterform = &timebased_select_form('sincefilter',$filter);
17133:
17134: # course created filter and selection
17135: if (exists($filter->{'createdfilter'})) {
17136: $createdfilterform = &timebased_select_form('createdfilter',$filter);
17137: }
17138:
1.1239 raeburn 17139: my $prefix = $crstype;
17140: if ($crstype eq 'Placement') {
17141: $prefix = 'Placement Test'
17142: }
1.1181 raeburn 17143: my %lt = &Apache::lonlocal::texthash(
1.1239 raeburn 17144: 'cac' => "$prefix Activity",
17145: 'ccr' => "$prefix Created",
17146: 'cde' => "$prefix Title",
17147: 'cdo' => "$prefix Domain",
1.1181 raeburn 17148: 'ins' => 'Institutional Code',
17149: 'inc' => 'Institutional Categorization',
1.1239 raeburn 17150: 'cow' => "$prefix Owner/Co-owner",
17151: 'cop' => "$prefix Personnel Includes",
1.1181 raeburn 17152: 'cog' => 'Type',
17153: );
17154:
17155: if (($formname eq 'ccrs') || ($formname eq 'requestcrs')) {
17156: my $typeval = 'Course';
17157: if ($crstype eq 'Community') {
17158: $typeval = 'Community';
1.1239 raeburn 17159: } elsif ($crstype eq 'Placement') {
17160: $typeval = 'Placement';
1.1181 raeburn 17161: }
17162: $typeselectform = '<input type="hidden" name="type" value="'.$typeval.'" />';
17163: } else {
17164: $typeselectform = '<select name="type" size="1"';
17165: if ($onchange) {
17166: $typeselectform .= ' onchange="'.$onchange.'"';
17167: }
17168: $typeselectform .= '>'."\n";
1.1237 raeburn 17169: foreach my $posstype ('Course','Community','Placement') {
1.1239 raeburn 17170: my $shown;
17171: if ($posstype eq 'Placement') {
17172: $shown = &mt('Placement Test');
17173: } else {
17174: $shown = &mt($posstype);
17175: }
1.1181 raeburn 17176: $typeselectform.='<option value="'.$posstype.'"'.
1.1239 raeburn 17177: ($posstype eq $crstype ? ' selected="selected" ' : ''). ">".$shown."</option>\n";
1.1181 raeburn 17178: }
17179: $typeselectform.="</select>";
17180: }
17181:
17182: my ($cloneableonlyform,$cloneabletitle);
17183: if (exists($filter->{'cloneableonly'})) {
17184: my $cloneableon = '';
17185: my $cloneableoff = ' checked="checked"';
17186: if ($filter->{'cloneableonly'}) {
17187: $cloneableon = $cloneableoff;
17188: $cloneableoff = '';
17189: }
17190: $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>';
17191: if ($formname eq 'ccrs') {
1.1187 bisitz 17192: $cloneabletitle = &mt('Cloneable for [_1]',$cloneruname.':'.$clonerudom);
1.1181 raeburn 17193: } else {
17194: $cloneabletitle = &mt('Cloneable by you');
17195: }
17196: }
17197: my $officialjs;
17198: if ($crstype eq 'Course') {
17199: if (exists($filter->{'instcodefilter'})) {
1.1182 raeburn 17200: # if (($fixeddom) || ($formname eq 'requestcrs') ||
17201: # ($formname eq 'modifycourse') || ($formname eq 'filterpicker')) {
17202: if ($codedom) {
1.1181 raeburn 17203: $officialjs = 1;
17204: ($instcodeform,$jscript,$$numtitlesref) =
17205: &Apache::courseclassifier::instcode_selectors($codedom,'filterpicker',
17206: $officialjs,$codetitlesref);
17207: if ($jscript) {
1.1182 raeburn 17208: $jscript = '<script type="text/javascript">'."\n".
17209: '// <![CDATA['."\n".
17210: $jscript."\n".
17211: '// ]]>'."\n".
17212: '</script>'."\n";
1.1181 raeburn 17213: }
17214: }
17215: if ($instcodeform eq '') {
17216: $instcodeform =
17217: '<input type="text" name="instcodefilter" size="10" value="'.
17218: $list->{'instcodefilter'}.'" />';
17219: $instcodetitle = $lt{'ins'};
17220: } else {
17221: $instcodetitle = $lt{'inc'};
17222: }
17223: if ($fixeddom) {
17224: $instcodetitle .= '<br />('.$codedom.')';
17225: }
17226: }
17227: }
17228: my $output = qq|
17229: <form method="post" name="filterpicker" action="$action">
17230: <input type="hidden" name="form" value="$formname" />
17231: |;
17232: if ($formname eq 'modifycourse') {
17233: $output .= '<input type="hidden" name="phase" value="courselist" />'."\n".
17234: '<input type="hidden" name="prevphase" value="'.
17235: $prevphase.'" />'."\n";
1.1198 musolffc 17236: } elsif ($formname eq 'quotacheck') {
17237: $output .= qq|
17238: <input type="hidden" name="sortby" value="" />
17239: <input type="hidden" name="sortorder" value="" />
17240: |;
17241: } else {
1.1181 raeburn 17242: my $name_input;
17243: if ($cnameelement ne '') {
17244: $name_input = '<input type="hidden" name="cnameelement" value="'.
17245: $cnameelement.'" />';
17246: }
17247: $output .= qq|
1.1182 raeburn 17248: <input type="hidden" name="cnumelement" value="$cnumelement" />
17249: <input type="hidden" name="cdomelement" value="$cdomelement" />
1.1181 raeburn 17250: $name_input
17251: $roleelement
17252: $multelement
17253: $typeelement
17254: |;
17255: if ($formname eq 'portform') {
17256: $output .= '<input type="hidden" name="setroles" value="'.$setroles.'" />'."\n";
17257: }
17258: }
17259: if ($fixeddom) {
17260: $output .= '<input type="hidden" name="fixeddom" value="'.$fixeddom.'" />'."\n";
17261: }
17262: $output .= "<br />\n".&Apache::lonhtmlcommon::start_pick_box();
17263: if ($sincefilterform) {
17264: $output .= &Apache::lonhtmlcommon::row_title($lt{'cac'})
17265: .$sincefilterform
17266: .&Apache::lonhtmlcommon::row_closure();
17267: }
17268: if ($createdfilterform) {
17269: $output .= &Apache::lonhtmlcommon::row_title($lt{'ccr'})
17270: .$createdfilterform
17271: .&Apache::lonhtmlcommon::row_closure();
17272: }
17273: if ($domainselectform) {
17274: $output .= &Apache::lonhtmlcommon::row_title($lt{'cdo'})
17275: .$domainselectform
17276: .&Apache::lonhtmlcommon::row_closure();
17277: }
17278: if ($typeselectform) {
17279: if (($formname eq 'ccrs') || ($formname eq 'requestcrs')) {
17280: $output .= $typeselectform;
17281: } else {
17282: $output .= &Apache::lonhtmlcommon::row_title($lt{'cog'})
17283: .$typeselectform
17284: .&Apache::lonhtmlcommon::row_closure();
17285: }
17286: }
17287: if ($instcodeform) {
17288: $output .= &Apache::lonhtmlcommon::row_title($instcodetitle)
17289: .$instcodeform
17290: .&Apache::lonhtmlcommon::row_closure();
17291: }
17292: if (exists($filter->{'ownerfilter'})) {
17293: $output .= &Apache::lonhtmlcommon::row_title($lt{'cow'}).
17294: '<table><tr><td>'.&mt('Username').'<br />'.
17295: '<input type="text" name="ownerfilter" size="20" value="'.
17296: $list->{'ownerfilter'}.'" /></td><td>'.&mt('Domain').'<br />'.
17297: $ownerdomselectform.'</td></tr></table>'.
17298: &Apache::lonhtmlcommon::row_closure();
17299: }
17300: if (exists($filter->{'personfilter'})) {
17301: $output .= &Apache::lonhtmlcommon::row_title($lt{'cop'}).
17302: '<table><tr><td>'.&mt('Username').'<br />'.
17303: '<input type="text" name="personfilter" size="20" value="'.
17304: $list->{'personfilter'}.'" /></td><td>'.&mt('Domain').'<br />'.
17305: $persondomselectform.'</td></tr></table>'.
17306: &Apache::lonhtmlcommon::row_closure();
17307: }
17308: if (exists($filter->{'coursefilter'})) {
17309: $output .= &Apache::lonhtmlcommon::row_title(&mt('LON-CAPA course ID'))
17310: .'<input type="text" name="coursefilter" size="25" value="'
17311: .$list->{'coursefilter'}.'" />'
17312: .&Apache::lonhtmlcommon::row_closure();
17313: }
17314: if ($cloneableonlyform) {
17315: $output .= &Apache::lonhtmlcommon::row_title($cloneabletitle).
17316: $cloneableonlyform.&Apache::lonhtmlcommon::row_closure();
17317: }
17318: if (exists($filter->{'descriptfilter'})) {
17319: $output .= &Apache::lonhtmlcommon::row_title($lt{'cde'})
17320: .'<input type="text" name="descriptfilter" size="40" value="'
17321: .$list->{'descriptfilter'}.'" />'
17322: .&Apache::lonhtmlcommon::row_closure(1);
17323: }
17324: $output .= &Apache::lonhtmlcommon::end_pick_box().'<p>'.$clonetext."\n".
17325: '<input type="hidden" name="updater" value="" />'."\n".
17326: '<input type="submit" name="gosearch" value="'.
17327: &mt('Search').'" /></p>'."\n".'</form>'."\n".'<hr />'."\n";
17328: return $jscript.$clonewarning.$output;
17329: }
17330:
17331: =pod
17332:
17333: =item * &timebased_select_form()
17334:
1.1182 raeburn 17335: Create markup for a dropdown list used to select a time-based
1.1181 raeburn 17336: filter e.g., Course Activity, Course Created, when searching for courses
17337: or communities
17338:
17339: Inputs:
17340:
17341: item - name of form element (sincefilter or createdfilter)
17342:
17343: filter - anonymous hash of criteria and their values
17344:
17345: Returns: HTML for a select box contained a blank, then six time selections,
17346: with value set in incoming form variables currently selected.
17347:
17348: Side Effects: None
17349:
17350: =cut
17351:
17352: sub timebased_select_form {
17353: my ($item,$filter) = @_;
17354: if (ref($filter) eq 'HASH') {
17355: $filter->{$item} =~ s/[^\d-]//g;
17356: if (!$filter->{$item}) { $filter->{$item}=-1; }
17357: return &select_form(
17358: $filter->{$item},
17359: $item,
17360: { '-1' => '',
17361: '86400' => &mt('today'),
17362: '604800' => &mt('last week'),
17363: '2592000' => &mt('last month'),
17364: '7776000' => &mt('last three months'),
17365: '15552000' => &mt('last six months'),
17366: '31104000' => &mt('last year'),
17367: 'select_form_order' =>
17368: ['-1','86400','604800','2592000','7776000',
17369: '15552000','31104000']});
17370: }
17371: }
17372:
17373: =pod
17374:
17375: =item * &js_changer()
17376:
17377: Create script tag containing Javascript used to submit course search form
1.1183 raeburn 17378: when course type or domain is changed, and also to hide 'Searching ...' on
17379: page load completion for page showing search result.
1.1181 raeburn 17380:
17381: Inputs: None
17382:
1.1183 raeburn 17383: Returns: markup containing updateFilters() and hideSearching() javascript functions.
1.1181 raeburn 17384:
17385: Side Effects: None
17386:
17387: =cut
17388:
17389: sub js_changer {
17390: return <<ENDJS;
17391: <script type="text/javascript">
17392: // <![CDATA[
17393: function updateFilters(caller) {
17394: if (typeof(caller) != "undefined") {
17395: document.filterpicker.updater.value = caller.name;
17396: }
17397: document.filterpicker.submit();
17398: }
1.1183 raeburn 17399:
17400: function hideSearching() {
17401: if (document.getElementById('searching')) {
17402: document.getElementById('searching').style.display = 'none';
17403: }
17404: return;
17405: }
17406:
1.1181 raeburn 17407: // ]]>
17408: </script>
17409:
17410: ENDJS
17411: }
17412:
17413: =pod
17414:
1.1182 raeburn 17415: =item * &search_courses()
17416:
17417: Process selected filters form course search form and pass to lonnet::courseiddump
17418: to retrieve a hash for which keys are courseIDs which match the selected filters.
17419:
17420: Inputs:
17421:
17422: dom - domain being searched
17423:
17424: type - course type ('Course' or 'Community' or '.' if any).
17425:
17426: filter - anonymous hash of criteria and their values
17427:
17428: numtitles - for institutional codes - number of categories
17429:
17430: cloneruname - optional username of new course owner
17431:
17432: clonerudom - optional domain of new course owner
17433:
1.1221 raeburn 17434: domcloner - optional "domcloner" flag; has value=1 if user has ccc priv in domain being filtered by,
1.1182 raeburn 17435: (used when DC is using course creation form)
17436:
17437: codetitles - reference to array of titles of components in institutional codes (official courses).
17438:
1.1221 raeburn 17439: cc_clone - escaped comma separated list of courses for which course cloner has active CC role
17440: (and so can clone automatically)
17441:
17442: reqcrsdom - domain of new course, where search_courses is used to identify potential courses to clone
17443:
17444: reqinstcode - institutional code of new course, where search_courses is used to identify potential
17445: courses to clone
1.1182 raeburn 17446:
17447: Returns: %courses - hash of courses satisfying search criteria, keys = course IDs, values are corresponding colon-separated escaped description, institutional code, owner and type.
17448:
17449:
17450: Side Effects: None
17451:
17452: =cut
17453:
17454:
17455: sub search_courses {
1.1221 raeburn 17456: my ($dom,$type,$filter,$numtitles,$cloneruname,$clonerudom,$domcloner,$codetitles,
17457: $cc_clone,$reqcrsdom,$reqinstcode) = @_;
1.1182 raeburn 17458: my (%courses,%showcourses,$cloner);
17459: if (($filter->{'ownerfilter'} ne '') ||
17460: ($filter->{'ownerdomfilter'} ne '')) {
17461: $filter->{'combownerfilter'} = $filter->{'ownerfilter'}.':'.
17462: $filter->{'ownerdomfilter'};
17463: }
17464: foreach my $item ('descriptfilter','coursefilter','combownerfilter') {
17465: if (!$filter->{$item}) {
17466: $filter->{$item}='.';
17467: }
17468: }
17469: my $now = time;
17470: my $timefilter =
17471: ($filter->{'sincefilter'}==-1?1:$now-$filter->{'sincefilter'});
17472: my ($createdbefore,$createdafter);
17473: if (($filter->{'createdfilter'} ne '') && ($filter->{'createdfilter'} !=-1)) {
17474: $createdbefore = $now;
17475: $createdafter = $now-$filter->{'createdfilter'};
17476: }
17477: my ($instcodefilter,$regexpok);
17478: if ($numtitles) {
17479: if ($env{'form.official'} eq 'on') {
17480: $instcodefilter =
17481: &Apache::courseclassifier::instcode_search_str($dom,$numtitles,$codetitles);
17482: $regexpok = 1;
17483: } elsif ($env{'form.official'} eq 'off') {
17484: $instcodefilter = &Apache::courseclassifier::instcode_search_str($dom,$numtitles,$codetitles);
17485: unless ($instcodefilter eq '') {
17486: $regexpok = -1;
17487: }
17488: }
17489: } else {
17490: $instcodefilter = $filter->{'instcodefilter'};
17491: }
17492: if ($instcodefilter eq '') { $instcodefilter = '.'; }
17493: if ($type eq '') { $type = '.'; }
17494:
17495: if (($clonerudom ne '') && ($cloneruname ne '')) {
17496: $cloner = $cloneruname.':'.$clonerudom;
17497: }
17498: %courses = &Apache::lonnet::courseiddump($dom,
17499: $filter->{'descriptfilter'},
17500: $timefilter,
17501: $instcodefilter,
17502: $filter->{'combownerfilter'},
17503: $filter->{'coursefilter'},
17504: undef,undef,$type,$regexpok,undef,undef,
1.1221 raeburn 17505: undef,undef,$cloner,$cc_clone,
1.1182 raeburn 17506: $filter->{'cloneableonly'},
17507: $createdbefore,$createdafter,undef,
1.1221 raeburn 17508: $domcloner,undef,$reqcrsdom,$reqinstcode);
1.1182 raeburn 17509: if (($filter->{'personfilter'} ne '') && ($filter->{'persondomfilter'} ne '')) {
17510: my $ccrole;
17511: if ($type eq 'Community') {
17512: $ccrole = 'co';
17513: } else {
17514: $ccrole = 'cc';
17515: }
17516: my %rolehash = &Apache::lonnet::get_my_roles($filter->{'personfilter'},
17517: $filter->{'persondomfilter'},
17518: 'userroles',undef,
17519: [$ccrole,'in','ad','ep','ta','cr'],
17520: $dom);
17521: foreach my $role (keys(%rolehash)) {
17522: my ($cnum,$cdom,$courserole) = split(':',$role);
17523: my $cid = $cdom.'_'.$cnum;
17524: if (exists($courses{$cid})) {
17525: if (ref($courses{$cid}) eq 'HASH') {
17526: if (ref($courses{$cid}{roles}) eq 'ARRAY') {
17527: if (!grep(/^\Q$courserole\E$/,@{$courses{$cid}{roles}})) {
1.1263 raeburn 17528: push(@{$courses{$cid}{roles}},$courserole);
1.1182 raeburn 17529: }
17530: } else {
17531: $courses{$cid}{roles} = [$courserole];
17532: }
17533: $showcourses{$cid} = $courses{$cid};
17534: }
17535: }
17536: }
17537: %courses = %showcourses;
17538: }
17539: return %courses;
17540: }
17541:
17542: =pod
17543:
1.1181 raeburn 17544: =back
17545:
1.1207 raeburn 17546: =head1 Routines for version requirements for current course.
17547:
17548: =over 4
17549:
17550: =item * &check_release_required()
17551:
17552: Compares required LON-CAPA version with version on server, and
17553: if required version is newer looks for a server with the required version.
17554:
17555: Looks first at servers in user's owen domain; if none suitable, looks at
17556: servers in course's domain are permitted to host sessions for user's domain.
17557:
17558: Inputs:
17559:
17560: $loncaparev - Version on current server (format: Major.Minor.Subrelease-datestamp)
17561:
17562: $courseid - Course ID of current course
17563:
17564: $rolecode - User's current role in course (for switchserver query string).
17565:
17566: $required - LON-CAPA version needed by course (format: Major.Minor).
17567:
17568:
17569: Returns:
17570:
17571: $switchserver - query string tp append to /adm/switchserver call (if
17572: current server's LON-CAPA version is too old.
17573:
17574: $warning - Message is displayed if no suitable server could be found.
17575:
17576: =cut
17577:
17578: sub check_release_required {
17579: my ($loncaparev,$courseid,$rolecode,$required) = @_;
17580: my ($switchserver,$warning);
17581: if ($required ne '') {
17582: my ($reqdmajor,$reqdminor) = ($required =~ /^(\d+)\.(\d+)$/);
17583: my ($major,$minor) = ($loncaparev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?$/);
17584: if ($reqdmajor ne '' && $reqdminor ne '') {
17585: my $otherserver;
17586: if (($major eq '' && $minor eq '') ||
17587: (($reqdmajor > $major) || (($reqdmajor == $major) && ($reqdminor > $minor)))) {
17588: my ($userdomserver) = &Apache::lonnet::choose_server($env{'user.domain'},undef,$required,1);
17589: my $switchlcrev =
17590: &Apache::lonnet::get_server_loncaparev($env{'user.domain'},
17591: $userdomserver);
17592: my ($swmajor,$swminor) = ($switchlcrev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?$/);
17593: if (($swmajor eq '' && $swminor eq '') || ($reqdmajor > $swmajor) ||
17594: (($reqdmajor == $swmajor) && ($reqdminor > $swminor))) {
17595: my $cdom = $env{'course.'.$courseid.'.domain'};
17596: if ($cdom ne $env{'user.domain'}) {
17597: my ($coursedomserver,$coursehostname) = &Apache::lonnet::choose_server($cdom,undef,$required,1);
17598: my $serverhomeID = &Apache::lonnet::get_server_homeID($coursehostname);
17599: my $serverhomedom = &Apache::lonnet::host_domain($serverhomeID);
17600: my %defdomdefaults = &Apache::lonnet::get_domain_defaults($serverhomedom);
17601: my %udomdefaults = &Apache::lonnet::get_domain_defaults($env{'user.domain'});
17602: my $remoterev = &Apache::lonnet::get_server_loncaparev($serverhomedom,$coursedomserver);
17603: my $canhost =
17604: &Apache::lonnet::can_host_session($env{'user.domain'},
17605: $coursedomserver,
17606: $remoterev,
17607: $udomdefaults{'remotesessions'},
17608: $defdomdefaults{'hostedsessions'});
17609:
17610: if ($canhost) {
17611: $otherserver = $coursedomserver;
17612: } else {
17613: $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.");
17614: }
17615: } else {
17616: $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).");
17617: }
17618: } else {
17619: $otherserver = $userdomserver;
17620: }
17621: }
17622: if ($otherserver ne '') {
17623: $switchserver = 'otherserver='.$otherserver.'&role='.$rolecode;
17624: }
17625: }
17626: }
17627: return ($switchserver,$warning);
17628: }
17629:
17630: =pod
17631:
17632: =item * &check_release_result()
17633:
17634: Inputs:
17635:
17636: $switchwarning - Warning message if no suitable server found to host session.
17637:
17638: $switchserver - query string to append to /adm/switchserver containing lonHostID
17639: and current role.
17640:
17641: Returns: HTML to display with information about requirement to switch server.
17642: Either displaying warning with link to Roles/Courses screen or
17643: display link to switchserver.
17644:
1.1181 raeburn 17645: =cut
17646:
1.1207 raeburn 17647: sub check_release_result {
17648: my ($switchwarning,$switchserver) = @_;
17649: my $output = &start_page('Selected course unavailable on this server').
17650: '<p class="LC_warning">';
17651: if ($switchwarning) {
17652: $output .= $switchwarning.'<br /><a href="/adm/roles">';
17653: if (&show_course()) {
17654: $output .= &mt('Display courses');
17655: } else {
17656: $output .= &mt('Display roles');
17657: }
17658: $output .= '</a>';
17659: } elsif ($switchserver) {
17660: $output .= &mt('This course requires a newer version of LON-CAPA than is installed on this server.').
17661: '<br />'.
17662: '<a href="/adm/switchserver?'.$switchserver.'">'.
17663: &mt('Switch Server').
17664: '</a>';
17665: }
17666: $output .= '</p>'.&end_page();
17667: return $output;
17668: }
17669:
17670: =pod
17671:
17672: =item * &needs_coursereinit()
17673:
17674: Determine if course contents stored for user's session needs to be
17675: refreshed, because content has changed since "Big Hash" last tied.
17676:
17677: Check for change is made if time last checked is more than 10 minutes ago
17678: (by default).
17679:
17680: Inputs:
17681:
17682: $loncaparev - Version on current server (format: Major.Minor.Subrelease-datestamp)
17683:
17684: $interval (optional) - Time which may elapse (in s) between last check for content
17685: change in current course. (default: 600 s).
17686:
17687: Returns: an array; first element is:
17688:
17689: =over 4
17690:
17691: 'switch' - if content updates mean user's session
17692: needs to be switched to a server running a newer LON-CAPA version
17693:
17694: 'update' - if course session needs to be refreshed (i.e., Big Hash needs to be reloaded)
17695: on current server hosting user's session
17696:
17697: '' - if no action required.
17698:
17699: =back
17700:
17701: If first item element is 'switch':
17702:
17703: second item is $switchwarning - Warning message if no suitable server found to host session.
17704:
17705: third item is $switchserver - query string to append to /adm/switchserver containing lonHostID
17706: and current role.
17707:
17708: otherwise: no other elements returned.
17709:
17710: =back
17711:
17712: =cut
17713:
17714: sub needs_coursereinit {
17715: my ($loncaparev,$interval) = @_;
17716: return() unless ($env{'request.course.id'} && $env{'request.course.tied'});
17717: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
17718: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
17719: my $now = time;
17720: if ($interval eq '') {
17721: $interval = 600;
17722: }
17723: if (($now-$env{'request.course.timechecked'})>$interval) {
1.1282 raeburn 17724: &Apache::lonnet::appenv({'request.course.timechecked'=>$now});
1.1283 raeburn 17725: my $blocked = &blocking_status('reinit',$cnum,$cdom,undef,1);
1.1282 raeburn 17726: if ($blocked) {
17727: return ();
17728: }
1.1207 raeburn 17729: my $lastchange = &Apache::lonnet::get_coursechange($cdom,$cnum);
17730: if ($lastchange > $env{'request.course.tied'}) {
17731: my %curr_reqd_hash = &Apache::lonnet::userenvironment($cdom,$cnum,'internal.releaserequired');
17732: if ($curr_reqd_hash{'internal.releaserequired'} ne '') {
17733: my $required = $env{'course.'.$cdom.'_'.$cnum.'.internal.releaserequired'};
17734: if ($curr_reqd_hash{'internal.releaserequired'} ne $required) {
17735: &Apache::lonnet::appenv({'course.'.$cdom.'_'.$cnum.'.internal.releaserequired' =>
17736: $curr_reqd_hash{'internal.releaserequired'}});
17737: my ($switchserver,$switchwarning) =
17738: &check_release_required($loncaparev,$cdom.'_'.$cnum,$env{'request.role'},
17739: $curr_reqd_hash{'internal.releaserequired'});
17740: if ($switchwarning ne '' || $switchserver ne '') {
17741: return ('switch',$switchwarning,$switchserver);
17742: }
17743: }
17744: }
17745: return ('update');
17746: }
17747: }
17748: return ();
17749: }
1.1181 raeburn 17750:
1.1083 raeburn 17751: sub update_content_constraints {
1.1326 raeburn 17752: my ($cdom,$cnum,$chome,$cid,$keeporder) = @_;
1.1083 raeburn 17753: my %curr_reqd_hash = &Apache::lonnet::userenvironment($cdom,$cnum,'internal.releaserequired');
17754: my ($reqdmajor,$reqdminor) = split(/\./,$curr_reqd_hash{'internal.releaserequired'});
1.1307 raeburn 17755: my (%checkresponsetypes,%checkcrsrestypes);
1.1083 raeburn 17756: foreach my $key (keys(%Apache::lonnet::needsrelease)) {
1.1236 raeburn 17757: my ($item,$name,$value) = split(/:/,$key);
1.1083 raeburn 17758: if ($item eq 'resourcetag') {
17759: if ($name eq 'responsetype') {
17760: $checkresponsetypes{$value} = $Apache::lonnet::needsrelease{$key}
17761: }
1.1307 raeburn 17762: } elsif ($item eq 'course') {
17763: if ($name eq 'courserestype') {
17764: $checkcrsrestypes{$value} = $Apache::lonnet::needsrelease{$key};
17765: }
1.1083 raeburn 17766: }
17767: }
17768: my $navmap = Apache::lonnavmaps::navmap->new();
17769: if (defined($navmap)) {
1.1307 raeburn 17770: my (%allresponses,%allcrsrestypes);
17771: foreach my $res ($navmap->retrieveResources(undef,sub { $_[0]->is_problem() || $_[0]->is_tool() },1,0)) {
17772: if ($res->is_tool()) {
17773: if ($allcrsrestypes{'exttool'}) {
17774: $allcrsrestypes{'exttool'} ++;
17775: } else {
17776: $allcrsrestypes{'exttool'} = 1;
17777: }
17778: next;
17779: }
1.1083 raeburn 17780: my %responses = $res->responseTypes();
17781: foreach my $key (keys(%responses)) {
17782: next unless(exists($checkresponsetypes{$key}));
17783: $allresponses{$key} += $responses{$key};
17784: }
17785: }
17786: foreach my $key (keys(%allresponses)) {
17787: my ($major,$minor) = split(/\./,$checkresponsetypes{$key});
17788: if (($major > $reqdmajor) || ($major == $reqdmajor && $minor > $reqdminor)) {
17789: ($reqdmajor,$reqdminor) = ($major,$minor);
17790: }
17791: }
1.1307 raeburn 17792: foreach my $key (keys(%allcrsrestypes)) {
1.1308 raeburn 17793: my ($major,$minor) = split(/\./,$checkcrsrestypes{$key});
1.1307 raeburn 17794: if (($major > $reqdmajor) || ($major == $reqdmajor && $minor > $reqdminor)) {
17795: ($reqdmajor,$reqdminor) = ($major,$minor);
17796: }
17797: }
1.1083 raeburn 17798: undef($navmap);
17799: }
1.1326 raeburn 17800: my (@resources,@order,@resparms,@zombies);
17801: if ($keeporder) {
17802: use LONCAPA::map;
17803: @resources = @LONCAPA::map::resources;
17804: @order = @LONCAPA::map::order;
17805: @resparms = @LONCAPA::map::resparms;
17806: @zombies = @LONCAPA::map::zombies;
17807: }
1.1308 raeburn 17808: my $suppmap = 'supplemental.sequence';
17809: my ($suppcount,$supptools,$errors) = (0,0,0);
17810: ($suppcount,$supptools,$errors) = &recurse_supplemental($cnum,$cdom,$suppmap,
17811: $suppcount,$supptools,$errors);
1.1326 raeburn 17812: if ($keeporder) {
17813: @LONCAPA::map::resources = @resources;
17814: @LONCAPA::map::order = @order;
17815: @LONCAPA::map::resparms = @resparms;
17816: @LONCAPA::map::zombies = @zombies;
17817: }
1.1308 raeburn 17818: if ($supptools) {
17819: my ($major,$minor) = split(/\./,$checkcrsrestypes{'exttool'});
17820: if (($major > $reqdmajor) || ($major == $reqdmajor && $minor > $reqdminor)) {
17821: ($reqdmajor,$reqdminor) = ($major,$minor);
17822: }
17823: }
1.1083 raeburn 17824: unless (($reqdmajor eq '') && ($reqdminor eq '')) {
17825: &Apache::lonnet::update_released_required($reqdmajor.'.'.$reqdminor,$cdom,$cnum,$chome,$cid);
17826: }
17827: return;
17828: }
17829:
1.1110 raeburn 17830: sub allmaps_incourse {
17831: my ($cdom,$cnum,$chome,$cid) = @_;
17832: if ($cdom eq '' || $cnum eq '' || $chome eq '' || $cid eq '') {
17833: $cid = $env{'request.course.id'};
17834: $cdom = $env{'course.'.$cid.'.domain'};
17835: $cnum = $env{'course.'.$cid.'.num'};
17836: $chome = $env{'course.'.$cid.'.home'};
17837: }
17838: my %allmaps = ();
17839: my $lastchange =
17840: &Apache::lonnet::get_coursechange($cdom,$cnum);
17841: if ($lastchange > $env{'request.course.tied'}) {
17842: my ($furl,$ferr) = &Apache::lonuserstate::readmap("$cdom/$cnum");
17843: unless ($ferr) {
1.1326 raeburn 17844: &update_content_constraints($cdom,$cnum,$chome,$cid,1);
1.1110 raeburn 17845: }
17846: }
17847: my $navmap = Apache::lonnavmaps::navmap->new();
17848: if (defined($navmap)) {
17849: foreach my $res ($navmap->retrieveResources(undef,sub { $_[0]->is_map() },1,0,1)) {
17850: $allmaps{$res->src()} = 1;
17851: }
17852: }
17853: return \%allmaps;
17854: }
17855:
1.1083 raeburn 17856: sub parse_supplemental_title {
17857: my ($title) = @_;
17858:
17859: my ($foldertitle,$renametitle);
17860: if ($title =~ /&&&/) {
17861: $title = &HTML::Entites::decode($title);
17862: }
17863: if ($title =~ m/^(\d+)___&&&___($match_username)___&&&___($match_domain)___&&&___(.*)$/) {
17864: $renametitle=$4;
17865: my ($time,$uname,$udom) = ($1,$2,$3);
17866: $foldertitle=&Apache::lontexconvert::msgtexconverted($4);
17867: my $name = &plainname($uname,$udom);
17868: $name = &HTML::Entities::encode($name,'"<>&\'');
17869: $renametitle = &HTML::Entities::encode($renametitle,'"<>&\'');
17870: $title='<i>'.&Apache::lonlocal::locallocaltime($time).'</i> '.
17871: $name.': <br />'.$foldertitle;
17872: }
17873: if (wantarray) {
17874: return ($title,$foldertitle,$renametitle);
17875: }
17876: return $title;
17877: }
17878:
1.1143 raeburn 17879: sub recurse_supplemental {
1.1308 raeburn 17880: my ($cnum,$cdom,$suppmap,$numfiles,$numexttools,$errors) = @_;
1.1143 raeburn 17881: if ($suppmap) {
17882: my ($errtext,$fatal) = &LONCAPA::map::mapread('/uploaded/'.$cdom.'/'.$cnum.'/'.$suppmap);
17883: if ($fatal) {
17884: $errors ++;
17885: } else {
17886: if ($#LONCAPA::map::resources > 0) {
17887: foreach my $res (@LONCAPA::map::resources) {
17888: my ($title,$src,$ext,$type,$status)=split(/\:/,$res);
17889: if (($src ne '') && ($status eq 'res')) {
1.1146 raeburn 17890: if ($src =~ m{^\Q/uploaded/$cdom/$cnum/\E(supplemental_\d+\.sequence)$}) {
1.1308 raeburn 17891: ($numfiles,$numexttools,$errors) = &recurse_supplemental($cnum,$cdom,$1,
17892: $numfiles,$numexttools,$errors);
1.1143 raeburn 17893: } else {
1.1308 raeburn 17894: if ($src =~ m{^/adm/$cdom/$cnum/\d+/ext\.tool$}) {
17895: $numexttools ++;
17896: }
1.1143 raeburn 17897: $numfiles ++;
17898: }
17899: }
17900: }
17901: }
17902: }
17903: }
1.1308 raeburn 17904: return ($numfiles,$numexttools,$errors);
1.1143 raeburn 17905: }
17906:
1.1101 raeburn 17907: sub symb_to_docspath {
1.1267 raeburn 17908: my ($symb,$navmapref) = @_;
17909: return unless ($symb && ref($navmapref));
1.1101 raeburn 17910: my ($mapurl,$id,$resurl) = &Apache::lonnet::decode_symb($symb);
17911: if ($resurl=~/\.(sequence|page)$/) {
17912: $mapurl=$resurl;
17913: } elsif ($resurl eq 'adm/navmaps') {
17914: $mapurl=$env{'course.'.$env{'request.course.id'}.'.url'};
17915: }
17916: my $mapresobj;
1.1267 raeburn 17917: unless (ref($$navmapref)) {
17918: $$navmapref = Apache::lonnavmaps::navmap->new();
17919: }
17920: if (ref($$navmapref)) {
17921: $mapresobj = $$navmapref->getResourceByUrl($mapurl);
1.1101 raeburn 17922: }
17923: $mapurl=~s{^.*/([^/]+)\.(\w+)$}{$1};
17924: my $type=$2;
17925: my $path;
17926: if (ref($mapresobj)) {
17927: my $pcslist = $mapresobj->map_hierarchy();
17928: if ($pcslist ne '') {
17929: foreach my $pc (split(/,/,$pcslist)) {
17930: next if ($pc <= 1);
1.1267 raeburn 17931: my $res = $$navmapref->getByMapPc($pc);
1.1101 raeburn 17932: if (ref($res)) {
17933: my $thisurl = $res->src();
17934: $thisurl=~s{^.*/([^/]+)\.\w+$}{$1};
17935: my $thistitle = $res->title();
17936: $path .= '&'.
17937: &Apache::lonhtmlcommon::entity_encode($thisurl).'&'.
1.1146 raeburn 17938: &escape($thistitle).
1.1101 raeburn 17939: ':'.$res->randompick().
17940: ':'.$res->randomout().
17941: ':'.$res->encrypted().
17942: ':'.$res->randomorder().
17943: ':'.$res->is_page();
17944: }
17945: }
17946: }
17947: $path =~ s/^\&//;
17948: my $maptitle = $mapresobj->title();
17949: if ($mapurl eq 'default') {
1.1129 raeburn 17950: $maptitle = 'Main Content';
1.1101 raeburn 17951: }
17952: $path .= (($path ne '')? '&' : '').
17953: &Apache::lonhtmlcommon::entity_encode($mapurl).'&'.
1.1146 raeburn 17954: &escape($maptitle).
1.1101 raeburn 17955: ':'.$mapresobj->randompick().
17956: ':'.$mapresobj->randomout().
17957: ':'.$mapresobj->encrypted().
17958: ':'.$mapresobj->randomorder().
17959: ':'.$mapresobj->is_page();
17960: } else {
17961: my $maptitle = &Apache::lonnet::gettitle($mapurl);
17962: my $ispage = (($type eq 'page')? 1 : '');
17963: if ($mapurl eq 'default') {
1.1129 raeburn 17964: $maptitle = 'Main Content';
1.1101 raeburn 17965: }
17966: $path = &Apache::lonhtmlcommon::entity_encode($mapurl).'&'.
1.1146 raeburn 17967: &escape($maptitle).':::::'.$ispage;
1.1101 raeburn 17968: }
17969: unless ($mapurl eq 'default') {
17970: $path = 'default&'.
1.1146 raeburn 17971: &escape('Main Content').
1.1101 raeburn 17972: ':::::&'.$path;
17973: }
17974: return $path;
17975: }
17976:
1.1094 raeburn 17977: sub captcha_display {
1.1327 raeburn 17978: my ($context,$lonhost,$defdom) = @_;
1.1094 raeburn 17979: my ($output,$error);
1.1234 raeburn 17980: my ($captcha,$pubkey,$privkey,$version) =
1.1327 raeburn 17981: &get_captcha_config($context,$lonhost,$defdom);
1.1095 raeburn 17982: if ($captcha eq 'original') {
1.1094 raeburn 17983: $output = &create_captcha();
17984: unless ($output) {
1.1172 raeburn 17985: $error = 'captcha';
1.1094 raeburn 17986: }
17987: } elsif ($captcha eq 'recaptcha') {
1.1234 raeburn 17988: $output = &create_recaptcha($pubkey,$version);
1.1094 raeburn 17989: unless ($output) {
1.1172 raeburn 17990: $error = 'recaptcha';
1.1094 raeburn 17991: }
17992: }
1.1234 raeburn 17993: return ($output,$error,$captcha,$version);
1.1094 raeburn 17994: }
17995:
17996: sub captcha_response {
1.1327 raeburn 17997: my ($context,$lonhost,$defdom) = @_;
1.1094 raeburn 17998: my ($captcha_chk,$captcha_error);
1.1327 raeburn 17999: my ($captcha,$pubkey,$privkey,$version) = &get_captcha_config($context,$lonhost,$defdom);
1.1095 raeburn 18000: if ($captcha eq 'original') {
1.1094 raeburn 18001: ($captcha_chk,$captcha_error) = &check_captcha();
18002: } elsif ($captcha eq 'recaptcha') {
1.1234 raeburn 18003: $captcha_chk = &check_recaptcha($privkey,$version);
1.1094 raeburn 18004: } else {
18005: $captcha_chk = 1;
18006: }
18007: return ($captcha_chk,$captcha_error);
18008: }
18009:
18010: sub get_captcha_config {
1.1327 raeburn 18011: my ($context,$lonhost,$dom_in_effect) = @_;
1.1234 raeburn 18012: my ($captcha,$pubkey,$privkey,$version,$hashtocheck);
1.1094 raeburn 18013: my $hostname = &Apache::lonnet::hostname($lonhost);
18014: my $serverhomeID = &Apache::lonnet::get_server_homeID($hostname);
18015: my $serverhomedom = &Apache::lonnet::host_domain($serverhomeID);
1.1095 raeburn 18016: if ($context eq 'usercreation') {
18017: my %domconfig = &Apache::lonnet::get_dom('configuration',[$context],$serverhomedom);
18018: if (ref($domconfig{$context}) eq 'HASH') {
18019: $hashtocheck = $domconfig{$context}{'cancreate'};
18020: if (ref($hashtocheck) eq 'HASH') {
18021: if ($hashtocheck->{'captcha'} eq 'recaptcha') {
18022: if (ref($hashtocheck->{'recaptchakeys'}) eq 'HASH') {
18023: $pubkey = $hashtocheck->{'recaptchakeys'}{'public'};
18024: $privkey = $hashtocheck->{'recaptchakeys'}{'private'};
18025: }
18026: if ($privkey && $pubkey) {
18027: $captcha = 'recaptcha';
1.1234 raeburn 18028: $version = $hashtocheck->{'recaptchaversion'};
18029: if ($version ne '2') {
18030: $version = 1;
18031: }
1.1095 raeburn 18032: } else {
18033: $captcha = 'original';
18034: }
18035: } elsif ($hashtocheck->{'captcha'} ne 'notused') {
18036: $captcha = 'original';
18037: }
1.1094 raeburn 18038: }
1.1095 raeburn 18039: } else {
18040: $captcha = 'captcha';
18041: }
18042: } elsif ($context eq 'login') {
18043: my %domconfhash = &Apache::loncommon::get_domainconf($serverhomedom);
18044: if ($domconfhash{$serverhomedom.'.login.captcha'} eq 'recaptcha') {
18045: $pubkey = $domconfhash{$serverhomedom.'.login.recaptchakeys_public'};
18046: $privkey = $domconfhash{$serverhomedom.'.login.recaptchakeys_private'};
1.1094 raeburn 18047: if ($privkey && $pubkey) {
18048: $captcha = 'recaptcha';
1.1234 raeburn 18049: $version = $domconfhash{$serverhomedom.'.login.recaptchaversion'};
18050: if ($version ne '2') {
18051: $version = 1;
18052: }
1.1095 raeburn 18053: } else {
18054: $captcha = 'original';
1.1094 raeburn 18055: }
1.1095 raeburn 18056: } elsif ($domconfhash{$serverhomedom.'.login.captcha'} eq 'original') {
18057: $captcha = 'original';
1.1094 raeburn 18058: }
1.1327 raeburn 18059: } elsif ($context eq 'passwords') {
18060: if ($dom_in_effect) {
18061: my %passwdconf = &Apache::lonnet::get_passwdconf($dom_in_effect);
18062: if ($passwdconf{'captcha'} eq 'recaptcha') {
18063: if (ref($passwdconf{'recaptchakeys'}) eq 'HASH') {
18064: $pubkey = $passwdconf{'recaptchakeys'}{'public'};
18065: $privkey = $passwdconf{'recaptchakeys'}{'private'};
18066: }
18067: if ($privkey && $pubkey) {
18068: $captcha = 'recaptcha';
18069: $version = $passwdconf{'recaptchaversion'};
18070: if ($version ne '2') {
18071: $version = 1;
18072: }
18073: } else {
18074: $captcha = 'original';
18075: }
18076: } elsif ($passwdconf{'captcha'} ne 'notused') {
18077: $captcha = 'original';
18078: }
18079: }
18080: }
1.1234 raeburn 18081: return ($captcha,$pubkey,$privkey,$version);
1.1094 raeburn 18082: }
18083:
18084: sub create_captcha {
18085: my %captcha_params = &captcha_settings();
18086: my ($output,$maxtries,$tries) = ('',10,0);
18087: while ($tries < $maxtries) {
18088: $tries ++;
18089: my $captcha = Authen::Captcha->new (
18090: output_folder => $captcha_params{'output_dir'},
18091: data_folder => $captcha_params{'db_dir'},
18092: );
18093: my $md5sum = $captcha->generate_code($captcha_params{'numchars'});
18094:
18095: if (-e $Apache::lonnet::perlvar{'lonCaptchaDir'}.'/'.$md5sum.'.png') {
18096: $output = '<input type="hidden" name="crypt" value="'.$md5sum.'" />'."\n".
18097: &mt('Type in the letters/numbers shown below').' '.
1.1176 raeburn 18098: '<input type="text" size="5" name="code" value="" autocomplete="off" />'.
18099: '<br />'.
18100: '<img src="'.$captcha_params{'www_output_dir'}.'/'.$md5sum.'.png" alt="captcha" />';
1.1094 raeburn 18101: last;
18102: }
18103: }
1.1323 raeburn 18104: if ($output eq '') {
18105: &Apache::lonnet::logthis("Failed to create Captcha code after $tries attempts.");
18106: }
1.1094 raeburn 18107: return $output;
18108: }
18109:
18110: sub captcha_settings {
18111: my %captcha_params = (
18112: output_dir => $Apache::lonnet::perlvar{'lonCaptchaDir'},
18113: www_output_dir => "/captchaspool",
18114: db_dir => $Apache::lonnet::perlvar{'lonCaptchaDb'},
18115: numchars => '5',
18116: );
18117: return %captcha_params;
18118: }
18119:
18120: sub check_captcha {
18121: my ($captcha_chk,$captcha_error);
18122: my $code = $env{'form.code'};
18123: my $md5sum = $env{'form.crypt'};
18124: my %captcha_params = &captcha_settings();
18125: my $captcha = Authen::Captcha->new(
18126: output_folder => $captcha_params{'output_dir'},
18127: data_folder => $captcha_params{'db_dir'},
18128: );
1.1109 raeburn 18129: $captcha_chk = $captcha->check_code($code,$md5sum);
1.1094 raeburn 18130: my %captcha_hash = (
18131: 0 => 'Code not checked (file error)',
18132: -1 => 'Failed: code expired',
18133: -2 => 'Failed: invalid code (not in database)',
18134: -3 => 'Failed: invalid code (code does not match crypt)',
18135: );
18136: if ($captcha_chk != 1) {
18137: $captcha_error = $captcha_hash{$captcha_chk}
18138: }
18139: return ($captcha_chk,$captcha_error);
18140: }
18141:
18142: sub create_recaptcha {
1.1234 raeburn 18143: my ($pubkey,$version) = @_;
18144: if ($version >= 2) {
18145: return '<div class="g-recaptcha" data-sitekey="'.$pubkey.'"></div>';
18146: } else {
18147: my $use_ssl;
18148: if ($ENV{'SERVER_PORT'} == 443) {
18149: $use_ssl = 1;
18150: }
18151: my $captcha = Captcha::reCAPTCHA->new;
18152: return $captcha->get_options_setter({theme => 'white'})."\n".
18153: $captcha->get_html($pubkey,undef,$use_ssl).
18154: &mt('If the text is hard to read, [_1] will replace them.',
18155: '<img src="/res/adm/pages/refresh.gif" alt="reCAPTCHA refresh" />').
18156: '<br /><br />';
18157: }
1.1094 raeburn 18158: }
18159:
18160: sub check_recaptcha {
1.1234 raeburn 18161: my ($privkey,$version) = @_;
1.1094 raeburn 18162: my $captcha_chk;
1.1350 ! raeburn 18163: my $ip = &Apache::lonnet::get_requestor_ip();
1.1234 raeburn 18164: if ($version >= 2) {
18165: my %info = (
18166: secret => $privkey,
18167: response => $env{'form.g-recaptcha-response'},
1.1350 ! raeburn 18168: remoteip => $ip,
1.1234 raeburn 18169: );
1.1280 raeburn 18170: my $request=new HTTP::Request('POST','https://www.google.com/recaptcha/api/siteverify');
18171: $request->content(join('&',map {
18172: my $name = escape($_);
18173: "$name=" . ( ref($info{$_}) eq 'ARRAY'
18174: ? join("&$name=", map {escape($_) } @{$info{$_}})
18175: : &escape($info{$_}) );
18176: } keys(%info)));
18177: my $response = &LONCAPA::LWPReq::makerequest('',$request,'','',10,1);
1.1234 raeburn 18178: if ($response->is_success) {
18179: my $data = JSON::DWIW->from_json($response->decoded_content);
18180: if (ref($data) eq 'HASH') {
18181: if ($data->{'success'}) {
18182: $captcha_chk = 1;
18183: }
18184: }
18185: }
18186: } else {
18187: my $captcha = Captcha::reCAPTCHA->new;
18188: my $captcha_result =
18189: $captcha->check_answer(
18190: $privkey,
1.1350 ! raeburn 18191: $ip,
1.1234 raeburn 18192: $env{'form.recaptcha_challenge_field'},
18193: $env{'form.recaptcha_response_field'},
18194: );
18195: if ($captcha_result->{is_valid}) {
18196: $captcha_chk = 1;
18197: }
1.1094 raeburn 18198: }
18199: return $captcha_chk;
18200: }
18201:
1.1174 raeburn 18202: sub emailusername_info {
1.1244 raeburn 18203: my @fields = ('firstname','lastname','institution','web','location','officialemail','id');
1.1174 raeburn 18204: my %titles = &Apache::lonlocal::texthash (
18205: lastname => 'Last Name',
18206: firstname => 'First Name',
18207: institution => 'School/college/university',
18208: location => "School's city, state/province, country",
18209: web => "School's web address",
18210: officialemail => 'E-mail address at institution (if different)',
1.1244 raeburn 18211: id => 'Student/Employee ID',
1.1174 raeburn 18212: );
18213: return (\@fields,\%titles);
18214: }
18215:
1.1161 raeburn 18216: sub cleanup_html {
18217: my ($incoming) = @_;
18218: my $outgoing;
18219: if ($incoming ne '') {
18220: $outgoing = $incoming;
18221: $outgoing =~ s/;/;/g;
18222: $outgoing =~ s/\#/#/g;
18223: $outgoing =~ s/\&/&/g;
18224: $outgoing =~ s/</</g;
18225: $outgoing =~ s/>/>/g;
18226: $outgoing =~ s/\(/(/g;
18227: $outgoing =~ s/\)/)/g;
18228: $outgoing =~ s/"/"/g;
18229: $outgoing =~ s/'/'/g;
18230: $outgoing =~ s/\$/$/g;
18231: $outgoing =~ s{/}{/}g;
18232: $outgoing =~ s/=/=/g;
18233: $outgoing =~ s/\\/\/g
18234: }
18235: return $outgoing;
18236: }
18237:
1.1190 musolffc 18238: # Checks for critical messages and returns a redirect url if one exists.
18239: # $interval indicates how often to check for messages.
1.1282 raeburn 18240: # $context is the calling context -- roles, grades, contents, menu or flip.
1.1190 musolffc 18241: sub critical_redirect {
1.1282 raeburn 18242: my ($interval,$context) = @_;
1.1190 musolffc 18243: if ((time-$env{'user.criticalcheck.time'})>$interval) {
1.1282 raeburn 18244: if (($env{'request.course.id'}) && (($context eq 'flip') || ($context eq 'contents'))) {
18245: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
18246: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
18247: my $blocked = &blocking_status('alert',$cnum,$cdom,undef,1);
18248: if ($blocked) {
18249: my $checkrole = "cm./$cdom/$cnum";
18250: if ($env{'request.course.sec'} ne '') {
18251: $checkrole .= "/$env{'request.course.sec'}";
18252: }
18253: unless ((&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) &&
18254: ($env{'request.role'} !~ m{^st\./$cdom/$cnum})) {
18255: return;
18256: }
18257: }
18258: }
1.1190 musolffc 18259: my @what=&Apache::lonnet::dump('critical', $env{'user.domain'},
18260: $env{'user.name'});
18261: &Apache::lonnet::appenv({'user.criticalcheck.time'=>time});
1.1191 raeburn 18262: my $redirecturl;
1.1190 musolffc 18263: if ($what[0]) {
18264: if (($what[0] ne 'con_lost') && ($what[0]!~/^error\:/)) {
18265: $redirecturl='/adm/email?critical=display';
1.1191 raeburn 18266: my $url=&Apache::lonnet::absolute_url().$redirecturl;
18267: return (1, $url);
1.1190 musolffc 18268: }
1.1191 raeburn 18269: }
18270: }
18271: return ();
1.1190 musolffc 18272: }
18273:
1.1174 raeburn 18274: # Use:
18275: # my $answer=reply("encrypt:passwd:$udom:$uname:$upass",$tryserver);
18276: #
18277: ##################################################
18278: # password associated functions #
18279: ##################################################
18280: sub des_keys {
18281: # Make a new key for DES encryption.
18282: # Each key has two parts which are returned separately.
18283: # Please note: Each key must be passed through the &hex function
18284: # before it is output to the web browser. The hex versions cannot
18285: # be used to decrypt.
18286: my @hexstr=('0','1','2','3','4','5','6','7',
18287: '8','9','a','b','c','d','e','f');
18288: my $lkey='';
18289: for (0..7) {
18290: $lkey.=$hexstr[rand(15)];
18291: }
18292: my $ukey='';
18293: for (0..7) {
18294: $ukey.=$hexstr[rand(15)];
18295: }
18296: return ($lkey,$ukey);
18297: }
18298:
18299: sub des_decrypt {
18300: my ($key,$cyphertext) = @_;
18301: my $keybin=pack("H16",$key);
18302: my $cypher;
18303: if ($Crypt::DES::VERSION>=2.03) {
18304: $cypher=new Crypt::DES $keybin;
18305: } else {
18306: $cypher=new DES $keybin;
18307: }
1.1233 raeburn 18308: my $plaintext='';
18309: my $cypherlength = length($cyphertext);
18310: my $numchunks = int($cypherlength/32);
18311: for (my $j=0; $j<$numchunks; $j++) {
18312: my $start = $j*32;
18313: my $cypherblock = substr($cyphertext,$start,32);
18314: my $chunk =
18315: $cypher->decrypt(unpack("a8",pack("H16",substr($cypherblock,0,16))));
18316: $chunk .=
18317: $cypher->decrypt(unpack("a8",pack("H16",substr($cypherblock,16,16))));
18318: $chunk=substr($chunk,1,ord(substr($chunk,0,1)) );
18319: $plaintext .= $chunk;
18320: }
1.1174 raeburn 18321: return $plaintext;
18322: }
18323:
1.1344 raeburn 18324: sub get_requested_shorturls {
1.1309 raeburn 18325: my ($cdom,$cnum,$navmap) = @_;
18326: return unless (ref($navmap));
1.1344 raeburn 18327: my ($numnew,$errors);
1.1309 raeburn 18328: my @toshorten = &Apache::loncommon::get_env_multiple('form.addtiny');
18329: if (@toshorten) {
18330: my (%maps,%resources,%titles);
18331: &Apache::loncourserespicker::enumerate_course_contents($navmap,\%maps,\%resources,\%titles,
18332: 'shorturls',$cdom,$cnum);
18333: if (keys(%resources)) {
1.1344 raeburn 18334: my %tocreate;
1.1309 raeburn 18335: foreach my $item (sort {$a <=> $b} (@toshorten)) {
18336: my $symb = $resources{$item};
18337: if ($symb) {
18338: $tocreate{$cnum.'&'.$symb} = 1;
18339: }
18340: }
1.1344 raeburn 18341: if (keys(%tocreate)) {
18342: ($numnew,$errors) = &make_short_symbs($cdom,$cnum,
18343: \%tocreate);
18344: }
1.1309 raeburn 18345: }
1.1344 raeburn 18346: }
18347: return ($numnew,$errors);
18348: }
18349:
18350: sub make_short_symbs {
18351: my ($cdom,$cnum,$tocreateref,$lockuser) = @_;
18352: my ($numnew,@errors);
18353: if (ref($tocreateref) eq 'HASH') {
18354: my %tocreate = %{$tocreateref};
1.1309 raeburn 18355: if (keys(%tocreate)) {
18356: my %coursetiny = &Apache::lonnet::dump('tiny',$cdom,$cnum);
18357: my $su = Short::URL->new(no_vowels => 1);
18358: my $init = '';
18359: my (%newunique,%addcourse,%courseonly,%failed);
18360: # get lock on tiny db
18361: my $now = time;
1.1344 raeburn 18362: if ($lockuser eq '') {
18363: $lockuser = $env{'user.name'}.':'.$env{'user.domain'};
18364: }
1.1309 raeburn 18365: my $lockhash = {
1.1344 raeburn 18366: "lock\0$now" => $lockuser,
1.1309 raeburn 18367: };
18368: my $tries = 0;
18369: my $gotlock = &Apache::lonnet::newput_dom('tiny',$lockhash,$cdom);
18370: my ($code,$error);
18371: while (($gotlock ne 'ok') && ($tries<3)) {
18372: $tries ++;
18373: sleep 1;
1.1319 raeburn 18374: $gotlock = &Apache::lonnet::newput_dom('tiny',$lockhash,$cdom);
1.1309 raeburn 18375: }
18376: if ($gotlock eq 'ok') {
18377: $init = &shorten_symbs($cdom,$init,$su,\%coursetiny,\%tocreate,\%newunique,
18378: \%addcourse,\%courseonly,\%failed);
18379: if (keys(%failed)) {
18380: my $numfailed = scalar(keys(%failed));
18381: push(@errors,&mt('error: could not obtain unique six character URL for [quant,_1,resource]',$numfailed));
18382: }
18383: if (keys(%newunique)) {
18384: my $putres = &Apache::lonnet::newput_dom('tiny',\%newunique,$cdom);
18385: if ($putres eq 'ok') {
18386: $numnew = scalar(keys(%newunique));
18387: my $newputres = &Apache::lonnet::newput('tiny',\%addcourse,$cdom,$cnum);
18388: unless ($newputres eq 'ok') {
18389: push(@errors,&mt('error: could not store course look-up of short URLs'));
18390: }
18391: } else {
18392: push(@errors,&mt('error: could not store unique six character URLs'));
18393: }
18394: }
18395: my $dellockres = &Apache::lonnet::del_dom('tiny',["lock\0$now"],$cdom);
18396: unless ($dellockres eq 'ok') {
18397: push(@errors,&mt('error: could not release lockfile'));
18398: }
18399: } else {
18400: push(@errors,&mt('error: could not obtain lockfile'));
18401: }
18402: if (keys(%courseonly)) {
18403: my $result = &Apache::lonnet::newput('tiny',\%courseonly,$cdom,$cnum);
18404: if ($result ne 'ok') {
18405: push(@errors,&mt('error: could not update course look-up of short URLs'));
18406: }
18407: }
18408: }
18409: }
18410: return ($numnew,\@errors);
18411: }
18412:
18413: sub shorten_symbs {
18414: my ($cdom,$init,$su,$coursetiny,$tocreate,$newunique,$addcourse,$courseonly,$failed) = @_;
18415: return unless ((ref($su)) && (ref($coursetiny) eq 'HASH') && (ref($tocreate) eq 'HASH') &&
18416: (ref($newunique) eq 'HASH') && (ref($addcourse) eq 'HASH') &&
18417: (ref($courseonly) eq 'HASH') && (ref($failed) eq 'HASH'));
18418: my (%possibles,%collisions);
18419: foreach my $key (keys(%{$tocreate})) {
18420: my $num = String::CRC32::crc32($key);
18421: my $tiny = $su->encode($num,$init);
18422: if ($tiny) {
18423: $possibles{$tiny} = $key;
18424: }
18425: }
18426: if (!$init) {
18427: $init = 1;
18428: } else {
18429: $init ++;
18430: }
18431: if (keys(%possibles)) {
18432: my @posstiny = keys(%possibles);
18433: my $configuname = &Apache::lonnet::get_domainconfiguser($cdom);
18434: my %currtiny = &Apache::lonnet::get('tiny',\@posstiny,$cdom,$configuname);
18435: if (keys(%currtiny)) {
18436: foreach my $key (keys(%currtiny)) {
18437: next if ($currtiny{$key} eq '');
18438: if ($currtiny{$key} eq $possibles{$key}) {
18439: my ($tcnum,$tsymb) = split(/\&/,$currtiny{$key});
18440: unless (($coursetiny->{$tsymb} eq $key) || ($addcourse->{$tsymb} eq $key) || ($courseonly->{$tsymb} eq $key)) {
18441: $courseonly->{$tsymb} = $key;
18442: }
18443: } else {
18444: $collisions{$possibles{$key}} = 1;
18445: }
18446: delete($possibles{$key});
18447: }
18448: }
18449: foreach my $key (keys(%possibles)) {
18450: $newunique->{$key} = $possibles{$key};
18451: my ($tcnum,$tsymb) = split(/\&/,$possibles{$key});
18452: unless (($coursetiny->{$tsymb} eq $key) || ($addcourse->{$tsymb} eq $key) || ($courseonly->{$tsymb} eq $key)) {
18453: $addcourse->{$tsymb} = $key;
18454: }
18455: }
18456: }
18457: if (keys(%collisions)) {
18458: if ($init <5) {
18459: if (!$init) {
18460: $init = 1;
18461: } else {
18462: $init ++;
18463: }
18464: $init = &shorten_symbs($cdom,$init,$su,$coursetiny,\%collisions,
18465: $newunique,$addcourse,$courseonly,$failed);
18466: } else {
18467: foreach my $key (keys(%collisions)) {
18468: $failed->{$key} = 1;
18469: }
18470: }
18471: }
18472: return $init;
18473: }
18474:
1.1328 raeburn 18475: sub is_nonframeable {
1.1329 raeburn 18476: my ($url,$absolute,$hostname,$ip,$nocache) = @_;
18477: my ($remprotocol,$remhost) = ($url =~ m{^(https?)\://(([a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,})}i);
1.1330 raeburn 18478: return if (($remprotocol eq '') || ($remhost eq ''));
1.1329 raeburn 18479:
18480: $remprotocol = lc($remprotocol);
18481: $remhost = lc($remhost);
18482: my $remport = 80;
18483: if ($remprotocol eq 'https') {
18484: $remport = 443;
18485: }
1.1330 raeburn 18486: my ($result,$cached) = &Apache::lonnet::is_cached_new('noiframe',$remhost.':'.$remport);
1.1329 raeburn 18487: if ($cached) {
18488: unless ($nocache) {
18489: if ($result) {
18490: return 1;
18491: } else {
18492: return 0;
18493: }
18494: }
18495: }
1.1328 raeburn 18496: my $uselink;
18497: my $request = new HTTP::Request('HEAD',$url);
18498: my $response = &LONCAPA::LWPReq::makerequest('',$request,'','',5);
18499: if ($response->is_success()) {
18500: my $secpolicy = lc($response->header('content-security-policy'));
18501: my $xframeop = lc($response->header('x-frame-options'));
18502: $secpolicy =~ s/^\s+|\s+$//g;
18503: $xframeop =~ s/^\s+|\s+$//g;
18504: if (($secpolicy ne '') || ($xframeop ne '')) {
1.1329 raeburn 18505: my $remotehost = $remprotocol.'://'.$remhost;
1.1328 raeburn 18506: my ($origin,$protocol,$port);
18507: if ($ENV{'SERVER_PORT'} =~/^\d+$/) {
18508: $port = $ENV{'SERVER_PORT'};
18509: } else {
18510: $port = 80;
18511: }
18512: if ($absolute eq '') {
18513: $protocol = 'http:';
18514: if ($port == 443) {
18515: $protocol = 'https:';
18516: }
18517: $origin = $protocol.'//'.lc($hostname);
18518: } else {
18519: $origin = lc($absolute);
18520: ($protocol,$hostname) = ($absolute =~ m{^(https?:)//([^/]+)$});
18521: }
18522: if (($secpolicy) && ($secpolicy =~ /\Qframe-ancestors\E([^;]*)(;|$)/)) {
18523: my $framepolicy = $1;
18524: $framepolicy =~ s/^\s+|\s+$//g;
18525: my @policies = split(/\s+/,$framepolicy);
18526: if (@policies) {
18527: if (grep(/^\Q'none'\E$/,@policies)) {
18528: $uselink = 1;
18529: } else {
18530: $uselink = 1;
18531: if ((grep(/^\Q*\E$/,@policies)) || (grep(/^\Q$protocol\E$/,@policies)) ||
18532: (($origin ne '') && (grep(/^\Q$origin\E$/,@policies))) ||
18533: (($ip ne '') && (grep(/^\Q$ip\E$/,@policies)))) {
18534: undef($uselink);
18535: }
18536: if ($uselink) {
18537: if (grep(/^\Q'self'\E$/,@policies)) {
18538: if (($origin ne '') && ($remotehost eq $origin)) {
18539: undef($uselink);
18540: }
18541: }
18542: }
18543: if ($uselink) {
18544: my @possok;
18545: if ($ip ne '') {
18546: push(@possok,$ip);
18547: }
18548: my $hoststr = '';
18549: foreach my $part (reverse(split(/\./,$hostname))) {
18550: if ($hoststr eq '') {
18551: $hoststr = $part;
18552: } else {
18553: $hoststr = "$part.$hoststr";
18554: }
18555: if ($hoststr eq $hostname) {
18556: push(@possok,$hostname);
18557: } else {
18558: push(@possok,"*.$hoststr");
18559: }
18560: }
18561: if (@possok) {
18562: foreach my $poss (@possok) {
18563: last if (!$uselink);
18564: foreach my $policy (@policies) {
18565: if ($policy =~ m{^(\Q$protocol\E//|)\Q$poss\E(\Q:$port\E|)$}) {
18566: undef($uselink);
18567: last;
18568: }
18569: }
18570: }
18571: }
18572: }
18573: }
18574: }
18575: } elsif ($xframeop ne '') {
18576: $uselink = 1;
18577: my @policies = split(/\s*,\s*/,$xframeop);
18578: if (@policies) {
18579: unless (grep(/^deny$/,@policies)) {
18580: if ($origin ne '') {
18581: if (grep(/^sameorigin$/,@policies)) {
18582: if ($remotehost eq $origin) {
18583: undef($uselink);
18584: }
18585: }
18586: if ($uselink) {
18587: foreach my $policy (@policies) {
18588: if ($policy =~ /^allow-from\s*(.+)$/) {
18589: my $allowfrom = $1;
18590: if (($allowfrom ne '') && ($allowfrom eq $origin)) {
18591: undef($uselink);
18592: last;
18593: }
18594: }
18595: }
18596: }
18597: }
18598: }
18599: }
18600: }
18601: }
18602: }
1.1329 raeburn 18603: if ($nocache) {
18604: if ($cached) {
18605: my $devalidate;
18606: if ($uselink && !$result) {
18607: $devalidate = 1;
18608: } elsif (!$uselink && $result) {
18609: $devalidate = 1;
18610: }
18611: if ($devalidate) {
18612: &Apache::lonnet::devalidate_cache_new('noiframe',$remhost.':'.$remport);
18613: }
18614: }
18615: } else {
18616: if ($uselink) {
18617: $result = 1;
18618: } else {
18619: $result = 0;
18620: }
18621: &Apache::lonnet::do_cache_new('noiframe',$remhost.':'.$remport,$result,3600);
18622: }
1.1328 raeburn 18623: return $uselink;
18624: }
18625:
1.112 bowersj2 18626: 1;
18627: __END__;
1.41 ng 18628:
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