Changeset 2577

Timestamp:

02/06/10 08:51:44 (6 weeks ago)

Author:

tomdooley

Message:

Small changes, code cleanup

Location:

branches/backup-restore

Files:

• backup.php (modified) (3 diffs)
• includes/BackupPackage.php (modified) (4 diffs)
• includes/BackupPackage_ispCP.php (modified) (6 diffs)
• includes/Base.php (modified) (2 diffs)
• includes/RestorePackage_ispCP.php (modified) (5 diffs)
• restore.php (modified) (2 diffs)

branches/backup-restore/backup.php

@@ -26 +26 @@
         echo "OPTIONS:\n";
         echo " -v ........... verbose mode\n";
+        echo "\n";
+        echo "Please ensure, there is enough free disk space available for\n";
+        echo "this operation (approx. triple size of htdocs and databases)!\n";
         exit(1);
 }
@@ -38 +41 @@
 $domain_name = $argv[$argc-2];
 $password = $argv[$argc-1];
-if (!file_exists(ISPCP_VIRTUAL_PATH.'/'.$domain_name)) {
-        echo "Domain not found in ".ISPCP_VIRTUAL_PATH.'/'.$domain_name."\n";
-        exit(2);
-}
-
-// make clean temp path for every call
-if (file_exists(BACKUP_TEMP_PATH)) {
-        delTree(BACKUP_TEMP_PATH);
-}
-mkdir(BACKUP_TEMP_PATH, 0700, true);
-
-// create archive path if not exist
-if (!file_exists(ARCHIVE_PATH)) {
-        mkdir(ARCHIVE_PATH, 0700, true);
-}
 
 $exitcode = 0;
@@ -68 +56 @@
 }
 
-// clean up temp path on exit
-if (file_exists(BACKUP_TEMP_PATH)) {
-        delTree(BACKUP_TEMP_PATH);
-}
-
 exit($exitcode);

branches/backup-restore/includes/BackupPackage.php

@@ -44 +44 @@
         public function __construct($domain_name, $password)
         {
+                // make clean temp path for every call
+                if (file_exists(BACKUP_TEMP_PATH)) {
+                        delTree(BACKUP_TEMP_PATH);
+                }
+                mkdir(BACKUP_TEMP_PATH, 0700, true);
+
+                // create archive path for domain packages if not exist
+                if (!file_exists(ARCHIVE_PATH)) {
+                        mkdir(ARCHIVE_PATH, 0700, true);
+                }
+
                 $this->password = $password;
                 $this->domain_name = $domain_name;
+
+                // tar and mysqldump can take a lot of time
+                set_time_limit(0);
+        }
+
+        /**
+         * Destructor, clean up temp path on exit
+         */
+        public function __destruct()
+        {
+                if (file_exists(BACKUP_TEMP_PATH)) {
+                        delTree(BACKUP_TEMP_PATH);
+                }
         }
 
@@ -111 +135 @@
          * Create .tar.gz and protect by gpg symmetric encryption
          */
-        private function createDomainArchive()
+        private function createDomainPackage()
         {
                 // create .tar.gz
@@ -128 +152 @@
                 $this->shellExecute($cmd, $a);
 
-                // delete .tar.gz
+                // delete remaining .tar.gz
                 unlink($filename);
 
@@ -152 +176 @@
                         $this->setConfigData('dbuser',   $this->getDBUserConfig());
 
-                        // first create configuration file
-                        // if successful, create databases and complete domain archive
+                        // First create configuration file. If successful, create database
+                        // dumps and create the complete domain package file
                         $result = $this->writeDomainConfig();
                         if ($result) {
                                 $result = $this->dumpDomainDatabases();
                                 if ($result) {
-                                        $result = $this->createDomainArchive();
+                                        $result = $this->createDomainPackage();
                                 }
                         }

branches/backup-restore/includes/BackupPackage_ispCP.php

@@ -39 +39 @@
          * ispCP database IDs (name => id)
          */
-        private $db_ids = array();
+        protected $db_ids = array();
 
         public function __construct($domain_name, $password)
@@ -47 +47 @@
         }
 
+        /**
+         * Get domain database id, validate if vhost path exists
+         * @return bool true = init ok, false = see error message
+         */
         protected function initDomain()
         {
                 $result = false;
 
-                $test = $this->getDomainID($this->domain_name);
-                if ($test != -1) {
-                        $result = true;
+                if (!file_exists(ISPCP_VIRTUAL_PATH.'/'.$this->domain_name)) {
+                        $this->addErrorMessage('Domain not found in '.ISPCP_VIRTUAL_PATH.'/'.$this->domain_name);
                 } else {
-                        $this->addErrorMessage('Domain not in database: '.$this->domain_name);
+                        $test = $this->getDomainID($this->domain_name);
+                        if ($test != -1) {
+                                $result = true;
+                        } else {
+                                $this->addErrorMessage('Domain not in database: '.$this->domain_name);
+                        }
                 }
 
@@ -66 +74 @@
          * @return integer domain id, -1 if not present
          */
-        private function getDomainID($domain_name)
+        protected function getDomainID($domain_name)
         {
                 $this->domain_id = -1;
@@ -148 +156 @@
                 $rs = $this->db->Execute($query, array(':id'=>$this->domain_id));
                 while (!$rs->EOF) {
-                        // TODO: sub_id?
                         $row = $rs->FetchRow();
                         $row['mail_pass'] = decrypt_db_password($row['mail_pass']);
@@ -172 +179 @@
                 $rs = $this->db->Execute($query, array(':uid'=>$this->domain_user_id));
                 while ($rs && !$rs->EOF) {
-                        // TODO: passwd? Where is the magic?
                         $row = $rs->FetchRow();
                         $result[] = $row;
@@ -205 +211 @@
         }
 
-        private function getSubdomainAliasConfig($alias_id)
+        protected function getSubdomainAliasConfig($alias_id)
         {
                 $result = array();

branches/backup-restore/includes/Base.php

@@ -25 +25 @@
         public $verbose = false;
         /**
-         * array of error messages
+         * array of strings for error messages
          */
         protected $errorMessages = array();
@@ -55 +55 @@
         }
 }
+

branches/backup-restore/includes/RestorePackage_ispCP.php

@@ -19 +19 @@
  */
 
+/**
+ * ispCP restore packager main class
+ */
 class RestorePackage_ispCP extends BaseController
 {
@@ -42 +45 @@
         protected $ip_id = -1;
         /**
+         * Reseller name or false for first reseller
+         */
+        protected $reseller;
+        /**
+         * ID of reseller
+         */
+        protected $reseller_id = -1;
+        /**
          * linux user id
          */
         protected $domain_user_id = 0;
-
-        public function __construct($domain_name, $password, $specific_ip)
+        /**
+         * file name of gpg encrypted domain package
+         */
+        protected $archive = '';
+
+        /**
+         * Restore packager
+         * @param string $domain_name
+         * @param string $password password for gpg symmetric decryption
+         * @param mixed $option_ip false or string of target IP address
+         * @param mixed $option_reseller false or string of reseller name
+         */
+        public function __construct($domain_name, $password, $option_ip, $option_reseller)
         {
                 $this->password = $password;
                 $this->domain_name = $domain_name;
                 $this->db = Database::getInstance();
-                $this->ip = $specific_ip;
-        }
-
-        private function setDomainPermissions()
+                $this->ip = $option_ip;
+                $this->reseller = $option_reseller;
+                $this->archive = ARCHIVE_PATH.'/'.$this->domain_name.'.tar.gz.gpg';
+
+                // untar and mysql can take a lot of time
+                set_time_limit(0);
+        }
+
+        /**
+         * Set permissions to vhost directory
+         */
+        protected function setDomainPermissions()
         {
                 // TODO: setDomainPermissions (chown)
@@ -63 +93 @@
          * @return integer ID of IP
          */
-        private function getDefaultIP()
+        protected function getDefaultIPID()
         {
                 $result = -1;
@@ -80 +110 @@
 
         /**
-         * Get ID of specific IP
+         * Get ID of first reseller
+         * @return integer ID of reseller
+         */
+        protected function getDefaultResellerID()
+        {
+                $result = -1;
+
+                $sql = "SELECT `admin_id` FROM `admin` WHERE `admin_type` = :admin_type" .
+                           " ORDER BY `admin_id` LIMIT 0, 1";
+                $query = $this->db->Prepare($sql);
+                $rs = $this->db->Execute($query, array(':admin_type'=>'reseller'));
+                if ($rs && !$rs->EOF) {
+                        $result = $rs->fields['admin_id'];
+                } else {
+                        $this->addErrorMessage('No resellers found!?');
+                }
+
+                return $result;
+        }
+
+        /**
+         * Get ID of reseller name
+         * @param string $reseller name of reseller (e.g. 'res1')
+         * @return integer ispCP database ID of reseller
+         */
+        protected function getResellerID($reseller)
+        {
+                $result = -1;
+
+                $sql = "SELECT `admin_id` FROM `admin` WHERE `admin_type` = :admin_type" .
+                           " AND `admin_name` = :name" .
+                           " ORDER BY `admin_id` LIMIT 0, 1";
+                $query = $this->db->Prepare($sql);
+                $rs = $this->db->Execute($query, array(':admin_type'=>'reseller', ':name'=>$reseller));
+                if ($rs && !$rs->EOF) {
+                        $result = $rs->fields['admin_id'];
+                } else {
+                        $this->addErrorMessage('Reseller not found: '.$reseller);
+                }
+
+                return $result;
+        }
+
+        /**
+         * Get ID of IP
          * @param string $ip IP address
-         * @return integer ID of IP
-         */
-        private function getSpecificIP($ip)
+         * @return integer ispCP database ID of IP
+         */
+        protected function getIPID($ip)
         {
                 $result = -1;
@@ -94 +168 @@
                         $result = $rs->fields['ip_id'];
                 } else {
-                        $this->addErrorMessage('IP not found!?');
-                }
-
-                return $result;
-        }
-
+                        $this->addErrorMessage('IP not found: '.$ip);
+                }
+
+                return $result;
+        }
+
+        /**
+         * Validate presence of gpg encrypted archive, get ID of IP and reseller
+         */
+        protected function initRestore()
+        {
+                $result = false;
+
+                if (!file_exists($this->archive)) {
+                        $this->addErrorMessage('Domain backup package file not found: '.$this->archive);
+                } else {
+                        // IP detection
+                        if ($this->ip === false) {
+                                $this->ip_id = $this->getDefaultIPID();
+                        } else {
+                                $this->ip_id = $this->getIPID($this->ip);
+                        }
+
+                        // Reseller detection
+                        if ($this->reseller === false) {
+                                $this->reseller_id = $this->getDefaultResellerID();
+                        } else {
+                                $this->reseller_id = $this->getResellerID($this->reseller);
+                        }
+
+                        if ($this->ip_id != -1 && $this->reseller_id != -1) {
+                                $result = true;
+                        }
+                }
+
+                return $result;
+        }
+
+        /**
+         * Run the restore, main method
+         * @return boolean true = restore successful, false = see error messages
+         */
         public function runRestore()
         {
                 $result = false;
 
-                // IP detection
-                if ($this->ip === false) {
-                        $this->ip_id = $this->getDefaultIP();
-                } else {
-                        $this->ip_id = $this->getSpecificIP($this->ip);
-                }
-
-                if ($this->ip_id != -1) {
-                        // TODO: got IP ID, go on...
+                if ($this->initRestore()) {
+                        // TODO: runRestore()
+                        // don't forget sub_id in mail accounts!
                 }
 

branches/backup-restore/restore.php

@@ -25 +25 @@
         echo "Usage: php restore.php [OPTIONS] domain archive-password\n";
         echo "OPTIONS:\n";
-        echo " -i IP ........ use specific IP for domain\n";
+        echo " -i IP ........ use IP for domain (default = first found)\n";
+        echo " -r RES ....... use reseller for domain (default = first found)\n";
         echo " -v ........... verbose mode\n";
+        echo "\n";
+        echo "Please ensure, there is enough free disk space available for\n";
+        echo "this operation (approx. triple size of htdocs and databases)!\n";
         exit(1);
 }
 
-$verbose = $specific_ip = false;
+$verbose = $option_ip = $option_res = false;
 for ($i = 1; $i < $argc-2; $i++) {
         if ($argv[$i] == '-v') {
                 $verbose = true;
         } elseif ($argv[$i] == '-i') {
-                $specific_ip = $argv[++$i];
+                $option_ip = $argv[++$i];
+        } elseif ($argv[$i] == '-r') {
+                $option_res = $argv[++$i];
         }
 }
@@ -41 +47 @@
 $domain_name = $argv[$argc-2];
 $password = $argv[$argc-1];
-if (!file_exists(ARCHIVE_PATH.'/'.$domain_name.'.tar.gz.gpg')) {
-        echo "Domain backup file not found in ".ARCHIVE_PATH.'/'.$domain_name.'.tar.gz.gpg'."\n";
-        exit(2);
-}
 
 $exitcode = 0;
-$handler = new RestorePackage_ispCP($domain_name, $password, $specific_ip);
+$handler = new RestorePackage_ispCP($domain_name, $password, $option_ip);
 $handler->verbose = $verbose;
 if ($handler->runRestore() == false) {