feature(Setup/Cli): pass additional struct tables to --setup

setup.php --backup -- structTables=timemachine_modlog,notes
tine-groupware · Jan 22, 2024 · 2a41245 · 2a41245
1 parent de8ed03
commit 2a41245
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 8 deletions.
diff --git a/tine20/Setup/Controller.php b/tine20/Setup/Controller.php
@@ -2797,12 +2797,14 @@ public function isFilesystemAvailable()
      *      'db'         => bool   // backup database
      *      'files'      => bool   // backup files
      *      'novalidate' => bool   // do not validate sql backup
+     *      'structTables' => array // additional struct only tables (data backup is omitted)
      *    )
      */
     public function backup($options)
     {
         if (! $this->isInstalled('Tinebase')) {
-            Setup_Core::getLogger()->notice(__METHOD__ . '::' . __LINE__ . ' Tine 2.0 is not installed');
+            Setup_Core::getLogger()->notice(__METHOD__ . '::' . __LINE__ . ' '
+                . Tinebase_Config::getInstance()->get(Tinebase_Config::BRANDING_TITLE) . ' is not installed');
             return;
         }
 
@@ -2842,12 +2844,15 @@ public function backup($options)
                 throw new Exception('db not configured, cannot backup');
             }
 
+            $structTables = $this->getBackupStructureOnlyTables($options['structTables'] ?? null);
             $backupOptions = array(
                 'backupDir'         => $backupDir,
-                'structTables'      => $this->getBackupStructureOnlyTables(),
+                'structTables'      => $structTables,
                 'novalidate'        => isset($options['novalidate']) && $options['novalidate'],
             );
 
+            Setup_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__ . ' Using options: ' . print_r($backupOptions, true));
+
             $this->_backend->backup($backupOptions);
 
             Setup_Core::getLogger()->info(__METHOD__ . '::' . __LINE__ . ' Backup of DB successful');
@@ -2885,14 +2890,21 @@ public function backup($options)
     /**
      * returns an array of all tables of all applications that should only backup the structure
      *
+     * @param ?string $structTablesString
      * @return array
      * @throws Setup_Exception_NotFound
      *
      * TODO support <backupStructureOnly>true</backupStructureOnly> for MC models without a table definition in setup.xml
      */
-    public function getBackupStructureOnlyTables()
+    public function getBackupStructureOnlyTables(?string $structTablesString = null): array
     {
-        $tables = array();
+        $tables = [];
+
+        if ($structTablesString) {
+            foreach (explode(',', $structTablesString) as $table) {
+                $tables[] = SQL_TABLE_PREFIX . $table;
+            }
+        }
 
         // find tables that only backup structure
         $applications = Tinebase_Application::getInstance()->getApplications();
@@ -2905,10 +2917,10 @@ public function getBackupStructureOnlyTables()
             if (! $tableDef) {
                 continue;
             }
-            $structOnlys = $tableDef->xpath('//table/backupStructureOnly[text()="true"]');
+            $structOnly = $tableDef->xpath('//table/backupStructureOnly[text()="true"]');
 
-            foreach ($structOnlys as $structOnly) {
-                $tableName = $structOnly->xpath('./../name/text()');
+            foreach ($structOnly as $structOnlyTable) {
+                $tableName = $structOnlyTable->xpath('./../name/text()');
                 $tables[] = SQL_TABLE_PREFIX . $tableName[0];
             }
         }

diff --git a/tine20/Setup/Server/Cli.php b/tine20/Setup/Server/Cli.php
@@ -71,7 +71,7 @@ public function handle(\Laminas\Http\Request $request = null, $body = null)
                            setup.php --updateAllAccountsWithAccountEmail -- fromInstance=master.mytine20.com',
                 'backup'                    => 'backup config and data
                          Examples:
-                           setup.php --backup -- config=1 db=1 files=1 emailusers=1 backupDir=/backup/tine20 noTimestamp=1 novalidate=1',
+                           setup.php --backup -- config=1 db=1 files=1 emailusers=1 backupDir=/backup/tine20 noTimestamp=1 novalidate=1 structTables=timemachine_modlog,notes',
                 'restore'                   => 'restore config and data
                          Examples:
                            setup.php --restore -- config=1 db=1 files=1 backupDir=/backup/tine20',