- md5
- 3fc2ad046131cef974cb39ff9ca30cf7
- sha1
- d65ff9a05961ab3248ee2b60f96ece063ad09ce3
- sha256
- 83cfebca4994b3226a2f7ce3ba08c7c9e98f473a6a517c8180225b5b0217f394
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663
<?php
/**
* @package Joomla.Plugin
* @subpackage System.languagefilter
*
* @copyright Copyright (C) 2005 - 2015 Open Source Matters, Inc. All rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE.txt
*/
defined('_JEXEC') or die;
use Joomla\Registry\Registry;
JLoader::register('MenusHelper', JPATH_ADMINISTRATOR . '/components/com_menus/helpers/menus.php');
/**
* Joomla! Language Filter Plugin.
*
* @since 1.6
*/
class PlgSystemLanguageFilter extends JPlugin
{
protected $mode_sef;
protected $sefs;
protected $lang_codes;
protected $default_lang;
private $user_lang_code;
/**
* Application object.
*
* @var JApplicationCms
* @since 3.3
*/
protected $app;
/**
* Constructor.
*
* @param object &$subject The object to observe
* @param array $config An optional associative array of configuration settings.
*
* @since 1.6
*/
public function __construct(&$subject, $config)
{
parent::__construct($subject, $config);
$this->app = JFactory::getApplication();
if ($this->app->isSite())
{
// Setup language data.
$router = $this->app->getRouter();
$this->mode_sef = ($router->getMode() == JROUTER_MODE_SEF);
$this->sefs = JLanguageHelper::getLanguages('sef');
$this->lang_codes = JLanguageHelper::getLanguages('lang_code');
$levels = JFactory::getUser()->getAuthorisedViewLevels();
foreach ($this->sefs as $sef => $language)
{
if (!in_array($language->access, $levels))
{
unset($this->lang_codes[$language->lang_code]);
unset($this->sefs[$language->sef]);
}
}
$this->app->setLanguageFilter(true);
// Detect browser feature.
$this->app->setDetectBrowser($this->params->get('detect_browser', '1') == '1');
}
}
/**
* After initialise.
*
* @return void
*
* @since 1.6
*/
public function onAfterInitialise()
{
$this->app->item_associations = $this->params->get('item_associations', 0);
if ($this->app->isSite())
{
$router = $this->app->getRouter();
// Attach build rules for language SEF.
$router->attachBuildRule(array($this, 'preprocessBuildRule'), JRouter::PROCESS_BEFORE);
$router->attachBuildRule(array($this, 'buildRule'), JRouter::PROCESS_DURING);
if ($this->mode_sef)
{
$router->attachBuildRule(array($this, 'postprocessSEFBuildRule'), JRouter::PROCESS_AFTER);
}
else
{
$router->attachBuildRule(array($this, 'postprocessNonSEFBuildRule'), JRouter::PROCESS_AFTER);
}
// Attach parse rules for language SEF.
$router->attachParseRule(array($this, 'parseRule'), JRouter::PROCESS_DURING);
}
}
/**
* After route.
*
* @return void
*
* @since 3.4
*/
public function onAfterRoute()
{
// Add custom site name.
if (isset($this->lang_codes[$this->default_lang]) && $this->lang_codes[$this->default_lang]->sitename)
{
$this->app->set('sitename', $this->lang_codes[$this->default_lang]->sitename);
}
}
/**
* Add build preprocess rule to router.
*
* @param JRouter &$router JRouter object.
* @param JUri &$uri JUri object.
*
* @return void
*
* @since 3.4
*/
public function preprocessBuildRule(&$router, &$uri)
{
$lang = $uri->getVar('lang', $this->default_lang);
$uri->setVar('lang', $lang);
if (isset($this->sefs[$lang]))
{
$lang = $this->sefs[$lang]->lang_code;
$uri->setVar('lang', $lang);
}
}
/**
* Add build rule to router.
*
* @param JRouter &$router JRouter object.
* @param JUri &$uri JUri object.
*
* @return void
*
* @since 1.6
*/
public function buildRule(&$router, &$uri)
{
$lang = $uri->getVar('lang');
if (isset($this->lang_codes[$lang]))
{
$sef = $this->lang_codes[$lang]->sef;
}
else
{
$sef = $this->lang_codes[$this->default_lang]->sef;
}
if ($this->mode_sef
&& (!$this->params->get('remove_default_prefix', 0) || $lang != JComponentHelper::getParams('com_languages')->get('site', 'en-GB')))
{
$uri->setPath($uri->getPath() . '/' . $sef . '/');
}
}
/**
* postprocess build rule for SEF URLs
*
* @param JRouter &$router JRouter object.
* @param JUri &$uri JUri object.
*
* @return void
*
* @since 3.4
*/
public function postprocessSEFBuildRule(&$router, &$uri)
{
$uri->delVar('lang');
}
/**
* postprocess build rule for non-SEF URLs
*
* @param JRouter &$router JRouter object.
* @param JUri &$uri JUri object.
*
* @return void
*
* @since 3.4
*/
public function postprocessNonSEFBuildRule(&$router, &$uri)
{
$lang = $uri->getVar('lang');
if (isset($this->lang_codes[$lang]))
{
$uri->setVar('lang', $this->lang_codes[$lang]->sef);
}
}
/**
* Add parse rule to router.
*
* @param JRouter &$router JRouter object.
* @param JUri &$uri JUri object.
*
* @return void
*
* @since 1.6
*/
public function parseRule(&$router, &$uri)
{
// Did we find the current and existing language yet?
$found = false;
// Are we in SEF mode or not?
if ($this->mode_sef)
{
$path = $uri->getPath();
$parts = explode('/', $path);
$sef = $parts[0];
// If the default prefix should be removed and the SEF prefix is not among those
// that we have in our system, its the default language and we "found" the right language
if ($this->params->get('remove_default_prefix', 0) && !isset($this->sefs[$sef]))
{
$found = true;
$lang_code = JComponentHelper::getParams('com_languages')->get('site', 'en-GB');
}
else
{
// If the language prefix should always be present or it is indeed , we can now look it up in our array
if (isset($this->sefs[$sef]))
{
// We found our language
$found = true;
$lang_code = $this->sefs[$sef]->lang_code;
}
// If we found our language, but its the default language and we don't want a prefix for that, we are on a wrong URL
if ($this->params->get('remove_default_prefix', 0)
&& $lang_code == JComponentHelper::getParams('com_languages')->get('site', 'en-GB'))
{
$found = false;
array_shift($parts);
$path = implode('/', $parts);
}
// We have found our language and the first part of our URL is the language prefix
if ($found)
{
array_shift($parts);
$uri->setPath(implode('/', $parts));
}
}
}
else
{
// We are not in SEF mode
$lang = $uri->getVar('lang');
if (isset($this->sefs[$lang]))
{
// We found our language
$found = true;
$lang_code = $this->sefs[$lang]->lang_code;
}
}
// We are called via POST. We don't care about the language
// and simply set the default language as our current language.
if ($this->app->input->getMethod() == "POST"
|| count($this->app->input->post) > 0
|| count($this->app->input->files) > 0)
{
$found = true;
$lang_code = $this->app->input->cookie->getString(JApplicationHelper::getHash('language'));
if ($this->params->get('detect_browser', 1) && !$lang_code)
{
$lang_code = JLanguageHelper::detectLanguage();
}
if (!isset($this->lang_codes[$lang_code]))
{
$lang_code = JComponentHelper::getParams('com_languages')->get('site', 'en-GB');
}
}
// We have not found the language and thus need to redirect
if (!$found)
{
// Lets find the default language for this user
if (!isset($lang_code) || !isset($this->lang_codes[$lang_code]))
{
$lang_code = false;
if ($this->params->get('detect_browser', 1))
{
$lang_code = JLanguageHelper::detectLanguage();
if (!isset($this->lang_codes[$lang_code]))
{
$lang_code = false;
}
}
if (!$lang_code)
{
$lang_code = JComponentHelper::getParams('com_languages')->get('site', 'en-GB');
}
// Either we detected the language via the browser or we got it from the cookie. In worst case
// we fall back to the application setting
$lang_code = $this->app->input->cookie->getString(JApplicationHelper::getHash('language'), $lang_code);
}
if ($this->mode_sef)
{
// Use the current language sef or the default one.
if (!$this->params->get('remove_default_prefix', 0)
|| $lang_code != JComponentHelper::getParams('com_languages')->get('site', 'en-GB'))
{
$path = $this->lang_codes[$lang_code]->sef . '/' . $path;
}
$uri->setPath($path);
if (!$this->app->get('sef_rewrite'))
{
$uri->setPath('index.php/' . $uri->getPath());
}
$this->app->redirect($uri->base() . $uri->toString(array('path', 'query', 'fragment')));
}
else
{
$uri->setVar('lang', $this->lang_codes[$lang_code]->sef);
$this->app->redirect($uri->base() . 'index.php?' . $uri->getQuery());
}
}
// We have found our language and now need to set the cookie and the language value in our system
$array = array('lang' => $lang_code);
$this->default_lang = $lang_code;
// Set the request var.
$this->app->input->set('language', $lang_code);
$this->app->set('language', $lang_code);
$language = JFactory::getLanguage();
if ($language->getTag() != $lang_code)
{
$newLang = JLanguage::getInstance($lang_code);
foreach ($language->getPaths() as $extension => $files)
{
$newLang->load($extension);
}
JFactory::$language = $newLang;
$this->app->loadLanguage($newLang);
}
// Create a cookie.
if ($this->app->input->cookie->getString(JApplicationHelper::getHash('language')) != $lang_code)
{
$cookie_domain = $this->app->get('cookie_domain');
$cookie_path = $this->app->get('cookie_path', $uri->base(true));
$this->app->input->cookie->set(JApplicationHelper::getHash('language'), $lang_code, $this->getLangCookieTime(), $cookie_path, $cookie_domain);
}
return $array;
}
/**
* Before store user method.
*
* Method is called before user data is stored in the database.
*
* @param array $user Holds the old user data.
* @param boolean $isnew True if a new user is stored.
* @param array $new Holds the new user data.
*
* @return void
*
* @since 1.6
*/
public function onUserBeforeSave($user, $isnew, $new)
{
if ($this->params->get('automatic_change', '1') == '1' && key_exists('params', $user))
{
$registry = new Registry;
$registry->loadString($user['params']);
$this->user_lang_code = $registry->get('language');
if (empty($this->user_lang_code))
{
$this->user_lang_code = $this->default_lang;
}
}
}
/**
* After store user method.
*
* Method is called after user data is stored in the database.
*
* @param array $user Holds the new user data.
* @param boolean $isnew True if a new user is stored.
* @param boolean $success True if user was succesfully stored in the database.
* @param string $msg Message.
*
* @return void
*
* @since 1.6
*/
public function onUserAfterSave($user, $isnew, $success, $msg)
{
if ($this->params->get('automatic_change', '1') == '1' && key_exists('params', $user) && $success)
{
$registry = new Registry;
$registry->loadString($user['params']);
$lang_code = $registry->get('language');
if (empty($lang_code))
{
$lang_code = $this->default_lang;
}
if ($lang_code == $this->user_lang_code || !isset($this->lang_codes[$lang_code]))
{
if ($this->app->isSite())
{
$this->app->setUserState('com_users.edit.profile.redirect', null);
}
}
else
{
if ($this->app->isSite())
{
$this->app->setUserState('com_users.edit.profile.redirect', 'index.php?Itemid='
. $this->app->getMenu()->getDefault($lang_code)->id . '&lang=' . $this->lang_codes[$lang_code]->sef
);
// Create a cookie.
$cookie_domain = $this->app->get('cookie_domain', '');
$cookie_path = $this->app->get('cookie_path', '/');
setcookie(JApplicationHelper::getHash('language'), $lang_code, $this->getLangCookieTime(), $cookie_path, $cookie_domain);
}
}
}
}
/**
* Method to handle any login logic and report back to the subject.
*
* @param array $user Holds the user data.
* @param array $options Array holding options (remember, autoregister, group).
*
* @return boolean True on success.
*
* @since 1.5
*/
public function onUserLogin($user, $options = array())
{
$menu = $this->app->getMenu();
if ($this->app->isSite() && $this->params->get('automatic_change', 1))
{
// Load associations.
$assoc = JLanguageAssociations::isEnabled();
if ($assoc)
{
$active = $menu->getActive();
if ($active)
{
$associations = MenusHelper::getAssociations($active->id);
}
}
$lang_code = $user['language'];
if (empty($lang_code))
{
$lang_code = $this->default_lang;
}
if ($lang_code != $this->default_lang)
{
// Change language.
$this->default_lang = $lang_code;
// Create a cookie.
$cookie_domain = $this->app->get('cookie_domain', '');
$cookie_path = $this->app->get('cookie_path', '/');
setcookie(JApplicationHelper::getHash('language'), $lang_code, $this->getLangCookieTime(), $cookie_path, $cookie_domain);
// Change the language code.
JFactory::getLanguage()->setLanguage($lang_code);
// Change the redirect (language has changed).
if (isset($associations[$lang_code]) && $menu->getItem($associations[$lang_code]))
{
$itemid = $associations[$lang_code];
$this->app->setUserState('users.login.form.return', 'index.php?&Itemid=' . $itemid);
}
else
{
JLoader::register('MultilangstatusHelper', JPATH_ADMINISTRATOR . '/components/com_languages/helpers/multilangstatus.php');
$homes = MultilangstatusHelper::getHomepages();
$itemid = isset($homes[$lang_code]) ? $homes[$lang_code]->id : $homes['*']->id;
$this->app->setUserState('users.login.form.return', 'index.php?&Itemid=' . $itemid);
}
}
}
}
/**
* Method to add alternative meta tags for associated menu items.
*
* @return void
*
* @since 1.7
*/
public function onAfterDispatch()
{
$doc = JFactory::getDocument();
$menu = $this->app->getMenu();
$server = JUri::getInstance()->toString(array('scheme', 'host', 'port'));
$option = $this->app->input->get('option');
$eName = JString::ucfirst(JString::str_ireplace('com_', '', $option));
if ($this->app->isSite() && $this->params->get('alternate_meta') && $doc->getType() == 'html')
{
// Get active menu item.
$active = $menu->getActive();
$assocs = array();
$home = false;
// Load menu associations.
if ($active)
{
$active_link = JRoute::_($active->link . '&Itemid=' . $active->id, false);
// Get current link.
$current_link = JUri::getInstance()->toString(array('path', 'query'));
// Check the exact menu item's URL.
if ($active_link == $current_link)
{
$associations = MenusHelper::getAssociations($active->id);
unset($associations[$active->language]);
$assocs = array_keys($associations);
// If the menu item is a home menu item and the URLs are identical, we are on the homepage
$home = true;
}
}
// Load component associations.
$cName = JString::ucfirst($eName . 'HelperAssociation');
JLoader::register($cName, JPath::clean(JPATH_COMPONENT_SITE . '/helpers/association.php'));
if (class_exists($cName) && is_callable(array($cName, 'getAssociations')))
{
$cassociations = call_user_func(array($cName, 'getAssociations'));
$lang_code = $this->app->input->cookie->getString(JApplicationHelper::getHash('language'));
// No cookie - let's try to detect browser language or use site default.
if (!$lang_code)
{
if ($this->params->get('detect_browser', 1))
{
$lang_code = JLanguageHelper::detectLanguage();
}
else
{
$lang_code = $this->default_lang;
}
}
unset($cassociations[$lang_code]);
$assocs = array_merge(array_keys($cassociations), $assocs);
}
// Handle the default associations.
if ($this->params->get('item_associations') || ($active && $active->home && $home))
{
$languages = JLanguageHelper::getLanguages('lang_code');
foreach ($assocs as $language)
{
if (!JLanguage::exists($language))
{
continue;
}
$lang = $languages[$language];
if (isset($cassociations[$language]))
{
$link = JRoute::_($cassociations[$language] . '&lang=' . $lang->sef);
// Check if language is the default site language and remove url language code is on
if ($lang->sef == $this->lang_codes[$this->default_lang]->sef && $this->params->get('remove_default_prefix') == '1')
{
$link = preg_replace('|/' . $lang->sef . '/|', '/', $link, 1);
}
$doc->addHeadLink($server . $link, 'alternate', 'rel', array('hreflang' => $language));
}
elseif (isset($associations[$language]))
{
$item = $menu->getItem($associations[$language]);
if ($item)
{
$link = JRoute::_($item->link . '&Itemid=' . $item->id . '&lang=' . $lang->sef);
$doc->addHeadLink($server . $link, 'alternate', 'rel', array('hreflang' => $language));
}
}
}
}
}
}
/**
* Get the language cookie settings.
*
* @return string The cookie time.
*
* @since 3.0.4
*/
private function getLangCookieTime()
{
if ($this->params->get('lang_cookie', 1) == 1)
{
$lang_cookie = time() + 365 * 86400;
}
else
{
$lang_cookie = 0;
}
return $lang_cookie;
}
}
The same content is in 2 releases, Joomla 3.4.0-rc to 3.4.0. See them all, or every version of this file.