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