2.53 snac.h
  1/* snac - A simple, minimalistic ActivityPub instance */
  2/* copyright (c) 2022 - 2024 grunfink et al. / MIT license */
  3
  4#define VERSION "2.53"
  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(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);
 79
 80int validate_uid(const char *uid);
 81
 82xs_str *hash_password(const char *uid, const char *passwd, const char *nonce);
 83int check_password(const char *uid, const char *passwd, const char *hash);
 84
 85void srv_archive(const char *direction, const char *url, xs_dict *req,
 86                 const char *payload, int p_size,
 87                 int status, xs_dict *headers,
 88                 const char *body, int b_size);
 89void srv_archive_error(const char *prefix, const xs_str *err,
 90                       const xs_dict *req, const xs_val *data);
 91void srv_archive_qitem(char *prefix, xs_dict *q_item);
 92
 93double mtime_nl(const char *fn, int *n_link);
 94#define mtime(fn) mtime_nl(fn, NULL)
 95double f_ctime(const char *fn);
 96
 97int index_add_md5(const char *fn, const char *md5);
 98int index_add(const char *fn, const char *id);
 99int index_gc(const char *fn);
100int index_first(const char *fn, char *buf, int size);
101int index_len(const char *fn);
102xs_list *index_list(const char *fn, int max);
103xs_list *index_list_desc(const char *fn, int skip, int show);
104
105int object_add(const char *id, const xs_dict *obj);
106int object_add_ow(const char *id, const xs_dict *obj);
107int object_here_by_md5(const char *id);
108int object_here(const char *id);
109int object_get_by_md5(const char *md5, xs_dict **obj);
110int object_get(const char *id, xs_dict **obj);
111int object_del(const char *id);
112int object_del_if_unref(const char *id);
113double object_ctime_by_md5(const char *md5);
114double object_ctime(const char *id);
115double object_mtime_by_md5(const char *md5);
116double object_mtime(const char *id);
117void object_touch(const char *id);
118
119int object_admire(const char *id, const char *actor, int like);
120int object_unadmire(const char *id, const char *actor, int like);
121
122int object_likes_len(const char *id);
123int object_announces_len(const char *id);
124
125xs_list *object_children(const char *id);
126xs_list *object_likes(const char *id);
127xs_list *object_announces(const char *id);
128int object_parent(const char *id, char *buf, int size);
129
130int object_user_cache_add(snac *snac, const char *id, const char *cachedir);
131int object_user_cache_del(snac *snac, const char *id, const char *cachedir);
132
133int follower_add(snac *snac, const char *actor);
134int follower_del(snac *snac, const char *actor);
135int follower_check(snac *snac, const char *actor);
136xs_list *follower_list(snac *snac);
137
138double timeline_mtime(snac *snac);
139int timeline_touch(snac *snac);
140int timeline_here(snac *snac, const char *md5);
141int timeline_get_by_md5(snac *snac, const char *md5, xs_dict **msg);
142int timeline_del(snac *snac, char *id);
143xs_list *timeline_simple_list(snac *snac, const char *idx_name, int skip, int show);
144xs_list *timeline_list(snac *snac, const char *idx_name, int skip, int show);
145int timeline_add(snac *snac, const char *id, const xs_dict *o_msg);
146int timeline_admire(snac *snac, const char *id, const char *admirer, int like);
147
148xs_list *timeline_top_level(snac *snac, xs_list *list);
149xs_list *local_list(snac *snac, int max);
150xs_list *timeline_instance_list(int skip, int show);
151
152int following_add(snac *snac, const char *actor, const xs_dict *msg);
153int following_del(snac *snac, const char *actor);
154int following_check(snac *snac, const char *actor);
155int following_get(snac *snac, const char *actor, xs_dict **data);
156xs_list *following_list(snac *snac);
157
158void mute(snac *snac, const char *actor);
159void unmute(snac *snac, const char *actor);
160int is_muted(snac *snac, const char *actor);
161
162int pin(snac *user, const char *id);
163int unpin(snac *user, const char *id);
164int is_pinned(snac *user, const char *id);
165int is_pinned_by_md5(snac *user, const char *md5);
166xs_list *pinned_list(snac *user);
167
168int limited(snac *user, const char *id, int cmd);
169#define is_limited(user, id) limited((user), (id), 0)
170#define limit(user, id) limited((user), (id), 1)
171#define unlimit(user, id) limited((user), (id), 2)
172
173void hide(snac *snac, const char *id);
174int is_hidden(snac *snac, const char *id);
175
176void tag_index(const char *id, const xs_dict *obj);
177xs_list *tag_search(char *tag, int skip, int show);
178
179xs_val *list_maint(snac *user, const char *list, int op);
180xs_list *list_timeline(snac *user, const char *list, int skip, int show);
181xs_val *list_content(snac *user, const char *list_id, const char *actor_md5, int op);
182void list_distribute(snac *user, const char *who, const xs_dict *post);
183
184int actor_add(const char *actor, xs_dict *msg);
185int actor_get(const char *actor, xs_dict **data);
186int actor_get_refresh(snac *user, const char *actor, xs_dict **data);
187
188int static_get(snac *snac, const char *id, xs_val **data, int *size, const char *inm, xs_str **etag);
189void static_put(snac *snac, const char *id, const char *data, int size);
190void static_put_meta(snac *snac, const char *id, const char *str);
191xs_str *static_get_meta(snac *snac, const char *id);
192
193double history_mtime(snac *snac, const char *id);
194void history_add(snac *snac, const char *id, const char *content, int size,
195                    xs_str **etag);
196int history_get(snac *snac, const char *id, xs_str **content, int *size,
197                const char *inm, xs_str **etag);
198int history_del(snac *snac, const char *id);
199xs_list *history_list(snac *snac);
200
201void lastlog_write(snac *snac, const char *source);
202
203xs_str *notify_check_time(snac *snac, int reset);
204void notify_add(snac *snac, const char *type, const char *utype,
205                const char *actor, const char *objid);
206xs_dict *notify_get(snac *snac, const char *id);
207int notify_new_num(snac *snac);
208xs_list *notify_list(snac *snac, int skip, int show);
209void notify_clear(snac *snac);
210
211void inbox_add(const char *inbox);
212void inbox_add_by_actor(const xs_dict *actor);
213xs_list *inbox_list(void);
214
215int is_instance_blocked(const char *instance);
216int instance_block(const char *instance);
217int instance_unblock(const char *instance);
218
219int content_match(const char *file, const xs_dict *msg);
220xs_list *content_search(snac *user, const char *regex,
221            int priv, int skip, int show, int max_secs, int *timeout);
222
223void enqueue_input(snac *snac, const xs_dict *msg, const xs_dict *req, int retries);
224void enqueue_shared_input(const xs_dict *msg, const xs_dict *req, int retries);
225void enqueue_output_raw(const char *keyid, const char *seckey,
226                        xs_dict *msg, xs_str *inbox, int retries, int p_status);
227void enqueue_output(snac *snac, xs_dict *msg, xs_str *inbox, int retries, int p_status);
228void enqueue_output_by_actor(snac *snac, xs_dict *msg, const xs_str *actor, int retries);
229void enqueue_email(xs_str *msg, int retries);
230void enqueue_telegram(const xs_str *msg, const char *bot, const char *chat_id);
231void enqueue_ntfy(const xs_str *msg, const char *ntfy_server, const char *ntfy_token);
232void enqueue_message(snac *snac, const xs_dict *msg);
233void enqueue_close_question(snac *user, const char *id, int end_secs);
234void enqueue_object_request(snac *user, const char *id, int forward_secs);
235void enqueue_verify_links(snac *user);
236void enqueue_actor_refresh(snac *user, const char *actor, int forward_secs);
237void enqueue_request_replies(snac *user, const char *id);
238int was_question_voted(snac *user, const char *id);
239
240xs_list *user_queue(snac *snac);
241xs_list *queue(void);
242xs_dict *queue_get(const char *fn);
243xs_dict *dequeue(const char *fn);
244
245void purge(snac *snac);
246void purge_all(void);
247
248xs_dict *http_signed_request_raw(const char *keyid, const char *seckey,
249                            const char *method, const char *url,
250                            xs_dict *headers,
251                            const char *body, int b_size,
252                            int *status, xs_str **payload, int *p_size,
253                            int timeout);
254xs_dict *http_signed_request(snac *snac, const char *method, const char *url,
255                            xs_dict *headers,
256                            const char *body, int b_size,
257                            int *status, xs_str **payload, int *p_size,
258                            int timeout);
259int check_signature(xs_dict *req, xs_str **err);
260
261srv_state *srv_state_op(xs_str **fname, int op);
262void httpd(void);
263
264int webfinger_request_signed(snac *snac, const char *qs, char **actor, char **user);
265int webfinger_request(const char *qs, char **actor, char **user);
266int webfinger_get_handler(xs_dict *req, char *q_path,
267                          char **body, int *b_size, char **ctype);
268
269const char *default_avatar_base64(void);
270
271xs_str *process_tags(snac *snac, const char *content, xs_list **tag);
272
273char *get_atto(const xs_dict *msg);
274xs_list *get_attachments(const xs_dict *msg);
275
276xs_dict *msg_admiration(snac *snac, char *object, char *type);
277xs_dict *msg_repulsion(snac *user, char *id, char *type);
278xs_dict *msg_create(snac *snac, const xs_dict *object);
279xs_dict *msg_follow(snac *snac, const char *actor);
280
281xs_dict *msg_note(snac *snac, const xs_str *content, const xs_val *rcpts,
282                  xs_str *in_reply_to, xs_list *attach, int priv);
283
284xs_dict *msg_undo(snac *snac, char *object);
285xs_dict *msg_delete(snac *snac, char *id);
286xs_dict *msg_actor(snac *snac);
287xs_dict *msg_update(snac *snac, xs_dict *object);
288xs_dict *msg_ping(snac *user, const char *rcpt);
289xs_dict *msg_pong(snac *user, const char *rcpt, const char *object);
290xs_dict *msg_question(snac *user, const char *content, xs_list *attach,
291                      const xs_list *opts, int multiple, int end_secs);
292
293int activitypub_request(snac *snac, const char *url, xs_dict **data);
294int actor_request(snac *user, const char *actor, xs_dict **data);
295void timeline_request_replies(snac *user, const char *id);
296int send_to_inbox_raw(const char *keyid, const char *seckey,
297                  const xs_str *inbox, const xs_dict *msg,
298                  xs_val **payload, int *p_size, int timeout);
299int send_to_inbox(snac *snac, const xs_str *inbox, const xs_dict *msg,
300                  xs_val **payload, int *p_size, int timeout);
301xs_str *get_actor_inbox(const char *actor);
302int send_to_actor(snac *snac, const char *actor, const xs_dict *msg,
303                  xs_val **payload, int *p_size, int timeout);
304int is_msg_public(const xs_dict *msg);
305int is_msg_from_private_user(const xs_dict *msg);
306int is_msg_for_me(snac *snac, const xs_dict *msg);
307
308int process_user_queue(snac *snac);
309void process_queue_item(xs_dict *q_item);
310int process_queue(void);
311
312int activitypub_get_handler(const xs_dict *req, const char *q_path,
313                            char **body, int *b_size, char **ctype);
314int activitypub_post_handler(const xs_dict *req, const char *q_path,
315                             char *payload, int p_size,
316                             char **body, int *b_size, char **ctype);
317
318xs_dict *emojis(void);
319xs_str *not_really_markdown(const char *content, xs_list **attach, xs_list **tag);
320xs_str *sanitize(const char *content);
321xs_str *encode_html(const char *str);
322
323xs_str *html_timeline(snac *user, const xs_list *list, int read_only,
324                      int skip, int show, int show_more,
325                      char *title, char *page, int utl);
326
327int html_get_handler(const xs_dict *req, const char *q_path,
328                     char **body, int *b_size, char **ctype, xs_str **etag);
329int html_post_handler(const xs_dict *req, const char *q_path,
330                      char *payload, int p_size,
331                      char **body, int *b_size, char **ctype);
332xs_str *timeline_to_rss(snac *user, const xs_list *timeline, char *title, char *link, char *desc);
333
334int snac_init(const char *_basedir);
335int adduser(const char *uid);
336int resetpwd(snac *snac);
337int deluser(snac *user);
338
339extern const char *snac_blurb;
340
341void job_post(const xs_val *job, int urgent);
342void job_wait(xs_val **job);
343
344int oauth_get_handler(const xs_dict *req, const char *q_path,
345                      char **body, int *b_size, char **ctype);
346int oauth_post_handler(const xs_dict *req, const char *q_path,
347                       const char *payload, int p_size,
348                       char **body, int *b_size, char **ctype);
349int mastoapi_get_handler(const xs_dict *req, const char *q_path,
350                         char **body, int *b_size, char **ctype);
351int mastoapi_post_handler(const xs_dict *req, const char *q_path,
352                          const char *payload, int p_size,
353                          char **body, int *b_size, char **ctype);
354int mastoapi_delete_handler(const xs_dict *req, const char *q_path,
355                          const char *payload, int p_size,
356                          char **body, int *b_size, char **ctype);
357int mastoapi_put_handler(const xs_dict *req, const char *q_path,
358                          const char *payload, int p_size,
359                          char **body, int *b_size, char **ctype);
360void mastoapi_purge(void);
361
362void verify_links(snac *user);