Initial changes (#1)

* Changed namespace, and fixed errors

* typos

* Missing

* Altered Readme

* Update README.md

* Update README.md

* Update README.md

* changed config path

Author: mortenbirkelund

.travis.yml

@@ -1,15 +1,6 @@
 <?php
-/**
- * Phoenix_MediaStorageSync for Magento 2
- *
- *
- * @category    Phoenix
- * @package     Phoenix_MediaStorageSync
- * @license     http://opensource.org/licenses/MIT MIT
- * @copyright   Copyright (c) 2018 PHOENIX MEDIA GmbH (http://www.phoenix-media.eu)
- */
 
-namespace Phoenix\MediaStorageSync\Helper;
+namespace Salecto\MediaStorageSync\Helper;
 
 use Magento\Framework\App\Helper\AbstractHelper;
 use Magento\Framework\App\Helper\Context;

Helper/Data.php

@@ -1,16 +1,6 @@
 <?php
-/**
- * Phoenix_MediaStorageSync for Magento 2
- *
- *
- * @category    Phoenix
- * @package     Phoenix_MediaStorageSync
- * @license     http://opensource.org/licenses/MIT MIT
- * @copyright   Copyright (c) 2018 PHOENIX MEDIA GmbH (http://www.phoenix-media.eu)
- */
-
-namespace Phoenix\MediaStorageSync\Model;
 
+namespace Salecto\MediaStorageSync\Model;
 
 use Magento\Framework\App\Config\ScopeConfigInterface;
 
@@ -103,6 +93,6 @@ public function getDownloadLimit()
      */
     protected function getXmlPathPrefix()
     {
-        return 'phoenix_mediastoragesync/general/';
+        return 'media_storage_sync/general/';
     }
 }

Model/Config.php

@@ -1,17 +1,8 @@
 <?php
-/**
- * Phoenix_MediaStorageSync for Magento 2
- *
- *
- * @category    Phoenix
- * @package     Phoenix_MediaStorageSync
- * @license     http://opensource.org/licenses/MIT MIT
- * @copyright   Copyright (c) 2018 PHOENIX MEDIA GmbH (http://www.phoenix-media.eu)
- */
-
-namespace Phoenix\MediaStorageSync\Model;
-
-use Phoenix\MediaStorageSync\Helper\Data as Helper;
+
+namespace Salecto\MediaStorageSync\Model;
+
+use Salecto\MediaStorageSync\Helper\Data as Helper;
 use Magento\Framework\HTTP\ClientFactory;
 use Magento\Framework\HTTP\ClientInterface;
 use Magento\Framework\Filesystem\Io\File;
@@ -101,9 +92,14 @@ public function sync($src, $target)
      */
     protected function saveFileFromRemoteServer($src, $target)
     {
+        if (strstr($target, 'media/') !== false) {
+            $src = preg_replace('/^media\//', '', $src);
+        }
+        
         $fileSaved = false;
         $fileName = basename($src);
         $fileDirectory = $target;
+        
         if ($fileName != $src) {
             $fileDirectory .= dirname($src);
         }
@@ -154,7 +150,7 @@ public function getHttpClient()
             $client = $this->httpClientFactory->create();
 
             $client->setTimeout(20);
-            $client->addHeader('User-Agent', 'Phoenix MediaStorageSync');
+            $client->addHeader('User-Agent', 'Salecto MediaStorageSync');
             $client->addHeader('Content-Transfer-Encoding', 'binary');
 
             $user = $this->config->getHttpClientUser();

Model/Sync.php

@@ -1,13 +1,13 @@
 <?php
 
-namespace Phoenix\MediaStorageSync\Observer\Product;
+namespace Salecto\MediaStorageSync\Observer\Product;
 
 use Magento\Framework\Event\ObserverInterface;
 use Magento\Framework\Event\Observer;
 use Magento\Catalog\Model\Product\Gallery\ReadHandler as GalleryReadHandler;
-use Phoenix\MediaStorageSync\Model\Sync;
-use Phoenix\MediaStorageSync\Model\Config;
-use Phoenix\MediaStorageSync\Helper\Data as Helper;
+use Salecto\MediaStorageSync\Model\Sync;
+use Salecto\MediaStorageSync\Model\Config;
+use Salecto\MediaStorageSync\Helper\Data as Helper;
 
 class CollectionObserver implements ObserverInterface
 {
@@ -54,7 +54,7 @@ public function execute(Observer $observer)
 
                         if ($fileIsNotAvailable) {
                             $this->sync->sync(
-                                $this->helper->getCatalogMediaConfigPath() . $mediaGalleryImage->getData('file'),
+                                $this->helper->getCatalogMediaConfigPath() . "/" . $mediaGalleryImage->getData('file'),
                                 $this->helper->getMediaBaseDir()
                             );
                         }

Observer/Product/CollectionObserver.php

@@ -1,22 +1,13 @@
 <?php
-/**
- * Phoenix_MediaStorageSync for Magento 2
- *
- *
- * @category    Phoenix
- * @package     Phoenix_MediaStorageSync
- * @license     http://opensource.org/licenses/MIT MIT
- * @copyright   Copyright (c) 2018 PHOENIX MEDIA GmbH (http://www.phoenix-media.eu)
- */
 
-namespace Phoenix\MediaStorageSync\Observer;
+namespace Salecto\MediaStorageSync\Observer;
 
 use Magento\Framework\Event\ObserverInterface;
 use Magento\Framework\Event\Observer;
 use Magento\Catalog\Model\Product\Gallery\ReadHandler as GalleryReadHandler;
-use Phoenix\MediaStorageSync\Model\Sync;
-use Phoenix\MediaStorageSync\Model\Config;
-use Phoenix\MediaStorageSync\Helper\Data as Helper;
+use Salecto\MediaStorageSync\Model\Sync;
+use Salecto\MediaStorageSync\Model\Config;
+use Salecto\MediaStorageSync\Helper\Data as Helper;
 
 class ProductObserver implements ObserverInterface
 {
@@ -63,7 +54,7 @@ public function execute(Observer $observer)
 
                     if ($fileIsNotAvailable) {
                         $this->sync->sync(
-                            $this->helper->getCatalogMediaConfigPath() . $mediaGalleryImage->getData('file'),
+                            $this->helper->getCatalogMediaConfigPath() . "/" . $mediaGalleryImage->getData('file'),
                             $this->helper->getMediaBaseDir()
                         );
                     }

Observer/ProductObserver.php

@@ -1,20 +1,11 @@
 <?php
-/**
- * Phoenix_MediaStorageSync for Magento 2
- *
- *
- * @category    Phoenix
- * @package     Phoenix_MediaStorageSync
- * @license     http://opensource.org/licenses/MIT MIT
- * @copyright   Copyright (c) 2018 PHOENIX MEDIA GmbH (http://www.phoenix-media.eu)
- */
 
-namespace Phoenix\MediaStorageSync\Plugin;
+namespace Salecto\MediaStorageSync\Plugin;
 
 use Magento\MediaStorage\Model\File\Storage\Database as StorageDatabase;
-use Phoenix\MediaStorageSync\Model\Config;
-use Phoenix\MediaStorageSync\Model\Sync;
-use Phoenix\MediaStorageSync\Helper\Data as Helper;
+use Salecto\MediaStorageSync\Model\Config;
+use Salecto\MediaStorageSync\Model\Sync;
+use Salecto\MediaStorageSync\Helper\Data as Helper;
 
 
 class Synchronization

Plugin/Synchronization.php

@@ -1,7 +1,11 @@
-## Phoenix Media Storage Sync
-The module retrieves files in /media from an origin server.
+# Media Storage Sync
+*This project is a fork of [this repo](https://github.com/PHOENIX-MEDIA/magento2-mediastoragesync). Since it was no longer maintained, and contained critical bugs, we haved decided to continue maintaining it, under a new name. Kudos to [Phoenix Media](https://www.phoenix-media.eu/de/) for their work.* 
+---
+The module retrieves files in /media from an origin server/url. Useful if you have a local development environment for your shop, and don't want to download the whole media folder along with the shop. 
 
-### What it does
+This module will try to download the images from the provided url, as they are required. 
+
+## What it does
 
 Imagine you have a fresh local development environment with the Magento code checked out.
 You retrieved the database but you don't have any of the media assets and your store frontend
@@ -14,7 +18,7 @@ products and CMS blocks/pages from a configurable origin server similar to a CDN
 you load an entity from the database. This means you can forget about the media folder and
 just browse the frontend as images are downloaded and saved transparently.
 
-### How it works
+## How it works
 
 In the module's configuration you can configure a base URL, the domain where your production/staging
 Magento instance is located from which to picked the database. In the database the relative
@@ -23,34 +27,30 @@ simply checks if their images are already in media/catalog. If not it uses the b
 appends the relative image path from the database and downloads the files from origin server.
 This slows down page generation the first time you access a page but improves pretty quickly.
 
-For other assets in the media folder we make use of another mechanism: Maybe you recognized
-Magento is shipped with a get.php file in the Magento root. It was intended to retrieve image
-data from a database, save it on the host's filesystem and then deliver it. Well, our assets
-are located at a different web server but beside the retrieval of the asset data the rest is
-pretty similar.
-The get.php is called via a mod_rewrite rule in the media/.htaccess or equivalent rules in
-your nginx configuration. The process is triggered every time a file in /media is not found
-so it is only triggered the first time. The MediaStorageSync module downloads the file, saves
-it and the get.php delivers the file. On the second load the web service can directly deliver
-the static asset.
+## Settings
 
-### How to use
+- `Enable` - Self explanatory
+- `URL` - The url full url of the shop you want to download medias from (e.g. https://yoursite.com/)
+- `HTTP Client User`- Username, in case of need for authorization 
+- `HTTP CLient Password`- Password, in case of need for authorization
+- `Download Limit Per Request`- Limit the amount of downloads per request
 
-1. Install the module via Composer:
-``` 
-composer require phoenix-media/magento2-mediastoragesync
-```
-2. Enable it
-``` bin/magento module:enable Phoenix_MediaStorageSync ```
-3. Install the module and rebuild the DI cache
-``` bin/magento setup:upgrade ```
+## Developer informations
 
-### How to configure
+### Install module
 
-Find the modules configuration in the PHOENIX MEDIA section of your Magento configuration.
+1. Install the module via Composer:
+    ``` 
+    composer require salecto2/magento2-mediastoragesync
+    ```
+2. Enable it
 
-Enable: Enable or disable the functionality
+    ```
+    php bin/magento module:enable Salecto_MediaStorageSync
+    ```
 
-URL: Configure the source URL where to retrieve the images (e.g. "https://magento.com/")
+3. Install the module and rebuild the DI cache
 
-optionally configure credentials for BasicAuth.
+    ```
+    php bin/magento setup:upgrade
+    ```

README.md

@@ -1,19 +1,19 @@
 {
-    "name": "phoenix-media/magento2-mediastoragesync",
-    "description": "The module retrieves files in /media from origin server.",
+    "name": "salecto2/magento2-mediastoragesync",
+    "description": "The module retrieves media files from origin server.",
     "require": {
         "php": "^7.0",
         "magento/module-media-storage": "*"
     },
     "type": "magento2-module",
-    "version": "1.2.2",
+    "version": "1.0.0",
     "license": "MIT",
     "autoload": {
         "files": [
             "registration.php"
         ],
         "psr-4": {
-            "Phoenix\\MediaStorageSync\\": ""
+            "Salecto\\MediaStorageSync\\": ""
         }
     }
 }

composer.json

@@ -1,23 +1,13 @@
 <?xml version="1.0"?>
-<!--
-/**
- * Phoenix_MediaStorageSync for Magento 2
- *
- *
- * @category    Phoenix
- * @package     Phoenix_MediaStorageSync
- * @license     http://opensource.org/licenses/MIT MIT
- * @copyright   Copyright (c) 2018 PHOENIX MEDIA GmbH (http://www.phoenix-media.eu)
- */
--->
+
 <config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:Acl/etc/acl.xsd">
     <acl>
         <resources>
             <resource id="Magento_Backend::admin">
                 <resource id="Magento_Backend::stores">
                     <resource id="Magento_Backend::stores_settings">
                         <resource id="Magento_Config::config">
-                            <resource id="Phoenix_MediaStorageSync::config" title="Media Storage Sync Section" sortOrder="75" />
+                            <resource id="Salecto_MediaStorageSync::config" title="Media Storage Sync Section" sortOrder="75" />
                         </resource>
                     </resource>
                 </resource>