Your IP : 216.73.216.122
<?php
GFForms::include_feed_addon_framework();
class GFActiveCampaign extends GFFeedAddOn {
protected $_version = GF_ACTIVECAMPAIGN_VERSION;
protected $_min_gravityforms_version = '1.9.11';
protected $_slug = 'gravityformsactivecampaign';
protected $_path = 'gravityformsactivecampaign/activecampaign.php';
protected $_full_path = __FILE__;
protected $_url = 'http://www.gravityforms.com';
protected $_title = 'Gravity Forms ActiveCampaign Add-On';
protected $_short_title = 'ActiveCampaign';
// Members plugin integration
protected $_capabilities = array( 'gravityforms_activecampaign', 'gravityforms_activecampaign_uninstall' );
// Permissions
protected $_capabilities_settings_page = 'gravityforms_activecampaign';
protected $_capabilities_form_settings = 'gravityforms_activecampaign';
protected $_capabilities_uninstall = 'gravityforms_activecampaign_uninstall';
protected $_enable_rg_autoupgrade = true;
protected $api = null;
protected $_new_custom_fields = array();
private static $_instance = null;
public static function get_instance() {
if ( self::$_instance == null ) {
self::$_instance = new GFActiveCampaign();
}
return self::$_instance;
}
/* Enqueue needed styles */
public function styles() {
$styles = array(
array(
'handle' => 'gform_activecampaign_form_settings_css',
'src' => $this->get_base_url() . '/css/form_settings.css',
'version' => $this->_version,
'enqueue' => array(
array( 'admin_page' => array( 'form_settings' ) ),
)
)
);
return array_merge( parent::styles(), $styles );
}
/* Settings Page */
public function plugin_settings_fields() {
return array(
array(
'title' => '',
'description' => $this->plugin_settings_description(),
'fields' => array(
array(
'name' => 'api_url',
'label' => __( 'API URL', 'gravityformsactivecampaign' ),
'type' => 'text',
'class' => 'medium',
'feedback_callback' => array( $this, 'has_valid_api_url' )
),
array(
'name' => 'api_key',
'label' => __( 'API Key', 'gravityformsactivecampaign' ),
'type' => 'text',
'class' => 'large',
'feedback_callback' => array( $this, 'initialize_api' )
),
array(
'type' => 'save',
'messages' => array(
'success' => __( 'ActiveCampaign settings have been updated.', 'gravityformsactivecampaign' )
),
),
),
),
);
}
/* Prepare plugin settings description */
public function plugin_settings_description() {
$description = '<p>';
$description .= sprintf(
__( 'ActiveCampaign makes it easy to send email newsletters to your customers, manage your subscriber lists, and track campaign performance. Use Gravity Forms to collect customer information and automatically add them to your ActiveCampaign list. If you don\'t have a ActiveCampaign account, you can %1$s sign up for one here.%2$s', 'gravityformsactivecampaign' ),
'<a href="http://www.activecampaign.com/" target="_blank">', '</a>'
);
$description .= '</p>';
if ( ! $this->initialize_api() ) {
$description .= '<p>';
$description .= __( 'Gravity Forms ActiveCampaign Add-On requires your API URL and API Key, which can be found in the API tab on the account settings page.', 'gravityformsactivecampaign' );
$description .= '</p>';
}
return $description;
}
/* Setup feed settings fields */
public function feed_settings_fields() {
/* Build fields array. */
$fields = array(
array(
'name' => 'feed_name',
'label' => __( 'Feed Name', 'gravityformsactivecampaign' ),
'type' => 'text',
'required' => true,
'tooltip' => '<h6>' . __( 'Name', 'gravityformsactivecampaign' ) . '</h6>' . __( 'Enter a feed name to uniquely identify this setup.', 'gravityformsactivecampaign' )
),
array(
'name' => 'list',
'label' => __( 'ActiveCampaign List', 'gravityformsactivecampaign' ),
'type' => 'select',
'required' => true,
'choices' => $this->lists_for_feed_setting(),
'onchange' => "jQuery(this).parents('form').submit();",
'tooltip' => '<h6>' . __( 'ActiveCampaign List', 'gravityformsactivecampaign' ) . '</h6>' . __( 'Select which ActiveCampaign list this feed will add contacts to.', 'gravityformsactivecampaign' )
),
array(
'name' => 'fields',
'label' => __( 'Map Fields', 'gravityformsactivecampaign' ),
'type' => 'field_map',
'dependency' => 'list',
'field_map' => $this->fields_for_feed_mapping(),
'tooltip' => '<h6>' . __( 'Map Fields', 'gravityformsactivecampaign' ) . '</h6>' . __( 'Select which Gravity Form fields pair with their respective ActiveCampaign fields.', 'gravityformsactivecampaign' )
),
array(
'name' => 'custom_fields',
'label' => '',
'type' => 'dynamic_field_map',
'dependency' => 'list',
'field_map' => $this->custom_fields_for_feed_setting(),
),
array(
'name' => 'tags',
'type' => 'text',
'label' => __( 'Tags', 'gravityformsactivecampaign' ),
'dependency' => 'list',
'class' => 'medium merge-tag-support mt-position-right mt-hide_all_fields',
)
);
/* Add double opt-in form field if forms exist. */
$forms = $this->forms_for_feed_setting();
if ( count( $forms ) > 1 ) {
$fields[] = array(
'name' => 'double_optin_form',
'label' => __( 'Double Opt-In Form', 'gravityformsactivecampaign' ),
'type' => 'select',
'dependency' => 'list',
'choices' => $this->forms_for_feed_setting(),
'tooltip' => '<h6>' . __( 'Double Opt-In Form', 'gravityformsactivecampaign' ) . '</h6>' . __( 'Select which ActiveCampaign form will be used when exporting to ActiveCampaign to send the opt-in email.', 'gravityformsactivecampaign' )
);
}
/* Add feed condition and options fields. */
$fields[] = array(
'name' => 'feed_condition',
'label' => __( 'Opt-In Condition', 'gravityformsactivecampaign' ),
'type' => 'feed_condition',
'dependency' => 'list',
'checkbox_label' => __( 'Enable', 'gravityformsactivecampaign' ),
'instructions' => __( 'Export to ActiveCampaign if', 'gravityformsactivecampaign' ),
'tooltip' => '<h6>' . __( 'Opt-In Condition', 'gravityformsactivecampaign' ) . '</h6>' . __( 'When the opt-in condition is enabled, form submissions will only be exported to ActiveCampaign when the condition is met. When disabled, all form submissions will be exported.', 'gravityformsactivecampaign' )
);
$fields[] = array(
'name' => 'options',
'label' => __( 'Options', 'gravityformsactivecampaign' ),
'type' => 'checkbox',
'dependency' => 'list',
'choices' => array(
array(
'name' => 'instant_responders',
'label' => __( 'Instant Responders', 'gravityformsactivecampaign' ),
'default_value' => 1,
'tooltip' => '<h6>' . __( 'Instant Responders', 'gravityformsactivecampaign' ) . '</h6>' . __( 'When the instant responders option is enabled, ActiveCampaign will send any instant responders setup when the contact is added to the list. This option is not available to users on a free trial.', 'gravityformsactivecampaign' ),
),
array(
'name' => 'last_message',
'label' => __( 'Send the last broadcast campaign', 'gravityformsactivecampaign' ),
'default_value' => 0,
'tooltip' => '<h6>' . __( 'Send the last broadcast campaign', 'gravityformsactivecampaign' ) . '</h6>' . __( 'When the send the last broadcast campaign option is enabled, ActiveCampaign will send the last campaign sent out to the list to the contact being added. This option is not available to users on a free trial.', 'gravityformsactivecampaign' ),
),
)
);
return array(
array(
'title' => '',
'fields' => $fields
)
);
}
/* Fork of maybe_save_feed_settings to create new ActiveCampaign custom fields */
public function maybe_save_feed_settings( $feed_id, $form_id ) {
if ( ! rgpost( 'gform-settings-save' ) ) {
return $feed_id;
}
// store a copy of the previous settings for cases where action would only happen if value has changed
$feed = $this->get_feed( $feed_id );
$this->set_previous_settings( $feed['meta'] );
$settings = $this->get_posted_settings();
$settings = $this->create_new_custom_fields( $settings );
$sections = $this->get_feed_settings_fields();
$settings = $this->trim_conditional_logic_vales( $settings, $form_id );
$is_valid = $this->validate_settings( $sections, $settings );
$result = false;
if ( $is_valid ) {
$feed_id = $this->save_feed_settings( $feed_id, $form_id, $settings );
if ( $feed_id ) {
GFCommon::add_message( $this->get_save_success_message( $sections ) );
} else {
GFCommon::add_error_message( $this->get_save_error_message( $sections ) );
}
} else {
GFCommon::add_error_message( $this->get_save_error_message( $sections ) );
}
return $feed_id;
}
/* Prepare ActiveCampaign lists for feed field */
public function lists_for_feed_setting() {
$lists = array(
array(
'label' => '',
'value' => ''
)
);
/* If ActiveCampaign API credentials are invalid, return the lists array. */
if ( ! $this->initialize_api() ) {
return $lists;
}
/* Get available ActiveCampaign lists. */
$ac_lists = $this->api->get_lists();
/* Add ActiveCampaign lists to array and return it. */
foreach ( $ac_lists as $list ) {
if ( ! is_array( $list ) ) {
continue;
}
$lists[] = array(
'label' => $list['name'],
'value' => $list['id']
);
}
return $lists;
}
/* Prepare fields for feed field mapping */
public function fields_for_feed_mapping() {
return array(
array(
'name' => 'email',
'label' => __( 'Email Address', 'gravityformsactivecampaign' ),
'required' => true,
'field_type' => array( 'email', 'hidden' )
),
array(
'name' => 'first_name',
'label' => __( 'First Name', 'gravityformsactivecampaign' ),
'required' => false
),
array(
'name' => 'last_name',
'label' => __( 'Last Name', 'gravityformsactivecampaign' ),
'required' => false
),
array(
'name' => 'phone',
'label' => __( 'Phone Number', 'gravityformsactivecampaign' ),
'required' => false
),
array(
'name' => 'orgname',
'label' => __( 'Organization Name', 'gravityformsactivecampaign' ),
'required' => false
),
);
}
/* Prepare custom fields for feed field mapping */
public function custom_fields_for_feed_setting() {
$fields = array();
/* If ActiveCampaign API credentials are invalid, return the fields array. */
if ( ! $this->initialize_api() ) {
return $fields;
}
/* Get available ActiveCampaign fields. */
$ac_fields = $this->api->get_custom_fields();
/* If no ActiveCampaign fields exist, return the fields array. */
if ( empty( $ac_fields ) ) {
return $fields;
}
/* If ActiveCampaign fields exist, add them to the fields array. */
if ( $ac_fields['result_code'] == 1 ) {
foreach ( $ac_fields as $field ) {
if ( ! is_array( $field ) ) {
continue;
}
$fields[] = array(
'label' => $field['title'],
'value' => $field['id']
);
}
}
if ( ! empty( $this->_new_custom_fields ) ) {
foreach ( $this->_new_custom_fields as $new_field ) {
$found_custom_field = false;
foreach ( $fields as $field ) {
if ( $field['value'] == $new_field['value'] ) {
$found_custom_field = true;
}
}
if ( ! $found_custom_field ) {
$fields[] = array(
'label' => $new_field['label'],
'value' => $new_field['value']
);
}
}
}
if ( empty( $fields ) ) {
return $fields;
}
/* Add "Add Custom Field" to array. */
$fields[] = array(
'label' => __( 'Add Custom Field', 'gravityformsactivecampaign' ),
'value' => 'gf_custom'
);
return $fields;
}
/* Prepare ActiveCampaign forms for feed field */
public function forms_for_feed_setting() {
$forms = array(
array(
'label' => '',
'value' => ''
)
);
/* If ActiveCampaign API credentials are invalid, return the forms array. */
if ( ! $this->initialize_api() ) {
return $forms;
}
/* Get list ID. */
$current_feed = $this->get_current_feed();
$list_id = rgpost( '_gaddon_setting_list' ) ? rgpost( '_gaddon_setting_list' ) : $current_feed['meta']['list'];
/* Get available ActiveCampaign forms. */
$ac_forms = $this->api->get_forms();
/* Add ActiveCampaign forms to array and return it. */
foreach ( $ac_forms as $form ) {
if ( ! is_array( $form ) ) {
continue;
}
if ( $form['sendoptin'] == 0 || ! in_array( $list_id, $form['lists'] ) ) {
continue;
}
$forms[] = array(
'label' => $form['name'],
'value' => $form['id']
);
}
return $forms;
}
/* Create new ActiveCampaign custom fields */
public function create_new_custom_fields( $settings ) {
global $_gaddon_posted_settings;
/* If no custom fields are set or if the API credentials are invalid, return settings. */
if ( empty( $settings['custom_fields'] ) || ! $this->initialize_api() ) {
return $settings;
}
/* Loop through each custom field. */
foreach ( $settings['custom_fields'] as $index => &$field ) {
/* If no custom key is set, move on. */
if ( rgblank( $field['custom_key'] ) ) {
continue;
}
$custom_key = $field['custom_key'];
$perstag = trim( $custom_key ); // Set shortcut name to custom key
$perstag = str_replace( ' ', '_', $custom_key ); // Remove all spaces
$perstag = preg_replace( '([^\w\d])', '', $custom_key ); // Strip all custom characters
$perstag = strtoupper( $custom_key ); // Set to lowercase
/* Prepare new field to add. */
$custom_field = array(
'title' => $custom_key,
'type' => 1,
'req' => 0,
'p[0]' => 0
);
/* Add new field. */
$new_field = $this->api->add_custom_field( $custom_field );
/* Replace key for field with new shortcut name and reset custom key. */
if ( $new_field['result_code'] == 1 ) {
$field['key'] = $new_field['fieldid'];
$field['custom_key'] = '';
/* Update POST field to ensure front-end display is up-to-date. */
$_gaddon_posted_settings['custom_fields'][ $index ]['key'] = $new_field['fieldid'];
$_gaddon_posted_settings['custom_fields'][ $index ]['custom_key'] = '';
/* Push to new custom fields array to update the UI. */
$this->_new_custom_fields[] = array(
'label' => $custom_key,
'value' => $new_field['fieldid'],
);
}
}
return $settings;
}
/* Setup feed list columns */
public function feed_list_columns() {
return array(
'feed_name' => __( 'Name', 'gravityformsactivecampaign' ),
'list' => __( 'ActiveCampaign List', 'gravityformsactivecampaign' )
);
}
/* Change value of list feed column to list name */
public function get_column_value_list( $feed ) {
/* If ActiveCampaign instance is not initialized, return campaign ID. */
if ( ! $this->initialize_api() ) {
return $feed['meta']['list'];
}
/* Get campaign and return name */
$list = $this->api->get_list( $feed['meta']['list'] );
return ( $list['result_code'] == 1 ) ? $list['name'] : $feed['meta']['list'];
}
/* Set feed creation control */
public function can_create_feed() {
return $this->initialize_api();
}
/* Process feed */
public function process_feed( $feed, $entry, $form ) {
$this->log_debug( __METHOD__ . '(): Processing feed.' );
/* If API instance is not initialized, exit. */
if ( ! $this->initialize_api() ) {
$this->log_error( __METHOD__ . '(): Failed to set up the API.' );
return;
}
/* Setup mapped fields array. */
$mapped_fields = $this->get_field_map_fields( $feed, 'fields' );
/* Setup contact array. */
$contact = array(
'email' => $this->get_field_value( $form, $entry, rgar( $mapped_fields, 'email' ) ),
'first_name' => $this->get_field_value( $form, $entry, rgar( $mapped_fields, 'first_name' ) ),
'last_name' => $this->get_field_value( $form, $entry, rgar( $mapped_fields, 'last_name' ) ),
'phone' => $this->get_field_value( $form, $entry, rgar( $mapped_fields, 'phone' ) ),
'orgname' => $this->get_field_value( $form, $entry, rgar( $mapped_fields, 'orgname' ) ),
);
/* If the email address is invalid or empty, exit. */
if ( GFCommon::is_invalid_or_empty_email( $contact['email'] ) ) {
$this->log_error( __METHOD__ . '(): Aborting. Invalid email address: ' . rgar( $contact, 'email' ) );
return;
}
/* Prepare tags. */
if ( rgars( $feed, 'meta/tags' ) ) {
$tags = GFCommon::replace_variables( $feed['meta']['tags'], $form, $entry, false, false, false, 'text' );
$tags = array_map( 'trim', explode( ',', $tags ) );
$contact['tags'] = gf_apply_filters( 'gform_activecampaign_tags', $form['id'], $tags, $feed, $entry, $form );
}
/* Add list to contact array. */
$list_id = $feed['meta']['list'];
$contact[ 'p[' . $list_id . ']' ] = $list_id;
$contact[ 'status[' . $list_id . ']' ] = '1';
/* Add custom fields to contact array. */
$custom_fields = rgars( $feed, 'meta/custom_fields' );
if ( is_array( $custom_fields ) ) {
foreach ( $feed['meta']['custom_fields'] as $custom_field ) {
if ( rgblank( $custom_field['key'] ) || $custom_field['key'] == 'gf_custom' || rgblank( $custom_field['value'] ) ) {
continue;
}
$field_value = $this->get_field_value( $form, $entry, $custom_field['value'] );
if ( rgblank( $field_value ) ) {
continue;
}
$contact[ 'field[' . $custom_field['key'] . ',0]' ] = $field_value;
}
}
/* Set instant responders flag if needed. */
if ( $feed['meta']['instant_responders'] == 1 ) {
$contact[ 'instantresponders[' . $list_id . ']' ] = $feed['meta']['instant_responders'];
}
/* Set last message flag. */
$contact[ 'lastmessage[' . $list_id . ']' ] = $feed['meta']['last_message'];
/* Add opt-in form if set. */
if ( isset( $feed['meta']['double_optin_form'] ) ) {
$contact['form'] = $feed['meta']['double_optin_form'];
}
/* Sync the contact. */
$this->log_debug( __METHOD__ . '(): Contact to be added => ' . print_r( $contact, true ) );
$sync_contact = $this->api->sync_contact( $contact );
if ( $sync_contact['result_code'] == 1 ) {
$this->log_debug( __METHOD__ . "(): {$contact['email']} has been added; {$sync_contact['result_message']}." );
return true;
} else {
$this->log_error( __METHOD__ . "(): {$contact['email']} was not added; {$sync_contact['result_message']}" );
return false;
}
}
/* Checks validity of ActiveCampaign API credentials and initializes API if valid. */
public function initialize_api() {
if ( ! is_null( $this->api ) ) {
return true;
}
/* Load the ActiveCampaign API library. */
require_once 'includes/class-activecampaign.php';
/* Get the plugin settings */
$settings = $this->get_plugin_settings();
/* If any of the account information fields are empty, return null. */
if ( rgblank( $settings['api_url'] ) || rgblank( $settings['api_key'] ) ) {
return null;
}
$this->log_debug( __METHOD__ . "(): Validating API info for {$settings['api_url']} / {$settings['api_key']}." );
$activecampaign = new ActiveCampaign( $settings['api_url'], $settings['api_key'] );
try {
/* Run API test. */
$activecampaign->auth_test();
/* Log that test passed. */
$this->log_debug( __METHOD__ . '(): API credentials are valid.' );
/* Assign ActiveCampaign object to the class. */
$this->api = $activecampaign;
return true;
} catch ( Exception $e ) {
/* Log that test failed. */
$this->log_error( __METHOD__ . '(): API credentials are invalid; ' . $e->getMessage() );
return false;
}
}
/* Checks if API URL is valid */
public function has_valid_api_url( $api_url ) {
/* If no API URL is set, return null. */
if ( rgblank( $api_url ) ) {
return null;
}
$this->log_debug( __METHOD__ . "(): Validating API url {$api_url}." );
/* Setup request URL. */
$request_url = untrailingslashit( $api_url ) . '/admin/api.php?api_action=list_view&api_output=json';
/* Setup API request. */
$response = wp_remote_get( $request_url );
/* If there was a failure on the request, return false. */
if ( is_a( $response, 'WP_Error' ) ) {
return false;
}
/* Return validity based on content type. */
return ( strpos( $response['headers']['content-type'], 'application/json' ) !== false );
}
/* Migrate tags from field map to input field. */
public function upgrade( $previous_version ) {
$previous_is_pre_tags_change = ! empty( $previous_version ) && version_compare( $previous_version, '1.2', '<' );
if ( $previous_is_pre_tags_change ) {
$feeds = $this->get_feeds();
foreach ( $feeds as &$feed ) {
$merge_tag = '';
if ( ! empty( $feed['meta']['fields_tags'] ) ) {
if ( is_numeric( $feed['meta']['fields_tags'] ) ) {
$form = GFAPI::get_form( $feed['form_id'] );
$field = GFFormsModel::get_field( $form, $feed['meta']['fields_tags'] );
$field_merge_tags = GFCommon::get_field_merge_tags( $field );
if ( $field->id == $feed['meta']['fields_tags'] ) {
$merge_tag = $field_merge_tags[0]['tag'];
} else {
foreach ( $field_merge_tags as $field_merge_tag ) {
if ( strpos( $field_merge_tag['tag'], $feed['meta']['fields_tags'] ) !== false ) {
$merge_tag = $field_merge_tag['tag'];
}
}
}
} else {
if ( $feed['meta']['fields_tags'] == 'date_created' ) {
$merge_tag = '{date_mdy}';
} else {
$merge_tag = '{' . $feed['meta']['fields_tags'] . '}';
}
}
}
$feed['meta']['tags'] = $merge_tag;
unset( $feed['meta']['fields_tags'] );
$this->update_feed_meta( $feed['id'], $feed['meta'] );
}
}
}
}