2.59
snac.h
1/* snac - A simple, minimalistic ActivityPub instance */
2/* copyright (c) 2022 - 2024 grunfink et al. / MIT license */
3
4#define VERSION "2.59"
5
6#define USER_AGENT "snac/" VERSION
7
8#define WHAT_IS_SNAC_URL "https:/" "/comam.es/what-is-snac"
9
10#define DIR_PERM 00770
11#define DIR_PERM_ADD 02770
12
13#define ISO_DATE_SPEC "%Y-%m-%dT%H:%M:%SZ"
14
15#ifndef MAX_THREADS
16#define MAX_THREADS 256
17#endif
18
19#ifndef MAX_CONVERSATION_LEVELS
20#define MAX_CONVERSATION_LEVELS 48
21#endif
22
23#define MD5_HEX_SIZE 33
24
25extern double disk_layout;
26extern xs_str *srv_basedir;
27extern xs_dict *srv_config;
28extern xs_str *srv_baseurl;
29
30extern int dbglevel;
31
32#define L(s) (s)
33
34#define POSTLIKE_OBJECT_TYPE "Note|Question|Page|Article|Video|Event"
35
36int mkdirx(const char *pathname);
37
38int valid_status(int status);
39xs_str *tid(int offset);
40double ftime(void);
41
42void srv_log(xs_str *str);
43#define srv_debug(level, str) do { if (dbglevel >= (level)) \
44 { srv_log((str)); } } while (0)
45
46typedef struct {
47 xs_str *uid; /* uid */
48 xs_str *basedir; /* user base directory */
49 xs_dict *config; /* user configuration */
50 xs_dict *config_o; /* user configuration admin override */
51 xs_dict *key; /* keypair */
52 xs_dict *links; /* validated links */
53 xs_str *actor; /* actor url */
54 xs_str *md5; /* actor url md5 */
55} snac;
56
57typedef struct {
58 int s_size; /* struct size (for double checking) */
59 int srv_running; /* server running on/off */
60 int use_fcgi; /* FastCGI use on/off */
61 time_t srv_start_time; /* start time */
62 int job_fifo_size; /* job fifo size */
63 int peak_job_fifo_size; /* maximum job fifo size seen */
64 int n_threads; /* number of configured threads */
65 enum { THST_STOP, THST_WAIT, THST_IN, THST_QUEUE } th_state[MAX_THREADS];
66} srv_state;
67
68extern srv_state *p_state;
69
70void snac_log(snac *user, xs_str *str);
71#define snac_debug(user, level, str) do { if (dbglevel >= (level)) \
72 { snac_log((user), (str)); } } while (0)
73
74int srv_open(const char *basedir, int auto_upgrade);
75void srv_free(void);
76
77int user_open(snac *snac, const char *uid);
78void user_free(snac *snac);
79xs_list *user_list(void);
80int user_open_by_md5(snac *snac, const char *md5);
81int user_persist(snac *snac, int publish);
82
83int validate_uid(const char *uid);
84
85xs_str *hash_password(const char *uid, const char *passwd, const char *nonce);
86int check_password(const char *uid, const char *passwd, const char *hash);
87
88void srv_archive(const char *direction, const char *url, xs_dict *req,
89 const char *payload, int p_size,
90 int status, xs_dict *headers,
91 const char *body, int b_size);
92void srv_archive_error(const char *prefix, const xs_str *err,
93 const xs_dict *req, const xs_val *data);
94void srv_archive_qitem(const char *prefix, xs_dict *q_item);
95
96double mtime_nl(const char *fn, int *n_link);
97#define mtime(fn) mtime_nl(fn, NULL)
98double f_ctime(const char *fn);
99
100int index_add_md5(const char *fn, const char *md5);
101int index_add(const char *fn, const char *id);
102int index_gc(const char *fn);
103int index_first(const char *fn, char md5[MD5_HEX_SIZE]);
104int index_len(const char *fn);
105xs_list *index_list(const char *fn, int max);
106int index_desc_next(FILE *f, char md5[MD5_HEX_SIZE]);
107int index_desc_first(FILE *f, char md5[MD5_HEX_SIZE], int skip);
108xs_list *index_list_desc(const char *fn, int skip, int show);
109
110int object_add(const char *id, const xs_dict *obj);
111int object_add_ow(const char *id, const xs_dict *obj);
112int object_here_by_md5(const char *id);
113int object_here(const char *id);
114int object_get_by_md5(const char *md5, xs_dict **obj);
115int object_get(const char *id, xs_dict **obj);
116int object_del(const char *id);
117int object_del_if_unref(const char *id);
118double object_ctime_by_md5(const char *md5);
119double object_ctime(const char *id);
120double object_mtime_by_md5(const char *md5);
121double object_mtime(const char *id);
122void object_touch(const char *id);
123
124int object_admire(const char *id, const char *actor, int like);
125int object_unadmire(const char *id, const char *actor, int like);
126
127int object_likes_len(const char *id);
128int object_announces_len(const char *id);
129
130xs_list *object_children(const char *id);
131xs_list *object_likes(const char *id);
132xs_list *object_announces(const char *id);
133int object_parent(const char *md5, char parent[MD5_HEX_SIZE]);
134
135int object_user_cache_add(snac *snac, const char *id, const char *cachedir);
136int object_user_cache_del(snac *snac, const char *id, const char *cachedir);
137
138int follower_add(snac *snac, const char *actor);
139int follower_del(snac *snac, const char *actor);
140int follower_check(snac *snac, const char *actor);
141xs_list *follower_list(snac *snac);
142
143double timeline_mtime(snac *snac);
144int timeline_touch(snac *snac);
145int timeline_here(snac *snac, const char *md5);
146int timeline_get_by_md5(snac *snac, const char *md5, xs_dict **msg);
147int timeline_del(snac *snac, const char *id);
148xs_str *user_index_fn(snac *user, const char *idx_name);
149xs_list *timeline_simple_list(snac *user, const char *idx_name, int skip, int show);
150xs_list *timeline_list(snac *snac, const char *idx_name, int skip, int show);
151int timeline_add(snac *snac, const char *id, const xs_dict *o_msg);
152int timeline_admire(snac *snac, const char *id, const char *admirer, int like);
153
154xs_list *timeline_top_level(snac *snac, const xs_list *list);
155xs_list *local_list(snac *snac, int max);
156xs_str *instance_index_fn(void);
157xs_list *timeline_instance_list(int skip, int show);
158
159int following_add(snac *snac, const char *actor, const xs_dict *msg);
160int following_del(snac *snac, const char *actor);
161int following_check(snac *snac, const char *actor);
162int following_get(snac *snac, const char *actor, xs_dict **data);
163xs_list *following_list(snac *snac);
164
165void mute(snac *snac, const char *actor);
166void unmute(snac *snac, const char *actor);
167int is_muted(snac *snac, const char *actor);
168
169int is_bookmarked(snac *user, const char *id);
170int bookmark(snac *user, const char *id);
171int unbookmark(snac *user, const char *id);
172xs_list *bookmark_list(snac *user);
173xs_str *bookmark_index_fn(snac *user);
174
175int pin(snac *user, const char *id);
176int unpin(snac *user, const char *id);
177int is_pinned(snac *user, const char *id);
178int is_pinned_by_md5(snac *user, const char *md5);
179xs_list *pinned_list(snac *user);
180
181int is_draft(snac *user, const char *id);
182void draft_del(snac *user, const char *id);
183void draft_add(snac *user, const char *id, const xs_dict *msg);
184xs_list *draft_list(snac *user);
185
186int limited(snac *user, const char *id, int cmd);
187#define is_limited(user, id) limited((user), (id), 0)
188#define limit(user, id) limited((user), (id), 1)
189#define unlimit(user, id) limited((user), (id), 2)
190
191void hide(snac *snac, const char *id);
192int is_hidden(snac *snac, const char *id);
193
194void tag_index(const char *id, const xs_dict *obj);
195xs_str *tag_fn(const char *tag);
196xs_list *tag_search(const char *tag, int skip, int show);
197
198xs_val *list_maint(snac *user, const char *list, int op);
199xs_str *list_timeline_fn(snac *user, const char *list);
200xs_list *list_timeline(snac *user, const char *list, int skip, int show);
201xs_val *list_content(snac *user, const char *list_id, const char *actor_md5, int op);
202void list_distribute(snac *user, const char *who, const xs_dict *post);
203
204int actor_add(const char *actor, const xs_dict *msg);
205int actor_get(const char *actor, xs_dict **data);
206int actor_get_refresh(snac *user, const char *actor, xs_dict **data);
207
208int static_get(snac *snac, const char *id, xs_val **data, int *size, const char *inm, xs_str **etag);
209void static_put(snac *snac, const char *id, const char *data, int size);
210void static_put_meta(snac *snac, const char *id, const char *str);
211xs_str *static_get_meta(snac *snac, const char *id);
212
213double history_mtime(snac *snac, const char *id);
214void history_add(snac *snac, const char *id, const char *content, int size,
215 xs_str **etag);
216int history_get(snac *snac, const char *id, xs_str **content, int *size,
217 const char *inm, xs_str **etag);
218int history_del(snac *snac, const char *id);
219xs_list *history_list(snac *snac);
220
221void lastlog_write(snac *snac, const char *source);
222
223xs_str *notify_check_time(snac *snac, int reset);
224void notify_add(snac *snac, const char *type, const char *utype,
225 const char *actor, const char *objid, const xs_dict *msg);
226xs_dict *notify_get(snac *snac, const char *id);
227int notify_new_num(snac *snac);
228xs_list *notify_list(snac *snac, int skip, int show);
229void notify_clear(snac *snac);
230
231void inbox_add(const char *inbox);
232void inbox_add_by_actor(const xs_dict *actor);
233xs_list *inbox_list(void);
234
235int is_instance_blocked(const char *instance);
236int instance_block(const char *instance);
237int instance_unblock(const char *instance);
238
239int content_match(const char *file, const xs_dict *msg);
240xs_list *content_search(snac *user, const char *regex,
241 int priv, int skip, int show, int max_secs, int *timeout);
242
243void enqueue_input(snac *snac, const xs_dict *msg, const xs_dict *req, int retries);
244void enqueue_shared_input(const xs_dict *msg, const xs_dict *req, int retries);
245void enqueue_output_raw(const char *keyid, const char *seckey,
246 const xs_dict *msg, const xs_str *inbox,
247 int retries, int p_status);
248void enqueue_output(snac *snac, const xs_dict *msg,
249 const xs_str *inbox, int retries, int p_status);
250void enqueue_output_by_actor(snac *snac, const xs_dict *msg,
251 const xs_str *actor, int retries);
252void enqueue_email(const xs_str *msg, int retries);
253void enqueue_telegram(const xs_str *msg, const char *bot, const char *chat_id);
254void enqueue_ntfy(const xs_str *msg, const char *ntfy_server, const char *ntfy_token);
255void enqueue_message(snac *snac, const xs_dict *msg);
256void enqueue_close_question(snac *user, const char *id, int end_secs);
257void enqueue_object_request(snac *user, const char *id, int forward_secs);
258void enqueue_verify_links(snac *user);
259void enqueue_actor_refresh(snac *user, const char *actor, int forward_secs);
260int was_question_voted(snac *user, const char *id);
261
262xs_list *user_queue(snac *snac);
263xs_list *queue(void);
264xs_dict *queue_get(const char *fn);
265xs_dict *dequeue(const char *fn);
266
267void purge(snac *snac);
268void purge_all(void);
269
270xs_dict *http_signed_request_raw(const char *keyid, const char *seckey,
271 const char *method, const char *url,
272 const xs_dict *headers,
273 const char *body, int b_size,
274 int *status, xs_str **payload, int *p_size,
275 int timeout);
276xs_dict *http_signed_request(snac *snac, const char *method, const char *url,
277 const xs_dict *headers,
278 const char *body, int b_size,
279 int *status, xs_str **payload, int *p_size,
280 int timeout);
281int check_signature(const xs_dict *req, xs_str **err);
282
283srv_state *srv_state_op(xs_str **fname, int op);
284void httpd(void);
285
286int webfinger_request_signed(snac *snac, const char *qs, char **actor, char **user);
287int webfinger_request(const char *qs, char **actor, char **user);
288int webfinger_get_handler(xs_dict *req, char *q_path,
289 char **body, int *b_size, char **ctype);
290
291const char *default_avatar_base64(void);
292
293xs_str *process_tags(snac *snac, const char *content, xs_list **tag);
294
295const char *get_atto(const xs_dict *msg);
296xs_list *get_attachments(const xs_dict *msg);
297
298xs_dict *msg_admiration(snac *snac, const char *object, const char *type);
299xs_dict *msg_repulsion(snac *user, const char *id, const char *type);
300xs_dict *msg_create(snac *snac, const xs_dict *object);
301xs_dict *msg_follow(snac *snac, const char *actor);
302
303xs_dict *msg_note(snac *snac, const xs_str *content, const xs_val *rcpts,
304 const xs_str *in_reply_to, const xs_list *attach, int priv);
305
306xs_dict *msg_undo(snac *snac, const xs_val *object);
307xs_dict *msg_delete(snac *snac, const char *id);
308xs_dict *msg_actor(snac *snac);
309xs_dict *msg_update(snac *snac, const xs_dict *object);
310xs_dict *msg_ping(snac *user, const char *rcpt);
311xs_dict *msg_pong(snac *user, const char *rcpt, const char *object);
312xs_dict *msg_question(snac *user, const char *content, xs_list *attach,
313 const xs_list *opts, int multiple, int end_secs);
314
315int activitypub_request(snac *snac, const char *url, xs_dict **data);
316int actor_request(snac *user, const char *actor, xs_dict **data);
317int send_to_inbox_raw(const char *keyid, const char *seckey,
318 const xs_str *inbox, const xs_dict *msg,
319 xs_val **payload, int *p_size, int timeout);
320int send_to_inbox(snac *snac, const xs_str *inbox, const xs_dict *msg,
321 xs_val **payload, int *p_size, int timeout);
322xs_str *get_actor_inbox(const char *actor);
323int send_to_actor(snac *snac, const char *actor, const xs_dict *msg,
324 xs_val **payload, int *p_size, int timeout);
325int is_msg_public(const xs_dict *msg);
326int is_msg_from_private_user(const xs_dict *msg);
327int is_msg_for_me(snac *snac, const xs_dict *msg);
328
329int process_user_queue(snac *snac);
330void process_queue_item(xs_dict *q_item);
331int process_queue(void);
332
333int activitypub_get_handler(const xs_dict *req, const char *q_path,
334 char **body, int *b_size, char **ctype);
335int activitypub_post_handler(const xs_dict *req, const char *q_path,
336 char *payload, int p_size,
337 char **body, int *b_size, char **ctype);
338
339xs_dict *emojis(void);
340xs_str *not_really_markdown(const char *content, xs_list **attach, xs_list **tag);
341xs_str *sanitize(const char *content);
342xs_str *encode_html(const char *str);
343
344xs_str *html_timeline(snac *user, const xs_list *list, int read_only,
345 int skip, int show, int show_more,
346 char *title, char *page, int utl);
347
348int html_get_handler(const xs_dict *req, const char *q_path,
349 char **body, int *b_size, char **ctype, xs_str **etag);
350int html_post_handler(const xs_dict *req, const char *q_path,
351 char *payload, int p_size,
352 char **body, int *b_size, char **ctype);
353xs_str *timeline_to_rss(snac *user, const xs_list *timeline, char *title, char *link, char *desc);
354
355int write_default_css(void);
356int snac_init(const char *_basedir);
357int adduser(const char *uid);
358int resetpwd(snac *snac);
359int deluser(snac *user);
360
361extern const char *snac_blurb;
362
363void job_post(const xs_val *job, int urgent);
364void job_wait(xs_val **job);
365
366int oauth_get_handler(const xs_dict *req, const char *q_path,
367 char **body, int *b_size, char **ctype);
368int oauth_post_handler(const xs_dict *req, const char *q_path,
369 const char *payload, int p_size,
370 char **body, int *b_size, char **ctype);
371int mastoapi_get_handler(const xs_dict *req, const char *q_path,
372 char **body, int *b_size, char **ctype);
373int mastoapi_post_handler(const xs_dict *req, const char *q_path,
374 const char *payload, int p_size,
375 char **body, int *b_size, char **ctype);
376int mastoapi_delete_handler(const xs_dict *req, const char *q_path,
377 const char *payload, int p_size,
378 char **body, int *b_size, char **ctype);
379int mastoapi_put_handler(const xs_dict *req, const char *q_path,
380 const char *payload, int p_size,
381 char **body, int *b_size, char **ctype);
382void persist_image(const char *key, const xs_val *data, const char *payload, snac *snac);
383int mastoapi_patch_handler(const xs_dict *req, const char *q_path,
384 const char *payload, int p_size,
385 char **body, int *b_size, char **ctype);
386void mastoapi_purge(void);
387
388void verify_links(snac *user);
389
390
391typedef enum {
392#define HTTP_STATUS(code, name, text) HTTP_STATUS_ ## name = code,
393#include "http_codes.h"
394#undef HTTP_STATUS
395} http_status;
396
397const char *http_status_text(int status);
398
399typedef struct {
400 double timestamp;
401 char *text;
402} t_announcement;
403t_announcement *announcement(double after);
