protected function _init_page_props() { global $espresso_wp_user; $this->page_slug = EE_MSG_PG_SLUG; $this->page_label = __('Messages Settings', 'event_espresso'); $this->_admin_base_url = EE_MSG_ADMIN_URL; $this->_admin_base_path = EE_MSG_ADMIN; $this->_activate_state = isset($this->_req_data['activate_state']) ? (array) $this->_req_data['activate_state'] : array(); $this->_active_messenger = isset($this->_req_data['messenger']) ? $this->_req_data['messenger'] : NULL; EE_Registry::instance()->load_lib('messages'); //we're also going to set the active messengers and active message types in here. $this->_active_messengers = EEH_MSG_Template::get_active_messengers_in_db(); $this->_active_messengers = !empty($this->_active_messengers) ? $this->_active_messengers : array(); $this->_active_message_types = !empty($this->_active_messenger) && !empty($this->_active_messengers[$this->_active_messenger]) && !empty($this->_active_messengers[$this->_active_messenger]['settings'][$this->_active_messenger . '-message_types']) ? array_keys($this->_active_messengers[$this->_active_messenger]['settings'][$this->_active_messenger . '-message_types']) : array(); //what about saving the objects in the active_messengers and active_message_types? $this->_load_active_messenger_objects(); $this->_load_active_message_type_objects(); }
/** * tests to make sure forcing a messenger to be active works. * * @since 4.5.0 */ public function test_ensure_messenger_is_active() { EE_Registry::instance()->load_lib('messages'); EE_Registry::instance()->load_helper('Activation'); $msg = new EE_messages(); $this->assertInstanceOf('EE_messages', $msg); //make sure html messenger is setup (should be by default) $active_messengers = EEH_MSG_Template::get_active_messengers_in_db(); $this->assertTrue(isset($active_messengers['html']), sprintf('The messenger %s should be active on fresh install, but it is not.', 'html')); //let's UNSET the html messenger from active messengers and update the db unset($active_messengers['html']); EEH_MSG_Template::update_active_messengers_in_db($active_messengers); //now let's FORCE reactivation. $response = $msg->ensure_messenger_is_active('html'); $this->assertFalse($response); //that means it was previously inactive which it should be. //verify html messenger IS actually active now. $active_messengers = EEH_MSG_Template::get_active_messengers_in_db(); $this->assertTrue(isset($active_messengers['html']), 'The html messenger should have been forced to be active again but it is not.'); //now verify that trying to ensure is active verifies it's already active $response = $msg->ensure_messenger_is_active('html'); $this->assertTrue($response); }
/** * This simply validates active messengers and message types to ensure they actually match installed messengers and message types. If there's a mismatch then we deactivate the messenger/message type and ensure all related db rows are set inactive. * * @since 4.3.1 * * @return void */ public static function validate_messages_system() { //include our helper EE_Registry::instance()->load_helper('MSG_Template'); //get active and installed messengers/message types. $active_messengers = EEH_MSG_Template::get_active_messengers_in_db(); $installed = EEH_MSG_Template::get_installed_message_objects(); $installed_messengers = $installed_mts = array(); //set up the arrays so they can be handled easier. foreach ($installed['messengers'] as $im) { if ($im instanceof EE_messenger) { $installed_messengers[$im->name] = $im; } } foreach ($installed['message_types'] as $imt) { if ($imt instanceof EE_message_type) { $installed_mts[$imt->name] = $imt; } } //now let's loop through the active array and validate foreach ($active_messengers as $messenger => $active_details) { //first let's see if this messenger is installed. if (!isset($installed_messengers[$messenger])) { //not set so let's just remove from actives and make sure templates are inactive. unset($active_messengers[$messenger]); EEH_MSG_Template::update_to_inactive($messenger); continue; } //messenger is active, so let's just make sure that any active message types not installed are deactivated. $mts = !empty($active_details['settings'][$messenger . '-message_types']) ? $active_details['settings'][$messenger . '-message_types'] : array(); foreach ($mts as $mt_name => $mt) { if (!isset($installed_mts[$mt_name])) { unset($active_messengers[$messenger]['settings'][$messenger . '-message_types'][$mt_name]); EEH_MSG_Template::update_to_inactive($messenger, $mt_name); } } } //all done! let's update the active_messengers. EEH_MSG_Template::update_active_messengers_in_db($active_messengers); do_action('AHEE__EEH_Activation__validate_messages_system'); return; }
/** * This tests the generate_default_message_templates method with using the * FHEE__EE_messenger__get_default_message_types__default_types filter to add a * bogus message_type string. No errors should be triggered, and the invalid default mt * should NOT be added to the active array for the messenger. * * @since 4.6 * @group 7595 */ public function test_filtered_default_message_types_on_activation() { EE_Registry::instance()->load_helper('MSG_Template'); EE_Registry::instance()->load_helper('Activation'); //let's clear out all active messengers to get an accurate test of initial generation of message templates. global $wpdb; $mtpg_table = $wpdb->prefix . 'esp_message_template_group'; $mtp_table = $wpdb->prefix . 'esp_message_template'; $evt_mtp_table = $wpdb->prefix . 'esp_event_message_template'; $query = "DELETE FROM {$mtpg_table} WHERE 'GRP_ID' > 0"; $wpdb->query($query); $query = "DELETE FROM {$mtp_table} WHERE 'MTP_ID' > 0"; $wpdb->query($query); $query = "DELETE FROM {$evt_mtp_table} WHERE 'EMT_ID' > 0"; $wpdb->query($query); EEH_MSG_Template::update_active_messengers_in_db(array()); //set a filter for the invalid message type add_filter('FHEE__EE_messenger__get_default_message_types__default_types', function ($default_types, $messenger) { $default_types[] = 'bogus_message_type'; return $default_types; }, 10, 2); //activate messages... if there's any problems then errors will trigger a fail. EEH_Activation::generate_default_message_templates(); //all went well so let's make sure the activated system does NOT have our invalid message type string. $active_messengers = EEH_MSG_Template::get_active_messengers_in_db(); foreach ($active_messengers as $messenger => $settings) { $this->assertFalse(isset($settings['settings'][$messenger . '-message_types']['bogus_message_type']), sprintf('The %s messenger should not have "bogus_message_type" active on it but it does.', $messenger)); } }
/** * All this does is set the existing test settings (in the db) for the messenger * * @access public * @return bool success/fail */ public function set_existing_test_settings($settings) { $existing = EEH_MSG_Template::get_active_messengers_in_db(); $existing[$this->name]['test_settings'] = $settings; return EEH_MSG_Template::update_active_messengers_in_db($existing); }
/** * unsets the active if we can't find the file (failsafe) * * @access private * @param string $active_name name of messenger or message type * @param string $kind messenger or message_type? * @return void */ private function _unset_active($active_name, $kind) { //pluralize $active_messengers = EEH_MSG_Template::get_active_messengers_in_db(); EE_Registry::instance()->load_helper('MSG_Template'); if ($kind == 'messenger') { unset($active_messengers[$active_name]); EEH_MSG_Template::update_to_inactive($active_name); if (isset($this->_active_messengers[$active_name])) { unset($this->_active_messengers[$active_name]); } } else { foreach ($active_messengers as $messenger => $settings) { if (!empty($settings['settings'][$messenger . '-message_types'][$active_name])) { unset($active_messengers[$messenger]['settings'][$messenger . '-message_types'][$active_name]); } } EEH_MSG_Template::update_to_inactive('', $active_name); if (isset($this->_active_message_types[$active_name])) { unset($this->_active_message_types[$active_name]); } } EEH_MSG_Template::update_active_messengers_in_db($active_messengers); }
/** * sets the _existing_admin_settings property can be overridden by child classes. We do this so we only do database calls if needed. * * @access protected * @return void */ protected function _set_existing_admin_settings($messenger = NULL) { $active_messengers = EEH_MSG_Template::get_active_messengers_in_db(); $active_message_types = !empty($messenger) ? $active_messengers[$messenger]['settings'][$messenger . '-message_types'] : array(); $actives = $this->_messages_item_type == 'messenger' ? $active_messengers : $active_message_types; $this->_existing_admin_settings = isset($actives[$this->name]['settings']) ? $actives[$this->name]['settings'] : null; }
/** * This deregisters a message type that was previously registered with a specific mtname. * * @since 4.3.0 * * @param string $mt_name the name for the message type that was previously registered * @return void */ public static function deregister($mt_name = NULL) { if (!empty(self::$_ee_message_type_registry[$mt_name])) { //let's make sure that we remove any place this message type was made active EE_Registry::instance()->load_helper('MSG_Template'); $active_messengers = EEH_MSG_Template::get_active_messengers_in_db(); foreach ($active_messengers as $messenger => $settings) { if (!empty($settings['settings'][$messenger . '-message_types'][$mt_name])) { unset($active_messengers[$messenger]['settings'][$messenger . '-message_types'][$mt_name]); } } EEH_MSG_Template::update_to_inactive('', $mt_name); EEH_MSG_Template::update_active_messengers_in_db($active_messengers); unset(self::$_ee_message_type_registry[$mt_name]); } }