2.88
snac.h
1/* snac - A simple, minimalistic ActivityPub instance */
2/* copyright (c) 2022 - 2026 grunfink et al. / MIT license */
3
4#define VERSION "2.88"
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
47#define valid_status(status) xs_http_valid_status(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
81enum {
82 SCOPE_PUBLIC = 0,
83 SCOPE_MENTIONED = 1,
84 SCOPE_UNLISTED = 2,
85 SCOPE_FOLLOWERS = 3,
86};
87
88void snac_log(snac *user, xs_str *str);
89#define snac_debug(user, level, str) do { if (dbglevel >= (level)) \
90 { snac_log((user), (str)); } } while (0)
91
92int srv_open(const char *basedir, int auto_upgrade);
93void srv_free(void);
94
95void sbox_enter(const char *basedir);
96
97int user_open(snac *snac, const char *uid);
98void user_free(snac *snac);
99xs_list *user_list(void);
100int user_open_by_md5(snac *snac, const char *md5);
101int user_persist(snac *snac, int publish);
102
103int validate_uid(const char *uid);
104
105xs_str *hash_password(const char *uid, const char *passwd, const char *nonce);
106int check_password(const char *uid, const char *passwd, const char *hash);
107
108int strip_media(const char *fn);
109int check_strip_tool(void);
110
111void srv_archive(const char *direction, const char *url, xs_dict *req,
112 const char *payload, int p_size,
113 int status, xs_dict *headers,
114 const char *body, int b_size);
115void srv_archive_error(const char *prefix, const xs_str *err,
116 const xs_dict *req, const xs_val *data);
117void srv_archive_qitem(const char *prefix, xs_dict *q_item);
118
119double mtime_nl(const char *fn, int *n_link);
120#define mtime(fn) mtime_nl(fn, NULL)
121double f_ctime(const char *fn);
122
123int index_add_md5(const char *fn, const char *md5);
124int index_add(const char *fn, const char *id);
125int index_gc(const char *fn);
126int index_first(const char *fn, char md5[MD5_HEX_SIZE]);
127int index_len(const char *fn);
128xs_list *index_list(const char *fn, int max);
129int index_desc_next(FILE *f, char md5[MD5_HEX_SIZE]);
130int index_desc_first(FILE *f, char md5[MD5_HEX_SIZE], int skip);
131int index_asc_next(FILE *f, char md5[MD5_HEX_SIZE]);
132int index_asc_first(FILE *f, char md5[MD5_HEX_SIZE], const char *seek_md5);
133xs_list *index_list_desc(const char *fn, int skip, int show);
134
135int object_add(const char *id, const xs_dict *obj);
136int object_add_ow(const char *id, const xs_dict *obj);
137int object_here_by_md5(const char *id);
138int object_here(const char *id);
139int object_get_by_md5(const char *md5, xs_dict **obj);
140int object_get(const char *id, xs_dict **obj);
141int object_del(const char *id);
142int object_del_if_unref(const char *id);
143double object_ctime_by_md5(const char *md5);
144double object_ctime(const char *id);
145double object_mtime_by_md5(const char *md5);
146double object_mtime(const char *id);
147void object_touch(const char *id);
148
149int object_admire(const char *id, const char *actor, int like);
150int object_unadmire(const char *id, const char *actor, int like);
151
152int object_emoji_react(const char *mid, const char *eid);
153int object_rm_emoji_react(const char *mid, const char *eid);
154int object_likes_len(const char *id);
155int object_announces_len(const char *id);
156
157xs_list *object_children(const char *id);
158xs_list *object_likes(const char *id);
159xs_list *object_announces(const char *id);
160xs_list *object_get_emoji_reacts(const char *id);
161int object_parent(const char *md5, char parent[MD5_HEX_SIZE]);
162
163int object_user_cache_add(snac *snac, const char *id, const char *cachedir);
164int object_user_cache_del(snac *snac, const char *id, const char *cachedir);
165
166int follower_add(snac *snac, const char *actor);
167int follower_del(snac *snac, const char *actor);
168int follower_check(snac *snac, const char *actor);
169xs_list *follower_list(snac *snac);
170int follower_list_len(snac *snac);
171
172int pending_add(snac *user, const char *actor, const xs_dict *msg);
173int pending_check(snac *user, const char *actor);
174xs_dict *pending_get(snac *user, const char *actor);
175void pending_del(snac *user, const char *actor);
176xs_list *pending_list(snac *user);
177int pending_count(snac *user);
178
179double timeline_mtime(snac *snac);
180int timeline_touch(snac *snac);
181int timeline_here_by_md5(snac *snac, const char *md5);
182int timeline_here(snac *snac, const char *id);
183int timeline_get_by_md5(snac *snac, const char *md5, xs_dict **msg);
184int timeline_del(snac *snac, const char *id);
185xs_str *user_index_fn(snac *user, const char *idx_name);
186xs_list *timeline_simple_list(snac *user, const char *idx_name, int skip, int show, int *more);
187xs_list *timeline_list(snac *snac, const char *idx_name, int skip, int show, int *more);
188int timeline_add(snac *snac, const char *id, const xs_dict *o_msg);
189int timeline_admire(snac *snac, const char *id, const char *admirer, int like, const xs_dict *msg);
190int timeline_emoji_react(const char *atto, const char *id, const xs_dict *o_msg);
191
192xs_list *timeline_top_level(snac *snac, const xs_list *list);
193void timeline_add_mark(snac *user);
194
195xs_list *local_list(snac *snac, int max);
196xs_str *instance_index_fn(void);
197xs_list *timeline_instance_list(int skip, int show);
198
199int following_add(snac *snac, const char *actor, const xs_dict *msg);
200int following_del(snac *snac, const char *actor);
201int following_check(snac *snac, const char *actor);
202int following_get(snac *snac, const char *actor, xs_dict **data);
203xs_list *following_list(snac *snac);
204int following_list_len(snac *snac);
205
206void mute(snac *snac, const char *actor);
207void unmute(snac *snac, const char *actor);
208int is_muted(snac *snac, const char *actor);
209xs_list *muted_list(snac *user);
210
211xs_str *emoji_reacted(snac *user, const char *id);
212
213int is_bookmarked(snac *user, const char *id);
214int bookmark(snac *user, const char *id);
215int unbookmark(snac *user, const char *id);
216xs_list *bookmark_list(snac *user);
217xs_str *bookmark_index_fn(snac *user);
218
219int pin(snac *user, const char *id);
220int unpin(snac *user, const char *id);
221int is_pinned(snac *user, const char *id);
222int is_pinned_by_md5(snac *user, const char *md5);
223xs_list *pinned_list(snac *user);
224
225int is_draft(snac *user, const char *id);
226void draft_del(snac *user, const char *id);
227void draft_add(snac *user, const char *id, const xs_dict *msg);
228xs_list *draft_list(snac *user);
229
230int is_scheduled(snac *user, const char *id);
231void schedule_del(snac *user, const char *id);
232void schedule_add(snac *user, const char *id, const xs_dict *msg);
233xs_list *scheduled_list(snac *user);
234void scheduled_process(snac *user);
235
236int limited(snac *user, const char *id, int cmd);
237#define is_limited(user, id) limited((user), (id), 0)
238#define limit(user, id) limited((user), (id), 1)
239#define unlimit(user, id) limited((user), (id), 2)
240
241void hide(snac *snac, const char *id);
242int is_hidden(snac *snac, const char *id);
243int unhide(snac *user, const char *id);
244
245void tag_index(const char *id, const xs_dict *obj);
246xs_str *tag_fn(const char *tag);
247xs_list *tag_search(const char *tag, int skip, int show);
248
249xs_val *list_maint(snac *user, const char *list, int op);
250xs_str *list_timeline_fn(snac *user, const char *list);
251xs_list *list_timeline(snac *user, const char *list, int skip, int show);
252xs_val *list_members(snac *user, const char *list_id, const char *actor_md5, int op);
253void list_distribute(snac *user, const char *who, const xs_dict *post);
254
255int actor_add(const char *actor, const xs_dict *msg);
256int actor_get(const char *actor, xs_dict **data);
257int actor_get_refresh(snac *user, const char *actor, xs_dict **data);
258
259int static_get(snac *snac, const char *id, xs_val **data, int *size, const char *inm, xs_str **etag);
260void static_put(snac *snac, const char *id, const char *data, int size);
261void static_put_meta(snac *snac, const char *id, const char *str);
262xs_str *static_get_meta(snac *snac, const char *id);
263
264double history_mtime(snac *snac, const char *id);
265void history_add(snac *snac, const char *id, const char *content, int size,
266 xs_str **etag);
267int history_get(snac *snac, const char *id, xs_str **content, int *size,
268 const char *inm, xs_str **etag);
269int history_del(snac *snac, const char *id);
270xs_list *history_list(snac *snac);
271
272void lastlog_write(snac *snac, const char *source);
273
274xs_str *notify_check_time(snac *snac, int reset);
275void notify_add(snac *snac, const char *type, const char *utype,
276 const char *actor, const char *objid, const xs_dict *msg);
277xs_dict *notify_get(snac *snac, const char *id);
278int notify_new_num(snac *snac);
279xs_list *notify_list(snac *snac, int skip, int show);
280void notify_clear(snac *snac);
281
282xs_dict *markers_get(snac *snac, const xs_list *markers);
283xs_dict *markers_set(snac *snac, const char *home_marker, const char *notify_marker);
284
285void inbox_add(const char *inbox);
286void inbox_add_by_actor(const xs_dict *actor);
287xs_list *inbox_list(void);
288
289int is_instance_blocked(const char *instance);
290int instance_block(const char *instance);
291int instance_unblock(const char *instance);
292
293int content_match(const char *file, const xs_dict *msg);
294xs_list *content_search(snac *user, const char *regex,
295 int priv, int skip, int show, int max_secs, int *timeout);
296
297int actor_failure(const char *actor, int op);
298int instance_failure(const char *url, int op);
299
300int grave(const char *objid, int op);
301
302void enqueue_input(snac *snac, const xs_dict *msg, const xs_dict *req, int retries);
303void enqueue_shared_input(const xs_dict *msg, const xs_dict *req, int retries);
304void enqueue_output_raw(const char *keyid, const char *seckey,
305 const xs_dict *msg, const xs_str *inbox,
306 int retries, int p_status);
307void enqueue_output(snac *snac, const xs_dict *msg,
308 const xs_str *inbox, int retries, int p_status);
309void enqueue_output_by_actor(snac *snac, const xs_dict *msg,
310 const xs_str *actor, int retries);
311void enqueue_email(const xs_str *msg, int retries);
312void enqueue_telegram(const xs_str *msg, const char *bot, const char *chat_id);
313void enqueue_ntfy(const xs_str *msg, const char *ntfy_server, const char *ntfy_token);
314void enqueue_message(snac *snac, const xs_dict *msg);
315void enqueue_close_question(snac *user, const char *id, int end_secs);
316void enqueue_object_request(snac *user, const char *id, int forward_secs);
317void enqueue_verify_links(snac *user);
318void enqueue_actor_refresh(snac *user, const char *actor, int forward_secs);
319void enqueue_webmention(const xs_dict *msg);
320void enqueue_notify_webhook(snac *user, const xs_dict *noti, int retries);
321void enqueue_collect_replies(snac *user, const char *post);
322void enqueue_collect_outbox(snac *user, const char *actor_id);
323void enqueue_fsck(void);
324
325int was_question_voted(snac *user, const char *id);
326
327xs_list *user_queue(snac *snac);
328xs_list *queue(void);
329xs_dict *queue_get(const char *fn);
330xs_dict *dequeue(const char *fn);
331
332void purge(snac *snac);
333void purge_all(void);
334
335xs_dict *http_signed_request_raw(const char *keyid, const char *seckey,
336 const char *method, const char *url,
337 const xs_dict *headers,
338 const char *body, int b_size,
339 int *status, xs_str **payload, int *p_size,
340 int timeout);
341xs_dict *http_signed_request(snac *snac, const char *method, const char *url,
342 const xs_dict *headers,
343 const char *body, int b_size,
344 int *status, xs_str **payload, int *p_size,
345 int timeout);
346int check_signature(const xs_dict *req, xs_str **err);
347
348srv_state *srv_state_op(xs_str **fname, int op);
349void httpd(void);
350
351int webfinger_request_signed(snac *snac, const char *qs, xs_str **actor, xs_str **user);
352int webfinger_request(const char *qs, xs_str **actor, xs_str **user);
353int webfinger_request_fake(const char *qs, xs_str **actor, xs_str **user);
354int webfinger_get_handler(const xs_dict *req, const char *q_path,
355 xs_val **body, int *b_size, char **ctype);
356
357const char *default_avatar_base64(void);
358
359xs_str *process_tags(snac *snac, const char *content, xs_list **tag);
360
361void collect_replies(snac *user, const char *id);
362void collect_outbox(snac *user, const char *actor_id);
363
364const char *get_atto(const xs_dict *msg);
365const char *get_in_reply_to(const xs_dict *msg);
366xs_list *get_attachments(const xs_dict *msg);
367
368xs_dict *msg_admiration(snac *snac, const char *object, const char *type);
369xs_dict *msg_repulsion(snac *user, const char *id, const char *type);
370xs_dict *msg_emoji_init(snac *user, const char *mid, const char *eid);
371xs_dict *msg_emoji_unreact(snac *user, const char *id, const char *type);
372xs_dict *msg_create(snac *snac, const xs_dict *object);
373xs_dict *msg_follow(snac *snac, const char *actor);
374
375xs_dict *msg_note(snac *snac, const xs_str *content, const xs_val *rcpts,
376 const xs_str *in_reply_to, const xs_list *attach,
377 int scope, const char *lang_str, const char *msg_date);
378
379xs_dict *msg_undo(snac *snac, const xs_val *object);
380xs_dict *msg_delete(snac *snac, const char *id);
381xs_dict *msg_actor(snac *snac);
382xs_dict *msg_update(snac *snac, const xs_dict *object);
383xs_dict *msg_ping(snac *user, const char *rcpt);
384xs_dict *msg_pong(snac *user, const char *rcpt, const char *object);
385xs_dict *msg_move(snac *user, const char *new_account);
386xs_dict *msg_accept(snac *snac, const xs_val *object, const char *to);
387xs_dict *msg_question(snac *user, const char *content, xs_list *attach,
388 const xs_list *opts, int multiple, int end_secs);
389xs_dict *msg_replies(snac *user, const char *id, int fill);
390int get_msg_visibility(const xs_dict *msg);
391
392int activitypub_request(snac *snac, const char *url, xs_dict **data);
393int actor_request(snac *user, const char *actor, xs_dict **data);
394int send_to_inbox_raw(const char *keyid, const char *seckey,
395 const xs_str *inbox, const xs_dict *msg,
396 xs_val **payload, int *p_size, int timeout);
397int send_to_inbox(snac *snac, const xs_str *inbox, const xs_dict *msg,
398 xs_val **payload, int *p_size, int timeout);
399xs_str *get_actor_inbox(const char *actor, int shared);
400int send_to_actor(snac *snac, const char *actor, const xs_dict *msg,
401 xs_val **payload, int *p_size, int timeout);
402int is_msg_mine(snac *user, const char *id);
403int is_msg_public(const xs_dict *msg);
404int is_msg_from_private_user(const xs_dict *msg);
405int is_msg_for_me(snac *snac, const xs_dict *msg);
406
407int process_user_queue(snac *snac);
408void process_queue_item(xs_dict *q_item);
409int process_queue(void);
410
411int activitypub_get_handler(const xs_dict *req, const char *q_path,
412 char **body, int *b_size, char **ctype);
413int activitypub_post_handler(const xs_dict *req, const char *q_path,
414 char *payload, int p_size,
415 char **body, int *b_size, char **ctype);
416
417xs_dict *emojis(void);
418xs_dict *emojis_rm_categories(void);
419xs_str *format_text_with_emoji(snac *user, const char *text, int ems, const char *proxy);
420xs_str *not_really_markdown(const char *content, xs_list **attach, xs_list **tag);
421xs_str *sanitize(const char *content);
422xs_str *encode_html(const char *str);
423
424xs_str *html_timeline(snac *user, const xs_list *list, int read_only,
425 int skip, int show, int show_more,
426 const char *title, const char *page, int utl, const char *error, int terse);
427
428int html_get_handler(const xs_dict *req, const char *q_path,
429 char **body, int *b_size, char **ctype,
430 xs_str **etag, xs_str **last_modified);
431
432int html_post_handler(const xs_dict *req, const char *q_path,
433 char *payload, int p_size,
434 char **body, int *b_size, char **ctype);
435
436int write_default_css(void);
437int snac_init(const char *_basedir);
438int adduser(const char *uid);
439int resetpwd(snac *snac);
440int deluser(snac *user);
441
442extern const char *snac_blurb;
443
444void job_post(const xs_val *job, int urgent);
445void job_wait(xs_val **job);
446
447int oauth_get_handler(const xs_dict *req, const char *q_path,
448 char **body, int *b_size, char **ctype);
449int oauth_post_handler(const xs_dict *req, const char *q_path,
450 const char *payload, int p_size,
451 char **body, int *b_size, char **ctype);
452int mastoapi_get_handler(const xs_dict *req, const char *q_path,
453 char **body, int *b_size, char **ctype, xs_str **link);
454int mastoapi_post_handler(const xs_dict *req, const char *q_path,
455 const char *payload, int p_size,
456 char **body, int *b_size, char **ctype);
457int mastoapi_delete_handler(const xs_dict *req, const char *q_path,
458 const char *payload, int p_size,
459 char **body, int *b_size, char **ctype);
460int mastoapi_put_handler(const xs_dict *req, const char *q_path,
461 const char *payload, int p_size,
462 char **body, int *b_size, char **ctype);
463void persist_image(const char *key, const xs_val *data, const char *payload, snac *snac);
464int mastoapi_patch_handler(const xs_dict *req, const char *q_path,
465 const char *payload, int p_size,
466 char **body, int *b_size, char **ctype);
467void mastoapi_purge(void);
468
469void verify_links(snac *user);
470
471void export_csv(snac *user);
472void export_posts(snac *user);
473
474int migrate_account(snac *user);
475
476void import_blocked_accounts_csv(snac *user, const char *fn);
477void import_following_accounts_csv(snac *user, const char *fn);
478void import_list_csv(snac *user, const char *fn);
479void import_csv(snac *user);
480int parse_port(const char *url, const char **errstr);
481
482typedef struct {
483 double timestamp;
484 char *text;
485} t_announcement;
486t_announcement *announcement(double after);
487
488xs_str *make_url(const char *href, const char *proxy, int by_token);
489
490int badlogin_check(const char *user, const char *addr);
491void badlogin_inc(const char *user, const char *addr);
492
493const char *lang_str(const char *str, const snac *user);
494
495xs_str *rss_from_timeline(snac *user, const xs_list *timeline,
496 const char *title, const char *link, const char *desc);
497void rss_to_timeline(snac *user, const char *url);
498void rss_poll_hashtags(void);
499
500void data_fsck(void);
501
502xs_list *user_top_ten(snac *user, int count);
