Annotation of loncom/interface/loncommon.pm, revision 1.1305
1.10 albertel 1: # The LearningOnline Network with CAPA
1.1 albertel 2: # a pile of common routines
1.10 albertel 3: #
1.1305 ! raeburn 4: # $Id: loncommon.pm,v 1.1304 2017/12/18 16:11:18 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.657 raeburn 75: use DateTime::TimeZone;
1.1241 raeburn 76: use DateTime::Locale;
1.1220 raeburn 77: use Encode();
1.1091 foxr 78: use Text::Aspell;
1.1094 raeburn 79: use Authen::Captcha;
80: use Captcha::reCAPTCHA;
1.1234 raeburn 81: use JSON::DWIW;
82: use LWP::UserAgent;
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.117 www 89:
1.517 raeburn 90: # ---------------------------------------------- Designs
91: use vars qw(%defaultdesign);
92:
1.22 www 93: my $readit;
94:
1.517 raeburn 95:
1.157 matthew 96: ##
97: ## Global Variables
98: ##
1.46 matthew 99:
1.643 foxr 100:
101: # ----------------------------------------------- SSI with retries:
102: #
103:
104: =pod
105:
1.648 raeburn 106: =head1 Server Side include with retries:
1.643 foxr 107:
108: =over 4
109:
1.648 raeburn 110: =item * &ssi_with_retries(resource,retries form)
1.643 foxr 111:
112: Performs an ssi with some number of retries. Retries continue either
113: until the result is ok or until the retry count supplied by the
114: caller is exhausted.
115:
116: Inputs:
1.648 raeburn 117:
118: =over 4
119:
1.643 foxr 120: resource - Identifies the resource to insert.
1.648 raeburn 121:
1.643 foxr 122: retries - Count of the number of retries allowed.
1.648 raeburn 123:
1.643 foxr 124: form - Hash that identifies the rendering options.
125:
1.648 raeburn 126: =back
127:
128: Returns:
129:
130: =over 4
131:
1.643 foxr 132: content - The content of the response. If retries were exhausted this is empty.
1.648 raeburn 133:
1.643 foxr 134: response - The response from the last attempt (which may or may not have been successful.
135:
1.648 raeburn 136: =back
137:
138: =back
139:
1.643 foxr 140: =cut
141:
142: sub ssi_with_retries {
143: my ($resource, $retries, %form) = @_;
144:
145:
146: my $ok = 0; # True if we got a good response.
147: my $content;
148: my $response;
149:
150: # Try to get the ssi done. within the retries count:
151:
152: do {
153: ($content, $response) = &Apache::lonnet::ssi($resource, %form);
154: $ok = $response->is_success;
1.650 www 155: if (!$ok) {
156: &Apache::lonnet::logthis("Failed ssi_with_retries on $resource: ".$response->is_success.', '.$response->code.', '.$response->message);
157: }
1.643 foxr 158: $retries--;
159: } while (!$ok && ($retries > 0));
160:
161: if (!$ok) {
162: $content = ''; # On error return an empty content.
163: }
164: return ($content, $response);
165:
166: }
167:
168:
169:
1.20 www 170: # ----------------------------------------------- Filetypes/Languages/Copyright
1.12 harris41 171: my %language;
1.124 www 172: my %supported_language;
1.1088 foxr 173: my %supported_codes;
1.1048 foxr 174: my %latex_language; # For choosing hyphenation in <transl..>
175: my %latex_language_bykey; # for choosing hyphenation from metadata
1.12 harris41 176: my %cprtag;
1.192 taceyjo1 177: my %scprtag;
1.351 www 178: my %fe; my %fd; my %fm;
1.41 ng 179: my %category_extensions;
1.12 harris41 180:
1.46 matthew 181: # ---------------------------------------------- Thesaurus variables
1.144 matthew 182: #
183: # %Keywords:
184: # A hash used by &keyword to determine if a word is considered a keyword.
185: # $thesaurus_db_file
186: # Scalar containing the full path to the thesaurus database.
1.46 matthew 187:
188: my %Keywords;
189: my $thesaurus_db_file;
190:
1.144 matthew 191: #
192: # Initialize values from language.tab, copyright.tab, filetypes.tab,
193: # thesaurus.tab, and filecategories.tab.
194: #
1.18 www 195: BEGIN {
1.46 matthew 196: # Variable initialization
197: $thesaurus_db_file = $Apache::lonnet::perlvar{'lonTabDir'}."/thesaurus.db";
198: #
1.22 www 199: unless ($readit) {
1.12 harris41 200: # ------------------------------------------------------------------- languages
201: {
1.158 raeburn 202: my $langtabfile = $Apache::lonnet::perlvar{'lonTabDir'}.
203: '/language.tab';
204: if ( open(my $fh,"<$langtabfile") ) {
1.356 albertel 205: while (my $line = <$fh>) {
206: next if ($line=~/^\#/);
207: chomp($line);
1.1088 foxr 208: my ($key,$code,$country,$three,$enc,$val,$sup,$latex)=(split(/\t/,$line));
1.158 raeburn 209: $language{$key}=$val.' - '.$enc;
210: if ($sup) {
211: $supported_language{$key}=$sup;
1.1088 foxr 212: $supported_codes{$key} = $code;
1.158 raeburn 213: }
1.1048 foxr 214: if ($latex) {
215: $latex_language_bykey{$key} = $latex;
1.1088 foxr 216: $latex_language{$code} = $latex;
1.1048 foxr 217: }
1.158 raeburn 218: }
219: close($fh);
220: }
1.12 harris41 221: }
222: # ------------------------------------------------------------------ copyrights
223: {
1.158 raeburn 224: my $copyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
225: '/copyright.tab';
226: if ( open (my $fh,"<$copyrightfile") ) {
1.356 albertel 227: while (my $line = <$fh>) {
228: next if ($line=~/^\#/);
229: chomp($line);
230: my ($key,$val)=(split(/\s+/,$line,2));
1.158 raeburn 231: $cprtag{$key}=$val;
232: }
233: close($fh);
234: }
1.12 harris41 235: }
1.351 www 236: # ----------------------------------------------------------- source copyrights
1.192 taceyjo1 237: {
238: my $sourcecopyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
239: '/source_copyright.tab';
240: if ( open (my $fh,"<$sourcecopyrightfile") ) {
1.356 albertel 241: while (my $line = <$fh>) {
242: next if ($line =~ /^\#/);
243: chomp($line);
244: my ($key,$val)=(split(/\s+/,$line,2));
1.192 taceyjo1 245: $scprtag{$key}=$val;
246: }
247: close($fh);
248: }
249: }
1.63 www 250:
1.517 raeburn 251: # -------------------------------------------------------------- default domain designs
1.63 www 252: my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
1.517 raeburn 253: my $designfile = $designdir.'/default.tab';
254: if ( open (my $fh,"<$designfile") ) {
255: while (my $line = <$fh>) {
256: next if ($line =~ /^\#/);
257: chomp($line);
258: my ($key,$val)=(split(/\=/,$line));
259: if ($val) { $defaultdesign{$key}=$val; }
260: }
261: close($fh);
1.63 www 262: }
263:
1.15 harris41 264: # ------------------------------------------------------------- file categories
265: {
1.158 raeburn 266: my $categoryfile = $Apache::lonnet::perlvar{'lonTabDir'}.
267: '/filecategories.tab';
268: if ( open (my $fh,"<$categoryfile") ) {
1.356 albertel 269: while (my $line = <$fh>) {
270: next if ($line =~ /^\#/);
271: chomp($line);
272: my ($extension,$category)=(split(/\s+/,$line,2));
1.1263 raeburn 273: push(@{$category_extensions{lc($category)}},$extension);
1.158 raeburn 274: }
275: close($fh);
276: }
277:
1.15 harris41 278: }
1.12 harris41 279: # ------------------------------------------------------------------ file types
280: {
1.158 raeburn 281: my $typesfile = $Apache::lonnet::perlvar{'lonTabDir'}.
282: '/filetypes.tab';
283: if ( open (my $fh,"<$typesfile") ) {
1.356 albertel 284: while (my $line = <$fh>) {
285: next if ($line =~ /^\#/);
286: chomp($line);
287: my ($ending,$emb,$mime,$descr)=split(/\s+/,$line,4);
1.158 raeburn 288: if ($descr ne '') {
289: $fe{$ending}=lc($emb);
290: $fd{$ending}=$descr;
1.351 www 291: if ($mime ne 'unk') { $fm{$ending}=$mime; }
1.158 raeburn 292: }
293: }
294: close($fh);
295: }
1.12 harris41 296: }
1.22 www 297: &Apache::lonnet::logthis(
1.705 tempelho 298: "<span style='color:yellow;'>INFO: Read file types</span>");
1.22 www 299: $readit=1;
1.46 matthew 300: } # end of unless($readit)
1.32 matthew 301:
302: }
1.112 bowersj2 303:
1.42 matthew 304: ###############################################################
305: ## HTML and Javascript Helper Functions ##
306: ###############################################################
307:
308: =pod
309:
1.112 bowersj2 310: =head1 HTML and Javascript Functions
1.42 matthew 311:
1.112 bowersj2 312: =over 4
313:
1.648 raeburn 314: =item * &browser_and_searcher_javascript()
1.112 bowersj2 315:
316: X<browsing, javascript>X<searching, javascript>Returns a string
317: containing javascript with two functions, C<openbrowser> and
318: C<opensearcher>. Returned string does not contain E<lt>scriptE<gt>
319: tags.
1.42 matthew 320:
1.648 raeburn 321: =item * &openbrowser(formname,elementname,only,omit) [javascript]
1.42 matthew 322:
323: inputs: formname, elementname, only, omit
324:
325: formname and elementname indicate the name of the html form and name of
326: the element that the results of the browsing selection are to be placed in.
327:
328: Specifying 'only' will restrict the browser to displaying only files
1.185 www 329: with the given extension. Can be a comma separated list.
1.42 matthew 330:
331: Specifying 'omit' will restrict the browser to NOT displaying files
1.185 www 332: with the given extension. Can be a comma separated list.
1.42 matthew 333:
1.648 raeburn 334: =item * &opensearcher(formname,elementname) [javascript]
1.42 matthew 335:
336: Inputs: formname, elementname
337:
338: formname and elementname specify the name of the html form and the name
339: of the element the selection from the search results will be placed in.
1.542 raeburn 340:
1.42 matthew 341: =cut
342:
343: sub browser_and_searcher_javascript {
1.199 albertel 344: my ($mode)=@_;
345: if (!defined($mode)) { $mode='edit'; }
1.453 albertel 346: my $resurl=&escape_single(&lastresurl());
1.42 matthew 347: return <<END;
1.219 albertel 348: // <!-- BEGIN LON-CAPA Internal
1.50 matthew 349: var editbrowser = null;
1.135 albertel 350: function openbrowser(formname,elementname,only,omit,titleelement) {
1.170 www 351: var url = '$resurl/?';
1.42 matthew 352: if (editbrowser == null) {
353: url += 'launch=1&';
354: }
355: url += 'catalogmode=interactive&';
1.199 albertel 356: url += 'mode=$mode&';
1.611 albertel 357: url += 'inhibitmenu=yes&';
1.42 matthew 358: url += 'form=' + formname + '&';
359: if (only != null) {
360: url += 'only=' + only + '&';
1.217 albertel 361: } else {
362: url += 'only=&';
363: }
1.42 matthew 364: if (omit != null) {
365: url += 'omit=' + omit + '&';
1.217 albertel 366: } else {
367: url += 'omit=&';
368: }
1.135 albertel 369: if (titleelement != null) {
370: url += 'titleelement=' + titleelement + '&';
1.217 albertel 371: } else {
372: url += 'titleelement=&';
373: }
1.42 matthew 374: url += 'element=' + elementname + '';
375: var title = 'Browser';
1.435 albertel 376: var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42 matthew 377: options += ',width=700,height=600';
378: editbrowser = open(url,title,options,'1');
379: editbrowser.focus();
380: }
381: var editsearcher;
1.135 albertel 382: function opensearcher(formname,elementname,titleelement) {
1.42 matthew 383: var url = '/adm/searchcat?';
384: if (editsearcher == null) {
385: url += 'launch=1&';
386: }
387: url += 'catalogmode=interactive&';
1.199 albertel 388: url += 'mode=$mode&';
1.42 matthew 389: url += 'form=' + formname + '&';
1.135 albertel 390: if (titleelement != null) {
391: url += 'titleelement=' + titleelement + '&';
1.217 albertel 392: } else {
393: url += 'titleelement=&';
394: }
1.42 matthew 395: url += 'element=' + elementname + '';
396: var title = 'Search';
1.435 albertel 397: var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42 matthew 398: options += ',width=700,height=600';
399: editsearcher = open(url,title,options,'1');
400: editsearcher.focus();
401: }
1.219 albertel 402: // END LON-CAPA Internal -->
1.42 matthew 403: END
1.170 www 404: }
405:
406: sub lastresurl {
1.258 albertel 407: if ($env{'environment.lastresurl'}) {
408: return $env{'environment.lastresurl'}
1.170 www 409: } else {
410: return '/res';
411: }
412: }
413:
414: sub storeresurl {
415: my $resurl=&Apache::lonnet::clutter(shift);
416: unless ($resurl=~/^\/res/) { return 0; }
417: $resurl=~s/\/$//;
418: &Apache::lonnet::put('environment',{'lastresurl' => $resurl});
1.646 raeburn 419: &Apache::lonnet::appenv({'environment.lastresurl' => $resurl});
1.170 www 420: return 1;
1.42 matthew 421: }
422:
1.74 www 423: sub studentbrowser_javascript {
1.111 www 424: unless (
1.258 albertel 425: (($env{'request.course.id'}) &&
1.302 albertel 426: (&Apache::lonnet::allowed('srm',$env{'request.course.id'})
427: || &Apache::lonnet::allowed('srm',$env{'request.course.id'}.
428: '/'.$env{'request.course.sec'})
429: ))
1.258 albertel 430: || ($env{'request.role'}=~/^(au|dc|su)/)
1.111 www 431: ) { return ''; }
1.74 www 432: return (<<'ENDSTDBRW');
1.776 bisitz 433: <script type="text/javascript" language="Javascript">
1.824 bisitz 434: // <![CDATA[
1.74 www 435: var stdeditbrowser;
1.999 www 436: function openstdbrowser(formname,uname,udom,clicker,roleflag,ignorefilter,courseadvonly) {
1.74 www 437: var url = '/adm/pickstudent?';
438: var filter;
1.558 albertel 439: if (!ignorefilter) {
440: eval('filter=document.'+formname+'.'+uname+'.value;');
441: }
1.74 www 442: if (filter != null) {
443: if (filter != '') {
444: url += 'filter='+filter+'&';
445: }
446: }
447: url += 'form=' + formname + '&unameelement='+uname+
1.999 www 448: '&udomelement='+udom+
449: '&clicker='+clicker;
1.111 www 450: if (roleflag) { url+="&roles=1"; }
1.793 raeburn 451: if (courseadvonly) { url+="&courseadvonly=1"; }
1.102 www 452: var title = 'Student_Browser';
1.74 www 453: var options = 'scrollbars=1,resizable=1,menubar=0';
454: options += ',width=700,height=600';
455: stdeditbrowser = open(url,title,options,'1');
456: stdeditbrowser.focus();
457: }
1.824 bisitz 458: // ]]>
1.74 www 459: </script>
460: ENDSTDBRW
461: }
1.42 matthew 462:
1.1003 www 463: sub resourcebrowser_javascript {
464: unless ($env{'request.course.id'}) { return ''; }
1.1004 www 465: return (<<'ENDRESBRW');
1.1003 www 466: <script type="text/javascript" language="Javascript">
467: // <![CDATA[
468: var reseditbrowser;
1.1004 www 469: function openresbrowser(formname,reslink) {
1.1005 www 470: var url = '/adm/pickresource?form='+formname+'&reslink='+reslink;
1.1003 www 471: var title = 'Resource_Browser';
472: var options = 'scrollbars=1,resizable=1,menubar=0';
1.1005 www 473: options += ',width=700,height=500';
1.1004 www 474: reseditbrowser = open(url,title,options,'1');
475: reseditbrowser.focus();
1.1003 www 476: }
477: // ]]>
478: </script>
1.1004 www 479: ENDRESBRW
1.1003 www 480: }
481:
1.74 www 482: sub selectstudent_link {
1.999 www 483: my ($form,$unameele,$udomele,$courseadvonly,$clickerid)=@_;
484: my $callargs = "'".&Apache::lonhtmlcommon::entity_encode($form)."','".
485: &Apache::lonhtmlcommon::entity_encode($unameele)."','".
486: &Apache::lonhtmlcommon::entity_encode($udomele)."'";
1.258 albertel 487: if ($env{'request.course.id'}) {
1.302 albertel 488: if (!&Apache::lonnet::allowed('srm',$env{'request.course.id'})
489: && !&Apache::lonnet::allowed('srm',$env{'request.course.id'}.
490: '/'.$env{'request.course.sec'})) {
1.111 www 491: return '';
492: }
1.999 www 493: $callargs.=",'".&Apache::lonhtmlcommon::entity_encode($clickerid)."'";
1.793 raeburn 494: if ($courseadvonly) {
495: $callargs .= ",'',1,1";
496: }
497: return '<span class="LC_nobreak">'.
498: '<a href="javascript:openstdbrowser('.$callargs.');">'.
499: &mt('Select User').'</a></span>';
1.74 www 500: }
1.258 albertel 501: if ($env{'request.role'}=~/^(au|dc|su)/) {
1.1012 www 502: $callargs .= ",'',1";
1.793 raeburn 503: return '<span class="LC_nobreak">'.
504: '<a href="javascript:openstdbrowser('.$callargs.');">'.
505: &mt('Select User').'</a></span>';
1.111 www 506: }
507: return '';
1.91 www 508: }
509:
1.1004 www 510: sub selectresource_link {
511: my ($form,$reslink,$arg)=@_;
512:
513: my $callargs = "'".&Apache::lonhtmlcommon::entity_encode($form)."','".
514: &Apache::lonhtmlcommon::entity_encode($reslink)."'";
515: unless ($env{'request.course.id'}) { return $arg; }
516: return '<span class="LC_nobreak">'.
517: '<a href="javascript:openresbrowser('.$callargs.');">'.
518: $arg.'</a></span>';
519: }
520:
521:
522:
1.653 raeburn 523: sub authorbrowser_javascript {
524: return <<"ENDAUTHORBRW";
1.776 bisitz 525: <script type="text/javascript" language="JavaScript">
1.824 bisitz 526: // <![CDATA[
1.653 raeburn 527: var stdeditbrowser;
528:
529: function openauthorbrowser(formname,udom) {
530: var url = '/adm/pickauthor?';
531: url += 'form='+formname+'&roledom='+udom;
532: var title = 'Author_Browser';
533: var options = 'scrollbars=1,resizable=1,menubar=0';
534: options += ',width=700,height=600';
535: stdeditbrowser = open(url,title,options,'1');
536: stdeditbrowser.focus();
537: }
538:
1.824 bisitz 539: // ]]>
1.653 raeburn 540: </script>
541: ENDAUTHORBRW
542: }
543:
1.91 www 544: sub coursebrowser_javascript {
1.1116 raeburn 545: my ($domainfilter,$sec_element,$formname,$role_element,$crstype,
1.1221 raeburn 546: $credits_element,$instcode) = @_;
1.932 raeburn 547: my $wintitle = 'Course_Browser';
1.931 raeburn 548: if ($crstype eq 'Community') {
1.932 raeburn 549: $wintitle = 'Community_Browser';
1.909 raeburn 550: }
1.876 raeburn 551: my $id_functions = &javascript_index_functions();
552: my $output = '
1.776 bisitz 553: <script type="text/javascript" language="JavaScript">
1.824 bisitz 554: // <![CDATA[
1.468 raeburn 555: var stdeditbrowser;'."\n";
1.876 raeburn 556:
557: $output .= <<"ENDSTDBRW";
1.909 raeburn 558: function opencrsbrowser(formname,uname,udom,desc,extra_element,multflag,type,type_elem) {
1.91 www 559: var url = '/adm/pickcourse?';
1.895 raeburn 560: var formid = getFormIdByName(formname);
1.876 raeburn 561: var domainfilter = getDomainFromSelectbox(formname,udom);
1.128 albertel 562: if (domainfilter != null) {
563: if (domainfilter != '') {
564: url += 'domainfilter='+domainfilter+'&';
565: }
566: }
1.91 www 567: url += 'form=' + formname + '&cnumelement='+uname+
1.187 albertel 568: '&cdomelement='+udom+
569: '&cnameelement='+desc;
1.468 raeburn 570: if (extra_element !=null && extra_element != '') {
1.594 raeburn 571: if (formname == 'rolechoice' || formname == 'studentform') {
1.468 raeburn 572: url += '&roleelement='+extra_element;
573: if (domainfilter == null || domainfilter == '') {
574: url += '&domainfilter='+extra_element;
575: }
1.234 raeburn 576: }
1.468 raeburn 577: else {
578: if (formname == 'portform') {
579: url += '&setroles='+extra_element;
1.800 raeburn 580: } else {
581: if (formname == 'rules') {
582: url += '&fixeddom='+extra_element;
583: }
1.468 raeburn 584: }
585: }
1.230 raeburn 586: }
1.909 raeburn 587: if (type != null && type != '') {
588: url += '&type='+type;
589: }
590: if (type_elem != null && type_elem != '') {
591: url += '&typeelement='+type_elem;
592: }
1.872 raeburn 593: if (formname == 'ccrs') {
594: var ownername = document.forms[formid].ccuname.value;
595: var ownerdom = document.forms[formid].ccdomain.options[document.forms[formid].ccdomain.selectedIndex].value;
1.1238 raeburn 596: url += '&cloner='+ownername+':'+ownerdom;
597: if (type == 'Course') {
598: url += '&crscode='+document.forms[formid].crscode.value;
599: }
1.1221 raeburn 600: }
601: if (formname == 'requestcrs') {
602: url += '&crsdom=$domainfilter&crscode=$instcode';
1.872 raeburn 603: }
1.293 raeburn 604: if (multflag !=null && multflag != '') {
605: url += '&multiple='+multflag;
606: }
1.909 raeburn 607: var title = '$wintitle';
1.91 www 608: var options = 'scrollbars=1,resizable=1,menubar=0';
609: options += ',width=700,height=600';
610: stdeditbrowser = open(url,title,options,'1');
611: stdeditbrowser.focus();
612: }
1.876 raeburn 613: $id_functions
614: ENDSTDBRW
1.1116 raeburn 615: if (($sec_element ne '') || ($role_element ne '') || ($credits_element ne '')) {
616: $output .= &setsec_javascript($sec_element,$formname,$role_element,
617: $credits_element);
1.876 raeburn 618: }
619: $output .= '
620: // ]]>
621: </script>';
622: return $output;
623: }
624:
625: sub javascript_index_functions {
626: return <<"ENDJS";
627:
628: function getFormIdByName(formname) {
629: for (var i=0;i<document.forms.length;i++) {
630: if (document.forms[i].name == formname) {
631: return i;
632: }
633: }
634: return -1;
635: }
636:
637: function getIndexByName(formid,item) {
638: for (var i=0;i<document.forms[formid].elements.length;i++) {
639: if (document.forms[formid].elements[i].name == item) {
640: return i;
641: }
642: }
643: return -1;
644: }
1.468 raeburn 645:
1.876 raeburn 646: function getDomainFromSelectbox(formname,udom) {
647: var userdom;
648: var formid = getFormIdByName(formname);
649: if (formid > -1) {
650: var domid = getIndexByName(formid,udom);
651: if (domid > -1) {
652: if (document.forms[formid].elements[domid].type == 'select-one') {
653: userdom=document.forms[formid].elements[domid].options[document.forms[formid].elements[domid].selectedIndex].value;
654: }
655: if (document.forms[formid].elements[domid].type == 'hidden') {
656: userdom=document.forms[formid].elements[domid].value;
1.468 raeburn 657: }
658: }
659: }
1.876 raeburn 660: return userdom;
661: }
662:
663: ENDJS
1.468 raeburn 664:
1.876 raeburn 665: }
666:
1.1017 raeburn 667: sub javascript_array_indexof {
1.1018 raeburn 668: return <<ENDJS;
1.1017 raeburn 669: <script type="text/javascript" language="JavaScript">
670: // <![CDATA[
671:
672: if (!Array.prototype.indexOf) {
673: Array.prototype.indexOf = function (searchElement /*, fromIndex */ ) {
674: "use strict";
675: if (this === void 0 || this === null) {
676: throw new TypeError();
677: }
678: var t = Object(this);
679: var len = t.length >>> 0;
680: if (len === 0) {
681: return -1;
682: }
683: var n = 0;
684: if (arguments.length > 0) {
685: n = Number(arguments[1]);
1.1088 foxr 686: if (n !== n) { // shortcut for verifying if it is NaN
1.1017 raeburn 687: n = 0;
688: } else if (n !== 0 && n !== (1 / 0) && n !== -(1 / 0)) {
689: n = (n > 0 || -1) * Math.floor(Math.abs(n));
690: }
691: }
692: if (n >= len) {
693: return -1;
694: }
695: var k = n >= 0 ? n : Math.max(len - Math.abs(n), 0);
696: for (; k < len; k++) {
697: if (k in t && t[k] === searchElement) {
698: return k;
699: }
700: }
701: return -1;
702: }
703: }
704:
705: // ]]>
706: </script>
707:
708: ENDJS
709:
710: }
711:
1.876 raeburn 712: sub userbrowser_javascript {
713: my $id_functions = &javascript_index_functions();
714: return <<"ENDUSERBRW";
715:
1.888 raeburn 716: function openuserbrowser(formname,uname,udom,ulast,ufirst,uemail,hideudom,crsdom,caller) {
1.876 raeburn 717: var url = '/adm/pickuser?';
718: var userdom = getDomainFromSelectbox(formname,udom);
719: if (userdom != null) {
720: if (userdom != '') {
721: url += 'srchdom='+userdom+'&';
722: }
723: }
724: url += 'form=' + formname + '&unameelement='+uname+
725: '&udomelement='+udom+
726: '&ulastelement='+ulast+
727: '&ufirstelement='+ufirst+
728: '&uemailelement='+uemail+
1.881 raeburn 729: '&hideudomelement='+hideudom+
730: '&coursedom='+crsdom;
1.888 raeburn 731: if ((caller != null) && (caller != undefined)) {
732: url += '&caller='+caller;
733: }
1.876 raeburn 734: var title = 'User_Browser';
735: var options = 'scrollbars=1,resizable=1,menubar=0';
736: options += ',width=700,height=600';
737: var stdeditbrowser = open(url,title,options,'1');
738: stdeditbrowser.focus();
739: }
740:
1.888 raeburn 741: function fix_domain (formname,udom,origdom,uname) {
1.876 raeburn 742: var formid = getFormIdByName(formname);
743: if (formid > -1) {
1.888 raeburn 744: var unameid = getIndexByName(formid,uname);
1.876 raeburn 745: var domid = getIndexByName(formid,udom);
746: var hidedomid = getIndexByName(formid,origdom);
747: if (hidedomid > -1) {
748: var fixeddom = document.forms[formid].elements[hidedomid].value;
1.888 raeburn 749: var unameval = document.forms[formid].elements[unameid].value;
750: if ((fixeddom != '') && (fixeddom != undefined) && (fixeddom != null) && (unameval != '') && (unameval != undefined) && (unameval != null)) {
751: if (domid > -1) {
752: var slct = document.forms[formid].elements[domid];
753: if (slct.type == 'select-one') {
754: var i;
755: for (i=0;i<slct.length;i++) {
756: if (slct.options[i].value==fixeddom) { slct.selectedIndex=i; }
757: }
758: }
759: if (slct.type == 'hidden') {
760: slct.value = fixeddom;
1.876 raeburn 761: }
762: }
1.468 raeburn 763: }
764: }
765: }
1.876 raeburn 766: return;
767: }
768:
769: $id_functions
770: ENDUSERBRW
1.468 raeburn 771: }
772:
773: sub setsec_javascript {
1.1116 raeburn 774: my ($sec_element,$formname,$role_element,$credits_element) = @_;
1.905 raeburn 775: my (@courserolenames,@communityrolenames,$rolestr,$courserolestr,
776: $communityrolestr);
777: if ($role_element ne '') {
778: my @allroles = ('st','ta','ep','in','ad');
779: foreach my $crstype ('Course','Community') {
780: if ($crstype eq 'Community') {
781: foreach my $role (@allroles) {
782: push(@communityrolenames,&Apache::lonnet::plaintext($role,$crstype));
783: }
784: push(@communityrolenames,&Apache::lonnet::plaintext('co'));
785: } else {
786: foreach my $role (@allroles) {
787: push(@courserolenames,&Apache::lonnet::plaintext($role,$crstype));
788: }
789: push(@courserolenames,&Apache::lonnet::plaintext('cc'));
790: }
791: }
792: $rolestr = '"'.join('","',@allroles).'"';
793: $courserolestr = '"'.join('","',@courserolenames).'"';
794: $communityrolestr = '"'.join('","',@communityrolenames).'"';
795: }
1.468 raeburn 796: my $setsections = qq|
797: function setSect(sectionlist) {
1.629 raeburn 798: var sectionsArray = new Array();
799: if ((sectionlist != '') && (typeof sectionlist != "undefined")) {
800: sectionsArray = sectionlist.split(",");
801: }
1.468 raeburn 802: var numSections = sectionsArray.length;
803: document.$formname.$sec_element.length = 0;
804: if (numSections == 0) {
805: document.$formname.$sec_element.multiple=false;
806: document.$formname.$sec_element.size=1;
807: document.$formname.$sec_element.options[0] = new Option('No existing sections','',false,false)
808: } else {
809: if (numSections == 1) {
810: document.$formname.$sec_element.multiple=false;
811: document.$formname.$sec_element.size=1;
812: document.$formname.$sec_element.options[0] = new Option('Select','',true,true);
813: document.$formname.$sec_element.options[1] = new Option('No section','',false,false)
814: document.$formname.$sec_element.options[2] = new Option(sectionsArray[0],sectionsArray[0],false,false);
815: } else {
816: for (var i=0; i<numSections; i++) {
817: document.$formname.$sec_element.options[i] = new Option(sectionsArray[i],sectionsArray[i],false,false)
818: }
819: document.$formname.$sec_element.multiple=true
820: if (numSections < 3) {
821: document.$formname.$sec_element.size=numSections;
822: } else {
823: document.$formname.$sec_element.size=3;
824: }
825: document.$formname.$sec_element.options[0].selected = false
826: }
827: }
1.91 www 828: }
1.905 raeburn 829:
830: function setRole(crstype) {
1.468 raeburn 831: |;
1.905 raeburn 832: if ($role_element eq '') {
833: $setsections .= ' return;
834: }
835: ';
836: } else {
837: $setsections .= qq|
838: var elementLength = document.$formname.$role_element.length;
839: var allroles = Array($rolestr);
840: var courserolenames = Array($courserolestr);
841: var communityrolenames = Array($communityrolestr);
842: if (elementLength != undefined) {
843: if (document.$formname.$role_element.options[5].value == 'cc') {
844: if (crstype == 'Course') {
845: return;
846: } else {
847: allroles[5] = 'co';
848: for (var i=0; i<6; i++) {
849: document.$formname.$role_element.options[i].value = allroles[i];
850: document.$formname.$role_element.options[i].text = communityrolenames[i];
851: }
852: }
853: } else {
854: if (crstype == 'Community') {
855: return;
856: } else {
857: allroles[5] = 'cc';
858: for (var i=0; i<6; i++) {
859: document.$formname.$role_element.options[i].value = allroles[i];
860: document.$formname.$role_element.options[i].text = courserolenames[i];
861: }
862: }
863: }
864: }
865: return;
866: }
867: |;
868: }
1.1116 raeburn 869: if ($credits_element) {
870: $setsections .= qq|
871: function setCredits(defaultcredits) {
872: document.$formname.$credits_element.value = defaultcredits;
873: return;
874: }
875: |;
876: }
1.468 raeburn 877: return $setsections;
878: }
879:
1.91 www 880: sub selectcourse_link {
1.909 raeburn 881: my ($form,$unameele,$udomele,$desc,$extra_element,$multflag,$selecttype,
882: $typeelement) = @_;
883: my $type = $selecttype;
1.871 raeburn 884: my $linktext = &mt('Select Course');
885: if ($selecttype eq 'Community') {
1.909 raeburn 886: $linktext = &mt('Select Community');
1.1239 raeburn 887: } elsif ($selecttype eq 'Placement') {
888: $linktext = &mt('Select Placement Test');
1.906 raeburn 889: } elsif ($selecttype eq 'Course/Community') {
890: $linktext = &mt('Select Course/Community');
1.909 raeburn 891: $type = '';
1.1019 raeburn 892: } elsif ($selecttype eq 'Select') {
893: $linktext = &mt('Select');
894: $type = '';
1.871 raeburn 895: }
1.787 bisitz 896: return '<span class="LC_nobreak">'
897: ."<a href='"
898: .'javascript:opencrsbrowser("'.$form.'","'.$unameele
899: .'","'.$udomele.'","'.$desc.'","'.$extra_element
1.909 raeburn 900: .'","'.$multflag.'","'.$type.'","'.$typeelement.'");'
1.871 raeburn 901: ."'>".$linktext.'</a>'
1.787 bisitz 902: .'</span>';
1.74 www 903: }
1.42 matthew 904:
1.653 raeburn 905: sub selectauthor_link {
906: my ($form,$udom)=@_;
907: return '<a href="javascript:openauthorbrowser('."'$form','$udom'".');">'.
908: &mt('Select Author').'</a>';
909: }
910:
1.876 raeburn 911: sub selectuser_link {
1.881 raeburn 912: my ($form,$unameelem,$domelem,$lastelem,$firstelem,$emailelem,$hdomelem,
1.888 raeburn 913: $coursedom,$linktext,$caller) = @_;
1.876 raeburn 914: return '<a href="javascript:openuserbrowser('."'$form','$unameelem','$domelem',".
1.888 raeburn 915: "'$lastelem','$firstelem','$emailelem','$hdomelem','$coursedom','$caller'".
1.881 raeburn 916: ');">'.$linktext.'</a>';
1.876 raeburn 917: }
918:
1.273 raeburn 919: sub check_uncheck_jscript {
920: my $jscript = <<"ENDSCRT";
921: function checkAll(field) {
922: if (field.length > 0) {
923: for (i = 0; i < field.length; i++) {
1.1093 raeburn 924: if (!field[i].disabled) {
925: field[i].checked = true;
926: }
1.273 raeburn 927: }
928: } else {
1.1093 raeburn 929: if (!field.disabled) {
930: field.checked = true;
931: }
1.273 raeburn 932: }
933: }
934:
935: function uncheckAll(field) {
936: if (field.length > 0) {
937: for (i = 0; i < field.length; i++) {
938: field[i].checked = false ;
1.543 albertel 939: }
940: } else {
1.273 raeburn 941: field.checked = false ;
942: }
943: }
944: ENDSCRT
945: return $jscript;
946: }
947:
1.656 www 948: sub select_timezone {
1.1256 raeburn 949: my ($name,$selected,$onchange,$includeempty,$disabled)=@_;
950: my $output='<select name="'.$name.'" '.$onchange.$disabled.'>'."\n";
1.659 raeburn 951: if ($includeempty) {
952: $output .= '<option value=""';
953: if (($selected eq '') || ($selected eq 'local')) {
954: $output .= ' selected="selected" ';
955: }
956: $output .= '> </option>';
957: }
1.657 raeburn 958: my @timezones = DateTime::TimeZone->all_names;
959: foreach my $tzone (@timezones) {
960: $output.= '<option value="'.$tzone.'"';
961: if ($tzone eq $selected) {
962: $output.=' selected="selected"';
963: }
964: $output.=">$tzone</option>\n";
1.656 www 965: }
966: $output.="</select>";
967: return $output;
968: }
1.273 raeburn 969:
1.687 raeburn 970: sub select_datelocale {
1.1256 raeburn 971: my ($name,$selected,$onchange,$includeempty,$disabled)=@_;
972: my $output='<select name="'.$name.'" '.$onchange.$disabled.'>'."\n";
1.687 raeburn 973: if ($includeempty) {
974: $output .= '<option value=""';
975: if ($selected eq '') {
976: $output .= ' selected="selected" ';
977: }
978: $output .= '> </option>';
979: }
1.1241 raeburn 980: my @languages = &Apache::lonlocal::preferred_languages();
1.687 raeburn 981: my (@possibles,%locale_names);
1.1241 raeburn 982: my @locales = DateTime::Locale->ids();
983: foreach my $id (@locales) {
984: if ($id ne '') {
985: my ($en_terr,$native_terr);
986: my $loc = DateTime::Locale->load($id);
987: if (ref($loc)) {
988: $en_terr = $loc->name();
989: $native_terr = $loc->native_name();
1.687 raeburn 990: if (grep(/^en$/,@languages) || !@languages) {
991: if ($en_terr ne '') {
992: $locale_names{$id} = '('.$en_terr.')';
993: } elsif ($native_terr ne '') {
994: $locale_names{$id} = $native_terr;
995: }
996: } else {
997: if ($native_terr ne '') {
998: $locale_names{$id} = $native_terr.' ';
999: } elsif ($en_terr ne '') {
1000: $locale_names{$id} = '('.$en_terr.')';
1001: }
1002: }
1.1220 raeburn 1003: $locale_names{$id} = Encode::encode('UTF-8',$locale_names{$id});
1.1241 raeburn 1004: push(@possibles,$id);
1005: }
1.687 raeburn 1006: }
1007: }
1008: foreach my $item (sort(@possibles)) {
1009: $output.= '<option value="'.$item.'"';
1010: if ($item eq $selected) {
1011: $output.=' selected="selected"';
1012: }
1013: $output.=">$item";
1014: if ($locale_names{$item} ne '') {
1.1220 raeburn 1015: $output.=' '.$locale_names{$item};
1.687 raeburn 1016: }
1017: $output.="</option>\n";
1018: }
1019: $output.="</select>";
1020: return $output;
1021: }
1022:
1.792 raeburn 1023: sub select_language {
1.1256 raeburn 1024: my ($name,$selected,$includeempty,$noedit) = @_;
1.792 raeburn 1025: my %langchoices;
1026: if ($includeempty) {
1.1117 raeburn 1027: %langchoices = ('' => 'No language preference');
1.792 raeburn 1028: }
1029: foreach my $id (&languageids()) {
1030: my $code = &supportedlanguagecode($id);
1031: if ($code) {
1032: $langchoices{$code} = &plainlanguagedescription($id);
1033: }
1034: }
1.1117 raeburn 1035: %langchoices = &Apache::lonlocal::texthash(%langchoices);
1.1256 raeburn 1036: return &select_form($selected,$name,\%langchoices,undef,$noedit);
1.792 raeburn 1037: }
1038:
1.42 matthew 1039: =pod
1.36 matthew 1040:
1.1088 foxr 1041:
1042: =item * &list_languages()
1043:
1044: Returns an array reference that is suitable for use in language prompters.
1045: Each array element is itself a two element array. The first element
1046: is the language code. The second element a descsriptiuon of the
1047: language itself. This is suitable for use in e.g.
1048: &Apache::edit::select_arg (once dereferenced that is).
1049:
1050: =cut
1051:
1052: sub list_languages {
1053: my @lang_choices;
1054:
1055: foreach my $id (&languageids()) {
1056: my $code = &supportedlanguagecode($id);
1057: if ($code) {
1058: my $selector = $supported_codes{$id};
1059: my $description = &plainlanguagedescription($id);
1.1263 raeburn 1060: push(@lang_choices, [$selector, $description]);
1.1088 foxr 1061: }
1062: }
1063: return \@lang_choices;
1064: }
1065:
1066: =pod
1067:
1.648 raeburn 1068: =item * &linked_select_forms(...)
1.36 matthew 1069:
1070: linked_select_forms returns a string containing a <script></script> block
1071: and html for two <select> menus. The select menus will be linked in that
1072: changing the value of the first menu will result in new values being placed
1073: in the second menu. The values in the select menu will appear in alphabetical
1.609 raeburn 1074: order unless a defined order is provided.
1.36 matthew 1075:
1076: linked_select_forms takes the following ordered inputs:
1077:
1078: =over 4
1079:
1.112 bowersj2 1080: =item * $formname, the name of the <form> tag
1.36 matthew 1081:
1.112 bowersj2 1082: =item * $middletext, the text which appears between the <select> tags
1.36 matthew 1083:
1.112 bowersj2 1084: =item * $firstdefault, the default value for the first menu
1.36 matthew 1085:
1.112 bowersj2 1086: =item * $firstselectname, the name of the first <select> tag
1.36 matthew 1087:
1.112 bowersj2 1088: =item * $secondselectname, the name of the second <select> tag
1.36 matthew 1089:
1.112 bowersj2 1090: =item * $hashref, a reference to a hash containing the data for the menus.
1.36 matthew 1091:
1.609 raeburn 1092: =item * $menuorder, the order of values in the first menu
1093:
1.1115 raeburn 1094: =item * $onchangefirst, additional javascript call to execute for an onchange
1095: event for the first <select> tag
1096:
1097: =item * $onchangesecond, additional javascript call to execute for an onchange
1098: event for the second <select> tag
1099:
1.1245 raeburn 1100: =item * $suffix, to differentiate separate uses of select2data javascript
1101: objects in a page.
1102:
1.41 ng 1103: =back
1104:
1.36 matthew 1105: Below is an example of such a hash. Only the 'text', 'default', and
1106: 'select2' keys must appear as stated. keys(%menu) are the possible
1107: values for the first select menu. The text that coincides with the
1.41 ng 1108: first menu value is given in $menu{$choice1}->{'text'}. The values
1.36 matthew 1109: and text for the second menu are given in the hash pointed to by
1110: $menu{$choice1}->{'select2'}.
1111:
1.112 bowersj2 1112: my %menu = ( A1 => { text =>"Choice A1" ,
1113: default => "B3",
1114: select2 => {
1115: B1 => "Choice B1",
1116: B2 => "Choice B2",
1117: B3 => "Choice B3",
1118: B4 => "Choice B4"
1.609 raeburn 1119: },
1120: order => ['B4','B3','B1','B2'],
1.112 bowersj2 1121: },
1122: A2 => { text =>"Choice A2" ,
1123: default => "C2",
1124: select2 => {
1125: C1 => "Choice C1",
1126: C2 => "Choice C2",
1127: C3 => "Choice C3"
1.609 raeburn 1128: },
1129: order => ['C2','C1','C3'],
1.112 bowersj2 1130: },
1131: A3 => { text =>"Choice A3" ,
1132: default => "D6",
1133: select2 => {
1134: D1 => "Choice D1",
1135: D2 => "Choice D2",
1136: D3 => "Choice D3",
1137: D4 => "Choice D4",
1138: D5 => "Choice D5",
1139: D6 => "Choice D6",
1140: D7 => "Choice D7"
1.609 raeburn 1141: },
1142: order => ['D4','D3','D2','D1','D7','D6','D5'],
1.112 bowersj2 1143: }
1144: );
1.36 matthew 1145:
1146: =cut
1147:
1148: sub linked_select_forms {
1149: my ($formname,
1150: $middletext,
1151: $firstdefault,
1152: $firstselectname,
1153: $secondselectname,
1.609 raeburn 1154: $hashref,
1155: $menuorder,
1.1115 raeburn 1156: $onchangefirst,
1.1245 raeburn 1157: $onchangesecond,
1158: $suffix
1.36 matthew 1159: ) = @_;
1160: my $second = "document.$formname.$secondselectname";
1161: my $first = "document.$formname.$firstselectname";
1162: # output the javascript to do the changing
1163: my $result = '';
1.776 bisitz 1164: $result.='<script type="text/javascript" language="JavaScript">'."\n";
1.824 bisitz 1165: $result.="// <![CDATA[\n";
1.1245 raeburn 1166: $result.="var select2data${suffix} = new Object();\n";
1.36 matthew 1167: $" = '","';
1168: my $debug = '';
1169: foreach my $s1 (sort(keys(%$hashref))) {
1.1245 raeburn 1170: $result.="select2data${suffix}['d_$s1'] = new Object();\n";
1171: $result.="select2data${suffix}['d_$s1'].def = new String('".
1.36 matthew 1172: $hashref->{$s1}->{'default'}."');\n";
1.1245 raeburn 1173: $result.="select2data${suffix}['d_$s1'].values = new Array(";
1.36 matthew 1174: my @s2values = sort(keys( %{ $hashref->{$s1}->{'select2'} } ));
1.609 raeburn 1175: if (ref($hashref->{$s1}->{'order'}) eq 'ARRAY') {
1176: @s2values = @{$hashref->{$s1}->{'order'}};
1177: }
1.36 matthew 1178: $result.="\"@s2values\");\n";
1.1245 raeburn 1179: $result.="select2data${suffix}['d_$s1'].texts = new Array(";
1.36 matthew 1180: my @s2texts;
1181: foreach my $value (@s2values) {
1.1263 raeburn 1182: push(@s2texts, $hashref->{$s1}->{'select2'}->{$value});
1.36 matthew 1183: }
1184: $result.="\"@s2texts\");\n";
1185: }
1186: $"=' ';
1187: $result.= <<"END";
1188:
1.1245 raeburn 1189: function select1${suffix}_changed() {
1.36 matthew 1190: // Determine new choice
1.1245 raeburn 1191: var newvalue = "d_" + $first.options[$first.selectedIndex].value;
1.36 matthew 1192: // update select2
1.1245 raeburn 1193: var values = select2data${suffix}[newvalue].values;
1194: var texts = select2data${suffix}[newvalue].texts;
1195: var select2def = select2data${suffix}[newvalue].def;
1.36 matthew 1196: var i;
1197: // out with the old
1.1245 raeburn 1198: $second.options.length = 0;
1199: // in with the new
1.36 matthew 1200: for (i=0;i<values.length; i++) {
1201: $second.options[i] = new Option(values[i]);
1.143 matthew 1202: $second.options[i].value = values[i];
1.36 matthew 1203: $second.options[i].text = texts[i];
1204: if (values[i] == select2def) {
1205: $second.options[i].selected = true;
1206: }
1207: }
1208: }
1.824 bisitz 1209: // ]]>
1.36 matthew 1210: </script>
1211: END
1212: # output the initial values for the selection lists
1.1245 raeburn 1213: $result .= "<select size=\"1\" name=\"$firstselectname\" onchange=\"select1${suffix}_changed();$onchangefirst\">\n";
1.609 raeburn 1214: my @order = sort(keys(%{$hashref}));
1215: if (ref($menuorder) eq 'ARRAY') {
1216: @order = @{$menuorder};
1217: }
1218: foreach my $value (@order) {
1.36 matthew 1219: $result.=" <option value=\"$value\" ";
1.253 albertel 1220: $result.=" selected=\"selected\" " if ($value eq $firstdefault);
1.119 www 1221: $result.=">".&mt($hashref->{$value}->{'text'})."</option>\n";
1.36 matthew 1222: }
1223: $result .= "</select>\n";
1224: my %select2 = %{$hashref->{$firstdefault}->{'select2'}};
1225: $result .= $middletext;
1.1115 raeburn 1226: $result .= "<select size=\"1\" name=\"$secondselectname\"";
1227: if ($onchangesecond) {
1228: $result .= ' onchange="'.$onchangesecond.'"';
1229: }
1230: $result .= ">\n";
1.36 matthew 1231: my $seconddefault = $hashref->{$firstdefault}->{'default'};
1.609 raeburn 1232:
1233: my @secondorder = sort(keys(%select2));
1234: if (ref($hashref->{$firstdefault}->{'order'}) eq 'ARRAY') {
1235: @secondorder = @{$hashref->{$firstdefault}->{'order'}};
1236: }
1237: foreach my $value (@secondorder) {
1.36 matthew 1238: $result.=" <option value=\"$value\" ";
1.253 albertel 1239: $result.=" selected=\"selected\" " if ($value eq $seconddefault);
1.119 www 1240: $result.=">".&mt($select2{$value})."</option>\n";
1.36 matthew 1241: }
1242: $result .= "</select>\n";
1243: # return $debug;
1244: return $result;
1245: } # end of sub linked_select_forms {
1246:
1.45 matthew 1247: =pod
1.44 bowersj2 1248:
1.973 raeburn 1249: =item * &help_open_topic($topic,$text,$stayOnPage,$width,$height,$imgid)
1.44 bowersj2 1250:
1.112 bowersj2 1251: Returns a string corresponding to an HTML link to the given help
1252: $topic, where $topic corresponds to the name of a .tex file in
1253: /home/httpd/html/adm/help/tex, with underscores replaced by
1254: spaces.
1255:
1256: $text will optionally be linked to the same topic, allowing you to
1257: link text in addition to the graphic. If you do not want to link
1258: text, but wish to specify one of the later parameters, pass an
1259: empty string.
1260:
1261: $stayOnPage is a value that will be interpreted as a boolean. If true,
1262: the link will not open a new window. If false, the link will open
1263: a new window using Javascript. (Default is false.)
1264:
1265: $width and $height are optional numerical parameters that will
1266: override the width and height of the popped up window, which may
1.973 raeburn 1267: be useful for certain help topics with big pictures included.
1268:
1269: $imgid is the id of the img tag used for the help icon. This may be
1270: used in a javascript call to switch the image src. See
1271: lonhtmlcommon::htmlareaselectactive() for an example.
1.44 bowersj2 1272:
1273: =cut
1274:
1275: sub help_open_topic {
1.973 raeburn 1276: my ($topic, $text, $stayOnPage, $width, $height, $imgid) = @_;
1.48 bowersj2 1277: $text = "" if (not defined $text);
1.44 bowersj2 1278: $stayOnPage = 0 if (not defined $stayOnPage);
1.1033 www 1279: $width = 500 if (not defined $width);
1.44 bowersj2 1280: $height = 400 if (not defined $height);
1281: my $filename = $topic;
1282: $filename =~ s/ /_/g;
1283:
1.48 bowersj2 1284: my $template = "";
1285: my $link;
1.572 banghart 1286:
1.159 www 1287: $topic=~s/\W/\_/g;
1.44 bowersj2 1288:
1.572 banghart 1289: if (!$stayOnPage) {
1.1033 www 1290: $link = "javascript:openMyModal('/adm/help/${filename}.hlp',$width,$height,'yes');";
1.1037 www 1291: } elsif ($stayOnPage eq 'popup') {
1292: $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 1293: } else {
1.48 bowersj2 1294: $link = "/adm/help/${filename}.hlp";
1295: }
1296:
1297: # Add the text
1.755 neumanie 1298: if ($text ne "") {
1.763 bisitz 1299: $template.='<span class="LC_help_open_topic">'
1300: .'<a target="_top" href="'.$link.'">'
1301: .$text.'</a>';
1.48 bowersj2 1302: }
1303:
1.763 bisitz 1304: # (Always) Add the graphic
1.179 matthew 1305: my $title = &mt('Online Help');
1.667 raeburn 1306: my $helpicon=&lonhttpdurl("/adm/help/help.png");
1.973 raeburn 1307: if ($imgid ne '') {
1308: $imgid = ' id="'.$imgid.'"';
1309: }
1.763 bisitz 1310: $template.=' <a target="_top" href="'.$link.'" title="'.$title.'">'
1311: .'<img src="'.$helpicon.'" border="0"'
1312: .' alt="'.&mt('Help: [_1]',$topic).'"'
1.973 raeburn 1313: .' title="'.$title.'" style="vertical-align:middle;"'.$imgid
1.763 bisitz 1314: .' /></a>';
1315: if ($text ne "") {
1316: $template.='</span>';
1317: }
1.44 bowersj2 1318: return $template;
1319:
1.106 bowersj2 1320: }
1321:
1322: # This is a quicky function for Latex cheatsheet editing, since it
1323: # appears in at least four places
1324: sub helpLatexCheatsheet {
1.1037 www 1325: my ($topic,$text,$not_author,$stayOnPage) = @_;
1.732 raeburn 1326: my $out;
1.106 bowersj2 1327: my $addOther = '';
1.732 raeburn 1328: if ($topic) {
1.1037 www 1329: $addOther = '<span>'.&help_open_topic($topic,&mt($text),$stayOnPage, undef, 600).'</span> ';
1.763 bisitz 1330: }
1331: $out = '<span>' # Start cheatsheet
1332: .$addOther
1333: .'<span>'
1.1037 www 1334: .&help_open_topic('Greek_Symbols',&mt('Greek Symbols'),$stayOnPage,undef,600)
1.763 bisitz 1335: .'</span> <span>'
1.1037 www 1336: .&help_open_topic('Other_Symbols',&mt('Other Symbols'),$stayOnPage,undef,600)
1.763 bisitz 1337: .'</span>';
1.732 raeburn 1338: unless ($not_author) {
1.1186 kruse 1339: $out .= '<span>'
1340: .&help_open_topic('Authoring_Output_Tags',&mt('Output Tags'),$stayOnPage,undef,600)
1341: .'</span> <span>'
1342: .&help_open_topic('Authoring_Multilingual_Problems',&mt('How to create problems in different languages'),$stayOnPage,undef,600)
1.763 bisitz 1343: .'</span>';
1.732 raeburn 1344: }
1.763 bisitz 1345: $out .= '</span>'; # End cheatsheet
1.732 raeburn 1346: return $out;
1.172 www 1347: }
1348:
1.430 albertel 1349: sub general_help {
1350: my $helptopic='Student_Intro';
1351: if ($env{'request.role'}=~/^(ca|au)/) {
1352: $helptopic='Authoring_Intro';
1.907 raeburn 1353: } elsif ($env{'request.role'}=~/^(cc|co)/) {
1.430 albertel 1354: $helptopic='Course_Coordination_Intro';
1.672 raeburn 1355: } elsif ($env{'request.role'}=~/^dc/) {
1356: $helptopic='Domain_Coordination_Intro';
1.430 albertel 1357: }
1358: return $helptopic;
1359: }
1360:
1361: sub update_help_link {
1362: my ($topic,$component_help,$faq,$bug,$stayOnPage) = @_;
1363: my $origurl = $ENV{'REQUEST_URI'};
1364: $origurl=~s|^/~|/priv/|;
1365: my $timestamp = time;
1366: foreach my $datum (\$topic,\$component_help,\$faq,\$bug,\$origurl) {
1367: $$datum = &escape($$datum);
1368: }
1369:
1370: my $banner_link = "/adm/helpmenu?page=banner&topic=$topic&component_help=$component_help&faq=$faq&bug=$bug&origurl=$origurl&stamp=$timestamp&stayonpage=$stayOnPage";
1371: my $output .= <<"ENDOUTPUT";
1372: <script type="text/javascript">
1.824 bisitz 1373: // <![CDATA[
1.430 albertel 1374: banner_link = '$banner_link';
1.824 bisitz 1375: // ]]>
1.430 albertel 1376: </script>
1377: ENDOUTPUT
1378: return $output;
1379: }
1380:
1381: # now just updates the help link and generates a blue icon
1.193 raeburn 1382: sub help_open_menu {
1.430 albertel 1383: my ($topic,$component_help,$faq,$bug,$stayOnPage,$width,$height,$text)
1.552 banghart 1384: = @_;
1.949 droeschl 1385: $stayOnPage = 1;
1.430 albertel 1386: my $output;
1387: if ($component_help) {
1388: if (!$text) {
1389: $output=&help_open_topic($component_help,undef,$stayOnPage,
1390: $width,$height);
1391: } else {
1392: my $help_text;
1393: $help_text=&unescape($topic);
1394: $output='<table><tr><td>'.
1395: &help_open_topic($component_help,$help_text,$stayOnPage,
1396: $width,$height).'</td></tr></table>';
1397: }
1398: }
1399: my $banner_link = &update_help_link($topic,$component_help,$faq,$bug,$stayOnPage);
1400: return $output.$banner_link;
1401: }
1402:
1403: sub top_nav_help {
1404: my ($text) = @_;
1.436 albertel 1405: $text = &mt($text);
1.949 droeschl 1406: my $stay_on_page = 1;
1407:
1.1168 raeburn 1408: my ($link,$banner_link);
1409: unless ($env{'request.noversionuri'} =~ m{^/adm/helpmenu}) {
1410: $link = ($stay_on_page) ? "javascript:helpMenu('display')"
1411: : "javascript:helpMenu('open')";
1412: $banner_link = &update_help_link(undef,undef,undef,undef,$stay_on_page);
1413: }
1.201 raeburn 1414: my $title = &mt('Get help');
1.1168 raeburn 1415: if ($link) {
1416: return <<"END";
1.436 albertel 1417: $banner_link
1.1159 raeburn 1418: <a href="$link" title="$title">$text</a>
1.436 albertel 1419: END
1.1168 raeburn 1420: } else {
1421: return ' '.$text.' ';
1422: }
1.436 albertel 1423: }
1424:
1425: sub help_menu_js {
1.1154 raeburn 1426: my ($httphost) = @_;
1.949 droeschl 1427: my $stayOnPage = 1;
1.436 albertel 1428: my $width = 620;
1429: my $height = 600;
1.430 albertel 1430: my $helptopic=&general_help();
1.1154 raeburn 1431: my $details_link = $httphost.'/adm/help/'.$helptopic.'.hlp';
1.261 albertel 1432: my $nothing=&Apache::lonhtmlcommon::javascript_nothing();
1.331 albertel 1433: my $start_page =
1434: &Apache::loncommon::start_page('Help Menu', undef,
1435: {'frameset' => 1,
1436: 'js_ready' => 1,
1.1154 raeburn 1437: 'use_absolute' => $httphost,
1.331 albertel 1438: 'add_entries' => {
1.1168 raeburn 1439: 'border' => '0',
1.579 raeburn 1440: 'rows' => "110,*",},});
1.331 albertel 1441: my $end_page =
1442: &Apache::loncommon::end_page({'frameset' => 1,
1443: 'js_ready' => 1,});
1444:
1.436 albertel 1445: my $template .= <<"ENDTEMPLATE";
1446: <script type="text/javascript">
1.877 bisitz 1447: // <![CDATA[
1.253 albertel 1448: // <!-- BEGIN LON-CAPA Internal
1.430 albertel 1449: var banner_link = '';
1.243 raeburn 1450: function helpMenu(target) {
1451: var caller = this;
1452: if (target == 'open') {
1453: var newWindow = null;
1454: try {
1.262 albertel 1455: newWindow = window.open($nothing,"helpmenu","HEIGHT=$height,WIDTH=$width,resizable=yes,scrollbars=yes" )
1.243 raeburn 1456: }
1457: catch(error) {
1458: writeHelp(caller);
1459: return;
1460: }
1461: if (newWindow) {
1462: caller = newWindow;
1463: }
1.193 raeburn 1464: }
1.243 raeburn 1465: writeHelp(caller);
1466: return;
1467: }
1468: function writeHelp(caller) {
1.1168 raeburn 1469: caller.document.writeln('$start_page\\n<frame name="bannerframe" src="'+banner_link+'" marginwidth="0" marginheight="0" frameborder="0">\\n');
1470: caller.document.writeln('<frame name="bodyframe" src="$details_link" marginwidth="0" marginheight="0" frameborder="0">\\n$end_page');
1471: caller.document.close();
1472: caller.focus();
1.193 raeburn 1473: }
1.877 bisitz 1474: // END LON-CAPA Internal -->
1.253 albertel 1475: // ]]>
1.436 albertel 1476: </script>
1.193 raeburn 1477: ENDTEMPLATE
1478: return $template;
1479: }
1480:
1.172 www 1481: sub help_open_bug {
1482: my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258 albertel 1483: unless ($env{'user.adv'}) { return ''; }
1.172 www 1484: unless ($Apache::lonnet::perlvar{'BugzillaHost'}) { return ''; }
1485: $text = "" if (not defined $text);
1486: $stayOnPage=1;
1.184 albertel 1487: $width = 600 if (not defined $width);
1488: $height = 600 if (not defined $height);
1.172 www 1489:
1490: $topic=~s/\W+/\+/g;
1491: my $link='';
1492: my $template='';
1.379 albertel 1493: my $url=$Apache::lonnet::perlvar{'BugzillaHost'}.'enter_bug.cgi?product=LON-CAPA&bug_file_loc='.
1494: &escape($ENV{'REQUEST_URI'}).'&component='.$topic;
1.172 www 1495: if (!$stayOnPage)
1496: {
1497: $link = "javascript:void(open('$url', 'Bugzilla', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1498: }
1499: else
1500: {
1501: $link = $url;
1502: }
1503: # Add the text
1504: if ($text ne "")
1505: {
1506: $template .=
1507: "<table bgcolor='#AA3333' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705 tempelho 1508: "<td bgcolor='#FF5555'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF;font-size:10pt;\">$text</span></a>";
1.172 www 1509: }
1510:
1511: # Add the graphic
1.179 matthew 1512: my $title = &mt('Report a Bug');
1.215 albertel 1513: my $bugicon=&lonhttpdurl("/adm/lonMisc/smallBug.gif");
1.172 www 1514: $template .= <<"ENDTEMPLATE";
1.436 albertel 1515: <a target="_top" href="$link" title="$title"><img src="$bugicon" border="0" alt="(Bug: $topic)" /></a>
1.172 www 1516: ENDTEMPLATE
1517: if ($text ne '') { $template.='</td></tr></table>' };
1518: return $template;
1519:
1520: }
1521:
1522: sub help_open_faq {
1523: my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258 albertel 1524: unless ($env{'user.adv'}) { return ''; }
1.172 www 1525: unless ($Apache::lonnet::perlvar{'FAQHost'}) { return ''; }
1526: $text = "" if (not defined $text);
1527: $stayOnPage=1;
1528: $width = 350 if (not defined $width);
1529: $height = 400 if (not defined $height);
1530:
1531: $topic=~s/\W+/\+/g;
1532: my $link='';
1533: my $template='';
1534: my $url=$Apache::lonnet::perlvar{'FAQHost'}.'/fom/cache/'.$topic.'.html';
1535: if (!$stayOnPage)
1536: {
1537: $link = "javascript:void(open('$url', 'FAQ-O-Matic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1538: }
1539: else
1540: {
1541: $link = $url;
1542: }
1543:
1544: # Add the text
1545: if ($text ne "")
1546: {
1547: $template .=
1.173 www 1548: "<table bgcolor='#337733' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705 tempelho 1549: "<td bgcolor='#448844'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF; font-size:10pt;\">$text</span></a>";
1.172 www 1550: }
1551:
1552: # Add the graphic
1.179 matthew 1553: my $title = &mt('View the FAQ');
1.215 albertel 1554: my $faqicon=&lonhttpdurl("/adm/lonMisc/smallFAQ.gif");
1.172 www 1555: $template .= <<"ENDTEMPLATE";
1.436 albertel 1556: <a target="_top" href="$link" title="$title"><img src="$faqicon" border="0" alt="(FAQ: $topic)" /></a>
1.172 www 1557: ENDTEMPLATE
1558: if ($text ne '') { $template.='</td></tr></table>' };
1559: return $template;
1560:
1.44 bowersj2 1561: }
1.37 matthew 1562:
1.180 matthew 1563: ###############################################################
1564: ###############################################################
1565:
1.45 matthew 1566: =pod
1567:
1.648 raeburn 1568: =item * &change_content_javascript():
1.256 matthew 1569:
1570: This and the next function allow you to create small sections of an
1571: otherwise static HTML page that you can update on the fly with
1572: Javascript, even in Netscape 4.
1573:
1574: The Javascript fragment returned by this function (no E<lt>scriptE<gt> tag)
1575: must be written to the HTML page once. It will prove the Javascript
1576: function "change(name, content)". Calling the change function with the
1577: name of the section
1578: you want to update, matching the name passed to C<changable_area>, and
1579: the new content you want to put in there, will put the content into
1580: that area.
1581:
1582: B<Note>: Netscape 4 only reserves enough space for the changable area
1583: to contain room for the original contents. You need to "make space"
1584: for whatever changes you wish to make, and be B<sure> to check your
1585: code in Netscape 4. This feature in Netscape 4 is B<not> powerful;
1586: it's adequate for updating a one-line status display, but little more.
1587: This script will set the space to 100% width, so you only need to
1588: worry about height in Netscape 4.
1589:
1590: Modern browsers are much less limiting, and if you can commit to the
1591: user not using Netscape 4, this feature may be used freely with
1592: pretty much any HTML.
1593:
1594: =cut
1595:
1596: sub change_content_javascript {
1597: # If we're on Netscape 4, we need to use Layer-based code
1.258 albertel 1598: if ($env{'browser.type'} eq 'netscape' &&
1599: $env{'browser.version'} =~ /^4\./) {
1.256 matthew 1600: return (<<NETSCAPE4);
1601: function change(name, content) {
1602: doc = document.layers[name+"___escape"].layers[0].document;
1603: doc.open();
1604: doc.write(content);
1605: doc.close();
1606: }
1607: NETSCAPE4
1608: } else {
1609: # Otherwise, we need to use semi-standards-compliant code
1610: # (technically, "innerHTML" isn't standard but the equivalent
1611: # is really scary, and every useful browser supports it
1612: return (<<DOMBASED);
1613: function change(name, content) {
1614: element = document.getElementById(name);
1615: element.innerHTML = content;
1616: }
1617: DOMBASED
1618: }
1619: }
1620:
1621: =pod
1622:
1.648 raeburn 1623: =item * &changable_area($name,$origContent):
1.256 matthew 1624:
1625: This provides a "changable area" that can be modified on the fly via
1626: the Javascript code provided in C<change_content_javascript>. $name is
1627: the name you will use to reference the area later; do not repeat the
1628: same name on a given HTML page more then once. $origContent is what
1629: the area will originally contain, which can be left blank.
1630:
1631: =cut
1632:
1633: sub changable_area {
1634: my ($name, $origContent) = @_;
1635:
1.258 albertel 1636: if ($env{'browser.type'} eq 'netscape' &&
1637: $env{'browser.version'} =~ /^4\./) {
1.256 matthew 1638: # If this is netscape 4, we need to use the Layer tag
1639: return "<ilayer width='100%' id='${name}___escape' overflow='none'><layer width='100%' id='$name' overflow='none'>$origContent</layer></ilayer>";
1640: } else {
1641: return "<span id='$name'>$origContent</span>";
1642: }
1643: }
1644:
1645: =pod
1646:
1.648 raeburn 1647: =item * &viewport_geometry_js
1.590 raeburn 1648:
1649: Provides javascript object (Geometry) which can provide information about the viewport geometry for the client browser.
1650:
1651: =cut
1652:
1653:
1654: sub viewport_geometry_js {
1655: return <<"GEOMETRY";
1656: var Geometry = {};
1657: function init_geometry() {
1658: if (Geometry.init) { return };
1659: Geometry.init=1;
1660: if (window.innerHeight) {
1661: Geometry.getViewportHeight = function() { return window.innerHeight; };
1662: Geometry.getViewportWidth = function() { return window.innerWidth; };
1663: Geometry.getHorizontalScroll = function() { return window.pageXOffset; };
1664: Geometry.getVerticalScroll = function() { return window.pageYOffset; };
1665: }
1666: else if (document.documentElement && document.documentElement.clientHeight) {
1667: Geometry.getViewportHeight =
1668: function() { return document.documentElement.clientHeight; };
1669: Geometry.getViewportWidth =
1670: function() { return document.documentElement.clientWidth; };
1671:
1672: Geometry.getHorizontalScroll =
1673: function() { return document.documentElement.scrollLeft; };
1674: Geometry.getVerticalScroll =
1675: function() { return document.documentElement.scrollTop; };
1676: }
1677: else if (document.body.clientHeight) {
1678: Geometry.getViewportHeight =
1679: function() { return document.body.clientHeight; };
1680: Geometry.getViewportWidth =
1681: function() { return document.body.clientWidth; };
1682: Geometry.getHorizontalScroll =
1683: function() { return document.body.scrollLeft; };
1684: Geometry.getVerticalScroll =
1685: function() { return document.body.scrollTop; };
1686: }
1687: }
1688:
1689: GEOMETRY
1690: }
1691:
1692: =pod
1693:
1.648 raeburn 1694: =item * &viewport_size_js()
1.590 raeburn 1695:
1696: 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.
1697:
1698: =cut
1699:
1700: sub viewport_size_js {
1701: my $geometry = &viewport_geometry_js();
1702: return <<"DIMS";
1703:
1704: $geometry
1705:
1706: function getViewportDims(width,height) {
1707: init_geometry();
1708: width.value = Geometry.getViewportWidth();
1709: height.value = Geometry.getViewportHeight();
1710: return;
1711: }
1712:
1713: DIMS
1714: }
1715:
1716: =pod
1717:
1.648 raeburn 1718: =item * &resize_textarea_js()
1.565 albertel 1719:
1720: emits the needed javascript to resize a textarea to be as big as possible
1721:
1722: creates a function resize_textrea that takes two IDs first should be
1723: the id of the element to resize, second should be the id of a div that
1724: surrounds everything that comes after the textarea, this routine needs
1725: to be attached to the <body> for the onload and onresize events.
1726:
1.648 raeburn 1727: =back
1.565 albertel 1728:
1729: =cut
1730:
1731: sub resize_textarea_js {
1.590 raeburn 1732: my $geometry = &viewport_geometry_js();
1.565 albertel 1733: return <<"RESIZE";
1734: <script type="text/javascript">
1.824 bisitz 1735: // <![CDATA[
1.590 raeburn 1736: $geometry
1.565 albertel 1737:
1.588 albertel 1738: function getX(element) {
1739: var x = 0;
1740: while (element) {
1741: x += element.offsetLeft;
1742: element = element.offsetParent;
1743: }
1744: return x;
1745: }
1746: function getY(element) {
1747: var y = 0;
1748: while (element) {
1749: y += element.offsetTop;
1750: element = element.offsetParent;
1751: }
1752: return y;
1753: }
1754:
1755:
1.565 albertel 1756: function resize_textarea(textarea_id,bottom_id) {
1757: init_geometry();
1758: var textarea = document.getElementById(textarea_id);
1759: //alert(textarea);
1760:
1.588 albertel 1761: var textarea_top = getY(textarea);
1.565 albertel 1762: var textarea_height = textarea.offsetHeight;
1763: var bottom = document.getElementById(bottom_id);
1.588 albertel 1764: var bottom_top = getY(bottom);
1.565 albertel 1765: var bottom_height = bottom.offsetHeight;
1766: var window_height = Geometry.getViewportHeight();
1.588 albertel 1767: var fudge = 23;
1.565 albertel 1768: var new_height = window_height-fudge-textarea_top-bottom_height;
1769: if (new_height < 300) {
1770: new_height = 300;
1771: }
1772: textarea.style.height=new_height+'px';
1773: }
1.824 bisitz 1774: // ]]>
1.565 albertel 1775: </script>
1776: RESIZE
1777:
1778: }
1779:
1.1205 golterma 1780: sub colorfuleditor_js {
1.1248 raeburn 1781: my $browse_or_search;
1782: my $respath;
1783: my ($cnum,$cdom) = &crsauthor_url();
1784: if ($cnum) {
1785: $respath = "/res/$cdom/$cnum/";
1786: my %js_lt = &Apache::lonlocal::texthash(
1787: sunm => 'Sub-directory name',
1788: save => 'Save page to make this permanent',
1789: );
1790: &js_escape(\%js_lt);
1791: $browse_or_search = <<"END";
1792:
1793: function toggleChooser(form,element,titleid,only,search) {
1794: var disp = 'none';
1795: if (document.getElementById('chooser_'+element)) {
1796: var curr = document.getElementById('chooser_'+element).style.display;
1797: if (curr == 'none') {
1798: disp='inline';
1799: if (form.elements['chooser_'+element].length) {
1800: for (var i=0; i<form.elements['chooser_'+element].length; i++) {
1801: form.elements['chooser_'+element][i].checked = false;
1802: }
1803: }
1804: toggleResImport(form,element);
1805: }
1806: document.getElementById('chooser_'+element).style.display = disp;
1807: }
1808: }
1809:
1810: function toggleCrsFile(form,element,numdirs) {
1811: if (document.getElementById('chooser_'+element+'_crsres')) {
1812: var curr = document.getElementById('chooser_'+element+'_crsres').style.display;
1813: if (curr == 'none') {
1814: if (numdirs) {
1815: form.elements['coursepath_'+element].selectedIndex = 0;
1816: if (numdirs > 1) {
1817: window['select1'+element+'_changed']();
1818: }
1819: }
1820: }
1821: document.getElementById('chooser_'+element+'_crsres').style.display = 'block';
1822:
1823: }
1824: if (document.getElementById('chooser_'+element+'_upload')) {
1825: document.getElementById('chooser_'+element+'_upload').style.display = 'none';
1826: if (document.getElementById('uploadcrsres_'+element)) {
1827: document.getElementById('uploadcrsres_'+element).value = '';
1828: }
1829: }
1830: return;
1831: }
1832:
1833: function toggleCrsUpload(form,element,numcrsdirs) {
1834: if (document.getElementById('chooser_'+element+'_crsres')) {
1835: document.getElementById('chooser_'+element+'_crsres').style.display = 'none';
1836: }
1837: if (document.getElementById('chooser_'+element+'_upload')) {
1838: var curr = document.getElementById('chooser_'+element+'_upload').style.display;
1839: if (curr == 'none') {
1840: if (numcrsdirs) {
1841: form.elements['crsauthorpath_'+element].selectedIndex = 0;
1842: form.elements['newsubdir_'+element][0].checked = true;
1843: toggleNewsubdir(form,element);
1844: }
1845: }
1846: document.getElementById('chooser_'+element+'_upload').style.display = 'block';
1847: }
1848: return;
1849: }
1850:
1851: function toggleResImport(form,element) {
1852: var choices = new Array('crsres','upload');
1853: for (var i=0; i<choices.length; i++) {
1854: if (document.getElementById('chooser_'+element+'_'+choices[i])) {
1855: document.getElementById('chooser_'+element+'_'+choices[i]).style.display = 'none';
1856: }
1857: }
1858: }
1859:
1860: function toggleNewsubdir(form,element) {
1861: var newsub = form.elements['newsubdir_'+element];
1862: if (newsub) {
1863: if (newsub.length) {
1864: for (var j=0; j<newsub.length; j++) {
1865: if (newsub[j].checked) {
1866: if (document.getElementById('newsubdirname_'+element)) {
1867: if (newsub[j].value == '1') {
1868: document.getElementById('newsubdirname_'+element).type = "text";
1869: if (document.getElementById('newsubdir_'+element)) {
1870: document.getElementById('newsubdir_'+element).innerHTML = '<br />$js_lt{sunm}';
1871: }
1872: } else {
1873: document.getElementById('newsubdirname_'+element).type = "hidden";
1874: document.getElementById('newsubdirname_'+element).value = "";
1875: document.getElementById('newsubdir_'+element).innerHTML = "";
1876: }
1877: }
1878: break;
1879: }
1880: }
1881: }
1882: }
1883: }
1884:
1885: function updateCrsFile(form,element) {
1886: var directory = form.elements['coursepath_'+element];
1887: var filename = form.elements['coursefile_'+element];
1888: var path = directory.options[directory.selectedIndex].value;
1889: var file = filename.options[filename.selectedIndex].value;
1890: form.elements[element].value = '$respath';
1891: if (path == '/') {
1892: form.elements[element].value += file;
1893: } else {
1894: form.elements[element].value += path+'/'+file;
1895: }
1896: unClean();
1897: if (document.getElementById('previewimg_'+element)) {
1898: document.getElementById('previewimg_'+element).src = form.elements[element].value;
1899: var newsrc = document.getElementById('previewimg_'+element).src;
1900: }
1901: if (document.getElementById('showimg_'+element)) {
1902: document.getElementById('showimg_'+element).innerHTML = '($js_lt{save})';
1903: }
1904: toggleChooser(form,element);
1905: return;
1906: }
1907:
1908: function uploadDone(suffix,name) {
1909: if (name) {
1910: document.forms["lonhomework"].elements[suffix].value = name;
1911: unClean();
1912: toggleChooser(document.forms["lonhomework"],suffix);
1913: }
1914: }
1915:
1916: \$(document).ready(function(){
1917:
1918: \$(document).delegate('form :submit', 'click', function( event ) {
1919: if ( \$( this ).hasClass( "LC_uploadcrsres" ) ) {
1920: var buttonId = this.id;
1921: var suffix = buttonId.toString();
1922: suffix = suffix.replace(/^crsupload_/,'');
1923: event.preventDefault();
1924: document.lonhomework.target = 'crsupload_target_'+suffix;
1925: document.lonhomework.action = '/adm/coursepub?LC_uploadcrsres='+suffix;
1926: \$(this.form).submit();
1927: document.lonhomework.target = '';
1928: if (document.getElementById('crsuploadto_'+suffix)) {
1929: document.lonhomework.action = document.getElementById('crsuploadto_'+suffix).value;
1930: }
1931: return false;
1932: }
1933: });
1934: });
1935: END
1936: }
1.1205 golterma 1937: return <<"COLORFULEDIT"
1938: <script type="text/javascript">
1939: // <![CDATA[>
1940: function fold_box(curDepth, lastresource){
1941:
1942: // we need a list because there can be several blocks you need to fold in one tag
1943: var block = document.getElementsByName('foldblock_'+curDepth);
1944: // but there is only one folding button per tag
1945: var foldbutton = document.getElementById('folding_btn_'+curDepth);
1946:
1947: if(block.item(0).style.display == 'none'){
1948:
1949: foldbutton.value = '@{[&mt("Hide")]}';
1950: for (i = 0; i < block.length; i++){
1951: block.item(i).style.display = '';
1952: }
1953: }else{
1954:
1955: foldbutton.value = '@{[&mt("Show")]}';
1956: for (i = 0; i < block.length; i++){
1957: // block.item(i).style.visibility = 'collapse';
1958: block.item(i).style.display = 'none';
1959: }
1960: };
1961: saveState(lastresource);
1962: }
1963:
1964: function saveState (lastresource) {
1965:
1966: var tag_list = getTagList();
1967: if(tag_list != null){
1968: var timestamp = new Date().getTime();
1969: var key = lastresource;
1970:
1971: // the value pattern is: 'time;key1,value1;key2,value2; ... '
1972: // starting with timestamp
1973: var value = timestamp+';';
1974:
1975: // building the list of key-value pairs
1976: for(var i = 0; i < tag_list.length; i++){
1977: value += tag_list[i]+',';
1978: value += document.getElementsByName(tag_list[i])[0].style.display+';';
1979: }
1980:
1981: // only iterate whole storage if nothing to override
1982: if(localStorage.getItem(key) == null){
1983:
1984: // prevent storage from growing large
1985: if(localStorage.length > 50){
1986: var regex_getTimestamp = /^(?:\d)+;/;
1987: var oldest_timestamp = regex_getTimestamp.exec(localStorage.key(0));
1988: var oldest_key;
1989:
1990: for(var i = 1; i < localStorage.length; i++){
1991: if (regex_getTimestamp.exec(localStorage.key(i)) < oldest_timestamp) {
1992: oldest_key = localStorage.key(i);
1993: oldest_timestamp = regex_getTimestamp.exec(oldest_key);
1994: }
1995: }
1996: localStorage.removeItem(oldest_key);
1997: }
1998: }
1999: localStorage.setItem(key,value);
2000: }
2001: }
2002:
2003: // restore folding status of blocks (on page load)
2004: function restoreState (lastresource) {
2005: if(localStorage.getItem(lastresource) != null){
2006: var key = lastresource;
2007: var value = localStorage.getItem(key);
2008: var regex_delTimestamp = /^\d+;/;
2009:
2010: value.replace(regex_delTimestamp, '');
2011:
2012: var valueArr = value.split(';');
2013: var pairs;
2014: var elements;
2015: for (var i = 0; i < valueArr.length; i++){
2016: pairs = valueArr[i].split(',');
2017: elements = document.getElementsByName(pairs[0]);
2018:
2019: for (var j = 0; j < elements.length; j++){
2020: elements[j].style.display = pairs[1];
2021: if (pairs[1] == "none"){
2022: var regex_id = /([_\\d]+)\$/;
2023: regex_id.exec(pairs[0]);
2024: document.getElementById("folding_btn"+RegExp.\$1).value = "Show";
2025: }
2026: }
2027: }
2028: }
2029: }
2030:
2031: function getTagList () {
2032:
2033: var stringToSearch = document.lonhomework.innerHTML;
2034:
2035: var ret = new Array();
2036: var regex_findBlock = /(foldblock_.*?)"/g;
2037: var tag_list = stringToSearch.match(regex_findBlock);
2038:
2039: if(tag_list != null){
2040: for(var i = 0; i < tag_list.length; i++){
2041: ret.push(tag_list[i].replace(/"/, ''));
2042: }
2043: }
2044: return ret;
2045: }
2046:
2047: function saveScrollPosition (resource) {
2048: var tag_list = getTagList();
2049:
2050: // we dont always want to jump to the first block
2051: // 170 is roughly above the "Problem Editing" header. we just want to save if the user scrolled down further than this
2052: if(\$(window).scrollTop() > 170){
2053: if(tag_list != null){
2054: var result;
2055: for(var i = 0; i < tag_list.length; i++){
2056: if(isElementInViewport(tag_list[i])){
2057: result += tag_list[i]+';';
2058: }
2059: }
2060: sessionStorage.setItem('anchor_'+resource, result);
2061: }
2062: } else {
2063: // we dont need to save zero, just delete the item to leave everything tidy
2064: sessionStorage.removeItem('anchor_'+resource);
2065: }
2066: }
2067:
2068: function restoreScrollPosition(resource){
2069:
2070: var elem = sessionStorage.getItem('anchor_'+resource);
2071: if(elem != null){
2072: var tag_list = elem.split(';');
2073: var elem_list;
2074:
2075: for(var i = 0; i < tag_list.length; i++){
2076: elem_list = document.getElementsByName(tag_list[i]);
2077:
2078: if(elem_list.length > 0){
2079: elem = elem_list[0];
2080: break;
2081: }
2082: }
2083: elem.scrollIntoView();
2084: }
2085: }
2086:
2087: function isElementInViewport(el) {
2088:
2089: // change to last element instead of first
2090: var elem = document.getElementsByName(el);
2091: var rect = elem[0].getBoundingClientRect();
2092:
2093: return (
2094: rect.top >= 0 &&
2095: rect.left >= 0 &&
2096: rect.bottom <= (window.innerHeight || document.documentElement.clientHeight) && /*or $(window).height() */
2097: rect.right <= (window.innerWidth || document.documentElement.clientWidth) /*or $(window).width() */
2098: );
2099: }
2100:
2101: function autosize(depth){
2102: var cmInst = window['cm'+depth];
2103: var fitsizeButton = document.getElementById('fitsize'+depth);
2104:
2105: // is fixed size, switching to dynamic
2106: if (sessionStorage.getItem("autosized_"+depth) == null) {
2107: cmInst.setSize("","auto");
2108: fitsizeButton.value = "@{[&mt('Fixed size')]}";
2109: sessionStorage.setItem("autosized_"+depth, "yes");
2110:
2111: // is dynamic size, switching to fixed
2112: } else {
2113: cmInst.setSize("","300px");
2114: fitsizeButton.value = "@{[&mt('Dynamic size')]}";
2115: sessionStorage.removeItem("autosized_"+depth);
2116: }
2117: }
2118:
1.1248 raeburn 2119: $browse_or_search
1.1205 golterma 2120:
2121: // ]]>
2122: </script>
2123: COLORFULEDIT
2124: }
2125:
2126: sub xmleditor_js {
2127: return <<XMLEDIT
2128: <script type="text/javascript" src="/adm/jQuery/addons/jquery-scrolltofixed.js"></script>
2129: <script type="text/javascript">
2130: // <![CDATA[>
2131:
2132: function saveScrollPosition (resource) {
2133:
2134: var scrollPos = \$(window).scrollTop();
2135: sessionStorage.setItem(resource,scrollPos);
2136: }
2137:
2138: function restoreScrollPosition(resource){
2139:
2140: var scrollPos = sessionStorage.getItem(resource);
2141: \$(window).scrollTop(scrollPos);
2142: }
2143:
2144: // unless internet explorer
2145: if (!(window.navigator.appName == "Microsoft Internet Explorer" && (document.documentMode || document.compatMode))){
2146:
2147: \$(document).ready(function() {
2148: \$(".LC_edit_actionbar").scrollToFixed(\{zIndex: 100\});
2149: });
2150: }
2151:
2152: // inserts text at cursor position into codemirror (xml editor only)
2153: function insertText(text){
2154: cm.focus();
2155: var curPos = cm.getCursor();
2156: cm.replaceRange(text.replace(/ESCAPEDSCRIPT/g,'script'), {line: curPos.line,ch: curPos.ch});
2157: }
2158: // ]]>
2159: </script>
2160: XMLEDIT
2161: }
2162:
2163: sub insert_folding_button {
2164: my $curDepth = $Apache::lonxml::curdepth;
2165: my $lastresource = $env{'request.ambiguous'};
2166:
2167: return "<input type=\"button\" id=\"folding_btn_$curDepth\"
2168: value=\"".&mt('Hide')."\" onclick=\"fold_box('$curDepth','$lastresource')\">";
2169: }
2170:
1.1248 raeburn 2171: sub crsauthor_url {
2172: my ($url) = @_;
2173: if ($url eq '') {
2174: $url = $ENV{'REQUEST_URI'};
2175: }
2176: my ($cnum,$cdom);
2177: if ($env{'request.course.id'}) {
2178: my ($audom,$auname) = ($url =~ m{^/priv/($match_domain)/($match_name)/});
2179: if ($audom ne '' && $auname ne '') {
2180: if (($env{'course.'.$env{'request.course.id'}.'.num'} eq $auname) &&
2181: ($env{'course.'.$env{'request.course.id'}.'.domain'} eq $audom)) {
2182: $cnum = $auname;
2183: $cdom = $audom;
2184: }
2185: }
2186: }
2187: return ($cnum,$cdom);
2188: }
2189:
2190: sub import_crsauthor_form {
1.1265 raeburn 2191: my ($form,$firstselectname,$secondselectname,$onchangefirst,$only,$suffix,$disabled) = @_;
1.1248 raeburn 2192: return (0) unless ($env{'request.course.id'});
2193: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
2194: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
2195: my $crshome = $env{'course.'.$env{'request.course.id'}.'.home'};
2196: return (0) unless (($cnum ne '') && ($cdom ne ''));
2197: my $londocroot = $Apache::lonnet::perlvar{'lonDocRoot'};
2198: my @ids=&Apache::lonnet::current_machine_ids();
2199: my ($output,$is_home,$relpath,%subdirs,%files,%selimport_menus);
2200:
2201: if (grep(/^\Q$crshome\E$/,@ids)) {
2202: $is_home = 1;
2203: }
2204: $relpath = "/priv/$cdom/$cnum";
2205: &Apache::lonnet::recursedirs($is_home,'priv',$londocroot,$relpath,'',\%subdirs,\%files);
2206: my %lt = &Apache::lonlocal::texthash (
2207: fnam => 'Filename',
2208: dire => 'Directory',
2209: );
2210: my $numdirs = scalar(keys(%files));
2211: my (%possexts,$singledir,@singledirfiles);
2212: if ($only) {
2213: map { $possexts{$_} = 1; } split(/\s*,\s*/,$only);
2214: }
2215: my (%nonemptydirs,$possdirs);
2216: if ($numdirs > 1) {
2217: my @order;
2218: foreach my $key (sort { lc($a) cmp lc($b) } (keys(%files))) {
2219: if (ref($files{$key}) eq 'HASH') {
2220: my $shown = $key;
2221: if ($key eq '') {
2222: $shown = '/';
2223: }
2224: my @ordered = ();
2225: foreach my $file (sort { lc($a) cmp lc($b) } (keys(%{$files{$key}}))) {
2226: if ($only) {
2227: my ($ext) = ($file =~ /\.([^.]+)$/);
2228: unless ($possexts{lc($ext)}) {
2229: next;
2230: }
2231: }
2232: $selimport_menus{$key}->{'select2'}->{$file} = $file;
2233: push(@ordered,$file);
2234: }
2235: if (@ordered) {
2236: push(@order,$key);
2237: $nonemptydirs{$key} = 1;
2238: $selimport_menus{$key}->{'text'} = $shown;
2239: $selimport_menus{$key}->{'default'} = '';
2240: $selimport_menus{$key}->{'select2'}->{''} = '';
2241: $selimport_menus{$key}->{'order'} = \@ordered;
2242: }
2243: }
2244: }
2245: $possdirs = scalar(keys(%nonemptydirs));
2246: if ($possdirs > 1) {
2247: my @order = sort { lc($a) cmp lc($b) } (keys(%nonemptydirs));
2248: $output = $lt{'dire'}.
2249: &linked_select_forms($form,'<br />'.
2250: $lt{'fnam'},'',
2251: $firstselectname,$secondselectname,
2252: \%selimport_menus,\@order,
2253: $onchangefirst,'',$suffix).'<br />';
2254: } elsif ($possdirs == 1) {
2255: $singledir = (keys(%nonemptydirs))[0];
2256: if (ref($selimport_menus{$singledir}->{'order'}) eq 'ARRAY') {
2257: @singledirfiles = @{$selimport_menus{$singledir}->{'order'}};
2258: }
2259: delete($selimport_menus{$singledir});
2260: }
2261: } elsif ($numdirs == 1) {
2262: $singledir = (keys(%files))[0];
2263: foreach my $file (sort { lc($a) cmp lc($b) } (keys(%{$files{$singledir}}))) {
2264: if ($only) {
2265: my ($ext) = ($file =~ /\.([^.]+)$/);
2266: unless ($possexts{lc($ext)}) {
2267: next;
2268: }
2269: }
2270: push(@singledirfiles,$file);
2271: }
2272: if (@singledirfiles) {
2273: $possdirs == 1;
2274: }
2275: }
2276: if (($possdirs == 1) && (@singledirfiles)) {
2277: my $showdir = $singledir;
2278: if ($singledir eq '') {
2279: $showdir = '/';
2280: }
2281: $output = $lt{'dire'}.
2282: '<select name="'.$firstselectname.'">'.
2283: '<option value="'.$singledir.'">'.$showdir.'</option>'."\n".
2284: '</select><br />'.
2285: $lt{'fnam'}.'<select name="'.$secondselectname.'">'."\n".
2286: '<option value="" selected="selected">'.$lt{'se'}.'</option>'."\n";
2287: foreach my $file (@singledirfiles) {
2288: $output .= '<option value="'.$file.'">'.$file.'</option>'."\n";
2289: }
2290: $output .= '</select><br />'."\n";
2291: }
2292: return ($possdirs,$output);
2293: }
2294:
1.565 albertel 2295: =pod
2296:
1.256 matthew 2297: =head1 Excel and CSV file utility routines
2298:
2299: =cut
2300:
2301: ###############################################################
2302: ###############################################################
2303:
2304: =pod
2305:
1.1162 raeburn 2306: =over 4
2307:
1.648 raeburn 2308: =item * &csv_translate($text)
1.37 matthew 2309:
1.185 www 2310: Translate $text to allow it to be output as a 'comma separated values'
1.37 matthew 2311: format.
2312:
2313: =cut
2314:
1.180 matthew 2315: ###############################################################
2316: ###############################################################
1.37 matthew 2317: sub csv_translate {
2318: my $text = shift;
2319: $text =~ s/\"/\"\"/g;
1.209 albertel 2320: $text =~ s/\n/ /g;
1.37 matthew 2321: return $text;
2322: }
1.180 matthew 2323:
2324: ###############################################################
2325: ###############################################################
2326:
2327: =pod
2328:
1.648 raeburn 2329: =item * &define_excel_formats()
1.180 matthew 2330:
2331: Define some commonly used Excel cell formats.
2332:
2333: Currently supported formats:
2334:
2335: =over 4
2336:
2337: =item header
2338:
2339: =item bold
2340:
2341: =item h1
2342:
2343: =item h2
2344:
2345: =item h3
2346:
1.256 matthew 2347: =item h4
2348:
2349: =item i
2350:
1.180 matthew 2351: =item date
2352:
2353: =back
2354:
2355: Inputs: $workbook
2356:
2357: Returns: $format, a hash reference.
2358:
1.1057 foxr 2359:
1.180 matthew 2360: =cut
2361:
2362: ###############################################################
2363: ###############################################################
2364: sub define_excel_formats {
2365: my ($workbook) = @_;
2366: my $format;
2367: $format->{'header'} = $workbook->add_format(bold => 1,
2368: bottom => 1,
2369: align => 'center');
2370: $format->{'bold'} = $workbook->add_format(bold=>1);
2371: $format->{'h1'} = $workbook->add_format(bold=>1, size=>18);
2372: $format->{'h2'} = $workbook->add_format(bold=>1, size=>16);
2373: $format->{'h3'} = $workbook->add_format(bold=>1, size=>14);
1.255 matthew 2374: $format->{'h4'} = $workbook->add_format(bold=>1, size=>12);
1.246 matthew 2375: $format->{'i'} = $workbook->add_format(italic=>1);
1.180 matthew 2376: $format->{'date'} = $workbook->add_format(num_format=>
1.207 matthew 2377: 'mm/dd/yyyy hh:mm:ss');
1.180 matthew 2378: return $format;
2379: }
2380:
2381: ###############################################################
2382: ###############################################################
1.113 bowersj2 2383:
2384: =pod
2385:
1.648 raeburn 2386: =item * &create_workbook()
1.255 matthew 2387:
2388: Create an Excel worksheet. If it fails, output message on the
2389: request object and return undefs.
2390:
2391: Inputs: Apache request object
2392:
2393: Returns (undef) on failure,
2394: Excel worksheet object, scalar with filename, and formats
2395: from &Apache::loncommon::define_excel_formats on success
2396:
2397: =cut
2398:
2399: ###############################################################
2400: ###############################################################
2401: sub create_workbook {
2402: my ($r) = @_;
2403: #
2404: # Create the excel spreadsheet
2405: my $filename = '/prtspool/'.
1.258 albertel 2406: $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.255 matthew 2407: time.'_'.rand(1000000000).'.xls';
2408: my $workbook = Spreadsheet::WriteExcel->new('/home/httpd'.$filename);
2409: if (! defined($workbook)) {
2410: $r->log_error("Error creating excel spreadsheet $filename: $!");
1.928 bisitz 2411: $r->print(
2412: '<p class="LC_error">'
2413: .&mt('Problems occurred in creating the new Excel file.')
2414: .' '.&mt('This error has been logged.')
2415: .' '.&mt('Please alert your LON-CAPA administrator.')
2416: .'</p>'
2417: );
1.255 matthew 2418: return (undef);
2419: }
2420: #
1.1014 foxr 2421: $workbook->set_tempdir(LONCAPA::tempdir());
1.255 matthew 2422: #
2423: my $format = &Apache::loncommon::define_excel_formats($workbook);
2424: return ($workbook,$filename,$format);
2425: }
2426:
2427: ###############################################################
2428: ###############################################################
2429:
2430: =pod
2431:
1.648 raeburn 2432: =item * &create_text_file()
1.113 bowersj2 2433:
1.542 raeburn 2434: Create a file to write to and eventually make available to the user.
1.256 matthew 2435: If file creation fails, outputs an error message on the request object and
2436: return undefs.
1.113 bowersj2 2437:
1.256 matthew 2438: Inputs: Apache request object, and file suffix
1.113 bowersj2 2439:
1.256 matthew 2440: Returns (undef) on failure,
2441: Filehandle and filename on success.
1.113 bowersj2 2442:
2443: =cut
2444:
1.256 matthew 2445: ###############################################################
2446: ###############################################################
2447: sub create_text_file {
2448: my ($r,$suffix) = @_;
2449: if (! defined($suffix)) { $suffix = 'txt'; };
2450: my $fh;
2451: my $filename = '/prtspool/'.
1.258 albertel 2452: $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.256 matthew 2453: time.'_'.rand(1000000000).'.'.$suffix;
2454: $fh = Apache::File->new('>/home/httpd'.$filename);
2455: if (! defined($fh)) {
2456: $r->log_error("Couldn't open $filename for output $!");
1.928 bisitz 2457: $r->print(
2458: '<p class="LC_error">'
2459: .&mt('Problems occurred in creating the output file.')
2460: .' '.&mt('This error has been logged.')
2461: .' '.&mt('Please alert your LON-CAPA administrator.')
2462: .'</p>'
2463: );
1.113 bowersj2 2464: }
1.256 matthew 2465: return ($fh,$filename)
1.113 bowersj2 2466: }
2467:
2468:
1.256 matthew 2469: =pod
1.113 bowersj2 2470:
2471: =back
2472:
2473: =cut
1.37 matthew 2474:
2475: ###############################################################
1.33 matthew 2476: ## Home server <option> list generating code ##
2477: ###############################################################
1.35 matthew 2478:
1.169 www 2479: # ------------------------------------------
2480:
2481: sub domain_select {
1.1289 raeburn 2482: my ($name,$value,$multiple,$incdoms,$excdoms)=@_;
2483: my @possdoms;
2484: if (ref($incdoms) eq 'ARRAY') {
2485: @possdoms = @{$incdoms};
2486: } else {
2487: @possdoms = &Apache::lonnet::all_domains();
2488: }
2489:
1.169 www 2490: my %domains=map {
1.514 albertel 2491: $_ => $_.' '. &Apache::lonnet::domain($_,'description')
1.1289 raeburn 2492: } @possdoms;
2493:
2494: if ((ref($excdoms) eq 'ARRAY') && (@{$excdoms} > 0)) {
2495: foreach my $dom (@{$excdoms}) {
2496: delete($domains{$dom});
2497: }
2498: }
2499:
1.169 www 2500: if ($multiple) {
2501: $domains{''}=&mt('Any domain');
1.550 albertel 2502: $domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.287 albertel 2503: return &multiple_select_form($name,$value,4,\%domains);
1.169 www 2504: } else {
1.550 albertel 2505: $domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.970 raeburn 2506: return &select_form($name,$value,\%domains);
1.169 www 2507: }
2508: }
2509:
1.282 albertel 2510: #-------------------------------------------
2511:
2512: =pod
2513:
1.519 raeburn 2514: =head1 Routines for form select boxes
2515:
2516: =over 4
2517:
1.648 raeburn 2518: =item * &multiple_select_form($name,$value,$size,$hash,$order)
1.282 albertel 2519:
2520: Returns a string containing a <select> element int multiple mode
2521:
2522:
2523: Args:
2524: $name - name of the <select> element
1.506 raeburn 2525: $value - scalar or array ref of values that should already be selected
1.282 albertel 2526: $size - number of rows long the select element is
1.283 albertel 2527: $hash - the elements should be 'option' => 'shown text'
1.282 albertel 2528: (shown text should already have been &mt())
1.506 raeburn 2529: $order - (optional) array ref of the order to show the elements in
1.283 albertel 2530:
1.282 albertel 2531: =cut
2532:
2533: #-------------------------------------------
1.169 www 2534: sub multiple_select_form {
1.284 albertel 2535: my ($name,$value,$size,$hash,$order)=@_;
1.169 www 2536: my %selected = map { $_ => 1 } ref($value)?@{$value}:($value);
2537: my $output='';
1.191 matthew 2538: if (! defined($size)) {
2539: $size = 4;
1.283 albertel 2540: if (scalar(keys(%$hash))<4) {
2541: $size = scalar(keys(%$hash));
1.191 matthew 2542: }
2543: }
1.734 bisitz 2544: $output.="\n".'<select name="'.$name.'" size="'.$size.'" multiple="multiple">';
1.501 banghart 2545: my @order;
1.506 raeburn 2546: if (ref($order) eq 'ARRAY') {
2547: @order = @{$order};
2548: } else {
2549: @order = sort(keys(%$hash));
1.501 banghart 2550: }
2551: if (exists($$hash{'select_form_order'})) {
2552: @order = @{$$hash{'select_form_order'}};
2553: }
2554:
1.284 albertel 2555: foreach my $key (@order) {
1.356 albertel 2556: $output.='<option value="'.&HTML::Entities::encode($key,'"<>&').'" ';
1.284 albertel 2557: $output.='selected="selected" ' if ($selected{$key});
2558: $output.='>'.$hash->{$key}."</option>\n";
1.169 www 2559: }
2560: $output.="</select>\n";
2561: return $output;
2562: }
2563:
1.88 www 2564: #-------------------------------------------
2565:
2566: =pod
2567:
1.1254 raeburn 2568: =item * &select_form($defdom,$name,$hashref,$onchange,$readonly)
1.88 www 2569:
2570: Returns a string containing a <select name='$name' size='1'> form to
1.970 raeburn 2571: allow a user to select options from a ref to a hash containing:
2572: option_name => displayed text. An optional $onchange can include
1.1254 raeburn 2573: a javascript onchange item, e.g., onchange="this.form.submit();".
2574: An optional arg -- $readonly -- if true will cause the select form
2575: to be disabled, e.g., for the case where an instructor has a section-
2576: specific role, and is viewing/modifying parameters.
1.970 raeburn 2577:
1.88 www 2578: See lonrights.pm for an example invocation and use.
2579:
2580: =cut
2581:
2582: #-------------------------------------------
2583: sub select_form {
1.1228 raeburn 2584: my ($def,$name,$hashref,$onchange,$readonly) = @_;
1.970 raeburn 2585: return unless (ref($hashref) eq 'HASH');
2586: if ($onchange) {
2587: $onchange = ' onchange="'.$onchange.'"';
2588: }
1.1228 raeburn 2589: my $disabled;
2590: if ($readonly) {
2591: $disabled = ' disabled="disabled"';
2592: }
2593: my $selectform = "<select name=\"$name\" size=\"1\"$onchange$disabled>\n";
1.128 albertel 2594: my @keys;
1.970 raeburn 2595: if (exists($hashref->{'select_form_order'})) {
2596: @keys=@{$hashref->{'select_form_order'}};
1.128 albertel 2597: } else {
1.970 raeburn 2598: @keys=sort(keys(%{$hashref}));
1.128 albertel 2599: }
1.356 albertel 2600: foreach my $key (@keys) {
2601: $selectform.=
2602: '<option value="'.&HTML::Entities::encode($key,'"<>&').'" '.
2603: ($key eq $def ? 'selected="selected" ' : '').
1.970 raeburn 2604: ">".$hashref->{$key}."</option>\n";
1.88 www 2605: }
2606: $selectform.="</select>";
2607: return $selectform;
2608: }
2609:
1.475 www 2610: # For display filters
2611:
2612: sub display_filter {
1.1074 raeburn 2613: my ($context) = @_;
1.475 www 2614: if (!$env{'form.show'}) { $env{'form.show'}=10; }
1.477 www 2615: if (!$env{'form.displayfilter'}) { $env{'form.displayfilter'}='currentfolder'; }
1.1074 raeburn 2616: my $phraseinput = 'hidden';
2617: my $includeinput = 'hidden';
2618: my ($checked,$includetypestext);
2619: if ($env{'form.displayfilter'} eq 'containing') {
2620: $phraseinput = 'text';
2621: if ($context eq 'parmslog') {
2622: $includeinput = 'checkbox';
2623: if ($env{'form.includetypes'}) {
2624: $checked = ' checked="checked"';
2625: }
2626: $includetypestext = &mt('Include parameter types');
2627: }
2628: } else {
2629: $includetypestext = ' ';
2630: }
2631: my ($additional,$secondid,$thirdid);
2632: if ($context eq 'parmslog') {
2633: $additional =
2634: '<label><input type="'.$includeinput.'" name="includetypes"'.
2635: $checked.' name="includetypes" value="1" id="includetypes" />'.
2636: ' <span id="includetypestext">'.$includetypestext.'</span>'.
2637: '</label>';
2638: $secondid = 'includetypes';
2639: $thirdid = 'includetypestext';
2640: }
2641: my $onchange = "javascript:toggleHistoryOptions(this,'containingphrase','$context',
2642: '$secondid','$thirdid')";
2643: return '<span class="LC_nobreak"><label>'.&mt('Records: [_1]',
1.475 www 2644: &Apache::lonmeta::selectbox('show',$env{'form.show'},undef,
2645: (&mt('all'),10,20,50,100,1000,10000))).
1.714 bisitz 2646: '</label></span> <span class="LC_nobreak">'.
1.1074 raeburn 2647: &mt('Filter: [_1]',
1.477 www 2648: &select_form($env{'form.displayfilter'},
2649: 'displayfilter',
1.970 raeburn 2650: {'currentfolder' => 'Current folder/page',
1.477 www 2651: 'containing' => 'Containing phrase',
1.1074 raeburn 2652: 'none' => 'None'},$onchange)).' '.
2653: '<input type="'.$phraseinput.'" name="containingphrase" id="containingphrase" size="30" value="'.
2654: &HTML::Entities::encode($env{'form.containingphrase'}).
2655: '" />'.$additional;
2656: }
2657:
2658: sub display_filter_js {
2659: my $includetext = &mt('Include parameter types');
2660: return <<"ENDJS";
2661:
2662: function toggleHistoryOptions(setter,firstid,context,secondid,thirdid) {
2663: var firstType = 'hidden';
2664: if (setter.options[setter.selectedIndex].value == 'containing') {
2665: firstType = 'text';
2666: }
2667: firstObject = document.getElementById(firstid);
2668: if (typeof(firstObject) == 'object') {
2669: if (firstObject.type != firstType) {
2670: changeInputType(firstObject,firstType);
2671: }
2672: }
2673: if (context == 'parmslog') {
2674: var secondType = 'hidden';
2675: if (firstType == 'text') {
2676: secondType = 'checkbox';
2677: }
2678: secondObject = document.getElementById(secondid);
2679: if (typeof(secondObject) == 'object') {
2680: if (secondObject.type != secondType) {
2681: changeInputType(secondObject,secondType);
2682: }
2683: }
2684: var textItem = document.getElementById(thirdid);
2685: var currtext = textItem.innerHTML;
2686: var newtext;
2687: if (firstType == 'text') {
2688: newtext = '$includetext';
2689: } else {
2690: newtext = ' ';
2691: }
2692: if (currtext != newtext) {
2693: textItem.innerHTML = newtext;
2694: }
2695: }
2696: return;
2697: }
2698:
2699: function changeInputType(oldObject,newType) {
2700: var newObject = document.createElement('input');
2701: newObject.type = newType;
2702: if (oldObject.size) {
2703: newObject.size = oldObject.size;
2704: }
2705: if (oldObject.value) {
2706: newObject.value = oldObject.value;
2707: }
2708: if (oldObject.name) {
2709: newObject.name = oldObject.name;
2710: }
2711: if (oldObject.id) {
2712: newObject.id = oldObject.id;
2713: }
2714: oldObject.parentNode.replaceChild(newObject,oldObject);
2715: return;
2716: }
2717:
2718: ENDJS
1.475 www 2719: }
2720:
1.167 www 2721: sub gradeleveldescription {
2722: my $gradelevel=shift;
2723: my %gradelevels=(0 => 'Not specified',
2724: 1 => 'Grade 1',
2725: 2 => 'Grade 2',
2726: 3 => 'Grade 3',
2727: 4 => 'Grade 4',
2728: 5 => 'Grade 5',
2729: 6 => 'Grade 6',
2730: 7 => 'Grade 7',
2731: 8 => 'Grade 8',
2732: 9 => 'Grade 9',
2733: 10 => 'Grade 10',
2734: 11 => 'Grade 11',
2735: 12 => 'Grade 12',
2736: 13 => 'Grade 13',
2737: 14 => '100 Level',
2738: 15 => '200 Level',
2739: 16 => '300 Level',
2740: 17 => '400 Level',
2741: 18 => 'Graduate Level');
2742: return &mt($gradelevels{$gradelevel});
2743: }
2744:
1.163 www 2745: sub select_level_form {
2746: my ($deflevel,$name)=@_;
2747: unless ($deflevel) { $deflevel=0; }
1.167 www 2748: my $selectform = "<select name=\"$name\" size=\"1\">\n";
2749: for (my $i=0; $i<=18; $i++) {
2750: $selectform.="<option value=\"$i\" ".
1.253 albertel 2751: ($i==$deflevel ? 'selected="selected" ' : '').
1.167 www 2752: ">".&gradeleveldescription($i)."</option>\n";
2753: }
2754: $selectform.="</select>";
2755: return $selectform;
1.163 www 2756: }
1.167 www 2757:
1.35 matthew 2758: #-------------------------------------------
2759:
1.45 matthew 2760: =pod
2761:
1.1256 raeburn 2762: =item * &select_dom_form($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms,$excdoms,$disabled)
1.35 matthew 2763:
2764: Returns a string containing a <select name='$name' size='1'> form to
2765: allow a user to select the domain to preform an operation in.
2766: See loncreateuser.pm for an example invocation and use.
2767:
1.90 www 2768: If the $includeempty flag is set, it also includes an empty choice ("no domain
2769: selected");
2770:
1.743 raeburn 2771: If the $showdomdesc flag is set, the domain name is followed by the domain description.
2772:
1.910 raeburn 2773: 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.
2774:
1.1121 raeburn 2775: The optional $incdoms is a reference to an array of domains which will be the only available options.
2776:
2777: The optional $excdoms is a reference to an array of domains which will be excluded from the available options.
1.563 raeburn 2778:
1.1256 raeburn 2779: The optional $disabled argument, if true, adds the disabled attribute to the select tag.
2780:
1.35 matthew 2781: =cut
2782:
2783: #-------------------------------------------
1.34 matthew 2784: sub select_dom_form {
1.1256 raeburn 2785: my ($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms,$excdoms,$disabled) = @_;
1.872 raeburn 2786: if ($onchange) {
1.874 raeburn 2787: $onchange = ' onchange="'.$onchange.'"';
1.743 raeburn 2788: }
1.1256 raeburn 2789: if ($disabled) {
2790: $disabled = ' disabled="disabled"';
2791: }
1.1121 raeburn 2792: my (@domains,%exclude);
1.910 raeburn 2793: if (ref($incdoms) eq 'ARRAY') {
2794: @domains = sort {lc($a) cmp lc($b)} (@{$incdoms});
2795: } else {
2796: @domains = sort {lc($a) cmp lc($b)} (&Apache::lonnet::all_domains());
2797: }
1.90 www 2798: if ($includeempty) { @domains=('',@domains); }
1.1121 raeburn 2799: if (ref($excdoms) eq 'ARRAY') {
2800: map { $exclude{$_} = 1; } @{$excdoms};
2801: }
1.1256 raeburn 2802: my $selectdomain = "<select name=\"$name\" size=\"1\"$onchange$disabled>\n";
1.356 albertel 2803: foreach my $dom (@domains) {
1.1121 raeburn 2804: next if ($exclude{$dom});
1.356 albertel 2805: $selectdomain.="<option value=\"$dom\" ".
1.563 raeburn 2806: ($dom eq $defdom ? 'selected="selected" ' : '').'>'.$dom;
2807: if ($showdomdesc) {
2808: if ($dom ne '') {
2809: my $domdesc = &Apache::lonnet::domain($dom,'description');
2810: if ($domdesc ne '') {
2811: $selectdomain .= ' ('.$domdesc.')';
2812: }
2813: }
2814: }
2815: $selectdomain .= "</option>\n";
1.34 matthew 2816: }
2817: $selectdomain.="</select>";
2818: return $selectdomain;
2819: }
2820:
1.35 matthew 2821: #-------------------------------------------
2822:
1.45 matthew 2823: =pod
2824:
1.648 raeburn 2825: =item * &home_server_form_item($domain,$name,$defaultflag)
1.35 matthew 2826:
1.586 raeburn 2827: input: 4 arguments (two required, two optional) -
2828: $domain - domain of new user
2829: $name - name of form element
2830: $default - Value of 'default' causes a default item to be first
2831: option, and selected by default.
2832: $hide - Value of 'hide' causes hiding of the name of the server,
2833: if 1 server found, or default, if 0 found.
1.594 raeburn 2834: output: returns 2 items:
1.586 raeburn 2835: (a) form element which contains either:
2836: (i) <select name="$name">
2837: <option value="$hostid1">$hostid $servers{$hostid}</option>
2838: <option value="$hostid2">$hostid $servers{$hostid}</option>
2839: </select>
2840: form item if there are multiple library servers in $domain, or
2841: (ii) an <input type="hidden" name="$name" value="$hostid" /> form item
2842: if there is only one library server in $domain.
2843:
2844: (b) number of library servers found.
2845:
2846: See loncreateuser.pm for example of use.
1.35 matthew 2847:
2848: =cut
2849:
2850: #-------------------------------------------
1.586 raeburn 2851: sub home_server_form_item {
2852: my ($domain,$name,$default,$hide) = @_;
1.513 albertel 2853: my %servers = &Apache::lonnet::get_servers($domain,'library');
1.586 raeburn 2854: my $result;
2855: my $numlib = keys(%servers);
2856: if ($numlib > 1) {
2857: $result .= '<select name="'.$name.'" />'."\n";
2858: if ($default) {
1.804 bisitz 2859: $result .= '<option value="default" selected="selected">'.&mt('default').
1.586 raeburn 2860: '</option>'."\n";
2861: }
2862: foreach my $hostid (sort(keys(%servers))) {
2863: $result.= '<option value="'.$hostid.'">'.
2864: $hostid.' '.$servers{$hostid}."</option>\n";
2865: }
2866: $result .= '</select>'."\n";
2867: } elsif ($numlib == 1) {
2868: my $hostid;
2869: foreach my $item (keys(%servers)) {
2870: $hostid = $item;
2871: }
2872: $result .= '<input type="hidden" name="'.$name.'" value="'.
2873: $hostid.'" />';
2874: if (!$hide) {
2875: $result .= $hostid.' '.$servers{$hostid};
2876: }
2877: $result .= "\n";
2878: } elsif ($default) {
2879: $result .= '<input type="hidden" name="'.$name.
2880: '" value="default" />';
2881: if (!$hide) {
2882: $result .= &mt('default');
2883: }
2884: $result .= "\n";
1.33 matthew 2885: }
1.586 raeburn 2886: return ($result,$numlib);
1.33 matthew 2887: }
1.112 bowersj2 2888:
2889: =pod
2890:
1.534 albertel 2891: =back
2892:
1.112 bowersj2 2893: =cut
1.87 matthew 2894:
2895: ###############################################################
1.112 bowersj2 2896: ## Decoding User Agent ##
1.87 matthew 2897: ###############################################################
2898:
2899: =pod
2900:
1.112 bowersj2 2901: =head1 Decoding the User Agent
2902:
2903: =over 4
2904:
2905: =item * &decode_user_agent()
1.87 matthew 2906:
2907: Inputs: $r
2908:
2909: Outputs:
2910:
2911: =over 4
2912:
1.112 bowersj2 2913: =item * $httpbrowser
1.87 matthew 2914:
1.112 bowersj2 2915: =item * $clientbrowser
1.87 matthew 2916:
1.112 bowersj2 2917: =item * $clientversion
1.87 matthew 2918:
1.112 bowersj2 2919: =item * $clientmathml
1.87 matthew 2920:
1.112 bowersj2 2921: =item * $clientunicode
1.87 matthew 2922:
1.112 bowersj2 2923: =item * $clientos
1.87 matthew 2924:
1.1137 raeburn 2925: =item * $clientmobile
2926:
1.1141 raeburn 2927: =item * $clientinfo
2928:
1.1194 raeburn 2929: =item * $clientosversion
2930:
1.87 matthew 2931: =back
2932:
1.157 matthew 2933: =back
2934:
1.87 matthew 2935: =cut
2936:
2937: ###############################################################
2938: ###############################################################
2939: sub decode_user_agent {
1.247 albertel 2940: my ($r)=@_;
1.87 matthew 2941: my @browsertype=split(/\&/,$Apache::lonnet::perlvar{"lonBrowsDet"});
2942: my %mathcap=split(/\&/,$$Apache::lonnet::perlvar{"lonMathML"});
2943: my $httpbrowser=$ENV{"HTTP_USER_AGENT"};
1.247 albertel 2944: if (!$httpbrowser && $r) { $httpbrowser=$r->header_in('User-Agent'); }
1.87 matthew 2945: my $clientbrowser='unknown';
2946: my $clientversion='0';
2947: my $clientmathml='';
2948: my $clientunicode='0';
1.1137 raeburn 2949: my $clientmobile=0;
1.1194 raeburn 2950: my $clientosversion='';
1.87 matthew 2951: for (my $i=0;$i<=$#browsertype;$i++) {
1.1193 raeburn 2952: my ($bname,$match,$notmatch,$vreg,$minv,$univ)=split(/\%/,$browsertype[$i]);
1.87 matthew 2953: if (($httpbrowser=~/$match/i) && ($httpbrowser!~/$notmatch/i)) {
2954: $clientbrowser=$bname;
2955: $httpbrowser=~/$vreg/i;
2956: $clientversion=$1;
2957: $clientmathml=($clientversion>=$minv);
2958: $clientunicode=($clientversion>=$univ);
2959: }
2960: }
2961: my $clientos='unknown';
1.1141 raeburn 2962: my $clientinfo;
1.87 matthew 2963: if (($httpbrowser=~/linux/i) ||
2964: ($httpbrowser=~/unix/i) ||
2965: ($httpbrowser=~/ux/i) ||
2966: ($httpbrowser=~/solaris/i)) { $clientos='unix'; }
2967: if (($httpbrowser=~/vax/i) ||
2968: ($httpbrowser=~/vms/i)) { $clientos='vms'; }
2969: if ($httpbrowser=~/next/i) { $clientos='next'; }
2970: if (($httpbrowser=~/mac/i) ||
2971: ($httpbrowser=~/powerpc/i)) { $clientos='mac'; }
1.1194 raeburn 2972: if ($httpbrowser=~/win/i) {
2973: $clientos='win';
2974: if ($httpbrowser =~/Windows\s+NT\s+(\d+\.\d+)/i) {
2975: $clientosversion = $1;
2976: }
2977: }
1.87 matthew 2978: if ($httpbrowser=~/embed/i) { $clientos='pda'; }
1.1137 raeburn 2979: if ($httpbrowser=~/(Android|iPod|iPad|iPhone|webOS|Blackberry|Windows Phone|Opera m(?:ob|in)|Fennec)/i) {
2980: $clientmobile=lc($1);
2981: }
1.1141 raeburn 2982: if ($httpbrowser=~ m{Firefox/(\d+\.\d+)}) {
2983: $clientinfo = 'firefox-'.$1;
2984: } elsif ($httpbrowser=~ m{chromeframe/(\d+\.\d+)\.}) {
2985: $clientinfo = 'chromeframe-'.$1;
2986: }
1.87 matthew 2987: return ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
1.1194 raeburn 2988: $clientunicode,$clientos,$clientmobile,$clientinfo,
2989: $clientosversion);
1.87 matthew 2990: }
2991:
1.32 matthew 2992: ###############################################################
2993: ## Authentication changing form generation subroutines ##
2994: ###############################################################
2995: ##
2996: ## All of the authform_xxxxxxx subroutines take their inputs in a
2997: ## hash, and have reasonable default values.
2998: ##
2999: ## formname = the name given in the <form> tag.
1.35 matthew 3000: #-------------------------------------------
3001:
1.45 matthew 3002: =pod
3003:
1.112 bowersj2 3004: =head1 Authentication Routines
3005:
3006: =over 4
3007:
1.648 raeburn 3008: =item * &authform_xxxxxx()
1.35 matthew 3009:
3010: The authform_xxxxxx subroutines provide javascript and html forms which
3011: handle some of the conveniences required for authentication forms.
3012: This is not an optimal method, but it works.
3013:
3014: =over 4
3015:
1.112 bowersj2 3016: =item * authform_header
1.35 matthew 3017:
1.112 bowersj2 3018: =item * authform_authorwarning
1.35 matthew 3019:
1.112 bowersj2 3020: =item * authform_nochange
1.35 matthew 3021:
1.112 bowersj2 3022: =item * authform_kerberos
1.35 matthew 3023:
1.112 bowersj2 3024: =item * authform_internal
1.35 matthew 3025:
1.112 bowersj2 3026: =item * authform_filesystem
1.35 matthew 3027:
3028: =back
3029:
1.648 raeburn 3030: See loncreateuser.pm for invocation and use examples.
1.157 matthew 3031:
1.35 matthew 3032: =cut
3033:
3034: #-------------------------------------------
1.32 matthew 3035: sub authform_header{
3036: my %in = (
3037: formname => 'cu',
1.80 albertel 3038: kerb_def_dom => '',
1.32 matthew 3039: @_,
3040: );
3041: $in{'formname'} = 'document.' . $in{'formname'};
3042: my $result='';
1.80 albertel 3043:
3044: #---------------------------------------------- Code for upper case translation
3045: my $Javascript_toUpperCase;
3046: unless ($in{kerb_def_dom}) {
3047: $Javascript_toUpperCase =<<"END";
3048: switch (choice) {
3049: case 'krb': currentform.elements[choicearg].value =
3050: currentform.elements[choicearg].value.toUpperCase();
3051: break;
3052: default:
3053: }
3054: END
3055: } else {
3056: $Javascript_toUpperCase = "";
3057: }
3058:
1.165 raeburn 3059: my $radioval = "'nochange'";
1.591 raeburn 3060: if (defined($in{'curr_authtype'})) {
3061: if ($in{'curr_authtype'} ne '') {
3062: $radioval = "'".$in{'curr_authtype'}."arg'";
3063: }
1.174 matthew 3064: }
1.165 raeburn 3065: my $argfield = 'null';
1.591 raeburn 3066: if (defined($in{'mode'})) {
1.165 raeburn 3067: if ($in{'mode'} eq 'modifycourse') {
1.591 raeburn 3068: if (defined($in{'curr_autharg'})) {
3069: if ($in{'curr_autharg'} ne '') {
1.165 raeburn 3070: $argfield = "'$in{'curr_autharg'}'";
3071: }
3072: }
3073: }
3074: }
3075:
1.32 matthew 3076: $result.=<<"END";
3077: var current = new Object();
1.165 raeburn 3078: current.radiovalue = $radioval;
3079: current.argfield = $argfield;
1.32 matthew 3080:
3081: function changed_radio(choice,currentform) {
3082: var choicearg = choice + 'arg';
3083: // If a radio button in changed, we need to change the argfield
3084: if (current.radiovalue != choice) {
3085: current.radiovalue = choice;
3086: if (current.argfield != null) {
3087: currentform.elements[current.argfield].value = '';
3088: }
3089: if (choice == 'nochange') {
3090: current.argfield = null;
3091: } else {
3092: current.argfield = choicearg;
3093: switch(choice) {
3094: case 'krb':
3095: currentform.elements[current.argfield].value =
3096: "$in{'kerb_def_dom'}";
3097: break;
3098: default:
3099: break;
3100: }
3101: }
3102: }
3103: return;
3104: }
1.22 www 3105:
1.32 matthew 3106: function changed_text(choice,currentform) {
3107: var choicearg = choice + 'arg';
3108: if (currentform.elements[choicearg].value !='') {
1.80 albertel 3109: $Javascript_toUpperCase
1.32 matthew 3110: // clear old field
3111: if ((current.argfield != choicearg) && (current.argfield != null)) {
3112: currentform.elements[current.argfield].value = '';
3113: }
3114: current.argfield = choicearg;
3115: }
3116: set_auth_radio_buttons(choice,currentform);
3117: return;
1.20 www 3118: }
1.32 matthew 3119:
3120: function set_auth_radio_buttons(newvalue,currentform) {
1.986 raeburn 3121: var numauthchoices = currentform.login.length;
3122: if (typeof numauthchoices == "undefined") {
3123: return;
3124: }
1.32 matthew 3125: var i=0;
1.986 raeburn 3126: while (i < numauthchoices) {
1.32 matthew 3127: if (currentform.login[i].value == newvalue) { break; }
3128: i++;
3129: }
1.986 raeburn 3130: if (i == numauthchoices) {
1.32 matthew 3131: return;
3132: }
3133: current.radiovalue = newvalue;
3134: currentform.login[i].checked = true;
3135: return;
3136: }
3137: END
3138: return $result;
3139: }
3140:
1.1106 raeburn 3141: sub authform_authorwarning {
1.32 matthew 3142: my $result='';
1.144 matthew 3143: $result='<i>'.
3144: &mt('As a general rule, only authors or co-authors should be '.
3145: 'filesystem authenticated '.
3146: '(which allows access to the server filesystem).')."</i>\n";
1.32 matthew 3147: return $result;
3148: }
3149:
1.1106 raeburn 3150: sub authform_nochange {
1.32 matthew 3151: my %in = (
3152: formname => 'document.cu',
3153: kerb_def_dom => 'MSU.EDU',
3154: @_,
3155: );
1.1106 raeburn 3156: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.586 raeburn 3157: my $result;
1.1104 raeburn 3158: if (!$authnum) {
1.1105 raeburn 3159: $result = &mt('Under your current role you are not permitted to change login settings for this user');
1.586 raeburn 3160: } else {
3161: $result = '<label>'.&mt('[_1] Do not change login data',
3162: '<input type="radio" name="login" value="nochange" '.
3163: 'checked="checked" onclick="'.
1.281 albertel 3164: "javascript:changed_radio('nochange',$in{'formname'});".'" />').
3165: '</label>';
1.586 raeburn 3166: }
1.32 matthew 3167: return $result;
3168: }
3169:
1.591 raeburn 3170: sub authform_kerberos {
1.32 matthew 3171: my %in = (
3172: formname => 'document.cu',
3173: kerb_def_dom => 'MSU.EDU',
1.80 albertel 3174: kerb_def_auth => 'krb4',
1.32 matthew 3175: @_,
3176: );
1.586 raeburn 3177: my ($check4,$check5,$krbcheck,$krbarg,$krbver,$result,$authtype,
1.1259 raeburn 3178: $autharg,$jscall,$disabled);
1.1106 raeburn 3179: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.80 albertel 3180: if ($in{'kerb_def_auth'} eq 'krb5') {
1.772 bisitz 3181: $check5 = ' checked="checked"';
1.80 albertel 3182: } else {
1.772 bisitz 3183: $check4 = ' checked="checked"';
1.80 albertel 3184: }
1.1259 raeburn 3185: if ($in{'readonly'}) {
3186: $disabled = ' disabled="disabled"';
3187: }
1.165 raeburn 3188: $krbarg = $in{'kerb_def_dom'};
1.591 raeburn 3189: if (defined($in{'curr_authtype'})) {
3190: if ($in{'curr_authtype'} eq 'krb') {
1.772 bisitz 3191: $krbcheck = ' checked="checked"';
1.623 raeburn 3192: if (defined($in{'mode'})) {
3193: if ($in{'mode'} eq 'modifyuser') {
3194: $krbcheck = '';
3195: }
3196: }
1.591 raeburn 3197: if (defined($in{'curr_kerb_ver'})) {
3198: if ($in{'curr_krb_ver'} eq '5') {
1.772 bisitz 3199: $check5 = ' checked="checked"';
1.591 raeburn 3200: $check4 = '';
3201: } else {
1.772 bisitz 3202: $check4 = ' checked="checked"';
1.591 raeburn 3203: $check5 = '';
3204: }
1.586 raeburn 3205: }
1.591 raeburn 3206: if (defined($in{'curr_autharg'})) {
1.165 raeburn 3207: $krbarg = $in{'curr_autharg'};
3208: }
1.586 raeburn 3209: if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
1.591 raeburn 3210: if (defined($in{'curr_autharg'})) {
1.586 raeburn 3211: $result =
3212: &mt('Currently Kerberos authenticated with domain [_1] Version [_2].',
3213: $in{'curr_autharg'},$krbver);
3214: } else {
3215: $result =
3216: &mt('Currently Kerberos authenticated, Version [_1].',$krbver);
3217: }
3218: return $result;
3219: }
3220: }
3221: } else {
3222: if ($authnum == 1) {
1.784 bisitz 3223: $authtype = '<input type="hidden" name="login" value="krb" />';
1.165 raeburn 3224: }
3225: }
1.586 raeburn 3226: if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
3227: return;
1.587 raeburn 3228: } elsif ($authtype eq '') {
1.591 raeburn 3229: if (defined($in{'mode'})) {
1.587 raeburn 3230: if ($in{'mode'} eq 'modifycourse') {
3231: if ($authnum == 1) {
1.1259 raeburn 3232: $authtype = '<input type="radio" name="login" value="krb"'.$disabled.' />';
1.587 raeburn 3233: }
3234: }
3235: }
1.586 raeburn 3236: }
3237: $jscall = "javascript:changed_radio('krb',$in{'formname'});";
3238: if ($authtype eq '') {
3239: $authtype = '<input type="radio" name="login" value="krb" '.
3240: 'onclick="'.$jscall.'" onchange="'.$jscall.'"'.
1.1259 raeburn 3241: $krbcheck.$disabled.' />';
1.586 raeburn 3242: }
3243: if (($can_assign{'krb4'} && $can_assign{'krb5'}) ||
1.1106 raeburn 3244: ($can_assign{'krb4'} && !$can_assign{'krb5'} &&
1.586 raeburn 3245: $in{'curr_authtype'} eq 'krb5') ||
1.1106 raeburn 3246: (!$can_assign{'krb4'} && $can_assign{'krb5'} &&
1.586 raeburn 3247: $in{'curr_authtype'} eq 'krb4')) {
3248: $result .= &mt
1.144 matthew 3249: ('[_1] Kerberos authenticated with domain [_2] '.
1.281 albertel 3250: '[_3] Version 4 [_4] Version 5 [_5]',
1.586 raeburn 3251: '<label>'.$authtype,
1.281 albertel 3252: '</label><input type="text" size="10" name="krbarg" '.
1.165 raeburn 3253: 'value="'.$krbarg.'" '.
1.1259 raeburn 3254: 'onchange="'.$jscall.'"'.$disabled.' />',
3255: '<label><input type="radio" name="krbver" value="4" '.$check4.$disabled.' />',
3256: '</label><label><input type="radio" name="krbver" value="5" '.$check5.$disabled.' />',
1.281 albertel 3257: '</label>');
1.586 raeburn 3258: } elsif ($can_assign{'krb4'}) {
3259: $result .= &mt
3260: ('[_1] Kerberos authenticated with domain [_2] '.
3261: '[_3] Version 4 [_4]',
3262: '<label>'.$authtype,
3263: '</label><input type="text" size="10" name="krbarg" '.
3264: 'value="'.$krbarg.'" '.
1.1259 raeburn 3265: 'onchange="'.$jscall.'"'.$disabled.' />',
1.586 raeburn 3266: '<label><input type="hidden" name="krbver" value="4" />',
3267: '</label>');
3268: } elsif ($can_assign{'krb5'}) {
3269: $result .= &mt
3270: ('[_1] Kerberos authenticated with domain [_2] '.
3271: '[_3] Version 5 [_4]',
3272: '<label>'.$authtype,
3273: '</label><input type="text" size="10" name="krbarg" '.
3274: 'value="'.$krbarg.'" '.
1.1259 raeburn 3275: 'onchange="'.$jscall.'"'.$disabled.' />',
1.586 raeburn 3276: '<label><input type="hidden" name="krbver" value="5" />',
3277: '</label>');
3278: }
1.32 matthew 3279: return $result;
3280: }
3281:
1.1106 raeburn 3282: sub authform_internal {
1.586 raeburn 3283: my %in = (
1.32 matthew 3284: formname => 'document.cu',
3285: kerb_def_dom => 'MSU.EDU',
3286: @_,
3287: );
1.1259 raeburn 3288: my ($intcheck,$intarg,$result,$authtype,$autharg,$jscall,$disabled);
1.1106 raeburn 3289: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.1259 raeburn 3290: if ($in{'readonly'}) {
3291: $disabled = ' disabled="disabled"';
3292: }
1.591 raeburn 3293: if (defined($in{'curr_authtype'})) {
3294: if ($in{'curr_authtype'} eq 'int') {
1.586 raeburn 3295: if ($can_assign{'int'}) {
1.772 bisitz 3296: $intcheck = 'checked="checked" ';
1.623 raeburn 3297: if (defined($in{'mode'})) {
3298: if ($in{'mode'} eq 'modifyuser') {
3299: $intcheck = '';
3300: }
3301: }
1.591 raeburn 3302: if (defined($in{'curr_autharg'})) {
1.586 raeburn 3303: $intarg = $in{'curr_autharg'};
3304: }
3305: } else {
3306: $result = &mt('Currently internally authenticated.');
3307: return $result;
1.165 raeburn 3308: }
3309: }
1.586 raeburn 3310: } else {
3311: if ($authnum == 1) {
1.784 bisitz 3312: $authtype = '<input type="hidden" name="login" value="int" />';
1.586 raeburn 3313: }
3314: }
3315: if (!$can_assign{'int'}) {
3316: return;
1.587 raeburn 3317: } elsif ($authtype eq '') {
1.591 raeburn 3318: if (defined($in{'mode'})) {
1.587 raeburn 3319: if ($in{'mode'} eq 'modifycourse') {
3320: if ($authnum == 1) {
1.1259 raeburn 3321: $authtype = '<input type="radio" name="login" value="int"'.$disabled.' />';
1.587 raeburn 3322: }
3323: }
3324: }
1.165 raeburn 3325: }
1.586 raeburn 3326: $jscall = "javascript:changed_radio('int',$in{'formname'});";
3327: if ($authtype eq '') {
3328: $authtype = '<input type="radio" name="login" value="int" '.$intcheck.
1.1259 raeburn 3329: ' onchange="'.$jscall.'" onclick="'.$jscall.'"'.$disabled.' />';
1.586 raeburn 3330: }
1.605 bisitz 3331: $autharg = '<input type="password" size="10" name="intarg" value="'.
1.1259 raeburn 3332: $intarg.'" onchange="'.$jscall.'"'.$disabled.' />';
1.586 raeburn 3333: $result = &mt
1.144 matthew 3334: ('[_1] Internally authenticated (with initial password [_2])',
1.586 raeburn 3335: '<label>'.$authtype,'</label>'.$autharg);
1.1259 raeburn 3336: $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 3337: return $result;
3338: }
3339:
1.1104 raeburn 3340: sub authform_local {
1.32 matthew 3341: my %in = (
3342: formname => 'document.cu',
3343: kerb_def_dom => 'MSU.EDU',
3344: @_,
3345: );
1.1259 raeburn 3346: my ($loccheck,$locarg,$result,$authtype,$autharg,$jscall,$disabled);
1.1106 raeburn 3347: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.1259 raeburn 3348: if ($in{'readonly'}) {
3349: $disabled = ' disabled="disabled"';
3350: }
1.591 raeburn 3351: if (defined($in{'curr_authtype'})) {
3352: if ($in{'curr_authtype'} eq 'loc') {
1.586 raeburn 3353: if ($can_assign{'loc'}) {
1.772 bisitz 3354: $loccheck = 'checked="checked" ';
1.623 raeburn 3355: if (defined($in{'mode'})) {
3356: if ($in{'mode'} eq 'modifyuser') {
3357: $loccheck = '';
3358: }
3359: }
1.591 raeburn 3360: if (defined($in{'curr_autharg'})) {
1.586 raeburn 3361: $locarg = $in{'curr_autharg'};
3362: }
3363: } else {
3364: $result = &mt('Currently using local (institutional) authentication.');
3365: return $result;
1.165 raeburn 3366: }
3367: }
1.586 raeburn 3368: } else {
3369: if ($authnum == 1) {
1.784 bisitz 3370: $authtype = '<input type="hidden" name="login" value="loc" />';
1.586 raeburn 3371: }
3372: }
3373: if (!$can_assign{'loc'}) {
3374: return;
1.587 raeburn 3375: } elsif ($authtype eq '') {
1.591 raeburn 3376: if (defined($in{'mode'})) {
1.587 raeburn 3377: if ($in{'mode'} eq 'modifycourse') {
3378: if ($authnum == 1) {
1.1259 raeburn 3379: $authtype = '<input type="radio" name="login" value="loc"'.$disabled.' />';
1.587 raeburn 3380: }
3381: }
3382: }
1.165 raeburn 3383: }
1.586 raeburn 3384: $jscall = "javascript:changed_radio('loc',$in{'formname'});";
3385: if ($authtype eq '') {
3386: $authtype = '<input type="radio" name="login" value="loc" '.
3387: $loccheck.' onchange="'.$jscall.'" onclick="'.
1.1259 raeburn 3388: $jscall.'"'.$disabled.' />';
1.586 raeburn 3389: }
3390: $autharg = '<input type="text" size="10" name="locarg" value="'.
1.1259 raeburn 3391: $locarg.'" onchange="'.$jscall.'"'.$disabled.' />';
1.586 raeburn 3392: $result = &mt('[_1] Local Authentication with argument [_2]',
3393: '<label>'.$authtype,'</label>'.$autharg);
1.32 matthew 3394: return $result;
3395: }
3396:
1.1106 raeburn 3397: sub authform_filesystem {
1.32 matthew 3398: my %in = (
3399: formname => 'document.cu',
3400: kerb_def_dom => 'MSU.EDU',
3401: @_,
3402: );
1.1259 raeburn 3403: my ($fsyscheck,$result,$authtype,$autharg,$jscall,$disabled);
1.1106 raeburn 3404: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.1259 raeburn 3405: if ($in{'readonly'}) {
3406: $disabled = ' disabled="disabled"';
3407: }
1.591 raeburn 3408: if (defined($in{'curr_authtype'})) {
3409: if ($in{'curr_authtype'} eq 'fsys') {
1.586 raeburn 3410: if ($can_assign{'fsys'}) {
1.772 bisitz 3411: $fsyscheck = 'checked="checked" ';
1.623 raeburn 3412: if (defined($in{'mode'})) {
3413: if ($in{'mode'} eq 'modifyuser') {
3414: $fsyscheck = '';
3415: }
3416: }
1.586 raeburn 3417: } else {
3418: $result = &mt('Currently Filesystem Authenticated.');
3419: return $result;
1.1259 raeburn 3420: }
1.586 raeburn 3421: }
3422: } else {
3423: if ($authnum == 1) {
1.784 bisitz 3424: $authtype = '<input type="hidden" name="login" value="fsys" />';
1.586 raeburn 3425: }
3426: }
3427: if (!$can_assign{'fsys'}) {
3428: return;
1.587 raeburn 3429: } elsif ($authtype eq '') {
1.591 raeburn 3430: if (defined($in{'mode'})) {
1.587 raeburn 3431: if ($in{'mode'} eq 'modifycourse') {
3432: if ($authnum == 1) {
1.1259 raeburn 3433: $authtype = '<input type="radio" name="login" value="fsys"'.$disabled.' />';
1.587 raeburn 3434: }
3435: }
3436: }
1.586 raeburn 3437: }
3438: $jscall = "javascript:changed_radio('fsys',$in{'formname'});";
3439: if ($authtype eq '') {
3440: $authtype = '<input type="radio" name="login" value="fsys" '.
3441: $fsyscheck.' onchange="'.$jscall.'" onclick="'.
1.1259 raeburn 3442: $jscall.'"'.$disabled.' />';
1.586 raeburn 3443: }
3444: $autharg = '<input type="text" size="10" name="fsysarg" value=""'.
1.1259 raeburn 3445: ' onchange="'.$jscall.'"'.$disabled.' />';
1.586 raeburn 3446: $result = &mt
1.144 matthew 3447: ('[_1] Filesystem Authenticated (with initial password [_2])',
1.281 albertel 3448: '<label><input type="radio" name="login" value="fsys" '.
1.1259 raeburn 3449: $fsyscheck.'onchange="'.$jscall.'" onclick="'.$jscall.'"'.$disabled.' />',
1.605 bisitz 3450: '</label><input type="password" size="10" name="fsysarg" value="" '.
1.1259 raeburn 3451: 'onchange="'.$jscall.'"'.$disabled.' />');
1.32 matthew 3452: return $result;
3453: }
3454:
1.586 raeburn 3455: sub get_assignable_auth {
3456: my ($dom) = @_;
3457: if ($dom eq '') {
3458: $dom = $env{'request.role.domain'};
3459: }
3460: my %can_assign = (
3461: krb4 => 1,
3462: krb5 => 1,
3463: int => 1,
3464: loc => 1,
3465: );
3466: my %domconfig = &Apache::lonnet::get_dom('configuration',['usercreation'],$dom);
3467: if (ref($domconfig{'usercreation'}) eq 'HASH') {
3468: if (ref($domconfig{'usercreation'}{'authtypes'}) eq 'HASH') {
3469: my $authhash = $domconfig{'usercreation'}{'authtypes'};
3470: my $context;
3471: if ($env{'request.role'} =~ /^au/) {
3472: $context = 'author';
1.1259 raeburn 3473: } elsif ($env{'request.role'} =~ /^(dc|dh)/) {
1.586 raeburn 3474: $context = 'domain';
3475: } elsif ($env{'request.course.id'}) {
3476: $context = 'course';
3477: }
3478: if ($context) {
3479: if (ref($authhash->{$context}) eq 'HASH') {
3480: %can_assign = %{$authhash->{$context}};
3481: }
3482: }
3483: }
3484: }
3485: my $authnum = 0;
3486: foreach my $key (keys(%can_assign)) {
3487: if ($can_assign{$key}) {
3488: $authnum ++;
3489: }
3490: }
3491: if ($can_assign{'krb4'} && $can_assign{'krb5'}) {
3492: $authnum --;
3493: }
3494: return ($authnum,%can_assign);
3495: }
3496:
1.80 albertel 3497: ###############################################################
3498: ## Get Kerberos Defaults for Domain ##
3499: ###############################################################
3500: ##
3501: ## Returns default kerberos version and an associated argument
3502: ## as listed in file domain.tab. If not listed, provides
3503: ## appropriate default domain and kerberos version.
3504: ##
3505: #-------------------------------------------
3506:
3507: =pod
3508:
1.648 raeburn 3509: =item * &get_kerberos_defaults()
1.80 albertel 3510:
3511: get_kerberos_defaults($target_domain) returns the default kerberos
1.641 raeburn 3512: version and domain. If not found, it defaults to version 4 and the
3513: domain of the server.
1.80 albertel 3514:
1.648 raeburn 3515: =over 4
3516:
1.80 albertel 3517: ($def_version, $def_krb_domain) = &get_kerberos_defaults($target_domain);
3518:
1.648 raeburn 3519: =back
3520:
3521: =back
3522:
1.80 albertel 3523: =cut
3524:
3525: #-------------------------------------------
3526: sub get_kerberos_defaults {
3527: my $domain=shift;
1.641 raeburn 3528: my ($krbdef,$krbdefdom);
3529: my %domdefaults = &Apache::lonnet::get_domain_defaults($domain);
3530: if (($domdefaults{'auth_def'} =~/^krb(4|5)$/) && ($domdefaults{'auth_arg_def'} ne '')) {
3531: $krbdef = $domdefaults{'auth_def'};
3532: $krbdefdom = $domdefaults{'auth_arg_def'};
3533: } else {
1.80 albertel 3534: $ENV{'SERVER_NAME'}=~/(\w+\.\w+)$/;
3535: my $krbdefdom=$1;
3536: $krbdefdom=~tr/a-z/A-Z/;
3537: $krbdef = "krb4";
3538: }
3539: return ($krbdef,$krbdefdom);
3540: }
1.112 bowersj2 3541:
1.32 matthew 3542:
1.46 matthew 3543: ###############################################################
3544: ## Thesaurus Functions ##
3545: ###############################################################
1.20 www 3546:
1.46 matthew 3547: =pod
1.20 www 3548:
1.112 bowersj2 3549: =head1 Thesaurus Functions
3550:
3551: =over 4
3552:
1.648 raeburn 3553: =item * &initialize_keywords()
1.46 matthew 3554:
3555: Initializes the package variable %Keywords if it is empty. Uses the
3556: package variable $thesaurus_db_file.
3557:
3558: =cut
3559:
3560: ###################################################
3561:
3562: sub initialize_keywords {
3563: return 1 if (scalar keys(%Keywords));
3564: # If we are here, %Keywords is empty, so fill it up
3565: # Make sure the file we need exists...
3566: if (! -e $thesaurus_db_file) {
3567: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file".
3568: " failed because it does not exist");
3569: return 0;
3570: }
3571: # Set up the hash as a database
3572: my %thesaurus_db;
3573: if (! tie(%thesaurus_db,'GDBM_File',
1.53 albertel 3574: $thesaurus_db_file,&GDBM_READER(),0640)){
1.46 matthew 3575: &Apache::lonnet::logthis("Could not tie \%thesaurus_db to ".
3576: $thesaurus_db_file);
3577: return 0;
3578: }
3579: # Get the average number of appearances of a word.
3580: my $avecount = $thesaurus_db{'average.count'};
3581: # Put keywords (those that appear > average) into %Keywords
3582: while (my ($word,$data)=each (%thesaurus_db)) {
3583: my ($count,undef) = split /:/,$data;
3584: $Keywords{$word}++ if ($count > $avecount);
3585: }
3586: untie %thesaurus_db;
3587: # Remove special values from %Keywords.
1.356 albertel 3588: foreach my $value ('total.count','average.count') {
3589: delete($Keywords{$value}) if (exists($Keywords{$value}));
1.586 raeburn 3590: }
1.46 matthew 3591: return 1;
3592: }
3593:
3594: ###################################################
3595:
3596: =pod
3597:
1.648 raeburn 3598: =item * &keyword($word)
1.46 matthew 3599:
3600: Returns true if $word is a keyword. A keyword is a word that appears more
3601: than the average number of times in the thesaurus database. Calls
3602: &initialize_keywords
3603:
3604: =cut
3605:
3606: ###################################################
1.20 www 3607:
3608: sub keyword {
1.46 matthew 3609: return if (!&initialize_keywords());
3610: my $word=lc(shift());
3611: $word=~s/\W//g;
3612: return exists($Keywords{$word});
1.20 www 3613: }
1.46 matthew 3614:
3615: ###############################################################
3616:
3617: =pod
1.20 www 3618:
1.648 raeburn 3619: =item * &get_related_words()
1.46 matthew 3620:
1.160 matthew 3621: Look up a word in the thesaurus. Takes a scalar argument and returns
1.46 matthew 3622: an array of words. If the keyword is not in the thesaurus, an empty array
3623: will be returned. The order of the words returned is determined by the
3624: database which holds them.
3625:
3626: Uses global $thesaurus_db_file.
3627:
1.1057 foxr 3628:
1.46 matthew 3629: =cut
3630:
3631: ###############################################################
3632: sub get_related_words {
3633: my $keyword = shift;
3634: my %thesaurus_db;
3635: if (! -e $thesaurus_db_file) {
3636: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file ".
3637: "failed because the file does not exist");
3638: return ();
3639: }
3640: if (! tie(%thesaurus_db,'GDBM_File',
1.53 albertel 3641: $thesaurus_db_file,&GDBM_READER(),0640)){
1.46 matthew 3642: return ();
3643: }
3644: my @Words=();
1.429 www 3645: my $count=0;
1.46 matthew 3646: if (exists($thesaurus_db{$keyword})) {
1.356 albertel 3647: # The first element is the number of times
3648: # the word appears. We do not need it now.
1.429 www 3649: my (undef,@RelatedWords) = (split(/:/,$thesaurus_db{$keyword}));
3650: my (undef,$mostfrequentcount)=split(/\,/,$RelatedWords[0]);
3651: my $threshold=$mostfrequentcount/10;
3652: foreach my $possibleword (@RelatedWords) {
3653: my ($word,$wordcount)=split(/\,/,$possibleword);
3654: if ($wordcount>$threshold) {
3655: push(@Words,$word);
3656: $count++;
3657: if ($count>10) { last; }
3658: }
1.20 www 3659: }
3660: }
1.46 matthew 3661: untie %thesaurus_db;
3662: return @Words;
1.14 harris41 3663: }
1.1090 foxr 3664: ###############################################################
3665: #
3666: # Spell checking
3667: #
3668:
3669: =pod
3670:
1.1142 raeburn 3671: =back
3672:
1.1090 foxr 3673: =head1 Spell checking
3674:
3675: =over 4
3676:
3677: =item * &check_spelling($wordlist $language)
3678:
3679: Takes a string containing words and feeds it to an external
3680: spellcheck program via a pipeline. Returns a string containing
3681: them mis-spelled words.
3682:
3683: Parameters:
3684:
3685: =over 4
3686:
3687: =item - $wordlist
3688:
3689: String that will be fed into the spellcheck program.
3690:
3691: =item - $language
3692:
3693: Language string that specifies the language for which the spell
3694: check will be performed.
3695:
3696: =back
3697:
3698: =back
3699:
3700: Note: This sub assumes that aspell is installed.
3701:
3702:
3703: =cut
3704:
1.46 matthew 3705:
1.1090 foxr 3706: sub check_spelling {
3707: my ($wordlist, $language) = @_;
1.1091 foxr 3708: my @misspellings;
3709:
3710: # Generate the speller and set the langauge.
3711: # if explicitly selected:
1.1090 foxr 3712:
1.1091 foxr 3713: my $speller = Text::Aspell->new;
1.1090 foxr 3714: if ($language) {
1.1091 foxr 3715: $speller->set_option('lang', $language);
1.1090 foxr 3716: }
3717:
1.1091 foxr 3718: # Turn the word list into an array of words by splittingon whitespace
1.1090 foxr 3719:
1.1091 foxr 3720: my @words = split(/\s+/, $wordlist);
1.1090 foxr 3721:
1.1091 foxr 3722: foreach my $word (@words) {
3723: if(! $speller->check($word)) {
3724: push(@misspellings, $word);
1.1090 foxr 3725: }
3726: }
1.1091 foxr 3727: return join(' ', @misspellings);
3728:
1.1090 foxr 3729: }
3730:
1.61 www 3731: # -------------------------------------------------------------- Plaintext name
1.81 albertel 3732: =pod
3733:
1.112 bowersj2 3734: =head1 User Name Functions
3735:
3736: =over 4
3737:
1.648 raeburn 3738: =item * &plainname($uname,$udom,$first)
1.81 albertel 3739:
1.112 bowersj2 3740: Takes a users logon name and returns it as a string in
1.226 albertel 3741: "first middle last generation" form
3742: if $first is set to 'lastname' then it returns it as
3743: 'lastname generation, firstname middlename' if their is a lastname
1.81 albertel 3744:
3745: =cut
1.61 www 3746:
1.295 www 3747:
1.81 albertel 3748: ###############################################################
1.61 www 3749: sub plainname {
1.226 albertel 3750: my ($uname,$udom,$first)=@_;
1.537 albertel 3751: return if (!defined($uname) || !defined($udom));
1.295 www 3752: my %names=&getnames($uname,$udom);
1.226 albertel 3753: my $name=&Apache::lonnet::format_name($names{'firstname'},
3754: $names{'middlename'},
3755: $names{'lastname'},
3756: $names{'generation'},$first);
3757: $name=~s/^\s+//;
1.62 www 3758: $name=~s/\s+$//;
3759: $name=~s/\s+/ /g;
1.353 albertel 3760: if ($name !~ /\S/) { $name=$uname.':'.$udom; }
1.62 www 3761: return $name;
1.61 www 3762: }
1.66 www 3763:
3764: # -------------------------------------------------------------------- Nickname
1.81 albertel 3765: =pod
3766:
1.648 raeburn 3767: =item * &nickname($uname,$udom)
1.81 albertel 3768:
3769: Gets a users name and returns it as a string as
3770:
3771: ""nickname""
1.66 www 3772:
1.81 albertel 3773: if the user has a nickname or
3774:
3775: "first middle last generation"
3776:
3777: if the user does not
3778:
3779: =cut
1.66 www 3780:
3781: sub nickname {
3782: my ($uname,$udom)=@_;
1.537 albertel 3783: return if (!defined($uname) || !defined($udom));
1.295 www 3784: my %names=&getnames($uname,$udom);
1.68 albertel 3785: my $name=$names{'nickname'};
1.66 www 3786: if ($name) {
3787: $name='"'.$name.'"';
3788: } else {
3789: $name=$names{'firstname'}.' '.$names{'middlename'}.' '.
3790: $names{'lastname'}.' '.$names{'generation'};
3791: $name=~s/\s+$//;
3792: $name=~s/\s+/ /g;
3793: }
3794: return $name;
3795: }
3796:
1.295 www 3797: sub getnames {
3798: my ($uname,$udom)=@_;
1.537 albertel 3799: return if (!defined($uname) || !defined($udom));
1.433 albertel 3800: if ($udom eq 'public' && $uname eq 'public') {
3801: return ('lastname' => &mt('Public'));
3802: }
1.295 www 3803: my $id=$uname.':'.$udom;
3804: my ($names,$cached)=&Apache::lonnet::is_cached_new('namescache',$id);
3805: if ($cached) {
3806: return %{$names};
3807: } else {
3808: my %loadnames=&Apache::lonnet::get('environment',
3809: ['firstname','middlename','lastname','generation','nickname'],
3810: $udom,$uname);
3811: &Apache::lonnet::do_cache_new('namescache',$id,\%loadnames);
3812: return %loadnames;
3813: }
3814: }
1.61 www 3815:
1.542 raeburn 3816: # -------------------------------------------------------------------- getemails
1.648 raeburn 3817:
1.542 raeburn 3818: =pod
3819:
1.648 raeburn 3820: =item * &getemails($uname,$udom)
1.542 raeburn 3821:
3822: Gets a user's email information and returns it as a hash with keys:
3823: notification, critnotification, permanentemail
3824:
3825: For notification and critnotification, values are comma-separated lists
1.648 raeburn 3826: of e-mail addresses; for permanentemail, value is a single e-mail address.
1.542 raeburn 3827:
1.648 raeburn 3828:
1.542 raeburn 3829: =cut
3830:
1.648 raeburn 3831:
1.466 albertel 3832: sub getemails {
3833: my ($uname,$udom)=@_;
3834: if ($udom eq 'public' && $uname eq 'public') {
3835: return;
3836: }
1.467 www 3837: if (!$udom) { $udom=$env{'user.domain'}; }
3838: if (!$uname) { $uname=$env{'user.name'}; }
1.466 albertel 3839: my $id=$uname.':'.$udom;
3840: my ($names,$cached)=&Apache::lonnet::is_cached_new('emailscache',$id);
3841: if ($cached) {
3842: return %{$names};
3843: } else {
3844: my %loadnames=&Apache::lonnet::get('environment',
3845: ['notification','critnotification',
3846: 'permanentemail'],
3847: $udom,$uname);
3848: &Apache::lonnet::do_cache_new('emailscache',$id,\%loadnames);
3849: return %loadnames;
3850: }
3851: }
3852:
1.551 albertel 3853: sub flush_email_cache {
3854: my ($uname,$udom)=@_;
3855: if (!$udom) { $udom =$env{'user.domain'}; }
3856: if (!$uname) { $uname=$env{'user.name'}; }
3857: return if ($udom eq 'public' && $uname eq 'public');
3858: my $id=$uname.':'.$udom;
3859: &Apache::lonnet::devalidate_cache_new('emailscache',$id);
3860: }
3861:
1.728 raeburn 3862: # -------------------------------------------------------------------- getlangs
3863:
3864: =pod
3865:
3866: =item * &getlangs($uname,$udom)
3867:
3868: Gets a user's language preference and returns it as a hash with key:
3869: language.
3870:
3871: =cut
3872:
3873:
3874: sub getlangs {
3875: my ($uname,$udom) = @_;
3876: if (!$udom) { $udom =$env{'user.domain'}; }
3877: if (!$uname) { $uname=$env{'user.name'}; }
3878: my $id=$uname.':'.$udom;
3879: my ($langs,$cached)=&Apache::lonnet::is_cached_new('userlangs',$id);
3880: if ($cached) {
3881: return %{$langs};
3882: } else {
3883: my %loadlangs=&Apache::lonnet::get('environment',['languages'],
3884: $udom,$uname);
3885: &Apache::lonnet::do_cache_new('userlangs',$id,\%loadlangs);
3886: return %loadlangs;
3887: }
3888: }
3889:
3890: sub flush_langs_cache {
3891: my ($uname,$udom)=@_;
3892: if (!$udom) { $udom =$env{'user.domain'}; }
3893: if (!$uname) { $uname=$env{'user.name'}; }
3894: return if ($udom eq 'public' && $uname eq 'public');
3895: my $id=$uname.':'.$udom;
3896: &Apache::lonnet::devalidate_cache_new('userlangs',$id);
3897: }
3898:
1.61 www 3899: # ------------------------------------------------------------------ Screenname
1.81 albertel 3900:
3901: =pod
3902:
1.648 raeburn 3903: =item * &screenname($uname,$udom)
1.81 albertel 3904:
3905: Gets a users screenname and returns it as a string
3906:
3907: =cut
1.61 www 3908:
3909: sub screenname {
3910: my ($uname,$udom)=@_;
1.258 albertel 3911: if ($uname eq $env{'user.name'} &&
3912: $udom eq $env{'user.domain'}) {return $env{'environment.screenname'};}
1.212 albertel 3913: my %names=&Apache::lonnet::get('environment',['screenname'],$udom,$uname);
1.68 albertel 3914: return $names{'screenname'};
1.62 www 3915: }
3916:
1.212 albertel 3917:
1.802 bisitz 3918: # ------------------------------------------------------------- Confirm Wrapper
3919: =pod
3920:
1.1142 raeburn 3921: =item * &confirmwrapper($message)
1.802 bisitz 3922:
3923: Wrap messages about completion of operation in box
3924:
3925: =cut
3926:
3927: sub confirmwrapper {
3928: my ($message)=@_;
3929: if ($message) {
3930: return "\n".'<div class="LC_confirm_box">'."\n"
3931: .$message."\n"
3932: .'</div>'."\n";
3933: } else {
3934: return $message;
3935: }
3936: }
3937:
1.62 www 3938: # ------------------------------------------------------------- Message Wrapper
3939:
3940: sub messagewrapper {
1.369 www 3941: my ($link,$username,$domain,$subject,$text)=@_;
1.62 www 3942: return
1.441 albertel 3943: '<a href="/adm/email?compose=individual&'.
3944: 'recname='.$username.'&recdom='.$domain.
3945: '&subject='.&escape($subject).'&text='.&escape($text).'" '.
1.200 matthew 3946: 'title="'.&mt('Send message').'">'.$link.'</a>';
1.74 www 3947: }
1.802 bisitz 3948:
1.74 www 3949: # --------------------------------------------------------------- Notes Wrapper
3950:
3951: sub noteswrapper {
3952: my ($link,$un,$do)=@_;
3953: return
1.896 amueller 3954: "<a href='/adm/email?recordftf=retrieve&recname=$un&recdom=$do'>$link</a>";
1.62 www 3955: }
1.802 bisitz 3956:
1.62 www 3957: # ------------------------------------------------------------- Aboutme Wrapper
3958:
3959: sub aboutmewrapper {
1.1070 raeburn 3960: my ($link,$username,$domain,$target,$class)=@_;
1.447 raeburn 3961: if (!defined($username) && !defined($domain)) {
3962: return;
3963: }
1.1096 raeburn 3964: return '<a href="/adm/'.$domain.'/'.$username.'/aboutme"'.
1.1070 raeburn 3965: ($target?' target="'.$target.'"':'').($class?' class="'.$class.'"':'').' title="'.&mt("View this user's personal information page").'">'.$link.'</a>';
1.62 www 3966: }
3967:
3968: # ------------------------------------------------------------ Syllabus Wrapper
3969:
3970: sub syllabuswrapper {
1.707 bisitz 3971: my ($linktext,$coursedir,$domain)=@_;
1.208 matthew 3972: return qq{<a href="/public/$domain/$coursedir/syllabus">$linktext</a>};
1.61 www 3973: }
1.14 harris41 3974:
1.802 bisitz 3975: # -----------------------------------------------------------------------------
3976:
1.208 matthew 3977: sub track_student_link {
1.887 raeburn 3978: my ($linktext,$sname,$sdom,$target,$start,$only_body) = @_;
1.268 albertel 3979: my $link ="/adm/trackstudent?";
1.208 matthew 3980: my $title = 'View recent activity';
3981: if (defined($sname) && $sname !~ /^\s*$/ &&
3982: defined($sdom) && $sdom !~ /^\s*$/) {
1.268 albertel 3983: $link .= "selected_student=$sname:$sdom";
1.208 matthew 3984: $title .= ' of this student';
1.268 albertel 3985: }
1.208 matthew 3986: if (defined($target) && $target !~ /^\s*$/) {
3987: $target = qq{target="$target"};
3988: } else {
3989: $target = '';
3990: }
1.268 albertel 3991: if ($start) { $link.='&start='.$start; }
1.887 raeburn 3992: if ($only_body) { $link .= '&only_body=1'; }
1.554 albertel 3993: $title = &mt($title);
3994: $linktext = &mt($linktext);
1.448 albertel 3995: return qq{<a href="$link" title="$title" $target>$linktext</a>}.
3996: &help_open_topic('View_recent_activity');
1.208 matthew 3997: }
3998:
1.781 raeburn 3999: sub slot_reservations_link {
4000: my ($linktext,$sname,$sdom,$target) = @_;
4001: my $link ="/adm/slotrequest?command=showresv&origin=aboutme";
4002: my $title = 'View slot reservation history';
4003: if (defined($sname) && $sname !~ /^\s*$/ &&
4004: defined($sdom) && $sdom !~ /^\s*$/) {
4005: $link .= "&uname=$sname&udom=$sdom";
4006: $title .= ' of this student';
4007: }
4008: if (defined($target) && $target !~ /^\s*$/) {
4009: $target = qq{target="$target"};
4010: } else {
4011: $target = '';
4012: }
4013: $title = &mt($title);
4014: $linktext = &mt($linktext);
4015: return qq{<a href="$link" title="$title" $target>$linktext</a>};
4016: # FIXME uncomment when help item created: &help_open_topic('Slot_Reservation_History');
4017:
4018: }
4019:
1.508 www 4020: # ===================================================== Display a student photo
4021:
4022:
1.509 albertel 4023: sub student_image_tag {
1.508 www 4024: my ($domain,$user)=@_;
4025: my $imgsrc=&Apache::lonnet::studentphoto($domain,$user,'jpg');
4026: if (($imgsrc) && ($imgsrc ne '/adm/lonKaputt/lonlogo_broken.gif')) {
4027: return '<img src="'.$imgsrc.'" align="right" />';
4028: } else {
4029: return '';
4030: }
4031: }
4032:
1.112 bowersj2 4033: =pod
4034:
4035: =back
4036:
4037: =head1 Access .tab File Data
4038:
4039: =over 4
4040:
1.648 raeburn 4041: =item * &languageids()
1.112 bowersj2 4042:
4043: returns list of all language ids
4044:
4045: =cut
4046:
1.14 harris41 4047: sub languageids {
1.16 harris41 4048: return sort(keys(%language));
1.14 harris41 4049: }
4050:
1.112 bowersj2 4051: =pod
4052:
1.648 raeburn 4053: =item * &languagedescription()
1.112 bowersj2 4054:
4055: returns description of a specified language id
4056:
4057: =cut
4058:
1.14 harris41 4059: sub languagedescription {
1.125 www 4060: my $code=shift;
4061: return ($supported_language{$code}?'* ':'').
4062: $language{$code}.
1.126 www 4063: ($supported_language{$code}?' ('.&mt('interface available').')':'');
1.145 www 4064: }
4065:
1.1048 foxr 4066: =pod
4067:
4068: =item * &plainlanguagedescription
4069:
4070: Returns both the plain language description (e.g. 'Creoles and Pidgins, English-based (Other)')
4071: and the language character encoding (e.g. ISO) separated by a ' - ' string.
4072:
4073: =cut
4074:
1.145 www 4075: sub plainlanguagedescription {
4076: my $code=shift;
4077: return $language{$code};
4078: }
4079:
1.1048 foxr 4080: =pod
4081:
4082: =item * &supportedlanguagecode
4083:
4084: Returns the supported language code (e.g. sptutf maps to pt) given a language
4085: code.
4086:
4087: =cut
4088:
1.145 www 4089: sub supportedlanguagecode {
4090: my $code=shift;
4091: return $supported_language{$code};
1.97 www 4092: }
4093:
1.112 bowersj2 4094: =pod
4095:
1.1048 foxr 4096: =item * &latexlanguage()
4097:
4098: Given a language key code returns the correspondnig language to use
4099: to select the correct hyphenation on LaTeX printouts. This is undef if there
4100: is no supported hyphenation for the language code.
4101:
4102: =cut
4103:
4104: sub latexlanguage {
4105: my $code = shift;
4106: return $latex_language{$code};
4107: }
4108:
4109: =pod
4110:
4111: =item * &latexhyphenation()
4112:
4113: Same as above but what's supplied is the language as it might be stored
4114: in the metadata.
4115:
4116: =cut
4117:
4118: sub latexhyphenation {
4119: my $key = shift;
4120: return $latex_language_bykey{$key};
4121: }
4122:
4123: =pod
4124:
1.648 raeburn 4125: =item * ©rightids()
1.112 bowersj2 4126:
4127: returns list of all copyrights
4128:
4129: =cut
4130:
4131: sub copyrightids {
4132: return sort(keys(%cprtag));
4133: }
4134:
4135: =pod
4136:
1.648 raeburn 4137: =item * ©rightdescription()
1.112 bowersj2 4138:
4139: returns description of a specified copyright id
4140:
4141: =cut
4142:
4143: sub copyrightdescription {
1.166 www 4144: return &mt($cprtag{shift(@_)});
1.112 bowersj2 4145: }
1.197 matthew 4146:
4147: =pod
4148:
1.648 raeburn 4149: =item * &source_copyrightids()
1.192 taceyjo1 4150:
4151: returns list of all source copyrights
4152:
4153: =cut
4154:
4155: sub source_copyrightids {
4156: return sort(keys(%scprtag));
4157: }
4158:
4159: =pod
4160:
1.648 raeburn 4161: =item * &source_copyrightdescription()
1.192 taceyjo1 4162:
4163: returns description of a specified source copyright id
4164:
4165: =cut
4166:
4167: sub source_copyrightdescription {
4168: return &mt($scprtag{shift(@_)});
4169: }
1.112 bowersj2 4170:
4171: =pod
4172:
1.648 raeburn 4173: =item * &filecategories()
1.112 bowersj2 4174:
4175: returns list of all file categories
4176:
4177: =cut
4178:
4179: sub filecategories {
4180: return sort(keys(%category_extensions));
4181: }
4182:
4183: =pod
4184:
1.648 raeburn 4185: =item * &filecategorytypes()
1.112 bowersj2 4186:
4187: returns list of file types belonging to a given file
4188: category
4189:
4190: =cut
4191:
4192: sub filecategorytypes {
1.356 albertel 4193: my ($cat) = @_;
1.1248 raeburn 4194: if (ref($category_extensions{lc($cat)}) eq 'ARRAY') {
4195: return @{$category_extensions{lc($cat)}};
4196: } else {
4197: return ();
4198: }
1.112 bowersj2 4199: }
4200:
4201: =pod
4202:
1.648 raeburn 4203: =item * &fileembstyle()
1.112 bowersj2 4204:
4205: returns embedding style for a specified file type
4206:
4207: =cut
4208:
4209: sub fileembstyle {
4210: return $fe{lc(shift(@_))};
1.169 www 4211: }
4212:
1.351 www 4213: sub filemimetype {
4214: return $fm{lc(shift(@_))};
4215: }
4216:
1.169 www 4217:
4218: sub filecategoryselect {
4219: my ($name,$value)=@_;
1.189 matthew 4220: return &select_form($value,$name,
1.970 raeburn 4221: {'' => &mt('Any category'), map { $_,$_ } sort(keys(%category_extensions))});
1.112 bowersj2 4222: }
4223:
4224: =pod
4225:
1.648 raeburn 4226: =item * &filedescription()
1.112 bowersj2 4227:
4228: returns description for a specified file type
4229:
4230: =cut
4231:
4232: sub filedescription {
1.188 matthew 4233: my $file_description = $fd{lc(shift())};
4234: $file_description =~ s:([\[\]]):~$1:g;
4235: return &mt($file_description);
1.112 bowersj2 4236: }
4237:
4238: =pod
4239:
1.648 raeburn 4240: =item * &filedescriptionex()
1.112 bowersj2 4241:
4242: returns description for a specified file type with
4243: extra formatting
4244:
4245: =cut
4246:
4247: sub filedescriptionex {
4248: my $ex=shift;
1.188 matthew 4249: my $file_description = $fd{lc($ex)};
4250: $file_description =~ s:([\[\]]):~$1:g;
4251: return '.'.$ex.' '.&mt($file_description);
1.112 bowersj2 4252: }
4253:
4254: # End of .tab access
4255: =pod
4256:
4257: =back
4258:
4259: =cut
4260:
4261: # ------------------------------------------------------------------ File Types
4262: sub fileextensions {
4263: return sort(keys(%fe));
4264: }
4265:
1.97 www 4266: # ----------------------------------------------------------- Display Languages
4267: # returns a hash with all desired display languages
4268: #
4269:
4270: sub display_languages {
4271: my %languages=();
1.695 raeburn 4272: foreach my $lang (&Apache::lonlocal::preferred_languages()) {
1.356 albertel 4273: $languages{$lang}=1;
1.97 www 4274: }
4275: &get_unprocessed_cgi($ENV{'QUERY_STRING'},['displaylanguage']);
1.258 albertel 4276: if ($env{'form.displaylanguage'}) {
1.356 albertel 4277: foreach my $lang (split(/\s*(\,|\;|\:)\s*/,$env{'form.displaylanguage'})) {
4278: $languages{$lang}=1;
1.97 www 4279: }
4280: }
4281: return %languages;
1.14 harris41 4282: }
4283:
1.582 albertel 4284: sub languages {
4285: my ($possible_langs) = @_;
1.695 raeburn 4286: my @preferred_langs = &Apache::lonlocal::preferred_languages();
1.582 albertel 4287: if (!ref($possible_langs)) {
4288: if( wantarray ) {
4289: return @preferred_langs;
4290: } else {
4291: return $preferred_langs[0];
4292: }
4293: }
4294: my %possibilities = map { $_ => 1 } (@$possible_langs);
4295: my @preferred_possibilities;
4296: foreach my $preferred_lang (@preferred_langs) {
4297: if (exists($possibilities{$preferred_lang})) {
4298: push(@preferred_possibilities, $preferred_lang);
4299: }
4300: }
4301: if( wantarray ) {
4302: return @preferred_possibilities;
4303: }
4304: return $preferred_possibilities[0];
4305: }
4306:
1.742 raeburn 4307: sub user_lang {
4308: my ($touname,$toudom,$fromcid) = @_;
4309: my @userlangs;
4310: if (($fromcid ne '') && ($env{'course.'.$fromcid.'.languages'} ne '')) {
4311: @userlangs=(@userlangs,split(/\s*(\,|\;|\:)\s*/,
4312: $env{'course.'.$fromcid.'.languages'}));
4313: } else {
4314: my %langhash = &getlangs($touname,$toudom);
4315: if ($langhash{'languages'} ne '') {
4316: @userlangs = split(/\s*(\,|\;|\:)\s*/,$langhash{'languages'});
4317: } else {
4318: my %domdefs = &Apache::lonnet::get_domain_defaults($toudom);
4319: if ($domdefs{'lang_def'} ne '') {
4320: @userlangs = ($domdefs{'lang_def'});
4321: }
4322: }
4323: }
4324: my @languages=&Apache::lonlocal::get_genlanguages(@userlangs);
4325: my $user_lh = Apache::localize->get_handle(@languages);
4326: return $user_lh;
4327: }
4328:
4329:
1.112 bowersj2 4330: ###############################################################
4331: ## Student Answer Attempts ##
4332: ###############################################################
4333:
4334: =pod
4335:
4336: =head1 Alternate Problem Views
4337:
4338: =over 4
4339:
1.648 raeburn 4340: =item * &get_previous_attempt($symb, $username, $domain, $course,
1.1199 raeburn 4341: $getattempt, $regexp, $gradesub, $usec, $identifier)
1.112 bowersj2 4342:
4343: Return string with previous attempt on problem. Arguments:
4344:
4345: =over 4
4346:
4347: =item * $symb: Problem, including path
4348:
4349: =item * $username: username of the desired student
4350:
4351: =item * $domain: domain of the desired student
1.14 harris41 4352:
1.112 bowersj2 4353: =item * $course: Course ID
1.14 harris41 4354:
1.112 bowersj2 4355: =item * $getattempt: Leave blank for all attempts, otherwise put
4356: something
1.14 harris41 4357:
1.112 bowersj2 4358: =item * $regexp: if string matches this regexp, the string will be
4359: sent to $gradesub
1.14 harris41 4360:
1.112 bowersj2 4361: =item * $gradesub: routine that processes the string if it matches $regexp
1.14 harris41 4362:
1.1199 raeburn 4363: =item * $usec: section of the desired student
4364:
4365: =item * $identifier: counter for student (multiple students one problem) or
4366: problem (one student; whole sequence).
4367:
1.112 bowersj2 4368: =back
1.14 harris41 4369:
1.112 bowersj2 4370: The output string is a table containing all desired attempts, if any.
1.16 harris41 4371:
1.112 bowersj2 4372: =cut
1.1 albertel 4373:
4374: sub get_previous_attempt {
1.1199 raeburn 4375: my ($symb,$username,$domain,$course,$getattempt,$regexp,$gradesub,$usec,$identifier)=@_;
1.1 albertel 4376: my $prevattempts='';
1.43 ng 4377: no strict 'refs';
1.1 albertel 4378: if ($symb) {
1.3 albertel 4379: my (%returnhash)=
4380: &Apache::lonnet::restore($symb,$course,$domain,$username);
1.1 albertel 4381: if ($returnhash{'version'}) {
4382: my %lasthash=();
4383: my $version;
4384: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.1212 raeburn 4385: foreach my $key (reverse(sort(split(/\:/,$returnhash{$version.':keys'})))) {
4386: if ($key =~ /\.rawrndseed$/) {
4387: my ($id) = ($key =~ /^(.+)\.rawrndseed$/);
4388: $lasthash{$id.'.rndseed'} = $returnhash{$version.':'.$key};
4389: } else {
4390: $lasthash{$key}=$returnhash{$version.':'.$key};
4391: }
1.19 harris41 4392: }
1.1 albertel 4393: }
1.596 albertel 4394: $prevattempts=&start_data_table().&start_data_table_header_row();
4395: $prevattempts.='<th>'.&mt('History').'</th>';
1.1199 raeburn 4396: my (%typeparts,%lasthidden,%regraded,%hidestatus);
1.945 raeburn 4397: my $showsurv=&Apache::lonnet::allowed('vas',$env{'request.course.id'});
1.356 albertel 4398: foreach my $key (sort(keys(%lasthash))) {
4399: my ($ign,@parts) = split(/\./,$key);
1.41 ng 4400: if ($#parts > 0) {
1.31 albertel 4401: my $data=$parts[-1];
1.989 raeburn 4402: next if ($data eq 'foilorder');
1.31 albertel 4403: pop(@parts);
1.1010 www 4404: $prevattempts.='<th>'.&mt('Part ').join('.',@parts).'<br />'.$data.' </th>';
1.945 raeburn 4405: if ($data eq 'type') {
4406: unless ($showsurv) {
4407: my $id = join(',',@parts);
4408: $typeparts{$ign.'.'.$id} = $lasthash{$key};
1.978 raeburn 4409: if (($lasthash{$key} eq 'anonsurvey') || ($lasthash{$key} eq 'anonsurveycred')) {
4410: $lasthidden{$ign.'.'.$id} = 1;
4411: }
1.945 raeburn 4412: }
1.1199 raeburn 4413: if ($identifier ne '') {
4414: my $id = join(',',@parts);
4415: if (&Apache::lonnet::EXT("resource.$id.problemstatus",$symb,
4416: $domain,$username,$usec,undef,$course) =~ /^no/) {
4417: $hidestatus{$ign.'.'.$id} = 1;
4418: }
4419: }
4420: } elsif ($data eq 'regrader') {
4421: if (($identifier ne '') && (@parts)) {
1.1200 raeburn 4422: my $id = join(',',@parts);
4423: $regraded{$ign.'.'.$id} = 1;
1.1199 raeburn 4424: }
1.1010 www 4425: }
1.31 albertel 4426: } else {
1.41 ng 4427: if ($#parts == 0) {
4428: $prevattempts.='<th>'.$parts[0].'</th>';
4429: } else {
4430: $prevattempts.='<th>'.$ign.'</th>';
4431: }
1.31 albertel 4432: }
1.16 harris41 4433: }
1.596 albertel 4434: $prevattempts.=&end_data_table_header_row();
1.40 ng 4435: if ($getattempt eq '') {
1.1199 raeburn 4436: my (%solved,%resets,%probstatus);
1.1200 raeburn 4437: if (($identifier ne '') && (keys(%regraded) > 0)) {
4438: for ($version=1;$version<=$returnhash{'version'};$version++) {
4439: foreach my $id (keys(%regraded)) {
4440: if (($returnhash{$version.':'.$id.'.regrader'}) &&
4441: ($returnhash{$version.':'.$id.'.tries'} eq '') &&
4442: ($returnhash{$version.':'.$id.'.award'} eq '')) {
4443: push(@{$resets{$id}},$version);
1.1199 raeburn 4444: }
4445: }
4446: }
1.1200 raeburn 4447: }
4448: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.1199 raeburn 4449: my (@hidden,@unsolved);
1.945 raeburn 4450: if (%typeparts) {
4451: foreach my $id (keys(%typeparts)) {
1.1199 raeburn 4452: if (($returnhash{$version.':'.$id.'.type'} eq 'anonsurvey') ||
4453: ($returnhash{$version.':'.$id.'.type'} eq 'anonsurveycred')) {
1.945 raeburn 4454: push(@hidden,$id);
1.1199 raeburn 4455: } elsif ($identifier ne '') {
4456: unless (($returnhash{$version.':'.$id.'.type'} eq 'survey') ||
4457: ($returnhash{$version.':'.$id.'.type'} eq 'surveycred') ||
4458: ($hidestatus{$id})) {
1.1200 raeburn 4459: next if ((ref($resets{$id}) eq 'ARRAY') && grep(/^\Q$version\E$/,@{$resets{$id}}));
1.1199 raeburn 4460: if ($returnhash{$version.':'.$id.'.solved'} eq 'correct_by_student') {
4461: push(@{$solved{$id}},$version);
4462: } elsif (($returnhash{$version.':'.$id.'.solved'} ne '') &&
4463: (ref($solved{$id}) eq 'ARRAY')) {
4464: my $skip;
4465: if (ref($resets{$id}) eq 'ARRAY') {
4466: foreach my $reset (@{$resets{$id}}) {
4467: if ($reset > $solved{$id}[-1]) {
4468: $skip=1;
4469: last;
4470: }
4471: }
4472: }
4473: unless ($skip) {
4474: my ($ign,$partslist) = split(/\./,$id,2);
4475: push(@unsolved,$partslist);
4476: }
4477: }
4478: }
1.945 raeburn 4479: }
4480: }
4481: }
4482: $prevattempts.=&start_data_table_row().
1.1199 raeburn 4483: '<td>'.&mt('Transaction [_1]',$version);
4484: if (@unsolved) {
4485: $prevattempts .= '<span class="LC_nobreak"><label>'.
4486: '<input type="checkbox" name="HIDE'.$identifier.'" value="'.$version.':'.join('_',@unsolved).'" />'.
4487: &mt('Hide').'</label></span>';
4488: }
4489: $prevattempts .= '</td>';
1.945 raeburn 4490: if (@hidden) {
4491: foreach my $key (sort(keys(%lasthash))) {
1.989 raeburn 4492: next if ($key =~ /\.foilorder$/);
1.945 raeburn 4493: my $hide;
4494: foreach my $id (@hidden) {
4495: if ($key =~ /^\Q$id\E/) {
4496: $hide = 1;
4497: last;
4498: }
4499: }
4500: if ($hide) {
4501: my ($id,$data) = ($key =~ /^(.+)\.([^.]+)$/);
4502: if (($data eq 'award') || ($data eq 'awarddetail')) {
4503: my $value = &format_previous_attempt_value($key,
4504: $returnhash{$version.':'.$key});
1.1173 kruse 4505: $prevattempts.='<td>'.$value.' </td>';
1.945 raeburn 4506: } else {
4507: $prevattempts.='<td> </td>';
4508: }
4509: } else {
4510: if ($key =~ /\./) {
1.1212 raeburn 4511: my $value = $returnhash{$version.':'.$key};
4512: if ($key =~ /\.rndseed$/) {
4513: my ($id) = ($key =~ /^(.+)\.[^.]+$/);
4514: if (exists($returnhash{$version.':'.$id.'.rawrndseed'})) {
4515: $value = $returnhash{$version.':'.$id.'.rawrndseed'};
4516: }
4517: }
4518: $prevattempts.='<td>'.&format_previous_attempt_value($key,$value).
4519: ' </td>';
1.945 raeburn 4520: } else {
4521: $prevattempts.='<td> </td>';
4522: }
4523: }
4524: }
4525: } else {
4526: foreach my $key (sort(keys(%lasthash))) {
1.989 raeburn 4527: next if ($key =~ /\.foilorder$/);
1.1212 raeburn 4528: my $value = $returnhash{$version.':'.$key};
4529: if ($key =~ /\.rndseed$/) {
4530: my ($id) = ($key =~ /^(.+)\.[^.]+$/);
4531: if (exists($returnhash{$version.':'.$id.'.rawrndseed'})) {
4532: $value = $returnhash{$version.':'.$id.'.rawrndseed'};
4533: }
4534: }
4535: $prevattempts.='<td>'.&format_previous_attempt_value($key,$value).
4536: ' </td>';
1.945 raeburn 4537: }
4538: }
4539: $prevattempts.=&end_data_table_row();
1.40 ng 4540: }
1.1 albertel 4541: }
1.945 raeburn 4542: my @currhidden = keys(%lasthidden);
1.596 albertel 4543: $prevattempts.=&start_data_table_row().'<td>'.&mt('Current').'</td>';
1.356 albertel 4544: foreach my $key (sort(keys(%lasthash))) {
1.989 raeburn 4545: next if ($key =~ /\.foilorder$/);
1.945 raeburn 4546: if (%typeparts) {
4547: my $hidden;
4548: foreach my $id (@currhidden) {
4549: if ($key =~ /^\Q$id\E/) {
4550: $hidden = 1;
4551: last;
4552: }
4553: }
4554: if ($hidden) {
4555: my ($id,$data) = ($key =~ /^(.+)\.([^.]+)$/);
4556: if (($data eq 'award') || ($data eq 'awarddetail')) {
4557: my $value = &format_previous_attempt_value($key,$lasthash{$key});
4558: if ($key =~/$regexp$/ && (defined &$gradesub)) {
4559: $value = &$gradesub($value);
4560: }
1.1173 kruse 4561: $prevattempts.='<td>'. $value.' </td>';
1.945 raeburn 4562: } else {
4563: $prevattempts.='<td> </td>';
4564: }
4565: } else {
4566: my $value = &format_previous_attempt_value($key,$lasthash{$key});
4567: if ($key =~/$regexp$/ && (defined &$gradesub)) {
4568: $value = &$gradesub($value);
4569: }
1.1173 kruse 4570: $prevattempts.='<td>'.$value.' </td>';
1.945 raeburn 4571: }
4572: } else {
4573: my $value = &format_previous_attempt_value($key,$lasthash{$key});
4574: if ($key =~/$regexp$/ && (defined &$gradesub)) {
4575: $value = &$gradesub($value);
4576: }
1.1173 kruse 4577: $prevattempts.='<td>'.$value.' </td>';
1.945 raeburn 4578: }
1.16 harris41 4579: }
1.596 albertel 4580: $prevattempts.= &end_data_table_row().&end_data_table();
1.1 albertel 4581: } else {
1.1305 ! raeburn 4582: my $msg;
! 4583: if ($symb =~ /ext\.tool$/) {
! 4584: $msg = &mt('No grade passed back.');
! 4585: } else {
! 4586: $msg = &mt('Nothing submitted - no attempts.');
! 4587: }
1.596 albertel 4588: $prevattempts=
4589: &start_data_table().&start_data_table_row().
1.1305 ! raeburn 4590: '<td>'.$msg.'</td>'.
1.596 albertel 4591: &end_data_table_row().&end_data_table();
1.1 albertel 4592: }
4593: } else {
1.596 albertel 4594: $prevattempts=
4595: &start_data_table().&start_data_table_row().
4596: '<td>'.&mt('No data.').'</td>'.
4597: &end_data_table_row().&end_data_table();
1.1 albertel 4598: }
1.10 albertel 4599: }
4600:
1.581 albertel 4601: sub format_previous_attempt_value {
4602: my ($key,$value) = @_;
1.1011 www 4603: if (($key =~ /timestamp/) || ($key=~/duedate/)) {
1.1173 kruse 4604: $value = &Apache::lonlocal::locallocaltime($value);
1.581 albertel 4605: } elsif (ref($value) eq 'ARRAY') {
1.1173 kruse 4606: $value = &HTML::Entities::encode('('.join(', ', @{ $value }).')','"<>&');
1.988 raeburn 4607: } elsif ($key =~ /answerstring$/) {
4608: my %answers = &Apache::lonnet::str2hash($value);
1.1173 kruse 4609: my @answer = %answers;
4610: %answers = map {&HTML::Entities::encode($_, '"<>&')} @answer;
1.988 raeburn 4611: my @anskeys = sort(keys(%answers));
4612: if (@anskeys == 1) {
4613: my $answer = $answers{$anskeys[0]};
1.1001 raeburn 4614: if ($answer =~ m{\0}) {
4615: $answer =~ s{\0}{,}g;
1.988 raeburn 4616: }
4617: my $tag_internal_answer_name = 'INTERNAL';
4618: if ($anskeys[0] eq $tag_internal_answer_name) {
4619: $value = $answer;
4620: } else {
4621: $value = $anskeys[0].'='.$answer;
4622: }
4623: } else {
4624: foreach my $ans (@anskeys) {
4625: my $answer = $answers{$ans};
1.1001 raeburn 4626: if ($answer =~ m{\0}) {
4627: $answer =~ s{\0}{,}g;
1.988 raeburn 4628: }
4629: $value .= $ans.'='.$answer.'<br />';;
4630: }
4631: }
1.581 albertel 4632: } else {
1.1173 kruse 4633: $value = &HTML::Entities::encode(&unescape($value), '"<>&');
1.581 albertel 4634: }
4635: return $value;
4636: }
4637:
4638:
1.107 albertel 4639: sub relative_to_absolute {
4640: my ($url,$output)=@_;
4641: my $parser=HTML::TokeParser->new(\$output);
4642: my $token;
4643: my $thisdir=$url;
4644: my @rlinks=();
4645: while ($token=$parser->get_token) {
4646: if ($token->[0] eq 'S') {
4647: if ($token->[1] eq 'a') {
4648: if ($token->[2]->{'href'}) {
4649: $rlinks[$#rlinks+1]=$token->[2]->{'href'};
4650: }
4651: } elsif ($token->[1] eq 'img' || $token->[1] eq 'embed' ) {
4652: $rlinks[$#rlinks+1]=$token->[2]->{'src'};
4653: } elsif ($token->[1] eq 'base') {
4654: $thisdir=$token->[2]->{'href'};
4655: }
4656: }
4657: }
4658: $thisdir=~s-/[^/]*$--;
1.356 albertel 4659: foreach my $link (@rlinks) {
1.726 raeburn 4660: unless (($link=~/^https?\:\/\//i) ||
1.356 albertel 4661: ($link=~/^\//) ||
4662: ($link=~/^javascript:/i) ||
4663: ($link=~/^mailto:/i) ||
4664: ($link=~/^\#/)) {
4665: my $newlocation=&Apache::lonnet::hreflocation($thisdir,$link);
4666: $output=~s/(\"|\'|\=\s*)\Q$link\E(\"|\'|\s|\>)/$1$newlocation$2/;
1.107 albertel 4667: }
4668: }
4669: # -------------------------------------------------- Deal with Applet codebases
4670: $output=~s/(\<applet[^\>]+)(codebase\=[^\S\>]+)*([^\>]*)\>/$1.($2?$2:' codebase="'.$thisdir.'"').$3.'>'/gei;
4671: return $output;
4672: }
4673:
1.112 bowersj2 4674: =pod
4675:
1.648 raeburn 4676: =item * &get_student_view()
1.112 bowersj2 4677:
4678: show a snapshot of what student was looking at
4679:
4680: =cut
4681:
1.10 albertel 4682: sub get_student_view {
1.186 albertel 4683: my ($symb,$username,$domain,$courseid,$target,$moreenv) = @_;
1.114 www 4684: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186 albertel 4685: my (%form);
1.10 albertel 4686: my @elements=('symb','courseid','domain','username');
4687: foreach my $element (@elements) {
1.186 albertel 4688: $form{'grade_'.$element}=eval '$'.$element #'
1.10 albertel 4689: }
1.186 albertel 4690: if (defined($moreenv)) {
4691: %form=(%form,%{$moreenv});
4692: }
1.236 albertel 4693: if (defined($target)) { $form{'grade_target'} = $target; }
1.107 albertel 4694: $feedurl=&Apache::lonnet::clutter($feedurl);
1.650 www 4695: my ($userview,$response)=&Apache::lonnet::ssi_body($feedurl,%form);
1.11 albertel 4696: $userview=~s/\<body[^\>]*\>//gi;
4697: $userview=~s/\<\/body\>//gi;
4698: $userview=~s/\<html\>//gi;
4699: $userview=~s/\<\/html\>//gi;
4700: $userview=~s/\<head\>//gi;
4701: $userview=~s/\<\/head\>//gi;
4702: $userview=~s/action\s*\=/would_be_action\=/gi;
1.107 albertel 4703: $userview=&relative_to_absolute($feedurl,$userview);
1.650 www 4704: if (wantarray) {
4705: return ($userview,$response);
4706: } else {
4707: return $userview;
4708: }
4709: }
4710:
4711: sub get_student_view_with_retries {
4712: my ($symb,$retries,$username,$domain,$courseid,$target,$moreenv) = @_;
4713:
4714: my $ok = 0; # True if we got a good response.
4715: my $content;
4716: my $response;
4717:
4718: # Try to get the student_view done. within the retries count:
4719:
4720: do {
4721: ($content, $response) = &get_student_view($symb,$username,$domain,$courseid,$target,$moreenv);
4722: $ok = $response->is_success;
4723: if (!$ok) {
4724: &Apache::lonnet::logthis("Failed get_student_view_with_retries on $symb: ".$response->is_success.', '.$response->code.', '.$response->message);
4725: }
4726: $retries--;
4727: } while (!$ok && ($retries > 0));
4728:
4729: if (!$ok) {
4730: $content = ''; # On error return an empty content.
4731: }
1.651 www 4732: if (wantarray) {
4733: return ($content, $response);
4734: } else {
4735: return $content;
4736: }
1.11 albertel 4737: }
4738:
1.112 bowersj2 4739: =pod
4740:
1.648 raeburn 4741: =item * &get_student_answers()
1.112 bowersj2 4742:
4743: show a snapshot of how student was answering problem
4744:
4745: =cut
4746:
1.11 albertel 4747: sub get_student_answers {
1.100 sakharuk 4748: my ($symb,$username,$domain,$courseid,%form) = @_;
1.114 www 4749: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186 albertel 4750: my (%moreenv);
1.11 albertel 4751: my @elements=('symb','courseid','domain','username');
4752: foreach my $element (@elements) {
1.186 albertel 4753: $moreenv{'grade_'.$element}=eval '$'.$element #'
1.10 albertel 4754: }
1.186 albertel 4755: $moreenv{'grade_target'}='answer';
4756: %moreenv=(%form,%moreenv);
1.497 raeburn 4757: $feedurl = &Apache::lonnet::clutter($feedurl);
4758: my $userview=&Apache::lonnet::ssi($feedurl,%moreenv);
1.10 albertel 4759: return $userview;
1.1 albertel 4760: }
1.116 albertel 4761:
4762: =pod
4763:
4764: =item * &submlink()
4765:
1.242 albertel 4766: Inputs: $text $uname $udom $symb $target
1.116 albertel 4767:
4768: Returns: A link to grades.pm such as to see the SUBM view of a student
4769:
4770: =cut
4771:
4772: ###############################################
4773: sub submlink {
1.242 albertel 4774: my ($text,$uname,$udom,$symb,$target)=@_;
1.116 albertel 4775: if (!($uname && $udom)) {
4776: (my $cursymb, my $courseid,$udom,$uname)=
1.463 albertel 4777: &Apache::lonnet::whichuser($symb);
1.116 albertel 4778: if (!$symb) { $symb=$cursymb; }
4779: }
1.254 matthew 4780: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369 www 4781: $symb=&escape($symb);
1.960 bisitz 4782: if ($target) { $target=" target=\"$target\""; }
4783: return
4784: '<a href="/adm/grades?command=submission'.
4785: '&symb='.$symb.
4786: '&student='.$uname.
4787: '&userdom='.$udom.'"'.
4788: $target.'>'.$text.'</a>';
1.242 albertel 4789: }
4790: ##############################################
4791:
4792: =pod
4793:
4794: =item * &pgrdlink()
4795:
4796: Inputs: $text $uname $udom $symb $target
4797:
4798: Returns: A link to grades.pm such as to see the PGRD view of a student
4799:
4800: =cut
4801:
4802: ###############################################
4803: sub pgrdlink {
4804: my $link=&submlink(@_);
4805: $link=~s/(&command=submission)/$1&showgrading=yes/;
4806: return $link;
4807: }
4808: ##############################################
4809:
4810: =pod
4811:
4812: =item * &pprmlink()
4813:
4814: Inputs: $text $uname $udom $symb $target
4815:
4816: Returns: A link to parmset.pm such as to see the PPRM view of a
1.283 albertel 4817: student and a specific resource
1.242 albertel 4818:
4819: =cut
4820:
4821: ###############################################
4822: sub pprmlink {
4823: my ($text,$uname,$udom,$symb,$target)=@_;
4824: if (!($uname && $udom)) {
4825: (my $cursymb, my $courseid,$udom,$uname)=
1.463 albertel 4826: &Apache::lonnet::whichuser($symb);
1.242 albertel 4827: if (!$symb) { $symb=$cursymb; }
4828: }
1.254 matthew 4829: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369 www 4830: $symb=&escape($symb);
1.242 albertel 4831: if ($target) { $target="target=\"$target\""; }
1.595 albertel 4832: return '<a href="/adm/parmset?command=set&'.
4833: 'symb='.$symb.'&uname='.$uname.
4834: '&udom='.$udom.'" '.$target.'>'.$text.'</a>';
1.116 albertel 4835: }
4836: ##############################################
1.37 matthew 4837:
1.112 bowersj2 4838: =pod
4839:
4840: =back
4841:
4842: =cut
4843:
1.37 matthew 4844: ###############################################
1.51 www 4845:
4846:
4847: sub timehash {
1.687 raeburn 4848: my ($thistime) = @_;
4849: my $timezone = &Apache::lonlocal::gettimezone();
4850: my $dt = DateTime->from_epoch(epoch => $thistime)
4851: ->set_time_zone($timezone);
4852: my $wday = $dt->day_of_week();
4853: if ($wday == 7) { $wday = 0; }
4854: return ( 'second' => $dt->second(),
4855: 'minute' => $dt->minute(),
4856: 'hour' => $dt->hour(),
4857: 'day' => $dt->day_of_month(),
4858: 'month' => $dt->month(),
4859: 'year' => $dt->year(),
4860: 'weekday' => $wday,
4861: 'dayyear' => $dt->day_of_year(),
4862: 'dlsav' => $dt->is_dst() );
1.51 www 4863: }
4864:
1.370 www 4865: sub utc_string {
4866: my ($date)=@_;
1.371 www 4867: return strftime("%Y%m%dT%H%M%SZ",gmtime($date));
1.370 www 4868: }
4869:
1.51 www 4870: sub maketime {
4871: my %th=@_;
1.687 raeburn 4872: my ($epoch_time,$timezone,$dt);
4873: $timezone = &Apache::lonlocal::gettimezone();
4874: eval {
4875: $dt = DateTime->new( year => $th{'year'},
4876: month => $th{'month'},
4877: day => $th{'day'},
4878: hour => $th{'hour'},
4879: minute => $th{'minute'},
4880: second => $th{'second'},
4881: time_zone => $timezone,
4882: );
4883: };
4884: if (!$@) {
4885: $epoch_time = $dt->epoch;
4886: if ($epoch_time) {
4887: return $epoch_time;
4888: }
4889: }
1.51 www 4890: return POSIX::mktime(
4891: ($th{'seconds'},$th{'minutes'},$th{'hours'},
1.210 www 4892: $th{'day'},$th{'month'}-1,$th{'year'}-1900,0,0,-1));
1.70 www 4893: }
4894:
4895: #########################################
1.51 www 4896:
4897: sub findallcourses {
1.482 raeburn 4898: my ($roles,$uname,$udom) = @_;
1.355 albertel 4899: my %roles;
4900: if (ref($roles)) { %roles = map { $_ => 1 } @{$roles}; }
1.348 albertel 4901: my %courses;
1.51 www 4902: my $now=time;
1.482 raeburn 4903: if (!defined($uname)) {
4904: $uname = $env{'user.name'};
4905: }
4906: if (!defined($udom)) {
4907: $udom = $env{'user.domain'};
4908: }
4909: if (($uname ne $env{'user.name'}) || ($udom ne $env{'user.domain'})) {
1.1073 raeburn 4910: my %roleshash = &Apache::lonnet::dump('roles',$udom,$uname);
1.482 raeburn 4911: if (!%roles) {
4912: %roles = (
4913: cc => 1,
1.907 raeburn 4914: co => 1,
1.482 raeburn 4915: in => 1,
4916: ep => 1,
4917: ta => 1,
4918: cr => 1,
4919: st => 1,
4920: );
4921: }
4922: foreach my $entry (keys(%roleshash)) {
4923: my ($trole,$tend,$tstart) = split(/_/,$roleshash{$entry});
4924: if ($trole =~ /^cr/) {
4925: next if (!exists($roles{$trole}) && !exists($roles{'cr'}));
4926: } else {
4927: next if (!exists($roles{$trole}));
4928: }
4929: if ($tend) {
4930: next if ($tend < $now);
4931: }
4932: if ($tstart) {
4933: next if ($tstart > $now);
4934: }
1.1058 raeburn 4935: my ($cdom,$cnum,$sec,$cnumpart,$secpart,$role);
1.482 raeburn 4936: (undef,$cdom,$cnumpart,$secpart) = split(/\//,$entry);
1.1058 raeburn 4937: my $value = $trole.'/'.$cdom.'/';
1.482 raeburn 4938: if ($secpart eq '') {
4939: ($cnum,$role) = split(/_/,$cnumpart);
4940: $sec = 'none';
1.1058 raeburn 4941: $value .= $cnum.'/';
1.482 raeburn 4942: } else {
4943: $cnum = $cnumpart;
4944: ($sec,$role) = split(/_/,$secpart);
1.1058 raeburn 4945: $value .= $cnum.'/'.$sec;
4946: }
4947: if (ref($courses{$cdom.'_'.$cnum}{$sec}) eq 'ARRAY') {
4948: unless (grep(/^\Q$value\E$/,@{$courses{$cdom.'_'.$cnum}{$sec}})) {
4949: push(@{$courses{$cdom.'_'.$cnum}{$sec}},$value);
4950: }
4951: } else {
4952: @{$courses{$cdom.'_'.$cnum}{$sec}} = ($value);
1.490 raeburn 4953: }
1.482 raeburn 4954: }
4955: } else {
4956: foreach my $key (keys(%env)) {
1.483 albertel 4957: if ( $key=~m{^user\.role\.(\w+)\./($match_domain)/($match_courseid)/?(\w*)$} ||
4958: $key=~m{^user\.role\.(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_courseid)/?(\w*)$}) {
1.482 raeburn 4959: my ($role,$cdom,$cnum,$sec) = ($1,$2,$3,$4);
4960: next if ($role eq 'ca' || $role eq 'aa');
4961: next if (%roles && !exists($roles{$role}));
4962: my ($starttime,$endtime)=split(/\./,$env{$key});
4963: my $active=1;
4964: if ($starttime) {
4965: if ($now<$starttime) { $active=0; }
4966: }
4967: if ($endtime) {
4968: if ($now>$endtime) { $active=0; }
4969: }
4970: if ($active) {
1.1058 raeburn 4971: my $value = $role.'/'.$cdom.'/'.$cnum.'/';
1.482 raeburn 4972: if ($sec eq '') {
4973: $sec = 'none';
1.1058 raeburn 4974: } else {
4975: $value .= $sec;
4976: }
4977: if (ref($courses{$cdom.'_'.$cnum}{$sec}) eq 'ARRAY') {
4978: unless (grep(/^\Q$value\E$/,@{$courses{$cdom.'_'.$cnum}{$sec}})) {
4979: push(@{$courses{$cdom.'_'.$cnum}{$sec}},$value);
4980: }
4981: } else {
4982: @{$courses{$cdom.'_'.$cnum}{$sec}} = ($value);
1.482 raeburn 4983: }
1.474 raeburn 4984: }
4985: }
1.51 www 4986: }
4987: }
1.474 raeburn 4988: return %courses;
1.51 www 4989: }
1.37 matthew 4990:
1.54 www 4991: ###############################################
1.474 raeburn 4992:
4993: sub blockcheck {
1.1189 raeburn 4994: my ($setters,$activity,$uname,$udom,$url,$is_course) = @_;
1.490 raeburn 4995:
1.1189 raeburn 4996: if (defined($udom) && defined($uname)) {
4997: # If uname and udom are for a course, check for blocks in the course.
4998: if (($is_course) || (&Apache::lonnet::is_course($udom,$uname))) {
4999: my ($startblock,$endblock,$triggerblock) =
5000: &get_blocks($setters,$activity,$udom,$uname,$url);
5001: return ($startblock,$endblock,$triggerblock);
5002: }
5003: } else {
1.490 raeburn 5004: $udom = $env{'user.domain'};
5005: $uname = $env{'user.name'};
5006: }
5007:
1.502 raeburn 5008: my $startblock = 0;
5009: my $endblock = 0;
1.1062 raeburn 5010: my $triggerblock = '';
1.482 raeburn 5011: my %live_courses = &findallcourses(undef,$uname,$udom);
1.474 raeburn 5012:
1.490 raeburn 5013: # If uname is for a user, and activity is course-specific, i.e.,
5014: # boards, chat or groups, check for blocking in current course only.
1.474 raeburn 5015:
1.490 raeburn 5016: if (($activity eq 'boards' || $activity eq 'chat' ||
1.1282 raeburn 5017: $activity eq 'groups' || $activity eq 'printout' ||
5018: $activity eq 'reinit' || $activity eq 'alert') &&
1.1189 raeburn 5019: ($env{'request.course.id'})) {
1.490 raeburn 5020: foreach my $key (keys(%live_courses)) {
5021: if ($key ne $env{'request.course.id'}) {
5022: delete($live_courses{$key});
5023: }
5024: }
5025: }
5026:
5027: my $otheruser = 0;
5028: my %own_courses;
5029: if ((($uname ne $env{'user.name'})) || ($udom ne $env{'user.domain'})) {
5030: # Resource belongs to user other than current user.
5031: $otheruser = 1;
5032: # Gather courses for current user
5033: %own_courses =
5034: &findallcourses(undef,$env{'user.name'},$env{'user.domain'});
5035: }
5036:
5037: # Gather active course roles - course coordinator, instructor,
5038: # exam proctor, ta, student, or custom role.
1.474 raeburn 5039:
5040: foreach my $course (keys(%live_courses)) {
1.482 raeburn 5041: my ($cdom,$cnum);
5042: if ((defined($env{'course.'.$course.'.domain'})) && (defined($env{'course.'.$course.'.num'}))) {
5043: $cdom = $env{'course.'.$course.'.domain'};
5044: $cnum = $env{'course.'.$course.'.num'};
5045: } else {
1.490 raeburn 5046: ($cdom,$cnum) = split(/_/,$course);
1.482 raeburn 5047: }
5048: my $no_ownblock = 0;
5049: my $no_userblock = 0;
1.533 raeburn 5050: if ($otheruser && $activity ne 'com') {
1.490 raeburn 5051: # Check if current user has 'evb' priv for this
5052: if (defined($own_courses{$course})) {
5053: foreach my $sec (keys(%{$own_courses{$course}})) {
5054: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
5055: if ($sec ne 'none') {
5056: $checkrole .= '/'.$sec;
5057: }
5058: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
5059: $no_ownblock = 1;
5060: last;
5061: }
5062: }
5063: }
5064: # if they have 'evb' priv and are currently not playing student
5065: next if (($no_ownblock) &&
5066: ($env{'request.role'} !~ m{^st\./$cdom/$cnum}));
5067: }
1.474 raeburn 5068: foreach my $sec (keys(%{$live_courses{$course}})) {
1.482 raeburn 5069: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
1.474 raeburn 5070: if ($sec ne 'none') {
1.482 raeburn 5071: $checkrole .= '/'.$sec;
1.474 raeburn 5072: }
1.490 raeburn 5073: if ($otheruser) {
5074: # Resource belongs to user other than current user.
5075: # Assemble privs for that user, and check for 'evb' priv.
1.1058 raeburn 5076: my (%allroles,%userroles);
5077: if (ref($live_courses{$course}{$sec}) eq 'ARRAY') {
5078: foreach my $entry (@{$live_courses{$course}{$sec}}) {
5079: my ($trole,$tdom,$tnum,$tsec);
5080: if ($entry =~ /^cr/) {
5081: ($trole,$tdom,$tnum,$tsec) =
5082: ($entry =~ m|^(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_username)/?(\w*)$|);
5083: } else {
5084: ($trole,$tdom,$tnum,$tsec) = split(/\//,$entry);
5085: }
5086: my ($spec,$area,$trest);
5087: $area = '/'.$tdom.'/'.$tnum;
5088: $trest = $tnum;
5089: if ($tsec ne '') {
5090: $area .= '/'.$tsec;
5091: $trest .= '/'.$tsec;
5092: }
5093: $spec = $trole.'.'.$area;
5094: if ($trole =~ /^cr/) {
5095: &Apache::lonnet::custom_roleprivs(\%allroles,$trole,
5096: $tdom,$spec,$trest,$area);
5097: } else {
5098: &Apache::lonnet::standard_roleprivs(\%allroles,$trole,
5099: $tdom,$spec,$trest,$area);
5100: }
5101: }
1.1276 raeburn 5102: my ($author,$adv,$rar) = &Apache::lonnet::set_userprivs(\%userroles,\%allroles);
1.1058 raeburn 5103: if ($userroles{'user.priv.'.$checkrole} =~ /evb\&([^\:]*)/) {
5104: if ($1) {
5105: $no_userblock = 1;
5106: last;
5107: }
1.486 raeburn 5108: }
5109: }
1.490 raeburn 5110: } else {
5111: # Resource belongs to current user
5112: # Check for 'evb' priv via lonnet::allowed().
1.482 raeburn 5113: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
5114: $no_ownblock = 1;
5115: last;
5116: }
1.474 raeburn 5117: }
5118: }
5119: # if they have the evb priv and are currently not playing student
1.482 raeburn 5120: next if (($no_ownblock) &&
1.491 albertel 5121: ($env{'request.role'} !~ m{^st\./\Q$cdom\E/\Q$cnum\E}));
1.482 raeburn 5122: next if ($no_userblock);
1.474 raeburn 5123:
1.1303 raeburn 5124: # Retrieve blocking times and identity of blocker for course
1.490 raeburn 5125: # of specified user, unless user has 'evb' privilege.
1.1284 raeburn 5126:
1.1062 raeburn 5127: my ($start,$end,$trigger) =
5128: &get_blocks($setters,$activity,$cdom,$cnum,$url);
1.502 raeburn 5129: if (($start != 0) &&
5130: (($startblock == 0) || ($startblock > $start))) {
5131: $startblock = $start;
1.1062 raeburn 5132: if ($trigger ne '') {
5133: $triggerblock = $trigger;
5134: }
1.502 raeburn 5135: }
5136: if (($end != 0) &&
5137: (($endblock == 0) || ($endblock < $end))) {
5138: $endblock = $end;
1.1062 raeburn 5139: if ($trigger ne '') {
5140: $triggerblock = $trigger;
5141: }
1.502 raeburn 5142: }
1.490 raeburn 5143: }
1.1062 raeburn 5144: return ($startblock,$endblock,$triggerblock);
1.490 raeburn 5145: }
5146:
5147: sub get_blocks {
1.1062 raeburn 5148: my ($setters,$activity,$cdom,$cnum,$url) = @_;
1.490 raeburn 5149: my $startblock = 0;
5150: my $endblock = 0;
1.1062 raeburn 5151: my $triggerblock = '';
1.490 raeburn 5152: my $course = $cdom.'_'.$cnum;
5153: $setters->{$course} = {};
5154: $setters->{$course}{'staff'} = [];
5155: $setters->{$course}{'times'} = [];
1.1062 raeburn 5156: $setters->{$course}{'triggers'} = [];
5157: my (@blockers,%triggered);
5158: my $now = time;
5159: my %commblocks = &Apache::lonnet::get_comm_blocks($cdom,$cnum);
5160: if ($activity eq 'docs') {
5161: @blockers = &Apache::lonnet::has_comm_blocking('bre',undef,$url,\%commblocks);
5162: foreach my $block (@blockers) {
5163: if ($block =~ /^firstaccess____(.+)$/) {
5164: my $item = $1;
5165: my $type = 'map';
5166: my $timersymb = $item;
5167: if ($item eq 'course') {
5168: $type = 'course';
5169: } elsif ($item =~ /___\d+___/) {
5170: $type = 'resource';
5171: } else {
5172: $timersymb = &Apache::lonnet::symbread($item);
5173: }
5174: my $start = $env{'course.'.$cdom.'_'.$cnum.'.firstaccess.'.$timersymb};
5175: my $end = $start + $env{'course.'.$cdom.'_'.$cnum.'.timerinterval.'.$timersymb};
5176: $triggered{$block} = {
5177: start => $start,
5178: end => $end,
5179: type => $type,
5180: };
5181: }
5182: }
5183: } else {
5184: foreach my $block (keys(%commblocks)) {
5185: if ($block =~ m/^(\d+)____(\d+)$/) {
5186: my ($start,$end) = ($1,$2);
5187: if ($start <= time && $end >= time) {
5188: if (ref($commblocks{$block}) eq 'HASH') {
5189: if (ref($commblocks{$block}{'blocks'}) eq 'HASH') {
5190: if ($commblocks{$block}{'blocks'}{$activity} eq 'on') {
5191: unless(grep(/^\Q$block\E$/,@blockers)) {
5192: push(@blockers,$block);
5193: }
5194: }
5195: }
5196: }
5197: }
5198: } elsif ($block =~ /^firstaccess____(.+)$/) {
5199: my $item = $1;
5200: my $timersymb = $item;
5201: my $type = 'map';
5202: if ($item eq 'course') {
5203: $type = 'course';
5204: } elsif ($item =~ /___\d+___/) {
5205: $type = 'resource';
5206: } else {
5207: $timersymb = &Apache::lonnet::symbread($item);
5208: }
5209: my $start = $env{'course.'.$cdom.'_'.$cnum.'.firstaccess.'.$timersymb};
5210: my $end = $start + $env{'course.'.$cdom.'_'.$cnum.'.timerinterval.'.$timersymb};
5211: if ($start && $end) {
5212: if (($start <= time) && ($end >= time)) {
1.1281 raeburn 5213: if (ref($commblocks{$block}) eq 'HASH') {
5214: if (ref($commblocks{$block}{'blocks'}) eq 'HASH') {
5215: if ($commblocks{$block}{'blocks'}{$activity} eq 'on') {
5216: unless(grep(/^\Q$block\E$/,@blockers)) {
5217: push(@blockers,$block);
5218: $triggered{$block} = {
5219: start => $start,
5220: end => $end,
5221: type => $type,
5222: };
5223: }
5224: }
5225: }
1.1062 raeburn 5226: }
5227: }
1.490 raeburn 5228: }
1.1062 raeburn 5229: }
5230: }
5231: }
5232: foreach my $blocker (@blockers) {
5233: my ($staff_name,$staff_dom,$title,$blocks) =
5234: &parse_block_record($commblocks{$blocker});
5235: push(@{$$setters{$course}{'staff'}},[$staff_name,$staff_dom]);
5236: my ($start,$end,$triggertype);
5237: if ($blocker =~ m/^(\d+)____(\d+)$/) {
5238: ($start,$end) = ($1,$2);
5239: } elsif (ref($triggered{$blocker}) eq 'HASH') {
5240: $start = $triggered{$blocker}{'start'};
5241: $end = $triggered{$blocker}{'end'};
5242: $triggertype = $triggered{$blocker}{'type'};
5243: }
5244: if ($start) {
5245: push(@{$$setters{$course}{'times'}}, [$start,$end]);
5246: if ($triggertype) {
5247: push(@{$$setters{$course}{'triggers'}},$triggertype);
5248: } else {
5249: push(@{$$setters{$course}{'triggers'}},0);
5250: }
5251: if ( ($startblock == 0) || ($startblock > $start) ) {
5252: $startblock = $start;
5253: if ($triggertype) {
5254: $triggerblock = $blocker;
1.474 raeburn 5255: }
5256: }
1.1062 raeburn 5257: if ( ($endblock == 0) || ($endblock < $end) ) {
5258: $endblock = $end;
5259: if ($triggertype) {
5260: $triggerblock = $blocker;
5261: }
5262: }
1.474 raeburn 5263: }
5264: }
1.1062 raeburn 5265: return ($startblock,$endblock,$triggerblock);
1.474 raeburn 5266: }
5267:
5268: sub parse_block_record {
5269: my ($record) = @_;
5270: my ($setuname,$setudom,$title,$blocks);
5271: if (ref($record) eq 'HASH') {
5272: ($setuname,$setudom) = split(/:/,$record->{'setter'});
5273: $title = &unescape($record->{'event'});
5274: $blocks = $record->{'blocks'};
5275: } else {
5276: my @data = split(/:/,$record,3);
5277: if (scalar(@data) eq 2) {
5278: $title = $data[1];
5279: ($setuname,$setudom) = split(/@/,$data[0]);
5280: } else {
5281: ($setuname,$setudom,$title) = @data;
5282: }
5283: $blocks = { 'com' => 'on' };
5284: }
5285: return ($setuname,$setudom,$title,$blocks);
5286: }
5287:
1.854 kalberla 5288: sub blocking_status {
1.1189 raeburn 5289: my ($activity,$uname,$udom,$url,$is_course) = @_;
1.1061 raeburn 5290: my %setters;
1.890 droeschl 5291:
1.1061 raeburn 5292: # check for active blocking
1.1062 raeburn 5293: my ($startblock,$endblock,$triggerblock) =
1.1189 raeburn 5294: &blockcheck(\%setters,$activity,$uname,$udom,$url,$is_course);
1.1062 raeburn 5295: my $blocked = 0;
5296: if ($startblock && $endblock) {
5297: $blocked = 1;
5298: }
1.890 droeschl 5299:
1.1061 raeburn 5300: # caller just wants to know whether a block is active
5301: if (!wantarray) { return $blocked; }
5302:
5303: # build a link to a popup window containing the details
5304: my $querystring = "?activity=$activity";
5305: # $uname and $udom decide whose portfolio the user is trying to look at
1.1232 raeburn 5306: if (($activity eq 'port') || ($activity eq 'passwd')) {
5307: $querystring .= "&udom=$udom" if ($udom =~ /^$match_domain$/);
5308: $querystring .= "&uname=$uname" if ($uname =~ /^$match_username$/);
1.1062 raeburn 5309: } elsif ($activity eq 'docs') {
5310: $querystring .= '&url='.&HTML::Entities::encode($url,'&"');
5311: }
1.1061 raeburn 5312:
5313: my $output .= <<'END_MYBLOCK';
5314: function openWindow(url, wdwName, w, h, toolbar,scrollbar) {
5315: var options = "width=" + w + ",height=" + h + ",";
5316: options += "resizable=yes,scrollbars="+scrollbar+",status=no,";
5317: options += "menubar=no,toolbar="+toolbar+",location=no,directories=no";
5318: var newWin = window.open(url, wdwName, options);
5319: newWin.focus();
5320: }
1.890 droeschl 5321: END_MYBLOCK
1.854 kalberla 5322:
1.1061 raeburn 5323: $output = Apache::lonhtmlcommon::scripttag($output);
1.890 droeschl 5324:
1.1061 raeburn 5325: my $popupUrl = "/adm/blockingstatus/$querystring";
1.1062 raeburn 5326: my $text = &mt('Communication Blocked');
1.1217 raeburn 5327: my $class = 'LC_comblock';
1.1062 raeburn 5328: if ($activity eq 'docs') {
5329: $text = &mt('Content Access Blocked');
1.1217 raeburn 5330: $class = '';
1.1063 raeburn 5331: } elsif ($activity eq 'printout') {
5332: $text = &mt('Printing Blocked');
1.1232 raeburn 5333: } elsif ($activity eq 'passwd') {
5334: $text = &mt('Password Changing Blocked');
1.1282 raeburn 5335: } elsif ($activity eq 'alert') {
5336: $text = &mt('Checking Critical Messages Blocked');
5337: } elsif ($activity eq 'reinit') {
5338: $text = &mt('Checking Course Update Blocked');
1.1062 raeburn 5339: }
1.1061 raeburn 5340: $output .= <<"END_BLOCK";
1.1217 raeburn 5341: <div class='$class'>
1.869 kalberla 5342: <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring'
1.890 droeschl 5343: title='$text'>
5344: <img class='LC_noBorder LC_middle' title='$text' src='/res/adm/pages/comblock.png' alt='$text'/></a>
1.869 kalberla 5345: <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring'
1.890 droeschl 5346: title='$text'>$text</a>
1.867 kalberla 5347: </div>
5348:
5349: END_BLOCK
1.474 raeburn 5350:
1.1061 raeburn 5351: return ($blocked, $output);
1.854 kalberla 5352: }
1.490 raeburn 5353:
1.60 matthew 5354: ###############################################
5355:
1.682 raeburn 5356: sub check_ip_acc {
1.1201 raeburn 5357: my ($acc,$clientip)=@_;
1.682 raeburn 5358: &Apache::lonxml::debug("acc is $acc");
5359: if (!defined($acc) || $acc =~ /^\s*$/ || $acc =~/^\s*no\s*$/i) {
5360: return 1;
5361: }
1.1219 raeburn 5362: my $allowed;
1.1252 raeburn 5363: my $ip=$ENV{'REMOTE_ADDR'} || $clientip || $env{'request.host'};
1.682 raeburn 5364:
5365: my $name;
1.1219 raeburn 5366: my %access = (
5367: allowfrom => 1,
5368: denyfrom => 0,
5369: );
5370: my @allows;
5371: my @denies;
5372: foreach my $item (split(',',$acc)) {
5373: $item =~ s/^\s*//;
5374: $item =~ s/\s*$//;
5375: my $pattern;
5376: if ($item =~ /^\!(.+)$/) {
5377: push(@denies,$1);
5378: } else {
5379: push(@allows,$item);
5380: }
5381: }
5382: my $numdenies = scalar(@denies);
5383: my $numallows = scalar(@allows);
5384: my $count = 0;
5385: foreach my $pattern (@denies,@allows) {
5386: $count ++;
5387: my $acctype = 'allowfrom';
5388: if ($count <= $numdenies) {
5389: $acctype = 'denyfrom';
5390: }
1.682 raeburn 5391: if ($pattern =~ /\*$/) {
5392: #35.8.*
5393: $pattern=~s/\*//;
1.1219 raeburn 5394: if ($ip =~ /^\Q$pattern\E/) { $allowed=$access{$acctype}; }
1.682 raeburn 5395: } elsif ($pattern =~ /(\d+\.\d+\.\d+)\.\[(\d+)-(\d+)\]$/) {
5396: #35.8.3.[34-56]
5397: my $low=$2;
5398: my $high=$3;
5399: $pattern=$1;
5400: if ($ip =~ /^\Q$pattern\E/) {
5401: my $last=(split(/\./,$ip))[3];
1.1219 raeburn 5402: if ($last <=$high && $last >=$low) { $allowed=$access{$acctype}; }
1.682 raeburn 5403: }
5404: } elsif ($pattern =~ /^\*/) {
5405: #*.msu.edu
5406: $pattern=~s/\*//;
5407: if (!defined($name)) {
5408: use Socket;
5409: my $netaddr=inet_aton($ip);
5410: ($name)=gethostbyaddr($netaddr,AF_INET);
5411: }
1.1219 raeburn 5412: if ($name =~ /\Q$pattern\E$/i) { $allowed=$access{$acctype}; }
1.682 raeburn 5413: } elsif ($pattern =~ /\d+\.\d+\.\d+\.\d+/) {
5414: #127.0.0.1
1.1219 raeburn 5415: if ($ip =~ /^\Q$pattern\E/) { $allowed=$access{$acctype}; }
1.682 raeburn 5416: } else {
5417: #some.name.com
5418: if (!defined($name)) {
5419: use Socket;
5420: my $netaddr=inet_aton($ip);
5421: ($name)=gethostbyaddr($netaddr,AF_INET);
5422: }
1.1219 raeburn 5423: if ($name =~ /\Q$pattern\E$/i) { $allowed=$access{$acctype}; }
5424: }
5425: if ($allowed =~ /^(0|1)$/) { last; }
5426: }
5427: if ($allowed eq '') {
5428: if ($numdenies && !$numallows) {
5429: $allowed = 1;
5430: } else {
5431: $allowed = 0;
1.682 raeburn 5432: }
5433: }
5434: return $allowed;
5435: }
5436:
5437: ###############################################
5438:
1.60 matthew 5439: =pod
5440:
1.112 bowersj2 5441: =head1 Domain Template Functions
5442:
5443: =over 4
5444:
5445: =item * &determinedomain()
1.60 matthew 5446:
5447: Inputs: $domain (usually will be undef)
5448:
1.63 www 5449: Returns: Determines which domain should be used for designs
1.60 matthew 5450:
5451: =cut
1.54 www 5452:
1.60 matthew 5453: ###############################################
1.63 www 5454: sub determinedomain {
5455: my $domain=shift;
1.531 albertel 5456: if (! $domain) {
1.60 matthew 5457: # Determine domain if we have not been given one
1.893 raeburn 5458: $domain = &Apache::lonnet::default_login_domain();
1.258 albertel 5459: if ($env{'user.domain'}) { $domain=$env{'user.domain'}; }
5460: if ($env{'request.role.domain'}) {
5461: $domain=$env{'request.role.domain'};
1.60 matthew 5462: }
5463: }
1.63 www 5464: return $domain;
5465: }
5466: ###############################################
1.517 raeburn 5467:
1.518 albertel 5468: sub devalidate_domconfig_cache {
5469: my ($udom)=@_;
5470: &Apache::lonnet::devalidate_cache_new('domainconfig',$udom);
5471: }
5472:
5473: # ---------------------- Get domain configuration for a domain
5474: sub get_domainconf {
5475: my ($udom) = @_;
5476: my $cachetime=1800;
5477: my ($result,$cached)=&Apache::lonnet::is_cached_new('domainconfig',$udom);
5478: if (defined($cached)) { return %{$result}; }
5479:
5480: my %domconfig = &Apache::lonnet::get_dom('configuration',
1.948 raeburn 5481: ['login','rolecolors','autoenroll'],$udom);
1.632 raeburn 5482: my (%designhash,%legacy);
1.518 albertel 5483: if (keys(%domconfig) > 0) {
5484: if (ref($domconfig{'login'}) eq 'HASH') {
1.632 raeburn 5485: if (keys(%{$domconfig{'login'}})) {
5486: foreach my $key (keys(%{$domconfig{'login'}})) {
1.699 raeburn 5487: if (ref($domconfig{'login'}{$key}) eq 'HASH') {
1.1208 raeburn 5488: if (($key eq 'loginvia') || ($key eq 'headtag')) {
5489: if (ref($domconfig{'login'}{$key}) eq 'HASH') {
5490: foreach my $hostname (keys(%{$domconfig{'login'}{$key}})) {
5491: if (ref($domconfig{'login'}{$key}{$hostname}) eq 'HASH') {
5492: if ($key eq 'loginvia') {
5493: if ($domconfig{'login'}{'loginvia'}{$hostname}{'server'}) {
5494: my $server = $domconfig{'login'}{'loginvia'}{$hostname}{'server'};
5495: $designhash{$udom.'.login.loginvia'} = $server;
5496: if ($domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'} eq 'custom') {
5497:
5498: $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'custompath'};
5499: } else {
5500: $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'};
5501: }
1.948 raeburn 5502: }
1.1208 raeburn 5503: } elsif ($key eq 'headtag') {
5504: if ($domconfig{'login'}{'headtag'}{$hostname}{'url'}) {
5505: $designhash{$udom.'.login.headtag_'.$hostname} = $domconfig{'login'}{'headtag'}{$hostname}{'url'};
1.948 raeburn 5506: }
1.946 raeburn 5507: }
1.1208 raeburn 5508: if ($domconfig{'login'}{$key}{$hostname}{'exempt'}) {
5509: $designhash{$udom.'.login.'.$key.'_exempt_'.$hostname} = $domconfig{'login'}{$key}{$hostname}{'exempt'};
5510: }
1.946 raeburn 5511: }
5512: }
5513: }
5514: } else {
5515: foreach my $img (keys(%{$domconfig{'login'}{$key}})) {
5516: $designhash{$udom.'.login.'.$key.'_'.$img} =
5517: $domconfig{'login'}{$key}{$img};
5518: }
1.699 raeburn 5519: }
5520: } else {
5521: $designhash{$udom.'.login.'.$key}=$domconfig{'login'}{$key};
5522: }
1.632 raeburn 5523: }
5524: } else {
5525: $legacy{'login'} = 1;
1.518 albertel 5526: }
1.632 raeburn 5527: } else {
5528: $legacy{'login'} = 1;
1.518 albertel 5529: }
5530: if (ref($domconfig{'rolecolors'}) eq 'HASH') {
1.632 raeburn 5531: if (keys(%{$domconfig{'rolecolors'}})) {
5532: foreach my $role (keys(%{$domconfig{'rolecolors'}})) {
5533: if (ref($domconfig{'rolecolors'}{$role}) eq 'HASH') {
5534: foreach my $item (keys(%{$domconfig{'rolecolors'}{$role}})) {
5535: $designhash{$udom.'.'.$role.'.'.$item}=$domconfig{'rolecolors'}{$role}{$item};
5536: }
1.518 albertel 5537: }
5538: }
1.632 raeburn 5539: } else {
5540: $legacy{'rolecolors'} = 1;
1.518 albertel 5541: }
1.632 raeburn 5542: } else {
5543: $legacy{'rolecolors'} = 1;
1.518 albertel 5544: }
1.948 raeburn 5545: if (ref($domconfig{'autoenroll'}) eq 'HASH') {
5546: if ($domconfig{'autoenroll'}{'co-owners'}) {
5547: $designhash{$udom.'.autoassign.co-owners'}=$domconfig{'autoenroll'}{'co-owners'};
5548: }
5549: }
1.632 raeburn 5550: if (keys(%legacy) > 0) {
5551: my %legacyhash = &get_legacy_domconf($udom);
5552: foreach my $item (keys(%legacyhash)) {
5553: if ($item =~ /^\Q$udom\E\.login/) {
5554: if ($legacy{'login'}) {
5555: $designhash{$item} = $legacyhash{$item};
5556: }
5557: } else {
5558: if ($legacy{'rolecolors'}) {
5559: $designhash{$item} = $legacyhash{$item};
5560: }
1.518 albertel 5561: }
5562: }
5563: }
1.632 raeburn 5564: } else {
5565: %designhash = &get_legacy_domconf($udom);
1.518 albertel 5566: }
5567: &Apache::lonnet::do_cache_new('domainconfig',$udom,\%designhash,
5568: $cachetime);
5569: return %designhash;
5570: }
5571:
1.632 raeburn 5572: sub get_legacy_domconf {
5573: my ($udom) = @_;
5574: my %legacyhash;
5575: my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
5576: my $designfile = $designdir.'/'.$udom.'.tab';
5577: if (-e $designfile) {
5578: if ( open (my $fh,"<$designfile") ) {
5579: while (my $line = <$fh>) {
5580: next if ($line =~ /^\#/);
5581: chomp($line);
5582: my ($key,$val)=(split(/\=/,$line));
5583: if ($val) { $legacyhash{$udom.'.'.$key}=$val; }
5584: }
5585: close($fh);
5586: }
5587: }
1.1026 raeburn 5588: if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/adm/lonDomLogos/'.$udom.'.gif') {
1.632 raeburn 5589: $legacyhash{$udom.'.login.domlogo'} = "/adm/lonDomLogos/$udom.gif";
5590: }
5591: return %legacyhash;
5592: }
5593:
1.63 www 5594: =pod
5595:
1.112 bowersj2 5596: =item * &domainlogo()
1.63 www 5597:
5598: Inputs: $domain (usually will be undef)
5599:
5600: Returns: A link to a domain logo, if the domain logo exists.
5601: If the domain logo does not exist, a description of the domain.
5602:
5603: =cut
1.112 bowersj2 5604:
1.63 www 5605: ###############################################
5606: sub domainlogo {
1.517 raeburn 5607: my $domain = &determinedomain(shift);
1.518 albertel 5608: my %designhash = &get_domainconf($domain);
1.517 raeburn 5609: # See if there is a logo
5610: if ($designhash{$domain.'.login.domlogo'} ne '') {
1.519 raeburn 5611: my $imgsrc = $designhash{$domain.'.login.domlogo'};
1.538 albertel 5612: if ($imgsrc =~ m{^/(adm|res)/}) {
5613: if ($imgsrc =~ m{^/res/}) {
5614: my $local_name = &Apache::lonnet::filelocation('',$imgsrc);
5615: &Apache::lonnet::repcopy($local_name);
5616: }
5617: $imgsrc = &lonhttpdurl($imgsrc);
1.519 raeburn 5618: }
5619: return '<img src="'.$imgsrc.'" alt="'.$domain.'" />';
1.514 albertel 5620: } elsif (defined(&Apache::lonnet::domain($domain,'description'))) {
5621: return &Apache::lonnet::domain($domain,'description');
1.59 www 5622: } else {
1.60 matthew 5623: return '';
1.59 www 5624: }
5625: }
1.63 www 5626: ##############################################
5627:
5628: =pod
5629:
1.112 bowersj2 5630: =item * &designparm()
1.63 www 5631:
5632: Inputs: $which parameter; $domain (usually will be undef)
5633:
5634: Returns: value of designparamter $which
5635:
5636: =cut
1.112 bowersj2 5637:
1.397 albertel 5638:
1.400 albertel 5639: ##############################################
1.397 albertel 5640: sub designparm {
5641: my ($which,$domain)=@_;
5642: if (exists($env{'environment.color.'.$which})) {
1.817 bisitz 5643: return $env{'environment.color.'.$which};
1.96 www 5644: }
1.63 www 5645: $domain=&determinedomain($domain);
1.1016 raeburn 5646: my %domdesign;
5647: unless ($domain eq 'public') {
5648: %domdesign = &get_domainconf($domain);
5649: }
1.520 raeburn 5650: my $output;
1.517 raeburn 5651: if ($domdesign{$domain.'.'.$which} ne '') {
1.817 bisitz 5652: $output = $domdesign{$domain.'.'.$which};
1.63 www 5653: } else {
1.520 raeburn 5654: $output = $defaultdesign{$which};
5655: }
5656: if (($which =~ /^(student|coordinator|author|admin)\.img$/) ||
1.635 raeburn 5657: ($which =~ /login\.(img|logo|domlogo|login)/)) {
1.538 albertel 5658: if ($output =~ m{^/(adm|res)/}) {
1.817 bisitz 5659: if ($output =~ m{^/res/}) {
5660: my $local_name = &Apache::lonnet::filelocation('',$output);
5661: &Apache::lonnet::repcopy($local_name);
5662: }
1.520 raeburn 5663: $output = &lonhttpdurl($output);
5664: }
1.63 www 5665: }
1.520 raeburn 5666: return $output;
1.63 www 5667: }
1.59 www 5668:
1.822 bisitz 5669: ##############################################
5670: =pod
5671:
1.832 bisitz 5672: =item * &authorspace()
5673:
1.1028 raeburn 5674: Inputs: $url (usually will be undef).
1.832 bisitz 5675:
1.1132 raeburn 5676: Returns: Path to Authoring Space containing the resource or
1.1028 raeburn 5677: directory being viewed (or for which action is being taken).
5678: If $url is provided, and begins /priv/<domain>/<uname>
5679: the path will be that portion of the $context argument.
5680: Otherwise the path will be for the author space of the current
5681: user when the current role is author, or for that of the
5682: co-author/assistant co-author space when the current role
5683: is co-author or assistant co-author.
1.832 bisitz 5684:
5685: =cut
5686:
5687: sub authorspace {
1.1028 raeburn 5688: my ($url) = @_;
5689: if ($url ne '') {
5690: if ($url =~ m{^(/priv/$match_domain/$match_username/)}) {
5691: return $1;
5692: }
5693: }
1.832 bisitz 5694: my $caname = '';
1.1024 www 5695: my $cadom = '';
1.1028 raeburn 5696: if ($env{'request.role'} =~ /^(?:ca|aa)/) {
1.1024 www 5697: ($cadom,$caname) =
1.832 bisitz 5698: ($env{'request.role'}=~/($match_domain)\/($match_username)$/);
1.1028 raeburn 5699: } elsif ($env{'request.role'} =~ m{^au\./($match_domain)/}) {
1.832 bisitz 5700: $caname = $env{'user.name'};
1.1024 www 5701: $cadom = $env{'user.domain'};
1.832 bisitz 5702: }
1.1028 raeburn 5703: if (($caname ne '') && ($cadom ne '')) {
5704: return "/priv/$cadom/$caname/";
5705: }
5706: return;
1.832 bisitz 5707: }
5708:
5709: ##############################################
5710: =pod
5711:
1.822 bisitz 5712: =item * &head_subbox()
5713:
5714: Inputs: $content (contains HTML code with page functions, etc.)
5715:
5716: Returns: HTML div with $content
5717: To be included in page header
5718:
5719: =cut
5720:
5721: sub head_subbox {
5722: my ($content)=@_;
5723: my $output =
1.993 raeburn 5724: '<div class="LC_head_subbox">'
1.822 bisitz 5725: .$content
5726: .'</div>'
5727: }
5728:
5729: ##############################################
5730: =pod
5731:
5732: =item * &CSTR_pageheader()
5733:
1.1026 raeburn 5734: Input: (optional) filename from which breadcrumb trail is built.
5735: In most cases no input as needed, as $env{'request.filename'}
5736: is appropriate for use in building the breadcrumb trail.
1.822 bisitz 5737:
5738: Returns: HTML div with CSTR path and recent box
1.1132 raeburn 5739: To be included on Authoring Space pages
1.822 bisitz 5740:
5741: =cut
5742:
5743: sub CSTR_pageheader {
1.1026 raeburn 5744: my ($trailfile) = @_;
5745: if ($trailfile eq '') {
5746: $trailfile = $env{'request.filename'};
5747: }
5748:
5749: # this is for resources; directories have customtitle, and crumbs
5750: # and select recent are created in lonpubdir.pm
5751:
5752: my $londocroot = $Apache::lonnet::perlvar{'lonDocRoot'};
1.1022 www 5753: my ($udom,$uname,$thisdisfn)=
1.1113 raeburn 5754: ($trailfile =~ m{^\Q$londocroot\E/priv/([^/]+)/([^/]+)(?:|/(.*))$});
1.1026 raeburn 5755: my $formaction = "/priv/$udom/$uname/$thisdisfn";
5756: $formaction =~ s{/+}{/}g;
1.822 bisitz 5757:
5758: my $parentpath = '';
5759: my $lastitem = '';
5760: if ($thisdisfn =~ m-(.+/)([^/]*)$-) {
5761: $parentpath = $1;
5762: $lastitem = $2;
5763: } else {
5764: $lastitem = $thisdisfn;
5765: }
1.921 bisitz 5766:
1.1246 raeburn 5767: my ($crsauthor,$title);
5768: if (($env{'request.course.id'}) &&
5769: ($env{'course.'.$env{'request.course.id'}.'.num'} eq $uname) &&
1.1247 raeburn 5770: ($env{'course.'.$env{'request.course.id'}.'.domain'} eq $udom)) {
1.1246 raeburn 5771: $crsauthor = 1;
5772: $title = &mt('Course Authoring Space');
5773: } else {
5774: $title = &mt('Authoring Space');
5775: }
5776:
1.921 bisitz 5777: my $output =
1.822 bisitz 5778: '<div>'
5779: .&Apache::loncommon::help_open_menu('','',3,'Authoring') #FIXME: Broken? Where is it?
1.1246 raeburn 5780: .'<b>'.$title.'</b> '
1.822 bisitz 5781: .'<form name="dirs" method="post" action="'.$formaction
1.921 bisitz 5782: .'" target="_top">' #FIXME lonpubdir: target="_parent"
1.1024 www 5783: .&Apache::lonhtmlcommon::crumbs($uname.'/'.$parentpath,'_top','/priv/'.$udom,undef,undef);
1.921 bisitz 5784:
5785: if ($lastitem) {
5786: $output .=
5787: '<span class="LC_filename">'
5788: .$lastitem
5789: .'</span>';
5790: }
1.1245 raeburn 5791:
1.1246 raeburn 5792: if ($crsauthor) {
5793: $output .= '</form>'.&Apache::lonmenu::constspaceform();
5794: } else {
5795: $output .=
5796: '<br />'
5797: #FIXME lonpubdir: &Apache::lonhtmlcommon::crumbs($uname.$thisdisfn.'/','_top','/priv','','+1',1)."</b></tt><br />"
5798: .&Apache::lonhtmlcommon::select_recent('construct','recent','this.form.action=this.form.recent.value;this.form.submit()')
5799: .'</form>'
5800: .&Apache::lonmenu::constspaceform();
5801: }
5802: $output .= '</div>';
1.921 bisitz 5803:
5804: return $output;
1.822 bisitz 5805: }
5806:
1.60 matthew 5807: ###############################################
5808: ###############################################
5809:
5810: =pod
5811:
1.112 bowersj2 5812: =back
5813:
1.549 albertel 5814: =head1 HTML Helpers
1.112 bowersj2 5815:
5816: =over 4
5817:
5818: =item * &bodytag()
1.60 matthew 5819:
5820: Returns a uniform header for LON-CAPA web pages.
5821:
5822: Inputs:
5823:
1.112 bowersj2 5824: =over 4
5825:
5826: =item * $title, A title to be displayed on the page.
5827:
5828: =item * $function, the current role (can be undef).
5829:
5830: =item * $addentries, extra parameters for the <body> tag.
5831:
5832: =item * $bodyonly, if defined, only return the <body> tag.
5833:
5834: =item * $domain, if defined, force a given domain.
5835:
5836: =item * $forcereg, if page should register as content page (relevant for
1.86 www 5837: text interface only)
1.60 matthew 5838:
1.814 bisitz 5839: =item * $no_nav_bar, if true, keep the 'what is this' info but remove the
5840: navigational links
1.317 albertel 5841:
1.338 albertel 5842: =item * $bgcolor, used to override the bgcolor on a webpage to a specific value
5843:
1.460 albertel 5844: =item * $args, optional argument valid values are
5845: no_auto_mt_title -> prevents &mt()ing the title arg
1.1274 raeburn 5846: use_absolute -> for external resource or syllabus, this will
5847: contain https://<hostname> if server uses
5848: https (as per hosts.tab), but request is for http
5849: hostname -> hostname, from $r->hostname().
1.460 albertel 5850:
1.1096 raeburn 5851: =item * $advtoolsref, optional argument, ref to an array containing
5852: inlineremote items to be added in "Functions" menu below
5853: breadcrumbs.
5854:
1.112 bowersj2 5855: =back
5856:
1.60 matthew 5857: Returns: A uniform header for LON-CAPA web pages.
5858: If $bodyonly is nonzero, a string containing a <body> tag will be returned.
5859: If $bodyonly is undef or zero, an html string containing a <body> tag and
5860: other decorations will be returned.
5861:
5862: =cut
5863:
1.54 www 5864: sub bodytag {
1.831 bisitz 5865: my ($title,$function,$addentries,$bodyonly,$domain,$forcereg,
1.1096 raeburn 5866: $no_nav_bar,$bgcolor,$args,$advtoolsref)=@_;
1.339 albertel 5867:
1.954 raeburn 5868: my $public;
5869: if ((($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public'))
5870: || ($env{'user.name'} eq '') && ($env{'user.domain'} eq '')) {
5871: $public = 1;
5872: }
1.460 albertel 5873: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
1.1154 raeburn 5874: my $httphost = $args->{'use_absolute'};
1.1274 raeburn 5875: my $hostname = $args->{'hostname'};
1.339 albertel 5876:
1.183 matthew 5877: $function = &get_users_function() if (!$function);
1.339 albertel 5878: my $img = &designparm($function.'.img',$domain);
5879: my $font = &designparm($function.'.font',$domain);
5880: my $pgbg = $bgcolor || &designparm($function.'.pgbg',$domain);
5881:
1.803 bisitz 5882: my %design = ( 'style' => 'margin-top: 0',
1.535 albertel 5883: 'bgcolor' => $pgbg,
1.339 albertel 5884: 'text' => $font,
5885: 'alink' => &designparm($function.'.alink',$domain),
5886: 'vlink' => &designparm($function.'.vlink',$domain),
5887: 'link' => &designparm($function.'.link',$domain),);
1.438 albertel 5888: @design{keys(%$addentries)} = @$addentries{keys(%$addentries)};
1.339 albertel 5889:
1.63 www 5890: # role and realm
1.1178 raeburn 5891: my ($role,$realm) = split(m{\./},$env{'request.role'},2);
5892: if ($realm) {
5893: $realm = '/'.$realm;
5894: }
1.378 raeburn 5895: if ($role eq 'ca') {
1.479 albertel 5896: my ($rdom,$rname) = ($realm =~ m{^/($match_domain)/($match_username)$});
1.500 albertel 5897: $realm = &plainname($rname,$rdom);
1.378 raeburn 5898: }
1.55 www 5899: # realm
1.258 albertel 5900: if ($env{'request.course.id'}) {
1.378 raeburn 5901: if ($env{'request.role'} !~ /^cr/) {
5902: $role = &Apache::lonnet::plaintext($role,&course_type());
1.1257 raeburn 5903: } elsif ($role =~ m{^cr/($match_domain)/\1-domainconfig/(\w+)$}) {
1.1269 raeburn 5904: if ($env{'request.role.desc'}) {
5905: $role = $env{'request.role.desc'};
5906: } else {
5907: $role = &mt('Helpdesk[_1]',' '.$2);
5908: }
1.1257 raeburn 5909: } else {
5910: $role = (split(/\//,$role,4))[-1];
1.378 raeburn 5911: }
1.898 raeburn 5912: if ($env{'request.course.sec'}) {
5913: $role .= (' 'x2).'- '.&mt('section:').' '.$env{'request.course.sec'};
5914: }
1.359 albertel 5915: $realm = $env{'course.'.$env{'request.course.id'}.'.description'};
1.378 raeburn 5916: } else {
5917: $role = &Apache::lonnet::plaintext($role);
1.54 www 5918: }
1.433 albertel 5919:
1.359 albertel 5920: if (!$realm) { $realm=' '; }
1.330 albertel 5921:
1.438 albertel 5922: my $extra_body_attr = &make_attr_string($forcereg,\%design);
1.329 albertel 5923:
1.101 www 5924: # construct main body tag
1.359 albertel 5925: my $bodytag = "<body $extra_body_attr>".
1.1235 raeburn 5926: &Apache::lontexconvert::init_math_support();
1.252 albertel 5927:
1.1131 raeburn 5928: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
5929:
1.1130 raeburn 5930: if (($bodyonly) || ($no_nav_bar) || ($env{'form.inhibitmenu'} eq 'yes')) {
1.60 matthew 5931: return $bodytag;
1.1130 raeburn 5932: }
1.359 albertel 5933:
1.954 raeburn 5934: if ($public) {
1.433 albertel 5935: undef($role);
5936: }
1.359 albertel 5937:
1.762 bisitz 5938: my $titleinfo = '<h1>'.$title.'</h1>';
1.359 albertel 5939: #
5940: # Extra info if you are the DC
5941: my $dc_info = '';
5942: if ($env{'user.adv'} && exists($env{'user.role.dc./'.
5943: $env{'course.'.$env{'request.course.id'}.
5944: '.domain'}.'/'})) {
5945: my $cid = $env{'request.course.id'};
1.917 raeburn 5946: $dc_info = $cid.' '.$env{'course.'.$cid.'.internal.coursecode'};
1.380 www 5947: $dc_info =~ s/\s+$//;
1.359 albertel 5948: }
5949:
1.1237 raeburn 5950: my $crstype;
5951: if ($env{'request.course.id'}) {
5952: $crstype = $env{'course.'.$env{'request.course.id'}.'.type'};
5953: } elsif ($args->{'crstype'}) {
5954: $crstype = $args->{'crstype'};
5955: }
5956: if (($crstype eq 'Placement') && (!$env{'request.role.adv'})) {
5957: undef($role);
5958: } else {
1.1242 raeburn 5959: $role = '<span class="LC_nobreak">('.$role.')</span>' if ($role && !$env{'browser.mobile'});
1.1237 raeburn 5960: }
1.853 droeschl 5961:
1.903 droeschl 5962: if ($env{'request.state'} eq 'construct') { $forcereg=1; }
5963:
5964: # if ($env{'request.state'} eq 'construct') {
5965: # $titleinfo = &CSTR_pageheader(); #FIXME: Will be removed once all scripts have their own calls
5966: # }
5967:
1.1130 raeburn 5968: $bodytag .= Apache::lonhtmlcommon::scripttag(
1.1154 raeburn 5969: Apache::lonmenu::utilityfunctions($httphost), 'start');
1.359 albertel 5970:
1.1237 raeburn 5971: my ($left,$right) = Apache::lonmenu::primary_menu($crstype);
1.359 albertel 5972:
1.916 droeschl 5973: if ($env{'request.noversionuri'} =~ m{^/res/adm/pages/}) {
1.917 raeburn 5974: if ($dc_info) {
5975: $dc_info = qq|<span class="LC_cusr_subheading">$dc_info</span>|;
5976: }
1.1130 raeburn 5977: $bodytag .= qq|<div id="LC_nav_bar">$left $role<br />
1.916 droeschl 5978: <em>$realm</em> $dc_info</div>|;
1.903 droeschl 5979: return $bodytag;
5980: }
1.894 droeschl 5981:
1.927 raeburn 5982: unless ($env{'request.symb'} =~ m/\.page___\d+___/) {
1.1130 raeburn 5983: $bodytag .= qq|<div id="LC_nav_bar">$left $role</div>|;
1.927 raeburn 5984: }
1.916 droeschl 5985:
1.1130 raeburn 5986: $bodytag .= $right;
1.852 droeschl 5987:
1.917 raeburn 5988: if ($dc_info) {
5989: $dc_info = &dc_courseid_toggle($dc_info);
5990: }
5991: $bodytag .= qq|<div id="LC_realm">$realm $dc_info</div>|;
1.916 droeschl 5992:
1.1169 raeburn 5993: #if directed to not display the secondary menu, don't.
1.1168 raeburn 5994: if ($args->{'no_secondary_menu'}) {
5995: return $bodytag;
5996: }
1.1169 raeburn 5997: #don't show menus for public users
1.954 raeburn 5998: if (!$public){
1.1154 raeburn 5999: $bodytag .= Apache::lonmenu::secondary_menu($httphost);
1.903 droeschl 6000: $bodytag .= Apache::lonmenu::serverform();
1.920 raeburn 6001: $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
6002: if ($env{'request.state'} eq 'construct') {
1.962 droeschl 6003: $bodytag .= &Apache::lonmenu::innerregister($forcereg,
1.1274 raeburn 6004: $args->{'bread_crumbs'},'','',$hostname);
1.1096 raeburn 6005: } elsif ($forcereg) {
6006: $bodytag .= &Apache::lonmenu::innerregister($forcereg,undef,
1.1258 raeburn 6007: $args->{'group'},
1.1274 raeburn 6008: $args->{'hide_buttons'},
6009: $hostname);
1.1096 raeburn 6010: } else {
6011: $bodytag .=
6012: &Apache::lonmenu::prepare_functions($env{'request.noversionuri'},
6013: $forcereg,$args->{'group'},
6014: $args->{'bread_crumbs'},
1.1274 raeburn 6015: $advtoolsref,'',$hostname);
1.920 raeburn 6016: }
1.903 droeschl 6017: }else{
6018: # this is to seperate menu from content when there's no secondary
6019: # menu. Especially needed for public accessible ressources.
6020: $bodytag .= '<hr style="clear:both" />';
6021: $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
1.235 raeburn 6022: }
1.903 droeschl 6023:
1.235 raeburn 6024: return $bodytag;
1.182 matthew 6025: }
6026:
1.917 raeburn 6027: sub dc_courseid_toggle {
6028: my ($dc_info) = @_;
1.980 raeburn 6029: return ' <span id="dccidtext" class="LC_cusr_subheading LC_nobreak">'.
1.1069 raeburn 6030: '<a href="javascript:showCourseID();" class="LC_menubuttons_link">'.
1.917 raeburn 6031: &mt('(More ...)').'</a></span>'.
6032: '<div id="dccid" class="LC_dccid">'.$dc_info.'</div>';
6033: }
6034:
1.330 albertel 6035: sub make_attr_string {
6036: my ($register,$attr_ref) = @_;
6037:
6038: if ($attr_ref && !ref($attr_ref)) {
6039: die("addentries Must be a hash ref ".
6040: join(':',caller(1))." ".
6041: join(':',caller(0))." ");
6042: }
6043:
6044: if ($register) {
1.339 albertel 6045: my ($on_load,$on_unload);
6046: foreach my $key (keys(%{$attr_ref})) {
6047: if (lc($key) eq 'onload') {
6048: $on_load.=$attr_ref->{$key}.';';
6049: delete($attr_ref->{$key});
6050:
6051: } elsif (lc($key) eq 'onunload') {
6052: $on_unload.=$attr_ref->{$key}.';';
6053: delete($attr_ref->{$key});
6054: }
6055: }
1.953 droeschl 6056: $attr_ref->{'onload'} = $on_load;
6057: $attr_ref->{'onunload'}= $on_unload;
1.330 albertel 6058: }
1.339 albertel 6059:
1.330 albertel 6060: my $attr_string;
1.1159 raeburn 6061: foreach my $attr (sort(keys(%$attr_ref))) {
1.330 albertel 6062: $attr_string .= " $attr=\"".$attr_ref->{$attr}.'" ';
6063: }
6064: return $attr_string;
6065: }
6066:
6067:
1.182 matthew 6068: ###############################################
1.251 albertel 6069: ###############################################
6070:
6071: =pod
6072:
6073: =item * &endbodytag()
6074:
6075: Returns a uniform footer for LON-CAPA web pages.
6076:
1.635 raeburn 6077: Inputs: 1 - optional reference to an args hash
6078: If in the hash, key for noredirectlink has a value which evaluates to true,
6079: a 'Continue' link is not displayed if the page contains an
6080: internal redirect in the <head></head> section,
6081: i.e., $env{'internal.head.redirect'} exists
1.251 albertel 6082:
6083: =cut
6084:
6085: sub endbodytag {
1.635 raeburn 6086: my ($args) = @_;
1.1080 raeburn 6087: my $endbodytag;
6088: unless ((ref($args) eq 'HASH') && ($args->{'notbody'})) {
6089: $endbodytag='</body>';
6090: }
1.315 albertel 6091: if ( exists( $env{'internal.head.redirect'} ) ) {
1.635 raeburn 6092: if (!(ref($args) eq 'HASH' && $args->{'noredirectlink'})) {
6093: $endbodytag=
6094: "<br /><a href=\"$env{'internal.head.redirect'}\">".
6095: &mt('Continue').'</a>'.
6096: $endbodytag;
6097: }
1.315 albertel 6098: }
1.251 albertel 6099: return $endbodytag;
6100: }
6101:
1.352 albertel 6102: =pod
6103:
6104: =item * &standard_css()
6105:
6106: Returns a style sheet
6107:
6108: Inputs: (all optional)
6109: domain -> force to color decorate a page for a specific
6110: domain
6111: function -> force usage of a specific rolish color scheme
6112: bgcolor -> override the default page bgcolor
6113:
6114: =cut
6115:
1.343 albertel 6116: sub standard_css {
1.345 albertel 6117: my ($function,$domain,$bgcolor) = @_;
1.352 albertel 6118: $function = &get_users_function() if (!$function);
6119: my $img = &designparm($function.'.img', $domain);
6120: my $tabbg = &designparm($function.'.tabbg', $domain);
6121: my $font = &designparm($function.'.font', $domain);
1.801 tempelho 6122: my $fontmenu = &designparm($function.'.fontmenu', $domain);
1.791 tempelho 6123: #second colour for later usage
1.345 albertel 6124: my $sidebg = &designparm($function.'.sidebg',$domain);
1.382 albertel 6125: my $pgbg_or_bgcolor =
6126: $bgcolor ||
1.352 albertel 6127: &designparm($function.'.pgbg', $domain);
1.382 albertel 6128: my $pgbg = &designparm($function.'.pgbg', $domain);
1.352 albertel 6129: my $alink = &designparm($function.'.alink', $domain);
6130: my $vlink = &designparm($function.'.vlink', $domain);
6131: my $link = &designparm($function.'.link', $domain);
6132:
1.602 albertel 6133: my $sans = 'Verdana,Arial,Helvetica,sans-serif';
1.395 albertel 6134: my $mono = 'monospace';
1.850 bisitz 6135: my $data_table_head = $sidebg;
6136: my $data_table_light = '#FAFAFA';
1.1060 bisitz 6137: my $data_table_dark = '#E0E0E0';
1.470 banghart 6138: my $data_table_darker = '#CCCCCC';
1.349 albertel 6139: my $data_table_highlight = '#FFFF00';
1.352 albertel 6140: my $mail_new = '#FFBB77';
6141: my $mail_new_hover = '#DD9955';
6142: my $mail_read = '#BBBB77';
6143: my $mail_read_hover = '#999944';
6144: my $mail_replied = '#AAAA88';
6145: my $mail_replied_hover = '#888855';
6146: my $mail_other = '#99BBBB';
6147: my $mail_other_hover = '#669999';
1.391 albertel 6148: my $table_header = '#DDDDDD';
1.489 raeburn 6149: my $feedback_link_bg = '#BBBBBB';
1.911 bisitz 6150: my $lg_border_color = '#C8C8C8';
1.952 onken 6151: my $button_hover = '#BF2317';
1.392 albertel 6152:
1.608 albertel 6153: my $border = ($env{'browser.type'} eq 'explorer' ||
1.911 bisitz 6154: $env{'browser.type'} eq 'safari' ) ? '0 2px 0 2px'
6155: : '0 3px 0 4px';
1.448 albertel 6156:
1.523 albertel 6157:
1.343 albertel 6158: return <<END;
1.947 droeschl 6159:
6160: /* needed for iframe to allow 100% height in FF */
6161: body, html {
6162: margin: 0;
6163: padding: 0 0.5%;
6164: height: 99%; /* to avoid scrollbars */
6165: }
6166:
1.795 www 6167: body {
1.911 bisitz 6168: font-family: $sans;
6169: line-height:130%;
6170: font-size:0.83em;
6171: color:$font;
1.795 www 6172: }
6173:
1.959 onken 6174: a:focus,
6175: a:focus img {
1.795 www 6176: color: red;
6177: }
1.698 harmsja 6178:
1.911 bisitz 6179: form, .inline {
6180: display: inline;
1.795 www 6181: }
1.721 harmsja 6182:
1.795 www 6183: .LC_right {
1.911 bisitz 6184: text-align:right;
1.795 www 6185: }
6186:
6187: .LC_middle {
1.911 bisitz 6188: vertical-align:middle;
1.795 www 6189: }
1.721 harmsja 6190:
1.1130 raeburn 6191: .LC_floatleft {
6192: float: left;
6193: }
6194:
6195: .LC_floatright {
6196: float: right;
6197: }
6198:
1.911 bisitz 6199: .LC_400Box {
6200: width:400px;
6201: }
1.721 harmsja 6202:
1.947 droeschl 6203: .LC_iframecontainer {
6204: width: 98%;
6205: margin: 0;
6206: position: fixed;
6207: top: 8.5em;
6208: bottom: 0;
6209: }
6210:
6211: .LC_iframecontainer iframe{
6212: border: none;
6213: width: 100%;
6214: height: 100%;
6215: }
6216:
1.778 bisitz 6217: .LC_filename {
6218: font-family: $mono;
6219: white-space:pre;
1.921 bisitz 6220: font-size: 120%;
1.778 bisitz 6221: }
6222:
6223: .LC_fileicon {
6224: border: none;
6225: height: 1.3em;
6226: vertical-align: text-bottom;
6227: margin-right: 0.3em;
6228: text-decoration:none;
6229: }
6230:
1.1008 www 6231: .LC_setting {
6232: text-decoration:underline;
6233: }
6234:
1.350 albertel 6235: .LC_error {
6236: color: red;
6237: }
1.795 www 6238:
1.1097 bisitz 6239: .LC_warning {
6240: color: darkorange;
6241: }
6242:
1.457 albertel 6243: .LC_diff_removed {
1.733 bisitz 6244: color: red;
1.394 albertel 6245: }
1.532 albertel 6246:
6247: .LC_info,
1.457 albertel 6248: .LC_success,
6249: .LC_diff_added {
1.350 albertel 6250: color: green;
6251: }
1.795 www 6252:
1.802 bisitz 6253: div.LC_confirm_box {
6254: background-color: #FAFAFA;
6255: border: 1px solid $lg_border_color;
6256: margin-right: 0;
6257: padding: 5px;
6258: }
6259:
6260: div.LC_confirm_box .LC_error img,
6261: div.LC_confirm_box .LC_success img {
6262: vertical-align: middle;
6263: }
6264:
1.1242 raeburn 6265: .LC_maxwidth {
6266: max-width: 100%;
6267: height: auto;
6268: }
6269:
1.1243 raeburn 6270: .LC_textsize_mobile {
6271: \@media only screen and (max-device-width: 480px) {
6272: -webkit-text-size-adjust:100%; -moz-text-size-adjust:100%; -ms-text-size-adjust:100%;
6273: }
6274: }
6275:
1.440 albertel 6276: .LC_icon {
1.771 droeschl 6277: border: none;
1.790 droeschl 6278: vertical-align: middle;
1.771 droeschl 6279: }
6280:
1.543 albertel 6281: .LC_docs_spacer {
6282: width: 25px;
6283: height: 1px;
1.771 droeschl 6284: border: none;
1.543 albertel 6285: }
1.346 albertel 6286:
1.532 albertel 6287: .LC_internal_info {
1.735 bisitz 6288: color: #999999;
1.532 albertel 6289: }
6290:
1.794 www 6291: .LC_discussion {
1.1050 www 6292: background: $data_table_dark;
1.911 bisitz 6293: border: 1px solid black;
6294: margin: 2px;
1.794 www 6295: }
6296:
6297: .LC_disc_action_left {
1.1050 www 6298: background: $sidebg;
1.911 bisitz 6299: text-align: left;
1.1050 www 6300: padding: 4px;
6301: margin: 2px;
1.794 www 6302: }
6303:
6304: .LC_disc_action_right {
1.1050 www 6305: background: $sidebg;
1.911 bisitz 6306: text-align: right;
1.1050 www 6307: padding: 4px;
6308: margin: 2px;
1.794 www 6309: }
6310:
6311: .LC_disc_new_item {
1.911 bisitz 6312: background: white;
6313: border: 2px solid red;
1.1050 www 6314: margin: 4px;
6315: padding: 4px;
1.794 www 6316: }
6317:
6318: .LC_disc_old_item {
1.911 bisitz 6319: background: white;
1.1050 www 6320: margin: 4px;
6321: padding: 4px;
1.794 www 6322: }
6323:
1.458 albertel 6324: table.LC_pastsubmission {
6325: border: 1px solid black;
6326: margin: 2px;
6327: }
6328:
1.924 bisitz 6329: table#LC_menubuttons {
1.345 albertel 6330: width: 100%;
6331: background: $pgbg;
1.392 albertel 6332: border: 2px;
1.402 albertel 6333: border-collapse: separate;
1.803 bisitz 6334: padding: 0;
1.345 albertel 6335: }
1.392 albertel 6336:
1.801 tempelho 6337: table#LC_title_bar a {
6338: color: $fontmenu;
6339: }
1.836 bisitz 6340:
1.807 droeschl 6341: table#LC_title_bar {
1.819 tempelho 6342: clear: both;
1.836 bisitz 6343: display: none;
1.807 droeschl 6344: }
6345:
1.795 www 6346: table#LC_title_bar,
1.933 droeschl 6347: table.LC_breadcrumbs, /* obsolete? */
1.393 albertel 6348: table#LC_title_bar.LC_with_remote {
1.359 albertel 6349: width: 100%;
1.392 albertel 6350: border-color: $pgbg;
6351: border-style: solid;
6352: border-width: $border;
1.379 albertel 6353: background: $pgbg;
1.801 tempelho 6354: color: $fontmenu;
1.392 albertel 6355: border-collapse: collapse;
1.803 bisitz 6356: padding: 0;
1.819 tempelho 6357: margin: 0;
1.359 albertel 6358: }
1.795 www 6359:
1.933 droeschl 6360: ul.LC_breadcrumb_tools_outerlist {
1.913 droeschl 6361: margin: 0;
6362: padding: 0;
1.933 droeschl 6363: position: relative;
6364: list-style: none;
1.913 droeschl 6365: }
1.933 droeschl 6366: ul.LC_breadcrumb_tools_outerlist li {
1.913 droeschl 6367: display: inline;
6368: }
1.933 droeschl 6369:
6370: .LC_breadcrumb_tools_navigation {
1.913 droeschl 6371: padding: 0;
1.933 droeschl 6372: margin: 0;
6373: float: left;
1.913 droeschl 6374: }
1.933 droeschl 6375: .LC_breadcrumb_tools_tools {
6376: padding: 0;
6377: margin: 0;
1.913 droeschl 6378: float: right;
6379: }
6380:
1.1240 raeburn 6381: .LC_placement_prog {
6382: padding-right: 20px;
6383: font-weight: bold;
6384: font-size: 90%;
6385: }
6386:
1.359 albertel 6387: table#LC_title_bar td {
6388: background: $tabbg;
6389: }
1.795 www 6390:
1.911 bisitz 6391: table#LC_menubuttons img {
1.803 bisitz 6392: border: none;
1.346 albertel 6393: }
1.795 www 6394:
1.842 droeschl 6395: .LC_breadcrumbs_component {
1.911 bisitz 6396: float: right;
6397: margin: 0 1em;
1.357 albertel 6398: }
1.842 droeschl 6399: .LC_breadcrumbs_component img {
1.911 bisitz 6400: vertical-align: middle;
1.777 tempelho 6401: }
1.795 www 6402:
1.1243 raeburn 6403: .LC_breadcrumbs_hoverable {
6404: background: $sidebg;
6405: }
6406:
1.383 albertel 6407: td.LC_table_cell_checkbox {
6408: text-align: center;
6409: }
1.795 www 6410:
6411: .LC_fontsize_small {
1.911 bisitz 6412: font-size: 70%;
1.705 tempelho 6413: }
6414:
1.844 bisitz 6415: #LC_breadcrumbs {
1.911 bisitz 6416: clear:both;
6417: background: $sidebg;
6418: border-bottom: 1px solid $lg_border_color;
6419: line-height: 2.5em;
1.933 droeschl 6420: overflow: hidden;
1.911 bisitz 6421: margin: 0;
6422: padding: 0;
1.995 raeburn 6423: text-align: left;
1.819 tempelho 6424: }
1.862 bisitz 6425:
1.1098 bisitz 6426: .LC_head_subbox, .LC_actionbox {
1.911 bisitz 6427: clear:both;
6428: background: #F8F8F8; /* $sidebg; */
1.915 droeschl 6429: border: 1px solid $sidebg;
1.1098 bisitz 6430: margin: 0 0 10px 0;
1.966 bisitz 6431: padding: 3px;
1.995 raeburn 6432: text-align: left;
1.822 bisitz 6433: }
6434:
1.795 www 6435: .LC_fontsize_medium {
1.911 bisitz 6436: font-size: 85%;
1.705 tempelho 6437: }
6438:
1.795 www 6439: .LC_fontsize_large {
1.911 bisitz 6440: font-size: 120%;
1.705 tempelho 6441: }
6442:
1.346 albertel 6443: .LC_menubuttons_inline_text {
6444: color: $font;
1.698 harmsja 6445: font-size: 90%;
1.701 harmsja 6446: padding-left:3px;
1.346 albertel 6447: }
6448:
1.934 droeschl 6449: .LC_menubuttons_inline_text img{
6450: vertical-align: middle;
6451: }
6452:
1.1051 www 6453: li.LC_menubuttons_inline_text img {
1.951 onken 6454: cursor:pointer;
1.1002 droeschl 6455: text-decoration: none;
1.951 onken 6456: }
6457:
1.526 www 6458: .LC_menubuttons_link {
6459: text-decoration: none;
6460: }
1.795 www 6461:
1.522 albertel 6462: .LC_menubuttons_category {
1.521 www 6463: color: $font;
1.526 www 6464: background: $pgbg;
1.521 www 6465: font-size: larger;
6466: font-weight: bold;
6467: }
6468:
1.346 albertel 6469: td.LC_menubuttons_text {
1.911 bisitz 6470: color: $font;
1.346 albertel 6471: }
1.706 harmsja 6472:
1.346 albertel 6473: .LC_current_location {
6474: background: $tabbg;
6475: }
1.795 www 6476:
1.1286 raeburn 6477: td.LC_zero_height {
6478: line-height: 0;
6479: cellpadding: 0;
6480: }
6481:
1.938 bisitz 6482: table.LC_data_table {
1.347 albertel 6483: border: 1px solid #000000;
1.402 albertel 6484: border-collapse: separate;
1.426 albertel 6485: border-spacing: 1px;
1.610 albertel 6486: background: $pgbg;
1.347 albertel 6487: }
1.795 www 6488:
1.422 albertel 6489: .LC_data_table_dense {
6490: font-size: small;
6491: }
1.795 www 6492:
1.507 raeburn 6493: table.LC_nested_outer {
6494: border: 1px solid #000000;
1.589 raeburn 6495: border-collapse: collapse;
1.803 bisitz 6496: border-spacing: 0;
1.507 raeburn 6497: width: 100%;
6498: }
1.795 www 6499:
1.879 raeburn 6500: table.LC_innerpickbox,
1.507 raeburn 6501: table.LC_nested {
1.803 bisitz 6502: border: none;
1.589 raeburn 6503: border-collapse: collapse;
1.803 bisitz 6504: border-spacing: 0;
1.507 raeburn 6505: width: 100%;
6506: }
1.795 www 6507:
1.911 bisitz 6508: table.LC_data_table tr th,
6509: table.LC_calendar tr th,
1.879 raeburn 6510: table.LC_prior_tries tr th,
6511: table.LC_innerpickbox tr th {
1.349 albertel 6512: font-weight: bold;
6513: background-color: $data_table_head;
1.801 tempelho 6514: color:$fontmenu;
1.701 harmsja 6515: font-size:90%;
1.347 albertel 6516: }
1.795 www 6517:
1.879 raeburn 6518: table.LC_innerpickbox tr th,
6519: table.LC_innerpickbox tr td {
6520: vertical-align: top;
6521: }
6522:
1.711 raeburn 6523: table.LC_data_table tr.LC_info_row > td {
1.735 bisitz 6524: background-color: #CCCCCC;
1.711 raeburn 6525: font-weight: bold;
6526: text-align: left;
6527: }
1.795 www 6528:
1.912 bisitz 6529: table.LC_data_table tr.LC_odd_row > td {
6530: background-color: $data_table_light;
6531: padding: 2px;
6532: vertical-align: top;
6533: }
6534:
1.809 bisitz 6535: table.LC_pick_box tr > td.LC_odd_row {
1.349 albertel 6536: background-color: $data_table_light;
1.912 bisitz 6537: vertical-align: top;
6538: }
6539:
6540: table.LC_data_table tr.LC_even_row > td {
6541: background-color: $data_table_dark;
1.425 albertel 6542: padding: 2px;
1.900 bisitz 6543: vertical-align: top;
1.347 albertel 6544: }
1.795 www 6545:
1.809 bisitz 6546: table.LC_pick_box tr > td.LC_even_row {
1.349 albertel 6547: background-color: $data_table_dark;
1.900 bisitz 6548: vertical-align: top;
1.347 albertel 6549: }
1.795 www 6550:
1.425 albertel 6551: table.LC_data_table tr.LC_data_table_highlight td {
6552: background-color: $data_table_darker;
6553: }
1.795 www 6554:
1.639 raeburn 6555: table.LC_data_table tr td.LC_leftcol_header {
6556: background-color: $data_table_head;
6557: font-weight: bold;
6558: }
1.795 www 6559:
1.451 albertel 6560: table.LC_data_table tr.LC_empty_row td,
1.507 raeburn 6561: table.LC_nested tr.LC_empty_row td {
1.421 albertel 6562: font-weight: bold;
6563: font-style: italic;
6564: text-align: center;
6565: padding: 8px;
1.347 albertel 6566: }
1.795 www 6567:
1.1114 raeburn 6568: table.LC_data_table tr.LC_empty_row td,
6569: table.LC_data_table tr.LC_footer_row td {
1.940 bisitz 6570: background-color: $sidebg;
6571: }
6572:
6573: table.LC_nested tr.LC_empty_row td {
6574: background-color: #FFFFFF;
6575: }
6576:
1.890 droeschl 6577: table.LC_caption {
6578: }
6579:
1.507 raeburn 6580: table.LC_nested tr.LC_empty_row td {
1.465 albertel 6581: padding: 4ex
6582: }
1.795 www 6583:
1.507 raeburn 6584: table.LC_nested_outer tr th {
6585: font-weight: bold;
1.801 tempelho 6586: color:$fontmenu;
1.507 raeburn 6587: background-color: $data_table_head;
1.701 harmsja 6588: font-size: small;
1.507 raeburn 6589: border-bottom: 1px solid #000000;
6590: }
1.795 www 6591:
1.507 raeburn 6592: table.LC_nested_outer tr td.LC_subheader {
6593: background-color: $data_table_head;
6594: font-weight: bold;
6595: font-size: small;
6596: border-bottom: 1px solid #000000;
6597: text-align: right;
1.451 albertel 6598: }
1.795 www 6599:
1.507 raeburn 6600: table.LC_nested tr.LC_info_row td {
1.735 bisitz 6601: background-color: #CCCCCC;
1.451 albertel 6602: font-weight: bold;
6603: font-size: small;
1.507 raeburn 6604: text-align: center;
6605: }
1.795 www 6606:
1.589 raeburn 6607: table.LC_nested tr.LC_info_row td.LC_left_item,
6608: table.LC_nested_outer tr th.LC_left_item {
1.507 raeburn 6609: text-align: left;
1.451 albertel 6610: }
1.795 www 6611:
1.507 raeburn 6612: table.LC_nested td {
1.735 bisitz 6613: background-color: #FFFFFF;
1.451 albertel 6614: font-size: small;
1.507 raeburn 6615: }
1.795 www 6616:
1.507 raeburn 6617: table.LC_nested_outer tr th.LC_right_item,
6618: table.LC_nested tr.LC_info_row td.LC_right_item,
6619: table.LC_nested tr.LC_odd_row td.LC_right_item,
6620: table.LC_nested tr td.LC_right_item {
1.451 albertel 6621: text-align: right;
6622: }
6623:
1.507 raeburn 6624: table.LC_nested tr.LC_odd_row td {
1.735 bisitz 6625: background-color: #EEEEEE;
1.451 albertel 6626: }
6627:
1.473 raeburn 6628: table.LC_createuser {
6629: }
6630:
6631: table.LC_createuser tr.LC_section_row td {
1.701 harmsja 6632: font-size: small;
1.473 raeburn 6633: }
6634:
6635: table.LC_createuser tr.LC_info_row td {
1.735 bisitz 6636: background-color: #CCCCCC;
1.473 raeburn 6637: font-weight: bold;
6638: text-align: center;
6639: }
6640:
1.349 albertel 6641: table.LC_calendar {
6642: border: 1px solid #000000;
6643: border-collapse: collapse;
1.917 raeburn 6644: width: 98%;
1.349 albertel 6645: }
1.795 www 6646:
1.349 albertel 6647: table.LC_calendar_pickdate {
6648: font-size: xx-small;
6649: }
1.795 www 6650:
1.349 albertel 6651: table.LC_calendar tr td {
6652: border: 1px solid #000000;
6653: vertical-align: top;
1.917 raeburn 6654: width: 14%;
1.349 albertel 6655: }
1.795 www 6656:
1.349 albertel 6657: table.LC_calendar tr td.LC_calendar_day_empty {
6658: background-color: $data_table_dark;
6659: }
1.795 www 6660:
1.779 bisitz 6661: table.LC_calendar tr td.LC_calendar_day_current {
6662: background-color: $data_table_highlight;
1.777 tempelho 6663: }
1.795 www 6664:
1.938 bisitz 6665: table.LC_data_table tr td.LC_mail_new {
1.349 albertel 6666: background-color: $mail_new;
6667: }
1.795 www 6668:
1.938 bisitz 6669: table.LC_data_table tr.LC_mail_new:hover {
1.349 albertel 6670: background-color: $mail_new_hover;
6671: }
1.795 www 6672:
1.938 bisitz 6673: table.LC_data_table tr td.LC_mail_read {
1.349 albertel 6674: background-color: $mail_read;
6675: }
1.795 www 6676:
1.938 bisitz 6677: /*
6678: table.LC_data_table tr.LC_mail_read:hover {
1.349 albertel 6679: background-color: $mail_read_hover;
6680: }
1.938 bisitz 6681: */
1.795 www 6682:
1.938 bisitz 6683: table.LC_data_table tr td.LC_mail_replied {
1.349 albertel 6684: background-color: $mail_replied;
6685: }
1.795 www 6686:
1.938 bisitz 6687: /*
6688: table.LC_data_table tr.LC_mail_replied:hover {
1.349 albertel 6689: background-color: $mail_replied_hover;
6690: }
1.938 bisitz 6691: */
1.795 www 6692:
1.938 bisitz 6693: table.LC_data_table tr td.LC_mail_other {
1.349 albertel 6694: background-color: $mail_other;
6695: }
1.795 www 6696:
1.938 bisitz 6697: /*
6698: table.LC_data_table tr.LC_mail_other:hover {
1.349 albertel 6699: background-color: $mail_other_hover;
6700: }
1.938 bisitz 6701: */
1.494 raeburn 6702:
1.777 tempelho 6703: table.LC_data_table tr > td.LC_browser_file,
6704: table.LC_data_table tr > td.LC_browser_file_published {
1.899 bisitz 6705: background: #AAEE77;
1.389 albertel 6706: }
1.795 www 6707:
1.777 tempelho 6708: table.LC_data_table tr > td.LC_browser_file_locked,
6709: table.LC_data_table tr > td.LC_browser_file_unpublished {
1.389 albertel 6710: background: #FFAA99;
1.387 albertel 6711: }
1.795 www 6712:
1.777 tempelho 6713: table.LC_data_table tr > td.LC_browser_file_obsolete {
1.899 bisitz 6714: background: #888888;
1.779 bisitz 6715: }
1.795 www 6716:
1.777 tempelho 6717: table.LC_data_table tr > td.LC_browser_file_modified,
1.779 bisitz 6718: table.LC_data_table tr > td.LC_browser_file_metamodified {
1.899 bisitz 6719: background: #F8F866;
1.777 tempelho 6720: }
1.795 www 6721:
1.696 bisitz 6722: table.LC_data_table tr.LC_browser_folder > td {
1.899 bisitz 6723: background: #E0E8FF;
1.387 albertel 6724: }
1.696 bisitz 6725:
1.707 bisitz 6726: table.LC_data_table tr > td.LC_roles_is {
1.911 bisitz 6727: /* background: #77FF77; */
1.707 bisitz 6728: }
1.795 www 6729:
1.707 bisitz 6730: table.LC_data_table tr > td.LC_roles_future {
1.939 bisitz 6731: border-right: 8px solid #FFFF77;
1.707 bisitz 6732: }
1.795 www 6733:
1.707 bisitz 6734: table.LC_data_table tr > td.LC_roles_will {
1.939 bisitz 6735: border-right: 8px solid #FFAA77;
1.707 bisitz 6736: }
1.795 www 6737:
1.707 bisitz 6738: table.LC_data_table tr > td.LC_roles_expired {
1.939 bisitz 6739: border-right: 8px solid #FF7777;
1.707 bisitz 6740: }
1.795 www 6741:
1.707 bisitz 6742: table.LC_data_table tr > td.LC_roles_will_not {
1.939 bisitz 6743: border-right: 8px solid #AAFF77;
1.707 bisitz 6744: }
1.795 www 6745:
1.707 bisitz 6746: table.LC_data_table tr > td.LC_roles_selected {
1.939 bisitz 6747: border-right: 8px solid #11CC55;
1.707 bisitz 6748: }
6749:
1.388 albertel 6750: span.LC_current_location {
1.701 harmsja 6751: font-size:larger;
1.388 albertel 6752: background: $pgbg;
6753: }
1.387 albertel 6754:
1.1029 www 6755: span.LC_current_nav_location {
6756: font-weight:bold;
6757: background: $sidebg;
6758: }
6759:
1.395 albertel 6760: span.LC_parm_menu_item {
6761: font-size: larger;
6762: }
1.795 www 6763:
1.395 albertel 6764: span.LC_parm_scope_all {
6765: color: red;
6766: }
1.795 www 6767:
1.395 albertel 6768: span.LC_parm_scope_folder {
6769: color: green;
6770: }
1.795 www 6771:
1.395 albertel 6772: span.LC_parm_scope_resource {
6773: color: orange;
6774: }
1.795 www 6775:
1.395 albertel 6776: span.LC_parm_part {
6777: color: blue;
6778: }
1.795 www 6779:
1.911 bisitz 6780: span.LC_parm_folder,
6781: span.LC_parm_symb {
1.395 albertel 6782: font-size: x-small;
6783: font-family: $mono;
6784: color: #AAAAAA;
6785: }
6786:
1.977 bisitz 6787: ul.LC_parm_parmlist li {
6788: display: inline-block;
6789: padding: 0.3em 0.8em;
6790: vertical-align: top;
6791: width: 150px;
6792: border-top:1px solid $lg_border_color;
6793: }
6794:
1.795 www 6795: td.LC_parm_overview_level_menu,
6796: td.LC_parm_overview_map_menu,
6797: td.LC_parm_overview_parm_selectors,
6798: td.LC_parm_overview_restrictions {
1.396 albertel 6799: border: 1px solid black;
6800: border-collapse: collapse;
6801: }
1.795 www 6802:
1.1285 raeburn 6803: span.LC_parm_recursive,
6804: td.LC_parm_recursive {
6805: font-weight: bold;
6806: font-size: smaller;
6807: }
6808:
1.396 albertel 6809: table.LC_parm_overview_restrictions td {
6810: border-width: 1px 4px 1px 4px;
6811: border-style: solid;
6812: border-color: $pgbg;
6813: text-align: center;
6814: }
1.795 www 6815:
1.396 albertel 6816: table.LC_parm_overview_restrictions th {
6817: background: $tabbg;
6818: border-width: 1px 4px 1px 4px;
6819: border-style: solid;
6820: border-color: $pgbg;
6821: }
1.795 www 6822:
1.398 albertel 6823: table#LC_helpmenu {
1.803 bisitz 6824: border: none;
1.398 albertel 6825: height: 55px;
1.803 bisitz 6826: border-spacing: 0;
1.398 albertel 6827: }
6828:
6829: table#LC_helpmenu fieldset legend {
6830: font-size: larger;
6831: }
1.795 www 6832:
1.397 albertel 6833: table#LC_helpmenu_links {
6834: width: 100%;
6835: border: 1px solid black;
6836: background: $pgbg;
1.803 bisitz 6837: padding: 0;
1.397 albertel 6838: border-spacing: 1px;
6839: }
1.795 www 6840:
1.397 albertel 6841: table#LC_helpmenu_links tr td {
6842: padding: 1px;
6843: background: $tabbg;
1.399 albertel 6844: text-align: center;
6845: font-weight: bold;
1.397 albertel 6846: }
1.396 albertel 6847:
1.795 www 6848: table#LC_helpmenu_links a:link,
6849: table#LC_helpmenu_links a:visited,
1.397 albertel 6850: table#LC_helpmenu_links a:active {
6851: text-decoration: none;
6852: color: $font;
6853: }
1.795 www 6854:
1.397 albertel 6855: table#LC_helpmenu_links a:hover {
6856: text-decoration: underline;
6857: color: $vlink;
6858: }
1.396 albertel 6859:
1.417 albertel 6860: .LC_chrt_popup_exists {
6861: border: 1px solid #339933;
6862: margin: -1px;
6863: }
1.795 www 6864:
1.417 albertel 6865: .LC_chrt_popup_up {
6866: border: 1px solid yellow;
6867: margin: -1px;
6868: }
1.795 www 6869:
1.417 albertel 6870: .LC_chrt_popup {
6871: border: 1px solid #8888FF;
6872: background: #CCCCFF;
6873: }
1.795 www 6874:
1.421 albertel 6875: table.LC_pick_box {
6876: border-collapse: separate;
6877: background: white;
6878: border: 1px solid black;
6879: border-spacing: 1px;
6880: }
1.795 www 6881:
1.421 albertel 6882: table.LC_pick_box td.LC_pick_box_title {
1.850 bisitz 6883: background: $sidebg;
1.421 albertel 6884: font-weight: bold;
1.900 bisitz 6885: text-align: left;
1.740 bisitz 6886: vertical-align: top;
1.421 albertel 6887: width: 184px;
6888: padding: 8px;
6889: }
1.795 www 6890:
1.579 raeburn 6891: table.LC_pick_box td.LC_pick_box_value {
6892: text-align: left;
6893: padding: 8px;
6894: }
1.795 www 6895:
1.579 raeburn 6896: table.LC_pick_box td.LC_pick_box_select {
6897: text-align: left;
6898: padding: 8px;
6899: }
1.795 www 6900:
1.424 albertel 6901: table.LC_pick_box td.LC_pick_box_separator {
1.803 bisitz 6902: padding: 0;
1.421 albertel 6903: height: 1px;
6904: background: black;
6905: }
1.795 www 6906:
1.421 albertel 6907: table.LC_pick_box td.LC_pick_box_submit {
6908: text-align: right;
6909: }
1.795 www 6910:
1.579 raeburn 6911: table.LC_pick_box td.LC_evenrow_value {
6912: text-align: left;
6913: padding: 8px;
6914: background-color: $data_table_light;
6915: }
1.795 www 6916:
1.579 raeburn 6917: table.LC_pick_box td.LC_oddrow_value {
6918: text-align: left;
6919: padding: 8px;
6920: background-color: $data_table_light;
6921: }
1.795 www 6922:
1.579 raeburn 6923: span.LC_helpform_receipt_cat {
6924: font-weight: bold;
6925: }
1.795 www 6926:
1.424 albertel 6927: table.LC_group_priv_box {
6928: background: white;
6929: border: 1px solid black;
6930: border-spacing: 1px;
6931: }
1.795 www 6932:
1.424 albertel 6933: table.LC_group_priv_box td.LC_pick_box_title {
6934: background: $tabbg;
6935: font-weight: bold;
6936: text-align: right;
6937: width: 184px;
6938: }
1.795 www 6939:
1.424 albertel 6940: table.LC_group_priv_box td.LC_groups_fixed {
6941: background: $data_table_light;
6942: text-align: center;
6943: }
1.795 www 6944:
1.424 albertel 6945: table.LC_group_priv_box td.LC_groups_optional {
6946: background: $data_table_dark;
6947: text-align: center;
6948: }
1.795 www 6949:
1.424 albertel 6950: table.LC_group_priv_box td.LC_groups_functionality {
6951: background: $data_table_darker;
6952: text-align: center;
6953: font-weight: bold;
6954: }
1.795 www 6955:
1.424 albertel 6956: table.LC_group_priv td {
6957: text-align: left;
1.803 bisitz 6958: padding: 0;
1.424 albertel 6959: }
6960:
6961: .LC_navbuttons {
6962: margin: 2ex 0ex 2ex 0ex;
6963: }
1.795 www 6964:
1.423 albertel 6965: .LC_topic_bar {
6966: font-weight: bold;
6967: background: $tabbg;
1.918 wenzelju 6968: margin: 1em 0em 1em 2em;
1.805 bisitz 6969: padding: 3px;
1.918 wenzelju 6970: font-size: 1.2em;
1.423 albertel 6971: }
1.795 www 6972:
1.423 albertel 6973: .LC_topic_bar span {
1.918 wenzelju 6974: left: 0.5em;
6975: position: absolute;
1.423 albertel 6976: vertical-align: middle;
1.918 wenzelju 6977: font-size: 1.2em;
1.423 albertel 6978: }
1.795 www 6979:
1.423 albertel 6980: table.LC_course_group_status {
6981: margin: 20px;
6982: }
1.795 www 6983:
1.423 albertel 6984: table.LC_status_selector td {
6985: vertical-align: top;
6986: text-align: center;
1.424 albertel 6987: padding: 4px;
6988: }
1.795 www 6989:
1.599 albertel 6990: div.LC_feedback_link {
1.616 albertel 6991: clear: both;
1.829 kalberla 6992: background: $sidebg;
1.779 bisitz 6993: width: 100%;
1.829 kalberla 6994: padding-bottom: 10px;
6995: border: 1px $tabbg solid;
1.833 kalberla 6996: height: 22px;
6997: line-height: 22px;
6998: padding-top: 5px;
6999: }
7000:
7001: div.LC_feedback_link img {
7002: height: 22px;
1.867 kalberla 7003: vertical-align:middle;
1.829 kalberla 7004: }
7005:
1.911 bisitz 7006: div.LC_feedback_link a {
1.829 kalberla 7007: text-decoration: none;
1.489 raeburn 7008: }
1.795 www 7009:
1.867 kalberla 7010: div.LC_comblock {
1.911 bisitz 7011: display:inline;
1.867 kalberla 7012: color:$font;
7013: font-size:90%;
7014: }
7015:
7016: div.LC_feedback_link div.LC_comblock {
7017: padding-left:5px;
7018: }
7019:
7020: div.LC_feedback_link div.LC_comblock a {
7021: color:$font;
7022: }
7023:
1.489 raeburn 7024: span.LC_feedback_link {
1.858 bisitz 7025: /* background: $feedback_link_bg; */
1.599 albertel 7026: font-size: larger;
7027: }
1.795 www 7028:
1.599 albertel 7029: span.LC_message_link {
1.858 bisitz 7030: /* background: $feedback_link_bg; */
1.599 albertel 7031: font-size: larger;
7032: position: absolute;
7033: right: 1em;
1.489 raeburn 7034: }
1.421 albertel 7035:
1.515 albertel 7036: table.LC_prior_tries {
1.524 albertel 7037: border: 1px solid #000000;
7038: border-collapse: separate;
7039: border-spacing: 1px;
1.515 albertel 7040: }
1.523 albertel 7041:
1.515 albertel 7042: table.LC_prior_tries td {
1.524 albertel 7043: padding: 2px;
1.515 albertel 7044: }
1.523 albertel 7045:
7046: .LC_answer_correct {
1.795 www 7047: background: lightgreen;
7048: color: darkgreen;
7049: padding: 6px;
1.523 albertel 7050: }
1.795 www 7051:
1.523 albertel 7052: .LC_answer_charged_try {
1.797 www 7053: background: #FFAAAA;
1.795 www 7054: color: darkred;
7055: padding: 6px;
1.523 albertel 7056: }
1.795 www 7057:
1.779 bisitz 7058: .LC_answer_not_charged_try,
1.523 albertel 7059: .LC_answer_no_grade,
7060: .LC_answer_late {
1.795 www 7061: background: lightyellow;
1.523 albertel 7062: color: black;
1.795 www 7063: padding: 6px;
1.523 albertel 7064: }
1.795 www 7065:
1.523 albertel 7066: .LC_answer_previous {
1.795 www 7067: background: lightblue;
7068: color: darkblue;
7069: padding: 6px;
1.523 albertel 7070: }
1.795 www 7071:
1.779 bisitz 7072: .LC_answer_no_message {
1.777 tempelho 7073: background: #FFFFFF;
7074: color: black;
1.795 www 7075: padding: 6px;
1.779 bisitz 7076: }
1.795 www 7077:
1.779 bisitz 7078: .LC_answer_unknown {
7079: background: orange;
7080: color: black;
1.795 www 7081: padding: 6px;
1.777 tempelho 7082: }
1.795 www 7083:
1.529 albertel 7084: span.LC_prior_numerical,
7085: span.LC_prior_string,
7086: span.LC_prior_custom,
7087: span.LC_prior_reaction,
7088: span.LC_prior_math {
1.925 bisitz 7089: font-family: $mono;
1.523 albertel 7090: white-space: pre;
7091: }
7092:
1.525 albertel 7093: span.LC_prior_string {
1.925 bisitz 7094: font-family: $mono;
1.525 albertel 7095: white-space: pre;
7096: }
7097:
1.523 albertel 7098: table.LC_prior_option {
7099: width: 100%;
7100: border-collapse: collapse;
7101: }
1.795 www 7102:
1.911 bisitz 7103: table.LC_prior_rank,
1.795 www 7104: table.LC_prior_match {
1.528 albertel 7105: border-collapse: collapse;
7106: }
1.795 www 7107:
1.528 albertel 7108: table.LC_prior_option tr td,
7109: table.LC_prior_rank tr td,
7110: table.LC_prior_match tr td {
1.524 albertel 7111: border: 1px solid #000000;
1.515 albertel 7112: }
7113:
1.855 bisitz 7114: .LC_nobreak {
1.544 albertel 7115: white-space: nowrap;
1.519 raeburn 7116: }
7117:
1.576 raeburn 7118: span.LC_cusr_emph {
7119: font-style: italic;
7120: }
7121:
1.633 raeburn 7122: span.LC_cusr_subheading {
7123: font-weight: normal;
7124: font-size: 85%;
7125: }
7126:
1.861 bisitz 7127: div.LC_docs_entry_move {
1.859 bisitz 7128: border: 1px solid #BBBBBB;
1.545 albertel 7129: background: #DDDDDD;
1.861 bisitz 7130: width: 22px;
1.859 bisitz 7131: padding: 1px;
7132: margin: 0;
1.545 albertel 7133: }
7134:
1.861 bisitz 7135: table.LC_data_table tr > td.LC_docs_entry_commands,
7136: table.LC_data_table tr > td.LC_docs_entry_parameter {
1.545 albertel 7137: font-size: x-small;
7138: }
1.795 www 7139:
1.861 bisitz 7140: .LC_docs_entry_parameter {
7141: white-space: nowrap;
7142: }
7143:
1.544 albertel 7144: .LC_docs_copy {
1.545 albertel 7145: color: #000099;
1.544 albertel 7146: }
1.795 www 7147:
1.544 albertel 7148: .LC_docs_cut {
1.545 albertel 7149: color: #550044;
1.544 albertel 7150: }
1.795 www 7151:
1.544 albertel 7152: .LC_docs_rename {
1.545 albertel 7153: color: #009900;
1.544 albertel 7154: }
1.795 www 7155:
1.544 albertel 7156: .LC_docs_remove {
1.545 albertel 7157: color: #990000;
7158: }
7159:
1.1284 raeburn 7160: .LC_docs_alias {
7161: color: #440055;
7162: }
7163:
1.1286 raeburn 7164: .LC_domprefs_email,
1.1284 raeburn 7165: .LC_docs_alias_name,
1.547 albertel 7166: .LC_docs_reinit_warn,
7167: .LC_docs_ext_edit {
7168: font-size: x-small;
7169: }
7170:
1.545 albertel 7171: table.LC_docs_adddocs td,
7172: table.LC_docs_adddocs th {
7173: border: 1px solid #BBBBBB;
7174: padding: 4px;
7175: background: #DDDDDD;
1.543 albertel 7176: }
7177:
1.584 albertel 7178: table.LC_sty_begin {
7179: background: #BBFFBB;
7180: }
1.795 www 7181:
1.584 albertel 7182: table.LC_sty_end {
7183: background: #FFBBBB;
7184: }
7185:
1.589 raeburn 7186: table.LC_double_column {
1.803 bisitz 7187: border-width: 0;
1.589 raeburn 7188: border-collapse: collapse;
7189: width: 100%;
7190: padding: 2px;
7191: }
7192:
7193: table.LC_double_column tr td.LC_left_col {
1.590 raeburn 7194: top: 2px;
1.589 raeburn 7195: left: 2px;
7196: width: 47%;
7197: vertical-align: top;
7198: }
7199:
7200: table.LC_double_column tr td.LC_right_col {
7201: top: 2px;
1.779 bisitz 7202: right: 2px;
1.589 raeburn 7203: width: 47%;
7204: vertical-align: top;
7205: }
7206:
1.591 raeburn 7207: div.LC_left_float {
7208: float: left;
7209: padding-right: 5%;
1.597 albertel 7210: padding-bottom: 4px;
1.591 raeburn 7211: }
7212:
7213: div.LC_clear_float_header {
1.597 albertel 7214: padding-bottom: 2px;
1.591 raeburn 7215: }
7216:
7217: div.LC_clear_float_footer {
1.597 albertel 7218: padding-top: 10px;
1.591 raeburn 7219: clear: both;
7220: }
7221:
1.597 albertel 7222: div.LC_grade_show_user {
1.941 bisitz 7223: /* border-left: 5px solid $sidebg; */
7224: border-top: 5px solid #000000;
7225: margin: 50px 0 0 0;
1.936 bisitz 7226: padding: 15px 0 5px 10px;
1.597 albertel 7227: }
1.795 www 7228:
1.936 bisitz 7229: div.LC_grade_show_user_odd_row {
1.941 bisitz 7230: /* border-left: 5px solid #000000; */
7231: }
7232:
7233: div.LC_grade_show_user div.LC_Box {
7234: margin-right: 50px;
1.597 albertel 7235: }
7236:
7237: div.LC_grade_submissions,
7238: div.LC_grade_message_center,
1.936 bisitz 7239: div.LC_grade_info_links {
1.597 albertel 7240: margin: 5px;
7241: width: 99%;
7242: background: #FFFFFF;
7243: }
1.795 www 7244:
1.597 albertel 7245: div.LC_grade_submissions_header,
1.936 bisitz 7246: div.LC_grade_message_center_header {
1.705 tempelho 7247: font-weight: bold;
7248: font-size: large;
1.597 albertel 7249: }
1.795 www 7250:
1.597 albertel 7251: div.LC_grade_submissions_body,
1.936 bisitz 7252: div.LC_grade_message_center_body {
1.597 albertel 7253: border: 1px solid black;
7254: width: 99%;
7255: background: #FFFFFF;
7256: }
1.795 www 7257:
1.613 albertel 7258: table.LC_scantron_action {
7259: width: 100%;
7260: }
1.795 www 7261:
1.613 albertel 7262: table.LC_scantron_action tr th {
1.698 harmsja 7263: font-weight:bold;
7264: font-style:normal;
1.613 albertel 7265: }
1.795 www 7266:
1.779 bisitz 7267: .LC_edit_problem_header,
1.614 albertel 7268: div.LC_edit_problem_footer {
1.705 tempelho 7269: font-weight: normal;
7270: font-size: medium;
1.602 albertel 7271: margin: 2px;
1.1060 bisitz 7272: background-color: $sidebg;
1.600 albertel 7273: }
1.795 www 7274:
1.600 albertel 7275: div.LC_edit_problem_header,
1.602 albertel 7276: div.LC_edit_problem_header div,
1.614 albertel 7277: div.LC_edit_problem_footer,
7278: div.LC_edit_problem_footer div,
1.602 albertel 7279: div.LC_edit_problem_editxml_header,
7280: div.LC_edit_problem_editxml_header div {
1.1205 golterma 7281: z-index: 100;
1.600 albertel 7282: }
1.795 www 7283:
1.600 albertel 7284: div.LC_edit_problem_header_title {
1.705 tempelho 7285: font-weight: bold;
7286: font-size: larger;
1.602 albertel 7287: background: $tabbg;
7288: padding: 3px;
1.1060 bisitz 7289: margin: 0 0 5px 0;
1.602 albertel 7290: }
1.795 www 7291:
1.602 albertel 7292: table.LC_edit_problem_header_title {
7293: width: 100%;
1.600 albertel 7294: background: $tabbg;
1.602 albertel 7295: }
7296:
1.1205 golterma 7297: div.LC_edit_actionbar {
7298: background-color: $sidebg;
1.1218 droeschl 7299: margin: 0;
7300: padding: 0;
7301: line-height: 200%;
1.602 albertel 7302: }
1.795 www 7303:
1.1218 droeschl 7304: div.LC_edit_actionbar div{
7305: padding: 0;
7306: margin: 0;
7307: display: inline-block;
1.600 albertel 7308: }
1.795 www 7309:
1.1124 bisitz 7310: .LC_edit_opt {
7311: padding-left: 1em;
7312: white-space: nowrap;
7313: }
7314:
1.1152 golterma 7315: .LC_edit_problem_latexhelper{
7316: text-align: right;
7317: }
7318:
7319: #LC_edit_problem_colorful div{
7320: margin-left: 40px;
7321: }
7322:
1.1205 golterma 7323: #LC_edit_problem_codemirror div{
7324: margin-left: 0px;
7325: }
7326:
1.911 bisitz 7327: img.stift {
1.803 bisitz 7328: border-width: 0;
7329: vertical-align: middle;
1.677 riegler 7330: }
1.680 riegler 7331:
1.923 bisitz 7332: table td.LC_mainmenu_col_fieldset {
1.680 riegler 7333: vertical-align: top;
1.777 tempelho 7334: }
1.795 www 7335:
1.716 raeburn 7336: div.LC_createcourse {
1.911 bisitz 7337: margin: 10px 10px 10px 10px;
1.716 raeburn 7338: }
7339:
1.917 raeburn 7340: .LC_dccid {
1.1130 raeburn 7341: float: right;
1.917 raeburn 7342: margin: 0.2em 0 0 0;
7343: padding: 0;
7344: font-size: 90%;
7345: display:none;
7346: }
7347:
1.897 wenzelju 7348: ol.LC_primary_menu a:hover,
1.721 harmsja 7349: ol#LC_MenuBreadcrumbs a:hover,
7350: ol#LC_PathBreadcrumbs a:hover,
1.897 wenzelju 7351: ul#LC_secondary_menu a:hover,
1.721 harmsja 7352: .LC_FormSectionClearButton input:hover
1.795 www 7353: ul.LC_TabContent li:hover a {
1.952 onken 7354: color:$button_hover;
1.911 bisitz 7355: text-decoration:none;
1.693 droeschl 7356: }
7357:
1.779 bisitz 7358: h1 {
1.911 bisitz 7359: padding: 0;
7360: line-height:130%;
1.693 droeschl 7361: }
1.698 harmsja 7362:
1.911 bisitz 7363: h2,
7364: h3,
7365: h4,
7366: h5,
7367: h6 {
7368: margin: 5px 0 5px 0;
7369: padding: 0;
7370: line-height:130%;
1.693 droeschl 7371: }
1.795 www 7372:
7373: .LC_hcell {
1.911 bisitz 7374: padding:3px 15px 3px 15px;
7375: margin: 0;
7376: background-color:$tabbg;
7377: color:$fontmenu;
7378: border-bottom:solid 1px $lg_border_color;
1.693 droeschl 7379: }
1.795 www 7380:
1.840 bisitz 7381: .LC_Box > .LC_hcell {
1.911 bisitz 7382: margin: 0 -10px 10px -10px;
1.835 bisitz 7383: }
7384:
1.721 harmsja 7385: .LC_noBorder {
1.911 bisitz 7386: border: 0;
1.698 harmsja 7387: }
1.693 droeschl 7388:
1.721 harmsja 7389: .LC_FormSectionClearButton input {
1.911 bisitz 7390: background-color:transparent;
7391: border: none;
7392: cursor:pointer;
7393: text-decoration:underline;
1.693 droeschl 7394: }
1.763 bisitz 7395:
7396: .LC_help_open_topic {
1.911 bisitz 7397: color: #FFFFFF;
7398: background-color: #EEEEFF;
7399: margin: 1px;
7400: padding: 4px;
7401: border: 1px solid #000033;
7402: white-space: nowrap;
7403: /* vertical-align: middle; */
1.759 neumanie 7404: }
1.693 droeschl 7405:
1.911 bisitz 7406: dl,
7407: ul,
7408: div,
7409: fieldset {
7410: margin: 10px 10px 10px 0;
7411: /* overflow: hidden; */
1.693 droeschl 7412: }
1.795 www 7413:
1.1211 raeburn 7414: article.geogebraweb div {
7415: margin: 0;
7416: }
7417:
1.838 bisitz 7418: fieldset > legend {
1.911 bisitz 7419: font-weight: bold;
7420: padding: 0 5px 0 5px;
1.838 bisitz 7421: }
7422:
1.813 bisitz 7423: #LC_nav_bar {
1.911 bisitz 7424: float: left;
1.995 raeburn 7425: background-color: $pgbg_or_bgcolor;
1.966 bisitz 7426: margin: 0 0 2px 0;
1.807 droeschl 7427: }
7428:
1.916 droeschl 7429: #LC_realm {
7430: margin: 0.2em 0 0 0;
7431: padding: 0;
7432: font-weight: bold;
7433: text-align: center;
1.995 raeburn 7434: background-color: $pgbg_or_bgcolor;
1.916 droeschl 7435: }
7436:
1.911 bisitz 7437: #LC_nav_bar em {
7438: font-weight: bold;
7439: font-style: normal;
1.807 droeschl 7440: }
7441:
1.897 wenzelju 7442: ol.LC_primary_menu {
1.934 droeschl 7443: margin: 0;
1.1076 raeburn 7444: padding: 0;
1.807 droeschl 7445: }
7446:
1.852 droeschl 7447: ol#LC_PathBreadcrumbs {
1.911 bisitz 7448: margin: 0;
1.693 droeschl 7449: }
7450:
1.897 wenzelju 7451: ol.LC_primary_menu li {
1.1076 raeburn 7452: color: RGB(80, 80, 80);
7453: vertical-align: middle;
7454: text-align: left;
7455: list-style: none;
1.1205 golterma 7456: position: relative;
1.1076 raeburn 7457: float: left;
1.1205 golterma 7458: z-index: 100; /* will be displayed above codemirror and underneath the help-layer */
7459: line-height: 1.5em;
1.1076 raeburn 7460: }
7461:
1.1205 golterma 7462: ol.LC_primary_menu li a,
7463: ol.LC_primary_menu li p {
1.1076 raeburn 7464: display: block;
7465: margin: 0;
7466: padding: 0 5px 0 10px;
7467: text-decoration: none;
7468: }
7469:
1.1205 golterma 7470: ol.LC_primary_menu li p span.LC_primary_menu_innertitle {
7471: display: inline-block;
7472: width: 95%;
7473: text-align: left;
7474: }
7475:
7476: ol.LC_primary_menu li p span.LC_primary_menu_innerarrow {
7477: display: inline-block;
7478: width: 5%;
7479: float: right;
7480: text-align: right;
7481: font-size: 70%;
7482: }
7483:
7484: ol.LC_primary_menu ul {
1.1076 raeburn 7485: display: none;
1.1205 golterma 7486: width: 15em;
1.1076 raeburn 7487: background-color: $data_table_light;
1.1205 golterma 7488: position: absolute;
7489: top: 100%;
1.1076 raeburn 7490: }
7491:
1.1205 golterma 7492: ol.LC_primary_menu ul ul {
7493: left: 100%;
7494: top: 0;
7495: }
7496:
7497: ol.LC_primary_menu li:hover > ul, ol.LC_primary_menu li.hover > ul {
1.1076 raeburn 7498: display: block;
7499: position: absolute;
7500: margin: 0;
7501: padding: 0;
1.1078 raeburn 7502: z-index: 2;
1.1076 raeburn 7503: }
7504:
7505: ol.LC_primary_menu li:hover li, ol.LC_primary_menu li.hover li {
1.1205 golterma 7506: /* First Submenu -> size should be smaller than the menu title of the whole menu */
1.1076 raeburn 7507: font-size: 90%;
1.911 bisitz 7508: vertical-align: top;
1.1076 raeburn 7509: float: none;
1.1079 raeburn 7510: border-left: 1px solid black;
7511: border-right: 1px solid black;
1.1205 golterma 7512: /* A dark bottom border to visualize different menu options;
7513: overwritten in the create_submenu routine for the last border-bottom of the menu */
7514: border-bottom: 1px solid $data_table_dark;
1.1076 raeburn 7515: }
7516:
1.1205 golterma 7517: ol.LC_primary_menu li li p:hover {
7518: color:$button_hover;
7519: text-decoration:none;
7520: background-color:$data_table_dark;
1.1076 raeburn 7521: }
7522:
7523: ol.LC_primary_menu li li a:hover {
7524: color:$button_hover;
7525: background-color:$data_table_dark;
1.693 droeschl 7526: }
7527:
1.1205 golterma 7528: /* Font-size equal to the size of the predecessors*/
7529: ol.LC_primary_menu li:hover li li {
7530: font-size: 100%;
7531: }
7532:
1.897 wenzelju 7533: ol.LC_primary_menu li img {
1.911 bisitz 7534: vertical-align: bottom;
1.934 droeschl 7535: height: 1.1em;
1.1077 raeburn 7536: margin: 0.2em 0 0 0;
1.693 droeschl 7537: }
7538:
1.897 wenzelju 7539: ol.LC_primary_menu a {
1.911 bisitz 7540: color: RGB(80, 80, 80);
7541: text-decoration: none;
1.693 droeschl 7542: }
1.795 www 7543:
1.949 droeschl 7544: ol.LC_primary_menu a.LC_new_message {
7545: font-weight:bold;
7546: color: darkred;
7547: }
7548:
1.975 raeburn 7549: ol.LC_docs_parameters {
7550: margin-left: 0;
7551: padding: 0;
7552: list-style: none;
7553: }
7554:
7555: ol.LC_docs_parameters li {
7556: margin: 0;
7557: padding-right: 20px;
7558: display: inline;
7559: }
7560:
1.976 raeburn 7561: ol.LC_docs_parameters li:before {
7562: content: "\\002022 \\0020";
7563: }
7564:
7565: li.LC_docs_parameters_title {
7566: font-weight: bold;
7567: }
7568:
7569: ol.LC_docs_parameters li.LC_docs_parameters_title:before {
7570: content: "";
7571: }
7572:
1.897 wenzelju 7573: ul#LC_secondary_menu {
1.1107 raeburn 7574: clear: right;
1.911 bisitz 7575: color: $fontmenu;
7576: background: $tabbg;
7577: list-style: none;
7578: padding: 0;
7579: margin: 0;
7580: width: 100%;
1.995 raeburn 7581: text-align: left;
1.1107 raeburn 7582: float: left;
1.808 droeschl 7583: }
7584:
1.897 wenzelju 7585: ul#LC_secondary_menu li {
1.911 bisitz 7586: font-weight: bold;
7587: line-height: 1.8em;
1.1107 raeburn 7588: border-right: 1px solid black;
7589: float: left;
7590: }
7591:
7592: ul#LC_secondary_menu li.LC_hoverable:hover, ul#LC_secondary_menu li.hover {
7593: background-color: $data_table_light;
7594: }
7595:
7596: ul#LC_secondary_menu li a {
1.911 bisitz 7597: padding: 0 0.8em;
1.1107 raeburn 7598: }
7599:
7600: ul#LC_secondary_menu li ul {
7601: display: none;
7602: }
7603:
7604: ul#LC_secondary_menu li:hover ul, ul#LC_secondary_menu li.hover ul {
7605: display: block;
7606: position: absolute;
7607: margin: 0;
7608: padding: 0;
7609: list-style:none;
7610: float: none;
7611: background-color: $data_table_light;
7612: z-index: 2;
7613: margin-left: -1px;
7614: }
7615:
7616: ul#LC_secondary_menu li ul li {
7617: font-size: 90%;
7618: vertical-align: top;
7619: border-left: 1px solid black;
1.911 bisitz 7620: border-right: 1px solid black;
1.1119 raeburn 7621: background-color: $data_table_light;
1.1107 raeburn 7622: list-style:none;
7623: float: none;
7624: }
7625:
7626: ul#LC_secondary_menu li ul li:hover, ul#LC_secondary_menu li ul li.hover {
7627: background-color: $data_table_dark;
1.807 droeschl 7628: }
7629:
1.847 tempelho 7630: ul.LC_TabContent {
1.911 bisitz 7631: display:block;
7632: background: $sidebg;
7633: border-bottom: solid 1px $lg_border_color;
7634: list-style:none;
1.1020 raeburn 7635: margin: -1px -10px 0 -10px;
1.911 bisitz 7636: padding: 0;
1.693 droeschl 7637: }
7638:
1.795 www 7639: ul.LC_TabContent li,
7640: ul.LC_TabContentBigger li {
1.911 bisitz 7641: float:left;
1.741 harmsja 7642: }
1.795 www 7643:
1.897 wenzelju 7644: ul#LC_secondary_menu li a {
1.911 bisitz 7645: color: $fontmenu;
7646: text-decoration: none;
1.693 droeschl 7647: }
1.795 www 7648:
1.721 harmsja 7649: ul.LC_TabContent {
1.952 onken 7650: min-height:20px;
1.721 harmsja 7651: }
1.795 www 7652:
7653: ul.LC_TabContent li {
1.911 bisitz 7654: vertical-align:middle;
1.959 onken 7655: padding: 0 16px 0 10px;
1.911 bisitz 7656: background-color:$tabbg;
7657: border-bottom:solid 1px $lg_border_color;
1.1020 raeburn 7658: border-left: solid 1px $font;
1.721 harmsja 7659: }
1.795 www 7660:
1.847 tempelho 7661: ul.LC_TabContent .right {
1.911 bisitz 7662: float:right;
1.847 tempelho 7663: }
7664:
1.911 bisitz 7665: ul.LC_TabContent li a,
7666: ul.LC_TabContent li {
7667: color:rgb(47,47,47);
7668: text-decoration:none;
7669: font-size:95%;
7670: font-weight:bold;
1.952 onken 7671: min-height:20px;
7672: }
7673:
1.959 onken 7674: ul.LC_TabContent li a:hover,
7675: ul.LC_TabContent li a:focus {
1.952 onken 7676: color: $button_hover;
1.959 onken 7677: background:none;
7678: outline:none;
1.952 onken 7679: }
7680:
7681: ul.LC_TabContent li:hover {
7682: color: $button_hover;
7683: cursor:pointer;
1.721 harmsja 7684: }
1.795 www 7685:
1.911 bisitz 7686: ul.LC_TabContent li.active {
1.952 onken 7687: color: $font;
1.911 bisitz 7688: background:#FFFFFF url(/adm/lonIcons/open.gif) no-repeat scroll right center;
1.952 onken 7689: border-bottom:solid 1px #FFFFFF;
7690: cursor: default;
1.744 ehlerst 7691: }
1.795 www 7692:
1.959 onken 7693: ul.LC_TabContent li.active a {
7694: color:$font;
7695: background:#FFFFFF;
7696: outline: none;
7697: }
1.1047 raeburn 7698:
7699: ul.LC_TabContent li.goback {
7700: float: left;
7701: border-left: none;
7702: }
7703:
1.870 tempelho 7704: #maincoursedoc {
1.911 bisitz 7705: clear:both;
1.870 tempelho 7706: }
7707:
7708: ul.LC_TabContentBigger {
1.911 bisitz 7709: display:block;
7710: list-style:none;
7711: padding: 0;
1.870 tempelho 7712: }
7713:
1.795 www 7714: ul.LC_TabContentBigger li {
1.911 bisitz 7715: vertical-align:bottom;
7716: height: 30px;
7717: font-size:110%;
7718: font-weight:bold;
7719: color: #737373;
1.841 tempelho 7720: }
7721:
1.957 onken 7722: ul.LC_TabContentBigger li.active {
7723: position: relative;
7724: top: 1px;
7725: }
7726:
1.870 tempelho 7727: ul.LC_TabContentBigger li a {
1.911 bisitz 7728: background:url('/adm/lonIcons/tabbgleft.gif') left bottom no-repeat;
7729: height: 30px;
7730: line-height: 30px;
7731: text-align: center;
7732: display: block;
7733: text-decoration: none;
1.958 onken 7734: outline: none;
1.741 harmsja 7735: }
1.795 www 7736:
1.870 tempelho 7737: ul.LC_TabContentBigger li.active a {
1.911 bisitz 7738: background:url('/adm/lonIcons/tabbgleft.gif') left top no-repeat;
7739: color:$font;
1.744 ehlerst 7740: }
1.795 www 7741:
1.870 tempelho 7742: ul.LC_TabContentBigger li b {
1.911 bisitz 7743: background: url('/adm/lonIcons/tabbgright.gif') no-repeat right bottom;
7744: display: block;
7745: float: left;
7746: padding: 0 30px;
1.957 onken 7747: border-bottom: 1px solid $lg_border_color;
1.870 tempelho 7748: }
7749:
1.956 onken 7750: ul.LC_TabContentBigger li:hover b {
7751: color:$button_hover;
7752: }
7753:
1.870 tempelho 7754: ul.LC_TabContentBigger li.active b {
1.911 bisitz 7755: background:url('/adm/lonIcons/tabbgright.gif') right top no-repeat;
7756: color:$font;
1.957 onken 7757: border: 0;
1.741 harmsja 7758: }
1.693 droeschl 7759:
1.870 tempelho 7760:
1.862 bisitz 7761: ul.LC_CourseBreadcrumbs {
7762: background: $sidebg;
1.1020 raeburn 7763: height: 2em;
1.862 bisitz 7764: padding-left: 10px;
1.1020 raeburn 7765: margin: 0;
1.862 bisitz 7766: list-style-position: inside;
7767: }
7768:
1.911 bisitz 7769: ol#LC_MenuBreadcrumbs,
1.862 bisitz 7770: ol#LC_PathBreadcrumbs {
1.911 bisitz 7771: padding-left: 10px;
7772: margin: 0;
1.933 droeschl 7773: height: 2.5em; /* equal to #LC_breadcrumbs line-height */
1.693 droeschl 7774: }
7775:
1.911 bisitz 7776: ol#LC_MenuBreadcrumbs li,
7777: ol#LC_PathBreadcrumbs li,
1.862 bisitz 7778: ul.LC_CourseBreadcrumbs li {
1.911 bisitz 7779: display: inline;
1.933 droeschl 7780: white-space: normal;
1.693 droeschl 7781: }
7782:
1.823 bisitz 7783: ol#LC_MenuBreadcrumbs li a,
1.862 bisitz 7784: ul.LC_CourseBreadcrumbs li a {
1.911 bisitz 7785: text-decoration: none;
7786: font-size:90%;
1.693 droeschl 7787: }
1.795 www 7788:
1.969 droeschl 7789: ol#LC_MenuBreadcrumbs h1 {
7790: display: inline;
7791: font-size: 90%;
7792: line-height: 2.5em;
7793: margin: 0;
7794: padding: 0;
7795: }
7796:
1.795 www 7797: ol#LC_PathBreadcrumbs li a {
1.911 bisitz 7798: text-decoration:none;
7799: font-size:100%;
7800: font-weight:bold;
1.693 droeschl 7801: }
1.795 www 7802:
1.840 bisitz 7803: .LC_Box {
1.911 bisitz 7804: border: solid 1px $lg_border_color;
7805: padding: 0 10px 10px 10px;
1.746 neumanie 7806: }
1.795 www 7807:
1.1020 raeburn 7808: .LC_DocsBox {
7809: border: solid 1px $lg_border_color;
7810: padding: 0 0 10px 10px;
7811: }
7812:
1.795 www 7813: .LC_AboutMe_Image {
1.911 bisitz 7814: float:left;
7815: margin-right:10px;
1.747 neumanie 7816: }
1.795 www 7817:
7818: .LC_Clear_AboutMe_Image {
1.911 bisitz 7819: clear:left;
1.747 neumanie 7820: }
1.795 www 7821:
1.721 harmsja 7822: dl.LC_ListStyleClean dt {
1.911 bisitz 7823: padding-right: 5px;
7824: display: table-header-group;
1.693 droeschl 7825: }
7826:
1.721 harmsja 7827: dl.LC_ListStyleClean dd {
1.911 bisitz 7828: display: table-row;
1.693 droeschl 7829: }
7830:
1.721 harmsja 7831: .LC_ListStyleClean,
7832: .LC_ListStyleSimple,
7833: .LC_ListStyleNormal,
1.795 www 7834: .LC_ListStyleSpecial {
1.911 bisitz 7835: /* display:block; */
7836: list-style-position: inside;
7837: list-style-type: none;
7838: overflow: hidden;
7839: padding: 0;
1.693 droeschl 7840: }
7841:
1.721 harmsja 7842: .LC_ListStyleSimple li,
7843: .LC_ListStyleSimple dd,
7844: .LC_ListStyleNormal li,
7845: .LC_ListStyleNormal dd,
7846: .LC_ListStyleSpecial li,
1.795 www 7847: .LC_ListStyleSpecial dd {
1.911 bisitz 7848: margin: 0;
7849: padding: 5px 5px 5px 10px;
7850: clear: both;
1.693 droeschl 7851: }
7852:
1.721 harmsja 7853: .LC_ListStyleClean li,
7854: .LC_ListStyleClean dd {
1.911 bisitz 7855: padding-top: 0;
7856: padding-bottom: 0;
1.693 droeschl 7857: }
7858:
1.721 harmsja 7859: .LC_ListStyleSimple dd,
1.795 www 7860: .LC_ListStyleSimple li {
1.911 bisitz 7861: border-bottom: solid 1px $lg_border_color;
1.693 droeschl 7862: }
7863:
1.721 harmsja 7864: .LC_ListStyleSpecial li,
7865: .LC_ListStyleSpecial dd {
1.911 bisitz 7866: list-style-type: none;
7867: background-color: RGB(220, 220, 220);
7868: margin-bottom: 4px;
1.693 droeschl 7869: }
7870:
1.721 harmsja 7871: table.LC_SimpleTable {
1.911 bisitz 7872: margin:5px;
7873: border:solid 1px $lg_border_color;
1.795 www 7874: }
1.693 droeschl 7875:
1.721 harmsja 7876: table.LC_SimpleTable tr {
1.911 bisitz 7877: padding: 0;
7878: border:solid 1px $lg_border_color;
1.693 droeschl 7879: }
1.795 www 7880:
7881: table.LC_SimpleTable thead {
1.911 bisitz 7882: background:rgb(220,220,220);
1.693 droeschl 7883: }
7884:
1.721 harmsja 7885: div.LC_columnSection {
1.911 bisitz 7886: display: block;
7887: clear: both;
7888: overflow: hidden;
7889: margin: 0;
1.693 droeschl 7890: }
7891:
1.721 harmsja 7892: div.LC_columnSection>* {
1.911 bisitz 7893: float: left;
7894: margin: 10px 20px 10px 0;
7895: overflow:hidden;
1.693 droeschl 7896: }
1.721 harmsja 7897:
1.795 www 7898: table em {
1.911 bisitz 7899: font-weight: bold;
7900: font-style: normal;
1.748 schulted 7901: }
1.795 www 7902:
1.779 bisitz 7903: table.LC_tableBrowseRes,
1.795 www 7904: table.LC_tableOfContent {
1.911 bisitz 7905: border:none;
7906: border-spacing: 1px;
7907: padding: 3px;
7908: background-color: #FFFFFF;
7909: font-size: 90%;
1.753 droeschl 7910: }
1.789 droeschl 7911:
1.911 bisitz 7912: table.LC_tableOfContent {
7913: border-collapse: collapse;
1.789 droeschl 7914: }
7915:
1.771 droeschl 7916: table.LC_tableBrowseRes a,
1.768 schulted 7917: table.LC_tableOfContent a {
1.911 bisitz 7918: background-color: transparent;
7919: text-decoration: none;
1.753 droeschl 7920: }
7921:
1.795 www 7922: table.LC_tableOfContent img {
1.911 bisitz 7923: border: none;
7924: height: 1.3em;
7925: vertical-align: text-bottom;
7926: margin-right: 0.3em;
1.753 droeschl 7927: }
1.757 schulted 7928:
1.795 www 7929: a#LC_content_toolbar_firsthomework {
1.911 bisitz 7930: background-image:url(/res/adm/pages/open-first-problem.gif);
1.774 ehlerst 7931: }
7932:
1.795 www 7933: a#LC_content_toolbar_everything {
1.911 bisitz 7934: background-image:url(/res/adm/pages/show-all.gif);
1.774 ehlerst 7935: }
7936:
1.795 www 7937: a#LC_content_toolbar_uncompleted {
1.911 bisitz 7938: background-image:url(/res/adm/pages/show-incomplete-problems.gif);
1.774 ehlerst 7939: }
7940:
1.795 www 7941: #LC_content_toolbar_clearbubbles {
1.911 bisitz 7942: background-image:url(/res/adm/pages/mark-discussionentries-read.gif);
1.774 ehlerst 7943: }
7944:
1.795 www 7945: a#LC_content_toolbar_changefolder {
1.911 bisitz 7946: background : url(/res/adm/pages/close-all-folders.gif) top center ;
1.757 schulted 7947: }
7948:
1.795 www 7949: a#LC_content_toolbar_changefolder_toggled {
1.911 bisitz 7950: background-image:url(/res/adm/pages/open-all-folders.gif);
1.757 schulted 7951: }
7952:
1.1043 raeburn 7953: a#LC_content_toolbar_edittoplevel {
7954: background-image:url(/res/adm/pages/edittoplevel.gif);
7955: }
7956:
1.795 www 7957: ul#LC_toolbar li a:hover {
1.911 bisitz 7958: background-position: bottom center;
1.757 schulted 7959: }
7960:
1.795 www 7961: ul#LC_toolbar {
1.911 bisitz 7962: padding: 0;
7963: margin: 2px;
7964: list-style:none;
7965: position:relative;
7966: background-color:white;
1.1082 raeburn 7967: overflow: auto;
1.757 schulted 7968: }
7969:
1.795 www 7970: ul#LC_toolbar li {
1.911 bisitz 7971: border:1px solid white;
7972: padding: 0;
7973: margin: 0;
7974: float: left;
7975: display:inline;
7976: vertical-align:middle;
1.1082 raeburn 7977: white-space: nowrap;
1.911 bisitz 7978: }
1.757 schulted 7979:
1.783 amueller 7980:
1.795 www 7981: a.LC_toolbarItem {
1.911 bisitz 7982: display:block;
7983: padding: 0;
7984: margin: 0;
7985: height: 32px;
7986: width: 32px;
7987: color:white;
7988: border: none;
7989: background-repeat:no-repeat;
7990: background-color:transparent;
1.757 schulted 7991: }
7992:
1.915 droeschl 7993: ul.LC_funclist {
7994: margin: 0;
7995: padding: 0.5em 1em 0.5em 0;
7996: }
7997:
1.933 droeschl 7998: ul.LC_funclist > li:first-child {
7999: font-weight:bold;
8000: margin-left:0.8em;
8001: }
8002:
1.915 droeschl 8003: ul.LC_funclist + ul.LC_funclist {
8004: /*
8005: left border as a seperator if we have more than
8006: one list
8007: */
8008: border-left: 1px solid $sidebg;
8009: /*
8010: this hides the left border behind the border of the
8011: outer box if element is wrapped to the next 'line'
8012: */
8013: margin-left: -1px;
8014: }
8015:
1.843 bisitz 8016: ul.LC_funclist li {
1.915 droeschl 8017: display: inline;
1.782 bisitz 8018: white-space: nowrap;
1.915 droeschl 8019: margin: 0 0 0 25px;
8020: line-height: 150%;
1.782 bisitz 8021: }
8022:
1.974 wenzelju 8023: .LC_hidden {
8024: display: none;
8025: }
8026:
1.1030 www 8027: .LCmodal-overlay {
8028: position:fixed;
8029: top:0;
8030: right:0;
8031: bottom:0;
8032: left:0;
8033: height:100%;
8034: width:100%;
8035: margin:0;
8036: padding:0;
8037: background:#999;
8038: opacity:.75;
8039: filter: alpha(opacity=75);
8040: -moz-opacity: 0.75;
8041: z-index:101;
8042: }
8043:
8044: * html .LCmodal-overlay {
8045: position: absolute;
8046: height: expression(document.body.scrollHeight > document.body.offsetHeight ? document.body.scrollHeight : document.body.offsetHeight + 'px');
8047: }
8048:
8049: .LCmodal-window {
8050: position:fixed;
8051: top:50%;
8052: left:50%;
8053: margin:0;
8054: padding:0;
8055: z-index:102;
8056: }
8057:
8058: * html .LCmodal-window {
8059: position:absolute;
8060: }
8061:
8062: .LCclose-window {
8063: position:absolute;
8064: width:32px;
8065: height:32px;
8066: right:8px;
8067: top:8px;
8068: background:transparent url('/res/adm/pages/process-stop.png') no-repeat scroll right top;
8069: text-indent:-99999px;
8070: overflow:hidden;
8071: cursor:pointer;
8072: }
8073:
1.1100 raeburn 8074: /*
1.1231 damieng 8075: styles used for response display
8076: */
8077: div.LC_radiofoil, div.LC_rankfoil {
8078: margin: .5em 0em .5em 0em;
8079: }
8080: table.LC_itemgroup {
8081: margin-top: 1em;
8082: }
8083:
8084: /*
1.1100 raeburn 8085: styles used by TTH when "Default set of options to pass to tth/m
8086: when converting TeX" in course settings has been set
8087:
8088: option passed: -t
8089:
8090: */
8091:
8092: td div.comp { margin-top: -0.6ex; margin-bottom: -1ex;}
8093: td div.comb { margin-top: -0.6ex; margin-bottom: -.6ex;}
8094: td div.hrcomp { line-height: 0.9; margin-top: -0.8ex; margin-bottom: -1ex;}
8095: td div.norm {line-height:normal;}
8096:
8097: /*
8098: option passed -y3
8099: */
8100:
8101: span.roman {font-family: serif; font-style: normal; font-weight: normal;}
8102: span.overacc2 {position: relative; left: .8em; top: -1.2ex;}
8103: span.overacc1 {position: relative; left: .6em; top: -1.2ex;}
8104:
1.1230 damieng 8105: /*
8106: sections with roles, for content only
8107: */
8108: section[class^="role-"] {
8109: padding-left: 10px;
8110: padding-right: 5px;
8111: margin-top: 8px;
8112: margin-bottom: 8px;
8113: border: 1px solid #2A4;
8114: border-radius: 5px;
8115: box-shadow: 0px 1px 1px #BBB;
8116: }
8117: section[class^="role-"]>h1 {
8118: position: relative;
8119: margin: 0px;
8120: padding-top: 10px;
8121: padding-left: 40px;
8122: }
8123: section[class^="role-"]>h1:before {
8124: position: absolute;
8125: left: -5px;
8126: top: 5px;
8127: }
8128: section.role-activity>h1:before {
8129: content:url('/adm/daxe/images/section_icons/activity.png');
8130: }
8131: section.role-advice>h1:before {
8132: content:url('/adm/daxe/images/section_icons/advice.png');
8133: }
8134: section.role-bibliography>h1:before {
8135: content:url('/adm/daxe/images/section_icons/bibliography.png');
8136: }
8137: section.role-citation>h1:before {
8138: content:url('/adm/daxe/images/section_icons/citation.png');
8139: }
8140: section.role-conclusion>h1:before {
8141: content:url('/adm/daxe/images/section_icons/conclusion.png');
8142: }
8143: section.role-definition>h1:before {
8144: content:url('/adm/daxe/images/section_icons/definition.png');
8145: }
8146: section.role-demonstration>h1:before {
8147: content:url('/adm/daxe/images/section_icons/demonstration.png');
8148: }
8149: section.role-example>h1:before {
8150: content:url('/adm/daxe/images/section_icons/example.png');
8151: }
8152: section.role-explanation>h1:before {
8153: content:url('/adm/daxe/images/section_icons/explanation.png');
8154: }
8155: section.role-introduction>h1:before {
8156: content:url('/adm/daxe/images/section_icons/introduction.png');
8157: }
8158: section.role-method>h1:before {
8159: content:url('/adm/daxe/images/section_icons/method.png');
8160: }
8161: section.role-more_information>h1:before {
8162: content:url('/adm/daxe/images/section_icons/more_information.png');
8163: }
8164: section.role-objectives>h1:before {
8165: content:url('/adm/daxe/images/section_icons/objectives.png');
8166: }
8167: section.role-prerequisites>h1:before {
8168: content:url('/adm/daxe/images/section_icons/prerequisites.png');
8169: }
8170: section.role-remark>h1:before {
8171: content:url('/adm/daxe/images/section_icons/remark.png');
8172: }
8173: section.role-reminder>h1:before {
8174: content:url('/adm/daxe/images/section_icons/reminder.png');
8175: }
8176: section.role-summary>h1:before {
8177: content:url('/adm/daxe/images/section_icons/summary.png');
8178: }
8179: section.role-syntax>h1:before {
8180: content:url('/adm/daxe/images/section_icons/syntax.png');
8181: }
8182: section.role-warning>h1:before {
8183: content:url('/adm/daxe/images/section_icons/warning.png');
8184: }
8185:
1.1269 raeburn 8186: #LC_minitab_header {
8187: float:left;
8188: width:100%;
8189: background:#DAE0D2 url("/res/adm/pages/minitabmenu_bg.gif") repeat-x bottom;
8190: font-size:93%;
8191: line-height:normal;
8192: margin: 0.5em 0 0.5em 0;
8193: }
8194: #LC_minitab_header ul {
8195: margin:0;
8196: padding:10px 10px 0;
8197: list-style:none;
8198: }
8199: #LC_minitab_header li {
8200: float:left;
8201: background:url("/res/adm/pages/minitabmenu_left.gif") no-repeat left top;
8202: margin:0;
8203: padding:0 0 0 9px;
8204: }
8205: #LC_minitab_header a {
8206: display:block;
8207: background:url("/res/adm/pages/minitabmenu_right.gif") no-repeat right top;
8208: padding:5px 15px 4px 6px;
8209: }
8210: #LC_minitab_header #LC_current_minitab {
8211: background-image:url("/res/adm/pages/minitabmenu_left_on.gif");
8212: }
8213: #LC_minitab_header #LC_current_minitab a {
8214: background-image:url("/res/adm/pages/minitabmenu_right_on.gif");
8215: padding-bottom:5px;
8216: }
8217:
8218:
1.343 albertel 8219: END
8220: }
8221:
1.306 albertel 8222: =pod
8223:
8224: =item * &headtag()
8225:
8226: Returns a uniform footer for LON-CAPA web pages.
8227:
1.307 albertel 8228: Inputs: $title - optional title for the head
8229: $head_extra - optional extra HTML to put inside the <head>
1.315 albertel 8230: $args - optional arguments
1.319 albertel 8231: force_register - if is true call registerurl so the remote is
8232: informed
1.415 albertel 8233: redirect -> array ref of
8234: 1- seconds before redirect occurs
8235: 2- url to redirect to
8236: 3- whether the side effect should occur
1.315 albertel 8237: (side effect of setting
8238: $env{'internal.head.redirect'} to the url
8239: redirected too)
1.352 albertel 8240: domain -> force to color decorate a page for a specific
8241: domain
8242: function -> force usage of a specific rolish color scheme
8243: bgcolor -> override the default page bgcolor
1.460 albertel 8244: no_auto_mt_title
8245: -> prevent &mt()ing the title arg
1.464 albertel 8246:
1.306 albertel 8247: =cut
8248:
8249: sub headtag {
1.313 albertel 8250: my ($title,$head_extra,$args) = @_;
1.306 albertel 8251:
1.363 albertel 8252: my $function = $args->{'function'} || &get_users_function();
8253: my $domain = $args->{'domain'} || &determinedomain();
8254: my $bgcolor = $args->{'bgcolor'} || &designparm($function.'.pgbg',$domain);
1.1154 raeburn 8255: my $httphost = $args->{'use_absolute'};
1.418 albertel 8256: my $url = join(':',$env{'user.name'},$env{'user.domain'},
1.458 albertel 8257: $Apache::lonnet::perlvar{'lonVersion'},
1.531 albertel 8258: #time(),
1.418 albertel 8259: $env{'environment.color.timestamp'},
1.363 albertel 8260: $function,$domain,$bgcolor);
8261:
1.369 www 8262: $url = '/adm/css/'.&escape($url).'.css';
1.363 albertel 8263:
1.308 albertel 8264: my $result =
8265: '<head>'.
1.1160 raeburn 8266: &font_settings($args);
1.319 albertel 8267:
1.1188 raeburn 8268: my $inhibitprint;
8269: if ($args->{'print_suppress'}) {
8270: $inhibitprint = &print_suppression();
8271: }
1.1064 raeburn 8272:
1.461 albertel 8273: if (!$args->{'frameset'}) {
8274: $result .= &Apache::lonhtmlcommon::htmlareaheaders();
8275: }
1.962 droeschl 8276: if ($args->{'force_register'} && $env{'request.noversionuri'} !~ m{^/res/adm/pages/}) {
8277: $result .= Apache::lonxml::display_title();
1.319 albertel 8278: }
1.436 albertel 8279: if (!$args->{'no_nav_bar'}
8280: && !$args->{'only_body'}
8281: && !$args->{'frameset'}) {
1.1154 raeburn 8282: $result .= &help_menu_js($httphost);
1.1032 www 8283: $result.=&modal_window();
1.1038 www 8284: $result.=&togglebox_script();
1.1034 www 8285: $result.=&wishlist_window();
1.1041 www 8286: $result.=&LCprogressbarUpdate_script();
1.1034 www 8287: } else {
8288: if ($args->{'add_modal'}) {
8289: $result.=&modal_window();
8290: }
8291: if ($args->{'add_wishlist'}) {
8292: $result.=&wishlist_window();
8293: }
1.1038 www 8294: if ($args->{'add_togglebox'}) {
8295: $result.=&togglebox_script();
8296: }
1.1041 www 8297: if ($args->{'add_progressbar'}) {
8298: $result.=&LCprogressbarUpdate_script();
8299: }
1.436 albertel 8300: }
1.314 albertel 8301: if (ref($args->{'redirect'})) {
1.414 albertel 8302: my ($time,$url,$inhibit_continue) = @{$args->{'redirect'}};
1.315 albertel 8303: $url = &Apache::lonenc::check_encrypt($url);
1.414 albertel 8304: if (!$inhibit_continue) {
8305: $env{'internal.head.redirect'} = $url;
8306: }
1.313 albertel 8307: $result.=<<ADDMETA
8308: <meta http-equiv="pragma" content="no-cache" />
1.344 albertel 8309: <meta http-equiv="Refresh" content="$time; url=$url" />
1.313 albertel 8310: ADDMETA
1.1210 raeburn 8311: } else {
8312: unless (($args->{'frameset'}) || ($args->{'js_ready'}) || ($args->{'only_body'}) || ($args->{'no_nav_bar'})) {
8313: my $requrl = $env{'request.uri'};
8314: if ($requrl eq '') {
8315: $requrl = $ENV{'REQUEST_URI'};
8316: $requrl =~ s/\?.+$//;
8317: }
8318: unless (($requrl =~ m{^/adm/(?:switchserver|login|authenticate|logout|groupsort|cleanup|helper|slotrequest|grades)(\?|$)}) ||
8319: (($requrl =~ m{^/res/}) && (($env{'form.submitted'} eq 'scantron') ||
8320: ($env{'form.grade_symb'}) || ($Apache::lonhomework::scantronmode)))) {
8321: my $dom_in_use = $Apache::lonnet::perlvar{'lonDefDomain'};
8322: unless (&Apache::lonnet::allowed('mau',$dom_in_use)) {
8323: my %domdefs = &Apache::lonnet::get_domain_defaults($dom_in_use);
8324: if (ref($domdefs{'offloadnow'}) eq 'HASH') {
8325: my $lonhost = $Apache::lonnet::perlvar{'lonHostID'};
8326: if ($domdefs{'offloadnow'}{$lonhost}) {
8327: my $newserver = &Apache::lonnet::spareserver(30000,undef,1,$dom_in_use);
8328: if (($newserver) && ($newserver ne $lonhost)) {
8329: my $numsec = 5;
8330: my $timeout = $numsec * 1000;
8331: my ($newurl,$locknum,%locks,$msg);
8332: if ($env{'request.role.adv'}) {
8333: ($locknum,%locks) = &Apache::lonnet::get_locks();
8334: }
8335: my $disable_submit = 0;
8336: if ($requrl =~ /$LONCAPA::assess_re/) {
8337: $disable_submit = 1;
8338: }
8339: if ($locknum) {
8340: my @lockinfo = sort(values(%locks));
8341: $msg = &mt('Once the following tasks are complete: ')."\\n".
8342: join(", ",sort(values(%locks)))."\\n".
8343: &mt('your session will be transferred to a different server, after you click "Roles".');
8344: } else {
8345: if (($requrl =~ m{^/res/}) && ($env{'form.submitted'} =~ /^part_/)) {
8346: $msg = &mt('Your LON-CAPA submission has been recorded')."\\n";
8347: }
8348: $msg .= &mt('Your current LON-CAPA session will be transferred to a different server in [quant,_1,second].',$numsec);
8349: $newurl = '/adm/switchserver?otherserver='.$newserver;
8350: if (($env{'request.role'}) && ($env{'request.role'} ne 'cm')) {
8351: $newurl .= '&role='.$env{'request.role'};
8352: }
8353: if ($env{'request.symb'}) {
8354: $newurl .= '&symb='.$env{'request.symb'};
8355: } else {
8356: $newurl .= '&origurl='.$requrl;
8357: }
8358: }
1.1222 damieng 8359: &js_escape(\$msg);
1.1210 raeburn 8360: $result.=<<OFFLOAD
8361: <meta http-equiv="pragma" content="no-cache" />
8362: <script type="text/javascript">
1.1215 raeburn 8363: // <![CDATA[
1.1210 raeburn 8364: function LC_Offload_Now() {
8365: var dest = "$newurl";
8366: if (dest != '') {
8367: window.location.href="$newurl";
8368: }
8369: }
1.1214 raeburn 8370: \$(document).ready(function () {
8371: window.alert('$msg');
8372: if ($disable_submit) {
1.1210 raeburn 8373: \$(".LC_hwk_submit").prop("disabled", true);
8374: \$( ".LC_textline" ).prop( "readonly", "readonly");
1.1214 raeburn 8375: }
8376: setTimeout('LC_Offload_Now()', $timeout);
8377: });
1.1215 raeburn 8378: // ]]>
1.1210 raeburn 8379: </script>
8380: OFFLOAD
8381: }
8382: }
8383: }
8384: }
8385: }
8386: }
1.313 albertel 8387: }
1.306 albertel 8388: if (!defined($title)) {
8389: $title = 'The LearningOnline Network with CAPA';
8390: }
1.460 albertel 8391: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
8392: $result .= '<title> LON-CAPA '.$title.'</title>'
1.1168 raeburn 8393: .'<link rel="stylesheet" type="text/css" href="'.$url.'"';
8394: if (!$args->{'frameset'}) {
8395: $result .= ' /';
8396: }
8397: $result .= '>'
1.1064 raeburn 8398: .$inhibitprint
1.414 albertel 8399: .$head_extra;
1.1242 raeburn 8400: my $clientmobile;
8401: if (($env{'user.name'} eq '') && ($env{'user.domain'} eq '')) {
8402: (undef,undef,undef,undef,undef,undef,$clientmobile) = &decode_user_agent();
8403: } else {
8404: $clientmobile = $env{'browser.mobile'};
8405: }
8406: if ($clientmobile) {
1.1137 raeburn 8407: $result .= '
8408: <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=0, minimum-scale=1.0, maximum-scale=1.0">
8409: <meta name="apple-mobile-web-app-capable" content="yes" />';
8410: }
1.1278 raeburn 8411: $result .= '<meta name="google" content="notranslate" />'."\n";
1.962 droeschl 8412: return $result.'</head>';
1.306 albertel 8413: }
8414:
8415: =pod
8416:
1.340 albertel 8417: =item * &font_settings()
8418:
8419: Returns neccessary <meta> to set the proper encoding
8420:
1.1160 raeburn 8421: Inputs: optional reference to HASH -- $args passed to &headtag()
1.340 albertel 8422:
8423: =cut
8424:
8425: sub font_settings {
1.1160 raeburn 8426: my ($args) = @_;
1.340 albertel 8427: my $headerstring='';
1.1160 raeburn 8428: if ((!$env{'browser.mathml'} && $env{'browser.unicode'}) ||
8429: ((ref($args) eq 'HASH') && ($args->{'browser.unicode'}))) {
1.1168 raeburn 8430: $headerstring.=
8431: '<meta http-equiv="Content-Type" content="text/html; charset=utf-8"';
8432: if (!$args->{'frameset'}) {
8433: $headerstring.= ' /';
8434: }
8435: $headerstring .= '>'."\n";
1.340 albertel 8436: }
8437: return $headerstring;
8438: }
8439:
1.341 albertel 8440: =pod
8441:
1.1064 raeburn 8442: =item * &print_suppression()
8443:
8444: In course context returns css which causes the body to be blank when media="print",
8445: if printout generation is unavailable for the current resource.
8446:
8447: This could be because:
8448:
8449: (a) printstartdate is in the future
8450:
8451: (b) printenddate is in the past
8452:
8453: (c) there is an active exam block with "printout"
8454: functionality blocked
8455:
8456: Users with pav, pfo or evb privileges are exempt.
8457:
8458: Inputs: none
8459:
8460: =cut
8461:
8462:
8463: sub print_suppression {
8464: my $noprint;
8465: if ($env{'request.course.id'}) {
8466: my $scope = $env{'request.course.id'};
8467: if ((&Apache::lonnet::allowed('pav',$scope)) ||
8468: (&Apache::lonnet::allowed('pfo',$scope))) {
8469: return;
8470: }
8471: if ($env{'request.course.sec'} ne '') {
8472: $scope .= "/$env{'request.course.sec'}";
8473: if ((&Apache::lonnet::allowed('pav',$scope)) ||
8474: (&Apache::lonnet::allowed('pfo',$scope))) {
1.1065 raeburn 8475: return;
1.1064 raeburn 8476: }
8477: }
8478: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
8479: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
1.1189 raeburn 8480: my $blocked = &blocking_status('printout',$cnum,$cdom,undef,1);
1.1064 raeburn 8481: if ($blocked) {
8482: my $checkrole = "cm./$cdom/$cnum";
8483: if ($env{'request.course.sec'} ne '') {
8484: $checkrole .= "/$env{'request.course.sec'}";
8485: }
8486: unless ((&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) &&
8487: ($env{'request.role'} !~ m{^st\./$cdom/$cnum})) {
8488: $noprint = 1;
8489: }
8490: }
8491: unless ($noprint) {
8492: my $symb = &Apache::lonnet::symbread();
8493: if ($symb ne '') {
8494: my $navmap = Apache::lonnavmaps::navmap->new();
8495: if (ref($navmap)) {
8496: my $res = $navmap->getBySymb($symb);
8497: if (ref($res)) {
8498: if (!$res->resprintable()) {
8499: $noprint = 1;
8500: }
8501: }
8502: }
8503: }
8504: }
8505: if ($noprint) {
8506: return <<"ENDSTYLE";
8507: <style type="text/css" media="print">
8508: body { display:none }
8509: </style>
8510: ENDSTYLE
8511: }
8512: }
8513: return;
8514: }
8515:
8516: =pod
8517:
1.341 albertel 8518: =item * &xml_begin()
8519:
8520: Returns the needed doctype and <html>
8521:
8522: Inputs: none
8523:
8524: =cut
8525:
8526: sub xml_begin {
1.1168 raeburn 8527: my ($is_frameset) = @_;
1.341 albertel 8528: my $output='';
8529:
8530: if ($env{'browser.mathml'}) {
8531: $output='<?xml version="1.0"?>'
8532: #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
8533: # .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
8534:
8535: # .'<!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">] >'
8536: .'<!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">'
8537: .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" '
8538: .'xmlns="http://www.w3.org/1999/xhtml">';
1.1168 raeburn 8539: } elsif ($is_frameset) {
8540: $output='<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN" "http://www.w3.org/TR/html4/frameset.dtd">'."\n".
8541: '<html>'."\n";
1.341 albertel 8542: } else {
1.1168 raeburn 8543: $output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">'."\n".
8544: '<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">'."\n";
1.341 albertel 8545: }
8546: return $output;
8547: }
1.340 albertel 8548:
8549: =pod
8550:
1.306 albertel 8551: =item * &start_page()
8552:
8553: Returns a complete <html> .. <body> section for LON-CAPA web pages.
8554:
1.648 raeburn 8555: Inputs:
8556:
8557: =over 4
8558:
8559: $title - optional title for the page
8560:
8561: $head_extra - optional extra HTML to incude inside the <head>
8562:
8563: $args - additional optional args supported are:
8564:
8565: =over 8
8566:
8567: only_body -> is true will set &bodytag() onlybodytag
1.317 albertel 8568: arg on
1.814 bisitz 8569: no_nav_bar -> is true will set &bodytag() no_nav_bar arg on
1.648 raeburn 8570: add_entries -> additional attributes to add to the <body>
8571: domain -> force to color decorate a page for a
1.317 albertel 8572: specific domain
1.648 raeburn 8573: function -> force usage of a specific rolish color
1.317 albertel 8574: scheme
1.648 raeburn 8575: redirect -> see &headtag()
8576: bgcolor -> override the default page bg color
8577: js_ready -> return a string ready for being used in
1.317 albertel 8578: a javascript writeln
1.648 raeburn 8579: html_encode -> return a string ready for being used in
1.320 albertel 8580: a html attribute
1.648 raeburn 8581: force_register -> if is true will turn on the &bodytag()
1.317 albertel 8582: $forcereg arg
1.648 raeburn 8583: frameset -> if true will start with a <frameset>
1.330 albertel 8584: rather than <body>
1.648 raeburn 8585: skip_phases -> hash ref of
1.338 albertel 8586: head -> skip the <html><head> generation
8587: body -> skip all <body> generation
1.648 raeburn 8588: no_auto_mt_title -> prevent &mt()ing the title arg
1.867 kalberla 8589: bread_crumbs -> Array containing breadcrumbs
1.983 raeburn 8590: bread_crumbs_component -> if exists show it as headline else show only the breadcrumbs
1.1272 raeburn 8591: bread_crumbs_nomenu -> if true will pass false as the value of $menulink
8592: to lonhtmlcommon::breadcrumbs
1.1096 raeburn 8593: group -> includes the current group, if page is for a
1.1274 raeburn 8594: specific group
8595: use_absolute -> for request for external resource or syllabus, this
8596: will contain https://<hostname> if server uses
8597: https (as per hosts.tab), but request is for http
8598: hostname -> hostname, originally from $r->hostname(), (optional).
1.361 albertel 8599:
1.648 raeburn 8600: =back
1.460 albertel 8601:
1.648 raeburn 8602: =back
1.562 albertel 8603:
1.306 albertel 8604: =cut
8605:
8606: sub start_page {
1.309 albertel 8607: my ($title,$head_extra,$args) = @_;
1.318 albertel 8608: #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
1.319 albertel 8609:
1.315 albertel 8610: $env{'internal.start_page'}++;
1.1096 raeburn 8611: my ($result,@advtools);
1.964 droeschl 8612:
1.338 albertel 8613: if (! exists($args->{'skip_phases'}{'head'}) ) {
1.1168 raeburn 8614: $result .= &xml_begin($args->{'frameset'}) . &headtag($title, $head_extra, $args);
1.338 albertel 8615: }
8616:
8617: if (! exists($args->{'skip_phases'}{'body'}) ) {
8618: if ($args->{'frameset'}) {
8619: my $attr_string = &make_attr_string($args->{'force_register'},
8620: $args->{'add_entries'});
8621: $result .= "\n<frameset $attr_string>\n";
1.831 bisitz 8622: } else {
8623: $result .=
8624: &bodytag($title,
8625: $args->{'function'}, $args->{'add_entries'},
8626: $args->{'only_body'}, $args->{'domain'},
8627: $args->{'force_register'}, $args->{'no_nav_bar'},
1.1096 raeburn 8628: $args->{'bgcolor'}, $args,
8629: \@advtools);
1.831 bisitz 8630: }
1.330 albertel 8631: }
1.338 albertel 8632:
1.315 albertel 8633: if ($args->{'js_ready'}) {
1.713 kaisler 8634: $result = &js_ready($result);
1.315 albertel 8635: }
1.320 albertel 8636: if ($args->{'html_encode'}) {
1.713 kaisler 8637: $result = &html_encode($result);
8638: }
8639:
1.813 bisitz 8640: # Preparation for new and consistent functionlist at top of screen
8641: # if ($args->{'functionlist'}) {
8642: # $result .= &build_functionlist();
8643: #}
8644:
1.964 droeschl 8645: # Don't add anything more if only_body wanted or in const space
8646: return $result if $args->{'only_body'}
8647: || $env{'request.state'} eq 'construct';
1.813 bisitz 8648:
8649: #Breadcrumbs
1.758 kaisler 8650: if (exists($args->{'bread_crumbs'}) or exists($args->{'bread_crumbs_component'})) {
8651: &Apache::lonhtmlcommon::clear_breadcrumbs();
8652: #if any br links exists, add them to the breadcrumbs
8653: if (exists($args->{'bread_crumbs'}) and ref($args->{'bread_crumbs'}) eq 'ARRAY') {
8654: foreach my $crumb (@{$args->{'bread_crumbs'}}){
8655: &Apache::lonhtmlcommon::add_breadcrumb($crumb);
8656: }
8657: }
1.1096 raeburn 8658: # if @advtools array contains items add then to the breadcrumbs
8659: if (@advtools > 0) {
8660: &Apache::lonmenu::advtools_crumbs(@advtools);
8661: }
1.1272 raeburn 8662: my $menulink;
8663: # if arg: bread_crumbs_nomenu is true pass 0 as $menulink item.
8664: if ((exists($args->{'bread_crumbs_nomenu'})) ||
8665: ((($args->{'crstype'} eq 'Placement') || (($env{'request.course.id'}) &&
8666: ($env{'course.'.$env{'request.course.id'}.'.type'} eq 'Placement'))) &&
8667: (!$env{'request.role.adv'}))) {
8668: $menulink = 0;
8669: } else {
8670: undef($menulink);
8671: }
1.758 kaisler 8672: #if bread_crumbs_component exists show it as headline else show only the breadcrumbs
8673: if(exists($args->{'bread_crumbs_component'})){
1.1272 raeburn 8674: $result .= &Apache::lonhtmlcommon::breadcrumbs($args->{'bread_crumbs_component'},'',$menulink);
1.1237 raeburn 8675: } else {
1.1272 raeburn 8676: $result .= &Apache::lonhtmlcommon::breadcrumbs('','',$menulink);
1.758 kaisler 8677: }
1.320 albertel 8678: }
1.315 albertel 8679: return $result;
1.306 albertel 8680: }
8681:
8682: sub end_page {
1.315 albertel 8683: my ($args) = @_;
8684: $env{'internal.end_page'}++;
1.330 albertel 8685: my $result;
1.335 albertel 8686: if ($args->{'discussion'}) {
8687: my ($target,$parser);
8688: if (ref($args->{'discussion'})) {
8689: ($target,$parser) =($args->{'discussion'}{'target'},
8690: $args->{'discussion'}{'parser'});
8691: }
8692: $result .= &Apache::lonxml::xmlend($target,$parser);
8693: }
1.330 albertel 8694: if ($args->{'frameset'}) {
8695: $result .= '</frameset>';
8696: } else {
1.635 raeburn 8697: $result .= &endbodytag($args);
1.330 albertel 8698: }
1.1080 raeburn 8699: unless ($args->{'notbody'}) {
8700: $result .= "\n</html>";
8701: }
1.330 albertel 8702:
1.315 albertel 8703: if ($args->{'js_ready'}) {
1.317 albertel 8704: $result = &js_ready($result);
1.315 albertel 8705: }
1.335 albertel 8706:
1.320 albertel 8707: if ($args->{'html_encode'}) {
8708: $result = &html_encode($result);
8709: }
1.335 albertel 8710:
1.315 albertel 8711: return $result;
8712: }
8713:
1.1034 www 8714: sub wishlist_window {
8715: return(<<'ENDWISHLIST');
1.1046 raeburn 8716: <script type="text/javascript">
1.1034 www 8717: // <![CDATA[
8718: // <!-- BEGIN LON-CAPA Internal
8719: function set_wishlistlink(title, path) {
8720: if (!title) {
8721: title = document.title;
8722: title = title.replace(/^LON-CAPA /,'');
8723: }
1.1175 raeburn 8724: title = encodeURIComponent(title);
1.1203 raeburn 8725: title = title.replace("'","\\\'");
1.1034 www 8726: if (!path) {
8727: path = location.pathname;
8728: }
1.1175 raeburn 8729: path = encodeURIComponent(path);
1.1203 raeburn 8730: path = path.replace("'","\\\'");
1.1034 www 8731: Win = window.open('/adm/wishlist?mode=newLink&setTitle='+title+'&setPath='+path,
8732: 'wishlistNewLink','width=560,height=350,scrollbars=0');
8733: }
8734: // END LON-CAPA Internal -->
8735: // ]]>
8736: </script>
8737: ENDWISHLIST
8738: }
8739:
1.1030 www 8740: sub modal_window {
8741: return(<<'ENDMODAL');
1.1046 raeburn 8742: <script type="text/javascript">
1.1030 www 8743: // <![CDATA[
8744: // <!-- BEGIN LON-CAPA Internal
8745: var modalWindow = {
8746: parent:"body",
8747: windowId:null,
8748: content:null,
8749: width:null,
8750: height:null,
8751: close:function()
8752: {
8753: $(".LCmodal-window").remove();
8754: $(".LCmodal-overlay").remove();
8755: },
8756: open:function()
8757: {
8758: var modal = "";
8759: modal += "<div class=\"LCmodal-overlay\"></div>";
8760: 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;\">";
8761: modal += this.content;
8762: modal += "</div>";
8763:
8764: $(this.parent).append(modal);
8765:
8766: $(".LCmodal-window").append("<a class=\"LCclose-window\"></a>");
8767: $(".LCclose-window").click(function(){modalWindow.close();});
8768: $(".LCmodal-overlay").click(function(){modalWindow.close();});
8769: }
8770: };
1.1140 raeburn 8771: var openMyModal = function(source,width,height,scrolling,transparency,style)
1.1030 www 8772: {
1.1266 raeburn 8773: source = source.replace(/'/g,"'");
1.1030 www 8774: modalWindow.windowId = "myModal";
8775: modalWindow.width = width;
8776: modalWindow.height = height;
1.1196 raeburn 8777: modalWindow.content = "<iframe width='"+width+"' height='"+height+"' frameborder='0' scrolling='"+scrolling+"' allowtransparency='"+transparency+"' src='" + source + "' style='"+style+"'></iframe>";
1.1030 www 8778: modalWindow.open();
1.1208 raeburn 8779: };
1.1030 www 8780: // END LON-CAPA Internal -->
8781: // ]]>
8782: </script>
8783: ENDMODAL
8784: }
8785:
8786: sub modal_link {
1.1140 raeburn 8787: my ($link,$linktext,$width,$height,$target,$scrolling,$title,$transparency,$style)=@_;
1.1030 www 8788: unless ($width) { $width=480; }
8789: unless ($height) { $height=400; }
1.1031 www 8790: unless ($scrolling) { $scrolling='yes'; }
1.1140 raeburn 8791: unless ($transparency) { $transparency='true'; }
8792:
1.1074 raeburn 8793: my $target_attr;
8794: if (defined($target)) {
8795: $target_attr = 'target="'.$target.'"';
8796: }
8797: return <<"ENDLINK";
1.1140 raeburn 8798: <a href="$link" $target_attr title="$title" onclick="javascript:openMyModal('$link',$width,$height,'$scrolling','$transparency','$style'); return false;">
1.1074 raeburn 8799: $linktext</a>
8800: ENDLINK
1.1030 www 8801: }
8802:
1.1032 www 8803: sub modal_adhoc_script {
8804: my ($funcname,$width,$height,$content)=@_;
8805: return (<<ENDADHOC);
1.1046 raeburn 8806: <script type="text/javascript">
1.1032 www 8807: // <![CDATA[
8808: var $funcname = function()
8809: {
8810: modalWindow.windowId = "myModal";
8811: modalWindow.width = $width;
8812: modalWindow.height = $height;
8813: modalWindow.content = '$content';
8814: modalWindow.open();
8815: };
8816: // ]]>
8817: </script>
8818: ENDADHOC
8819: }
8820:
1.1041 www 8821: sub modal_adhoc_inner {
8822: my ($funcname,$width,$height,$content)=@_;
8823: my $innerwidth=$width-20;
8824: $content=&js_ready(
1.1140 raeburn 8825: &start_page('Dialog',undef,{'only_body'=>1,'bgcolor'=>'#FFFFFF'}).
8826: &start_scrollbox($width.'px',$innerwidth.'px',$height.'px','myModal','#FFFFFF',undef,1).
8827: $content.
1.1041 www 8828: &end_scrollbox().
1.1140 raeburn 8829: &end_page()
1.1041 www 8830: );
8831: return &modal_adhoc_script($funcname,$width,$height,$content);
8832: }
8833:
8834: sub modal_adhoc_window {
8835: my ($funcname,$width,$height,$content,$linktext)=@_;
8836: return &modal_adhoc_inner($funcname,$width,$height,$content).
8837: "<a href=\"javascript:$funcname();void(0);\">".$linktext."</a>";
8838: }
8839:
8840: sub modal_adhoc_launch {
8841: my ($funcname,$width,$height,$content)=@_;
8842: return &modal_adhoc_inner($funcname,$width,$height,$content).(<<ENDLAUNCH);
8843: <script type="text/javascript">
8844: // <![CDATA[
8845: $funcname();
8846: // ]]>
8847: </script>
8848: ENDLAUNCH
8849: }
8850:
8851: sub modal_adhoc_close {
8852: return (<<ENDCLOSE);
8853: <script type="text/javascript">
8854: // <![CDATA[
8855: modalWindow.close();
8856: // ]]>
8857: </script>
8858: ENDCLOSE
8859: }
8860:
1.1038 www 8861: sub togglebox_script {
8862: return(<<ENDTOGGLE);
8863: <script type="text/javascript">
8864: // <![CDATA[
8865: function LCtoggleDisplay(id,hidetext,showtext) {
8866: link = document.getElementById(id + "link").childNodes[0];
8867: with (document.getElementById(id).style) {
8868: if (display == "none" ) {
8869: display = "inline";
8870: link.nodeValue = hidetext;
8871: } else {
8872: display = "none";
8873: link.nodeValue = showtext;
8874: }
8875: }
8876: }
8877: // ]]>
8878: </script>
8879: ENDTOGGLE
8880: }
8881:
1.1039 www 8882: sub start_togglebox {
8883: my ($id,$heading,$headerbg,$hidetext,$showtext)=@_;
8884: unless ($heading) { $heading=''; } else { $heading.=' '; }
8885: unless ($showtext) { $showtext=&mt('show'); }
8886: unless ($hidetext) { $hidetext=&mt('hide'); }
8887: unless ($headerbg) { $headerbg='#FFFFFF'; }
8888: return &start_data_table().
8889: &start_data_table_header_row().
8890: '<td bgcolor="'.$headerbg.'">'.$heading.
8891: '[<a id="'.$id.'link" href="javascript:LCtoggleDisplay(\''.$id.'\',\''.$hidetext.'\',\''.
8892: $showtext.'\')">'.$showtext.'</a>]</td>'.
8893: &end_data_table_header_row().
8894: '<tr id="'.$id.'" style="display:none""><td>';
8895: }
8896:
8897: sub end_togglebox {
8898: return '</td></tr>'.&end_data_table();
8899: }
8900:
1.1041 www 8901: sub LCprogressbar_script {
1.1302 raeburn 8902: my ($id,$number_to_do)=@_;
8903: if ($number_to_do) {
8904: return(<<ENDPROGRESS);
1.1041 www 8905: <script type="text/javascript">
8906: // <![CDATA[
1.1045 www 8907: \$('#progressbar$id').progressbar({
1.1041 www 8908: value: 0,
8909: change: function(event, ui) {
8910: var newVal = \$(this).progressbar('option', 'value');
8911: \$('.pblabel', this).text(LCprogressTxt);
8912: }
8913: });
8914: // ]]>
8915: </script>
8916: ENDPROGRESS
1.1302 raeburn 8917: } else {
8918: return(<<ENDPROGRESS);
8919: <script type="text/javascript">
8920: // <![CDATA[
8921: \$('#progressbar$id').progressbar({
8922: value: false,
8923: create: function(event, ui) {
8924: \$('.ui-widget-header', this).css({'background':'#F0F0F0'});
8925: \$('.ui-progressbar-overlay', this).css({'margin':'0'});
8926: }
8927: });
8928: // ]]>
8929: </script>
8930: ENDPROGRESS
8931: }
1.1041 www 8932: }
8933:
8934: sub LCprogressbarUpdate_script {
8935: return(<<ENDPROGRESSUPDATE);
8936: <style type="text/css">
8937: .ui-progressbar { position:relative; }
1.1302 raeburn 8938: .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 8939: .pblabel { position: absolute; width: 100%; text-align: center; line-height: 1.9em; }
8940: </style>
8941: <script type="text/javascript">
8942: // <![CDATA[
1.1045 www 8943: var LCprogressTxt='---';
8944:
1.1302 raeburn 8945: function LCupdateProgress(percent,progresstext,id,maxnum) {
1.1041 www 8946: LCprogressTxt=progresstext;
1.1302 raeburn 8947: if ((maxnum == '') || (maxnum == undefined) || (maxnum == null)) {
8948: \$('#progressbar'+id).find('.progress-label').text(LCprogressTxt);
8949: } else if (percent === \$('#progressbar'+id).progressbar( "value" )) {
1.1301 raeburn 8950: \$('#progressbar'+id).find('.pblabel').text(LCprogressTxt);
8951: } else {
8952: \$('#progressbar'+id).progressbar('value',percent);
8953: }
1.1041 www 8954: }
8955: // ]]>
8956: </script>
8957: ENDPROGRESSUPDATE
8958: }
8959:
1.1042 www 8960: my $LClastpercent;
1.1045 www 8961: my $LCidcnt;
8962: my $LCcurrentid;
1.1042 www 8963:
1.1041 www 8964: sub LCprogressbar {
1.1302 raeburn 8965: my ($r,$number_to_do,$preamble)=@_;
1.1042 www 8966: $LClastpercent=0;
1.1045 www 8967: $LCidcnt++;
8968: $LCcurrentid=$$.'_'.$LCidcnt;
1.1302 raeburn 8969: my ($starting,$content);
8970: if ($number_to_do) {
8971: $starting=&mt('Starting');
8972: $content=(<<ENDPROGBAR);
8973: $preamble
1.1045 www 8974: <div id="progressbar$LCcurrentid">
1.1041 www 8975: <span class="pblabel">$starting</span>
8976: </div>
8977: ENDPROGBAR
1.1302 raeburn 8978: } else {
8979: $starting=&mt('Loading...');
8980: $LClastpercent='false';
8981: $content=(<<ENDPROGBAR);
8982: $preamble
8983: <div id="progressbar$LCcurrentid">
8984: <div class="progress-label">$starting</div>
8985: </div>
8986: ENDPROGBAR
8987: }
8988: &r_print($r,$content.&LCprogressbar_script($LCcurrentid,$number_to_do));
1.1041 www 8989: }
8990:
8991: sub LCprogressbarUpdate {
1.1302 raeburn 8992: my ($r,$val,$text,$number_to_do)=@_;
8993: if ($number_to_do) {
8994: unless ($val) {
8995: if ($LClastpercent) {
8996: $val=$LClastpercent;
8997: } else {
8998: $val=0;
8999: }
9000: }
9001: if ($val<0) { $val=0; }
9002: if ($val>100) { $val=0; }
9003: $LClastpercent=$val;
9004: unless ($text) { $text=$val.'%'; }
9005: } else {
9006: $val = 'false';
1.1042 www 9007: }
1.1041 www 9008: $text=&js_ready($text);
1.1044 www 9009: &r_print($r,<<ENDUPDATE);
1.1041 www 9010: <script type="text/javascript">
9011: // <![CDATA[
1.1302 raeburn 9012: LCupdateProgress($val,'$text','$LCcurrentid','$number_to_do');
1.1041 www 9013: // ]]>
9014: </script>
9015: ENDUPDATE
1.1035 www 9016: }
9017:
1.1042 www 9018: sub LCprogressbarClose {
9019: my ($r)=@_;
9020: $LClastpercent=0;
1.1044 www 9021: &r_print($r,<<ENDCLOSE);
1.1042 www 9022: <script type="text/javascript">
9023: // <![CDATA[
1.1045 www 9024: \$("#progressbar$LCcurrentid").hide('slow');
1.1042 www 9025: // ]]>
9026: </script>
9027: ENDCLOSE
1.1044 www 9028: }
9029:
9030: sub r_print {
9031: my ($r,$to_print)=@_;
9032: if ($r) {
9033: $r->print($to_print);
9034: $r->rflush();
9035: } else {
9036: print($to_print);
9037: }
1.1042 www 9038: }
9039:
1.320 albertel 9040: sub html_encode {
9041: my ($result) = @_;
9042:
1.322 albertel 9043: $result = &HTML::Entities::encode($result,'<>&"');
1.320 albertel 9044:
9045: return $result;
9046: }
1.1044 www 9047:
1.317 albertel 9048: sub js_ready {
9049: my ($result) = @_;
9050:
1.323 albertel 9051: $result =~ s/[\n\r]/ /xmsg;
9052: $result =~ s/\\/\\\\/xmsg;
9053: $result =~ s/'/\\'/xmsg;
1.372 albertel 9054: $result =~ s{</}{<\\/}xmsg;
1.317 albertel 9055:
9056: return $result;
9057: }
9058:
1.315 albertel 9059: sub validate_page {
9060: if ( exists($env{'internal.start_page'})
1.316 albertel 9061: && $env{'internal.start_page'} > 1) {
9062: &Apache::lonnet::logthis('start_page called multiple times '.
1.318 albertel 9063: $env{'internal.start_page'}.' '.
1.316 albertel 9064: $ENV{'request.filename'});
1.315 albertel 9065: }
9066: if ( exists($env{'internal.end_page'})
1.316 albertel 9067: && $env{'internal.end_page'} > 1) {
9068: &Apache::lonnet::logthis('end_page called multiple times '.
1.318 albertel 9069: $env{'internal.end_page'}.' '.
1.316 albertel 9070: $env{'request.filename'});
1.315 albertel 9071: }
9072: if ( exists($env{'internal.start_page'})
9073: && ! exists($env{'internal.end_page'})) {
1.316 albertel 9074: &Apache::lonnet::logthis('start_page called without end_page '.
9075: $env{'request.filename'});
1.315 albertel 9076: }
9077: if ( ! exists($env{'internal.start_page'})
9078: && exists($env{'internal.end_page'})) {
1.316 albertel 9079: &Apache::lonnet::logthis('end_page called without start_page'.
9080: $env{'request.filename'});
1.315 albertel 9081: }
1.306 albertel 9082: }
1.315 albertel 9083:
1.996 www 9084:
9085: sub start_scrollbox {
1.1140 raeburn 9086: my ($outerwidth,$width,$height,$id,$bgcolor,$cursor,$needjsready) = @_;
1.998 raeburn 9087: unless ($outerwidth) { $outerwidth='520px'; }
9088: unless ($width) { $width='500px'; }
9089: unless ($height) { $height='200px'; }
1.1075 raeburn 9090: my ($table_id,$div_id,$tdcol);
1.1018 raeburn 9091: if ($id ne '') {
1.1140 raeburn 9092: $table_id = ' id="table_'.$id.'"';
1.1137 raeburn 9093: $div_id = ' id="div_'.$id.'"';
1.1018 raeburn 9094: }
1.1075 raeburn 9095: if ($bgcolor ne '') {
9096: $tdcol = "background-color: $bgcolor;";
9097: }
1.1137 raeburn 9098: my $nicescroll_js;
9099: if ($env{'browser.mobile'}) {
1.1140 raeburn 9100: $nicescroll_js = &nicescroll_javascript('div_'.$id,$cursor,$needjsready);
9101: }
9102: return <<"END";
9103: $nicescroll_js
9104:
9105: <table style="width: $outerwidth; border: 1px solid none;"$table_id><tr><td style="width: $width;$tdcol">
9106: <div style="overflow:auto; width:$width; height:$height;"$div_id>
9107: END
9108: }
9109:
9110: sub end_scrollbox {
9111: return '</div></td></tr></table>';
9112: }
9113:
9114: sub nicescroll_javascript {
9115: my ($id,$cursor,$needjsready,$framecheck,$location) = @_;
9116: my %options;
9117: if (ref($cursor) eq 'HASH') {
9118: %options = %{$cursor};
9119: }
9120: unless ($options{'railalign'} =~ /^left|right$/) {
9121: $options{'railalign'} = 'left';
9122: }
9123: unless ($options{'cursorcolor'} =~ /^\#\w+$/) {
9124: my $function = &get_users_function();
9125: $options{'cursorcolor'} = &designparm($function.'.sidebg',$env{'request.role.domain'});
1.1138 raeburn 9126: unless ($options{'cursorcolor'} =~ /^\#\w+$/) {
1.1140 raeburn 9127: $options{'cursorcolor'} = '#00F';
1.1138 raeburn 9128: }
1.1140 raeburn 9129: }
9130: if ($options{'cursoropacity'} =~ /^[\d.]+$/) {
9131: unless ($options{'cursoropacity'} >= 0.0 && $options{'cursoropacity'} <=1.0) {
1.1138 raeburn 9132: $options{'cursoropacity'}='1.0';
9133: }
1.1140 raeburn 9134: } else {
9135: $options{'cursoropacity'}='1.0';
9136: }
9137: if ($options{'cursorfixedheight'} eq 'none') {
9138: delete($options{'cursorfixedheight'});
9139: } else {
9140: unless ($options{'cursorfixedheight'} =~ /^\d+$/) { $options{'cursorfixedheight'}='50'; }
9141: }
9142: unless ($options{'railoffset'} =~ /^{[\w\:\d\-,]+}$/) {
9143: delete($options{'railoffset'});
9144: }
9145: my @niceoptions;
9146: while (my($key,$value) = each(%options)) {
9147: if ($value =~ /^\{.+\}$/) {
9148: push(@niceoptions,$key.':'.$value);
1.1138 raeburn 9149: } else {
1.1140 raeburn 9150: push(@niceoptions,$key.':"'.$value.'"');
1.1138 raeburn 9151: }
1.1140 raeburn 9152: }
9153: my $nicescroll_js = '
1.1137 raeburn 9154: $(document).ready(
1.1140 raeburn 9155: function() {
9156: $("#'.$id.'").niceScroll({'.join(',',@niceoptions).'});
9157: }
1.1137 raeburn 9158: );
9159: ';
1.1140 raeburn 9160: if ($framecheck) {
9161: $nicescroll_js .= '
9162: function expand_div(caller) {
9163: if (top === self) {
9164: document.getElementById("'.$id.'").style.width = "auto";
9165: document.getElementById("'.$id.'").style.height = "auto";
9166: } else {
9167: try {
9168: if (parent.frames) {
9169: if (parent.frames.length > 1) {
9170: var framesrc = parent.frames[1].location.href;
9171: var currsrc = framesrc.replace(/\#.*$/,"");
9172: if ((caller == "search") || (currsrc == "'.$location.'")) {
9173: document.getElementById("'.$id.'").style.width = "auto";
9174: document.getElementById("'.$id.'").style.height = "auto";
9175: }
9176: }
9177: }
9178: } catch (e) {
9179: return;
9180: }
1.1137 raeburn 9181: }
1.1140 raeburn 9182: return;
1.996 www 9183: }
1.1140 raeburn 9184: ';
9185: }
9186: if ($needjsready) {
9187: $nicescroll_js = '
9188: <script type="text/javascript">'."\n".$nicescroll_js."\n</script>\n";
9189: } else {
9190: $nicescroll_js = &Apache::lonhtmlcommon::scripttag($nicescroll_js);
9191: }
9192: return $nicescroll_js;
1.996 www 9193: }
9194:
1.318 albertel 9195: sub simple_error_page {
1.1150 bisitz 9196: my ($r,$title,$msg,$args) = @_;
1.1304 raeburn 9197: my %displayargs;
1.1151 raeburn 9198: if (ref($args) eq 'HASH') {
9199: if (!$args->{'no_auto_mt_msg'}) { $msg = &mt($msg); }
1.1304 raeburn 9200: if ($args->{'only_body'}) {
9201: $displayargs{'only_body'} = 1;
9202: }
9203: if ($args->{'no_nav_bar'}) {
9204: $displayargs{'no_nav_bar'} = 1;
9205: }
1.1151 raeburn 9206: } else {
9207: $msg = &mt($msg);
9208: }
1.1150 bisitz 9209:
1.318 albertel 9210: my $page =
1.1304 raeburn 9211: &Apache::loncommon::start_page($title,'',\%displayargs).
1.1150 bisitz 9212: '<p class="LC_error">'.$msg.'</p>'.
1.318 albertel 9213: &Apache::loncommon::end_page();
9214: if (ref($r)) {
9215: $r->print($page);
1.327 albertel 9216: return;
1.318 albertel 9217: }
9218: return $page;
9219: }
1.347 albertel 9220:
9221: {
1.610 albertel 9222: my @row_count;
1.961 onken 9223:
9224: sub start_data_table_count {
9225: unshift(@row_count, 0);
9226: return;
9227: }
9228:
9229: sub end_data_table_count {
9230: shift(@row_count);
9231: return;
9232: }
9233:
1.347 albertel 9234: sub start_data_table {
1.1018 raeburn 9235: my ($add_class,$id) = @_;
1.422 albertel 9236: my $css_class = (join(' ','LC_data_table',$add_class));
1.1018 raeburn 9237: my $table_id;
9238: if (defined($id)) {
9239: $table_id = ' id="'.$id.'"';
9240: }
1.961 onken 9241: &start_data_table_count();
1.1018 raeburn 9242: return '<table class="'.$css_class.'"'.$table_id.'>'."\n";
1.347 albertel 9243: }
9244:
9245: sub end_data_table {
1.961 onken 9246: &end_data_table_count();
1.389 albertel 9247: return '</table>'."\n";;
1.347 albertel 9248: }
9249:
9250: sub start_data_table_row {
1.974 wenzelju 9251: my ($add_class, $id) = @_;
1.610 albertel 9252: $row_count[0]++;
9253: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.900 bisitz 9254: $css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
1.974 wenzelju 9255: $id = (' id="'.$id.'"') unless ($id eq '');
9256: return '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.347 albertel 9257: }
1.471 banghart 9258:
9259: sub continue_data_table_row {
1.974 wenzelju 9260: my ($add_class, $id) = @_;
1.610 albertel 9261: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.974 wenzelju 9262: $css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
9263: $id = (' id="'.$id.'"') unless ($id eq '');
9264: return '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.471 banghart 9265: }
1.347 albertel 9266:
9267: sub end_data_table_row {
1.389 albertel 9268: return '</tr>'."\n";;
1.347 albertel 9269: }
1.367 www 9270:
1.421 albertel 9271: sub start_data_table_empty_row {
1.707 bisitz 9272: # $row_count[0]++;
1.421 albertel 9273: return '<tr class="LC_empty_row" >'."\n";;
9274: }
9275:
9276: sub end_data_table_empty_row {
9277: return '</tr>'."\n";;
9278: }
9279:
1.367 www 9280: sub start_data_table_header_row {
1.389 albertel 9281: return '<tr class="LC_header_row">'."\n";;
1.367 www 9282: }
9283:
9284: sub end_data_table_header_row {
1.389 albertel 9285: return '</tr>'."\n";;
1.367 www 9286: }
1.890 droeschl 9287:
9288: sub data_table_caption {
9289: my $caption = shift;
9290: return "<caption class=\"LC_caption\">$caption</caption>";
9291: }
1.347 albertel 9292: }
9293:
1.548 albertel 9294: =pod
9295:
9296: =item * &inhibit_menu_check($arg)
9297:
9298: Checks for a inhibitmenu state and generates output to preserve it
9299:
9300: Inputs: $arg - can be any of
9301: - undef - in which case the return value is a string
9302: to add into arguments list of a uri
9303: - 'input' - in which case the return value is a HTML
9304: <form> <input> field of type hidden to
9305: preserve the value
9306: - a url - in which case the return value is the url with
9307: the neccesary cgi args added to preserve the
9308: inhibitmenu state
9309: - a ref to a url - no return value, but the string is
9310: updated to include the neccessary cgi
9311: args to preserve the inhibitmenu state
9312:
9313: =cut
9314:
9315: sub inhibit_menu_check {
9316: my ($arg) = @_;
9317: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
9318: if ($arg eq 'input') {
9319: if ($env{'form.inhibitmenu'}) {
9320: return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
9321: } else {
9322: return
9323: }
9324: }
9325: if ($env{'form.inhibitmenu'}) {
9326: if (ref($arg)) {
9327: $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
9328: } elsif ($arg eq '') {
9329: $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
9330: } else {
9331: $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
9332: }
9333: }
9334: if (!ref($arg)) {
9335: return $arg;
9336: }
9337: }
9338:
1.251 albertel 9339: ###############################################
1.182 matthew 9340:
9341: =pod
9342:
1.549 albertel 9343: =back
9344:
9345: =head1 User Information Routines
9346:
9347: =over 4
9348:
1.405 albertel 9349: =item * &get_users_function()
1.182 matthew 9350:
9351: Used by &bodytag to determine the current users primary role.
9352: Returns either 'student','coordinator','admin', or 'author'.
9353:
9354: =cut
9355:
9356: ###############################################
9357: sub get_users_function {
1.815 tempelho 9358: my $function = 'norole';
1.818 tempelho 9359: if ($env{'request.role'}=~/^(st)/) {
9360: $function='student';
9361: }
1.907 raeburn 9362: if ($env{'request.role'}=~/^(cc|co|in|ta|ep)/) {
1.182 matthew 9363: $function='coordinator';
9364: }
1.258 albertel 9365: if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182 matthew 9366: $function='admin';
9367: }
1.826 bisitz 9368: if (($env{'request.role'}=~/^(au|ca|aa)/) ||
1.1025 raeburn 9369: ($ENV{'REQUEST_URI'}=~ m{/^(/priv)})) {
1.182 matthew 9370: $function='author';
9371: }
9372: return $function;
1.54 www 9373: }
1.99 www 9374:
9375: ###############################################
9376:
1.233 raeburn 9377: =pod
9378:
1.821 raeburn 9379: =item * &show_course()
9380:
9381: Used by lonmenu.pm and lonroles.pm to determine whether to use the word
9382: 'Courses' or 'Roles' in inline navigation and on screen displaying user's roles.
9383:
9384: Inputs:
9385: None
9386:
9387: Outputs:
9388: Scalar: 1 if 'Course' to be used, 0 otherwise.
9389:
9390: =cut
9391:
9392: ###############################################
9393: sub show_course {
9394: my $course = !$env{'user.adv'};
9395: if (!$env{'user.adv'}) {
9396: foreach my $env (keys(%env)) {
9397: next if ($env !~ m/^user\.priv\./);
9398: if ($env !~ m/^user\.priv\.(?:st|cm)/) {
9399: $course = 0;
9400: last;
9401: }
9402: }
9403: }
9404: return $course;
9405: }
9406:
9407: ###############################################
9408:
9409: =pod
9410:
1.542 raeburn 9411: =item * &check_user_status()
1.274 raeburn 9412:
9413: Determines current status of supplied role for a
9414: specific user. Roles can be active, previous or future.
9415:
9416: Inputs:
9417: user's domain, user's username, course's domain,
1.375 raeburn 9418: course's number, optional section ID.
1.274 raeburn 9419:
9420: Outputs:
9421: role status: active, previous or future.
9422:
9423: =cut
9424:
9425: sub check_user_status {
1.412 raeburn 9426: my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
1.1073 raeburn 9427: my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname);
1.1202 raeburn 9428: my @uroles = keys(%userinfo);
1.274 raeburn 9429: my $srchstr;
9430: my $active_chk = 'none';
1.412 raeburn 9431: my $now = time;
1.274 raeburn 9432: if (@uroles > 0) {
1.908 raeburn 9433: if (($role eq 'cc') || ($role eq 'co') || ($sec eq '') || (!defined($sec))) {
1.274 raeburn 9434: $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
9435: } else {
1.412 raeburn 9436: $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
9437: }
9438: if (grep/^\Q$srchstr\E$/,@uroles) {
1.274 raeburn 9439: my $role_end = 0;
9440: my $role_start = 0;
9441: $active_chk = 'active';
1.412 raeburn 9442: if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
9443: $role_end = $1;
9444: if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
9445: $role_start = $1;
1.274 raeburn 9446: }
9447: }
9448: if ($role_start > 0) {
1.412 raeburn 9449: if ($now < $role_start) {
1.274 raeburn 9450: $active_chk = 'future';
9451: }
9452: }
9453: if ($role_end > 0) {
1.412 raeburn 9454: if ($now > $role_end) {
1.274 raeburn 9455: $active_chk = 'previous';
9456: }
9457: }
9458: }
9459: }
9460: return $active_chk;
9461: }
9462:
9463: ###############################################
9464:
9465: =pod
9466:
1.405 albertel 9467: =item * &get_sections()
1.233 raeburn 9468:
9469: Determines all the sections for a course including
9470: sections with students and sections containing other roles.
1.419 raeburn 9471: Incoming parameters:
9472:
9473: 1. domain
9474: 2. course number
9475: 3. reference to array containing roles for which sections should
9476: be gathered (optional).
9477: 4. reference to array containing status types for which sections
9478: should be gathered (optional).
9479:
9480: If the third argument is undefined, sections are gathered for any role.
9481: If the fourth argument is undefined, sections are gathered for any status.
9482: Permissible values are 'active' or 'future' or 'previous'.
1.233 raeburn 9483:
1.374 raeburn 9484: Returns section hash (keys are section IDs, values are
9485: number of users in each section), subject to the
1.419 raeburn 9486: optional roles filter, optional status filter
1.233 raeburn 9487:
9488: =cut
9489:
9490: ###############################################
9491: sub get_sections {
1.419 raeburn 9492: my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
1.366 albertel 9493: if (!defined($cdom) || !defined($cnum)) {
9494: my $cid = $env{'request.course.id'};
9495:
9496: return if (!defined($cid));
9497:
9498: $cdom = $env{'course.'.$cid.'.domain'};
9499: $cnum = $env{'course.'.$cid.'.num'};
9500: }
9501:
9502: my %sectioncount;
1.419 raeburn 9503: my $now = time;
1.240 albertel 9504:
1.1118 raeburn 9505: my $check_students = 1;
9506: my $only_students = 0;
9507: if (ref($possible_roles) eq 'ARRAY') {
9508: if (grep(/^st$/,@{$possible_roles})) {
9509: if (@{$possible_roles} == 1) {
9510: $only_students = 1;
9511: }
9512: } else {
9513: $check_students = 0;
9514: }
9515: }
9516:
9517: if ($check_students) {
1.276 albertel 9518: my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240 albertel 9519: my $sec_index = &Apache::loncoursedata::CL_SECTION();
9520: my $status_index = &Apache::loncoursedata::CL_STATUS();
1.419 raeburn 9521: my $start_index = &Apache::loncoursedata::CL_START();
9522: my $end_index = &Apache::loncoursedata::CL_END();
9523: my $status;
1.366 albertel 9524: while (my ($student,$data) = each(%$classlist)) {
1.419 raeburn 9525: my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
9526: $data->[$status_index],
9527: $data->[$start_index],
9528: $data->[$end_index]);
9529: if ($stu_status eq 'Active') {
9530: $status = 'active';
9531: } elsif ($end < $now) {
9532: $status = 'previous';
9533: } elsif ($start > $now) {
9534: $status = 'future';
9535: }
9536: if ($section ne '-1' && $section !~ /^\s*$/) {
9537: if ((!defined($possible_status)) || (($status ne '') &&
9538: (grep/^\Q$status\E$/,@{$possible_status}))) {
9539: $sectioncount{$section}++;
9540: }
1.240 albertel 9541: }
9542: }
9543: }
1.1118 raeburn 9544: if ($only_students) {
9545: return %sectioncount;
9546: }
1.240 albertel 9547: my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
9548: foreach my $user (sort(keys(%courseroles))) {
9549: if ($user !~ /^(\w{2})/) { next; }
9550: my ($role) = ($user =~ /^(\w{2})/);
9551: if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
1.419 raeburn 9552: my ($section,$status);
1.240 albertel 9553: if ($role eq 'cr' &&
9554: $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
9555: $section=$1;
9556: }
9557: if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
9558: if (!defined($section) || $section eq '-1') { next; }
1.419 raeburn 9559: my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
9560: if ($end == -1 && $start == -1) {
9561: next; #deleted role
9562: }
9563: if (!defined($possible_status)) {
9564: $sectioncount{$section}++;
9565: } else {
9566: if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
9567: $status = 'active';
9568: } elsif ($end < $now) {
9569: $status = 'future';
9570: } elsif ($start > $now) {
9571: $status = 'previous';
9572: }
9573: if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
9574: $sectioncount{$section}++;
9575: }
9576: }
1.233 raeburn 9577: }
1.366 albertel 9578: return %sectioncount;
1.233 raeburn 9579: }
9580:
1.274 raeburn 9581: ###############################################
1.294 raeburn 9582:
9583: =pod
1.405 albertel 9584:
9585: =item * &get_course_users()
9586:
1.275 raeburn 9587: Retrieves usernames:domains for users in the specified course
9588: with specific role(s), and access status.
9589:
9590: Incoming parameters:
1.277 albertel 9591: 1. course domain
9592: 2. course number
9593: 3. access status: users must have - either active,
1.275 raeburn 9594: previous, future, or all.
1.277 albertel 9595: 4. reference to array of permissible roles
1.288 raeburn 9596: 5. reference to array of section restrictions (optional)
9597: 6. reference to results object (hash of hashes).
9598: 7. reference to optional userdata hash
1.609 raeburn 9599: 8. reference to optional statushash
1.630 raeburn 9600: 9. flag if privileged users (except those set to unhide in
9601: course settings) should be excluded
1.609 raeburn 9602: Keys of top level results hash are roles.
1.275 raeburn 9603: Keys of inner hashes are username:domain, with
9604: values set to access type.
1.288 raeburn 9605: Optional userdata hash returns an array with arguments in the
9606: same order as loncoursedata::get_classlist() for student data.
9607:
1.609 raeburn 9608: Optional statushash returns
9609:
1.288 raeburn 9610: Entries for end, start, section and status are blank because
9611: of the possibility of multiple values for non-student roles.
9612:
1.275 raeburn 9613: =cut
1.405 albertel 9614:
1.275 raeburn 9615: ###############################################
1.405 albertel 9616:
1.275 raeburn 9617: sub get_course_users {
1.630 raeburn 9618: my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
1.288 raeburn 9619: my %idx = ();
1.419 raeburn 9620: my %seclists;
1.288 raeburn 9621:
9622: $idx{udom} = &Apache::loncoursedata::CL_SDOM();
9623: $idx{uname} = &Apache::loncoursedata::CL_SNAME();
9624: $idx{end} = &Apache::loncoursedata::CL_END();
9625: $idx{start} = &Apache::loncoursedata::CL_START();
9626: $idx{id} = &Apache::loncoursedata::CL_ID();
9627: $idx{section} = &Apache::loncoursedata::CL_SECTION();
9628: $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
9629: $idx{status} = &Apache::loncoursedata::CL_STATUS();
9630:
1.290 albertel 9631: if (grep(/^st$/,@{$roles})) {
1.276 albertel 9632: my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278 raeburn 9633: my $now = time;
1.277 albertel 9634: foreach my $student (keys(%{$classlist})) {
1.288 raeburn 9635: my $match = 0;
1.412 raeburn 9636: my $secmatch = 0;
1.419 raeburn 9637: my $section = $$classlist{$student}[$idx{section}];
1.609 raeburn 9638: my $status = $$classlist{$student}[$idx{status}];
1.419 raeburn 9639: if ($section eq '') {
9640: $section = 'none';
9641: }
1.291 albertel 9642: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 9643: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 9644: $secmatch = 1;
9645: } elsif ($$classlist{$student}[$idx{section}] eq '') {
1.420 albertel 9646: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 9647: $secmatch = 1;
9648: }
9649: } else {
1.419 raeburn 9650: if (grep(/^\Q$section\E$/,@{$sections})) {
1.412 raeburn 9651: $secmatch = 1;
9652: }
1.290 albertel 9653: }
1.412 raeburn 9654: if (!$secmatch) {
9655: next;
9656: }
1.419 raeburn 9657: }
1.275 raeburn 9658: if (defined($$types{'active'})) {
1.288 raeburn 9659: if ($$classlist{$student}[$idx{status}] eq 'Active') {
1.275 raeburn 9660: push(@{$$users{st}{$student}},'active');
1.288 raeburn 9661: $match = 1;
1.275 raeburn 9662: }
9663: }
9664: if (defined($$types{'previous'})) {
1.609 raeburn 9665: if ($$classlist{$student}[$idx{status}] eq 'Expired') {
1.275 raeburn 9666: push(@{$$users{st}{$student}},'previous');
1.288 raeburn 9667: $match = 1;
1.275 raeburn 9668: }
9669: }
9670: if (defined($$types{'future'})) {
1.609 raeburn 9671: if ($$classlist{$student}[$idx{status}] eq 'Future') {
1.275 raeburn 9672: push(@{$$users{st}{$student}},'future');
1.288 raeburn 9673: $match = 1;
1.275 raeburn 9674: }
9675: }
1.609 raeburn 9676: if ($match) {
9677: push(@{$seclists{$student}},$section);
9678: if (ref($userdata) eq 'HASH') {
9679: $$userdata{$student} = $$classlist{$student};
9680: }
9681: if (ref($statushash) eq 'HASH') {
9682: $statushash->{$student}{'st'}{$section} = $status;
9683: }
1.288 raeburn 9684: }
1.275 raeburn 9685: }
9686: }
1.412 raeburn 9687: if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
1.439 raeburn 9688: my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
9689: my $now = time;
1.609 raeburn 9690: my %displaystatus = ( previous => 'Expired',
9691: active => 'Active',
9692: future => 'Future',
9693: );
1.1121 raeburn 9694: my (%nothide,@possdoms);
1.630 raeburn 9695: if ($hidepriv) {
9696: my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
9697: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
9698: if ($user !~ /:/) {
9699: $nothide{join(':',split(/[\@]/,$user))}=1;
9700: } else {
9701: $nothide{$user} = 1;
9702: }
9703: }
1.1121 raeburn 9704: my @possdoms = ($cdom);
9705: if ($coursehash{'checkforpriv'}) {
9706: push(@possdoms,split(/,/,$coursehash{'checkforpriv'}));
9707: }
1.630 raeburn 9708: }
1.439 raeburn 9709: foreach my $person (sort(keys(%coursepersonnel))) {
1.288 raeburn 9710: my $match = 0;
1.412 raeburn 9711: my $secmatch = 0;
1.439 raeburn 9712: my $status;
1.412 raeburn 9713: my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
1.275 raeburn 9714: $user =~ s/:$//;
1.439 raeburn 9715: my ($end,$start) = split(/:/,$coursepersonnel{$person});
9716: if ($end == -1 || $start == -1) {
9717: next;
9718: }
9719: if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
9720: (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
1.412 raeburn 9721: my ($uname,$udom) = split(/:/,$user);
9722: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 9723: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 9724: $secmatch = 1;
9725: } elsif ($usec eq '') {
1.420 albertel 9726: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 9727: $secmatch = 1;
9728: }
9729: } else {
9730: if (grep(/^\Q$usec\E$/,@{$sections})) {
9731: $secmatch = 1;
9732: }
9733: }
9734: if (!$secmatch) {
9735: next;
9736: }
1.288 raeburn 9737: }
1.419 raeburn 9738: if ($usec eq '') {
9739: $usec = 'none';
9740: }
1.275 raeburn 9741: if ($uname ne '' && $udom ne '') {
1.630 raeburn 9742: if ($hidepriv) {
1.1121 raeburn 9743: if ((&Apache::lonnet::privileged($uname,$udom,\@possdoms)) &&
1.630 raeburn 9744: (!$nothide{$uname.':'.$udom})) {
9745: next;
9746: }
9747: }
1.503 raeburn 9748: if ($end > 0 && $end < $now) {
1.439 raeburn 9749: $status = 'previous';
9750: } elsif ($start > $now) {
9751: $status = 'future';
9752: } else {
9753: $status = 'active';
9754: }
1.277 albertel 9755: foreach my $type (keys(%{$types})) {
1.275 raeburn 9756: if ($status eq $type) {
1.420 albertel 9757: if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
1.419 raeburn 9758: push(@{$$users{$role}{$user}},$type);
9759: }
1.288 raeburn 9760: $match = 1;
9761: }
9762: }
1.419 raeburn 9763: if (($match) && (ref($userdata) eq 'HASH')) {
9764: if (!exists($$userdata{$uname.':'.$udom})) {
9765: &get_user_info($udom,$uname,\%idx,$userdata);
9766: }
1.420 albertel 9767: if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
1.419 raeburn 9768: push(@{$seclists{$uname.':'.$udom}},$usec);
9769: }
1.609 raeburn 9770: if (ref($statushash) eq 'HASH') {
9771: $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
9772: }
1.275 raeburn 9773: }
9774: }
9775: }
9776: }
1.290 albertel 9777: if (grep(/^ow$/,@{$roles})) {
1.279 raeburn 9778: if ((defined($cdom)) && (defined($cnum))) {
9779: my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
9780: if ( defined($csettings{'internal.courseowner'}) ) {
9781: my $owner = $csettings{'internal.courseowner'};
1.609 raeburn 9782: next if ($owner eq '');
9783: my ($ownername,$ownerdom);
9784: if ($owner =~ /^([^:]+):([^:]+)$/) {
9785: $ownername = $1;
9786: $ownerdom = $2;
9787: } else {
9788: $ownername = $owner;
9789: $ownerdom = $cdom;
9790: $owner = $ownername.':'.$ownerdom;
1.439 raeburn 9791: }
9792: @{$$users{'ow'}{$owner}} = 'any';
1.290 albertel 9793: if (defined($userdata) &&
1.609 raeburn 9794: !exists($$userdata{$owner})) {
9795: &get_user_info($ownerdom,$ownername,\%idx,$userdata);
9796: if (!grep(/^none$/,@{$seclists{$owner}})) {
9797: push(@{$seclists{$owner}},'none');
9798: }
9799: if (ref($statushash) eq 'HASH') {
9800: $statushash->{$owner}{'ow'}{'none'} = 'Any';
1.419 raeburn 9801: }
1.290 albertel 9802: }
1.279 raeburn 9803: }
9804: }
9805: }
1.419 raeburn 9806: foreach my $user (keys(%seclists)) {
9807: @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
9808: $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
9809: }
1.275 raeburn 9810: }
9811: return;
9812: }
9813:
1.288 raeburn 9814: sub get_user_info {
9815: my ($udom,$uname,$idx,$userdata) = @_;
1.289 albertel 9816: $$userdata{$uname.':'.$udom}[$$idx{fullname}] =
9817: &plainname($uname,$udom,'lastname');
1.291 albertel 9818: $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
1.297 raeburn 9819: $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
1.609 raeburn 9820: my %idhash = &Apache::lonnet::idrget($udom,($uname));
9821: $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname};
1.288 raeburn 9822: return;
9823: }
1.275 raeburn 9824:
1.472 raeburn 9825: ###############################################
9826:
9827: =pod
9828:
9829: =item * &get_user_quota()
9830:
1.1134 raeburn 9831: Retrieves quota assigned for storage of user files.
9832: Default is to report quota for portfolio files.
1.472 raeburn 9833:
9834: Incoming parameters:
9835: 1. user's username
9836: 2. user's domain
1.1134 raeburn 9837: 3. quota name - portfolio, author, or course
1.1136 raeburn 9838: (if no quota name provided, defaults to portfolio).
1.1237 raeburn 9839: 4. crstype - official, unofficial, textbook, placement or community,
9840: if quota name is course
1.472 raeburn 9841:
9842: Returns:
1.1163 raeburn 9843: 1. Disk quota (in MB) assigned to student.
1.536 raeburn 9844: 2. (Optional) Type of setting: custom or default
9845: (individually assigned or default for user's
9846: institutional status).
9847: 3. (Optional) - User's institutional status (e.g., faculty, staff
9848: or student - types as defined in localenroll::inst_usertypes
9849: for user's domain, which determines default quota for user.
9850: 4. (Optional) - Default quota which would apply to the user.
1.472 raeburn 9851:
9852: If a value has been stored in the user's environment,
1.536 raeburn 9853: it will return that, otherwise it returns the maximal default
1.1134 raeburn 9854: defined for the user's institutional status(es) in the domain.
1.472 raeburn 9855:
9856: =cut
9857:
9858: ###############################################
9859:
9860:
9861: sub get_user_quota {
1.1136 raeburn 9862: my ($uname,$udom,$quotaname,$crstype) = @_;
1.536 raeburn 9863: my ($quota,$quotatype,$settingstatus,$defquota);
1.472 raeburn 9864: if (!defined($udom)) {
9865: $udom = $env{'user.domain'};
9866: }
9867: if (!defined($uname)) {
9868: $uname = $env{'user.name'};
9869: }
9870: if (($udom eq '' || $uname eq '') ||
9871: ($udom eq 'public') && ($uname eq 'public')) {
9872: $quota = 0;
1.536 raeburn 9873: $quotatype = 'default';
9874: $defquota = 0;
1.472 raeburn 9875: } else {
1.536 raeburn 9876: my $inststatus;
1.1134 raeburn 9877: if ($quotaname eq 'course') {
9878: if (($env{'course.'.$udom.'_'.$uname.'.num'} eq $uname) &&
9879: ($env{'course.'.$udom.'_'.$uname.'.domain'} eq $udom)) {
9880: $quota = $env{'course.'.$udom.'_'.$uname.'.internal.uploadquota'};
9881: } else {
9882: my %cenv = &Apache::lonnet::coursedescription("$udom/$uname");
9883: $quota = $cenv{'internal.uploadquota'};
9884: }
1.536 raeburn 9885: } else {
1.1134 raeburn 9886: if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
9887: if ($quotaname eq 'author') {
9888: $quota = $env{'environment.authorquota'};
9889: } else {
9890: $quota = $env{'environment.portfolioquota'};
9891: }
9892: $inststatus = $env{'environment.inststatus'};
9893: } else {
9894: my %userenv =
9895: &Apache::lonnet::get('environment',['portfolioquota',
9896: 'authorquota','inststatus'],$udom,$uname);
9897: my ($tmp) = keys(%userenv);
9898: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
9899: if ($quotaname eq 'author') {
9900: $quota = $userenv{'authorquota'};
9901: } else {
9902: $quota = $userenv{'portfolioquota'};
9903: }
9904: $inststatus = $userenv{'inststatus'};
9905: } else {
9906: undef(%userenv);
9907: }
9908: }
9909: }
9910: if ($quota eq '' || wantarray) {
9911: if ($quotaname eq 'course') {
9912: my %domdefs = &Apache::lonnet::get_domain_defaults($udom);
1.1165 raeburn 9913: if (($crstype eq 'official') || ($crstype eq 'unofficial') ||
1.1237 raeburn 9914: ($crstype eq 'community') || ($crstype eq 'textbook') ||
9915: ($crstype eq 'placement')) {
1.1136 raeburn 9916: $defquota = $domdefs{$crstype.'quota'};
9917: }
9918: if ($defquota eq '') {
9919: $defquota = 500;
9920: }
1.1134 raeburn 9921: } else {
9922: ($defquota,$settingstatus) = &default_quota($udom,$inststatus,$quotaname);
9923: }
9924: if ($quota eq '') {
9925: $quota = $defquota;
9926: $quotatype = 'default';
9927: } else {
9928: $quotatype = 'custom';
9929: }
1.472 raeburn 9930: }
9931: }
1.536 raeburn 9932: if (wantarray) {
9933: return ($quota,$quotatype,$settingstatus,$defquota);
9934: } else {
9935: return $quota;
9936: }
1.472 raeburn 9937: }
9938:
9939: ###############################################
9940:
9941: =pod
9942:
9943: =item * &default_quota()
9944:
1.536 raeburn 9945: Retrieves default quota assigned for storage of user portfolio files,
9946: given an (optional) user's institutional status.
1.472 raeburn 9947:
9948: Incoming parameters:
1.1142 raeburn 9949:
1.472 raeburn 9950: 1. domain
1.536 raeburn 9951: 2. (Optional) institutional status(es). This is a : separated list of
9952: status types (e.g., faculty, staff, student etc.)
9953: which apply to the user for whom the default is being retrieved.
9954: If the institutional status string in undefined, the domain
1.1134 raeburn 9955: default quota will be returned.
9956: 3. quota name - portfolio, author, or course
9957: (if no quota name provided, defaults to portfolio).
1.472 raeburn 9958:
9959: Returns:
1.1142 raeburn 9960:
1.1163 raeburn 9961: 1. Default disk quota (in MB) for user portfolios in the domain.
1.536 raeburn 9962: 2. (Optional) institutional type which determined the value of the
9963: default quota.
1.472 raeburn 9964:
9965: If a value has been stored in the domain's configuration db,
9966: it will return that, otherwise it returns 20 (for backwards
9967: compatibility with domains which have not set up a configuration
1.1163 raeburn 9968: db file; the original statically defined portfolio quota was 20 MB).
1.472 raeburn 9969:
1.536 raeburn 9970: If the user's status includes multiple types (e.g., staff and student),
9971: the largest default quota which applies to the user determines the
9972: default quota returned.
9973:
1.472 raeburn 9974: =cut
9975:
9976: ###############################################
9977:
9978:
9979: sub default_quota {
1.1134 raeburn 9980: my ($udom,$inststatus,$quotaname) = @_;
1.536 raeburn 9981: my ($defquota,$settingstatus);
9982: my %quotahash = &Apache::lonnet::get_dom('configuration',
1.622 raeburn 9983: ['quotas'],$udom);
1.1134 raeburn 9984: my $key = 'defaultquota';
9985: if ($quotaname eq 'author') {
9986: $key = 'authorquota';
9987: }
1.622 raeburn 9988: if (ref($quotahash{'quotas'}) eq 'HASH') {
1.536 raeburn 9989: if ($inststatus ne '') {
1.765 raeburn 9990: my @statuses = map { &unescape($_); } split(/:/,$inststatus);
1.536 raeburn 9991: foreach my $item (@statuses) {
1.1134 raeburn 9992: if (ref($quotahash{'quotas'}{$key}) eq 'HASH') {
9993: if ($quotahash{'quotas'}{$key}{$item} ne '') {
1.711 raeburn 9994: if ($defquota eq '') {
1.1134 raeburn 9995: $defquota = $quotahash{'quotas'}{$key}{$item};
1.711 raeburn 9996: $settingstatus = $item;
1.1134 raeburn 9997: } elsif ($quotahash{'quotas'}{$key}{$item} > $defquota) {
9998: $defquota = $quotahash{'quotas'}{$key}{$item};
1.711 raeburn 9999: $settingstatus = $item;
10000: }
10001: }
1.1134 raeburn 10002: } elsif ($key eq 'defaultquota') {
1.711 raeburn 10003: if ($quotahash{'quotas'}{$item} ne '') {
10004: if ($defquota eq '') {
10005: $defquota = $quotahash{'quotas'}{$item};
10006: $settingstatus = $item;
10007: } elsif ($quotahash{'quotas'}{$item} > $defquota) {
10008: $defquota = $quotahash{'quotas'}{$item};
10009: $settingstatus = $item;
10010: }
1.536 raeburn 10011: }
10012: }
10013: }
10014: }
10015: if ($defquota eq '') {
1.1134 raeburn 10016: if (ref($quotahash{'quotas'}{$key}) eq 'HASH') {
10017: $defquota = $quotahash{'quotas'}{$key}{'default'};
10018: } elsif ($key eq 'defaultquota') {
1.711 raeburn 10019: $defquota = $quotahash{'quotas'}{'default'};
10020: }
1.536 raeburn 10021: $settingstatus = 'default';
1.1139 raeburn 10022: if ($defquota eq '') {
10023: if ($quotaname eq 'author') {
10024: $defquota = 500;
10025: }
10026: }
1.536 raeburn 10027: }
10028: } else {
10029: $settingstatus = 'default';
1.1134 raeburn 10030: if ($quotaname eq 'author') {
10031: $defquota = 500;
10032: } else {
10033: $defquota = 20;
10034: }
1.536 raeburn 10035: }
10036: if (wantarray) {
10037: return ($defquota,$settingstatus);
1.472 raeburn 10038: } else {
1.536 raeburn 10039: return $defquota;
1.472 raeburn 10040: }
10041: }
10042:
1.1135 raeburn 10043: ###############################################
10044:
10045: =pod
10046:
1.1136 raeburn 10047: =item * &excess_filesize_warning()
1.1135 raeburn 10048:
10049: Returns warning message if upload of file to authoring space, or copying
1.1136 raeburn 10050: of existing file within authoring space will cause quota for the authoring
1.1146 raeburn 10051: space to be exceeded.
1.1136 raeburn 10052:
10053: Same, if upload of a file directly to a course/community via Course Editor
1.1137 raeburn 10054: will cause quota for uploaded content for the course to be exceeded.
1.1135 raeburn 10055:
1.1165 raeburn 10056: Inputs: 7
1.1136 raeburn 10057: 1. username or coursenum
1.1135 raeburn 10058: 2. domain
1.1136 raeburn 10059: 3. context ('author' or 'course')
1.1135 raeburn 10060: 4. filename of file for which action is being requested
10061: 5. filesize (kB) of file
10062: 6. action being taken: copy or upload.
1.1237 raeburn 10063: 7. quotatype (in course context -- official, unofficial, textbook, placement or community).
1.1135 raeburn 10064:
10065: Returns: 1 scalar: HTML to display containing warning if quota would be exceeded,
1.1142 raeburn 10066: otherwise return null.
10067:
10068: =back
1.1135 raeburn 10069:
10070: =cut
10071:
1.1136 raeburn 10072: sub excess_filesize_warning {
1.1165 raeburn 10073: my ($uname,$udom,$context,$filename,$filesize,$action,$quotatype) = @_;
1.1136 raeburn 10074: my $current_disk_usage = 0;
1.1165 raeburn 10075: my $disk_quota = &get_user_quota($uname,$udom,$context,$quotatype); #expressed in MB
1.1136 raeburn 10076: if ($context eq 'author') {
10077: my $authorspace = $Apache::lonnet::perlvar{'lonDocRoot'}."/priv/$udom/$uname";
10078: $current_disk_usage = &Apache::lonnet::diskusage($udom,$uname,$authorspace);
10079: } else {
10080: foreach my $subdir ('docs','supplemental') {
10081: $current_disk_usage += &Apache::lonnet::diskusage($udom,$uname,"userfiles/$subdir",1);
10082: }
10083: }
1.1135 raeburn 10084: $disk_quota = int($disk_quota * 1000);
10085: if (($current_disk_usage + $filesize) > $disk_quota) {
1.1179 bisitz 10086: return '<p class="LC_warning">'.
1.1135 raeburn 10087: &mt("Unable to $action [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.",
1.1179 bisitz 10088: '<span class="LC_filename">'.$filename.'</span>',$filesize).'</p>'.
10089: '<p>'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',
1.1135 raeburn 10090: $disk_quota,$current_disk_usage).
10091: '</p>';
10092: }
10093: return;
10094: }
10095:
10096: ###############################################
10097:
10098:
1.1136 raeburn 10099:
10100:
1.384 raeburn 10101: sub get_secgrprole_info {
10102: my ($cdom,$cnum,$needroles,$type) = @_;
10103: my %sections_count = &get_sections($cdom,$cnum);
10104: my @sections = (sort {$a <=> $b} keys(%sections_count));
10105: my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
10106: my @groups = sort(keys(%curr_groups));
10107: my $allroles = [];
10108: my $rolehash;
10109: my $accesshash = {
10110: active => 'Currently has access',
10111: future => 'Will have future access',
10112: previous => 'Previously had access',
10113: };
10114: if ($needroles) {
10115: $rolehash = {'all' => 'all'};
1.385 albertel 10116: my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
10117: if (&Apache::lonnet::error(%user_roles)) {
10118: undef(%user_roles);
10119: }
10120: foreach my $item (keys(%user_roles)) {
1.384 raeburn 10121: my ($role)=split(/\:/,$item,2);
10122: if ($role eq 'cr') { next; }
10123: if ($role =~ /^cr/) {
10124: $$rolehash{$role} = (split('/',$role))[3];
10125: } else {
10126: $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
10127: }
10128: }
10129: foreach my $key (sort(keys(%{$rolehash}))) {
10130: push(@{$allroles},$key);
10131: }
10132: push (@{$allroles},'st');
10133: $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
10134: }
10135: return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
10136: }
10137:
1.555 raeburn 10138: sub user_picker {
1.1279 raeburn 10139: my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype,$context,$fixeddom,$noinstd) = @_;
1.555 raeburn 10140: my $currdom = $dom;
1.1253 raeburn 10141: my @alldoms = &Apache::lonnet::all_domains();
10142: if (@alldoms == 1) {
10143: my %domsrch = &Apache::lonnet::get_dom('configuration',
10144: ['directorysrch'],$alldoms[0]);
10145: my $domdesc = &Apache::lonnet::domain($alldoms[0],'description');
10146: my $showdom = $domdesc;
10147: if ($showdom eq '') {
10148: $showdom = $dom;
10149: }
10150: if (ref($domsrch{'directorysrch'}) eq 'HASH') {
10151: if ((!$domsrch{'directorysrch'}{'available'}) &&
10152: ($domsrch{'directorysrch'}{'lcavailable'} eq '0')) {
10153: return (&mt('LON-CAPA directory search is not available in domain: [_1]',$showdom),0);
10154: }
10155: }
10156: }
1.555 raeburn 10157: my %curr_selected = (
10158: srchin => 'dom',
1.580 raeburn 10159: srchby => 'lastname',
1.555 raeburn 10160: );
10161: my $srchterm;
1.625 raeburn 10162: if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
1.555 raeburn 10163: if ($srch->{'srchby'} ne '') {
10164: $curr_selected{'srchby'} = $srch->{'srchby'};
10165: }
10166: if ($srch->{'srchin'} ne '') {
10167: $curr_selected{'srchin'} = $srch->{'srchin'};
10168: }
10169: if ($srch->{'srchtype'} ne '') {
10170: $curr_selected{'srchtype'} = $srch->{'srchtype'};
10171: }
10172: if ($srch->{'srchdomain'} ne '') {
10173: $currdom = $srch->{'srchdomain'};
10174: }
10175: $srchterm = $srch->{'srchterm'};
10176: }
1.1222 damieng 10177: my %html_lt=&Apache::lonlocal::texthash(
1.573 raeburn 10178: 'usr' => 'Search criteria',
1.563 raeburn 10179: 'doma' => 'Domain/institution to search',
1.558 albertel 10180: 'uname' => 'username',
10181: 'lastname' => 'last name',
1.555 raeburn 10182: 'lastfirst' => 'last name, first name',
1.558 albertel 10183: 'crs' => 'in this course',
1.576 raeburn 10184: 'dom' => 'in selected LON-CAPA domain',
1.558 albertel 10185: 'alc' => 'all LON-CAPA',
1.573 raeburn 10186: 'instd' => 'in institutional directory for selected domain',
1.558 albertel 10187: 'exact' => 'is',
10188: 'contains' => 'contains',
1.569 raeburn 10189: 'begins' => 'begins with',
1.1222 damieng 10190: );
10191: my %js_lt=&Apache::lonlocal::texthash(
1.571 raeburn 10192: 'youm' => "You must include some text to search for.",
10193: 'thte' => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
10194: 'thet' => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
10195: 'yomc' => "You must choose a domain when using an institutional directory search.",
10196: 'ymcd' => "You must choose a domain when using a domain search.",
10197: 'whus' => "When using searching by last,first you must include a comma as separator between last name and first name.",
10198: 'whse' => "When searching by last,first you must include at least one character in the first name.",
10199: 'thfo' => "The following need to be corrected before the search can be run:",
1.555 raeburn 10200: );
1.1222 damieng 10201: &html_escape(\%html_lt);
10202: &js_escape(\%js_lt);
1.1255 raeburn 10203: my $domform;
1.1277 raeburn 10204: my $allow_blank = 1;
1.1255 raeburn 10205: if ($fixeddom) {
1.1277 raeburn 10206: $allow_blank = 0;
10207: $domform = &select_dom_form($currdom,'srchdomain',$allow_blank,1,undef,[$currdom]);
1.1255 raeburn 10208: } else {
1.1287 raeburn 10209: my $defdom = $env{'request.role.domain'};
1.1288 raeburn 10210: my ($trusted,$untrusted);
1.1287 raeburn 10211: if (($context eq 'requestcrs') || ($context eq 'course')) {
1.1288 raeburn 10212: ($trusted,$untrusted) = &Apache::lonnet::trusted_domains('enroll',$defdom);
1.1287 raeburn 10213: } elsif ($context eq 'author') {
1.1288 raeburn 10214: ($trusted,$untrusted) = &Apache::lonnet::trusted_domains('othcoau',$defdom);
1.1287 raeburn 10215: } elsif ($context eq 'domain') {
1.1288 raeburn 10216: ($trusted,$untrusted) = &Apache::lonnet::trusted_domains('domroles',$defdom);
1.1287 raeburn 10217: }
1.1288 raeburn 10218: $domform = &select_dom_form($currdom,'srchdomain',$allow_blank,1,undef,$trusted,$untrusted);
1.1255 raeburn 10219: }
1.563 raeburn 10220: my $srchinsel = ' <select name="srchin">';
1.555 raeburn 10221:
10222: my @srchins = ('crs','dom','alc','instd');
10223:
10224: foreach my $option (@srchins) {
10225: # FIXME 'alc' option unavailable until
10226: # loncreateuser::print_user_query_page()
10227: # has been completed.
10228: next if ($option eq 'alc');
1.880 raeburn 10229: next if (($option eq 'crs') && ($env{'form.form'} eq 'requestcrs'));
1.555 raeburn 10230: next if ($option eq 'crs' && !$env{'request.course.id'});
1.1279 raeburn 10231: next if (($option eq 'instd') && ($noinstd));
1.563 raeburn 10232: if ($curr_selected{'srchin'} eq $option) {
10233: $srchinsel .= '
1.1222 damieng 10234: <option value="'.$option.'" selected="selected">'.$html_lt{$option}.'</option>';
1.563 raeburn 10235: } else {
10236: $srchinsel .= '
1.1222 damieng 10237: <option value="'.$option.'">'.$html_lt{$option}.'</option>';
1.563 raeburn 10238: }
1.555 raeburn 10239: }
1.563 raeburn 10240: $srchinsel .= "\n </select>\n";
1.555 raeburn 10241:
10242: my $srchbysel = ' <select name="srchby">';
1.580 raeburn 10243: foreach my $option ('lastname','lastfirst','uname') {
1.555 raeburn 10244: if ($curr_selected{'srchby'} eq $option) {
10245: $srchbysel .= '
1.1222 damieng 10246: <option value="'.$option.'" selected="selected">'.$html_lt{$option}.'</option>';
1.555 raeburn 10247: } else {
10248: $srchbysel .= '
1.1222 damieng 10249: <option value="'.$option.'">'.$html_lt{$option}.'</option>';
1.555 raeburn 10250: }
10251: }
10252: $srchbysel .= "\n </select>\n";
10253:
10254: my $srchtypesel = ' <select name="srchtype">';
1.580 raeburn 10255: foreach my $option ('begins','contains','exact') {
1.555 raeburn 10256: if ($curr_selected{'srchtype'} eq $option) {
10257: $srchtypesel .= '
1.1222 damieng 10258: <option value="'.$option.'" selected="selected">'.$html_lt{$option}.'</option>';
1.555 raeburn 10259: } else {
10260: $srchtypesel .= '
1.1222 damieng 10261: <option value="'.$option.'">'.$html_lt{$option}.'</option>';
1.555 raeburn 10262: }
10263: }
10264: $srchtypesel .= "\n </select>\n";
10265:
1.558 albertel 10266: my ($newuserscript,$new_user_create);
1.994 raeburn 10267: my $context_dom = $env{'request.role.domain'};
10268: if ($context eq 'requestcrs') {
10269: if ($env{'form.coursedom'} ne '') {
10270: $context_dom = $env{'form.coursedom'};
10271: }
10272: }
1.556 raeburn 10273: if ($forcenewuser) {
1.576 raeburn 10274: if (ref($srch) eq 'HASH') {
1.994 raeburn 10275: if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $context_dom) {
1.627 raeburn 10276: if ($cancreate) {
10277: $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>';
10278: } else {
1.799 bisitz 10279: my $helplink = 'javascript:helpMenu('."'display'".')';
1.627 raeburn 10280: my %usertypetext = (
10281: official => 'institutional',
10282: unofficial => 'non-institutional',
10283: );
1.799 bisitz 10284: $new_user_create = '<p class="LC_warning">'
10285: .&mt("You are not authorized to create new $usertypetext{$usertype} users in this domain.")
10286: .' '
10287: .&mt('Please contact the [_1]helpdesk[_2] for assistance.'
10288: ,'<a href="'.$helplink.'">','</a>')
10289: .'</p><br />';
1.627 raeburn 10290: }
1.576 raeburn 10291: }
10292: }
10293:
1.556 raeburn 10294: $newuserscript = <<"ENDSCRIPT";
10295:
1.570 raeburn 10296: function setSearch(createnew,callingForm) {
1.556 raeburn 10297: if (createnew == 1) {
1.570 raeburn 10298: for (var i=0; i<callingForm.srchby.length; i++) {
10299: if (callingForm.srchby.options[i].value == 'uname') {
10300: callingForm.srchby.selectedIndex = i;
1.556 raeburn 10301: }
10302: }
1.570 raeburn 10303: for (var i=0; i<callingForm.srchin.length; i++) {
10304: if ( callingForm.srchin.options[i].value == 'dom') {
10305: callingForm.srchin.selectedIndex = i;
1.556 raeburn 10306: }
10307: }
1.570 raeburn 10308: for (var i=0; i<callingForm.srchtype.length; i++) {
10309: if (callingForm.srchtype.options[i].value == 'exact') {
10310: callingForm.srchtype.selectedIndex = i;
1.556 raeburn 10311: }
10312: }
1.570 raeburn 10313: for (var i=0; i<callingForm.srchdomain.length; i++) {
1.994 raeburn 10314: if (callingForm.srchdomain.options[i].value == '$context_dom') {
1.570 raeburn 10315: callingForm.srchdomain.selectedIndex = i;
1.556 raeburn 10316: }
10317: }
10318: }
10319: }
10320: ENDSCRIPT
1.558 albertel 10321:
1.556 raeburn 10322: }
10323:
1.555 raeburn 10324: my $output = <<"END_BLOCK";
1.556 raeburn 10325: <script type="text/javascript">
1.824 bisitz 10326: // <![CDATA[
1.570 raeburn 10327: function validateEntry(callingForm) {
1.558 albertel 10328:
1.556 raeburn 10329: var checkok = 1;
1.558 albertel 10330: var srchin;
1.570 raeburn 10331: for (var i=0; i<callingForm.srchin.length; i++) {
10332: if ( callingForm.srchin[i].checked ) {
10333: srchin = callingForm.srchin[i].value;
1.558 albertel 10334: }
10335: }
10336:
1.570 raeburn 10337: var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
10338: var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
10339: var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
10340: var srchterm = callingForm.srchterm.value;
10341: var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
1.556 raeburn 10342: var msg = "";
10343:
10344: if (srchterm == "") {
10345: checkok = 0;
1.1222 damieng 10346: msg += "$js_lt{'youm'}\\n";
1.556 raeburn 10347: }
10348:
1.569 raeburn 10349: if (srchtype== 'begins') {
10350: if (srchterm.length < 2) {
10351: checkok = 0;
1.1222 damieng 10352: msg += "$js_lt{'thte'}\\n";
1.569 raeburn 10353: }
10354: }
10355:
1.556 raeburn 10356: if (srchtype== 'contains') {
10357: if (srchterm.length < 3) {
10358: checkok = 0;
1.1222 damieng 10359: msg += "$js_lt{'thet'}\\n";
1.556 raeburn 10360: }
10361: }
10362: if (srchin == 'instd') {
10363: if (srchdomain == '') {
10364: checkok = 0;
1.1222 damieng 10365: msg += "$js_lt{'yomc'}\\n";
1.556 raeburn 10366: }
10367: }
10368: if (srchin == 'dom') {
10369: if (srchdomain == '') {
10370: checkok = 0;
1.1222 damieng 10371: msg += "$js_lt{'ymcd'}\\n";
1.556 raeburn 10372: }
10373: }
10374: if (srchby == 'lastfirst') {
10375: if (srchterm.indexOf(",") == -1) {
10376: checkok = 0;
1.1222 damieng 10377: msg += "$js_lt{'whus'}\\n";
1.556 raeburn 10378: }
10379: if (srchterm.indexOf(",") == srchterm.length -1) {
10380: checkok = 0;
1.1222 damieng 10381: msg += "$js_lt{'whse'}\\n";
1.556 raeburn 10382: }
10383: }
10384: if (checkok == 0) {
1.1222 damieng 10385: alert("$js_lt{'thfo'}\\n"+msg);
1.556 raeburn 10386: return;
10387: }
10388: if (checkok == 1) {
1.570 raeburn 10389: callingForm.submit();
1.556 raeburn 10390: }
10391: }
10392:
10393: $newuserscript
10394:
1.824 bisitz 10395: // ]]>
1.556 raeburn 10396: </script>
1.558 albertel 10397:
10398: $new_user_create
10399:
1.555 raeburn 10400: END_BLOCK
1.558 albertel 10401:
1.876 raeburn 10402: $output .= &Apache::lonhtmlcommon::start_pick_box().
1.1222 damieng 10403: &Apache::lonhtmlcommon::row_title($html_lt{'doma'}).
1.876 raeburn 10404: $domform.
10405: &Apache::lonhtmlcommon::row_closure().
1.1222 damieng 10406: &Apache::lonhtmlcommon::row_title($html_lt{'usr'}).
1.876 raeburn 10407: $srchbysel.
10408: $srchtypesel.
10409: '<input type="text" size="15" name="srchterm" value="'.$srchterm.'" />'.
10410: $srchinsel.
10411: &Apache::lonhtmlcommon::row_closure(1).
10412: &Apache::lonhtmlcommon::end_pick_box().
10413: '<br />';
1.1253 raeburn 10414: return ($output,1);
1.555 raeburn 10415: }
10416:
1.612 raeburn 10417: sub user_rule_check {
1.615 raeburn 10418: my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
1.1226 raeburn 10419: my ($response,%inst_response);
1.612 raeburn 10420: if (ref($usershash) eq 'HASH') {
1.1226 raeburn 10421: if (keys(%{$usershash}) > 1) {
10422: my (%by_username,%by_id,%userdoms);
10423: my $checkid;
10424: if (ref($checks) eq 'HASH') {
10425: if ((!defined($checks->{'username'})) && (defined($checks->{'id'}))) {
10426: $checkid = 1;
10427: }
10428: }
10429: foreach my $user (keys(%{$usershash})) {
10430: my ($uname,$udom) = split(/:/,$user);
10431: if ($checkid) {
10432: if (ref($usershash->{$user}) eq 'HASH') {
10433: if ($usershash->{$user}->{'id'} ne '') {
1.1227 raeburn 10434: $by_id{$udom}{$usershash->{$user}->{'id'}} = $uname;
1.1226 raeburn 10435: $userdoms{$udom} = 1;
1.1227 raeburn 10436: if (ref($inst_results) eq 'HASH') {
10437: $inst_results->{$uname.':'.$udom} = {};
10438: }
1.1226 raeburn 10439: }
10440: }
10441: } else {
10442: $by_username{$udom}{$uname} = 1;
10443: $userdoms{$udom} = 1;
1.1227 raeburn 10444: if (ref($inst_results) eq 'HASH') {
10445: $inst_results->{$uname.':'.$udom} = {};
10446: }
1.1226 raeburn 10447: }
10448: }
10449: foreach my $udom (keys(%userdoms)) {
10450: if (!$got_rules->{$udom}) {
10451: my %domconfig = &Apache::lonnet::get_dom('configuration',
10452: ['usercreation'],$udom);
10453: if (ref($domconfig{'usercreation'}) eq 'HASH') {
10454: foreach my $item ('username','id') {
10455: if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
1.1227 raeburn 10456: $$curr_rules{$udom}{$item} =
10457: $domconfig{'usercreation'}{$item.'_rule'};
1.1226 raeburn 10458: }
10459: }
10460: }
10461: $got_rules->{$udom} = 1;
10462: }
1.612 raeburn 10463: }
1.1226 raeburn 10464: if ($checkid) {
10465: foreach my $udom (keys(%by_id)) {
10466: my ($outcome,$results) = &Apache::lonnet::get_multiple_instusers($udom,$by_id{$udom},'id');
10467: if ($outcome eq 'ok') {
1.1227 raeburn 10468: foreach my $id (keys(%{$by_id{$udom}})) {
10469: my $uname = $by_id{$udom}{$id};
10470: $inst_response{$uname.':'.$udom} = $outcome;
10471: }
1.1226 raeburn 10472: if (ref($results) eq 'HASH') {
10473: foreach my $uname (keys(%{$results})) {
1.1227 raeburn 10474: if (exists($inst_response{$uname.':'.$udom})) {
10475: $inst_response{$uname.':'.$udom} = $outcome;
10476: $inst_results->{$uname.':'.$udom} = $results->{$uname};
10477: }
1.1226 raeburn 10478: }
10479: }
10480: }
1.612 raeburn 10481: }
1.615 raeburn 10482: } else {
1.1226 raeburn 10483: foreach my $udom (keys(%by_username)) {
10484: my ($outcome,$results) = &Apache::lonnet::get_multiple_instusers($udom,$by_username{$udom});
10485: if ($outcome eq 'ok') {
1.1227 raeburn 10486: foreach my $uname (keys(%{$by_username{$udom}})) {
10487: $inst_response{$uname.':'.$udom} = $outcome;
10488: }
1.1226 raeburn 10489: if (ref($results) eq 'HASH') {
10490: foreach my $uname (keys(%{$results})) {
10491: $inst_results->{$uname.':'.$udom} = $results->{$uname};
10492: }
10493: }
10494: }
10495: }
1.612 raeburn 10496: }
1.1226 raeburn 10497: } elsif (keys(%{$usershash}) == 1) {
10498: my $user = (keys(%{$usershash}))[0];
10499: my ($uname,$udom) = split(/:/,$user);
10500: if (($udom ne '') && ($uname ne '')) {
10501: if (ref($usershash->{$user}) eq 'HASH') {
10502: if (ref($checks) eq 'HASH') {
10503: if (defined($checks->{'username'})) {
10504: ($inst_response{$user},%{$inst_results->{$user}}) =
10505: &Apache::lonnet::get_instuser($udom,$uname);
10506: } elsif (defined($checks->{'id'})) {
10507: if ($usershash->{$user}->{'id'} ne '') {
10508: ($inst_response{$user},%{$inst_results->{$user}}) =
10509: &Apache::lonnet::get_instuser($udom,undef,
10510: $usershash->{$user}->{'id'});
10511: } else {
10512: ($inst_response{$user},%{$inst_results->{$user}}) =
10513: &Apache::lonnet::get_instuser($udom,$uname);
10514: }
1.585 raeburn 10515: }
1.1226 raeburn 10516: } else {
10517: ($inst_response{$user},%{$inst_results->{$user}}) =
10518: &Apache::lonnet::get_instuser($udom,$uname);
10519: return;
10520: }
10521: if (!$got_rules->{$udom}) {
10522: my %domconfig = &Apache::lonnet::get_dom('configuration',
10523: ['usercreation'],$udom);
10524: if (ref($domconfig{'usercreation'}) eq 'HASH') {
10525: foreach my $item ('username','id') {
10526: if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
10527: $$curr_rules{$udom}{$item} =
10528: $domconfig{'usercreation'}{$item.'_rule'};
10529: }
10530: }
10531: }
10532: $got_rules->{$udom} = 1;
1.585 raeburn 10533: }
10534: }
1.1226 raeburn 10535: } else {
10536: return;
10537: }
10538: } else {
10539: return;
10540: }
10541: foreach my $user (keys(%{$usershash})) {
10542: my ($uname,$udom) = split(/:/,$user);
10543: next if (($udom eq '') || ($uname eq ''));
10544: my $id;
1.1227 raeburn 10545: if (ref($inst_results) eq 'HASH') {
10546: if (ref($inst_results->{$user}) eq 'HASH') {
10547: $id = $inst_results->{$user}->{'id'};
10548: }
10549: }
10550: if ($id eq '') {
10551: if (ref($usershash->{$user})) {
10552: $id = $usershash->{$user}->{'id'};
10553: }
1.585 raeburn 10554: }
1.612 raeburn 10555: foreach my $item (keys(%{$checks})) {
10556: if (ref($$curr_rules{$udom}) eq 'HASH') {
10557: if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
10558: if (@{$$curr_rules{$udom}{$item}} > 0) {
1.1226 raeburn 10559: my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,
10560: $$curr_rules{$udom}{$item});
1.612 raeburn 10561: foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
10562: if ($rule_check{$rule}) {
10563: $$rulematch{$user}{$item} = $rule;
1.1226 raeburn 10564: if ($inst_response{$user} eq 'ok') {
1.615 raeburn 10565: if (ref($inst_results) eq 'HASH') {
10566: if (ref($inst_results->{$user}) eq 'HASH') {
10567: if (keys(%{$inst_results->{$user}}) == 0) {
10568: $$alerts{$item}{$udom}{$uname} = 1;
1.1227 raeburn 10569: } elsif ($item eq 'id') {
10570: if ($inst_results->{$user}->{'id'} eq '') {
10571: $$alerts{$item}{$udom}{$uname} = 1;
10572: }
1.615 raeburn 10573: }
1.612 raeburn 10574: }
10575: }
1.615 raeburn 10576: }
10577: last;
1.585 raeburn 10578: }
10579: }
10580: }
10581: }
10582: }
10583: }
10584: }
10585: }
1.612 raeburn 10586: return;
10587: }
10588:
10589: sub user_rule_formats {
10590: my ($domain,$domdesc,$curr_rules,$check) = @_;
10591: my %text = (
10592: 'username' => 'Usernames',
10593: 'id' => 'IDs',
10594: );
10595: my $output;
10596: my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
10597: if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
10598: if (@{$ruleorder} > 0) {
1.1102 raeburn 10599: $output = '<br />'.
10600: &mt($text{$check}.' with the following format(s) may [_1]only[_2] be used for verified users at [_3]:',
10601: '<span class="LC_cusr_emph">','</span>',$domdesc).
10602: ' <ul>';
1.612 raeburn 10603: foreach my $rule (@{$ruleorder}) {
10604: if (ref($curr_rules) eq 'ARRAY') {
10605: if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
10606: if (ref($rules->{$rule}) eq 'HASH') {
10607: $output .= '<li>'.$rules->{$rule}{'name'}.': '.
10608: $rules->{$rule}{'desc'}.'</li>';
10609: }
10610: }
10611: }
10612: }
10613: $output .= '</ul>';
10614: }
10615: }
10616: return $output;
10617: }
10618:
10619: sub instrule_disallow_msg {
1.615 raeburn 10620: my ($checkitem,$domdesc,$count,$mode) = @_;
1.612 raeburn 10621: my $response;
10622: my %text = (
10623: item => 'username',
10624: items => 'usernames',
10625: match => 'matches',
10626: do => 'does',
10627: action => 'a username',
10628: one => 'one',
10629: );
10630: if ($count > 1) {
10631: $text{'item'} = 'usernames';
10632: $text{'match'} ='match';
10633: $text{'do'} = 'do';
10634: $text{'action'} = 'usernames',
10635: $text{'one'} = 'ones';
10636: }
10637: if ($checkitem eq 'id') {
10638: $text{'items'} = 'IDs';
10639: $text{'item'} = 'ID';
10640: $text{'action'} = 'an ID';
1.615 raeburn 10641: if ($count > 1) {
10642: $text{'item'} = 'IDs';
10643: $text{'action'} = 'IDs';
10644: }
1.612 raeburn 10645: }
1.674 bisitz 10646: $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 10647: if ($mode eq 'upload') {
10648: if ($checkitem eq 'username') {
10649: $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'}.");
10650: } elsif ($checkitem eq 'id') {
1.674 bisitz 10651: $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 10652: }
1.669 raeburn 10653: } elsif ($mode eq 'selfcreate') {
10654: if ($checkitem eq 'id') {
10655: $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.");
10656: }
1.615 raeburn 10657: } else {
10658: if ($checkitem eq 'username') {
10659: $response .= &mt("You must choose $text{'action'} with a different format -- $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
10660: } elsif ($checkitem eq 'id') {
10661: $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.");
10662: }
1.612 raeburn 10663: }
10664: return $response;
1.585 raeburn 10665: }
10666:
1.624 raeburn 10667: sub personal_data_fieldtitles {
10668: my %fieldtitles = &Apache::lonlocal::texthash (
10669: id => 'Student/Employee ID',
10670: permanentemail => 'E-mail address',
10671: lastname => 'Last Name',
10672: firstname => 'First Name',
10673: middlename => 'Middle Name',
10674: generation => 'Generation',
10675: gen => 'Generation',
1.765 raeburn 10676: inststatus => 'Affiliation',
1.624 raeburn 10677: );
10678: return %fieldtitles;
10679: }
10680:
1.642 raeburn 10681: sub sorted_inst_types {
10682: my ($dom) = @_;
1.1185 raeburn 10683: my ($usertypes,$order);
10684: my %domdefaults = &Apache::lonnet::get_domain_defaults($dom);
10685: if (ref($domdefaults{'inststatus'}) eq 'HASH') {
10686: $usertypes = $domdefaults{'inststatus'}{'inststatustypes'};
10687: $order = $domdefaults{'inststatus'}{'inststatusorder'};
10688: } else {
10689: ($usertypes,$order) = &Apache::lonnet::retrieve_inst_usertypes($dom);
10690: }
1.642 raeburn 10691: my $othertitle = &mt('All users');
10692: if ($env{'request.course.id'}) {
1.668 raeburn 10693: $othertitle = &mt('Any users');
1.642 raeburn 10694: }
10695: my @types;
10696: if (ref($order) eq 'ARRAY') {
10697: @types = @{$order};
10698: }
10699: if (@types == 0) {
10700: if (ref($usertypes) eq 'HASH') {
10701: @types = sort(keys(%{$usertypes}));
10702: }
10703: }
10704: if (keys(%{$usertypes}) > 0) {
10705: $othertitle = &mt('Other users');
10706: }
10707: return ($othertitle,$usertypes,\@types);
10708: }
10709:
1.645 raeburn 10710: sub get_institutional_codes {
10711: my ($settings,$allcourses,$LC_code) = @_;
10712: # Get complete list of course sections to update
10713: my @currsections = ();
10714: my @currxlists = ();
10715: my $coursecode = $$settings{'internal.coursecode'};
10716:
10717: if ($$settings{'internal.sectionnums'} ne '') {
10718: @currsections = split(/,/,$$settings{'internal.sectionnums'});
10719: }
10720:
10721: if ($$settings{'internal.crosslistings'} ne '') {
10722: @currxlists = split(/,/,$$settings{'internal.crosslistings'});
10723: }
10724:
10725: if (@currxlists > 0) {
10726: foreach (@currxlists) {
10727: if (m/^([^:]+):(\w*)$/) {
10728: unless (grep/^$1$/,@{$allcourses}) {
1.1263 raeburn 10729: push(@{$allcourses},$1);
1.645 raeburn 10730: $$LC_code{$1} = $2;
10731: }
10732: }
10733: }
10734: }
10735:
10736: if (@currsections > 0) {
10737: foreach (@currsections) {
10738: if (m/^(\w+):(\w*)$/) {
10739: my $sec = $coursecode.$1;
10740: my $lc_sec = $2;
10741: unless (grep/^$sec$/,@{$allcourses}) {
1.1263 raeburn 10742: push(@{$allcourses},$sec);
1.645 raeburn 10743: $$LC_code{$sec} = $lc_sec;
10744: }
10745: }
10746: }
10747: }
10748: return;
10749: }
10750:
1.971 raeburn 10751: sub get_standard_codeitems {
10752: return ('Year','Semester','Department','Number','Section');
10753: }
10754:
1.112 bowersj2 10755: =pod
10756:
1.780 raeburn 10757: =head1 Slot Helpers
10758:
10759: =over 4
10760:
10761: =item * sorted_slots()
10762:
1.1040 raeburn 10763: Sorts an array of slot names in order of an optional sort key,
10764: default sort is by slot start time (earliest first).
1.780 raeburn 10765:
10766: Inputs:
10767:
10768: =over 4
10769:
10770: slotsarr - Reference to array of unsorted slot names.
10771:
10772: slots - Reference to hash of hash, where outer hash keys are slot names.
10773:
1.1040 raeburn 10774: sortkey - Name of key in inner hash to be sorted on (e.g., starttime).
10775:
1.549 albertel 10776: =back
10777:
1.780 raeburn 10778: Returns:
10779:
10780: =over 4
10781:
1.1040 raeburn 10782: sorted - An array of slot names sorted by a specified sort key
10783: (default sort key is start time of the slot).
1.780 raeburn 10784:
10785: =back
10786:
10787: =cut
10788:
10789:
10790: sub sorted_slots {
1.1040 raeburn 10791: my ($slotsarr,$slots,$sortkey) = @_;
10792: if ($sortkey eq '') {
10793: $sortkey = 'starttime';
10794: }
1.780 raeburn 10795: my @sorted;
10796: if ((ref($slotsarr) eq 'ARRAY') && (ref($slots) eq 'HASH')) {
10797: @sorted =
10798: sort {
10799: if (ref($slots->{$a}) && ref($slots->{$b})) {
1.1040 raeburn 10800: return $slots->{$a}{$sortkey} <=> $slots->{$b}{$sortkey}
1.780 raeburn 10801: }
10802: if (ref($slots->{$a})) { return -1;}
10803: if (ref($slots->{$b})) { return 1;}
10804: return 0;
10805: } @{$slotsarr};
10806: }
10807: return @sorted;
10808: }
10809:
1.1040 raeburn 10810: =pod
10811:
10812: =item * get_future_slots()
10813:
10814: Inputs:
10815:
10816: =over 4
10817:
10818: cnum - course number
10819:
10820: cdom - course domain
10821:
10822: now - current UNIX time
10823:
10824: symb - optional symb
10825:
10826: =back
10827:
10828: Returns:
10829:
10830: =over 4
10831:
10832: sorted_reservable - ref to array of student_schedulable slots currently
10833: reservable, ordered by end date of reservation period.
10834:
10835: reservable_now - ref to hash of student_schedulable slots currently
10836: reservable.
10837:
10838: Keys in inner hash are:
10839: (a) symb: either blank or symb to which slot use is restricted.
1.1250 raeburn 10840: (b) endreserve: end date of reservation period.
10841: (c) uniqueperiod: start,end dates when slot is to be uniquely
10842: selected.
1.1040 raeburn 10843:
10844: sorted_future - ref to array of student_schedulable slots reservable in
10845: the future, ordered by start date of reservation period.
10846:
10847: future_reservable - ref to hash of student_schedulable slots reservable
10848: in the future.
10849:
10850: Keys in inner hash are:
10851: (a) symb: either blank or symb to which slot use is restricted.
1.1250 raeburn 10852: (b) startreserve: start date of reservation period.
10853: (c) uniqueperiod: start,end dates when slot is to be uniquely
10854: selected.
1.1040 raeburn 10855:
10856: =back
10857:
10858: =cut
10859:
10860: sub get_future_slots {
10861: my ($cnum,$cdom,$now,$symb) = @_;
1.1229 raeburn 10862: my $map;
10863: if ($symb) {
10864: ($map) = &Apache::lonnet::decode_symb($symb);
10865: }
1.1040 raeburn 10866: my (%reservable_now,%future_reservable,@sorted_reservable,@sorted_future);
10867: my %slots = &Apache::lonnet::get_course_slots($cnum,$cdom);
10868: foreach my $slot (keys(%slots)) {
10869: next unless($slots{$slot}->{'type'} eq 'schedulable_student');
10870: if ($symb) {
1.1229 raeburn 10871: if ($slots{$slot}->{'symb'} ne '') {
10872: my $canuse;
10873: my %oksymbs;
10874: my @slotsymbs = split(/\s*,\s*/,$slots{$slot}->{'symb'});
10875: map { $oksymbs{$_} = 1; } @slotsymbs;
10876: if ($oksymbs{$symb}) {
10877: $canuse = 1;
10878: } else {
10879: foreach my $item (@slotsymbs) {
10880: if ($item =~ /\.(page|sequence)$/) {
10881: (undef,undef,my $sloturl) = &Apache::lonnet::decode_symb($item);
10882: if (($map ne '') && ($map eq $sloturl)) {
10883: $canuse = 1;
10884: last;
10885: }
10886: }
10887: }
10888: }
10889: next unless ($canuse);
10890: }
1.1040 raeburn 10891: }
10892: if (($slots{$slot}->{'starttime'} > $now) &&
10893: ($slots{$slot}->{'endtime'} > $now)) {
10894: if (($slots{$slot}->{'allowedsections'}) || ($slots{$slot}->{'allowedusers'})) {
10895: my $userallowed = 0;
10896: if ($slots{$slot}->{'allowedsections'}) {
10897: my @allowed_sec = split(',',$slots{$slot}->{'allowedsections'});
10898: if (!defined($env{'request.role.sec'})
10899: && grep(/^No section assigned$/,@allowed_sec)) {
10900: $userallowed=1;
10901: } else {
10902: if (grep(/^\Q$env{'request.role.sec'}\E$/,@allowed_sec)) {
10903: $userallowed=1;
10904: }
10905: }
10906: unless ($userallowed) {
10907: if (defined($env{'request.course.groups'})) {
10908: my @groups = split(/:/,$env{'request.course.groups'});
10909: foreach my $group (@groups) {
10910: if (grep(/^\Q$group\E$/,@allowed_sec)) {
10911: $userallowed=1;
10912: last;
10913: }
10914: }
10915: }
10916: }
10917: }
10918: if ($slots{$slot}->{'allowedusers'}) {
10919: my @allowed_users = split(',',$slots{$slot}->{'allowedusers'});
10920: my $user = $env{'user.name'}.':'.$env{'user.domain'};
10921: if (grep(/^\Q$user\E$/,@allowed_users)) {
10922: $userallowed = 1;
10923: }
10924: }
10925: next unless($userallowed);
10926: }
10927: my $startreserve = $slots{$slot}->{'startreserve'};
10928: my $endreserve = $slots{$slot}->{'endreserve'};
10929: my $symb = $slots{$slot}->{'symb'};
1.1250 raeburn 10930: my $uniqueperiod;
10931: if (ref($slots{$slot}->{'uniqueperiod'}) eq 'ARRAY') {
10932: $uniqueperiod = join(',',@{$slots{$slot}->{'uniqueperiod'}});
10933: }
1.1040 raeburn 10934: if (($startreserve < $now) &&
10935: (!$endreserve || $endreserve > $now)) {
10936: my $lastres = $endreserve;
10937: if (!$lastres) {
10938: $lastres = $slots{$slot}->{'starttime'};
10939: }
10940: $reservable_now{$slot} = {
10941: symb => $symb,
1.1250 raeburn 10942: endreserve => $lastres,
10943: uniqueperiod => $uniqueperiod,
1.1040 raeburn 10944: };
10945: } elsif (($startreserve > $now) &&
10946: (!$endreserve || $endreserve > $startreserve)) {
10947: $future_reservable{$slot} = {
10948: symb => $symb,
1.1250 raeburn 10949: startreserve => $startreserve,
10950: uniqueperiod => $uniqueperiod,
1.1040 raeburn 10951: };
10952: }
10953: }
10954: }
10955: my @unsorted_reservable = keys(%reservable_now);
10956: if (@unsorted_reservable > 0) {
10957: @sorted_reservable =
10958: &sorted_slots(\@unsorted_reservable,\%reservable_now,'endreserve');
10959: }
10960: my @unsorted_future = keys(%future_reservable);
10961: if (@unsorted_future > 0) {
10962: @sorted_future =
10963: &sorted_slots(\@unsorted_future,\%future_reservable,'startreserve');
10964: }
10965: return (\@sorted_reservable,\%reservable_now,\@sorted_future,\%future_reservable);
10966: }
1.780 raeburn 10967:
10968: =pod
10969:
1.1057 foxr 10970: =back
10971:
1.549 albertel 10972: =head1 HTTP Helpers
10973:
10974: =over 4
10975:
1.648 raeburn 10976: =item * &get_unprocessed_cgi($query,$possible_names)
1.112 bowersj2 10977:
1.258 albertel 10978: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112 bowersj2 10979: $query. The parameters listed in $possible_names (an array reference),
1.258 albertel 10980: will be set in $env{'form.name'} if they do not already exist.
1.112 bowersj2 10981:
10982: Typically called with $ENV{'QUERY_STRING'} as the first parameter.
10983: $possible_names is an ref to an array of form element names. As an example:
10984: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258 albertel 10985: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112 bowersj2 10986:
10987: =cut
1.1 albertel 10988:
1.6 albertel 10989: sub get_unprocessed_cgi {
1.25 albertel 10990: my ($query,$possible_names)= @_;
1.26 matthew 10991: # $Apache::lonxml::debug=1;
1.356 albertel 10992: foreach my $pair (split(/&/,$query)) {
10993: my ($name, $value) = split(/=/,$pair);
1.369 www 10994: $name = &unescape($name);
1.25 albertel 10995: if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
10996: $value =~ tr/+/ /;
10997: $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258 albertel 10998: unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25 albertel 10999: }
1.16 harris41 11000: }
1.6 albertel 11001: }
11002:
1.112 bowersj2 11003: =pod
11004:
1.648 raeburn 11005: =item * &cacheheader()
1.112 bowersj2 11006:
11007: returns cache-controlling header code
11008:
11009: =cut
11010:
1.7 albertel 11011: sub cacheheader {
1.258 albertel 11012: unless ($env{'request.method'} eq 'GET') { return ''; }
1.216 albertel 11013: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
11014: my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7 albertel 11015: <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
11016: <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216 albertel 11017: return $output;
1.7 albertel 11018: }
11019:
1.112 bowersj2 11020: =pod
11021:
1.648 raeburn 11022: =item * &no_cache($r)
1.112 bowersj2 11023:
11024: specifies header code to not have cache
11025:
11026: =cut
11027:
1.9 albertel 11028: sub no_cache {
1.216 albertel 11029: my ($r) = @_;
11030: if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258 albertel 11031: $env{'request.method'} ne 'GET') { return ''; }
1.216 albertel 11032: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
11033: $r->no_cache(1);
11034: $r->header_out("Expires" => $date);
11035: $r->header_out("Pragma" => "no-cache");
1.123 www 11036: }
11037:
11038: sub content_type {
1.181 albertel 11039: my ($r,$type,$charset) = @_;
1.299 foxr 11040: if ($r) {
11041: # Note that printout.pl calls this with undef for $r.
11042: &no_cache($r);
11043: }
1.258 albertel 11044: if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181 albertel 11045: unless ($charset) {
11046: $charset=&Apache::lonlocal::current_encoding;
11047: }
11048: if ($charset) { $type.='; charset='.$charset; }
11049: if ($r) {
11050: $r->content_type($type);
11051: } else {
11052: print("Content-type: $type\n\n");
11053: }
1.9 albertel 11054: }
1.25 albertel 11055:
1.112 bowersj2 11056: =pod
11057:
1.648 raeburn 11058: =item * &add_to_env($name,$value)
1.112 bowersj2 11059:
1.258 albertel 11060: adds $name to the %env hash with value
1.112 bowersj2 11061: $value, if $name already exists, the entry is converted to an array
11062: reference and $value is added to the array.
11063:
11064: =cut
11065:
1.25 albertel 11066: sub add_to_env {
11067: my ($name,$value)=@_;
1.258 albertel 11068: if (defined($env{$name})) {
11069: if (ref($env{$name})) {
1.25 albertel 11070: #already have multiple values
1.258 albertel 11071: push(@{ $env{$name} },$value);
1.25 albertel 11072: } else {
11073: #first time seeing multiple values, convert hash entry to an arrayref
1.258 albertel 11074: my $first=$env{$name};
11075: undef($env{$name});
11076: push(@{ $env{$name} },$first,$value);
1.25 albertel 11077: }
11078: } else {
1.258 albertel 11079: $env{$name}=$value;
1.25 albertel 11080: }
1.31 albertel 11081: }
1.149 albertel 11082:
11083: =pod
11084:
1.648 raeburn 11085: =item * &get_env_multiple($name)
1.149 albertel 11086:
1.258 albertel 11087: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149 albertel 11088: values may be defined and end up as an array ref.
11089:
11090: returns an array of values
11091:
11092: =cut
11093:
11094: sub get_env_multiple {
11095: my ($name) = @_;
11096: my @values;
1.258 albertel 11097: if (defined($env{$name})) {
1.149 albertel 11098: # exists is it an array
1.258 albertel 11099: if (ref($env{$name})) {
11100: @values=@{ $env{$name} };
1.149 albertel 11101: } else {
1.258 albertel 11102: $values[0]=$env{$name};
1.149 albertel 11103: }
11104: }
11105: return(@values);
11106: }
11107:
1.1249 damieng 11108: # Looks at given dependencies, and returns something depending on the context.
11109: # For coursedocs paste, returns (undef, $counter, $numpathchg, \%existing).
11110: # For syllabus rewrites, returns (undef, $counter, $numpathchg, \%existing, \%mapping).
11111: # For all other contexts, returns ($output, $counter, $numpathchg).
11112: # $output: string with the HTML output. Can contain missing dependencies with an upload form, existing dependencies, and dependencies no longer in use.
11113: # $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.
11114: # $numpathchg: integer with the number of cleaned up dependency paths.
11115: # \%existing: hash reference clean path -> 1 only for existing dependencies.
11116: # \%mapping: hash reference clean path -> original path for all dependencies.
11117: # @param {string} actionurl - The path to the handler, indicative of the context.
11118: # @param {string} state - Can contain HTML with hidden inputs that will be added to the output form.
11119: # @param {hash reference} allfiles - List of file info from lonnet::extract_embedded_items
11120: # @param {hash reference} codebase - undef, not modified by lonnet::extract_embedded_items ?
11121: # @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)
11122: # @return {Array} - array depending on the context (not a reference)
1.660 raeburn 11123: sub ask_for_embedded_content {
1.1249 damieng 11124: # NOTE: documentation was added afterwards, it could be wrong
1.660 raeburn 11125: my ($actionurl,$state,$allfiles,$codebase,$args)=@_;
1.1071 raeburn 11126: my (%subdependencies,%dependencies,%mapping,%existing,%newfiles,%pathchanges,
1.1085 raeburn 11127: %currsubfile,%unused,$rem);
1.1071 raeburn 11128: my $counter = 0;
11129: my $numnew = 0;
1.987 raeburn 11130: my $numremref = 0;
11131: my $numinvalid = 0;
11132: my $numpathchg = 0;
11133: my $numexisting = 0;
1.1071 raeburn 11134: my $numunused = 0;
11135: my ($output,$upload_output,$toplevel,$url,$udom,$uname,$getpropath,$cdom,$cnum,
1.1156 raeburn 11136: $fileloc,$filename,$delete_output,$modify_output,$title,$symb,$path,$navmap);
1.1071 raeburn 11137: my $heading = &mt('Upload embedded files');
11138: my $buttontext = &mt('Upload');
11139:
1.1249 damieng 11140: # fills these variables based on the context:
11141: # $navmap, $cdom, $cnum, $udom, $uname, $url, $toplevel, $getpropath,
11142: # $path, $fileloc, $title, $rem, $filename
1.1085 raeburn 11143: if ($env{'request.course.id'}) {
1.1123 raeburn 11144: if ($actionurl eq '/adm/dependencies') {
11145: $navmap = Apache::lonnavmaps::navmap->new();
11146: }
11147: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
11148: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
1.1085 raeburn 11149: }
1.1123 raeburn 11150: if (($actionurl eq '/adm/portfolio') ||
11151: ($actionurl eq '/adm/coursegrp_portfolio')) {
1.984 raeburn 11152: my $current_path='/';
11153: if ($env{'form.currentpath'}) {
11154: $current_path = $env{'form.currentpath'};
11155: }
11156: if ($actionurl eq '/adm/coursegrp_portfolio') {
1.1123 raeburn 11157: $udom = $cdom;
11158: $uname = $cnum;
1.984 raeburn 11159: $url = '/userfiles/groups/'.$env{'form.group'}.'/portfolio';
11160: } else {
11161: $udom = $env{'user.domain'};
11162: $uname = $env{'user.name'};
11163: $url = '/userfiles/portfolio';
11164: }
1.987 raeburn 11165: $toplevel = $url.'/';
1.984 raeburn 11166: $url .= $current_path;
11167: $getpropath = 1;
1.987 raeburn 11168: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') ||
11169: ($actionurl eq '/adm/imsimport')) {
1.1022 www 11170: my ($udom,$uname,$rest) = ($args->{'current_path'} =~ m{/priv/($match_domain)/($match_username)/?(.*)$});
1.1026 raeburn 11171: $url = $Apache::lonnet::perlvar{'lonDocRoot'}."/priv/$udom/$uname/";
1.987 raeburn 11172: $toplevel = $url;
1.984 raeburn 11173: if ($rest ne '') {
1.987 raeburn 11174: $url .= $rest;
11175: }
11176: } elsif ($actionurl eq '/adm/coursedocs') {
11177: if (ref($args) eq 'HASH') {
1.1071 raeburn 11178: $url = $args->{'docs_url'};
11179: $toplevel = $url;
1.1084 raeburn 11180: if ($args->{'context'} eq 'paste') {
11181: ($cdom,$cnum) = ($url =~ m{^\Q/uploaded/\E($match_domain)/($match_courseid)/});
11182: ($path) =
11183: ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/\E(?:docs|supplemental)/(?:default|\d+)/\d+)/});
11184: $fileloc = &Apache::lonnet::filelocation('',$toplevel);
11185: $fileloc =~ s{^/}{};
11186: }
1.1071 raeburn 11187: }
1.1084 raeburn 11188: } elsif ($actionurl eq '/adm/dependencies') {
1.1071 raeburn 11189: if ($env{'request.course.id'} ne '') {
11190: if (ref($args) eq 'HASH') {
11191: $url = $args->{'docs_url'};
11192: $title = $args->{'docs_title'};
1.1126 raeburn 11193: $toplevel = $url;
11194: unless ($toplevel =~ m{^/}) {
11195: $toplevel = "/$url";
11196: }
1.1085 raeburn 11197: ($rem) = ($toplevel =~ m{^(.+/)[^/]+$});
1.1126 raeburn 11198: if ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/portfolio/syllabus\E)}) {
11199: $path = $1;
11200: } else {
11201: ($path) =
11202: ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/\E(?:docs|supplemental)/(?:default|\d+)/\d+)/});
11203: }
1.1195 raeburn 11204: if ($toplevel=~/^\/*(uploaded|editupload)/) {
11205: $fileloc = $toplevel;
11206: $fileloc=~ s/^\s*(\S+)\s*$/$1/;
11207: my ($udom,$uname,$fname) =
11208: ($fileloc=~ m{^/+(?:uploaded|editupload)/+($match_domain)/+($match_name)/+(.*)$});
11209: $fileloc = propath($udom,$uname).'/userfiles/'.$fname;
11210: } else {
11211: $fileloc = &Apache::lonnet::filelocation('',$toplevel);
11212: }
1.1071 raeburn 11213: $fileloc =~ s{^/}{};
11214: ($filename) = ($fileloc =~ m{.+/([^/]+)$});
11215: $heading = &mt('Status of dependencies in [_1]',"$title ($filename)");
11216: }
1.987 raeburn 11217: }
1.1123 raeburn 11218: } elsif ($actionurl eq "/public/$cdom/$cnum/syllabus") {
11219: $udom = $cdom;
11220: $uname = $cnum;
11221: $url = "/uploaded/$cdom/$cnum/portfolio/syllabus";
11222: $toplevel = $url;
11223: $path = $url;
11224: $fileloc = &Apache::lonnet::filelocation('',$toplevel).'/';
11225: $fileloc =~ s{^/}{};
1.987 raeburn 11226: }
1.1249 damieng 11227:
11228: # parses the dependency paths to get some info
11229: # fills $newfiles, $mapping, $subdependencies, $dependencies
11230: # $newfiles: hash URL -> 1 for new files or external URLs
11231: # (will be completed later)
11232: # $mapping:
11233: # for external URLs: external URL -> external URL
11234: # for relative paths: clean path -> original path
11235: # $subdependencies: hash clean path -> clean file name -> 1 for relative paths in subdirectories
11236: # $dependencies: hash clean or not file name -> 1 for relative paths not in subdirectories
1.1126 raeburn 11237: foreach my $file (keys(%{$allfiles})) {
11238: my $embed_file;
11239: if (($path eq "/uploaded/$cdom/$cnum/portfolio/syllabus") && ($file =~ m{^\Q$path/\E(.+)$})) {
11240: $embed_file = $1;
11241: } else {
11242: $embed_file = $file;
11243: }
1.1158 raeburn 11244: my ($absolutepath,$cleaned_file);
11245: if ($embed_file =~ m{^\w+://}) {
11246: $cleaned_file = $embed_file;
1.1147 raeburn 11247: $newfiles{$cleaned_file} = 1;
11248: $mapping{$cleaned_file} = $embed_file;
1.987 raeburn 11249: } else {
1.1158 raeburn 11250: $cleaned_file = &clean_path($embed_file);
1.987 raeburn 11251: if ($embed_file =~ m{^/}) {
11252: $absolutepath = $embed_file;
11253: }
1.1147 raeburn 11254: if ($cleaned_file =~ m{/}) {
11255: my ($path,$fname) = ($cleaned_file =~ m{^(.+)/([^/]*)$});
1.987 raeburn 11256: $path = &check_for_traversal($path,$url,$toplevel);
11257: my $item = $fname;
11258: if ($path ne '') {
11259: $item = $path.'/'.$fname;
11260: $subdependencies{$path}{$fname} = 1;
11261: } else {
11262: $dependencies{$item} = 1;
11263: }
11264: if ($absolutepath) {
11265: $mapping{$item} = $absolutepath;
11266: } else {
11267: $mapping{$item} = $embed_file;
11268: }
11269: } else {
11270: $dependencies{$embed_file} = 1;
11271: if ($absolutepath) {
1.1147 raeburn 11272: $mapping{$cleaned_file} = $absolutepath;
1.987 raeburn 11273: } else {
1.1147 raeburn 11274: $mapping{$cleaned_file} = $embed_file;
1.987 raeburn 11275: }
11276: }
1.984 raeburn 11277: }
11278: }
1.1249 damieng 11279:
11280: # looks for all existing files in dependency subdirectories (from $subdependencies filled above)
11281: # and lists
11282: # fills $currsubfile, $pathchanges, $existing, $numexisting, $newfiles, $unused
11283: # $currsubfile: hash clean path -> file name -> 1 for all existing files in the path
11284: # $pathchanges: hash clean path -> 1 if the file in subdirectory exists and
11285: # the path had to be cleaned up
11286: # $existing: hash clean path -> 1 if the file exists
11287: # $numexisting: number of keys in $existing
11288: # $newfiles: updated with clean path -> 1 for files in subdirectories that do not exist
11289: # $unused: only for /adm/dependencies, hash clean path -> 1 for existing files in
11290: # dependency subdirectories that are
11291: # not listed as dependencies, with some exceptions using $rem
1.1071 raeburn 11292: my $dirptr = 16384;
1.984 raeburn 11293: foreach my $path (keys(%subdependencies)) {
1.1071 raeburn 11294: $currsubfile{$path} = {};
1.1123 raeburn 11295: if (($actionurl eq '/adm/portfolio') ||
11296: ($actionurl eq '/adm/coursegrp_portfolio')) {
1.1021 raeburn 11297: my ($sublistref,$listerror) =
11298: &Apache::lonnet::dirlist($url.$path,$udom,$uname,$getpropath);
11299: if (ref($sublistref) eq 'ARRAY') {
11300: foreach my $line (@{$sublistref}) {
11301: my ($file_name,$rest) = split(/\&/,$line,2);
1.1071 raeburn 11302: $currsubfile{$path}{$file_name} = 1;
1.1021 raeburn 11303: }
1.984 raeburn 11304: }
1.987 raeburn 11305: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984 raeburn 11306: if (opendir(my $dir,$url.'/'.$path)) {
11307: my @subdir_list = grep(!/^\./,readdir($dir));
1.1071 raeburn 11308: map {$currsubfile{$path}{$_} = 1;} @subdir_list;
11309: }
1.1084 raeburn 11310: } elsif (($actionurl eq '/adm/dependencies') ||
11311: (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
1.1123 raeburn 11312: ($args->{'context'} eq 'paste')) ||
11313: ($actionurl eq "/public/$cdom/$cnum/syllabus")) {
1.1071 raeburn 11314: if ($env{'request.course.id'} ne '') {
1.1123 raeburn 11315: my $dir;
11316: if ($actionurl eq "/public/$cdom/$cnum/syllabus") {
11317: $dir = $fileloc;
11318: } else {
11319: ($dir) = ($fileloc =~ m{^(.+/)[^/]+$});
11320: }
1.1071 raeburn 11321: if ($dir ne '') {
11322: my ($sublistref,$listerror) =
11323: &Apache::lonnet::dirlist($dir.$path,$cdom,$cnum,$getpropath,undef,'/');
11324: if (ref($sublistref) eq 'ARRAY') {
11325: foreach my $line (@{$sublistref}) {
11326: my ($file_name,$dom,undef,$testdir,undef,undef,undef,undef,$size,
11327: undef,$mtime)=split(/\&/,$line,12);
11328: unless (($testdir&$dirptr) ||
11329: ($file_name =~ /^\.\.?$/)) {
11330: $currsubfile{$path}{$file_name} = [$size,$mtime];
11331: }
11332: }
11333: }
11334: }
1.984 raeburn 11335: }
11336: }
11337: foreach my $file (keys(%{$subdependencies{$path}})) {
1.1071 raeburn 11338: if (exists($currsubfile{$path}{$file})) {
1.987 raeburn 11339: my $item = $path.'/'.$file;
11340: unless ($mapping{$item} eq $item) {
11341: $pathchanges{$item} = 1;
11342: }
11343: $existing{$item} = 1;
11344: $numexisting ++;
11345: } else {
11346: $newfiles{$path.'/'.$file} = 1;
1.984 raeburn 11347: }
11348: }
1.1071 raeburn 11349: if ($actionurl eq '/adm/dependencies') {
11350: foreach my $path (keys(%currsubfile)) {
11351: if (ref($currsubfile{$path}) eq 'HASH') {
11352: foreach my $file (keys(%{$currsubfile{$path}})) {
11353: unless ($subdependencies{$path}{$file}) {
1.1085 raeburn 11354: next if (($rem ne '') &&
11355: (($env{"httpref.$rem"."$path/$file"} ne '') ||
11356: (ref($navmap) &&
11357: (($navmap->getResourceByUrl($rem."$path/$file") ne '') ||
11358: (($file =~ /^(.*\.s?html?)\.bak$/i) &&
11359: ($navmap->getResourceByUrl($rem."$path/$1")))))));
1.1071 raeburn 11360: $unused{$path.'/'.$file} = 1;
11361: }
11362: }
11363: }
11364: }
11365: }
1.984 raeburn 11366: }
1.1249 damieng 11367:
11368: # fills $currfile, hash file name -> 1 or [$size,$mtime]
11369: # for files in $url or $fileloc (target directory) in some contexts
1.987 raeburn 11370: my %currfile;
1.1123 raeburn 11371: if (($actionurl eq '/adm/portfolio') ||
11372: ($actionurl eq '/adm/coursegrp_portfolio')) {
1.1021 raeburn 11373: my ($dirlistref,$listerror) =
11374: &Apache::lonnet::dirlist($url,$udom,$uname,$getpropath);
11375: if (ref($dirlistref) eq 'ARRAY') {
11376: foreach my $line (@{$dirlistref}) {
11377: my ($file_name,$rest) = split(/\&/,$line,2);
11378: $currfile{$file_name} = 1;
11379: }
1.984 raeburn 11380: }
1.987 raeburn 11381: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984 raeburn 11382: if (opendir(my $dir,$url)) {
1.987 raeburn 11383: my @dir_list = grep(!/^\./,readdir($dir));
1.984 raeburn 11384: map {$currfile{$_} = 1;} @dir_list;
11385: }
1.1084 raeburn 11386: } elsif (($actionurl eq '/adm/dependencies') ||
11387: (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
1.1123 raeburn 11388: ($args->{'context'} eq 'paste')) ||
11389: ($actionurl eq "/public/$cdom/$cnum/syllabus")) {
1.1071 raeburn 11390: if ($env{'request.course.id'} ne '') {
11391: my ($dir) = ($fileloc =~ m{^(.+/)[^/]+$});
11392: if ($dir ne '') {
11393: my ($dirlistref,$listerror) =
11394: &Apache::lonnet::dirlist($dir,$cdom,$cnum,$getpropath,undef,'/');
11395: if (ref($dirlistref) eq 'ARRAY') {
11396: foreach my $line (@{$dirlistref}) {
11397: my ($file_name,$dom,undef,$testdir,undef,undef,undef,undef,
11398: $size,undef,$mtime)=split(/\&/,$line,12);
11399: unless (($testdir&$dirptr) ||
11400: ($file_name =~ /^\.\.?$/)) {
11401: $currfile{$file_name} = [$size,$mtime];
11402: }
11403: }
11404: }
11405: }
11406: }
1.984 raeburn 11407: }
1.1249 damieng 11408: # updates $pathchanges, $existing, $numexisting, $newfiles and $unused for files that
11409: # are not in subdirectories, using $currfile
1.984 raeburn 11410: foreach my $file (keys(%dependencies)) {
1.1071 raeburn 11411: if (exists($currfile{$file})) {
1.987 raeburn 11412: unless ($mapping{$file} eq $file) {
11413: $pathchanges{$file} = 1;
11414: }
11415: $existing{$file} = 1;
11416: $numexisting ++;
11417: } else {
1.984 raeburn 11418: $newfiles{$file} = 1;
11419: }
11420: }
1.1071 raeburn 11421: foreach my $file (keys(%currfile)) {
11422: unless (($file eq $filename) ||
11423: ($file eq $filename.'.bak') ||
11424: ($dependencies{$file})) {
1.1085 raeburn 11425: if ($actionurl eq '/adm/dependencies') {
1.1126 raeburn 11426: unless ($toplevel =~ m{^\Q/uploaded/$cdom/$cnum/portfolio/syllabus\E}) {
11427: next if (($rem ne '') &&
11428: (($env{"httpref.$rem".$file} ne '') ||
11429: (ref($navmap) &&
11430: (($navmap->getResourceByUrl($rem.$file) ne '') ||
11431: (($file =~ /^(.*\.s?html?)\.bak$/i) &&
11432: ($navmap->getResourceByUrl($rem.$1)))))));
11433: }
1.1085 raeburn 11434: }
1.1071 raeburn 11435: $unused{$file} = 1;
11436: }
11437: }
1.1249 damieng 11438:
11439: # returns some results for coursedocs paste and syllabus rewrites ($output is undef)
1.1084 raeburn 11440: if (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
11441: ($args->{'context'} eq 'paste')) {
11442: $counter = scalar(keys(%existing));
11443: $numpathchg = scalar(keys(%pathchanges));
1.1123 raeburn 11444: return ($output,$counter,$numpathchg,\%existing);
11445: } elsif (($actionurl eq "/public/$cdom/$cnum/syllabus") &&
11446: (ref($args) eq 'HASH') && ($args->{'context'} eq 'rewrites')) {
11447: $counter = scalar(keys(%existing));
11448: $numpathchg = scalar(keys(%pathchanges));
11449: return ($output,$counter,$numpathchg,\%existing,\%mapping);
1.1084 raeburn 11450: }
1.1249 damieng 11451:
11452: # returns HTML otherwise, with dependency results and to ask for more uploads
11453:
11454: # $upload_output: missing dependencies (with upload form)
11455: # $modify_output: uploaded dependencies (in use)
11456: # $delete_output: files no longer in use (unused files are not listed for londocs, bug?)
1.984 raeburn 11457: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%newfiles)) {
1.1071 raeburn 11458: if ($actionurl eq '/adm/dependencies') {
11459: next if ($embed_file =~ m{^\w+://});
11460: }
1.660 raeburn 11461: $upload_output .= &start_data_table_row().
1.1123 raeburn 11462: '<td valign="top"><img src="'.&icon($embed_file).'" /> '.
1.1071 raeburn 11463: '<span class="LC_filename">'.$embed_file.'</span>';
1.987 raeburn 11464: unless ($mapping{$embed_file} eq $embed_file) {
1.1123 raeburn 11465: $upload_output .= '<br /><span class="LC_info" style="font-size:smaller;">'.
11466: &mt('changed from: [_1]',$mapping{$embed_file}).'</span>';
1.987 raeburn 11467: }
1.1123 raeburn 11468: $upload_output .= '</td>';
1.1071 raeburn 11469: if ($args->{'ignore_remote_references'} && $embed_file =~ m{^\w+://}) {
1.1123 raeburn 11470: $upload_output.='<td align="right">'.
11471: '<span class="LC_info LC_fontsize_medium">'.
11472: &mt("URL points to web address").'</span>';
1.987 raeburn 11473: $numremref++;
1.660 raeburn 11474: } elsif ($args->{'error_on_invalid_names'}
11475: && $embed_file ne &Apache::lonnet::clean_filename($embed_file,{'keep_path' => 1,})) {
1.1123 raeburn 11476: $upload_output.='<td align="right"><span class="LC_warning">'.
11477: &mt('Invalid characters').'</span>';
1.987 raeburn 11478: $numinvalid++;
1.660 raeburn 11479: } else {
1.1123 raeburn 11480: $upload_output .= '<td>'.
11481: &embedded_file_element('upload_embedded',$counter,
1.987 raeburn 11482: $embed_file,\%mapping,
1.1071 raeburn 11483: $allfiles,$codebase,'upload');
11484: $counter ++;
11485: $numnew ++;
1.987 raeburn 11486: }
11487: $upload_output .= '</td>'.&Apache::loncommon::end_data_table_row()."\n";
11488: }
11489: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%existing)) {
1.1071 raeburn 11490: if ($actionurl eq '/adm/dependencies') {
11491: my ($size,$mtime) = &get_dependency_details(\%currfile,\%currsubfile,$embed_file);
11492: $modify_output .= &start_data_table_row().
11493: '<td><a href="'.$path.'/'.$embed_file.'" style="text-decoration:none;">'.
11494: '<img src="'.&icon($embed_file).'" border="0" />'.
11495: ' <span class="LC_filename">'.$embed_file.'</span></a></td>'.
11496: '<td>'.$size.'</td>'.
11497: '<td>'.$mtime.'</td>'.
11498: '<td><label><input type="checkbox" name="mod_upload_dep" '.
11499: 'onclick="toggleBrowse('."'$counter'".')" id="mod_upload_dep_'.
11500: $counter.'" value="'.$counter.'" />'.&mt('Yes').'</label>'.
11501: '<div id="moduploaddep_'.$counter.'" style="display:none;">'.
11502: &embedded_file_element('upload_embedded',$counter,
11503: $embed_file,\%mapping,
11504: $allfiles,$codebase,'modify').
11505: '</div></td>'.
11506: &end_data_table_row()."\n";
11507: $counter ++;
11508: } else {
11509: $upload_output .= &start_data_table_row().
1.1123 raeburn 11510: '<td valign="top"><img src="'.&icon($embed_file).'" /> '.
11511: '<span class="LC_filename">'.$embed_file.'</span></td>'.
11512: '<td align="right"><span class="LC_info LC_fontsize_medium">'.&mt('Already exists').'</span></td>'.
1.1071 raeburn 11513: &Apache::loncommon::end_data_table_row()."\n";
11514: }
11515: }
11516: my $delidx = $counter;
11517: foreach my $oldfile (sort {lc($a) cmp lc($b)} keys(%unused)) {
11518: my ($size,$mtime) = &get_dependency_details(\%currfile,\%currsubfile,$oldfile);
11519: $delete_output .= &start_data_table_row().
11520: '<td><img src="'.&icon($oldfile).'" />'.
11521: ' <span class="LC_filename">'.$oldfile.'</span></td>'.
11522: '<td>'.$size.'</td>'.
11523: '<td>'.$mtime.'</td>'.
11524: '<td><label><input type="checkbox" name="del_upload_dep" '.
11525: ' value="'.$delidx.'" />'.&mt('Yes').'</label>'.
11526: &embedded_file_element('upload_embedded',$delidx,
11527: $oldfile,\%mapping,$allfiles,
11528: $codebase,'delete').'</td>'.
11529: &end_data_table_row()."\n";
11530: $numunused ++;
11531: $delidx ++;
1.987 raeburn 11532: }
11533: if ($upload_output) {
11534: $upload_output = &start_data_table().
11535: $upload_output.
11536: &end_data_table()."\n";
11537: }
1.1071 raeburn 11538: if ($modify_output) {
11539: $modify_output = &start_data_table().
11540: &start_data_table_header_row().
11541: '<th>'.&mt('File').'</th>'.
11542: '<th>'.&mt('Size (KB)').'</th>'.
11543: '<th>'.&mt('Modified').'</th>'.
11544: '<th>'.&mt('Upload replacement?').'</th>'.
11545: &end_data_table_header_row().
11546: $modify_output.
11547: &end_data_table()."\n";
11548: }
11549: if ($delete_output) {
11550: $delete_output = &start_data_table().
11551: &start_data_table_header_row().
11552: '<th>'.&mt('File').'</th>'.
11553: '<th>'.&mt('Size (KB)').'</th>'.
11554: '<th>'.&mt('Modified').'</th>'.
11555: '<th>'.&mt('Delete?').'</th>'.
11556: &end_data_table_header_row().
11557: $delete_output.
11558: &end_data_table()."\n";
11559: }
1.987 raeburn 11560: my $applies = 0;
11561: if ($numremref) {
11562: $applies ++;
11563: }
11564: if ($numinvalid) {
11565: $applies ++;
11566: }
11567: if ($numexisting) {
11568: $applies ++;
11569: }
1.1071 raeburn 11570: if ($counter || $numunused) {
1.987 raeburn 11571: $output = '<form name="upload_embedded" action="'.$actionurl.'"'.
11572: ' method="post" enctype="multipart/form-data">'."\n".
1.1071 raeburn 11573: $state.'<h3>'.$heading.'</h3>';
11574: if ($actionurl eq '/adm/dependencies') {
11575: if ($numnew) {
11576: $output .= '<h4>'.&mt('Missing dependencies').'</h4>'.
11577: '<p>'.&mt('The following files need to be uploaded.').'</p>'."\n".
11578: $upload_output.'<br />'."\n";
11579: }
11580: if ($numexisting) {
11581: $output .= '<h4>'.&mt('Uploaded dependencies (in use)').'</h4>'.
11582: '<p>'.&mt('Upload a new file to replace the one currently in use.').'</p>'."\n".
11583: $modify_output.'<br />'."\n";
11584: $buttontext = &mt('Save changes');
11585: }
11586: if ($numunused) {
11587: $output .= '<h4>'.&mt('Unused files').'</h4>'.
11588: '<p>'.&mt('The following uploaded files are no longer used.').'</p>'."\n".
11589: $delete_output.'<br />'."\n";
11590: $buttontext = &mt('Save changes');
11591: }
11592: } else {
11593: $output .= $upload_output.'<br />'."\n";
11594: }
11595: $output .= '<input type ="hidden" name="number_embedded_items" value="'.
11596: $counter.'" />'."\n";
11597: if ($actionurl eq '/adm/dependencies') {
11598: $output .= '<input type ="hidden" name="number_newemb_items" value="'.
11599: $numnew.'" />'."\n";
11600: } elsif ($actionurl eq '') {
1.987 raeburn 11601: $output .= '<input type="hidden" name="phase" value="three" />';
11602: }
11603: } elsif ($applies) {
11604: $output = '<b>'.&mt('Referenced files').'</b>:<br />';
11605: if ($applies > 1) {
11606: $output .=
1.1123 raeburn 11607: &mt('No dependencies need to be uploaded, as one of the following applies to each reference:').'<ul>';
1.987 raeburn 11608: if ($numremref) {
11609: $output .= '<li>'.&mt('reference is to a URL which points to another server').'</li>'."\n";
11610: }
11611: if ($numinvalid) {
11612: $output .= '<li>'.&mt('reference is to file with a name containing invalid characters').'</li>'."\n";
11613: }
11614: if ($numexisting) {
11615: $output .= '<li>'.&mt('reference is to an existing file at the specified location').'</li>'."\n";
11616: }
11617: $output .= '</ul><br />';
11618: } elsif ($numremref) {
11619: $output .= '<p>'.&mt('None to upload, as all references are to URLs pointing to another server.').'</p>';
11620: } elsif ($numinvalid) {
11621: $output .= '<p>'.&mt('None to upload, as all references are to files with names containing invalid characters.').'</p>';
11622: } elsif ($numexisting) {
11623: $output .= '<p>'.&mt('None to upload, as all references are to existing files.').'</p>';
11624: }
11625: $output .= $upload_output.'<br />';
11626: }
11627: my ($pathchange_output,$chgcount);
1.1071 raeburn 11628: $chgcount = $counter;
1.987 raeburn 11629: if (keys(%pathchanges) > 0) {
11630: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%pathchanges)) {
1.1071 raeburn 11631: if ($counter) {
1.987 raeburn 11632: $output .= &embedded_file_element('pathchange',$chgcount,
11633: $embed_file,\%mapping,
1.1071 raeburn 11634: $allfiles,$codebase,'change');
1.987 raeburn 11635: } else {
11636: $pathchange_output .=
11637: &start_data_table_row().
11638: '<td><input type ="checkbox" name="namechange" value="'.
11639: $chgcount.'" checked="checked" /></td>'.
11640: '<td>'.$mapping{$embed_file}.'</td>'.
11641: '<td>'.$embed_file.
11642: &embedded_file_element('pathchange',$numpathchg,$embed_file,
1.1071 raeburn 11643: \%mapping,$allfiles,$codebase,'change').
1.987 raeburn 11644: '</td>'.&end_data_table_row();
1.660 raeburn 11645: }
1.987 raeburn 11646: $numpathchg ++;
11647: $chgcount ++;
1.660 raeburn 11648: }
11649: }
1.1127 raeburn 11650: if (($counter) || ($numunused)) {
1.987 raeburn 11651: if ($numpathchg) {
11652: $output .= '<input type ="hidden" name="number_pathchange_items" value="'.
11653: $numpathchg.'" />'."\n";
11654: }
11655: if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') ||
11656: ($actionurl eq '/adm/imsimport')) {
11657: $output .= '<input type="hidden" name="phase" value="three" />'."\n";
11658: } elsif ($actionurl eq '/adm/portfolio' || $actionurl eq '/adm/coursegrp_portfolio') {
11659: $output .= '<input type="hidden" name="action" value="upload_embedded" />';
1.1071 raeburn 11660: } elsif ($actionurl eq '/adm/dependencies') {
11661: $output .= '<input type="hidden" name="action" value="process_changes" />';
1.987 raeburn 11662: }
1.1123 raeburn 11663: $output .= '<input type ="submit" value="'.$buttontext.'" />'."\n".'</form>'."\n";
1.987 raeburn 11664: } elsif ($numpathchg) {
11665: my %pathchange = ();
11666: $output .= &modify_html_form('pathchange',$actionurl,$state,\%pathchange,$pathchange_output);
11667: if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
11668: $output .= '<p>'.&mt('or').'</p>';
1.1123 raeburn 11669: }
1.987 raeburn 11670: }
1.1071 raeburn 11671: return ($output,$counter,$numpathchg);
1.987 raeburn 11672: }
11673:
1.1147 raeburn 11674: =pod
11675:
11676: =item * clean_path($name)
11677:
11678: Performs clean-up of directories, subdirectories and filename in an
11679: embedded object, referenced in an HTML file which is being uploaded
11680: to a course or portfolio, where
11681: "Upload embedded images/multimedia files if HTML file" checkbox was
11682: checked.
11683:
11684: Clean-up is similar to replacements in lonnet::clean_filename()
11685: except each / between sub-directory and next level is preserved.
11686:
11687: =cut
11688:
11689: sub clean_path {
11690: my ($embed_file) = @_;
11691: $embed_file =~s{^/+}{};
11692: my @contents;
11693: if ($embed_file =~ m{/}) {
11694: @contents = split(/\//,$embed_file);
11695: } else {
11696: @contents = ($embed_file);
11697: }
11698: my $lastidx = scalar(@contents)-1;
11699: for (my $i=0; $i<=$lastidx; $i++) {
11700: $contents[$i]=~s{\\}{/}g;
11701: $contents[$i]=~s/\s+/\_/g;
11702: $contents[$i]=~s{[^/\w\.\-]}{}g;
11703: if ($i == $lastidx) {
11704: $contents[$i]=~s/\.(\d+)(?=\.)/_$1/g;
11705: }
11706: }
11707: if ($lastidx > 0) {
11708: return join('/',@contents);
11709: } else {
11710: return $contents[0];
11711: }
11712: }
11713:
1.987 raeburn 11714: sub embedded_file_element {
1.1071 raeburn 11715: my ($context,$num,$embed_file,$mapping,$allfiles,$codebase,$type) = @_;
1.987 raeburn 11716: return unless ((ref($mapping) eq 'HASH') && (ref($allfiles) eq 'HASH') &&
11717: (ref($codebase) eq 'HASH'));
11718: my $output;
1.1071 raeburn 11719: if (($context eq 'upload_embedded') && ($type ne 'delete')) {
1.987 raeburn 11720: $output = '<input name="embedded_item_'.$num.'" type="file" value="" />'."\n";
11721: }
11722: $output .= '<input name="embedded_orig_'.$num.'" type="hidden" value="'.
11723: &escape($embed_file).'" />';
11724: unless (($context eq 'upload_embedded') &&
11725: ($mapping->{$embed_file} eq $embed_file)) {
11726: $output .='
11727: <input name="embedded_ref_'.$num.'" type="hidden" value="'.&escape($mapping->{$embed_file}).'" />';
11728: }
11729: my $attrib;
11730: if (ref($allfiles->{$mapping->{$embed_file}}) eq 'ARRAY') {
11731: $attrib = &escape(join(':',@{$allfiles->{$mapping->{$embed_file}}}));
11732: }
11733: $output .=
11734: "\n\t\t".
11735: '<input name="embedded_attrib_'.$num.'" type="hidden" value="'.
11736: $attrib.'" />';
11737: if (exists($codebase->{$mapping->{$embed_file}})) {
11738: $output .=
11739: "\n\t\t".
11740: '<input name="codebase_'.$num.'" type="hidden" value="'.
11741: &escape($codebase->{$mapping->{$embed_file}}).'" />';
1.984 raeburn 11742: }
1.987 raeburn 11743: return $output;
1.660 raeburn 11744: }
11745:
1.1071 raeburn 11746: sub get_dependency_details {
11747: my ($currfile,$currsubfile,$embed_file) = @_;
11748: my ($size,$mtime,$showsize,$showmtime);
11749: if ((ref($currfile) eq 'HASH') && (ref($currsubfile))) {
11750: if ($embed_file =~ m{/}) {
11751: my ($path,$fname) = split(/\//,$embed_file);
11752: if (ref($currsubfile->{$path}{$fname}) eq 'ARRAY') {
11753: ($size,$mtime) = @{$currsubfile->{$path}{$fname}};
11754: }
11755: } else {
11756: if (ref($currfile->{$embed_file}) eq 'ARRAY') {
11757: ($size,$mtime) = @{$currfile->{$embed_file}};
11758: }
11759: }
11760: $showsize = $size/1024.0;
11761: $showsize = sprintf("%.1f",$showsize);
11762: if ($mtime > 0) {
11763: $showmtime = &Apache::lonlocal::locallocaltime($mtime);
11764: }
11765: }
11766: return ($showsize,$showmtime);
11767: }
11768:
11769: sub ask_embedded_js {
11770: return <<"END";
11771: <script type="text/javascript"">
11772: // <![CDATA[
11773: function toggleBrowse(counter) {
11774: var chkboxid = document.getElementById('mod_upload_dep_'+counter);
11775: var fileid = document.getElementById('embedded_item_'+counter);
11776: var uploaddivid = document.getElementById('moduploaddep_'+counter);
11777: if (chkboxid.checked == true) {
11778: uploaddivid.style.display='block';
11779: } else {
11780: uploaddivid.style.display='none';
11781: fileid.value = '';
11782: }
11783: }
11784: // ]]>
11785: </script>
11786:
11787: END
11788: }
11789:
1.661 raeburn 11790: sub upload_embedded {
11791: my ($context,$dirpath,$uname,$udom,$dir_root,$url_root,$group,$disk_quota,
1.987 raeburn 11792: $current_disk_usage,$hiddenstate,$actionurl) = @_;
11793: my (%pathchange,$output,$modifyform,$footer,$returnflag);
1.661 raeburn 11794: for (my $i=0; $i<$env{'form.number_embedded_items'}; $i++) {
11795: next if (!exists($env{'form.embedded_item_'.$i.'.filename'}));
11796: my $orig_uploaded_filename =
11797: $env{'form.embedded_item_'.$i.'.filename'};
1.987 raeburn 11798: foreach my $type ('orig','ref','attrib','codebase') {
11799: if ($env{'form.embedded_'.$type.'_'.$i} ne '') {
11800: $env{'form.embedded_'.$type.'_'.$i} =
11801: &unescape($env{'form.embedded_'.$type.'_'.$i});
11802: }
11803: }
1.661 raeburn 11804: my ($path,$fname) =
11805: ($env{'form.embedded_orig_'.$i} =~ m{(.*/)([^/]*)});
11806: # no path, whole string is fname
11807: if (!$fname) { $fname = $env{'form.embedded_orig_'.$i} };
11808: $fname = &Apache::lonnet::clean_filename($fname);
11809: # See if there is anything left
11810: next if ($fname eq '');
11811:
11812: # Check if file already exists as a file or directory.
11813: my ($state,$msg);
11814: if ($context eq 'portfolio') {
11815: my $port_path = $dirpath;
11816: if ($group ne '') {
11817: $port_path = "groups/$group/$port_path";
11818: }
1.987 raeburn 11819: ($state,$msg) = &check_for_upload($env{'form.currentpath'}.$path,
11820: $fname,$group,'embedded_item_'.$i,
1.661 raeburn 11821: $dir_root,$port_path,$disk_quota,
11822: $current_disk_usage,$uname,$udom);
11823: if ($state eq 'will_exceed_quota'
1.984 raeburn 11824: || $state eq 'file_locked') {
1.661 raeburn 11825: $output .= $msg;
11826: next;
11827: }
11828: } elsif (($context eq 'author') || ($context eq 'testbank')) {
11829: ($state,$msg) = &check_for_existing($path,$fname,'embedded_item_'.$i);
11830: if ($state eq 'exists') {
11831: $output .= $msg;
11832: next;
11833: }
11834: }
11835: # Check if extension is valid
11836: if (($fname =~ /\.(\w+)$/) &&
11837: (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
1.1155 bisitz 11838: $output .= &mt('Invalid file extension ([_1]) - reserved for internal use.',$1)
11839: .' '.&mt('Rename the file with a different extension and re-upload.').'<br />';
1.661 raeburn 11840: next;
11841: } elsif (($fname =~ /\.(\w+)$/) &&
11842: (!defined(&Apache::loncommon::fileembstyle($1)))) {
1.987 raeburn 11843: $output .= &mt('Unrecognized file extension ([_1]) - rename the file with a proper extension and re-upload.',$1).'<br />';
1.661 raeburn 11844: next;
11845: } elsif ($fname=~/\.(\d+)\.(\w+)$/) {
1.1120 bisitz 11846: $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 11847: next;
11848: }
11849: $env{'form.embedded_item_'.$i.'.filename'}=$fname;
1.1123 raeburn 11850: my $subdir = $path;
11851: $subdir =~ s{/+$}{};
1.661 raeburn 11852: if ($context eq 'portfolio') {
1.984 raeburn 11853: my $result;
11854: if ($state eq 'existingfile') {
11855: $result=
11856: &Apache::lonnet::userfileupload('embedded_item_'.$i,'existingfile',
1.1123 raeburn 11857: $dirpath.$env{'form.currentpath'}.$subdir);
1.661 raeburn 11858: } else {
1.984 raeburn 11859: $result=
11860: &Apache::lonnet::userfileupload('embedded_item_'.$i,'',
1.987 raeburn 11861: $dirpath.
1.1123 raeburn 11862: $env{'form.currentpath'}.$subdir);
1.984 raeburn 11863: if ($result !~ m|^/uploaded/|) {
11864: $output .= '<span class="LC_error">'
11865: .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
11866: ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
11867: .'</span><br />';
11868: next;
11869: } else {
1.987 raeburn 11870: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
11871: $path.$fname.'</span>').'<br />';
1.984 raeburn 11872: }
1.661 raeburn 11873: }
1.1123 raeburn 11874: } elsif (($context eq 'coursedoc') || ($context eq 'syllabus')) {
1.1126 raeburn 11875: my $extendedsubdir = $dirpath.'/'.$subdir;
11876: $extendedsubdir =~ s{/+$}{};
1.987 raeburn 11877: my $result =
1.1126 raeburn 11878: &Apache::lonnet::userfileupload('embedded_item_'.$i,$context,$extendedsubdir);
1.987 raeburn 11879: if ($result !~ m|^/uploaded/|) {
11880: $output .= '<span class="LC_error">'
11881: .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
11882: ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
11883: .'</span><br />';
11884: next;
11885: } else {
11886: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
11887: $path.$fname.'</span>').'<br />';
1.1125 raeburn 11888: if ($context eq 'syllabus') {
11889: &Apache::lonnet::make_public_indefinitely($result);
11890: }
1.987 raeburn 11891: }
1.661 raeburn 11892: } else {
11893: # Save the file
11894: my $target = $env{'form.embedded_item_'.$i};
11895: my $fullpath = $dir_root.$dirpath.'/'.$path;
11896: my $dest = $fullpath.$fname;
11897: my $url = $url_root.$dirpath.'/'.$path.$fname;
1.1027 raeburn 11898: my @parts=split(/\//,"$dirpath/$path");
1.661 raeburn 11899: my $count;
11900: my $filepath = $dir_root;
1.1027 raeburn 11901: foreach my $subdir (@parts) {
11902: $filepath .= "/$subdir";
11903: if (!-e $filepath) {
1.661 raeburn 11904: mkdir($filepath,0770);
11905: }
11906: }
11907: my $fh;
11908: if (!open($fh,'>'.$dest)) {
11909: &Apache::lonnet::logthis('Failed to create '.$dest);
11910: $output .= '<span class="LC_error">'.
1.1071 raeburn 11911: &mt('An error occurred while trying to upload [_1] for embedded element [_2].',
11912: $orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
1.661 raeburn 11913: '</span><br />';
11914: } else {
11915: if (!print $fh $env{'form.embedded_item_'.$i}) {
11916: &Apache::lonnet::logthis('Failed to write to '.$dest);
11917: $output .= '<span class="LC_error">'.
1.1071 raeburn 11918: &mt('An error occurred while writing the file [_1] for embedded element [_2].',
11919: $orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
1.661 raeburn 11920: '</span><br />';
11921: } else {
1.987 raeburn 11922: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
11923: $url.'</span>').'<br />';
11924: unless ($context eq 'testbank') {
11925: $footer .= &mt('View embedded file: [_1]',
11926: '<a href="'.$url.'">'.$fname.'</a>').'<br />';
11927: }
11928: }
11929: close($fh);
11930: }
11931: }
11932: if ($env{'form.embedded_ref_'.$i}) {
11933: $pathchange{$i} = 1;
11934: }
11935: }
11936: if ($output) {
11937: $output = '<p>'.$output.'</p>';
11938: }
11939: $output .= &modify_html_form('upload_embedded',$actionurl,$hiddenstate,\%pathchange);
11940: $returnflag = 'ok';
1.1071 raeburn 11941: my $numpathchgs = scalar(keys(%pathchange));
11942: if ($numpathchgs > 0) {
1.987 raeburn 11943: if ($context eq 'portfolio') {
11944: $output .= '<p>'.&mt('or').'</p>';
11945: } elsif ($context eq 'testbank') {
1.1071 raeburn 11946: $output .= '<p>'.&mt('Or [_1]continue[_2] the testbank import without modifying the reference(s).',
11947: '<a href="javascript:document.testbankForm.submit();">','</a>').'</p>';
1.987 raeburn 11948: $returnflag = 'modify_orightml';
11949: }
11950: }
1.1071 raeburn 11951: return ($output.$footer,$returnflag,$numpathchgs);
1.987 raeburn 11952: }
11953:
11954: sub modify_html_form {
11955: my ($context,$actionurl,$hiddenstate,$pathchange,$pathchgtable) = @_;
11956: my $end = 0;
11957: my $modifyform;
11958: if ($context eq 'upload_embedded') {
11959: return unless (ref($pathchange) eq 'HASH');
11960: if ($env{'form.number_embedded_items'}) {
11961: $end += $env{'form.number_embedded_items'};
11962: }
11963: if ($env{'form.number_pathchange_items'}) {
11964: $end += $env{'form.number_pathchange_items'};
11965: }
11966: if ($end) {
11967: for (my $i=0; $i<$end; $i++) {
11968: if ($i < $env{'form.number_embedded_items'}) {
11969: next unless($pathchange->{$i});
11970: }
11971: $modifyform .=
11972: &start_data_table_row().
11973: '<td><input type ="checkbox" name="namechange" value="'.$i.'" '.
11974: 'checked="checked" /></td>'.
11975: '<td>'.$env{'form.embedded_ref_'.$i}.
11976: '<input type="hidden" name="embedded_ref_'.$i.'" value="'.
11977: &escape($env{'form.embedded_ref_'.$i}).'" />'.
11978: '<input type="hidden" name="embedded_codebase_'.$i.'" value="'.
11979: &escape($env{'form.embedded_codebase_'.$i}).'" />'.
11980: '<input type="hidden" name="embedded_attrib_'.$i.'" value="'.
11981: &escape($env{'form.embedded_attrib_'.$i}).'" /></td>'.
11982: '<td>'.$env{'form.embedded_orig_'.$i}.
11983: '<input type="hidden" name="embedded_orig_'.$i.'" value="'.
11984: &escape($env{'form.embedded_orig_'.$i}).'" /></td>'.
11985: &end_data_table_row();
1.1071 raeburn 11986: }
1.987 raeburn 11987: }
11988: } else {
11989: $modifyform = $pathchgtable;
11990: if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
11991: $hiddenstate .= '<input type="hidden" name="phase" value="four" />';
11992: } elsif (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
11993: $hiddenstate .= '<input type="hidden" name="action" value="modify_orightml" />';
11994: }
11995: }
11996: if ($modifyform) {
1.1071 raeburn 11997: if ($actionurl eq '/adm/dependencies') {
11998: $hiddenstate .= '<input type="hidden" name="action" value="modifyhrefs" />';
11999: }
1.987 raeburn 12000: return '<h3>'.&mt('Changes in content of HTML file required').'</h3>'."\n".
12001: '<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".
12002: '<li>'.&mt('For consistency between the reference(s) and the location of the corresponding stored file within LON-CAPA.').'</li>'."\n".
12003: '<li>'.&mt('To change absolute paths to relative paths, or replace directory traversal via "../" within the original reference.').'</li>'."\n".
12004: '</ol></p>'."\n".'<p>'.
12005: &mt('LON-CAPA can make the required changes to your HTML file.').'</p>'."\n".
12006: '<form method="post" name="refchanger" action="'.$actionurl.'">'.
12007: &start_data_table()."\n".
12008: &start_data_table_header_row().
12009: '<th>'.&mt('Change?').'</th>'.
12010: '<th>'.&mt('Current reference').'</th>'.
12011: '<th>'.&mt('Required reference').'</th>'.
12012: &end_data_table_header_row()."\n".
12013: $modifyform.
12014: &end_data_table().'<br />'."\n".$hiddenstate.
12015: '<input type="submit" name="pathchanges" value="'.&mt('Modify HTML file').'" />'.
12016: '</form>'."\n";
12017: }
12018: return;
12019: }
12020:
12021: sub modify_html_refs {
1.1123 raeburn 12022: my ($context,$dirpath,$uname,$udom,$dir_root,$url) = @_;
1.987 raeburn 12023: my $container;
12024: if ($context eq 'portfolio') {
12025: $container = $env{'form.container'};
12026: } elsif ($context eq 'coursedoc') {
12027: $container = $env{'form.primaryurl'};
1.1071 raeburn 12028: } elsif ($context eq 'manage_dependencies') {
12029: (undef,undef,$container) = &Apache::lonnet::decode_symb($env{'form.symb'});
12030: $container = "/$container";
1.1123 raeburn 12031: } elsif ($context eq 'syllabus') {
12032: $container = $url;
1.987 raeburn 12033: } else {
1.1027 raeburn 12034: $container = $Apache::lonnet::perlvar{'lonDocRoot'}.$env{'form.filename'};
1.987 raeburn 12035: }
12036: my (%allfiles,%codebase,$output,$content);
12037: my @changes = &get_env_multiple('form.namechange');
1.1126 raeburn 12038: unless ((@changes > 0) || ($context eq 'syllabus')) {
1.1071 raeburn 12039: if (wantarray) {
12040: return ('',0,0);
12041: } else {
12042: return;
12043: }
12044: }
12045: if (($context eq 'portfolio') || ($context eq 'coursedoc') ||
1.1123 raeburn 12046: ($context eq 'manage_dependencies') || ($context eq 'syllabus')) {
1.1071 raeburn 12047: unless ($container =~ m{^/uploaded/\Q$udom\E/\Q$uname\E/}) {
12048: if (wantarray) {
12049: return ('',0,0);
12050: } else {
12051: return;
12052: }
12053: }
1.987 raeburn 12054: $content = &Apache::lonnet::getfile($container);
1.1071 raeburn 12055: if ($content eq '-1') {
12056: if (wantarray) {
12057: return ('',0,0);
12058: } else {
12059: return;
12060: }
12061: }
1.987 raeburn 12062: } else {
1.1071 raeburn 12063: unless ($container =~ /^\Q$dir_root\E/) {
12064: if (wantarray) {
12065: return ('',0,0);
12066: } else {
12067: return;
12068: }
12069: }
1.987 raeburn 12070: if (open(my $fh,"<$container")) {
12071: $content = join('', <$fh>);
12072: close($fh);
12073: } else {
1.1071 raeburn 12074: if (wantarray) {
12075: return ('',0,0);
12076: } else {
12077: return;
12078: }
1.987 raeburn 12079: }
12080: }
12081: my ($count,$codebasecount) = (0,0);
12082: my $mm = new File::MMagic;
12083: my $mime_type = $mm->checktype_contents($content);
12084: if ($mime_type eq 'text/html') {
12085: my $parse_result =
12086: &Apache::lonnet::extract_embedded_items($container,\%allfiles,
12087: \%codebase,\$content);
12088: if ($parse_result eq 'ok') {
12089: foreach my $i (@changes) {
12090: my $orig = &unescape($env{'form.embedded_orig_'.$i});
12091: my $ref = &unescape($env{'form.embedded_ref_'.$i});
12092: if ($allfiles{$ref}) {
12093: my $newname = $orig;
12094: my ($attrib_regexp,$codebase);
1.1006 raeburn 12095: $attrib_regexp = &unescape($env{'form.embedded_attrib_'.$i});
1.987 raeburn 12096: if ($attrib_regexp =~ /:/) {
12097: $attrib_regexp =~ s/\:/|/g;
12098: }
12099: if ($content =~ m{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}) {
12100: my $numchg = ($content =~ s{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}{$1$newname$2}gi);
12101: $count += $numchg;
1.1123 raeburn 12102: $allfiles{$newname} = $allfiles{$ref};
1.1148 raeburn 12103: delete($allfiles{$ref});
1.987 raeburn 12104: }
12105: if ($env{'form.embedded_codebase_'.$i} ne '') {
1.1006 raeburn 12106: $codebase = &unescape($env{'form.embedded_codebase_'.$i});
1.987 raeburn 12107: my $numchg = ($content =~ s/(codebase\s*=\s*["']?)\Q$codebase\E(["']?)/$1.$2/i); #' stupid emacs
12108: $codebasecount ++;
12109: }
12110: }
12111: }
1.1123 raeburn 12112: my $skiprewrites;
1.987 raeburn 12113: if ($count || $codebasecount) {
12114: my $saveresult;
1.1071 raeburn 12115: if (($context eq 'portfolio') || ($context eq 'coursedoc') ||
1.1123 raeburn 12116: ($context eq 'manage_dependencies') || ($context eq 'syllabus')) {
1.987 raeburn 12117: my $url = &Apache::lonnet::store_edited_file($container,$content,$udom,$uname,\$saveresult);
12118: if ($url eq $container) {
12119: my ($fname) = ($container =~ m{/([^/]+)$});
12120: $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
12121: $count,'<span class="LC_filename">'.
1.1071 raeburn 12122: $fname.'</span>').'</p>';
1.987 raeburn 12123: } else {
12124: $output = '<p class="LC_error">'.
12125: &mt('Error: update failed for: [_1].',
12126: '<span class="LC_filename">'.
12127: $container.'</span>').'</p>';
12128: }
1.1123 raeburn 12129: if ($context eq 'syllabus') {
12130: unless ($saveresult eq 'ok') {
12131: $skiprewrites = 1;
12132: }
12133: }
1.987 raeburn 12134: } else {
12135: if (open(my $fh,">$container")) {
12136: print $fh $content;
12137: close($fh);
12138: $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
12139: $count,'<span class="LC_filename">'.
12140: $container.'</span>').'</p>';
1.661 raeburn 12141: } else {
1.987 raeburn 12142: $output = '<p class="LC_error">'.
12143: &mt('Error: could not update [_1].',
12144: '<span class="LC_filename">'.
12145: $container.'</span>').'</p>';
1.661 raeburn 12146: }
12147: }
12148: }
1.1123 raeburn 12149: if (($context eq 'syllabus') && (!$skiprewrites)) {
12150: my ($actionurl,$state);
12151: $actionurl = "/public/$udom/$uname/syllabus";
12152: my ($ignore,$num,$numpathchanges,$existing,$mapping) =
12153: &ask_for_embedded_content($actionurl,$state,\%allfiles,
12154: \%codebase,
12155: {'context' => 'rewrites',
12156: 'ignore_remote_references' => 1,});
12157: if (ref($mapping) eq 'HASH') {
12158: my $rewrites = 0;
12159: foreach my $key (keys(%{$mapping})) {
12160: next if ($key =~ m{^https?://});
12161: my $ref = $mapping->{$key};
12162: my $newname = "/uploaded/$udom/$uname/portfolio/syllabus/$key";
12163: my $attrib;
12164: if (ref($allfiles{$mapping->{$key}}) eq 'ARRAY') {
12165: $attrib = join('|',@{$allfiles{$mapping->{$key}}});
12166: }
12167: if ($content =~ m{($attrib\s*=\s*['"]?)\Q$ref\E(['"]?)}) {
12168: my $numchg = ($content =~ s{($attrib\s*=\s*['"]?)\Q$ref\E(['"]?)}{$1$newname$2}gi);
12169: $rewrites += $numchg;
12170: }
12171: }
12172: if ($rewrites) {
12173: my $saveresult;
12174: my $url = &Apache::lonnet::store_edited_file($container,$content,$udom,$uname,\$saveresult);
12175: if ($url eq $container) {
12176: my ($fname) = ($container =~ m{/([^/]+)$});
12177: $output .= '<p>'.&mt('Rewrote [quant,_1,link] as [quant,_1,absolute link] in [_2].',
12178: $count,'<span class="LC_filename">'.
12179: $fname.'</span>').'</p>';
12180: } else {
12181: $output .= '<p class="LC_error">'.
12182: &mt('Error: could not update links in [_1].',
12183: '<span class="LC_filename">'.
12184: $container.'</span>').'</p>';
12185:
12186: }
12187: }
12188: }
12189: }
1.987 raeburn 12190: } else {
12191: &logthis('Failed to parse '.$container.
12192: ' to modify references: '.$parse_result);
1.661 raeburn 12193: }
12194: }
1.1071 raeburn 12195: if (wantarray) {
12196: return ($output,$count,$codebasecount);
12197: } else {
12198: return $output;
12199: }
1.661 raeburn 12200: }
12201:
12202: sub check_for_existing {
12203: my ($path,$fname,$element) = @_;
12204: my ($state,$msg);
12205: if (-d $path.'/'.$fname) {
12206: $state = 'exists';
12207: $msg = &mt('Unable to upload [_1]. A directory by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
12208: } elsif (-e $path.'/'.$fname) {
12209: $state = 'exists';
12210: $msg = &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
12211: }
12212: if ($state eq 'exists') {
12213: $msg = '<span class="LC_error">'.$msg.'</span><br />';
12214: }
12215: return ($state,$msg);
12216: }
12217:
12218: sub check_for_upload {
12219: my ($path,$fname,$group,$element,$portfolio_root,$port_path,
12220: $disk_quota,$current_disk_usage,$uname,$udom) = @_;
1.985 raeburn 12221: my $filesize = length($env{'form.'.$element});
12222: if (!$filesize) {
12223: my $msg = '<span class="LC_error">'.
12224: &mt('Unable to upload [_1]. (size = [_2] bytes)',
12225: '<span class="LC_filename">'.$fname.'</span>',
12226: $filesize).'<br />'.
1.1007 raeburn 12227: &mt('Either the file you attempted to upload was empty, or your web browser was unable to read its contents.').'<br />'.
1.985 raeburn 12228: '</span>';
12229: return ('zero_bytes',$msg);
12230: }
12231: $filesize = $filesize/1000; #express in k (1024?)
1.661 raeburn 12232: my $getpropath = 1;
1.1021 raeburn 12233: my ($dirlistref,$listerror) =
12234: &Apache::lonnet::dirlist($portfolio_root.$path,$udom,$uname,$getpropath);
1.661 raeburn 12235: my $found_file = 0;
12236: my $locked_file = 0;
1.991 raeburn 12237: my @lockers;
12238: my $navmap;
12239: if ($env{'request.course.id'}) {
12240: $navmap = Apache::lonnavmaps::navmap->new();
12241: }
1.1021 raeburn 12242: if (ref($dirlistref) eq 'ARRAY') {
12243: foreach my $line (@{$dirlistref}) {
12244: my ($file_name,$rest)=split(/\&/,$line,2);
12245: if ($file_name eq $fname){
12246: $file_name = $path.$file_name;
12247: if ($group ne '') {
12248: $file_name = $group.$file_name;
12249: }
12250: $found_file = 1;
12251: if (&Apache::lonnet::is_locked($file_name,$udom,$uname,\@lockers) eq 'true') {
12252: foreach my $lock (@lockers) {
12253: if (ref($lock) eq 'ARRAY') {
12254: my ($symb,$crsid) = @{$lock};
12255: if ($crsid eq $env{'request.course.id'}) {
12256: if (ref($navmap)) {
12257: my $res = $navmap->getBySymb($symb);
12258: foreach my $part (@{$res->parts()}) {
12259: my ($slot_status,$slot_time,$slot_name)=$res->check_for_slot($part);
12260: unless (($slot_status == $res->RESERVED) ||
12261: ($slot_status == $res->RESERVED_LOCATION)) {
12262: $locked_file = 1;
12263: }
1.991 raeburn 12264: }
1.1021 raeburn 12265: } else {
12266: $locked_file = 1;
1.991 raeburn 12267: }
12268: } else {
12269: $locked_file = 1;
12270: }
12271: }
1.1021 raeburn 12272: }
12273: } else {
12274: my @info = split(/\&/,$rest);
12275: my $currsize = $info[6]/1000;
12276: if ($currsize < $filesize) {
12277: my $extra = $filesize - $currsize;
12278: if (($current_disk_usage + $extra) > $disk_quota) {
1.1179 bisitz 12279: my $msg = '<p class="LC_warning">'.
1.1021 raeburn 12280: &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 12281: '<span class="LC_filename">'.$fname.'</span>',$filesize,$currsize).'</p>'.
12282: '<p>'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',
12283: $disk_quota,$current_disk_usage).'</p>';
1.1021 raeburn 12284: return ('will_exceed_quota',$msg);
12285: }
1.984 raeburn 12286: }
12287: }
1.661 raeburn 12288: }
12289: }
12290: }
12291: if (($current_disk_usage + $filesize) > $disk_quota){
1.1179 bisitz 12292: my $msg = '<p class="LC_warning">'.
12293: &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.','<span class="LC_filename">'.$fname.'</span>',$filesize).'</p>'.
1.1184 raeburn 12294: '<p>'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',$disk_quota,$current_disk_usage).'</p>';
1.661 raeburn 12295: return ('will_exceed_quota',$msg);
12296: } elsif ($found_file) {
12297: if ($locked_file) {
1.1179 bisitz 12298: my $msg = '<p class="LC_warning">';
1.661 raeburn 12299: $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 12300: $msg .= '</p>';
1.661 raeburn 12301: $msg .= &mt('You will be able to rename or delete existing [_1] after a grade has been assigned.','<span class="LC_filename">'.$fname.'</span>');
12302: return ('file_locked',$msg);
12303: } else {
1.1179 bisitz 12304: my $msg = '<p class="LC_error">';
1.984 raeburn 12305: $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 12306: $msg .= '</p>';
1.984 raeburn 12307: return ('existingfile',$msg);
1.661 raeburn 12308: }
12309: }
12310: }
12311:
1.987 raeburn 12312: sub check_for_traversal {
12313: my ($path,$url,$toplevel) = @_;
12314: my @parts=split(/\//,$path);
12315: my $cleanpath;
12316: my $fullpath = $url;
12317: for (my $i=0;$i<@parts;$i++) {
12318: next if ($parts[$i] eq '.');
12319: if ($parts[$i] eq '..') {
12320: $fullpath =~ s{([^/]+/)$}{};
12321: } else {
12322: $fullpath .= $parts[$i].'/';
12323: }
12324: }
12325: if ($fullpath =~ /^\Q$url\E(.*)$/) {
12326: $cleanpath = $1;
12327: } elsif ($fullpath =~ /^\Q$toplevel\E(.*)$/) {
12328: my $curr_toprel = $1;
12329: my @parts = split(/\//,$curr_toprel);
12330: my ($url_toprel) = ($url =~ /^\Q$toplevel\E(.*)$/);
12331: my @urlparts = split(/\//,$url_toprel);
12332: my $doubledots;
12333: my $startdiff = -1;
12334: for (my $i=0; $i<@urlparts; $i++) {
12335: if ($startdiff == -1) {
12336: unless ($urlparts[$i] eq $parts[$i]) {
12337: $startdiff = $i;
12338: $doubledots .= '../';
12339: }
12340: } else {
12341: $doubledots .= '../';
12342: }
12343: }
12344: if ($startdiff > -1) {
12345: $cleanpath = $doubledots;
12346: for (my $i=$startdiff; $i<@parts; $i++) {
12347: $cleanpath .= $parts[$i].'/';
12348: }
12349: }
12350: }
12351: $cleanpath =~ s{(/)$}{};
12352: return $cleanpath;
12353: }
1.31 albertel 12354:
1.1053 raeburn 12355: sub is_archive_file {
12356: my ($mimetype) = @_;
12357: if (($mimetype eq 'application/octet-stream') ||
12358: ($mimetype eq 'application/x-stuffit') ||
12359: ($mimetype =~ m{^application/(x\-)?(compressed|tar|zip|tgz|gz|gtar|gzip|gunzip|bz|bz2|bzip2)})) {
12360: return 1;
12361: }
12362: return;
12363: }
12364:
12365: sub decompress_form {
1.1065 raeburn 12366: my ($mimetype,$archiveurl,$action,$noextract,$hiddenelements,$dirlist) = @_;
1.1053 raeburn 12367: my %lt = &Apache::lonlocal::texthash (
12368: this => 'This file is an archive file.',
1.1067 raeburn 12369: camt => 'This file is a Camtasia archive file.',
1.1065 raeburn 12370: itsc => 'Its contents are as follows:',
1.1053 raeburn 12371: youm => 'You may wish to extract its contents.',
12372: extr => 'Extract contents',
1.1067 raeburn 12373: auto => 'LON-CAPA can process the files automatically, or you can decide how each should be handled.',
12374: proa => 'Process automatically?',
1.1053 raeburn 12375: yes => 'Yes',
12376: no => 'No',
1.1067 raeburn 12377: fold => 'Title for folder containing movie',
12378: movi => 'Title for page containing embedded movie',
1.1053 raeburn 12379: );
1.1065 raeburn 12380: my $fileloc = &Apache::lonnet::filelocation(undef,$archiveurl);
1.1067 raeburn 12381: my ($is_camtasia,$topdir,%toplevel,@paths);
1.1065 raeburn 12382: my $info = &list_archive_contents($fileloc,\@paths);
12383: if (@paths) {
12384: foreach my $path (@paths) {
12385: $path =~ s{^/}{};
1.1067 raeburn 12386: if ($path =~ m{^([^/]+)/$}) {
12387: $topdir = $1;
12388: }
1.1065 raeburn 12389: if ($path =~ m{^([^/]+)/}) {
12390: $toplevel{$1} = $path;
12391: } else {
12392: $toplevel{$path} = $path;
12393: }
12394: }
12395: }
1.1067 raeburn 12396: if ($mimetype =~ m{^application/(x\-)?(compressed|zip)}) {
1.1164 raeburn 12397: my @camtasia6 = ("$topdir/","$topdir/index.html",
1.1067 raeburn 12398: "$topdir/media/",
12399: "$topdir/media/$topdir.mp4",
12400: "$topdir/media/FirstFrame.png",
12401: "$topdir/media/player.swf",
12402: "$topdir/media/swfobject.js",
12403: "$topdir/media/expressInstall.swf");
1.1197 raeburn 12404: my @camtasia8_1 = ("$topdir/","$topdir/$topdir.html",
1.1164 raeburn 12405: "$topdir/$topdir.mp4",
12406: "$topdir/$topdir\_config.xml",
12407: "$topdir/$topdir\_controller.swf",
12408: "$topdir/$topdir\_embed.css",
12409: "$topdir/$topdir\_First_Frame.png",
12410: "$topdir/$topdir\_player.html",
12411: "$topdir/$topdir\_Thumbnails.png",
12412: "$topdir/playerProductInstall.swf",
12413: "$topdir/scripts/",
12414: "$topdir/scripts/config_xml.js",
12415: "$topdir/scripts/handlebars.js",
12416: "$topdir/scripts/jquery-1.7.1.min.js",
12417: "$topdir/scripts/jquery-ui-1.8.15.custom.min.js",
12418: "$topdir/scripts/modernizr.js",
12419: "$topdir/scripts/player-min.js",
12420: "$topdir/scripts/swfobject.js",
12421: "$topdir/skins/",
12422: "$topdir/skins/configuration_express.xml",
12423: "$topdir/skins/express_show/",
12424: "$topdir/skins/express_show/player-min.css",
12425: "$topdir/skins/express_show/spritesheet.png");
1.1197 raeburn 12426: my @camtasia8_4 = ("$topdir/","$topdir/$topdir.html",
12427: "$topdir/$topdir.mp4",
12428: "$topdir/$topdir\_config.xml",
12429: "$topdir/$topdir\_controller.swf",
12430: "$topdir/$topdir\_embed.css",
12431: "$topdir/$topdir\_First_Frame.png",
12432: "$topdir/$topdir\_player.html",
12433: "$topdir/$topdir\_Thumbnails.png",
12434: "$topdir/playerProductInstall.swf",
12435: "$topdir/scripts/",
12436: "$topdir/scripts/config_xml.js",
12437: "$topdir/scripts/techsmith-smart-player.min.js",
12438: "$topdir/skins/",
12439: "$topdir/skins/configuration_express.xml",
12440: "$topdir/skins/express_show/",
12441: "$topdir/skins/express_show/spritesheet.min.css",
12442: "$topdir/skins/express_show/spritesheet.png",
12443: "$topdir/skins/express_show/techsmith-smart-player.min.css");
1.1164 raeburn 12444: my @diffs = &compare_arrays(\@paths,\@camtasia6);
1.1067 raeburn 12445: if (@diffs == 0) {
1.1164 raeburn 12446: $is_camtasia = 6;
12447: } else {
1.1197 raeburn 12448: @diffs = &compare_arrays(\@paths,\@camtasia8_1);
1.1164 raeburn 12449: if (@diffs == 0) {
12450: $is_camtasia = 8;
1.1197 raeburn 12451: } else {
12452: @diffs = &compare_arrays(\@paths,\@camtasia8_4);
12453: if (@diffs == 0) {
12454: $is_camtasia = 8;
12455: }
1.1164 raeburn 12456: }
1.1067 raeburn 12457: }
12458: }
12459: my $output;
12460: if ($is_camtasia) {
12461: $output = <<"ENDCAM";
12462: <script type="text/javascript" language="Javascript">
12463: // <![CDATA[
12464:
12465: function camtasiaToggle() {
12466: for (var i=0; i<document.uploaded_decompress.autoextract_camtasia.length; i++) {
12467: if (document.uploaded_decompress.autoextract_camtasia[i].checked) {
1.1164 raeburn 12468: if (document.uploaded_decompress.autoextract_camtasia[i].value == $is_camtasia) {
1.1067 raeburn 12469: document.getElementById('camtasia_titles').style.display='block';
12470: } else {
12471: document.getElementById('camtasia_titles').style.display='none';
12472: }
12473: }
12474: }
12475: return;
12476: }
12477:
12478: // ]]>
12479: </script>
12480: <p>$lt{'camt'}</p>
12481: ENDCAM
1.1065 raeburn 12482: } else {
1.1067 raeburn 12483: $output = '<p>'.$lt{'this'};
12484: if ($info eq '') {
12485: $output .= ' '.$lt{'youm'}.'</p>'."\n";
12486: } else {
12487: $output .= ' '.$lt{'itsc'}.'</p>'."\n".
12488: '<div><pre>'.$info.'</pre></div>';
12489: }
1.1065 raeburn 12490: }
1.1067 raeburn 12491: $output .= '<form name="uploaded_decompress" action="'.$action.'" method="post">'."\n";
1.1065 raeburn 12492: my $duplicates;
12493: my $num = 0;
12494: if (ref($dirlist) eq 'ARRAY') {
12495: foreach my $item (@{$dirlist}) {
12496: if (ref($item) eq 'ARRAY') {
12497: if (exists($toplevel{$item->[0]})) {
12498: $duplicates .=
12499: &start_data_table_row().
12500: '<td><label><input type="radio" name="archive_overwrite_'.$num.'" '.
12501: 'value="0" checked="checked" />'.&mt('No').'</label>'.
12502: ' <label><input type="radio" name="archive_overwrite_'.$num.'" '.
12503: 'value="1" />'.&mt('Yes').'</label>'.
12504: '<input type="hidden" name="archive_overwrite_name_'.$num.'" value="'.$item->[0].'" /></td>'."\n".
12505: '<td>'.$item->[0].'</td>';
12506: if ($item->[2]) {
12507: $duplicates .= '<td>'.&mt('Directory').'</td>';
12508: } else {
12509: $duplicates .= '<td>'.&mt('File').'</td>';
12510: }
12511: $duplicates .= '<td>'.$item->[3].'</td>'.
12512: '<td>'.
12513: &Apache::lonlocal::locallocaltime($item->[4]).
12514: '</td>'.
12515: &end_data_table_row();
12516: $num ++;
12517: }
12518: }
12519: }
12520: }
12521: my $itemcount;
12522: if (@paths > 0) {
12523: $itemcount = scalar(@paths);
12524: } else {
12525: $itemcount = 1;
12526: }
1.1067 raeburn 12527: if ($is_camtasia) {
12528: $output .= $lt{'auto'}.'<br />'.
12529: '<span class="LC_nobreak">'.$lt{'proa'}.'<label>'.
1.1164 raeburn 12530: '<input type="radio" name="autoextract_camtasia" value="'.$is_camtasia.'" onclick="javascript:camtasiaToggle();" checked="checked" />'.
1.1067 raeburn 12531: $lt{'yes'}.'</label> <label>'.
12532: '<input type="radio" name="autoextract_camtasia" value="0" onclick="javascript:camtasiaToggle();" />'.
12533: $lt{'no'}.'</label></span><br />'.
12534: '<div id="camtasia_titles" style="display:block">'.
12535: &Apache::lonhtmlcommon::start_pick_box().
12536: &Apache::lonhtmlcommon::row_title($lt{'fold'}).
12537: '<input type="textbox" name="camtasia_foldername" value="'.$env{'form.comment'}.'" />'."\n".
12538: &Apache::lonhtmlcommon::row_closure().
12539: &Apache::lonhtmlcommon::row_title($lt{'movi'}).
12540: '<input type="textbox" name="camtasia_moviename" value="" />'."\n".
12541: &Apache::lonhtmlcommon::row_closure(1).
12542: &Apache::lonhtmlcommon::end_pick_box().
12543: '</div>';
12544: }
1.1065 raeburn 12545: $output .=
12546: '<input type="hidden" name="archive_overwrite_total" value="'.$num.'" />'.
1.1067 raeburn 12547: '<input type="hidden" name="archive_itemcount" value="'.$itemcount.'" />'.
12548: "\n";
1.1065 raeburn 12549: if ($duplicates ne '') {
12550: $output .= '<p><span class="LC_warning">'.
12551: &mt('Warning: decompression of the archive will overwrite the following items which already exist:').'</span><br />'.
12552: &start_data_table().
12553: &start_data_table_header_row().
12554: '<th>'.&mt('Overwrite?').'</th>'.
12555: '<th>'.&mt('Name').'</th>'.
12556: '<th>'.&mt('Type').'</th>'.
12557: '<th>'.&mt('Size').'</th>'.
12558: '<th>'.&mt('Last modified').'</th>'.
12559: &end_data_table_header_row().
12560: $duplicates.
12561: &end_data_table().
12562: '</p>';
12563: }
1.1067 raeburn 12564: $output .= '<input type="hidden" name="archiveurl" value="'.$archiveurl.'" />'."\n";
1.1053 raeburn 12565: if (ref($hiddenelements) eq 'HASH') {
12566: foreach my $hidden (sort(keys(%{$hiddenelements}))) {
12567: $output .= '<input type="hidden" name="'.$hidden.'" value="'.$hiddenelements->{$hidden}.'" />'."\n";
12568: }
12569: }
12570: $output .= <<"END";
1.1067 raeburn 12571: <br />
1.1053 raeburn 12572: <input type="submit" name="decompress" value="$lt{'extr'}" />
12573: </form>
12574: $noextract
12575: END
12576: return $output;
12577: }
12578:
1.1065 raeburn 12579: sub decompression_utility {
12580: my ($program) = @_;
12581: my @utilities = ('tar','gunzip','bunzip2','unzip');
12582: my $location;
12583: if (grep(/^\Q$program\E$/,@utilities)) {
12584: foreach my $dir ('/bin/','/usr/bin/','/usr/local/bin/','/sbin/',
12585: '/usr/sbin/') {
12586: if (-x $dir.$program) {
12587: $location = $dir.$program;
12588: last;
12589: }
12590: }
12591: }
12592: return $location;
12593: }
12594:
12595: sub list_archive_contents {
12596: my ($file,$pathsref) = @_;
12597: my (@cmd,$output);
12598: my $needsregexp;
12599: if ($file =~ /\.zip$/) {
12600: @cmd = (&decompression_utility('unzip'),"-l");
12601: $needsregexp = 1;
12602: } elsif (($file =~ m/\.tar\.gz$/) ||
12603: ($file =~ /\.tgz$/)) {
12604: @cmd = (&decompression_utility('tar'),"-ztf");
12605: } elsif ($file =~ /\.tar\.bz2$/) {
12606: @cmd = (&decompression_utility('tar'),"-jtf");
12607: } elsif ($file =~ m|\.tar$|) {
12608: @cmd = (&decompression_utility('tar'),"-tf");
12609: }
12610: if (@cmd) {
12611: undef($!);
12612: undef($@);
12613: if (open(my $fh,"-|", @cmd, $file)) {
12614: while (my $line = <$fh>) {
12615: $output .= $line;
12616: chomp($line);
12617: my $item;
12618: if ($needsregexp) {
12619: ($item) = ($line =~ /^\s*\d+\s+[\d\-]+\s+[\d:]+\s*(.+)$/);
12620: } else {
12621: $item = $line;
12622: }
12623: if ($item ne '') {
12624: unless (grep(/^\Q$item\E$/,@{$pathsref})) {
12625: push(@{$pathsref},$item);
12626: }
12627: }
12628: }
12629: close($fh);
12630: }
12631: }
12632: return $output;
12633: }
12634:
1.1053 raeburn 12635: sub decompress_uploaded_file {
12636: my ($file,$dir) = @_;
12637: &Apache::lonnet::appenv({'cgi.file' => $file});
12638: &Apache::lonnet::appenv({'cgi.dir' => $dir});
12639: my $result = &Apache::lonnet::ssi_body('/cgi-bin/decompress.pl');
12640: my ($handle) = ($env{'user.environment'} =~m{/([^/]+)\.id$});
12641: my $lonidsdir = $Apache::lonnet::perlvar{'lonIDsDir'};
12642: &Apache::lonnet::transfer_profile_to_env($lonidsdir,$handle,1);
12643: my $decompressed = $env{'cgi.decompressed'};
12644: &Apache::lonnet::delenv('cgi.file');
12645: &Apache::lonnet::delenv('cgi.dir');
12646: &Apache::lonnet::delenv('cgi.decompressed');
12647: return ($decompressed,$result);
12648: }
12649:
1.1055 raeburn 12650: sub process_decompression {
12651: my ($docudom,$docuname,$file,$destination,$dir_root,$hiddenelem) = @_;
1.1292 raeburn 12652: unless (($dir_root eq '/userfiles') && ($destination =~ m{^(docs|supplemental)/(default|\d+)/\d+$})) {
12653: return '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
12654: &mt('Unexpected file path.').'</p>'."\n";
12655: }
12656: unless (($docudom =~ /^$match_domain$/) && ($docuname =~ /^$match_courseid$/)) {
12657: return '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
12658: &mt('Unexpected course context.').'</p>'."\n";
12659: }
1.1293 raeburn 12660: unless ($file eq &Apache::lonnet::clean_filename($file)) {
1.1292 raeburn 12661: return '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
12662: &mt('Filename contained unexpected characters.').'</p>'."\n";
12663: }
1.1055 raeburn 12664: my ($dir,$error,$warning,$output);
1.1180 raeburn 12665: if ($file !~ /\.(zip|tar|bz2|gz|tar.gz|tar.bz2|tgz)$/i) {
1.1120 bisitz 12666: $error = &mt('Filename not a supported archive file type.').
12667: '<br />'.&mt('Filename should end with one of: [_1].',
1.1055 raeburn 12668: '.zip, .tar, .bz2, .gz, .tar.gz, .tar.bz2, .tgz');
12669: } else {
12670: my $docuhome = &Apache::lonnet::homeserver($docuname,$docudom);
12671: if ($docuhome eq 'no_host') {
12672: $error = &mt('Could not determine home server for course.');
12673: } else {
12674: my @ids=&Apache::lonnet::current_machine_ids();
12675: my $currdir = "$dir_root/$destination";
12676: if (grep(/^\Q$docuhome\E$/,@ids)) {
12677: $dir = &LONCAPA::propath($docudom,$docuname).
12678: "$dir_root/$destination";
12679: } else {
12680: $dir = $Apache::lonnet::perlvar{'lonDocRoot'}.
12681: "$dir_root/$docudom/$docuname/$destination";
12682: unless (&Apache::lonnet::repcopy_userfile("$dir/$file") eq 'ok') {
12683: $error = &mt('Archive file not found.');
12684: }
12685: }
1.1065 raeburn 12686: my (@to_overwrite,@to_skip);
12687: if ($env{'form.archive_overwrite_total'} > 0) {
12688: my $total = $env{'form.archive_overwrite_total'};
12689: for (my $i=0; $i<$total; $i++) {
12690: if ($env{'form.archive_overwrite_'.$i} == 1) {
12691: push(@to_overwrite,$env{'form.archive_overwrite_name_'.$i});
12692: } elsif ($env{'form.archive_overwrite_'.$i} == 0) {
12693: push(@to_skip,$env{'form.archive_overwrite_name_'.$i});
12694: }
12695: }
12696: }
12697: my $numskip = scalar(@to_skip);
1.1292 raeburn 12698: my $numoverwrite = scalar(@to_overwrite);
12699: if (($numskip) && (!$numoverwrite)) {
1.1065 raeburn 12700: $warning = &mt('All items in the archive file already exist, and no overwriting of existing files has been requested.');
12701: } elsif ($dir eq '') {
1.1055 raeburn 12702: $error = &mt('Directory containing archive file unavailable.');
12703: } elsif (!$error) {
1.1065 raeburn 12704: my ($decompressed,$display);
1.1292 raeburn 12705: if (($numskip) || ($numoverwrite)) {
1.1065 raeburn 12706: my $tempdir = time.'_'.$$.int(rand(10000));
12707: mkdir("$dir/$tempdir",0755);
1.1292 raeburn 12708: if (&File::Copy::move("$dir/$file","$dir/$tempdir/$file")) {
12709: ($decompressed,$display) =
12710: &decompress_uploaded_file($file,"$dir/$tempdir");
12711: foreach my $item (@to_skip) {
12712: if (($item ne '') && ($item !~ /\.\./)) {
12713: if (-f "$dir/$tempdir/$item") {
12714: unlink("$dir/$tempdir/$item");
12715: } elsif (-d "$dir/$tempdir/$item") {
1.1300 raeburn 12716: &File::Path::remove_tree("$dir/$tempdir/$item",{ safe => 1 });
1.1292 raeburn 12717: }
12718: }
12719: }
12720: foreach my $item (@to_overwrite) {
12721: if ((-e "$dir/$tempdir/$item") && (-e "$dir/$item")) {
12722: if (($item ne '') && ($item !~ /\.\./)) {
12723: if (-f "$dir/$item") {
12724: unlink("$dir/$item");
12725: } elsif (-d "$dir/$item") {
1.1300 raeburn 12726: &File::Path::remove_tree("$dir/$item",{ safe => 1 });
1.1292 raeburn 12727: }
12728: &File::Copy::move("$dir/$tempdir/$item","$dir/$item");
12729: }
1.1065 raeburn 12730: }
12731: }
1.1292 raeburn 12732: if (&File::Copy::move("$dir/$tempdir/$file","$dir/$file")) {
1.1300 raeburn 12733: &File::Path::remove_tree("$dir/$tempdir",{ safe => 1 });
1.1292 raeburn 12734: }
1.1065 raeburn 12735: }
12736: } else {
12737: ($decompressed,$display) =
12738: &decompress_uploaded_file($file,$dir);
12739: }
1.1055 raeburn 12740: if ($decompressed eq 'ok') {
1.1065 raeburn 12741: $output = '<p class="LC_info">'.
12742: &mt('Files extracted successfully from archive.').
12743: '</p>'."\n";
1.1055 raeburn 12744: my ($warning,$result,@contents);
12745: my ($newdirlistref,$newlisterror) =
12746: &Apache::lonnet::dirlist($currdir,$docudom,
12747: $docuname,1);
12748: my (%is_dir,%changes,@newitems);
12749: my $dirptr = 16384;
1.1065 raeburn 12750: if (ref($newdirlistref) eq 'ARRAY') {
1.1055 raeburn 12751: foreach my $dir_line (@{$newdirlistref}) {
12752: my ($item,undef,undef,$testdir)=split(/\&/,$dir_line,5);
1.1292 raeburn 12753: unless (($item =~ /^\.+$/) || ($item eq $file)) {
1.1055 raeburn 12754: push(@newitems,$item);
12755: if ($dirptr&$testdir) {
12756: $is_dir{$item} = 1;
12757: }
12758: $changes{$item} = 1;
12759: }
12760: }
12761: }
12762: if (keys(%changes) > 0) {
12763: foreach my $item (sort(@newitems)) {
12764: if ($changes{$item}) {
12765: push(@contents,$item);
12766: }
12767: }
12768: }
12769: if (@contents > 0) {
1.1067 raeburn 12770: my $wantform;
12771: unless ($env{'form.autoextract_camtasia'}) {
12772: $wantform = 1;
12773: }
1.1056 raeburn 12774: my (%children,%parent,%dirorder,%titles);
1.1055 raeburn 12775: my ($count,$datatable) = &get_extracted($docudom,$docuname,
12776: $currdir,\%is_dir,
12777: \%children,\%parent,
1.1056 raeburn 12778: \@contents,\%dirorder,
12779: \%titles,$wantform);
1.1055 raeburn 12780: if ($datatable ne '') {
12781: $output .= &archive_options_form('decompressed',$datatable,
12782: $count,$hiddenelem);
1.1065 raeburn 12783: my $startcount = 6;
1.1055 raeburn 12784: $output .= &archive_javascript($startcount,$count,
1.1056 raeburn 12785: \%titles,\%children);
1.1055 raeburn 12786: }
1.1067 raeburn 12787: if ($env{'form.autoextract_camtasia'}) {
1.1164 raeburn 12788: my $version = $env{'form.autoextract_camtasia'};
1.1067 raeburn 12789: my %displayed;
12790: my $total = 1;
12791: $env{'form.archive_directory'} = [];
12792: foreach my $i (sort { $a <=> $b } keys(%dirorder)) {
12793: my $path = join('/',map { $titles{$_}; } @{$dirorder{$i}});
12794: $path =~ s{/$}{};
12795: my $item;
12796: if ($path ne '') {
12797: $item = "$path/$titles{$i}";
12798: } else {
12799: $item = $titles{$i};
12800: }
12801: $env{'form.archive_content_'.$i} = "$dir_root/$destination/$item";
12802: if ($item eq $contents[0]) {
12803: push(@{$env{'form.archive_directory'}},$i);
12804: $env{'form.archive_'.$i} = 'display';
12805: $env{'form.archive_title_'.$i} = $env{'form.camtasia_foldername'};
12806: $displayed{'folder'} = $i;
1.1164 raeburn 12807: } elsif ((($item eq "$contents[0]/index.html") && ($version == 6)) ||
12808: (($item eq "$contents[0]/$contents[0]".'.html') && ($version == 8))) {
1.1067 raeburn 12809: $env{'form.archive_'.$i} = 'display';
12810: $env{'form.archive_title_'.$i} = $env{'form.camtasia_moviename'};
12811: $displayed{'web'} = $i;
12812: } else {
1.1164 raeburn 12813: if ((($item eq "$contents[0]/media") && ($version == 6)) ||
12814: ((($item eq "$contents[0]/scripts") || ($item eq "$contents[0]/skins") ||
12815: ($item eq "$contents[0]/skins/express_show")) && ($version == 8))) {
1.1067 raeburn 12816: push(@{$env{'form.archive_directory'}},$i);
12817: }
12818: $env{'form.archive_'.$i} = 'dependency';
12819: }
12820: $total ++;
12821: }
12822: for (my $i=1; $i<$total; $i++) {
12823: next if ($i == $displayed{'web'});
12824: next if ($i == $displayed{'folder'});
12825: $env{'form.archive_dependent_on_'.$i} = $displayed{'web'};
12826: }
12827: $env{'form.phase'} = 'decompress_cleanup';
12828: $env{'form.archivedelete'} = 1;
12829: $env{'form.archive_count'} = $total-1;
12830: $output .=
12831: &process_extracted_files('coursedocs',$docudom,
12832: $docuname,$destination,
12833: $dir_root,$hiddenelem);
12834: }
1.1055 raeburn 12835: } else {
12836: $warning = &mt('No new items extracted from archive file.');
12837: }
12838: } else {
12839: $output = $display;
12840: $error = &mt('An error occurred during extraction from the archive file.');
12841: }
12842: }
12843: }
12844: }
12845: if ($error) {
12846: $output .= '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
12847: $error.'</p>'."\n";
12848: }
12849: if ($warning) {
12850: $output .= '<p class="LC_warning">'.$warning.'</p>'."\n";
12851: }
12852: return $output;
12853: }
12854:
12855: sub get_extracted {
1.1056 raeburn 12856: my ($docudom,$docuname,$currdir,$is_dir,$children,$parent,$contents,$dirorder,
12857: $titles,$wantform) = @_;
1.1055 raeburn 12858: my $count = 0;
12859: my $depth = 0;
12860: my $datatable;
1.1056 raeburn 12861: my @hierarchy;
1.1055 raeburn 12862: return unless ((ref($is_dir) eq 'HASH') && (ref($children) eq 'HASH') &&
1.1056 raeburn 12863: (ref($parent) eq 'HASH') && (ref($contents) eq 'ARRAY') &&
12864: (ref($dirorder) eq 'HASH') && (ref($titles) eq 'HASH'));
1.1055 raeburn 12865: foreach my $item (@{$contents}) {
12866: $count ++;
1.1056 raeburn 12867: @{$dirorder->{$count}} = @hierarchy;
12868: $titles->{$count} = $item;
1.1055 raeburn 12869: &archive_hierarchy($depth,$count,$parent,$children);
12870: if ($wantform) {
12871: $datatable .= &archive_row($is_dir->{$item},$item,
12872: $currdir,$depth,$count);
12873: }
12874: if ($is_dir->{$item}) {
12875: $depth ++;
1.1056 raeburn 12876: push(@hierarchy,$count);
12877: $parent->{$depth} = $count;
1.1055 raeburn 12878: $datatable .=
12879: &recurse_extracted_archive("$currdir/$item",$docudom,$docuname,
1.1056 raeburn 12880: \$depth,\$count,\@hierarchy,$dirorder,
12881: $children,$parent,$titles,$wantform);
1.1055 raeburn 12882: $depth --;
1.1056 raeburn 12883: pop(@hierarchy);
1.1055 raeburn 12884: }
12885: }
12886: return ($count,$datatable);
12887: }
12888:
12889: sub recurse_extracted_archive {
1.1056 raeburn 12890: my ($currdir,$docudom,$docuname,$depth,$count,$hierarchy,$dirorder,
12891: $children,$parent,$titles,$wantform) = @_;
1.1055 raeburn 12892: my $result='';
1.1056 raeburn 12893: unless ((ref($depth)) && (ref($count)) && (ref($hierarchy) eq 'ARRAY') &&
12894: (ref($children) eq 'HASH') && (ref($parent) eq 'HASH') &&
12895: (ref($dirorder) eq 'HASH')) {
1.1055 raeburn 12896: return $result;
12897: }
12898: my $dirptr = 16384;
12899: my ($newdirlistref,$newlisterror) =
12900: &Apache::lonnet::dirlist($currdir,$docudom,$docuname,1);
12901: if (ref($newdirlistref) eq 'ARRAY') {
12902: foreach my $dir_line (@{$newdirlistref}) {
12903: my ($item,undef,undef,$testdir)=split(/\&/,$dir_line,5);
12904: unless ($item =~ /^\.+$/) {
12905: $$count ++;
1.1056 raeburn 12906: @{$dirorder->{$$count}} = @{$hierarchy};
12907: $titles->{$$count} = $item;
1.1055 raeburn 12908: &archive_hierarchy($$depth,$$count,$parent,$children);
1.1056 raeburn 12909:
1.1055 raeburn 12910: my $is_dir;
12911: if ($dirptr&$testdir) {
12912: $is_dir = 1;
12913: }
12914: if ($wantform) {
12915: $result .= &archive_row($is_dir,$item,$currdir,$$depth,$$count);
12916: }
12917: if ($is_dir) {
12918: $$depth ++;
1.1056 raeburn 12919: push(@{$hierarchy},$$count);
12920: $parent->{$$depth} = $$count;
1.1055 raeburn 12921: $result .=
12922: &recurse_extracted_archive("$currdir/$item",$docudom,
12923: $docuname,$depth,$count,
1.1056 raeburn 12924: $hierarchy,$dirorder,$children,
12925: $parent,$titles,$wantform);
1.1055 raeburn 12926: $$depth --;
1.1056 raeburn 12927: pop(@{$hierarchy});
1.1055 raeburn 12928: }
12929: }
12930: }
12931: }
12932: return $result;
12933: }
12934:
12935: sub archive_hierarchy {
12936: my ($depth,$count,$parent,$children) =@_;
12937: if ((ref($parent) eq 'HASH') && (ref($children) eq 'HASH')) {
12938: if (exists($parent->{$depth})) {
12939: $children->{$parent->{$depth}} .= $count.':';
12940: }
12941: }
12942: return;
12943: }
12944:
12945: sub archive_row {
12946: my ($is_dir,$item,$currdir,$depth,$count) = @_;
12947: my ($name) = ($item =~ m{([^/]+)$});
12948: my %choices = &Apache::lonlocal::texthash (
1.1059 raeburn 12949: 'display' => 'Add as file',
1.1055 raeburn 12950: 'dependency' => 'Include as dependency',
12951: 'discard' => 'Discard',
12952: );
12953: if ($is_dir) {
1.1059 raeburn 12954: $choices{'display'} = &mt('Add as folder');
1.1055 raeburn 12955: }
1.1056 raeburn 12956: my $output = &start_data_table_row().'<td align="right">'.$count.'</td>'."\n";
12957: my $offset = 0;
1.1055 raeburn 12958: foreach my $action ('display','dependency','discard') {
1.1056 raeburn 12959: $offset ++;
1.1065 raeburn 12960: if ($action ne 'display') {
12961: $offset ++;
12962: }
1.1055 raeburn 12963: $output .= '<td><span class="LC_nobreak">'.
12964: '<label><input type="radio" name="archive_'.$count.
12965: '" id="archive_'.$action.'_'.$count.'" value="'.$action.'"';
12966: my $text = $choices{$action};
12967: if ($is_dir) {
12968: $output .= ' onclick="javascript:propagateCheck(this.form,'."'$count'".');"';
12969: if ($action eq 'display') {
1.1059 raeburn 12970: $text = &mt('Add as folder');
1.1055 raeburn 12971: }
1.1056 raeburn 12972: } else {
12973: $output .= ' onclick="javascript:dependencyCheck(this.form,'."$count,$offset".');"';
12974:
12975: }
12976: $output .= ' /> '.$choices{$action}.'</label></span>';
12977: if ($action eq 'dependency') {
12978: $output .= '<div id="arc_depon_'.$count.'" style="display:none;">'."\n".
12979: &mt('Used by:').' <select name="archive_dependent_on_'.$count.'" '.
12980: 'onchange="propagateSelect(this.form,'."$count,$offset".')">'."\n".
12981: '<option value=""></option>'."\n".
12982: '</select>'."\n".
12983: '</div>';
1.1059 raeburn 12984: } elsif ($action eq 'display') {
12985: $output .= '<div id="arc_title_'.$count.'" style="display:none;">'."\n".
12986: &mt('Title:').' <input type="text" name="archive_title_'.$count.'" id="archive_title_'.$count.'" />'."\n".
12987: '</div>';
1.1055 raeburn 12988: }
1.1056 raeburn 12989: $output .= '</td>';
1.1055 raeburn 12990: }
12991: $output .= '<td><input type="hidden" name="archive_content_'.$count.'" value="'.
12992: &HTML::Entities::encode("$currdir/$item",'"<>&').'" />'.(' ' x 2);
12993: for (my $i=0; $i<$depth; $i++) {
12994: $output .= ('<img src="/adm/lonIcons/whitespace1.gif" class="LC_docs_spacer" alt="" />' x2)."\n";
12995: }
12996: if ($is_dir) {
12997: $output .= '<img src="/adm/lonIcons/navmap.folder.open.gif" alt="" /> '."\n".
12998: '<input type="hidden" name="archive_directory" value="'.$count.'" />'."\n";
12999: } else {
13000: $output .= '<input type="hidden" name="archive_file" value="'.$count.'" />'."\n";
13001: }
13002: $output .= ' '.$name.'</td>'."\n".
13003: &end_data_table_row();
13004: return $output;
13005: }
13006:
13007: sub archive_options_form {
1.1065 raeburn 13008: my ($form,$display,$count,$hiddenelem) = @_;
13009: my %lt = &Apache::lonlocal::texthash(
13010: perm => 'Permanently remove archive file?',
13011: hows => 'How should each extracted item be incorporated in the course?',
13012: cont => 'Content actions for all',
13013: addf => 'Add as folder/file',
13014: incd => 'Include as dependency for a displayed file',
13015: disc => 'Discard',
13016: no => 'No',
13017: yes => 'Yes',
13018: save => 'Save',
13019: );
13020: my $output = <<"END";
13021: <form name="$form" method="post" action="">
13022: <p><span class="LC_nobreak">$lt{'perm'}
13023: <label>
13024: <input type="radio" name="archivedelete" value="0" checked="checked" />$lt{'no'}
13025: </label>
13026:
13027: <label>
13028: <input type="radio" name="archivedelete" value="1" />$lt{'yes'}</label>
13029: </span>
13030: </p>
13031: <input type="hidden" name="phase" value="decompress_cleanup" />
13032: <br />$lt{'hows'}
13033: <div class="LC_columnSection">
13034: <fieldset>
13035: <legend>$lt{'cont'}</legend>
13036: <input type="button" value="$lt{'addf'}" onclick="javascript:checkAll(document.$form,'display');" />
13037: <input type="button" value="$lt{'incd'}" onclick="javascript:checkAll(document.$form,'dependency');" />
13038: <input type="button" value="$lt{'disc'}" onclick="javascript:checkAll(document.$form,'discard');" />
13039: </fieldset>
13040: </div>
13041: END
13042: return $output.
1.1055 raeburn 13043: &start_data_table()."\n".
1.1065 raeburn 13044: $display."\n".
1.1055 raeburn 13045: &end_data_table()."\n".
13046: '<input type="hidden" name="archive_count" value="'.$count.'" />'.
13047: $hiddenelem.
1.1065 raeburn 13048: '<br /><input type="submit" name="archive_submit" value="'.$lt{'save'}.'" />'.
1.1055 raeburn 13049: '</form>';
13050: }
13051:
13052: sub archive_javascript {
1.1056 raeburn 13053: my ($startcount,$numitems,$titles,$children) = @_;
13054: return unless ((ref($titles) eq 'HASH') && (ref($children) eq 'HASH'));
1.1059 raeburn 13055: my $maintitle = $env{'form.comment'};
1.1055 raeburn 13056: my $scripttag = <<START;
13057: <script type="text/javascript">
13058: // <![CDATA[
13059:
13060: function checkAll(form,prefix) {
13061: var idstr = new RegExp("^archive_"+prefix+"_\\\\d+\$");
13062: for (var i=0; i < form.elements.length; i++) {
13063: var id = form.elements[i].id;
13064: if ((id != '') && (id != undefined)) {
13065: if (idstr.test(id)) {
13066: if (form.elements[i].type == 'radio') {
13067: form.elements[i].checked = true;
1.1056 raeburn 13068: var nostart = i-$startcount;
1.1059 raeburn 13069: var offset = nostart%7;
13070: var count = (nostart-offset)/7;
1.1056 raeburn 13071: dependencyCheck(form,count,offset);
1.1055 raeburn 13072: }
13073: }
13074: }
13075: }
13076: }
13077:
13078: function propagateCheck(form,count) {
13079: if (count > 0) {
1.1059 raeburn 13080: var startelement = $startcount + ((count-1) * 7);
13081: for (var j=1; j<6; j++) {
13082: if ((j != 2) && (j != 4)) {
1.1056 raeburn 13083: var item = startelement + j;
13084: if (form.elements[item].type == 'radio') {
13085: if (form.elements[item].checked) {
13086: containerCheck(form,count,j);
13087: break;
13088: }
1.1055 raeburn 13089: }
13090: }
13091: }
13092: }
13093: }
13094:
13095: numitems = $numitems
1.1056 raeburn 13096: var titles = new Array(numitems);
13097: var parents = new Array(numitems);
1.1055 raeburn 13098: for (var i=0; i<numitems; i++) {
1.1056 raeburn 13099: parents[i] = new Array;
1.1055 raeburn 13100: }
1.1059 raeburn 13101: var maintitle = '$maintitle';
1.1055 raeburn 13102:
13103: START
13104:
1.1056 raeburn 13105: foreach my $container (sort { $a <=> $b } (keys(%{$children}))) {
13106: my @contents = split(/:/,$children->{$container});
1.1055 raeburn 13107: for (my $i=0; $i<@contents; $i ++) {
13108: $scripttag .= 'parents['.$container.']['.$i.'] = '.$contents[$i]."\n";
13109: }
13110: }
13111:
1.1056 raeburn 13112: foreach my $key (sort { $a <=> $b } (keys(%{$titles}))) {
13113: $scripttag .= "titles[$key] = '".$titles->{$key}."';\n";
13114: }
13115:
1.1055 raeburn 13116: $scripttag .= <<END;
13117:
13118: function containerCheck(form,count,offset) {
13119: if (count > 0) {
1.1056 raeburn 13120: dependencyCheck(form,count,offset);
1.1059 raeburn 13121: var item = (offset+$startcount)+7*(count-1);
1.1055 raeburn 13122: form.elements[item].checked = true;
13123: if(Object.prototype.toString.call(parents[count]) === '[object Array]') {
13124: if (parents[count].length > 0) {
13125: for (var j=0; j<parents[count].length; j++) {
1.1056 raeburn 13126: containerCheck(form,parents[count][j],offset);
13127: }
13128: }
13129: }
13130: }
13131: }
13132:
13133: function dependencyCheck(form,count,offset) {
13134: if (count > 0) {
1.1059 raeburn 13135: var chosen = (offset+$startcount)+7*(count-1);
13136: var depitem = $startcount + ((count-1) * 7) + 4;
1.1056 raeburn 13137: var currtype = form.elements[depitem].type;
13138: if (form.elements[chosen].value == 'dependency') {
13139: document.getElementById('arc_depon_'+count).style.display='block';
13140: form.elements[depitem].options.length = 0;
13141: form.elements[depitem].options[0] = new Option('Select','',true,true);
1.1085 raeburn 13142: for (var i=1; i<=numitems; i++) {
13143: if (i == count) {
13144: continue;
13145: }
1.1059 raeburn 13146: var startelement = $startcount + (i-1) * 7;
13147: for (var j=1; j<6; j++) {
13148: if ((j != 2) && (j!= 4)) {
1.1056 raeburn 13149: var item = startelement + j;
13150: if (form.elements[item].type == 'radio') {
13151: if (form.elements[item].checked) {
13152: if (form.elements[item].value == 'display') {
13153: var n = form.elements[depitem].options.length;
13154: form.elements[depitem].options[n] = new Option(titles[i],i,false,false);
13155: }
13156: }
13157: }
13158: }
13159: }
13160: }
13161: } else {
13162: document.getElementById('arc_depon_'+count).style.display='none';
13163: form.elements[depitem].options.length = 0;
13164: form.elements[depitem].options[0] = new Option('Select','',true,true);
13165: }
1.1059 raeburn 13166: titleCheck(form,count,offset);
1.1056 raeburn 13167: }
13168: }
13169:
13170: function propagateSelect(form,count,offset) {
13171: if (count > 0) {
1.1065 raeburn 13172: var item = (1+offset+$startcount)+7*(count-1);
1.1056 raeburn 13173: var picked = form.elements[item].options[form.elements[item].selectedIndex].value;
13174: if (Object.prototype.toString.call(parents[count]) === '[object Array]') {
13175: if (parents[count].length > 0) {
13176: for (var j=0; j<parents[count].length; j++) {
13177: containerSelect(form,parents[count][j],offset,picked);
1.1055 raeburn 13178: }
13179: }
13180: }
13181: }
13182: }
1.1056 raeburn 13183:
13184: function containerSelect(form,count,offset,picked) {
13185: if (count > 0) {
1.1065 raeburn 13186: var item = (offset+$startcount)+7*(count-1);
1.1056 raeburn 13187: if (form.elements[item].type == 'radio') {
13188: if (form.elements[item].value == 'dependency') {
13189: if (form.elements[item+1].type == 'select-one') {
13190: for (var i=0; i<form.elements[item+1].options.length; i++) {
13191: if (form.elements[item+1].options[i].value == picked) {
13192: form.elements[item+1].selectedIndex = i;
13193: break;
13194: }
13195: }
13196: }
13197: if (Object.prototype.toString.call(parents[count]) === '[object Array]') {
13198: if (parents[count].length > 0) {
13199: for (var j=0; j<parents[count].length; j++) {
13200: containerSelect(form,parents[count][j],offset,picked);
13201: }
13202: }
13203: }
13204: }
13205: }
13206: }
13207: }
13208:
1.1059 raeburn 13209: function titleCheck(form,count,offset) {
13210: if (count > 0) {
13211: var chosen = (offset+$startcount)+7*(count-1);
13212: var depitem = $startcount + ((count-1) * 7) + 2;
13213: var currtype = form.elements[depitem].type;
13214: if (form.elements[chosen].value == 'display') {
13215: document.getElementById('arc_title_'+count).style.display='block';
13216: if ((count==1) && ((parents[count].length > 0) || (numitems == 1))) {
13217: document.getElementById('archive_title_'+count).value=maintitle;
13218: }
13219: } else {
13220: document.getElementById('arc_title_'+count).style.display='none';
13221: if (currtype == 'text') {
13222: document.getElementById('archive_title_'+count).value='';
13223: }
13224: }
13225: }
13226: return;
13227: }
13228:
1.1055 raeburn 13229: // ]]>
13230: </script>
13231: END
13232: return $scripttag;
13233: }
13234:
13235: sub process_extracted_files {
1.1067 raeburn 13236: my ($context,$docudom,$docuname,$destination,$dir_root,$hiddenelem) = @_;
1.1055 raeburn 13237: my $numitems = $env{'form.archive_count'};
1.1294 raeburn 13238: return if ((!$numitems) || ($numitems =~ /\D/));
1.1055 raeburn 13239: my @ids=&Apache::lonnet::current_machine_ids();
13240: my ($prefix,$pathtocheck,$dir,$ishome,$error,$warning,%toplevelitems,%is_dir,
1.1067 raeburn 13241: %folders,%containers,%mapinner,%prompttofetch);
1.1055 raeburn 13242: my $docuhome = &Apache::lonnet::homeserver($docuname,$docudom);
13243: if (grep(/^\Q$docuhome\E$/,@ids)) {
13244: $prefix = &LONCAPA::propath($docudom,$docuname);
13245: $pathtocheck = "$dir_root/$destination";
13246: $dir = $dir_root;
13247: $ishome = 1;
13248: } else {
13249: $prefix = $Apache::lonnet::perlvar{'lonDocRoot'};
13250: $pathtocheck = "$dir_root/$docudom/$docuname/$destination";
1.1294 raeburn 13251: $dir = "$dir_root/$docudom/$docuname";
1.1055 raeburn 13252: }
13253: my $currdir = "$dir_root/$destination";
13254: (my $docstype,$mapinner{'0'}) = ($destination =~ m{^(docs|supplemental)/(\w+)/});
13255: if ($env{'form.folderpath'}) {
13256: my @items = split('&',$env{'form.folderpath'});
13257: $folders{'0'} = $items[-2];
1.1099 raeburn 13258: if ($env{'form.folderpath'} =~ /\:1$/) {
13259: $containers{'0'}='page';
13260: } else {
13261: $containers{'0'}='sequence';
13262: }
1.1055 raeburn 13263: }
13264: my @archdirs = &get_env_multiple('form.archive_directory');
13265: if ($numitems) {
13266: for (my $i=1; $i<=$numitems; $i++) {
13267: my $path = $env{'form.archive_content_'.$i};
13268: if ($path =~ m{^\Q$pathtocheck\E/([^/]+)$}) {
13269: my $item = $1;
13270: $toplevelitems{$item} = $i;
13271: if (grep(/^\Q$i\E$/,@archdirs)) {
13272: $is_dir{$item} = 1;
13273: }
13274: }
13275: }
13276: }
1.1067 raeburn 13277: my ($output,%children,%parent,%titles,%dirorder,$result);
1.1055 raeburn 13278: if (keys(%toplevelitems) > 0) {
13279: my @contents = sort(keys(%toplevelitems));
1.1056 raeburn 13280: (my $count,undef) = &get_extracted($docudom,$docuname,$currdir,\%is_dir,\%children,
13281: \%parent,\@contents,\%dirorder,\%titles);
1.1055 raeburn 13282: }
1.1066 raeburn 13283: my (%referrer,%orphaned,%todelete,%todeletedir,%newdest,%newseqid);
1.1055 raeburn 13284: if ($numitems) {
13285: for (my $i=1; $i<=$numitems; $i++) {
1.1086 raeburn 13286: next if ($env{'form.archive_'.$i} eq 'dependency');
1.1055 raeburn 13287: my $path = $env{'form.archive_content_'.$i};
13288: if ($path =~ /^\Q$pathtocheck\E/) {
13289: if ($env{'form.archive_'.$i} eq 'discard') {
13290: if ($prefix ne '' && $path ne '') {
13291: if (-e $prefix.$path) {
1.1066 raeburn 13292: if ((@archdirs > 0) &&
13293: (grep(/^\Q$i\E$/,@archdirs))) {
13294: $todeletedir{$prefix.$path} = 1;
13295: } else {
13296: $todelete{$prefix.$path} = 1;
13297: }
1.1055 raeburn 13298: }
13299: }
13300: } elsif ($env{'form.archive_'.$i} eq 'display') {
1.1059 raeburn 13301: my ($docstitle,$title,$url,$outer);
1.1055 raeburn 13302: ($title) = ($path =~ m{/([^/]+)$});
1.1059 raeburn 13303: $docstitle = $env{'form.archive_title_'.$i};
13304: if ($docstitle eq '') {
13305: $docstitle = $title;
13306: }
1.1055 raeburn 13307: $outer = 0;
1.1056 raeburn 13308: if (ref($dirorder{$i}) eq 'ARRAY') {
13309: if (@{$dirorder{$i}} > 0) {
13310: foreach my $item (reverse(@{$dirorder{$i}})) {
1.1055 raeburn 13311: if ($env{'form.archive_'.$item} eq 'display') {
13312: $outer = $item;
13313: last;
13314: }
13315: }
13316: }
13317: }
13318: my ($errtext,$fatal) =
13319: &LONCAPA::map::mapread('/uploaded/'.$docudom.'/'.$docuname.
13320: '/'.$folders{$outer}.'.'.
13321: $containers{$outer});
13322: next if ($fatal);
13323: if ((@archdirs > 0) && (grep(/^\Q$i\E$/,@archdirs))) {
13324: if ($context eq 'coursedocs') {
1.1056 raeburn 13325: $mapinner{$i} = time;
1.1055 raeburn 13326: $folders{$i} = 'default_'.$mapinner{$i};
13327: $containers{$i} = 'sequence';
13328: my $url = '/uploaded/'.$docudom.'/'.$docuname.'/'.
13329: $folders{$i}.'.'.$containers{$i};
13330: my $newidx = &LONCAPA::map::getresidx();
13331: $LONCAPA::map::resources[$newidx]=
1.1059 raeburn 13332: $docstitle.':'.$url.':false:normal:res';
1.1055 raeburn 13333: push(@LONCAPA::map::order,$newidx);
13334: my ($outtext,$errtext) =
13335: &LONCAPA::map::storemap('/uploaded/'.$docudom.'/'.
13336: $docuname.'/'.$folders{$outer}.
1.1087 raeburn 13337: '.'.$containers{$outer},1,1);
1.1056 raeburn 13338: $newseqid{$i} = $newidx;
1.1067 raeburn 13339: unless ($errtext) {
1.1294 raeburn 13340: $result .= '<li>'.&mt('Folder: [_1] added to course',
13341: &HTML::Entities::encode($docstitle,'<>&"')).
13342: '</li>'."\n";
1.1067 raeburn 13343: }
1.1055 raeburn 13344: }
13345: } else {
13346: if ($context eq 'coursedocs') {
13347: my $newidx=&LONCAPA::map::getresidx();
13348: my $url = '/uploaded/'.$docudom.'/'.$docuname.'/'.
13349: $docstype.'/'.$mapinner{$outer}.'/'.$newidx.'/'.
13350: $title;
1.1294 raeburn 13351: if (($outer !~ /\D/) && ($mapinner{$outer} !~ /\D/) && ($newidx !~ /\D/)) {
13352: if (!-e "$prefix$dir/$docstype/$mapinner{$outer}") {
13353: mkdir("$prefix$dir/$docstype/$mapinner{$outer}",0755);
13354: }
13355: if (!-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx") {
13356: mkdir("$prefix$dir/$docstype/$mapinner{$outer}/$newidx");
13357: }
13358: if (-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx") {
13359: if (rename("$prefix$path","$prefix$dir/$docstype/$mapinner{$outer}/$newidx/$title")) {
13360: $newdest{$i} = "$prefix$dir/$docstype/$mapinner{$outer}/$newidx";
13361: unless ($ishome) {
13362: my $fetch = "$newdest{$i}/$title";
13363: $fetch =~ s/^\Q$prefix$dir\E//;
13364: $prompttofetch{$fetch} = 1;
13365: }
1.1292 raeburn 13366: }
1.1067 raeburn 13367: }
1.1294 raeburn 13368: $LONCAPA::map::resources[$newidx]=
13369: $docstitle.':'.$url.':false:normal:res';
13370: push(@LONCAPA::map::order, $newidx);
13371: my ($outtext,$errtext)=
13372: &LONCAPA::map::storemap('/uploaded/'.$docudom.'/'.
13373: $docuname.'/'.$folders{$outer}.
13374: '.'.$containers{$outer},1,1);
13375: unless ($errtext) {
13376: if (-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx/$title") {
13377: $result .= '<li>'.&mt('File: [_1] added to course',
13378: &HTML::Entities::encode($docstitle,'<>&"')).
13379: '</li>'."\n";
13380: }
1.1067 raeburn 13381: }
1.1294 raeburn 13382: } else {
13383: $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',
13384: &HTML::Entities::encode($path,'<>&"')).'<br />';
1.1296 raeburn 13385: }
1.1055 raeburn 13386: }
13387: }
1.1086 raeburn 13388: }
13389: } else {
1.1294 raeburn 13390: $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',
13391: &HTML::Entities::encode($path,'<>&"')).'<br />';
1.1086 raeburn 13392: }
13393: }
13394: for (my $i=1; $i<=$numitems; $i++) {
13395: next unless ($env{'form.archive_'.$i} eq 'dependency');
13396: my $path = $env{'form.archive_content_'.$i};
13397: if ($path =~ /^\Q$pathtocheck\E/) {
13398: my ($title) = ($path =~ m{/([^/]+)$});
13399: $referrer{$i} = $env{'form.archive_dependent_on_'.$i};
13400: if ($env{'form.archive_'.$referrer{$i}} eq 'display') {
13401: if (ref($dirorder{$i}) eq 'ARRAY') {
13402: my ($itemidx,$fullpath,$relpath);
13403: if (ref($dirorder{$referrer{$i}}) eq 'ARRAY') {
13404: my $container = $dirorder{$referrer{$i}}->[-1];
1.1056 raeburn 13405: for (my $j=0; $j<@{$dirorder{$i}}; $j++) {
1.1086 raeburn 13406: if ($dirorder{$i}->[$j] eq $container) {
13407: $itemidx = $j;
1.1056 raeburn 13408: }
13409: }
1.1086 raeburn 13410: }
13411: if ($itemidx eq '') {
13412: $itemidx = 0;
13413: }
13414: if (grep(/^\Q$referrer{$i}\E$/,@archdirs)) {
13415: if ($mapinner{$referrer{$i}}) {
13416: $fullpath = "$prefix$dir/$docstype/$mapinner{$referrer{$i}}";
13417: for (my $j=$itemidx; $j<@{$dirorder{$i}}; $j++) {
13418: if (grep(/^\Q$dirorder{$i}->[$j]\E$/,@archdirs)) {
13419: unless (defined($newseqid{$dirorder{$i}->[$j]})) {
13420: $fullpath .= '/'.$titles{$dirorder{$i}->[$j]};
13421: $relpath .= '/'.$titles{$dirorder{$i}->[$j]};
13422: if (!-e $fullpath) {
13423: mkdir($fullpath,0755);
1.1056 raeburn 13424: }
13425: }
1.1086 raeburn 13426: } else {
13427: last;
1.1056 raeburn 13428: }
1.1086 raeburn 13429: }
13430: }
13431: } elsif ($newdest{$referrer{$i}}) {
13432: $fullpath = $newdest{$referrer{$i}};
13433: for (my $j=$itemidx; $j<@{$dirorder{$i}}; $j++) {
13434: if ($env{'form.archive_'.$dirorder{$i}->[$j]} eq 'discard') {
13435: $orphaned{$i} = $env{'form.archive_'.$dirorder{$i}->[$j]};
13436: last;
13437: } elsif (grep(/^\Q$dirorder{$i}->[$j]\E$/,@archdirs)) {
13438: unless (defined($newseqid{$dirorder{$i}->[$j]})) {
13439: $fullpath .= '/'.$titles{$dirorder{$i}->[$j]};
13440: $relpath .= '/'.$titles{$dirorder{$i}->[$j]};
13441: if (!-e $fullpath) {
13442: mkdir($fullpath,0755);
1.1056 raeburn 13443: }
13444: }
1.1086 raeburn 13445: } else {
13446: last;
1.1056 raeburn 13447: }
1.1055 raeburn 13448: }
13449: }
1.1086 raeburn 13450: if ($fullpath ne '') {
13451: if (-e "$prefix$path") {
1.1292 raeburn 13452: unless (rename("$prefix$path","$fullpath/$title")) {
13453: $warning .= &mt('Failed to rename dependency').'<br />';
13454: }
1.1086 raeburn 13455: }
13456: if (-e "$fullpath/$title") {
13457: my $showpath;
13458: if ($relpath ne '') {
13459: $showpath = "$relpath/$title";
13460: } else {
13461: $showpath = "/$title";
13462: }
1.1294 raeburn 13463: $result .= '<li>'.&mt('[_1] included as a dependency',
13464: &HTML::Entities::encode($showpath,'<>&"')).
13465: '</li>'."\n";
1.1292 raeburn 13466: unless ($ishome) {
13467: my $fetch = "$fullpath/$title";
13468: $fetch =~ s/^\Q$prefix$dir\E//;
13469: $prompttofetch{$fetch} = 1;
13470: }
1.1086 raeburn 13471: }
13472: }
1.1055 raeburn 13473: }
1.1086 raeburn 13474: } elsif ($env{'form.archive_'.$referrer{$i}} eq 'discard') {
13475: $warning .= &mt('[_1] is a dependency of [_2], which was discarded.',
1.1294 raeburn 13476: &HTML::Entities::encode($path,'<>&"'),
13477: &HTML::Entities::encode($env{'form.archive_content_'.$referrer{$i}},'<>&"')).
13478: '<br />';
1.1055 raeburn 13479: }
13480: } else {
1.1294 raeburn 13481: $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',
1.1296 raeburn 13482: &HTML::Entities::encode($path)).'<br />';
1.1055 raeburn 13483: }
13484: }
13485: if (keys(%todelete)) {
13486: foreach my $key (keys(%todelete)) {
13487: unlink($key);
1.1066 raeburn 13488: }
13489: }
13490: if (keys(%todeletedir)) {
13491: foreach my $key (keys(%todeletedir)) {
13492: rmdir($key);
13493: }
13494: }
13495: foreach my $dir (sort(keys(%is_dir))) {
13496: if (($pathtocheck ne '') && ($dir ne '')) {
13497: &cleanup_empty_dirs($prefix."$pathtocheck/$dir");
1.1055 raeburn 13498: }
13499: }
1.1067 raeburn 13500: if ($result ne '') {
13501: $output .= '<ul>'."\n".
13502: $result."\n".
13503: '</ul>';
13504: }
13505: unless ($ishome) {
13506: my $replicationfail;
13507: foreach my $item (keys(%prompttofetch)) {
13508: my $fetchresult= &Apache::lonnet::reply('fetchuserfile:'.$item,$docuhome);
13509: unless ($fetchresult eq 'ok') {
13510: $replicationfail .= '<li>'.$item.'</li>'."\n";
13511: }
13512: }
13513: if ($replicationfail) {
13514: $output .= '<p class="LC_error">'.
13515: &mt('Course home server failed to retrieve:').'<ul>'.
13516: $replicationfail.
13517: '</ul></p>';
13518: }
13519: }
1.1055 raeburn 13520: } else {
13521: $warning = &mt('No items found in archive.');
13522: }
13523: if ($error) {
13524: $output .= '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
13525: $error.'</p>'."\n";
13526: }
13527: if ($warning) {
13528: $output .= '<p class="LC_warning">'.$warning.'</p>'."\n";
13529: }
13530: return $output;
13531: }
13532:
1.1066 raeburn 13533: sub cleanup_empty_dirs {
13534: my ($path) = @_;
13535: if (($path ne '') && (-d $path)) {
13536: if (opendir(my $dirh,$path)) {
13537: my @dircontents = grep(!/^\./,readdir($dirh));
13538: my $numitems = 0;
13539: foreach my $item (@dircontents) {
13540: if (-d "$path/$item") {
1.1111 raeburn 13541: &cleanup_empty_dirs("$path/$item");
1.1066 raeburn 13542: if (-e "$path/$item") {
13543: $numitems ++;
13544: }
13545: } else {
13546: $numitems ++;
13547: }
13548: }
13549: if ($numitems == 0) {
13550: rmdir($path);
13551: }
13552: closedir($dirh);
13553: }
13554: }
13555: return;
13556: }
13557:
1.41 ng 13558: =pod
1.45 matthew 13559:
1.1162 raeburn 13560: =item * &get_folder_hierarchy()
1.1068 raeburn 13561:
13562: Provides hierarchy of names of folders/sub-folders containing the current
13563: item,
13564:
13565: Inputs: 3
13566: - $navmap - navmaps object
13567:
13568: - $map - url for map (either the trigger itself, or map containing
13569: the resource, which is the trigger).
13570:
13571: - $showitem - 1 => show title for map itself; 0 => do not show.
13572:
13573: Outputs: 1 @pathitems - array of folder/subfolder names.
13574:
13575: =cut
13576:
13577: sub get_folder_hierarchy {
13578: my ($navmap,$map,$showitem) = @_;
13579: my @pathitems;
13580: if (ref($navmap)) {
13581: my $mapres = $navmap->getResourceByUrl($map);
13582: if (ref($mapres)) {
13583: my $pcslist = $mapres->map_hierarchy();
13584: if ($pcslist ne '') {
13585: my @pcs = split(/,/,$pcslist);
13586: foreach my $pc (@pcs) {
13587: if ($pc == 1) {
1.1129 raeburn 13588: push(@pathitems,&mt('Main Content'));
1.1068 raeburn 13589: } else {
13590: my $res = $navmap->getByMapPc($pc);
13591: if (ref($res)) {
13592: my $title = $res->compTitle();
13593: $title =~ s/\W+/_/g;
13594: if ($title ne '') {
13595: push(@pathitems,$title);
13596: }
13597: }
13598: }
13599: }
13600: }
1.1071 raeburn 13601: if ($showitem) {
13602: if ($mapres->{ID} eq '0.0') {
1.1129 raeburn 13603: push(@pathitems,&mt('Main Content'));
1.1071 raeburn 13604: } else {
13605: my $maptitle = $mapres->compTitle();
13606: $maptitle =~ s/\W+/_/g;
13607: if ($maptitle ne '') {
13608: push(@pathitems,$maptitle);
13609: }
1.1068 raeburn 13610: }
13611: }
13612: }
13613: }
13614: return @pathitems;
13615: }
13616:
13617: =pod
13618:
1.1015 raeburn 13619: =item * &get_turnedin_filepath()
13620:
13621: Determines path in a user's portfolio file for storage of files uploaded
13622: to a specific essayresponse or dropbox item.
13623:
13624: Inputs: 3 required + 1 optional.
13625: $symb is symb for resource, $uname and $udom are for current user (required).
13626: $caller is optional (can be "submission", if routine is called when storing
13627: an upoaded file when "Submit Answer" button was pressed).
13628:
13629: Returns array containing $path and $multiresp.
13630: $path is path in portfolio. $multiresp is 1 if this resource contains more
13631: than one file upload item. Callers of routine should append partid as a
13632: subdirectory to $path in cases where $multiresp is 1.
13633:
13634: Called by: homework/essayresponse.pm and homework/structuretags.pm
13635:
13636: =cut
13637:
13638: sub get_turnedin_filepath {
13639: my ($symb,$uname,$udom,$caller) = @_;
13640: my ($map,$resid,$resurl)=&Apache::lonnet::decode_symb($symb);
13641: my $turnindir;
13642: my %userhash = &Apache::lonnet::userenvironment($udom,$uname,'turnindir');
13643: $turnindir = $userhash{'turnindir'};
13644: my ($path,$multiresp);
13645: if ($turnindir eq '') {
13646: if ($caller eq 'submission') {
13647: $turnindir = &mt('turned in');
13648: $turnindir =~ s/\W+/_/g;
13649: my %newhash = (
13650: 'turnindir' => $turnindir,
13651: );
13652: &Apache::lonnet::put('environment',\%newhash,$udom,$uname);
13653: }
13654: }
13655: if ($turnindir ne '') {
13656: $path = '/'.$turnindir.'/';
13657: my ($multipart,$turnin,@pathitems);
13658: my $navmap = Apache::lonnavmaps::navmap->new();
13659: if (defined($navmap)) {
13660: my $mapres = $navmap->getResourceByUrl($map);
13661: if (ref($mapres)) {
13662: my $pcslist = $mapres->map_hierarchy();
13663: if ($pcslist ne '') {
13664: foreach my $pc (split(/,/,$pcslist)) {
13665: my $res = $navmap->getByMapPc($pc);
13666: if (ref($res)) {
13667: my $title = $res->compTitle();
13668: $title =~ s/\W+/_/g;
13669: if ($title ne '') {
1.1149 raeburn 13670: if (($pc > 1) && (length($title) > 12)) {
13671: $title = substr($title,0,12);
13672: }
1.1015 raeburn 13673: push(@pathitems,$title);
13674: }
13675: }
13676: }
13677: }
13678: my $maptitle = $mapres->compTitle();
13679: $maptitle =~ s/\W+/_/g;
13680: if ($maptitle ne '') {
1.1149 raeburn 13681: if (length($maptitle) > 12) {
13682: $maptitle = substr($maptitle,0,12);
13683: }
1.1015 raeburn 13684: push(@pathitems,$maptitle);
13685: }
13686: unless ($env{'request.state'} eq 'construct') {
13687: my $res = $navmap->getBySymb($symb);
13688: if (ref($res)) {
13689: my $partlist = $res->parts();
13690: my $totaluploads = 0;
13691: if (ref($partlist) eq 'ARRAY') {
13692: foreach my $part (@{$partlist}) {
13693: my @types = $res->responseType($part);
13694: my @ids = $res->responseIds($part);
13695: for (my $i=0; $i < scalar(@ids); $i++) {
13696: if ($types[$i] eq 'essay') {
13697: my $partid = $part.'_'.$ids[$i];
13698: if (&Apache::lonnet::EXT("resource.$partid.uploadedfiletypes") ne '') {
13699: $totaluploads ++;
13700: }
13701: }
13702: }
13703: }
13704: if ($totaluploads > 1) {
13705: $multiresp = 1;
13706: }
13707: }
13708: }
13709: }
13710: } else {
13711: return;
13712: }
13713: } else {
13714: return;
13715: }
13716: my $restitle=&Apache::lonnet::gettitle($symb);
13717: $restitle =~ s/\W+/_/g;
13718: if ($restitle eq '') {
13719: $restitle = ($resurl =~ m{/[^/]+$});
13720: if ($restitle eq '') {
13721: $restitle = time;
13722: }
13723: }
1.1149 raeburn 13724: if (length($restitle) > 12) {
13725: $restitle = substr($restitle,0,12);
13726: }
1.1015 raeburn 13727: push(@pathitems,$restitle);
13728: $path .= join('/',@pathitems);
13729: }
13730: return ($path,$multiresp);
13731: }
13732:
13733: =pod
13734:
1.464 albertel 13735: =back
1.41 ng 13736:
1.112 bowersj2 13737: =head1 CSV Upload/Handling functions
1.38 albertel 13738:
1.41 ng 13739: =over 4
13740:
1.648 raeburn 13741: =item * &upfile_store($r)
1.41 ng 13742:
13743: Store uploaded file, $r should be the HTTP Request object,
1.258 albertel 13744: needs $env{'form.upfile'}
1.41 ng 13745: returns $datatoken to be put into hidden field
13746:
13747: =cut
1.31 albertel 13748:
13749: sub upfile_store {
13750: my $r=shift;
1.258 albertel 13751: $env{'form.upfile'}=~s/\r/\n/gs;
13752: $env{'form.upfile'}=~s/\f/\n/gs;
13753: $env{'form.upfile'}=~s/\n+/\n/gs;
13754: $env{'form.upfile'}=~s/\n+$//gs;
1.31 albertel 13755:
1.1299 raeburn 13756: my $datatoken = &valid_datatoken($env{'user.name'}.'_'.$env{'user.domain'}.
13757: '_enroll_'.$env{'request.course.id'}.'_'.
13758: time.'_'.$$);
13759: return if ($datatoken eq '');
13760:
1.31 albertel 13761: {
1.158 raeburn 13762: my $datafile = $r->dir_config('lonDaemons').
13763: '/tmp/'.$datatoken.'.tmp';
13764: if ( open(my $fh,">$datafile") ) {
1.258 albertel 13765: print $fh $env{'form.upfile'};
1.158 raeburn 13766: close($fh);
13767: }
1.31 albertel 13768: }
13769: return $datatoken;
13770: }
13771:
1.56 matthew 13772: =pod
13773:
1.1290 raeburn 13774: =item * &load_tmp_file($r,$datatoken)
1.41 ng 13775:
13776: Load uploaded file from tmp, $r should be the HTTP Request object,
1.1290 raeburn 13777: $datatoken is the name to assign to the temporary file.
1.258 albertel 13778: sets $env{'form.upfile'} to the contents of the file
1.41 ng 13779:
13780: =cut
1.31 albertel 13781:
13782: sub load_tmp_file {
1.1290 raeburn 13783: my ($r,$datatoken) = @_;
13784: return if ($datatoken eq '');
1.31 albertel 13785: my @studentdata=();
13786: {
1.158 raeburn 13787: my $studentfile = $r->dir_config('lonDaemons').
1.1290 raeburn 13788: '/tmp/'.$datatoken.'.tmp';
1.158 raeburn 13789: if ( open(my $fh,"<$studentfile") ) {
13790: @studentdata=<$fh>;
13791: close($fh);
13792: }
1.31 albertel 13793: }
1.258 albertel 13794: $env{'form.upfile'}=join('',@studentdata);
1.31 albertel 13795: }
13796:
1.1290 raeburn 13797: sub valid_datatoken {
13798: my ($datatoken) = @_;
1.1291 raeburn 13799: if ($datatoken =~ /^$match_username\_$match_domain\_enroll_$match_domain\_$match_courseid\_\d+_\d+$/) {
1.1290 raeburn 13800: return $datatoken;
13801: }
13802: return;
13803: }
13804:
1.56 matthew 13805: =pod
13806:
1.648 raeburn 13807: =item * &upfile_record_sep()
1.41 ng 13808:
13809: Separate uploaded file into records
13810: returns array of records,
1.258 albertel 13811: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41 ng 13812:
13813: =cut
1.31 albertel 13814:
13815: sub upfile_record_sep {
1.258 albertel 13816: if ($env{'form.upfiletype'} eq 'xml') {
1.31 albertel 13817: } else {
1.248 albertel 13818: my @records;
1.258 albertel 13819: foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248 albertel 13820: if ($line=~/^\s*$/) { next; }
13821: push(@records,$line);
13822: }
13823: return @records;
1.31 albertel 13824: }
13825: }
13826:
1.56 matthew 13827: =pod
13828:
1.648 raeburn 13829: =item * &record_sep($record)
1.41 ng 13830:
1.258 albertel 13831: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41 ng 13832:
13833: =cut
13834:
1.263 www 13835: sub takeleft {
13836: my $index=shift;
13837: return substr('0000'.$index,-4,4);
13838: }
13839:
1.31 albertel 13840: sub record_sep {
13841: my $record=shift;
13842: my %components=();
1.258 albertel 13843: if ($env{'form.upfiletype'} eq 'xml') {
13844: } elsif ($env{'form.upfiletype'} eq 'space') {
1.31 albertel 13845: my $i=0;
1.356 albertel 13846: foreach my $field (split(/\s+/,$record)) {
1.31 albertel 13847: $field=~s/^(\"|\')//;
13848: $field=~s/(\"|\')$//;
1.263 www 13849: $components{&takeleft($i)}=$field;
1.31 albertel 13850: $i++;
13851: }
1.258 albertel 13852: } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31 albertel 13853: my $i=0;
1.356 albertel 13854: foreach my $field (split(/\t/,$record)) {
1.31 albertel 13855: $field=~s/^(\"|\')//;
13856: $field=~s/(\"|\')$//;
1.263 www 13857: $components{&takeleft($i)}=$field;
1.31 albertel 13858: $i++;
13859: }
13860: } else {
1.561 www 13861: my $separator=',';
1.480 banghart 13862: if ($env{'form.upfiletype'} eq 'semisv') {
1.561 www 13863: $separator=';';
1.480 banghart 13864: }
1.31 albertel 13865: my $i=0;
1.561 www 13866: # the character we are looking for to indicate the end of a quote or a record
13867: my $looking_for=$separator;
13868: # do not add the characters to the fields
13869: my $ignore=0;
13870: # we just encountered a separator (or the beginning of the record)
13871: my $just_found_separator=1;
13872: # store the field we are working on here
13873: my $field='';
13874: # work our way through all characters in record
13875: foreach my $character ($record=~/(.)/g) {
13876: if ($character eq $looking_for) {
13877: if ($character ne $separator) {
13878: # Found the end of a quote, again looking for separator
13879: $looking_for=$separator;
13880: $ignore=1;
13881: } else {
13882: # Found a separator, store away what we got
13883: $components{&takeleft($i)}=$field;
13884: $i++;
13885: $just_found_separator=1;
13886: $ignore=0;
13887: $field='';
13888: }
13889: next;
13890: }
13891: # single or double quotation marks after a separator indicate beginning of a quote
13892: # we are now looking for the end of the quote and need to ignore separators
13893: if ((($character eq '"') || ($character eq "'")) && ($just_found_separator)) {
13894: $looking_for=$character;
13895: next;
13896: }
13897: # ignore would be true after we reached the end of a quote
13898: if ($ignore) { next; }
13899: if (($just_found_separator) && ($character=~/\s/)) { next; }
13900: $field.=$character;
13901: $just_found_separator=0;
1.31 albertel 13902: }
1.561 www 13903: # catch the very last entry, since we never encountered the separator
13904: $components{&takeleft($i)}=$field;
1.31 albertel 13905: }
13906: return %components;
13907: }
13908:
1.144 matthew 13909: ######################################################
13910: ######################################################
13911:
1.56 matthew 13912: =pod
13913:
1.648 raeburn 13914: =item * &upfile_select_html()
1.41 ng 13915:
1.144 matthew 13916: Return HTML code to select a file from the users machine and specify
13917: the file type.
1.41 ng 13918:
13919: =cut
13920:
1.144 matthew 13921: ######################################################
13922: ######################################################
1.31 albertel 13923: sub upfile_select_html {
1.144 matthew 13924: my %Types = (
13925: csv => &mt('CSV (comma separated values, spreadsheet)'),
1.480 banghart 13926: semisv => &mt('Semicolon separated values'),
1.144 matthew 13927: space => &mt('Space separated'),
13928: tab => &mt('Tabulator separated'),
13929: # xml => &mt('HTML/XML'),
13930: );
13931: my $Str = '<input type="file" name="upfile" size="50" />'.
1.727 riegler 13932: '<br />'.&mt('Type').': <select name="upfiletype">';
1.144 matthew 13933: foreach my $type (sort(keys(%Types))) {
13934: $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
13935: }
13936: $Str .= "</select>\n";
13937: return $Str;
1.31 albertel 13938: }
13939:
1.301 albertel 13940: sub get_samples {
13941: my ($records,$toget) = @_;
13942: my @samples=({});
13943: my $got=0;
13944: foreach my $rec (@$records) {
13945: my %temp = &record_sep($rec);
13946: if (! grep(/\S/, values(%temp))) { next; }
13947: if (%temp) {
13948: $samples[$got]=\%temp;
13949: $got++;
13950: if ($got == $toget) { last; }
13951: }
13952: }
13953: return \@samples;
13954: }
13955:
1.144 matthew 13956: ######################################################
13957: ######################################################
13958:
1.56 matthew 13959: =pod
13960:
1.648 raeburn 13961: =item * &csv_print_samples($r,$records)
1.41 ng 13962:
13963: Prints a table of sample values from each column uploaded $r is an
13964: Apache Request ref, $records is an arrayref from
13965: &Apache::loncommon::upfile_record_sep
13966:
13967: =cut
13968:
1.144 matthew 13969: ######################################################
13970: ######################################################
1.31 albertel 13971: sub csv_print_samples {
13972: my ($r,$records) = @_;
1.662 bisitz 13973: my $samples = &get_samples($records,5);
1.301 albertel 13974:
1.594 raeburn 13975: $r->print(&mt('Samples').'<br />'.&start_data_table().
13976: &start_data_table_header_row());
1.356 albertel 13977: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.845 bisitz 13978: $r->print('<th>'.&mt('Column [_1]',($sample+1)).'</th>'); }
1.594 raeburn 13979: $r->print(&end_data_table_header_row());
1.301 albertel 13980: foreach my $hash (@$samples) {
1.594 raeburn 13981: $r->print(&start_data_table_row());
1.356 albertel 13982: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.31 albertel 13983: $r->print('<td>');
1.356 albertel 13984: if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
1.31 albertel 13985: $r->print('</td>');
13986: }
1.594 raeburn 13987: $r->print(&end_data_table_row());
1.31 albertel 13988: }
1.594 raeburn 13989: $r->print(&end_data_table().'<br />'."\n");
1.31 albertel 13990: }
13991:
1.144 matthew 13992: ######################################################
13993: ######################################################
13994:
1.56 matthew 13995: =pod
13996:
1.648 raeburn 13997: =item * &csv_print_select_table($r,$records,$d)
1.41 ng 13998:
13999: Prints a table to create associations between values and table columns.
1.144 matthew 14000:
1.41 ng 14001: $r is an Apache Request ref,
14002: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174 matthew 14003: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41 ng 14004:
14005: =cut
14006:
1.144 matthew 14007: ######################################################
14008: ######################################################
1.31 albertel 14009: sub csv_print_select_table {
14010: my ($r,$records,$d) = @_;
1.301 albertel 14011: my $i=0;
14012: my $samples = &get_samples($records,1);
1.144 matthew 14013: $r->print(&mt('Associate columns with student attributes.')."\n".
1.594 raeburn 14014: &start_data_table().&start_data_table_header_row().
1.144 matthew 14015: '<th>'.&mt('Attribute').'</th>'.
1.594 raeburn 14016: '<th>'.&mt('Column').'</th>'.
14017: &end_data_table_header_row()."\n");
1.356 albertel 14018: foreach my $array_ref (@$d) {
14019: my ($value,$display,$defaultcol)=@{ $array_ref };
1.729 raeburn 14020: $r->print(&start_data_table_row().'<td>'.$display.'</td>');
1.31 albertel 14021:
1.875 bisitz 14022: $r->print('<td><select name="f'.$i.'"'.
1.32 matthew 14023: ' onchange="javascript:flip(this.form,'.$i.');">');
1.31 albertel 14024: $r->print('<option value="none"></option>');
1.356 albertel 14025: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
14026: $r->print('<option value="'.$sample.'"'.
14027: ($sample eq $defaultcol ? ' selected="selected" ' : '').
1.662 bisitz 14028: '>'.&mt('Column [_1]',($sample+1)).'</option>');
1.31 albertel 14029: }
1.594 raeburn 14030: $r->print('</select></td>'.&end_data_table_row()."\n");
1.31 albertel 14031: $i++;
14032: }
1.594 raeburn 14033: $r->print(&end_data_table());
1.31 albertel 14034: $i--;
14035: return $i;
14036: }
1.56 matthew 14037:
1.144 matthew 14038: ######################################################
14039: ######################################################
14040:
1.56 matthew 14041: =pod
1.31 albertel 14042:
1.648 raeburn 14043: =item * &csv_samples_select_table($r,$records,$d)
1.41 ng 14044:
14045: Prints a table of sample values from the upload and can make associate samples to internal names.
14046:
14047: $r is an Apache Request ref,
14048: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
14049: $d is an array of 2 element arrays (internal name, displayed name)
14050:
14051: =cut
14052:
1.144 matthew 14053: ######################################################
14054: ######################################################
1.31 albertel 14055: sub csv_samples_select_table {
14056: my ($r,$records,$d) = @_;
14057: my $i=0;
1.144 matthew 14058: #
1.662 bisitz 14059: my $max_samples = 5;
14060: my $samples = &get_samples($records,$max_samples);
1.594 raeburn 14061: $r->print(&start_data_table().
14062: &start_data_table_header_row().'<th>'.
14063: &mt('Field').'</th><th>'.&mt('Samples').'</th>'.
14064: &end_data_table_header_row());
1.301 albertel 14065:
14066: foreach my $key (sort(keys(%{ $samples->[0] }))) {
1.594 raeburn 14067: $r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
1.32 matthew 14068: ' onchange="javascript:flip(this.form,'.$i.');">');
1.301 albertel 14069: foreach my $option (@$d) {
14070: my ($value,$display,$defaultcol)=@{ $option };
1.174 matthew 14071: $r->print('<option value="'.$value.'"'.
1.253 albertel 14072: ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174 matthew 14073: $display.'</option>');
1.31 albertel 14074: }
14075: $r->print('</select></td><td>');
1.662 bisitz 14076: foreach my $line (0..($max_samples-1)) {
1.301 albertel 14077: if (defined($samples->[$line]{$key})) {
14078: $r->print($samples->[$line]{$key}."<br />\n");
14079: }
14080: }
1.594 raeburn 14081: $r->print('</td>'.&end_data_table_row());
1.31 albertel 14082: $i++;
14083: }
1.594 raeburn 14084: $r->print(&end_data_table());
1.31 albertel 14085: $i--;
14086: return($i);
1.115 matthew 14087: }
14088:
1.144 matthew 14089: ######################################################
14090: ######################################################
14091:
1.115 matthew 14092: =pod
14093:
1.648 raeburn 14094: =item * &clean_excel_name($name)
1.115 matthew 14095:
14096: Returns a replacement for $name which does not contain any illegal characters.
14097:
14098: =cut
14099:
1.144 matthew 14100: ######################################################
14101: ######################################################
1.115 matthew 14102: sub clean_excel_name {
14103: my ($name) = @_;
14104: $name =~ s/[:\*\?\/\\]//g;
14105: if (length($name) > 31) {
14106: $name = substr($name,0,31);
14107: }
14108: return $name;
1.25 albertel 14109: }
1.84 albertel 14110:
1.85 albertel 14111: =pod
14112:
1.648 raeburn 14113: =item * &check_if_partid_hidden($id,$symb,$udom,$uname)
1.85 albertel 14114:
14115: Returns either 1 or undef
14116:
14117: 1 if the part is to be hidden, undef if it is to be shown
14118:
14119: Arguments are:
14120:
14121: $id the id of the part to be checked
14122: $symb, optional the symb of the resource to check
14123: $udom, optional the domain of the user to check for
14124: $uname, optional the username of the user to check for
14125:
14126: =cut
1.84 albertel 14127:
14128: sub check_if_partid_hidden {
14129: my ($id,$symb,$udom,$uname) = @_;
1.133 albertel 14130: my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84 albertel 14131: $symb,$udom,$uname);
1.141 albertel 14132: my $truth=1;
14133: #if the string starts with !, then the list is the list to show not hide
14134: if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84 albertel 14135: my @hiddenlist=split(/,/,$hiddenparts);
14136: foreach my $checkid (@hiddenlist) {
1.141 albertel 14137: if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84 albertel 14138: }
1.141 albertel 14139: return !$truth;
1.84 albertel 14140: }
1.127 matthew 14141:
1.138 matthew 14142:
14143: ############################################################
14144: ############################################################
14145:
14146: =pod
14147:
1.157 matthew 14148: =back
14149:
1.138 matthew 14150: =head1 cgi-bin script and graphing routines
14151:
1.157 matthew 14152: =over 4
14153:
1.648 raeburn 14154: =item * &get_cgi_id()
1.138 matthew 14155:
14156: Inputs: none
14157:
14158: Returns an id which can be used to pass environment variables
14159: to various cgi-bin scripts. These environment variables will
14160: be removed from the users environment after a given time by
14161: the routine &Apache::lonnet::transfer_profile_to_env.
14162:
14163: =cut
14164:
14165: ############################################################
14166: ############################################################
1.152 albertel 14167: my $uniq=0;
1.136 matthew 14168: sub get_cgi_id {
1.154 albertel 14169: $uniq=($uniq+1)%100000;
1.280 albertel 14170: return (time.'_'.$$.'_'.$uniq);
1.136 matthew 14171: }
14172:
1.127 matthew 14173: ############################################################
14174: ############################################################
14175:
14176: =pod
14177:
1.648 raeburn 14178: =item * &DrawBarGraph()
1.127 matthew 14179:
1.138 matthew 14180: Facilitates the plotting of data in a (stacked) bar graph.
14181: Puts plot definition data into the users environment in order for
14182: graph.png to plot it. Returns an <img> tag for the plot.
14183: The bars on the plot are labeled '1','2',...,'n'.
14184:
14185: Inputs:
14186:
14187: =over 4
14188:
14189: =item $Title: string, the title of the plot
14190:
14191: =item $xlabel: string, text describing the X-axis of the plot
14192:
14193: =item $ylabel: string, text describing the Y-axis of the plot
14194:
14195: =item $Max: scalar, the maximum Y value to use in the plot
14196: If $Max is < any data point, the graph will not be rendered.
14197:
1.140 matthew 14198: =item $colors: array ref holding the colors to be used for the data sets when
1.138 matthew 14199: they are plotted. If undefined, default values will be used.
14200:
1.178 matthew 14201: =item $labels: array ref holding the labels to use on the x-axis for the bars.
14202:
1.138 matthew 14203: =item @Values: An array of array references. Each array reference holds data
14204: to be plotted in a stacked bar chart.
14205:
1.239 matthew 14206: =item If the final element of @Values is a hash reference the key/value
14207: pairs will be added to the graph definition.
14208:
1.138 matthew 14209: =back
14210:
14211: Returns:
14212:
14213: An <img> tag which references graph.png and the appropriate identifying
14214: information for the plot.
14215:
1.127 matthew 14216: =cut
14217:
14218: ############################################################
14219: ############################################################
1.134 matthew 14220: sub DrawBarGraph {
1.178 matthew 14221: my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134 matthew 14222: #
14223: if (! defined($colors)) {
14224: $colors = ['#33ff00',
14225: '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
14226: '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
14227: ];
14228: }
1.228 matthew 14229: my $extra_settings = {};
14230: if (ref($Values[-1]) eq 'HASH') {
14231: $extra_settings = pop(@Values);
14232: }
1.127 matthew 14233: #
1.136 matthew 14234: my $identifier = &get_cgi_id();
14235: my $id = 'cgi.'.$identifier;
1.129 matthew 14236: if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127 matthew 14237: return '';
14238: }
1.225 matthew 14239: #
14240: my @Labels;
14241: if (defined($labels)) {
14242: @Labels = @$labels;
14243: } else {
14244: for (my $i=0;$i<@{$Values[0]};$i++) {
1.1263 raeburn 14245: push(@Labels,$i+1);
1.225 matthew 14246: }
14247: }
14248: #
1.129 matthew 14249: my $NumBars = scalar(@{$Values[0]});
1.225 matthew 14250: if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129 matthew 14251: my %ValuesHash;
14252: my $NumSets=1;
14253: foreach my $array (@Values) {
14254: next if (! ref($array));
1.136 matthew 14255: $ValuesHash{$id.'.data.'.$NumSets++} =
1.132 matthew 14256: join(',',@$array);
1.129 matthew 14257: }
1.127 matthew 14258: #
1.136 matthew 14259: my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225 matthew 14260: if ($NumBars < 3) {
14261: $width = 120+$NumBars*32;
1.220 matthew 14262: $xskip = 1;
1.225 matthew 14263: $bar_width = 30;
14264: } elsif ($NumBars < 5) {
14265: $width = 120+$NumBars*20;
14266: $xskip = 1;
14267: $bar_width = 20;
1.220 matthew 14268: } elsif ($NumBars < 10) {
1.136 matthew 14269: $width = 120+$NumBars*15;
14270: $xskip = 1;
14271: $bar_width = 15;
14272: } elsif ($NumBars <= 25) {
14273: $width = 120+$NumBars*11;
14274: $xskip = 5;
14275: $bar_width = 8;
14276: } elsif ($NumBars <= 50) {
14277: $width = 120+$NumBars*8;
14278: $xskip = 5;
14279: $bar_width = 4;
14280: } else {
14281: $width = 120+$NumBars*8;
14282: $xskip = 5;
14283: $bar_width = 4;
14284: }
14285: #
1.137 matthew 14286: $Max = 1 if ($Max < 1);
14287: if ( int($Max) < $Max ) {
14288: $Max++;
14289: $Max = int($Max);
14290: }
1.127 matthew 14291: $Title = '' if (! defined($Title));
14292: $xlabel = '' if (! defined($xlabel));
14293: $ylabel = '' if (! defined($ylabel));
1.369 www 14294: $ValuesHash{$id.'.title'} = &escape($Title);
14295: $ValuesHash{$id.'.xlabel'} = &escape($xlabel);
14296: $ValuesHash{$id.'.ylabel'} = &escape($ylabel);
1.137 matthew 14297: $ValuesHash{$id.'.y_max_value'} = $Max;
1.136 matthew 14298: $ValuesHash{$id.'.NumBars'} = $NumBars;
14299: $ValuesHash{$id.'.NumSets'} = $NumSets;
14300: $ValuesHash{$id.'.PlotType'} = 'bar';
14301: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
14302: $ValuesHash{$id.'.height'} = $height;
14303: $ValuesHash{$id.'.width'} = $width;
14304: $ValuesHash{$id.'.xskip'} = $xskip;
14305: $ValuesHash{$id.'.bar_width'} = $bar_width;
14306: $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127 matthew 14307: #
1.228 matthew 14308: # Deal with other parameters
14309: while (my ($key,$value) = each(%$extra_settings)) {
14310: $ValuesHash{$id.'.'.$key} = $value;
14311: }
14312: #
1.646 raeburn 14313: &Apache::lonnet::appenv(\%ValuesHash);
1.137 matthew 14314: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
14315: }
14316:
14317: ############################################################
14318: ############################################################
14319:
14320: =pod
14321:
1.648 raeburn 14322: =item * &DrawXYGraph()
1.137 matthew 14323:
1.138 matthew 14324: Facilitates the plotting of data in an XY graph.
14325: Puts plot definition data into the users environment in order for
14326: graph.png to plot it. Returns an <img> tag for the plot.
14327:
14328: Inputs:
14329:
14330: =over 4
14331:
14332: =item $Title: string, the title of the plot
14333:
14334: =item $xlabel: string, text describing the X-axis of the plot
14335:
14336: =item $ylabel: string, text describing the Y-axis of the plot
14337:
14338: =item $Max: scalar, the maximum Y value to use in the plot
14339: If $Max is < any data point, the graph will not be rendered.
14340:
14341: =item $colors: Array ref containing the hex color codes for the data to be
14342: plotted in. If undefined, default values will be used.
14343:
14344: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
14345:
14346: =item $Ydata: Array ref containing Array refs.
1.185 www 14347: Each of the contained arrays will be plotted as a separate curve.
1.138 matthew 14348:
14349: =item %Values: hash indicating or overriding any default values which are
14350: passed to graph.png.
14351: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
14352:
14353: =back
14354:
14355: Returns:
14356:
14357: An <img> tag which references graph.png and the appropriate identifying
14358: information for the plot.
14359:
1.137 matthew 14360: =cut
14361:
14362: ############################################################
14363: ############################################################
14364: sub DrawXYGraph {
14365: my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
14366: #
14367: # Create the identifier for the graph
14368: my $identifier = &get_cgi_id();
14369: my $id = 'cgi.'.$identifier;
14370: #
14371: $Title = '' if (! defined($Title));
14372: $xlabel = '' if (! defined($xlabel));
14373: $ylabel = '' if (! defined($ylabel));
14374: my %ValuesHash =
14375: (
1.369 www 14376: $id.'.title' => &escape($Title),
14377: $id.'.xlabel' => &escape($xlabel),
14378: $id.'.ylabel' => &escape($ylabel),
1.137 matthew 14379: $id.'.y_max_value'=> $Max,
14380: $id.'.labels' => join(',',@$Xlabels),
14381: $id.'.PlotType' => 'XY',
14382: );
14383: #
14384: if (defined($colors) && ref($colors) eq 'ARRAY') {
14385: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
14386: }
14387: #
14388: if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
14389: return '';
14390: }
14391: my $NumSets=1;
1.138 matthew 14392: foreach my $array (@{$Ydata}){
1.137 matthew 14393: next if (! ref($array));
14394: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
14395: }
1.138 matthew 14396: $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137 matthew 14397: #
14398: # Deal with other parameters
14399: while (my ($key,$value) = each(%Values)) {
14400: $ValuesHash{$id.'.'.$key} = $value;
1.127 matthew 14401: }
14402: #
1.646 raeburn 14403: &Apache::lonnet::appenv(\%ValuesHash);
1.136 matthew 14404: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
14405: }
14406:
14407: ############################################################
14408: ############################################################
14409:
14410: =pod
14411:
1.648 raeburn 14412: =item * &DrawXYYGraph()
1.138 matthew 14413:
14414: Facilitates the plotting of data in an XY graph with two Y axes.
14415: Puts plot definition data into the users environment in order for
14416: graph.png to plot it. Returns an <img> tag for the plot.
14417:
14418: Inputs:
14419:
14420: =over 4
14421:
14422: =item $Title: string, the title of the plot
14423:
14424: =item $xlabel: string, text describing the X-axis of the plot
14425:
14426: =item $ylabel: string, text describing the Y-axis of the plot
14427:
14428: =item $colors: Array ref containing the hex color codes for the data to be
14429: plotted in. If undefined, default values will be used.
14430:
14431: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
14432:
14433: =item $Ydata1: The first data set
14434:
14435: =item $Min1: The minimum value of the left Y-axis
14436:
14437: =item $Max1: The maximum value of the left Y-axis
14438:
14439: =item $Ydata2: The second data set
14440:
14441: =item $Min2: The minimum value of the right Y-axis
14442:
14443: =item $Max2: The maximum value of the left Y-axis
14444:
14445: =item %Values: hash indicating or overriding any default values which are
14446: passed to graph.png.
14447: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
14448:
14449: =back
14450:
14451: Returns:
14452:
14453: An <img> tag which references graph.png and the appropriate identifying
14454: information for the plot.
1.136 matthew 14455:
14456: =cut
14457:
14458: ############################################################
14459: ############################################################
1.137 matthew 14460: sub DrawXYYGraph {
14461: my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
14462: $Ydata2,$Min2,$Max2,%Values)=@_;
1.136 matthew 14463: #
14464: # Create the identifier for the graph
14465: my $identifier = &get_cgi_id();
14466: my $id = 'cgi.'.$identifier;
14467: #
14468: $Title = '' if (! defined($Title));
14469: $xlabel = '' if (! defined($xlabel));
14470: $ylabel = '' if (! defined($ylabel));
14471: my %ValuesHash =
14472: (
1.369 www 14473: $id.'.title' => &escape($Title),
14474: $id.'.xlabel' => &escape($xlabel),
14475: $id.'.ylabel' => &escape($ylabel),
1.136 matthew 14476: $id.'.labels' => join(',',@$Xlabels),
14477: $id.'.PlotType' => 'XY',
14478: $id.'.NumSets' => 2,
1.137 matthew 14479: $id.'.two_axes' => 1,
14480: $id.'.y1_max_value' => $Max1,
14481: $id.'.y1_min_value' => $Min1,
14482: $id.'.y2_max_value' => $Max2,
14483: $id.'.y2_min_value' => $Min2,
1.136 matthew 14484: );
14485: #
1.137 matthew 14486: if (defined($colors) && ref($colors) eq 'ARRAY') {
14487: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
14488: }
14489: #
14490: if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
14491: ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136 matthew 14492: return '';
14493: }
14494: my $NumSets=1;
1.137 matthew 14495: foreach my $array ($Ydata1,$Ydata2){
1.136 matthew 14496: next if (! ref($array));
14497: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137 matthew 14498: }
14499: #
14500: # Deal with other parameters
14501: while (my ($key,$value) = each(%Values)) {
14502: $ValuesHash{$id.'.'.$key} = $value;
1.136 matthew 14503: }
14504: #
1.646 raeburn 14505: &Apache::lonnet::appenv(\%ValuesHash);
1.130 albertel 14506: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139 matthew 14507: }
14508:
14509: ############################################################
14510: ############################################################
14511:
14512: =pod
14513:
1.157 matthew 14514: =back
14515:
1.139 matthew 14516: =head1 Statistics helper routines?
14517:
14518: Bad place for them but what the hell.
14519:
1.157 matthew 14520: =over 4
14521:
1.648 raeburn 14522: =item * &chartlink()
1.139 matthew 14523:
14524: Returns a link to the chart for a specific student.
14525:
14526: Inputs:
14527:
14528: =over 4
14529:
14530: =item $linktext: The text of the link
14531:
14532: =item $sname: The students username
14533:
14534: =item $sdomain: The students domain
14535:
14536: =back
14537:
1.157 matthew 14538: =back
14539:
1.139 matthew 14540: =cut
14541:
14542: ############################################################
14543: ############################################################
14544: sub chartlink {
14545: my ($linktext, $sname, $sdomain) = @_;
14546: my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.369 www 14547: '&SelectedStudent='.&escape($sname.':'.$sdomain).
1.219 albertel 14548: '&chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139 matthew 14549: '">'.$linktext.'</a>';
1.153 matthew 14550: }
14551:
14552: #######################################################
14553: #######################################################
14554:
14555: =pod
14556:
14557: =head1 Course Environment Routines
1.157 matthew 14558:
14559: =over 4
1.153 matthew 14560:
1.648 raeburn 14561: =item * &restore_course_settings()
1.153 matthew 14562:
1.648 raeburn 14563: =item * &store_course_settings()
1.153 matthew 14564:
14565: Restores/Store indicated form parameters from the course environment.
14566: Will not overwrite existing values of the form parameters.
14567:
14568: Inputs:
14569: a scalar describing the data (e.g. 'chart', 'problem_analysis')
14570:
14571: a hash ref describing the data to be stored. For example:
14572:
14573: %Save_Parameters = ('Status' => 'scalar',
14574: 'chartoutputmode' => 'scalar',
14575: 'chartoutputdata' => 'scalar',
14576: 'Section' => 'array',
1.373 raeburn 14577: 'Group' => 'array',
1.153 matthew 14578: 'StudentData' => 'array',
14579: 'Maps' => 'array');
14580:
14581: Returns: both routines return nothing
14582:
1.631 raeburn 14583: =back
14584:
1.153 matthew 14585: =cut
14586:
14587: #######################################################
14588: #######################################################
14589: sub store_course_settings {
1.496 albertel 14590: return &store_settings($env{'request.course.id'},@_);
14591: }
14592:
14593: sub store_settings {
1.153 matthew 14594: # save to the environment
14595: # appenv the same items, just to be safe
1.300 albertel 14596: my $udom = $env{'user.domain'};
14597: my $uname = $env{'user.name'};
1.496 albertel 14598: my ($context,$prefix,$Settings) = @_;
1.153 matthew 14599: my %SaveHash;
14600: my %AppHash;
14601: while (my ($setting,$type) = each(%$Settings)) {
1.496 albertel 14602: my $basename = join('.','internal',$context,$prefix,$setting);
1.300 albertel 14603: my $envname = 'environment.'.$basename;
1.258 albertel 14604: if (exists($env{'form.'.$setting})) {
1.153 matthew 14605: # Save this value away
14606: if ($type eq 'scalar' &&
1.258 albertel 14607: (! exists($env{$envname}) ||
14608: $env{$envname} ne $env{'form.'.$setting})) {
14609: $SaveHash{$basename} = $env{'form.'.$setting};
14610: $AppHash{$envname} = $env{'form.'.$setting};
1.153 matthew 14611: } elsif ($type eq 'array') {
14612: my $stored_form;
1.258 albertel 14613: if (ref($env{'form.'.$setting})) {
1.153 matthew 14614: $stored_form = join(',',
14615: map {
1.369 www 14616: &escape($_);
1.258 albertel 14617: } sort(@{$env{'form.'.$setting}}));
1.153 matthew 14618: } else {
14619: $stored_form =
1.369 www 14620: &escape($env{'form.'.$setting});
1.153 matthew 14621: }
14622: # Determine if the array contents are the same.
1.258 albertel 14623: if ($stored_form ne $env{$envname}) {
1.153 matthew 14624: $SaveHash{$basename} = $stored_form;
14625: $AppHash{$envname} = $stored_form;
14626: }
14627: }
14628: }
14629: }
14630: my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
1.300 albertel 14631: $udom,$uname);
1.153 matthew 14632: if ($put_result !~ /^(ok|delayed)/) {
14633: &Apache::lonnet::logthis('unable to save form parameters, '.
14634: 'got error:'.$put_result);
14635: }
14636: # Make sure these settings stick around in this session, too
1.646 raeburn 14637: &Apache::lonnet::appenv(\%AppHash);
1.153 matthew 14638: return;
14639: }
14640:
14641: sub restore_course_settings {
1.499 albertel 14642: return &restore_settings($env{'request.course.id'},@_);
1.496 albertel 14643: }
14644:
14645: sub restore_settings {
14646: my ($context,$prefix,$Settings) = @_;
1.153 matthew 14647: while (my ($setting,$type) = each(%$Settings)) {
1.258 albertel 14648: next if (exists($env{'form.'.$setting}));
1.496 albertel 14649: my $envname = 'environment.internal.'.$context.'.'.$prefix.
1.153 matthew 14650: '.'.$setting;
1.258 albertel 14651: if (exists($env{$envname})) {
1.153 matthew 14652: if ($type eq 'scalar') {
1.258 albertel 14653: $env{'form.'.$setting} = $env{$envname};
1.153 matthew 14654: } elsif ($type eq 'array') {
1.258 albertel 14655: $env{'form.'.$setting} = [
1.153 matthew 14656: map {
1.369 www 14657: &unescape($_);
1.258 albertel 14658: } split(',',$env{$envname})
1.153 matthew 14659: ];
14660: }
14661: }
14662: }
1.127 matthew 14663: }
14664:
1.618 raeburn 14665: #######################################################
14666: #######################################################
14667:
14668: =pod
14669:
14670: =head1 Domain E-mail Routines
14671:
14672: =over 4
14673:
1.648 raeburn 14674: =item * &build_recipient_list()
1.618 raeburn 14675:
1.1144 raeburn 14676: Build recipient lists for following types of e-mail:
1.766 raeburn 14677: (a) Error Reports, (b) Package Updates, (c) lonstatus warnings/errors
1.1144 raeburn 14678: (d) Help requests, (e) Course requests needing approval, (f) loncapa
14679: module change checking, student/employee ID conflict checks, as
14680: generated by lonerrorhandler.pm, CHECKRPMS, loncron,
14681: lonsupportreq.pm, loncoursequeueadmin.pm, searchcat.pl respectively.
1.618 raeburn 14682:
14683: Inputs:
1.619 raeburn 14684: defmail (scalar - email address of default recipient),
1.1144 raeburn 14685: mailing type (scalar: errormail, packagesmail, helpdeskmail,
14686: requestsmail, updatesmail, or idconflictsmail).
14687:
1.619 raeburn 14688: defdom (domain for which to retrieve configuration settings),
1.1144 raeburn 14689:
1.619 raeburn 14690: origmail (scalar - email address of recipient from loncapa.conf,
1.1297 raeburn 14691: i.e., predates configuration by DC via domainprefs.pm
14692:
14693: $requname username of requester (if mailing type is helpdeskmail)
14694:
14695: $requdom domain of requester (if mailing type is helpdeskmail)
14696:
14697: $reqemail e-mail address of requester (if mailing type is helpdeskmail)
14698:
1.618 raeburn 14699:
1.655 raeburn 14700: Returns: comma separated list of addresses to which to send e-mail.
14701:
14702: =back
1.618 raeburn 14703:
14704: =cut
14705:
14706: ############################################################
14707: ############################################################
14708: sub build_recipient_list {
1.1297 raeburn 14709: my ($defmail,$mailing,$defdom,$origmail,$requname,$requdom,$reqemail) = @_;
1.618 raeburn 14710: my @recipients;
1.1270 raeburn 14711: my ($otheremails,$lastresort,$allbcc,$addtext);
1.618 raeburn 14712: my %domconfig =
1.1270 raeburn 14713: &Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
1.618 raeburn 14714: if (ref($domconfig{'contacts'}) eq 'HASH') {
1.766 raeburn 14715: if (exists($domconfig{'contacts'}{$mailing})) {
14716: if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
14717: my @contacts = ('adminemail','supportemail');
14718: foreach my $item (@contacts) {
14719: if ($domconfig{'contacts'}{$mailing}{$item}) {
14720: my $addr = $domconfig{'contacts'}{$item};
14721: if (!grep(/^\Q$addr\E$/,@recipients)) {
14722: push(@recipients,$addr);
14723: }
1.619 raeburn 14724: }
1.1270 raeburn 14725: }
14726: $otheremails = $domconfig{'contacts'}{$mailing}{'others'};
14727: if ($mailing eq 'helpdeskmail') {
14728: if ($domconfig{'contacts'}{$mailing}{'bcc'}) {
14729: my @bccs = split(/,/,$domconfig{'contacts'}{$mailing}{'bcc'});
14730: my @ok_bccs;
14731: foreach my $bcc (@bccs) {
14732: $bcc =~ s/^\s+//g;
14733: $bcc =~ s/\s+$//g;
14734: if ($bcc =~ m/^[^\@]+\@[^\@]+$/) {
14735: if (!(grep(/^\Q$bcc\E$/,@ok_bccs))) {
14736: push(@ok_bccs,$bcc);
14737: }
14738: }
14739: }
14740: if (@ok_bccs > 0) {
14741: $allbcc = join(', ',@ok_bccs);
14742: }
14743: }
14744: $addtext = $domconfig{'contacts'}{$mailing}{'include'};
1.618 raeburn 14745: }
14746: }
1.766 raeburn 14747: } elsif ($origmail ne '') {
1.1270 raeburn 14748: $lastresort = $origmail;
1.618 raeburn 14749: }
1.1297 raeburn 14750: if ($mailing eq 'helpdeskmail') {
14751: if ((ref($domconfig{'contacts'}{'overrides'}) eq 'HASH') &&
14752: (keys(%{$domconfig{'contacts'}{'overrides'}}))) {
14753: my ($inststatus,$inststatus_checked);
14754: if (($env{'user.name'} ne '') && ($env{'user.domain'} ne '') &&
14755: ($env{'user.domain'} ne 'public')) {
14756: $inststatus_checked = 1;
14757: $inststatus = $env{'environment.inststatus'};
14758: }
14759: unless ($inststatus_checked) {
14760: if (($requname ne '') && ($requdom ne '')) {
14761: if (($requname =~ /^$match_username$/) &&
14762: ($requdom =~ /^$match_domain$/) &&
14763: (&Apache::lonnet::domain($requdom))) {
14764: my $requhome = &Apache::lonnet::homeserver($requname,
14765: $requdom);
14766: unless ($requhome eq 'no_host') {
14767: my %userenv = &Apache::lonnet::userenvironment($requdom,$requname,'inststatus');
14768: $inststatus = $userenv{'inststatus'};
14769: $inststatus_checked = 1;
14770: }
14771: }
14772: }
14773: }
14774: unless ($inststatus_checked) {
14775: if ($reqemail =~ /^[^\@]+\@[^\@]+$/) {
14776: my %srch = (srchby => 'email',
14777: srchdomain => $defdom,
14778: srchterm => $reqemail,
14779: srchtype => 'exact');
14780: my %srch_results = &Apache::lonnet::usersearch(\%srch);
14781: foreach my $uname (keys(%srch_results)) {
14782: if (ref($srch_results{$uname}{'inststatus'}) eq 'ARRAY') {
14783: $inststatus = join(',',@{$srch_results{$uname}{'inststatus'}});
14784: $inststatus_checked = 1;
14785: last;
14786: }
14787: }
14788: unless ($inststatus_checked) {
14789: my ($dirsrchres,%srch_results) = &Apache::lonnet::inst_directory_query(\%srch);
14790: if ($dirsrchres eq 'ok') {
14791: foreach my $uname (keys(%srch_results)) {
14792: if (ref($srch_results{$uname}{'inststatus'}) eq 'ARRAY') {
14793: $inststatus = join(',',@{$srch_results{$uname}{'inststatus'}});
14794: $inststatus_checked = 1;
14795: last;
14796: }
14797: }
14798: }
14799: }
14800: }
14801: }
14802: if ($inststatus ne '') {
14803: foreach my $status (split(/\:/,$inststatus)) {
14804: if (ref($domconfig{'contacts'}{'overrides'}{$status}) eq 'HASH') {
14805: my @contacts = ('adminemail','supportemail');
14806: foreach my $item (@contacts) {
14807: if ($domconfig{'contacts'}{'overrides'}{$status}{$item}) {
14808: my $addr = $domconfig{'contacts'}{'overrides'}{$status};
14809: if (!grep(/^\Q$addr\E$/,@recipients)) {
14810: push(@recipients,$addr);
14811: }
14812: }
14813: }
14814: $otheremails = $domconfig{'contacts'}{'overrides'}{$status}{'others'};
14815: if ($domconfig{'contacts'}{'overrides'}{$status}{'bcc'}) {
14816: my @bccs = split(/,/,$domconfig{'contacts'}{'overrides'}{$status}{'bcc'});
14817: my @ok_bccs;
14818: foreach my $bcc (@bccs) {
14819: $bcc =~ s/^\s+//g;
14820: $bcc =~ s/\s+$//g;
14821: if ($bcc =~ m/^[^\@]+\@[^\@]+$/) {
14822: if (!(grep(/^\Q$bcc\E$/,@ok_bccs))) {
14823: push(@ok_bccs,$bcc);
14824: }
14825: }
14826: }
14827: if (@ok_bccs > 0) {
14828: $allbcc = join(', ',@ok_bccs);
14829: }
14830: }
14831: $addtext = $domconfig{'contacts'}{'overrides'}{$status}{'include'};
14832: last;
14833: }
14834: }
14835: }
14836: }
14837: }
1.619 raeburn 14838: } elsif ($origmail ne '') {
1.1270 raeburn 14839: $lastresort = $origmail;
14840: }
1.1297 raeburn 14841: if (($mailing eq 'helpdeskmail') && ($lastresort ne '')) {
1.1270 raeburn 14842: unless (grep(/^\Q$defdom\E$/,&Apache::lonnet::current_machine_domains())) {
14843: my $lonhost = $Apache::lonnet::perlvar{'lonHostID'};
14844: my $machinedom = $Apache::lonnet::perlvar{'lonDefDomain'};
14845: my %what = (
14846: perlvar => 1,
14847: );
14848: my $primary = &Apache::lonnet::domain($defdom,'primary');
14849: if ($primary) {
14850: my $gotaddr;
14851: my ($result,$returnhash) =
14852: &Apache::lonnet::get_remote_globals($primary,{ perlvar => 1 });
14853: if (($result eq 'ok') && (ref($returnhash) eq 'HASH')) {
14854: if ($returnhash->{'lonSupportEMail'} =~ /^[^\@]+\@[^\@]+$/) {
14855: $lastresort = $returnhash->{'lonSupportEMail'};
14856: $gotaddr = 1;
14857: }
14858: }
14859: unless ($gotaddr) {
14860: my $uintdom = &Apache::lonnet::internet_dom($primary);
14861: my $intdom = &Apache::lonnet::internet_dom($lonhost);
14862: unless ($uintdom eq $intdom) {
14863: my %domconfig =
14864: &Apache::lonnet::get_dom('configuration',['contacts'],$machinedom);
14865: if (ref($domconfig{'contacts'}) eq 'HASH') {
14866: if (ref($domconfig{'contacts'}{'otherdomsmail'}) eq 'HASH') {
14867: my @contacts = ('adminemail','supportemail');
14868: foreach my $item (@contacts) {
14869: if ($domconfig{'contacts'}{'otherdomsmail'}{$item}) {
14870: my $addr = $domconfig{'contacts'}{$item};
14871: if (!grep(/^\Q$addr\E$/,@recipients)) {
14872: push(@recipients,$addr);
14873: }
14874: }
14875: }
14876: if ($domconfig{'contacts'}{'otherdomsmail'}{'others'}) {
14877: $otheremails = $domconfig{'contacts'}{'otherdomsmail'}{'others'};
14878: }
14879: if ($domconfig{'contacts'}{'otherdomsmail'}{'bcc'}) {
14880: my @bccs = split(/,/,$domconfig{'contacts'}{'otherdomsmail'}{'bcc'});
14881: my @ok_bccs;
14882: foreach my $bcc (@bccs) {
14883: $bcc =~ s/^\s+//g;
14884: $bcc =~ s/\s+$//g;
14885: if ($bcc =~ m/^[^\@]+\@[^\@]+$/) {
14886: if (!(grep(/^\Q$bcc\E$/,@ok_bccs))) {
14887: push(@ok_bccs,$bcc);
14888: }
14889: }
14890: }
14891: if (@ok_bccs > 0) {
14892: $allbcc = join(', ',@ok_bccs);
14893: }
14894: }
14895: $addtext = $domconfig{'contacts'}{'otherdomsmail'}{'include'};
14896: }
14897: }
14898: }
14899: }
14900: }
14901: }
1.618 raeburn 14902: }
1.688 raeburn 14903: if (defined($defmail)) {
14904: if ($defmail ne '') {
14905: push(@recipients,$defmail);
14906: }
1.618 raeburn 14907: }
14908: if ($otheremails) {
1.619 raeburn 14909: my @others;
14910: if ($otheremails =~ /,/) {
14911: @others = split(/,/,$otheremails);
1.618 raeburn 14912: } else {
1.619 raeburn 14913: push(@others,$otheremails);
14914: }
14915: foreach my $addr (@others) {
14916: if (!grep(/^\Q$addr\E$/,@recipients)) {
14917: push(@recipients,$addr);
14918: }
1.618 raeburn 14919: }
14920: }
1.1298 raeburn 14921: if ($mailing eq 'helpdeskmail') {
1.1270 raeburn 14922: if ((!@recipients) && ($lastresort ne '')) {
14923: push(@recipients,$lastresort);
14924: }
14925: } elsif ($lastresort ne '') {
14926: if (!grep(/^\Q$lastresort\E$/,@recipients)) {
14927: push(@recipients,$lastresort);
14928: }
14929: }
1.1271 raeburn 14930: my $recipientlist = join(',',@recipients);
1.1270 raeburn 14931: if (wantarray) {
14932: return ($recipientlist,$allbcc,$addtext);
14933: } else {
14934: return $recipientlist;
14935: }
1.618 raeburn 14936: }
14937:
1.127 matthew 14938: ############################################################
14939: ############################################################
1.154 albertel 14940:
1.655 raeburn 14941: =pod
14942:
1.1224 musolffc 14943: =over 4
14944:
1.1223 musolffc 14945: =item * &mime_email()
14946:
14947: Sends an email with a possible attachment
14948:
14949: Inputs:
14950:
14951: =over 4
14952:
14953: from - Sender's email address
14954:
14955: to - Email address of recipient
14956:
14957: subject - Subject of email
14958:
14959: body - Body of email
14960:
14961: cc_string - Carbon copy email address
14962:
14963: bcc - Blind carbon copy email address
14964:
14965: type - File type of attachment
14966:
14967: attachment_path - Path of file to be attached
14968:
14969: file_name - Name of file to be attached
14970:
14971: attachment_text - The body of an attachment of type "TEXT"
14972:
14973: =back
14974:
14975: =back
14976:
14977: =cut
14978:
14979: ############################################################
14980: ############################################################
14981:
14982: sub mime_email {
14983: my ($from, $to, $subject, $body, $cc_string, $bcc, $attachment_path,
14984: $file_name, $attachment_text) = @_;
14985: my $msg = MIME::Lite->new(
14986: From => $from,
14987: To => $to,
14988: Subject => $subject,
14989: Type =>'TEXT',
14990: Data => $body,
14991: );
14992: if ($cc_string ne '') {
14993: $msg->add("Cc" => $cc_string);
14994: }
14995: if ($bcc ne '') {
14996: $msg->add("Bcc" => $bcc);
14997: }
14998: $msg->attr("content-type" => "text/plain");
14999: $msg->attr("content-type.charset" => "UTF-8");
15000: # Attach file if given
15001: if ($attachment_path) {
15002: unless ($file_name) {
15003: if ($attachment_path =~ m-/([^/]+)$-) { $file_name = $1; }
15004: }
15005: my ($type, $encoding) = MIME::Types::by_suffix($attachment_path);
15006: $msg->attach(Type => $type,
15007: Path => $attachment_path,
15008: Filename => $file_name
15009: );
15010: # Otherwise attach text if given
15011: } elsif ($attachment_text) {
15012: $msg->attach(Type => 'TEXT',
15013: Data => $attachment_text);
15014: }
15015: # Send it
15016: $msg->send('sendmail');
15017: }
15018:
15019: ############################################################
15020: ############################################################
15021:
15022: =pod
15023:
1.655 raeburn 15024: =head1 Course Catalog Routines
15025:
15026: =over 4
15027:
15028: =item * &gather_categories()
15029:
15030: Converts category definitions - keys of categories hash stored in
15031: coursecategories in configuration.db on the primary library server in a
15032: domain - to an array. Also generates javascript and idx hash used to
15033: generate Domain Coordinator interface for editing Course Categories.
15034:
15035: Inputs:
1.663 raeburn 15036:
1.655 raeburn 15037: categories (reference to hash of category definitions).
1.663 raeburn 15038:
1.655 raeburn 15039: cats (reference to array of arrays/hashes which encapsulates hierarchy of
15040: categories and subcategories).
1.663 raeburn 15041:
1.655 raeburn 15042: idx (reference to hash of counters used in Domain Coordinator interface for
15043: editing Course Categories).
1.663 raeburn 15044:
1.655 raeburn 15045: jsarray (reference to array of categories used to create Javascript arrays for
15046: Domain Coordinator interface for editing Course Categories).
15047:
15048: Returns: nothing
15049:
15050: Side effects: populates cats, idx and jsarray.
15051:
15052: =cut
15053:
15054: sub gather_categories {
15055: my ($categories,$cats,$idx,$jsarray) = @_;
15056: my %counters;
15057: my $num = 0;
15058: foreach my $item (keys(%{$categories})) {
15059: my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item);
15060: if ($container eq '' && $depth == 0) {
15061: $cats->[$depth][$categories->{$item}] = $cat;
15062: } else {
15063: $cats->[$depth]{$container}[$categories->{$item}] = $cat;
15064: }
15065: my ($escitem,$tail) = split(/:/,$item,2);
15066: if ($counters{$tail} eq '') {
15067: $counters{$tail} = $num;
15068: $num ++;
15069: }
15070: if (ref($idx) eq 'HASH') {
15071: $idx->{$item} = $counters{$tail};
15072: }
15073: if (ref($jsarray) eq 'ARRAY') {
15074: push(@{$jsarray->[$counters{$tail}]},$item);
15075: }
15076: }
15077: return;
15078: }
15079:
15080: =pod
15081:
15082: =item * &extract_categories()
15083:
15084: Used to generate breadcrumb trails for course categories.
15085:
15086: Inputs:
1.663 raeburn 15087:
1.655 raeburn 15088: categories (reference to hash of category definitions).
1.663 raeburn 15089:
1.655 raeburn 15090: cats (reference to array of arrays/hashes which encapsulates hierarchy of
15091: categories and subcategories).
1.663 raeburn 15092:
1.655 raeburn 15093: trails (reference to array of breacrumb trails for each category).
1.663 raeburn 15094:
1.655 raeburn 15095: allitems (reference to hash - key is category key
15096: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 15097:
1.655 raeburn 15098: idx (reference to hash of counters used in Domain Coordinator interface for
15099: editing Course Categories).
1.663 raeburn 15100:
1.655 raeburn 15101: jsarray (reference to array of categories used to create Javascript arrays for
15102: Domain Coordinator interface for editing Course Categories).
15103:
1.665 raeburn 15104: subcats (reference to hash of arrays containing all subcategories within each
15105: category, -recursive)
15106:
1.655 raeburn 15107: Returns: nothing
15108:
15109: Side effects: populates trails and allitems hash references.
15110:
15111: =cut
15112:
15113: sub extract_categories {
1.665 raeburn 15114: my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats) = @_;
1.655 raeburn 15115: if (ref($categories) eq 'HASH') {
15116: &gather_categories($categories,$cats,$idx,$jsarray);
15117: if (ref($cats->[0]) eq 'ARRAY') {
15118: for (my $i=0; $i<@{$cats->[0]}; $i++) {
15119: my $name = $cats->[0][$i];
15120: my $item = &escape($name).'::0';
15121: my $trailstr;
15122: if ($name eq 'instcode') {
15123: $trailstr = &mt('Official courses (with institutional codes)');
1.919 raeburn 15124: } elsif ($name eq 'communities') {
15125: $trailstr = &mt('Communities');
1.1239 raeburn 15126: } elsif ($name eq 'placement') {
15127: $trailstr = &mt('Placement Tests');
1.655 raeburn 15128: } else {
15129: $trailstr = $name;
15130: }
15131: if ($allitems->{$item} eq '') {
15132: push(@{$trails},$trailstr);
15133: $allitems->{$item} = scalar(@{$trails})-1;
15134: }
15135: my @parents = ($name);
15136: if (ref($cats->[1]{$name}) eq 'ARRAY') {
15137: for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) {
15138: my $category = $cats->[1]{$name}[$j];
1.665 raeburn 15139: if (ref($subcats) eq 'HASH') {
15140: push(@{$subcats->{$item}},&escape($category).':'.&escape($name).':1');
15141: }
15142: &recurse_categories($cats,2,$category,$trails,$allitems,\@parents,$subcats);
15143: }
15144: } else {
15145: if (ref($subcats) eq 'HASH') {
15146: $subcats->{$item} = [];
1.655 raeburn 15147: }
15148: }
15149: }
15150: }
15151: }
15152: return;
15153: }
15154:
15155: =pod
15156:
1.1162 raeburn 15157: =item * &recurse_categories()
1.655 raeburn 15158:
15159: Recursively used to generate breadcrumb trails for course categories.
15160:
15161: Inputs:
1.663 raeburn 15162:
1.655 raeburn 15163: cats (reference to array of arrays/hashes which encapsulates hierarchy of
15164: categories and subcategories).
1.663 raeburn 15165:
1.655 raeburn 15166: depth (current depth in hierarchy of categories and sub-categories - 0 indexed).
1.663 raeburn 15167:
15168: category (current course category, for which breadcrumb trail is being generated).
15169:
15170: trails (reference to array of breadcrumb trails for each category).
15171:
1.655 raeburn 15172: allitems (reference to hash - key is category key
15173: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 15174:
1.655 raeburn 15175: parents (array containing containers directories for current category,
15176: back to top level).
15177:
15178: Returns: nothing
15179:
15180: Side effects: populates trails and allitems hash references
15181:
15182: =cut
15183:
15184: sub recurse_categories {
1.665 raeburn 15185: my ($cats,$depth,$category,$trails,$allitems,$parents,$subcats) = @_;
1.655 raeburn 15186: my $shallower = $depth - 1;
15187: if (ref($cats->[$depth]{$category}) eq 'ARRAY') {
15188: for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) {
15189: my $name = $cats->[$depth]{$category}[$k];
15190: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
15191: my $trailstr = join(' -> ',(@{$parents},$category));
15192: if ($allitems->{$item} eq '') {
15193: push(@{$trails},$trailstr);
15194: $allitems->{$item} = scalar(@{$trails})-1;
15195: }
15196: my $deeper = $depth+1;
15197: push(@{$parents},$category);
1.665 raeburn 15198: if (ref($subcats) eq 'HASH') {
15199: my $subcat = &escape($name).':'.$category.':'.$depth;
15200: for (my $j=@{$parents}; $j>=0; $j--) {
15201: my $higher;
15202: if ($j > 0) {
15203: $higher = &escape($parents->[$j]).':'.
15204: &escape($parents->[$j-1]).':'.$j;
15205: } else {
15206: $higher = &escape($parents->[$j]).'::'.$j;
15207: }
15208: push(@{$subcats->{$higher}},$subcat);
15209: }
15210: }
15211: &recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents,
15212: $subcats);
1.655 raeburn 15213: pop(@{$parents});
15214: }
15215: } else {
15216: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
15217: my $trailstr = join(' -> ',(@{$parents},$category));
15218: if ($allitems->{$item} eq '') {
15219: push(@{$trails},$trailstr);
15220: $allitems->{$item} = scalar(@{$trails})-1;
15221: }
15222: }
15223: return;
15224: }
15225:
1.663 raeburn 15226: =pod
15227:
1.1162 raeburn 15228: =item * &assign_categories_table()
1.663 raeburn 15229:
15230: Create a datatable for display of hierarchical categories in a domain,
15231: with checkboxes to allow a course to be categorized.
15232:
15233: Inputs:
15234:
15235: cathash - reference to hash of categories defined for the domain (from
15236: configuration.db)
15237:
15238: currcat - scalar with an & separated list of categories assigned to a course.
15239:
1.919 raeburn 15240: type - scalar contains course type (Course or Community).
15241:
1.1260 raeburn 15242: disabled - scalar (optional) contains disabled="disabled" if input elements are
15243: to be readonly (e.g., Domain Helpdesk role viewing course settings).
15244:
1.663 raeburn 15245: Returns: $output (markup to be displayed)
15246:
15247: =cut
15248:
15249: sub assign_categories_table {
1.1259 raeburn 15250: my ($cathash,$currcat,$type,$disabled) = @_;
1.663 raeburn 15251: my $output;
15252: if (ref($cathash) eq 'HASH') {
15253: my (@cats,@trails,%allitems,%idx,@jsarray,@path,$maxdepth);
15254: &extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray);
15255: $maxdepth = scalar(@cats);
15256: if (@cats > 0) {
15257: my $itemcount = 0;
15258: if (ref($cats[0]) eq 'ARRAY') {
15259: my @currcategories;
15260: if ($currcat ne '') {
15261: @currcategories = split('&',$currcat);
15262: }
1.919 raeburn 15263: my $table;
1.663 raeburn 15264: for (my $i=0; $i<@{$cats[0]}; $i++) {
15265: my $parent = $cats[0][$i];
1.919 raeburn 15266: next if ($parent eq 'instcode');
15267: if ($type eq 'Community') {
15268: next unless ($parent eq 'communities');
1.1239 raeburn 15269: } elsif ($type eq 'Placement') {
15270: next unless ($parent eq 'placement');
1.919 raeburn 15271: } else {
1.1239 raeburn 15272: next if (($parent eq 'communities') || ($parent eq 'placement'));
1.919 raeburn 15273: }
1.663 raeburn 15274: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
15275: my $item = &escape($parent).'::0';
15276: my $checked = '';
15277: if (@currcategories > 0) {
15278: if (grep(/^\Q$item\E$/,@currcategories)) {
1.772 bisitz 15279: $checked = ' checked="checked"';
1.663 raeburn 15280: }
15281: }
1.919 raeburn 15282: my $parent_title = $parent;
15283: if ($parent eq 'communities') {
15284: $parent_title = &mt('Communities');
1.1239 raeburn 15285: } elsif ($parent eq 'placement') {
15286: $parent_title = &mt('Placement Tests');
1.919 raeburn 15287: }
15288: $table .= '<tr '.$css_class.'><td><span class="LC_nobreak">'.
15289: '<input type="checkbox" name="usecategory" value="'.
1.1259 raeburn 15290: $item.'"'.$checked.$disabled.' />'.$parent_title.'</span>'.
1.919 raeburn 15291: '<input type="hidden" name="catname" value="'.$parent.'" /></td>';
1.663 raeburn 15292: my $depth = 1;
15293: push(@path,$parent);
1.1259 raeburn 15294: $table .= &assign_category_rows($itemcount,\@cats,$depth,$parent,\@path,\@currcategories,$disabled);
1.663 raeburn 15295: pop(@path);
1.919 raeburn 15296: $table .= '</tr><tr><td colspan="'.$maxdepth.'" class="LC_row_separator"></td></tr>';
1.663 raeburn 15297: $itemcount ++;
15298: }
1.919 raeburn 15299: if ($itemcount) {
15300: $output = &Apache::loncommon::start_data_table().
15301: $table.
15302: &Apache::loncommon::end_data_table();
15303: }
1.663 raeburn 15304: }
15305: }
15306: }
15307: return $output;
15308: }
15309:
15310: =pod
15311:
1.1162 raeburn 15312: =item * &assign_category_rows()
1.663 raeburn 15313:
15314: Create a datatable row for display of nested categories in a domain,
15315: with checkboxes to allow a course to be categorized,called recursively.
15316:
15317: Inputs:
15318:
15319: itemcount - track row number for alternating colors
15320:
15321: cats - reference to array of arrays/hashes which encapsulates hierarchy of
15322: categories and subcategories.
15323:
15324: depth - current depth in hierarchy of categories and sub-categories - 0 indexed.
15325:
15326: parent - parent of current category item
15327:
15328: path - Array containing all categories back up through the hierarchy from the
15329: current category to the top level.
15330:
15331: currcategories - reference to array of current categories assigned to the course
15332:
1.1260 raeburn 15333: disabled - scalar (optional) contains disabled="disabled" if input elements are
15334: to be readonly (e.g., Domain Helpdesk role viewing course settings).
15335:
1.663 raeburn 15336: Returns: $output (markup to be displayed).
15337:
15338: =cut
15339:
15340: sub assign_category_rows {
1.1259 raeburn 15341: my ($itemcount,$cats,$depth,$parent,$path,$currcategories,$disabled) = @_;
1.663 raeburn 15342: my ($text,$name,$item,$chgstr);
15343: if (ref($cats) eq 'ARRAY') {
15344: my $maxdepth = scalar(@{$cats});
15345: if (ref($cats->[$depth]) eq 'HASH') {
15346: if (ref($cats->[$depth]{$parent}) eq 'ARRAY') {
15347: my $numchildren = @{$cats->[$depth]{$parent}};
15348: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
1.1145 raeburn 15349: $text .= '<td><table class="LC_data_table">';
1.663 raeburn 15350: for (my $j=0; $j<$numchildren; $j++) {
15351: $name = $cats->[$depth]{$parent}[$j];
15352: $item = &escape($name).':'.&escape($parent).':'.$depth;
15353: my $deeper = $depth+1;
15354: my $checked = '';
15355: if (ref($currcategories) eq 'ARRAY') {
15356: if (@{$currcategories} > 0) {
15357: if (grep(/^\Q$item\E$/,@{$currcategories})) {
1.772 bisitz 15358: $checked = ' checked="checked"';
1.663 raeburn 15359: }
15360: }
15361: }
1.664 raeburn 15362: $text .= '<tr><td><span class="LC_nobreak"><label>'.
15363: '<input type="checkbox" name="usecategory" value="'.
1.1259 raeburn 15364: $item.'"'.$checked.$disabled.' />'.$name.'</label></span>'.
1.675 raeburn 15365: '<input type="hidden" name="catname" value="'.$name.'" />'.
15366: '</td><td>';
1.663 raeburn 15367: if (ref($path) eq 'ARRAY') {
15368: push(@{$path},$name);
1.1259 raeburn 15369: $text .= &assign_category_rows($itemcount,$cats,$deeper,$name,$path,$currcategories,$disabled);
1.663 raeburn 15370: pop(@{$path});
15371: }
15372: $text .= '</td></tr>';
15373: }
15374: $text .= '</table></td>';
15375: }
15376: }
15377: }
15378: return $text;
15379: }
15380:
1.1181 raeburn 15381: =pod
15382:
15383: =back
15384:
15385: =cut
15386:
1.655 raeburn 15387: ############################################################
15388: ############################################################
15389:
15390:
1.443 albertel 15391: sub commit_customrole {
1.664 raeburn 15392: my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context) = @_;
1.630 raeburn 15393: my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
1.443 albertel 15394: ($start?', '.&mt('starting').' '.localtime($start):'').
15395: ($end?', ending '.localtime($end):'').': <b>'.
15396: &Apache::lonnet::assigncustomrole(
1.664 raeburn 15397: $udom,$uname,$url,$three,$four,$five,$end,$start,undef,undef,$context).
1.443 albertel 15398: '</b><br />';
15399: return $output;
15400: }
15401:
15402: sub commit_standardrole {
1.1116 raeburn 15403: my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context,$credits) = @_;
1.541 raeburn 15404: my ($output,$logmsg,$linefeed);
15405: if ($context eq 'auto') {
15406: $linefeed = "\n";
15407: } else {
15408: $linefeed = "<br />\n";
15409: }
1.443 albertel 15410: if ($three eq 'st') {
1.541 raeburn 15411: my $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
1.1116 raeburn 15412: $one,$two,$sec,$context,$credits);
1.541 raeburn 15413: if (($result =~ /^error/) || ($result eq 'not_in_class') ||
1.626 raeburn 15414: ($result eq 'unknown_course') || ($result eq 'refused')) {
15415: $output = $logmsg.' '.&mt('Error: ').$result."\n";
1.443 albertel 15416: } else {
1.541 raeburn 15417: $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
1.443 albertel 15418: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 15419: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
15420: if ($context eq 'auto') {
15421: $output .= $result.$linefeed.&mt('Add to classlist').': ok';
15422: } else {
15423: $output .= '<b>'.$result.'</b>'.$linefeed.
15424: &mt('Add to classlist').': <b>ok</b>';
15425: }
15426: $output .= $linefeed;
1.443 albertel 15427: }
15428: } else {
15429: $output = &mt('Assigning').' '.$three.' in '.$url.
15430: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 15431: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
1.652 raeburn 15432: my $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,'','',$context);
1.541 raeburn 15433: if ($context eq 'auto') {
15434: $output .= $result.$linefeed;
15435: } else {
15436: $output .= '<b>'.$result.'</b>'.$linefeed;
15437: }
1.443 albertel 15438: }
15439: return $output;
15440: }
15441:
15442: sub commit_studentrole {
1.1116 raeburn 15443: my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context,
15444: $credits) = @_;
1.626 raeburn 15445: my ($result,$linefeed,$oldsecurl,$newsecurl);
1.541 raeburn 15446: if ($context eq 'auto') {
15447: $linefeed = "\n";
15448: } else {
15449: $linefeed = '<br />'."\n";
15450: }
1.443 albertel 15451: if (defined($one) && defined($two)) {
15452: my $cid=$one.'_'.$two;
15453: my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
15454: my $secchange = 0;
15455: my $expire_role_result;
15456: my $modify_section_result;
1.628 raeburn 15457: if ($oldsec ne '-1') {
15458: if ($oldsec ne $sec) {
1.443 albertel 15459: $secchange = 1;
1.628 raeburn 15460: my $now = time;
1.443 albertel 15461: my $uurl='/'.$cid;
15462: $uurl=~s/\_/\//g;
15463: if ($oldsec) {
15464: $uurl.='/'.$oldsec;
15465: }
1.626 raeburn 15466: $oldsecurl = $uurl;
1.628 raeburn 15467: $expire_role_result =
1.652 raeburn 15468: &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,'','',$context);
1.628 raeburn 15469: if ($env{'request.course.sec'} ne '') {
15470: if ($expire_role_result eq 'refused') {
15471: my @roles = ('st');
15472: my @statuses = ('previous');
15473: my @roledoms = ($one);
15474: my $withsec = 1;
15475: my %roleshash =
15476: &Apache::lonnet::get_my_roles($uname,$udom,'userroles',
15477: \@statuses,\@roles,\@roledoms,$withsec);
15478: if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
15479: my ($oldstart,$oldend) =
15480: split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
15481: if ($oldend > 0 && $oldend <= $now) {
15482: $expire_role_result = 'ok';
15483: }
15484: }
15485: }
15486: }
1.443 albertel 15487: $result = $expire_role_result;
15488: }
15489: }
15490: if (($expire_role_result eq 'ok') || ($secchange == 0)) {
1.1116 raeburn 15491: $modify_section_result =
15492: &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,
15493: undef,undef,undef,$sec,
15494: $end,$start,'','',$cid,
15495: '',$context,$credits);
1.443 albertel 15496: if ($modify_section_result =~ /^ok/) {
15497: if ($secchange == 1) {
1.628 raeburn 15498: if ($sec eq '') {
15499: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
15500: } else {
15501: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
15502: }
1.443 albertel 15503: } elsif ($oldsec eq '-1') {
1.628 raeburn 15504: if ($sec eq '') {
15505: $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
15506: } else {
15507: $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
15508: }
1.443 albertel 15509: } else {
1.628 raeburn 15510: if ($sec eq '') {
15511: $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
15512: } else {
15513: $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
15514: }
1.443 albertel 15515: }
15516: } else {
1.1115 raeburn 15517: if ($secchange) {
1.628 raeburn 15518: $$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;
15519: } else {
15520: $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
15521: }
1.443 albertel 15522: }
15523: $result = $modify_section_result;
15524: } elsif ($secchange == 1) {
1.628 raeburn 15525: if ($oldsec eq '') {
1.1103 raeburn 15526: $$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 15527: } else {
15528: $$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;
15529: }
1.626 raeburn 15530: if ($expire_role_result eq 'refused') {
15531: my $newsecurl = '/'.$cid;
15532: $newsecurl =~ s/\_/\//g;
15533: if ($sec ne '') {
15534: $newsecurl.='/'.$sec;
15535: }
15536: if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
15537: if ($sec eq '') {
15538: $$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;
15539: } else {
15540: $$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;
15541: }
15542: }
15543: }
1.443 albertel 15544: }
15545: } else {
1.626 raeburn 15546: $$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 15547: $result = "error: incomplete course id\n";
15548: }
15549: return $result;
15550: }
15551:
1.1108 raeburn 15552: sub show_role_extent {
15553: my ($scope,$context,$role) = @_;
15554: $scope =~ s{^/}{};
15555: my @courseroles = &Apache::lonuserutils::roles_by_context('course',1);
15556: push(@courseroles,'co');
15557: my @authorroles = &Apache::lonuserutils::roles_by_context('author');
15558: if (($context eq 'course') || (grep(/^\Q$role\E/,@courseroles))) {
15559: $scope =~ s{/}{_};
15560: return '<span class="LC_cusr_emph">'.$env{'course.'.$scope.'.description'}.'</span>';
15561: } elsif (($context eq 'author') || (grep(/^\Q$role\E/,@authorroles))) {
15562: my ($audom,$auname) = split(/\//,$scope);
15563: return &mt('[_1] Author Space','<span class="LC_cusr_emph">'.
15564: &Apache::loncommon::plainname($auname,$audom).'</span>');
15565: } else {
15566: $scope =~ s{/$}{};
15567: return &mt('Domain: [_1]','<span class="LC_cusr_emph">'.
15568: &Apache::lonnet::domain($scope,'description').'</span>');
15569: }
15570: }
15571:
1.443 albertel 15572: ############################################################
15573: ############################################################
15574:
1.566 albertel 15575: sub check_clone {
1.578 raeburn 15576: my ($args,$linefeed) = @_;
1.566 albertel 15577: my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
15578: my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
15579: my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
15580: my $clonemsg;
15581: my $can_clone = 0;
1.944 raeburn 15582: my $lctype = lc($args->{'crstype'});
1.908 raeburn 15583: if ($lctype ne 'community') {
15584: $lctype = 'course';
15585: }
1.566 albertel 15586: if ($clonehome eq 'no_host') {
1.944 raeburn 15587: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 15588: $clonemsg = &mt('No new community created.').$linefeed.&mt('A new community could not be cloned from the specified original - [_1] - because it is a non-existent community.',$args->{'clonecourse'}.':'.$args->{'clonedomain'});
15589: } else {
15590: $clonemsg = &mt('No new course created.').$linefeed.&mt('A new course could not be cloned from the specified original - [_1] - because it is a non-existent course.',$args->{'clonecourse'}.':'.$args->{'clonedomain'});
15591: }
1.566 albertel 15592: } else {
15593: my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
1.944 raeburn 15594: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 15595: if ($clonedesc{'type'} ne 'Community') {
1.1262 raeburn 15596: $clonemsg = &mt('No new community created.').$linefeed.&mt('A new community could not be cloned from the specified original - [_1] - because it is a course not a community.',$args->{'clonecourse'}.':'.$args->{'clonedomain'});
1.908 raeburn 15597: return ($can_clone, $clonemsg, $cloneid, $clonehome);
15598: }
15599: }
1.1262 raeburn 15600: if (($env{'request.role.domain'} eq $args->{'clonedomain'}) &&
1.882 raeburn 15601: (&Apache::lonnet::allowed('ccc',$env{'request.role.domain'}))) {
1.566 albertel 15602: $can_clone = 1;
15603: } else {
1.1221 raeburn 15604: my %clonehash = &Apache::lonnet::get('environment',['cloners','internal.coursecode'],
1.566 albertel 15605: $args->{'clonedomain'},$args->{'clonecourse'});
1.1221 raeburn 15606: if ($clonehash{'cloners'} eq '') {
15607: my %domdefs = &Apache::lonnet::get_domain_defaults($args->{'course_domain'});
15608: if ($domdefs{'canclone'}) {
15609: unless ($domdefs{'canclone'} eq 'none') {
15610: if ($domdefs{'canclone'} eq 'domain') {
15611: if ($args->{'ccdomain'} eq $args->{'clonedomain'}) {
15612: $can_clone = 1;
15613: }
15614: } elsif (($clonehash{'internal.coursecode'}) && ($args->{'crscode'}) &&
15615: ($args->{'clonedomain'} eq $args->{'course_domain'})) {
15616: if (&Apache::lonnet::default_instcode_cloning($args->{'clonedomain'},$domdefs{'canclone'},
15617: $clonehash{'internal.coursecode'},$args->{'crscode'})) {
15618: $can_clone = 1;
15619: }
15620: }
15621: }
15622: }
1.578 raeburn 15623: } else {
1.1221 raeburn 15624: my @cloners = split(/,/,$clonehash{'cloners'});
15625: if (grep(/^\*$/,@cloners)) {
1.942 raeburn 15626: $can_clone = 1;
1.1221 raeburn 15627: } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
1.942 raeburn 15628: $can_clone = 1;
1.1225 raeburn 15629: } elsif (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners)) {
15630: $can_clone = 1;
1.1221 raeburn 15631: }
15632: unless ($can_clone) {
1.1225 raeburn 15633: if (($clonehash{'internal.coursecode'}) && ($args->{'crscode'}) &&
15634: ($args->{'clonedomain'} eq $args->{'course_domain'})) {
1.1221 raeburn 15635: my (%gotdomdefaults,%gotcodedefaults);
15636: foreach my $cloner (@cloners) {
15637: if (($cloner ne '*') && ($cloner !~ /^\*\:$match_domain$/) &&
15638: ($cloner !~ /^$match_username\:$match_domain$/) && ($cloner ne '')) {
15639: my (%codedefaults,@code_order);
15640: if (ref($gotcodedefaults{$args->{'clonedomain'}}) eq 'HASH') {
15641: if (ref($gotcodedefaults{$args->{'clonedomain'}}{'defaults'}) eq 'HASH') {
15642: %codedefaults = %{$gotcodedefaults{$args->{'clonedomain'}}{'defaults'}};
15643: }
15644: if (ref($gotcodedefaults{$args->{'clonedomain'}}{'order'}) eq 'ARRAY') {
15645: @code_order = @{$gotcodedefaults{$args->{'clonedomain'}}{'order'}};
15646: }
15647: } else {
15648: &Apache::lonnet::auto_instcode_defaults($args->{'clonedomain'},
15649: \%codedefaults,
15650: \@code_order);
15651: $gotcodedefaults{$args->{'clonedomain'}}{'defaults'} = \%codedefaults;
15652: $gotcodedefaults{$args->{'clonedomain'}}{'order'} = \@code_order;
15653: }
15654: if (@code_order > 0) {
15655: if (&Apache::lonnet::check_instcode_cloning(\%codedefaults,\@code_order,
15656: $cloner,$clonehash{'internal.coursecode'},
15657: $args->{'crscode'})) {
15658: $can_clone = 1;
15659: last;
15660: }
15661: }
15662: }
15663: }
15664: }
1.1225 raeburn 15665: }
15666: }
15667: unless ($can_clone) {
15668: my $ccrole = 'cc';
15669: if ($args->{'crstype'} eq 'Community') {
15670: $ccrole = 'co';
15671: }
15672: my %roleshash =
15673: &Apache::lonnet::get_my_roles($args->{'ccuname'},
15674: $args->{'ccdomain'},
15675: 'userroles',['active'],[$ccrole],
15676: [$args->{'clonedomain'}]);
15677: if ($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':'.$ccrole}) {
15678: $can_clone = 1;
15679: } elsif (&Apache::lonnet::is_course_owner($args->{'clonedomain'},$args->{'clonecourse'},
15680: $args->{'ccuname'},$args->{'ccdomain'})) {
15681: $can_clone = 1;
1.1221 raeburn 15682: }
15683: }
15684: unless ($can_clone) {
15685: if ($args->{'crstype'} eq 'Community') {
15686: $clonemsg = &mt('No new community created.').$linefeed.&mt('The new community could not be cloned from the existing community because the new community owner ([_1]) does not have cloning rights in the existing community ([_2]).',$args->{'ccuname'}.':'.$args->{'ccdomain'},$clonedesc{'description'});
1.942 raeburn 15687: } else {
1.1221 raeburn 15688: $clonemsg = &mt('No new course created.').$linefeed.&mt('The new course could not be cloned from the existing course because the new course owner ([_1]) does not have cloning rights in the existing course ([_2]).',$args->{'ccuname'}.':'.$args->{'ccdomain'},$clonedesc{'description'});
15689: }
1.566 albertel 15690: }
1.578 raeburn 15691: }
1.566 albertel 15692: }
15693: return ($can_clone, $clonemsg, $cloneid, $clonehome);
15694: }
15695:
1.444 albertel 15696: sub construct_course {
1.1262 raeburn 15697: my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context,
15698: $cnum,$category,$coderef) = @_;
1.444 albertel 15699: my $outcome;
1.541 raeburn 15700: my $linefeed = '<br />'."\n";
15701: if ($context eq 'auto') {
15702: $linefeed = "\n";
15703: }
1.566 albertel 15704:
15705: #
15706: # Are we cloning?
15707: #
15708: my ($can_clone, $clonemsg, $cloneid, $clonehome);
15709: if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
1.578 raeburn 15710: ($can_clone, $clonemsg, $cloneid, $clonehome) = &check_clone($args,$linefeed);
1.566 albertel 15711: if ($context ne 'auto') {
1.578 raeburn 15712: if ($clonemsg ne '') {
15713: $clonemsg = '<span class="LC_error">'.$clonemsg.'</span>';
15714: }
1.566 albertel 15715: }
15716: $outcome .= $clonemsg.$linefeed;
15717:
15718: if (!$can_clone) {
15719: return (0,$outcome);
15720: }
15721: }
15722:
1.444 albertel 15723: #
15724: # Open course
15725: #
1.1239 raeburn 15726: my $showncrstype;
15727: if ($args->{'crstype'} eq 'Placement') {
15728: $showncrstype = 'placement test';
15729: } else {
15730: $showncrstype = lc($args->{'crstype'});
15731: }
1.444 albertel 15732: my %cenv=();
15733: $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
15734: $args->{'cdescr'},
15735: $args->{'curl'},
15736: $args->{'course_home'},
15737: $args->{'nonstandard'},
15738: $args->{'crscode'},
15739: $args->{'ccuname'}.':'.
15740: $args->{'ccdomain'},
1.882 raeburn 15741: $args->{'crstype'},
1.885 raeburn 15742: $cnum,$context,$category);
1.444 albertel 15743:
15744: # Note: The testing routines depend on this being output; see
15745: # Utils::Course. This needs to at least be output as a comment
15746: # if anyone ever decides to not show this, and Utils::Course::new
15747: # will need to be suitably modified.
1.1239 raeburn 15748: $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$showncrstype,$$courseid).$linefeed;
1.943 raeburn 15749: if ($$courseid =~ /^error:/) {
15750: return (0,$outcome);
15751: }
15752:
1.444 albertel 15753: #
15754: # Check if created correctly
15755: #
1.479 albertel 15756: ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
1.444 albertel 15757: my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
1.943 raeburn 15758: if ($crsuhome eq 'no_host') {
15759: $outcome .= &mt('Course creation failed, unrecognized course home server.').$linefeed;
15760: return (0,$outcome);
15761: }
1.541 raeburn 15762: $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
1.566 albertel 15763:
1.444 albertel 15764: #
1.566 albertel 15765: # Do the cloning
15766: #
15767: if ($can_clone && $cloneid) {
1.1239 raeburn 15768: $clonemsg = &mt('Cloning [_1] from [_2]',$showncrstype,$clonehome);
1.566 albertel 15769: if ($context ne 'auto') {
15770: $clonemsg = '<span class="LC_success">'.$clonemsg.'</span>';
15771: }
15772: $outcome .= $clonemsg.$linefeed;
15773: my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
1.444 albertel 15774: # Copy all files
1.637 www 15775: &Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},$args->{'dateshift'});
1.444 albertel 15776: # Restore URL
1.566 albertel 15777: $cenv{'url'}=$oldcenv{'url'};
1.444 albertel 15778: # Restore title
1.566 albertel 15779: $cenv{'description'}=$oldcenv{'description'};
1.955 raeburn 15780: # Restore creation date, creator and creation context.
15781: $cenv{'internal.created'}=$oldcenv{'internal.created'};
15782: $cenv{'internal.creator'}=$oldcenv{'internal.creator'};
15783: $cenv{'internal.creationcontext'}=$oldcenv{'internal.creationcontext'};
1.444 albertel 15784: # Mark as cloned
1.566 albertel 15785: $cenv{'clonedfrom'}=$cloneid;
1.638 www 15786: # Need to clone grading mode
15787: my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum);
15788: $cenv{'grading'}=$newenv{'grading'};
15789: # Do not clone these environment entries
15790: &Apache::lonnet::del('environment',
15791: ['default_enrollment_start_date',
15792: 'default_enrollment_end_date',
15793: 'question.email',
15794: 'policy.email',
15795: 'comment.email',
15796: 'pch.users.denied',
1.725 raeburn 15797: 'plc.users.denied',
15798: 'hidefromcat',
1.1121 raeburn 15799: 'checkforpriv',
1.1166 raeburn 15800: 'categories',
15801: 'internal.uniquecode'],
1.638 www 15802: $$crsudom,$$crsunum);
1.1170 raeburn 15803: if ($args->{'textbook'}) {
15804: $cenv{'internal.textbook'} = $args->{'textbook'};
15805: }
1.444 albertel 15806: }
1.566 albertel 15807:
1.444 albertel 15808: #
15809: # Set environment (will override cloned, if existing)
15810: #
15811: my @sections = ();
15812: my @xlists = ();
15813: if ($args->{'crstype'}) {
15814: $cenv{'type'}=$args->{'crstype'};
15815: }
15816: if ($args->{'crsid'}) {
15817: $cenv{'courseid'}=$args->{'crsid'};
15818: }
15819: if ($args->{'crscode'}) {
15820: $cenv{'internal.coursecode'}=$args->{'crscode'};
15821: }
15822: if ($args->{'crsquota'} ne '') {
15823: $cenv{'internal.coursequota'}=$args->{'crsquota'};
15824: } else {
15825: $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
15826: }
15827: if ($args->{'ccuname'}) {
15828: $cenv{'internal.courseowner'} = $args->{'ccuname'}.
15829: ':'.$args->{'ccdomain'};
15830: } else {
15831: $cenv{'internal.courseowner'} = $args->{'curruser'};
15832: }
1.1116 raeburn 15833: if ($args->{'defaultcredits'}) {
15834: $cenv{'internal.defaultcredits'} = $args->{'defaultcredits'};
15835: }
1.444 albertel 15836: my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
15837: if ($args->{'crssections'}) {
15838: $cenv{'internal.sectionnums'} = '';
15839: if ($args->{'crssections'} =~ m/,/) {
15840: @sections = split/,/,$args->{'crssections'};
15841: } else {
15842: $sections[0] = $args->{'crssections'};
15843: }
15844: if (@sections > 0) {
15845: foreach my $item (@sections) {
15846: my ($sec,$gp) = split/:/,$item;
15847: my $class = $args->{'crscode'}.$sec;
15848: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
15849: $cenv{'internal.sectionnums'} .= $item.',';
15850: unless ($addcheck eq 'ok') {
1.1263 raeburn 15851: push(@badclasses,$class);
1.444 albertel 15852: }
15853: }
15854: $cenv{'internal.sectionnums'} =~ s/,$//;
15855: }
15856: }
15857: # do not hide course coordinator from staff listing,
15858: # even if privileged
15859: $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
1.1121 raeburn 15860: # add course coordinator's domain to domains to check for privileged users
15861: # if different to course domain
15862: if ($$crsudom ne $args->{'ccdomain'}) {
15863: $cenv{'checkforpriv'} = $args->{'ccdomain'};
15864: }
1.444 albertel 15865: # add crosslistings
15866: if ($args->{'crsxlist'}) {
15867: $cenv{'internal.crosslistings'}='';
15868: if ($args->{'crsxlist'} =~ m/,/) {
15869: @xlists = split/,/,$args->{'crsxlist'};
15870: } else {
15871: $xlists[0] = $args->{'crsxlist'};
15872: }
15873: if (@xlists > 0) {
15874: foreach my $item (@xlists) {
15875: my ($xl,$gp) = split/:/,$item;
15876: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
15877: $cenv{'internal.crosslistings'} .= $item.',';
15878: unless ($addcheck eq 'ok') {
1.1263 raeburn 15879: push(@badclasses,$xl);
1.444 albertel 15880: }
15881: }
15882: $cenv{'internal.crosslistings'} =~ s/,$//;
15883: }
15884: }
15885: if ($args->{'autoadds'}) {
15886: $cenv{'internal.autoadds'}=$args->{'autoadds'};
15887: }
15888: if ($args->{'autodrops'}) {
15889: $cenv{'internal.autodrops'}=$args->{'autodrops'};
15890: }
15891: # check for notification of enrollment changes
15892: my @notified = ();
15893: if ($args->{'notify_owner'}) {
15894: if ($args->{'ccuname'} ne '') {
15895: push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
15896: }
15897: }
15898: if ($args->{'notify_dc'}) {
15899: if ($uname ne '') {
1.630 raeburn 15900: push(@notified,$uname.':'.$udom);
1.444 albertel 15901: }
15902: }
15903: if (@notified > 0) {
15904: my $notifylist;
15905: if (@notified > 1) {
15906: $notifylist = join(',',@notified);
15907: } else {
15908: $notifylist = $notified[0];
15909: }
15910: $cenv{'internal.notifylist'} = $notifylist;
15911: }
15912: if (@badclasses > 0) {
15913: my %lt=&Apache::lonlocal::texthash(
1.1264 raeburn 15914: 'tclb' => 'The courses listed below were included as sections or crosslistings affiliated with your new LON-CAPA course.',
15915: 'howi' => 'However, if automated course roster updates are enabled for this class, these particular sections/crosslistings are not guaranteed to contribute towards enrollment.',
15916: 'itis' => 'It is possible that rights to access enrollment for these classes will be available through assignment of co-owners.',
1.444 albertel 15917: );
1.1264 raeburn 15918: my $badclass_msg = $lt{'tclb'}.$linefeed.$lt{'howi'}.$linefeed.
15919: &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 15920: if ($context eq 'auto') {
15921: $outcome .= $badclass_msg.$linefeed;
1.1261 raeburn 15922: } else {
1.566 albertel 15923: $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
1.1261 raeburn 15924: }
15925: foreach my $item (@badclasses) {
1.541 raeburn 15926: if ($context eq 'auto') {
1.1261 raeburn 15927: $outcome .= " - $item\n";
1.541 raeburn 15928: } else {
1.1261 raeburn 15929: $outcome .= "<li>$item</li>\n";
1.541 raeburn 15930: }
1.1261 raeburn 15931: }
15932: if ($context eq 'auto') {
15933: $outcome .= $linefeed;
15934: } else {
15935: $outcome .= "</ul><br /><br /></div>\n";
1.541 raeburn 15936: }
1.444 albertel 15937: }
15938: if ($args->{'no_end_date'}) {
15939: $args->{'endaccess'} = 0;
15940: }
15941: $cenv{'internal.autostart'}=$args->{'enrollstart'};
15942: $cenv{'internal.autoend'}=$args->{'enrollend'};
15943: $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
15944: $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
15945: if ($args->{'showphotos'}) {
15946: $cenv{'internal.showphotos'}=$args->{'showphotos'};
15947: }
15948: $cenv{'internal.authtype'} = $args->{'authtype'};
15949: $cenv{'internal.autharg'} = $args->{'autharg'};
15950: if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
15951: if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'} eq '') {
1.541 raeburn 15952: 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');
15953: if ($context eq 'auto') {
15954: $outcome .= $krb_msg;
15955: } else {
1.566 albertel 15956: $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
1.541 raeburn 15957: }
15958: $outcome .= $linefeed;
1.444 albertel 15959: }
15960: }
15961: if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
15962: if ($args->{'setpolicy'}) {
15963: $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
15964: }
15965: if ($args->{'setcontent'}) {
15966: $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
15967: }
1.1251 raeburn 15968: if ($args->{'setcomment'}) {
15969: $cenv{'comment.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
15970: }
1.444 albertel 15971: }
15972: if ($args->{'reshome'}) {
15973: $cenv{'reshome'}=$args->{'reshome'}.'/';
15974: $cenv{'reshome'}=~s/\/+$/\//;
15975: }
15976: #
15977: # course has keyed access
15978: #
15979: if ($args->{'setkeys'}) {
15980: $cenv{'keyaccess'}='yes';
15981: }
15982: # if specified, key authority is not course, but user
15983: # only active if keyaccess is yes
15984: if ($args->{'keyauth'}) {
1.487 albertel 15985: my ($user,$domain) = split(':',$args->{'keyauth'});
15986: $user = &LONCAPA::clean_username($user);
15987: $domain = &LONCAPA::clean_username($domain);
1.488 foxr 15988: if ($user ne '' && $domain ne '') {
1.487 albertel 15989: $cenv{'keyauth'}=$user.':'.$domain;
1.444 albertel 15990: }
15991: }
15992:
1.1166 raeburn 15993: #
1.1167 raeburn 15994: # generate and store uniquecode (available to course requester), if course should have one.
1.1166 raeburn 15995: #
15996: if ($args->{'uniquecode'}) {
15997: my ($code,$error) = &make_unique_code($$crsudom,$$crsunum);
15998: if ($code) {
15999: $cenv{'internal.uniquecode'} = $code;
1.1167 raeburn 16000: my %crsinfo =
16001: &Apache::lonnet::courseiddump($$crsudom,'.',1,'.','.',$$crsunum,undef,undef,'.');
16002: if (ref($crsinfo{$$crsudom.'_'.$$crsunum}) eq 'HASH') {
16003: $crsinfo{$$crsudom.'_'.$$crsunum}{'uniquecode'} = $code;
16004: my $putres = &Apache::lonnet::courseidput($$crsudom,\%crsinfo,$crsuhome,'notime');
16005: }
1.1166 raeburn 16006: if (ref($coderef)) {
16007: $$coderef = $code;
16008: }
16009: }
16010: }
16011:
1.444 albertel 16012: if ($args->{'disresdis'}) {
16013: $cenv{'pch.roles.denied'}='st';
16014: }
16015: if ($args->{'disablechat'}) {
16016: $cenv{'plc.roles.denied'}='st';
16017: }
16018:
16019: # Record we've not yet viewed the Course Initialization Helper for this
16020: # course
16021: $cenv{'course.helper.not.run'} = 1;
16022: #
16023: # Use new Randomseed
16024: #
16025: $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
16026: $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
16027: #
16028: # The encryption code and receipt prefix for this course
16029: #
16030: $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
16031: $cenv{'internal.encpref'}=100+int(9*rand(99));
16032: #
16033: # By default, use standard grading
16034: if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
16035:
1.541 raeburn 16036: $outcome .= $linefeed.&mt('Setting environment').': '.
16037: &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 16038: #
16039: # Open all assignments
16040: #
16041: if ($args->{'openall'}) {
16042: my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
16043: my %storecontent = ($storeunder => time,
16044: $storeunder.'.type' => 'date_start');
16045:
16046: $outcome .= &mt('Opening all assignments').': '.&Apache::lonnet::cput
1.541 raeburn 16047: ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 16048: }
16049: #
16050: # Set first page
16051: #
16052: unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
16053: || ($cloneid)) {
1.445 albertel 16054: use LONCAPA::map;
1.444 albertel 16055: $outcome .= &mt('Setting first resource').': ';
1.445 albertel 16056:
16057: my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
16058: my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
16059:
1.444 albertel 16060: $outcome .= ($fatal?$errtext:'read ok').' - ';
16061: my $title; my $url;
16062: if ($args->{'firstres'} eq 'syl') {
1.690 bisitz 16063: $title=&mt('Syllabus');
1.444 albertel 16064: $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
16065: } else {
1.963 raeburn 16066: $title=&mt('Table of Contents');
1.444 albertel 16067: $url='/adm/navmaps';
16068: }
1.445 albertel 16069:
16070: $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
16071: (my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
16072:
16073: if ($errtext) { $fatal=2; }
1.541 raeburn 16074: $outcome .= ($fatal?$errtext:'write ok').$linefeed;
1.444 albertel 16075: }
1.566 albertel 16076:
1.1237 raeburn 16077: #
16078: # Set params for Placement Tests
16079: #
1.1239 raeburn 16080: if ($args->{'crstype'} eq 'Placement') {
16081: my %storecontent;
16082: my $prefix=$$crsudom.'_'.$$crsunum.'.0.';
16083: my %defaults = (
16084: buttonshide => { value => 'yes',
16085: type => 'string_yesno',},
16086: type => { value => 'randomizetry',
16087: type => 'string_questiontype',},
16088: maxtries => { value => 1,
16089: type => 'int_pos',},
16090: problemstatus => { value => 'no',
16091: type => 'string_problemstatus',},
16092: );
16093: foreach my $key (keys(%defaults)) {
16094: $storecontent{$prefix.$key} = $defaults{$key}{'value'};
16095: $storecontent{$prefix.$key.'.type'} = $defaults{$key}{'type'};
16096: }
1.1237 raeburn 16097: &Apache::lonnet::cput
16098: ('resourcedata',\%storecontent,$$crsudom,$$crsunum);
16099: }
16100:
1.566 albertel 16101: return (1,$outcome);
1.444 albertel 16102: }
16103:
1.1166 raeburn 16104: sub make_unique_code {
16105: my ($cdom,$cnum) = @_;
16106: # get lock on uniquecodes db
16107: my $lockhash = {
16108: $cnum."\0".'uniquecodes' => $env{'user.name'}.
16109: ':'.$env{'user.domain'},
16110: };
16111: my $tries = 0;
16112: my $gotlock = &Apache::lonnet::newput_dom('uniquecodes',$lockhash,$cdom);
16113: my ($code,$error);
16114:
16115: while (($gotlock ne 'ok') && ($tries<3)) {
16116: $tries ++;
16117: sleep 1;
16118: $gotlock = &Apache::lonnet::newput_dom('uniquecodes',$lockhash,$cdom);
16119: }
16120: if ($gotlock eq 'ok') {
16121: my %currcodes = &Apache::lonnet::dump_dom('uniquecodes',$cdom);
16122: my $gotcode;
16123: my $attempts = 0;
16124: while ((!$gotcode) && ($attempts < 100)) {
16125: $code = &generate_code();
16126: if (!exists($currcodes{$code})) {
16127: $gotcode = 1;
16128: unless (&Apache::lonnet::newput_dom('uniquecodes',{ $code => $cnum },$cdom) eq 'ok') {
16129: $error = 'nostore';
16130: }
16131: }
16132: $attempts ++;
16133: }
16134: my @del_lock = ($cnum."\0".'uniquecodes');
16135: my $dellockoutcome = &Apache::lonnet::del_dom('uniquecodes',\@del_lock,$cdom);
16136: } else {
16137: $error = 'nolock';
16138: }
16139: return ($code,$error);
16140: }
16141:
16142: sub generate_code {
16143: my $code;
16144: my @letts = qw(B C D G H J K M N P Q R S T V W X Z);
16145: for (my $i=0; $i<6; $i++) {
16146: my $lettnum = int (rand 2);
16147: my $item = '';
16148: if ($lettnum) {
16149: $item = $letts[int( rand(18) )];
16150: } else {
16151: $item = 1+int( rand(8) );
16152: }
16153: $code .= $item;
16154: }
16155: return $code;
16156: }
16157:
1.444 albertel 16158: ############################################################
16159: ############################################################
16160:
1.1237 raeburn 16161: # Community, Course and Placement Test
1.378 raeburn 16162: sub course_type {
16163: my ($cid) = @_;
16164: if (!defined($cid)) {
16165: $cid = $env{'request.course.id'};
16166: }
1.404 albertel 16167: if (defined($env{'course.'.$cid.'.type'})) {
16168: return $env{'course.'.$cid.'.type'};
1.378 raeburn 16169: } else {
16170: return 'Course';
1.377 raeburn 16171: }
16172: }
1.156 albertel 16173:
1.406 raeburn 16174: sub group_term {
16175: my $crstype = &course_type();
16176: my %names = (
16177: 'Course' => 'group',
1.865 raeburn 16178: 'Community' => 'group',
1.1237 raeburn 16179: 'Placement' => 'group',
1.406 raeburn 16180: );
16181: return $names{$crstype};
16182: }
16183:
1.902 raeburn 16184: sub course_types {
1.1237 raeburn 16185: my @types = ('official','unofficial','community','textbook','placement');
1.902 raeburn 16186: my %typename = (
16187: official => 'Official course',
16188: unofficial => 'Unofficial course',
16189: community => 'Community',
1.1165 raeburn 16190: textbook => 'Textbook course',
1.1237 raeburn 16191: placement => 'Placement test',
1.902 raeburn 16192: );
16193: return (\@types,\%typename);
16194: }
16195:
1.156 albertel 16196: sub icon {
16197: my ($file)=@_;
1.505 albertel 16198: my $curfext = lc((split(/\./,$file))[-1]);
1.168 albertel 16199: my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156 albertel 16200: my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168 albertel 16201: if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
16202: if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
16203: $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
16204: $curfext.".gif") {
16205: $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
16206: $curfext.".gif";
16207: }
16208: }
1.249 albertel 16209: return &lonhttpdurl($iconname);
1.154 albertel 16210: }
1.84 albertel 16211:
1.575 albertel 16212: sub lonhttpdurl {
1.692 www 16213: #
16214: # Had been used for "small fry" static images on separate port 8080.
16215: # Modify here if lightweight http functionality desired again.
16216: # Currently eliminated due to increasing firewall issues.
16217: #
1.575 albertel 16218: my ($url)=@_;
1.692 www 16219: return $url;
1.215 albertel 16220: }
16221:
1.213 albertel 16222: sub connection_aborted {
16223: my ($r)=@_;
16224: $r->print(" ");$r->rflush();
16225: my $c = $r->connection;
16226: return $c->aborted();
16227: }
16228:
1.221 foxr 16229: # Escapes strings that may have embedded 's that will be put into
1.222 foxr 16230: # strings as 'strings'.
16231: sub escape_single {
1.221 foxr 16232: my ($input) = @_;
1.223 albertel 16233: $input =~ s/\\/\\\\/g; # Escape the \'s..(must be first)>
1.221 foxr 16234: $input =~ s/\'/\\\'/g; # Esacpe the 's....
16235: return $input;
16236: }
1.223 albertel 16237:
1.222 foxr 16238: # Same as escape_single, but escape's "'s This
16239: # can be used for "strings"
16240: sub escape_double {
16241: my ($input) = @_;
16242: $input =~ s/\\/\\\\/g; # Escape the /'s..(must be first)>
16243: $input =~ s/\"/\\\"/g; # Esacpe the "s....
16244: return $input;
16245: }
1.223 albertel 16246:
1.222 foxr 16247: # Escapes the last element of a full URL.
16248: sub escape_url {
16249: my ($url) = @_;
1.238 raeburn 16250: my @urlslices = split(/\//, $url,-1);
1.369 www 16251: my $lastitem = &escape(pop(@urlslices));
1.1203 raeburn 16252: return &HTML::Entities::encode(join('/',@urlslices),"'").'/'.$lastitem;
1.222 foxr 16253: }
1.462 albertel 16254:
1.820 raeburn 16255: sub compare_arrays {
16256: my ($arrayref1,$arrayref2) = @_;
16257: my (@difference,%count);
16258: @difference = ();
16259: %count = ();
16260: if ((ref($arrayref1) eq 'ARRAY') && (ref($arrayref2) eq 'ARRAY')) {
16261: foreach my $element (@{$arrayref1}, @{$arrayref2}) { $count{$element}++; }
16262: foreach my $element (keys(%count)) {
16263: if ($count{$element} == 1) {
16264: push(@difference,$element);
16265: }
16266: }
16267: }
16268: return @difference;
16269: }
16270:
1.817 bisitz 16271: # -------------------------------------------------------- Initialize user login
1.462 albertel 16272: sub init_user_environment {
1.463 albertel 16273: my ($r, $username, $domain, $authhost, $form, $args) = @_;
1.462 albertel 16274: my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
16275:
16276: my $public=($username eq 'public' && $domain eq 'public');
16277:
1.1062 raeburn 16278: my ($filename,$cookie,$userroles,$firstaccenv,$timerintenv);
1.462 albertel 16279: my $now=time;
16280:
16281: if ($public) {
16282: my $max_public=100;
16283: my $oldest;
16284: my $oldest_time=0;
16285: for(my $next=1;$next<=$max_public;$next++) {
16286: if (-e $lonids."/publicuser_$next.id") {
16287: my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
16288: if ($mtime<$oldest_time || !$oldest_time) {
16289: $oldest_time=$mtime;
16290: $oldest=$next;
16291: }
16292: } else {
16293: $cookie="publicuser_$next";
16294: last;
16295: }
16296: }
16297: if (!$cookie) { $cookie="publicuser_$oldest"; }
16298: } else {
1.1275 raeburn 16299: # See if old ID present, if so, remove if this isn't a robot,
16300: # killing any existing non-robot sessions
1.463 albertel 16301: if (!$args->{'robot'}) {
16302: opendir(DIR,$lonids);
16303: while ($filename=readdir(DIR)) {
16304: if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
1.1295 raeburn 16305: if ($ENV{'SERVER_PORT'} == 443) {
16306: my $linkedfile;
16307: if (tie(my %oldenv,'GDBM_File',"$lonids/$cookie.id",
16308: &GDBM_READER(),0640)) {
16309: if (exists($oldenv{'user.linkedenv'})) {
16310: $linkedfile = $oldenv{'user.linkedenv'};
16311: }
16312: untie(%oldenv);
16313: }
16314: if (unlink($lonids.'/'.$filename)) {
16315: if ($linkedfile =~ /^[a-f0-9]+_linked\.id$/) {
16316: unlink($lonids.'/'.$linkedfile);
16317: }
16318: }
16319: } else {
16320: unlink($lonids.'/'.$filename);
16321: }
1.463 albertel 16322: }
1.462 albertel 16323: }
1.463 albertel 16324: closedir(DIR);
1.1204 raeburn 16325: # If there is a undeleted lockfile for the user's paste buffer remove it.
16326: my $namespace = 'nohist_courseeditor';
16327: my $lockingkey = 'paste'."\0".'locked_num';
16328: my %lockhash = &Apache::lonnet::get($namespace,[$lockingkey],
16329: $domain,$username);
16330: if (exists($lockhash{$lockingkey})) {
16331: my $delresult = &Apache::lonnet::del($namespace,[$lockingkey],$domain,$username);
16332: unless ($delresult eq 'ok') {
16333: &Apache::lonnet::logthis("Failed to delete paste buffer locking key in $namespace for ".$username.":".$domain." Result was: $delresult");
16334: }
16335: }
1.462 albertel 16336: }
16337: # Give them a new cookie
1.463 albertel 16338: my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
1.684 www 16339: : $now.$$.int(rand(10000)));
1.463 albertel 16340: $cookie="$username\_$id\_$domain\_$authhost";
1.462 albertel 16341:
16342: # Initialize roles
16343:
1.1062 raeburn 16344: ($userroles,$firstaccenv,$timerintenv) =
16345: &Apache::lonnet::rolesinit($domain,$username,$authhost);
1.462 albertel 16346: }
16347: # ------------------------------------ Check browser type and MathML capability
16348:
1.1194 raeburn 16349: my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,$clientunicode,
16350: $clientos,$clientmobile,$clientinfo,$clientosversion) = &decode_user_agent($r);
1.462 albertel 16351:
16352: # ------------------------------------------------------------- Get environment
16353:
16354: my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
16355: my ($tmp) = keys(%userenv);
1.1275 raeburn 16356: if ($tmp =~ /^(con_lost|error|no_such_host)/i) {
1.462 albertel 16357: undef(%userenv);
16358: }
16359: if (($userenv{'interface'}) && (!$form->{'interface'})) {
16360: $form->{'interface'}=$userenv{'interface'};
16361: }
16362: if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
16363:
16364: # --------------- Do not trust query string to be put directly into environment
1.817 bisitz 16365: foreach my $option ('interface','localpath','localres') {
16366: $form->{$option}=~s/[\n\r\=]//gs;
1.462 albertel 16367: }
16368: # --------------------------------------------------------- Write first profile
16369:
16370: {
16371: my %initial_env =
16372: ("user.name" => $username,
16373: "user.domain" => $domain,
16374: "user.home" => $authhost,
16375: "browser.type" => $clientbrowser,
16376: "browser.version" => $clientversion,
16377: "browser.mathml" => $clientmathml,
16378: "browser.unicode" => $clientunicode,
16379: "browser.os" => $clientos,
1.1137 raeburn 16380: "browser.mobile" => $clientmobile,
1.1141 raeburn 16381: "browser.info" => $clientinfo,
1.1194 raeburn 16382: "browser.osversion" => $clientosversion,
1.462 albertel 16383: "server.domain" => $Apache::lonnet::perlvar{'lonDefDomain'},
16384: "request.course.fn" => '',
16385: "request.course.uri" => '',
16386: "request.course.sec" => '',
16387: "request.role" => 'cm',
16388: "request.role.adv" => $env{'user.adv'},
16389: "request.host" => $ENV{'REMOTE_ADDR'},);
16390:
16391: if ($form->{'localpath'}) {
16392: $initial_env{"browser.localpath"} = $form->{'localpath'};
16393: $initial_env{"browser.localres"} = $form->{'localres'};
16394: }
16395:
16396: if ($form->{'interface'}) {
16397: $form->{'interface'}=~s/\W//gs;
16398: $initial_env{"browser.interface"} = $form->{'interface'};
16399: $env{'browser.interface'}=$form->{'interface'};
16400: }
16401:
1.1157 raeburn 16402: if ($form->{'iptoken'}) {
16403: my $lonhost = $r->dir_config('lonHostID');
16404: $initial_env{"user.noloadbalance"} = $lonhost;
16405: $env{'user.noloadbalance'} = $lonhost;
16406: }
16407:
1.1268 raeburn 16408: if ($form->{'noloadbalance'}) {
16409: my @hosts = &Apache::lonnet::current_machine_ids();
16410: my $hosthere = $form->{'noloadbalance'};
16411: if (grep(/^\Q$hosthere\E$/,@hosts)) {
16412: $initial_env{"user.noloadbalance"} = $hosthere;
16413: $env{'user.noloadbalance'} = $hosthere;
16414: }
16415: }
16416:
1.1016 raeburn 16417: unless ($domain eq 'public') {
1.1273 raeburn 16418: my %is_adv = ( is_adv => $env{'user.adv'} );
16419: my %domdef = &Apache::lonnet::get_domain_defaults($domain);
16420:
16421: foreach my $tool ('aboutme','blog','webdav','portfolio') {
16422: $userenv{'availabletools.'.$tool} =
16423: &Apache::lonnet::usertools_access($username,$domain,$tool,'reload',
16424: undef,\%userenv,\%domdef,\%is_adv);
16425: }
1.980 raeburn 16426:
1.1273 raeburn 16427: foreach my $crstype ('official','unofficial','community','textbook','placement') {
16428: $userenv{'canrequest.'.$crstype} =
16429: &Apache::lonnet::usertools_access($username,$domain,$crstype,
16430: 'reload','requestcourses',
16431: \%userenv,\%domdef,\%is_adv);
16432: }
1.724 raeburn 16433:
1.1273 raeburn 16434: $userenv{'canrequest.author'} =
16435: &Apache::lonnet::usertools_access($username,$domain,'requestauthor',
16436: 'reload','requestauthor',
1.980 raeburn 16437: \%userenv,\%domdef,\%is_adv);
1.1273 raeburn 16438: my %reqauthor = &Apache::lonnet::get('requestauthor',['author_status','author'],
16439: $domain,$username);
16440: my $reqstatus = $reqauthor{'author_status'};
16441: if ($reqstatus eq 'approval' || $reqstatus eq 'approved') {
16442: if (ref($reqauthor{'author'}) eq 'HASH') {
16443: $userenv{'requestauthorqueued'} = $reqstatus.':'.
16444: $reqauthor{'author'}{'timestamp'};
16445: }
1.1092 raeburn 16446: }
1.1287 raeburn 16447: my ($types,$typename) = &course_types();
16448: if (ref($types) eq 'ARRAY') {
16449: my @options = ('approval','validate','autolimit');
16450: my $optregex = join('|',@options);
16451: my (%willtrust,%trustchecked);
16452: foreach my $type (@{$types}) {
16453: my $dom_str = $env{'environment.reqcrsotherdom.'.$type};
16454: if ($dom_str ne '') {
16455: my $updatedstr = '';
16456: my @possdomains = split(',',$dom_str);
16457: foreach my $entry (@possdomains) {
16458: my ($extdom,$extopt) = split(':',$entry);
16459: unless ($trustchecked{$extdom}) {
16460: $willtrust{$extdom} = &Apache::lonnet::will_trust('reqcrs',$domain,$extdom);
16461: $trustchecked{$extdom} = 1;
16462: }
16463: if ($willtrust{$extdom}) {
16464: $updatedstr .= $entry.',';
16465: }
16466: }
16467: $updatedstr =~ s/,$//;
16468: if ($updatedstr) {
16469: $userenv{'reqcrsotherdom.'.$type} = $updatedstr;
16470: } else {
16471: delete($userenv{'reqcrsotherdom.'.$type});
16472: }
16473: }
16474: }
16475: }
1.1092 raeburn 16476: }
1.462 albertel 16477: $env{'user.environment'} = "$lonids/$cookie.id";
1.1062 raeburn 16478:
1.462 albertel 16479: if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
16480: &GDBM_WRCREAT(),0640)) {
16481: &_add_to_env(\%disk_env,\%initial_env);
16482: &_add_to_env(\%disk_env,\%userenv,'environment.');
16483: &_add_to_env(\%disk_env,$userroles);
1.1062 raeburn 16484: if (ref($firstaccenv) eq 'HASH') {
16485: &_add_to_env(\%disk_env,$firstaccenv);
16486: }
16487: if (ref($timerintenv) eq 'HASH') {
16488: &_add_to_env(\%disk_env,$timerintenv);
16489: }
1.463 albertel 16490: if (ref($args->{'extra_env'})) {
16491: &_add_to_env(\%disk_env,$args->{'extra_env'});
16492: }
1.462 albertel 16493: untie(%disk_env);
16494: } else {
1.705 tempelho 16495: &Apache::lonnet::logthis("<span style=\"color:blue;\">WARNING: ".
16496: 'Could not create environment storage in lonauth: '.$!.'</span>');
1.462 albertel 16497: return 'error: '.$!;
16498: }
16499: }
16500: $env{'request.role'}='cm';
16501: $env{'request.role.adv'}=$env{'user.adv'};
16502: $env{'browser.type'}=$clientbrowser;
16503:
16504: return $cookie;
16505:
16506: }
16507:
16508: sub _add_to_env {
16509: my ($idf,$env_data,$prefix) = @_;
1.676 raeburn 16510: if (ref($env_data) eq 'HASH') {
16511: while (my ($key,$value) = each(%$env_data)) {
16512: $idf->{$prefix.$key} = $value;
16513: $env{$prefix.$key} = $value;
16514: }
1.462 albertel 16515: }
16516: }
16517:
1.685 tempelho 16518: # --- Get the symbolic name of a problem and the url
16519: sub get_symb {
16520: my ($request,$silent) = @_;
1.726 raeburn 16521: (my $url=$env{'form.url'}) =~ s-^https?\://($ENV{'SERVER_NAME'}|$ENV{'HTTP_HOST'})--;
1.685 tempelho 16522: my $symb=($env{'form.symb'} ne '' ? $env{'form.symb'} : (&Apache::lonnet::symbread($url)));
16523: if ($symb eq '') {
16524: if (!$silent) {
1.1071 raeburn 16525: if (ref($request)) {
16526: $request->print("Unable to handle ambiguous references:$url:.");
16527: }
1.685 tempelho 16528: return ();
16529: }
16530: }
16531: &Apache::lonenc::check_decrypt(\$symb);
16532: return ($symb);
16533: }
16534:
16535: # --------------------------------------------------------------Get annotation
16536:
16537: sub get_annotation {
16538: my ($symb,$enc) = @_;
16539:
16540: my $key = $symb;
16541: if (!$enc) {
16542: $key =
16543: &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]);
16544: }
16545: my %annotation=&Apache::lonnet::get('nohist_annotations',[$key]);
16546: return $annotation{$key};
16547: }
16548:
16549: sub clean_symb {
1.731 raeburn 16550: my ($symb,$delete_enc) = @_;
1.685 tempelho 16551:
16552: &Apache::lonenc::check_decrypt(\$symb);
16553: my $enc = $env{'request.enc'};
1.731 raeburn 16554: if ($delete_enc) {
1.730 raeburn 16555: delete($env{'request.enc'});
16556: }
1.685 tempelho 16557:
16558: return ($symb,$enc);
16559: }
1.462 albertel 16560:
1.1181 raeburn 16561: ############################################################
16562: ############################################################
16563:
16564: =pod
16565:
16566: =head1 Routines for building display used to search for courses
16567:
16568:
16569: =over 4
16570:
16571: =item * &build_filters()
16572:
16573: Create markup for a table used to set filters to use when selecting
1.1182 raeburn 16574: courses in a domain. Used by lonpickcourse.pm, lonmodifycourse.pm
16575: and quotacheck.pl
16576:
1.1181 raeburn 16577:
16578: Inputs:
16579:
16580: filterlist - anonymous array of fields to include as potential filters
16581:
16582: crstype - course type
16583:
16584: roleelement - fifth arg in selectcourse_link() populates fifth arg in javascript: opencrsbrowser() function, used
16585: to pop-open a course selector (will contain "extra element").
16586:
16587: multelement - if multiple course selections will be allowed, this will be a hidden form element: name: multiple; value: 1
16588:
16589: filter - anonymous hash of criteria and their values
16590:
16591: action - form action
16592:
16593: numfiltersref - ref to scalar (count of number of elements in institutional codes -- e.g., 4 for year, semester, department, and number)
16594:
1.1182 raeburn 16595: caller - caller context (e.g., set to 'modifycourse' when routine is called from lonmodifycourse.pm)
1.1181 raeburn 16596:
16597: cloneruname - username of owner of new course who wants to clone
16598:
16599: clonerudom - domain of owner of new course who wants to clone
16600:
16601: typeelem - text to use for left column in row containing course type (i.e., Course, Community or Course/Community)
16602:
16603: codetitlesref - reference to array of titles of components in institutional codes (official courses)
16604:
16605: codedom - domain
16606:
16607: formname - value of form element named "form".
16608:
16609: fixeddom - domain, if fixed.
16610:
16611: prevphase - value to assign to form element named "phase" when going back to the previous screen
16612:
16613: cnameelement - name of form element in form on opener page which will receive title of selected course
16614:
16615: cnumelement - name of form element in form on opener page which will receive courseID of selected course
16616:
16617: cdomelement - name of form element in form on opener page which will receive domain of selected course
16618:
16619: setroles - includes access constraint identifier when setting a roles-based condition for acces to a portfolio file
16620:
16621: clonetext - hidden form elements containing list of courses cloneable by intended course owner when DC creates a course
16622:
16623: clonewarning - warning message about missing information for intended course owner when DC creates a course
16624:
1.1182 raeburn 16625:
1.1181 raeburn 16626: Returns: $output - HTML for display of search criteria, and hidden form elements.
16627:
1.1182 raeburn 16628:
1.1181 raeburn 16629: Side Effects: None
16630:
16631: =cut
16632:
16633: # ---------------------------------------------- search for courses based on last activity etc.
16634:
16635: sub build_filters {
16636: my ($filterlist,$crstype,$roleelement,$multelement,$filter,$action,
16637: $numtitlesref,$caller,$cloneruname,$clonerudom,$typeelement,
16638: $codetitlesref,$codedom,$formname,$fixeddom,$prevphase,
16639: $cnameelement,$cnumelement,$cdomelement,$setroles,
16640: $clonetext,$clonewarning) = @_;
1.1182 raeburn 16641: my ($list,$jscript);
1.1181 raeburn 16642: my $onchange = 'javascript:updateFilters(this)';
16643: my ($domainselectform,$sincefilterform,$createdfilterform,
16644: $ownerdomselectform,$persondomselectform,$instcodeform,
16645: $typeselectform,$instcodetitle);
16646: if ($formname eq '') {
16647: $formname = $caller;
16648: }
16649: foreach my $item (@{$filterlist}) {
16650: unless (($item eq 'descriptfilter') || ($item eq 'instcodefilter') ||
16651: ($item eq 'sincefilter') || ($item eq 'createdfilter')) {
16652: if ($item eq 'domainfilter') {
16653: $filter->{$item} = &LONCAPA::clean_domain($filter->{$item});
16654: } elsif ($item eq 'coursefilter') {
16655: $filter->{$item} = &LONCAPA::clean_courseid($filter->{$item});
16656: } elsif ($item eq 'ownerfilter') {
16657: $filter->{$item} = &LONCAPA::clean_username($filter->{$item});
16658: } elsif ($item eq 'ownerdomfilter') {
16659: $filter->{'ownerdomfilter'} =
16660: &LONCAPA::clean_domain($filter->{$item});
16661: $ownerdomselectform = &select_dom_form($filter->{'ownerdomfilter'},
16662: 'ownerdomfilter',1);
16663: } elsif ($item eq 'personfilter') {
16664: $filter->{$item} = &LONCAPA::clean_username($filter->{$item});
16665: } elsif ($item eq 'persondomfilter') {
16666: $persondomselectform = &select_dom_form($filter->{'persondomfilter'},
16667: 'persondomfilter',1);
16668: } else {
16669: $filter->{$item} =~ s/\W//g;
16670: }
16671: if (!$filter->{$item}) {
16672: $filter->{$item} = '';
16673: }
16674: }
16675: if ($item eq 'domainfilter') {
16676: my $allow_blank = 1;
16677: if ($formname eq 'portform') {
16678: $allow_blank=0;
16679: } elsif ($formname eq 'studentform') {
16680: $allow_blank=0;
16681: }
16682: if ($fixeddom) {
16683: $domainselectform = '<input type="hidden" name="domainfilter"'.
16684: ' value="'.$codedom.'" />'.
16685: &Apache::lonnet::domain($codedom,'description');
16686: } else {
16687: $domainselectform = &select_dom_form($filter->{$item},
16688: 'domainfilter',
16689: $allow_blank,'',$onchange);
16690: }
16691: } else {
16692: $list->{$item} = &HTML::Entities::encode($filter->{$item},'<>&"');
16693: }
16694: }
16695:
16696: # last course activity filter and selection
16697: $sincefilterform = &timebased_select_form('sincefilter',$filter);
16698:
16699: # course created filter and selection
16700: if (exists($filter->{'createdfilter'})) {
16701: $createdfilterform = &timebased_select_form('createdfilter',$filter);
16702: }
16703:
1.1239 raeburn 16704: my $prefix = $crstype;
16705: if ($crstype eq 'Placement') {
16706: $prefix = 'Placement Test'
16707: }
1.1181 raeburn 16708: my %lt = &Apache::lonlocal::texthash(
1.1239 raeburn 16709: 'cac' => "$prefix Activity",
16710: 'ccr' => "$prefix Created",
16711: 'cde' => "$prefix Title",
16712: 'cdo' => "$prefix Domain",
1.1181 raeburn 16713: 'ins' => 'Institutional Code',
16714: 'inc' => 'Institutional Categorization',
1.1239 raeburn 16715: 'cow' => "$prefix Owner/Co-owner",
16716: 'cop' => "$prefix Personnel Includes",
1.1181 raeburn 16717: 'cog' => 'Type',
16718: );
16719:
16720: if (($formname eq 'ccrs') || ($formname eq 'requestcrs')) {
16721: my $typeval = 'Course';
16722: if ($crstype eq 'Community') {
16723: $typeval = 'Community';
1.1239 raeburn 16724: } elsif ($crstype eq 'Placement') {
16725: $typeval = 'Placement';
1.1181 raeburn 16726: }
16727: $typeselectform = '<input type="hidden" name="type" value="'.$typeval.'" />';
16728: } else {
16729: $typeselectform = '<select name="type" size="1"';
16730: if ($onchange) {
16731: $typeselectform .= ' onchange="'.$onchange.'"';
16732: }
16733: $typeselectform .= '>'."\n";
1.1237 raeburn 16734: foreach my $posstype ('Course','Community','Placement') {
1.1239 raeburn 16735: my $shown;
16736: if ($posstype eq 'Placement') {
16737: $shown = &mt('Placement Test');
16738: } else {
16739: $shown = &mt($posstype);
16740: }
1.1181 raeburn 16741: $typeselectform.='<option value="'.$posstype.'"'.
1.1239 raeburn 16742: ($posstype eq $crstype ? ' selected="selected" ' : ''). ">".$shown."</option>\n";
1.1181 raeburn 16743: }
16744: $typeselectform.="</select>";
16745: }
16746:
16747: my ($cloneableonlyform,$cloneabletitle);
16748: if (exists($filter->{'cloneableonly'})) {
16749: my $cloneableon = '';
16750: my $cloneableoff = ' checked="checked"';
16751: if ($filter->{'cloneableonly'}) {
16752: $cloneableon = $cloneableoff;
16753: $cloneableoff = '';
16754: }
16755: $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>';
16756: if ($formname eq 'ccrs') {
1.1187 bisitz 16757: $cloneabletitle = &mt('Cloneable for [_1]',$cloneruname.':'.$clonerudom);
1.1181 raeburn 16758: } else {
16759: $cloneabletitle = &mt('Cloneable by you');
16760: }
16761: }
16762: my $officialjs;
16763: if ($crstype eq 'Course') {
16764: if (exists($filter->{'instcodefilter'})) {
1.1182 raeburn 16765: # if (($fixeddom) || ($formname eq 'requestcrs') ||
16766: # ($formname eq 'modifycourse') || ($formname eq 'filterpicker')) {
16767: if ($codedom) {
1.1181 raeburn 16768: $officialjs = 1;
16769: ($instcodeform,$jscript,$$numtitlesref) =
16770: &Apache::courseclassifier::instcode_selectors($codedom,'filterpicker',
16771: $officialjs,$codetitlesref);
16772: if ($jscript) {
1.1182 raeburn 16773: $jscript = '<script type="text/javascript">'."\n".
16774: '// <![CDATA['."\n".
16775: $jscript."\n".
16776: '// ]]>'."\n".
16777: '</script>'."\n";
1.1181 raeburn 16778: }
16779: }
16780: if ($instcodeform eq '') {
16781: $instcodeform =
16782: '<input type="text" name="instcodefilter" size="10" value="'.
16783: $list->{'instcodefilter'}.'" />';
16784: $instcodetitle = $lt{'ins'};
16785: } else {
16786: $instcodetitle = $lt{'inc'};
16787: }
16788: if ($fixeddom) {
16789: $instcodetitle .= '<br />('.$codedom.')';
16790: }
16791: }
16792: }
16793: my $output = qq|
16794: <form method="post" name="filterpicker" action="$action">
16795: <input type="hidden" name="form" value="$formname" />
16796: |;
16797: if ($formname eq 'modifycourse') {
16798: $output .= '<input type="hidden" name="phase" value="courselist" />'."\n".
16799: '<input type="hidden" name="prevphase" value="'.
16800: $prevphase.'" />'."\n";
1.1198 musolffc 16801: } elsif ($formname eq 'quotacheck') {
16802: $output .= qq|
16803: <input type="hidden" name="sortby" value="" />
16804: <input type="hidden" name="sortorder" value="" />
16805: |;
16806: } else {
1.1181 raeburn 16807: my $name_input;
16808: if ($cnameelement ne '') {
16809: $name_input = '<input type="hidden" name="cnameelement" value="'.
16810: $cnameelement.'" />';
16811: }
16812: $output .= qq|
1.1182 raeburn 16813: <input type="hidden" name="cnumelement" value="$cnumelement" />
16814: <input type="hidden" name="cdomelement" value="$cdomelement" />
1.1181 raeburn 16815: $name_input
16816: $roleelement
16817: $multelement
16818: $typeelement
16819: |;
16820: if ($formname eq 'portform') {
16821: $output .= '<input type="hidden" name="setroles" value="'.$setroles.'" />'."\n";
16822: }
16823: }
16824: if ($fixeddom) {
16825: $output .= '<input type="hidden" name="fixeddom" value="'.$fixeddom.'" />'."\n";
16826: }
16827: $output .= "<br />\n".&Apache::lonhtmlcommon::start_pick_box();
16828: if ($sincefilterform) {
16829: $output .= &Apache::lonhtmlcommon::row_title($lt{'cac'})
16830: .$sincefilterform
16831: .&Apache::lonhtmlcommon::row_closure();
16832: }
16833: if ($createdfilterform) {
16834: $output .= &Apache::lonhtmlcommon::row_title($lt{'ccr'})
16835: .$createdfilterform
16836: .&Apache::lonhtmlcommon::row_closure();
16837: }
16838: if ($domainselectform) {
16839: $output .= &Apache::lonhtmlcommon::row_title($lt{'cdo'})
16840: .$domainselectform
16841: .&Apache::lonhtmlcommon::row_closure();
16842: }
16843: if ($typeselectform) {
16844: if (($formname eq 'ccrs') || ($formname eq 'requestcrs')) {
16845: $output .= $typeselectform;
16846: } else {
16847: $output .= &Apache::lonhtmlcommon::row_title($lt{'cog'})
16848: .$typeselectform
16849: .&Apache::lonhtmlcommon::row_closure();
16850: }
16851: }
16852: if ($instcodeform) {
16853: $output .= &Apache::lonhtmlcommon::row_title($instcodetitle)
16854: .$instcodeform
16855: .&Apache::lonhtmlcommon::row_closure();
16856: }
16857: if (exists($filter->{'ownerfilter'})) {
16858: $output .= &Apache::lonhtmlcommon::row_title($lt{'cow'}).
16859: '<table><tr><td>'.&mt('Username').'<br />'.
16860: '<input type="text" name="ownerfilter" size="20" value="'.
16861: $list->{'ownerfilter'}.'" /></td><td>'.&mt('Domain').'<br />'.
16862: $ownerdomselectform.'</td></tr></table>'.
16863: &Apache::lonhtmlcommon::row_closure();
16864: }
16865: if (exists($filter->{'personfilter'})) {
16866: $output .= &Apache::lonhtmlcommon::row_title($lt{'cop'}).
16867: '<table><tr><td>'.&mt('Username').'<br />'.
16868: '<input type="text" name="personfilter" size="20" value="'.
16869: $list->{'personfilter'}.'" /></td><td>'.&mt('Domain').'<br />'.
16870: $persondomselectform.'</td></tr></table>'.
16871: &Apache::lonhtmlcommon::row_closure();
16872: }
16873: if (exists($filter->{'coursefilter'})) {
16874: $output .= &Apache::lonhtmlcommon::row_title(&mt('LON-CAPA course ID'))
16875: .'<input type="text" name="coursefilter" size="25" value="'
16876: .$list->{'coursefilter'}.'" />'
16877: .&Apache::lonhtmlcommon::row_closure();
16878: }
16879: if ($cloneableonlyform) {
16880: $output .= &Apache::lonhtmlcommon::row_title($cloneabletitle).
16881: $cloneableonlyform.&Apache::lonhtmlcommon::row_closure();
16882: }
16883: if (exists($filter->{'descriptfilter'})) {
16884: $output .= &Apache::lonhtmlcommon::row_title($lt{'cde'})
16885: .'<input type="text" name="descriptfilter" size="40" value="'
16886: .$list->{'descriptfilter'}.'" />'
16887: .&Apache::lonhtmlcommon::row_closure(1);
16888: }
16889: $output .= &Apache::lonhtmlcommon::end_pick_box().'<p>'.$clonetext."\n".
16890: '<input type="hidden" name="updater" value="" />'."\n".
16891: '<input type="submit" name="gosearch" value="'.
16892: &mt('Search').'" /></p>'."\n".'</form>'."\n".'<hr />'."\n";
16893: return $jscript.$clonewarning.$output;
16894: }
16895:
16896: =pod
16897:
16898: =item * &timebased_select_form()
16899:
1.1182 raeburn 16900: Create markup for a dropdown list used to select a time-based
1.1181 raeburn 16901: filter e.g., Course Activity, Course Created, when searching for courses
16902: or communities
16903:
16904: Inputs:
16905:
16906: item - name of form element (sincefilter or createdfilter)
16907:
16908: filter - anonymous hash of criteria and their values
16909:
16910: Returns: HTML for a select box contained a blank, then six time selections,
16911: with value set in incoming form variables currently selected.
16912:
16913: Side Effects: None
16914:
16915: =cut
16916:
16917: sub timebased_select_form {
16918: my ($item,$filter) = @_;
16919: if (ref($filter) eq 'HASH') {
16920: $filter->{$item} =~ s/[^\d-]//g;
16921: if (!$filter->{$item}) { $filter->{$item}=-1; }
16922: return &select_form(
16923: $filter->{$item},
16924: $item,
16925: { '-1' => '',
16926: '86400' => &mt('today'),
16927: '604800' => &mt('last week'),
16928: '2592000' => &mt('last month'),
16929: '7776000' => &mt('last three months'),
16930: '15552000' => &mt('last six months'),
16931: '31104000' => &mt('last year'),
16932: 'select_form_order' =>
16933: ['-1','86400','604800','2592000','7776000',
16934: '15552000','31104000']});
16935: }
16936: }
16937:
16938: =pod
16939:
16940: =item * &js_changer()
16941:
16942: Create script tag containing Javascript used to submit course search form
1.1183 raeburn 16943: when course type or domain is changed, and also to hide 'Searching ...' on
16944: page load completion for page showing search result.
1.1181 raeburn 16945:
16946: Inputs: None
16947:
1.1183 raeburn 16948: Returns: markup containing updateFilters() and hideSearching() javascript functions.
1.1181 raeburn 16949:
16950: Side Effects: None
16951:
16952: =cut
16953:
16954: sub js_changer {
16955: return <<ENDJS;
16956: <script type="text/javascript">
16957: // <![CDATA[
16958: function updateFilters(caller) {
16959: if (typeof(caller) != "undefined") {
16960: document.filterpicker.updater.value = caller.name;
16961: }
16962: document.filterpicker.submit();
16963: }
1.1183 raeburn 16964:
16965: function hideSearching() {
16966: if (document.getElementById('searching')) {
16967: document.getElementById('searching').style.display = 'none';
16968: }
16969: return;
16970: }
16971:
1.1181 raeburn 16972: // ]]>
16973: </script>
16974:
16975: ENDJS
16976: }
16977:
16978: =pod
16979:
1.1182 raeburn 16980: =item * &search_courses()
16981:
16982: Process selected filters form course search form and pass to lonnet::courseiddump
16983: to retrieve a hash for which keys are courseIDs which match the selected filters.
16984:
16985: Inputs:
16986:
16987: dom - domain being searched
16988:
16989: type - course type ('Course' or 'Community' or '.' if any).
16990:
16991: filter - anonymous hash of criteria and their values
16992:
16993: numtitles - for institutional codes - number of categories
16994:
16995: cloneruname - optional username of new course owner
16996:
16997: clonerudom - optional domain of new course owner
16998:
1.1221 raeburn 16999: domcloner - optional "domcloner" flag; has value=1 if user has ccc priv in domain being filtered by,
1.1182 raeburn 17000: (used when DC is using course creation form)
17001:
17002: codetitles - reference to array of titles of components in institutional codes (official courses).
17003:
1.1221 raeburn 17004: cc_clone - escaped comma separated list of courses for which course cloner has active CC role
17005: (and so can clone automatically)
17006:
17007: reqcrsdom - domain of new course, where search_courses is used to identify potential courses to clone
17008:
17009: reqinstcode - institutional code of new course, where search_courses is used to identify potential
17010: courses to clone
1.1182 raeburn 17011:
17012: Returns: %courses - hash of courses satisfying search criteria, keys = course IDs, values are corresponding colon-separated escaped description, institutional code, owner and type.
17013:
17014:
17015: Side Effects: None
17016:
17017: =cut
17018:
17019:
17020: sub search_courses {
1.1221 raeburn 17021: my ($dom,$type,$filter,$numtitles,$cloneruname,$clonerudom,$domcloner,$codetitles,
17022: $cc_clone,$reqcrsdom,$reqinstcode) = @_;
1.1182 raeburn 17023: my (%courses,%showcourses,$cloner);
17024: if (($filter->{'ownerfilter'} ne '') ||
17025: ($filter->{'ownerdomfilter'} ne '')) {
17026: $filter->{'combownerfilter'} = $filter->{'ownerfilter'}.':'.
17027: $filter->{'ownerdomfilter'};
17028: }
17029: foreach my $item ('descriptfilter','coursefilter','combownerfilter') {
17030: if (!$filter->{$item}) {
17031: $filter->{$item}='.';
17032: }
17033: }
17034: my $now = time;
17035: my $timefilter =
17036: ($filter->{'sincefilter'}==-1?1:$now-$filter->{'sincefilter'});
17037: my ($createdbefore,$createdafter);
17038: if (($filter->{'createdfilter'} ne '') && ($filter->{'createdfilter'} !=-1)) {
17039: $createdbefore = $now;
17040: $createdafter = $now-$filter->{'createdfilter'};
17041: }
17042: my ($instcodefilter,$regexpok);
17043: if ($numtitles) {
17044: if ($env{'form.official'} eq 'on') {
17045: $instcodefilter =
17046: &Apache::courseclassifier::instcode_search_str($dom,$numtitles,$codetitles);
17047: $regexpok = 1;
17048: } elsif ($env{'form.official'} eq 'off') {
17049: $instcodefilter = &Apache::courseclassifier::instcode_search_str($dom,$numtitles,$codetitles);
17050: unless ($instcodefilter eq '') {
17051: $regexpok = -1;
17052: }
17053: }
17054: } else {
17055: $instcodefilter = $filter->{'instcodefilter'};
17056: }
17057: if ($instcodefilter eq '') { $instcodefilter = '.'; }
17058: if ($type eq '') { $type = '.'; }
17059:
17060: if (($clonerudom ne '') && ($cloneruname ne '')) {
17061: $cloner = $cloneruname.':'.$clonerudom;
17062: }
17063: %courses = &Apache::lonnet::courseiddump($dom,
17064: $filter->{'descriptfilter'},
17065: $timefilter,
17066: $instcodefilter,
17067: $filter->{'combownerfilter'},
17068: $filter->{'coursefilter'},
17069: undef,undef,$type,$regexpok,undef,undef,
1.1221 raeburn 17070: undef,undef,$cloner,$cc_clone,
1.1182 raeburn 17071: $filter->{'cloneableonly'},
17072: $createdbefore,$createdafter,undef,
1.1221 raeburn 17073: $domcloner,undef,$reqcrsdom,$reqinstcode);
1.1182 raeburn 17074: if (($filter->{'personfilter'} ne '') && ($filter->{'persondomfilter'} ne '')) {
17075: my $ccrole;
17076: if ($type eq 'Community') {
17077: $ccrole = 'co';
17078: } else {
17079: $ccrole = 'cc';
17080: }
17081: my %rolehash = &Apache::lonnet::get_my_roles($filter->{'personfilter'},
17082: $filter->{'persondomfilter'},
17083: 'userroles',undef,
17084: [$ccrole,'in','ad','ep','ta','cr'],
17085: $dom);
17086: foreach my $role (keys(%rolehash)) {
17087: my ($cnum,$cdom,$courserole) = split(':',$role);
17088: my $cid = $cdom.'_'.$cnum;
17089: if (exists($courses{$cid})) {
17090: if (ref($courses{$cid}) eq 'HASH') {
17091: if (ref($courses{$cid}{roles}) eq 'ARRAY') {
17092: if (!grep(/^\Q$courserole\E$/,@{$courses{$cid}{roles}})) {
1.1263 raeburn 17093: push(@{$courses{$cid}{roles}},$courserole);
1.1182 raeburn 17094: }
17095: } else {
17096: $courses{$cid}{roles} = [$courserole];
17097: }
17098: $showcourses{$cid} = $courses{$cid};
17099: }
17100: }
17101: }
17102: %courses = %showcourses;
17103: }
17104: return %courses;
17105: }
17106:
17107: =pod
17108:
1.1181 raeburn 17109: =back
17110:
1.1207 raeburn 17111: =head1 Routines for version requirements for current course.
17112:
17113: =over 4
17114:
17115: =item * &check_release_required()
17116:
17117: Compares required LON-CAPA version with version on server, and
17118: if required version is newer looks for a server with the required version.
17119:
17120: Looks first at servers in user's owen domain; if none suitable, looks at
17121: servers in course's domain are permitted to host sessions for user's domain.
17122:
17123: Inputs:
17124:
17125: $loncaparev - Version on current server (format: Major.Minor.Subrelease-datestamp)
17126:
17127: $courseid - Course ID of current course
17128:
17129: $rolecode - User's current role in course (for switchserver query string).
17130:
17131: $required - LON-CAPA version needed by course (format: Major.Minor).
17132:
17133:
17134: Returns:
17135:
17136: $switchserver - query string tp append to /adm/switchserver call (if
17137: current server's LON-CAPA version is too old.
17138:
17139: $warning - Message is displayed if no suitable server could be found.
17140:
17141: =cut
17142:
17143: sub check_release_required {
17144: my ($loncaparev,$courseid,$rolecode,$required) = @_;
17145: my ($switchserver,$warning);
17146: if ($required ne '') {
17147: my ($reqdmajor,$reqdminor) = ($required =~ /^(\d+)\.(\d+)$/);
17148: my ($major,$minor) = ($loncaparev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?$/);
17149: if ($reqdmajor ne '' && $reqdminor ne '') {
17150: my $otherserver;
17151: if (($major eq '' && $minor eq '') ||
17152: (($reqdmajor > $major) || (($reqdmajor == $major) && ($reqdminor > $minor)))) {
17153: my ($userdomserver) = &Apache::lonnet::choose_server($env{'user.domain'},undef,$required,1);
17154: my $switchlcrev =
17155: &Apache::lonnet::get_server_loncaparev($env{'user.domain'},
17156: $userdomserver);
17157: my ($swmajor,$swminor) = ($switchlcrev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?$/);
17158: if (($swmajor eq '' && $swminor eq '') || ($reqdmajor > $swmajor) ||
17159: (($reqdmajor == $swmajor) && ($reqdminor > $swminor))) {
17160: my $cdom = $env{'course.'.$courseid.'.domain'};
17161: if ($cdom ne $env{'user.domain'}) {
17162: my ($coursedomserver,$coursehostname) = &Apache::lonnet::choose_server($cdom,undef,$required,1);
17163: my $serverhomeID = &Apache::lonnet::get_server_homeID($coursehostname);
17164: my $serverhomedom = &Apache::lonnet::host_domain($serverhomeID);
17165: my %defdomdefaults = &Apache::lonnet::get_domain_defaults($serverhomedom);
17166: my %udomdefaults = &Apache::lonnet::get_domain_defaults($env{'user.domain'});
17167: my $remoterev = &Apache::lonnet::get_server_loncaparev($serverhomedom,$coursedomserver);
17168: my $canhost =
17169: &Apache::lonnet::can_host_session($env{'user.domain'},
17170: $coursedomserver,
17171: $remoterev,
17172: $udomdefaults{'remotesessions'},
17173: $defdomdefaults{'hostedsessions'});
17174:
17175: if ($canhost) {
17176: $otherserver = $coursedomserver;
17177: } else {
17178: $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.");
17179: }
17180: } else {
17181: $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).");
17182: }
17183: } else {
17184: $otherserver = $userdomserver;
17185: }
17186: }
17187: if ($otherserver ne '') {
17188: $switchserver = 'otherserver='.$otherserver.'&role='.$rolecode;
17189: }
17190: }
17191: }
17192: return ($switchserver,$warning);
17193: }
17194:
17195: =pod
17196:
17197: =item * &check_release_result()
17198:
17199: Inputs:
17200:
17201: $switchwarning - Warning message if no suitable server found to host session.
17202:
17203: $switchserver - query string to append to /adm/switchserver containing lonHostID
17204: and current role.
17205:
17206: Returns: HTML to display with information about requirement to switch server.
17207: Either displaying warning with link to Roles/Courses screen or
17208: display link to switchserver.
17209:
1.1181 raeburn 17210: =cut
17211:
1.1207 raeburn 17212: sub check_release_result {
17213: my ($switchwarning,$switchserver) = @_;
17214: my $output = &start_page('Selected course unavailable on this server').
17215: '<p class="LC_warning">';
17216: if ($switchwarning) {
17217: $output .= $switchwarning.'<br /><a href="/adm/roles">';
17218: if (&show_course()) {
17219: $output .= &mt('Display courses');
17220: } else {
17221: $output .= &mt('Display roles');
17222: }
17223: $output .= '</a>';
17224: } elsif ($switchserver) {
17225: $output .= &mt('This course requires a newer version of LON-CAPA than is installed on this server.').
17226: '<br />'.
17227: '<a href="/adm/switchserver?'.$switchserver.'">'.
17228: &mt('Switch Server').
17229: '</a>';
17230: }
17231: $output .= '</p>'.&end_page();
17232: return $output;
17233: }
17234:
17235: =pod
17236:
17237: =item * &needs_coursereinit()
17238:
17239: Determine if course contents stored for user's session needs to be
17240: refreshed, because content has changed since "Big Hash" last tied.
17241:
17242: Check for change is made if time last checked is more than 10 minutes ago
17243: (by default).
17244:
17245: Inputs:
17246:
17247: $loncaparev - Version on current server (format: Major.Minor.Subrelease-datestamp)
17248:
17249: $interval (optional) - Time which may elapse (in s) between last check for content
17250: change in current course. (default: 600 s).
17251:
17252: Returns: an array; first element is:
17253:
17254: =over 4
17255:
17256: 'switch' - if content updates mean user's session
17257: needs to be switched to a server running a newer LON-CAPA version
17258:
17259: 'update' - if course session needs to be refreshed (i.e., Big Hash needs to be reloaded)
17260: on current server hosting user's session
17261:
17262: '' - if no action required.
17263:
17264: =back
17265:
17266: If first item element is 'switch':
17267:
17268: second item is $switchwarning - Warning message if no suitable server found to host session.
17269:
17270: third item is $switchserver - query string to append to /adm/switchserver containing lonHostID
17271: and current role.
17272:
17273: otherwise: no other elements returned.
17274:
17275: =back
17276:
17277: =cut
17278:
17279: sub needs_coursereinit {
17280: my ($loncaparev,$interval) = @_;
17281: return() unless ($env{'request.course.id'} && $env{'request.course.tied'});
17282: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
17283: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
17284: my $now = time;
17285: if ($interval eq '') {
17286: $interval = 600;
17287: }
17288: if (($now-$env{'request.course.timechecked'})>$interval) {
1.1282 raeburn 17289: &Apache::lonnet::appenv({'request.course.timechecked'=>$now});
1.1283 raeburn 17290: my $blocked = &blocking_status('reinit',$cnum,$cdom,undef,1);
1.1282 raeburn 17291: if ($blocked) {
17292: return ();
17293: }
1.1207 raeburn 17294: my $lastchange = &Apache::lonnet::get_coursechange($cdom,$cnum);
17295: if ($lastchange > $env{'request.course.tied'}) {
17296: my %curr_reqd_hash = &Apache::lonnet::userenvironment($cdom,$cnum,'internal.releaserequired');
17297: if ($curr_reqd_hash{'internal.releaserequired'} ne '') {
17298: my $required = $env{'course.'.$cdom.'_'.$cnum.'.internal.releaserequired'};
17299: if ($curr_reqd_hash{'internal.releaserequired'} ne $required) {
17300: &Apache::lonnet::appenv({'course.'.$cdom.'_'.$cnum.'.internal.releaserequired' =>
17301: $curr_reqd_hash{'internal.releaserequired'}});
17302: my ($switchserver,$switchwarning) =
17303: &check_release_required($loncaparev,$cdom.'_'.$cnum,$env{'request.role'},
17304: $curr_reqd_hash{'internal.releaserequired'});
17305: if ($switchwarning ne '' || $switchserver ne '') {
17306: return ('switch',$switchwarning,$switchserver);
17307: }
17308: }
17309: }
17310: return ('update');
17311: }
17312: }
17313: return ();
17314: }
1.1181 raeburn 17315:
1.1083 raeburn 17316: sub update_content_constraints {
17317: my ($cdom,$cnum,$chome,$cid) = @_;
17318: my %curr_reqd_hash = &Apache::lonnet::userenvironment($cdom,$cnum,'internal.releaserequired');
17319: my ($reqdmajor,$reqdminor) = split(/\./,$curr_reqd_hash{'internal.releaserequired'});
17320: my %checkresponsetypes;
17321: foreach my $key (keys(%Apache::lonnet::needsrelease)) {
1.1236 raeburn 17322: my ($item,$name,$value) = split(/:/,$key);
1.1083 raeburn 17323: if ($item eq 'resourcetag') {
17324: if ($name eq 'responsetype') {
17325: $checkresponsetypes{$value} = $Apache::lonnet::needsrelease{$key}
17326: }
17327: }
17328: }
17329: my $navmap = Apache::lonnavmaps::navmap->new();
17330: if (defined($navmap)) {
17331: my %allresponses;
17332: foreach my $res ($navmap->retrieveResources(undef,sub { $_[0]->is_problem() },1,0)) {
17333: my %responses = $res->responseTypes();
17334: foreach my $key (keys(%responses)) {
17335: next unless(exists($checkresponsetypes{$key}));
17336: $allresponses{$key} += $responses{$key};
17337: }
17338: }
17339: foreach my $key (keys(%allresponses)) {
17340: my ($major,$minor) = split(/\./,$checkresponsetypes{$key});
17341: if (($major > $reqdmajor) || ($major == $reqdmajor && $minor > $reqdminor)) {
17342: ($reqdmajor,$reqdminor) = ($major,$minor);
17343: }
17344: }
17345: undef($navmap);
17346: }
17347: unless (($reqdmajor eq '') && ($reqdminor eq '')) {
17348: &Apache::lonnet::update_released_required($reqdmajor.'.'.$reqdminor,$cdom,$cnum,$chome,$cid);
17349: }
17350: return;
17351: }
17352:
1.1110 raeburn 17353: sub allmaps_incourse {
17354: my ($cdom,$cnum,$chome,$cid) = @_;
17355: if ($cdom eq '' || $cnum eq '' || $chome eq '' || $cid eq '') {
17356: $cid = $env{'request.course.id'};
17357: $cdom = $env{'course.'.$cid.'.domain'};
17358: $cnum = $env{'course.'.$cid.'.num'};
17359: $chome = $env{'course.'.$cid.'.home'};
17360: }
17361: my %allmaps = ();
17362: my $lastchange =
17363: &Apache::lonnet::get_coursechange($cdom,$cnum);
17364: if ($lastchange > $env{'request.course.tied'}) {
17365: my ($furl,$ferr) = &Apache::lonuserstate::readmap("$cdom/$cnum");
17366: unless ($ferr) {
17367: &update_content_constraints($cdom,$cnum,$chome,$cid);
17368: }
17369: }
17370: my $navmap = Apache::lonnavmaps::navmap->new();
17371: if (defined($navmap)) {
17372: foreach my $res ($navmap->retrieveResources(undef,sub { $_[0]->is_map() },1,0,1)) {
17373: $allmaps{$res->src()} = 1;
17374: }
17375: }
17376: return \%allmaps;
17377: }
17378:
1.1083 raeburn 17379: sub parse_supplemental_title {
17380: my ($title) = @_;
17381:
17382: my ($foldertitle,$renametitle);
17383: if ($title =~ /&&&/) {
17384: $title = &HTML::Entites::decode($title);
17385: }
17386: if ($title =~ m/^(\d+)___&&&___($match_username)___&&&___($match_domain)___&&&___(.*)$/) {
17387: $renametitle=$4;
17388: my ($time,$uname,$udom) = ($1,$2,$3);
17389: $foldertitle=&Apache::lontexconvert::msgtexconverted($4);
17390: my $name = &plainname($uname,$udom);
17391: $name = &HTML::Entities::encode($name,'"<>&\'');
17392: $renametitle = &HTML::Entities::encode($renametitle,'"<>&\'');
17393: $title='<i>'.&Apache::lonlocal::locallocaltime($time).'</i> '.
17394: $name.': <br />'.$foldertitle;
17395: }
17396: if (wantarray) {
17397: return ($title,$foldertitle,$renametitle);
17398: }
17399: return $title;
17400: }
17401:
1.1143 raeburn 17402: sub recurse_supplemental {
17403: my ($cnum,$cdom,$suppmap,$numfiles,$errors) = @_;
17404: if ($suppmap) {
17405: my ($errtext,$fatal) = &LONCAPA::map::mapread('/uploaded/'.$cdom.'/'.$cnum.'/'.$suppmap);
17406: if ($fatal) {
17407: $errors ++;
17408: } else {
17409: if ($#LONCAPA::map::resources > 0) {
17410: foreach my $res (@LONCAPA::map::resources) {
17411: my ($title,$src,$ext,$type,$status)=split(/\:/,$res);
17412: if (($src ne '') && ($status eq 'res')) {
1.1146 raeburn 17413: if ($src =~ m{^\Q/uploaded/$cdom/$cnum/\E(supplemental_\d+\.sequence)$}) {
17414: ($numfiles,$errors) = &recurse_supplemental($cnum,$cdom,$1,$numfiles,$errors);
1.1143 raeburn 17415: } else {
17416: $numfiles ++;
17417: }
17418: }
17419: }
17420: }
17421: }
17422: }
17423: return ($numfiles,$errors);
17424: }
17425:
1.1101 raeburn 17426: sub symb_to_docspath {
1.1267 raeburn 17427: my ($symb,$navmapref) = @_;
17428: return unless ($symb && ref($navmapref));
1.1101 raeburn 17429: my ($mapurl,$id,$resurl) = &Apache::lonnet::decode_symb($symb);
17430: if ($resurl=~/\.(sequence|page)$/) {
17431: $mapurl=$resurl;
17432: } elsif ($resurl eq 'adm/navmaps') {
17433: $mapurl=$env{'course.'.$env{'request.course.id'}.'.url'};
17434: }
17435: my $mapresobj;
1.1267 raeburn 17436: unless (ref($$navmapref)) {
17437: $$navmapref = Apache::lonnavmaps::navmap->new();
17438: }
17439: if (ref($$navmapref)) {
17440: $mapresobj = $$navmapref->getResourceByUrl($mapurl);
1.1101 raeburn 17441: }
17442: $mapurl=~s{^.*/([^/]+)\.(\w+)$}{$1};
17443: my $type=$2;
17444: my $path;
17445: if (ref($mapresobj)) {
17446: my $pcslist = $mapresobj->map_hierarchy();
17447: if ($pcslist ne '') {
17448: foreach my $pc (split(/,/,$pcslist)) {
17449: next if ($pc <= 1);
1.1267 raeburn 17450: my $res = $$navmapref->getByMapPc($pc);
1.1101 raeburn 17451: if (ref($res)) {
17452: my $thisurl = $res->src();
17453: $thisurl=~s{^.*/([^/]+)\.\w+$}{$1};
17454: my $thistitle = $res->title();
17455: $path .= '&'.
17456: &Apache::lonhtmlcommon::entity_encode($thisurl).'&'.
1.1146 raeburn 17457: &escape($thistitle).
1.1101 raeburn 17458: ':'.$res->randompick().
17459: ':'.$res->randomout().
17460: ':'.$res->encrypted().
17461: ':'.$res->randomorder().
17462: ':'.$res->is_page();
17463: }
17464: }
17465: }
17466: $path =~ s/^\&//;
17467: my $maptitle = $mapresobj->title();
17468: if ($mapurl eq 'default') {
1.1129 raeburn 17469: $maptitle = 'Main Content';
1.1101 raeburn 17470: }
17471: $path .= (($path ne '')? '&' : '').
17472: &Apache::lonhtmlcommon::entity_encode($mapurl).'&'.
1.1146 raeburn 17473: &escape($maptitle).
1.1101 raeburn 17474: ':'.$mapresobj->randompick().
17475: ':'.$mapresobj->randomout().
17476: ':'.$mapresobj->encrypted().
17477: ':'.$mapresobj->randomorder().
17478: ':'.$mapresobj->is_page();
17479: } else {
17480: my $maptitle = &Apache::lonnet::gettitle($mapurl);
17481: my $ispage = (($type eq 'page')? 1 : '');
17482: if ($mapurl eq 'default') {
1.1129 raeburn 17483: $maptitle = 'Main Content';
1.1101 raeburn 17484: }
17485: $path = &Apache::lonhtmlcommon::entity_encode($mapurl).'&'.
1.1146 raeburn 17486: &escape($maptitle).':::::'.$ispage;
1.1101 raeburn 17487: }
17488: unless ($mapurl eq 'default') {
17489: $path = 'default&'.
1.1146 raeburn 17490: &escape('Main Content').
1.1101 raeburn 17491: ':::::&'.$path;
17492: }
17493: return $path;
17494: }
17495:
1.1094 raeburn 17496: sub captcha_display {
17497: my ($context,$lonhost) = @_;
17498: my ($output,$error);
1.1234 raeburn 17499: my ($captcha,$pubkey,$privkey,$version) =
17500: &get_captcha_config($context,$lonhost);
1.1095 raeburn 17501: if ($captcha eq 'original') {
1.1094 raeburn 17502: $output = &create_captcha();
17503: unless ($output) {
1.1172 raeburn 17504: $error = 'captcha';
1.1094 raeburn 17505: }
17506: } elsif ($captcha eq 'recaptcha') {
1.1234 raeburn 17507: $output = &create_recaptcha($pubkey,$version);
1.1094 raeburn 17508: unless ($output) {
1.1172 raeburn 17509: $error = 'recaptcha';
1.1094 raeburn 17510: }
17511: }
1.1234 raeburn 17512: return ($output,$error,$captcha,$version);
1.1094 raeburn 17513: }
17514:
17515: sub captcha_response {
17516: my ($context,$lonhost) = @_;
17517: my ($captcha_chk,$captcha_error);
1.1234 raeburn 17518: my ($captcha,$pubkey,$privkey,$version) = &get_captcha_config($context,$lonhost);
1.1095 raeburn 17519: if ($captcha eq 'original') {
1.1094 raeburn 17520: ($captcha_chk,$captcha_error) = &check_captcha();
17521: } elsif ($captcha eq 'recaptcha') {
1.1234 raeburn 17522: $captcha_chk = &check_recaptcha($privkey,$version);
1.1094 raeburn 17523: } else {
17524: $captcha_chk = 1;
17525: }
17526: return ($captcha_chk,$captcha_error);
17527: }
17528:
17529: sub get_captcha_config {
17530: my ($context,$lonhost) = @_;
1.1234 raeburn 17531: my ($captcha,$pubkey,$privkey,$version,$hashtocheck);
1.1094 raeburn 17532: my $hostname = &Apache::lonnet::hostname($lonhost);
17533: my $serverhomeID = &Apache::lonnet::get_server_homeID($hostname);
17534: my $serverhomedom = &Apache::lonnet::host_domain($serverhomeID);
1.1095 raeburn 17535: if ($context eq 'usercreation') {
17536: my %domconfig = &Apache::lonnet::get_dom('configuration',[$context],$serverhomedom);
17537: if (ref($domconfig{$context}) eq 'HASH') {
17538: $hashtocheck = $domconfig{$context}{'cancreate'};
17539: if (ref($hashtocheck) eq 'HASH') {
17540: if ($hashtocheck->{'captcha'} eq 'recaptcha') {
17541: if (ref($hashtocheck->{'recaptchakeys'}) eq 'HASH') {
17542: $pubkey = $hashtocheck->{'recaptchakeys'}{'public'};
17543: $privkey = $hashtocheck->{'recaptchakeys'}{'private'};
17544: }
17545: if ($privkey && $pubkey) {
17546: $captcha = 'recaptcha';
1.1234 raeburn 17547: $version = $hashtocheck->{'recaptchaversion'};
17548: if ($version ne '2') {
17549: $version = 1;
17550: }
1.1095 raeburn 17551: } else {
17552: $captcha = 'original';
17553: }
17554: } elsif ($hashtocheck->{'captcha'} ne 'notused') {
17555: $captcha = 'original';
17556: }
1.1094 raeburn 17557: }
1.1095 raeburn 17558: } else {
17559: $captcha = 'captcha';
17560: }
17561: } elsif ($context eq 'login') {
17562: my %domconfhash = &Apache::loncommon::get_domainconf($serverhomedom);
17563: if ($domconfhash{$serverhomedom.'.login.captcha'} eq 'recaptcha') {
17564: $pubkey = $domconfhash{$serverhomedom.'.login.recaptchakeys_public'};
17565: $privkey = $domconfhash{$serverhomedom.'.login.recaptchakeys_private'};
1.1094 raeburn 17566: if ($privkey && $pubkey) {
17567: $captcha = 'recaptcha';
1.1234 raeburn 17568: $version = $domconfhash{$serverhomedom.'.login.recaptchaversion'};
17569: if ($version ne '2') {
17570: $version = 1;
17571: }
1.1095 raeburn 17572: } else {
17573: $captcha = 'original';
1.1094 raeburn 17574: }
1.1095 raeburn 17575: } elsif ($domconfhash{$serverhomedom.'.login.captcha'} eq 'original') {
17576: $captcha = 'original';
1.1094 raeburn 17577: }
17578: }
1.1234 raeburn 17579: return ($captcha,$pubkey,$privkey,$version);
1.1094 raeburn 17580: }
17581:
17582: sub create_captcha {
17583: my %captcha_params = &captcha_settings();
17584: my ($output,$maxtries,$tries) = ('',10,0);
17585: while ($tries < $maxtries) {
17586: $tries ++;
17587: my $captcha = Authen::Captcha->new (
17588: output_folder => $captcha_params{'output_dir'},
17589: data_folder => $captcha_params{'db_dir'},
17590: );
17591: my $md5sum = $captcha->generate_code($captcha_params{'numchars'});
17592:
17593: if (-e $Apache::lonnet::perlvar{'lonCaptchaDir'}.'/'.$md5sum.'.png') {
17594: $output = '<input type="hidden" name="crypt" value="'.$md5sum.'" />'."\n".
17595: &mt('Type in the letters/numbers shown below').' '.
1.1176 raeburn 17596: '<input type="text" size="5" name="code" value="" autocomplete="off" />'.
17597: '<br />'.
17598: '<img src="'.$captcha_params{'www_output_dir'}.'/'.$md5sum.'.png" alt="captcha" />';
1.1094 raeburn 17599: last;
17600: }
17601: }
17602: return $output;
17603: }
17604:
17605: sub captcha_settings {
17606: my %captcha_params = (
17607: output_dir => $Apache::lonnet::perlvar{'lonCaptchaDir'},
17608: www_output_dir => "/captchaspool",
17609: db_dir => $Apache::lonnet::perlvar{'lonCaptchaDb'},
17610: numchars => '5',
17611: );
17612: return %captcha_params;
17613: }
17614:
17615: sub check_captcha {
17616: my ($captcha_chk,$captcha_error);
17617: my $code = $env{'form.code'};
17618: my $md5sum = $env{'form.crypt'};
17619: my %captcha_params = &captcha_settings();
17620: my $captcha = Authen::Captcha->new(
17621: output_folder => $captcha_params{'output_dir'},
17622: data_folder => $captcha_params{'db_dir'},
17623: );
1.1109 raeburn 17624: $captcha_chk = $captcha->check_code($code,$md5sum);
1.1094 raeburn 17625: my %captcha_hash = (
17626: 0 => 'Code not checked (file error)',
17627: -1 => 'Failed: code expired',
17628: -2 => 'Failed: invalid code (not in database)',
17629: -3 => 'Failed: invalid code (code does not match crypt)',
17630: );
17631: if ($captcha_chk != 1) {
17632: $captcha_error = $captcha_hash{$captcha_chk}
17633: }
17634: return ($captcha_chk,$captcha_error);
17635: }
17636:
17637: sub create_recaptcha {
1.1234 raeburn 17638: my ($pubkey,$version) = @_;
17639: if ($version >= 2) {
17640: return '<div class="g-recaptcha" data-sitekey="'.$pubkey.'"></div>';
17641: } else {
17642: my $use_ssl;
17643: if ($ENV{'SERVER_PORT'} == 443) {
17644: $use_ssl = 1;
17645: }
17646: my $captcha = Captcha::reCAPTCHA->new;
17647: return $captcha->get_options_setter({theme => 'white'})."\n".
17648: $captcha->get_html($pubkey,undef,$use_ssl).
17649: &mt('If the text is hard to read, [_1] will replace them.',
17650: '<img src="/res/adm/pages/refresh.gif" alt="reCAPTCHA refresh" />').
17651: '<br /><br />';
17652: }
1.1094 raeburn 17653: }
17654:
17655: sub check_recaptcha {
1.1234 raeburn 17656: my ($privkey,$version) = @_;
1.1094 raeburn 17657: my $captcha_chk;
1.1234 raeburn 17658: if ($version >= 2) {
17659: my %info = (
17660: secret => $privkey,
17661: response => $env{'form.g-recaptcha-response'},
17662: remoteip => $ENV{'REMOTE_ADDR'},
17663: );
1.1280 raeburn 17664: my $request=new HTTP::Request('POST','https://www.google.com/recaptcha/api/siteverify');
17665: $request->content(join('&',map {
17666: my $name = escape($_);
17667: "$name=" . ( ref($info{$_}) eq 'ARRAY'
17668: ? join("&$name=", map {escape($_) } @{$info{$_}})
17669: : &escape($info{$_}) );
17670: } keys(%info)));
17671: my $response = &LONCAPA::LWPReq::makerequest('',$request,'','',10,1);
1.1234 raeburn 17672: if ($response->is_success) {
17673: my $data = JSON::DWIW->from_json($response->decoded_content);
17674: if (ref($data) eq 'HASH') {
17675: if ($data->{'success'}) {
17676: $captcha_chk = 1;
17677: }
17678: }
17679: }
17680: } else {
17681: my $captcha = Captcha::reCAPTCHA->new;
17682: my $captcha_result =
17683: $captcha->check_answer(
17684: $privkey,
17685: $ENV{'REMOTE_ADDR'},
17686: $env{'form.recaptcha_challenge_field'},
17687: $env{'form.recaptcha_response_field'},
17688: );
17689: if ($captcha_result->{is_valid}) {
17690: $captcha_chk = 1;
17691: }
1.1094 raeburn 17692: }
17693: return $captcha_chk;
17694: }
17695:
1.1174 raeburn 17696: sub emailusername_info {
1.1244 raeburn 17697: my @fields = ('firstname','lastname','institution','web','location','officialemail','id');
1.1174 raeburn 17698: my %titles = &Apache::lonlocal::texthash (
17699: lastname => 'Last Name',
17700: firstname => 'First Name',
17701: institution => 'School/college/university',
17702: location => "School's city, state/province, country",
17703: web => "School's web address",
17704: officialemail => 'E-mail address at institution (if different)',
1.1244 raeburn 17705: id => 'Student/Employee ID',
1.1174 raeburn 17706: );
17707: return (\@fields,\%titles);
17708: }
17709:
1.1161 raeburn 17710: sub cleanup_html {
17711: my ($incoming) = @_;
17712: my $outgoing;
17713: if ($incoming ne '') {
17714: $outgoing = $incoming;
17715: $outgoing =~ s/;/;/g;
17716: $outgoing =~ s/\#/#/g;
17717: $outgoing =~ s/\&/&/g;
17718: $outgoing =~ s/</</g;
17719: $outgoing =~ s/>/>/g;
17720: $outgoing =~ s/\(/(/g;
17721: $outgoing =~ s/\)/)/g;
17722: $outgoing =~ s/"/"/g;
17723: $outgoing =~ s/'/'/g;
17724: $outgoing =~ s/\$/$/g;
17725: $outgoing =~ s{/}{/}g;
17726: $outgoing =~ s/=/=/g;
17727: $outgoing =~ s/\\/\/g
17728: }
17729: return $outgoing;
17730: }
17731:
1.1190 musolffc 17732: # Checks for critical messages and returns a redirect url if one exists.
17733: # $interval indicates how often to check for messages.
1.1282 raeburn 17734: # $context is the calling context -- roles, grades, contents, menu or flip.
1.1190 musolffc 17735: sub critical_redirect {
1.1282 raeburn 17736: my ($interval,$context) = @_;
1.1190 musolffc 17737: if ((time-$env{'user.criticalcheck.time'})>$interval) {
1.1282 raeburn 17738: if (($env{'request.course.id'}) && (($context eq 'flip') || ($context eq 'contents'))) {
17739: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
17740: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
17741: my $blocked = &blocking_status('alert',$cnum,$cdom,undef,1);
17742: if ($blocked) {
17743: my $checkrole = "cm./$cdom/$cnum";
17744: if ($env{'request.course.sec'} ne '') {
17745: $checkrole .= "/$env{'request.course.sec'}";
17746: }
17747: unless ((&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) &&
17748: ($env{'request.role'} !~ m{^st\./$cdom/$cnum})) {
17749: return;
17750: }
17751: }
17752: }
1.1190 musolffc 17753: my @what=&Apache::lonnet::dump('critical', $env{'user.domain'},
17754: $env{'user.name'});
17755: &Apache::lonnet::appenv({'user.criticalcheck.time'=>time});
1.1191 raeburn 17756: my $redirecturl;
1.1190 musolffc 17757: if ($what[0]) {
17758: if (($what[0] ne 'con_lost') && ($what[0]!~/^error\:/)) {
17759: $redirecturl='/adm/email?critical=display';
1.1191 raeburn 17760: my $url=&Apache::lonnet::absolute_url().$redirecturl;
17761: return (1, $url);
1.1190 musolffc 17762: }
1.1191 raeburn 17763: }
17764: }
17765: return ();
1.1190 musolffc 17766: }
17767:
1.1174 raeburn 17768: # Use:
17769: # my $answer=reply("encrypt:passwd:$udom:$uname:$upass",$tryserver);
17770: #
17771: ##################################################
17772: # password associated functions #
17773: ##################################################
17774: sub des_keys {
17775: # Make a new key for DES encryption.
17776: # Each key has two parts which are returned separately.
17777: # Please note: Each key must be passed through the &hex function
17778: # before it is output to the web browser. The hex versions cannot
17779: # be used to decrypt.
17780: my @hexstr=('0','1','2','3','4','5','6','7',
17781: '8','9','a','b','c','d','e','f');
17782: my $lkey='';
17783: for (0..7) {
17784: $lkey.=$hexstr[rand(15)];
17785: }
17786: my $ukey='';
17787: for (0..7) {
17788: $ukey.=$hexstr[rand(15)];
17789: }
17790: return ($lkey,$ukey);
17791: }
17792:
17793: sub des_decrypt {
17794: my ($key,$cyphertext) = @_;
17795: my $keybin=pack("H16",$key);
17796: my $cypher;
17797: if ($Crypt::DES::VERSION>=2.03) {
17798: $cypher=new Crypt::DES $keybin;
17799: } else {
17800: $cypher=new DES $keybin;
17801: }
1.1233 raeburn 17802: my $plaintext='';
17803: my $cypherlength = length($cyphertext);
17804: my $numchunks = int($cypherlength/32);
17805: for (my $j=0; $j<$numchunks; $j++) {
17806: my $start = $j*32;
17807: my $cypherblock = substr($cyphertext,$start,32);
17808: my $chunk =
17809: $cypher->decrypt(unpack("a8",pack("H16",substr($cypherblock,0,16))));
17810: $chunk .=
17811: $cypher->decrypt(unpack("a8",pack("H16",substr($cypherblock,16,16))));
17812: $chunk=substr($chunk,1,ord(substr($chunk,0,1)) );
17813: $plaintext .= $chunk;
17814: }
1.1174 raeburn 17815: return $plaintext;
17816: }
17817:
1.112 bowersj2 17818: 1;
17819: __END__;
1.41 ng 17820:
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