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