mirror of
https://github.com/nextcloud/mail.git
synced 2026-01-31 08:07:30 +00:00
23e3cc48ff
The cron background sync can be expensive with accounts that have many mailboxes. As it turns out other clients like Thunderbird also don't look into *all* mailboxes to check for new email. Instead they only do that for INBOX by default and let the user pick more mailboxes if they wish. We should do the same. This adds a simple flag. Only the inbox and mailboxes that have this flag set will get a sync in background. Any other mailbox can still be used, but the sync only happens if the user has the mailbox open. This will bring down the load on instances with many accounts, especially if those have many mailboxes. Signed-off-by: Christoph Wurst <christoph@winzerhof-wurst.at>
145 lines
4.5 KiB
PHP
145 lines
4.5 KiB
PHP
<?php
|
|
|
|
declare(strict_types=1);
|
|
|
|
/**
|
|
* @copyright 2019 Christoph Wurst <christoph@winzerhof-wurst.at>
|
|
*
|
|
* @author 2019 Christoph Wurst <christoph@winzerhof-wurst.at>
|
|
*
|
|
* @license GNU AGPL version 3 or any later version
|
|
*
|
|
* This program is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU Affero General Public License as
|
|
* published by the Free Software Foundation, either version 3 of the
|
|
* License, or (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU Affero General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Affero General Public License
|
|
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
namespace OCA\Mail\Db;
|
|
|
|
use JsonSerializable;
|
|
use OCP\AppFramework\Db\Entity;
|
|
use function base64_encode;
|
|
use function in_array;
|
|
use function json_decode;
|
|
use function ltrim;
|
|
use function strtolower;
|
|
|
|
/**
|
|
* @method string getName()
|
|
* @method void setName(string $name)
|
|
* @method int getAccountId()
|
|
* @method void setAccountId(int $accountId)
|
|
* @method string|null getSyncNewToken()
|
|
* @method void setSyncNewToken(string|null $syncNewToken)
|
|
* @method string|null getSyncChangedToken()
|
|
* @method void setSyncChangedToken(string|null $syncNewToken)
|
|
* @method string|null getSyncVanishedToken()
|
|
* @method void setSyncVanishedToken(string|null $syncNewToken)
|
|
* @method int|null getSyncNewLock()
|
|
* @method void setSyncNewLock(int|null $ts)
|
|
* @method int|null getSyncChangedLock()
|
|
* @method void setSyncChangedLock(int|null $ts)
|
|
* @method int|null getSyncVanishedLock()
|
|
* @method void setSyncVanishedLock(int|null $ts)
|
|
* @method string getAttributes()
|
|
* @method void setAttributes(string $attributes)
|
|
* @method string getDelimiter()
|
|
* @method void setDelimiter(string $delimiter)
|
|
* @method int getMessages()
|
|
* @method void setMessages(int $messages)
|
|
* @method int getUnseen()
|
|
* @method void setUnseen(int $unseen)
|
|
* @method bool getSelectable()
|
|
* @method void setSelectable(bool $selectable)
|
|
* @method string getSpecialUse()
|
|
* @method void setSpecialUse(string $specialUse)
|
|
* @method bool getSyncInBackground()
|
|
* @method void setSyncInBackground(bool $sync)
|
|
*/
|
|
class Mailbox extends Entity implements JsonSerializable {
|
|
protected $name;
|
|
protected $accountId;
|
|
protected $syncNewToken;
|
|
protected $syncChangedToken;
|
|
protected $syncVanishedToken;
|
|
protected $syncNewLock;
|
|
protected $syncChangedLock;
|
|
protected $syncVanishedLock;
|
|
protected $attributes;
|
|
protected $delimiter;
|
|
protected $messages;
|
|
protected $unseen;
|
|
protected $selectable;
|
|
protected $specialUse;
|
|
protected $syncInBackground;
|
|
|
|
public function __construct() {
|
|
$this->addType('accountId', 'integer');
|
|
$this->addType('messages', 'integer');
|
|
$this->addType('unseen', 'integer');
|
|
$this->addType('syncNewLock', 'integer');
|
|
$this->addType('syncChangedLock', 'integer');
|
|
$this->addType('syncVanishedLock', 'integer');
|
|
$this->addType('selectable', 'boolean');
|
|
$this->addType('syncInBackground', 'boolean');
|
|
}
|
|
|
|
public function isInbox(): bool {
|
|
// https://tools.ietf.org/html/rfc3501#section-5.1
|
|
return strtolower($this->getName()) === 'inbox';
|
|
}
|
|
|
|
private function getSpecialUseParsed(): array {
|
|
return json_decode($this->getSpecialUse() ?? '[]', true) ?? [];
|
|
}
|
|
|
|
public function isSpecialUse(string $specialUse): bool {
|
|
return in_array(
|
|
ltrim(
|
|
strtolower($specialUse),
|
|
'\\'
|
|
),
|
|
array_map("strtolower", $this->getSpecialUseParsed()),
|
|
true
|
|
);
|
|
}
|
|
|
|
public function isCached(): bool {
|
|
return $this->getSyncNewToken() !== null
|
|
&& $this->getSyncChangedToken() !== null
|
|
&& $this->getSyncVanishedToken() !== null;
|
|
}
|
|
|
|
public function hasLocks(): bool {
|
|
return $this->getSyncNewLock() !== null
|
|
|| $this->getSyncChangedLock() !== null
|
|
|| $this->getSyncVanishedLock() !== null;
|
|
}
|
|
|
|
public function jsonSerialize() {
|
|
$specialUse = $this->getSpecialUseParsed();
|
|
return [
|
|
'databaseId' => $this->getId(),
|
|
'id' => base64_encode($this->getName()),
|
|
'name' => $this->getName(),
|
|
'accountId' => $this->accountId,
|
|
'displayName' => $this->getName(),
|
|
'attributes' => json_decode($this->attributes ?? '[]', true) ?? [],
|
|
'delimiter' => $this->delimiter,
|
|
'specialUse' => $specialUse,
|
|
'specialRole' => $specialUse[0] ?? 0,
|
|
'mailboxes' => [],
|
|
'syncInBackground' => $this->getSyncInBackground(),
|
|
];
|
|
}
|
|
}
|