Release 4.2.0

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,19 @@
+<!-----------------------------------------------------------------------------
+Thank you for contributing to the PrestaShop project! 
+
+Please take the time to edit the "Answers" rows below with the necessary information.
+
+Check out our contribution guidelines to find out how to complete it:
+https://devdocs.prestashop.com/1.7/contribute/contribution-guidelines/#pull-requests
+------------------------------------------------------------------------------>
+
+| Questions     | Answers
+| ------------- | -------------------------------------------------------
+| Description?  | Please be specific when describing the PR. <br> Every detail helps: versions, browser/server configuration, specific module/theme, etc. Feel free to add more information below this table.
+| Type?         | bug fix / improvement / new feature / refacto / critical
+| BC breaks?    | yes / no
+| Deprecations? | yes / no
+| Fixed ticket? | Fixes PrestaShop/Prestashop#{issue number here}.
+| How to test?  | Please indicate how to best verify that this PR is correct.
+
+<!-- Click the form's "Preview" button to make sure the table is functional in GitHub. Thank you! -->

.github/release-drafter.yml

@@ -0,0 +1,14 @@
+branches:
+  - master
+name-template: v$NEXT_PATCH_VERSION
+tag-template: v$NEXT_PATCH_VERSION
+categories:
+  - title: 🚀 Improvements
+    label: enhancement
+  - title: 🐛 Bug Fixes
+    label: bug
+change-template: '- #$NUMBER: $TITLE by @$AUTHOR'
+template: |
+  # Changes
+
+  $CHANGES

.gitignore

@@ -0,0 +1 @@
+/vendor

.travis.yml

@@ -0,0 +1,69 @@
+language: node_js
+
+notifications:
+  email:
+    on_success: never
+
+jobs:
+  include:
+    - stage: "PHP"
+      name: "PHPStan on PS nightly and unit tests"
+      language: php
+      php: 7.2
+      script:
+        - composer install
+        # PHP syntax check
+        - bash -c '! (find . -name "*.php" ! -path "./vendor/*" -print0 | xargs -0 -n1 -P4 php -l | grep "Parse error")'
+        # PHP cs fixer
+        # - composer run lint
+        # PHP Unit
+        # - composer run test
+        # PHP Stan
+        - docker run -tid --rm -v ps-volume:/var/www/html --name temp-ps prestashop/prestashop:nightly
+        # - docker exec -ti temp-ps rm -rf /var/www/html/modules/gsitemap
+        # - docker run --rm --volumes-from temp-ps -v $PWD:/var/www/html/modules/gsitemap -e _PS_ROOT_DIR_=/var/www/html quetzacoalt/phpstan analyse --configuration=/var/www/html/modules/gsitemap/tests/php/phpstan/phpstan.neon
+    - stage: "PHP"
+      name: "PHPStan on PS 1.7.5.2"
+      language: php
+      php: 7.2
+      script:
+        - composer install
+        - docker run -tid --rm -v ps-volume:/var/www/html --name temp-ps prestashop/prestashop:1.7.5.1
+        # - docker exec -ti temp-ps rm -rf /var/www/html/modules/gsitemap
+        # - docker run --rm --volumes-from temp-ps -v $PWD:/var/www/html/modules/gsitemap -e _PS_ROOT_DIR_=/var/www/html quetzacoalt/phpstan analyse --configuration=/var/www/html/modules/gsitemap/tests/php/phpstan/phpstan.neon
+    - stage: "PHP"
+      name: "PHPStan on PS 1.7.4.4"
+      language: php
+      php: 7.2
+      script:
+        - composer install
+        - docker run -tid --rm -v ps-volume:/var/www/html --name temp-ps prestashop/prestashop:1.7.4.4
+        # - docker exec -ti temp-ps rm -rf /var/www/html/modules/gsitemap
+        # - docker run --rm --volumes-from temp-ps -v $PWD:/var/www/html/modules/gsitemap -e _PS_ROOT_DIR_=/var/www/html quetzacoalt/phpstan analyse --configuration=/var/www/html/modules/gsitemap/tests/php/phpstan/phpstan.neon
+    - stage: "PHP"
+      name: "PHPStan on PS 1.7.3.4"
+      language: php
+      php: 7.2
+      script:
+        - composer install
+        - docker run -tid --rm -v ps-volume:/var/www/html --name temp-ps prestashop/prestashop:1.7.3.4
+        # - docker exec -ti temp-ps rm -rf /var/www/html/modules/gsitemap
+        # - docker run --rm --volumes-from temp-ps -v $PWD:/var/www/html/modules/gsitemap -e _PS_ROOT_DIR_=/var/www/html quetzacoalt/phpstan analyse --configuration=/var/www/html/modules/gsitemap/tests/php/phpstan/phpstan.neon
+    - stage: "PHP"
+      name: "PHPStan on PS 1.7.2.5"
+      language: php
+      php: 7.2
+      script:
+        - composer install
+        - docker run -tid --rm -v ps-volume:/var/www/html --name temp-ps prestashop/prestashop:1.7.2.5
+        #- docker exec -ti temp-ps rm -rf /var/www/html/modules/gsitemap
+        #- docker run --rm --volumes-from temp-ps -v $PWD:/var/www/html/modules/gsitemap -e _PS_ROOT_DIR_=/var/www/html quetzacoalt/phpstan analyse --configuration=/var/www/html/modules/gsitemap/tests/php/phpstan/phpstan.neon
+    - stage: "PHP"
+      name: "PHPStan on PS 1.7.1.2"
+      language: php
+      php: 7.2
+      script:
+        - composer install
+        - docker run -tid --rm -v ps-volume:/var/www/html --name temp-ps prestashop/prestashop:1.7.1.2
+        # - docker exec -ti temp-ps rm -rf /var/www/html/modules/gsitemap
+        # - docker run --rm --volumes-from temp-ps -v $PWD:/var/www/html/modules/gsitemap -e _PS_ROOT_DIR_=/var/www/html quetzacoalt/phpstan analyse --configuration=/var/www/html/modules/gsitemap/tests/php/phpstan/phpstan.neon

CONTRIBUTORS.md

@@ -0,0 +1,24 @@
+GitHub contributors:
+--------------------------------
+ - Caleydon
+ - Francois Gaillard
+ - Gregory Roussac
+ - Jerome Nadaud
+ - Jerome Nadaud
+ - Jérôme Nadaud
+ - MathiasReker
+ - Maxime Biloé
+ - PierreRambaud
+ - Quetzacoalt91
+ - Shagshag
+ - TrogloGeek
+ - chellem
+ - eternoendless
+ - gRoussac
+ - gaillafr
+ - jeromenadaud
+ - julienbourdeau
+ - kermes
+ - massimonicoli
+ - maximebiloe
+ - xBorderie

Readme.md → README.md

@@ -4,6 +4,13 @@
 
 Generate your Google sitemap file
 
+## Multistore compatibility
+
+This module is compatible with the multistore :heavy_check_mark: <br/>
+It can be configured differently from one store to another.<br/>
+It can be configured quickly in the same way on all stores thanks to the all shops context or the group of shops.<br/>
+It can be activated on one store and deactivated on another
+
 ## Reporting issues
 
 You can report issues with this module in the main PrestaShop repository. [Click here to report an issue][report-issue]. 

config.xml

@@ -2,7 +2,7 @@
 <module>
     <name>gsitemap</name>
     <displayName><![CDATA[Google sitemap]]></displayName>
-    <version><![CDATA[4.1.0]]></version>
+    <version><![CDATA[4.2.0]]></version>
     <description><![CDATA[Generate your Google sitemap file]]></description>
     <author><![CDATA[PrestaShop]]></author>
     <tab><![CDATA[seo]]></tab>

gsitemap-cron.php

@@ -1,10 +1,10 @@
 <?php
 /**
- * 2007-2018 PrestaShop.
+ * 2007-2020 PrestaShop SA and Contributors
  *
  * NOTICE OF LICENSE
  *
- * This source file is subject to the Academic Free License (AFL 3.0)
+ * This source file is subject to the Academic Free License 3.0 (AFL-3.0)
  * that is bundled with this package in the file LICENSE.txt.
  * It is also available through the world-wide-web at this URL:
  * https://opensource.org/licenses/AFL-3.0
@@ -16,11 +16,11 @@
  *
  * Do not edit or add to this file if you wish to upgrade PrestaShop to newer
  * versions in the future. If you wish to customize PrestaShop for your
- * needs please refer to https://www.prestashop.com for more information.
+ * needs please refer to http://www.prestashop.com for more information.
  *
  * @author    PrestaShop SA <contact@prestashop.com>
- * @copyright 2007-2018 PrestaShop SA
- * @license   https://opensource.org/licenses/AFL-3.0 Academic Free License (AFL 3.0)
+ * @copyright 2007-2020 PrestaShop SA and Contributors
+ * @license   https://opensource.org/licenses/AFL-3.0 Academic Free License 3.0 (AFL-3.0)
  * International Registered Trademark & Property of PrestaShop SA
  */
 
@@ -29,10 +29,11 @@
  */
 
 include(dirname(__FILE__) . '/../../config/config.inc.php');
-include(dirname(__FILE__) . '/../../init.php');
 
 /* Check security token */
 if (!Tools::isPHPCLI()) {
+    include(dirname(__FILE__) . '/../../init.php');
+
     if (Tools::substr(Tools::encrypt('gsitemap/cron'), 0, 10) != Tools::getValue('token') || !Module::isInstalled('gsitemap')) {
         die('Bad token');
     }
@@ -48,15 +49,15 @@
     foreach ($shops as $shop) {
         $list_id_shop[] = (int) $shop['id_shop'];
     }
-    
-    $id_shop = (Tools::getIsset(Tools::getValue('id_shop')) && in_array(Tools::getValue('id_shop'), $list_id_shop)) ? (int) Tools::getValue('id_shop') : (int) Configuration::get('PS_SHOP_DEFAULT');
+
+    $id_shop = (Tools::getIsset('id_shop') && in_array(Tools::getValue('id_shop'), $list_id_shop)) ? (int) Tools::getValue('id_shop') : (int) Configuration::get('PS_SHOP_DEFAULT');
     $gsitemap->cron = true;
-    
+
     /* for the main run initiat the sitemap's files name stored in the database */
-    if (!Tools::getIsset(Tools::getValue('continue'))) {
+    if (!Tools::getIsset('continue')) {
         $gsitemap->emptySitemap((int) $id_shop);
     }
-    
+
     /* Create the Google sitemap's files */
     $gsitemap->createSitemap((int) $id_shop);
 }

gsitemap.php

@@ -1,10 +1,10 @@
 <?php
 /**
- * 2007-2018 PrestaShop.
+ * 2007-2020 PrestaShop SA and Contributors
  *
  * NOTICE OF LICENSE
  *
- * This source file is subject to the Academic Free License (AFL 3.0)
+ * This source file is subject to the Academic Free License 3.0 (AFL-3.0)
  * that is bundled with this package in the file LICENSE.txt.
  * It is also available through the world-wide-web at this URL:
  * https://opensource.org/licenses/AFL-3.0
@@ -16,11 +16,11 @@
  *
  * Do not edit or add to this file if you wish to upgrade PrestaShop to newer
  * versions in the future. If you wish to customize PrestaShop for your
- * needs please refer to https://www.prestashop.com for more information.
+ * needs please refer to http://www.prestashop.com for more information.
  *
  * @author    PrestaShop SA <contact@prestashop.com>
- * @copyright 2007-2018 PrestaShop SA
- * @license   https://opensource.org/licenses/AFL-3.0 Academic Free License (AFL 3.0)
+ * @copyright 2007-2020 PrestaShop SA and Contributors
+ * @license   https://opensource.org/licenses/AFL-3.0 Academic Free License 3.0 (AFL-3.0)
  * International Registered Trademark & Property of PrestaShop SA
  */
 
@@ -39,7 +39,7 @@ public function __construct()
     {
         $this->name = 'gsitemap';
         $this->tab = 'seo';
-        $this->version = '4.1.0';
+        $this->version = '4.2.0';
         $this->author = 'PrestaShop';
         $this->need_instance = 0;
         $this->bootstrap = true;
@@ -293,6 +293,7 @@ public function addLinkToSitemap(&$link_sitemap, $new_link, $lang, &$index, &$i,
                     Tools::redirectAdmin($this->context->link->getAdminLink('AdminModules', true, array(), array(
                         'tab_module' => $this->tab,
                         'module_name' => $this->name,
+                        'configure' => $this->name,
                         'continue' => 1,
                         'type' => $new_link['type'],
                         'lang' => $lang,
@@ -390,37 +391,38 @@ protected function getProductLink(&$link_sitemap, $lang, &$index, &$i, $id_produ
 
             $url = $link->getProductLink($product, $product->link_rewrite, htmlspecialchars(strip_tags($product->category)), $product->ean13, (int) $lang['id_lang'], (int) $this->context->shop->id, 0);
 
-            $id_image = Product::getCover((int) $product_id['id_product']);
-            if (isset($id_image['id_image'])) {
-                $image_link = $this->context->link->getImageLink($product->link_rewrite, $product->id . '-' . (int) $id_image['id_image'], ImageType::getFormattedName('large'));
-                $image_link = (!in_array(rtrim(Context::getContext()->shop->virtual_uri, '/'), explode('/', $image_link))) ? str_replace(array(
-                    'https',
-                    Context::getContext()->shop->domain . Context::getContext()->shop->physical_uri,
-                ), array(
-                    'http',
-                    Context::getContext()->shop->domain . Context::getContext()->shop->physical_uri . Context::getContext()->shop->virtual_uri,
-                ), $image_link) : $image_link;
-            }
-            $file_headers = (Configuration::get('GSITEMAP_CHECK_IMAGE_FILE')) ? @get_headers($image_link) : true;
-            $image_product = array();
-            if (isset($image_link) && ($file_headers[0] != 'HTTP/1.1 404 Not Found' || $file_headers === true)) {
-                $image_product = array(
-                    'title_img' => htmlspecialchars(strip_tags($product->name)),
-                    'caption' => htmlspecialchars(strip_tags($product->description_short)),
-                    'link' => $image_link,
-                );
+            $images_product = array();
+            foreach($product->getImages($lang) as $id_image) {
+                if (isset($id_image['id_image'])) {
+                    $image_link = $this->context->link->getImageLink($product->link_rewrite, $product->id . '-' . (int) $id_image['id_image'], ImageType::getFormattedName('large'));
+                    $image_link = (!in_array(rtrim(Context::getContext()->shop->virtual_uri, '/'), explode('/', $image_link))) ? str_replace(array(
+                        'https',
+                        Context::getContext()->shop->domain . Context::getContext()->shop->physical_uri,
+                    ), array(
+                        'http',
+                        Context::getContext()->shop->domain . Context::getContext()->shop->physical_uri . Context::getContext()->shop->virtual_uri,
+                    ), $image_link) : $image_link;
+                }
+                $file_headers = (Configuration::get('GSITEMAP_CHECK_IMAGE_FILE')) ? @get_headers($image_link) : true;
+                if (isset($image_link) && ($file_headers[0] != 'HTTP/1.1 404 Not Found' || $file_headers === true)) {
+                    $images_product[] = array(
+                        'title_img' => htmlspecialchars(strip_tags($product->name)),
+                        'caption' => htmlspecialchars(strip_tags($product->meta_description)),
+                        'link' => $image_link,
+                    );
+                }
+                unset($image_link);
             }
+
             if (!$this->addLinkToSitemap($link_sitemap, array(
                 'type' => 'product',
                 'page' => 'product',
                 'lastmod' => $product->date_upd,
                 'link' => $url,
-                'image' => $image_product,
+                'images' => $images_product,
             ), $lang['iso_code'], $index, $i, $product_id['id_product'])) {
                 return false;
             }
-
-            unset($image_link);
         }
 
         return true;
@@ -666,16 +668,24 @@ protected function recursiveSitemapCreator($link_sitemap, $lang, &$index)
             fwrite($write_fd, '<url>' . PHP_EOL);
             $lastmod = (isset($file['lastmod']) && !empty($file['lastmod'])) ? date('c', strtotime($file['lastmod'])) : null;
             $this->addSitemapNode($write_fd, htmlspecialchars(strip_tags($file['link'])), $this->getPriorityPage($file['page']), Configuration::get('GSITEMAP_FREQUENCY'), $lastmod);
-            if ($file['image']) {
-                $this->addSitemapNodeImage($write_fd, htmlspecialchars(strip_tags($file['image']['link'])), isset($file['image']['title_img']) ? htmlspecialchars(str_replace(array(
+
+            $images = array();
+            if (isset($file['image']) && $file['image']) {
+                $images[] = $file['image'];
+            }
+            if (isset($file['images']) && $file['images']) {
+                $images = array_merge($images, $file['images']);
+            }
+            foreach($images as $image) {
+                $this->addSitemapNodeImage($write_fd, htmlspecialchars(strip_tags($image['link'])), isset($image['title_img']) ? htmlspecialchars(str_replace(array(
                     "\r\n",
                     "\r",
                     "\n",
-                ), '', $this->removeControlCharacters(strip_tags($file['image']['title_img'])))) : '', isset($file['image']['caption']) ? htmlspecialchars(str_replace(array(
+                ), '', $this->removeControlCharacters(strip_tags($image['title_img'])))) : '', isset($image['caption']) ? htmlspecialchars(str_replace(array(
                     "\r\n",
                     "\r",
                     "\n",
-                ), '', strip_tags($file['image']['caption']))) : '');
+                ), '', strip_tags($image['caption']))) : '');
             }
             fwrite($write_fd, '</url>' . PHP_EOL);
         }