ElkArte\AdminController\ManageNews::action_mailingsend()

Complexity

Conditions	66
Paths	> 20000

Size

Total Lines	386
Code Lines	182

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	4422

Importance

Changes

0

<?php
	public function action_mailingsend(bool $clean_only = false): void
	{
		global $txt, $context, $scripturl, $modSettings;

		// A nice successful screen if you did it
		if ($this->_req->hasQuery('success'))
		{
			$context['sub_template'] = 'email_members_succeeded';
			theme()->getTemplates()->load('ManageNews');

			return;
		}

		// If just previewing, we prepare a message and return it for viewing
		if (isset($this->_req->post->preview))
		{
			$context['preview'] = true;

			$this->action_mailingcompose();
			return;
		}

		// How many to send at once? Quantity depends on whether we are queueing or not.
		// @todo Might need an interface? (used in Post.controller.php too with different limits)
		$num_at_once = empty($modSettings['mail_queue']) ? 60 : 1000;

		// If by PM's I suggest we half the above number.
		if (!empty($this->_req->post->send_pm))
		{
			$num_at_once /= 2;
		}

		checkSession();

		// Where are we actually to?
		$context['start'] = $this->_req->getPost('start', 'intval', 0);
		$context['email_force'] = $this->_req->getPost('email_force', 'isset', false);
		$context['total_emails'] = $this->_req->getPost('total_emails', 'intval', 0);
		$context['max_id_member'] = $this->_req->getPost('max_id_member', 'intval', 0);
		$context['send_pm'] = $this->_req->getPost('send_pm', 'isset', false);
		$context['send_html'] = $this->_req->getPost('send_html', 'isset', false);
		$context['parse_html'] = $this->_req->getPost('parse_html', 'isset', false);

		// Create our main context.
		$context['recipients'] = [
			'groups' => [],
			'exclude_groups' => [],
			'members' => [],
			'exclude_members' => [],
			'emails' => [],
		];

		// Do we have any excluded members?
		if (!empty($this->_req->post->exclude_members))
		{
			$members = explode(',', $this->_req->post->exclude_members);
			foreach ($members as $member)
			{
				if ($member >= $context['start'])
				{
					$context['recipients']['exclude_members'][] = (int) $member;
				}
			}
		}

		// What about members we *must* do?
		if (!empty($this->_req->post->members))
		{
			$members = explode(',', $this->_req->post->members);
			foreach ($members as $member)
			{
				if ($member >= $context['start'])
				{
					$context['recipients']['members'][] = (int) $member;
				}
			}
		}

		// Cleaning groups is simple - although deal with both checkbox and commas.
		if (is_array($this->_req->getPost('groups')))
		{
			foreach ($this->_req->post->groups as $group => $dummy)
			{
				$context['recipients']['groups'][] = (int) $group;
			}
		}
		elseif ($this->_req->getPost('groups', 'trim', '') !== '')
		{
			$groups = explode(',', $this->_req->post->groups);
			foreach ($groups as $group)
			{
				$context['recipients']['groups'][] = (int) $group;
			}
		}

		// Same for excluded groups
		if (is_array($this->_req->getPost('exclude_groups')))
		{
			foreach ($this->_req->post->exclude_groups as $group => $dummy)
			{
				$context['recipients']['exclude_groups'][] = (int) $group;
			}
		}
		elseif ($this->_req->getPost('exclude_groups', 'trim', '') !== '')
		{
			$groups = explode(',', $this->_req->post->exclude_groups);
			foreach ($groups as $group)
			{
				$context['recipients']['exclude_groups'][] = (int) $group;
			}
		}

		// Finally - emails!
		if (!empty($this->_req->post->emails))
		{
			$addressed = array_unique(explode(';', strtr($this->_req->post->emails, ["\n" => ';', "\r" => ';', ',' => ';'])));
			foreach ($addressed as $curmem)
			{
				$curmem = trim($curmem);
				if ($curmem !== '')
				{
					$context['recipients']['emails'][$curmem] = $curmem;
				}
			}
		}

		// If we're only cleaning, drop out here.
		if ($clean_only)
		{
			return;
		}

		// Some functions we will need
		require_once(SUBSDIR . '/Mail.subs.php');
		if ($context['send_pm'])
		{
			require_once(SUBSDIR . '/PersonalMessage.subs.php');
		}

		$base_subject = $this->_req->getPost('subject', 'trim|strval', '');
		$base_message = $this->_req->getPost('message', 'strval', '');

		// Save the message and its subject in $context
		$context['subject'] = htmlspecialchars($base_subject, ENT_COMPAT, 'UTF-8');
		$context['message'] = htmlspecialchars($base_message, ENT_COMPAT, 'UTF-8');

		// Prepare the message for sending it as HTML
		if (!$context['send_pm'] && !empty($context['send_html']))
		{
			// Prepare the message for HTML.
			if (!empty($context['parse_html']))
			{
				$base_message = str_replace(["\n", '  '], ['<br />' . "\n", '&nbsp; '], $base_message);
			}

			// This is here to prevent spam filters from tagging this as spam.
			if (preg_match('~<html~i', $base_message) == 0)
			{
				if (preg_match('~<body~i', $base_message) == 0)
				{
					$base_message = '<html><head><title>' . $base_subject . '</title></head>' . "\n" . '<body>' . $base_message . '</body></html>';
				}
				else
				{
					$base_message = '<html>' . $base_message . '</html>';
				}
			}
		}

		if (empty($base_message) || empty($base_subject))
		{
			$context['preview'] = true;

			$this->action_mailingcompose();
			return;
		}

		// Use the default time format.
		$this->user->time_format = $modSettings['time_format'];

		$variables = [
			'{$board_url}',
			'{$current_time}',
			'{$latest_member.link}',
			'{$latest_member.id}',
			'{$latest_member.name}'
		];

		// We might need this in a bit
		$cleanLatestMember = empty($context['send_html']) || $context['send_pm'] ? un_htmlspecialchars($modSettings['latestRealName']) : $modSettings['latestRealName'];

		// Replace in all the standard things.
		$base_message = str_replace($variables,
			[
				empty($context['send_html']) ? $scripturl : '<a href="' . $scripturl . '">' . $scripturl . '</a>',
				standardTime(forum_time(), false),
				empty($context['send_html']) ? ($context['send_pm'] ? '[url=' . getUrl('profile', ['action' => 'profile', 'u' => $modSettings['latestMember'], 'name' => $cleanLatestMember]) . ']' . $cleanLatestMember . '[/url]' : $cleanLatestMember) : ('<a href="' . getUrl('profile', ['action' => 'profile', 'u' => $modSettings['latestMember'], 'name' => $cleanLatestMember]) . '">' . $cleanLatestMember . '</a>'),
				$modSettings['latestMember'],
				$cleanLatestMember
			], $base_message);

		$base_subject = str_replace($variables,
			[
				$scripturl,
				standardTime(forum_time(), false),
				$modSettings['latestRealName'],
				$modSettings['latestMember'],
				$modSettings['latestRealName']
			], $base_subject);

		$from_member = [
			'{$member.email}',
			'{$member.link}',
			'{$member.id}',
			'{$member.name}'
		];

		// If we still have emails, do them first!
		$i = 0;
		foreach ($context['recipients']['emails'] as $k => $email)
		{
			// Done as many as we can?
			if ($i >= $num_at_once)
			{
				break;
			}

			// Don't send it twice!
			unset($context['recipients']['emails'][$k]);

			// Dammit - can't PM emails!
			if ($context['send_pm'])
			{
				continue;
			}

			$to_member = [
				$email,
				empty($context['send_html']) ? $email : '<a href="mailto:' . $email . '">' . $email . '</a>',
				'??',
				$email
			];

			sendmail($email, str_replace($from_member, $to_member, $base_subject), str_replace($from_member, $to_member, $base_message), null, null, !empty($context['send_html']), 5);

			// Done another...
			$i++;
		}

		// Got some more to send this batch?
		$last_id_member = 0;
		if ($i < $num_at_once)
		{
			// Need to build quite a query!
			$sendQuery = '(';
			$sendParams = [];
			if (!empty($context['recipients']['groups']))
			{
				// Take the long route...
				$queryBuild = [];
				foreach ($context['recipients']['groups'] as $group)
				{
					$sendParams['group_' . $group] = $group;
					$queryBuild[] = 'mem.id_group = {int:group_' . $group . '}';
					if (!empty($group))
					{
						$queryBuild[] = 'FIND_IN_SET({int:group_' . $group . '}, mem.additional_groups) != 0';
						$queryBuild[] = 'mem.id_post_group = {int:group_' . $group . '}';
					}
				}

				if (!empty($queryBuild))
				{
					$sendQuery .= implode(' OR ', $queryBuild);
				}
			}

			if (!empty($context['recipients']['members']))
			{
				$sendQuery .= ($sendQuery === '(' ? '' : ' OR ') . 'mem.id_member IN ({array_int:members})';
				$sendParams['members'] = $context['recipients']['members'];
			}

			$sendQuery .= ')';

			// If we've not got a query, then we must be done!
			if ($sendQuery === '()')
			{
				redirectexit('action=admin');
			}

			// Anything to exclude?
			if (!empty($context['recipients']['exclude_groups']) && in_array(0, $context['recipients']['exclude_groups']))
			{
				$sendQuery .= ' AND mem.id_group != {int:regular_group}';
			}

			if (!empty($context['recipients']['exclude_members']))
			{
				$sendQuery .= ' AND mem.id_member NOT IN ({array_int:exclude_members})';
				$sendParams['exclude_members'] = $context['recipients']['exclude_members'];
			}

			// Force them to have it?
			if (empty($context['email_force']))
			{
				$sendQuery .= ' AND mem.notify_announcements = {int:notify_announcements}';
			}

			require_once(SUBSDIR . '/News.subs.php');

			// Get the smelly people - note we respect the id_member range as it gives us a quicker query.
			$recipients = getNewsletterRecipients($sendQuery, $sendParams, $context['start'], $num_at_once, $i);

			foreach ($recipients as $row)
			{
				$last_id_member = $row['id_member'];

				// What groups are we looking at here?
				$groups = array_merge([$row['id_group'], $row['id_post_group']], (empty($row['additional_groups']) ? [] : explode(',', $row['additional_groups'])));

				// Excluded groups?
				if (array_intersect($groups, $context['recipients']['exclude_groups']) !== [])
				{
					continue;
				}

				// We might need this
				$cleanMemberName = empty($context['send_html']) || $context['send_pm'] ? un_htmlspecialchars($row['real_name']) : $row['real_name'];

				// Replace the member-dependant variables
				$message = str_replace($from_member,
					[
						$row['email_address'],
						empty($context['send_html']) ? ($context['send_pm'] ? '[url=' . getUrl('profile', ['action' => 'profile', 'u' => $row['id_member'], 'name' => $cleanMemberName]) . ']' . $cleanMemberName . '[/url]' : $cleanMemberName) : ('<a href="' . getUrl('profile', ['action' => 'profile', 'u' => $row['id_member'], 'name' => $cleanMemberName]) . '">' . $cleanMemberName . '</a>'),
						$row['id_member'],
						$cleanMemberName,
					], $base_message);

				$subject = str_replace($from_member,
					[
						$row['email_address'],
						$row['real_name'],
						$row['id_member'],
						$row['real_name'],
					], $base_subject);

				// Send the actual email - or a PM!
				if (!$context['send_pm'])
				{
					sendmail($row['email_address'], $subject, $message, null, null, !empty($context['send_html']), 5);
				}
				else
				{
					sendpm(['to' => [$row['id_member']], 'bcc' => []], $subject, $message);
				}
			}
		}

		// If used our batch assume we still have a member.
		if ($i >= $num_at_once)
		{
			$last_id_member = $context['start'];
		}
		// Or we didn't have one in range?
		elseif (empty($last_id_member) && $context['start'] + $num_at_once < $context['max_id_member'])
		{
			$last_id_member = $context['start'] + $num_at_once;
		}
		// If we have no id_member, then we're done.
		elseif (empty($last_id_member) && empty($context['recipients']['emails']))
		{
			// Log this into the admin log.
			logAction('newsletter', [], 'admin');
			redirectexit('action=admin;area=news;sa=mailingsend;success');
		}

		$context['start'] = $last_id_member;

		// Working out progress is a black art of sorts.
		$percentEmails = $context['total_emails'] == 0 ? 0 : ((count($context['recipients']['emails']) / $context['total_emails']) * ($context['total_emails'] / ($context['total_emails'] + $context['max_id_member'])));
		$percentMembers = ($context['start'] / $context['max_id_member']) * ($context['max_id_member'] / ($context['total_emails'] + $context['max_id_member']));
		$context['percentage_done'] = round(($percentEmails + $percentMembers) * 100, 2);

		$context['page_title'] = $txt['admin_newsletters'];
		$context['sub_template'] = 'email_members_send';
	}