From ee8fe5676bc5963ade9c5d598c8cd4e1867037ef Mon Sep 17 00:00:00 2001 From: Steve Sutton Date: Fri, 26 Oct 2018 16:39:13 -0400 Subject: [PATCH 1/1] First sources --- activate.php | 153 +++++++++++ assets/readme.txt | 2 + classes/readme.txt | 3 + config/plugin.ini | 8 + css/readme.txt | 1 + deactivate.php | 62 +++++ defines.php | 71 +++++ index.php | 244 ++++++++++++++++++ js/front.js | 10 + js/readme.txt | 1 + lib/readme.txt | 3 + misc/documentation/AddAnAdminTab.txt | 15 ++ misc/documentation/CreateNewAddOn.txt | 49 ++++ models/admin/ajax/itineraryList.php | 91 +++++++ models/admin/readme.txt | 5 + models/front/readme.txt | 7 + readme.txt | 27 ++ setup/adminHooks.php | 44 ++++ setup/adminMenus.php | 52 ++++ setup/adminTabs.php | 35 +++ .../create_database_V0.0.1.sql | 50 ++++ setup/frontHooks.php | 47 ++++ setup/hooksHelp.html | 16 ++ setup/permissions.php | 53 ++++ setup/rolesAndCapabilities.php | 19 ++ setup/shortcodes.php | 94 +++++++ setup/validActions.php | 70 +++++ uninstall.php | 28 ++ views/admin/readme.txt | 5 + views/front/readme.txt | 7 + 30 files changed, 1272 insertions(+) create mode 100644 activate.php create mode 100644 assets/readme.txt create mode 100644 classes/readme.txt create mode 100644 config/plugin.ini create mode 100644 css/readme.txt create mode 100644 deactivate.php create mode 100644 defines.php create mode 100644 index.php create mode 100644 js/front.js create mode 100644 js/readme.txt create mode 100644 lib/readme.txt create mode 100644 misc/documentation/AddAnAdminTab.txt create mode 100644 misc/documentation/CreateNewAddOn.txt create mode 100644 models/admin/ajax/itineraryList.php create mode 100644 models/admin/readme.txt create mode 100644 models/front/readme.txt create mode 100644 readme.txt create mode 100644 setup/adminHooks.php create mode 100644 setup/adminMenus.php create mode 100644 setup/adminTabs.php create mode 100644 setup/databaseScripts/create_database_V0.0.1.sql create mode 100644 setup/frontHooks.php create mode 100644 setup/hooksHelp.html create mode 100644 setup/permissions.php create mode 100644 setup/rolesAndCapabilities.php create mode 100644 setup/shortcodes.php create mode 100644 setup/validActions.php create mode 100644 uninstall.php create mode 100644 views/admin/readme.txt create mode 100644 views/front/readme.txt diff --git a/activate.php b/activate.php new file mode 100644 index 0000000..2046d99 --- /dev/null +++ b/activate.php @@ -0,0 +1,153 @@ + + * @license http://www.gaslightmedia.com Gaslightmedia + * @release activate.php,v 1.0 2014/10/31 19:31:47 cscott Exp $ + * @link http://dev.gaslightmedia.com/ + */ + +// Check that we're being called by WordPress. +if (!defined('ABSPATH')) { + header("Location: http://".$_SERVER['SERVER_NAME']."/error/404.html"); + die(); +} + +/* + * This class performs all necessary additional work when this + * plugin is activated. + * + * Currently the only actions are to add role capability to display and modify + * prototypes. + */ +class glmMembersItineraryPluginActivate +{ + + /** + * WordPress Database Object + * + * @var $wpdb + * @access public + */ + public $wpdb; + /** + * Plugin Configuration Data + * + * @var $config + * @access public + */ + public $config; + + /* + * Constructor + * + * Note that the $noDatabaseCheck is used to access the database versions + * without triggering a database check. + * + * Performs all the work for this model + */ + public function __construct ($wpdb, $config) + { + + // Make sure the current user has this capability + if (! current_user_can('activate_plugins')) { + die(); + } + + // Save WordPress Database object + $this->wpdb = $wpdb; + + // Save plugin configuration object + $this->config = $config; + + // Set current plugin version + update_option('glmMembersItineraryPluginVersion', GLM_MEMBERS_ITINERARY_PLUGIN_VERSION); + + // Set Roles and Capabilities for this plugin + require_once GLM_MEMBERS_ITINERARY_PLUGIN_SETUP_PATH.'/rolesAndCapabilities.php'; + } + + /* + * Add a capability to all current roles + * + * @param string $capability Name of capability to add + * @param array $default Whether capability should be on by default + * array( + * 'author' => false, + * 'contributor' => false, + * 'editor' => false, + * 'subscriber' => false + * ) + * + * @return void + * @access private + */ + private function addRoleCapability($capability, $default) + { + // Get list of role objects + $roleObjects = $GLOBALS['wp_roles']->role_objects; + + // Get list of roles we can edit + $roles = get_editable_roles(); + + // For each role object + foreach ($roleObjects as $key => $role) { + + // Check if the role exists in list of editable roles and + // the capability does not exist + if (isset($roles[$key]) && ! isset($role->capabilities[$capability])) { + + // Check if a default value has been specified in the $default array + $enabled = false; + if (isset($default[$role->name])) { + + // It has, so use that + $enabled = $default[$role->name]; + + } + + // Add the role + $role->add_cap($capability, $enabled); + + } + } + } + + + /* + * Delete a capability from all current roles + * + * @param string $capability Name of capability to add + * + * @return void + * @access private + */ + private function deleteRoleCapability($capability) + { + // Get list of role objects + $roleObjects = $GLOBALS['wp_roles']->role_objects; + + // Get list of roles we can edit + $roles = get_editable_roles(); + + // For each role object + foreach ($roleObjects as $key => $role) { + + if ( isset($role->capabilities[$capability])) { + $role->remove_cap($capability); + } + + } + + } + + + +} diff --git a/assets/readme.txt b/assets/readme.txt new file mode 100644 index 0000000..34a6135 --- /dev/null +++ b/assets/readme.txt @@ -0,0 +1,2 @@ +Assets folder for things like images and other +files that might need to be read directly. \ No newline at end of file diff --git a/classes/readme.txt b/classes/readme.txt new file mode 100644 index 0000000..fa5f44e --- /dev/null +++ b/classes/readme.txt @@ -0,0 +1,3 @@ +General class libraries developed specifically for this add-on should be placed in this directory. + +The lib directory should be considered instead for any standard class libraries not specifically developed for this add-on. \ No newline at end of file diff --git a/config/plugin.ini b/config/plugin.ini new file mode 100644 index 0000000..9222f7e --- /dev/null +++ b/config/plugin.ini @@ -0,0 +1,8 @@ +; +; Main Configuration File +; {descrName} +; +; Place any static configuration parameters here. +; + +[common] diff --git a/css/readme.txt b/css/readme.txt new file mode 100644 index 0000000..954cc9c --- /dev/null +++ b/css/readme.txt @@ -0,0 +1 @@ +Add admin.css and/or front.css to this directory to have those registered automatically. \ No newline at end of file diff --git a/deactivate.php b/deactivate.php new file mode 100644 index 0000000..d785c8d --- /dev/null +++ b/deactivate.php @@ -0,0 +1,62 @@ + + * @license http://www.gaslightmedia.com Gaslightmedia + * @release admin.php,v 1.0 2014/10/31 19:31:47 cscott Exp $ + * @link http://dev.gaslightmedia.com/ + */ + +// Check that we're being called by WordPress. +if (!defined('ABSPATH')) { + header("Location: http://".$_SERVER['SERVER_NAME']."/error/404.html"); + die(); +} + +/* + * This class performs all necessary additional work when this + * plugin is deactivated. + */ +class glmMembersItineraryPluginDeactivate +{ + + /** + * WordPress Database Object + * + * @var $wpdb + * @access public + */ + public $wpdb; + /** + * Plugin Configuration Data + * + * @var $config + * @access public + */ + public $config; + + /* + * Constructor + * + * Performs all the work for this model + */ + public function __construct ($wpdb, $config) + { +/* + // Save WordPress Database object + $this->wpdb = $wpdb; + + // Save plugin configuration object + $this->config = $config; +*/ + // Delete our version from WordPress Options + delete_option('glmMembersItineraryPluginVersion'); + } + +} diff --git a/defines.php b/defines.php new file mode 100644 index 0000000..abf9abc --- /dev/null +++ b/defines.php @@ -0,0 +1,71 @@ +prefix.'glm_membersItinerary_'); +define('GLM_MEMBERS_ITINERARY_PLUGIN_ACTIVE_DB_OPTION', 'glmMembersItineraryDbVersion'); + +// Determine which system we're running on - If not provided, assume PRODUCTION +$host = getenv('GLM_HOST_ID'); +if (trim($host) == '') { + $host = 'PRODUCTION'; +} +define('GLM_MEMBERS_ITINERARY_PLUGIN_HOST', $host); + +// Determine current http/https protocol +$pageProtocol = 'http'; +if (isset($_SERVER['SERVER_PORT']) && $_SERVER['SERVER_PORT'] == '443') { + $pageProtocol = 'https'; +} +define('GLM_MEMBERS_ITINERARY_PLUGIN_HTTP_PROTOCOL', $pageProtocol); + +// Get various pieces of the URL +$urlParts = parse_url(get_bloginfo('url')); +$pageUri = explode('?', $_SERVER['REQUEST_URI']); // Bust this up to access URL path and script name only + +$WPUploadDir = wp_upload_dir(); + +/* + * Create a copy of the plugin slug that can be used as a variable prefix used to keep + * global instances from clashing with instances in other plugins. + */ +$vprefix = str_replace('-', '_', GLM_MEMBERS_ITINERARY_PLUGIN_SLUG); +define('GLM_MEMBERS_ITINERARY_PLUGIN_PREFIX', $vprefix.'_'); + +// URLs +define('GLM_MEMBERS_ITINERARY_SITE_BASE_URL', home_url('/') ); +define('GLM_MEMBERS_ITINERARY_PLUGIN_URL', plugin_dir_url(__FILE__)); +define('GLM_MEMBERS_ITINERARY_PLUGIN_ADMIN_URL', admin_url('admin.php')); +define('GLM_MEMBERS_ITINERARY_PLUGIN_BASE_URL', WP_PLUGIN_URL.'/'.GLM_MEMBERS_ITINERARY_PLUGIN_SLUG); +define('GLM_MEMBERS_ITINERARY_PLUGIN_CURRENT_URL', $urlParts['scheme'].'://'.$urlParts['host'].$pageUri[0]); + +// Directories +define('GLM_MEMBERS_ITINERARY_PLUGIN_PATH', dirname(__FILE__)); +define('GLM_MEMBERS_ITINERARY_PLUGIN_SETUP_PATH', GLM_MEMBERS_ITINERARY_PLUGIN_PATH.'/setup'); +define('GLM_MEMBERS_ITINERARY_PLUGIN_DB_SCRIPTS', GLM_MEMBERS_ITINERARY_PLUGIN_SETUP_PATH.'/databaseScripts'); +define('GLM_MEMBERS_ITINERARY_PLUGIN_CLASS_PATH', GLM_MEMBERS_ITINERARY_PLUGIN_PATH.'/classes'); +define('GLM_MEMBERS_ITINERARY_PLUGIN_CONFIG_PATH', GLM_MEMBERS_ITINERARY_PLUGIN_PATH.'/config'); + +// Parameters related to the Main GLM Member DB plugin - Depending on what's going on these may already defined by the main plugin +$pluginsPath = str_replace(GLM_MEMBERS_ITINERARY_PLUGIN_SLUG, '', GLM_MEMBERS_ITINERARY_PLUGIN_PATH); +define('GLM_MEMBERS_ITINERARY_MAIN_PLUGIN_PATH', $pluginsPath.'/glm-member-db'); +define('GLM_MEMBERS_ITINERARY_MAIN_PLUGIN_LIB_PATH', GLM_MEMBERS_ITINERARY_MAIN_PLUGIN_PATH.'/lib'); +define('GLM_MEMBERS_ITINERARY_PLUGIN_LIB_PATH', GLM_MEMBERS_ITINERARY_PLUGIN_PATH.'/lib'); + diff --git a/index.php b/index.php new file mode 100644 index 0000000..2cde743 --- /dev/null +++ b/index.php @@ -0,0 +1,244 @@ + + * @license http://www.gaslightmedia.com Gaslightmedia + * @version 0.0.1 + */ + +// Check that we're being called by WordPress. +if (!defined('ABSPATH')) { + header("Location: http://".$_SERVER['SERVER_NAME']."/error/404.html"); + die(); +} + +/* + * Plugin and Database Versions + * + * Note that the database version matches the version of the last + * plugin version where there was a change in the database. + * + * Updates to checkDatabase() in glmPluginSupport.php must be + * made together with the DB_VERSION below. ONLY bump the DB + * version when there's a change in the database!! Use the + * version nunmber of that release for the DB version. + * + * We check the plugin version stored in the WordPress option below + * so that we're sure the other add-ons see an up to date + * version from this plugin. + */ +define('GLM_MEMBERS_ITINERARY_PLUGIN_VERSION', '0.0.1'); +define('GLM_MEMBERS_ITINERARY_PLUGIN_DB_VERSION', '0.0.1'); + +// This is the minimum version of the GLM Members DB plugin require for this plugin. +define('GLM_MEMBERS_ITINERARY_PLUGIN_MIN_MEMBERS_REQUIRED_VERSION', '2.8.0'); + +// Check if plugin version is not current in WordPress option and if needed updated it +if (GLM_MEMBERS_ITINERARY_PLUGIN_VERSION != get_option('glmMembersItineraryPluginVersion')) { + update_option('glmMembersItineraryPluginVersion', GLM_MEMBERS_ITINERARY_PLUGIN_VERSION); +} + +/* + * Copyright 2014 Charles Scott (email : cscott@gaslightmedia.com) + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License, version 2, as + * published by the Free Software Foundation. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA + */ + +/* +* Some initial setup and tests +*/ + +$startupNotices = ''; + +// Get standard defined parameters +require_once 'defines.php'; + +// Required to be able to get user capabilities when being called as a filter from the main plugin +require_once ABSPATH . 'wp-includes/pluggable.php'; + +// Include defines to tell if a plugin is active +include_once ABSPATH . 'wp-admin/includes/plugin.php'; + +/* + * Do some preliminary sanity checks + */ + +// Check if database version should be defined and it isn't - This would be a plugin/add-on setup issue +if (is_file(GLM_MEMBERS_ITINERARY_PLUGIN_PATH.'/setup/databaseScripts/dbVersions.php') && !defined('GLM_MEMBERS_ITINERARY_PLUGIN_DB_VERSION')) { + die('You have database scripts but have not defined a current database version at the top of index.php for this plugin/add-on!'); +} + +/* + * Check installation, activation, and version of main Member DB plugin + */ + +// Check for main plugin and that it's active +function glmMembersItineraryPluginRequired() { + echo ' +
+

The '.GLM_MEMBERS_ITINERARY_PLUGIN_NAME.' add-on requires the base GLM Member DB plugin to be installed and active!

+

The '.GLM_MEMBERS_ITINERARY_PLUGIN_NAME.' plugin has been de-activated.

+
+ '; +} +$plugin_name = 'glm-member-db/index.php'; +$is_active = is_plugin_active($plugin_name); +if ($is_active != '1') { + add_action( 'admin_notices', 'glmMembersItineraryPluginRequired' ); + deactivate_plugins('/'.GLM_MEMBERS_ITINERARY_PLUGIN_SLUG.'/index.php'); +} + +// Check for Minimum DB version for main Member DB +function glmMembersItineraryMinVerRequired() { + echo ' +
+

The '.GLM_MEMBERS_ITINERARY_PLUGIN_NAME.' requires that the main GLM Member DB plugin version be no older than ' + .GLM_MEMBERS_ITINERARY_PLUGIN_MIN_MEMBERS_REQUIRED_VERSION.'!
+ '.GLM_MEMBERS_ITINERARY_MIN_VERSION_NOTE.'

+

The '.GLM_MEMBERS_ITINERARY_PLUGIN_NAME.' plugin has been de-activated.

+
+ '; +} +$glmMembersDatabasePluginVersion = get_option('glmMembersDatabasePluginVersion'); +if (version_compare($glmMembersDatabasePluginVersion, GLM_MEMBERS_ITINERARY_PLUGIN_MIN_MEMBERS_REQUIRED_VERSION) < 0) { + define('GLM_MEMBERS_ITINERARY_MIN_VERSION_NOTE', "Members DB: $glmMembersDatabasePluginVersion, Itinerary Requires: ".GLM_MEMBERS_ITINERARY_PLUGIN_MIN_MEMBERS_REQUIRED_VERSION); + add_action( 'admin_notices', 'glmMembersItineraryMinVerRequired'); + deactivate_plugins('/'.GLM_MEMBERS_ITINERARY_PLUGIN_SLUG.'/'.GLM_MEMBERS_ITINERARY_PLUGIN_SLUG.'.php'); +} + +/* + * Register this add-on with the main GLM Member DB plugin and get information on all add-ons loaded. + */ +require_once GLM_MEMBERS_ITINERARY_PLUGIN_SETUP_PATH.'/validActions.php'; +require_once GLM_MEMBERS_ITINERARY_PLUGIN_SETUP_PATH.'/shortcodes.php'; +if (is_file(GLM_MEMBERS_ITINERARY_PLUGIN_DB_SCRIPTS.'/dbVersions.php')) { + require_once GLM_MEMBERS_ITINERARY_PLUGIN_DB_SCRIPTS.'/dbVersions.php'; +} + +/* + * Load Add-On Management Settings data + * + * To have management and settings data from this add-on added to the main plugin config, + * uncomment the two sections and fix anything that's need to be corrected. + * + * Then add the data to the "config" array under "// Add this add-on to the add-ons array" below. + */ + +// Management +// $glmMembersItineraryManagementSettings = $wpdb->get_row( "SELECT * FROM ".GLM_MEMBERS_ITINERARY_PLUGIN_DB_PREFIX."management WHERE id = 1", ARRAY_A ); +// unset($glmMembersItineraryManagementSettings['id']); + +// Settings +// $glmMembersItinerarySettingsTerms = $wpdb->get_row( "SELECT * FROM ".GLM_MEMBERS_ITINERARY_PLUGIN_DB_PREFIX."settings_terms WHERE id = 1", ARRAY_A ); +// unset($glmMembersItinerarySettingsTerms['id']); + + + +function glmMembersItineraryRegisterAddOn($addOns) { + + // Add this add-on to the add-ons array + $addOns[GLM_MEMBERS_ITINERARY_PLUGIN_SLUG] = array( + 'dir' => GLM_MEMBERS_ITINERARY_PLUGIN_PATH, + 'name' => GLM_MEMBERS_ITINERARY_PLUGIN_NAME, + 'short_name' => GLM_MEMBERS_ITINERARY_PLUGIN_SHORT_NAME, + 'slug' => GLM_MEMBERS_ITINERARY_PLUGIN_SLUG, + 'actions' => $GLOBALS['glmMembersItineraryAddOnValidActions'], + 'config' => array( +// 'settings' => $GLOBALS['glmMembersItineraryManagementSettings'], +// 'terms' => $GLOBALS['glmMembersItinerarySettingsTerms'] + ), + 'shortcodes' => $GLOBALS['glmMembersItineraryShortcodes'], + 'shortcodesDescription' => $GLOBALS['glmMembersItineraryShortcodesDescription'] + ); + + // If we have database tables for this plugin/addon, provide that data also + if (isset($GLOBALS['glmMembersItineraryDbVersions'])) { + $addOns[GLM_MEMBERS_ITINERARY_PLUGIN_SLUG]['database'] = array( + 'dbPrefix' => GLM_MEMBERS_ITINERARY_PLUGIN_DB_PREFIX, + 'dbCurrentVersion' => GLM_MEMBERS_ITINERARY_PLUGIN_DB_VERSION, + 'dbActiveVersionOption' => GLM_MEMBERS_ITINERARY_PLUGIN_ACTIVE_DB_OPTION, + 'dbScriptPath' => GLM_MEMBERS_ITINERARY_PLUGIN_DB_SCRIPTS, + 'dbVersions' => $GLOBALS['glmMembersItineraryDbVersions'] + ); + } else { + $addOns[GLM_MEMBERS_ITINERARY_PLUGIN_SLUG]['database'] = false; + } + + // Return the array with our data added + return $addOns; +} +add_filter('glm-member-db-register-addon','glmMembersItineraryRegisterAddOn', 10, 1); + +/* + * Plugin Update Support - uses Gaslight Media update server + */ +/* Not functional yet - Need to resolve JavaScript conflicts with this feature in other plugins +require GLM_MEMBERS_ITINERARY_PLUGIN_LIB_PATH.'/opentools-update-checker/opentools-update-checker.php'; +${GLM_MEMBERS_ITINERARY_PLUGIN_PREFIX."updateChecker"} = new OpenToolsPluginUpdateChecker( + 'http://www.gaslightmedia.com/update_server/?action=get_metadata&slug='.GLM_MEMBERS_ITINERARY_PLUGIN_SLUG, + __FILE__, + GLM_MEMBERS_ITINERARY_PLUGIN_SLUG +); + +${GLM_MEMBERS_ITINERARY_PLUGIN_PREFIX."updateChecker"}->declareCredentials(array( + 'license_key' => __('License Key:') +)); +*/ + +/* + * + * Activate and Deactivate hooks + * + */ + + // Activate + function glmMembersItineraryPluginActivate () + { + global $wpdb, $config; + require_once GLM_MEMBERS_ITINERARY_PLUGIN_PATH . '/activate.php'; + new glmMembersItineraryPluginActivate($wpdb, $config); + } + register_activation_hook(__FILE__, 'glmMembersItineraryPluginActivate'); + + // Deactivate + function glmMembersItineraryPluginDeactivate () + { + global $wpdb, $config; + require_once GLM_MEMBERS_ITINERARY_PLUGIN_PATH . '/deactivate.php'; + $x = new glmMembersItineraryPluginDeactivate($wpdb, $config); + return false; + } + register_deactivation_hook(__FILE__, 'glmMembersItineraryPluginDeactivate'); + +/* + * Hooks for testing capabilities provided by this add-on + */ +require_once GLM_MEMBERS_ITINERARY_PLUGIN_SETUP_PATH.'/permissions.php'; + diff --git a/js/front.js b/js/front.js new file mode 100644 index 0000000..ff4ea4b --- /dev/null +++ b/js/front.js @@ -0,0 +1,10 @@ +/* Js file for Itinerary */ + +jQuery('.glm-planner-button').on('click', function(){ + var member_id = jQuery(this).data('id'); + console.log( 'help me ' + member_id ); + jQuery.ajax({ + url: 'http://66.129.38.1/wp-admin/admin-ajax.php?action=glm_members_admin_ajax&glm_action=itineraryList&member_id=' + member_id, + + }); +}); diff --git a/js/readme.txt b/js/readme.txt new file mode 100644 index 0000000..f642355 --- /dev/null +++ b/js/readme.txt @@ -0,0 +1 @@ +Add admin.js and/or front.js to this directory to have those registered automatically. \ No newline at end of file diff --git a/lib/readme.txt b/lib/readme.txt new file mode 100644 index 0000000..8373066 --- /dev/null +++ b/lib/readme.txt @@ -0,0 +1,3 @@ +Standard class libraries not specifically developed for this add-on should be placed here. + +The classes directory should be considered instead for class libraries developed specifically for this add-on. diff --git a/misc/documentation/AddAnAdminTab.txt b/misc/documentation/AddAnAdminTab.txt new file mode 100644 index 0000000..c697b47 --- /dev/null +++ b/misc/documentation/AddAnAdminTab.txt @@ -0,0 +1,15 @@ +Add an admin tab + +* Add a new section in setup/adminTabs.php + +* Add a model file - models/admin/{menu}/{action}.php + +* Add a view file - views/admin/{menu}/{action}.html + +* Add action to setup/validActions.php + +* If needed add a database table to the create_database_V...sql file + and update name to current database version, add an + update_database_V....sql file, and/or update dbVersions.php + +* If required add a data definition for any new tables diff --git a/misc/documentation/CreateNewAddOn.txt b/misc/documentation/CreateNewAddOn.txt new file mode 100644 index 0000000..b93235f --- /dev/null +++ b/misc/documentation/CreateNewAddOn.txt @@ -0,0 +1,49 @@ +Procedure to create a new GLM Members add-on plugin +---------------------------------------------------- + +* Checkout glm-member-db-sample and rename directory to glm-member-db-{add-on name} + +* From a bash prompt, run "SETUP_SCRIPT" + +* Create new repository named WP-Plugins/glm-member-db-{name of add-on}.git + +* If there are any databases associated with this add-on, setup the database scripts and + data under the "setup/databaseScripts" directory. If there are no database tables + with this add-on, remove all but the "readme.txt" file from that directory. + NOTE: No "update_database..." files should be there for a new add-on with new tables. + NOTE: There should be only one entry in the "dbVersions.php" file. + +* Carefully review "defines.php" file and update as needed. + +* Do a quick review of the readme.txt file and update as desired. + +* TEST - At this point the add-on should install and activate but not do anything. + - If there are any database tables, make sure they were created and are correct. + - Go to "Members" -> "Management" -> "Add-Ons" and make sure the add-on was + properly registered with the main plugin and that any database data is shown. + +* Adding menus + - Update "setup/adminMenus.php" and add menu section as described there. + - Add an entry in the validActions.php file. Pay attention to how slug name is + constructed ("glm-members-admin-{page}-{action}"). + - If needed add a database table to the create_database_V...sql file + Also add a "classes/data/data{Table}.php file + - Add a model file as "models/admin/{page}/{action}.php + - Add any desired view file as "views/admin/{page}/{action}.html + Note that additional possible view files should be named as... + "views/admin/{page}/{action}{Name}.html + - Test that when add-on is activated that the menu shows and is functional. + +* Adding tabs + - Update "setup/admin/Tabs.php" and add new tab filter as described there. + - Add an entry in the validActions.php file. Pay attention to how slug name is + constructed ("glm-members-admin-{page}-{action}"). + - If needed add a database table to the create_database_V...sql file + Also add a "classes/data/data{Table}.php file + - Add a model file as "models/admin/{page}/{action}.php + - Add any desired view file as "views/admin/{page}/{action}.html + Note that additional possible view files should be named as... + "views/admin/{page}/{action}{Name}.html + - Test that when add-on is activated that the tab shows and is functional. + + * \ No newline at end of file diff --git a/models/admin/ajax/itineraryList.php b/models/admin/ajax/itineraryList.php new file mode 100644 index 0000000..293a70e --- /dev/null +++ b/models/admin/ajax/itineraryList.php @@ -0,0 +1,91 @@ + + * @license http://www.gaslightmedia.com Gaslightmedia + * @version 0.1 + */ + + +// Load Member Info data abstract +require_once GLM_MEMBERS_PLUGIN_CLASS_PATH.'/data/dataMemberInfo.php'; + +/** + * + * This class exports the currently selected members list + * to a printable HTML file, to a CSV file, or otherwise. + */ +class GlmMembersAdmin_ajax_itineraryList //extends GlmDataMemberInfo +{ + + /** + * WordPress Database Object + * + * @var $wpdb + * @access public + */ + public $wpdb; + /** + * Plugin Configuration Data + * + * @var $config + * @access public + */ + public $config; + + /** + * Constructor + * + * This constructor sets up this model. At this time that only includes + * storing away the WordPress data object. + * + * @return object Class object + * + */ + public function __construct ($wpdb, $config) + { + + // Save WordPress Database object + $this->wpdb = $wpdb; + + // Save plugin configuration object + $this->config = $config; + + // parent::__construct(false, false); + + } + + /** + * Perform Model Action + * + * This modelAction takes an AJAX image upload and stores the image in the + * media/images directory of the plugin. + * + * This model action does not return, it simply does it's work then calls die(); + * + * @param $actionData + * + * Echos JSON string as response and does not return + */ + public function modelAction ($actionData = false) + { + + $member_id = isset( $_REQUEST['member_id'] ) ? filter_var( $_REQUEST['member_id'], FILTER_VALIDATE_INT ) : null; + + if ( $member_id ) { + // add to the session + $_SESSION['travel-list'][$member_id]; + } + + return true; + + } + +} diff --git a/models/admin/readme.txt b/models/admin/readme.txt new file mode 100644 index 0000000..e9a199d --- /dev/null +++ b/models/admin/readme.txt @@ -0,0 +1,5 @@ +The admin controller executes models under this directory. + +Typically you should add a directory here that matches the page where the action should take place. + +Under that directory place the model for the various actions. \ No newline at end of file diff --git a/models/front/readme.txt b/models/front/readme.txt new file mode 100644 index 0000000..4c54852 --- /dev/null +++ b/models/front/readme.txt @@ -0,0 +1,7 @@ +The front controller executes models under this directory. + +Typically you should add a directory here that matches the category of actions that will take place. + +Under that directory place the model for the various actions. + +Actions under this directory would normally be called due to processing of a shortcode. \ No newline at end of file diff --git a/readme.txt b/readme.txt new file mode 100644 index 0000000..d67a5f5 --- /dev/null +++ b/readme.txt @@ -0,0 +1,27 @@ +=== GLM Associate Itinerary === +Contributors: cscott@gaslightmedia.com +Donate link: http://www.gaslightmedia.com +Tags: Gaslight Media,Plugin,Itinerary +Requires at least: 3.0.1 +Tested up to: 3.4 +Stable tag: 4.3 +License: GPLv2 or later +License URI: http://www.gnu.org/licenses/gpl-2.0.html + +This is the GLM Associate Itinerary. + +== Description == + +The GLM Associate Itinerary is an add-on to the Gaslight Media Members Database, +which is required to install and run this plugin + +== Installation == + +This section describes how to install the plugin and get it working. + +e.g. + +1. Upload `plugin-name.php` to the `/wp-content/plugins/` directory +1. Activate the plugin through the 'Plugins' menu in WordPress + + diff --git a/setup/adminHooks.php b/setup/adminHooks.php new file mode 100644 index 0000000..8788e10 --- /dev/null +++ b/setup/adminHooks.php @@ -0,0 +1,44 @@ + + * @license http://www.gaslightmedia.com Gaslightmedia + * @release adminHooks.php,v 1.0 2014/10/31 19:31:47 cscott Exp $ + * @link http://dev.gaslightmedia.com/ + */ + +/* + * Place Misc Hooks and Filters here. If this file exists, it will be included + * by the add-on main plugin script. + * + * Note that filter and hook callback functions must be included in-line as shown below... + * + * add_filter( 'filter_title', function( $parameter ) { + * // Function code + * }); + * + * Also note that parameters will be in the context of the main admin controller constructor. + */ + +// Add content to member detail page +add_filter('glm-member-db-admin-management-hooksHelp', function($content) { + + // Read in this plugin/addon hook help file + $fname = GLM_MEMBERS_ITINERARY_PLUGIN_PATH.'/setup/hooksHelp.html'; + if (is_file($fname)) { + $hooksHelp = file_get_contents($fname); + if ($hooksHelp != false) { + $content .= $hooksHelp; + } + } + return $content; + }, + 10, + 2 +); diff --git a/setup/adminMenus.php b/setup/adminMenus.php new file mode 100644 index 0000000..d69ce18 --- /dev/null +++ b/setup/adminMenus.php @@ -0,0 +1,52 @@ + + * @license http://www.gaslightmedia.com Gaslightmedia + * @release admin.php,v 1.0 2014/10/31 19:31:47 cscott Exp $ + * @link http://dev.gaslightmedia.com/ + */ + +/* + * Added menus or sub-menus examples + * + * // Add a main menu item + * add_menu_page( + * 'GLM Sample', // Page Title + * 'GLM Sample', // Menu Title + * 'glm-members-members', // Capability + * 'glm-members-admin-menu-glm-sample', // Menu Slug + * function() {$this->controller('sample');}, // Called function - typically controller() with the menu name + * false, // Icon URL + * '92' // Menu Position + * ); + * + * // Add a sub-menu item + * add_submenu_page( + * 'glm-members-admin-menu-sample', // Parent slug + * 'Sample', // Page title + * 'Sample', // Menu Title + * 'glm_members_edit', // Capability required + * 'glm-members-admin-menu-sample', // Menu slug + * function() {$this->controller('sample');} + * ); + * + * If creating a main menu item with add_menu_page(), please document + * that structure here. + * + * NOTE: The menu slug is the link for the page. It is also parsed by + * the controller and used to find the model to load. The + * "glm-members-admin-menu-" portion should not change, the last + * segment is the model directory name. By default the "index.php" file + * in that directory is executed. If the URL includes a "glm_action" + * parameter, then the model file called is in the same directory but + * is named the same as the "glm_action" parameter. + * + */ + diff --git a/setup/adminTabs.php b/setup/adminTabs.php new file mode 100644 index 0000000..3bfc353 --- /dev/null +++ b/setup/adminTabs.php @@ -0,0 +1,35 @@ + + * @license http://www.gaslightmedia.com Gaslightmedia + * @release admin.php,v 1.0 2014/10/31 19:31:47 cscott Exp $ + * @link http://dev.gaslightmedia.com/ + */ + +/* + * To add a new tab to an existing Member DB page use a block + * like this and replace the {} parameters. + * + * add_filter('glm-member-db-add-tab-for-{menu name}', + * function($addOnTabs) { + * $newTabs = array( + * array( + * 'text' => '{text for display on tab}', + * 'menu' => '{menu name}', + * 'action' => '{action to perform}' + * ) + * ); + * $addOnTabs = array_merge($addOnTabs, $newTabs); + * return $addOnTabs; + * } + * ); + * + */ + diff --git a/setup/databaseScripts/create_database_V0.0.1.sql b/setup/databaseScripts/create_database_V0.0.1.sql new file mode 100644 index 0000000..a09bb04 --- /dev/null +++ b/setup/databaseScripts/create_database_V0.0.1.sql @@ -0,0 +1,50 @@ +-- Gaslight Media Staff Add On +-- File Created: 2018-10-24 +-- Database Version: 0.0.1 +-- Database Creation Script +-- +-- To permit each query below to be executed separately, +-- all queries must be separated by a line with four dashes + +-- Itinerary Session +CREATE TABLE {prefix}session ( + id INT NOT NULL AUTO_INCREMENT, + ref_type INT NOT NULL, -- Reference Type (see plugin.ini for ref_types) + ref_dest INT NOT NULL, -- Id from the Reference + contact_type INT NOT NULL, -- Contact Type (see plugin.ini for contact_types) + contact_dest INT NOT NULL, -- Id of the Contact Type + page_url TEXT NOT NULL, -- Page url when this was added. + PRIMARY KEY (id), + INDEX(ref_dest), + INDEX(contact_dest) +); + +---- + +-- Itinerary User +CREATE TABLE {prefix}user ( + id INT NOT NULL AUTO_INCREMENT, + fname TINYTEXT NULL, + lname TINYTEXT NULL, + addr1 TINYTEXT NULL, + addr2 TINYTEXT NULL, + city TINYTEXT NULL, + state TINYTEXT NULL, + zip TINYTEXT NULL, + email TINYTEXT NULL, + phone TINYTEXT NULL, + fax TINYTEXT NULL, + password TINYTEXT NULL, + PRIMARY KEY (id), + INDEX(email(20)) +); + +---- + +-- Management +CREATE TABLE {prefix}management ( + id INT NOT NULL AUTO_INCREMENT, + itinerary_page INT NULL, + button_text TINYTEXT NULL, + PRIMARY KEY (id) +); diff --git a/setup/frontHooks.php b/setup/frontHooks.php new file mode 100644 index 0000000..bd75a0d --- /dev/null +++ b/setup/frontHooks.php @@ -0,0 +1,47 @@ + + * @license http://www.gaslightmedia.com Gaslightmedia + * @release frontHooks.php,v 1.0 2014/10/31 19:31:47 cscott Exp $ + * @link http://dev.gaslightmedia.com/ + */ + +/* + * Place Misc Hooks and Filters here. If this file exists, it will be included + * by the add-on main plugin script. + * + * Note that filter and hook callback functions must be included in-line as shown below... + * + * add_filter( 'filter_title', function( $parameter ) { + * // Function code + * }); + * + * *** Also note that parameters will be in the context of the main front controller constructor. *** + */ +add_filter( + 'glm-member-db-front-members-list-memberDataBelow', + function( $content, $member_id ){ + echo '
$_SESSION: ' . print_r( $_SESSION, true ) . '
'; + if ( $_SESSION['travel-list'][$member_id] ) { + return $content . ''; + } else { + return $content . ''; + } + }, + 10, + 2 +); + +// If no session then start one. +add_action( 'init', function(){ + if ( ! session_id() ) { + session_start(); + } +}); diff --git a/setup/hooksHelp.html b/setup/hooksHelp.html new file mode 100644 index 0000000..bbe0e75 --- /dev/null +++ b/setup/hooksHelp.html @@ -0,0 +1,16 @@ + \ No newline at end of file diff --git a/setup/permissions.php b/setup/permissions.php new file mode 100644 index 0000000..68554ec --- /dev/null +++ b/setup/permissions.php @@ -0,0 +1,53 @@ + + * @license http://www.gaslightmedia.com Gaslightmedia + * @release permissions.php,v 1.0 2014/10/31 19:31:47 cscott Exp $ + * @link http://dev.gaslightmedia.com/ + */ + + +/* + * Below are permission checks for various specific things in this add-on and + * elsewhere in the Member DB main plugin and add-ons. + * + * Each location where a permission might be required has an apply_filters() + * hook with a tag name that includes the plugin or add-on name, the menu, + * the action, and a name for the specific thing that needs permissions. + * + * This can be included in code or in a Smarty template used in these plugins. + * For example, to check permissions for the main Members menu and it's "index" + * action to see if a member search is permitted, the template includes the + * following code... + * + * {if $membersList && apply_filters('glm_members_permit_admin_members_index_member_search', true)} + * --- some template output --- + * {/if} + * + * In the case above, it's also checking to see if the members list even exists + * before checking the permissions. The default value of "true" in the hook ensures + * that the permission is granted if nothing has linked into the hook to say otherwise. + * + * Note that each add_filter() below first checks if the permission has already + * been retracted by prior hook. This requires all that are attached to the hook + * to permit the action. + * + * Of course any of these may test more than one capability if that's desired. + * + * Since we have capabilities that only exist if a particular add-on (such as Contacts) + * has been loaded and activated, it can be helpful to be able to test for a capability + * for the current user and permit some action if that capability doesn't exist. The + * main plugin therefore provides the following globally accessible function that will + * return true if the capability doesn't exist, otherwise it respects the capability. + * + * glmMembersUserCan('glm_members_edit_any_member', $permit); + * + * $permit is a boolean set before this function call for passing on permissions. +*/ diff --git a/setup/rolesAndCapabilities.php b/setup/rolesAndCapabilities.php new file mode 100644 index 0000000..8ffa5e9 --- /dev/null +++ b/setup/rolesAndCapabilities.php @@ -0,0 +1,19 @@ + + * @license http://www.gaslightmedia.com Gaslightmedia + * @release rolesAndPermissions.php,v 1.0 2014/10/31 19:31:47 cscott Exp $ + * @link http://dev.gaslightmedia.com/ + */ + +/** + * NOTE: This file is only included in the activate.php process. + * It is not regularly used during operation. + */ diff --git a/setup/shortcodes.php b/setup/shortcodes.php new file mode 100644 index 0000000..7b38856 --- /dev/null +++ b/setup/shortcodes.php @@ -0,0 +1,94 @@ + + * @license http://www.gaslightmedia.com Gaslightmedia + * @release shortcodes.php,v 1.0 2014/10/31 19:31:47 cscott Exp $ + * @link http://dev.gaslightmedia.com/ + */ + +/* + * Array of short-code + * + * This array lists all of the short-codes available from the main + * member plugin and all add-ons that provide short-code features. + * + * This array is merged with the data from any registered add-ons + * providing short-code features. The plugin providing the short-code + * is designated in the 'plugin' elemeent. + * + * A shortcode is unique to a particular plugin. To provide additional + * data and features to a short-code, an add-on should use filters + * provided by the short-code to insert data into the template array, + * to insert additional format into the template, or to insert + * text directly into the completed template output. + * + * The "attributes" array is a list of available attributes for this + * shortcode and their default values. If a database table is provided, + * then the value for each attribute is a table column where we get + * the default value. If no table is provided, then the value for + * each attribute is the actual default value for that attribute. + * In the case that the data is taken from the database table, the + * "id" for the table entry where the data is stored is assumed to + * be 1. + * + * Note that if the value for a particular attribute is false, then + * it is not read from the database even if the table is specified + * but might be supplied at run-time as an attribute in the short-code. + * All attributes that might be specified in the shortcode must be + * listed in the 'attributes' array below. If an attribute is not + * specified here, it can't be read from the short-code. + * + * The following is an explanation of this array. + * + * array( + * '{shortcode-slug}' => array( + * 'plugin' => '{plugin (add-on) slug}', // Identifies which plugin is providing the short-code + * 'menu' => '{menu name}', // Menu name in this context is simply where to find the action + * 'action' => '{shortcode action name}', // Action used to execute this shortcode + * 'table' => '{table prefix}{table name}', // Database table where default attribute values are stored + * 'attributes' => array( // An array of all shortcode attributes (options) + * '{attr name}' => '{field name}', // Available attribute names and the database field names with the default value + * .... + * ), + * ... additional short-codes + * ) + * + * Shortcode descriptions sample + * + * ShortcodeAttributeDescription + * + * [glm-members-sample-shortcode] + *   + * + * Displays something related to this add-on. + * + * + * + *   + * type="{types}" + * + * The "type" attribute is used to select the type of data to be displayed. + * Below is a list of available list types. + *

+ * + * + * + * + *
List Types
oneType One
twoType Two
+ *

+ * + * + */ + +$glmMembersItineraryShortcodes = array( +); + +$glmMembersItineraryShortcodesDescription = ''; + diff --git a/setup/validActions.php b/setup/validActions.php new file mode 100644 index 0000000..da8022d --- /dev/null +++ b/setup/validActions.php @@ -0,0 +1,70 @@ + + * @license http://www.gaslightmedia.com Gaslightmedia + * @release admin.php,v 1.0 2014/10/31 19:31:47 cscott Exp $ + * @link http://dev.gaslightmedia.com/ + */ + +/* + * Array of valid menu items and actions. + * + * The higher level elements are valid menu items. These correlate to + * actual menu or sub menu items that are hooks back to this controller + * class. + * + * The lower level items below each menu item are actions that may be specified + * by a "glmMembersAction" form field. + * + * The string after the action is the slug of the plugin where the model/view + * is to perform that action. + * + * This array is integrated into the valid actions array in the main GLM Member + * DB plugin when this plugin registers itself. + * + * EXAMPLE + * + * $glmMembersItineraryAddOnValidActions = array( + * 'adminActions' => array( + * 'members' => array( + * 'sample' => GLM_MEMBERS_ITINERARY_PLUGIN_SLUG, + * ), + * 'sample' => array( + * 'index' => GLM_MEMBERS_ITINERARY_PLUGIN_SLUG, + * 'more' => GLM_MEMBERS_ITINERARY_PLUGIN_SLUG, + * ), + * 'info' => array( + * 'index' => GLM_MEMBERS_ITINERARY_PLUGIN_SLUG + * ) + * ), + * 'frontActions' => array( + * 'sample' => array( + * 'list' => GLM_MEMBERS_ITINERARY_PLUGIN_SLUG, + * 'detail' => GLM_MEMBERS_ITINERARY_PLUGIN_SLUG + * ) + * ) + * ); + * + * + * + * + */ + +$glmMembersItineraryAddOnValidActions = array( + 'adminActions' => array( + 'ajax' => array( + 'itineraryList' => GLM_MEMBERS_ITINERARY_PLUGIN_SLUG, + ), + ), + 'frontActions' => array( + ) +); + +?> diff --git a/uninstall.php b/uninstall.php new file mode 100644 index 0000000..9d9986f --- /dev/null +++ b/uninstall.php @@ -0,0 +1,28 @@ + + * @license http://www.gaslightmedia.com Gaslightmedia + * @release admin.php,v 1.0 2014/10/31 19:31:47 cscott Exp $ + * @link http://dev.gaslightmedia.com/ + */ + +// Check that we're being called by WordPress. +if (!defined('ABSPATH')) { + header("Location: http://".$_SERVER['SERVER_NAME']."/error/404.html"); + die(); +} + +//if uninstall not called from WordPress exit +if (!defined('WP_UNINSTALL_PLUGIN')) { + die("Sorry, uninstall must be called by WordPress!"); +} diff --git a/views/admin/readme.txt b/views/admin/readme.txt new file mode 100644 index 0000000..5a9d7ea --- /dev/null +++ b/views/admin/readme.txt @@ -0,0 +1,5 @@ +The admin controller uses views (templates) under this directory to generate final output. + +Typically you should add a directory here that matches the page where the view is used. + +Under that directory place the view (template) for the various actions. \ No newline at end of file diff --git a/views/front/readme.txt b/views/front/readme.txt new file mode 100644 index 0000000..1138d90 --- /dev/null +++ b/views/front/readme.txt @@ -0,0 +1,7 @@ +The front controller uses views (templates) under this directory to generate final output. + +Typically you should add a directory here that matches the category of actions that will use these views. + +Under that directory place the view (template) for the various actions. + +Views under this directory would normally be called due to processing of a shortcode. \ No newline at end of file -- 2.17.1