1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
|
"""Nextcloud API for working with Notifications."""
import dataclasses
import datetime
from ._misc import (
check_capabilities,
nc_iso_time_to_datetime,
random_string,
require_capabilities,
)
from ._session import (
AsyncNcSessionApp,
AsyncNcSessionBasic,
NcSessionApp,
NcSessionBasic,
)
@dataclasses.dataclass
class Notification:
"""Class representing information about Nextcloud notification."""
def __init__(self, raw_data: dict):
self._raw_data = raw_data
@property
def notification_id(self) -> int:
"""ID of the notification."""
return self._raw_data["notification_id"]
@property
def object_id(self) -> str:
"""Randomly generated unique object ID."""
return self._raw_data["object_id"]
@property
def object_type(self) -> str:
"""Currently not used."""
return self._raw_data["object_type"]
@property
def app_name(self) -> str:
"""Application name that generated notification."""
return self._raw_data["app"]
@property
def user_id(self) -> str:
"""User ID of user for which this notification is."""
return self._raw_data["user"]
@property
def subject(self) -> str:
"""Subject of the notification."""
return self._raw_data["subject"]
@property
def message(self) -> str:
"""Message of the notification."""
return self._raw_data["message"]
@property
def time(self) -> datetime.datetime:
"""Time when the notification was created."""
return nc_iso_time_to_datetime(self._raw_data["datetime"])
@property
def link(self) -> str:
"""Link, which will be opened when user clicks on notification."""
return self._raw_data.get("link", "")
@property
def icon(self) -> str:
"""Relative to instance url of the icon image."""
return self._raw_data.get("icon", "")
def __repr__(self):
return (
f"<{self.__class__.__name__} id={self.notification_id}, app_name={self.app_name}, user_id={self.user_id},"
f" time={self.time}>"
)
class _NotificationsAPI:
"""Class providing an API for managing user notifications on the Nextcloud server."""
_ep_base: str = "/ocs/v2.php/apps/notifications/api/v2/notifications"
def __init__(self, session: NcSessionBasic):
self._session = session
@property
def available(self) -> bool:
"""Returns True if the Nextcloud instance supports this feature, False otherwise."""
return not check_capabilities("notifications", self._session.capabilities)
def create(
self,
subject: str,
message: str = "",
subject_params: dict | None = None,
message_params: dict | None = None,
link: str = "",
) -> str:
"""Create a Notification for the current user and returns it's ObjectID.
.. note:: Does not work in Nextcloud client mode, only for NextcloudApp mode.
"""
params = _create(subject, message, subject_params, message_params, link)
if not isinstance(self._session, NcSessionApp):
raise NotImplementedError("Sending notifications is only supported for `App` mode.")
require_capabilities(["app_api", "notifications"], self._session.capabilities)
return self._session.ocs("POST", f"{self._session.ae_url}/notification", json=params)["object_id"]
def get_all(self) -> list[Notification]:
"""Gets all notifications for a current user."""
require_capabilities("notifications", self._session.capabilities)
return [Notification(i) for i in self._session.ocs("GET", self._ep_base)]
def get_one(self, notification_id: int) -> Notification:
"""Gets a single notification for a current user."""
require_capabilities("notifications", self._session.capabilities)
return Notification(self._session.ocs("GET", f"{self._ep_base}/{notification_id}"))
def by_object_id(self, object_id: str) -> Notification | None:
"""Returns Notification if any by its object ID.
.. note:: this method is a temporary workaround until `create` can return `notification_id`.
"""
for i in self.get_all():
if i.object_id == object_id:
return i
return None
def delete(self, notification_id: int) -> None:
"""Deletes a notification for the current user."""
require_capabilities("notifications", self._session.capabilities)
self._session.ocs("DELETE", f"{self._ep_base}/{notification_id}")
def delete_all(self) -> None:
"""Deletes all notifications for the current user."""
require_capabilities("notifications", self._session.capabilities)
self._session.ocs("DELETE", self._ep_base)
def exists(self, notification_ids: list[int]) -> list[int]:
"""Checks the existence of notifications for the current user."""
require_capabilities("notifications", self._session.capabilities)
return self._session.ocs("POST", f"{self._ep_base}/exists", json={"ids": notification_ids})
class _AsyncNotificationsAPI:
"""Class provides async API for managing user notifications on the Nextcloud server."""
_ep_base: str = "/ocs/v2.php/apps/notifications/api/v2/notifications"
def __init__(self, session: AsyncNcSessionBasic):
self._session = session
@property
async def available(self) -> bool:
"""Returns True if the Nextcloud instance supports this feature, False otherwise."""
return not check_capabilities("notifications", await self._session.capabilities)
async def create(
self,
subject: str,
message: str = "",
subject_params: dict | None = None,
message_params: dict | None = None,
link: str = "",
) -> str:
"""Create a Notification for the current user and returns it's ObjectID.
.. note:: Does not work in Nextcloud client mode, only for NextcloudApp mode.
"""
params = _create(subject, message, subject_params, message_params, link)
if not isinstance(self._session, AsyncNcSessionApp):
raise NotImplementedError("Sending notifications is only supported for `App` mode.")
require_capabilities(["app_api", "notifications"], await self._session.capabilities)
return (await self._session.ocs("POST", f"{self._session.ae_url}/notification", json=params))["object_id"]
async def get_all(self) -> list[Notification]:
"""Gets all notifications for a current user."""
require_capabilities("notifications", await self._session.capabilities)
return [Notification(i) for i in await self._session.ocs("GET", self._ep_base)]
async def get_one(self, notification_id: int) -> Notification:
"""Gets a single notification for a current user."""
require_capabilities("notifications", await self._session.capabilities)
return Notification(await self._session.ocs("GET", f"{self._ep_base}/{notification_id}"))
async def by_object_id(self, object_id: str) -> Notification | None:
"""Returns Notification if any by its object ID.
.. note:: this method is a temporary workaround until `create` can return `notification_id`.
"""
for i in await self.get_all():
if i.object_id == object_id:
return i
return None
async def delete(self, notification_id: int) -> None:
"""Deletes a notification for the current user."""
require_capabilities("notifications", await self._session.capabilities)
await self._session.ocs("DELETE", f"{self._ep_base}/{notification_id}")
async def delete_all(self) -> None:
"""Deletes all notifications for the current user."""
require_capabilities("notifications", await self._session.capabilities)
await self._session.ocs("DELETE", self._ep_base)
async def exists(self, notification_ids: list[int]) -> list[int]:
"""Checks the existence of notifications for the current user."""
require_capabilities("notifications", await self._session.capabilities)
return await self._session.ocs("POST", f"{self._ep_base}/exists", json={"ids": notification_ids})
def _create(
subject: str, message: str, subject_params: dict | None, message_params: dict | None, link: str
) -> dict[str, str | dict]:
if not subject:
raise ValueError("`subject` cannot be empty string.")
if subject_params is None:
subject_params = {}
if message_params is None:
message_params = {}
params: dict = {
"params": {
"object": "app_api",
"object_id": random_string(56),
"subject_type": "app_api_ex_app",
"subject_params": {
"rich_subject": subject,
"rich_subject_params": subject_params,
"rich_message": message,
"rich_message_params": message_params,
},
}
}
if link:
params["params"]["subject_params"]["link"] = link
return params
|
