assign_by_ref('trackbacks', $trackbacks); return serendipity_smarty_fetch('TRACKBACKS', 'trackbacks.tpl'); } /** * Smarty: Fetch a smarty block and pass it on to Serendipity Templates * * @access public * @param string The name of the block to parse data into ("COMMENTS" - virtual variable like {$COMMENTS}) * @param string The name of the template file to fetch. Only filename, the path is auto-detected * @param boolean If true, the output of the smarty parser will be echoed instead of invisibly treated * @return string The parsed HTML code */ function &serendipity_smarty_fetch($block, $file, $echo = false) { global $serendipity; $output =& $serendipity['smarty']->fetch('file:'. serendipity_getTemplateFile($file, 'serendipityPath'), null, null, ($echo === true && $serendipity['smarty_raw_mode'])); $serendipity['smarty']->assign_by_ref($block, $output); return $output; } /** * Smarty Modifier: Check if a string is not empty and prepend a prefix in that case. Else, leave empty * * @access public * @param string The input string to check * @param string The prefix to prepend, if $string is not empty * @return string The return string */ function serendipity_emptyPrefix($string, $prefix = ': ') { return (!empty($string) ? $prefix . htmlspecialchars($string) : ''); } /** * Smarty Modifier: Return a remembered variable * * @access public * @param string The variable name * @param string The wanted value * @param boolean Force default? * @param string Returned attribute * @return string The return string */ function serendipity_ifRemember($name, $value, $isDefault = false, $att = 'checked') { global $serendipity; if (!is_array($serendipity['COOKIE']) && !$isDefault) { return false; } if ((!is_array($serendipity['COOKIE']) && $isDefault) || (!isset($serendipity['COOKIE']['serendipity_' . $name]) && $isDefault) || (isset($serendipity['COOKIE']['serendipity_' . $name]) && $serendipity['COOKIE']['serendipity_' . $name] == $value)) { return " $att=\"$att\" "; } } /** * Smarty Function: Fetch and print a single or multiple entries * * @access public * @param array Smarty parameter input array: * [FETCHING] * category: (int) The category ID (seperate multiple with ";") to fetch entries from * viewAuthor: (int) The author ID (seperate multiple with ";") to fetch entries from * page: (int) The number of the page for paginating entries * id: (int) The ID of an entry. If given, only a single entry will be fetched. If left empty, multiple entries are fetched. * range: (mixed) Restricts fetching entries to a specific timespan. Behaves differently depending on the type: * Numeric: * YYYYMMDD - Shows all entries from YYYY-MM-DD. * If DD is "00", it will show all entries from that month. * If DD is any other number, it will show entries of that specific day. * 2-Dimensional Array: * Key #0 - Specifies the start timestamp (unix seconds) * Key #1 - Specifies the end timestamp (unix seconds) * Other (null, 3-dimensional Array, ...): * Entries newer than $modified_since will be fetched * full (boolean) Indicates if the full entry will be fetched (body+extended: TRUE), or only the body (FALSE). * limit (string) Holds a "Y" or "X, Y" string that tells which entries to fetch. X is the first entry offset, Y is number of entries. If not set, the global fetchLimit will be applied (15 entries by default) * fetchDrafts (boolean) Indicates whether drafts should be fetched (TRUE) or not * modified_since (int) Holds a unix timestamp to be used in conjunction with $range, to fetch all entries newer than this timestamp * orderby (string) Holds the SQL "ORDER BY" statement. * filter_sql (string) Can contain any SQL code to inject into the central SQL statement for fetching the entry * noCache (boolean) If set to TRUE, all entries will be fetched from scratch and any caching is ignored * noSticky (boolean) If set to TRUE, all sticky entries will NOT be fetched. * * [PRINTING] * template: (string) Name of the template file to print entries with * preview: (boolean) Indicates if this is a preview * block (string The name of the SMARTY block that this gets parsed into * use_hooks (boolean Indicates whether to apply footer/header event hooks * use_footer (boolean Indicates whether the pagination footer should be displayed * groupmode (string Indicates whether the input $entries array is already grouped in preparation for the smarty $entries output array [TRUE], or if it shall be grouped by date [FALSE] * skip_smarty_hooks (boolean) If TRUE, no plugins will be executed at all * skip_smarty_hook (mixed) Can be set to an array of plugin hooks to NOT execute * prevent_reset (boolean) If set to TRUE, the smarty $entries array will NOT be cleared. (to prevent possible duplicate output of entries) * @param object Smarty object * @return string The Smarty HTML response */ function serendipity_smarty_fetchPrintEntries($params, &$smarty) { global $serendipity; static $entrycount = 0; static $restore_var_GET_keys = array('category', 'viewAuthor', 'page'); // A counter variable to not assign template files multiple times $entrycount++; // Default values for function calls if (empty($params['template'])) { $params['template'] = 'entries.tpl'; } if (empty($params['range'])) { $params['range'] = null; } if (empty($params['full'])) { $params['full'] = true; } if (empty($params['fetchDrafts'])) { $params['fetchDrafts'] = false; } if (empty($params['modified_since'])) { $params['modified_since'] = false; } if (empty($params['orderby'])) { $params['orderby'] = 'timestamp DESC'; } if (empty($params['noCache'])) { $params['noCache'] = false; } if (empty($params['noSticky'])) { $params['noSticky'] = false; } if (empty($params['preview'])) { $params['preview'] = false; } if (empty($params['block'])) { $params['block'] = 'smarty_entries_' . $entrycount; } if (empty($params['use_hooks'])) { $params['use_hooks'] = false; } if (empty($params['use_footer'])) { $params['use_footer'] = false; } if (empty($params['groupmode'])) { $params['groupmode'] = 'date'; } if (empty($params['skip_smarty_hooks'])) { $params['skip_smarty_hooks'] = true; } if (empty($params['skip_smarty_hook'])) { $params['skip_smarty_hook'] = array(); } if (empty($params['prevent_reset'])) { $params['prevent_reset'] = false; } // Some functions deal with the $serendipity array. To modify them, we need to store // their original contents. $old_var = array(); if (!empty($params['short_archives'])) { $old_var['short_archives'] = $serendipity['short_archives']; $serendipity['short_archives'] = $params['short_archives']; } $old_var['skip_smarty_hooks'] = $serendipity['skip_smarty_hooks']; $serendipity['skip_smarty_hooks'] = $params['skip_smarty_hooks']; $old_var['skip_smarty_hook'] = $serendipity['skip_smarty_hook']; $serendipity['skip_smarty_hook'] = $params['skip_smarty_hook']; foreach($restore_var_GET_keys AS $key) { if (!empty($params[$key])) { $old_var['GET'][$key] = $serendipity['GET'][$key]; $serendipity['GET'][$key] = $params[$key]; } } if (!empty($params['id'])) { $entry = serendipity_fetchEntry( 'id', (int)$params['id'], $params['full'], $params['fetchDrafts']); } else { $entry = serendipity_fetchEntries( $params['range'], $params['full'], $params['limit'], $params['fetchDrafts'], $params['modified_since'], $params['orderby'], $params['filter_sql'], $params['noCache'], $params['noSticky'] ); // Check whether the returned entries shall be grouped specifically switch ($params['groupmode']) { case 'date': // No regrouping required, printEntries() does it for us. break; case 'category': // Regroup by primary category $groupdata = array(); foreach($entry AS $k => $_entry) { if (is_array($entry['categories'])) { $groupkey = $entry['categories'][0]; } else { $groupkey = 'none'; } $groupdata[$groupkey]['entries'] =& $_entry; } $entry =& $groupdata; break; } } serendipity_printEntries( $entry, // Entry data (!empty($params['id']) ? true : false), // Extended data? $params['preview'], // Entry preview? 'ENTRIES', false, // Prevent Smarty parsing $params['use_hooks'], $params['use_footer'], ($params['groupmode'] == 'date' ? false : true) // Grouping of $entry ); // Restore the $serendipity array after our modifications. if (isset($old_var['short_archives'])) { $serendipity['short_archives'] = $old_var['short_archives']; } if (is_array($old_var['GET'])) { foreach($old_var['GET'] AS $key => $val) { $serendipity['GET'][$key] = $val; } } $out = serendipity_smarty_fetch($params['block'], $params['template']); // Reset array list, because we might be in a nested code call. if ($params['prevent_reset'] == false) { $serendipity['smarty']->assign('entries', array()); } $serendipity['skip_smarty_hook'] = $old_var['skip_smarty_hook']; $serendipity['skip_smarty_hooks'] = $old_var['skip_smarty_hooks']; return $out; } /** * Smarty Function: Be able to include the output of a sidebar plugin within a smarty template * * @access public * @param array Smarty parameter input array: * class: The classname of the plugin to show * id: An ID of a plugin to show * side: The side of a plugin to show (left|right|hidden) * negate: Revert previous filters * @param object Smarty object * @return string The Smarty HTML response */ function serendipity_smarty_showPlugin($params, &$smarty) { global $serendipity; if (!isset($params['class']) && !isset($params['id'])) { $smarty->trigger_error(__FUNCTION__ .": missing 'class' or 'id' parameter"); return; } if (!isset($params['side'])) { $params['side'] = '*'; } if (!isset($params['negate'])) { $params['negate'] = null; } return serendipity_plugin_api::generate_plugins($params['side'], null, $params['negate'], $params['class'], $params['id']); } /** * Smarty Function: Get total count for specific objects * * @access public * @param array Smarty parameter input array: * what: The type of count to show: "entries", "trackbacks", "comments" * @param object Smarty object * @return string The Smarty HTML response */ function serendipity_smarty_getTotalCount($params, &$smarty) { if (!isset($params['what'])) { $smarty->trigger_error(__FUNCTION__ .": missing 'what' parameter"); return; } return serendipity_getTotalCount($params['what']); } /** * Smarty Function: Be able to execute the hook of an event plugin and return its output * * Listens to specific serendipity global variables: * $serendipity['skip_smarty_hooks'] - If TRUE, no plugins will be executed at all * $serendipity['skip_smarty_hook'] - Can be set to an array of plugin hooks to NOT execute * * @access public * @param array Smarty parameter input array: * hook: The name of the event hook * hookAll: boolean whether unknown hooks shall be executed * data: The $eventData to an event plugin * addData: the $addData to an event plugin * @param object Smarty object * @return null */ function serendipity_smarty_hookPlugin($params, &$smarty) { global $serendipity; static $hookable = array('frontend_header', 'entries_header', 'entries_footer', 'frontend_comment', 'frontend_footer'); if (!isset($params['hook'])) { $smarty->trigger_error(__FUNCTION__ .": missing 'hook' parameter"); return; } if (!in_array($params['hook'], $hookable) && $params['hookAll'] != 'true') { $smarty->trigger_error(__FUNCTION__ .": illegal hook '". $params['hook'] ."'"); return; } // Smarty hooks can be bypassed via an internal variable (temporarily) if (isset($serendipity['skip_smarty_hooks']) && $serendipity['skip_smarty_hooks']) { return; } // A specific hook can also be bypassed by creating an associative array like this: // $serendipity['skip_smarty_hook'] = array('entries_header'); // That would only skip the entries_header event hook, but allow all others. // Of course it cannot be used in conjunction with the all-blocking skip_smarty_hooks. if (isset($serendipity['skip_smarty_hook']) && is_array($serendipity['skip_smarty_hook']) && isset($serendipity['skip_smarty_hook'][$params['hook']])) { return; } if (!isset($params['data'])) { $params['data'] = &$serendipity; } if (!isset($params['addData'])) { $params['addData'] = null; } serendipity_plugin_api::hook_event($params['hook'], $params['data'], $params['addData']); } /** * Smarty Function: Prints a list of sidebar plugins * * @access public * @param array Smarty parameter input array: * side: The plugin side to show (left|right|hidden) * @param object Smarty object * @return string The HTML code of a plugin's output */ function serendipity_smarty_printSidebar($params, &$smarty) { if ( !isset($params['side']) ) { $smarty->trigger_error(__FUNCTION__ .": missing 'side' parameter"); return; } return serendipity_plugin_api::generate_plugins($params['side']); } /** * Smarty Function: Get the full path to a template file * * @access public * @param array Smarty parameter input array: * file: The filename you want to include (any file within your template directry or the 'default' template if not found) * @param object Smarty object * @return string The requested filename with full path */ function serendipity_smarty_getFile($params, &$smarty) { if ( !isset($params['file']) ) { $smarty->trigger_error(__FUNCTION__ .": missing 'file' parameter"); return; } return serendipity_getTemplateFile($params['file']); } /** * Smarty Function: Picks a specified key from an array and returns it * * @access public * @param array Smarty parameter input array: * array: The array you want to check * key: The keyname * default: What (string) to return when array does not contain the key. * @param object Smarty object * @return string The requested filename with full path */ function serendipity_smarty_pickKey($params, &$smarty) { if ( !isset($params['array']) ) { $smarty->trigger_error(__FUNCTION__ .": missing 'array' parameter"); return; } if ( !isset($params['key']) ) { $smarty->trigger_error(__FUNCTION__ .": missing 'key' parameter"); return; } return serendipity_pickKey($params['array'], $params['key'], $params['default']); } /** * Smarty Function: Get a permalink for an entry * * @access public * @param array Smarty parameter input array: * entry: $entry data to pull title etc. out of * is_comments: Whether a permalink for a comment feed should be embedded * @param object Smarty object * @return string The permalink */ function serendipity_smarty_rss_getguid($params, &$smarty) { if ( !isset($params['entry']) ) { $smarty->trigger_error(__FUNCTION__ .": missing 'entry' parameter"); return; } if ( !isset($params['is_comments']) ) { $smarty->trigger_error(__FUNCTION__ .": missing 'is_comments' parameter"); return; } return serendipity_rss_getguid($params['entry'], $params['is_comments']); } /** * Smarty Modifier: Format a timestamp * * @access public * @param int The timestamp to format (unix seconds) * @param string The strftime() format options on how to format this string * @param boolean Shall timezone conversions be applied? * @param boolean Try to detect a valid timestamp? * @return */ function serendipity_smarty_formatTime($timestamp, $format, $useOffset = true, $detectTimestamp = false) { if ($detectTimestamp !== false && stristr($detectTimestamp, 'date') === false) { return $timestamp; } if (defined($format)) { return serendipity_formatTime(constant($format), $timestamp, $useOffset); } else { return serendipity_formatTime($format, $timestamp, $useOffset); } } /** * Smarty Function: Show comments to an entry * * @access public * @param array Smarty parameter input array: * entry: The $entry data * mode: The default viewmode (threaded/linear) * @param object Smarty object * @return string The HTML code with the comments */ function &serendipity_smarty_printComments($params, &$smarty) { global $serendipity; if (!isset($params['entry'])) { $smarty->trigger_error(__FUNCTION__ .": missing 'entry' parameter"); return; } if (!isset($params['mode'])) { $params['mode'] = VIEWMODE_THREADED; } if (isset($params['order']) && $params['order'] != 'DESC') { $params['order'] = 'ASC'; } $comments = serendipity_fetchComments($params['entry'], (int)$params['limit'], $params['order']); if (!empty($serendipity['POST']['preview'])) { $comments[] = array( 'email' => $serendipity['POST']['email'], 'author' => $serendipity['POST']['name'], 'body' => $serendipity['POST']['comment'], 'url' => $serendipity['POST']['url'], 'parent_id' => $serendipity['POST']['replyTo'], 'timestamp' => time() ); } $out = serendipity_printComments($comments, $params['mode']); return $out; } /** * Smarty Function: Show Trackbacks * * @access public * @param array Smarty parameter input array: * entry: The $entry data for the trackbacks * @param object Smarty object * @return */ function &serendipity_smarty_printTrackbacks($params, &$smarty) { if ( !isset($params['entry']) ) { $smarty->trigger_error(__FUNCTION__ .": missing 'entry' parameter"); return; } $tb =& serendipity_fetchTrackbacks($params['entry']); return serendipity_printTrackbacks($tb); } /** * Smarty Prefilter: Replace constants to direkt $smarty.const. access * * @access public * @param string Template source content * @param object Smarty object * @return */ function &serendipity_replaceSmartyVars(&$tpl_source, &$smarty) { $tpl_source = str_replace('$CONST.', '$smarty.const.', $tpl_source); return $tpl_source; } /** * Initialize the Smarty framework for use in Serendipity * * @access public * @return null */ function serendipity_smarty_init($vars = array()) { global $serendipity, $template_config; if (!isset($serendipity['smarty'])) { $template_dir = $serendipity['serendipityPath'] . $serendipity['templatePath'] . $serendipity['template']; if (!defined('IN_serendipity_admin') && file_exists($template_dir . '/template.inc.php')) { // If this file exists, a custom template engine will be loaded. // Beware: Smarty is used in the Admin backend, despite of this. include $template_dir . '/template.inc.php'; } else { // Default Smarty Engine will be used @define('SMARTY_DIR', S9Y_PEAR_PATH . 'Smarty/libs/'); if (!class_exists('Smarty')) { require SMARTY_DIR . 'Smarty.class.php'; } $serendipity['smarty'] = new Smarty; if ($serendipity['production'] === 'debug') { $serendipity['smarty']->force_compile = true; $serendipity['smarty']->debugging = true; } $serendipity['smarty']->template_dir = array( $template_dir, $serendipity['serendipityPath'] . $serendipity['templatePath'] . 'default' ); $serendipity['smarty']->compile_dir = $serendipity['serendipityPath'] . PATH_SMARTY_COMPILE; if (!is_dir($serendipity['smarty']->compile_dir) || !is_writable($serendipity['smarty']->compile_dir)) { serendipity_die(sprintf(DIRECTORY_WRITE_ERROR, $serendipity['smarty']->compile_dir)); } $serendipity['smarty']->config_dir = $template_dir; $serendipity['smarty']->secure_dir = array($serendipity['serendipityPath'] . $serendipity['templatePath']); $serendipity['smarty']->security_settings['MODIFIER_FUNCS'] = array('sprintf', 'sizeof', 'count', 'rand', 'print_r', 'str_repeat'); $serendipity['smarty']->security_settings['ALLOW_CONSTANTS'] = true; $serendipity['smarty']->security = true; $serendipity['smarty']->use_sub_dirs = false; $serendipity['smarty']->compile_check = true; $serendipity['smarty']->compile_id = &$serendipity['template']; $serendipity['smarty']->register_modifier('makeFilename', 'serendipity_makeFilename'); $serendipity['smarty']->register_modifier('xhtml_target', 'serendipity_xhtml_target'); $serendipity['smarty']->register_modifier('emptyPrefix', 'serendipity_emptyPrefix'); $serendipity['smarty']->register_modifier('formatTime', 'serendipity_smarty_formatTime'); $serendipity['smarty']->register_modifier('serendipity_utf8_encode', 'serendipity_utf8_encode'); $serendipity['smarty']->register_modifier('ifRemember', 'serendipity_ifRemember'); $serendipity['smarty']->register_function('serendipity_printSidebar', 'serendipity_smarty_printSidebar'); $serendipity['smarty']->register_function('serendipity_hookPlugin', 'serendipity_smarty_hookPlugin'); $serendipity['smarty']->register_function('serendipity_showPlugin', 'serendipity_smarty_showPlugin'); $serendipity['smarty']->register_function('serendipity_getFile', 'serendipity_smarty_getFile'); $serendipity['smarty']->register_function('serendipity_printComments', 'serendipity_smarty_printComments'); $serendipity['smarty']->register_function('serendipity_printTrackbacks', 'serendipity_smarty_printTrackbacks'); $serendipity['smarty']->register_function('serendipity_rss_getguid', 'serendipity_smarty_rss_getguid'); $serendipity['smarty']->register_function('serendipity_fetchPrintEntries', 'serendipity_smarty_fetchPrintEntries'); $serendipity['smarty']->register_function('serendipity_getTotalCount', 'serendipity_smarty_getTotalCount'); $serendipity['smarty']->register_function('pickKey', 'serendipity_smarty_pickKey'); $serendipity['smarty']->register_prefilter('serendipity_replaceSmartyVars'); } if (!isset($serendipity['smarty_raw_mode'])) { if (file_exists($serendipity['smarty']->config_dir . '/layout.php') && $serendipity['template'] != 'default') { $serendipity['smarty_raw_mode'] = true; } else { $serendipity['smarty_raw_mode'] = false; } } if (!isset($serendipity['smarty_file'])) { $serendipity['smarty_file'] = 'index.tpl'; } $category = false; $category_info = array(); if (isset($serendipity['GET']['category'])) { $category = (int)$serendipity['GET']['category']; if (isset($GLOBALS['cInfo'])) { $category_info = $GLOBALS['cInfo']; } else { $category_info = serendipity_fetchCategoryInfo($category); } } if (!isset($serendipity['smarty_vars']['head_link_stylesheet'])) { $serendipity['smarty_vars']['head_link_stylesheet'] = serendipity_rewriteURL('serendipity.css'); } $serendipity['smarty']->assign( array( 'head_charset' => LANG_CHARSET, 'head_version' => $serendipity['version'], 'head_title' => $serendipity['head_title'], 'head_subtitle' => $serendipity['head_subtitle'], 'head_link_stylesheet' => $serendipity['smarty_vars']['head_link_stylesheet'], 'is_xhtml' => true, 'use_popups' => $serendipity['enablePopup'], 'is_embedded' => (!$serendipity['embed'] || $serendipity['embed'] === 'false' || $serendipity['embed'] === false) ? false : true, 'is_raw_mode' => $serendipity['smarty_raw_mode'], 'is_logged_in' => serendipity_userLoggedIn(), 'entry_id' => (isset($serendipity['GET']['id']) && is_numeric($serendipity['GET']['id'])) ? $serendipity['GET']['id'] : false, 'is_single_entry' => (isset($serendipity['GET']['id']) && is_numeric($serendipity['GET']['id'])), 'blogTitle' => htmlspecialchars($serendipity['blogTitle']), 'blogSubTitle' => (!empty($serendipity['blogSubTitle']) ? htmlspecialchars($serendipity['blogSubTitle']) : ''), 'blogDescription' => htmlspecialchars($serendipity['blogDescription']), 'serendipityHTTPPath' => $serendipity['serendipityHTTPPath'], 'serendipityBaseURL' => $serendipity['baseURL'], 'serendipityRewritePrefix' => $serendipity['rewrite'] == 'none' ? $serendipity['indexFile'] . '?/' : '', 'serendipityIndexFile' => $serendipity['indexFile'], 'serendipityVersion' => $serendipity['version'], 'lang' => $serendipity['lang'], 'category' => $category, 'category_info' => $category_info, 'template' => $serendipity['template'], 'dateRange' => (!empty($serendipity['range']) ? $serendipity['range'] : array()) ) ); if (count($vars) > 0) { $serendipity['smarty']->assign($vars); } // For advanced usage, we allow template authors to create a file 'config.inc.php' where they can // setup custom smarty variables, modifiers etc. to use in their templates. @include_once $serendipity['smarty']->config_dir . '/config.inc.php'; if (is_array($template_config)) { $template_vars =& serendipity_loadThemeOptions($template_config); $serendipity['smarty']->assign_by_ref('template_option', $template_vars); } } return true; } /** * Purge compiled Smarty Templates * * @access public * @return null */ function serendipity_smarty_purge() { global $serendipity; /* Attempt to init Smarty, brrr */ serendipity_smarty_init(); $files = serendipity_traversePath($serendipity['smarty']->compile_dir, '', false, '/.+\.tpl\.php$/'); if ( !is_array($files) ) { return false; } foreach ( $files as $file ) { @unlink($serendipity['smarty']->compile_dir . DIRECTORY_SEPARATOR . $file['name']); } } /** * Shut down the Smarty Framework, output all parsed data * * This function is meant to be used in embedded installations, like in Gallery. * Function can be called from foreign applications. ob_start() needs to * have been called before, and will be parsed into Smarty here * * @access public * @param string The path to Serendipity * @return null */ function serendipity_smarty_shutdown($serendipity_directory = '') { global $serendipity; #$cwd = getcwd(); chdir($serendipity_directory); $raw_data = ob_get_contents(); ob_end_clean(); $serendipity['smarty']->assign_by_ref('content_message', $raw_data); serendipity_smarty_fetch('CONTENT', 'content.tpl'); $serendipity['smarty']->assign('ENTRIES', ''); if (empty($serendipity['smarty_file'])) { $serendipity['smarty_file'] = '404.tpl'; } $serendipity['smarty']->display(serendipity_getTemplateFile($serendipity['smarty_file'], 'serendipityPath')); }