aboutsummaryrefslogtreecommitdiff
path: root/daemon/ip/internals.h
blob: 15b8df486a6b99d717a0d34ff6ed43e084da3545 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
/* ****************************************************************************
 * ip/internals.h -- déclarations et définitions pour les serveurs WES
 *                   connectés via IP.
 * Copyright (C) 2018 Thomas Touhey <thomas@touhey.fr>
 *
 * This project is governed by the CeCILL license under French law and
 * abiding by the rules of distribution of free software. You can use,
 * modify and/or redistribute the software under the terms of the
 * CeCILL license as circulated by CEA, CNRS and INRIA at the
 * following URL: "http://www.cecill.info".
 *
 * As a counterpart to the access to the source code and rights to copy,
 * modify and redistribute granted by the license, users are provided only
 * with a limited warranty and the project's author, the holder of the
 * economic rights, and the successive licensors have only limited liability.
 *
 * In this respect, the user's attention is drawn to the risks associated
 * with loading, using, modifying and/or developing or reproducing the
 * software by the user in light of its specific status of free software,
 * that may mean that it is complicated to manipulate, and that also therefore
 * means that it is reserved for developers and experienced professionals
 * having in-depth computer knowledge. Users are therefore encouraged to load
 * and test the software's suitability as regards their requirements in
 * conditions enabling the security of their systems and/or data to be
 * ensured and, more generally, to use and operate it in the same conditions
 * as regards security.
 *
 * The fact that you are presently reading this means that you have had
 * knowledge of the CeCILL license and that you accept its terms.
 * ************************************************************************* */
#ifndef  LOCAL_IP_INTERNALS_H
# define LOCAL_IP_INTERNALS_H 2018040401

# define WESIF_DEFINITIONS 1
# include "../internals.h"

/* POSIX-specific headers */

# include <unistd.h>
# include <netinet/in.h>
# include <netinet/tcp.h>
# include <sys/socket.h>
# include <sys/ioctl.h>

/* ---
 * Données utilisées pour le décodage de fichiers CSV.
 * --- */

/* Cookie et type du callback.
 * Le callback est appelé pour chaque ligne qui a été lue.
 * Le `fdc` passé (field count) ne donne que le nombre de valeurs remplies,
 * pas le nombre total de champs qu'il y avait dans la ligne. */

typedef int wescsventry_t (void *cookie, int line, int fdc,
	char * const fdv[]);

typedef struct wescsv {
	int num, id, line, err;
	char * const *buffers;
	size_t const *lens;
	wescsventry_t *callback;
	void *cbcookie;

	size_t off;
	int separator;

	int wescsv__align;
} wescsv_t;

/* ---
 * Définition des structures utilisées pour la configuration.
 * --- */

/* Élément de configuration. */

typedef struct wescfg {
	struct wescfg *next;

	size_t keysz; /* Taille de la clé de configuration */
	size_t valsz; /* Taille de la valeur */
	char data[];
} wescfg_t;

/* Section de configuration.
 * Une section contient à la fois :
 * - des options de configuration et leur valeur, sous la forme d'une liste
 *   chaînée de `wescfg_t`, détectées en `<key>=<val><CRLF>` ;
 * - ce qui reste (« text »), détectées en `<key><CRLF>` (sans '='). */

typedef struct wescfgsec {
	struct wescfgsec *next;

	wescfg_t *child;
	size_t keysz;
#if 0
	size_t textsz;
	char *text;
#endif
	char data[];
} wescfgsec_t;

/* ---
 * Définition des structures utilisées pour les données de type
 * PULSE (impulsions), PLIERS (pinces) et TELEINFO (externe).
 * --- */

/* Même si présentes dans différents fichiers, ces informations sont
 * regroupées à la même enseigne sous ce démon. */

#define WDFTIEXST     1 /* Les données TELEINFO existent. */
#define WDFPLEXST     2 /* Les données PL existent. */
#define WDFPCEXST     4 /* Les données PC existent. */

#define WDFTIPLUG     8 /* TELEINFO est non branché */
#define WDFPLNAN0    16 /* PL1 est égal à NaN */
#define WDFPLNAN1    32 /* PL2 est égal à NaN */
#define WDFPLNAN2    64 /* PL3 est égal à NaN */
#define WDFPLNAN3   128 /* PL4 est égal à NaN */
#define WDFPCNAN0   256 /* PC1 est égal à NaN */
#define WDFPCNAN1   512 /* PC2 est égal à NaN */
#define WDFPCNAN2  1024 /* PC3 est égal à NaN */
#define WDFPCNAN3  2048 /* PC4 est égal à NaN */

typedef struct wesdata {
	struct wesdata *next;

	/* Minute correspondante dans la journée. */

	int hour, min;

	/* Options, concernant si les données sont valides, etc. */

	int flags;
	int wesdata__align;

	/* Valeurs concernant les pulsations. */

	double pl[4];

	/* Valeurs concernant les pinces. */

	double pc[4];

	/* Valeurs récupérées depuis les compteurs.
	 * `hp` est le cumul de l'énergie consommée lors des heures pleines,
	 * en Wh. `hc` est son équivalent pour les heures creuses.
	 * `ii` est l'intensité instantanée en A.
	 * `pa` est la puissance apparente en VA. */

	long hp, hc;
	long ii, pa;
} wesdata_t;

typedef struct wesdataspan {
	struct wesdataspan *next;

	/* Données correspondant à cette journée. */

	wesdata_t *data;

	/* Année, mois, jour du mois.
	 * Il s'agit de l'organisation des fichiers sur le WES. */

	int year, mon, dom;

	int wesdataspan__align;
} wesdataspan_t;

/* ---
 * Définition d'une requête CGI.
 * --- */

/* Ce bloc contient à la fois les éléments de requête et les réponses à
 * remplir (à la manière des `sg_io_hdr_t` de l'interface utilisateur de
 * Linux). */

typedef struct wescgi {
	/* Requête (entrée).
	 * Requiert une variable et un format. */

	const char *var;
	const char *format;

	/* Réponse (sortie).
	 * `buffer`: buffer à remplir avec la réponse.
	 * `len`: longueur du buffer (incluant le '\0' à insérer).
	 * `full`: longueur attendue du buffer (en cas de ré-appel) ;
	 * `lines`: nombre de lignes de réponses (donc nombre de retours à la
	 * ligne trouvables dans le buffer + 1). */

	char *buffer;
	size_t len, full;
	int lines;

	int wescgi__align;
} wescgi_t;

/* Les requêtes CGI sont également le moyen de faire des requêtes GET et POST
 * pour interagir en écriture avec le serveur WES. La méthode peut varier
 * selon la variable et le moyen de l'atteindre, mais l'idée derrière les
 * arguments reste la même. */

typedef enum wescgimethod {
	WESCGIMETHOD_GET,
	WESCGIMETHOD_POST
} wescgimethod_t;

typedef struct wescgiarg {
	const char *name;
	const char *value; /* peut être NULL ! */
} wescgiarg_t;

# define WESCGIARG(NAME, VALUE) {(NAME), (VALUE)}

/* Cette macro permet de définir le contenu d'une instance de type `wescgi_t`
 * de façon rétrocompatible au niveau de l'API, et plus simplement qu'en
 * le faisant manuellement. */

# define WESCGI(VAR, FORMAT, BUFFER, LEN) \
	{(VAR), (FORMAT), (BUFFER), (LEN), 0, 0, 0}

/* ---
 * Structure du WES propre à cette interface.
 * --- */

# define WSK_NONE 0
# define WSK_TCP  1
# define WSK_UDP  2

struct wes {
	wesbase_t base;

	/* Identifiants pour les serveurs HTTP et FTP. */

	char *http_name;
	char *http_pass;

	char  *ftp_name;
	char  *ftp_pass;

	/* Canaux (handles de la libcurl) pour le HTTP et FTP. */

	CURL *http_handle;
	CURL  *ftp_handle;

	/* Éléments pour la gestion de la configuration.
	 * Il s'agit d'une liste chaînée de sections. */

	wescfgsec_t *sections;

	/* Éléments pour la gestion des données.
	 * Il s'agit d'une liste chaînée de données regroupées par date. */

	wesdataspan_t *data;

	/* Adresse IP cross-platform pour joindre le serveur WES. */

	wesaddr_t addr;

	/* Éléments pour le protocole M2M.
	 * `sock_type` représente le type de la socket parmi les constantes
	 * en `WSK_*` précisées ci-dessus.
	 * `sock_buf` est le buffer de réception, alloué dynamiquement à
	 * `WSBUFSIZE` lorsque l'on se sert de la socket.
	 * La socket et ses données, qui dépendent de la plateforme, sont
	 * stockées dans l'union `platform`. */

	int sock_type;
	char *sock_buf;
	size_t sock_buflen;

	/* Éléments spécifiques à des platformes données. */

	union {
		struct {
			/* Sockets BSD.
			 * On garde le file descriptor et l'adresse (pour l'UDP et
			 * sa commande associée `sendto()`). */

			int sock;

			int wes_posix__align;

			struct sockaddr *sockaddr;
			socklen_t sockaddr_size;

			union {
				struct sockaddr_in  ip;
				struct sockaddr_in6 ip6;
			} sock_addr;
		} posix;
	} platform;
};

/* ---
 * Décodages de fichiers CSV.
 * --- */

/* `init_csv()` permet d'initialiser le cookie avec les buffers, quelques
 * tweaks de lecture et le callback à utiliser. */

extern int init_csv(wescsv_t *cookie, int separator,
	int numfields, char * const buffers[], size_t const lens[],
	wescsventry_t *callback, void *cbcookie);

/* `read_csv()` sert de callback à la libcurl par exemple (ressemble donc
 * à `fwrite()`), pour lire du contenu ;
 * `end_csv()` termine la lecture du fichier en appelant si besoin une
 * dernière fois le callback. */

extern size_t read_csv(char *buf, size_t size, size_t nmemb, void *cookie);
extern int end_csv(wescsv_t *cookie);

/* ---
 * Gestions des protocoles cités ci-dessus.
 * --- */

extern int set_http_ident(wes_t *wes, const char *name, const char *pass);
extern int  set_ftp_ident(wes_t *wes, const char *name, const char *pass);

/* Ouvrir les canaux HTTP et FTP sur lesquels on fait les requêtes. */

extern int open_http_handle(wes_t *wes, CURL **handlep, const char *path);
extern int  open_ftp_handle(wes_t *wes, CURL **handlep, const char *path);

/* Récupérer et définir la valeur d'une option de configuration sur le
 * serveur WES. La « section » correspond au fichier dans le dossier `CFG/`
 * accessible sur le serveur FTP du serveur WES. */

extern int get_config(wes_t *wes, const char *section, const char *key,
	char *buf, size_t len);
extern int set_config(wes_t *wes, const char *section, const char *key,
	const char *value);

/* Appliquer et retirer l'intégralité de la copie locale de
 * la configuration. */

extern int apply_config(wes_t *wes);
extern int clear_config(wes_t *wes);

/* Récupération des données pour une minute particulière. */

extern int get_data(wes_t *wes, wesdata_t *data, struct tm *dt);

/* Nettoyage des données locales de la configuration. */

extern int clear_data(wes_t *wes);

/* Récupération d'un ou plusieurs éléments par script CGI
 * La gestion des arguments GET et POST via HTTP se fait via
 * la fonction la plus basse : `get_cgi_args()`. */

extern int get_cgi_var(wes_t *wes, const char *var, const char *format,
	char *buffer, size_t *len);
extern int get_cgi(wes_t *wes, int blkc, wescgi_t *blk);

extern int get_form(wes_t *wes, int argc, wescgiarg_t *args);
extern int post_form(wes_t *wes, int argc, wescgiarg_t *args);

extern int get_cgi_with_args(wes_t *wes, wescgimethod_t method,
	int argc, wescgiarg_t *args, int blkc, wescgi_t *blks);

/* Envoyer une commande et récupérer la réponse via le protocole M2M.
 * On propose aussi les commandes pour initialiser la couche réseau
 * utilisée par weshd : cela ne sera utilisé que par l'initialisation
 * et la déinitialisation/libération de la ressource de type WES, et non
 * pas par l'utilisateur. */

extern int init_m2m(wes_t *wes);
extern int deinit_m2m(wes_t *wes);

extern int send_command(wes_t *wes, const char *command,
	char *response, size_t *lenp);

#endif