public static function invalidateGadgetCache(GadgetContext $context)
{
$request = new RemoteContentRequest($context->getUrl());
$cache = Cache::createCache(Shindig_Config::get('data_cache'), 'RemoteContent');
$cacheData = $cache->get($request->toHash());
if ($cacheData) {
$uris = array();
$xml = $cacheData->getResponseContent();
$parserClass = Shindig_Config::get('gadget_spec_parser');
$parser = new $parserClass();
$gadgetSpec = $parser->parse($xml, $context);
if ($gadgetSpec->locales) {
foreach ($gadgetSpec->locales as $locale) {
if (!empty($locale['messages'])) {
$uris[] = RemoteContentRequest::transformRelativeUrl($locale['messages'], $context->getUrl());
}
}
}
if (is_array($gadgetSpec->preloads)) {
foreach ($gadgetSpec->preloads as $preload) {
if (!empty($preload['href'])) {
$uris[] = RemoteContentRequest::transformRelativeUrl($preload['href'], $context->getUrl());
}
}
}
if (is_array($gadgetSpec->templatesRequireLibraries)) {
foreach ($gadgetSpec->templatesRequireLibraries as $libraryUrl) {
$uris[] = RemoteContentRequest::transformRelativeUrl($locale['messages'], $context->getUrl());
}
}
$uris[] = $request->getUrl();
self::invalidateRemoteContents($uris);
}
}
/**
* Fetches all remote resources simultaniously using a multiFetchRequest to optimize rendering time.
*
* The preloads will be json_encoded to their gadget document injection format, and the locales will
* be reduced to only the GadgetContext->getLocale matching entries.
*
* @param Gadget $gadget
* @param GadgetContext $context
*/
protected function fetchResources(Gadget &$gadget)
{
$contextLocale = $this->context->getLocale();
$unsignedRequests = $signedRequests = array();
foreach ($gadget->gadgetSpec->locales as $key => $locale) {
// Only fetch the locales that match the current context's language and country
if ($locale['country'] == 'all' && $locale['lang'] == 'all' || $locale['lang'] == $contextLocale['lang'] && $locale['country'] == 'all' || $locale['lang'] == $contextLocale['lang'] && $locale['country'] == $contextLocale['country']) {
if (!empty($locale['messages'])) {
$transformedUrl = RemoteContentRequest::transformRelativeUrl($locale['messages'], $this->context->getUrl());
if (!$transformedUrl) {
// remove any locales that are not applicable to this context
unset($gadget->gadgetSpec->locales[$key]);
continue;
} else {
$gadget->gadgetSpec->locales[$key]['messages'] = $transformedUrl;
}
// locale matches the current context, add it to the requests queue
$request = new RemoteContentRequest($gadget->gadgetSpec->locales[$key]['messages']);
$request->createRemoteContentRequestWithUri($gadget->gadgetSpec->locales[$key]['messages']);
$request->getOptions()->ignoreCache = $this->context->getIgnoreCache();
$unsignedRequests[] = $request;
}
} else {
// remove any locales that are not applicable to this context
unset($gadget->gadgetSpec->locales[$key]);
}
}
if (!$gadget->gadgetContext instanceof MetadataGadgetContext) {
// Add preloads to the request queue
foreach ($gadget->getPreloads() as $preload) {
if (!empty($preload['href'])) {
$request = new RemoteContentRequest($preload['href']);
if (!empty($preload['authz']) && $preload['authz'] == 'SIGNED') {
if ($this->token == '') {
throw new GadgetException("Signed preloading requested, but no valid security token set");
}
$request = new RemoteContentRequest($preload['href']);
$request->setAuthType(RemoteContentRequest::$AUTH_SIGNED);
$request->setNotSignedUri($preload['href']);
$request->setToken($this->token);
$request->getOptions()->ignoreCache = $this->context->getIgnoreCache();
if (strcasecmp($preload['signViewer'], 'false') == 0) {
$request->getOptions()->viewerSigned = false;
}
if (strcasecmp($preload['signOwner'], 'false') == 0) {
$request->getOptions()->ownerSigned = false;
}
$signedRequests[] = $request;
} else {
$request->createRemoteContentRequestWithUri($preload['href']);
$request->getOptions()->ignoreCache = $this->context->getIgnoreCache();
$unsignedRequests[] = $request;
}
}
}
// Add template libraries to the request queue
if ($gadget->gadgetSpec->templatesRequireLibraries) {
foreach ($gadget->gadgetSpec->templatesRequireLibraries as $key => $libraryUrl) {
$request = new RemoteContentRequest($libraryUrl);
$transformedUrl = RemoteContentRequest::transformRelativeUrl($libraryUrl, $this->context->getUrl());
if (!$transformedUrl) {
continue;
} else {
$gadget->gadgetSpec->templatesRequireLibraries[$key] = $transformedUrl;
}
$request->createRemoteContentRequestWithUri($gadget->gadgetSpec->templatesRequireLibraries[$key]);
$request->getOptions()->ignoreCache = $this->context->getIgnoreCache();
$unsignedRequests[] = $request;
}
}
}
// Perform the non-signed requests
$responses = array();
if (count($unsignedRequests)) {
$brc = new BasicRemoteContent();
$resps = $brc->multiFetch($unsignedRequests);
foreach ($resps as $response) {
$responses[$response->getUrl()] = array('body' => $response->getResponseContent(), 'rc' => $response->getHttpCode());
}
}
// Perform the signed requests
if (count($signedRequests)) {
$signingFetcherFactory = new SigningFetcherFactory(Config::get("private_key_file"));
$remoteFetcherClass = Config::get('remote_content_fetcher');
$remoteFetcher = new $remoteFetcherClass();
$remoteContent = new BasicRemoteContent($remoteFetcher, $signingFetcherFactory);
$resps = $remoteContent->multiFetch($signedRequests);
foreach ($resps as $response) {
$responses[$response->getNotSignedUrl()] = array('body' => $response->getResponseContent(), 'rc' => $response->getHttpCode());
}
}
// assign the results to the gadget locales and preloads (using the url as the key)
foreach ($gadget->gadgetSpec->locales as $key => $locale) {
if (!empty($locale['messages']) && isset($responses[$locale['messages']]) && $responses[$locale['messages']]['rc'] == 200) {
$gadget->gadgetSpec->locales[$key]['messageBundle'] = $this->parseMessageBundle($responses[$locale['messages']]['body']);
}
}
if (!$gadget->gadgetContext instanceof MetadataGadgetContext) {
$preloads = array();
foreach ($gadget->gadgetSpec->preloads as $key => $preload) {
if (!empty($preload['href']) && isset($responses[$preload['href']]) && $responses[$preload['href']]['rc'] == 200) {
$preloads[] = array_merge(array('id' => $preload['href']), $responses[$preload['href']]);
}
}
$gadget->gadgetSpec->preloads = $preloads;
if ($gadget->gadgetSpec->templatesRequireLibraries) {
$requiredLibraries = array();
foreach ($gadget->gadgetSpec->templatesRequireLibraries as $key => $libraryUrl) {
if (isset($responses[$libraryUrl]) && $responses[$libraryUrl]['rc'] == 200) {
$requiredLibraries[$libraryUrl] = $responses[$libraryUrl]['body'];
}
}
$gadget->gadgetSpec->templatesRequireLibraries = $requiredLibraries;
}
}
}
/**
* Builds the outgoing URL by taking the href attribute of the view and appending
* the country, lang, and opensocial query params to it
*
* @param array $view
* @param SecurityToken $token
* @param Gadget $gadget
* @return string the url
*/
private function buildHref($view, $authz, $gadget)
{
$href = RemoteContentRequest::transformRelativeUrl($gadget->substitutions->substituteUri(null, $view['href']), $this->context->getUrl());
if (empty($href)) {
throw new Exception("Invalid empty href in the gadget view");
}
// add the required country and lang param to the URL
$lang = isset($_GET['lang']) ? $_GET['lang'] : 'en';
$country = isset($_GET['country']) ? $_GET['country'] : 'US';
$firstSeperator = strpos($href, '?') === false ? '?' : '&';
$href .= $firstSeperator . 'lang=' . urlencode($lang);
$href .= '&country=' . urlencode($country);
if ($authz != 'none') {
$href .= '&opensocial_proxied_content=1';
}
return $href;
}
