#region =============== CONSTANTS AND VARIABLE NAMES ===============

const pluginPageTitle = 'Forms: 3rd Party Integration';

const pluginPageShortTitle = '3rdparty Services';

/**

const adminOptionsCapability = 'manage_options';

/**

const pluginVersion = '1.8';

/**

private $N;

/**

public function N($key = false) {

// nothing provided, return namespace

if( ! $key || empty($key) ) { return $this->N; }

return sprintf('%s_%s', $this->N, $key);

}

/**

const PARAM_LBL = 'lbl';

/**

const PARAM_SRC = 'src';

/**

const PARAM_3RD = '3rd';

/**

const DEFAULT_TIMEOUT = 10;

/**

public static $instance = null;

#endregion =============== CONSTANTS AND VARIABLE NAMES ===============

#region =============== CONSTRUCTOR and INIT (admin, regular) ===============

// php5 constructor must come first for 'strict standards' -- http://wordpress.org/support/topic/redefining-already-defined-constructor-for-class-wp_widget

function __construct() {

$this->N = __CLASS__;

add_action( 'admin_menu', array( &$this, 'admin_init' ), 20 ); // late, so it'll attach menus farther down

add_action( 'init', array( &$this, 'init' ) ); // want to run late, but can't because it misses CF7 onsend?

} // function

function Forms3rdPartyIntegration() {

$this->__construct();

} // function

function admin_init() {

# perform your code here

//add_action('admin_menu', array(&$this, 'config_page'));

//add plugin entry settings link

add_filter( 'plugin_action_links', array(&$this, 'plugin_action_links'), 10, 2 );

//needs a registered page in order for the above link to work?

#$pageName = add_options_page("Custom Shortcodes - ABT Options", "Shortcodes -ABT", self::adminOptionsCapability, 'abt-shortcodes-config', array(&$this, 'submenu_config'));

if ( function_exists('add_submenu_page') ){

// autoattach to cf7, gravityforms

$subpagesOf = apply_filters($this->N('declare_subpages'), array());

foreach($subpagesOf as $plugin) {

$page = add_submenu_page(/*'plugins.php'*/$plugin, __(self::pluginPageTitle), __(self::pluginPageShortTitle), self::adminOptionsCapability, basename(__FILE__,'.php').'-config', array(&$this, 'submenu_config'));

//add admin stylesheet, etc

add_action('admin_print_styles-' . $page, array(&$this, 'add_admin_headers'));

}

//register options

$default_options = array(

'debug' => array('email'=>get_bloginfo('admin_email'), 'separator'=>', ', 'mode' => array(), 'sender' => '')

, 0 => array(

'name'=>'Service 1'

, 'url'=>plugins_url('3rd-parties/service_test.php', __FILE__)

, 'success'=>''

, 'failure'=>''

, 'forms' => array()

, 'timeout' => self::DEFAULT_TIMEOUT // timeout in seconds

, 'mapping' => array(

array(self::PARAM_LBL=>'The submitter name',self::PARAM_SRC=>'your-name', self::PARAM_3RD=>'name')

, array(self::PARAM_LBL=>'The email address', self::PARAM_SRC=>'your-email', self::PARAM_3RD=>'email')

)

)

);

add_option( $this->N('settings'), $default_options );

}

} // function

/**

function init(){

// needed here because both admin and before-send functions require v()

/// TODO: more intelligently include...

include_once('includes.php');

#wp_register_script('jquery-flip', plugins_url('jquery.flip.min.js', __FILE__), array('jquery'), self::pluginVersion, true);

#wp_register_style('sponsor-flip', plugins_url('styles.css', __FILE__), array(), self::pluginVersion, 'all');

#

#if( !is_admin() ){

# /*

# add_action('wp_print_header_scripts', array(&$this, 'add_headers'), 1);

# add_action('wp_print_footer_scripts', array(&$this, 'add_footers'), 1);

# */

# wp_enqueue_script('jquery-flip');

# wp_enqueue_script('sponsor-flip-init');

# wp_enqueue_style('sponsor-flip');

#}

// allow extensions; remember to check !is_admin

do_action($this->N('init'), false);

if(!is_admin()){

//add_action('wp_footer', array(&$this, 'shortcode_post_slider_add_script')); //jedi way to add shortcode scripts

}

}

#endregion =============== CONSTRUCTOR and INIT (admin, regular) ===============

#region =============== HEADER/FOOTER -- scripts and styles ===============

/**

function add_admin_headers(){

wp_enqueue_script($this->N('admin'), plugins_url('plugin.admin.js', __FILE__), array('jquery', 'jquery-ui-sortable'), self::pluginVersion, true);

wp_localize_script($this->N('admin'), $this->N('admin'), array(

'N' => $this->N()

));

$stylesToAdd = array(

basename(__FILE__,'.php') => 'plugin.admin.css' //add a stylesheet with the key matching the filename

);

// Have to manually add to in_footer

// Check if script is done, if not, then add to footer

foreach($stylesToAdd as $handle => $stylesheet){

wp_enqueue_style(

$handle //id

, plugins_url($stylesheet, __FILE__) //file

, array() //dependencies

, self::pluginVersion //version

, 'all' //media

);

}

}//--- function add_admin_headers

/**

function add_headers() {

//ignore the examples below

return;

if(is_admin()) return;

$stylesToAdd = array();

// Have to manually add to in_footer

// Check if script is done, if not, then add to footer

foreach($stylesToAdd as $style){

if (!in_array($style, $wp_styles->done) && !in_array($style, $wp_styles->in_footer)) {

$wp_styles->in_header[] = $style;

}

}

}//-- function add_headers

/**

function add_footers() {

if(is_admin()){

wp_enqueue_script($this->N('admin'));

return;

}

$scriptsToAdd = array( );

// Have to manually add to in_footer

// Check if script is done, if not, then add to footer

foreach($scriptsToAdd as $script){

if (!in_array($script, $wp_scripts->done) && !in_array($script, $wp_scripts->in_footer)) {

$wp_scripts->in_footer[] = $script;

}

}

}

#endregion =============== HEADER/FOOTER -- scripts and styles ===============

#region =============== Administrative Settings ========

private $_settings;

private $_services;

/**

function get_settings($stashed = true){

// TODO: if this ever changes, make sure to correspondingly fix 'upgrade.php'

if( $stashed && isset($this->_settings) ) return $this->_settings;

$this->_settings = get_option($this->N('settings'));

// but we only want the actual settings, not the services

$this->_settings = $this->_settings['debug'];

return $this->_settings;

}//--- get_settings

/**

function get_services($stashed = true) {

if( $stashed && isset($this->_services) ) return $this->_services;

$this->_services = get_option($this->N('settings'));

// but we only want service listing, not the settings

// TODO: this will go away once we move to custom post type like CF7

unset($this->_services['debug']);

return $this->_services;

}

function save_services($services) {

$settings = $this->get_settings(false);

$merged = array('debug' => $settings) + (array)$services;

update_option($this->N('settings'), $merged);

$this->_services = $services; // replace stash

}

function save_settings($settings) {

$services = $this->get_services(false);

$merged = array('debug' => $settings) + (array)$services;

update_option($this->N('settings'), $merged);

$this->_settings = $settings; // replace stash

}

/**

function submenu_config(){

wp_enqueue_script($this->N('admin'));

include_once('plugin-ui.php');

}

/**

function plugin_action_links( $links, $file ) {

if ( $file != plugin_basename( __FILE__ ) )

return $links;

$url = $this->plugin_admin_url( array( 'page' => basename(__FILE__, '.php').'-config' ) );

$settings_link = '<a title="Capability ' . self::adminOptionsCapability . ' required" href="' . esc_attr( $url ) . '">'

. esc_html( __( 'Settings', $this->N ) ) . '</a>';

array_unshift( $links, $settings_link );

return $links;

}

/**

function plugin_admin_url( $query = array() ) {

global $plugin_page;

if ( ! isset( $query['page'] ) )

$query['page'] = $plugin_page;

$path = 'admin.php';

if ( $query = build_query( $query ) )

$path .= '?' . $query;

$url = admin_url( $path );

return esc_url_raw( $url );

}

/**

public function form_select_input($forms, $eid, $selected, $field = 'forms'){

?>

<select class="multiple" multiple="multiple" id="<?php echo $field, '-', $eid?>" name="<?php echo "{$this->N}[$eid][$field][]"?>">

<?php

foreach($forms as $f){

$form_id = $f['id'];

$form_title = $f['title']; // as serialized option data

?>

<option <?php if($selected && in_array($form_id, $selected)): ?>selected="selected" <?php endif; ?>value="<?php echo esc_attr( $form_id );?>"><?php echo esc_html( $form_title ); ?></option>

<?php

}// foreach

?>

</select>

<?php

}//-- end function form_select_input

/**

public function selected_input($current, $expected, $type) {

if(in_array($expected, $current)) return " value='$expected' $type='$type'";

return " value='$expected'";

}

/**

public function selected_input_array($array, $currentKey, $expected, $type) {

return isset($array[$currentKey])

? $this->selected_input($array[$currentKey], $expected, $type)

: $this->selected_input(array(), $expected, $type);

}

#endregion =============== Administrative Settings ========

/**

function placeholder_separator($post) {

$new = array(); // add results to new so we don't pollute the enumerator

// find the arrays and reformat keys with index

###_log(__FUNCTION__ . '@' . __LINE__, $post);

foreach($post as $f => $v) {

// do we have a placeholder to fix for an array (iss #43)

if(is_array($v) && false !== strpos($f, '%i')) {

// for each item in the submission array,

// get its numerical index and replace the

// placeholder in the destination field

foreach($v as $i => $p) {

$k = str_replace('%i', $i, $f);

$new[$k] = $p;

}

unset($post[$f]); // now remove original, since we need to reattach under a different key

}

}

###_log(__FUNCTION__ . '@' . __LINE__, $new);

return array_merge($post, $new);

}

/**

function before_send($form, $submission = array()){

###_log(__LINE__.':'.__FILE__, ' begin before_send', $form);

$submissionInit = false; // only get the submission once when that we know we're going to use this service/form

//get field mappings and settings

$services = $this->get_services();

// unlikely, but skip handling if nothing to do

if(empty($services)) return $form;

$debug = $this->get_settings();

//loop services

foreach($services as $sid => $service):

$use_this_form = $this->use_form($form, $service, $sid);

if(!$use_this_form) continue;

// only get the submission once, now that we know we're going to use this service/form

if(false === $submissionInit) {

$submission = apply_filters($this->N('get_submission'), $submission, $form, $service);

$submissionInit = true;

}

// now we can conditionally check whether use the service based upon submission data

$use_this_form = apply_filters($this->N('use_submission'), $use_this_form, $submission, $sid);

if( !$use_this_form ) continue;

// populate the 3rdparty post args

$sendResult = $this->send($submission, $form, $service, $sid, $debug);

if($sendResult === self::RET_SEND_STOP) break;

elseif($sendResult === self::RET_SEND_SKIP) continue;

$response = $sendResult['response'];

$post_args = $sendResult['post_args'];

$form = $this->handle_results($submission, $response, $post_args, $form, $service, $sid, $debug);

endforeach; //-- loop services

###_log(__LINE__.':'.__FILE__, ' finished before_send', $form);

// some plugins expected usage is as filter, so return (modified?) form

return $form;

}//--- end function before_send

const RET_SEND_SKIP = -1;

const RET_SEND_STOP = -2;

const RET_SEND_OKAY = 1;

/**

public function use_form($form, $service, $sid) {

//check if we're supposed to use this service

if( !isset($service['forms']) || empty($service['forms']) ) return false; // nothing provided

// it's more like "use_this_service", actually...

$use_this_form = apply_filters($this->N('use_form'), false, $form, $sid, $service['forms']);

###_log('are we using this form?', $use_this_form ? "YES" : "NO", $sid, $service);

return $use_this_form;

}

/**

public function send($submission, $form, $service, $sid, $debug) {

$post = array();

if(!isset($service['delim']) || empty($service['delim']))

$service['delim'] = $debug['separator']; // alias here for reporting and using default

//find mapping

foreach($service['mapping'] as $mid => $mapping){

$third = $mapping[self::PARAM_3RD];

//is this static or dynamic (userinput)?

if(v($mapping['val'])){

$input = $mapping[self::PARAM_SRC];

}

else {

//check if we have that field in post data

if( !isset($submission[ $mapping[self::PARAM_SRC] ]) ) continue;

$input = $submission[ $mapping[self::PARAM_SRC] ];

}

//allow multiple values to attach to same entry

if( isset( $post[ $third ] ) ){

###echo "multiple @$mid - $fsrc, $third :=\n";

if(!is_array($post[$third])) {

$post[$third] = array($post[$third]);

}

$post[$third] []= $input;

}

else {

$post[$third] = $input;

}

}// foreach mapping

//extract special tags;

$post = apply_filters($this->N('service_filter_post_'.$sid), $post, $service, $form, $submission);

$post = apply_filters($this->N('service_filter_post'), $post, $service, $form, $sid, $submission);

// fix for multiple values

switch($service['delim']) {

case '[#]':

// don't do anything to include numerical index (default behavior of `http_build_query`)

break;

case '[%]':

// see github issue #43

$post = $this->placeholder_separator($post);

break;

case '[]':

// must build as querystring then strip `#` out of `[#]=`

$post = http_build_query($post);

$post = preg_replace('/%5B[0-9]+%5D=/', '%5B%5D=', $post);

break;

default:

// special case: newlines were escaped

if($service['delim'] == '\\r\\n') $service['delim'] = "\r\n";

elseif($service['delim'] == '\\n') $service['delim'] = "\n";

// otherwise, find the arrays and implode

foreach($post as $f => &$v) {

###_log('checking array', $f, $v, is_array($v) ? 'array' : 'notarray');

if(is_array($v)) $v = implode($service['delim'], $v);

}

break;

}

###_log(__LINE__.':'.__FILE__, ' sending post to '.$service['url'], $post);

// change args sent to remote post -- add headers, etc: http://codex.wordpress.org/Function_Reference/wp_remote_post

// optionally, return an array with 'response_bypass' set to skip the wp_remote_post in favor of whatever you did in the hook

$post_args = apply_filters($this->N('service_filter_args')

, array(

'timeout' => empty($service['timeout']) ? self::DEFAULT_TIMEOUT : $service['timeout']

,'body'=>$post

)

, $service

, $form

);

//remote call

// once more conditionally check whether use the service based upon (mapped) submission data

if(false === $post_args) return self::RET_SEND_SKIP;

// optional bypass -- replace with a SOAP call, etc

elseif(isset($post_args['response_bypass'])) {

$response = $post_args['response_bypass'];

}

else {

//@see http://planetozh.com/blog/2009/08/how-to-make-http-requests-with-wordpress/

// allow hooks to modify the URL with submission, like send as url-encoded XML, etc

$url = apply_filters($this->N('service_filter_url'), $service['url'], $post_args);

$response = isset($service['method']) && $service['method'] == 'get'

? wp_remote_get($url, $post_args)

: wp_remote_post($url, $post_args)

;

}

###pbug(__LINE__.':'.__FILE__, ' response from '.$service['url'], $response);

### _log(__LINE__.':'.__FILE__, ' response from '.$service['url'], $submission, $post_args, $response);

return array('response' => $response, 'post_args' => $post_args);

}//-- fn send

/**

public function handle_results($submission, $response, $post_args, $form, $service, $sid, $debug) {

$can_hook = true;

//if something went wrong with the remote-request "physically", warn

if (!is_array($response)) { //new occurrence of WP_Error?????

$response_array = array('safe_message'=>'error object', 'object'=>$response);

$form = $this->on_response_failure($form, $debug, $service, $post_args, $response_array);

$can_hook = false;

}

elseif(!$response

|| !isset($response['response'])

|| !isset($response['response']['code'])

|| ! apply_filters($this->N('is_success'), 200 <= $response['response']['code'] && $response['response']['code'] < 400, $response, $service)

) {

$response['safe_message'] = 'physical request failure';

$form = $this->on_response_failure($form, $debug, $service, $post_args, $response);

$can_hook = false;

}

//otherwise, check for a success "condition" if given

elseif(!empty($service['success'])) {

if(strpos($response['body'], $service['success']) === false){

$failMessage = array(

'reason'=>'Could not locate success clause within response'

, 'safe_message' => 'Success Clause not found'

, 'clause'=>$service['success']

, 'response'=>$response['body']

);

$form = $this->on_response_failure($form, $debug, $service, $post_args, $failMessage);

$can_hook = false;

}

}

if($can_hook){

###_log('performing hooks for:', $this->N.'_service_'.$sid);

//hack for pass-by-reference

//holder for callback return results

$callback_results = array('success'=>false, 'errors'=>false, 'attach'=>'', 'message' => '', 'redirect' => '');

// TODO: use object?

$param_ref = array(); foreach($callback_results as $k => &$v){ $param_ref[$k] = &$v; }

//allow hooks

do_action($this->N('service_a'.$sid), $response['body'], $param_ref);

do_action($this->N('service'), $response['body'], $param_ref, $sid);

###_log('after success', $form);

//check for callback errors; if none, then attach stuff to message if requested

if(!empty($callback_results['errors'])){

$failMessage = array(

'reason'=>'Service Callback Failure'

, 'safe_message' => 'Service Callback Failure'

, 'errors'=>$callback_results['errors']);

$form = $this->on_response_failure($form, $debug, $service, $post_args, $failMessage);

}

else {

###_log('before remote_success', $callback_results, $sid);

$form = apply_filters($this->N('remote_success'), $form, $callback_results, $service);

}

}// can hook

### _log(__FUNCTION__, $debug, strpos($debug['mode'], 'debug'));

//forced debug contact; support legacy setting too

if(isset($debug['mode']) && ($debug['mode'] == 'debug' || in_array('debug', $debug['mode'])) ) {

// TMI with new WP_HTTP_Requests_Response object

if( !is_a($response, 'WP_Error') && isset($response['http_response']) && is_object($response['http_response']) ) $response = $response['http_response'];

$this->send_debug_message($debug, $service, $post_args, $response, $submission);

}

return $form;

}

/**

private function send_debug_message($debug, $service, $post, $response, $submission){

// allow hooks to bypass, if for example we're not getting debug emails or we want to use some fancy logging service

$passthrough = apply_filters($this->N('debug_message'), true, $service, $post, $submission, $response, $debug);

// not all hosting services allow arbitrary emails

$sendAs = isset($debug['sender']) && !empty($debug['sender'])

? $debug['sender']

: get_bloginfo('admin_email'); //'From: "'.self::pluginPageTitle.' Debug" <'.$this->N.'-debug@' . str_replace('www.', '', $_SERVER['HTTP_HOST']) . '>';

$recipients = isset($debug['email']) && !empty($debug['email'])

? str_replace(';', ',', $debug['email'])

: get_bloginfo('admin_email');

// allow hook to alter dump truncation

$debug_truncation = apply_filters($this->N('debug_truncation'), array(

'service' => 5000,

'submission' => 200,

'post' => 2000,

'response' => 1000

));

// did the debug message send?

if( !$passthrough || !wp_mail( $recipients

, self::pluginPageTitle . " Debug: {$service['name']}"

, "*** Service ***\n".self::dump($service, $debug_truncation['service'])."\n*** Post (Form) ***\n" . get_bloginfo('url') . $_SERVER['REQUEST_URI'] . "\n".self::dump($submission, $debug_truncation['submission'])."\n*** Post (to Service) ***\n".self::dump($post, $debug_truncation['post'])."\n*** Response ***\n".self::dump($response, $debug_truncation['response'])

, array($sendAs)

) ) {

///TODO: log? another email? what?

error_log( sprintf("%s:%s could not send F3P debug email (to: %s) for service %s", __LINE__, __FILE__, $recipients, $service['url']) );

if(in_array('log', $debug['mode'])) {

$log = array(

'sendAs' => $sendAs,

'recipients' => $recipients,

'submission' => $submission,

'post' => $post,

'response' => $response

);

if(in_array('full', $debug['mode'])) $log['service'] = $service;

$as_json = is_array($post['body']) && isset($post['body']['_json']) && $post['body']['_json'];

$dump = $as_json

? wp_json_encode($log, defined('JSON_PRETTY_PRINT') ? JSON_PRETTY_PRINT : 0)

: print_r($log, true);

error_log( __CLASS__ . ':: ' . $dump );

}

}

}

/**

public static function dump($array, $length_limit = 200, $ignores = array(), $depth = '', $isBuffer = true) {

// maybe catch (if not recursive)

if($isBuffer) ob_start();

// trick loop

$array = (array) $array;

foreach($array as $k => $v) {

// maybe ignore?

if(in_array($k, $ignores)) continue;

// dump key

echo "{$depth}[{$k}] => ";

// dump value or recurse

if(is_array($v) || is_object($v)) {

echo is_array($v) ? 'Array (' : 'Object (';

echo "\n";

self::dump($v, $length_limit, $ignores, $depth . "\t", false);

echo "$depth)";

}

else if(is_string($v) && strlen($v) > $length_limit)

echo substr($v, 0, $length_limit), '...';

else

echo $v;

echo "\n";

}

// maybe uncatch (if not recursive)

if($isBuffer) {

$output = ob_get_contents();

ob_end_clean();

return $output;

}

}

/**

private function on_response_failure($form, $debug, $service, $post_args, $response){

// failure hooks; pass-by-value

$form = apply_filters($this->N('remote_failure'), $form, $debug, $service, $post_args, $response);

return $form;

}//--- end function on_response_failure

/**

public function send_service_error(&$service, &$debug, &$post, &$response, $form_title, $form_recipient, $debug_from_id) {

$body = sprintf('There was an error when trying to integrate with the 3rd party service {%2$s} (%3$s).%1$s%1$s**FORM**%1$sTitle: %6$s%1$sIntended Recipient: %7$s%1$sSource: %8$s%1$s%1$s**SUBMISSION**%1$s%4$s%1$s%1$s**RAW RESPONSE**%1$s%5$s'

, "\n"

, $service['name']

, $service['url']

, print_r($post, true)

, print_r($response, true)

, $form_title

, $form_recipient

, get_bloginfo('url') . $_SERVER['REQUEST_URI']

);

$subject = sprintf('%s-3rdParty Integration Failure: %s'

, $debug_from_id

, $service['name']

);

$headers = array(

sprintf('From: "%1$s-3rdparty Debug" <%1$s-3rdparty-debug@%2$s>'

, $debug_from_id

, str_replace('www.', '', $_SERVER['HTTP_HOST'])

)

);

//log if couldn't send debug email

if(wp_mail( $debug['email'], $subject, $body, $headers )) return true;

###$form->additional_settings .= "\n".'on_sent_ok: \'alert("Could not send debug warning '.$service['name'].'");\'';

error_log(__LINE__.':'.__FILE__ .' response failed from '.$service['url'].', could not send warning email: ' . print_r($response, true));

return false;

}//-- fn send_service_error

/**

public function format_failure_message(&$service, &$response, $original_message) {

return sprintf(

__($service['failure'], $this->N())

, $original_message

, __($response['safe_message'], $this->N())

);

}