2.64 snac.h
  1/* snac - A simple, minimalistic ActivityPub instance */
  2/* copyright (c) 2022 - 2024 grunfink et al. / MIT license */
  3
  4#define VERSION "2.64"
  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
144double timeline_mtime(snac *snac);
145int timeline_touch(snac *snac);
146int timeline_here(snac *snac, const char *md5);
147int timeline_get_by_md5(snac *snac, const char *md5, xs_dict **msg);
148int timeline_del(snac *snac, const char *id);
149xs_str *user_index_fn(snac *user, const char *idx_name);
150xs_list *timeline_simple_list(snac *user, const char *idx_name, int skip, int show);
151xs_list *timeline_list(snac *snac, const char *idx_name, int skip, int show);
152int timeline_add(snac *snac, const char *id, const xs_dict *o_msg);
153int timeline_admire(snac *snac, const char *id, const char *admirer, int like);
154
155xs_list *timeline_top_level(snac *snac, const xs_list *list);
156xs_list *local_list(snac *snac, int max);
157xs_str *instance_index_fn(void);
158xs_list *timeline_instance_list(int skip, int show);
159
160int following_add(snac *snac, const char *actor, const xs_dict *msg);
161int following_del(snac *snac, const char *actor);
162int following_check(snac *snac, const char *actor);
163int following_get(snac *snac, const char *actor, xs_dict **data);
164xs_list *following_list(snac *snac);
165
166void mute(snac *snac, const char *actor);
167void unmute(snac *snac, const char *actor);
168int is_muted(snac *snac, const char *actor);
169xs_list *muted_list(snac *user);
170
171int is_bookmarked(snac *user, const char *id);
172int bookmark(snac *user, const char *id);
173int unbookmark(snac *user, const char *id);
174xs_list *bookmark_list(snac *user);
175xs_str *bookmark_index_fn(snac *user);
176
177int pin(snac *user, const char *id);
178int unpin(snac *user, const char *id);
179int is_pinned(snac *user, const char *id);
180int is_pinned_by_md5(snac *user, const char *md5);
181xs_list *pinned_list(snac *user);
182
183int is_draft(snac *user, const char *id);
184void draft_del(snac *user, const char *id);
185void draft_add(snac *user, const char *id, const xs_dict *msg);
186xs_list *draft_list(snac *user);
187
188int limited(snac *user, const char *id, int cmd);
189#define is_limited(user, id) limited((user), (id), 0)
190#define limit(user, id) limited((user), (id), 1)
191#define unlimit(user, id) limited((user), (id), 2)
192
193void hide(snac *snac, const char *id);
194int is_hidden(snac *snac, const char *id);
195
196void tag_index(const char *id, const xs_dict *obj);
197xs_str *tag_fn(const char *tag);
198xs_list *tag_search(const char *tag, int skip, int show);
199
200xs_val *list_maint(snac *user, const char *list, int op);
201xs_str *list_timeline_fn(snac *user, const char *list);
202xs_list *list_timeline(snac *user, const char *list, int skip, int show);
203xs_val *list_content(snac *user, const char *list_id, const char *actor_md5, int op);
204void list_distribute(snac *user, const char *who, const xs_dict *post);
205
206int actor_add(const char *actor, const xs_dict *msg);
207int actor_get(const char *actor, xs_dict **data);
208int actor_get_refresh(snac *user, const char *actor, xs_dict **data);
209
210int static_get(snac *snac, const char *id, xs_val **data, int *size, const char *inm, xs_str **etag);
211void static_put(snac *snac, const char *id, const char *data, int size);
212void static_put_meta(snac *snac, const char *id, const char *str);
213xs_str *static_get_meta(snac *snac, const char *id);
214
215double history_mtime(snac *snac, const char *id);
216void history_add(snac *snac, const char *id, const char *content, int size,
217                    xs_str **etag);
218int history_get(snac *snac, const char *id, xs_str **content, int *size,
219                const char *inm, xs_str **etag);
220int history_del(snac *snac, const char *id);
221xs_list *history_list(snac *snac);
222
223void lastlog_write(snac *snac, const char *source);
224
225xs_str *notify_check_time(snac *snac, int reset);
226void notify_add(snac *snac, const char *type, const char *utype,
227                const char *actor, const char *objid, const xs_dict *msg);
228xs_dict *notify_get(snac *snac, const char *id);
229int notify_new_num(snac *snac);
230xs_list *notify_list(snac *snac, int skip, int show);
231void notify_clear(snac *snac);
232
233void inbox_add(const char *inbox);
234void inbox_add_by_actor(const xs_dict *actor);
235xs_list *inbox_list(void);
236
237int is_instance_blocked(const char *instance);
238int instance_block(const char *instance);
239int instance_unblock(const char *instance);
240
241int content_match(const char *file, const xs_dict *msg);
242xs_list *content_search(snac *user, const char *regex,
243            int priv, int skip, int show, int max_secs, int *timeout);
244
245void enqueue_input(snac *snac, const xs_dict *msg, const xs_dict *req, int retries);
246void enqueue_shared_input(const xs_dict *msg, const xs_dict *req, int retries);
247void enqueue_output_raw(const char *keyid, const char *seckey,
248                        const xs_dict *msg, const xs_str *inbox,
249                        int retries, int p_status);
250void enqueue_output(snac *snac, const xs_dict *msg,
251                    const xs_str *inbox, int retries, int p_status);
252void enqueue_output_by_actor(snac *snac, const xs_dict *msg,
253                             const xs_str *actor, int retries);
254void enqueue_email(const xs_str *msg, int retries);
255void enqueue_telegram(const xs_str *msg, const char *bot, const char *chat_id);
256void enqueue_ntfy(const xs_str *msg, const char *ntfy_server, const char *ntfy_token);
257void enqueue_message(snac *snac, const xs_dict *msg);
258void enqueue_close_question(snac *user, const char *id, int end_secs);
259void enqueue_object_request(snac *user, const char *id, int forward_secs);
260void enqueue_verify_links(snac *user);
261void enqueue_actor_refresh(snac *user, const char *actor, int forward_secs);
262int was_question_voted(snac *user, const char *id);
263
264xs_list *user_queue(snac *snac);
265xs_list *queue(void);
266xs_dict *queue_get(const char *fn);
267xs_dict *dequeue(const char *fn);
268
269void purge(snac *snac);
270void purge_all(void);
271
272xs_dict *http_signed_request_raw(const char *keyid, const char *seckey,
273                            const char *method, const char *url,
274                            const xs_dict *headers,
275                            const char *body, int b_size,
276                            int *status, xs_str **payload, int *p_size,
277                            int timeout);
278xs_dict *http_signed_request(snac *snac, const char *method, const char *url,
279                            const xs_dict *headers,
280                            const char *body, int b_size,
281                            int *status, xs_str **payload, int *p_size,
282                            int timeout);
283int check_signature(const xs_dict *req, xs_str **err);
284
285srv_state *srv_state_op(xs_str **fname, int op);
286void httpd(void);
287
288int webfinger_request_signed(snac *snac, const char *qs, xs_str **actor, xs_str **user);
289int webfinger_request(const char *qs, xs_str **actor, xs_str **user);
290int webfinger_request_fake(const char *qs, xs_str **actor, xs_str **user);
291int webfinger_get_handler(xs_dict *req, const char *q_path,
292                          xs_val **body, int *b_size, char **ctype);
293
294const char *default_avatar_base64(void);
295
296xs_str *process_tags(snac *snac, const char *content, xs_list **tag);
297
298const char *get_atto(const xs_dict *msg);
299const char *get_in_reply_to(const xs_dict *msg);
300xs_list *get_attachments(const xs_dict *msg);
301
302xs_dict *msg_admiration(snac *snac, const char *object, const char *type);
303xs_dict *msg_repulsion(snac *user, const char *id, const char *type);
304xs_dict *msg_create(snac *snac, const xs_dict *object);
305xs_dict *msg_follow(snac *snac, const char *actor);
306
307xs_dict *msg_note(snac *snac, const xs_str *content, const xs_val *rcpts,
308                  const xs_str *in_reply_to, const xs_list *attach, int priv);
309
310xs_dict *msg_undo(snac *snac, const xs_val *object);
311xs_dict *msg_delete(snac *snac, const char *id);
312xs_dict *msg_actor(snac *snac);
313xs_dict *msg_update(snac *snac, const xs_dict *object);
314xs_dict *msg_ping(snac *user, const char *rcpt);
315xs_dict *msg_pong(snac *user, const char *rcpt, const char *object);
316xs_dict *msg_move(snac *user, const char *new_account);
317xs_dict *msg_question(snac *user, const char *content, xs_list *attach,
318                      const xs_list *opts, int multiple, int end_secs);
319
320int activitypub_request(snac *snac, const char *url, xs_dict **data);
321int actor_request(snac *user, const char *actor, xs_dict **data);
322int send_to_inbox_raw(const char *keyid, const char *seckey,
323                  const xs_str *inbox, const xs_dict *msg,
324                  xs_val **payload, int *p_size, int timeout);
325int send_to_inbox(snac *snac, const xs_str *inbox, const xs_dict *msg,
326                  xs_val **payload, int *p_size, int timeout);
327xs_str *get_actor_inbox(const char *actor, int shared);
328int send_to_actor(snac *snac, const char *actor, const xs_dict *msg,
329                  xs_val **payload, int *p_size, int timeout);
330int is_msg_public(const xs_dict *msg);
331int is_msg_from_private_user(const xs_dict *msg);
332int is_msg_for_me(snac *snac, const xs_dict *msg);
333
334int process_user_queue(snac *snac);
335void process_queue_item(xs_dict *q_item);
336int process_queue(void);
337
338int activitypub_get_handler(const xs_dict *req, const char *q_path,
339                            char **body, int *b_size, char **ctype);
340int activitypub_post_handler(const xs_dict *req, const char *q_path,
341                             char *payload, int p_size,
342                             char **body, int *b_size, char **ctype);
343
344xs_dict *emojis(void);
345xs_str *not_really_markdown(const char *content, xs_list **attach, xs_list **tag);
346xs_str *sanitize(const char *content);
347xs_str *encode_html(const char *str);
348
349xs_str *html_timeline(snac *user, const xs_list *list, int read_only,
350                      int skip, int show, int show_more,
351                      const char *title, const char *page, int utl, const char *error);
352
353int html_get_handler(const xs_dict *req, const char *q_path,
354                     char **body, int *b_size, char **ctype,
355                     xs_str **etag, xs_str **last_modified);
356
357int html_post_handler(const xs_dict *req, const char *q_path,
358                      char *payload, int p_size,
359                      char **body, int *b_size, char **ctype);
360xs_str *timeline_to_rss(snac *user, const xs_list *timeline,
361                        const char *title, const char *link, const char *desc);
362
363int write_default_css(void);
364int snac_init(const char *_basedir);
365int adduser(const char *uid);
366int resetpwd(snac *snac);
367int deluser(snac *user);
368
369extern const char *snac_blurb;
370
371void job_post(const xs_val *job, int urgent);
372void job_wait(xs_val **job);
373
374int oauth_get_handler(const xs_dict *req, const char *q_path,
375                      char **body, int *b_size, char **ctype);
376int oauth_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_get_handler(const xs_dict *req, const char *q_path,
380                         char **body, int *b_size, char **ctype);
381int mastoapi_post_handler(const xs_dict *req, const char *q_path,
382                          const char *payload, int p_size,
383                          char **body, int *b_size, char **ctype);
384int mastoapi_delete_handler(const xs_dict *req, const char *q_path,
385                          const char *payload, int p_size,
386                          char **body, int *b_size, char **ctype);
387int mastoapi_put_handler(const xs_dict *req, const char *q_path,
388                          const char *payload, int p_size,
389                          char **body, int *b_size, char **ctype);
390void persist_image(const char *key, const xs_val *data, const char *payload, snac *snac);
391int mastoapi_patch_handler(const xs_dict *req, const char *q_path,
392                          const char *payload, int p_size,
393                          char **body, int *b_size, char **ctype);
394void mastoapi_purge(void);
395
396void verify_links(snac *user);
397
398void export_csv(snac *user);
399int migrate_account(snac *user);
400void import_csv(snac *user);
401
402typedef enum {
403#define HTTP_STATUS(code, name, text) HTTP_STATUS_ ## name = code,
404#include "http_codes.h"
405#undef HTTP_STATUS
406} http_status;
407
408const char *http_status_text(int status);
409
410typedef struct {
411    double timestamp;
412    char   *text;
413} t_announcement;
414t_announcement *announcement(double after);
415
416xs_str *make_url(const char *href, const char *proxy, int by_token);