acm2/src/acm2/acm2.php

<?php

    /** @noinspection PhpMissingFieldTypeInspection */

    namespace acm2;

    use acm2\Exceptions\ConfigurationFolderNotFoundException;
    use acm2\Exceptions\ConfigurationNotDefinedException;
    use acm2\Objects\Schema;

    class acm2
    {
        /**
         * @var string
         */
        private $VendorName;

        /**
         * @var string
         */
        private $WorkingDirectory;

        /**
         * @var string
         */
        private $MasterConfigurationPath;

        /**
         * @var array|null
         */
        private $Configuration;

        /**
         * @param string $vendor
         * @throws ConfigurationFolderNotFoundException
         */
        public function __construct(string $vendor)
        {
            $vendor = mb_ereg_replace("([^\w\s\d\-_~,;\[\]\(\).])", '', $vendor);
            $vendor = mb_ereg_replace("([\.]{2,})", '', $vendor);
            $vendor = str_ireplace(' ', '_', $vendor);
            $vendor = strtolower($vendor);
            $this->VendorName = $vendor;

            $this->WorkingDirectory = DIRECTORY_SEPARATOR . 'etc' . DIRECTORY_SEPARATOR . 'acm';
            $this->MasterConfigurationPath = $this->WorkingDirectory . DIRECTORY_SEPARATOR . $this->VendorName . '.json';

            if(file_exists($this->WorkingDirectory) == false)
                throw new ConfigurationFolderNotFoundException('The configuration folder \'' . $this->WorkingDirectory . '\' was not found');

            $this->reloadConfiguration();
        }

        /**
         * Reloads the configuration or creates it if it doesn't exist
         */
        public function reloadConfiguration()
        {
            if($this->Configuration == null)
            {
                $this->Configuration = [
                    'file_type' => 'acm_json',
                    'file_version' => '2.0.0.0',
                    'configuration' => []
                ];
            }

            if(file_exists($this->MasterConfigurationPath) == false)
            {
                file_put_contents($this->MasterConfigurationPath, json_encode($this->Configuration, JSON_UNESCAPED_SLASHES | JSON_PRETTY_PRINT));
                return;
            }

            $this->Configuration = json_decode(file_get_contents($this->MasterConfigurationPath), true);

            // Preform an upgrade
            if($this->Configuration['file_version'] == '1.0.0.0')
            {
                $this->Configuration['file_version'] = '2.0.0.0.0';

                if(isset($this->Configuration['configurations']))
                {
                    $this->Configuration['configuration'] = $this->Configuration['configurations'];
                    unset($this->Configuration['configurations']);
                }

                if(isset($this->Configuration['schemas']))
                {
                    unset($this->Configuration['schemas']);
                }

                file_put_contents($this->MasterConfigurationPath, json_encode($this->Configuration, JSON_UNESCAPED_SLASHES | JSON_PRETTY_PRINT));
            }
        }

        /**
         * Saves the updated configuration to disk
         */
        public function updateConfiguration()
        {
            if($this->Configuration == null)
                $this->reloadConfiguration();

            $this->Configuration['file_type'] = 'acm_json';
            $this->Configuration['file_version'] = '2.0.0.0';

            // Get in-memory hash
            $memory_hash = hash('crc32', json_encode($this->Configuration, JSON_UNESCAPED_SLASHES | JSON_PRETTY_PRINT));

            // Get configuration hash
            $configuration_hash = hash_file('crc32', $this->MasterConfigurationPath);

            if($memory_hash == $configuration_hash)
                return;

            file_put_contents($this->MasterConfigurationPath, json_encode($this->Configuration, JSON_UNESCAPED_SLASHES | JSON_PRETTY_PRINT));
        }

        /**
         * Defines a new schema in the configuration
         *
         * @param Schema $schema
         * @param bool $update
         */
        public function defineSchema(Schema $schema, bool $update=false)
        {
            if($this->Configuration == null)
                $this->reloadConfiguration();

            if(isset($this->Configuration['configuration'][$schema->getName()]) == false)
            {
                $this->Configuration['configuration'][$schema->getName()] = $schema->toArray();
            }
            else
            {
                // Add missing values
                foreach($schema->toArray() as $name => $value)
                {
                    if(isset($this->Configuration['configuration'][$schema->getName()][$name]) == false)
                        $this->Configuration['configuration'][$schema->getName()][$name] = $value;
                }
            }

            if($update)
                $this->updateConfiguration();
        }

        /**
         * Returns a configuration
         *
         * @param string $name
         * @return mixed
         * @throws ConfigurationNotDefinedException
         */
        public function getConfiguration(string $name)
        {
            if(isset($this->Configuration['configuration'][$name]) == false)
                throw new ConfigurationNotDefinedException($name . ' is not defined in the configuration');

            return $this->Configuration['configuration'][$name];
        }

        /**
         * Updates a configuration value
         *
         * @param string $name
         * @param string $config_name
         * @param string $config_value
         * @throws ConfigurationNotDefinedException
         */
        public function updateConfigurationValue(string $name, string $config_name, string $config_value)
        {
            if(isset($this->Configuration['configuration'][$name]) == false)
                throw new ConfigurationNotDefinedException($name . ' is not defined in the configuration');
            $this->Configuration['configuration'][$name][$config_name] = $config_value;
            file_put_contents($this->MasterConfigurationPath, json_encode($this->Configuration, JSON_UNESCAPED_SLASHES | JSON_PRETTY_PRINT));
        }

        /**
         * @return string
         */
        public function getMasterConfigurationPath(): string
        {
            return $this->MasterConfigurationPath;
        }

        /**
         * @return string
         */
        public function getWorkingDirectory(): string
        {
            return $this->WorkingDirectory;
        }

        /**
         * @return string
         */
        public function getVendorName(): string
        {
            return $this->VendorName;
        }
    }