Add option to define shop root (#73)

Co-authored-by: Jay <j.trees@hybridsupply.de>
Co-authored-by: Jay <grandel@posteo.de>

Author: 3 people

config/_config.php

@@ -24,5 +24,16 @@
      * @param string selfUpdate stable, latest
      */
     'installMode' => 'copy',
-    'selfUpdate' => 'stable'
+    'selfUpdate' => 'stable',
+
+    /**
+     * Settings revolving around your modified-shop
+     *
+     * Overwrite the default shop path. If your MMLC installation is not inside
+     * of your modified-shop root and exists as a symbolic link, you may need to
+     * define your shop root here.
+     *
+     * Leave empty for default.
+     */
+    'shopRoot' => '',
 ];

src/Classes/Api/V1/HttpRequest.php

@@ -46,7 +46,14 @@ public function sendPostRequest(string $url, $data)
 
         // Logging
         if ($this->logging) {
-            file_put_contents(App::getLogsRoot() . '/log.txt', $result);
+            $logFilepath = App::getLogsRoot() . '/log.txt';
+            $logDirectory = dirname($logFilepath);
+
+            if (!file_exists($logDirectory)) {
+                mkdir($logDirectory);
+            }
+
+            file_put_contents($logFilepath, $result);
         }
 
         return $result;

src/Classes/App.php

@@ -40,7 +40,7 @@ public static function getRoot(): string
 
     public static function getShopRoot(): string
     {
-        return realPath(__DIR__ . '/../../../');
+        return Config::getShopRoot();
     }
 
     public static function getSrcRoot(): string

src/Classes/Config.php

@@ -225,6 +225,26 @@ public static function setAdminDir(string $newAdminDir): void
         self::writeConfiguration(['adminDir' => $newAdminDir]);
     }
 
+    /**
+     * Get the modified-shop root directory.
+     *
+     * @return string
+     */
+    public static function getShopRoot(): string
+    {
+        $shopRootOption = self::getOption('shopRoot');
+        $shopRootDirectory = empty($shopRootOption)
+                           ? realpath(__DIR__ . '/../../../')
+                           : rtrim($shopRootOption, '/\\');
+
+        return $shopRootDirectory;
+    }
+
+    public static function setShopRoot(string $newShopRoot): void
+    {
+        self::writeConfiguration(['shopRoot' => $newShopRoot]);
+    }
+
     /**
      * Get modulesLocalDir from config.
      *

src/Classes/IndexController.php

@@ -602,6 +602,10 @@ public function invokeSettings()
                 Config::setAccessToken($parsedBody['accessToken']);
             }
 
+            if (isset($parsedBody['shopRoot'])) {
+                Config::setShopRoot($parsedBody['shopRoot']);
+            }
+
             if (isset($parsedBody['modulesLocalDir'])) {
                 Config::setModulesLocalDir($parsedBody['modulesLocalDir']);
             }

src/Templates/Settings.tmpl.php

@@ -73,7 +73,7 @@ function viewIsSelected(bool $value): string
                                     <input type="text" name="username" class="form-control" id="inputUsername" value="<?= Config::getUsername(); ?>">
                                     <p>Mit diesem Namen meldest du dich im MMLC an.</p>
                                 </div>
-                                
+
                                 <div class="form-group">
                                     <label for="inputPassword">Password</label>
                                     <input type="password" name="password" class="form-control" id="inputPassword">
@@ -90,6 +90,13 @@ function viewIsSelected(bool $value): string
                         <div class="tab-pane fade show" id="v-pills-advanced" role="tabpanel" aria-labelledby="v-pills-advanced-tab">
                             <h2>Erweitert</h2>
                             <form action="?action=settings&section=advanced" method="post">
+                                <!-- shopRoot -->
+                                <div class="form-group">
+                                    <label for="inputShopRoot">Shop Root</label>
+                                    <input type="text" name="shopRoot" class="form-control" id="inputShopRoot" value="<?= Config::getShopRoot(); ?>">
+                                    <p>Verzeichnis vom modified-shop. Lasse dieses Feld leer für die Standard Einstellung.</p>
+                                </div>
+
                                 <!-- modulesLocalDir -->
                                 <div class="form-group">
                                     <label for="inputModulesLocalDir">Module Pfad</label>
@@ -104,7 +111,7 @@ function viewIsSelected(bool $value): string
                                         <option <?= viewIsSelected(Config::getInstallMode() == 'copy') ?> value="copy">copy</option>
                                         <option <?= viewIsSelected(Config::getInstallMode() == 'link') ?> value="link">link</option>
                                     </select>
-                                    
+
                                     <p>Du kannst zwischen <code>copy</code> und <code>link</code> wählen. Hast du den MMLC in einem Live-Shop im Einsatz, wähle <code>copy</code>. Wenn du mit dem MMLC Module entwickelst, wähle <code>link</code>.</p>
                                 </div>
 
@@ -126,7 +133,7 @@ function viewIsSelected(bool $value): string
                 $(tabId).tab('show')
             })
         </script>
-        
+
         <?php include 'Footer.tmpl.php' ?>
     </body>
 </html>