PluginProbe
Mailchimp List Subscribe Form / trunk
Mailchimp List Subscribe Form vtrunk
1.2.4 1.2.5 1.2.6 1.2.7 1.2.8 1.2.9 1.3 1.4 1.4.1 1.4.2 1.4.3 1.4.4 1.4.5 1.5 1.5.1 1.5.2 1.5.3 1.5.4 1.5.5 1.5.6 1.5.7 1.5.8 1.5.9 1.6.0 1.6.1 All 55 releases
← All changes | mailchimp.php +816 -964 1.5.9 → trunk View file →
@@ -1,92 +1,179 @@
1 1 <?php
2 -/*
3 -Plugin Name: MailChimp
4 -Plugin URI: http://www.mailchimp.com/plugins/mailchimp-wordpress-plugin/
5 -Description: The MailChimp plugin allows you to quickly and easily add a signup form for your MailChimp list.
6 -Version: 1.5.9
7 -Author: MailChimp
8 -Author URI: https://mailchimp.com/
9 -*/
10 -/* Copyright 2008-2012 MailChimp.com (email : api@mailchimp.com)
2 +/**
3 + * Plugin Name: Mailchimp
4 + * Plugin URI: https://mailchimp.com/help/connect-or-disconnect-list-subscribe-for-wordpress/
5 + * Description: Add a Mailchimp signup form block, widget or shortcode to your WordPress site.
6 + * Text Domain: mailchimp
7 + * Version: 2.1.0
8 + * Requires at least: 6.6
9 + * Requires PHP: 7.4
10 + * PHP tested up to: 8.3
11 + * Author: Mailchimp
12 + * Author URI: https://mailchimp.com/
13 + * License: GPL-2.0-or-later
14 + * License URI: https://spdx.org/licenses/GPL-2.0-or-later.html
15 + *
16 + * @package Mailchimp
17 + **/
11 18
12 - This program is free software; you can redistribute it and/or modify
13 - it under the terms of the GNU General Public License as published by
14 - the Free Software Foundation; either version 2 of the License, or
15 - (at your option) any later version.
19 +/**
20 + * Copyright 2008-2012 Mailchimp.com (email : api@mailchimp.com)
21 + *
22 + * This program is free software; you can redistribute it and/or modify
23 + * it under the terms of the GNU General Public License as published by
24 + * the Free Software Foundation; either version 2 of the License, or
25 + * (at your option) any later version.
26 + *
27 + * This program is distributed in the hope that it will be useful,
28 + * but WITHOUT ANY WARRANTY; without even the implied warranty of
29 + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
30 + * GNU General Public License for more details.
31 + *
32 + * You should have received a copy of the GNU General Public License
33 + * along with this program; if not, write to the Free Software
34 + * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
35 + */
16 36
17 - This program is distributed in the hope that it will be useful,
18 - but WITHOUT ANY WARRANTY; without even the implied warranty of
19 - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 - GNU General Public License for more details.
37 +// Check if the autoload file exists
38 +if ( is_readable( __DIR__ . '/vendor/autoload.php' ) ) {
39 + require_once __DIR__ . '/vendor/autoload.php';
40 +} else {
41 + add_action(
42 + 'admin_notices',
43 + function () {
44 + ?>
45 + <div class="notice notice-error">
46 + <p>
47 + <?php
48 + echo wp_kses_post(
49 + sprintf(
50 + /* translators: 1: Command to run, e.g., <code>composer install</code>, 2: Support URL, e.g., https://wordpress.org/support/plugin/mailchimp/. */
51 + __( 'The composer autoload file is not found or not readable. Please contact <a href="%2$s" target="_blank">support</a> if you\'re a user. Please run %1$s if you\'re a developer in a development environment.', 'mailchimp' ),
52 + '<code>composer install</code>',
53 + 'https://wordpress.org/support/plugin/mailchimp/'
54 + )
55 + );
56 + ?>
57 + </p>
58 + </div>
59 + <?php
60 + }
61 + );
21 62
22 - You should have received a copy of the GNU General Public License
23 - along with this program; if not, write to the Free Software
24 - Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
25 -*/
63 + // Exit early.
64 + return;
65 +}
26 66
67 +use function Mailchimp\WordPress\Includes\Admin\{admin_notice_error, admin_notice_success};
68 +
27 69 // Version constant for easy CSS refreshes
28 -define('MCSF_VER', '1.5.9');
70 +define( 'MCSF_VER', '2.1.0' );
29 71
30 72 // What's our permission (capability) threshold
31 -define('MCSF_CAP_THRESHOLD', 'manage_options');
73 +define( 'MCSF_CAP_THRESHOLD', 'manage_options' );
32 74
33 75 // Define our location constants, both MCSF_DIR and MCSF_URL
34 -mailchimpSF_where_am_i();
76 +mailchimp_sf_where_am_i();
35 77
36 -// Get our MailChimp API class in scope
37 -if (!class_exists('MailChimp_API')) {
38 - $path = plugin_dir_path(__FILE__);
39 - require_once($path . 'lib/mailchimp/mailchimp.php');
78 +// Get our Mailchimp API class in scope
79 +if ( ! class_exists( 'MailChimp_API' ) ) {
80 + $path = plugin_dir_path( __FILE__ );
81 + require_once $path . 'lib/mailchimp/mailchimp.php';
40 82 }
41 83
84 +// Encryption utility class.
85 +require_once plugin_dir_path( __FILE__ ) . 'includes/class-mailchimp-data-encryption.php';
86 +
42 87 // includes the widget code so it can be easily called either normally or via ajax
43 -include_once('mailchimp_widget.php');
88 +require_once 'mailchimp_widget.php';
44 89
45 90 // includes the backwards compatibility functions
46 -include_once('mailchimp_compat.php');
91 +require_once 'mailchimp_compat.php';
47 92
93 +// Upgrade routines.
94 +require_once 'mailchimp_upgrade.php';
95 +
96 +// Init Admin functions.
97 +require_once plugin_dir_path( __FILE__ ) . 'includes/class-mailchimp-user-sync-backgroud-process.php';
98 +require_once plugin_dir_path( __FILE__ ) . 'includes/admin/class-mailchimp-user-sync.php';
99 +require_once plugin_dir_path( __FILE__ ) . 'includes/admin/class-mailchimp-admin-notices.php';
100 +require_once plugin_dir_path( __FILE__ ) . 'includes/class-mailchimp-admin.php';
101 +$admin = new Mailchimp_Admin();
102 +$admin->init();
103 +
104 +// Init the blocks.
105 +require_once plugin_dir_path( __FILE__ ) . 'includes/blocks/class-mailchimp-list-subscribe-form-blocks.php';
106 +$block = new Mailchimp_List_Subscribe_Form_Blocks();
107 +$block->init();
108 +
109 +// Form submission handler class.
110 +require_once plugin_dir_path( __FILE__ ) . 'includes/class-mailchimp-form-submission.php';
111 +$form_submission = new Mailchimp_Form_Submission();
112 +$form_submission->init();
113 +
114 +// Shared bucketing helpers used by both analytics chart data providers.
115 +require_once plugin_dir_path( __FILE__ ) . 'includes/trait-mailchimp-analytics-bucketing.php';
116 +
117 +// Init Analytics page.
118 +require_once plugin_dir_path( __FILE__ ) . 'includes/class-mailchimp-analytics.php';
119 +$analytics = new Mailchimp_Analytics();
120 +$analytics->init();
121 +
122 +// Analytics data class.
123 +require_once plugin_dir_path( __FILE__ ) . 'includes/class-mailchimp-analytics-data.php';
124 +$analytics_data = new Mailchimp_Analytics_Data();
125 +$analytics_data->init();
126 +
127 +// Subscriber activity (Mailchimp Activity API) data class.
128 +require_once plugin_dir_path( __FILE__ ) . 'includes/class-mailchimp-subscriber-activity.php';
129 +$subscriber_activity = new Mailchimp_Subscriber_Activity();
130 +$subscriber_activity->init();
131 +
132 +// Form performance (local analytics DB) data class.
133 +require_once plugin_dir_path( __FILE__ ) . 'includes/class-mailchimp-form-performance.php';
134 +$form_performance = new Mailchimp_Form_Performance();
135 +$form_performance->init();
136 +
137 +// Deprecated functions.
138 +require_once plugin_dir_path( __FILE__ ) . 'includes/mailchimp-deprecated-functions.php';
139 +
48 140 /**
49 141 * Do the following plugin setup steps here
50 142 *
51 - * Internationalization
52 143 * Resource (JS & CSS) enqueuing
53 144 *
54 145 * @return void
55 146 */
56 -function mailchimpSF_plugin_init() {
57 - // Internationalize the plugin
58 - $textdomain = 'mailchimp_i18n';
59 - $locale = apply_filters( 'plugin_locale', get_locale(), $textdomain);
60 - load_textdomain('mailchimp_i18n', MCSF_LANG_DIR.$textdomain.'-'.$locale.'.mo');
147 +function mailchimp_sf_plugin_init() {
61 148
62 - // Remove Sopresto check. If user does not have API key, make them authenticate.
149 + if ( get_option( 'mc_list_id' ) && get_option( 'mc_merge_field_migrate' ) !== '1' && mailchimp_sf_get_api() !== false ) {
150 + mailchimp_sf_update_merge_fields();
151 + }
63 152
64 - if (get_option('mc_list_id') && get_option('mc_merge_field_migrate') != true && mailchimpSF_get_api() !== false) {
65 - mailchimpSF_update_merge_fields(get_option('mc_list_id'));
66 - }
67 -
68 - // Bring in our appropriate JS and CSS resources
69 - mailchimpSF_load_resources();
153 + if ( mailchimp_sf_should_display_form() ) {
154 + // Bring in our appropriate JS and CSS resources
155 + add_action( 'wp_enqueue_scripts', 'mailchimp_sf_load_resources' );
156 + }
70 157 }
71 158
72 -add_action( 'init', 'mailchimpSF_plugin_init' );
159 +add_action( 'init', 'mailchimp_sf_plugin_init' );
73 160
74 -
75 161 /**
76 - * Add the settings link to the MailChimp plugin row
162 + * Add the settings link to the Mailchimp plugin row
77 163 *
78 164 * @param array $links - Links for the plugin
79 165 * @return array - Links
80 166 */
81 -function mailchimpSD_plugin_action_links($links) {
82 - $settings_page = add_query_arg(array('page' => 'mailchimpSF_options'), admin_url('options-general.php'));
83 - $settings_link = '<a href="'.esc_url($settings_page).'">'.__('Settings', 'mailchimp_i18n' ).'</a>';
84 - array_unshift($links, $settings_link);
85 - return $links;
167 +function mailchimp_sf_plugin_action_links( $links ) {
168 + $settings_page = add_query_arg( array( 'page' => 'mailchimp_sf_options' ), admin_url( 'admin.php' ) );
169 + $settings_link = '<a href="' . esc_url( $settings_page ) . '">' . esc_html__( 'Settings', 'mailchimp' ) . '</a>';
170 + array_unshift( $links, $settings_link );
171 + return $links;
86 172 }
87 -add_filter('plugin_action_links_'.plugin_basename(__FILE__), 'mailchimpSD_plugin_action_links', 10, 1);
88 173
174 +add_filter( 'plugin_action_links_' . plugin_basename( __FILE__ ), 'mailchimp_sf_plugin_action_links', 10, 1 );
175 +
89 176 /**
90 177 * Loads the appropriate JS and CSS resources depending on
91 178 * settings and context (admin or not)
92 179 *
@@ -91,257 +178,158 @@
91 178 * settings and context (admin or not)
92 179 *
93 180 * @return void
94 181 */
95 -function mailchimpSF_load_resources() {
96 - // JS
97 - if (get_option('mc_use_javascript') == 'on') {
98 - if (!is_admin()) {
99 - wp_enqueue_script('jquery_scrollto', MCSF_URL.'js/scrollTo.js', array('jquery'), MCSF_VER);
100 - wp_enqueue_script('mailchimpSF_main_js', MCSF_URL.'js/mailchimp.js', array('jquery', 'jquery-form'), MCSF_VER);
101 - // some javascript to get ajax version submitting to the proper location
102 - global $wp_scripts;
103 - $wp_scripts->localize('mailchimpSF_main_js', 'mailchimpSF', array(
104 - 'ajax_url' => trailingslashit(home_url()),
105 - ));
106 - }
107 - }
182 +function mailchimp_sf_load_resources() {
183 + // JS
184 + wp_enqueue_script( 'mailchimp_sf_main_js', MCSF_URL . 'assets/js/mailchimp.js', array( 'jquery', 'jquery-form', 'jquery-ui-datepicker' ), MCSF_VER, true );
185 + // some javascript to get ajax version submitting to the proper location
186 + global $wp_scripts;
187 + $localize_data = array(
188 + 'ajax_url' => trailingslashit( home_url() ),
189 + 'phone_validation_error' => esc_html__( 'Please enter a valid phone number.', 'mailchimp' ),
190 + );
108 191
109 - if (get_option('mc_use_datepicker') == 'on' && !is_admin()) {
110 - // Datepicker theme
111 - wp_enqueue_style('flick', MCSF_URL.'css/flick/flick.css'
112 - );
113 - // Datepicker JS
114 - wp_enqueue_script('datepicker', MCSF_URL.'js/datepicker.js', array('jquery','jquery-ui-core'));
115 - }
192 + if ( ! is_admin() ) {
193 + $localize_data['analytics_ajax_url'] = admin_url( 'admin-ajax.php' );
194 + $localize_data['analytics_nonce'] = wp_create_nonce( 'mailchimp_sf_analytics_nonce' );
195 + }
116 196
117 - if(get_option('mc_nuke_all_styles') != true) {
118 - wp_enqueue_style('mailchimpSF_main_css', home_url('?mcsf_action=main_css&ver='.MCSF_VER, 'relative'));
119 - wp_enqueue_style('mailchimpSF_ie_css', MCSF_URL.'css/ie.css');
120 - global $wp_styles;
121 - $wp_styles->add_data( 'mailchimpSF_ie_css', 'conditional', 'IE' );
122 - }
197 + $wp_scripts->localize(
198 + 'mailchimp_sf_main_js',
199 + 'mailchimpSF',
200 + $localize_data
201 + );
202 +
203 + // Datepicker theme
204 + wp_enqueue_style( 'flick', MCSF_URL . 'assets/css/flick/flick.css', array(), MCSF_VER );
205 +
206 + // CSS
207 + if ( get_option( 'mc_nuke_all_styles' ) !== '1' ) {
208 + wp_enqueue_style( 'mailchimp_sf_main_css', MCSF_URL . 'assets/css/frontend.css', array(), MCSF_VER );
209 +
210 + // Backwards compatibility. TODO: Remove this in a future version.
211 + if ( get_option( 'mc_custom_style' ) === 'on' ) {
212 + $custom_css = mailchimp_sf_custom_style_css();
213 + wp_add_inline_style( 'mailchimp_sf_main_css', $custom_css );
214 + }
215 + }
123 216 }
124 217
218 +/**
219 + * Custom styles CSS
220 + *
221 + * @return string
222 + */
223 +function mailchimp_sf_custom_style_css() {
224 + ob_start();
225 + ?>
226 + .mc_signup_form {
227 + padding:5px;
228 + border-width: <?php echo absint( get_option( 'mc_form_border_width' ) ); ?>px;
229 + border-style: <?php echo ( get_option( 'mc_form_border_width' ) === 0 ) ? 'none' : 'solid'; ?>;
230 + border-color: #<?php echo esc_attr( get_option( 'mc_form_border_color' ) ); ?>;
231 + color: #<?php echo esc_attr( get_option( 'mc_form_text_color' ) ); ?>;
232 + background-color: #<?php echo esc_attr( get_option( 'mc_form_background' ) ); ?>;
233 + }
234 + <?php
235 + return ob_get_clean();
236 +}
125 237
126 238 /**
127 - * Loads resources for the MailChimp admin page
239 + * Request handler
128 240 *
129 241 * @return void
130 242 */
131 -function mc_admin_page_load_resources() {
132 - wp_enqueue_style('mailchimpSF_admin_css', MCSF_URL.'css/admin.css');
133 -}
134 -add_action('load-settings_page_mailchimpSF_options', 'mc_admin_page_load_resources');
243 +function mailchimp_sf_request_handler() {
244 + if ( isset( $_POST['mcsf_action'] ) ) {
245 + switch ( $_POST['mcsf_action'] ) {
246 + case 'logout':
247 + // Check capability & Verify nonce
248 + if (
249 + ! current_user_can( MCSF_CAP_THRESHOLD ) ||
250 + ! isset( $_POST['_mcsf_nonce_action'] ) ||
251 + ! wp_verify_nonce( sanitize_key( $_POST['_mcsf_nonce_action'] ), 'mc_logout' )
252 + ) {
253 + wp_die( 'Cheatin&rsquo; huh?' );
254 + }
135 255
256 + // erase auth information
257 + $options = array( 'mc_api_key', 'mailchimp_sf_access_token', 'mc_datacenter', 'mailchimp_sf_auth_error', 'mailchimp_sf_waiting_for_login' );
258 + mailchimp_sf_delete_options( $options );
259 + break;
260 + case 'change_form_settings':
261 + if (
262 + ! current_user_can( MCSF_CAP_THRESHOLD ) ||
263 + ! isset( $_POST['_mcsf_nonce_action'] ) ||
264 + ! wp_verify_nonce( sanitize_key( $_POST['_mcsf_nonce_action'] ), 'update_general_form_settings' )
265 + ) {
266 + wp_die( 'Cheatin&rsquo; huh?' );
267 + }
136 268
137 -/**
138 - * Loads jQuery Datepicker for the date-pick class
139 - **/
140 -function mc_datepicker_load() {
141 - require_once(MCSF_DIR . '/views/datepicker.php');
269 + // Update the form settings
270 + mailchimp_sf_save_general_form_settings();
271 + break;
272 + }
273 + }
142 274 }
143 -if (get_option('mc_use_datepicker') == 'on' && !is_admin()) {
144 - add_action('wp_head', 'mc_datepicker_load');
145 -}
275 +add_action( 'init', 'mailchimp_sf_request_handler' );
146 276
147 277 /**
148 - * Handles requests that as light-weight a load as possible.
149 - * typically, JS or CSS
150 - **/
151 -function mailchimpSF_early_request_handler() {
152 - if (isset($_GET['mcsf_action'])) {
153 - switch ($_GET['mcsf_action']) {
154 - case 'main_css':
155 - header("Content-type: text/css");
156 - mailchimpSF_main_css();
157 - exit;
158 - }
159 - }
278 + * Update merge fields
279 + *
280 + * @return void
281 + */
282 +function mailchimp_sf_update_merge_fields() {
283 + mailchimp_sf_get_merge_vars( get_option( 'mc_list_id' ), true );
284 + mailchimp_sf_get_interest_categories( get_option( 'mc_list_id' ), true );
285 + update_option( 'mc_merge_field_migrate', true );
160 286 }
161 -add_action('init', 'mailchimpSF_early_request_handler', 0);
162 287
163 288 /**
164 - * Outputs the front-end CSS. This checks several options, so it
165 - * was best to put it in a Request-handled script, as opposed to
166 - * a static file.
289 + * Get auth key
290 + *
291 + * @param mixed $salt Salt
292 + * @return string
167 293 */
168 -function mailchimpSF_main_css() {
169 - require_once(MCSF_DIR . '/views/css/frontend.php');
294 +function mailchimp_sf_auth_nonce_key( $salt = null ) {
295 + if ( is_null( $salt ) ) {
296 + $salt = mailchimp_sf_auth_nonce_salt();
297 + }
298 + return 'social_authentication' . md5( AUTH_KEY . $salt );
170 299 }
171 300
172 -
173 301 /**
174 - * Add our settings page to the admin menu
302 + * Return auth nonce salt
175 303 *
176 - * @return void
304 + * @return string
177 305 */
178 -function mailchimpSF_add_pages(){
179 - // Add settings page for users who can edit plugins
180 - add_options_page( __( 'MailChimp Setup', 'mailchimp_i18n' ), __( 'MailChimp Setup', 'mailchimp_i18n' ), MCSF_CAP_THRESHOLD, 'mailchimpSF_options', 'mailchimpSF_setup_page');
306 +function mailchimp_sf_auth_nonce_salt() {
307 + return md5( microtime() . isset( $_SERVER['SERVER_ADDR'] ) ? sanitize_text_field( wp_unslash( $_SERVER['SERVER_ADDR'] ) ) : '' );
181 308 }
182 -add_action('admin_menu', 'mailchimpSF_add_pages');
183 309
184 -function mailchimpSF_request_handler() {
185 - if (isset($_POST['mcsf_action'])) {
186 - switch ($_POST['mcsf_action']) {
187 - case 'login':
188 - if (
189 - ! current_user_can( MCSF_CAP_THRESHOLD ) ||
190 - ! isset( $_POST['_mcsf_nonce_action'] ) ||
191 - ! wp_verify_nonce( sanitize_text_field( wp_unslash( $_POST['_mcsf_nonce_action'] ) ), 'mc_login' )
192 - ) {
193 - wp_die('Security check failed.');
194 - }
195 -
196 - $key = trim($_POST['mailchimpSF_api_key']);
197 -
198 - try {
199 - $api = new MailChimp_API($key);
200 - } catch (Exception $e) {
201 - $msg = "<strong class='mc_error_msg'>" . $e->getMessage() . "</strong>";
202 - mailchimpSF_global_msg($msg);
203 - break;
204 - }
205 -
206 - $key = mailchimpSF_verify_key($api);
207 - if(is_wp_error($key)) {
208 - $msg = "<strong class='mc_error_msg'>" . $key->get_error_message() . "</strong>";
209 - mailchimpSF_global_msg($msg);
210 - }
211 -
212 - break;
213 - case 'logout':
214 - // Check capability & Verify nonce
215 - if (!current_user_can(MCSF_CAP_THRESHOLD) || !wp_verify_nonce($_POST['_mcsf_nonce_action'], 'mc_logout')) {
216 - wp_die('Cheatin&rsquo; huh?');
217 - }
218 -
219 - // erase auth information
220 - $options = array('mc_api_key', 'mc_sopresto_user', 'mc_sopresto_public_key', 'mc_sopresto_secret_key');
221 - mailchimpSF_delete_options($options);
222 - break;
223 - case 'change_form_settings':
224 - if (!current_user_can(MCSF_CAP_THRESHOLD) || !wp_verify_nonce($_POST['_mcsf_nonce_action'], 'update_general_form_settings')) {
225 - wp_die('Cheatin&rsquo; huh?');
226 - }
227 -
228 - // Update the form settings
229 - mailchimpSF_save_general_form_settings();
230 - break;
231 - case 'mc_submit_signup_form':
232 - // Validate nonce
233 - if (!wp_verify_nonce($_POST['_mc_submit_signup_form_nonce'], 'mc_submit_signup_form')) {
234 - wp_die('Cheatin&rsquo; huh?');
235 - }
236 -
237 - // Attempt the signup
238 - mailchimpSF_signup_submit();
239 -
240 - // Do a different action for html vs. js
241 - switch ($_POST['mc_submit_type']) {
242 - case 'html':
243 - /* This gets set elsewhere! */
244 - break;
245 - case 'js':
246 - if (!headers_sent()){ //just in case...
247 - header('Last-Modified: '.gmdate('D, d M Y H:i:s').' GMT', true, 200);
248 - }
249 - echo mailchimpSF_global_msg(); // Don't esc_html this, b/c we've already escaped it
250 - exit;
251 - }
252 - }
253 - }
254 -}
255 -add_action('init', 'mailchimpSF_request_handler');
256 -
257 -function mailchimpSF_migrate_sopresto() {
258 - $sopresto = get_option('mc_sopresto_secret_key');
259 - if(!$sopresto) {
260 - return;
261 - }
262 -
263 - // Talk to Sopresto, make exchange, delete old sopresto things.
264 - $body = array(
265 - 'public_key' => get_option('mc_sopresto_public_key'),
266 - 'hash' => sha1(get_option('mc_sopresto_public_key').get_option('mc_sopresto_secret_key'))
267 - );
268 -
269 - $url = 'https://sopresto.socialize-this.com/mailchimp/exchange';
270 - $args = array(
271 - 'method' => 'POST',
272 - 'timeout' => 500,
273 - 'redirection' => 5,
274 - 'httpversion' => '1.0',
275 - 'user-agent' => 'MailChimp WordPress Plugin/' . get_bloginfo( 'url' ),
276 - 'body' => $body
277 - );
278 -
279 - //post to sopresto
280 - $key = wp_remote_post($url, $args);
281 - if(!is_wp_error($key) && $key['response']['code'] == 200) {
282 - $key = json_decode($key['body']);
283 - try {
284 - $api = new MailChimp_API($key->response);
285 - } catch (Exception $e) {
286 - $msg = "<strong class='mc_error_msg'>" . $e->getMessage() . "</strong>";
287 - mailchimpSF_global_msg($msg);
288 - return;
289 - }
290 -
291 - $verify = mailchimpSF_verify_key($api);
292 -
293 - //something went wrong with the key that we had
294 - if(is_wp_error($verify)) {
295 - return;
296 - }
297 -
298 - delete_option('mc_sopresto_public_key');
299 - delete_option('mc_sopresto_secret_key');
300 - delete_option('mc_sopresto_user');
301 -
302 - return;
303 - }
304 -
305 - // Nothing to do here.
306 - return;
307 -}
308 -
309 -function mailchimpSF_update_merge_fields($list_id)
310 -{
311 - mailchimpSF_get_merge_vars(get_option('mc_list_id'), true);
312 - mailchimpSF_get_interest_categories(get_option('mc_list_id'), true);
313 - update_option('mc_merge_field_migrate', true);
314 -}
315 -
316 -function mailchimpSF_auth_nonce_key($salt = null) {
317 - if (is_null($salt)) {
318 - $salt = mailchimpSF_auth_nonce_salt();
319 - }
320 - return 'social_authentication' . md5( AUTH_KEY . $salt );
321 -}
322 -
323 -function mailchimpSF_auth_nonce_salt() {
324 - return md5(microtime().$_SERVER['SERVER_ADDR']);
325 -}
326 -
327 310 /**
328 - * Creates new MailChimp API v3 object
311 + * Creates new Mailchimp API v3 object
329 312 *
330 313 * @return MailChimp_API | false
331 314 */
315 +function mailchimp_sf_get_api() {
316 + // Check for the access token first.
317 + $access_token = mailchimp_sf_get_access_token();
318 + $data_center = get_option( 'mc_datacenter' );
319 + if ( ! empty( $access_token ) && ! empty( $data_center ) ) {
320 + return new MailChimp_API( $access_token, $data_center );
321 + }
332 322
333 -function mailchimpSF_get_api($force = false) {
334 - $key = get_option('mc_api_key');
335 - if($key) {
336 - return new MailChimp_API($key);
337 - }
323 + // Check for the API key if the access token is not available.
324 + $key = get_option( 'mc_api_key' );
325 + if ( $key ) {
326 + return new MailChimp_API( $key );
327 + }
338 328
339 - return false;
329 + return false;
340 330 }
341 331
342 -
343 -
344 332 /**
345 333 * Checks to see if we're storing a password, if so, we need
346 334 * to upgrade to the API key
347 335 *
@@ -346,92 +334,117 @@
346 334 * to upgrade to the API key
347 335 *
348 336 * @return bool
349 337 **/
350 -function mailchimpSF_needs_upgrade() {
351 - $igs = get_option('mc_interest_groups');
338 +function mailchimp_sf_needs_upgrade() {
339 + $igs = get_option( 'mc_interest_groups' );
352 340
353 - if ($igs !== false // we have an option
354 - && (
355 - empty($igs) || // it can be an empty array (no interest groups)
356 - (is_array($igs) && isset($igs[0]['id'])) // OR it should be a populated array that's well-formed
357 - )) {
358 - return false; // no need to upgrade
359 - }
360 - else {
361 - return true; // yeah, let's do it
362 - }
341 + if ( false !== $igs // we have an option
342 + && (
343 + empty( $igs ) || // it can be an empty array (no interest groups)
344 + ( is_array( $igs ) && isset( $igs[0]['id'] ) ) // OR it should be a populated array that's well-formed
345 + )
346 + ) {
347 + return false; // no need to upgrade
348 + } else {
349 + return true; // yeah, let's do it
350 + }
363 351 }
364 352
365 353 /**
366 - * Deletes all mailchimp options
354 + * Deletes all Mailchimp options
355 + *
356 + * TODO: The options names should be moved to a config file
357 + * or to a class dedicated to options
367 358 **/
368 -function mailchimpSF_delete_setup() {
369 - $options = array('mc_user_id', 'mc_sopresto_user', 'mc_sopresto_public_key', 'mc_sopresto_secret_key', 'mc_rewards', 'mc_use_javascript', 'mc_use_datepicker', 'mc_use_unsub_link', 'mc_list_id', 'mc_list_name', 'mc_interest_groups', 'mc_merge_vars');
359 +function mailchimp_sf_delete_setup() {
360 + $options = array(
361 + 'mc_user_id',
362 + 'mc_use_unsub_link',
363 + 'mc_list_id',
364 + 'mc_list_name',
365 + 'mc_interest_groups',
366 + 'mc_merge_vars',
367 + );
370 368
371 - $igs = get_option('mc_interest_groups');
372 - if (is_array($igs)) {
373 - foreach ($igs as $ig) {
374 - $opt = 'mc_show_interest_groups_'.$ig['id'];
375 - $options[] = $opt;
376 - }
377 - }
369 + $igs = get_option( 'mc_interest_groups' );
370 + if ( is_array( $igs ) ) {
371 + foreach ( $igs as $ig ) {
372 + $opt = 'mc_show_interest_groups_' . $ig['id'];
373 + $options[] = $opt;
374 + }
375 + }
378 376
379 - $mv = get_option('mc_merge_vars');
380 - if (is_array($mv)){
381 - foreach($mv as $var){
382 - $opt = 'mc_mv_'.$var['tag'];
383 - $options[] = $opt;
384 - }
385 - }
386 -
387 - mailchimpSF_delete_options($options);
377 + $mv = get_option( 'mc_merge_vars' );
378 + if ( is_array( $mv ) ) {
379 + foreach ( $mv as $mv_var ) {
380 + $opt = 'mc_mv_' . $mv_var['tag'];
381 + $options[] = $opt;
382 + }
383 + }
384 +
385 + mailchimp_sf_delete_options( $options );
388 386 }
389 387
390 388 /**
391 - * Gets or sets a global message based on parameter passed to it
389 + * Gets or sets a frontend message based on parameter passed to it
392 390 *
391 + * Used to convey error messages to the user outside of the WP Admin
392 + *
393 + * On the plugin settings page, WP admin notices are used exclusively
394 + * instead of the frontend message.
395 + *
396 + * @param mixed $msg Message
393 397 * @return string/bool depending on get/set
394 - **/
395 -function mailchimpSF_global_msg($msg = null) {
396 - global $mcsf_msgs;
398 + */
399 +function mailchimp_sf_frontend_msg( $msg = null ) {
400 + global $mcsf_msgs;
397 401
398 - // Make sure we're formed properly
399 - if (!is_array($mcsf_msgs)) {
400 - $mcsf_msgs = array();
401 - }
402 + // Make sure we're formed properly
403 + if ( ! is_array( $mcsf_msgs ) ) {
404 + $mcsf_msgs = array();
405 + }
402 406
403 - // See if we're getting
404 - if (is_null($msg)) {
405 - return implode('', $mcsf_msgs);
406 - }
407 + // See if we're getting
408 + if ( is_null( $msg ) ) {
409 + return implode( '', $mcsf_msgs );
410 + }
407 411
408 - // Must be setting
409 - $mcsf_msgs[] = $msg;
410 - return true;
412 + // Must be setting
413 + $mcsf_msgs[] = $msg;
414 + return true;
411 415 }
412 416
413 417 /**
418 + * Gets or sets a frontend message based on parameter passed to it
419 + *
420 + * TODO: Deprecate this function in favor of mailchimp_sf_frontend_msg()
421 + *
422 + * @param mixed $msg Message
423 + * @return string/bool depending on get/set
424 + */
425 +function mailchimp_sf_global_msg( $msg = null ) {
426 + return mailchimp_sf_frontend_msg( $msg );
427 +}
428 +
429 +/**
414 430 * Sets the default options for the option form
415 - **/
416 -function mailchimpSF_set_form_defaults($list_name = '') {
417 - update_option('mc_header_content',__( 'Sign up for', 'mailchimp_i18n' ).' '.$list_name);
418 - update_option('mc_submit_text',__( 'Subscribe', 'mailchimp_i18n' ));
431 + *
432 + * @param string $list_name The Mailchimp list name.
433 + * @return void
434 + */
435 +function mailchimp_sf_set_form_defaults( $list_name = '' ) {
436 + update_option( 'mc_header_content', esc_html__( 'Sign up for', 'mailchimp' ) . ' ' . $list_name );
437 + update_option( 'mc_submit_text', esc_html__( 'Subscribe', 'mailchimp' ) );
419 438
420 - update_option('mc_use_datepicker', 'on');
421 - update_option('mc_custom_style','off');
422 - update_option('mc_use_javascript','on');
423 - update_option('mc_double_optin', true);
424 - update_option('mc_use_unsub_link','off');
425 - update_option('mc_header_border_width','1');
426 - update_option('mc_header_border_color','E3E3E3');
427 - update_option('mc_header_background','FFFFFF');
428 - update_option('mc_header_text_color','CC6600');
439 + update_option( 'mc_custom_style', 'off' );
440 + update_option( 'mc_double_optin', true );
441 + update_option( 'mc_use_unsub_link', 'off' );
429 442
430 - update_option('mc_form_border_width','1');
431 - update_option('mc_form_border_color','E0E0E0');
432 - update_option('mc_form_background','FFFFFF');
433 - update_option('mc_form_text_color','3F3F3f');
443 + update_option( 'mc_form_border_width', '1' );
444 + update_option( 'mc_form_border_color', 'E0E0E0' );
445 + update_option( 'mc_form_background', 'FFFFFF' );
446 + update_option( 'mc_form_text_color', '3F3F3f' );
434 447 }
435 448
436 449 /**
437 450 * Saves the General Form settings on the options page
@@ -437,151 +450,117 @@
437 450 * Saves the General Form settings on the options page
438 451 *
439 452 * @return void
440 453 **/
441 -function mailchimpSF_save_general_form_settings() {
454 +function mailchimp_sf_save_general_form_settings() {
455 + // phpcs:disable WordPress.Security.NonceVerification.Missing -- Nonce check is already done in the mailchimp_sf_request_handler() function.
456 + /*Enable double optin toggle*/
457 + if ( isset( $_POST['mc_double_optin'] ) ) {
458 + update_option( 'mc_double_optin', true );
459 + $msg = esc_html__( 'Double opt-in turned On!', 'mailchimp' );
460 + admin_notice_success( $msg );
461 + } elseif ( get_option( 'mc_double_optin' ) !== false ) {
462 + update_option( 'mc_double_optin', false );
463 + $msg = esc_html__( 'Double opt-in turned Off!', 'mailchimp' );
464 + admin_notice_success( $msg );
465 + }
442 466
443 - // IF NOT DEV MODE
444 - if (isset($_POST['mc_rewards'])){
445 - update_option('mc_rewards', 'on');
446 - $msg = '<p class="success_msg">'.__('Monkey Rewards turned On!', 'mailchimp_i18n').'</p>';
447 - mailchimpSF_global_msg($msg);
448 - } else if (get_option('mc_rewards')!='off') {
449 - update_option('mc_rewards', 'off');
450 - $msg = '<p class="success_msg">'.__('Monkey Rewards turned Off!', 'mailchimp_i18n').'</p>';
451 - mailchimpSF_global_msg($msg);
452 - }
453 - if (isset($_POST['mc_use_javascript'])){
454 - update_option('mc_use_javascript', 'on');
455 - $msg = '<p class="success_msg">'.__('Fancy Javascript submission turned On!', 'mailchimp_i18n').'</p>';
456 - mailchimpSF_global_msg($msg);
457 - } else if (get_option('mc_use_javascript')!='off') {
458 - update_option('mc_use_javascript', 'off');
459 - $msg = '<p class="success_msg">'.__('Fancy Javascript submission turned Off!', 'mailchimp_i18n').'</p>';
460 - mailchimpSF_global_msg($msg);
461 - }
467 + /* NUKE the CSS! */
468 + if ( isset( $_POST['mc_nuke_all_styles'] ) ) {
469 + update_option( 'mc_nuke_all_styles', true );
470 + $msg = esc_html__( 'Mailchimp CSS turned Off!', 'mailchimp' );
471 + admin_notice_success( $msg );
472 + } elseif ( get_option( 'mc_nuke_all_styles' ) !== false ) {
473 + update_option( 'mc_nuke_all_styles', false );
474 + $msg = esc_html__( 'Mailchimp CSS turned On!', 'mailchimp' );
475 + admin_notice_success( $msg );
476 + }
462 477
463 - if (isset($_POST['mc_use_datepicker'])){
464 - update_option('mc_use_datepicker', 'on');
465 - $msg = '<p class="success_msg">'.__('Datepicker turned On!', 'mailchimp_i18n').'</p>';
466 - mailchimpSF_global_msg($msg);
467 - } else if (get_option('mc_use_datepicker')!='off') {
468 - update_option('mc_use_datepicker', 'off');
469 - $msg = '<p class="success_msg">'.__('Datepicker turned Off!', 'mailchimp_i18n').'</p>';
470 - mailchimpSF_global_msg($msg);
471 - }
478 + /* Update existing */
479 + if ( isset( $_POST['mc_update_existing'] ) ) {
480 + update_option( 'mc_update_existing', true );
481 + $msg = esc_html__( 'Update existing subscribers turned On!', 'mailchimp' );
482 + admin_notice_success( $msg );
483 + } elseif ( get_option( 'mc_update_existing' ) !== false ) {
484 + update_option( 'mc_update_existing', false );
485 + $msg = esc_html__( 'Update existing subscribers turned Off!', 'mailchimp' );
486 + admin_notice_success( $msg );
487 + }
472 488
473 - /*Enable double optin toggle*/
474 -
475 - if(isset($_POST['mc_double_optin'])) {
476 - update_option('mc_double_optin', true);
477 - $msg = '<p class="success_msg">'.__('Double opt-in turned On!', 'mailchimp_i18n').'</p>';
478 - mailchimpSF_global_msg($msg);
479 - } else if (get_option('mc_double_optin') != false) {
480 - update_option('mc_double_optin', false);
481 - $msg = '<p class="success_msg">'.__('Double opt-in turned Off!', 'mailchimp_i18n').'</p>';
482 - mailchimpSF_global_msg($msg);
483 - }
489 + if ( isset( $_POST['mc_use_unsub_link'] ) ) {
490 + update_option( 'mc_use_unsub_link', 'on' );
491 + $msg = esc_html__( 'Unsubscribe link turned On!', 'mailchimp' );
492 + admin_notice_success( $msg );
493 + } elseif ( get_option( 'mc_use_unsub_link' ) !== 'off' ) {
494 + update_option( 'mc_use_unsub_link', 'off' );
495 + $msg = esc_html__( 'Unsubscribe link turned Off!', 'mailchimp' );
496 + admin_notice_success( $msg );
497 + }
484 498
485 - /* NUKE the CSS! */
486 - if(isset($_POST['mc_nuke_all_styles'])) {
487 - update_option('mc_nuke_all_styles', true);
488 - $msg = '<p class="success_msg">'.__('MailChimp CSS turned Off!', 'mailchimp_i18n').'</p>';
489 - mailchimpSF_global_msg($msg);
490 - }elseif (get_option('mc_nuke_all_styles') !== false) {
491 - update_option('mc_nuke_all_styles', false);
492 - $msg = '<p class="success_msg">'.__('MailChimp CSS turned On!', 'mailchimp_i18n').'</p>';
493 - mailchimpSF_global_msg($msg);
494 - }
499 + $content = isset( $_POST['mc_header_content'] ) ? wp_kses_post( wp_unslash( $_POST['mc_header_content'] ) ) : '';
500 + $content = str_replace( "\r\n", '<br/>', $content );
501 + update_option( 'mc_header_content', $content );
495 502
496 - /* Update existing */
497 - if (isset($_POST['mc_update_existing'])) {
498 - update_option('mc_update_existing', true);
499 - $msg = '<p class="success_msg">' . __('Update existing subscribers turned On!') . '</p>';
500 - mailchimpSF_global_msg($msg);
501 - } elseif (get_option('mc_update_existing') ==! false) {
502 - update_option('mc_update_existing', false);
503 - $msg = '<p class="success_msg">' . __('Update existing subscribers turned Off!') . '</p>';
504 - mailchimpSF_global_msg($msg);
505 - }
503 + $content = isset( $_POST['mc_subheader_content'] ) ? wp_kses_post( wp_unslash( $_POST['mc_subheader_content'] ) ) : '';
504 + $content = str_replace( "\r\n", '<br/>', $content );
505 + update_option( 'mc_subheader_content', $content );
506 506
507 - if (isset($_POST['mc_use_unsub_link'])){
508 - update_option('mc_use_unsub_link', 'on');
509 - $msg = '<p class="success_msg">'.__('Unsubscribe link turned On!', 'mailchimp_i18n').'</p>';
510 - mailchimpSF_global_msg($msg);
511 - }
507 + $submit_text = isset( $_POST['mc_submit_text'] ) ? sanitize_text_field( wp_unslash( $_POST['mc_submit_text'] ) ) : '';
508 + $submit_text = str_replace( "\r\n", '', $submit_text );
509 + update_option( 'mc_submit_text', $submit_text );
512 510
513 - elseif (get_option('mc_use_unsub_link')!='off') {
514 - update_option('mc_use_unsub_link', 'off');
515 - $msg = '<p class="success_msg">'.__('Unsubscribe link turned Off!', 'mailchimp_i18n').'</p>';
516 - mailchimpSF_global_msg($msg);
517 - }
511 + // Set Custom Style option
512 + update_option( 'mc_custom_style', isset( $_POST['mc_custom_style'] ) ? 'on' : 'off' );
518 513
519 - $content = stripslashes($_POST['mc_header_content']);
520 - $content = str_replace("\r\n","<br/>", $content);
521 - update_option('mc_header_content', $content );
514 + // we told them not to put these things we are replacing in, but let's just make sure they are listening...
515 + if ( isset( $_POST['mc_form_border_width'] ) ) {
516 + update_option( 'mc_form_border_width', str_replace( 'px', '', absint( $_POST['mc_form_border_width'] ) ) );
517 + }
518 + if ( isset( $_POST['mc_form_border_color'] ) ) {
519 + update_option( 'mc_form_border_color', str_replace( '#', '', sanitize_text_field( wp_unslash( $_POST['mc_form_border_color'] ) ) ) );
520 + }
521 + if ( isset( $_POST['mc_form_background'] ) ) {
522 + update_option( 'mc_form_background', str_replace( '#', '', sanitize_text_field( wp_unslash( $_POST['mc_form_background'] ) ) ) );
523 + }
524 + if ( isset( $_POST['mc_form_text_color'] ) ) {
525 + update_option( 'mc_form_text_color', str_replace( '#', '', sanitize_text_field( wp_unslash( $_POST['mc_form_text_color'] ) ) ) );
526 + }
522 527
523 - $content = stripslashes($_POST['mc_subheader_content']);
524 - $content = str_replace("\r\n","<br/>", $content);
525 - update_option('mc_subheader_content', $content );
528 + // IF NOT DEV MODE
529 + $igs = get_option( 'mc_interest_groups' );
530 + if ( is_array( $igs ) ) {
531 + foreach ( $igs as $mv_var ) {
532 + $opt = 'mc_show_interest_groups_' . $mv_var['id'];
533 + if ( isset( $_POST[ $opt ] ) ) {
534 + update_option( $opt, 'on' );
535 + } else {
536 + update_option( $opt, 'off' );
537 + }
538 + }
539 + }
526 540
541 + $mv = get_option( 'mc_merge_vars' );
542 + if ( is_array( $mv ) ) {
543 + foreach ( $mv as $mv_var ) {
544 + $opt = 'mc_mv_' . $mv_var['tag'];
545 + if ( isset( $_POST[ $opt ] ) || true === (bool) $mv_var['required'] ) {
546 + update_option( $opt, 'on' );
547 + } else {
548 + update_option( $opt, 'off' );
549 + }
550 + }
551 + }
527 552
528 - $submit_text = stripslashes($_POST['mc_submit_text']);
529 - $submit_text = str_replace("\r\n","", $submit_text);
530 - update_option('mc_submit_text', $submit_text);
531 -
532 - // Set Custom Style option
533 - update_option('mc_custom_style', isset($_POST['mc_custom_style']) ? 'on' : 'off');
534 -
535 - //we told them not to put these things we are replacing in, but let's just make sure they are listening...
536 - if(isset($_POST['mc_form_border_width'])) {
537 - update_option('mc_form_border_width',str_replace('px', '', $_POST['mc_form_border_width']) );
538 - }
539 - if(isset($_POST['mc_form_border_color'])) {
540 - update_option('mc_form_border_color', str_replace('#', '', $_POST['mc_form_border_color']));
541 - }
542 - if(isset($_POST['mc_form_background'])){
543 - update_option('mc_form_background',str_replace('#', '', $_POST['mc_form_background']));
544 - }
545 - if(isset($_POST['mc_form_text_color'])) {
546 - update_option('mc_form_text_color', str_replace('#', '', $_POST['mc_form_text_color']));
547 - }
548 -
549 -
550 - // IF NOT DEV MODE
551 - $igs = get_option('mc_interest_groups');
552 - if (is_array($igs)) {
553 - foreach($igs as $var){
554 - $opt = 'mc_show_interest_groups_'.$var['id'];
555 - if (isset($_POST[$opt])){
556 - update_option($opt,'on');
557 - } else {
558 - update_option($opt,'off');
559 - }
560 - }
561 - }
562 -
563 - $mv = get_option('mc_merge_vars');
564 - if (is_array($mv)) {
565 - foreach($mv as $var){
566 - $opt = 'mc_mv_'.$var['tag'];
567 - if (isset($_POST[$opt]) || $var['required']=='Y'){
568 - update_option($opt,'on');
569 - } else {
570 - update_option($opt,'off');
571 - }
572 - }
573 - }
574 -
575 - $msg = '<p class="success_msg">'.esc_html(__('Successfully Updated your List Subscribe Form Settings!', 'mailchimp_i18n')).'</p>';
576 - mailchimpSF_global_msg($msg);
553 + $msg = esc_html__( 'Successfully Updated your List Subscribe Form Settings!', 'mailchimp' );
554 + admin_notice_success( $msg );
555 + // phpcs:enable WordPress.Security.NonceVerification.Missing
577 556 }
578 557
579 558 /**
580 559 * Sees if the user changed the list, and updates options accordingly
581 560 **/
582 -function mailchimpSF_change_list_if_necessary() {
583 - if ( ! isset( $_POST['mc_list_id'] ) ) {
561 +function mailchimp_sf_change_list_if_necessary() {
562 + if ( ! isset( $_POST['mc_list_id'] ) ) {
584 563 return;
585 564 }
586 565
587 566 if (
@@ -591,548 +570,364 @@
591 570 ) {
592 571 wp_die( 'Security check failed.' );
593 572 }
594 573
595 - $api = mailchimpSF_get_api();
596 - if (!$api) { return; }
574 + if ( empty( $_POST['mc_list_id'] ) ) {
575 + $msg = esc_html__( 'Please choose a valid list', 'mailchimp' );
576 + admin_notice_error( $msg );
577 + return;
578 + }
597 579
598 - //we *could* support paging, but few users have that many lists (and shouldn't)
599 - $lists = $api->get('lists',100, array('fields' => 'lists.id,lists.name,lists.email_type_option'));
580 + $lists = mailchimp_sf_get_lists();
581 + if ( is_wp_error( $lists ) || ! isset( $lists['lists'] ) ) {
582 + return;
583 + }
600 584
601 - $lists = $lists['lists'];
585 + $lists = $lists['lists'];
602 586
603 - if (is_array($lists) && !empty($lists) && isset($_POST['mc_list_id'])) {
587 + if ( is_array( $lists ) && ! empty( $lists ) ) {
604 588
605 - /* If our incoming list ID (the one chosen in the select dropdown)
606 - is in our array of lists, the set it to be the active list */
607 - foreach($lists as $key => $list) {
608 - if ($list['id'] == $_POST['mc_list_id']) {
609 - $list_id = $_POST['mc_list_id'];
610 - $list_name = $list['name'];
611 - $list_key = $key;
612 - }
613 - }
589 + /**
590 + * If our incoming list ID (the one chosen in the select dropdown)
591 + * is in our array of lists, the set it to be the active list
592 + */
593 + foreach ( $lists as $key => $list ) {
594 + if ( isset( $_POST['mc_list_id'] ) && $list['id'] === $_POST['mc_list_id'] ) {
595 + $list_id = sanitize_text_field( wp_unslash( $_POST['mc_list_id'] ) );
596 + $list_name = $list['name'];
597 + $list_key = $key;
598 + }
614 599
615 - $orig_list = get_option('mc_list_id');
616 - if ($list_id != '') {
617 - update_option('mc_list_id', $list_id);
618 - update_option('mc_list_name', $list_name);
619 - update_option('mc_email_type_option', $lists[$list_key]['email_type_option']);
600 + $merge_fields = mailchimp_sf_get_merge_vars( $list['id'], false, false );
601 + $interests = mailchimp_sf_get_interest_categories( $list['id'], false, false );
602 + if ( ! empty( $merge_fields ) ) {
603 + update_option( 'mailchimp_sf_merge_fields_' . $list['id'], $merge_fields );
604 + }
605 + if ( ! empty( $interests ) ) {
606 + update_option( 'mailchimp_sf_interest_groups_' . $list['id'], $interests );
607 + }
608 + }
620 609
610 + $orig_list = get_option( 'mc_list_id' );
611 + if ( '' !== $list_id ) {
612 + update_option( 'mc_list_id', $list_id );
613 + update_option( 'mc_list_name', $list_name );
614 + update_option( 'mc_email_type_option', $lists[ $list_key ]['email_type_option'] );
621 615
622 - // See if the user changed the list
623 - $new_list = false;
624 - if ($orig_list != $list_id){
625 - // The user changed the list, Reset the Form Defaults
626 - mailchimpSF_set_form_defaults($list_name);
627 -
628 - $new_list = true;
629 - }
630 - // email_type_option
616 + // See if the user changed the list
617 + $new_list = false;
618 + if ( $orig_list !== $list_id ) {
619 + // The user changed the list, Reset the Form Defaults
620 + mailchimp_sf_set_form_defaults( $list_name );
631 621
632 - // Grab the merge vars and interest groups
633 - $mv = mailchimpSF_get_merge_vars($list_id, $new_list);
634 - $igs = mailchimpSF_get_interest_categories($list_id, $new_list);
622 + $new_list = true;
623 + }
635 624
636 - $igs_text = ' ';
637 - if (is_array($igs)) {
638 - $igs_text .= sprintf(__('and %s Sets of Interest Groups', 'mailchimp_i18n'), count($igs));
639 - }
625 + // Grab the merge vars and interest groups
626 + $mv = mailchimp_sf_get_merge_vars( $list_id, $new_list );
627 + $igs = mailchimp_sf_get_interest_categories( $list_id, $new_list );
640 628
641 - $msg = '<p class="success_msg">'.
642 - sprintf(
643 - __('<b>Success!</b> Loaded and saved the info for %d Merge Variables', 'mailchimp_i18n').$igs_text,
644 - count($mv)
645 - ).' '.
646 - __('from your list').' "'.$list_name.'"<br/><br/>'.
647 - __('Now you should either Turn On the MailChimp Widget or change your options below, then turn it on.', 'mailchimp_i18n').'</p>';
648 - mailchimpSF_global_msg($msg);
649 - }
650 - }
651 -}
629 + $igs_text = ' ';
630 + if ( is_array( $igs ) ) {
631 + /* translators: %s: count (number) */
632 + $igs_text .= sprintf( esc_html__( 'and %s Sets of Interest Groups', 'mailchimp' ), count( $igs ) );
633 + }
652 634
653 -function mailchimpSF_get_merge_vars($list_id, $new_list) {
654 - $api = mailchimpSF_get_api();
655 - $mv = $api->get('lists/' . $list_id . '/merge-fields', 80);
656 -
657 - //if we get an error back from the api, exit this process.
658 - if(is_wp_error($mv)) {
659 - return;
660 - }
635 + $msg = sprintf(
636 + /* translators: %s: count (number) */
637 + __( '<b>Success!</b> Loaded and saved the info for %d Merge Variables', 'mailchimp' ) . $igs_text,
638 + count( $mv )
639 + ) . ' ' .
640 + esc_html__( 'from your list', 'mailchimp' ) . ' "' . $list_name . '"<br/><br/>' .
641 + esc_html__( 'Now you should either Turn On the Mailchimp Widget or change your options below, then turn it on.', 'mailchimp' );
661 642
662 - $mv['merge_fields'] = mailchimpSF_add_email_field($mv['merge_fields']);
663 - update_option('mc_merge_vars', $mv['merge_fields']);
664 - foreach($mv['merge_fields'] as $var){
665 - $opt = 'mc_mv_'.$var['tag'];
666 - //turn them all on by default
667 - if ($new_list) {
668 - update_option($opt, 'on' );
669 - }
670 - }
671 - return $mv['merge_fields'];
672 -}
643 + admin_notice_success( $msg );
644 + }
673 645
674 -function mailchimpSF_add_email_field($merge) {
675 -
676 - $email = array(
677 - 'tag' => 'EMAIL',
678 - 'name' => __('Email Address', 'mailchimp_i18n'),
679 - 'type' => 'email',
680 - 'required' => true,
681 - 'public' => true,
682 - 'display_order' => 1,
683 - 'default_value' => null
684 - );
685 - array_unshift($merge, $email);
686 - return $merge;
646 + // Update the lists option.
647 + update_option( 'mailchimp_sf_lists', $lists );
648 + }
687 649 }
688 650
689 -function mailchimpSF_get_interest_categories($list_id, $new_list) {
690 - $api = mailchimpSF_get_api();
691 - $igs = $api->get('lists/' . $list_id . '/interest-categories', 60);
651 +/**
652 + * Get merge vars
653 + *
654 + * @param string $list_id List ID
655 + * @param bool $new_list Whether this is a new list
656 + * @param bool $update_option Whether to update the option
657 + * @return array
658 + */
659 +function mailchimp_sf_get_merge_vars( $list_id, $new_list, $update_option = true ) {
660 + $api = mailchimp_sf_get_api();
661 + $mv = $api->get( 'lists/' . $list_id . '/merge-fields', 80 );
692 662
693 - //if we get an error back from the api, exis
694 - if(is_wp_error($igs)) {
695 - return;
696 - }
663 + // if we get an error back from the api, exit this process.
664 + if ( is_wp_error( $mv ) ) {
665 + return;
666 + }
697 667
698 - if (is_array($igs)) {
699 - $key = 0;
700 - foreach($igs['categories'] as $ig) {
701 - $groups = $api->get('lists/' . $list_id . '/interest-categories/' . $ig['id'] . '/interests', 60);
702 - $igs['categories'][$key]['groups'] = $groups['interests'];
703 - $opt = 'mc_show_interest_groups_'.$ig['id'];
668 + $mv['merge_fields'] = mailchimp_sf_add_email_field( $mv['merge_fields'] );
669 + if ( $update_option ) {
670 + update_option( 'mc_merge_vars', $mv['merge_fields'] );
671 + }
704 672
705 - //turn them all on by default
706 - if ($new_list) {
707 - update_option($opt, 'on' );
708 - }
709 - $key++;
710 - }
711 - }
712 - update_option('mc_interest_groups', $igs['categories']);
713 - return $igs['categories'];
673 + foreach ( $mv['merge_fields'] as $mv_var ) {
674 + $opt = 'mc_mv_' . $mv_var['tag'];
675 + if ( $new_list ) {
676 + $public = $mv_var['public'] ?? false;
677 + if ( ! $public ) {
678 + // This is a hidden field, so we don't want to include it.
679 + update_option( $opt, 'off' );
680 + } else {
681 + // We need to set the option to 'on' so that it shows up in the form.
682 + update_option( $opt, 'on' );
683 + }
684 + }
685 + }
686 + return $mv['merge_fields'];
714 687 }
715 688
716 -
717 689 /**
718 - * Outputs the Settings/Options page
690 + * Add email field
691 + *
692 + * @param array $merge Merge
693 + * @return array
719 694 */
720 -function mailchimpSF_setup_page() {
721 - $path = plugin_dir_path(__FILE__);
722 - wp_enqueue_script('showMe', MCSF_URL.'js/hidecss.js', array('jquery'), MCSF_VER);
723 - require_once($path.'/views/setup_page.php');
724 -}//mailchimpSF_setup_page()
725 -
726 -
727 -function mailchimpSF_register_widgets() {
728 - if (mailchimpSF_get_api()) {
729 - register_widget('mailchimpSF_Widget');
730 - }
695 +function mailchimp_sf_add_email_field( $merge ) {
696 + $email = array(
697 + 'tag' => 'EMAIL',
698 + 'name' => esc_html__( 'Email Address', 'mailchimp' ),
699 + 'type' => 'email',
700 + 'required' => true,
701 + 'public' => true,
702 + 'display_order' => 1,
703 + 'default_value' => null,
704 + );
705 + array_unshift( $merge, $email );
706 + return $merge;
731 707 }
732 -add_action('widgets_init', 'mailchimpSF_register_widgets');
733 708
734 -function mailchimpSF_shortcode($atts){
735 - ob_start();
736 - mailchimpSF_signup_form();
737 - return ob_get_clean();
738 -}
739 -add_shortcode('mailchimpsf_form', 'mailchimpSF_shortcode');
740 -
741 709 /**
742 - * Attempts to signup a user, per the $_POST args.
710 + * Get interest categories
743 711 *
744 - * This sets a global message, that is then used in the widget
745 - * output to retrieve and display that message.
746 - *
747 - * @return bool
712 + * @param string $list_id List ID
713 + * @param bool $new_list Whether this is a new list
714 + * @param bool $update_option Whether to update the option
715 + * @return array
748 716 */
749 -function mailchimpSF_signup_submit() {
750 - $mv = get_option('mc_merge_vars', array());
751 - $mv_tag_keys = array();
717 +function mailchimp_sf_get_interest_categories( $list_id, $new_list, $update_option = true ) {
718 + $api = mailchimp_sf_get_api();
719 + $igs = $api->get( 'lists/' . $list_id . '/interest-categories', 60 );
752 720
753 - $igs = get_option('mc_interest_groups', array());
721 + // if we get an error back from the api, exis
722 + if ( is_wp_error( $igs ) ) {
723 + return;
724 + }
754 725
755 - $listId = get_option('mc_list_id');
756 - $email = isset($_POST['mc_mv_EMAIL']) ? strip_tags(stripslashes($_POST['mc_mv_EMAIL'])) : '';
757 - $merge = $errs = $html_errs = array(); // Set up some vars
726 + if ( is_array( $igs ) ) {
727 + $key = 0;
728 + foreach ( $igs['categories'] as $ig ) {
729 + $groups = $api->get( 'lists/' . $list_id . '/interest-categories/' . $ig['id'] . '/interests', 60 );
730 + $igs['categories'][ $key ]['groups'] = $groups['interests'];
731 + $opt = 'mc_show_interest_groups_' . $ig['id'];
758 732
759 - $merge = mailchimpSF_merge_submit($mv);
760 -
761 - //Catch errors and fail early.
762 - if(is_wp_error($merge)) {
763 - $msg = "<strong class='mc_error_msg'>" . $merge->get_error_message() . "</strong>";
764 - mailchimpSF_global_msg($msg);
733 + // turn them all on by default
734 + if ( $new_list ) {
735 + update_option( $opt, 'on' );
736 + }
737 + ++$key;
738 + }
739 + }
765 740
766 - return false;
767 - }
741 + if ( $update_option ) {
742 + update_option( 'mc_interest_groups', $igs['categories'] );
743 + }
768 744
769 - // Head back to the beginning of the merge vars array
770 - reset($mv);
771 - // Ensure we have an array
772 - $igs = !is_array($igs) ? array() : $igs;
773 - $igs = mailchimpSF_groups_submit($igs);
774 -
775 - // Clear out empty merge vars
776 - $merge = mailchimpSF_merge_remove_empty($merge);
777 - if (isset($_POST['email_type']) && in_array($_POST['email_type'], array('text', 'html', 'mobile'))) {
778 - $email_type = $_POST['email_type'];
779 - }
780 - else {
781 - $email_type = 'html';
782 - }
783 -
784 - $api = mailchimpSF_get_api();
785 - if (!$api) {
786 - $url = mailchimpSF_signup_form_url();
787 - $error = '<strong class="mc_error_msg">'. __('We encountered a problem adding ' . $email . ' to the list. Please <a href="' . $url . '">sign up here.</a>') . '</strong>';
788 - mailchimpSF_global_msg($error);
789 - return false;
790 - }
791 -
792 - $url = 'lists/'. $listId . '/members/' . md5(strtolower($email));
793 - $status = mailchimpSF_check_status($url);
794 -
795 -
796 - // If update existing is turned off and the subscriber exists, error out.
797 - if (get_option('mc_update_existing') == false && $status === 'subscribed') {
798 - $msg = 'This email address is already subscribed to the list.';
799 - $error = new WP_Error('mailchimp-update-existing', $msg);
800 - mailchimpSF_global_msg('<strong class="mc_error_msg">' . $msg . '</strong>');
801 - return false;
802 - }
803 -
804 - $body = mailchimpSF_subscribe_body($merge, $igs, $email_type, $email, $status, get_option('mc_double_optin'));
805 - $retval = $api->post($url, $body, 'PUT');
806 -
807 - // If we have errors, then show them
808 - if(is_wp_error($retval)) {
809 - $msg = "<strong class='mc_error_msg'>" . $retval->get_error_message() . "</strong>";
810 - mailchimpSF_global_msg($msg);
811 - return false;
812 - }
813 -
814 - if($retval['status'] == 'subscribed') {
815 - $esc = __("Success, you've been signed up.", 'mailchimp_i18n');
816 - $msg = "<strong class='mc_success_msg'>{$esc}</strong>";
817 - } else {
818 - $esc = __("Success, you've been signed up! Please look for our confirmation email.", 'mailchimp_i18n');
819 - $msg = "<strong class='mc_success_msg'>{$esc}</strong>";
820 - }
821 -
822 - // Set our global message
823 - mailchimpSF_global_msg($msg);
824 -
825 - return true;
745 + return $igs['categories'];
826 746 }
827 747
828 - /*
829 - Cleans up merge fields and interests to make them
830 - API 3.0-friendly.
831 - */
832 -
833 -function mailchimpSF_subscribe_body($merge, $igs, $email_type, $email, $status, $double_optin)
834 -{
835 - $body = new stdClass();
836 - $body->email_address = $email;
837 - $body->email_type = $email_type;
838 - $body->merge_fields = $merge;
839 - if (!empty($igs)) {
840 - $body->interests = $igs;
841 - }
842 -
843 - if($status !== 'subscribed') {
844 - // single opt-in that covers new subscribers
845 - if (!$status && $double_optin == false) {
846 - $body->status = 'subscribed';
847 - } else {
848 - // anyone else
849 - $body->status = 'pending';
850 - }
851 - }
852 - return $body;
748 +/**
749 + * Register the widget.
750 + *
751 + * @return void
752 + */
753 +function mailchimp_sf_register_widgets() {
754 + if ( mailchimp_sf_get_api() ) {
755 + register_widget( 'Mailchimp_SF_Widget' );
756 + }
853 757 }
758 +add_action( 'widgets_init', 'mailchimp_sf_register_widgets' );
854 759
855 -function mailchimpSF_check_status($endpoint) {
856 - $endpoint .= '?fields=status';
857 - $api = mailchimpSF_get_api();
858 - $subscriber = $api->get($endpoint, null);
859 - if(is_wp_error($subscriber)) {
860 - return false;
861 - }
862 - return $subscriber['status'];
863 - }
864 -
865 -function mailchimpSF_merge_submit($mv) {
866 - // Loop through our Merge Vars, and if they're empty, but required, then print an error, and mark as failed
867 - $merge = new stdClass();
868 - foreach($mv as $var) {
869 - // We also want to create an array where the keys are the tags for easier validation later
870 - $tag = $var['tag'];
871 - $mv_tag_keys[$tag] = $var;
872 -
873 - $opt = 'mc_mv_' . $tag;
874 -
875 - $opt_val = isset($_POST[$opt]) ? stripslashes_deep($_POST[$opt]) : '';
876 -
877 - // Handle phone number logic
878 - if ($var['type'] === 'phone' && $var['options']['phone_format'] === 'US') {
879 - $opt_val = mailchimpSF_merge_validate_phone($opt_val, $var);
880 - if(is_wp_error($opt_val)) {
881 - return $opt_val;
882 - }
883 - }
884 - // Handle address logic
885 - else if (is_array($opt_val) && $var['type'] == 'address') {
886 - $validate = mailchimpSF_merge_validate_address($opt_val, $var);
887 - if(is_wp_error($validate)) {
888 - return $validate;
889 - }
890 -
891 - if($validate) {
892 - $merge->$tag = $validate;
893 - }
894 - continue;
895 -
896 - }
897 - else if (is_array($opt_val)) {
898 - $keys = array_keys($opt_val);
899 - $val = new stdClass();
900 - foreach($keys as $key) {
901 - $val->$key = $opt_val[$key];
902 - }
903 - $opt_val = $val;
904 - }
905 -
906 - if ($var['required'] == 'Y' && trim($opt_val) == '') {
907 - $message = sprintf(__("You must fill in %s.", 'mailchimp_i18n'), esc_html($var['name']));
908 - $error = new WP_Error('missing_required_field', $message);
909 - return $error;
910 - }
911 - else {
912 - if ($tag != 'EMAIL') {
913 - $merge->$tag = $opt_val;
914 - }
915 - }
916 - }
917 - return $merge;
760 +/**
761 + * Add shortcode
762 + *
763 + * @return string
764 + */
765 +function mailchimp_sf_shortcode() {
766 + ob_start();
767 + mailchimp_sf_signup_form();
768 + return ob_get_clean();
918 769 }
770 +add_shortcode( 'mailchimpsf_form', 'mailchimp_sf_shortcode' );
919 771
920 -function mailchimpSF_merge_validate_phone($opt_val, $var) {
921 - // This filters out all 'falsey' elements
922 - $opt_val = array_filter($opt_val);
923 - // If they weren't all empty
924 - if (!$opt_val) {
925 - return;
926 - }
772 +/**
773 + * Cleans up merge fields and interests to make them
774 + * API 3.0-friendly.
775 + *
776 + * @param [type] $merge Merge fields
777 + * @param [type] $igs Interest groups
778 + * @param string $email_type Email type
779 + * @param string $email Email
780 + * @param string|false $status Status The subscription status ('subscribed', 'unsubscribed', 'pending', etc.) or false if an error occurred.
781 + * @param string $double_optin Whether double opt-in is enabled. "1" for enabled and "" for disabled.
782 + * @return stdClass
783 + */
784 +function mailchimp_sf_subscribe_body( $merge, $igs, $email_type, $email, $status, $double_optin ) {
785 + $body = new stdClass();
786 + $body->email_address = $email;
787 + $body->email_type = $email_type;
788 + $body->merge_fields = $merge;
927 789
928 - $opt_val = implode('-', $opt_val);
929 - if (strlen($opt_val) < 12) {
930 - $opt_val = '';
931 - }
790 + if ( ! empty( $igs ) ) {
791 + $body->interests = $igs;
792 + }
932 793
794 + // Early return for already subscribed users
795 + if ( 'subscribed' === $status ) {
796 + return $body;
797 + }
933 798
934 - if (!preg_match('/[0-9]{0,3}-[0-9]{0,3}-[0-9]{0,4}/A', $opt_val)) {
935 - $message = sprintf(__("%s must consist of only numbers", 'mailchimp_i18n'), esc_html($var['name']));
936 - $error = new WP_Error('mc_phone_validation', $message);
937 - return $error;
938 - }
799 + // Subscribe the email immediately unless double opt-in is enabled
800 + // "unsubscribed" and "subscribed" existing emails have been excluded at this stage
801 + // "pending" emails should follow double opt-in rules
802 + $body->status = $double_optin ? 'pending' : 'subscribed';
939 803
940 - return $opt_val;
804 + return $body;
941 805 }
942 806
943 -function mailchimpSF_merge_validate_address($opt_val, $var) {
944 - if ($var['required'] == 'Y') {
945 - if (empty($opt_val['addr1']) || empty($opt_val['city'])) {
946 - $message = sprintf(__("You must fill in %s.", 'mailchimp_i18n'), esc_html($var['name']));
947 - $error = new WP_Error('invalid_address_merge', $message);
948 - return $error;
949 - }
950 - } else {
951 - if (empty($opt_val['addr1']) || empty($opt_val['city'])) {
952 - return false;
953 - }
954 - }
955 -
956 - $merge = new stdClass();
957 - $merge->addr1 = $opt_val['addr1'];
958 - $merge->addr2 = $opt_val['addr2'];
959 - $merge->city = $opt_val['city'];
960 - $merge->state = $opt_val['state'];
961 - $merge->zip = $opt_val['zip'];
962 - $merge->country = $opt_val['country'];
963 - return $merge;
964 -
807 +/**
808 + * Check the status of a subscriber in the list.
809 + *
810 + * @param string $endpoint API endpoint to check the status.
811 + * @return string|false The subscription status ('subscribed', 'unsubscribed', 'pending', etc.) or false if the API returned 404 or an error occurred.
812 + */
813 +function mailchimp_sf_check_status( $endpoint ) {
814 + $endpoint .= '?fields=status';
815 + $api = mailchimp_sf_get_api();
816 + $subscriber = $api->get( $endpoint, null );
817 + if ( is_wp_error( $subscriber ) ) {
818 + return false;
819 + }
820 + return $subscriber['status'];
965 821 }
966 822
967 -function mailchimpSF_merge_remove_empty($merge)
968 -{
969 - foreach ($merge as $k => $v) {
970 - if (is_object($v) && empty($v)) {
971 - unset($merge->$k);
972 - } elseif ((is_string($v) && trim($v) === '') || is_null($v)) {
973 - unset($merge->$k);
974 - }
975 - }
823 +/**
824 + * Verify key
825 + *
826 + * @param MailChimp_API $api API instance
827 + * @return mixed
828 + */
829 +function mailchimp_sf_verify_key( $api ) {
830 + $user = $api->get( '' );
831 + if ( is_wp_error( $user ) ) {
832 + return $user;
833 + }
976 834
977 - return $merge;
978 -}
835 + // Might as well set this data if we have it already.
836 + $valid_roles = array( 'owner', 'admin', 'manager' );
837 + if ( isset( $user['role'] ) && in_array( $user['role'], $valid_roles, true ) ) {
838 + update_option( 'mc_api_key', $api->key );
839 + update_option( 'mc_user', $user );
840 + update_option( 'mc_datacenter', $api->datacenter );
979 841
980 -function mailchimpSF_groups_submit($igs) {
981 - $groups = mailchimpSF_set_all_groups_to_false();
982 -
983 - if(empty($igs)) {
984 - return new StdClass();
985 - }
986 -
987 - //get groups and ids
988 - //set all to false
989 -
990 - foreach ($igs as $ig) {
991 - $ig_id = $ig['id'];
992 - if (get_option('mc_show_interest_groups_'.$ig_id) == 'on' && $ig['type'] !== 'hidden') {
993 - switch ($ig['type']) {
994 - case 'dropdown':
995 - case 'radio':
996 - // there can only be one value submitted for radio/dropdowns, so use that at the group id.
997 - if (isset($_POST['group'][$ig_id]) && !empty($_POST['group'][$ig_id])) {
998 - $value = $_POST['group'][$ig_id];
999 - $groups->$value = true;
1000 - }
1001 - break;
1002 - case 'checkboxes':
1003 - if (isset($_POST['group'][$ig_id])) {
1004 - foreach ($_POST['group'][$ig_id] as $id => $value) {
1005 - $groups->$id = true;
1006 - }
1007 - }
1008 - break;
1009 - default:
1010 - // Nothing
1011 - break;
1012 - }
1013 - }
1014 - }
1015 - return $groups;
842 + } else {
843 + $msg = esc_html__( 'API Key must belong to "Owner", "Admin", or "Manager."', 'mailchimp' );
844 + return new WP_Error( 'mc-invalid-role', $msg );
845 + }
1016 846 }
1017 847
1018 -function mailchimpSF_set_all_groups_to_false() {
1019 - $toreturn = new StdClass();
1020 -
1021 - foreach (get_option('mc_interest_groups') as $grouping) {
1022 - if($grouping['type'] !== 'hidden') {
1023 - foreach ($grouping['groups'] as $group) {
1024 - $id = $group['id'];
1025 - $toreturn->$id = false;
1026 - }
1027 - }
1028 - }
1029 -
1030 - return $toreturn;
848 +/**
849 + * Update profile URL.
850 + *
851 + * @param string $email Email
852 + * @return string
853 + */
854 +function mailchimp_sf_update_profile_url( $email ) {
855 + $dc = get_option( 'mc_datacenter' );
856 + // This is the expected encoding for emails.
857 + $eid = base64_encode( $email ); // phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.obfuscation_base64_encode -- ignoring because this is the expected data for the endpoint
858 + $user = get_option( 'mc_user' );
859 + $list_id = get_option( 'mc_list_id' );
860 + $url = 'http://' . $dc . '.list-manage.com/subscribe/send-email?u=' . $user['account_id'] . '&id=' . $list_id . '&e=' . $eid;
861 + return $url;
1031 862 }
1032 863
1033 -function mailchimpSF_verify_key($api) {
1034 - $user = $api->get('');
1035 - if (is_wp_error($user)) {
1036 - return $user;
1037 - }
1038 -
1039 - //Might as well set this data if we have it already.
1040 - $valid_roles = array('owner', 'admin', 'manager');
1041 - if(in_array($user['role'], $valid_roles)) {
1042 - update_option('mc_api_key', $api->key);
1043 - update_option('mc_user', $user);
1044 - update_option('mc_datacenter', $api->datacenter);
1045 -
1046 - } else {
1047 - $msg = __('API Key must belong to "Owner", "Admin", or "Manager."', 'mailchimp_i18n');
1048 - return new WP_Error('mc-invalid-role', $msg);
1049 - }
1050 - return;
864 +/**
865 + * Delete options
866 + *
867 + * @param array $options Options
868 + * @return void
869 + */
870 +function mailchimp_sf_delete_options( $options = array() ) {
871 + foreach ( $options as $option ) {
872 + delete_option( $option );
873 + }
1051 874 }
1052 875
1053 -function mailchimpSF_update_profile_url($email) {
1054 - $dc = get_option('mc_datacenter');
1055 - $eid = base64_encode($email);
1056 - $user = get_option('mc_user');
1057 - $list_id = get_option('mc_list_id');
1058 - $url = 'http://' . $dc . '.list-manage.com/subscribe/send-email?u=' . $user['account_id'] . '&id=' . $list_id . '&e=' . $eid;
1059 - return $url;
1060 -}
1061 -
1062 -function mailchimpSF_signup_form_url() {
1063 - $dc = get_option('mc_datacenter');
1064 - $user = get_option('mc_user');
1065 - $list_id = get_option('mc_list_id');
1066 - $url = 'http://' . $dc . '.list-manage.com/subscribe?u=' . $user['account_id'] . '&id=' . $list_id;
1067 - return $url;
1068 -}
1069 -
1070 -function mailchimpSF_delete_options($options = array()) {
1071 - foreach($options as $option) {
1072 - delete_option($option);
1073 - }
1074 -}
1075 -
1076 -
1077 876 /**********************
1078 877 * Utility Functions *
1079 -**********************/
878 + **********************/
1080 879 /**
1081 880 * Utility function to allow placement of plugin in plugins, mu-plugins, child or parent theme's plugins folders
1082 881 *
1083 882 * This function must be ran _very early_ in the load process, as it sets up important constants for the rest of the plugin
1084 883 */
1085 -function mailchimpSF_where_am_i() {
1086 - $locations = array(
1087 - 'plugins' => array(
1088 - 'dir' => plugin_dir_path(__FILE__),
1089 - 'url' => plugins_url()
1090 - ),
1091 - 'mu_plugins' => array(
1092 - 'dir' => plugin_dir_path(__FILE__),
1093 - 'url' => plugins_url(),
1094 - ),
1095 - 'template' => array(
1096 - 'dir' => trailingslashit(get_template_directory()).'plugins/',
1097 - 'url' => trailingslashit(get_template_directory_uri()).'plugins/',
1098 - ),
1099 - 'stylesheet' => array(
1100 - 'dir' => trailingslashit(get_stylesheet_directory()).'plugins/',
1101 - 'url' => trailingslashit(get_stylesheet_directory_uri()).'plugins/',
1102 - ),
1103 - );
884 +function mailchimp_sf_where_am_i() {
885 + $locations = array(
886 + 'plugins' => array(
887 + 'dir' => plugin_dir_path( __FILE__ ),
888 + 'url' => plugins_url(),
889 + ),
890 + 'mu_plugins' => array(
891 + 'dir' => plugin_dir_path( __FILE__ ),
892 + 'url' => plugins_url(),
893 + ),
894 + 'template' => array(
895 + 'dir' => trailingslashit( get_template_directory() ) . 'plugins/',
896 + 'url' => trailingslashit( get_template_directory_uri() ) . 'plugins/',
897 + ),
898 + 'stylesheet' => array(
899 + 'dir' => trailingslashit( get_stylesheet_directory() ) . 'plugins/',
900 + 'url' => trailingslashit( get_stylesheet_directory_uri() ) . 'plugins/',
901 + ),
902 + );
1104 903
1105 - // Set defaults
1106 - $mscf_dirbase = trailingslashit(basename(dirname(__FILE__))); // Typically wp-mailchimp/ or mailchimp/
1107 - $mscf_dir = trailingslashit(plugin_dir_path(__FILE__));
1108 - $mscf_url = trailingslashit(plugins_url(null, __FILE__));
904 + // Set defaults
905 + $mscf_dirbase = trailingslashit( basename( __DIR__ ) ); // Typically wp-mailchimp/ or mailchimp/
906 + $mscf_dir = trailingslashit( plugin_dir_path( __FILE__ ) );
907 + $mscf_url = trailingslashit( plugins_url( '', __FILE__ ) );
1109 908
1110 - // Try our hands at finding the real location
1111 - foreach ($locations as $key => $loc) {
1112 - $dir = trailingslashit($loc['dir']).$mscf_dirbase;
1113 - $url = trailingslashit($loc['url']).$mscf_dirbase;
1114 - if (is_file($dir.basename(__FILE__))) {
1115 - $mscf_dir = $dir;
1116 - $mscf_url = $url;
1117 - break;
1118 - }
1119 - }
909 + // Try our hands at finding the real location
910 + foreach ( $locations as $key => $loc ) {
911 + $dir = trailingslashit( $loc['dir'] ) . $mscf_dirbase;
912 + $url = trailingslashit( $loc['url'] ) . $mscf_dirbase;
913 + if ( is_file( $dir . basename( __FILE__ ) ) ) {
914 + $mscf_dir = $dir;
915 + $mscf_url = $url;
916 + break;
917 + }
918 + }
1120 919
1121 - // Define our complete filesystem path
1122 - define('MCSF_DIR', $mscf_dir);
920 + // Define our complete filesystem path
921 + define( 'MCSF_DIR', $mscf_dir );
1123 922
1124 - /* Lang location needs to be relative *from* ABSPATH,
1125 - so strip it out of our language dir location */
1126 - define('MCSF_LANG_DIR', trailingslashit(MCSF_DIR).'po/');
1127 -
1128 - // Define our complete URL to the plugin folder
1129 - define('MCSF_URL', $mscf_url);
923 + // Define our complete URL to the plugin folder
924 + define( 'MCSF_URL', $mscf_url );
1130 925 }
1131 926
1132 927
1133 928 /**
1134 - * MODIFIED VERSION of wp_verify_nonce from WP Core. Core was not overridden to prevent problems when replacing
929 + * MODIFIED VERSION of wp_verify_nonce from WP Core. Core was not overridden to prevent problems when replacing
1135 930 * something universally.
1136 931 *
1137 932 * Verify that correct nonce was used with time limit.
1138 933 *
@@ -1138,45 +933,45 @@
1138 933 *
1139 934 * The user is given an amount of time to use the token, so therefore, since the
1140 935 * UID and $action remain the same, the independent variable is the time.
1141 936 *
1142 - * @param string $nonce Nonce that was used in the form to verify
937 + * @param string $nonce Nonce that was used in the form to verify
1143 938 * @param string|int $action Should give context to what is taking place and be the same when nonce was created.
1144 939 * @return bool Whether the nonce check passed or failed.
1145 940 */
1146 -function mailchimpSF_verify_nonce($nonce, $action = -1) {
1147 - $user = wp_get_current_user();
1148 - $uid = (int) $user->ID;
1149 - if ( ! $uid ) {
1150 - $uid = apply_filters( 'nonce_user_logged_out', $uid, $action );
1151 - }
941 +function mailchimp_sf_verify_nonce( $nonce, $action = -1 ) {
942 + $user = wp_get_current_user();
943 + $uid = (int) $user->ID;
944 + if ( ! $uid ) {
945 + $uid = apply_filters( 'nonce_user_logged_out', $uid, $action );
946 + }
1152 947
1153 - if ( empty( $nonce ) ) {
1154 - return false;
1155 - }
948 + if ( empty( $nonce ) ) {
949 + return false;
950 + }
1156 951
1157 - $token = 'MAILCHIMP';
1158 - $i = wp_nonce_tick();
952 + $token = 'MAILCHIMP';
953 + $i = wp_nonce_tick();
1159 954
1160 - // Nonce generated 0-12 hours ago
1161 - $expected = substr( wp_hash( $i . '|' . $action . '|' . $uid . '|' . $token, 'nonce'), -12, 10 );
1162 - if ( hash_equals( $expected, $nonce ) ) {
1163 - return 1;
1164 - }
955 + // Nonce generated 0-12 hours ago
956 + $expected = substr( wp_hash( $i . '|' . $action . '|' . $uid . '|' . $token, 'nonce' ), -12, 10 );
957 + if ( hash_equals( $expected, $nonce ) ) {
958 + return 1;
959 + }
1165 960
1166 - // Nonce generated 12-24 hours ago
1167 - $expected = substr( wp_hash( ( $i - 1 ) . '|' . $action . '|' . $uid . '|' . $token, 'nonce' ), -12, 10 );
1168 - if ( hash_equals( $expected, $nonce ) ) {
1169 - return 2;
1170 - }
961 + // Nonce generated 12-24 hours ago
962 + $expected = substr( wp_hash( ( $i - 1 ) . '|' . $action . '|' . $uid . '|' . $token, 'nonce' ), -12, 10 );
963 + if ( hash_equals( $expected, $nonce ) ) {
964 + return 2;
965 + }
1171 966
1172 - // Invalid nonce
1173 - return false;
967 + // Invalid nonce
968 + return false;
1174 969 }
1175 970
1176 971
1177 972 /**
1178 - * MODIFIED VERSION of wp_create_nonce from WP Core. Core was not overridden to prevent problems when replacing
973 + * MODIFIED VERSION of wp_create_nonce from WP Core. Core was not overridden to prevent problems when replacing
1179 974 * something universally.
1180 975 *
1181 976 * Creates a cryptographic token tied to a specific action, user, and window of time.
1182 977 *
@@ -1182,17 +977,74 @@
1182 977 *
1183 978 * @param string $action Scalar value to add context to the nonce.
1184 979 * @return string The token.
1185 980 */
1186 -function mailchimpSF_create_nonce($action = -1) {
1187 - $user = wp_get_current_user();
1188 - $uid = (int) $user->ID;
1189 - if ( ! $uid ) {
1190 - /** This filter is documented in wp-includes/pluggable.php */
1191 - $uid = apply_filters( 'nonce_user_logged_out', $uid, $action );
1192 - }
981 +function mailchimp_sf_create_nonce( $action = -1 ) {
982 + $user = wp_get_current_user();
983 + $uid = (int) $user->ID;
984 + if ( ! $uid ) {
985 + /** This filter is documented in wp-includes/pluggable.php */
986 + $uid = apply_filters( 'nonce_user_logged_out', $uid, $action );
987 + }
1193 988
1194 - $token = 'MAILCHIMP';
1195 - $i = wp_nonce_tick();
989 + $token = 'MAILCHIMP';
990 + $i = wp_nonce_tick();
1196 991
1197 - return substr( wp_hash( $i . '|' . $action . '|' . $uid . '|' . $token, 'nonce' ), -12, 10 );
992 + return substr( wp_hash( $i . '|' . $action . '|' . $uid . '|' . $token, 'nonce' ), -12, 10 );
993 +}
994 +
995 +/**
996 + * Get Mailchimp Access Token.
997 + *
998 + * @since 1.6.0
999 + * @return string|bool
1000 + */
1001 +function mailchimp_sf_get_access_token() {
1002 + $access_token = get_option( 'mailchimp_sf_access_token' );
1003 + if ( empty( $access_token ) ) {
1004 + return false;
1005 + }
1006 +
1007 + $data_encryption = new Mailchimp_Data_Encryption();
1008 + $access_token = $data_encryption->decrypt( $access_token );
1009 +
1010 + // If decryption fails, display notice to user to re-authenticate.
1011 + if ( false === $access_token ) {
1012 + update_option( 'mailchimp_sf_auth_error', true );
1013 + }
1014 +
1015 + return $access_token;
1016 +}
1017 +
1018 +/**
1019 + * Should display Mailchimp Signup form.
1020 + *
1021 + * @since 1.6.0
1022 + * @return bool
1023 + */
1024 +function mailchimp_sf_should_display_form() {
1025 + return mailchimp_sf_get_api() && ! get_option( 'mailchimp_sf_auth_error' ) && get_option( 'mc_list_id' );
1026 +}
1027 +
1028 +/**
1029 + * Get Mailchimp Lists.
1030 + *
1031 + * @since 2.1.0
1032 + * @return array|WP_Error|false List of Mailchimp lists, or an error/false from the API request.
1033 + */
1034 +function mailchimp_sf_get_lists() {
1035 + /**
1036 + * Filter the limit of lists to fetch.
1037 + *
1038 + * This value is sanitized to a positive integer and clamped before the API request.
1039 + * Defaults to 100. 1000 is the maximum allowed by the API. 1 is the minimum allowed.
1040 + */
1041 + $limit = apply_filters( 'mailchimp_sf_list_limit', 100 ); // Default to 100.
1042 + $limit = max( 1, min( 1000, absint( $limit ) ) );
1043 +
1044 + $api = mailchimp_sf_get_api();
1045 + if ( ! $api ) {
1046 + return array();
1047 + }
1048 +
1049 + return $api->get( 'lists', $limit, array( 'fields' => 'lists.id,lists.name,lists.email_type_option' ) );
1198 1050 }