// according to language
// only if you have defined the
if (!empty($sampleId)) {
// fetch some data about the content
try {
// using shLib database helper is J2.x/J3.x safe
$sampleTitle = ShlDbHelper::selectObject('#__sample_names', array('id', 'title'), array('id' => $sampleId));
} catch (Exception $e) {
ShlSystem_Log::error('sh404sef', '%s::%s::%d: %s', __CLASS__, __METHOD__, __LINE__, $e->getMessage());
}
if ($sampleTitle) {
// if we found a title for this element
$title[] = $sampleTitle->title;
// insert it in URL array
shRemoveFromGETVarsList('sampleId');
// remove sampleId var from GET vars list
// as we have found a text equivalent
shMustCreatePageId('set', true);
// NEW: ask sh404sef to create a short URL for this SEF URL (pageId)
}
}
shRemoveFromGETVarsList('task');
// also remove task, as it is not needed
// because we can revert the SEF URL without
// it
}
// ------------------ standard plugin finalize function - don't change ---------------------------
if ($dosef) {
$string = shFinalizePlugin($string, $title, $shAppendString, $shItemidString, isset($limit) ? @$limit : null, isset($limitstart) ? @$limitstart : null, isset($shLangName) ? @$shLangName : null);
}
// ------------------ standard plugin finalize function - don't change ---------------------------
function create($string, &$vars, &$shAppendString, $shLanguage, $shSaveString = '', &$originalUri)
{
$sefConfig =& shRouter::shGetConfig();
// get DB
$database =& JFactory::getDBO();
_log('Calling sef404 create function with ' . $string);
if ($sefConfig->shInsertGlobalItemidIfNone && !empty($GLOBALS['Itemid'])) {
// V 1.2.4.t
$shCurrentItemid = $GLOBALS['Itemid'];
} else {
$shCurrentItemid = null;
}
_log('CurrentItemid = ' . $shCurrentItemid);
$index = str_replace($GLOBALS['shConfigLiveSite'], '', $_SERVER['PHP_SELF']);
$base = dirname($index);
$base .= $base == '/' ? '' : '/';
_log('Extracting $vars:', $vars);
extract($vars);
if (isset($title)) {
// V 1.2.4.r : protect against components using 'title' as GET vars (com_jim for instance)
$sh404SEF_title = $title;
}
// means that $sh404SEF_title has to be used in plugins or extensions
$title = array();
// V 1.2.4.r
// get extension plugin
$extPlugin =& Sh404sefFactory::getExtensionPlugin($option);
// which plugin file are we supposed to use?
$extPluginPath = $extPlugin->getSefPluginPath($vars);
$pluginType = $extPlugin->getPluginType();
// use Joomla router.php file in extension dir
switch ($pluginType) {
case Sh404sefClassBaseextplugin::TYPE_JOOMLA_ROUTER:
// Load the plug-in file.
_log('Loading component own router.php file');
$functionName = ucfirst(str_replace('com_', '', $option)) . 'BuildRoute';
if (!function_exists($functionName)) {
include JPATH_ROOT . DS . 'components' . DS . $option . DS . 'router.php';
}
$originalVars = empty($originalUri) ? $vars : $originalUri->getQuery($asArray = true);
$title = $functionName($originalVars);
//$title = shRemoveSlugs( $title, $removeWhat = 'removeId');
global $mainframe;
$router =& $mainframe->getRouter();
$title = $router->_encodeSegments($title);
// manage GET var lists ourselves, as Joomla router.php does not do it
if (!empty($vars)) {
// there are some unused GET vars, we must transfer them to our mechanism, so
// that they are eventually appended to the sef url
foreach ($vars as $k => $v) {
switch ($k) {
case 'option':
case 'Itemid':
shRemoveFromGETVarsList($k);
break;
default:
// if variable has not been used in sef url, add it to list of variables to be
// appended to the url as query string elements
if (array_key_exists($k, $originalVars)) {
shAddToGETVarsList($k, $v);
} else {
shRemoveFromGETVarsList($k);
}
break;
}
}
}
// special case for search component, as router.php encode the search word in the url
// wa can't do that, as we are storing each url in the db
if (isset($originalVars['option']) && $originalVars['option'] == 'com_search' && !empty($vars['searchword'])) {
// router.php has encoded that in the url, we need to undo
$title = array();
$originalVars['searchword'] = $vars['searchword'];
shAddToGETVarsList('searchword', $vars['searchword']);
if (!empty($vars['view'])) {
$vars['view'] = $vars['view'];
shAddToGETVarsList('view', $vars['view']);
}
}
// handle menu items, having only a single Itemid in the url
// (router.php will return an empty array in that case, even if we have restored
// the full non-sef url, as we already did)
/*
* Build the application route
*/
$tmp = '';
if (empty($title) && isset($vars['Itemid']) && !empty($vars['Itemid'])) {
$menu =& shRouter::shGetMenu();
$item = $menu->getItem($vars['Itemid']);
if (is_object($item) && $vars['option'] == $item->component) {
$title[] = $item->route;
}
}
if (empty($title)) {
//$title[] = 'comp';
$title[] = substr($vars['option'], 4);
}
// add user defined prefix
$prefix = shGetComponentPrefix($option);
if (!empty($prefix)) {
array_unshift($title, $prefix);
}
// now process the resulting title string
$string = shFinalizePlugin($string, $title, $shAppendString, '', isset($limit) ? @$limit : null, isset($limitstart) ? @$limitstart : null, isset($shLangName) ? @$shLangName : null, isset($showall) ? @$showall : null);
break;
// use sh404sef plugins, either in ext. dir or in sh404sef dir
// use sh404sef plugins, either in ext. dir or in sh404sef dir
case Sh404sefClassBaseextplugin::TYPE_SH404SEF_ROUTER:
_log('Loading sh404SEF plugin in ' . $extPluginPath);
include $extPluginPath;
break;
case Sh404sefClassBaseextplugin::TYPE_JOOMSEF_ROUTER:
Sh404sefHelperExtplugins::loadJoomsefCompatLibs();
include_once $extPluginPath;
$className = 'SefExt_' . $option;
$plugin = new $className();
if (!shIsHomepage($string)) {
// make sure the plugin does not try to calculate pagination
$params =& SEFTools::GetExtParams('com_content');
$params->set('pagination', '1');
// ask plugin to build url
$plugin->beforeCreate($originalUri);
$result = $plugin->create($originalUri);
$title = empty($result['title']) ? array() : $result['title'];
$plugin->afterCreate($originalUri);
// make sure we have a url
if (empty($title) && isset($vars['Itemid']) && !empty($vars['Itemid'])) {
$menu =& shRouter::shGetMenu();
$item = $menu->getItem($vars['Itemid']);
if (is_object($item) && $vars['option'] == $item->component) {
$title[] = $item->route;
}
}
$prefix = shGetComponentPrefix($option);
if (!empty($prefix)) {
array_unshift($title, $prefix);
}
if (empty($title) && !shIsHomepage($string)) {
$title[] = substr($vars['option'], 4);
}
list($usedVars, $ignore) = $plugin->getNonSefVars($result);
if (!empty($ignore)) {
$usedVars = array_merge($usedVars, $ignore);
}
} else {
$string = '';
$title[] = '/';
$usedVars = array();
}
// post process result to adjust to our workflow
if (!empty($vars)) {
foreach ($vars as $key => $value) {
if (!array_key_exists($key, $usedVars)) {
shRemoveFromGETVarsList($key);
}
}
}
// finalize url
$string = shFinalizePlugin($string, $title, $shAppendString = '', $shItemidString = '', isset($limit) ? @$limit : null, isset($limitstart) ? @$limitstart : null, isset($shLangName) ? @$shLangName : null, isset($showall) ? @$showall : null);
break;
case Sh404sefClassBaseextplugin::TYPE_ACESEF_ROUTER:
Sh404sefHelperExtplugins::loadAcesefCompatLibs();
include_once $extPluginPath;
$className = 'AceSEF_' . $option;
$plugin = new $className();
$plugin->AcesefConfig = AcesefFactory::getConfig();
// some plugins appear to not call the constructor parent, and so AcesefConfig is not set
$tmp =& JPluginHelper::getPlugin('sh404sefextacesef', $option);
$params = new JParameter($tmp->params);
$plugin->setParams($params);
$segments = array();
$do_sef = true;
$metadata = array();
$item_limitstart = 0;
$plugin->beforeBuild($originalUri);
$originalVars = empty($originalUri) ? $vars : $originalUri->getQuery($asArray = true);
$plugin->build($originalVars, $title, $do_sef, $metadata, $item_limitstart);
$plugin->afterBuild($originalUri);
$prefix = shGetComponentPrefix($option);
if (empty($title) && isset($vars['Itemid']) && !empty($vars['Itemid'])) {
$menu =& shRouter::shGetMenu();
$item = $menu->getItem($vars['Itemid']);
if (is_object($item) && $vars['option'] == $item->component) {
$title[] = $item->route;
}
}
if (!empty($prefix)) {
array_unshift($title, $prefix);
}
if (empty($title) && !shIsHomepage($string)) {
$title[] = substr($vars['option'], 4);
}
// acesef plugin don't remove used vars from our GET var manager
// we'll do it now. Vars used are those not present anymore in
// $originalVars
// they will be reappended to the SEF url by shFinalizePlugin
$usedVars = array_diff($vars, $originalVars);
if (!empty($usedVars)) {
foreach ($usedVars as $key => $value) {
shRemoveFromGETVarsList($key);
}
}
// remove Itemid and option, as these are not unset by plugin
shRemoveFromGETVarsList('Itemid');
shRemoveFromGETVarsList('option');
// finalize url
$string = shFinalizePlugin($string, $title, $shAppendString = '', $shItemidString = '', isset($limit) ? @$limit : null, isset($limitstart) ? @$limitstart : null, isset($shLangName) ? @$shLangName : null, isset($showall) ? @$showall : null);
break;
default:
_log('Falling back to sefGetLocation');
if (empty($sefConfig->defaultComponentStringList[str_replace('com_', '', $option)])) {
$title[] = getMenuTitle($option, isset($task) ? @$task : null, null, null, $shLanguage);
} else {
$title[] = $sefConfig->defaultComponentStringList[str_replace('com_', '', $option)];
}
if ($title[0] != '/') {
$title[] = '/';
}
// V 1.2.4.q getMenuTitle can now return '/'
if (count($title) > 0) {
// V 1.2.4.q use $shLanguage insted of $lang (lang name rather than lang code)
$string = sef_404::sefGetLocation($string, $title, isset($task) ? @$task : null, isset($limit) ? @$limit : null, isset($limitstart) ? @$limitstart : null, isset($shLanguage) ? @$shLanguage : null);
}
break;
}
return $string;
}
function create($string, &$vars, &$shAppendString, $shLanguage, $shSaveString = '', &$originalUri)
{
$sefConfig =& shRouter::shGetConfig();
// get DB
$database =& JFactory::getDBO();
_log('Calling sef404 create function with ' . $string);
if ($sefConfig->shInsertGlobalItemidIfNone && !empty($GLOBALS['Itemid'])) {
// V 1.2.4.t
$shCurrentItemid = $GLOBALS['Itemid'];
} else {
$shCurrentItemid = null;
}
$index = str_replace($GLOBALS['shConfigLiveSite'], '', $_SERVER['PHP_SELF']);
$base = dirname($index);
$base .= $base == '/' ? '' : '/';
extract($vars);
if (isset($title)) {
// V 1.2.4.r : protect against components using 'title' as GET vars (com_jim for instance)
$sh404SEF_title = $title;
}
// means that $sh404SEF_title has to be used in plugins or extensions
$title = array();
// V 1.2.4.r
// Plug-in system.
$shDoNotOverride = in_array(str_replace('com_', '', $option), $sefConfig->shDoNotOverrideOwnSef);
// look first in component owndir for a joomla sef router.php file
if (shFileExists(JPATH_ROOT . DS . 'components' . DS . $option . DS . 'router.php') && ($shDoNotOverride || !$shDoNotOverride && !shFileExists(sh404SEF_ABS_PATH . 'components/com_sh404sef/sef_ext/' . $option . '.php') && !shFileExists(JPATH_ROOT . DS . 'components/' . $option . '/sef_ext/' . $option . '.php'))) {
// but we don't have a plugin
// Load the plug-in file.
_log('Loading component own router.php file');
$functionName = ucfirst(str_replace('com_', '', $option)) . 'BuildRoute';
if (!function_exists($functionName)) {
include JPATH_ROOT . DS . 'components' . DS . $option . DS . 'router.php';
}
$originalVars = empty($originalUri) ? $vars : $originalUri->getQuery($asArray = true);
$title = $functionName($originalVars);
//$title = shRemoveSlugs( $title, $removeWhat = 'removeId');
global $mainframe;
$router =& $mainframe->getRouter();
$title = $router->_encodeSegments($title);
// manage GET var lists ourselves, as Joomla router.php does not do it
if (!empty($vars)) {
// there are some unused GET vars, we must transfer them to our mechanism, so
// that they are eventually appended to the sef url
foreach ($vars as $k => $v) {
switch ($k) {
case 'option':
case 'Itemid':
shRemoveFromGETVarsList($k);
break;
default:
// if variable has not been used in sef url, add it to list of variables to be
// appended to the url as query string elements
if (array_key_exists($k, $originalVars)) {
shAddToGETVarsList($k, $v);
} else {
shRemoveFromGETVarsList($k);
}
break;
}
}
}
// special case for search component, as router.php encode the search word in the url
// wa can't do that, as we are storing each url in the db
if (isset($originalVars['option']) && $originalVars['option'] == 'com_search' && !empty($vars['searchword'])) {
// router.php has encoded that in the url, we need to undo
$title = array();
$originalVars['searchword'] = $vars['searchword'];
shAddToGETVarsList('searchword', $vars['searchword']);
if (!empty($vars['view'])) {
$vars['view'] = $vars['view'];
shAddToGETVarsList('view', $vars['view']);
}
}
// handle menu items, having only a single Itemid in the url
// (router.php will return an empty array in that case, even if we have restored
// the full non-sef url, as we already did)
/*
* Build the application route
*/
$tmp = '';
if (empty($title) && isset($vars['Itemid']) && !empty($vars['Itemid'])) {
$menu =& shRouter::shGetMenu();
$item = $menu->getItem($vars['Itemid']);
if (is_object($item) && $vars['option'] == $item->component) {
$title[] = $item->route;
}
}
if (empty($title)) {
//$title[] = 'comp';
$title[] = substr($vars['option'], 4);
}
// add user defined prefix
$prefix = shGetComponentPrefix($option);
if (!empty($prefix)) {
array_unshift($title, $prefix);
}
// now process the resulting title string
$string = shFinalizePlugin($string, $title, $shAppendString, '', isset($limit) ? @$limit : null, isset($limitstart) ? @$limitstart : null, isset($shLangName) ? @$shLangName : null, isset($showall) ? @$showall : null);
} else {
// look then in component own /sef_ext/ dir for a com_component_name.php plugin file
if (shFileExists(sh404SEF_ABS_PATH . 'components/' . $option . '/sef_ext/' . $option . '.php')) {
// Load the plug-in file.
_log('Loading component own sh404SEF plugin');
include sh404SEF_ABS_PATH . 'components/' . $option . '/sef_ext/' . $option . '.php';
} else {
if (shFileExists(sh404SEF_ABS_PATH . 'components/com_sh404sef/sef_ext/' . $option . '.php')) {
_log('Loading built-in plugin');
include sh404SEF_ABS_PATH . 'components/com_sh404sef/sef_ext/' . $option . '.php';
} else {
// no plugin found at all, use Joomla 1.0.x sef
_log('Falling back to sefGetLocation');
if (empty($sefConfig->defaultComponentStringList[str_replace('com_', '', $option)])) {
$title[] = getMenuTitle($option, isset($task) ? @$task : null, null, null, $shLanguage);
} else {
$title[] = $sefConfig->defaultComponentStringList[str_replace('com_', '', $option)];
}
if ($title[0] != '/') {
$title[] = '/';
}
// V 1.2.4.q getMenuTitle can now return '/'
if (count($title) > 0) {
// V 1.2.4.q use $shLanguage insted of $lang (lang name rather than lang code)
$string = sef_404::sefGetLocation($string, $title, isset($task) ? @$task : null, isset($limit) ? @$limit : null, isset($limitstart) ? @$limitstart : null, isset($shLanguage) ? @$shLanguage : null);
}
}
}
}
return $string;
}
}
$title = empty($title) ? $title : $pageInfo->router->encodeSegments($title);
}
// manage GET var lists ourselves, as Joomla router.php does not do it
if (!empty($vars)) {
// there are some unused GET vars, we must transfer them to our mechanism, so
// that they are eventually appended to the sef url
foreach ($vars as $k => $v) {
switch ($k) {
case 'option':
case 'Itemid':
case 'lang':
shRemoveFromGETVarsList($k);
break;
default:
// if variable has not been used in sef url, add it to list of variables to be
// appended to the url as query string elements
if (array_key_exists($k, $originalVars)) {
shAddToGETVarsList($k, $v);
} else {
shRemoveFromGETVarsList($k);
}
break;
}
}
}
// ------------------ standard plugin finalize function - don't change ---------------------------
if ($dosef) {
$string = shFinalizePlugin($string, $title, $shAppendString, $shItemidString, isset($limit) ? $limit : null, isset($limitstart) ? $limitstart : null, isset($shLangName) ? $shLangName : null, isset($showall) ? $showall : null, $suppressPagination = true);
}
// ------------------ standard plugin finalize function - don't change ---------------------------
// system plugins may cause pdf and rss to break if they call JFactory::getDocument() in the onAfterInitialize event handler
// because at this time SEF url are not decoded yet.
if (isset($format) && (!sh404SEF_PROTECT_AGAINST_DOCUMENT_TYPE_ERROR || (sh404SEF_PROTECT_AGAINST_DOCUMENT_TYPE_ERROR && $format == 'html')))
shRemoveFromGETVarsList('format');
if (isset($type))
shRemoveFromGETVarsList('type');
if (!empty($catid))
shRemoveFromGETVarsList('catid'); // V 1.2.4.m
if (isset($showall))
shRemoveFromGETVarsList('showall');
if (empty($page)) // remove page if not set or 0
shRemoveFromGETVarsList('page');
if (isset($print))
shRemoveFromGETVarsList('print');
if (isset($tmpl) && $tmpl == 'component') // remove if 'component', show otherwise as querystring
shRemoveFromGETVarsList('tmpl');
// ------------------ standard plugin finalize function - don't change ---------------------------
if ($dosef){
$string = shFinalizePlugin( $string, $title, $shAppendString, $shItemidString,
(isset($limit) ? $limit : null), (isset($limitstart) ? $limitstart : null),
(isset($shLangName) ? $shLangName : null), (isset($showall) ? $showall : null));
}
// ------------------ standard plugin finalize function - don't change ---------------------------
} else { // this is multipage homepage
$title[] = '/';
$string = sef_404::sefGetLocation( $string, $title, null, (isset($limit) ? $limit : null),
(isset($limitstart) ? $limitstart : null), (isset($shLangName) ? $shLangName : null),
(isset($showall) ? $showall : null));
}