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