#73 - header.inc.php reorganization

inc/classes/BxDolConfig.php

@@ -68,12 +68,6 @@ class BxDolConfig extends BxDol implements iBxDolSingleton
         $this->aUrlDynamic = array();
 
         $this->aPathDynamic = array();
-
-        $this->aDb = array(
-            'visual_processing' => true,
-            'debug_mode' => true,
-            'error_remort_by_email' => false
-        );
     }
 
     function get($sGroup, $sName)

inc/classes/BxDolDb.php

@@ -531,7 +531,7 @@ EOJ;
         }
 
         bx_import('BxDolConfig');
-        if (BxDolConfig::getInstance()->get('db', 'visual_processing')) {
+        if (defined('BX_DB_FULL_VISUAL_PROCESSING') && BX_DB_FULL_VISUAL_PROCESSING) {
 
             ob_start();
 
@@ -540,8 +540,8 @@ EOJ;
                     <div style="text-align:center;background-color:red;color:white;font-weight:bold;">Error</div>
                     <div style="text-align:center;"><?php echo $sOutput; ?></div>
             <?php
-            if(BxDolConfig::getInstance()->get('db', 'debug_mode')) {
-                if( strlen( $query ) )
+            if (defined('BX_DB_FULL_DEBUG_MODE') && BX_DB_FULL_DEBUG_MODE) {
+                if (!empty($query))
                     echo "<div><b>Query:</b><br />{$query}</div>";
 
                 if ($this->_rLink)
@@ -575,7 +575,7 @@ EOJ;
             $sOutput = ob_get_clean();
         } 
 
-        if (BxDolConfig::getInstance()->get('db', 'error_remort_by_email')) {
+        if (defined('BX_DB_DO_EMAIL_ERROR_REPORT') && BX_DB_DO_EMAIL_ERROR_REPORT) {
             $sSiteTitle = $this->getParam('site_title');
             $sMailBody = "Database error in " . $sSiteTitle . "<br /><br /> \n";
 

inc/classes/BxDolInstallerHasher.php

@@ -9,6 +9,10 @@
 
 bx_import('BxDolInstallerUtils');
 
+/**
+ * Functions for hashing system files.
+ * Hashing functions for module file are in @see BxDolInstallerUtils class.
+ */
 class BxDolInstallerHasher extends BxDolInstallerUtils
 {
     protected $_iSystemModuleId = 0;

inc/classes/BxDolPageQuery.php

@@ -7,8 +7,6 @@
  * @{
  */
 
-bx_import('BxDolDb');
-
 /**
  * Database queries for pages.
  * @see BxDolPage

inc/classes/BxDolStorageLocal.php

@@ -7,8 +7,8 @@
  * @{
  */
 
-define ('BX_DOL_STORAGE_DIR_RIGHTS', 0777);
-define ('BX_DOL_STORAGE_FILE_RIGHTS', 0666);
+define ('BX_DOL_STORAGE_DIR_RIGHTS', BX_DOL_DIR_RIGHTS);
+define ('BX_DOL_STORAGE_FILE_RIGHTS', BX_DOL_FILE_RIGHTS);
 
 bx_import('BxDolStorage');
 

inc/classes/BxDolStorageS3.php

@@ -7,12 +7,6 @@
  * @{
  */
 
-define ('BX_DOL_STORAGE_PUBLIC', 'public');
-define ('BX_DOL_STORAGE_PRIVATE', 'private');
-
-define ('BX_DOL_STORAGE_DIR_RIGHT', 0700);
-define ('BX_DOL_STORAGE_FILE_RIGHT', 0400);
-
 bx_import('BxDolStorage');
 
 require_once(BX_DIRECTORY_PATH_PLUGINS . 'amazon-s3/S3.php');

inc/params.inc.php

@@ -0,0 +1,94 @@
+<?php defined('BX_DOL') or defined('BX_DOL_INSTALL') or die('hack attempt');
+/**
+ * Copyright (c) BoonEx Pty Limited - http://www.boonex.com/
+ * CC-BY License - http://creativecommons.org/licenses/by/3.0/
+ *
+ * @defgroup    DolphinCore Dolphin Core
+ * @{
+ */
+
+define('BX_DOL_START', microtime ());
+
+//--- Main URLs ---//
+
+define('BX_DOL_URL_PLUGINS', BX_DOL_URL_ROOT . 'plugins/');
+define('BX_DOL_URL_PLUGINS_PUBLIC', BX_DOL_URL_ROOT . 'plugins_public/');
+define('BX_DOL_URL_MODULES', BX_DOL_URL_ROOT . 'modules/');
+define('BX_DOL_URL_CACHE_PUBLIC', BX_DOL_URL_ROOT . 'cache_public/');
+define('BX_DOL_URL_BASE', BX_DOL_URL_ROOT . 'template/');
+
+//--- Main Pathes ---//
+
+define('BX_DIRECTORY_PATH_INC', BX_DIRECTORY_PATH_ROOT . 'inc/');
+define('BX_DIRECTORY_PATH_BASE', BX_DIRECTORY_PATH_ROOT . 'template/');
+define('BX_DIRECTORY_PATH_CACHE', BX_DIRECTORY_PATH_ROOT . 'cache/');
+define('BX_DIRECTORY_PATH_CACHE_PUBLIC', BX_DIRECTORY_PATH_ROOT . 'cache_public/');
+define('BX_DIRECTORY_PATH_CLASSES', BX_DIRECTORY_PATH_ROOT . 'inc/classes/');
+define('BX_DIRECTORY_PATH_PLUGINS', BX_DIRECTORY_PATH_ROOT . 'plugins/');
+define('BX_DIRECTORY_PATH_PLUGINS_PUBLIC', BX_DIRECTORY_PATH_ROOT . 'plugins_public/');
+define('BX_DIRECTORY_PATH_MODULES', BX_DIRECTORY_PATH_ROOT . 'modules/');
+define('BX_DIRECTORY_PATH_TMP', BX_DIRECTORY_PATH_ROOT . 'tmp/');
+define('BX_DIRECTORY_STORAGE', BX_DIRECTORY_PATH_ROOT . 'storage/');
+
+//--- System settings ---//
+
+define('BX_DOL_DIR_RIGHTS', 0777);
+define('BX_DOL_FILE_RIGHTS', 0666);
+
+define('BX_DOL_STORAGE_OBJ_IMAGES', 'sys_images');
+
+define('BX_DOL_INT_MAX', 2147483647);
+
+define('BX_DOL_TRANSCODER_OBJ_ICON_APPLE', 'sys_icon_apple');
+define('BX_DOL_TRANSCODER_OBJ_ICON_FACEBOOK', 'sys_icon_facebook');
+define('BX_DOL_TRANSCODER_OBJ_ICON_FAVICON', 'sys_icon_favicon');
+
+//--- Module types ---//
+
+if (!defined('BX_DOL_MODULE_TYPE_MODULE')) {
+    define('BX_DOL_MODULE_TYPE_MODULE', 'module');
+    define('BX_DOL_MODULE_TYPE_LANGUAGE', 'language');
+    define('BX_DOL_MODULE_TYPE_TEMPLATE', 'template');
+}
+
+//--- Studio settings ---//
+
+define('BX_DOL_STUDIO_FOLDER', 'studio');
+
+define('BX_DOL_URL_STUDIO', BX_DOL_URL_ROOT . BX_DOL_STUDIO_FOLDER . '/');
+define('BX_DOL_URL_STUDIO_BASE', BX_DOL_URL_STUDIO . 'template/');
+
+define('BX_DOL_DIR_STUDIO', BX_DIRECTORY_PATH_ROOT . BX_DOL_STUDIO_FOLDER . '/');
+define('BX_DOL_DIR_STUDIO_INC', BX_DOL_DIR_STUDIO . 'inc/');
+define('BX_DOL_DIR_STUDIO_CLASSES', BX_DOL_DIR_STUDIO . 'classes/');
+define('BX_DOL_DIR_STUDIO_BASE', BX_DOL_DIR_STUDIO . 'template/');
+
+//--- User Roles ---//
+
+define('BX_DOL_ROLE_GUEST', 0);
+define('BX_DOL_ROLE_MEMBER', 1);
+define('BX_DOL_ROLE_ADMIN', 2);
+
+//--- Profile Statuses ---//
+
+define('BX_PROFILE_STATUS_SUSPENDED', 'suspended'); ///< profile status - suspended, profile is syspended by admin/moderator and usually can't access the site
+define('BX_PROFILE_STATUS_ACTIVE', 'active'); ///< profile status - active, profile is active on the site
+define('BX_PROFILE_STATUS_PENDING', 'pending'); ///< profile status - pending, default method of approving is manual approving
+
+//--- Include files needed for basic functionality ---//
+
+require_once(BX_DIRECTORY_PATH_CLASSES . 'BxDol.php');
+require_once(BX_DIRECTORY_PATH_INC . 'utils.inc.php');
+require_once(BX_DIRECTORY_PATH_INC . 'version.inc.php');
+
+bx_import('BxDolConfig');
+bx_import('BxDolService');
+bx_import('BxDolAlerts');
+bx_import('BxDolDb');
+
+require_once(BX_DIRECTORY_PATH_INC . 'profiles.inc.php');
+
+$o = new BxDolAlerts('system', 'begin', 0);
+$o->alert();
+
+/** @} */

inc/version.inc.php

@@ -0,0 +1,12 @@
+<?php defined('BX_DOL') or defined('BX_DOL_INSTALL') or die('hack attempt');
+/**
+ * Copyright (c) BoonEx Pty Limited - http://www.boonex.com/
+ * CC-BY License - http://creativecommons.org/licenses/by/3.0/
+ *
+ * @defgroup    DolphinCore Dolphin Core
+ * @{
+ */
+
+define('BX_DOL_VERSION', '8.0.0-DEV2');
+
+/** @} */

install/patterns/header.inc.php

@@ -2,105 +2,34 @@
 
 define('BX_DOL', 1);
 
-define('BX_DOL_START', microtime ());
+define('BX_DOL_URL_ROOT', '%SITE_URL%'); ///< site url
 
-//--- Main URLs ---//
-define('BX_DOL_URL_ROOT', '%SITE_URL%');
-define('BX_DOL_URL_PLUGINS', BX_DOL_URL_ROOT . 'plugins/');
-define('BX_DOL_URL_PLUGINS_PUBLIC', BX_DOL_URL_ROOT . 'plugins_public/');
-define('BX_DOL_URL_MODULES', BX_DOL_URL_ROOT . 'modules/');
-define('BX_DOL_URL_CACHE_PUBLIC', BX_DOL_URL_ROOT . 'cache_public/');
-define('BX_DOL_URL_BASE', BX_DOL_URL_ROOT . 'template/');
+define('BX_DIRECTORY_PATH_ROOT', '%ROOT_DIR%'); ///< site path
 
-//--- Main Pathes ---//
-define('BX_DIRECTORY_PATH_ROOT', '%ROOT_DIR%');
-define('BX_DIRECTORY_PATH_INC', BX_DIRECTORY_PATH_ROOT . 'inc/');
-define('BX_DIRECTORY_PATH_BASE', BX_DIRECTORY_PATH_ROOT . 'template/');
-define('BX_DIRECTORY_PATH_CACHE', BX_DIRECTORY_PATH_ROOT . 'cache/');
-define('BX_DIRECTORY_PATH_CACHE_PUBLIC', BX_DIRECTORY_PATH_ROOT . 'cache_public/');
-define('BX_DIRECTORY_PATH_CLASSES', BX_DIRECTORY_PATH_ROOT . 'inc/classes/');
-define('BX_DIRECTORY_PATH_PLUGINS', BX_DIRECTORY_PATH_ROOT . 'plugins/');
-define('BX_DIRECTORY_PATH_PLUGINS_PUBLIC', BX_DIRECTORY_PATH_ROOT . 'plugins_public/');
-define('BX_DIRECTORY_PATH_MODULES', BX_DIRECTORY_PATH_ROOT . 'modules/');
-define('BX_DIRECTORY_PATH_TMP', BX_DIRECTORY_PATH_ROOT . 'tmp/');
-define('BX_DIRECTORY_STORAGE', BX_DIRECTORY_PATH_ROOT . 'storage/');
+define('BX_DATABASE_HOST', '%DB_HOST%'); ///< db host
+define('BX_DATABASE_SOCK', '%DB_SOCK%'); ///< db socket
+define('BX_DATABASE_PORT', '%DB_PORT%'); ///< db port
+define('BX_DATABASE_USER', '%DB_USER%'); ///< db user
+define('BX_DATABASE_PASS', '%DB_PASSWORD%'); ///< db password
+define('BX_DATABASE_NAME', '%DB_NAME%'); ///< db name
 
-//--- DB Connection ---//
-define('BX_DATABASE_HOST', '%DB_HOST%');
-define('BX_DATABASE_SOCK', '%DB_SOCK%');
-define('BX_DATABASE_PORT', '%DB_PORT%');
-define('BX_DATABASE_USER', '%DB_USER%');
-define('BX_DATABASE_PASS', '%DB_PASSWORD%');
-define('BX_DATABASE_NAME', '%DB_NAME%');
+define('BX_SYSTEM_CONVERT', '%CONVERT_PATH%'); ///< path to ImageMagick convert binary
+define('BX_SYSTEM_COMPOSITE', '%COMPOSITE_PATH%'); ///< path to ImageMagick composite binary
+define('BX_DOL_SECRET', '%SECRET%'); ///< secret word
 
-//--- System settings ---//
-define('BX_SYSTEM_CONVERT', '%CONVERT_PATH%');
-define('BX_SYSTEM_COMPOSITE', '%COMPOSITE_PATH%');
-
-define('BX_DOL_DIR_RIGHTS', 0777);
-define('BX_DOL_FILE_RIGHTS', 0666);
-
-define('BX_DOL_STORAGE_OBJ_IMAGES', 'sys_images');
-
-define('BX_DOL_INT_MAX', 2147483647);
-
-define('BX_DOL_TRANSCODER_OBJ_ICON_APPLE', 'sys_icon_apple');
-define('BX_DOL_TRANSCODER_OBJ_ICON_FACEBOOK', 'sys_icon_facebook');
-define('BX_DOL_TRANSCODER_OBJ_ICON_FAVICON', 'sys_icon_favicon');
-
-//--- Module types ---//
-if (!defined('BX_DOL_MODULE_TYPE_MODULE')) {
-    define('BX_DOL_MODULE_TYPE_MODULE', 'module');
-    define('BX_DOL_MODULE_TYPE_LANGUAGE', 'language');
-    define('BX_DOL_MODULE_TYPE_TEMPLATE', 'template');
-}
-
-//--- Studio settings ---//
-define('BX_DOL_STUDIO_FOLDER', 'studio');
-
-define('BX_DOL_URL_STUDIO', BX_DOL_URL_ROOT . BX_DOL_STUDIO_FOLDER . '/');
-define('BX_DOL_URL_STUDIO_BASE', BX_DOL_URL_STUDIO . 'template/');
-
-define('BX_DOL_DIR_STUDIO', BX_DIRECTORY_PATH_ROOT . BX_DOL_STUDIO_FOLDER . '/');
-define('BX_DOL_DIR_STUDIO_INC', BX_DOL_DIR_STUDIO . 'inc/');
-define('BX_DOL_DIR_STUDIO_CLASSES', BX_DOL_DIR_STUDIO . 'classes/');
-define('BX_DOL_DIR_STUDIO_BASE', BX_DOL_DIR_STUDIO . 'template/');
-
-//--- User Roles ---//
-define('BX_DOL_ROLE_GUEST', 0);
-define('BX_DOL_ROLE_MEMBER', 1);
-define('BX_DOL_ROLE_ADMIN', 2);
-
-// profile statuses
-define('BX_PROFILE_STATUS_SUSPENDED', 'suspended'); ///< profile status - suspended, profile is syspended by admin/moderator and usually can't access the site
-define('BX_PROFILE_STATUS_ACTIVE', 'active'); ///< profile status - active, profile is active on the site
-define('BX_PROFILE_STATUS_PENDING', 'pending'); ///< profile status - pending, default method of approving is manual approving
-
-define('BX_DOL_SECRET', '%SECRET%');
-
-// set PHP options
+define('BX_DB_FULL_VISUAL_PROCESSING', true); ///< upon db error - show error message
+define('BX_DB_FULL_DEBUG_MODE', false); ///< upon db error - show detailed report (turn off in production mode)
+define('BX_DB_DO_EMAIL_ERROR_REPORT', true); ///< upon db error - send email with detailed report
 
 error_reporting(E_ALL);
 mb_internal_encoding('UTF-8');
 mb_regex_encoding('UTF-8');
 date_default_timezone_set('UTC');
 
-// include files needed for basic functionality and perform some checks
-
-require_once(BX_DIRECTORY_PATH_CLASSES . "BxDol.php");
-require_once(BX_DIRECTORY_PATH_INC . "utils.inc.php");
+require_once('params.inc.php');
 
 bx_check_maintenance_mode (true);
 bx_check_minimal_requirements(true);
 bx_check_redirect_to_correct_hostname(true);
 bx_check_redirect_to_remove_install_folder(true);
 
-bx_import('BxDolConfig');
-bx_import('BxDolService');
-bx_import('BxDolAlerts');
-bx_import('BxDolDb');
-
-require_once(BX_DIRECTORY_PATH_INC . "profiles.inc.php");
-
-$o = new BxDolAlerts('system', 'begin', 0);
-$o->alert();

template/scripts/BxBaseConfig.php

@@ -10,9 +10,7 @@
 class BxBaseConfig extends BxDol implements iBxDolSingleton
 {
     protected $_aConfig = array (
-        'iTagsMinFontSize' => 10, // minimal font size of tag
-        'iTagsMaxFontSize' => 30, // maximal font size of tag
-        'bAllowUnicodeInPreg' => false, // allow unicode in regular expressions
+        'bAllowUnicodeInPreg' => false, ///< allow unicode in regular expressions
         'aLessConfig' => array (
             'bx-page-width' => '1000px',
 

upgrade/BxDolUpgradeCron.php

@@ -0,0 +1,20 @@
+<?php defined('BX_DOL') or die('hack attempt');
+/**
+ * Copyright (c) BoonEx Pty Limited - http://www.boonex.com/
+ * CC-BY License - http://creativecommons.org/licenses/by/3.0/
+ *
+ * @defgroup    DolphinCore Dolphin Core
+ * @{
+ */
+
+bx_import('BxDolCron');
+
+class BxDolUpgradeCron extends BxDolCron
+{
+    public function processing()
+    {
+        echo "URA! \n";
+    }
+}
+
+/** @} */