<?php

/*
 * This file is part of MailSo.
 *
 * (c) 2014 Usenko Timur
 * (c) 2021 DJMaze
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 *
 * https://datatracker.ietf.org/doc/html/rfc5256
 */

namespace MailSo\Imap\Requests;

/**
 * @category MailSo
 * @package Imap
 */
class THREAD extends Request
{
	// ORDEREDSUBJECT or REFERENCES or REFS
	private string $sAlgorithm = '';

	// a parenthesized list of sort criteria
	public string $sCriterias = 'ALL';

	public bool $bUid = true;

	function __construct(\MailSo\Imap\ImapClient $oImapClient)
	{
		if ($oImapClient->hasCapability('THREAD=REFS')) {
			$this->sAlgorithm = 'REFS';
		} else if ($oImapClient->hasCapability('THREAD=REFERENCES')) {
			$this->sAlgorithm = 'REFERENCES';
		} else if ($oImapClient->hasCapability('THREAD=ORDEREDSUBJECT')) {
			$this->sAlgorithm = 'ORDEREDSUBJECT';
		} else {
			$oImapClient->writeLogException(new \MailSo\RuntimeException('THREAD is not supported'), \LOG_ERR);
		}
		parent::__construct($oImapClient);
	}

	public function setAlgorithm(string $sAlgorithm) : void
	{
		$sAlgorithm = \strtoupper($sAlgorithm);
		if (!$this->oImapClient->hasCapability("THREAD={$sAlgorithm}")) {
			$this->oImapClient->writeLogException(new \MailSo\RuntimeException("THREAD={$sAlgorithm} is not supported"), \LOG_ERR);
		}
		$this->sAlgorithm = $sAlgorithm;
	}

	public function SendRequestIterateResponse() : iterable
	{
		$this->oImapClient->SendRequest(
			($this->bUid ? 'UID THREAD' : 'THREAD'),
			array(
				$this->sAlgorithm,
				'UTF-8', // \strtoupper(\MailSo\Base\Enumerations\Charset::UTF_8)
				(\strlen($this->sCriterias) && '*' !== $this->sCriterias) ? $this->sCriterias : 'ALL'
			)
		);

		foreach ($this->oImapClient->yieldUntaggedResponses() as $oResponse) {
			$iOffset = ($this->bUid && 'UID' === $oResponse->StatusOrIndex && !empty($oResponse->ResponseList[2]) && 'THREAD' === $oResponse->ResponseList[2]) ? 1 : 0;
			if (('THREAD' === $oResponse->StatusOrIndex || $iOffset)
				&& \is_array($oResponse->ResponseList)
				&& 2 < \count($oResponse->ResponseList))
			{
				$iLen = \count($oResponse->ResponseList);
				for ($iIndex = 2 + $iOffset; $iIndex < $iLen; ++$iIndex) {
					$aNewValue = $this->validateThreadItem($oResponse->ResponseList[$iIndex]);
					if (\is_array($aNewValue)) {
						yield $aNewValue;
					}
				}
			}
		}
	}

	/**
	 * @param mixed $mValue
	 *
	 * @return int | array | false
	 */
	private function validateThreadItem($mValue)
	{
		if (\is_numeric($mValue)) {
			$mValue = (int) $mValue;
			if (0 < $mValue) {
				return $mValue;
			}
		} else if (\is_array($mValue)) {
			if (1 === \count($mValue) && \is_numeric($mValue[0])) {
				$mValue = (int) $mValue[0];
				if (0 < $mValue) {
					return $mValue;
				}
			} else {
				$aResult = array();
				foreach ($mValue as $mValueItem) {
					$mValueItem = $this->validateThreadItem($mValueItem);
					if ($mValueItem) {
						$aResult[] = $mValueItem;
					}
				}
				return $aResult;
			}
		}

		return false;
	}
}