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