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