rb79.h

   1 /*
   2  * Copyright (c) 2017-2018, De Rais <derais@cock.li>
   3  *
   4  * Permission to use, copy, modify, and/or distribute this software for
   5  * any purpose with or without fee is hereby granted, provided that the
   6  * above copyright notice and this permission notice appear in all
   7  * copies.
   8  *
   9  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
  10  * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
  11  * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
  12  * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
  13  * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
  14  * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
  15  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  16  * PERFORMANCE OF THIS SOFTWARE.
  17  */
  18
  19 /* Defines what's needed to identifiy a board['s folder] */
  20 struct board {
  21         /* Short name, like "a" or "b" */
  22         const char *name;
  23
  24         /* Like "Anime" or "Random" */
  25         const char *title;
  26
  27         /* Cooldown after you post text */
  28         int text_cooldown;
  29
  30         /* Cooldown after you post textless */
  31         int blank_cooldown;
  32
  33         /* How many threads are on each page */
  34         unsigned int threads_per_page;
  35
  36         /* How many pages total */
  37         unsigned int num_pages;
  38
  39         /* Whether posts here show up in /recent */
  40         unsigned int appears_in_recent;
  41 };
  42
  43 /* Things users can try to do */
  44 enum action_t { NONE, REPLY, NEWTHREAD, REBUILD };
  45
  46 /*
  47  * A post as it will be stored in (or retrieved from) the database.
  48  * As part of post_cmd, this will be built up by rb79.c, inserted
  49  * into the db by db_insert_post, and retrieved for writing to
  50  * filesystem in write-thread.c
  51  */
  52 struct prepared_post {
  53         /* When it was issued */
  54         time_t now;
  55
  56         /*
  57          * This requires db access to retrieve, so it may be 0 for
  58          * most of the object's life
  59          */
  60         uintmax_t id;
  61
  62         /* Flags, in case this is the OP of a thread */
  63         uint_fast8_t thread_closed;
  64         uint_fast8_t thread_stickied;
  65
  66         /* HTML-esc'd, ready for inserting into pages */
  67         char *name;
  68         size_t name_len;
  69         char *email;
  70         size_t email_len;
  71         char *tripcode;
  72         size_t tripcode_len;
  73         char *subject;
  74         size_t subject_len;
  75         char *comment;
  76         size_t comment_len;
  77
  78         /* Comes from a struct filetype. A copy, needs to be freed */
  79         char *ext;
  80         size_t ext_len;
  81
  82         /* The name the uploader called the file (HTML-esc'd) */
  83         char *file_name;
  84         size_t file_name_len;
  85
  86         /* The path for the full file, like /m/src/123.jpg */
  87         char *system_full_path;
  88         size_t system_full_path_len;
  89
  90         /* The path for the thumbnail, like /m/src/123s.jpg */
  91         char *system_thumb_path;
  92         size_t system_thumb_path_len;
  93
  94         /* A string like "image/jpeg, 30KiB, 500x399" */
  95         char *file_info;
  96         size_t file_info_len;
  97
  98         /* The main server ignores this, but mod tools use it */
  99         char *ip;
 100         size_t ip_len;
 101 };
 102 struct post_cmd {
 103         /*
 104          * Strings are filled in by multipart.c, where we are quite
 105          * thankful that everything is guaranteed to be UTF-8.
 106          * Parsing, if needed, is done by rb79.c
 107          */
 108         struct {
 109                 /* 0-terminated and normalized */
 110                 char *ip;
 111
 112                 /* action= */
 113                 char *action;
 114                 size_t action_len;
 115
 116                 /* board= */
 117                 char *board;
 118                 size_t board_len;
 119
 120                 /* thread= */
 121                 char *thread;
 122                 size_t thread_len;
 123
 124                 /* post= */
 125                 char *post;
 126                 size_t post_len;
 127
 128                 /* name= */
 129                 char *name;
 130                 size_t name_len;
 131
 132                 /* email= */
 133                 char *email;
 134                 size_t email_len;
 135
 136                 /* tripcode - calculated from email */
 137                 char *tripcode;
 138                 size_t tripcode_len;
 139
 140                 /* subject= */
 141                 char *subject;
 142                 size_t subject_len;
 143
 144                 /* comment= */
 145                 char *comment;
 146                 size_t comment_len;
 147
 148                 /* file upload */
 149                 char *file_name;
 150                 size_t file_name_len;
 151                 char *file_contents;
 152                 size_t file_contents_len;
 153
 154                 /* challengeid= */
 155                 char *challenge_id;
 156                 size_t challenge_id_len;
 157
 158                 /* challengeresponse= */
 159                 char *challenge_response;
 160                 size_t challenge_response_len;
 161         } raw;
 162
 163         /*
 164          * Everything below is filled in by rb79.c as derived data
 165          */
 166         enum action_t action_id;
 167         uintmax_t board_idx;
 168         uintmax_t thread_id;
 169
 170         /* This is what goes into the database. */
 171         struct prepared_post prepared;
 172
 173         /*
 174          * The following is intermediate data for sanitizing input
 175          * comments. XXX: figure out if these can be safely removed
 176          * from this object, because they're sort of messy.
 177          */
 178
 179         /* A sort of normalized UTF-8 comment */
 180         char *scannable_comment;
 181         size_t scannable_comment_len;
 182         size_t *comment_position_map;
 183         size_t comment_position_map_len;
 184         char *scannable_name;
 185         size_t scannable_name_len;
 186         size_t *name_position_map;
 187         size_t name_position_map_len;
 188         char *scannable_email;
 189         size_t scannable_email_len;
 190         size_t *email_position_map;
 191         size_t email_position_map_len;
 192         char *scannable_subject;
 193         size_t scannable_subject_len;
 194         size_t *subject_position_map;
 195         size_t subject_position_map_len;
 196 };
 197
 198 /* Filetype/thumbnailing options */
 199 struct filetype {
 200         /* */
 201         const char *mime_type;
 202         const char *ext;
 203         const char *install_command;
 204         const char *thumb_creation_command;
 205         const char *static_thumbnail;
 206
 207 };
 208
 209 #define NUM_CHALLENGE_ANSWERS 5
 210
 211 /* wakarimasen-style CAPTCHA */
 212 struct challenge {
 213         /* */
 214         const char *question;
 215         const char *answers[NUM_CHALLENGE_ANSWERS];
 216 };
 217
 218 /* regex-backed wordfilter */
 219 struct wordfilter_input {
 220         /* */
 221         const char *pattern;
 222         const char *replacement;
 223 };
 224
 225 /* regex-backed forbidden input */
 226 struct forbidden_input {
 227         /* */
 228         const char *pattern;
 229         int ban_duration;
 230         const char *ban_reason;
 231 };
 232
 233 /* See config.def.h for detailed descriptions. */
 234 struct configuration {
 235         /* */
 236         const char *static_www_folder;
 237         const char *work_path;
 238         const char *temp_dir_template;
 239         const char *trip_salt;
 240         size_t trip_salt_len;
 241         const struct board *boards;
 242         size_t boards_num;
 243         size_t max_form_data_size;
 244         size_t max_file_size;
 245         size_t max_text_len;
 246         const struct filetype *filetypes;
 247         size_t filetypes_num;
 248         const char *file_description_prog;
 249         const char **headers;
 250         size_t headers_num;
 251         const struct challenge *challenges;
 252         size_t challenges_num;
 253         const struct wordfilter_input *wordfilter_inputs;
 254         size_t wordfilter_inputs_num;
 255         const struct forbidden_input *forbidden_inputs;
 256         size_t forbidden_inputs_num;
 257 };
 258
 259 /* db_writeback_ZZZ takes a callback. */
 260 typedef int (*post_writeback)(struct prepared_post *p, FILE *f, uint_fast8_t
 261                               is_op, uint_fast8_t is_summary, uint_fast8_t
 262                               is_recent, const char *board_name,
 263                               uintmax_t in_thread, uintmax_t
 264                               total_posts_in_thread, uint_fast8_t hr_before);
 265
 266 /* db-ZZZ.c (currently only sqlite3, but it used to be MySQL) */
 267 int setup_dbs(const struct configuration *conf);
 268
 269 int db_construct_post_link(const char *board, size_t board_len, const
 270                            char *post, size_t post_len, int *found, char **out,
 271                            size_t *out_len);
 272
 273 int db_cull_threads(size_t board_idx, size_t *out_num_pages);
 274
 275 int db_check_bans(const char *ip, size_t board_idx, time_t now,
 276                   int *out_is_banned, char **out_ban_until, int *out_is_secret,
 277                   char **out_ban_reason);
 278
 279 int db_check_cooldowns(const char *ip, size_t board_idx, time_t now,
 280                        int *out_is_cooled, char **out_cooldown_length);
 281
 282 int db_cull_and_report_threads(size_t board_idx, uintmax_t **out_thread_ids,
 283                                size_t *out_thread_id_num,
 284                                size_t *out_num_pages);
 285
 286 int db_extract_subject(size_t board_idx, uintmax_t thread, char **out_subject,
 287                        size_t *out_subject_len);
 288
 289 int db_insert_ban(uint_fast8_t global_ban, size_t board_idx, const
 290                   char *first_ip, const char *last_ip, const char *message,
 291                   uint_fast8_t
 292                   is_secret, time_t ban_start, time_t ban_expiry);
 293
 294 int db_insert_post(const char *ip, size_t in_thread, int cooldown, struct
 295                    post_cmd *pc, int *thread_dne, int *thread_closed,
 296                    int *thread_full,
 297                    uintmax_t *post_id);
 298
 299 int db_is_op(size_t board_idx, uintmax_t post_id, uint_fast8_t *out_is_op);
 300
 301 int db_moderate_post(size_t board_idx, uintmax_t post_id, const
 302                      char *moderator_comment, uint_fast8_t change_sticky,
 303                      uint_fast8_t sticky_status,
 304                      uint_fast8_t change_close, uint_fast8_t close_status);
 305
 306 int db_remove_thread_and_files(size_t board_idx, uintmax_t thread_id);
 307
 308 int db_remove_post_and_files(size_t board_idx, uintmax_t thread_id);
 309
 310 int db_update_file_info(size_t board_idx, uintmax_t post_id, const char *info,
 311                         size_t info_len, const char *system_full_path, size_t
 312                         system_full_path_len,
 313                         const char *system_thumb_path, size_t
 314                         system_thumb_path_len);
 315
 316 int db_writeback_posts_in_thread(size_t board_idx, uintmax_t thread, FILE *f,
 317                                  post_writeback pw_function);
 318
 319 int db_writeback_recent_posts(FILE *f, post_writeback pw_function);
 320
 321 int db_writeback_thread_summaries(size_t board_idx, uintmax_t *thread_ids,
 322                                   size_t thread_ids_num, FILE *f);
 323
 324 int clean_dbs(void);
 325
 326 /* locks.c */
 327 int setup_locks(const struct configuration *conf);
 328
 329 int lock_acquire(size_t board_idx);
 330
 331 int lock_acquire_recent(void);
 332
 333 int lock_release(size_t board_idx);
 334
 335 int lock_release_recent(void);
 336
 337 int clean_locks(void);
 338
 339 /* multipart.c */
 340 int setup_multipart(void);
 341
 342 int multipart_decompose(const char *full_data, size_t full_data_len, struct
 343                         post_cmd *post_cmd);
 344
 345 int clean_multipart(void);
 346
 347 /* preconditions.c */
 348 int preconditions_check(const struct configuration *conf);
 349
 350 /* sanitize-comment.c */
 351 int setup_sanitize_comment(const struct configuration *conf);
 352
 353 int st_sanitize_text(struct post_cmd *pc, int *our_fault,
 354                      uint_fast8_t *is_forbidden, int *ban_duration, const
 355                      char **ban_reason);
 356
 357 int clean_sanitize_comment(void);
 358
 359 /* sanitize-file.c */
 360 int setup_sanitize_file(const struct configuration *conf);
 361
 362 int sf_check_mime_type(const char *buf, size_t len, const struct
 363                        filetype **out_filetype);
 364
 365 int sf_describe_file(const char *mimetype, const char *filepath,
 366                      char **out_description, size_t *out_len);
 367
 368 int sf_install_files(size_t board_idx, const char *buf, size_t len, time_t *now,
 369                      const struct filetype *filetype, char **out_abs_path,
 370                      char **out_path,
 371                      size_t *out_path_len, char **out_thumb_path,
 372                      size_t *out_thumb_path_len,
 373                      int *our_fault);
 374
 375 int clean_sanitize_file(void);
 376
 377 /* tripcodes.c */
 378 int setup_tripcodes(const struct configuration *conf);
 379
 380 int tripcodes_calculate(struct post_cmd *p);
 381
 382 int clean_tripcodes(void);
 383
 384 /* util.c */
 385 char * util_iso8601_from_time_t(time_t t);
 386
 387 int util_normalize_ip(const char *in, char **out);
 388
 389 int util_rebuild(struct configuration *conf);
 390
 391 /* write-thread.c */
 392 int setup_write_thread(const struct configuration *conf);
 393
 394 int wt_remove_files(const char *system_full_path, size_t system_full_path_len,
 395                     const char *system_thumb_path, size_t
 396                     system_thumb_path_len);
 397
 398 int wt_remove_thread_page(size_t board_idx, uintmax_t thread_id);
 399
 400 int wt_write_board(size_t board_idx, uintmax_t *thread_ids, size_t
 401                    thread_ids_num, size_t board_pages_num);
 402
 403 int wt_write_post(struct prepared_post *p, FILE *f, uint_fast8_t is_op,
 404                   uint_fast8_t is_summary, uint_fast8_t is_recent, const
 405                   char *board_name,
 406                   uintmax_t in_thread, uintmax_t total_posts_in_thread,
 407                   uint_fast8_t hr_before);
 408
 409 int wt_write_recent_page(void);
 410
 411 int wt_write_thread(size_t board_idx, uintmax_t thread);
 412
 413 void clean_write_thread(void);