path: root/core/config/anom_settings.php

<?php
/** CONFIGURATION PARAMETRES
 * -----------------------------------------------------------------------------
 * 
 * Here you can find all the setup paramaters that define
 * key-decisions of your application;
 * 
 * ex. Session driver, Cache driver, Cookies Policy etc;
 * 
 * Other supplamentary constants (ex. Session options according to the driver,
 * Cookie properties according to the application's specs) shall be defined
 * into the ~/public/app/config/app_constants.php
 * 
 * 
 * NOTE:
 * You may rewrite the defines setting any values manualy
 * SETTING anom CONSTANTS VIA an `.env` FILE IS HIGHLY RECOMMENDED (for safety)
 * The default env file is saved into `~/core/auth` folder
 *  
 * -----------------------------------------------------------------------------
 */

if (file_exists("../core/auth/.env")) {
    $ini = parse_ini_file("../core/auth/.env");
}




/** ENVIRONMENT constant
 * -----------------------------------------------------------------------------
 * 
 * define application's environment stage; [PRODUCTION|develpment|testing|*]
 * seting this constant to 'PRODUCTION' eliminates debuggin comments;
 * 
 * DO NOT FORGET to change this setting when deploying to a different stage
 * 
 * -----------------------------------------------------------------------------
 */

define('PRODUCTION', ($ini['ENVIRONMENT'] == 'production') );




/** APPLICATION NAMES AND URL DEFAULTS
 * -----------------------------------------------------------------------------
 * 
 * NOTE:
 * if .env file exists ... do not touch anything
 * else ... replace $env[*] values with your setup
 * 
 * -----------------------------------------------------------------------------
 */

define('APP_NAME', $ini['APP_NAME']);         // Application Name (how developer refers to it)

define('APP_VERSION', $ini['APP_VERSION']);   // Application version (major_version + subversion_class)
                                              // keep it simple, ex: '1.alfa'  -or-  '1.beta'  -or-  '2.rc'

define('SITE_URL', $ini['ANOM_HOSTNAME']);




/** APPLICATION PATHS
 * -----------------------------------------------------------------------------
 * 
 * Obligarory:
 * These are needed in order to run the bare minimum MVC system
 * They also make code easier to read
 * 
 * NOTE:
 * most likely won't need to change any of these subsection defines;
 * still the framework makes easy for the developer
 * to change the Views and/or the Tests diectrory;
 * 
 * -----------------------------------------------------------------------------
 */

define('APP_ROOT', $ini['APP_ROOT'] ?? dirname(get_included_files()[0]) );

define('URL_ROOT', '/');

define('INIT_APPLICATION', '../core/config/init.php');

define('VIEWS_DIRECTORY', $ini['VIEWS_DIRECTORY'] ?? (APP_ROOT.'/app/views/'));

define('TESTS_DIRECTORY', $ini['TESTS_DIRECTORY'] ?? (APP_ROOT."/../tests/"));




/** AUTOLOADER /////////////////////////////////////////////////////////////////
 * -----------------------------------------------------------------------------
 * 
 * An autoloader for classes is required;
 * 
 * 
 ** OPTION 1: COMPOSER
 * -----------------------------------------------------------------------------
 * Composer is recommended and makes much more than simple autoloding
 * -----------------------------------------------------------------------------
 */

define('AUTOLOADER' , '../vendor/autoload.php');

/** OPTION 2: Custom Autoloader
 * -----------------------------------------------------------------------------
 * If Composer is not supported, another autoloading proccess required
 * Comment/Disable the 1st option and uncomment/Enable the next line
 * -----------------------------------------------------------------------------
 * 
 * NOTE: if the custom autoloadet is used
 * then you need to defing CLASSPATHS constant-array too;
 */

# define('AUTOLOADER' , '../core/helpers/autoload.php');




/** SESSION HANDLING
 * ----------------------------------------------------------------------------
 * 
 * there are several session drivers for session handling:
 *    
 * 'DefaultSession'  : uses the default (file-based) php session management
 * 'FileSession'     : defines a custom file-based session mechanism
 * 'DatabaseSession' : mechanism that stores Session data into a DataBase
 * ----------------------------------------------------------------------------
 */

define('SESSION_DRIVER', $ini['SESSION_DRIVER']);



  
/** COOKIE SETTINGS
 * -----------------------------------------------------------------------------
 * 
 * Define cookie policy (cookie sharing and securing)
 * 
 * recomended values for production environment:
 * COOKIE_SECURE=true
 * COOKIE_SAMESITE='Strict'
 * 
 * NOTE:
 * on development environment COOKIE_SECURE has to be false
 * in order for the test server to use them from http://locahost
 * 
 * for more info about cookie policy read:
 * https://www.php.net/manual/en/function.session-set-cookie-params.php
 * 
 * -----------------------------------------------------------------------------
 */

define('COOKIE_SECURE', PRODUCTION);    // Secure cookie policy [true|false]

define('COOKIE_SAMESITE', $ini['COOKIE_SAMESITE'] ?? 'Strict');    // SameSite cookie policy [Strict|Lax|None]
    
# define('COOKIE_DOMAIN', $env['ANOM_HOSTNAME']);   // domain to be visible on




/* ADVANCED OPTIMIZATION ///////////////////////////////////////////////////////
 * -----------------------------------------------------------------------------
 *
 * APP_CACHE defines the cache-driver;
 * accepted values are the name of the Cache-interface impementations (the exact
 * names of the classes)
 *
 * 'FileCache'  : caching in filesystem; fair if caching on HDD; great on SSD
 * 'RedisCache' : caching in Redis server; generally recommended if available
 * 'MemCachedCache' : caching in Memcached server; recommended if available
 *
 * NOTE: FileCache on a NVMe SDD is the fastest option;
 * Redis and Memcached are really-fast caching options and are available for
 * scaling horizontaly your application (eache one has it's own strngths;
 * study, then choose the one that fulfills your needs;
 * -----------------------------------------------------------------------------
 */
  
define('CACHE_DRIVER', $ini['CACHE_DRIVER']);




/** HOTFIX: (needs refactoring) */

// CONNECTIONS ...

define('FILECACHE_PATH', APP_ROOT.'/../storage/cache/');     // if CACHE_DRIVER is set to 'FileCache'

define('MEDIA_STORAGE_ROOT', APP_ROOT.'/../storage/uploads/');    // Media files root directory

# define('REDIS_HOST', '127.0.0.1');              // if CACHE_DRIVER is set to 'RedisCache'

# define('MEMCAHCED_SERVER', '127.0.0.1');        // if CACHE_DRIVER is set to 'MemCached'



/** SECURITY SETTINGS ///////////////////////////////////////////////////////////
 * -----------------------------------------------------------------------------
 * 
 * Cross Site Request Forgery
 * ---
 * Enables a CSRF cookie token to be set. When set to TRUE, token will be
 * checked on a submitted form. If you are accepting user data, it is strongly
 * recommended CSRF protection be enabled.
 * -----------------------------------------------------------------------------
 */

define('CSRF_PROTECTION', false);

define('CSRF_TOKEN_NAME', 'csrf_test_name');        // token name

define('CSRF_COOKIE_NAME', 'csrf_cookie_name');     // cookie name

define('CSRF_EXPIRE', 7200);            // The number in seconds the token should expire.

define('CSRF_REGENERATE', TRUE);        // Regenerate token on every submission

define('CSRF_EXCLUDE_URIS', array());   // Array of URIs which ignore CSRF checks




/** CREDENTIALS
 * -----------------------------------------------------------------------------
 */

/** SERVICE PARAMETRES
 * -----------------------------------------------------------------------------
 * 
 * Connection parametres and credentials for accssing services 
 * needed by the application; Such services may be..
 * 
 * - RDBMS
 *   -- MySQL
 *   -- PotgresSQL
 * 
 * - Caching services
 *   -- Redis
 *   -- MemCached
 * 
 * Edit only the constants needed by the application;
 * Comment those you do not need;
 * 
 * /////////////////////////////////////////////////////////////////////////////
 */

/** DATABASE CONNECTION PARAMETRES
 * -----------------------------------------------------------------------------
 * Production and staging environments may use different databases.
 * 
 * A safe practice is to keep credentials outside plain files like this one
 * in environmental variable or other secret file etc.
 * 
 * Uncomment/enable each group of definitions suits your case to define
 * the credentials needed for accessing the database
 */

define('DB_NAME', $ini['DB_NAME']);
 
define('DB_USER', $ini['DB_USER']);
 
define('DB_PASS', $ini['DB_PASS']);
 
/** NOTE:
 * PDO_HOST can be a hostname/port combination -or- a unix socket
 * 
 * ...examples:
 * define('PDO_HOST', 'host=/localhost')    ## hostname case
 * define('PDO_HOST', 'host=/localhost;port=3456')    ## hostname/port case
 * define('PDO_HOST', 'unix_socket=/sql/ex123:europe:some-db');   ## unix socket
 * define('PDO_HOST', 'unix_socket=/cloudsql/name-123456:europe-west4:name-db-eu');
 */

define('PDO_HOST', $ini['PDO_HOST']);
 
define('DB_TIMEZONE', "SET time_zone = 'Europe/Athens'");




/** NOTE:
 * Both Redis and Memcached configurations are given as a template to work on;
 * In most cases the default values should do the job -- of course you need to
 * read the README file (check the project's root);
 * As these caching services are not fully tested you may need to ochestrate
 * the services in detail or edit the connection strings into the core classes
 * (hosted under the '/core/classes/cacher' folder)
 */


/** REDIS SERVICE
 * -----------------------------------------------------------------------------
 * Most of the times Redis is running on 'localhost' (host = '127.0.0.1')
 * When implemented via anom's docker-composer (redis via bridge) then you need
 * do declare the hostname as 'redis'
 */

# if (!defined('REDIS_HOST'))     define('REDIS_HOST', 'redis');
# 
# if (!defined('REDIS_PORT'))     define('REDIS_PORT', 6379);
# 
# if (!defined('REDIS_PASS'))     define('REDIS_PASS', null);


/** MEMCACHED
 * -----------------------------------------------------------------------------
 * Memcached looks very much like Redis (plus, both are serving from RAM)
 * Usualy Memcashed is running localy so host is 'localhost' ('127.0.0.1')
 * If you use the framework's docker-composer implementation then
 * the hostname is 'anomemcached'
 */

# if (!defined('MEMCACHE_HOST'))  define('MEMCACHE_HOST', 'anomemcached');