MailboxesParser #268
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2,3 +2,5 @@ vendor/ | |
| .php_cs.cache | ||
| composer.lock | ||
| phpunit.xml | ||
| #phpstorm config folder | ||
| .idea/ | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| <?php | ||
|
|
||
| declare(strict_types=1); | ||
|
|
||
| namespace Ddeboer\Imap\Exception; | ||
|
|
||
| final class MailboxesParserException extends AbstractException | ||
| { | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,300 @@ | ||
| <?php | ||
|
|
||
| declare(strict_types=1); | ||
| /** | ||
| * Created by PhpStorm. | ||
| * User: Lukasz | ||
| * Date: 2017-11-10 | ||
| * Time: 19:49. | ||
| */ | ||
|
|
||
| namespace Ddeboer\Imap\MailboxesParser; | ||
|
|
||
| use Ddeboer\Imap\Exception\MailboxesParserException; | ||
| use Ddeboer\Imap\MailboxInterface; | ||
|
|
||
| /** | ||
| * Class MailboxesParser. | ||
| */ | ||
| final class MailboxesParser implements MailboxesParserInterface | ||
| { | ||
| /** @var MailboxInterface[] */ | ||
| private $mailboxes; | ||
| /** @var ParsedMailbox[] */ | ||
| private $folders; | ||
| private $treeStructure; | ||
|
|
||
| const INBOX = 'inbox'; | ||
| const SENT = 'sent'; | ||
| const DRAFT = 'drafts'; | ||
| const SPAM = 'spam'; | ||
| const TRASH = 'trash'; | ||
| const TEMPLATES = 'templates'; | ||
| const ARCHIVES = 'archives'; | ||
|
|
||
| private $specialFoldersIds = [ | ||
| self::INBOX => ['inbox'], | ||
| self::SENT => ['sent', 'sent messages', 'INBOX.Sent', '[Gmail]/Sent Mail'], | ||
| self::DRAFT => ['drafts', 'INBOX.Drafts', '[Gmail]/Drafts'], | ||
| self::SPAM => ['spam', 'INBOX.spam', '[Gmail]/spam'], | ||
| self::TRASH => ['trash', 'bin', 'INBOX.trash', '[Gmail]/trash'], | ||
| self::TEMPLATES => ['templates'], | ||
| self::ARCHIVES => ['archives'], | ||
| ]; | ||
|
|
||
| private $specialFoldersNames = [ | ||
| self::DRAFT => 'Drafts', | ||
| self::INBOX => 'Inbox', | ||
| self::SENT => 'Sent', | ||
| self::SPAM => 'Spam', | ||
| self::TRASH => 'Trash', | ||
| self::TEMPLATES => 'Templates', | ||
| self::ARCHIVES => 'Archives', | ||
| ]; | ||
|
|
||
| private $specialFoldersOrder = [ | ||
| self::INBOX => 1, | ||
| self::SENT => 2, | ||
| self::DRAFT => 3, | ||
| self::TEMPLATES => 4, | ||
| self::ARCHIVES => 10000, | ||
| self::SPAM => 20000, | ||
| self::TRASH => 30000, | ||
| ]; | ||
|
|
||
| /** | ||
| * MailboxesTree constructor. | ||
| * | ||
| * @param MailboxInterface[] $mailboxes | ||
| */ | ||
| public function __construct($mailboxes) | ||
|
Author
There was a problem hiding this comment. I think in php 7.0 I cannot use
Collaborator
There was a problem hiding this comment. No, but you can typehint the
Collaborator
There was a problem hiding this comment. I still see Can you change this to |
||
| { | ||
| $this->mailboxes = $mailboxes; | ||
| } | ||
|
|
||
| /** | ||
| * Set language for parser. | ||
| * | ||
| * @param string $lang | ||
| */ | ||
| public function setLanguage(string $lang) | ||
| { | ||
| $path = __DIR__ . DIRECTORY_SEPARATOR . 'languages' . DIRECTORY_SEPARATOR . $lang . DIRECTORY_SEPARATOR . 'names.php'; | ||
| if (!\is_file($path)) { | ||
| throw new MailboxesParserException(\sprintf('File for language names %s does not exist', $path)); | ||
| } | ||
| $names = require $path; | ||
| $this->setSpecialFoldersNames($names); | ||
|
|
||
| $path = __DIR__ . DIRECTORY_SEPARATOR . 'languages' . DIRECTORY_SEPARATOR . $lang . DIRECTORY_SEPARATOR . 'ids.php'; | ||
| if (!\is_file($path)) { | ||
| throw new MailboxesParserException(\sprintf('File for language ids %s does not exist', $path)); | ||
| } | ||
| $ids = require $path; | ||
| foreach ($ids as $specialFolder => $idsArray) { | ||
| foreach ($idsArray as $id) { | ||
| $this->addSpecialFolderId($specialFolder, $id); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * @return ParsedMailbox[] | ||
| */ | ||
| private function parse(): array | ||
| { | ||
| $this->folders = []; | ||
| \usort($this->mailboxes, [$this, 'sortByMailboxName']); | ||
| foreach ($this->mailboxes as $k => $mailbox) { | ||
| $mailboxName = $mailbox->getName(); | ||
| $folder = new ParsedMailbox(); | ||
| $folder->setMailbox($mailbox); | ||
| $folder->setMailboxName($mailboxName); | ||
| $special = $this->getSpecialFolder($mailboxName); | ||
| $folder->setSpecial($special); | ||
| $folder->setName($special ? $this->specialFoldersNames[$special] : $this->getName($mailboxName, $mailbox->getDelimiter())); | ||
| $folder->setOrder($special ? $this->specialFoldersOrder[$special] : $this->getOrder($mailboxName, $mailbox->getDelimiter())); | ||
| $folder->setLevel($this->getFolderLevel($mailboxName, $mailbox->getDelimiter())); | ||
| $folder->setDelimiter($mailbox->getDelimiter()); | ||
| $this->folders[] = $folder; | ||
| } | ||
|
|
||
| \usort($this->folders, [$this, 'sortByOrder']); | ||
|
|
||
| return $this->folders; | ||
| } | ||
|
|
||
| /** | ||
| * @param MailboxInterface $a | ||
| * @param MailboxInterface $b | ||
| * | ||
| * @return int | ||
| */ | ||
| private function sortByMailboxName(MailboxInterface $a, MailboxInterface $b): int | ||
| { | ||
| return $a->getName() <=> $b->getName(); | ||
| } | ||
|
|
||
| /** | ||
| * @param ParsedMailbox $a | ||
| * @param ParsedMailbox $b | ||
| * | ||
| * @return int | ||
| */ | ||
| private function sortByOrder(ParsedMailbox $a, ParsedMailbox $b): int | ||
| { | ||
| return $a->getOrder() <=> $b->getOrder(); | ||
| } | ||
|
|
||
| /** | ||
| * @return ParsedMailbox[] | ||
| */ | ||
| public function getFolders(): array | ||
| { | ||
| if (!$this->folders) { | ||
| $this->parse(); | ||
| } | ||
|
|
||
| return $this->folders; | ||
| } | ||
|
|
||
| /** | ||
| * @return array | ||
| */ | ||
| public function getTreeStructure(): array | ||
| { | ||
| if (!$this->treeStructure) { | ||
| $treeParser = new MailboxesTreeParser(); | ||
| $this->treeStructure = $treeParser->parse($this->getFolders()); | ||
| } | ||
|
|
||
| return $this->treeStructure; | ||
| } | ||
|
|
||
| /** | ||
| * @param array $specialFoldersNames | ||
| */ | ||
| public function setSpecialFoldersNames(array $specialFoldersNames) | ||
| { | ||
| $this->specialFoldersNames = $specialFoldersNames; | ||
| } | ||
|
|
||
| /** | ||
| * @param $mailboxName | ||
| * | ||
| * @return null|int|string | ||
| */ | ||
| private function getSpecialFolder($mailboxName) | ||
| { | ||
| foreach ($this->specialFoldersIds as $specialFolderKind => $names) { | ||
| $lower = \mb_strtolower($mailboxName); | ||
| foreach ($names as $name) { | ||
| if ($lower === \mb_strtolower($name)) { | ||
| return $specialFolderKind; | ||
| } | ||
| } | ||
| } | ||
|
|
||
| return; | ||
| } | ||
|
|
||
| /** | ||
| * @param $mailboxName | ||
| * @param string $delimiter | ||
| * | ||
| * @return string | ||
| */ | ||
| private function getName($mailboxName, $delimiter = '.'): string | ||
| { | ||
| $e = \explode($delimiter, $mailboxName); | ||
|
|
||
| return \ucfirst($e[\count($e) - 1]); | ||
| } | ||
|
|
||
| /** | ||
| * @param $mailboxName | ||
| * @param $delimiter | ||
| * | ||
| * @return float|int|mixed | ||
| */ | ||
| private function getOrder($mailboxName, $delimiter) | ||
| { | ||
| if ($this->folders[$mailboxName]['special']) { | ||
| return $this->specialFoldersOrder[$this->folders[$mailboxName]['special']]; | ||
| } | ||
| $e = \explode($delimiter, $mailboxName); | ||
|
|
||
| $level = \count($e) - 1; | ||
| if ('INBOX' === $e[0] && 1 === $level) { | ||
| $level = -1; | ||
| } | ||
| if ($e[1]) { | ||
| \array_pop($e); | ||
| $parentMailboxName = \implode($delimiter, $e); | ||
| if ($level === -1) { | ||
| $multiplier = 100; | ||
| } else { | ||
| $power = -1 * ($level * 2); | ||
| $multiplier = 10 ** ($power); | ||
| } | ||
| $parsedParent = null; | ||
| /** @var ParsedMailbox $parsedMailbox */ | ||
| foreach ($this->folders as $parsedMailbox) { | ||
| if ($parsedMailbox->getMailboxName() === $parentMailboxName) { | ||
| $parsedParent = $parsedMailbox; | ||
|
|
||
| break; | ||
| } | ||
| } | ||
| if ($parsedParent) { | ||
| $parsedParent->setSubfolders($parsedParent->getSubfolders() + 1); | ||
| $order = ($parsedParent->getOrder() + ($parsedParent->getSubfolders() * $multiplier)); | ||
| } else { | ||
| $order = 10; | ||
| } | ||
| } else { | ||
| $order = 10; | ||
| } | ||
|
|
||
| return $order; | ||
| } | ||
|
|
||
| /** | ||
| * @param $special | ||
| * | ||
| * @return null|string | ||
| */ | ||
| public function getMailboxNameForSpecial($special) | ||
| { | ||
| /** @var ParsedMailbox $parsedMailbox */ | ||
| foreach ($this->folders as $parsedMailbox) { | ||
| if ($parsedMailbox->getSpecial() === $special) { | ||
| return $parsedMailbox->getMailboxName(); | ||
| } | ||
| } | ||
|
|
||
| return; | ||
| } | ||
|
|
||
| /** | ||
| * @param string $specialFolder Name of special folder | ||
| * @param string $id Id for that special folder | ||
| */ | ||
| public function addSpecialFolderId($specialFolder, $id) | ||
| { | ||
| $this->specialFoldersIds[$specialFolder][] = $id; | ||
| } | ||
|
|
||
| /** | ||
| * @param $mailboxName | ||
| * @param $delimiter | ||
| * | ||
| * @return int | ||
| */ | ||
| private function getFolderLevel($mailboxName, $delimiter): int | ||
| { | ||
| $e = \explode($delimiter, $mailboxName); | ||
|
|
||
| return \count($e); | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,52 @@ | ||
| <?php | ||
|
|
||
| declare(strict_types=1); | ||
| /** | ||
| * Created by PhpStorm. | ||
| * User: Lukasz | ||
| * Date: 2017-12-01 | ||
| * Time: 10:22. | ||
| */ | ||
|
|
||
| namespace Ddeboer\Imap\MailboxesParser; | ||
|
|
||
| /** | ||
| * Class MailboxesParser. | ||
| */ | ||
| interface MailboxesParserInterface | ||
| { | ||
| /** | ||
| * Set language for parser. | ||
| * | ||
| * @param string $lang | ||
| */ | ||
| public function setLanguage(string $lang); | ||
|
|
||
| /** | ||
| * @return ParsedMailbox[] | ||
| */ | ||
| public function getFolders(): array; | ||
|
|
||
| /** | ||
| * @return array | ||
| */ | ||
| public function getTreeStructure(): array; | ||
|
|
||
| /** | ||
| * @param array $specialFoldersNames | ||
| */ | ||
| public function setSpecialFoldersNames(array $specialFoldersNames); | ||
|
|
||
| /** | ||
| * @param $special | ||
| * | ||
| * @return null|string | ||
| */ | ||
| public function getMailboxNameForSpecial($special); | ||
|
|
||
| /** | ||
| * @param string $specialFolder Name of special folder | ||
| * @param string $id Id for that special folder | ||
| */ | ||
| public function addSpecialFolderId($specialFolder, $id); | ||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We want to keep one indentation for this file, please revert it.