Save images inside /img/homeslider directory

Module directory is not the right place to store slide image files. That is because tbupdater module always wipes out module directory during module update. This causes data loss. This new implementation uploads images into /img/homeslider/ directory instead. Closes #3 Related to thirtybees/thirtybees#922
thirtybees · Dec 12, 2022 · 73c1fa1 · 73c1fa1
1 parent a800903
commit 73c1fa1
Show file tree

Hide file tree

Showing 16 changed files with 326 additions and 139 deletions.
diff --git a/HomeSlide.php b/HomeSlide.php
@@ -121,32 +121,33 @@ public function add($autodate = true, $null_values = false)
     }
 
     /**
-     * @return int
+     * @return bool
      * @throws PrestaShopDatabaseException
      * @throws PrestaShopException
      */
     public function delete()
     {
         $res = true;
 
-        $images = $this->image;
-        foreach ($images as $image) {
-            if (preg_match('/sample/', $image) === 0) {
-                if ($image && file_exists(dirname(__FILE__) . '/images/' . $image)) {
-                    $res &= @unlink(dirname(__FILE__) . '/images/' . $image);
-                }
+        // delete image files
+        foreach ($this->image as $image) {
+            $filepath = HomeSlider::getImageDir() . $image;
+            if ($image && file_exists($filepath)) {
+                $res = unlink($filepath) && $res;
             }
         }
 
-        $res &= $this->reOrderPositions();
+        // reorder positions
+        $res = $this->reOrderPositions() && $res;
 
-        $res &= Db::getInstance()->execute('
+        // delete slides
+        $res = Db::getInstance()->execute('
 			DELETE FROM `' . _DB_PREFIX_ . 'homeslider`
 			WHERE `id_homeslider_slides` = ' . (int)$this->id
-        );
+        ) && $res;
 
-        $res &= parent::delete();
-        return $res;
+        // delete record
+        return parent::delete() && $res;
     }
 
     /**

diff --git a/fixtures/fixtures.json b/fixtures/fixtures.json
@@ -0,0 +1,20 @@
+[
+   {
+      "image": "sample-1.jpg",
+      "title": "Shop Tea",
+      "legend": "Shop Tea",
+      "description": "<h3 style=\"float:left;clear:both;font-size:30px;\">Shop Tea</h3><p style=\"text-align:center;margin-top:20px;\"><button class=\"btn btn-default\" type=\"button\">Shop now !</button></p>"
+   },
+   {
+      "image": "sample-2.jpg",
+      "title": "Soaps",
+      "legend": "Soaps",
+      "description": "<h3 style=\"float:left;clear:both;font-size:30px;\">View All Soaps</h3><p style=\"text-align:center;margin-top:20px;\"><button class=\"btn btn-default\" type=\"button\">Shop now !</button></p>"
+   },
+   {
+      "image": "sample-3.jpg",
+      "title": "Gifts",
+      "legend": "Gifts",
+      "description": "<h3 style=\"float:left;clear:both;font-size:30px;\">Shop Gifts</h3><p style=\"text-align:center;margin-top:20px;\"><button class=\"btn btn-default\" type=\"button\">Shop now !</button></p>"
+   }
+]
diff --git a/images/index.php → fixtures/index.php b/images/index.php → fixtures/index.php
diff --git a/images/sample-4.jpg → fixtures/sample-1.jpg b/images/sample-4.jpg → fixtures/sample-1.jpg
diff --git a/images/sample-5.jpg → fixtures/sample-2.jpg b/images/sample-5.jpg → fixtures/sample-2.jpg
diff --git a/images/sample-6.jpg → fixtures/sample-3.jpg b/images/sample-6.jpg → fixtures/sample-3.jpg
diff --git a/homeslider.php b/homeslider.php
diff --git a/images/gray_next.png b/images/gray_next.png
diff --git a/images/gray_pager.png b/images/gray_pager.png
diff --git a/images/gray_prev.png b/images/gray_prev.png
diff --git a/images/sample-1.jpg b/images/sample-1.jpg
diff --git a/images/sample-2.jpg b/images/sample-2.jpg
diff --git a/images/sample-3.jpg b/images/sample-3.jpg
diff --git a/upgrade/index.php b/upgrade/index.php
@@ -0,0 +1,35 @@
+<?php
+/**
+ * Copyright (C) 2017-2019 thirty bees
+ * Copyright (C) 2007-2016 PrestaShop SA
+ *
+ * thirty bees is an extension to the PrestaShop software by PrestaShop SA.
+ *
+ * NOTICE OF LICENSE
+ *
+ * This source file is subject to the Academic Free License (AFL 3.0)
+ * that is bundled with this package in the file LICENSE.md.
+ * It is also available through the world-wide-web at this URL:
+ * https://opensource.org/licenses/afl-3.0.php
+ * If you did not receive a copy of the license and are unable to
+ * obtain it through the world-wide-web, please send an email
+ * to license@thirtybees.com so we can send you a copy immediately.
+ *
+ * @author    thirty bees <modules@thirtybees.com>
+ * @author    PrestaShop SA <contact@prestashop.com>
+ * @copyright 2017-2019 thirty bees
+ * @copyright 2007-2016 PrestaShop SA
+ * @license   Academic Free License (AFL 3.0)
+ * PrestaShop is an internationally registered trademark of PrestaShop SA.
+ */
+
+header('Expires: Mon, 26 Jul 1997 05:00:00 GMT');
+header('Last-Modified: '.gmdate('D, d M Y H:i:s').' GMT');
+
+header('Cache-Control: no-store, no-cache, must-revalidate');
+header('Cache-Control: post-check=0, pre-check=0', false);
+header('Pragma: no-cache');
+
+header('Location: ../');
+
+exit;
diff --git a/upgrade/upgrade-2.1.0.php b/upgrade/upgrade-2.1.0.php
@@ -0,0 +1,60 @@
+<?php
+/**
+ * 2007-2016 PrestaShop
+ *
+ * thirty bees is an extension to the PrestaShop e-commerce software developed by PrestaShop SA
+ * Copyright (C) 2017-2018 thirty bees
+ *
+ * NOTICE OF LICENSE
+ *
+ * This source file is subject to the Academic Free License (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:
+ * http://opensource.org/licenses/afl-3.0.php
+ * If you did not receive a copy of the license and are unable to
+ * obtain it through the world-wide-web, please send an email
+ * to license@thirtybees.com so we can send you a copy immediately.
+ *
+ * @author    thirty bees <modules@thirtybees.com>
+ * @author    PrestaShop SA <contact@prestashop.com>
+ * @copyright 2017-2018 thirty bees
+ * @copyright 2007-2016 PrestaShop SA
+ * @license   http://opensource.org/licenses/afl-3.0.php  Academic Free License (AFL 3.0)
+ *  PrestaShop is an internationally registered trademark & property of PrestaShop SA
+ */
+
+if (!defined('_TB_VERSION_')) {
+    exit;
+}
+
+/**
+ * Copy all image files referenced in the database to the /img/homeslider/ directory
+ *
+ * @return bool
+ *
+ * @throws PrestaShopDatabaseException
+ * @throws PrestaShopException
+ */
+function upgrade_module_2_1_0()
+{
+    $sourceDir = __DIR__  . '/../images/';
+    $targetDir = HomeSlider::getImageDir();
+    if (file_exists($sourceDir)) {
+
+        // find images from the database
+        $images = array_column(Db::getInstance()->executeS((new DbQuery())
+            ->select('DISTINCT(image) as image')
+            ->from('homeslider_slides_lang')
+        ), 'image');
+
+        // copy them to destination
+        foreach ($images as $image) {
+            if (file_exists($sourceDir . $image)) {
+                if (! file_exists($targetDir . $image)) {
+                    copy($sourceDir . $image, $targetDir . $image);
+                }
+            }
+        }
+    }
+    return true;
+}
diff --git a/views/templates/hook/homeslider.tpl b/views/templates/hook/homeslider.tpl
@@ -22,26 +22,28 @@
  * PrestaShop is an internationally registered trademark of PrestaShop SA.
  *}
 
-{if $page_name =='index'}
-<!-- Module HomeSlider -->
+{if $page_name == 'index'}
     {if isset($homeslider_slides)}
-		<div id="homepage-slider">
-			{if isset($homeslider_slides.0) && isset($homeslider_slides.0.sizes.1)}{capture name='height'}{$homeslider_slides.0.sizes.1}{/capture}{/if}
-			<ul id="homeslider"{if isset($smarty.capture.height) && $smarty.capture.height} style="max-height:{$smarty.capture.height}px;"{/if}>
-				{foreach from=$homeslider_slides item=slide}
-					{if $slide.active}
-						<li class="homeslider-container">
-							<a href="{$slide.url|escape:'html':'UTF-8'}" title="{$slide.legend|escape:'html':'UTF-8'}">
-								<img src="{$link->getMediaLink("`$smarty.const._MODULE_DIR_`homeslider/images/`$slide.image|escape:'htmlall':'UTF-8'`")}"{if isset($slide.size) && $slide.size} {$slide.size}{else} width="100%" height="100%"{/if} alt="{$slide.legend|escape:'htmlall':'UTF-8'}" />
-							</a>
-							{if isset($slide.description) && trim($slide.description) != ''}
-								<div class="homeslider-description">{$slide.description}</div>
-							{/if}
-						</li>
-					{/if}
-				{/foreach}
-			</ul>
-		</div>
-	{/if}
-<!-- /Module HomeSlider -->
+        <div id="homepage-slider">
+            {if isset($homeslider_slides.0) && isset($homeslider_slides.0.sizes.1)}{capture name='height'}{$homeslider_slides.0.sizes.1}{/capture}{/if}
+            <ul id="homeslider"{if isset($smarty.capture.height) && $smarty.capture.height} style="max-height:{$smarty.capture.height}px;"{/if}>
+                {foreach from=$homeslider_slides item=slide}
+                    {if $slide.active}
+                        <li class="homeslider-container">
+                            <a href="{$slide.url|escape:'html':'UTF-8'}" title="{$slide.legend|escape:'html':'UTF-8'}">
+                                <img src="{$link->getMediaLink($slide.imageUrl)|escape:'htmlall':'UTF-8'}"
+                                     {if isset($slide.size) && $slide.size}{$slide.size}{else}width="100%"
+                                     height="100%"{/if}
+                                     alt="{$slide.legend|escape:'htmlall':'UTF-8'}"
+                                />
+                            </a>
+                            {if isset($slide.description) && trim($slide.description) != ''}
+                                <div class="homeslider-description">{$slide.description}</div>
+                            {/if}
+                        </li>
+                    {/if}
+                {/foreach}
+            </ul>
+        </div>
+    {/if}
 {/if}