Skip to content

Commit c91305c

Browse files
author
Jan Petr
authored
Merge pull request #930 from algolia/develop
Develop
2 parents 2201ddd + e1767d5 commit c91305c

File tree

14 files changed

+195
-18
lines changed

14 files changed

+195
-18
lines changed

‎CHANGELOG.md

+16
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,21 @@
11
## CHANGE LOG
22

3+
### 1.12.0
4+
5+
Since this release, the extension is **Enterprise Edition compliant**!
6+
7+
## FEATURES
8+
- Experimental feature to prevent backend rendering of category and search results pages (#886)
9+
- Use very carefully and read [documentation](https://community.algolia.com/magento/doc/m1/prevent-backend-rendering/) before enabling it
10+
- Introduced events and developer attributes to force add / remove product(s) to / from Algolia (#922)
11+
- Added to option to turn off administration top bar with information about queue (#920)
12+
13+
## UPDATES
14+
- Changed some links in the configuration
15+
16+
## FIXES
17+
- Fixed failing database migration for creation of queue log table (#927)
18+
319
### 1.11.1
420

521
- Query rules are preserved during reindex with indexing queue enabled (#913)

‎README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Algolia Search for Magento 1.6+
22
==================
33

4-
![Latest version](https://img.shields.io/badge/latest-1.11.1-green.svg)
4+
![Latest version](https://img.shields.io/badge/latest-1.12.0-green.svg)
55

66
[![Build Status](https://travis-ci.org/algolia/algoliasearch-magento.svg?branch=master)](https://travis-ci.org/algolia/algoliasearch-magento)
77
![PHP >= 5.3](https://img.shields.io/badge/php-%3E=5.3-green.svg)

‎app/code/community/Algolia/Algoliasearch/Block/Adminhtml/Notifications.php

+8
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,14 @@ public function getConfigurationUrl()
77
return $this->getUrl('adminhtml/system_config/edit/section/algoliasearch');
88
}
99

10+
public function showNotification()
11+
{
12+
/** @var Algolia_Algoliasearch_Helper_Config $config */
13+
$config = Mage::helper('algoliasearch/config');
14+
15+
return $config->showQueueNotificiation();
16+
}
17+
1018
public function getQueueInfo()
1119
{
1220
/** @var Algolia_Algoliasearch_Helper_Config $config */

‎app/code/community/Algolia/Algoliasearch/Helper/Algoliahelper.php

+10-6
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,12 @@ class Algolia_Algoliasearch_Helper_Algoliahelper extends Mage_Core_Helper_Abstra
1212
/** @var Algolia_Algoliasearch_Helper_Config */
1313
protected $config;
1414

15+
/** @var int */
16+
protected $maxRecordSize = 20000;
17+
18+
/** @var array */
19+
protected $potentiallyLongAttributes = array('description', 'short_description', 'meta_description', 'content');
20+
1521
/** @var string */
1622
private $lastUsedIndexName;
1723

@@ -287,26 +293,24 @@ private function prepareRecords(&$objects, $indexName)
287293
if (!empty($modifiedIds)) {
288294
/** @var Mage_Adminhtml_Model_Session $session */
289295
$session = Mage::getSingleton('adminhtml/session');
290-
$session->addWarning('Algolia reindexing : You have some records ('.implode(',', $modifiedIds).') that are too big. They have either been truncated or skipped');
296+
$session->addWarning('Algolia reindexing : You have some records ('.implode(',', $modifiedIds).') that are too big. They have either been truncated or skipped.');
291297
}
292298
}
293299

294300
public function handleTooBigRecord(&$object)
295301
{
296-
$longAttributes = array('description', 'short_description', 'meta_description', 'content');
297-
298302
$size = mb_strlen(json_encode($object));
299303

300-
if ($size > 20000) {
301-
foreach ($longAttributes as $attribute) {
304+
if ($size > $this->maxRecordSize) {
305+
foreach ($this->potentiallyLongAttributes as $attribute) {
302306
if (isset($object[$attribute])) {
303307
unset($object[$attribute]);
304308
}
305309
}
306310

307311
$size = mb_strlen(json_encode($object));
308312

309-
if ($size > 20000) {
313+
if ($size > $this->maxRecordSize) {
310314
$object = false;
311315
}
312316
}

‎app/code/community/Algolia/Algoliasearch/Helper/Config.php

+37
Original file line numberDiff line numberDiff line change
@@ -73,9 +73,12 @@ class Algolia_Algoliasearch_Helper_Config extends Mage_Core_Helper_Abstract
7373
const CUSTOMER_GROUPS_ENABLE = 'algoliasearch/advanced/customer_groups_enable';
7474
const MAKE_SEO_REQUEST = 'algoliasearch/advanced/make_seo_request';
7575
const REMOVE_BRANDING = 'algoliasearch/advanced/remove_branding';
76+
const SHOW_QUEUE_NOTIFICATION = 'algoliasearch/advanced/show_queue_notification';
7677
const AUTOCOMPLETE_SELECTOR = 'algoliasearch/advanced/autocomplete_selector';
7778
const INDEX_PRODUCT_ON_CATEGORY_PRODUCTS_UPDATE = 'algoliasearch/advanced/index_product_on_category_products_update';
7879
const INDEX_ALL_CATEGORY_PRODUCTS_ON_CATEGORY_UPDATE = 'algoliasearch/advanced/index_all_category_product_on_category_update';
80+
const PREVENT_BACKEND_RENDERING = 'algoliasearch/advanced/prevent_backend_rendering';
81+
const BACKEND_RENDERING_ALLOWED_USER_AGENTS = 'algoliasearch/advanced/backend_rendering_allowed_user_agents';
7982

8083
const SHOW_OUT_OF_STOCK = 'cataloginventory/options/show_out_of_stock';
8184
const LOGGING_ENABLED = 'algoliasearch/credentials/debug';
@@ -244,6 +247,11 @@ public function isRemoveBranding($storeId = null)
244247
return Mage::getStoreConfigFlag(self::REMOVE_BRANDING, $storeId);
245248
}
246249

250+
public function showQueueNotificiation($storeId = null)
251+
{
252+
return Mage::getStoreConfigFlag(self::SHOW_QUEUE_NOTIFICATION, $storeId);
253+
}
254+
247255
public function getMaxValuesPerFacet($storeId = null)
248256
{
249257
return Mage::getStoreConfig(self::MAX_VALUES_PER_FACET, $storeId);
@@ -633,6 +641,35 @@ public function getExtraSettings($section, $storeId = null)
633641
return trim(Mage::getStoreConfig(constant('self::'.$constant), $storeId));
634642
}
635643

644+
public function preventBackendRendering($storeId = null)
645+
{
646+
$preventBackendRendering = Mage::getStoreConfigFlag(self::PREVENT_BACKEND_RENDERING, $storeId);
647+
648+
if ($preventBackendRendering === false) {
649+
return false;
650+
}
651+
652+
$userAgent = mb_strtolower($_SERVER['HTTP_USER_AGENT'], 'utf-8');
653+
654+
$allowedUserAgents = Mage::getStoreConfig(self::BACKEND_RENDERING_ALLOWED_USER_AGENTS, $storeId);
655+
$allowedUserAgents = trim($allowedUserAgents);
656+
657+
if ($allowedUserAgents === '') {
658+
return true;
659+
}
660+
661+
$allowedUserAgents = explode("\n", $allowedUserAgents);
662+
663+
foreach ($allowedUserAgents as $allowedUserAgent) {
664+
$allowedUserAgent = mb_strtolower($allowedUserAgent, 'utf-8');
665+
if (strpos($userAgent, $allowedUserAgent) !== false) {
666+
return false;
667+
}
668+
}
669+
670+
return true;
671+
}
672+
636673
private function getCustomRanking($configName, $storeId = null)
637674
{
638675
$attrs = unserialize(Mage::getStoreConfig($configName, $storeId));

‎app/code/community/Algolia/Algoliasearch/Helper/Data.php

+11-2
Original file line numberDiff line numberDiff line change
@@ -476,6 +476,16 @@ protected function getProductsRecords($storeId, $collection, $potentiallyDeleted
476476
unset($potentiallyDeletedProductsIds[$productId]);
477477
}
478478

479+
Mage::dispatchEvent('algolia_before_product_availability_check', array('product' => $product, 'store' => $storeId));
480+
481+
if ($product->getData('algolia__noIndex') === true) {
482+
$productsToRemove[$productId] = $productId;
483+
}
484+
485+
if ($product->getData('algolia__alwaysIndex') === true) {
486+
$productsToIndex[$productId] = $this->product_helper->getObject($product);
487+
}
488+
479489
if (isset($productsToIndex[$productId]) || isset($productsToRemove[$productId])) {
480490
continue;
481491
}
@@ -489,8 +499,7 @@ protected function getProductsRecords($storeId, $collection, $potentiallyDeleted
489499
continue;
490500
}
491501

492-
$productObject = $this->product_helper->getObject($product);
493-
$productsToIndex[$productId] = $productObject;
502+
$productsToIndex[$productId] = $this->product_helper->getObject($product);
494503
}
495504

496505
$productsToRemove = array_merge($productsToRemove, $potentiallyDeletedProductsIds);

‎app/code/community/Algolia/Algoliasearch/Model/Observer.php

+4
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,10 @@ public function useAlgoliaSearchPopup(Varien_Event_Observer $observer)
7676
} else {
7777
$observer->getLayout()->getUpdate()->addHandle('algolia_search_handle_no_topsearch');
7878
}
79+
80+
if ($this->config->preventBackendRendering() === true) {
81+
$observer->getLayout()->getUpdate()->addHandle('algolia_search_handle_prevent_backend_rendering');
82+
}
7983
}
8084
}
8185
}

‎app/code/community/Algolia/Algoliasearch/etc/config.xml

+5-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<config>
33
<modules>
44
<Algolia_Algoliasearch>
5-
<version>1.11.1</version>
5+
<version>1.12.0</version>
66
</Algolia_Algoliasearch>
77
</modules>
88
<frontend>
@@ -246,9 +246,13 @@
246246
<partial_update>0</partial_update>
247247
<make_seo_request>1</make_seo_request>
248248
<remove_branding>0</remove_branding>
249+
<show_queue_notification>1</show_queue_notification>
249250
<autocomplete_selector>.algolia-search-input</autocomplete_selector>
250251
<index_product_on_category_products_update>1</index_product_on_category_products_update>
251252
<index_all_category_product_on_category_update>0</index_all_category_product_on_category_update>
253+
<prevent_backend_rendering>0</prevent_backend_rendering>
254+
<backend_rendering_allowed_user_agents>Googlebot
255+
Bingbot</backend_rendering_allowed_user_agents>
252256
</advanced>
253257
<product_map>
254258
<!--

‎app/code/community/Algolia/Algoliasearch/etc/system.xml

+44-5
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<algoliasearch translate="label" module="algoliasearch">
55
<label>
66
<![CDATA[
7-
Algolia Search 1.11.1
7+
Algolia Search 1.12.0
88
<style>
99
.algoliasearch-admin-menu span {
1010
padding-left: 38px !important;
@@ -939,7 +939,7 @@
939939
<table>
940940
<tr>
941941
<td>Synonyms documentation:</td>
942-
<td><a target="_blank" href="https://www.algolia.com/doc/synonyms/?utm_source=magento&utm_medium=extension&utm_campaign=magento_1&utm_term=shop-owner&utm_content=doc-link">https://www.algolia.com/doc/synonyms</a></td>
942+
<td><a target="_blank" href="https://www.algolia.com/doc/guides/textual-relevance/synonyms/?utm_source=magento&utm_medium=extension&utm_campaign=magento_1&utm_term=shop-owner&utm_content=doc-link">https://www.algolia.com/doc/guides/textual-relevance/synonyms/</a></td>
943943
</tr>
944944
</table>
945945
<br>
@@ -975,7 +975,7 @@
975975
Synonyms are defined by a comma-separated list of words that should be considered equivalent by the Algolia engine.<br>
976976
For instance: <code>tv, television, tv set</code><br>
977977
Using that set, if a record contains “television” and a user searches for “TV”, this record will be returned.<br>
978-
Documentation: <a href="https://www.algolia.com/doc/synonyms#synonyms" target="_blank">https://www.algolia.com/doc/synonyms#synonyms</a>
978+
Documentation: <a href="https://www.algolia.com/doc/guides/textual-relevance/synonyms/#regular-synonyms" target="_blank">https://www.algolia.com/doc/guides/textual-relevance/synonyms/#regular-synonyms</a>
979979
]]>
980980
</comment>
981981
</synonyms>
@@ -992,7 +992,7 @@
992992
One-way synonyms allow you to define alternative words for a search term, which are not synonyms to each others.<br>
993993
Let’s take an example: when a user searches for “tablet”, you want him to be able to find iPads and Galaxy Note tablets alike, but you might not want Android tablets to show up when he searches for “iPad”.<br>
994994
To do this, you’d define a one-way synonyms set between <code>tablet</code> (as input) and <code>ipad, galaxy note</code> (as synonyms). When the user types in “tablet”, records containing “iPad” and “Galaxy Note” will be returned. However records containing only “tablet” or “Galaxy Note” won’t be returned if he searches for “iPad”.<br>
995-
Documentation: <a href="https://www.algolia.com/doc/synonyms#one-way-synonyms" target="_blank">https://www.algolia.com/doc/synonyms#one-way-synonyms</a>
995+
Documentation: <a href="https://www.algolia.com/doc/guides/textual-relevance/synonyms/#one-way-synonyms" target="_blank">https://www.algolia.com/doc/guides/textual-relevance/synonyms/#one-way-synonyms</a>
996996
<br>
997997
<br>
998998
Algolia offers more synonymys’ types - placeholders and alternative corrections. These types can be managed directly from your <a href="https://www.algolia.com/dashboard" target="_blank">Algolia’s dashboard</a>.
@@ -1093,6 +1093,15 @@
10931093
<show_in_store>1</show_in_store>
10941094
<comment>Choose here if the algolia logo is added to the drop-down template.</comment>
10951095
</remove_branding>
1096+
<show_queue_notification translate="label comment">
1097+
<label>Show queue information panel in administration header</label>
1098+
<frontend_type>select</frontend_type>
1099+
<source_model>adminhtml/system_config_source_yesno</source_model>
1100+
<sort_order>45</sort_order>
1101+
<show_in_default>1</show_in_default>
1102+
<show_in_website>1</show_in_website>
1103+
<show_in_store>1</show_in_store>
1104+
</show_queue_notification>
10961105
<autocomplete_selector translate="label comment">
10971106
<label>Search input DOM Selector</label>
10981107
<frontend_type>text</frontend_type>
@@ -1134,6 +1143,36 @@
11341143
]]>
11351144
</comment>
11361145
</index_all_category_product_on_category_update>
1146+
<prevent_backend_rendering translate="label comment">
1147+
<label>Prevent backend rendering?</label>
1148+
<frontend_type>select</frontend_type>
1149+
<source_model>adminhtml/system_config_source_yesno</source_model>
1150+
<sort_order>90</sort_order>
1151+
<show_in_default>1</show_in_default>
1152+
<show_in_website>1</show_in_website>
1153+
<show_in_store>1</show_in_store>
1154+
<comment>
1155+
<![CDATA[
1156+
<span class="algolia-config-warning">&#9888;</span>
1157+
By preventing your store from backend rendering you might break your SEO and accessibility of your store by search crawlers. Please, read documentation before you turn the backend rendering off:
1158+
<a target="_blank" href="https://community.algolia.com/magento/doc/m1/prevent-backend-rendering/?utm_source=magento&utm_medium=extension&utm_campaign=magento_1&utm_term=shop-owner&utm_content=doc-link">Prevent Backend Rendering documentation</a>
1159+
]]>
1160+
</comment>
1161+
</prevent_backend_rendering>
1162+
<backend_rendering_allowed_user_agents translate="label comment">
1163+
<label>Allow backend rendering for User Agents:</label>
1164+
<frontend_type>textarea</frontend_type>
1165+
<sort_order>100</sort_order>
1166+
<show_in_default>1</show_in_default>
1167+
<show_in_website>1</show_in_website>
1168+
<show_in_store>1</show_in_store>
1169+
<comment>
1170+
<![CDATA[
1171+
To specify multiple User-Agents, please put one User-Agent per line.
1172+
]]>
1173+
</comment>
1174+
<depends><prevent_backend_rendering>1</prevent_backend_rendering></depends>
1175+
</backend_rendering_allowed_user_agents>
11371176
</fields>
11381177
</advanced>
11391178
<advanced_settings translate="label">
@@ -1153,7 +1192,7 @@
11531192
Example: <code>{"exactOnSingleWordQuery":"word"}</code>
11541193
</p>
11551194
1156-
<p>List of possible settings: <a href="https://www.algolia.com/doc/api-client/default/settings/#index-settings-parameters" target="_blank">https://www.algolia.com/doc/api-client/default/settings/#index-settings-parameters</a></p>
1195+
<p>List of possible settings: <a href="https://www.algolia.com/doc/api-reference/settings-api-parameters/#index-settings-parameters" target="_blank">https://www.algolia.com/doc/api-reference/settings-api-parameters/#index-settings-parameters</a></p>
11571196
11581197
<p><span class="algolia-config-warning">&#9888;</span> Edit extra settings only when you're sure what you're doing. Bad settings can effect your search functionality and have a bad impact on your relevance.</p>
11591198
]]>

‎app/code/community/Algolia/Algoliasearch/sql/algoliasearch_setup/mysql4-upgrade-1.11.1-1.12.0.php

+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
<?php
2+
3+
// This migration is the same to 1.11.1
4+
// That one didn't work when migrating from newer versions then 1.7.1
5+
6+
/** @var Mage_Core_Model_Resource_Setup $installer */
7+
$installer = $this;
8+
$installer->startSetup();
9+
10+
$tableName = $installer->getTable('algoliasearch/queue');
11+
12+
$installer->getConnection()->addColumn($tableName, 'created', array(
13+
'type' => Varien_Db_Ddl_Table::TYPE_DATETIME,
14+
'after' => 'job_id',
15+
'nullable' => true,
16+
'comment' => 'Time of job creation',
17+
));
18+
19+
$installer->run("
20+
CREATE TABLE IF NOT EXISTS `{$tableName}_log` (
21+
`id` INT(20) NOT NULL auto_increment,
22+
`started` DATETIME NOT NULL,
23+
`duration` INT(20) NOT NULL,
24+
`processed_jobs` INT NOT NULL,
25+
`with_empty_queue` INT(1) NOT NULL,
26+
PRIMARY KEY `id` (`id`)
27+
) ENGINE=InnoDB DEFAULT CHARACTER SET=utf8 AUTO_INCREMENT=1;
28+
");
29+
30+
$installer->endSetup();

‎app/design/adminhtml/default/default/template/algoliasearch/notifications.phtml

+4
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22

33
/** @var Algolia_Algoliasearch_Block_Adminhtml_Notifications $this */
44

5+
if ($this->showNotification() === false) {
6+
return;
7+
}
8+
59
$queueInfo = $this->getQueueInfo();
610

711
?>

‎app/design/frontend/base/default/layout/algoliasearch.xml

+22
Original file line numberDiff line numberDiff line change
@@ -63,4 +63,26 @@
6363
<block type="core/template" template="algoliasearch/autocomplete.phtml" name="algolia-autocomplete"/>
6464
</reference>
6565
</algolia_search_handle_no_topsearch>
66+
67+
<algolia_search_handle_prevent_backend_rendering>
68+
<reference name="left_first">
69+
<action method="unsetChild"><name>catalog.leftnav</name></action>
70+
<action method="unsetChild"><name>catalogsearch.leftnav</name></action>
71+
</reference>
72+
73+
<reference name="left">
74+
<action method="unsetChild"><name>tags_popular</name></action>
75+
</reference>
76+
77+
<reference name="content">
78+
<action method="unsetChild"><name>category.products</name></action>
79+
<action method="unsetChild"><name>search.result</name></action>
80+
</reference>
81+
82+
<reference name="right">
83+
<action method="unsetChild"><name>right.reports.product.viewed</name></action>
84+
<action method="unsetChild"><name>left.reports.product.viewed</name></action>
85+
<action method="unsetChild"><name>right.poll</name></action>
86+
</reference>
87+
</algolia_search_handle_prevent_backend_rendering>
6688
</layout>

‎app/etc/modules/Algolia_Algoliasearch.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<Algolia_Algoliasearch>
55
<active>true</active>
66
<codePool>community</codePool>
7-
<version>1.11.1</version>
7+
<version>1.12.0</version>
88
</Algolia_Algoliasearch>
99
</modules>
1010
</config>

0 commit comments

Comments
 (0)