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