module_text.inc.php

<?php

/*
 *	module_text.inc.php
 *	Module for placing text elements on a page
 *
 *	Copyright Gottfried Haider, Danja Vasiliev 2010.
 *	This source code is licensed under the GNU General Public License.
 *	See the file COPYING for more details.
 */

@require_once('config.inc.php');
require_once('common.inc.php');
require_once('html.inc.php');
require_once('html_parse.inc.php');
require_once('modules.inc.php');
// module glue gets loaded on demand
require_once('util.inc.php');


// module_image.inc.php has more information on what's going on inside modules 
// (they can be easier than that one though)


/**
 *	include the font-face css for a woff-font
 *
 *	@param string $font_family font family to include
 *	@param string $style_to_include style to include (normal, italic, bold, bolditalic) (default: include all styles)
 *	@return true if successful, false if not
 */
function _include_woff_font($font_family, $style_to_include = '')
{
	static $already_included = array();
	
	// strip quotation marks
	// TODO (later): do proper parsing of font-family string
	$font_family = str_replace('"', '', $font_family);
	$font_family = str_replace('\'', '', $font_family);
	$woff_fonts = _woff_fonts();
	if (!array_key_exists($font_family, $woff_fonts)) {
		return false;
	}
	
	foreach ($woff_fonts[$font_family] as $style=>$woff) {
		if (!empty($style_to_include) && $style_to_include != $style) {
			continue;
		}
		// check if already included
		if (isset($already_included[$font_family])) {
			if (isset($already_included[$font_family][$style])) {
				continue;
			}
		}
		// TODO (later): check css encoding
		$rule = '@font-face {'.nl();
		$rule .= tab().'font-family: \''.$font_family.'\';'.nl();
		if ($style == 'italic' || $style == 'bolditalic') {
			$rule .= tab().'font-style: italic;'.nl();
		} else {
			$rule .= tab().'font-style: normal;'.nl();
		}
		if ($style == 'bold' || $style == 'bolditalic') {
			$rule .= tab().'font-weight: bold;'.nl();
		} else {
			$rule .= tab().'font-weight: normal;'.nl();
		}
		$rule .= tab().'src: url('.base_url().'img/'.$woff.') format("woff");'.nl();
		$rule .= '}';
		html_add_css_inline($rule, 5);
		// add to list of already included font styles
		if (!isset($already_included[$font_family])) {
			$already_included[$font_family] = array();
		}
		$already_included[$font_family][$style] = true;
	}
	return true;
}


/**
 *	return if the font-family includes a woff-font
 *
 *	@param string $font_family font family
 *	@return true if there is a woff-font, false if not
 */
function _is_woff_font($font_family)
{
	$woff_fonts = _woff_fonts();
	// strip quotation marks for the comparison
	// TODO (later): do proper parsing of font-family string
	$font_family = str_replace('"', '', $font_family);
	$font_family = str_replace('\'', '', $font_family);
	return array_key_exists($font_family, $woff_fonts);
}


/**
 *	helper function for rendering the content of a text object for use in 
 *	editing (outside the textarea) and viewing
 *
 *	@param string $s content
 *	@param string $name object name
 *	@return html-encoded content
 */
function _text_render_content($s, $name)
{
	// resolve any aliases
	$s = resolve_aliases($s, $name);
	$s = html_encode_str_smart($s);
	// automatically add <br> elements for newlines
	if (TEXT_AUTO_BR) {
		$s = str_replace("\r\n", "\n", $s);
		$s = str_replace("\n", "<br>\n", $s);
	}
	// encode non-breakable spaces (160, 0xc2 0xa0 in utf-8)
	$s = str_replace("\xc2\xa0", '&nbsp;', $s);
	// resolve any relative urls
	$s = resolve_relative_urls($s);
	return $s;
}


// TODO (later): why do global variables not work here?
/**
 *	return an array of all available woff-fonts
 *
 *	@return array
 */
function _woff_fonts()
{
	// use a hardcoded array of woff fonts for now
	return array(
		'LatinModern' => array(
			'normal' => 'lmsans10-regular-webfont.woff',
			'italic' => 'lmsans10-oblique-webfont.woff',
			'bold' => 'lmsans10-bold-webfont.woff',
			'bolditalic' => 'lmsans10-boldoblique-webfont.woff'
		),
		'DejaVuSans' => array(
			'normal' => 'dejavusans-webfont.woff',
			'italic' => 'dejavusans-oblique-webfont.woff',
			'bold' => 'dejavusans-bold-webfont.woff',
			'bolditalic' => 'dejavusans-boldoblique-webfont.woff'
		),
		'DejaVuSerif' => array(
			'normal' => 'dejavuserif-webfont.woff',
			'italic' => 'dejavuserif-italic-webfont.woff',
			'bold' => 'dejavuserif-bold-webfont.woff',
			'bolditalic' => 'dejavuserif-bolditalic-webfont.woff'
		),
		'DejaVuSansMono' => array(
			'normal' => 'dejavusansmono-webfont.woff',
			'italic' => 'dejavusansmono-oblique-webfont.woff',
			'bold' => 'dejavusansmono-bold-webfont.woff',
			'bolditalic' => 'dejavusansmono-boldoblique-webfont.woff'
		)
	);
}


function text_alter_save($args)
{
	$elem = $args['elem'];
	$obj = &$args['obj'];
	if (!elem_has_class($elem, 'text')) {
		return false;
	}
	
	// background-color
	if (elem_css($elem, 'background-color') !== NULL) {
		$obj['text-background-color'] = elem_css($elem, 'background-color');
	} else {
		unset($obj['text-background-color']);
	}
	// we don't handle content here
	// see the comments in $.glue.object.register_alter_pre_save (at text-edit.js)
	// font-color
	if (elem_css($elem, 'color') !== NULL) {
		$obj['text-font-color'] = elem_css($elem, 'color');
	} else {
		unset($obj['text-font-color']);
	}
	// font-family
	if (elem_css($elem, 'font-family') !== NULL) {
		$obj['text-font-family'] = elem_css($elem, 'font-family');
	} else {
		unset($obj['text-font-family']);
	}
	// font-size
	if (elem_css($elem, 'font-size') !== NULL) {
		$obj['text-font-size'] = elem_css($elem, 'font-size');
	} else {
		unset($obj['text-font-size']);
	}
	// font-style
	if (elem_css($elem, 'font-style') !== NULL) {
		$obj['text-font-style'] = elem_css($elem, 'font-style');
	} else {
		unset($obj['text-font-style']);
	}
	// font-weight
	if (elem_css($elem, 'font-weight') !== NULL) {
		$obj['text-font-weight'] = elem_css($elem, 'font-weight');
	} else {
		unset($obj['text-font-weight']);
	}
	// letter-spacing
	if (elem_css($elem, 'letter-spacing') !== NULL) {
		$obj['text-letter-spacing'] = elem_css($elem, 'letter-spacing');
	} else {
		unset($obj['text-letter-spacing']);
	}
	// line-height
	if (elem_css($elem, 'line-height') !== NULL) {
		$obj['text-line-height'] = elem_css($elem, 'line-height');
	} else {
		unset($obj['text-line-height']);
	}
	if (elem_css($elem, 'padding') !== NULL) {
		// parse padding
		// this is needed for Firefox
		$s = expl(' ', elem_css($elem, 'padding'));
		if (count($s) == 1) {
			// padding-x = padding-y
			$obj['text-padding-x'] = $s[0];
			$obj['text-padding-y'] = $s[0];
		} elseif (1 < count($s)) {
			// padding-x
			$obj['text-padding-x'] = $s[1];
			// padding-y
			$obj['text-padding-y'] = $s[0];
		}
	} else {
		// padding-x
		if (elem_css($elem, 'padding-left') !== NULL) {
			$obj['text-padding-x'] = elem_css($elem, 'padding-left');
		} else {
			unset($obj['text-padding-x']);
		}
		// padding-y
		if (elem_css($elem, 'padding-top') !== NULL) {
			$obj['text-padding-y'] = elem_css($elem, 'padding-top');
		} else {
			unset($obj['text-padding-y']);
		}
	}
	// text-align
	if (elem_css($elem, 'text-align') !== NULL) {
		$obj['text-align'] = elem_css($elem, 'text-align');
	} else {
		unset($obj['text-align']);
	}
	// word-spacing
	if (elem_css($elem, 'word-spacing') !== NULL) {
		$obj['text-word-spacing'] = elem_css($elem, 'word-spacing');
	} else {
		unset($obj['text-word-spacing']);
	}
	
	return true;
}


function text_alter_render_early($args)
{
	$elem = &$args['elem'];
	$obj = $args['obj'];
	if (!elem_has_class($elem, 'text')) {
		return false;
	}
	
	// background-color
	if (!empty($obj['text-background-color'])) {
		elem_css($elem, 'background-color', $obj['text-background-color']);
	}
	// content
	if (!isset($obj['content'])) {
		$obj['content'] = '';
	}
	if ($args['edit']) {
		// add a textarea
		$i = elem('textarea');
		elem_add_class($i, 'glue-text-input');
		elem_css($i, 'width', '100%');
		elem_css($i, 'height', '100%');
		// hide the text area by default
		elem_css($i, 'display', 'none');
		// set the context to the textarea to the (unrendered) object content
		$content = htmlspecialchars($obj['content'], ENT_NOQUOTES, 'UTF-8');
		// replace newline characters by an entity to prevent render_object() 
		// from adding some indentation
		$content = str_replace("\r\n", '&#10;', $content);
		$content = str_replace("\n", '&#10;', $content);
		// why not replace tabs as well why we are at it
		$content = str_replace("\t", '&#09;', $content);
		elem_val($i, $content);
		elem_append($elem, $i);
		// and a nested div
		$r = elem('div');
		elem_add_class($r, 'glue-text-render');
		elem_css($r, 'width', '100%');
		elem_css($r, 'height', '100%');
		// set the content of the div to the rendered object content
		elem_val($r, _text_render_content($obj['content'], $obj['name']));
		elem_append($elem, $r);
	} else {
		elem_append($elem, _text_render_content($obj['content'], $obj['name']));
	}
	// font-color
	if (!empty($obj['text-font-color'])) {
		elem_css($elem, 'color', $obj['text-font-color']);
	}
	// font-family
	if (!empty($obj['text-font-family'])) {
		elem_css($elem, 'font-family', $obj['text-font-family']);
		if (TEXT_USE_WOFF_FONTS) {
			if (_is_woff_font($obj['text-font-family'])) {
				// include all styles of the font because of inline html 
				// (<strong>, etc)
				_include_woff_font($obj['text-font-family']);
			}
		}
	}
	// font-size
	if (!empty($obj['text-font-size'])) {
		elem_css($elem, 'font-size', $obj['text-font-size']);
	}
	// font-style
	if (!empty($obj['text-font-style'])) {
		elem_css($elem, 'font-style', $obj['text-font-style']);
	}
	// font-weight
	if (!empty($obj['text-font-weight'])) {
		elem_css($elem, 'font-weight', $obj['text-font-weight']);
	}
	// letter-spacing
	if (!empty($obj['text-letter-spacing'])) {
		elem_css($elem, 'letter-spacing', $obj['text-letter-spacing']);
	}
	// line-height
	if (!empty($obj['text-line-height'])) {
		elem_css($elem, 'line-height', $obj['text-line-height']);
	}
	// padding-x
	if (!empty($obj['text-padding-x'])) {
		elem_css($elem, 'padding-left', $obj['text-padding-x']);
		elem_css($elem, 'padding-right', $obj['text-padding-x']);
	}
	// padding-y
	if (!empty($obj['text-padding-y'])) {
		elem_css($elem, 'padding-top', $obj['text-padding-y']);
		elem_css($elem, 'padding-bottom', $obj['text-padding-y']);
	}
	// text-align
	if (!empty($obj['text-align'])) {
		elem_css($elem, 'text-align', $obj['text-align']);
	}
	// word-spacing
	if (!empty($obj['text-word-spacing'])) {
		elem_css($elem, 'word-spacing', $obj['text-word-spacing']);
	}
	
	return true;
}


function text_render_object($args)
{
	$obj = $args['obj'];
	if (!isset($obj['type']) || $obj['type'] != 'text') {
		return false;
	}
	
	$e = elem('div');
	elem_attr($e, 'id', $obj['name']);
	elem_add_class($e, 'text');
	elem_add_class($e, 'resizable');
	elem_add_class($e, 'object');
	
	// hooks
	invoke_hook_first('alter_render_early', 'text', array('obj'=>$obj, 'elem'=>&$e, 'edit'=>$args['edit']));
	$html = elem_finalize($e);
	invoke_hook_last('alter_render_late', 'text', array('obj'=>$obj, 'html'=>&$html, 'elem'=>$e, 'edit'=>$args['edit']));
	
	return $html;
}


function text_render_page_early($args)
{
	if ($args['edit']) {
		if (USE_MIN_FILES) {
			html_add_js(base_url().'modules/text/text-edit.min.js');
		} else {
			html_add_js(base_url().'modules/text/text-edit.js');
		}
		html_add_css(base_url().'modules/text/text-edit.css');
		html_add_js_var('$.glue.conf.text.auto_br', TEXT_AUTO_BR);
		
		if (TEXT_USE_WOFF_FONTS) {
			$woff_fonts = _woff_fonts();
			foreach ($woff_fonts as $font=>$styles) {
				_include_woff_font($font);
				// TODO (later): check css encoding
				$rule = '.glue-font-woff-'.$font.' {'.nl();
				// we use single quotes as they don't clash with inline styles
				$rule .= tab().'font-family: \''.$font.'\';'.nl();
				$rule .= '}';
				html_add_css_inline($rule, 6);
			}
		}
	}
}


function text_save_state($args)
{
	$elem = $args['elem'];
	$obj = $args['obj'];
	if (get_first_item(elem_classes($elem)) != 'text') {
		return false;
	}
	
	// make sure the type is set
	$obj['type'] = 'text';
	$obj['module'] = 'text';
	
	// hook
	invoke_hook('alter_save', array('obj'=>&$obj, 'elem'=>$elem));
	
	load_modules('glue');
	$ret = save_object($obj);
	if ($ret['#error']) {
		load_msg('error', 'text_save_state: save_object returned '.quot($ret['#data']));
		return false;
	} else {
		return true;
	}
}