wpml-tm-mail-notification.php 18.1 KB
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564
<?php

/**
 * Class WPML_TM_Mail_Notification
 */
class WPML_TM_Mail_Notification {

	const JOB_COMPLETE_TEMPLATE = 'notification/job-completed.twig';
	const JOB_REVISED_TEMPLATE  = 'notification/job-revised.twig';
	const JOB_CANCELED_TEMPLATE = 'notification/job-canceled.twig';

	private $mail_cache = array();
	private $process_mail_queue;

	/** @var wpdb $wpdb */
	private $wpdb;

	/** @var SitePress $sitepress */
	private $sitepress;

	/** @var WPML_Translation_Job_Factory $job_factory */
	private $job_factory;

	/** @var WPML_TM_Email_Notification_View $email_view */
	private $email_view;

	/** @var array $notification_settings */
	private $notification_settings;

	/** @var bool $has_active_remote_service */
	private $has_active_remote_service;

	public function __construct(
		SitePress $sitepress,
		wpdb $wpdb,
		WPML_Translation_Job_Factory $job_factory,
		WPML_TM_Email_Notification_View $email_view,
		array $notification_settings,
		$has_active_remote_service
	) {
		$this->wpdb                      = $wpdb;
		$this->sitepress                 = $sitepress;
		$this->job_factory               = $job_factory;
		$this->email_view                = $email_view;
		$this->notification_settings     = array_merge(
			array(
				'resigned'  => 0,
				'completed' => 0,
			),
			$notification_settings
		);
		$this->has_active_remote_service = $has_active_remote_service;
	}

	public function init() {
		add_action( 'wpml_tm_empty_mail_queue', array( $this, 'send_queued_mails' ), 10, 0 );

		if ( $this->should_send_email_on_update() ) {
			add_action( 'wpml_tm_complete_job_notification', array( $this, 'action_wpml_tm_job_complete_mail' ), 10, 2 );
			add_action( 'wpml_tm_revised_job_notification', array( $this, 'action_revised_job_email' ), 10 );
			add_action( 'wpml_tm_canceled_job_notification', array( $this, 'action_canceled_job_email' ), 10 );
		}

		add_action( 'wpml_tm_remove_job_notification', array( $this, 'action_translator_removed_mail' ), 10, 2 );
		add_action( 'wpml_tm_resign_job_notification', array( $this, 'action_translator_resign_mail' ), 10, 2 );
		add_action( 'icl_ajx_custom_call', array( $this, 'send_queued_mails' ), 10, 0 );
		add_action( 'icl_pro_translation_completed', array( $this, 'send_queued_mails' ), 10, 0 );

	}

	/**
	 * @return bool
	 */
	private function should_send_email_on_update() {
		return ! isset( $this->notification_settings[ WPML_TM_Emails_Settings::COMPLETED_JOB_FREQUENCY ] ) ||
			   ( isset( $this->notification_settings[ WPML_TM_Emails_Settings::COMPLETED_JOB_FREQUENCY ] ) &&
				 WPML_TM_Emails_Settings::NOTIFY_IMMEDIATELY === (int) $this->notification_settings[ WPML_TM_Emails_Settings::COMPLETED_JOB_FREQUENCY ] );
	}

	public function send_queued_mails() {
		$tj_url = admin_url( 'admin.php?page=' . WPML_TM_FOLDER . '/menu/translations-queue.php' );

		foreach ( $this->mail_cache as $type => $mail_to_send ) {
			foreach ( $mail_to_send as $to => $subjects ) {
				$headers      = '';
				$body_to_send = '';

				foreach ( $subjects as $subject => $content ) {
					$body     = $content['body'];
					$home_url = get_home_url();

					if ( 'completed' === $type ) {
						$headers = array(
							'Content-type: text/html; charset=UTF-8',
						);

						$body_to_send .= $body[0];

					} else {
						$body_to_send .= $body_to_send . "\n\n" . implode( "\n\n\n\n", $body ) . "\n\n\n\n";

						if ( $type === 'translator' ) {
							$footer  = sprintf(
								__( 'You can view your other translation jobs here: %s', 'wpml-translation-management' ),
								$tj_url
							) . "\n\n--\n";
							$footer .= sprintf(
								__(
									"This message was automatically sent by Translation Management running on %1\$s. To stop receiving these notifications contact the system administrator at %2\$s.\n\nThis email is not monitored for replies.",
									'wpml-translation-management'
								),
								get_bloginfo( 'name' ),
								$home_url
							);
						} else {
							$footer = "\n--\n" . sprintf(
								__(
									"This message was automatically sent by Translation Management running on %1\$s. To stop receiving these notifications, go to Notification Settings, or contact the system administrator at %2\$s.\n\nThis email is not monitored for replies.",
									'wpml-translation-management'
								),
								get_bloginfo( 'name' ),
								$home_url
							);
						}

						$body_to_send .= $footer;
					}

					$attachments = isset( $content['attachment'] ) ? $content['attachment'] : array();
					$attachments = apply_filters( 'wpml_new_job_notification_attachments', $attachments );

					/**
					 * @deprecated Use 'wpml_new_job_notification_attachments' instead
					 */
					$attachments = apply_filters( 'WPML_new_job_notification_attachments', $attachments );
					$this->sitepress->get_wp_api()->wp_mail( $to, $subject, $body_to_send, $headers, $attachments );
				}
			}
		}
		$this->mail_cache         = array();
		$this->process_mail_queue = false;
	}

	/**
	 * @param int|WPML_Translation_Job $job_id
	 *
	 * @return array|null
	 */
	private function get_basic_mail_data( $job_id ) {
		$manager_id = false;

		/** @var WPML_Translation_Job|false $job */
		if ( is_object( $job_id ) ) {
			$job = $job_id;
		} else {
			$job = $this->job_factory->get_translation_job( $job_id, false, 0, true );
		}

		if ( is_object( $job ) ) {
			$data       = $job->get_basic_data();
			$manager_id = isset( $data->manager_id ) ? $data->manager_id : -1;
		}

		if (
			! $job instanceof WPML_Translation_Job ||
			( $manager_id && (int) $manager_id === (int) $job->get_translator_id() )
		) {
			return null;
		}

		$manager       = new WP_User( $manager_id );
		$translator    = new WP_User( $job->get_translator_id() );
		$user_language = $this->sitepress->get_user_admin_language( $manager->ID );

		$mail = array(
			'to' => $manager->display_name . ' <' . $manager->user_email . '>',
		);

		$this->sitepress->switch_locale( $user_language );

		list( $lang_from, $lang_to ) = $this->get_lang_to_from( $job, $user_language );

		$model = array(
			'view_jobs_text' => __( 'View translation jobs', 'wpml-translation-management' ),
			'username'       => $manager->display_name,
			'lang_from'      => $lang_from,
			'lang_to'        => $lang_to,
		);

		$document_title = $job->get_title();

		if ( 'string' !== strtolower( $job->get_type() ) ) {
			/** @var WPML_Post_Translation_Job $job */
			$model['translation_jobs_url'] = admin_url( 'admin.php?page=' . WPML_TM_FOLDER . '/menu/main.php&sm=jobs' );
			$document_title                = '<a href="' . $job->get_url( true ) . '">' . $document_title . '</a>';
			$model                         = $this->update_model_for_deadline( $model, $job );
		}

		return array(
			'mail'           => $mail,
			'document_title' => $document_title,
			'job'            => $job,
			'manager'        => $manager,
			'translator'     => $translator,
			'model'          => $model,
		);
	}

	/**
	 * @param WPML_Translation_Job|int $job_id
	 * @param bool|false               $update
	 *
	 * @return void
	 */
	public function action_wpml_tm_job_complete_mail( $job_id, $update = false ) {
		$this->wpml_tm_job_complete_mail( $job_id, $update );
	}

	/**
	 * @param WPML_Translation_Job|int $job_id
	 * @param bool|false               $update
	 *
	 * @return false|array representation of the email to be sent
	 */
	public function wpml_tm_job_complete_mail( $job_id, $update = false ) {
		$basic_mail_data = $this->get_basic_mail_data( $job_id );
		if ( null === $basic_mail_data ) {
			return null;
		}

		$mail           = $basic_mail_data['mail'];
		$document_title = $basic_mail_data['document_title'];
		$translator     = $basic_mail_data['translator'];
		$job            = $basic_mail_data['job'];
		$model          = $basic_mail_data['model'];
		$lang_from      = $model['lang_from'];
		$lang_to        = $model['lang_to'];

		if ( $update ) {
			$mail['subject']  = sprintf(
				__( 'Translator has updated translation job for %s', 'wpml-translation-management' ),
				get_bloginfo( 'name' )
			);
			$body_placeholder = esc_html__(
				'The translator %1$shas updated the translation job for "%2$s" from %3$s to %4$s.',
				'wpml-translation-management'
			);
		} else {
			$mail['subject']  = sprintf(
				__( 'Translator has completed translation job for %s', 'wpml-translation-management' ),
				get_bloginfo( 'name' )
			);
			$body_placeholder = esc_html__(
				'The translator %1$shas completed the translation job for "%2$s" from %3$s to %4$s.',
				'wpml-translation-management'
			);
		}
		$translator_name      = ! empty( $translator->display_name ) ? '(' . $translator->display_name . ') ' : '';
		$model['message']     = sprintf( $body_placeholder, $translator_name, $document_title, $lang_from, $lang_to );
		$model['needs_help']  = array(
			'title'                     => __( 'Need help with translation?', 'wpml-translation-management' ),
			'options_or'                => __( 'or', 'wpml-translation-management' ),
			'translators_link'          => admin_url( 'admin.php?page=' . WPML_TM_FOLDER . '/menu/main.php&sm=translators' ),
			'translators_text'          => __( 'Manage your translators', 'wpml-translation-management' ),
			'translation_services_link' => admin_url( 'admin.php?page=' . WPML_TM_FOLDER . '/menu/main.php&sm=translators' ),
			'translation_services_text' => __( 'try a translation service', 'wpml-translation-management' ),
		);
		$model['overdue_job'] = ! $job->is_completed_on_time();

		$mail['body'] = $this->email_view->render_model( $model, self::JOB_COMPLETE_TEMPLATE );
		$mail['type'] = 'completed';
		$this->enqueue_mail( $mail );

		$this->sitepress->switch_locale();

		return $mail;
	}


	/**
	 * @param int $job_id
	 *
	 * @return void
	 */
	public function action_revised_job_email( $job_id ) {
		$this->revised_job_email( $job_id );
	}

	/**
	 * @param int $job_id
	 *
	 * @return array|bool
	 */
	public function revised_job_email( $job_id ) {

		if ( ! $this->should_send_immediate_notification( 'completed' ) ) {
			return false;
		}

		$subject     = sprintf( __( 'Translator job updated for %s', 'wpml-translation-management' ), get_bloginfo( 'name' ) );
		$placeholder = esc_html__(
			'A new translation for %1$s from %2$s to %3$s was created on the Translation Service. It&#8217;s ready to download and will be applied next time the Translation Service delivers completed translations to your site or when you manually fetch them.',
			'wpml-translation-management'
		);

		return $this->generic_update_notification_email( $job_id, $subject, $placeholder, self::JOB_REVISED_TEMPLATE );

	}
	/**
	 * @param WPML_TM_Job_Entity $job
	 *
	 * @return void
	 */
	public function action_canceled_job_email( WPML_TM_Job_Entity $job ) {
		$this->canceled_job_email( $job );
	}

	/**
	 * @param WPML_TM_Job_Entity $job
	 *
	 * @return array|bool
	 */
	public function canceled_job_email( WPML_TM_Job_Entity $job ) {
		if ( ! $job instanceof WPML_TM_Post_Job_Entity ) {
			return false;
		}

		if ( ! $this->should_send_immediate_notification( 'completed' ) ) {
			return false;
		}

		$subject     = sprintf( __( 'Translator job canceled for %s', 'wpml-translation-management' ), get_bloginfo( 'name' ) );
		$placeholder = esc_html__(
			'The translation for %1$s from %2$s to %3$s was canceled on the Translation Service. You can send this document to translation again from the Translation Dashboard.',
			'wpml-translation-management'
		);

		return $this->generic_update_notification_email(
			$job->get_translate_job_id(),
			$subject,
			$placeholder,
			self::JOB_CANCELED_TEMPLATE
		);
	}

	private function generic_update_notification_email( $job_id, $mail_subject, $body_placeholder, $template ) {
		$basic_mail_data = $this->get_basic_mail_data( $job_id );
		if ( null === $basic_mail_data ) {
			return null;
		}

		$mail           = $basic_mail_data['mail'];
		$document_title = $basic_mail_data['document_title'];

		$model     = $basic_mail_data['model'];
		$lang_from = $model['lang_from'];
		$lang_to   = $model['lang_to'];

		$mail['subject']  = $mail_subject;
		$model['message'] = sprintf( $body_placeholder, $document_title, $lang_from, $lang_to );
		$mail['body']     = $this->email_view->render_model( $model, $template );
		$mail['type']     = 'completed';
		$this->enqueue_mail( $mail );

		$this->sitepress->switch_locale();

		return $mail;
	}

	private function should_send_immediate_notification( $type ) {
		return isset( $this->notification_settings[ $type ] ) &&
			(int) $this->notification_settings[ $type ] === WPML_TM_Emails_Settings::NOTIFY_IMMEDIATELY;
	}

	/**
	 * @param array                        $model
	 * @param WPML_Element_Translation_Job $job
	 *
	 * @return array
	 */
	private function update_model_for_deadline( array $model, WPML_Element_Translation_Job $job ) {
		if ( $job->is_completed_on_time() ) {
			$model['deadline_status'] = __( 'The translation job was completed on time.', 'wpml-translation-management' );
			return $model;
		}

		$overdue_days = $job->get_number_of_days_overdue();

		if ( ! $overdue_days ) {
			$model['deadline_status'] = '';
			return $model;
		}

		$model['deadline_status'] = sprintf(
			_n(
				'This translation job is overdue by %s day.',
				'This translation job is overdue by %s days.',
				$overdue_days,
				'wpml-translation-management'
			),
			$overdue_days
		);

		if ( $overdue_days >= 7 ) {
			$model['promote_translation_services'] = ! $this->has_active_remote_service;
		}

		return $model;
	}

	/**
	 * @param int                      $translator_id
	 * @param WPML_Translation_Job|int $job
	 *
	 * @return void
	 */
	public function action_translator_removed_mail( $translator_id, $job ) {
		$this->translator_removed_mail( $translator_id, $job );
	}

	/**
	 * @param int                      $translator_id
	 * @param WPML_Translation_Job|int $job
	 *
	 * @return bool
	 */
	public function translator_removed_mail( $translator_id, $job ) {
		/** @var WPML_Translation_Job $job */
		list( $manager_id, $job ) = $this->get_mail_elements( $job );
		if ( ! $job || $manager_id == $translator_id ) {
			return false;
		}
		$translator    = new WP_User( $translator_id );
		$manager       = new WP_User( $manager_id );
		$user_language = $this->sitepress->get_user_admin_language( $manager->ID );
		$doc_title     = $job->get_title();
		$this->sitepress->switch_locale( $user_language );
		list( $lang_from, $lang_to ) = $this->get_lang_to_from( $job, $user_language );
		$mail['to']                  = $translator->display_name . ' <' . $translator->user_email . '>';
		$mail['subject']             = sprintf( __( 'Removed from translation job on %s', 'wpml-translation-management' ), get_bloginfo( 'name' ) );
		$mail['body']                = sprintf(
			__( 'You have been removed from the translation job "%1$s" for %2$s to %3$s.', 'wpml-translation-management' ),
			$doc_title,
			$lang_from,
			$lang_to
		);
		$mail['type']                = 'translator';
		$this->enqueue_mail( $mail );
		$this->sitepress->switch_locale();

		return $mail;
	}

	/**
	 * @param int                      $translator_id
	 * @param int|WPML_Translation_Job $job_id
	 *
	 * @return void
	 */
	public function action_translator_resign_mail( $translator_id, $job_id ) {
		$this->translator_resign_mail( $translator_id, $job_id );
	}

	/**
	 * @param int                      $translator_id
	 * @param int|WPML_Translation_Job $job_id
	 *
	 * @return array|bool
	 */
	public function translator_resign_mail( $translator_id, $job_id ) {
		/** @var WPML_Translation_Job $job */
		list( $manager_id, $job ) = $this->get_mail_elements( $job_id );
		if ( ! $job || $manager_id == $translator_id ) {
			return false;
		}
		$translator    = new WP_User( $translator_id );
		$manager       = new WP_User( $manager_id );
		$tj_url        = admin_url( 'admin.php?page=' . WPML_TM_FOLDER . '/menu/main.php&sm=jobs' );
		$doc_title     = $job->get_title();
		$user_language = $this->sitepress->get_user_admin_language( $manager->ID );
		$this->sitepress->switch_locale( $user_language );
		list( $lang_from, $lang_to ) = $this->get_lang_to_from( $job, $user_language );
		$mail                        = array();
		if ( $this->notification_settings['resigned'] == ICL_TM_NOTIFICATION_IMMEDIATELY ) {
			$mail['to']         = $manager->display_name . ' <' . $manager->user_email . '>';
			$mail['subject']    = sprintf(
				__( 'Translator has resigned from job on %s', 'wpml-translation-management' ),
				get_bloginfo( 'name' )
			);
			$original_doc_title = $doc_title ? $doc_title : __( 'Deleted', 'wpml-translation-management' );
			$mail['body']       = sprintf(
				__(
					'Translator %1$s has resigned from the translation job "%2$s" for %3$s to %4$s.%5$sView translation jobs: %6$s',
					'wpml-translation-management'
				),
				$translator->display_name,
				$original_doc_title,
				$lang_from,
				$lang_to,
				"\n",
				$tj_url
			);
			$mail['type']       = 'admin';
			$this->enqueue_mail( $mail );
		}
		// restore locale
		$this->sitepress->switch_locale();

		return $mail;
	}

	private function enqueue_mail( $mail ) {
		if ( $mail !== 'empty_queue' ) {
			$this->mail_cache[ $mail['type'] ][ $mail['to'] ][ $mail['subject'] ]['body'][] = $mail['body'];
			if ( isset( $mail['attachment'] ) ) {
				$this->mail_cache[ $mail['type'] ][ $mail['to'] ][ $mail['subject'] ]['attachment'][] = $mail['attachment'];
			}
			$this->process_mail_queue = true;
		}
	}

	/**
	 * @param int|WPML_Translation_Job $job_id
	 *
	 * @return array
	 */
	private function get_mail_elements( $job_id ) {
		$job = is_object( $job_id ) ? $job_id : $this->job_factory->get_translation_job(
			$job_id,
			false,
			0,
			true
		);
		if ( is_object( $job ) ) {
			$data       = $job->get_basic_data();
			$manager_id = isset( $data->manager_id ) ? $data->manager_id : - 1;
		} else {
			$job        = false;
			$manager_id = false;
		}

		return array( $manager_id, $job );
	}

	/**
	 * @param WPML_Translation_Job $job
	 * @param string               $user_language
	 *
	 * @return array
	 */
	private function get_lang_to_from( $job, $user_language ) {
		$sql       = "SELECT name FROM {$this->wpdb->prefix}icl_languages_translations WHERE language_code=%s AND display_language_code=%s LIMIT 1";
		$lang_from = $this->wpdb->get_var(
			$this->wpdb->prepare(
				$sql,
				$job->get_source_language_code(),
				$user_language
			)
		);
		$lang_to   = $this->wpdb->get_var( $this->wpdb->prepare( $sql, $job->get_language_code(), $user_language ) );

		return array( $lang_from, $lang_to );
	}
}