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