Email_Service::action() - Code Metrics - Inspection of "Add the beginnings of a dedicated page for extensi..." - humanmade/backupwordpress - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#909)

by Paul

created 2016-03-14 15:18 UTC

Email_Service::action() B

↳ Parent: Email_Service

Complexity

Conditions	9
Paths	9

Size

Total Lines	56
Code Lines	24

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	1	Features	0

Metric	Value
c	2
b	1
f	0
dl	0
loc	56
rs	7.1584
cc	9
eloc	24
nc	9
nop	2

How to fix Long Method

<?php

namespace HM\BackUpWordPress;

/**
 * Email notifications for backups
 *
 * @extends Service
 */
class Email_Service extends Service {

	/**
	 * Human readable name for this service
	 * @var string
	 */
	public $name = 'Email';

	/**
	 * Output the email form field
	 *
	 * @access  public
	 */
	public function field() {

	?>

		<tr>

			<th scope="row">
				<label for="<?php echo esc_attr( $this->get_field_name( 'email' ) ); ?>"><?php _e( 'Email notification', 'backupwordpress' ); ?></label>
			</th>

			<td>
				<input type="text" id="<?php echo esc_attr( $this->get_field_name( 'email' ) ); ?>" name="<?php echo esc_attr( $this->get_field_name( 'email' ) ); ?>" value="<?php echo esc_attr( $this->get_field_value( 'email' ) ); ?>" placeholder="[email protected]" />

				<p class="description"><?php printf( __( 'Receive a notification email when a backup completes. If the backup is small enough (&lt; %s), then it will be attached to the email. Separate multiple email addresses with a comma.', 'backupwordpress' ), '<code>' . size_format( get_max_attachment_size() ) . '</code>' ); ?></p>
			</td>

		</tr>

	<?php }

	/**
	 * Not used as we only need a field
	 *
	 * @see  field
	 * @return string Empty string
	 */
	public function form() {
		return '';
	}

	public static function constant() {

	?>

		<tr<?php if ( defined( 'HMBKP_ATTACHMENT_MAX_FILESIZE' ) ) { ?> class="hmbkp_active"<?php } ?>>

			<td><code>HMBKP_ATTACHMENT_MAX_FILESIZE</code></td>

			<td>

				<?php if ( defined( 'HMBKP_ATTACHMENT_MAX_FILESIZE' ) ) { ?>
				<p><?php printf( __( 'You\'ve set it to: %s', 'backupwordpress' ), '<code>' . HMBKP_ATTACHMENT_MAX_FILESIZE . '</code>' ); ?></p>
				<?php } ?>

				<p><?php printf( __( 'The maximum filesize of your backup that will be attached to your notification emails . Defaults to %s.', 'backupwordpress' ), '<code>10MB</code>' ); ?> <?php _e( 'e.g.', 'backupwordpress' ); ?> <code>define( 'HMBKP_ATTACHMENT_MAX_FILESIZE', '25MB' );</code></p>

			</td>

		</tr>

	<?php }

	/**
	 * The sentence fragment that is output as part of the schedule sentence
	 *
	 * @return string
	 */
	public function display() {

		if ( $emails = $this->get_email_address_array() ) {

			$email = '<code>' . implode( '</code>, <code>', array_map( 'esc_html', $emails ) ) . '</code>';

			return sprintf( __( 'Send an email notification to %s', 'backupwordpress' ), $email );

		}

		return '';

	}

	/**
	 * Used to determine if the service is in use or not
	 */
	public function is_service_active() {
		return (bool) $this->get_email_address_array();
	}

	/**
	 * Validate the email and return an error if validation fails
	 *
	 * @param  array  &$new_data Array of new data, passed by reference
	 * @param  array  $old_data  The data we are replacing
	 * @return null|array        Null on success, array of errors if validation failed

	 */
	public function update( &$new_data, $old_data ) {

		$errors = array();

		if ( isset( $new_data['email'] ) ) {

			if ( ! empty( $new_data['email'] ) ) {

				foreach ( explode( ',', $new_data['email'] ) as $email ) {

					$email = trim( $email );

					if ( ! is_email( $email ) ) {
						$errors['email'] = sprintf( __( '%s isn\'t a valid email',  'backupwordpress' ), $email );
					}
				}
			}

			if ( ! empty( $errors['email'] ) ) {
				$new_data['email'] = '';
			}

			return $errors;

		}
	}

	/**
	 * Get an array or validated email address's
	 * @return array An array of validated email address's
	 */
	private function get_email_address_array() {
		$emails = array_map( 'trim', explode( ',', $this->get_field_value( 'email' ) ) );
		return array_filter( array_unique( $emails ), 'is_email' );
	}

	/**
	 * Fire the email notification on the hmbkp_backup_complete
	 *
	 * @see  Backup::do_action
	 * @param  string $action The action received from the backup
	 * @return void
	 */
	public function action( $action, Backup $backup ) {

		if ( 'hmbkp_backup_complete' === $action && $this->get_email_address_array() ) {

			$file = $backup->get_backup_filepath();

			$sent = false;

			$download = add_query_arg( 'hmbkp_download', base64_encode( $file ), HMBKP_ADMIN_URL );
			$domain   = parse_url( home_url(), PHP_URL_HOST ) . parse_url( home_url(), PHP_URL_PATH );

			$headers  = 'From: BackUpWordPress <' . apply_filters( 'hmbkp_from_email', get_bloginfo( 'admin_email' ) ) . '>' . "\r\n";

			// The backup failed, send a message saying as much
			if ( ! file_exists( $file ) && ( $errors = array_merge( $backup->get_errors(), $backup->get_warnings() ) ) ) {

				$error_message = '';

				foreach ( $errors as $error_set ) {
					$error_message .= implode( "\n - ", $error_set );
				}

				if ( $error_message ) {
					$error_message = ' - ' . $error_message;
				}

				$subject = sprintf( __( 'Backup of %s Failed', 'backupwordpress' ), $domain );

				$message = sprintf( __( 'BackUpWordPress was unable to backup your site %1$s.', 'backupwordpress' ) . "\n\n" . __( 'Here are the errors that we\'ve encountered:', 'backupwordpress' ) . "\n\n" . '%2$s' . "\n\n" . __( 'If the errors above look like Martian, forward this email to %3$s and we\'ll take a look', 'backupwordpress' ) . "\n\n" . __( "Kind Regards,\nThe Apologetic BackUpWordPress Backup Emailing Robot", 'backupwordpress' ), home_url(), $error_message, '[email protected]' );

				wp_mail( $this->get_email_address_array(), $subject, $message, $headers );

				return;

			}

			$subject = sprintf( __( 'Backup of %s', 'backupwordpress' ), $domain );

			// If it's larger than the max attachment size limit assume it's not going to be able to send the backup
			if ( @filesize( $file ) < get_max_attachment_size() ) {

				$message = sprintf( __( 'BackUpWordPress has completed a backup of your site %1$s.', 'backupwordpress' ) . "\n\n" . __( 'The backup file should be attached to this email.', 'backupwordpress' ) . "\n\n" . __( 'You can download the backup file by clicking the link below:', 'backupwordpress' ) . "\n\n" . '%2$s' . "\n\n" . __( "Kind Regards,\nThe Happy BackUpWordPress Backup Emailing Robot", 'backupwordpress' ), home_url(),  $download );

				$sent = wp_mail( $this->get_email_address_array(), $subject, $message, $headers, $file );

			}

			// If we didn't send the email above then send just the notification
			if ( ! $sent ) {

				$message = sprintf( __( 'BackUpWordPress has completed a backup of your site %1$s.', 'backupwordpress' ) . "\n\n" . __( 'Unfortunately, the backup file was too large to attach to this email.', 'backupwordpress' ) . "\n\n" . __( 'You can download the backup file by clicking the link below:', 'backupwordpress' ) . "\n\n" . '%2$s' . "\n\n" . __( "Kind Regards,\nThe Happy BackUpWordPress Backup Emailing Robot", 'backupwordpress' ), home_url(), $download );
				wp_mail( $this->get_email_address_array(), $subject, $message, $headers );

			}
		}
	}

	public static function intercom_data() {
		return array();
	}

	public static function intercom_data_html() {}
}

// Register the service
Services::register( __FILE__, 'HM\BackUpWordPress\Email_Service' );


1			<?php
2
3			namespace HM\BackUpWordPress;
4
5			/**
6			* Email notifications for backups
7			*
8			* @extends Service
9			*/
10			class Email_Service extends Service {
11
12			/**
13			* Human readable name for this service
14			* @var string
15			*/
16			public $name = 'Email';
17
18			/**
19			* Output the email form field
20			*
21			* @access public
22			*/
23			public function field() {
24
25			?>
26
27			<tr>
28
29			<th scope="row">
30			<label for="<?php echo esc_attr( $this->get_field_name( 'email' ) ); ?>"><?php _e( 'Email notification', 'backupwordpress' ); ?></label>
31			</th>
32
33			<td>
34			<input type="text" id="<?php echo esc_attr( $this->get_field_name( 'email' ) ); ?>" name="<?php echo esc_attr( $this->get_field_name( 'email' ) ); ?>" value="<?php echo esc_attr( $this->get_field_value( 'email' ) ); ?>" placeholder="[email protected]" />
35
36			<p class="description"><?php printf( __( 'Receive a notification email when a backup completes. If the backup is small enough (< %s), then it will be attached to the email. Separate multiple email addresses with a comma.', 'backupwordpress' ), '<code>' . size_format( get_max_attachment_size() ) . '</code>' ); ?></p>
37			</td>
38
39			</tr>
40
41			<?php }
42
43			/**
44			* Not used as we only need a field
45			*
46			* @see field
47			* @return string Empty string
48			*/
49			public function form() {
50			return '';
51			}
52
53			public static function constant() {
54
55			?>
56
57			<tr<?php if ( defined( 'HMBKP_ATTACHMENT_MAX_FILESIZE' ) ) { ?> class="hmbkp_active"<?php } ?>>
58
59			<td><code>HMBKP_ATTACHMENT_MAX_FILESIZE</code></td>
60
61			<td>
62
63			<?php if ( defined( 'HMBKP_ATTACHMENT_MAX_FILESIZE' ) ) { ?>
64			<p><?php printf( __( 'You\'ve set it to: %s', 'backupwordpress' ), '<code>' . HMBKP_ATTACHMENT_MAX_FILESIZE . '</code>' ); ?></p>
65			<?php } ?>
66
67			<p><?php printf( __( 'The maximum filesize of your backup that will be attached to your notification emails . Defaults to %s.', 'backupwordpress' ), '<code>10MB</code>' ); ?> <?php _e( 'e.g.', 'backupwordpress' ); ?> <code>define( 'HMBKP_ATTACHMENT_MAX_FILESIZE', '25MB' );</code></p>
68
69			</td>
70
71			</tr>
72
73			<?php }
74
75			/**
76			* The sentence fragment that is output as part of the schedule sentence
77			*
78			* @return string
79			*/
80			public function display() {
81
82			if ( $emails = $this->get_email_address_array() ) {
83
84			$email = '<code>' . implode( '</code>, <code>', array_map( 'esc_html', $emails ) ) . '</code>';
85
86			return sprintf( __( 'Send an email notification to %s', 'backupwordpress' ), $email );
87
88			}
89
90			return '';
91
92			}
93
94			/**
95			* Used to determine if the service is in use or not
96			*/
97			public function is_service_active() {
98			return (bool) $this->get_email_address_array();
99			}
100
101			/**
102			* Validate the email and return an error if validation fails
103			*
104			* @param array &$new_data Array of new data, passed by reference
105			* @param array $old_data The data we are replacing
106			* @return null\|array Null on success, array of errors if validation failed
			0 ignored issues – show Documentation introduced 2015-11-21 01:52 UTC by Report Bug Copy Issue Report Consider making the return type a bit more specific; maybe use `array\|null`. This check looks for the generic type `array` as a return type and suggests a more specific type. This type is inferred from the actual code. Loading history...
107			*/
108			public function update( &$new_data, $old_data ) {
109
110			$errors = array();
111
112			if ( isset( $new_data['email'] ) ) {
113
114			if ( ! empty( $new_data['email'] ) ) {
115
116			foreach ( explode( ',', $new_data['email'] ) as $email ) {
117
118			$email = trim( $email );
119
120			if ( ! is_email( $email ) ) {
121			$errors['email'] = sprintf( __( '%s isn\'t a valid email', 'backupwordpress' ), $email );
122			}
123			}
124			}
125
126			if ( ! empty( $errors['email'] ) ) {
127			$new_data['email'] = '';
128			}
129
130			return $errors;
131
132			}
133			}
134
135			/**
136			* Get an array or validated email address's
137			* @return array An array of validated email address's
138			*/
139			private function get_email_address_array() {
140			$emails = array_map( 'trim', explode( ',', $this->get_field_value( 'email' ) ) );
141			return array_filter( array_unique( $emails ), 'is_email' );
142			}
143
144			/**
145			* Fire the email notification on the hmbkp_backup_complete
146			*
147			* @see Backup::do_action
148			* @param string $action The action received from the backup
149			* @return void
150			*/
151			public function action( $action, Backup $backup ) {
152
153			if ( 'hmbkp_backup_complete' === $action && $this->get_email_address_array() ) {
154
155			$file = $backup->get_backup_filepath();
156
157			$sent = false;
158
159			$download = add_query_arg( 'hmbkp_download', base64_encode( $file ), HMBKP_ADMIN_URL );
160			$domain = parse_url( home_url(), PHP_URL_HOST ) . parse_url( home_url(), PHP_URL_PATH );
161
162			$headers = 'From: BackUpWordPress <' . apply_filters( 'hmbkp_from_email', get_bloginfo( 'admin_email' ) ) . '>' . "\r\n";
163
164			// The backup failed, send a message saying as much
165			if ( ! file_exists( $file ) && ( $errors = array_merge( $backup->get_errors(), $backup->get_warnings() ) ) ) {
166
167			$error_message = '';
168
169			foreach ( $errors as $error_set ) {
170			$error_message .= implode( "\n - ", $error_set );
171			}
172
173			if ( $error_message ) {
174			$error_message = ' - ' . $error_message;
175			}
176
177			$subject = sprintf( __( 'Backup of %s Failed', 'backupwordpress' ), $domain );
178
179			$message = sprintf( __( 'BackUpWordPress was unable to backup your site %1$s.', 'backupwordpress' ) . "\n\n" . __( 'Here are the errors that we\'ve encountered:', 'backupwordpress' ) . "\n\n" . '%2$s' . "\n\n" . __( 'If the errors above look like Martian, forward this email to %3$s and we\'ll take a look', 'backupwordpress' ) . "\n\n" . __( "Kind Regards,\nThe Apologetic BackUpWordPress Backup Emailing Robot", 'backupwordpress' ), home_url(), $error_message, '[email protected]' );
180
181			wp_mail( $this->get_email_address_array(), $subject, $message, $headers );
182
183			return;
184
185			}
186
187			$subject = sprintf( __( 'Backup of %s', 'backupwordpress' ), $domain );
188
189			// If it's larger than the max attachment size limit assume it's not going to be able to send the backup
190			if ( @filesize( $file ) < get_max_attachment_size() ) {
191
192			$message = sprintf( __( 'BackUpWordPress has completed a backup of your site %1$s.', 'backupwordpress' ) . "\n\n" . __( 'The backup file should be attached to this email.', 'backupwordpress' ) . "\n\n" . __( 'You can download the backup file by clicking the link below:', 'backupwordpress' ) . "\n\n" . '%2$s' . "\n\n" . __( "Kind Regards,\nThe Happy BackUpWordPress Backup Emailing Robot", 'backupwordpress' ), home_url(), $download );
193
194			$sent = wp_mail( $this->get_email_address_array(), $subject, $message, $headers, $file );
195
196			}
197
198			// If we didn't send the email above then send just the notification
199			if ( ! $sent ) {
200
201			$message = sprintf( __( 'BackUpWordPress has completed a backup of your site %1$s.', 'backupwordpress' ) . "\n\n" . __( 'Unfortunately, the backup file was too large to attach to this email.', 'backupwordpress' ) . "\n\n" . __( 'You can download the backup file by clicking the link below:', 'backupwordpress' ) . "\n\n" . '%2$s' . "\n\n" . __( "Kind Regards,\nThe Happy BackUpWordPress Backup Emailing Robot", 'backupwordpress' ), home_url(), $download );
202			wp_mail( $this->get_email_address_array(), $subject, $message, $headers );
203
204			}
205			}
206			}
207
208			public static function intercom_data() {
209			return array();
210			}
211
212			public static function intercom_data_html() {}
213			}
214
215			// Register the service
216			Services::register( __FILE__, 'HM\BackUpWordPress\Email_Service' );
217

humanmade / backupwordpress

GitHub Access Token became invalid

Pull Request — master (#909)

Email_Service::action() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like