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