File:  [LON-CAPA] / loncom / interface / lontemplate.pm
Revision 1.51: download - view: text, annotated - select for diffs
Sun Sep 22 15:56:24 2013 UTC (10 years, 7 months ago) by raeburn
Branches: MAIN
CVS tags: version_2_12_X, HEAD
- White space changes only.
  - Indentation.

    1: # The LearningOnline Network
    2: # "Template" Functions to generate html output
    3: #
    4: # $Id: lontemplate.pm,v 1.51 2013/09/22 15:56:24 raeburn Exp $
    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: #
   28: 
   29: package Apache::lontemplate;
   30: 
   31: 
   32: use strict;
   33: use utf8;
   34: use Apache::Constants qw(:common);
   35: use Apache::loncommon;
   36: use Apache::lonnet;
   37: use Apache::lonxml;
   38: use Apache::lonspeller;
   39: use Apache::lontexconvert;
   40: use Apache::lonfeedback;
   41: use Apache::lonrss();
   42: use Apache::lonlocal;
   43: use Apache::lonhtmlgateway;
   44: use Apache::lonmsgdisplay();
   45: use HTML::Entities();
   46: 
   47: use constant {
   48: 	RICH_TEXT_ALWAYS_ON => 'LC_richAlwaysOn',
   49: 	RICH_TEXT_ALWAYS_OFF => 'LC_richAlwaysOff',
   50: 	RICH_TEXT_DEFAULT_ON => 'LC_richDefaultOn',
   51: 	RICH_TEXT_DETECT_HTML => 'LC_richDetectHtml',
   52: 	RICH_TEXT_DEFAULT_OFF => 'LC_richDefaultOff'
   53: };
   54: 
   55: sub start_columnSection {
   56: 	my ($r) = @_;
   57: 	 $r->print('<div class="LC_columnSection">');
   58: }
   59: 
   60: sub end_columnSection {
   61: 	my ($r) = @_;
   62: 	 $r->print('</div>');
   63: }
   64: 
   65: sub print_aboutme_content_template {
   66: 	my ($r,$allowed,$target,$syllabusfields_ref,$syllabus_ref) = @_;
   67: 	my %syllabusfields = %{$syllabusfields_ref};
   68: 	my %syllabus = %{$syllabus_ref};
   69: 
   70:        foreach my $field (sort(keys(%syllabusfields))) {
   71:           if (($syllabus{$field}) || ($allowed)) {
   72:               my $message=$syllabus{$field};
   73:               if (!&Apache::lonfeedback::contains_block_html($message)) {
   74:               	&Apache::lonfeedback::newline_to_br(\$message);
   75:               }
   76:               $message=&Apache::lonhtmlcommon::raw_href_to_link($message);
   77:               if ($allowed) {
   78:                   $message=&Apache::lonspeller::markeduptext($message);
   79:               }
   80:               $message=&Apache::lontexconvert::msgtexconverted($message);
   81:               if ($target ne 'tex') {
   82: 		    if($field eq 'aaa_contactinfo') {
   83: 				$r->print('<div class="LC_Clear_AboutMe_Image" >&nbsp;</div>');
   84: 				&print_template($r,$syllabusfields{$field},$message,$allowed,'LC_Box');
   85: 		    } else {
   86: 			  &print_template($r,$syllabusfields{$field},$message,$allowed,'LC_Box');
   87: 		    }
   88: 			if($allowed) {
   89:                &print_editbox_template($r,$syllabus{$field},$field);
   90: 			}
   91: 
   92:               } else {
   93:                      $r->print('\\\\\textbf{'.$syllabusfields{$field}.'}\\\\'.
   94:                                &Apache::lonxml::xmlparse($r,'tex',$message).'\\\\');
   95:               }
   96:           }
   97:        }
   98: 
   99: }
  100: 
  101: sub send_message {
  102: 	my ($r,$cnum,$cdom) = @_;
  103: 	my $linktext = &mt('Send message to [_1]',
  104: 			   &Apache::loncommon::plainname($cnum,$cdom));
  105: 	my $image = qq{<img name="Send_message" alt="Send message symbol" src="/res/adm/pages/mail-message-new.png" border="none" align="middle" />};
  106: 	return &Apache::loncommon::messagewrapper($image,$cnum,$cdom).' '.&Apache::loncommon::messagewrapper($linktext,$cnum,$cdom);
  107: }
  108: 
  109: sub print_template {
  110: 	my ($r,$topic,$content, $allowed,$boxclass) = @_;
  111: 	$r->print('<div class="'.$boxclass.'">');
  112: 	$r->print('<h4 class="LC_hcell">'.$topic.'</h4>');
  113: 	$r->print($content);
  114: 	$r->print('</div>');
  115: }
  116: 
  117: sub print_start_template {
  118: 	my ($r,$topic,$boxclass,$id,$display) = @_;
  119:         my $idattrib;
  120:         if ($id ne '') {
  121:             $idattrib = ' id="'.$id.'"';
  122:         }
  123: 	$r->print('<div class="'.$boxclass.'"'.$idattrib.$display.'>');
  124: 	$r->print('<h4 class="LC_hcell">'.$topic.'</h4>');
  125: }
  126: 
  127: sub print_end_template {
  128: 	my ($r) = @_;
  129: 	$r->print('</div>');
  130: }
  131: 
  132: sub print_editbox_template {
  133: 	my ($r,$content,$field) = @_;
  134: 	$r->print('<textarea cols="81" rows="6" name="'.$field.'">'.
  135:                   &HTML::Entities::encode($content,'"&<>').
  136:                   '</textarea><br />'."\n");
  137: 	&print_saveall_template($r);
  138: }
  139: 
  140: sub print_textarea_template {
  141: 	my ($r, $content, $field, $wysiwyg) = @_;
  142: 	$r->print('<textarea cols="81" rows="6" class="'.$wysiwyg.'" id="'.$field.'" name="'.$field.'">'.
  143: 						  &HTML::Entities::encode($content, '"&<>').
  144: 			'</textarea><br />');
  145: }
  146: 
  147: sub print_saveall_template {
  148: 	my ($r) = @_;
  149: 	$r->print('<input type="submit" name="storesyl" value="'.&mt('Save All').'" />');
  150: }
  151: 
  152: sub print_template_fields {
  153: 	my ($r, $data_ref, $fields_ref, $target, $allowed, $default_rich_text, $custom_handlers_ref, $group,
  154:             $displayref,$noshowref) = @_;
  155: 	my @html_ids = ();
  156: 	my %data = %{$data_ref};
  157: 	my %fields = %{$fields_ref};
  158: 	my %custom_handlers = %{$custom_handlers_ref};
  159:         my (%displays,%noshow);
  160:         if (ref($displayref) eq 'HASH') {
  161:             %displays = %{$displayref};
  162:         }
  163:         if (ref($noshowref) eq 'HASH') {
  164:             %noshow = %{$noshowref};
  165:         }
  166: 	foreach my $field (sort(keys(%fields))) {
  167: 		my $message = $data{$field} if (($data{$field}=~/\w/) || ($allowed));
  168: 		my $legacy = 1;
  169:                 my $display = $displays{$field};
  170:                 unless ($allowed) {
  171:                     next if ($noshow{$field});
  172:                 }
  173:                 my $gateway = Apache::lonhtmlgateway->new($target);
  174:                 $message = &Encode::decode('utf8', $message);
  175:                 $message = $gateway->process_outgoing_html($message, $legacy);
  176:                 if ((%custom_handlers) && ($custom_handlers{$field})) {
  177:                     $custom_handlers{$field}->($r, $field, $message, $group, $data_ref, $fields_ref, $target, $allowed, $display);
  178: 		} else {
  179: 			if (($data{$field}=~/\w/) || ($allowed)) {
  180: 				if ($target ne 'tex') {
  181: 					#output of syllabusfields will be generated here. 
  182: 					&Apache::lontemplate::print_start_template($r,$fields{$field},'LC_Box','box_'.$field,$display);
  183: 					$r->print($message);
  184: 					if ($allowed) {
  185: 						$r->print("<br /><div>");
  186: 						&Apache::lontemplate::print_textarea_template($r, $data{$field},
  187: 							$field, $default_rich_text);
  188: 						&print_saveall_template($r);
  189: 						$r->print("</div>");
  190: 					} 
  191: 					&Apache::lontemplate::print_end_template($r);
  192: 				} else {
  193: 				    my $safeinit;
  194:                                     if ($fields{$field}=~/\w/) {
  195:                                        $r->print(&Apache::lonxml::xmlparse($r,'tex','<h3>'.$fields{$field}.'</h3>'));
  196:                                     } else {
  197:                                        $r->print(&Apache::lonxml::xmlparse($r,'tex','<br />'));
  198:                                     }
  199:                                     $r->print(&Apache::lonxml::xmlparse($r,'tex',$message));
  200: 				}
  201: 				push(@html_ids,$field);
  202: 			}
  203: 		}
  204: 		undef $gateway;
  205: 	}
  206: 	
  207: 	return @html_ids;	
  208: }
  209: 
  210: 1;

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>