Moved all install functions into an AirtimeInstall class.

Formatted all the install files according to our code formatting standards.
Output more info if something goes wrong during DB create or DB user create.

install/airtime-install.php

@@ -1,7 +1,6 @@
 <?php
 /**
  * @package Airtime
- * @subpackage StorageServer
  * @copyright 2010 Sourcefabric O.P.S.
  * @license http://www.gnu.org/licenses/gpl.txt
  */
@@ -20,34 +19,33 @@ require_once(dirname(__FILE__).'/installInit.php');
 
 echo "******************************** Install Begin *********************************".PHP_EOL;
 
-checkIfRoot();
+AirtimeInstall::ExitIfNotRoot();
-createAPIKey();
+AirtimeInstall::CreateApiKey();
-updateINIKeyValues('../build/build.properties', 'project.home', realpath(__dir__.'/../'));
+AirtimeInstall::UpdateIniValue('../build/build.properties', 'project.home', realpath(__dir__.'/../'));
 
 
 echo PHP_EOL."*** Database Installation ***".PHP_EOL;
 
 echo "* Creating Airtime Database User".PHP_EOL;
-createAirtimeDatabaseUser();
+AirtimeInstall::CreateDatabaseUser();
 
 echo "* Creating Airtime Database".PHP_EOL;
-createAirtimeDatabase();
+AirtimeInstall::CreateDatabase();
 
-
+AirtimeInstall::DbConnect(true);
-airtime_db_connect(true);
 
 echo "* Install Postgresql Scripting Language".PHP_EOL;
-installPostgresScriptingLanguage();
+AirtimeInstall::InstallPostgresScriptingLanguage();
 
 echo "* Creating Database Tables".PHP_EOL;
-createAirtimeDatabaseTables();
+AirtimeInstall::CreateDatabaseTables();
-doctrineMigrateTables(__DIR__);
+AirtimeInstall::MigrateTables(__DIR__);
 
 echo "* Storage Directory Setup".PHP_EOL;
-storageDirectorySetup($CC_CONFIG);
+AirtimeInstall::SetupStorageDirectory($CC_CONFIG);
 
 echo "* Setting Dir Permissions".PHP_EOL;
-install_setDirPermissions($CC_CONFIG["storageDir"]);
+AirtimeInstall::ChangeDirOwnerToWebserver($CC_CONFIG["storageDir"]);
 
 echo "* Importing Sample Audio Clips".PHP_EOL;
 system(__DIR__."/../utils/airtime-import --copy ../audio_samples/ > /dev/null");

install/airtime-uninstall.php

@@ -18,13 +18,13 @@ require_once(dirname(__FILE__).'/../application/configs/conf.php');
 require_once(dirname(__FILE__).'/installInit.php');
 
 // Need to check that we are superuser before running this.
-checkIfRoot();
+AirtimeInstall::ExitIfNotRoot();
 
 
 echo "******************************* Uninstall Begin ********************************".PHP_EOL;
 //------------------------------------------------------------------------
 // Delete the database
-// Note: Do not put a call to airtime_db_connect()
+// Note: Do not put a call to AirtimeInstall::DbConnect()
 // before this function, even if you called $CC_DBC->disconnect(), there will
 // still be a connection to the database and you wont be able to delete it.
 //------------------------------------------------------------------------
@@ -37,26 +37,29 @@ $command = "sudo -u postgres dropdb {$CC_CONFIG['dsn']['database']} 2> /dev/null
 // We do this if dropping the database fails above.
 //------------------------------------------------------------------------
 if ($dbDeleteFailed) {
-  echo " * Couldn't delete the database, so deleting all the DB tables...".PHP_EOL;
+    echo " * Couldn't delete the database, so deleting all the DB tables...".PHP_EOL;
-  airtime_db_connect(true);
+    AirtimeInstall::DbConnect(true);
 
-  if (!PEAR::isError($CC_DBC)) {
+    if (!PEAR::isError($CC_DBC)) {
-      $sql = "select * from pg_tables where tableowner = 'airtime'";
+        $sql = "select * from pg_tables where tableowner = 'airtime'";
-      $rows = airtime_get_query($sql);
+        $rows = $CC_DBC->GetAll($sql);
+        if (PEAR::isError($result)) {
+            $rows = array();
+        }
 
-      foreach ($rows as $row){
+        foreach ($rows as $row) {
-          $tablename = $row["tablename"];
+            $tablename = $row["tablename"];
-          echo "   * Removing database table $tablename...";
+            echo "   * Removing database table $tablename...";
 
-          if (airtime_db_table_exists($tablename)){
+            if (AirtimeInstall::DbTableExists($tablename)){
-              $sql = "DROP TABLE $tablename CASCADE";
+                $sql = "DROP TABLE $tablename CASCADE";
-              airtime_install_query($sql, false);
+                AirtimeInstall::InstallQuery($sql, false);
-                  
+
-              $CC_DBC->dropSequence($tablename."_id");
+                $CC_DBC->dropSequence($tablename."_id");
-          }
+            }
-          echo "done.".PHP_EOL;
+            echo "done.".PHP_EOL;
-      }
+        }
-  }
+    }
 }
 
 //------------------------------------------------------------------------
@@ -66,16 +69,16 @@ echo " * Deleting database user '{$CC_CONFIG['dsn']['username']}'...".PHP_EOL;
 $command = "sudo -u postgres psql postgres --command \"DROP USER {$CC_CONFIG['dsn']['username']}\" 2> /dev/null";
 @exec($command, $output, $results);
 if ($results == 0) {
-  echo "   * User '{$CC_CONFIG['dsn']['username']}' deleted.".PHP_EOL;
+    echo "   * User '{$CC_CONFIG['dsn']['username']}' deleted.".PHP_EOL;
 } else {
-  echo "   * Nothing to delete..".PHP_EOL;
+    echo "   * Nothing to delete..".PHP_EOL;
 }
 
 
 //------------------------------------------------------------------------
 // Delete files
 //------------------------------------------------------------------------
-airtime_uninstall_delete_files($CC_CONFIG['storageDir']);
+AirtimeInstall::DeleteFilesRecursive($CC_CONFIG['storageDir']);
 
 
 $command = "python ".__DIR__."/../pypo/install/pypo-uninstall.py";

install/airtime-upgrade.php

@@ -17,13 +17,13 @@ if (isset($arr["DOCUMENT_ROOT"]) && ($arr["DOCUMENT_ROOT"] != "") ) {
 
 require_once(dirname(__FILE__).'/installInit.php');
 
-checkIfRoot();
+AirtimeInstall::ExitIfNotRoot();
 
 echo "******************************** Update Begin *********************************".PHP_EOL;
-updateINIKeyValues('../build/build.properties', 'project.home', realpath(__dir__.'/../'));
+AirtimeInstall::UpdateIniValue('../build/build.properties', 'project.home', realpath(__dir__.'/../'));
 
 echo PHP_EOL."*** Updating Database Tables ***".PHP_EOL;
-doctrineMigrateTables(__DIR__);
+AirtimeInstall::MigrateTables(__DIR__);
 
 echo PHP_EOL."*** Updating Pypo ***".PHP_EOL;
 system("python ".__DIR__."/../pypo/install/pypo-install.py");

install/installInit.php

@@ -7,190 +7,193 @@ if (!function_exists('pg_connect')) {
 require_once(dirname(__FILE__).'/../library/pear/DB.php');
 require_once(dirname(__FILE__).'/../application/configs/conf.php');
 
-function airtime_db_table_exists($p_name)
+class AirtimeInstall {
-{
-    global $CC_DBC;
-    $sql = "SELECT * FROM ".$p_name;
-    $result = $CC_DBC->GetOne($sql);
-    if (PEAR::isError($result)) {
-        return false;
-    }
-    return true;
-}
 
-function airtime_get_query($sql)
+    static function DbTableExists($p_name)
-{
+    {
-    global $CC_DBC;
+        global $CC_DBC;
-    $result = $CC_DBC->GetAll($sql);
+        $sql = "SELECT * FROM ".$p_name;
-    if (PEAR::isError($result)) {
+        $result = $CC_DBC->GetOne($sql);
-        return array();
+        if (PEAR::isError($result)) {
+            return false;
+        }
+        return true;
     }
-    return $result;
-}
 
-function airtime_install_query($sql, $verbose = true)
+    static function InstallQuery($sql, $verbose = true)
-{
+    {
-    global $CC_DBC;
+        global $CC_DBC;
-    $result = $CC_DBC->query($sql);
+        $result = $CC_DBC->query($sql);
-    if (PEAR::isError($result)) {
+        if (PEAR::isError($result)) {
-        echo "Error! ".$result->getMessage()."\n";
+            echo "Error! ".$result->getMessage()."\n";
-        echo "   SQL statement was:\n";
+            echo "   SQL statement was:\n";
-        echo "   ".$sql."\n\n";
+            echo "   ".$sql."\n\n";
-    } else {
+        } else {
-        if ($verbose) {
+            if ($verbose) {
-            echo "done.\n";
+                echo "done.\n";
+            }
         }
     }
-}
 
-function airtime_db_connect($p_exitOnError = true) {
+    static function DbConnect($p_exitOnError = true)
-    global $CC_DBC, $CC_CONFIG;
+    {
-    $CC_DBC = DB::connect($CC_CONFIG['dsn'], TRUE);
+        global $CC_DBC, $CC_CONFIG;
-    if (PEAR::isError($CC_DBC)) {
+        $CC_DBC = DB::connect($CC_CONFIG['dsn'], TRUE);
-        echo $CC_DBC->getMessage().PHP_EOL;
+        if (PEAR::isError($CC_DBC)) {
-        echo $CC_DBC->getUserInfo().PHP_EOL;
+            echo $CC_DBC->getMessage().PHP_EOL;
-        echo "Database connection problem.".PHP_EOL;
+            echo $CC_DBC->getUserInfo().PHP_EOL;
-        echo "Check if database '{$CC_CONFIG['dsn']['database']}' exists".
+            echo "Database connection problem.".PHP_EOL;
-            " with corresponding permissions.".PHP_EOL;
+            echo "Check if database '{$CC_CONFIG['dsn']['database']}' exists".
-        if ($p_exitOnError) {
+	            " with corresponding permissions.".PHP_EOL;
+            if ($p_exitOnError) {
+                exit(1);
+            }
+        } else {
+            echo "* Connected to database".PHP_EOL;
+            $CC_DBC->setFetchMode(DB_FETCHMODE_ASSOC);
+        }
+    }
+
+    static function ChangeDirOwnerToWebserver($filePath)
+    {
+        global $CC_CONFIG;
+        $success = chgrp($filePath, $CC_CONFIG["webServerUser"]);
+        $fileperms=@fileperms($filePath);
+        $fileperms = $fileperms | 0x0010; // group write bit
+        $fileperms = $fileperms | 0x0400; // group sticky bit
+        chmod($filePath, $fileperms);
+    }
+
+    private static function GenerateRandomString($len=20, $chars = 'ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789')
+    {
+        $string = '';
+        for ($i = 0; $i < $len; $i++)
+        {
+            $pos = mt_rand(0, strlen($chars)-1);
+            $string .= $chars{$pos};
+        }
+        return $string;
+    }
+
+    public static function CreateApiKey()
+    {
+        $api_key = AirtimeInstall::GenerateRandomString();
+        AirtimeInstall::UpdateIniValue(__DIR__.'/../build/airtime.conf', 'api_key', $api_key);
+        AirtimeInstall::UpdateIniValue(__DIR__.'/../pypo/config.cfg', 'api_key', "'$api_key'");
+    }
+
+    public static function ExitIfNotRoot()
+    {
+        // Need to check that we are superuser before running this.
+        if(exec("whoami") != "root"){
+            echo "Must be root user.\n";
             exit(1);
         }
-    } else {
-        echo "* Connected to database".PHP_EOL;
-        $CC_DBC->setFetchMode(DB_FETCHMODE_ASSOC);
     }
-}
 
-function install_setDirPermissions($filePath) {
+    public static function UpdateIniValue($filename, $property, $value)
-    global $CC_CONFIG;
-    $success = chgrp($filePath, $CC_CONFIG["webServerUser"]);
-    $fileperms=@fileperms($filePath);
-    $fileperms = $fileperms | 0x0010; // group write bit
-    $fileperms = $fileperms | 0x0400; // group sticky bit
-    chmod($filePath, $fileperms);
-}
-
-function rand_string($len=20, $chars = 'ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789')
-{
-    $string = '';
-    for ($i = 0; $i < $len; $i++)
     {
-        $pos = mt_rand(0, strlen($chars)-1);
+        $lines = file($filename);
-        $string .= $chars{$pos};
+        $n=count($lines);
-    }
+        for ($i=0; $i<$n; $i++) {
-    return $string;
+            if (strlen($lines[$i]) > strlen($property))
-}
-
-function createAPIKey(){
-
-    $api_key = rand_string();
-    updateINIKeyValues(__DIR__.'/../build/airtime.conf', 'api_key', $api_key);
-    updateINIKeyValues(__DIR__.'/../pypo/config.cfg', 'api_key', "'$api_key'");
-}
-
-function checkIfRoot(){
-    // Need to check that we are superuser before running this.
-    if(exec("whoami") != "root"){
-      echo "Must be root user.\n";
-      exit(1);
-    }
-}
-
-function updateINIKeyValues($filename, $property, $value){
-    $lines = file($filename);
-    $n=count($lines);
-    for ($i=0; $i<$n; $i++) {
-        if (strlen($lines[$i]) > strlen($property))
             if ($property == substr($lines[$i], 0, strlen($property))){
                 $lines[$i] = "$property = $value\n";
             }
-    }
-
-    $fp=fopen($filename, 'w');
-    for($i=0; $i<$n; $i++){
-        fwrite($fp, $lines[$i]);
-    }
-    fclose($fp);
-}
-
-function storageDirectorySetup($CC_CONFIG){
-    global $CC_CONFIG, $CC_DBC;
-    
-    echo PHP_EOL."*** Directory Setup ***".PHP_EOL;
-    foreach (array('baseFilesDir', 'storageDir') as $d) {
-        if ( !file_exists($CC_CONFIG[$d]) ) {
-            @mkdir($CC_CONFIG[$d], 02775, true);
-            if (file_exists($CC_CONFIG[$d])) {
-                $rp = realpath($CC_CONFIG[$d]);
-                echo "* Directory $rp created".PHP_EOL;
-            } else {
-                echo "* Failed creating {$CC_CONFIG[$d]}".PHP_EOL;
-                exit(1);
-            }
-        } elseif (is_writable($CC_CONFIG[$d])) {
-            $rp = realpath($CC_CONFIG[$d]);
-            echo "* Skipping directory already exists: $rp".PHP_EOL;
-        } else {
-            $rp = realpath($CC_CONFIG[$d]);
-            echo "* WARNING: Directory already exists, but is not writable: $rp".PHP_EOL;
         }
-        $CC_CONFIG[$d] = $rp;
+
+        $fp=fopen($filename, 'w');
+        for($i=0; $i<$n; $i++){
+            fwrite($fp, $lines[$i]);
+        }
+        fclose($fp);
     }
-}
 
-function createAirtimeDatabaseUser(){
+    public static function SetupStorageDirectory($CC_CONFIG)
-    global $CC_CONFIG;
+    {
-    // Create the database user
+        global $CC_CONFIG, $CC_DBC;
-    $command = "sudo -u postgres psql postgres --command \"CREATE USER {$CC_CONFIG['dsn']['username']} "
+         
-      ." ENCRYPTED PASSWORD '{$CC_CONFIG['dsn']['password']}' LOGIN CREATEDB NOCREATEUSER;\" 2>/dev/null";
+        echo PHP_EOL."*** Directory Setup ***".PHP_EOL;
-      
+        foreach (array('baseFilesDir', 'storageDir') as $d) {
-    @exec($command, $output, $results);
+            if ( !file_exists($CC_CONFIG[$d]) ) {
-    if ($results == 0) {
+                @mkdir($CC_CONFIG[$d], 02775, true);
-      echo "* User {$CC_CONFIG['dsn']['username']} created.".PHP_EOL;
+                if (file_exists($CC_CONFIG[$d])) {
-    } else {
+                    $rp = realpath($CC_CONFIG[$d]);
-      echo "* User {$CC_CONFIG['dsn']['username']} already exists.".PHP_EOL;
+                    echo "* Directory $rp created".PHP_EOL;
+                } else {
+                    echo "* Failed creating {$CC_CONFIG[$d]}".PHP_EOL;
+                    exit(1);
+                }
+            } elseif (is_writable($CC_CONFIG[$d])) {
+                $rp = realpath($CC_CONFIG[$d]);
+                echo "* Skipping directory already exists: $rp".PHP_EOL;
+            } else {
+                $rp = realpath($CC_CONFIG[$d]);
+                echo "* WARNING: Directory already exists, but is not writable: $rp".PHP_EOL;
+            }
+            $CC_CONFIG[$d] = $rp;
+        }
     }
-}
 
-function createAirtimeDatabase(){
+    public static function CreateDatabaseUser()
-    global $CC_CONFIG;
+    {
-    
+        global $CC_CONFIG;
-    $command = "sudo -u postgres createdb {$CC_CONFIG['dsn']['database']} --owner {$CC_CONFIG['dsn']['username']} 2> /dev/null";
+        // Create the database user
-    @exec($command, $output, $results);
+        $command = "sudo -u postgres psql postgres --command \"CREATE USER {$CC_CONFIG['dsn']['username']} "
-    if ($results == 0) {
+        ." ENCRYPTED PASSWORD '{$CC_CONFIG['dsn']['password']}' LOGIN CREATEDB NOCREATEUSER;\" 2>/dev/null";
-      echo "* Database '{$CC_CONFIG['dsn']['database']}' created.".PHP_EOL;
+         
-    } else {
+        @exec($command, $output, $results);
-      echo "* Database '{$CC_CONFIG['dsn']['database']}' already exists.".PHP_EOL;
+        if ($results == 0) {
+            echo "* User {$CC_CONFIG['dsn']['username']} created.".PHP_EOL;
+        } else {
+            echo "* Could not create user {$CC_CONFIG['dsn']['username']}: $output".PHP_EOL;
+        }
     }
-}
 
-function installPostgresScriptingLanguage(){
+    public static function CreateDatabase()
-    global $CC_DBC;
+    {
-    // Install postgres scripting language
+        global $CC_CONFIG;
-    $langIsInstalled = $CC_DBC->GetOne('SELECT COUNT(*) FROM pg_language WHERE lanname = \'plpgsql\'');
+         
-    if ($langIsInstalled == '0') {
+        $command = "sudo -u postgres createdb {$CC_CONFIG['dsn']['database']} --owner {$CC_CONFIG['dsn']['username']} 2> /dev/null";
-      echo "* Installing Postgres scripting language".PHP_EOL;
+        @exec($command, $output, $results);
-      $sql = "CREATE LANGUAGE 'plpgsql'";
+        if ($results == 0) {
-      airtime_install_query($sql, false);
+            echo "* Database '{$CC_CONFIG['dsn']['database']}' created.".PHP_EOL;
-    } else {
+        } else {
-      echo "* Postgres scripting language already installed".PHP_EOL;
+            echo "* Could not create database '{$CC_CONFIG['dsn']['database']}': $output".PHP_EOL;
+        }
     }
-}
 
+    public static function InstallPostgresScriptingLanguage()
+    {
+        global $CC_DBC;
+        // Install postgres scripting language
+        $langIsInstalled = $CC_DBC->GetOne('SELECT COUNT(*) FROM pg_language WHERE lanname = \'plpgsql\'');
+        if ($langIsInstalled == '0') {
+            echo "* Installing Postgres scripting language".PHP_EOL;
+            $sql = "CREATE LANGUAGE 'plpgsql'";
+            AirtimeInstall::InstallQuery($sql, false);
+        } else {
+            echo "* Postgres scripting language already installed".PHP_EOL;
+        }
+    }
 
-function createAirtimeDatabaseTables(){
+    public static function CreateDatabaseTables()
-    // Put Propel sql files in Database
+    {
-    $command = __DIR__."/../library/propel/generator/bin/propel-gen ../build/ insert-sql 2>propel-error.log";
+        // Put Propel sql files in Database
-    @exec($command, $output, $results);
+        $command = __DIR__."/../library/propel/generator/bin/propel-gen ../build/ insert-sql 2>propel-error.log";
-}
+        @exec($command, $output, $results);
+    }
 
-function doctrineMigrateTables($dir){
+    public static function MigrateTables($dir)
-    $command = "php $dir/../library/doctrine/migrations/doctrine-migrations.phar --configuration=$dir/DoctrineMigrations/migrations.xml --db-configuration=$dir/../library/doctrine/migrations/migrations-db.php --no-interaction migrations:migrate";
+    {
-    system($command);
+        $command = "php $dir/../library/doctrine/migrations/doctrine-migrations.phar --configuration=$dir/DoctrineMigrations/migrations.xml --db-configuration=$dir/../library/doctrine/migrations/migrations-db.php --no-interaction migrations:migrate";
-}
+        system($command);
+    }
 
-function airtime_uninstall_delete_files($p_path)
+    public static function DeleteFilesRecursive($p_path)
-{
+    {
-	$command = "rm -rf $p_path";
+        $command = "rm -rf $p_path";
-	exec($command);
+        exec($command);
-}
+    }
+
+}

utils/CleanStor.php

@@ -84,10 +84,10 @@ function airtime_empty_db($db) {
     global $CC_CONFIG;
 
     if (!PEAR::isError($db)) {
-        if (airtime_db_table_exists($CC_CONFIG['filesTable'])) {
+        if (AirtimeInstall::DbTableExists($CC_CONFIG['filesTable'])) {
             echo " * Deleting from database table ".$CC_CONFIG['filesTable']."\n";
             $sql = "DELETE FROM ".$CC_CONFIG['filesTable'];
-            airtime_install_query($sql, false);
+            AirtimeInstall::InstallQuery($sql, false);
         }
         else {
             echo " * Skipping: database table ".$CC_CONFIG['filesTable']."\n";