Your IP : 216.73.216.95
<?php
/**
* Email Notification
*
* This class handles all email notification settings.
*
* @package Give
* @subpackage Classes/Emails
* @copyright Copyright (c) 2016, GiveWP
* @license https://opensource.org/licenses/gpl-license GNU Public License
* @since 2.0
*/
// Exit if access directly.
if ( ! defined( 'ABSPATH' ) ) {
exit;
}
if ( ! class_exists( 'Give_Email_Notification' ) ) :
/**
* Give_Email_Notification
*
* @abstract
* @since 2.0
*/
abstract class Give_Email_Notification {
/**
* Array of instances
*
* @since 2.0
* @access private
* @var array
*/
private static $singleton = array();
/**
* Array of notification settings.
*
* @since 2.0
* @access public
* @var array
*/
public $config = array(
'id' => '',
'label' => '',
'description' => '',
'has_recipient_field' => false,
'recipient_group_name' => '',
'notification_status' => 'disabled',
'notification_status_editable' => true,
'notices' => array(),
'content_type_editable' => true,
'has_preview' => true,
'has_preview_header' => true,
'preview_email_tags_values' => array(),
'email_tag_context' => 'all',
'form_metabox_setting' => true,
'content_type' => '',
'email_template' => '',
'default_email_subject' => '',
'default_email_message' => '',
'default_email_header' => '',
// This setting page will appear under core setting.
'show_on_emails_setting_page' => true,
'form_metabox_id' => 'give_email_notification_options_metabox_fields',
);
/**
* @var string $recipient_email Donor email.
* @access protected
* @since 2.0
*/
protected $recipient_email = '';
/**
* Setup email notification.
*
* @since 2.0
*/
public function init() {
}
/**
* Get instance.
*
* @since 2.0
* @access public
*
* @param string $email_notification_id
*
* @return Give_Email_Notification
*/
public static function get_instance( $email_notification_id = '' ) {
$class = '';
if ( ! empty( $email_notification_id ) ) {
/* @var Give_Email_Notification $class */
foreach ( self::$singleton as $class ) {
if ( $email_notification_id === $class->config['id'] ) {
$class = get_class( $class );
break;
}
}
} else {
$class = get_called_class();
}
if ( ! empty( $class ) && ( ! array_key_exists( $class, self::$singleton ) || is_null( self::$singleton[ $class ] ) ) ) {
self::$singleton[ $class ] = new $class();
}
return ( isset( self::$singleton[ $class ] ) ? self::$singleton[ $class ] : null );
}
/**
* Setup action and filters.
*
* @access public
* @since 2.0
*
* @param array $config
*/
public function load( $config ) {
// Set notification configuration.
$this->config = wp_parse_args( $config, $this->config );
// Set email preview header status.
$this->config['has_preview_header'] = $this->config['has_preview'] && $this->config['has_preview_header'] ? true : false;
// Set email content type
$this->config['content_type'] = empty( $this->config['content_type'] ) || ! in_array(
$this->config['content_type'],
array(
'text/html',
'text/plain',
)
)
? Give()->emails->get_content_type()
: $this->config['content_type'];
$this->config['content_type'] = give_get_option( Give_Email_Setting_Field::get_prefix( $this ) . 'email_content_type', $this->config['content_type'] );
// Set email template type.
$this->config['email_template'] = empty( $this->config['email_template'] )
? give_get_option( 'email_template' )
: $this->config['email_template'];
// Set recipient group name.
$this->config['recipient_group_name'] = empty( $this->config['recipient_group_name'] )
? ( ! Give_Email_Notification_Util::has_recipient_field( $this ) ? __( 'Donor', 'give' ) : '' )
: $this->config['recipient_group_name'];
// Non notification status editable notice.
$this->config['notices']['non-notification-status-editable'] = empty( $this->config['notices']['non-notification-status-editable'] )
? __( 'You can not edit notification status from here.', 'give' )
: $this->config['notices']['non-notification-status-editable'];
/**
* Filter the notification config.
*
* @since 2.0
*
* @param array Give_Email_Notification::config
* @param Give_Email_Notification $this
*/
$this->config = apply_filters( 'give_email_api_notification_config', $this->config, $this );
// Setup filters.
$this->setup_filters();
}
/**
* Setup filters.
*
* @since 2.0
* @access public
*/
private function setup_filters() {
// Do not setup filters if not admin.
if ( ! is_admin() ) {
return;
}
// Apply filter only for current email notification section.
if ( isset( $_GET['section'] ) && give_get_current_setting_section() === $this->config['id'] ) {
// Initialize email context for email notification.
$this->config['email_tag_context'] = apply_filters(
"give_{$this->config['id']}_email_tag_context",
$this->config['email_tag_context'],
$this
);
}
// Setup setting fields.
if ( $this->config['show_on_emails_setting_page'] ) {
add_filter( 'give_get_settings_emails', array( $this, 'add_setting_fields' ), 10, 2 );
}
if ( $this->config['form_metabox_setting'] && ! empty( $this->config['form_metabox_id'] ) ) {
add_filter(
$this->config['form_metabox_id'],
array( $this, 'add_metabox_setting_field' ),
10,
2
);
}
if ( $this->config['has_recipient_field'] ) {
add_action(
"give_save__give_{$this->config['id']}_recipient",
array( $this, 'validate_form_recipient_field_value' ),
10,
3
);
}
/**
* Filter the default email subject.
*
* @since 2.0
*/
$this->config['default_email_subject'] = apply_filters(
"give_{$this->config['id']}_get_default_email_subject",
$this->config['default_email_subject'],
$this
);
/**
* Filter the default email message.
*
* @since 2.0
*/
$this->config['default_email_message'] = apply_filters(
"give_{$this->config['id']}_get_default_email_message",
$this->config['default_email_message'],
$this
);
/**
* Filter the default email header.
*
* @since 2.1.3
*/
$this->config['default_email_header'] = apply_filters(
"give_{$this->config['id']}_get_default_email_header",
$this->config['default_email_header'],
$this
);
}
/**
* Add sections.
*
* @since 2.0
*
* @param array $sections
*
* @return array
*/
public function add_section( $sections ) {
$sections[ $this->config['id'] ] = $this->config['label'];
return $sections;
}
/**
* Add sections.
*
* @since 2.0
*
* @param bool $hide_section
*
* @return bool
*/
public function hide_section( $hide_section ) {
$hide_section = true;
return $hide_section;
}
/**
* Register email settings.
*
* @since 2.0
* @access public
*
* @param array $settings
*
* @return array
*/
public function add_setting_fields( $settings ) {
if ( $this->config['id'] === give_get_current_setting_section() ) {
$settings = $this->get_setting_fields();
}
return $settings;
}
/**
* Get setting fields
*
* @since 2.0
* @access public
*
* @param int $form_id
*
* @return array
*/
public function get_setting_fields( $form_id = null ) {
return Give_Email_Setting_Field::get_setting_fields( $this, $form_id );
}
/**
* Register email settings to form metabox.
*
* @since 2.0
* @access public
*
* @param array $settings
* @param int $form_id
*
* @return array
*/
public function add_metabox_setting_field( $settings, $form_id ) {
if ( Give_Email_Notification_Util::is_email_notification_active( $this ) ) {
$settings[] = array(
'id' => $this->config['id'],
'title' => $this->config['label'],
'fields' => $this->get_setting_fields( $form_id ),
);
}
return $settings;
}
/**
* Get extra setting field.
*
* @since 2.0
* @access public
*
* @param int $form_id
*
* @return array
*/
public function get_extra_setting_fields( $form_id = null ) {
return array();
}
/**
* Get recipient(s).
*
* Note: in case of admin notification this fx will return array of emails otherwise empty string or email of donor.
*
* @since 2.0
* @access public
*
* @param int $form_id
*
* @return string|array
*/
public function get_recipient( $form_id = null ) {
if ( empty( $this->recipient_email ) && $this->config['has_recipient_field'] ) {
$this->recipient_email = Give_Email_Notification_Util::get_value(
$this,
Give_Email_Setting_Field::get_prefix( $this, $form_id ) . 'recipient',
$form_id
);
/**
* Filter the admin notice emails.
*
* @since 1.0
* @deprecated 2.0
*/
$this->recipient_email = apply_filters( 'give_admin_notice_emails', $this->recipient_email, $this, $form_id );
}
/**
* Filter the recipients
*
* @since 2.0
*/
return apply_filters(
"give_{$this->config['id']}_get_recipients",
give_check_variable(
$this->recipient_email,
'empty',
Give()->emails->get_from_address()
),
$this,
$form_id
);
}
/**
* Get notification status.
*
* @since 2.0
* @access public
*
* @param int $form_id
*
* @return bool
*/
public function get_notification_status( $form_id = null ) {
$notification_status = empty( $form_id )
? give_get_option( "{$this->config['id']}_notification", $this->config['notification_status'] )
: give_get_meta( $form_id, Give_Email_Setting_Field::get_prefix( $this, $form_id ) . 'notification', true, 'global' );
/**
* Filter the notification status.
*
* @since 1.8
*/
return apply_filters(
"give_{$this->config['id']}_get_notification_status",
$notification_status,
$this,
$form_id
);
}
/**
* Get email subject.
*
* @since 2.0
* @access public
*
* @param int $form_id
*
* @return string
*/
function get_email_subject( $form_id = null ) {
$subject = wp_strip_all_tags(
Give_Email_Notification_Util::get_value(
$this,
Give_Email_Setting_Field::get_prefix( $this, $form_id ) . 'email_subject',
$form_id,
$this->config['default_email_subject']
)
);
/**
* Filter the subject.
*
* @since 2.0
*/
return apply_filters(
"give_{$this->config['id']}_get_email_subject",
$subject,
$this,
$form_id
);
}
/**
* Get email message.
*
* @since 2.0
* @access public
*
* @param int $form_id
*
* @return string
*/
public function get_email_message( $form_id = null ) {
$message = Give_Email_Notification_Util::get_value(
$this,
Give_Email_Setting_Field::get_prefix( $this, $form_id ) . 'email_message',
$form_id,
$this->config['default_email_message']
);
/**
* Filter the message.
*
* @since 2.0
*/
return apply_filters(
"give_{$this->config['id']}_get_email_message",
$message,
$this,
$form_id
);
}
/**
* Get email header.
*
* @param int $form_id The Form ID.
*
* @since 2.1.3
*
* @return string
*/
public function get_email_header( $form_id = null ) {
$header = Give_Email_Notification_Util::get_value(
$this,
Give_Email_Setting_Field::get_prefix( $this, $form_id ) . 'email_header',
$form_id,
$this->config['default_email_header']
);
/**
* Filter the header.
*
* @since 2.1.3
*/
return apply_filters(
"give_{$this->config['id']}_get_email_header",
$header,
$this,
$form_id
);
}
/**
* Get email content type.
*
* @since 2.0
* @access public
*
* @param $form_id
*
* @return string
*/
public function get_email_content_type( $form_id ) {
$content_type = Give_Email_Notification_Util::get_value(
$this,
Give_Email_Setting_Field::get_prefix( $this, $form_id ) . 'email_content_type',
$form_id,
$this->config['content_type']
);
/**
* Filter the email content type.
*
* @since 2.0
*/
return apply_filters(
"give_{$this->config['id']}_get_email_content_type",
$content_type,
$this,
$form_id
);
}
/**
* Get email template.
*
* @since 2.0
* @access public
*
* @param $form_id
*
* @return string
*/
public function get_email_template( $form_id ) {
$email_template = give_get_meta( $form_id, '_give_email_template', true );
$email_template = Give_Email_Notification_Util::get_value(
$this,
Give_Email_Setting_Field::get_prefix( $this, $form_id ) . 'email_template',
$form_id,
! empty( $email_template ) && Give_Email_Notification_Util::can_use_form_email_options( $this, $form_id ) ?
$email_template :
$this->config['email_template']
);
/**
* Filter the email template.
*
* @since 2.0
*/
return apply_filters(
"give_{$this->config['id']}_get_email_template",
$email_template,
$this,
$form_id
);
}
/**
* Get allowed email tags for current email notification.
*
* @since 2.0
* @access private
*
* @param bool $formatted
*
* @return array
*/
public function get_allowed_email_tags( $formatted = false ) {
// Get all email tags.
$email_tags = Give()->email_tags->get_tags();
// Skip if all email template tags context setup exit.
if ( $this->config['email_tag_context'] && 'all' !== $this->config['email_tag_context'] ) {
$email_context = (array) $this->config['email_tag_context'];
foreach ( $email_tags as $index => $email_tag ) {
if ( in_array( $email_tag['context'], $email_context ) ) {
continue;
}
unset( $email_tags[ $index ] );
}
}
/**
* Disallow tags on Email Notifications which don't have a
* recipient and if the tag's is_admin property is set to true.
*/
if ( false === $this->config['has_recipient_field'] ) {
foreach ( $email_tags as $index => $email_tag ) {
if ( true === $email_tag['is_admin'] ) {
unset( $email_tags[ $index ] );
}
}
}
if ( count( $email_tags ) && $formatted ) :
ob_start() ?>
<ul class="give-email-tags-wrap">
<?php foreach ( $email_tags as $email_tag ) : ?>
<li class="give_<?php echo $email_tag['tag']; ?>_tag">
<code>{<?php echo $email_tag['tag']; ?>}</code> - <?php echo $email_tag['desc']; ?>
</li>
<?php endforeach; ?>
</ul>
<?php
$email_tags = ob_get_clean();
endif;
return $email_tags;
}
/**
* Get preview email recipients.
*
* @since 2.0
* @access public
*
* @param int $form_id
*
* @return array|string
*/
public function get_preview_email_recipient( $form_id = null ) {
$recipients = $this->get_recipient( $form_id );
/**
* Filter the preview email recipients.
*
* @since 2.0
*
* @param string|array $recipients List of recipients.
* @param Give_Email_Notification $this
*/
$recipients = apply_filters( 'give_get_preview_email_recipient', $recipients, $this, $form_id );
return $recipients;
}
/**
* Get the recipient attachments.
*
* @since 2.0
* @access public
*
* @param int $form_id
*
* @return array
*/
public function get_email_attachments( $form_id = null ) {
/**
* Filter the attachment.
*
* @since 2.0
*/
return apply_filters( "give_{$this->config['id']}_get_email_attachments", array(), $this, $form_id );
}
/**
* Send preview email.
*
* @since 2.0
* @access public
*
* @param bool $send Flag to check if send email or not.
*
* @return bool
*/
public function send_preview_email( $send = true ) {
// Get form id
$form_id = ! empty( $_GET['form_id'] ) ? absint( $_GET['form_id'] ) : null;
// setup email data.
$this->setup_email_data();
$attachments = $this->get_email_attachments();
$message = $this->preview_email_template_tags( $this->get_email_message( $form_id ) );
$subject = $this->preview_email_template_tags( $this->get_email_subject( $form_id ) );
$content_type = $this->get_email_content_type( $form_id );
// Setup email content type.
Give()->emails->__set( 'content_type', $content_type );
Give()->emails->__set( 'html', true );
// Setup email template
Give()->emails->__set( 'template', $this->get_email_template( $form_id ) );
// Set email header.
Give()->emails->__set( 'heading', $this->preview_email_template_tags( $this->get_email_header( $form_id ) ) );
// Format plain content type email.
if ( 'text/plain' === $content_type ) {
Give()->emails->__set( 'html', false );
Give()->emails->__set( 'template', 'none' );
$message = strip_tags( $message );
}
if ( Give_Email_Notification_Util::can_use_form_email_options( $this, $form_id ) ) {
Give()->emails->form_id = $form_id;
Give()->emails->from_name = give_get_meta( $form_id, '_give_from_name', true );
Give()->emails->from_address = give_get_meta( $form_id, '_give_from_email', true );
}
return $send
? Give()->emails->send( $this->get_preview_email_recipient( $form_id ), $subject, $message, $attachments )
: false;
}
/**
* Send email notification.
*
* Note: To render email tags in all context certain parameters are necessary for core (includes/emails/class-give-emails):
* 1. payment_id
* 2. user_id
* 3. form_id
* 4. donor_id
* 5. for third party email tags you can pass necessary param along above parameters other value replace by empty string.
*
* @since 2.0
* @access public
*
* @param array $email_tag_args Arguments which helps to decode email template tags.
*
* @return bool
*/
public function send_email_notification( $email_tag_args = array() ) {
/**
* Fire the filter
*
* @since 2.2.3
*/
if ( apply_filters( 'give_is_stop_email_notification', false, $this ) ) {
return false;
}
// Add email content type email tags.
$email_tag_args['email_content_type'] = $this->config['content_type'];
/**
* Filter the email tag args
*
* @since 2.0
*/
$email_tag_args = apply_filters( "give_{$this->config['id']}_email_tag_args", $email_tag_args, $this );
// Get form id.
$form_id = ! empty( $email_tag_args['form_id'] )
? absint( $email_tag_args['form_id'] )
: ( ! empty( $email_tag_args['payment_id'] ) ? give_get_payment_form_id( $email_tag_args['payment_id'] ) : null );
// Do not send email if notification is disabled.
if ( ! Give_Email_Notification_Util::is_email_notification_active( $this, $form_id ) ) {
return false;
}
/**
* Fire action after before email send.
*
* @since 2.0
*/
do_action( "give_{$this->config['id']}_email_send_before", $this, $form_id );
$attachments = $this->get_email_attachments();
$message = give_do_email_tags( $this->get_email_message( $form_id ), $email_tag_args );
$subject = give_do_email_tags( $this->get_email_subject( $form_id ), $email_tag_args );
$content_type = $this->get_email_content_type( $form_id );
// Setup email content type.
Give()->emails->__set( 'content_type', $content_type );
Give()->emails->__set( 'html', true );
// Set email template.
Give()->emails->__set( 'template', $this->get_email_template( $form_id ) );
// Set email header.
Give()->emails->__set( 'heading', give_do_email_tags( $this->get_email_header( $form_id ), $email_tag_args ) );
if ( 'text/plain' === $content_type ) {
Give()->emails->__set( 'html', false );
Give()->emails->__set( 'template', 'none' );
$message = strip_tags( $message );
}
if ( Give_Email_Notification_Util::can_use_form_email_options( $this, $form_id ) ) {
Give()->emails->form_id = $form_id;
Give()->emails->from_name = give_get_meta( $form_id, '_give_from_name', true );
Give()->emails->from_address = give_get_meta( $form_id, '_give_from_email', true );
}
// Send email.
$email_status = Give()->emails->send( $this->get_recipient( $form_id ), $subject, $message, $attachments );
/**
* Fire action after after email send.
*
* @since 2.0
*/
do_action( "give_{$this->config['id']}_email_send_after", $email_status, $this, $form_id );
return $email_status;
}
/**
* Decode preview email template tags.
*
* @since 2.0
*
* @param string $message Email Template Message.
*
* @return string
*/
public function preview_email_template_tags( $message ) {
$get_data = give_clean( filter_input_array( INPUT_GET ) );
// Set Payment.
$payment_id = give_check_variable( $get_data, 'isset_empty', 0, 'preview_id' );
$payment = $payment_id ? new Give_Payment( $payment_id ) : new stdClass();
// Set donor.
$user_id = $payment_id
? $payment->user_id
: give_check_variable( $get_data, 'isset_empty', 0, 'user_id' );
$user_id = $user_id ? $user_id : wp_get_current_user()->ID;
$receipt_link_url = give_get_receipt_url( $payment_id );
$receipt_link = give_get_receipt_link( $payment_id );
// Set default values for tags.
$this->config['preview_email_tags_values'] = wp_parse_args(
$this->config['preview_email_tags_values'],
array(
'name' => give_email_tag_first_name(
array(
'payment_id' => $payment_id,
'user_id' => $user_id,
)
),
'fullname' => give_email_tag_fullname(
array(
'payment_id' => $payment_id,
'user_id' => $user_id,
)
),
'username' => give_email_tag_username(
array(
'payment_id' => $payment_id,
'user_id' => $user_id,
)
),
'user_email' => give_email_tag_user_email(
array(
'payment_id' => $payment_id,
'user_id' => $user_id,
)
),
'payment_total' => $payment_id ? give_email_tag_payment_total( array( 'payment_id' => $payment_id ) ) : give_currency_filter( '10.50' ),
'amount' => $payment_id ? give_email_tag_amount( array( 'payment_id' => $payment_id ) ) : give_currency_filter( '10.50' ),
'price' => $payment_id ? give_email_tag_price( array( 'payment_id' => $payment_id ) ) : give_currency_filter( '10.50' ),
'payment_method' => $payment_id ? give_email_tag_payment_method( array( 'payment_id' => $payment_id ) ) : __( 'PayPal', 'give' ),
'payment_id' => $payment_id ? $payment_id : rand( 2000, 2050 ),
'receipt_link_url' => $receipt_link_url,
'receipt_link' => $receipt_link,
'date' => $payment_id ? date( give_date_format(), strtotime( $payment->date ) ) : date( give_date_format(), current_time( 'timestamp' ) ),
'donation' => $payment_id ? give_email_tag_donation( array( 'payment_id' => $payment_id ) ) : esc_html__( 'Sample Donation Form Title', 'give' ),
'form_title' => $payment_id ? give_email_tag_form_title( array( 'payment_id' => $payment_id ) ) : esc_html__( 'Sample Donation Form Title - Sample Donation Level', 'give' ),
'sitename' => $payment_id ? give_email_tag_sitename( array( 'payment_id' => $payment_id ) ) : get_bloginfo( 'name' ),
'billing_address' => $payment_id ? give_email_tag_billing_address( array( 'payment_id' => $payment_id ) ) : '',
'email_access_link' => sprintf(
'<a href="%1$s">%2$s</a>',
add_query_arg(
array(
'give_nl' => uniqid(),
),
give_get_history_page_uri()
),
__( 'View your donation history »', 'give' )
),
'donation_history_link' => sprintf(
'<a href="%1$s">%2$s</a>',
add_query_arg(
array(
'give_nl' => uniqid(),
),
give_get_history_page_uri()
),
__( 'View your donation history »', 'give' )
),
'reset_password_link' => $user_id ? give_email_tag_reset_password_link( array( 'user_id' => $user_id ), $payment_id ) : '',
'site_url' => sprintf(
'<a href="%1$s">%2$s</a>',
get_bloginfo( 'url' ),
get_bloginfo( 'url' )
),
'admin_email' => give_email_admin_email(),
'offline_mailing_address' => give_email_offline_mailing_address(),
'donor_comment' => $payment_id ? give_email_donor_comment( array( 'payment_id' => $payment_id ) ) : esc_html__( 'Sample Donor Comment', 'give' ),
)
);
// Decode tags.
foreach ( $this->config['preview_email_tags_values'] as $preview_tag => $value ) {
if ( isset( $this->config['preview_email_tags_values'][ $preview_tag ] ) ) {
$message = str_replace( "{{$preview_tag}}", $this->config['preview_email_tags_values'][ $preview_tag ], $message );
}
}
return apply_filters( 'give_email_preview_template_tags', $message );
}
/**
* Setup email data
*
* @since 2.0
*/
public function setup_email_data() {
}
/**
* Validate email form setting
*
* Note: internal use only
*
* @since 2.0
* @access public
*
* @param $form_meta_key
* @param $form_meta_value
* @param $post_id
*/
public function validate_form_recipient_field_value( $form_meta_key, $form_meta_value, $post_id ) {
// Get valid emails.
$new_form_meta_value = array_filter(
$form_meta_value,
function ( $value ) {
return ! empty( $value['email'] ) && is_email( $value['email'] );
}
);
// Remove duplicate emails from array.
$email_arr = array();
foreach ( $new_form_meta_value as $index => $email ) {
if ( in_array( $email['email'], $email_arr ) ) {
unset( $new_form_meta_value[ $index ] );
continue;
}
$email_arr[] = $email['email'];
}
$update = false;
if ( empty( $new_form_meta_value ) ) {
// Set default recipient.
$form_meta_value = array(
array(
'email' => get_bloginfo( 'admin_email' ),
),
);
$update = true;
} elseif ( count( $new_form_meta_value ) !== count( $form_meta_value ) ) {
// Filter recipient emails.
$form_meta_value = $new_form_meta_value;
$update = true;
}
if ( $update ) {
give_update_meta( $post_id, $form_meta_key, $form_meta_value );
}
}
}
endif; // End class_exists check