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