#6 - custom uploaders

contact.php

@@ -123,7 +123,7 @@ function PageCompPageMainCodeWithForm() {
             'attachment' => array(
                 'type' => 'files',
                 'storage_object' => 'sample2',
-                'uploaders' => array ('Simple', 'HTML5'),
+                'uploaders' => array ('sys_simple', 'sys_html5'),
                 'images_transcoder' => 'sample2',
                 'multiple' => true,
                 'content_id' => 0,

inc/classes/BxDolUploader.php

@@ -1,10 +1,13 @@
-<?php
+<?php defined('BX_DOL') or die('hack attempt');
 /**
- * @package     Dolphin Core
- * @copyright   Copyright (c) BoonEx Pty Limited - http://www.boonex.com/
- * @license     CC-BY - http://creativecommons.org/licenses/by/3.0/
+ * Copyright (c) BoonEx Pty Limited - http://www.boonex.com/
+ * CC-BY License - http://creativecommons.org/licenses/by/3.0/
+ *
+ * @defgroup    DolphinCore Dolphin Core
+ * @{
  */
-defined('BX_DOL') or die('hack attempt');
+
+bx_import('BxDolUploaderQuery');
 
 /**
  * Uploaders are disigned to work as form field in forms. @see BxDolForm.
@@ -16,8 +19,8 @@ defined('BX_DOL') or die('hack attempt');
  *     'type' => 'files', // this is new form type, which enable upholders automatically
  *     'storage_object' => 'sample', // the storage object, where uploaded files are going to be saved
  *     'images_transcoder' => 'sample2', // images transcoder object to use for images preview
- *     'uploaders' => array ('Simple', 'HTML5'), // the set of uploaders to use to upload files 
- *     'upload_buttons_titles' => array('Simple' => 'Upload one by one', 'HTML5' => 'Upload several files in bulk'); // change default button titles, array with button names, or string to assign to all bnuttons
+ *     'uploaders' => array ('sys_simple', 'sys_html5'), // the set of uploaders to use to upload files 
+ *     'upload_buttons_titles' => array('sys_simple' => 'Upload one by one', 'sys_html5' => 'Upload several files in bulk'); // change default button titles, array with button names, or string to assign to all bnuttons
  *     'multiple' => true, // allow to upload multiple files per one upload
  *     'content_id' => 4321, // content id to associate ghost files with
  *     'ghost_template' => $mixedGhostTemplate, // template for nested form
@@ -28,8 +31,8 @@ defined('BX_DOL') or die('hack attempt');
  *
  * 
  * Available uploaders:
- * - Simple - upload files using standard HTML forms.
- * - HTML5 - upload files using AJAX uploader with multiple files selection support (without flash), 
+ * - sys_simple - upload files using standard HTML forms.
+ * - sys_html5 - upload files using AJAX uploader with multiple files selection support (without flash), 
  *   it works in Firefox and WebKit(Safari, Chrome) browsers only, but has fallback for other browsers (IE, Opera).
  *
  * 
@@ -116,16 +119,16 @@ abstract class BxDolUploader extends BxDol {
     /**
      * constructor
      */
-    protected function BxDolUploader($aObject, $sStorageObject, $sUniqId) {
-        parent::BxDol();
+    protected function __construct($aObject, $sStorageObject, $sUniqId) {
+        parent::__construct();
         $this->_aObject = $aObject;
         $this->_sStorageObject = $sStorageObject;          
      
         $this->_sUniqId = $sUniqId;
 
-        $this->_sUploaderJsInstance = 'glUploader_' . $sUniqId . '_' . $this->_aObject['engine'];
-        $this->_sUploadInProgressContainerId = 'bx-form-input-files-' . $sUniqId . '-upload-in-progress-' . $this->_aObject['engine'];
-        $this->_sPopupContainerId = 'bx-form-input-files-' . $sUniqId . '-popup-wrapper-' . $this->_aObject['engine'];
+        $this->_sUploaderJsInstance = 'glUploader_' . $sUniqId . '_' . $this->_aObject['object'];
+        $this->_sUploadInProgressContainerId = 'bx-form-input-files-' . $sUniqId . '-upload-in-progress-' . $this->_aObject['object'];
+        $this->_sPopupContainerId = 'bx-form-input-files-' . $sUniqId . '-popup-wrapper-' . $this->_aObject['object'];
 
         $this->_sResultContainerId = 'bx-form-input-files-' . $sUniqId . '-upload-result';
         $this->_sErrorsContainerId = 'bx-form-input-files-' . $sUniqId . '-errors'; 
@@ -133,27 +136,23 @@ abstract class BxDolUploader extends BxDol {
     }
 
     static public function getObjectInstance($sObject, $sStorageObject, $sResultContainerId) {
-
-        if (isset($GLOBALS['bxDolClasses']['BxDolUploader!'.$sObject]))
-            return $GLOBALS['bxDolClasses']['BxDolUploader!'.$sObject];
-
-        $aUploaders = array (
-            'Simple' => array ('engine' => 'Simple', 'active' => 1),
-            'HTML5' => array ('engine' => 'HTML5', 'active' => 1),
-        );
-
-        $aObject = isset($aUploaders[$sObject]) ? $aUploaders[$sObject] : false;
-        if (!$aObject || !is_array($aObject))
+        
+        $aObject = BxDolUploaderQuery::getUploaderObject($sObject);
+        if (!$aObject || !is_array($aObject) || !$aObject['active'])
             return false;
 
-        $sClass = 'BxTemplUploader' . $aObject['engine'];
-        bx_import($sClass);
+        $sClass = $aObject['override_class_name'];
+        if (!empty($aObject['override_class_file']))
+            require_once(BX_DIRECTORY_PATH_ROOT . $aObject['override_class_file']);
+        else    
+            bx_import($sClass);
+
         $o = new $sClass($aObject, $sStorageObject, $sResultContainerId);
 
         if (!$o->isInstalled() || !$o->isAvailable())
             return false;
 
-        return ($GLOBALS['bxDolClasses']['BxDolUploader!'.$sObject] = $o);
+        return $o;
     }
 
     /**
@@ -197,13 +196,11 @@ abstract class BxDolUploader extends BxDol {
      * @param $mixedFiles as usual $_FILES['some_name'] array, but maybe some other params depending on the uploader
      * @return nothing, but if some files failed to upload, the actual error message can be determined by calling BxDolUploader::getUploadErrorMessages()
      */
-    public function handleUploads ($mixedFiles, $isMultiple = true, $iContentId = false) {
+    public function handleUploads ($iProfileId, $mixedFiles, $isMultiple = true, $iContentId = false) {
 
         bx_import('BxDolStorage');
         $oStorage = BxDolStorage::getObjectInstance($this->_sStorageObject);
 
-        $iProfileId = bx_get_logged_profile_id();
-
         if (false == ($aMultipleFiles = $oStorage->convertMultipleFilesArray($mixedFiles)))
             $aMultipleFiles = array($mixedFiles);
 
@@ -260,7 +257,7 @@ abstract class BxDolUploader extends BxDol {
 
         $aParamsDefault = array (
             'uploader_instance_name' => $this->getNameJsInstanceUploader(),
-            'engine' => $this->_aObject['engine'],
+            'engine' => $this->_aObject['object'],
             'storage_object' => $this->_sStorageObject,
             'uniq_id' => $this->_sUniqId,
             'template_ghost' => $sJsValue, 
@@ -388,3 +385,4 @@ abstract class BxDolUploader extends BxDol {
     }
 }
 
+/** @} */

inc/classes/BxDolUploaderQuery.php

@@ -0,0 +1,36 @@
+<?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('BxDolDb');
+
+/**
+ * Database queries for uploader objects.
+ * @see BxDolUploader
+ */
+class BxDolUploaderQuery extends BxDolDb {
+    protected $_aObject;
+
+    public function __construct($aObject) {
+        parent::__construct();
+        $this->_aObject = $aObject;
+    }
+
+    static public function getUploaderObject ($sObject) {
+        $oDb = BxDolDb::getInstance();
+        $sQuery = $oDb->prepare("SELECT * FROM `sys_objects_uploader` WHERE `object` = ?", $sObject);
+        $aObject = $oDb->getRow($sQuery);
+        if (!$aObject || !is_array($aObject)) 
+            return false;
+        
+        return $aObject;
+    }
+
+}
+
+/** @} */

install/sql/v70.sql

@@ -5,7 +5,7 @@
 -- --------------------------------------------------------
 
 SET NAMES 'utf8';
-DROP TABLE IF EXISTS `sys_admin_ban_list`, `sys_block_list`, `sys_categories`, `sys_keys`, `sys_objects_editor`, `sys_objects_captcha`, `sys_objects_social_sharing`, `sys_objects_categories`, `sys_objects_cmts`, `sys_email_templates`, `sys_friend_list`, `sys_options`, `sys_options_cats`, `sys_ip_list`, `sys_ip_members_visits`, `sys_localization_categories`, `sys_localization_keys`, `sys_localization_languages`, `sys_localization_string_params`, `sys_localization_strings`, `sys_acl_actions`, `sys_acl_actions_track`, `sys_acl_matrix`, `sys_acl_level_prices`, `sys_acl_levels`, `sys_sessions`, `sys_acl_levels_members`, `sys_objects_search`, `sys_stat_site`, `sys_alerts`, `sys_alerts_handlers`, `sys_injections`, `sys_injections_admin`, `sys_modules`, `sys_modules_file_tracks`, `sys_permalinks`, `sys_privacy_actions`, `sys_privacy_defaults`, `sys_privacy_groups`, `sys_privacy_members`, `sys_tags`, `sys_objects_tag`, `sys_transactions`, `sys_objects_auths`, `sys_objects_vote`, `sys_objects_views`, `sys_cron_jobs`, `sys_dnsbl_rules`, `sys_dnsbl_block_log`, `sys_dnsbluri_zones`, `sys_menu_mobile`, `sys_menu_mobile_pages`, `sys_objects_storage`, `sys_storage_user_quotas`, `sys_storage_tokens`, `sys_storage_ghosts`, `sys_storage_mime_types`, `sys_objects_transcoder_images`, `sys_transcoder_images_files`, `sys_transcoder_images_filters`,`sys_accounts`,`sys_profiles`;
+DROP TABLE IF EXISTS `sys_admin_ban_list`, `sys_block_list`, `sys_categories`, `sys_keys`, `sys_objects_editor`, `sys_objects_captcha`, `sys_objects_social_sharing`, `sys_objects_categories`, `sys_objects_cmts`, `sys_email_templates`, `sys_friend_list`, `sys_options`, `sys_options_cats`, `sys_ip_list`, `sys_ip_members_visits`, `sys_localization_categories`, `sys_localization_keys`, `sys_localization_languages`, `sys_localization_string_params`, `sys_localization_strings`, `sys_acl_actions`, `sys_acl_actions_track`, `sys_acl_matrix`, `sys_acl_level_prices`, `sys_acl_levels`, `sys_sessions`, `sys_acl_levels_members`, `sys_objects_search`, `sys_stat_site`, `sys_alerts`, `sys_alerts_handlers`, `sys_injections`, `sys_injections_admin`, `sys_modules`, `sys_modules_file_tracks`, `sys_permalinks`, `sys_privacy_actions`, `sys_privacy_defaults`, `sys_privacy_groups`, `sys_privacy_members`, `sys_tags`, `sys_objects_tag`, `sys_transactions`, `sys_objects_auths`, `sys_objects_vote`, `sys_objects_views`, `sys_cron_jobs`, `sys_dnsbl_rules`, `sys_dnsbl_block_log`, `sys_dnsbluri_zones`, `sys_menu_mobile`, `sys_menu_mobile_pages`, `sys_objects_storage`, `sys_objects_uploader`, `sys_storage_user_quotas`, `sys_storage_tokens`, `sys_storage_ghosts`, `sys_storage_mime_types`, `sys_objects_transcoder_images`, `sys_transcoder_images_files`, `sys_transcoder_images_filters`,`sys_accounts`,`sys_profiles`;
 ALTER DATABASE DEFAULT CHARACTER SET 'utf8' COLLATE 'utf8_unicode_ci';
 
 
@@ -2237,6 +2237,24 @@ INSERT INTO `sys_storage_mime_types` (`ext`, `mime_type`, `icon`) VALUES
 -- --------------------------------------------------------
 
 
+CREATE TABLE IF NOT EXISTS `sys_objects_uploader` (
+  `id` int(11) NOT NULL AUTO_INCREMENT,
+  `object` varchar(32) NOT NULL,
+  `active` tinyint(4) NOT NULL,
+  `override_class_name` varchar(255) NOT NULL,
+  `override_class_file` varchar(255) NOT NULL,
+  PRIMARY KEY (`id`),
+  UNIQUE KEY `object` (`object`)
+) ENGINE=MyISAM;
+
+INSERT INTO `sys_objects_uploader` (`object`, `active`, `override_class_name`, `override_class_file`) VALUES
+('sys_simple', 1, 'BxTemplUploaderSimple', ''),
+('sys_html5', 1, 'BxTemplUploaderHTML5', '');
+
+
+-- --------------------------------------------------------
+
+
 CREATE TABLE IF NOT EXISTS `sys_objects_form` (
   `id` int(11) NOT NULL AUTO_INCREMENT,
   `object` varchar(32) NOT NULL,

modules/boonex/notes/classes/BxNotesFormNote.php

@@ -40,7 +40,7 @@ class BxNotesFormNote extends BxTemplFormView {
 
         if (isset($this->aInputs[BxNotesConfig::$FIELD_PHOTO])) {
             $this->aInputs[BxNotesConfig::$FIELD_PHOTO]['storage_object'] = BxNotesConfig::$OBJECT_STORAGE;
-            $this->aInputs[BxNotesConfig::$FIELD_PHOTO]['uploaders'] = array('Simple', 'HTML5');
+            $this->aInputs[BxNotesConfig::$FIELD_PHOTO]['uploaders'] = array('sys_simple', 'sys_html5');
             $this->aInputs[BxNotesConfig::$FIELD_PHOTO]['images_transcoder'] = BxNotesConfig::$OBJECT_IMAGES_TRANSCODER_PREVIEW;
             $this->aInputs[BxNotesConfig::$FIELD_PHOTO]['multiple'] = true;
             $this->aInputs[BxNotesConfig::$FIELD_PHOTO]['content_id'] = 0;

modules/boonex/uni/data/template/system/scripts/BxTemplUploaderHTML5.php

@@ -1,10 +1,11 @@
-<?php
+<?php defined('BX_DOL') or die('hack attempt');
 /**
- * @package     Dolphin Core
- * @copyright   Copyright (c) BoonEx Pty Limited - http://www.boonex.com/
- * @license     CC-BY - http://creativecommons.org/licenses/by/3.0/
+ * Copyright (c) BoonEx Pty Limited - http://www.boonex.com/
+ * CC-BY License - http://creativecommons.org/licenses/by/3.0/
+ *
+ * @defgroup    DolphinCore Dolphin Core
+ * @{
  */
-defined('BX_DOL') or die('hack attempt');
 
 bx_import ('BxBaseUploaderHTML5');
 
@@ -12,8 +13,9 @@ bx_import ('BxBaseUploaderHTML5');
  * @see BxDolUploader
  */
 class BxTemplUploaderHTML5 extends BxBaseUploaderHTML5 {
-    function BxTemplUploaderHTML5($aObject, $sStorageObject, $sUniqId) {
-        parent::BxBaseUploaderHTML5($aObject, $sStorageObject, $sUniqId);
+    function __construct($aObject, $sStorageObject, $sUniqId) {
+        parent::__construct($aObject, $sStorageObject, $sUniqId);
     }
 }
 
+/** @} */

modules/boonex/uni/data/template/system/scripts/BxTemplUploaderSimple.php

@@ -1,10 +1,11 @@
-<?php
+<?php defined('BX_DOL') or die('hack attempt');
 /**
- * @package     Dolphin Core
- * @copyright   Copyright (c) BoonEx Pty Limited - http://www.boonex.com/
- * @license     CC-BY - http://creativecommons.org/licenses/by/3.0/
+ * Copyright (c) BoonEx Pty Limited - http://www.boonex.com/
+ * CC-BY License - http://creativecommons.org/licenses/by/3.0/
+ *
+ * @defgroup    DolphinCore Dolphin Core
+ * @{
  */
-defined('BX_DOL') or die('hack attempt');
 
 bx_import ('BxBaseUploaderSimple');
 
@@ -12,8 +13,9 @@ bx_import ('BxBaseUploaderSimple');
  * @see BxDolUploader
  */
 class BxTemplUploaderSimple extends BxBaseUploaderSimple {
-    function BxTemplUploaderSimple($aObject, $sStorageObject, $sUniqId) {
-        parent::BxBaseUploaderSimple($aObject, $sStorageObject, $sUniqId);
+    function __construct($aObject, $sStorageObject, $sUniqId) {
+        parent::__construct($aObject, $sStorageObject, $sUniqId);
     }
 }
 
+/** @} */

storage_uploader.php

@@ -65,7 +65,7 @@ switch ($sAction) {
 
         bx_import('BxDolLanguages');
 
-        $oUploader->handleUploads(isset($_FILES['f']) ? $_FILES['f'] : null, $isMultiple, $iContentId);
+        $oUploader->handleUploads(bx_get_logged_profile_id(), isset($_FILES['f']) ? $_FILES['f'] : null, $isMultiple, $iContentId);
         break;
 
 }

template/scripts/BxBaseFormView.php

@@ -869,9 +869,9 @@ BLAH;
             'uploaders_buttons' => $sUploaders,
             'info' => $sInfo,
             'error' => $sError,
-            'id_container_errors' => $oUploader->getIdContainerErrors(),
-            'id_container_result' => $oUploader->getIdContainerResult(),
-            'uploader_instance_name' => $oUploader->getNameJsInstanceUploader(),
+            'id_container_errors' => $oUploader ? $oUploader->getIdContainerErrors() : '',
+            'id_container_result' => $oUploader ? $oUploader->getIdContainerResult() : '',
+            'uploader_instance_name' => $oUploader ? $oUploader->getNameJsInstanceUploader() : '',
             'is_init_ghosts' => isset($aInput['init_ghosts']) && !$aInput['init_ghosts'] ? 0 : 1,
         ));
     }

template/scripts/BxBaseUploaderHTML5.php

@@ -1,10 +1,11 @@
-<?php
+<?php defined('BX_DOL') or die('hack attempt');
 /**
- * @package     Dolphin Core
- * @copyright   Copyright (c) BoonEx Pty Limited - http://www.boonex.com/
- * @license     CC-BY - http://creativecommons.org/licenses/by/3.0/
+ * Copyright (c) BoonEx Pty Limited - http://www.boonex.com/
+ * CC-BY License - http://creativecommons.org/licenses/by/3.0/
+ *
+ * @defgroup    DolphinCore Dolphin Core
+ * @{
  */
-defined('BX_DOL') or die('hack attempt');
 
 bx_import ('BxDolUploader');
 
@@ -17,10 +18,10 @@ class BxBaseUploaderHTML5 extends BxDolUploader {
 
     var $_sDivId; ///< div id where upload button will be placed
 
-    function BxBaseUploaderHTML5 ($aObject, $sStorageObject, $sUniqId) {
-        parent::BxDolUploader($aObject, $sStorageObject, $sUniqId);
+    function __construct ($aObject, $sStorageObject, $sUniqId) {
+        parent::__construct($aObject, $sStorageObject, $sUniqId);
 
-        $this->_sDivId = 'bx-form-input-files-' . $sUniqId . '-div-' . $this->_aObject['engine'];
+        $this->_sDivId = 'bx-form-input-files-' . $sUniqId . '-div-' . $this->_aObject['object'];
         $this->_sButtonTemplate = 'uploader_button_html5.html';
     }
 
@@ -103,3 +104,4 @@ class BxBaseUploaderHTML5 extends BxDolUploader {
     }
 }
 
+/** @} */

template/scripts/BxBaseUploaderSimple.php

@@ -1,10 +1,11 @@
-<?php
+<?php defined('BX_DOL') or die('hack attempt');
 /**
- * @package     Dolphin Core
- * @copyright   Copyright (c) BoonEx Pty Limited - http://www.boonex.com/
- * @license     CC-BY - http://creativecommons.org/licenses/by/3.0/
+ * Copyright (c) BoonEx Pty Limited - http://www.boonex.com/
+ * CC-BY License - http://creativecommons.org/licenses/by/3.0/
+ *
+ * @defgroup    DolphinCore Dolphin Core
+ * @{
  */
-defined('BX_DOL') or die('hack attempt');
 
 bx_import ('BxDolUploader');
 
@@ -16,8 +17,8 @@ class BxBaseUploaderSimple extends BxDolUploader {
 
     var $_sIframeId;
 
-    function BxBaseUploaderSimple ($aObject, $sStorageObject, $sUniqId) {
-        parent::BxDolUploader($aObject, $sStorageObject, $sUniqId);
+    function __construct ($aObject, $sStorageObject, $sUniqId) {
+        parent::__construct($aObject, $sStorageObject, $sUniqId);
         $this->_sIframeId = 'bx-form-input-files-' . $sUniqId . '-iframe';
         $this->_sButtonTemplate = 'uploader_button_simple.html';
     }
@@ -48,7 +49,7 @@ class BxBaseUploaderSimple extends BxDolUploader {
             'uploader_instance_name' => $this->getNameJsInstanceUploader(),
             'restrictions_text' => $this->getRestrictionsText(),
             'iframe_id' => $this->_sIframeId,
-            'engine' => $this->_aObject['engine'],
+            'engine' => $this->_aObject['object'],
             'storage_object' => $this->_sStorageObject,
             'uniq_id' => $this->_sUniqId,
             'multiple' => $isMultiple,
@@ -62,3 +63,4 @@ class BxBaseUploaderSimple extends BxDolUploader {
 
 }
 
+/** @} */