Files
inbuxa-server/crates/jmap/src/changes/get.rs
T
jcoffey-dev f44382fb09
ci / fork-checks (pull_request) Successful in 33s
ci / build (pull_request) Successful in 9m58s
DLP phase 3: hold for review
The hold action now holds (dlp-and-mail-flow-rules spec, §2.6), where
until now it blocked.

- At DATA a hold decision queues the message with its release a century
  off (the queue's future-release mechanism, so the stored format is
  unchanged and an older node just never sends it), transport rules
  still applied, and replies 250 Held for review. A review record under
  R/h + queue id keeps the sender, recipients, subject, size, rules and
  detector counts. The sender is told when the rule asks.
- smtp/queue/held.rs: release (each recipient due now, its next notice
  as far off as it was, its lifetime counted from the release), reject
  (removed from the queue, the sender told, with the reviewer's note),
  and expiry: the daily clean-up rejects what nobody reviewed in 7 days,
  recorded as the server's doing.
- inbuxa:HeldMessage get/set: the review queue, sysDlpReviewGet to list
  and read (preview, 64 KB of text, only when asked for and recorded as
  blobAccess), sysDlpReviewUpdate to release or reject, a reason
  required and audited by the request layer; no create or destroy;
  server-level only.
- Guards: Emails > Queue refuses to change or delete held mail; the
  sender can't unsend it.
- Privacy catalog entry for inbuxa:HeldMessage; spec §2.6 as built.

Tests: mail_rules_tests gains the whole flow (held and listed with
counts, sender notified and nothing delivered, queue and unsend
refused, preview recorded, reject needs a reason and tells the sender
the note, release delivers, expiry returns it, decisions audited with
reasons). smtp inbound, system_tests (after one BlobNotFound in
antispam, the known flake, then clean), features and common unit tests.
2026-09-28 18:33:12 -07:00

455 lines
17 KiB
Rust

/*
* SPDX-FileCopyrightText: 2020 Stalwart Labs LLC <[email protected]>
*
* SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-SEL
*
* Modified by Coffey Labs in 2026 for INBUXA.
*/
use crate::{api::auth::JmapAuthorization, changes::state::JmapCacheState};
use common::{Server, auth::AccessToken};
use email::cache::{MessageCacheFetch, email::MessageCacheAccess, mailbox::MailboxCacheAccess};
use groupware::cache::GroupwareCache;
use jmap_proto::{
method::changes::{ChangesRequest, ChangesResponse},
object::{JmapObject, NullObject, mailbox::MailboxProperty},
request::method::MethodObject,
response::{ChangesResponseMethod, ResponseMethod},
types::state::State,
};
use std::future::Future;
use store::{
query::log::{Change, Query},
roaring::RoaringBitmap,
};
use trc::AddContext;
use types::{
acl::Acl,
collection::{Collection, SyncCollection},
};
pub trait ChangesLookup: Sync + Send {
fn changes(
&self,
request: ChangesRequest,
object: MethodObject,
access_token: &AccessToken,
) -> impl Future<Output = trc::Result<IntermediateChangesResponse>> + Send;
}
pub struct IntermediateChangesResponse {
pub response: ChangesResponse<NullObject>,
pub object: MethodObject,
pub only_container_changes: bool,
}
impl ChangesLookup for Server {
async fn changes(
&self,
request: ChangesRequest,
object: MethodObject,
access_token: &AccessToken,
) -> trc::Result<IntermediateChangesResponse> {
// Map collection and validate ACLs
let (collection, is_container) = match object {
MethodObject::Email => {
access_token.assert_has_access(request.account_id, Collection::Email)?;
(SyncCollection::Email, false)
}
MethodObject::Mailbox => {
access_token.assert_has_access(request.account_id, Collection::Mailbox)?;
(SyncCollection::Email, true)
}
MethodObject::Thread => {
access_token.assert_has_access(request.account_id, Collection::Email)?;
(SyncCollection::Thread, true)
}
MethodObject::Identity => {
access_token.assert_is_member(request.account_id)?;
(SyncCollection::Identity, false)
}
MethodObject::EmailSubmission => {
access_token.assert_is_member(request.account_id)?;
(SyncCollection::EmailSubmission, false)
}
MethodObject::AddressBook => {
access_token.assert_has_access(request.account_id, Collection::AddressBook)?;
(SyncCollection::AddressBook, true)
}
MethodObject::ContactCard => {
access_token.assert_has_access(request.account_id, Collection::ContactCard)?;
(SyncCollection::AddressBook, false)
}
MethodObject::FileNode => {
access_token.assert_has_access(request.account_id, Collection::FileNode)?;
(SyncCollection::FileNode, false)
}
MethodObject::Calendar => {
access_token.assert_has_access(request.account_id, Collection::Calendar)?;
(SyncCollection::Calendar, true)
}
MethodObject::CalendarEvent => {
access_token.assert_has_access(request.account_id, Collection::CalendarEvent)?;
(SyncCollection::Calendar, false)
}
MethodObject::CalendarEventNotification => {
access_token.assert_is_member(request.account_id)?;
(SyncCollection::CalendarEventNotification, false)
}
MethodObject::ShareNotification => {
access_token.assert_is_member(request.account_id)?;
(SyncCollection::ShareNotification, false)
}
_ => {
return Err(trc::JmapEvent::CannotCalculateChanges.into_err());
}
};
let max_changes = std::cmp::min(
request
.max_changes
.filter(|n| *n != 0)
.unwrap_or(usize::MAX),
self.core.jmap.changes_max_results,
);
let mut response: ChangesResponse<NullObject> = ChangesResponse {
account_id: request.account_id,
old_state: request.since_state.clone(),
new_state: State::Initial,
has_more_changes: false,
created: vec![],
updated: vec![],
destroyed: vec![],
updated_properties: None,
};
let account_id = request.account_id.document_id();
let allowed_ids: Option<RoaringBitmap> = if access_token.is_member(account_id) {
None
} else {
Some(match object {
MethodObject::Email => self
.get_cached_messages(account_id)
.await?
.shared_messages(access_token, Acl::ReadItems),
MethodObject::Mailbox => self
.get_cached_messages(account_id)
.await?
.shared_mailboxes(access_token, Acl::Read),
MethodObject::Thread => {
let cache = self.get_cached_messages(account_id).await?;
let shared = cache.shared_messages(access_token, Acl::ReadItems);
let mut threads = RoaringBitmap::new();
for item in &cache.emails.items {
if shared.contains(item.document_id) {
threads.insert(item.thread_id);
}
}
threads
}
MethodObject::AddressBook => self
.fetch_dav_resources(
access_token.account_id(),
account_id,
SyncCollection::AddressBook,
)
.await?
.shared_containers(access_token, [Acl::Read, Acl::ReadItems], true),
MethodObject::ContactCard => self
.fetch_dav_resources(
access_token.account_id(),
account_id,
SyncCollection::AddressBook,
)
.await?
.shared_items(access_token, [Acl::ReadItems], true),
MethodObject::Calendar => self
.fetch_dav_resources(
access_token.account_id(),
account_id,
SyncCollection::Calendar,
)
.await?
.shared_containers(access_token, [Acl::Read, Acl::ReadItems], true),
MethodObject::CalendarEvent => self
.fetch_dav_resources(
access_token.account_id(),
account_id,
SyncCollection::Calendar,
)
.await?
.shared_items(access_token, [Acl::ReadItems], true),
MethodObject::FileNode => self
.fetch_dav_resources(
access_token.account_id(),
account_id,
SyncCollection::FileNode,
)
.await?
.shared_documents(access_token, [Acl::Read, Acl::ReadItems], true),
_ => RoaringBitmap::new(),
})
};
let (items_sent, changelog) = match &request.since_state {
State::Initial => {
let changelog = self
.store()
.changes(account_id, collection.into(), Query::All)
.await?;
if changelog.changes.is_empty() && changelog.from_change_id == 0 {
return Ok(IntermediateChangesResponse {
response,
object,
only_container_changes: false,
});
}
(0, changelog)
}
State::Exact(change_id) => {
let last_state = match collection {
SyncCollection::Calendar | SyncCollection::AddressBook => self
.fetch_dav_resources(access_token.account_id(), account_id, collection)
.await
.caused_by(trc::location!())?
.get_state(is_container)
.into(),
SyncCollection::Email => self
.get_cached_messages(account_id)
.await?
.get_state(is_container)
.into(),
_ => None,
};
if let Some(last_state) = last_state {
response.new_state = last_state;
if response.new_state == State::Exact(*change_id) {
return Ok(IntermediateChangesResponse {
response,
object,
only_container_changes: false,
});
}
}
(
0,
self.store()
.changes(account_id, collection.into(), Query::Since(*change_id))
.await?,
)
}
State::Intermediate(intermediate_state) => {
let changelog = self
.store()
.changes(
account_id,
collection.into(),
Query::RangeInclusive(intermediate_state.from_id, intermediate_state.to_id),
)
.await?;
if (is_container
&& intermediate_state.items_sent >= changelog.total_container_changes())
|| (!is_container
&& intermediate_state.items_sent >= changelog.total_item_changes())
{
(
0,
self.store()
.changes(
account_id,
collection.into(),
Query::Since(intermediate_state.to_id),
)
.await?,
)
} else {
(intermediate_state.items_sent, changelog)
}
}
};
if (changelog.is_truncated || changelog.from_change_id == 0)
&& request.since_state != State::Initial
{
return Err(trc::JmapEvent::CannotCalculateChanges.into_err().details(
if changelog.is_truncated {
"Change log is truncated"
} else {
"Since state is invalid"
},
));
}
let mut changes = changelog
.changes
.into_iter()
.filter(|change| {
(is_container && change.is_container_change())
|| (!is_container && change.is_item_change())
})
.filter(|change| {
allowed_ids.as_ref().is_none_or(|allowed| {
let id = if is_container {
change.container_id()
} else {
change.item_id()
};
id.is_some_and(|id| allowed.contains(id as u32))
})
})
.skip(items_sent)
.peekable();
let mut items_changed = false;
for change in (&mut changes).take(max_changes) {
match change {
Change::InsertContainer(item) | Change::InsertItem(item) => {
response.created.push(item.into());
}
Change::UpdateContainer(item) | Change::UpdateItem(item) => {
response.updated.push(item.into());
items_changed = true;
}
Change::DeleteContainer(item) | Change::DeleteItem(item) => {
response.destroyed.push(item.into());
}
Change::UpdateContainerProperty(item) => {
response.updated.push(item.into());
}
};
}
let change_id = (if is_container {
changelog.container_change_id
} else {
changelog.item_change_id
})
.unwrap_or(changelog.to_change_id);
response.has_more_changes = changes.peek().is_some();
if response.has_more_changes {
response.new_state = State::new_intermediate(
changelog.from_change_id,
change_id,
items_sent + max_changes,
);
} else if response.new_state == State::Initial {
response.new_state = State::new_exact(change_id)
}
Ok(IntermediateChangesResponse {
only_container_changes: is_container && !response.updated.is_empty() && !items_changed,
response,
object,
})
}
}
impl IntermediateChangesResponse {
pub fn into_method_response(self) -> ResponseMethod<'static> {
ResponseMethod::Changes(match self.object {
MethodObject::Email => ChangesResponseMethod::Email(transmute_response(self.response)),
MethodObject::Mailbox => {
let mut response = transmute_response(self.response);
if self.only_container_changes {
response.updated_properties = vec![
MailboxProperty::TotalEmails.into(),
MailboxProperty::UnreadEmails.into(),
MailboxProperty::TotalThreads.into(),
MailboxProperty::UnreadThreads.into(),
]
.into();
}
ChangesResponseMethod::Mailbox(response)
}
MethodObject::Thread => {
ChangesResponseMethod::Thread(transmute_response(self.response))
}
MethodObject::Identity => {
ChangesResponseMethod::Identity(transmute_response(self.response))
}
MethodObject::EmailSubmission => {
ChangesResponseMethod::EmailSubmission(transmute_response(self.response))
}
MethodObject::AddressBook => {
ChangesResponseMethod::AddressBook(transmute_response(self.response))
}
MethodObject::ContactCard => {
ChangesResponseMethod::ContactCard(transmute_response(self.response))
}
MethodObject::FileNode => {
ChangesResponseMethod::FileNode(transmute_response(self.response))
}
MethodObject::Calendar => {
ChangesResponseMethod::Calendar(transmute_response(self.response))
}
MethodObject::CalendarEvent => {
ChangesResponseMethod::CalendarEvent(transmute_response(self.response))
}
MethodObject::CalendarEventNotification => {
ChangesResponseMethod::CalendarEventNotification(transmute_response(self.response))
}
MethodObject::ShareNotification => {
ChangesResponseMethod::ShareNotification(transmute_response(self.response))
}
MethodObject::ParticipantIdentity
| MethodObject::Core
| MethodObject::Blob
| MethodObject::PushSubscription
| MethodObject::SearchSnippet
| MethodObject::VacationResponse
| MethodObject::SieveScript
| MethodObject::Principal
| MethodObject::Quota
| MethodObject::MaskedEmail
| MethodObject::DeletedAccount
| MethodObject::AiLimits
| MethodObject::LogSettings
| MethodObject::DataInventory
| MethodObject::InventorySnapshot
| MethodObject::Explanation
| MethodObject::AuditEvent
| MethodObject::AuditSettings
| MethodObject::AuditExport
| MethodObject::AuditVerification
| MethodObject::AccountLock
| MethodObject::LegalHold
| MethodObject::HoldExport
| MethodObject::MailRule
| MethodObject::HeldMessage
| MethodObject::ProtocolPolicy
| MethodObject::TenantProtocolPolicy
| MethodObject::Registry(_) => unreachable!(),
})
}
}
fn transmute_response<T: JmapObject>(
response: ChangesResponse<NullObject>,
) -> Box<ChangesResponse<T>> {
Box::new(ChangesResponse {
account_id: response.account_id,
old_state: response.old_state,
new_state: response.new_state,
has_more_changes: response.has_more_changes,
created: response.created,
updated: response.updated,
destroyed: response.destroyed,
updated_properties: None,
})
}