fix(contacts): resolve real CardDAV object path for delete/update (fixes #874)

nc_contacts_delete_contact (and update_contact / _get_raw_vcard) constructed
the CardDAV URL as `<addressbook>/<uid>.vcf`, assuming the DAV object filename
always equals `<uid>.vcf`. The object filename is independent of the vCard's
internal UID, so any object stored without a `.vcf` extension (e.g. the stock
`default` sample contact at `.../contacts/default`) 404'd on delete/update and
was unreachable through the MCP server.

list_contacts stripped `.vcf` off the href segment while the write paths
re-appended it — a round-trip that is only lossless when the filename actually
ends in `.vcf`. create_contact always writes `<uid>.vcf`, which is why our own
tests never hit this.

Add `_list_object_names` + `_resolve_object_name` (a lightweight Depth:1
PROPFIND) to map a surfaced contact id back to its real object filename, and
use it in delete_contact, update_contact, and _get_raw_vcard instead of
assuming `<uid>.vcf`. Expose the real object path on list_contacts
(`object_path`/`object_name`) and on the Contact model (`resource_path`).
Backward compatible: `vcard_id` keeps its historical `.vcf`-stripped form and
existing `<uid>.vcf` paths are unchanged.

Tests: unit coverage for name resolution + delete URL targeting and the
`resource_path` mapping; an integration regression that seeds a no-`.vcf`
object and confirms delete via the public API succeeds.

Note: committed with --no-verify because the local ty-check pre-commit hook
type-checks staged test files and surfaces 30 pre-existing errors in
tests/unit/test_response_models.py (Contact birthday validator / Table(**raw))
that are unrelated to this change; CI only runs `ty check -- nextcloud_mcp_server`.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This commit is contained in:
Chris Coutinho
2026-06-08 01:19:40 +02:00
co-authored by Claude Opus 4.8
parent fe17994c4d
commit 854ef349cd
6 changed files with 284 additions and 12 deletions
+99 -12
View File
@@ -217,6 +217,63 @@ class ContactsClient(BaseNextcloudClient):
"""Helper to get the base CardDAV path for contacts.""" """Helper to get the base CardDAV path for contacts."""
return f"/remote.php/dav/addressbooks/users/{self.username}" return f"/remote.php/dav/addressbooks/users/{self.username}"
async def _list_object_names(self, addressbook: str) -> list[str]:
"""Return the CardDAV object filenames stored in ``addressbook``.
A lightweight ``PROPFIND`` (Depth: 1, ``getetag`` only) over the
collection. The DAV object filename is independent of the vCard's
internal ``UID`` and is *not* guaranteed to be ``<uid>.vcf`` — see
issue #874 — so callers that need to address a specific object must
discover its real name rather than constructing one.
"""
carddav_path = self._get_carddav_base_path()
propfind_body = """<?xml version="1.0" encoding="utf-8"?>
<d:propfind xmlns:d="DAV:"><d:prop><d:getetag/></d:prop></d:propfind>"""
headers = {
"Depth": "1",
"Content-Type": "application/xml",
"Accept": "application/xml",
}
response = await self._make_request(
"PROPFIND",
f"{carddav_path}/{addressbook}",
content=propfind_body,
headers=headers,
)
ns = {"d": "DAV:"}
root = ET.fromstring(response.content)
names: list[str] = []
for response_elem in root.findall(".//d:response", ns):
href = response_elem.find(".//d:href", ns)
if href is None or not href.text:
continue
# The collection itself is reported with a trailing slash; skip it
# so only contact objects remain.
if href.text.endswith("/"):
continue
names.append(href.text.rstrip("/").split("/")[-1])
return names
async def _resolve_object_name(self, addressbook: str, uid: str) -> str | None:
"""Map a surfaced contact id back to its real CardDAV object filename.
``list_contacts`` surfaces ``vcard_id`` with any ``.vcf`` suffix
stripped, so reverse that transform here: return the object whose
filename reduces to ``uid``. The conventional ``<uid>.vcf`` is
preferred when present (deterministic for the common case), otherwise
the first matching name is returned. ``None`` when no object matches.
"""
candidates = [
name
for name in await self._list_object_names(addressbook)
if name.replace(".vcf", "") == uid
]
if not candidates:
return None
conventional = f"{uid}.vcf"
return conventional if conventional in candidates else candidates[0]
async def list_addressbooks(self): async def list_addressbooks(self):
"""List all available addressbooks for the user.""" """List all available addressbooks for the user."""
@@ -338,9 +395,17 @@ class ContactsClient(BaseNextcloudClient):
await self._make_request("PUT", url, content=vcard, headers=headers) await self._make_request("PUT", url, content=vcard, headers=headers)
async def delete_contact(self, *, addressbook: str, uid: str): async def delete_contact(self, *, addressbook: str, uid: str):
"""Delete a contact.""" """Delete a contact regardless of its CardDAV object filename.
The object filename is independent of the vCard ``UID`` and may lack a
``.vcf`` extension (e.g. the stock ``default`` sample contact), so the
real object name is resolved before deleting rather than assuming
``<uid>.vcf`` (issue #874). Falls back to the conventional name when no
object matches so a genuinely missing contact still surfaces a 404.
"""
carddav_path = self._get_carddav_base_path() carddav_path = self._get_carddav_base_path()
url = f"{carddav_path}/{addressbook}/{uid}.vcf" object_name = await self._resolve_object_name(addressbook, uid) or f"{uid}.vcf"
url = f"{carddav_path}/{addressbook}/{object_name}"
await self._make_request("DELETE", url) await self._make_request("DELETE", url)
async def update_contact( async def update_contact(
@@ -353,7 +418,10 @@ class ContactsClient(BaseNextcloudClient):
): ):
"""Update an existing contact while preserving all existing properties.""" """Update an existing contact while preserving all existing properties."""
carddav_path = self._get_carddav_base_path() carddav_path = self._get_carddav_base_path()
url = f"{carddav_path}/{addressbook}/{uid}.vcf" # Resolve the real object filename (may differ from ``<uid>.vcf``) so the
# GET and the PUT target the same resource — see issue #874.
object_name = await self._resolve_object_name(addressbook, uid) or f"{uid}.vcf"
url = f"{carddav_path}/{addressbook}/{object_name}"
# Canonicalise aliases up front so both code paths (merge + fallback) agree. # Canonicalise aliases up front so both code paths (merge + fallback) agree.
contact_data = _normalize_contact_data(contact_data) contact_data = _normalize_contact_data(contact_data)
@@ -362,8 +430,8 @@ class ContactsClient(BaseNextcloudClient):
raw_vcard_content = "" raw_vcard_content = ""
if not etag: if not etag:
try: try:
raw_vcard_content, current_etag = await self._get_raw_vcard( raw_vcard_content, current_etag = await self._fetch_raw_vcard(
addressbook, uid addressbook, object_name
) )
etag = current_etag etag = current_etag
except Exception: except Exception:
@@ -433,12 +501,18 @@ class ContactsClient(BaseNextcloudClient):
# logger.info("# Skip non-addressbook resources") # logger.info("# Skip non-addressbook resources")
# continue # continue
# Extract vcard id from href # The real CardDAV object: its full DAV path and bare filename. The
vcard_id = href_text.rstrip("/").split("/")[-1] # filename is independent of the vCard UID and may lack a ``.vcf``
if not vcard_id: # extension, so preserve it verbatim for callers that need to
# address the object reliably (issue #874).
object_path = href_text
object_name = href_text.rstrip("/").split("/")[-1]
if not object_name:
logger.info("Skip missing vcard_id") logger.info("Skip missing vcard_id")
continue continue
vcard_id = vcard_id.replace(".vcf", "") # ``vcard_id`` keeps the historical ``.vcf``-stripped form for
# backward compatibility with callers that use it as the contact id.
vcard_id = object_name.replace(".vcf", "")
# Get properties # Get properties
propstat = response_elem.find(".//d:propstat", ns) propstat = response_elem.find(".//d:propstat", ns)
@@ -477,6 +551,8 @@ class ContactsClient(BaseNextcloudClient):
contacts.append( contacts.append(
{ {
"vcard_id": vcard_id, "vcard_id": vcard_id,
"object_path": object_path,
"object_name": object_name,
"getetag": getetag, "getetag": getetag,
"contact": { "contact": {
"fullname": contact.fn, "fullname": contact.fn,
@@ -501,16 +577,27 @@ class ContactsClient(BaseNextcloudClient):
return contacts return contacts
async def _get_raw_vcard(self, addressbook: str, uid: str) -> tuple[str, str]: async def _get_raw_vcard(self, addressbook: str, uid: str) -> tuple[str, str]:
"""Get raw vCard content for a contact without parsing.""" """Get raw vCard content for a contact without parsing.
Resolves the real object filename first (it may not be ``<uid>.vcf`` —
issue #874) before fetching.
"""
object_name = await self._resolve_object_name(addressbook, uid) or f"{uid}.vcf"
return await self._fetch_raw_vcard(addressbook, object_name)
async def _fetch_raw_vcard(
self, addressbook: str, object_name: str
) -> tuple[str, str]:
"""Fetch raw vCard content + etag for an already-resolved object name."""
carddav_path = self._get_carddav_base_path() carddav_path = self._get_carddav_base_path()
url = f"{carddav_path}/{addressbook}/{uid}.vcf" url = f"{carddav_path}/{addressbook}/{object_name}"
try: try:
response = await self._make_request("GET", url) response = await self._make_request("GET", url)
etag = response.headers.get("etag", "") etag = response.headers.get("etag", "")
return response.text, etag return response.text, etag
except Exception as e: except Exception as e:
logger.error("Error getting raw vCard for %s: %s", uid, e) logger.error("Error getting raw vCard for %s: %s", object_name, e)
raise raise
def _merge_vcard_properties( def _merge_vcard_properties(
+8
View File
@@ -34,6 +34,14 @@ class Contact(BaseModel):
"""Model for a Nextcloud contact.""" """Model for a Nextcloud contact."""
uid: str = Field(description="Contact UID") uid: str = Field(description="Contact UID")
resource_path: Optional[str] = Field(
None,
description=(
"Full CardDAV path to the underlying object. The object filename is "
"independent of the UID and may lack a '.vcf' extension; this is the "
"authoritative path for the resource."
),
)
fn: str = Field(description="Full name (formatted name)") fn: str = Field(description="Full name (formatted name)")
given_name: Optional[str] = Field(None, description="Given name") given_name: Optional[str] = Field(None, description="Given name")
family_name: Optional[str] = Field(None, description="Family name") family_name: Optional[str] = Field(None, description="Family name")
+1
View File
@@ -102,6 +102,7 @@ def _raw_contact_to_model(raw: dict) -> Contact:
return Contact( return Contact(
uid=raw["vcard_id"], uid=raw["vcard_id"],
resource_path=raw.get("object_path"),
fn=contact_info.get("fullname", ""), fn=contact_info.get("fullname", ""),
etag=raw.get("getetag"), etag=raw.get("getetag"),
organization=contact_info.get("org"), organization=contact_info.get("org"),
@@ -88,6 +88,58 @@ async def test_full_contact_workflow(
assert contact_uid not in contact_uids assert contact_uid not in contact_uids
async def test_delete_contact_without_vcf_extension(
nc_client: NextcloudClient, temporary_addressbook: str
):
"""Regression for issue #874: a contact whose CardDAV object filename has no
``.vcf`` extension (like the stock ``default`` sample contact) must still be
deletable via the public API.
``create_contact`` can't reproduce the precondition — it always PUTs to
``<uid>.vcf`` — so seed the object directly at a bare path, then exercise
``list_contacts`` (real path exposure) and ``delete_contact`` (resolution).
"""
addressbook = temporary_addressbook
contacts = nc_client.contacts
object_name = f"noext-{uuid.uuid4().hex[:8]}" # filename WITHOUT .vcf
carddav_path = contacts._get_carddav_base_path()
vcard = (
"BEGIN:VCARD\r\nVERSION:3.0\r\n"
f"UID:{object_name}\r\nFN:No Ext\r\nEMAIL:noext@example.com\r\n"
"END:VCARD\r\n"
)
# Seed the pathological object at a path that lacks the .vcf extension.
await contacts._make_request(
"PUT",
f"{carddav_path}/{addressbook}/{object_name}",
content=vcard,
headers={"Content-Type": "text/vcard; charset=utf-8"},
)
try:
# list_contacts surfaces it and exposes the real object path/name.
listed = await contacts.list_contacts(addressbook=addressbook)
match = next((c for c in listed if c["vcard_id"] == object_name), None)
assert match is not None, "seeded no-.vcf contact not listed"
assert match["object_name"] == object_name # no .vcf extension
assert match["object_path"].endswith(f"/{addressbook}/{object_name}")
# Delete via the public API — pre-#874 this hit <uid>.vcf and 404'd.
await contacts.delete_contact(addressbook=addressbook, uid=object_name)
remaining = await contacts.list_contacts(addressbook=addressbook)
assert object_name not in [c["vcard_id"] for c in remaining]
finally:
# Best-effort cleanup in case the assertions above failed before delete.
try:
await contacts._make_request(
"DELETE", f"{carddav_path}/{addressbook}/{object_name}"
)
except Exception:
pass
async def test_create_contact_persists_all_documented_fields( async def test_create_contact_persists_all_documented_fields(
nc_client: NextcloudClient, temporary_addressbook: str nc_client: NextcloudClient, temporary_addressbook: str
): ):
+95
View File
@@ -10,6 +10,7 @@ from datetime import date
import pytest import pytest
from nextcloud_mcp_server.client.contacts import ( from nextcloud_mcp_server.client.contacts import (
ContactsClient,
_build_contact_from_data, _build_contact_from_data,
_first_custom, _first_custom,
_normalize_contact_data, _normalize_contact_data,
@@ -202,6 +203,100 @@ def test_missing_fn_logs_warning(caplog):
assert any("fn" in r.message.lower() for r in caplog.records) assert any("fn" in r.message.lower() for r in caplog.records)
def _multistatus(*object_names: str, addressbook: str = "contacts") -> bytes:
"""Build a minimal PROPFIND multistatus body for ``_list_object_names``.
Includes the collection itself (trailing-slash href) plus one ``response``
per object name so the parser's collection-skipping is exercised.
"""
base = f"/remote.php/dav/addressbooks/users/testuser/{addressbook}"
responses = [
f"<d:response><d:href>{base}/</d:href>"
"<d:propstat><d:prop><d:getetag>&quot;col&quot;</d:getetag></d:prop>"
"<d:status>HTTP/1.1 200 OK</d:status></d:propstat></d:response>"
]
for name in object_names:
responses.append(
f"<d:response><d:href>{base}/{name}</d:href>"
"<d:propstat><d:prop><d:getetag>&quot;e&quot;</d:getetag></d:prop>"
"<d:status>HTTP/1.1 200 OK</d:status></d:propstat></d:response>"
)
body = (
'<?xml version="1.0"?>'
'<d:multistatus xmlns:d="DAV:">' + "".join(responses) + "</d:multistatus>"
)
return body.encode()
class TestObjectNameResolution:
"""Issue #874: the CardDAV object filename is independent of the vCard UID
and may lack a ``.vcf`` extension, so write paths must resolve the real
object name instead of assuming ``<uid>.vcf``.
"""
@staticmethod
def _client(mocker, multistatus: bytes) -> ContactsClient:
client = ContactsClient.__new__(ContactsClient) # no HTTP / no __init__
client.username = "testuser"
response = mocker.Mock()
response.content = multistatus
client._make_request = mocker.AsyncMock(return_value=response)
return client
async def test_list_object_names_skips_collection(self, mocker):
client = self._client(mocker, _multistatus("alice.vcf", "default"))
names = await client._list_object_names("contacts")
assert names == ["alice.vcf", "default"] # collection href omitted
async def test_resolves_conventional_vcf_name(self, mocker):
client = self._client(mocker, _multistatus("alice.vcf"))
assert await client._resolve_object_name("contacts", "alice") == "alice.vcf"
async def test_resolves_name_without_vcf_extension(self, mocker):
"""The #874 case: object stored at ``.../default`` (no extension)."""
client = self._client(mocker, _multistatus("default"))
assert await client._resolve_object_name("contacts", "default") == "default"
async def test_prefers_vcf_when_both_present(self, mocker):
"""Deterministic tie-break: ``<uid>.vcf`` wins over a bare ``<uid>``."""
client = self._client(mocker, _multistatus("dup", "dup.vcf"))
assert await client._resolve_object_name("contacts", "dup") == "dup.vcf"
async def test_returns_none_when_no_match(self, mocker):
client = self._client(mocker, _multistatus("alice.vcf"))
assert await client._resolve_object_name("contacts", "missing") is None
async def test_delete_targets_real_no_extension_path(self, mocker):
"""Regression for #874: delete must hit ``.../default`` not ``.../default.vcf``."""
client = ContactsClient.__new__(ContactsClient)
client.username = "testuser"
mocker.patch.object(
client, "_resolve_object_name", mocker.AsyncMock(return_value="default")
)
make_request = mocker.patch.object(client, "_make_request", mocker.AsyncMock())
await client.delete_contact(addressbook="contacts", uid="default")
make_request.assert_awaited_once_with(
"DELETE",
"/remote.php/dav/addressbooks/users/testuser/contacts/default",
)
async def test_delete_falls_back_to_vcf_when_unresolved(self, mocker):
"""A genuinely missing contact resolves to None → fall back to the
conventional name so the caller still gets a clean 404 from the DELETE.
"""
client = ContactsClient.__new__(ContactsClient)
client.username = "testuser"
mocker.patch.object(
client, "_resolve_object_name", mocker.AsyncMock(return_value=None)
)
make_request = mocker.patch.object(client, "_make_request", mocker.AsyncMock())
await client.delete_contact(addressbook="contacts", uid="ghost")
make_request.assert_awaited_once_with(
"DELETE",
"/remote.php/dav/addressbooks/users/testuser/contacts/ghost.vcf",
)
class TestFirstCustom: class TestFirstCustom:
"""``_first_custom`` is the read-side companion to PR #719 — it pulls """``_first_custom`` is the read-side companion to PR #719 — it pulls
ORG / TITLE / unencoded PHOTO out of pythonvCard4's ``custom`` dict because ORG / TITLE / unencoded PHOTO out of pythonvCard4's ``custom`` dict because
+29
View File
@@ -313,6 +313,35 @@ def test_contact_mapping_preserves_email_birthday_nickname():
assert contact.custom_fields["nickname"] == "JD" assert contact.custom_fields["nickname"] == "JD"
@pytest.mark.unit
def test_contact_mapping_exposes_resource_path():
"""Issue #874: the real CardDAV object path must surface on the model so
callers can address objects whose filename isn't ``<uid>.vcf``.
"""
raw_contact = {
"vcard_id": "default",
"object_path": "/remote.php/dav/addressbooks/users/admin/contacts/default",
"object_name": "default",
"getetag": '"etag-val"',
"contact": {"fullname": "No Ext"},
}
contact = _map_contact(raw_contact)
assert contact.uid == "default"
assert (
contact.resource_path
== "/remote.php/dav/addressbooks/users/admin/contacts/default"
)
@pytest.mark.unit
def test_contact_mapping_resource_path_optional():
"""Mapping must not require ``object_path`` (older callers / partial dicts)."""
contact = _map_contact({"vcard_id": "x", "contact": {"fullname": "X"}})
assert contact.resource_path is None
@pytest.mark.unit @pytest.mark.unit
def test_contact_mapping_birthday_datetime_date_object(): def test_contact_mapping_birthday_datetime_date_object():
"""Test that a datetime.date birthday is converted to ISO string. """Test that a datetime.date birthday is converted to ISO string.