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