Mercurial > sci

annotate scid/crud.h @ 33:1d0ddf9e6efd

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
misc: general documentation
author David Demelier <markand@malikania.fr>
date Thu, 04 Aug 2022 16:47:10 +0200
parents 081e1c258e64
children 71cd8447e3a4
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
27
dae2de19ca5d misc: switch to JSON everywhere
David Demelier <markand@malikania.fr>
parents:
diff changeset
1 /*
dae2de19ca5d misc: switch to JSON everywhere
David Demelier <markand@malikania.fr>
parents:
diff changeset
2 * crud.h -- convenient helpers for page-api-*
dae2de19ca5d misc: switch to JSON everywhere
David Demelier <markand@malikania.fr>
parents:
diff changeset
3 *
32
081e1c258e64 misc: update copyright years
David Demelier <markand@malikania.fr>
parents: 27
diff changeset
4 * Copyright (c) 2021-2022 David Demelier <markand@malikania.fr>
27
dae2de19ca5d misc: switch to JSON everywhere
David Demelier <markand@malikania.fr>
parents:
diff changeset
5 *
dae2de19ca5d misc: switch to JSON everywhere
David Demelier <markand@malikania.fr>
parents:
diff changeset
6 * Permission to use, copy, modify, and/or distribute this software for any
dae2de19ca5d misc: switch to JSON everywhere
David Demelier <markand@malikania.fr>
parents:
diff changeset
7 * purpose with or without fee is hereby granted, provided that the above
dae2de19ca5d misc: switch to JSON everywhere
David Demelier <markand@malikania.fr>
parents:
diff changeset
8 * copyright notice and this permission notice appear in all copies.
dae2de19ca5d misc: switch to JSON everywhere
David Demelier <markand@malikania.fr>
parents:
diff changeset
9 *
dae2de19ca5d misc: switch to JSON everywhere
David Demelier <markand@malikania.fr>
parents:
diff changeset
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
dae2de19ca5d misc: switch to JSON everywhere
David Demelier <markand@malikania.fr>
parents:
diff changeset
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
dae2de19ca5d misc: switch to JSON everywhere
David Demelier <markand@malikania.fr>
parents:
diff changeset
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
dae2de19ca5d misc: switch to JSON everywhere
David Demelier <markand@malikania.fr>
parents:
diff changeset
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
dae2de19ca5d misc: switch to JSON everywhere
David Demelier <markand@malikania.fr>
parents:
diff changeset
14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
dae2de19ca5d misc: switch to JSON everywhere
David Demelier <markand@malikania.fr>
parents:
diff changeset
15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
dae2de19ca5d misc: switch to JSON everywhere
David Demelier <markand@malikania.fr>
parents:
diff changeset
16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
dae2de19ca5d misc: switch to JSON everywhere
David Demelier <markand@malikania.fr>
parents:
diff changeset
17 */
dae2de19ca5d misc: switch to JSON everywhere
David Demelier <markand@malikania.fr>
parents:
diff changeset
18
dae2de19ca5d misc: switch to JSON everywhere
David Demelier <markand@malikania.fr>
parents:
diff changeset
19 #ifndef SCID_CRUD_H
dae2de19ca5d misc: switch to JSON everywhere
David Demelier <markand@malikania.fr>
parents:
diff changeset
20 #define SCID_CRUD_H
dae2de19ca5d misc: switch to JSON everywhere
David Demelier <markand@malikania.fr>
parents:
diff changeset
21
33
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 32
diff changeset
22 /**
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 32
diff changeset
23 * \file crud.h
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 32
diff changeset
24 * \brief Convenient helpers for API pages.
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 32
diff changeset
25 *
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 32
diff changeset
26 * This module uses the database to fetch or insert data and finally show the
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 32
diff changeset
27 * result as HTTP response.
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 32
diff changeset
28 *
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 32
diff changeset
29 * This module logs message with tag `crud`.
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 32
diff changeset
30 */
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 32
diff changeset
31
27
dae2de19ca5d misc: switch to JSON everywhere
David Demelier <markand@malikania.fr>
parents:
diff changeset
32 #include <jansson.h>
dae2de19ca5d misc: switch to JSON everywhere
David Demelier <markand@malikania.fr>
parents:
diff changeset
33
dae2de19ca5d misc: switch to JSON everywhere
David Demelier <markand@malikania.fr>
parents:
diff changeset
34 struct kreq;
dae2de19ca5d misc: switch to JSON everywhere
David Demelier <markand@malikania.fr>
parents:
diff changeset
35
33
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 32
diff changeset
36 /**
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 32
diff changeset
37 * Decode the JSON input and insert them using the appropriate database
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 32
diff changeset
38 * function provided.
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 32
diff changeset
39 *
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 32
diff changeset
40 * \pre r != NULL
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 32
diff changeset
41 * \pre saver != NULL
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 32
diff changeset
42 * \pre topic != NULL
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 32
diff changeset
43 * \param r the request
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 32
diff changeset
44 * \param saver the function to save in database
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 32
diff changeset
45 * \param topic the log topic for diagnostic
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 32
diff changeset
46 */
27
dae2de19ca5d misc: switch to JSON everywhere
David Demelier <markand@malikania.fr>
parents:
diff changeset
47 void
33
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 32
diff changeset
48 crud_insert(struct kreq *r, int (*saver)(json_t *), const char *topic);
27
dae2de19ca5d misc: switch to JSON everywhere
David Demelier <markand@malikania.fr>
parents:
diff changeset
49
33
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 32
diff changeset
50 /**
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 32
diff changeset
51 * Convert the JSON provided value.
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 32
diff changeset
52 *
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 32
diff changeset
53 * For convenience, if the document is NULL (which happen if the database
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 32
diff changeset
54 * access failed) it will send a HTTP 500 error. Otherwise it is listed and
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 32
diff changeset
55 * free'd.
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 32
diff changeset
56 *
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 32
diff changeset
57 * \pre r != NULL
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 32
diff changeset
58 * \param r the request
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 32
diff changeset
59 * \param doc the document to send (maybe NULL)
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 32
diff changeset
60 * \warning The document will be destroyed using json_decref.
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 32
diff changeset
61 */
27
dae2de19ca5d misc: switch to JSON everywhere
David Demelier <markand@malikania.fr>
parents:
diff changeset
62 void
33
1d0ddf9e6efd misc: general documentation
David Demelier <markand@malikania.fr>
parents: 32
diff changeset
63 crud_list(struct kreq *r, json_t *doc);
27
dae2de19ca5d misc: switch to JSON everywhere
David Demelier <markand@malikania.fr>
parents:
diff changeset
64
dae2de19ca5d misc: switch to JSON everywhere
David Demelier <markand@malikania.fr>
parents:
diff changeset
65 #endif /* !SCID_CRUD_H */