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