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