Viewing file:  GadgetContext.php (8.69 KB) -rwxr-xr-x
Select action/file-type:
 (+) |  (+) |  (+) | Code (+) | Session (+) |  (+) | SDB (+) |  (+) |  (+) |  (+) |  (+) |  (+) |
<?php
/**
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
/*
* GadgetContext contains all contextual variables and classes that are relevant for this request,
* such as url, httpFetcher, feature registry, etc.
* Server wide variables are stored in config.php
*/
class GadgetContext {
const DEFAULT_VIEW = 'profile';
protected $httpFetcher = null;
protected $locale = null;
protected $renderingContext = null;
protected $registry = null;
protected $view = null;
protected $moduleId = null;
protected $url = null;
protected $cache = null;
protected $blacklist = null;
protected $ignoreCache = null;
protected $forcedJsLibs = null;
protected $containerConfig = null;
protected $container = null;
protected $refreshInterval;
public function __construct($renderingContext) {
// Rendering context is set by the calling event handler (either GADGET or CONTAINER)
$this->setRenderingContext($renderingContext);
// Request variables
$this->setIgnoreCache($this->getIgnoreCacheParam());
$this->setForcedJsLibs($this->getFocedJsLibsParam());
$this->setUrl($this->getUrlParam());
$this->setModuleId($this->getModuleIdParam());
$this->setView($this->getViewParam());
$this->setContainer($this->getContainerParam());
$this->setRefreshInterval($this->getRefreshIntervalParam());
//NOTE All classes are initialized when called (aka lazy loading) because we don't need all of them in every situation
}
private function getRefreshIntervalParam() {
return isset($_GET['refresh']) ? $_GET['refresh'] : Config::get('default_refresh_interval');
}
private function getContainerParam() {
$container = 'default';
if (! empty($_GET['container'])) {
$container = $_GET['container'];
} elseif (! empty($_POST['container'])) {
$container = $_POST['container'];
//FIXME The paramater used to be called 'synd' & is scheduled for removal
} elseif (! empty($_GET['synd'])) {
$container = $_GET['synd'];
} elseif (! empty($_POST['synd'])) {
$container = $_POST['synd'];
}
return $container;
}
private function getIgnoreCacheParam() {
// Support both the old Orkut style &bpc and new standard style &nocache= params
return (isset($_GET['nocache']) && intval($_GET['nocache']) == 1) || (isset($_GET['bpc']) && intval($_GET['bpc']) == 1);
}
private function getFocedJsLibsParam() {
return isset($_GET['libs']) ? trim($_GET['libs']) : null;
}
private function getUrlParam() {
if (! empty($_GET['url'])) {
return $_GET['url'];
} elseif (! empty($_POST['url'])) {
return $_POST['url'];
}
return null;
}
private function getModuleIdParam() {
return isset($_GET['mid']) && is_numeric($_GET['mid']) ? intval($_GET['mid']) : 0;
}
private function getViewParam() {
return ! empty($_GET['view']) ? $_GET['view'] : self::DEFAULT_VIEW;
}
private function instanceBlacklist() {
$blackListClass = Config::get('blacklist_class');
if (! empty($blackListClass)) {
return new $blackListClass();
} else {
return null;
}
}
private function instanceHttpFetcher() {
$remoteContent = Config::get('remote_content');
return new $remoteContent();
}
private function instanceRegistry() {
// feature parsing is very resource intensive so by caching the result this saves upto 30% of the processing time
$featureCache = Cache::createCache(Config::get('feature_cache'), 'FeatureCache');
if (! ($registry = $featureCache->get(md5(Config::get('features_path'))))) {
$registry = new GadgetFeatureRegistry(Config::get('features_path'));
$featureCache->set(md5(Config::get('features_path')), $registry);
}
return $registry;
}
private function instanceLocale() {
// Get language and country params, try the GET params first, if their not set try the POST, else use 'all' as default
$language = ! empty($_GET['lang']) ? $_GET['lang'] : (! empty($_POST['lang']) ? $_POST['lang'] : 'all');
$country = ! empty($_GET['country']) ? $_GET['country'] : (! empty($_POST['country']) ? $_POST['country'] : 'all');
return array('lang' => strtolower($language), 'country' => strtoupper($country));
}
private function instanceContainerConfig() {
return new ContainerConfig(Config::get('container_path'));
}
public function getContainer() {
return $this->container;
}
public function getContainerConfig() {
if ($this->containerConfig == null) {
$this->containerConfig = $this->instanceContainerConfig();
}
return $this->containerConfig;
}
public function getModuleId() {
return $this->moduleId;
}
public function getRegistry() {
if ($this->registry == null) {
$this->setRegistry($this->instanceRegistry());
}
return $this->registry;
}
public function getUrl() {
return $this->url;
}
public function getView() {
return $this->view;
}
public function setRefreshInterval($interval) {
$this->refreshInterval = $interval;
}
public function setContainer($container) {
$this->container = $container;
}
public function setContainerConfig($containerConfig) {
$this->containerConfig = $containerConfig;
}
public function setBlacklist($blacklist) {
$this->blacklist = $blacklist;
}
public function setCache($cache) {
$this->cache = $cache;
}
public function setHttpFetcher($httpFetcher) {
$this->httpFetcher = $httpFetcher;
}
public function setLocale($locale) {
$this->locale = $locale;
}
public function setModuleId($moduleId) {
$this->moduleId = $moduleId;
}
public function setRegistry($registry) {
$this->registry = $registry;
}
public function setRenderingContext($renderingContext) {
$this->renderingContext = $renderingContext;
}
public function setUrl($url) {
$this->url = $url;
}
public function setView($view) {
$this->view = $view;
}
public function setIgnoreCache($ignoreCache) {
$this->ignoreCache = $ignoreCache;
}
public function setForcedJsLibs($forcedJsLibs) {
$this->forcedJsLibs = $forcedJsLibs;
}
public function getRefreshInterval() {
return $this->refreshInterval;
}
public function getIgnoreCache() {
return $this->ignoreCache;
}
public function getForcedJsLibs() {
return $this->forcedJsLibs;
}
public function getBlacklist() {
if ($this->blacklist == null) {
$this->setBlacklist($this->instanceBlacklist());
}
return $this->blacklist;
}
public function getRenderingContext() {
return $this->renderingContext;
}
public function getHttpFetcher() {
if ($this->httpFetcher == null) {
$this->setHttpFetcher($this->instanceHttpFetcher());
}
return $this->httpFetcher;
}
public function getLocale() {
if ($this->locale == null) {
$this->setLocale($this->instanceLocale());
}
return $this->locale;
}
/**
* Extracts the 'st' token from the GET or POST params and calls the
* signer to validate the token
*
* @param SecurityTokenDecoder $signer the signer to use (configured in config.php)
* @return SecurityToken An object representation of the token data.
*/
public function extractAndValidateToken($signer) {
if ($signer == null) {
return null;
}
$token = isset($_GET["st"]) ? $_GET["st"] : '';
if (! isset($token) || $token == '') {
$token = isset($_POST['st']) ? $_POST['st'] : '';
}
return $this->validateToken($token, $signer);
}
/**
* Validates a passed-in token.
*
* @param string $token A urlencoded base64 encoded security token.
* @param SecurityTokenDecoder $signer The signer to use (configured in config.php)
* @return SecurityToken An object representation of the token data.
*/
public function validateToken($token, $signer) {
if (count(explode(':', $token)) != 7) {
$token = urldecode(base64_decode($token));
}
if (empty($token)) {
throw new Exception("Missing or invalid security token");
}
return $signer->createToken($token);
}
}
|