/wp-content/plugins/ninja-forms/includes/Actions/Email.php
PHP | 411 lines | 258 code | 91 blank | 62 comment | 41 complexity | ac77c28a87bc8685fcbc564a60a9acb5 MD5 | raw file
Possible License(s): GPL-3.0
- <?php if ( ! defined( 'ABSPATH' ) ) exit;
- /**
- * Class NF_Action_Email
- */
- final class NF_Actions_Email extends NF_Abstracts_Action
- {
- /**
- * @var string
- */
- protected $_name = 'email';
- /**
- * @var array
- */
- protected $_tags = array();
- /**
- * @var string
- */
- protected $_timing = 'late';
- /**
- * @var int
- */
- protected $_priority = 10;
- /**
- * Constructor
- */
- public function __construct()
- {
- parent::__construct();
- $this->_nicename = __( 'Email', 'ninja-forms' );
- $settings = Ninja_Forms::config( 'ActionEmailSettings' );
- $this->_settings = array_merge( $this->_settings, $settings );
- $this->_backwards_compatibility();
- }
- /*
- * PUBLIC METHODS
- */
- public function process( $action_settings, $form_id, $data )
- {
- $action_settings = $this->sanitize_address_fields( $action_settings );
- $errors = $this->check_for_errors( $action_settings );
- $headers = $this->_get_headers( $action_settings );
- if ( has_filter( 'ninja_forms_get_fields_sorted' ) ) {
- $fields_by_key = array();
- foreach( $data[ 'fields' ] as $field ){
- if( is_null( $field ) ) continue;
- if( is_array( $field ) ){
- if( ! isset( $field[ 'key' ] ) ) continue;
- $key = $field[ 'key' ];
- } else {
- $key = $field->get_setting('key');
- }
- $fields_by_key[ $key ] = $field;
- }
- $data[ 'fields' ] = apply_filters( 'ninja_forms_get_fields_sorted', array(), $data[ 'fields' ], $fields_by_key, $form_id );
- }
- $attachments = $this->_get_attachments( $action_settings, $data );
- if( 'html' == $action_settings[ 'email_format' ] ) {
- $message = wpautop( $action_settings['email_message'] );
- } else {
- $message = $this->format_plain_text_message( $action_settings[ 'email_message_plain' ] );
- }
- $message = apply_filters( 'ninja_forms_action_email_message', $message, $data, $action_settings );
- try {
- /**
- * Hook into the email send to override functionality.
- * @return bool True if already sent. False to fallback to default behavior. Throw a new Exception if there is an error.
- */
- if( ! $sent = apply_filters( 'ninja_forms_action_email_send', false, $action_settings, $message, $headers, $attachments ) ){
- $sent = wp_mail($action_settings['to'], $action_settings['email_subject'], $message, $headers, $attachments);
- }
- } catch ( Exception $e ){
- $sent = false;
- $errors[ 'email_not_sent' ] = $e->getMessage();
- }
- if( is_user_logged_in() && current_user_can( 'manage_options' ) ) {
- $data[ 'actions' ][ 'email' ][ 'to' ] = $action_settings[ 'to' ];
- $data[ 'actions' ][ 'email' ][ 'headers' ] = $headers;
- $data[ 'actions' ][ 'email' ][ 'attachments' ] = $attachments;
- }
- $data[ 'actions' ][ 'email' ][ 'sent' ] = $sent;
- // Only show errors to Administrators.
- if( $errors && current_user_can( 'manage_options' ) ){
- $data[ 'errors' ][ 'form' ] = $errors;
- }
- if ( ! empty( $attachments ) ) {
- $this->_drop_csv();
- }
- return $data;
- }
- /**
- * Sanitizes email address settings
- * @since 3.2.2
- *
- * @param array $action_settings
- * @return array
- */
- protected function sanitize_address_fields( $action_settings )
- {
- // Build a look array to compare our email address settings to.
- $email_address_settings = array( 'to', 'from_address', 'reply_to', 'cc', 'bcc' );
- // Loop over the look up values.
- foreach( $email_address_settings as $setting ) {
- // If the loop up values are not set in the action settings continue.
- if ( ! isset( $action_settings[ $setting ] ) ) continue;
- // If action settings do not match the look up values continue.
- if ( ! $action_settings[ $setting ] ) continue;
- // This is the array that will contain the sanitized email address values.
- $sanitized_array = array();
- /*
- * Checks to see action settings is array,
- * if not explodes to comma delimited array.
- */
- if( is_array( $action_settings[ $setting ] ) ) {
- $email_addresses = $action_settings[ $setting ];
- } else {
- $email_addresses = explode( ',', $action_settings[ $setting ] );
- }
- // Loop over our email addresses.
- foreach( $email_addresses as $email ) {
- // Updated to trim values in case there is a value with spaces/tabs/etc to remove whitespace
- $email = trim( $email );
- if ( empty( $email ) ) continue;
- // Build our array of the email addresses.
- $sanitized_array[] = $email;
- }
- // Sanitized our array of settings.
- $action_settings[ $setting ] = implode( ',' ,$sanitized_array );
- }
- return $action_settings;
- }
- protected function check_for_errors( $action_settings )
- {
- $errors = array();
- $email_address_settings = array( 'to', 'from_address', 'reply_to', 'cc', 'bcc' );
- foreach( $email_address_settings as $setting ){
- if( ! isset( $action_settings[ $setting ] ) ) continue;
- if( ! $action_settings[ $setting ] ) continue;
- $email_addresses = is_array( $action_settings[ $setting ] ) ? $action_settings[ $setting ] : explode( ',', $action_settings[ $setting ] );
- foreach( (array) $email_addresses as $email ){
- $email = trim( $email );
- if ( false !== strpos( $email, '<' ) && false !== strpos( $email, '>' ) ) {
- preg_match('/(?:<)[^>]*(?:>)/', $email, $email);
- $email = $email[ 1 ];
- }
- if( ! is_email( $email ) ) {
- $errors[ 'invalid_email' ] = sprintf( __( 'Your email action "%s" has an invalid value for the "%s" setting. Please check this setting and try again.', 'ninja-forms'), $action_settings[ 'label' ], $setting );
- }
- }
- }
- return $errors;
- }
- private function _get_headers( $settings )
- {
- $headers = array();
- $headers[] = 'Content-Type: text/' . $settings[ 'email_format' ];
- $headers[] = 'charset=UTF-8';
- $headers[] = 'X-Ninja-Forms:ninja-forms'; // Flag for transactional email.
- $headers[] = $this->_format_from( $settings );
- $headers = array_merge( $headers, $this->_format_recipients( $settings ) );
- return $headers;
- }
- private function _get_attachments( $settings, $data )
- {
- $attachments = array();
- if( isset( $settings[ 'attach_csv' ] ) && 1 == $settings[ 'attach_csv' ] ){
- $attachments[] = $this->_create_csv( $data[ 'fields' ] );
- }
- if( ! isset( $settings[ 'id' ] ) ) $settings[ 'id' ] = '';
- $attachments = apply_filters( 'ninja_forms_action_email_attachments', $attachments, $data, $settings );
- return $attachments;
- }
- private function _format_from( $settings )
- {
- $from_name = get_bloginfo( 'name', 'raw' );
- $from_name = apply_filters( 'ninja_forms_action_email_from_name', $from_name );
- $from_name = ( $settings[ 'from_name' ] ) ? $settings[ 'from_name' ] : $from_name;
- $from_address = get_bloginfo( 'admin_email' );
- $from_address = apply_filters( 'ninja_forms_action_email_from_address', $from_address );
- $from_address = ( $settings[ 'from_address' ] ) ? $settings[ 'from_address' ] : $from_address;
- return $this->_format_recipient( 'from', $from_address, $from_name );
- }
- private function _format_recipients( $settings )
- {
- $headers = array();
- $recipient_settings = array(
- 'Cc' => $settings[ 'cc' ],
- 'Bcc' => $settings[ 'bcc' ],
- 'Reply-to' => $settings[ 'reply_to' ],
- );
- foreach( $recipient_settings as $type => $emails ){
- $emails = explode( ',', $emails );
- foreach( $emails as $email ) {
- if( ! $email ) continue;
- $matches = array();
- if (preg_match('/^"?(?<name>[^<"]+)"? <(?<email>[^>]+)>$/', $email, $matches)) {
- $headers[] = $this->_format_recipient($type, $matches['email'], $matches['name']);
- } else {
- $headers[] = $this->_format_recipient($type, $email);
- }
- }
- }
- return $headers;
- }
- private function _format_recipient( $type, $email, $name = '' )
- {
- $type = ucfirst( $type );
- if( ! $name ) $name = $email;
- $recipient = "$type: $name <$email>";
- return $recipient;
- }
- private function _create_csv( $fields )
- {
- $csv_array = array();
- // Get our current date.
- $date_format = Ninja_Forms()->get_setting( 'date_format' );
- $today = date( $date_format, current_time( 'timestamp' ) );
- $csv_array[ 0 ][] = 'Date Submitted';
- $csv_array[ 1 ][] = $today;
- foreach( $fields as $field ){
- $ignore = array(
- 'hr',
- 'submit',
- 'html',
- 'creditcardcvc',
- 'creditcardexpiration',
- 'creditcardfullname',
- 'creditcardnumber',
- 'creditcardzip',
- );
- $ignore = apply_filters( 'ninja_forms_csv_ignore_fields', $ignore );
- if( ! isset( $field[ 'label' ] ) ) continue;
- if( in_array( $field[ 'type' ], $ignore ) ) continue;
- $label = ( '' != $field[ 'admin_label' ] ) ? $field[ 'admin_label' ] : $field[ 'label' ];
- $value = WPN_Helper::stripslashes( $field[ 'value' ] );
- if ( empty( $value ) && ! isset( $value ) ) {
- $value = '';
- }
- if ( is_array( $value ) ) {
- $value = implode( ',', $value );
- }
- // add filter to add single quote if first character in value is '='
- $value = apply_filters( 'ninja_forms_subs_export_field_value_' . $field[ 'type' ], $value, $field );
- $csv_array[ 0 ][] = $label;
- $csv_array[ 1 ][] = $value;
- }
- $csv_content = WPN_Helper::str_putcsv( $csv_array,
- apply_filters( 'ninja_forms_sub_csv_delimiter', ',' ),
- apply_filters( 'ninja_forms_sub_csv_enclosure', '"' ),
- apply_filters( 'ninja_forms_sub_csv_terminator', "\n" )
- );
- $upload_dir = wp_upload_dir();
- $path = trailingslashit( $upload_dir['path'] );
- // create temporary file
- $path = tempnam( $path, 'Sub' );
- $temp_file = fopen( $path, 'r+' );
- // write to temp file
- fwrite( $temp_file, $csv_content );
- fclose( $temp_file );
- // find the directory we will be using for the final file
- $path = pathinfo( $path );
- $dir = $path['dirname'];
- $basename = $path['basename'];
- // create name for file
- $new_name = apply_filters( 'ninja_forms_submission_csv_name', 'ninja-forms-submission' );
- // remove a file if it already exists
- if( file_exists( $dir.'/'.$new_name.'.csv' ) ) {
- unlink( $dir.'/'.$new_name.'.csv' );
- }
- // move file
- rename( $dir.'/'.$basename, $dir.'/'.$new_name.'.csv' );
- return $dir.'/'.$new_name.'.csv';
- }
- /**
- * Function to delete csv file from temp directory after Email Action has completed.
- */
- private function _drop_csv()
- {
- $upload_dir = wp_upload_dir();
- $path = trailingslashit( $upload_dir['path'] );
- // create name for file
- $new_name = apply_filters( 'ninja_forms_submission_csv_name', 'ninja-forms-submission' );
- // remove a file if it already exists
- if( file_exists( $path.'/'.$new_name.'.csv' ) ) {
- unlink( $path.'/'.$new_name.'.csv' );
- }
- }
- /*
- * Backwards Compatibility
- */
- private function _backwards_compatibility()
- {
- add_filter( 'ninja_forms_sub_csv_delimiter', array( $this, 'ninja_forms_sub_csv_delimiter' ), 10, 1 );
- add_filter( 'ninja_sub_csv_enclosure', array( $this, 'ninja_sub_csv_enclosure' ), 10, 1 );
- add_filter( 'ninja_sub_csv_terminator', array( $this, 'ninja_sub_csv_terminator' ), 10, 1 );
- add_filter( 'ninja_forms_action_email_attachments', array( $this, 'ninja_forms_action_email_attachments' ), 10, 3 );
- }
- public function ninja_forms_sub_csv_delimiter( $delimiter )
- {
- return apply_filters( 'nf_sub_csv_delimiter', $delimiter );
- }
- public function ninja_sub_csv_enclosure( $enclosure )
- {
- return apply_filters( 'nf_sub_csv_enclosure', $enclosure );
- }
- public function ninja_sub_csv_terminator( $terminator )
- {
- return apply_filters( 'nf_sub_csv_terminator', $terminator );
- }
- public function ninja_forms_action_email_attachments( $attachments, $form_data, $action_settings )
- {
- return apply_filters( 'nf_email_notification_attachments', $attachments, $action_settings[ 'id' ] );
- }
- private function format_plain_text_message( $message )
- {
- $message = str_replace( array( '<table>', '</table>', '<tr><td>', '' ), '', $message );
- $message = str_replace( '</td><td>', ' ', $message );
- $message = str_replace( '</td></tr>', "\r\n", $message );
- return strip_tags( $message );
- }
- }