* @version $Revision: 17991 $
*/
class GalleryTemplateAdapter {
/**
* The number of times our block callbacks have been executed
* @var array
* @access private
*/
var $_callCount;
/**
* The active theme
* @var GalleryTheme
* @access private
*/
var $_theme;
/**
* Aggregation of text that we want to output at the bottom of the page,
* useful for when we need to put javascript at the bottom.
* @var string
* @access private
*/
var $_trailer;
/**
* Registered callbacks that will get executed during the trailer.
* @var array
* @access private
*/
var $_trailerCallbacks = array();
/**
* Current state of the progress bar.
* @var array
* @access private
*/
var $_progressBarStats;
function GalleryTemplateAdapter() {
$this->_callCount = array();
$this->_theme = null;
$this->_trailer = null;
$this->_progressBarStats = null;
}
/**
* Set the theme
* @param GalleryTheme $theme
*/
function setTheme($theme) {
$this->_theme = $theme;
}
/*************************************************************
* Special purpose template callback methods.
*************************************************************/
/**
* Return a valid Gallery URL, standalone or embedded.
* @see GalleryUrlGenerator::generateUrl
*
* @param array $params data in key/value pairs
* @param Smarty $smarty the smarty instance
* @return string a URL
*/
function url($params, &$smarty) {
global $gallery;
/* Allow the user to pass in bulk params */
$urlParams = isset($params['params']) ? $params['params'] : array();
unset($params['params']);
/* Search for args and add them to the params */
for ($i = 1; ($arg = "arg$i") && isset($params[$arg]); $i++) {
list ($key, $value) = explode('=', $params[$arg], 2);
$urlParams[$key] = $value;
unset($params[$arg]);
}
/* Add special 'href' key to the params */
if (isset($params['href'])) {
$urlParams['href'] = $params['href'];
unset($params['href']);
}
/* Allow the user to pass in bulk options */
if (isset($params['options'])) {
$params = array_merge($params['options'], $params);
unset($params['options']);
}
$urlGenerator =& $gallery->getUrlGenerator();
return $urlGenerator->generateUrl($urlParams, $params);
}
/**
* Return any hidden form variables that we want to embed in this form based on the
* current session and request context. We use this to pass the special "return" variable
* forward, for example.
*
* @param array $params data in key/value pairs
* @param Smarty $smarty the smarty instance
* @return a series of XHTML 1.0 compliant elements
*/
function hiddenFormVars($params, &$smarty) {
global $gallery;
$urlGenerator =& $gallery->getUrlGenerator();
$session =& $gallery->getSession();
$vars = array();
/* The 'return' url */
if (GalleryUtilities::hasRequestVariable('return')) {
$vars['return'] = GalleryUtilities::getRequestVariables('return');
}
/* Remember the current url for getting back to where we came from */
if (empty($vars['return'])) {
$vars['return'] = $urlGenerator->getNavigationReturnUrl();
}
/* Remember the original URL where this form was first shown */
$vars['formUrl'] = GalleryUtilities::getRequestVariables('formUrl');
if (empty($vars['formUrl'])) {
/* First time we load this form */
$vars['formUrl'] = $urlGenerator->getNavigationReturnUrl();
}
/* Add the auth token to all controller requests */
$vars['authToken'] = $session->getAuthToken();
$out = '';
foreach ($vars as $key => $value) {
$out .= sprintf('' . "\n",
GalleryUtilities::prefixFormVariable($key),
$value);
}
return $out;
}
/**
* Return a valid Gallery date.
* @todo This needs to be refactored.
*
* @param array $params data in key/value pairs
* @param Smarty $smarty the smarty instance
* @return string date
*/
function date($params, &$smarty) {
global $gallery;
static $defaultFormat;
$platform =& $gallery->getPlatform();
if (empty($params['format'])) {
if (!isset($defaultFormat)) {
$defaultFormat = array('date' => '%x', 'time' => '%X', 'datetime' => '%c');
list ($ret, $core) = GalleryCoreApi::fetchAllPluginParameters('module', 'core');
if (!$ret) {
$defaultFormat = array('date' => $core['format.date'],
'time' => $core['format.time'],
'datetime' => $core['format.datetime']);
}
}
$params['format'] =
(!empty($params['style']) && isset($defaultFormat[$params['style']]))
? $defaultFormat[$params['style']] : $defaultFormat['date'];
}
return $platform->strftime($params['format'],
!empty($params['timestamp']) ? $params['timestamp'] : null);
}
/**
* @see GalleryTranslator::translateDomain
*/
function text($params, &$smarty) {
global $gallery;
if (isset($params['l10Domain'])) {
$domain = $params['l10Domain'];
} else if (isset($smarty->_tpl_vars['viewL10domain'])) {
$domain = $smarty->_tpl_vars['viewL10domain'];
} else {
$domain = $smarty->_tpl_vars['l10Domain'];
}
$translator =& $gallery->getTranslator();
if (!empty($params['postSprintfArg1'])) {
/*
* Attempt to translate post-sprintf string to allow specific translations
* for particular %s values. Currently only supports a single arg.
* Fallback to normal translation of given $params.
*/
$string = sprintf($params['text'], $params['postSprintfArg1']);
list ($ret, $text) = $translator->translateDomain($domain, $string);
if ($ret || $text == $string) {
list ($ret, $text) = $translator->translateDomain($domain, $params);
}
} else {
list ($ret, $text) = $translator->translateDomain($domain, $params);
}
if ($ret) {
return '[Translation error: ' . print_r($params, true) . ']';
}
if (!empty($params['forJavascript'])) {
if (!function_exists('smarty_modifier_escape')) {
GalleryCoreApi::requireOnce('lib/smarty/plugins/modifier.escape.php');
}
$text = smarty_modifier_escape($text, 'javascript', 'UTF-8');
}
return $text;
}
/**
* Return a checkbox asking whether to chenge the value in descendents.
* Useful when we are trying to change a value recursively.
*
* @param array $params key => value attributes
* @param Smarty $smarty the smarty instance
* @return HTML content
*/
function changeInDescendents($params, &$smarty) {
global $gallery;
if (isset($params['l10Domain'])) {
$domain = $params['l10Domain'];
} else {
$domain = $smarty->_tpl_vars['l10Domain'];
}
$translator =& $gallery->getTranslator();
list ($ret, $text) = $translator->translateDomain($domain, $params);
if ($ret) {
return '[Translation error: ' . print_r($params, true) . ']';
}
return ' ';
}
/**
* Return a transformed element name.
*
* @param array $params key => value attributes
* @return HTML content
*/
function formVar($params) {
return GalleryUtilities::prefixFormVariable($params['var']);
}
/**
* Delegate to the appropriate item class to render an image.
* @todo Figure out a more graceful way to deal with errors here.
*
* @param array $params containing item, image, maxSize, fallback, and any img attributes
* @param Smarty $smarty the smarty instance
* @return string HTML content
*/
function image($params, &$smarty) {
list ($ret, $html) = $this->_image($params, $smarty);
if ($ret) {
return '[Render error]';
}
return $html;
}
/**
* Implementation of image() that can return an error.
* @see GalleryTemplateAdapter::image
* @access private
*/
function _image($params, &$smarty) {
/*
* Cases:
* - Item can render itself
* - Entity can render itself (with info from the item)
* - Renderer can render the entity (with info from the item)
*/
if ($params['item']['id'] == $params['image']['id']) {
/* XXX: Can't be more specific than entity-type = GalleryEntity here */
list ($ret, $item) =
GalleryCoreApi::loadEntitiesById($params['item']['id'], 'GalleryEntity');
if ($ret) {
return array($ret, null);
}
$entity = null;
} else {
list ($ret, $results) = GalleryCoreApi::loadEntitiesById(
array($params['item']['id'], $params['image']['id']), 'GalleryEntity');
if ($ret) {
return array($ret, null);
}
list ($item, $entity) = $results;
}
unset($params['item']);
unset($params['image']);
if (isset($params['fallback'])) {
$fallback = $params['fallback'];
} else {
$fallback = $params['fallback'] = null;
}
$rendererClass = $item->getRenderer();
if ($rendererClass) {
list ($ret, $renderer) =
GalleryCoreApi::newFactoryInstanceById('GalleryRenderer', $rendererClass);
if ($ret) {
return array($ret, null);
}
} else {
$renderer = null;
}
/* TODO: Normalize these 3 different APIs */
$html = null;
if (isset($renderer)) {
$html = $renderer->render('HTML', $entity ? $entity : $item, $item, $params);
}
if ($html === null) {
if ($entity) {
$html = $entity->render('HTML', $item, $params);
} else {
$html = $item->render('HTML', $params);
}
}
if (empty($html)) {
$html = $fallback;
}
return array(null, $html);
}
/**
* Render head content
*
* @param array $params
* @param Smarty $smarty the smarty instance
* @return string HTML content
*/
function head($params, &$smarty) {
global $gallery;
$urlGenerator =& $gallery->getUrlGenerator();
$templateVars =& $smarty->get_template_vars();
$head = $templateVars['head'];
$output = array('');
/* Title */
if (isset($head['title'])) {
$output[] = '' . $head['title'] . "";
}
/* elements (rss, css) */
foreach (array_keys($head['link']) as $linkHtml) {
$output[] = $linkHtml;
}
/* Javascript */
if (!empty($head['javascript'])) {
$theme = $templateVars['theme'];
if (empty($theme['pageType']) || $theme['pageType'] != 'error') {
$this->_combineJavascriptFiles(array_keys($head['javascript']), $output);
} else {
foreach (array_keys($head['javascript']) as $file) {
$output[] = sprintf('',
$urlGenerator->generateUrl(array('href' => $file)));
}
}
}
/* Tpl to include. */
foreach ($head['tpl'] as $path => $l10Domain) {
/* Guard template vars so that the include doesn't pollute our namespace */
$save = $smarty->_tpl_vars;
$smarty->_smarty_include(
array('smarty_include_tpl_file' => "gallery:$path",
'smarty_include_vars' => array('l10Domain' => $l10Domain)));
$smarty->_tpl_vars = $save;
}
/* This should help out users whose browsers are confused about the character set */
$output[] = '';
/* Meta */
foreach ($head['meta'] as $meta) {
$key = empty($meta['isHttpEquiv']) ? 'name' : 'http-equiv';
$output[] = sprintf('',
$key, $meta['name'], $meta['content']);
}
return implode("\n", $output);
}
/**
* Combine as many static Javascript files as possible into a single request to
* core.CombinedJavascript to minimize the number of connections required by the browser to
* retrieve them, which improves performance on slower connections.
* @param array $files relative paths to javascript files
* @param array $output output buffer to add lines.
*/
function _combineJavascriptFiles($files, &$output) {
global $gallery;
$platform =& $gallery->getPlatform();
$urlGenerator =& $gallery->getUrlGenerator();
$filteredFiles = array();
$key = '';
$codeBase = GalleryCoreApi::getCodeBasePath();
$pattern = '';
/* Special case utilities.js is superset of yahoo-dom-event.js */
/** @todo move this check into GalleryTemplate::javascript */
$yde = array_search('lib/yui/yahoo-dom-event.js', $files);
if ($yde !== false) {
$util = array_search('lib/yui/utilities.js', $files);
if ($util !== false) {
if ($yde < $util) {
$files[$yde] = $files[$util];
unset($files[$util]);
} else {
unset($files[$yde]);
}
}
}
foreach ($files as $file) {
/*
* Don't do caching if it's a dynamic request, for which we use the quick and dirty
* approach of checking for a ? in the path. This will fail if you register a short
* url for a JS immediate view, which seems pretty unlikely.
*/
$path = $codeBase . $file;
if (strpos($file, '?') === false && $platform->file_exists($path)) {
/* 7 == size, 9 == mtime, see http://php.net/stat */
$stats = $platform->stat($path);
$key .= "$file $stats[7] $stats[9],";
$filteredFiles[] = $file;
} else {
if ($filteredFiles) {
/* Create a combined javascript file for what we have now */
$output[] = sprintf($pattern,
$this->_buildCombinedJavascriptFileAndGenerateUrl($filteredFiles, $key));
$filteredFiles = array();
$key = '';
}
$output[] = sprintf(
$pattern, $urlGenerator->generateUrl(array('href' => $file)));
}
}
if ($filteredFiles) {
$output[] = sprintf($pattern, $this->_buildCombinedJavascriptFileAndGenerateUrl(
$filteredFiles, $key));
}
}
/**
* Combine the specified files into a single file and store it in the disk cache with the key.
* @param array files to be combined
* @param array string to be used to generate the key
* @return string a url to retrieve the combined script file or null
*/
function _buildCombinedJavascriptFileAndGenerateUrl($filteredFiles, $key) {
global $gallery;
$platform =& $gallery->getPlatform();
$urlGenerator =& $gallery->getUrlGenerator();
$phpVm = $gallery->getPhpVm();
$codeBase = GalleryCoreApi::getCodeBasePath();
$key = $phpVm->md5($key);
$cacheFile = GalleryDataCache::getCachePath(
array('type' => 'module',
'itemId' => 'CombinedJavascript_' . $key,
'id' => '_all'));
if (!$platform->file_exists($cacheFile)) {
$contents = '';
foreach ($filteredFiles as $file) {
$contents .= $platform->file_get_contents($codeBase . $file);
}
GalleryDataCache::putToDisk(
array('type' => 'module',
'itemId' => 'CombinedJavascript_' . $key,
'id' => '_all'),
$contents);
if ($phpVm->function_exists('gzencode')) {
GalleryDataCache::putToDisk(
array('type' => 'module',
'itemId' => 'CombinedJavascript_gzip_' . $key,
'id' => '_all'),
$phpVm->gzencode($contents, 9, FORCE_GZIP));
}
}
return $urlGenerator->generateUrl(
array('view' => 'core.CombinedJavascript', 'key' => $key),
array('forceDirect' => true, 'forceFullUrl' => true));
}
/**
* Include our AutoCompletion template.
*
* @param array $params params
* @param string $content content
* @param Smarty $smarty the smarty instance
*/
function autoComplete($params, $content, &$smarty) {
global $gallery;
$session =& $gallery->getSession();
if (!isset($content)) {
return;
}
if (!isset($this->_callCount['autoComplete'])) {
$this->_callCount['autoComplete'] = 0;
}
$url = trim($content);
/* Add the auth token to the URL */
if (strstr($url, 'authToken') === false) {
$url = GalleryUrlGenerator::appendParamsToUrl($url,
array('authToken' => $session->getAuthToken()));
$url = str_replace('&', '&', $url);
}
/* Guard template vars so that the include doesn't pollute our namespace */
$save = $smarty->_tpl_vars;
$smarty->_smarty_include(
array('smarty_include_tpl_file' => 'gallery:modules/core/templates/AutoComplete.tpl',
'smarty_include_vars' =>
array('element' => $params['element'],
'url' => $url,
'callCount' => ++$this->_callCount['autoComplete'])));
$smarty->_tpl_vars = $save;
}
/**
* Include form inputs for dimensions.
*
* @param array $params params
* @param Smarty $smarty the smarty instance
*/
function dimensions($params, &$smarty) {
if (!isset($this->_callCount['dimensions'])) {
$this->_callCount['dimensions'] = 0;
}
/* Guard template vars so that the include doesn't pollute our namespace */
$save = $smarty->_tpl_vars;
$smarty->_smarty_include(
array('smarty_include_tpl_file' => 'gallery:modules/core/templates/Dimensions.tpl',
'smarty_include_vars' => array(
'formVar' => $params['formVar'],
'formVarId' => strtr($params['formVar'], '[]', '__'),
'width' => isset($params['width']) ? $params['width'] : null,
'height' => isset($params['height']) ? $params['height'] : null,
'callCount' => ++$this->_callCount['dimensions'])));
$smarty->_tpl_vars = $save;
}
/**
* Add hidden form elements to select a default submit button
* that is used if enter is pressed in a text input.
* Include this before any submit buttons are added to the form.
*
* @param array $params params
* @param Smarty $smarty the smarty instance
*/
function defaultButton($params, &$smarty) {
if (!isset($this->_callCount['defaultButton'])) {
$this->_callCount['defaultButton'] = 0;
}
/* Guard template vars so that the include doesn't pollute our namespace */
$save = $smarty->_tpl_vars;
$smarty->_smarty_include(
array('smarty_include_tpl_file' => 'gallery:modules/core/templates/DefaultButton.tpl',
'smarty_include_vars' => array(
'name' => $params['name'],
'callCount' => ++$this->_callCount['defaultButton'])));
$smarty->_tpl_vars = $save;
}
/**
* This takes an array and looks for view, subview, and controller to make
* a linkid (being used as a css classname)
*
* @param array $params the items to make a css class out of
* @return string the id of the css class
*/
function linkId($params) {
$linkId = 'gbLink';
if (!empty($params['urlParams']['controller'])) {
$linkId .= '-' . $params['urlParams']['controller'];
}
if (!empty($params['view'])) {
$linkId .= '-' . $params['view'];
} elseif (!empty($params['urlParams']['view'])) {
$linkId .= '-' . $params['urlParams']['view'];
}
if (!empty($params['urlParams']['subView'])) {
$linkId .= '-' . ($subView = $params['urlParams']['subView']);
if (preg_match('{^core\.Item(?:Edit|Move|Delete|CreateLink)(?:Single)?$}', $subView) &&
!empty($params['urlParams']['itemId'])) {
/* Append item type for a few subViews, with fallback class without type */
list ($ret, $item) = GalleryCoreApi::loadEntitiesById(
$params['urlParams']['itemId'], 'GalleryEntity');
if (!$ret) {
$type = $item->itemTypeName(false);
$fallbackLinkId = $linkId;
$linkId .= '-' . $type[1];
}
}
}
return 'gbAdminLink ' . GalleryTemplateAdapter::_safeCssName($linkId) .
(isset($fallbackLinkId) ?
' ' . GalleryTemplateAdapter::_safeCssName($fallbackLinkId) : '');
}
/**
* Render a single item link as an