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