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
|
/* Chrysalide - Outil d'analyse de fichiers binaires
* protocol.h - prototypes pour la description du protocole impactant les BD Chrysalide
*
* Copyright (C) 2014-2017 Cyrille Bagard
*
* This file is part of Chrysalide.
*
* Chrysalide is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 3 of the License, or
* (at your option) any later version.
*
* Chrysalide is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with Chrysalide. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef _ANALYSIS_DB_PROTOCOL_H
#define _ANALYSIS_DB_PROTOCOL_H
/**
* Version de la définition courante du protocole.
*/
#define CDB_PROTOCOL_VERSION 0xc0de0004
/**
* Délai maximal de réaction pour les coupures de flux (en ms).
*/
#define CDB_CONN_TIMEOUT 1000
/* Comportement vis à vis des éléments */
typedef enum _DBStorage
{
DBS_ALL_LOCAL = 0x00, /* Enregistrements locaux */
DBS_ALL_REMOTE = 0x01, /* Enregistrements distants */
DBS_MAX = 0x01
} DBStorage;
/**
* Une fois la connexion établie, les paquets ont tous la forme suivante :
*
* [ type de collection visée ; cf. DBFeatures ]
* [ action à mener ; cf. DBAction ]
* [ élément de type GDbItem sérialisé... ]
*
*/
/* Fonctionnalités offertes nativement */
typedef enum _DBFeatures
{
DBF_BOOKMARKS, /* Signets dans le code */
DBF_COMMENTS, /* Commentaires ajoutés */
DBF_MOVES, /* Déplacements dans du code */
DBF_DISPLAY_SWITCHERS, /* Choix d'affichage */
DBF_COUNT
} DBFeatures;
/* Interactions disponibles vis à vis d'une collection. */
typedef enum _DBAction
{
DBA_ADD_ITEM, /* Ajout d'un élément */
DBA_REM_ITEM, /* Suppression d'un élément */
DBA_CHANGE_STATE, /* Changement d'activité */
DBA_COUNT
} DBAction;
/**
* Commandes envoyées d'un côté à un autre.
*/
typedef enum _DBCommand
{
DBC_HELO, /* Connexion initiale C -> S */
DBC_WELCOME, /* Réponse initiale S -> C */
/**
* Gestion de la commande 'DBC_SAVE'.
*
* Le client connecté envoie un paquet de la forme suivante :
*
* [ Ordre de sauvegarde : DBC_SAVE ]
*
* Le serveur s'exécute et renvoie un bilan :
*
* [ Ordre de sauvegarde : DBC_SAVE ]
* [ Statut d'exécution ; cf. DBError ]
*
* Les traitements se réalisent dans :
* - g_db_client_save() pour la partie client en émission.
* - g_cdb_archive_process() pour la partie serveur.
* - g_db_client_update() pour la partie client en réception.
*
*/
DBC_SAVE, /* Enregistrement de l'archive */
DBC_COLLECTION, /* Implication d'une collection*/
/**
* Gestion de la commande 'DBC_[GS]ET_ALL_ITEMS'.
*
* Un client qui se connecte à un serveur doit en premier lieu envoyer :
*
* [ Demande de mise à jour : DBC_GET_ALL_ITEMS ]
*
* Tant qu'il ne reçoit pas la commande DBC_SET_ALL_ITEMS depuis le
* serveur, toutes les actions sur une collection sont à rejeter car elles
* lui seront retransmises plus tard.
*
* De son côté, le serveur répond par une requête :
*
* [ Notification de maj : DBC_SET_ALL_ITEMS ]
* [ marqueur de démarrage : octet 0x1 ]
*
* Dans la foulée, il enverra ensuite les éléments avec des paquets classiques :
*
* [ Traitement de collection : DBC_COLLECTION ]
* [ Action : DBA_ADD_ITEM ]
* ...
*
* La séquence se termine par une requête finale :
*
* [ Notification de maj : DBC_SET_ALL_ITEMS ]
* [ marqueur de fin : octet 0x0 ]
*
* Les traitements se réalisent dans :
* - g_db_client_update() pour la partie client.
* - g_cdb_archive_process() pour la partie serveur.
*
*/
DBC_GET_ALL_ITEMS, /* Mise à jour à la connexion */
DBC_SET_ALL_ITEMS, /* Mise à jour à la connexion */
/**
* Gestion de la commande 'DBC_SET_LAST_ACTIVE'.
*
* Le client connecté envoie un paquet de la forme suivante :
*
* [ Statut d'historique : DBC_SET_LAST_ACTIVE ]
* [ <horodatage du dernier élément actif ]
*
* Le serveur s'exécute et notifie le client d'éventuels changements,
* avec une série de paquets de la forme :
*
* [ Traitement de collection : DBC_COLLECTION ]
* [ Action : DBA_CHANGE_STATE ]
* [ <élément dont le statut a évolué> ]
*
* Les traitements se réalisent dans :
* - g_db_collection_disable_at() pour la partie serveur.
* - g_db_collection_update_item_state() pour la partie client.
*
*/
DBC_SET_LAST_ACTIVE, /* Définition du dernier actif */ // REMME
DBC_COUNT
} DBCommand;
/**
* Erreurs pouvant survenir...
*/
typedef enum _DBError
{
DBE_NONE, /* Succès d'une opération */
DBE_BAD_EXCHANGE, /* Incohérence des échanges */
DBE_WRONG_VERSION, /* Proto Client != Serveur */
DBE_SYS_ERROR, /* Erreur suite à un appel sys.*/
DBE_ARCHIVE_ERROR, /* Soucis du côté libarchive */
DBE_XML_VERSION_ERROR, /* Vieille archive présente */
DBE_DB_LOADING_ERROR, /* Erreur pendant le chargement*/
DBE_COUNT
} DBError;
#endif /* _ANALYSIS_DB_PROTOCOL_H */
|
