MailFolderSearch.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
namespace ILIAS\Mail\Folder;
 
use ilMailSearchResult;
use ilMailLuceneSearcher;
use ilMailLuceneQueryParser;
use ILIAS\Mail\Message\MailBoxQuery;
use ILIAS\Mail\Message\MailRecordData;
use ILIAS\Mail\Message\MailBoxOrderColumn;
 
class MailFolderSearch
{
    private MailBoxQuery $mailbox_query;
    private ?ilMailLuceneSearcher $lucene_searcher = null;
    private ?ilMailSearchResult $lucene_result = null;
    private ?array $filtered_ids = null;
    private ?int $count = null;
    private ?int $unread = null;
 
    public function __construct(
        private readonly MailFolderData $folder,
        private readonly MailFilterData $filter,
        private readonly bool $lucene_enabled,
    ) {
        $this->mailbox_query = (new MailBoxQuery(
            $this->folder->getUserId()
        ))
            ->withFolderId($this->folder->getFolderId())
            ->withSender($this->filter->getSender())
            ->withRecipients($this->filter->getRecipients())
            ->withSubject($this->filter->getSubject())
            ->withBody($this->filter->getBody())
            ->withPeriodStart($this->filter->getPeriodStart())
            ->withPeriodEnd($this->filter->getPeriodEnd())
            ->withIsUnread($this->filter->isUnread())
            ->withIsSystem($this->filter->isSystem())
            ->withHasAttachment($this->filter->hasAttachment());
 
        if ($this->lucene_enabled && (
            ($this->filter->getSender() ?? '') !== '' ||
            ($this->filter->getRecipients() ?? '') !== '' ||
            ($this->filter->getSubject() ?? '') !== '' ||
            ($this->filter->getBody() ?? '') !== '' ||
            ($this->filter->getAttachment() ?? '') !== ''
        )) {
            $query_parser = new ilMailLuceneQueryParser('');
            $query_parser->setFields([
                'title' => $this->filter->getSubject(),
                'content' => $this->filter->getBody(),
                'mattachment' => $this->filter->getAttachment(), // only possible with lucene
                'msender' => $this->filter->getSender(),
            ]);
            $query_parser->parse();
 
            // lucene search wil be done and cached by getFilteredIds
            $this->lucene_result = new ilMailSearchResult();
            $this->lucene_searcher = new ilMailLuceneSearcher($query_parser, $this->lucene_result);
        }
    }
 
    public function getCount(): int
    {
        if ($this->count === null) {
            $this->count = $this->mailbox_query->withFilteredIds($this->getFilteredIds())->count();
        }
 
        return $this->count;
    }
 
    public function getUnread(): int
    {
        if ($this->unread === null) {
            $this->unread = $this->mailbox_query->withFilteredIds($this->getFilteredIds())->countUnread();
        }
 
        return $this->unread;
    }
 
    public function getMaiIds(): array
    {
        return $this->mailbox_query
            ->withFilteredIds($this->getFilteredIds())
            ->queryMailIds();
    }
 
    public function getRecords(): array
    {
        return $this->mailbox_query
            ->withFilteredIds($this->getFilteredIds())
            ->query(true);
    }
 
    public function getPagedRecords(
        int $limit,
        int $offset,
        ?MailBoxOrderColumn $order_column,
        ?string $order_direction
    ): array {
        return $this->mailbox_query
            ->withFilteredIds($this->getFilteredIds())
            ->withLimit($limit)
            ->withOffset($offset)
            ->withOrderColumn($order_column)
            ->withOrderDirection($order_direction)
            ->query(true);
    }
 
    private function getFilteredIds(): ?array
    {
        if ($this->filtered_ids === null &&
            $this->lucene_result !== null &&
            $this->lucene_searcher !== null) {
            $this->lucene_searcher->search($this->folder->getUserId(), $this->folder->getFolderId());
            $this->filtered_ids = $this->lucene_result->getIds();
        }
 
        return $this->filtered_ids;
    }
 
    public function forMailIds(array $ids): self
    {
        $clone = clone $this;
        $clone->filtered_ids = $ids;
        return $clone;
    }
}