Annotation of libaitio/inc/aitio.h, revision 1.8.2.5
1.1 misho 1: /*************************************************************************
1.8 misho 2: * (C) 2010 AITNET ltd - Sofia/Bulgaria - <misho@aitnet.org>
3: * by Michael Pounov <misho@elwix.org>
1.1 misho 4: *
5: * $Author: misho $
1.8.2.5 ! misho 6: * $Id: aitio.h,v 1.8.2.4 2011/05/03 14:37:54 misho Exp $
1.1 misho 7: *
1.8 misho 8: **************************************************************************
9: The ELWIX and AITNET software is distributed under the following
10: terms:
11:
12: All of the documentation and software included in the ELWIX and AITNET
13: Releases is copyrighted by ELWIX - Sofia/Bulgaria <info@elwix.org>
14:
15: Copyright 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011
16: by Michael Pounov <misho@elwix.org>. All rights reserved.
17:
18: Redistribution and use in source and binary forms, with or without
19: modification, are permitted provided that the following conditions
20: are met:
21: 1. Redistributions of source code must retain the above copyright
22: notice, this list of conditions and the following disclaimer.
23: 2. Redistributions in binary form must reproduce the above copyright
24: notice, this list of conditions and the following disclaimer in the
25: documentation and/or other materials provided with the distribution.
26: 3. All advertising materials mentioning features or use of this software
27: must display the following acknowledgement:
28: This product includes software developed by Michael Pounov <misho@elwix.org>
29: ELWIX - Embedded LightWeight unIX and its contributors.
30: 4. Neither the name of AITNET nor the names of its contributors
31: may be used to endorse or promote products derived from this software
32: without specific prior written permission.
33:
34: THIS SOFTWARE IS PROVIDED BY AITNET AND CONTRIBUTORS ``AS IS'' AND
35: ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
36: IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
37: ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
38: FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
39: DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
40: OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
41: HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
42: LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
43: OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
44: SUCH DAMAGE.
45: */
1.1 misho 46: #ifndef __AITIO_H
47: #define __AITIO_H
48:
49:
1.8 misho 50: #include <assert.h>
1.7 misho 51: #include <openssl/evp.h>
52:
53:
1.8 misho 54: #define VACUUM_LEFT 1
55: #define VACUUM_BETWEEN 2
56:
57:
1.8.2.1 misho 58: typedef void ** sarr_seg_t;
59: typedef struct _tagSplitArray {
60: int sarr_num;
61: int sarr_seg;
62: int sarr_siz;
63: sarr_seg_t *sarr_data;
64: } sarr_t;
65:
1.8 misho 66: typedef struct _tagArray {
67: int arr_num;
68: void **arr_data;
69: } array_t;
70:
1.2 misho 71: typedef struct _tagURLItem {
72: int vallen;
73: char *value;
74: } url_Item_t;
75:
76: struct tagIOURL {
77: unsigned char url_line[BUFSIZ];
78:
79: url_Item_t url_tech;
80: url_Item_t url_user;
81: url_Item_t url_pass;
82: url_Item_t url_host;
83: url_Item_t url_port;
84: url_Item_t url_path;
85: url_Item_t url_args;
86:
87: char *url_reserved;
88: };
89:
1.6 misho 90: struct tagReqXML {
91: unsigned char xml_line[BUFSIZ];
92:
93: url_Item_t xml_namespace;
94: union {
95: url_Item_t container;
96: url_Item_t path;
97: } xml_node;
98: url_Item_t xml_data;
99: url_Item_t xml_attribute;
100: url_Item_t xml_value;
101: };
102:
1.3 misho 103:
1.1 misho 104: // io_GetErrno() Get error code of last operation
105: inline int io_GetErrno();
106: // io_GetError() Get error text of last operation
107: inline const char *io_GetError();
108:
109:
110: /*
111: * ioPromptRead() Read data from input h[0] with prompt to output h[1]
112: * @h = file handles h[0] = input, h[1] = output, if NULL use stdin, stdout
113: * @csPrompt = Prompt before input, may be NULL
114: * @psData = Readed data
115: * @dataLen = Length of data
116: * return: 0 EOF; -1 error:: can`t read; >0 count of readed chars
117: */
118: int ioPromptRead(int *h, const char *csPrompt, char * __restrict psData, int dataLen);
119: /*
120: * ioPromptPassword() Read password from input h[0] with prompt to output h[1]
121: * @h = file handles h[0] = input, h[1] = output, if NULL use stdin, stdout
122: * @csPrompt = Prompt before input, may be NULL
123: * @psPass = Readed password
124: * @passLen = Length of password
125: * @confirm = Confirm password, 0 - get password, !=0 Ask for confirmation
126: * return: 0 EOF; -1 error:: can`t read; >0 count of readed chars
127: */
128: int ioPromptPassword(int *h, const char *csPrompt, char * __restrict psPass, int passLen, int confirm);
129:
130: /*
131: * ioRegexVerify() Function for verify data match in regex expression
132: * @csRegex = Regulare expression pattern
133: * @csData = Data for check and verify
134: * @startPos = Return start positions
135: * @endPos = Return end positions
136: * return: NULL not match or error; !=NULL begin of matched data
137: */
138: const char *ioRegexVerify(const char *csRegex, const char *csData, int *startPos, int *endPos);
139: /*
140: * ioRegexGet() Function for get data match in regex expression
141: * @csRegex = Regulare expression pattern
142: * @csData = Data from get
143: * @psString = Returned string if match
144: * @strLen = Length of string
145: * return: 0 not match; >0 count of returned chars
146: */
147: int ioRegexGet(const char *csRegex, const char *csData, char * __restrict psString, int strLen);
148: /*
149: * ioRegexReplace() Function for replace data match in regex expression with newdata
150: * @csRegex = Regulare expression pattern
151: * @csData = Source data
152: * @csNew = Data for replace
153: * return: NULL not match or error; !=NULL allocated new string, must be free after use!
154: */
155: char *ioRegexReplace(const char *csRegex, const char *csData, const char *csNew);
156:
1.2 misho 157: /*
1.6 misho 158: * ioVarAst() Function for evaluate string like asterisk variable "{text[:[-]#[:#]]}"
159: * @csString = Input string
160: * return: NULL error, !=NULL Allocated new string evaluated from input string, must be free()
161: */
162: char *ioVarAst(const char *csString);
163:
164: /*
1.2 misho 165: * io_Path2File() Parse and make path/filename pair
166: * @csArgs = Input argument line
167: * @psPath = Output Path, if ==NULL path not returned
168: * @pathLen = Size of path array
169: * @psFile = Output File
170: * @fileLen = Size of file array
171: * return: 0 error format; -1 error:: can`t read; >0 ok, number of readed items
172: */
173: inline int io_Path2File(const char * __restrict csArgs, char * __restrict psPath, int pathLen,
174: char * __restrict psFile, int fileLen);
175:
176: /*
1.4 misho 177: * io_UnquotStr() Remove quots from input text string
178: * @psLine = Text string
179: * return: 0 nothing to do; 1 successful unquoted string
180: */
1.5 misho 181: inline int io_UnquotStr(unsigned char * __restrict psLine);
1.4 misho 182: /*
183: * io_LTrimStr() Remove left whitespaces from text string
184: * @psLine = Text string
185: * return: 0 nothing to do; !=0 Removed bytes
186: */
1.5 misho 187: inline int io_LTrimStr(unsigned char * __restrict psLine);
1.4 misho 188: /*
189: * io_RTrimStr() Remove right whitespaces from text string
190: * @psLine = Text string
191: * return: 0 nothing to do; !=0 Removed bytes
192: */
1.5 misho 193: inline int io_RTrimStr(unsigned char * __restrict psLine);
1.4 misho 194: /*
195: * io_TrimStr() Remove left and right whitespaces from text string
196: * @psLine = Text string
197: * return: 0 nothing to do; !=0 Removed bytes
198: */
1.5 misho 199: inline int io_TrimStr(unsigned char * __restrict psLine);
1.4 misho 200: /*
1.5 misho 201: * io_Ch2Hex() Convert from Char string to Hex string
1.4 misho 202: * @psLine = Text string
203: * @lineLen = Length of Text string
1.5 misho 204: * return: NULL nothing to do or error; !=0 Allocated new converted data without term\0 (must be free)
1.4 misho 205: */
1.5 misho 206: inline unsigned char *io_Ch2Hex(unsigned char *psLine, int lineLen);
1.4 misho 207: /*
1.5 misho 208: * io_Hex2Ch() Convert from Hex string to Char string
1.4 misho 209: * @psLine = Text string
210: * @lineLen = Length of Text string
211: * return: NULL nothing to do or error; !=0 Allocated new converted string(must be free)
212: */
1.5 misho 213: inline char *io_Hex2Ch(unsigned char *psLine, int lineLen);
1.4 misho 214:
215: /*
1.8 misho 216: * io_arrayInit() - Create and initialize dynamic array
217: * @numItems = Number of Items
218: * return: NULL error, != NULL allocated memory for array
219: */
220: inline array_t *io_arrayInit(int numItems);
221: /*
222: * io_arrayDestroy() - Free all data in dynamic array and Destroy dynamic array
223: * @parr = Array
224: * return: none
225: */
226: inline void io_arrayDestroy(array_t ** __restrict parr);
227: /*
228: * io_arrayFree() - Free all data in dynamic array
229: * (WARNING! If assign static array dont use this!!!)
230: * @arr = Array
231: * return: none
232: */
233: inline void io_arrayFree(array_t * __restrict arr);
234: /*
235: * io_arrayLen() - Get last used element in dynamic array (array Length)
236: * @arr = Array
237: * return: -1 error, 0 empty or >0 position of last used element
238: */
239: inline int io_arrayLen(array_t * __restrict arr);
240: /*
241: * io_arrayGrow() - Grow/Shrink dynamic array, Use with care when it shrink!!!
242: * @arr = Array
243: * @newNumItems = Number of Items
244: * return: -1 error, 0 ok
245: */
246: int io_arrayGrow(array_t * __restrict arr, int newNumItems);
247: /*
248: * io_arrayVacuum() - Vacuum dynamic array, empty elements will be deleted
249: * @arr = Array
250: * @fromWhere = 1 begin, 2 ALL empty elements
251: * return: -1 error, 0 ok
252: */
253: int io_arrayVacuum(array_t * __restrict arr, int fromWhere);
254:
255: #define io_arraySize(_arr) ((assert(_arr)), _arr->arr_num)
256:
257: #define io_arrayGet(_arr, _d, _type) ((assert(_arr && _arr->arr_num > _d)), \
258: ((_type) *(_arr->arr_data + _d)))
259: #define io_arraySet(_arr, _d, _ptr) do { \
260: assert(_arr && _arr->arr_num > _d); \
261: *(_arr->arr_data + _d) = (void*) _ptr; \
262: } while (0)
263:
264: /*
265: * io_arrayPush() - Push element into dynamic array like stack manner, place at first empty position
266: * @arr = Array
267: * @data = Element, if set NULL return only first empty position
268: * return: -1 not found empty position, array is full!, >-1 return position of stored element into array
269: */
270: inline int io_arrayPush(array_t * __restrict arr, void **data);
271: /*
272: * io_arrayPop() - Pop element from dynamic array like stack manner, last used position
273: * @arr = Array
274: * @data = Element, if set NULL return only first empty position
275: * @delAfter = Delete after Pop element, !=0 delete element from array after return data
276: * return: -1 not found used position, array is empty!, >-1 return element position
277: */
278: inline int io_arrayPop(array_t * __restrict arr, void ** __restrict data, int delAfter);
279:
280: /*
281: * io_argsNum() Parse and calculate number of arguments
282: * @csArgs = Input arguments line
283: * @csDelim = Delimiter(s) for separate
284: * return: 0 error format; -1 error:: can`t read; >0 ok, number of items
285: */
286: inline int io_argsNum(const char *csArgs, const char *csDelim);
287:
288: /*
289: * io_arrayMake() Parse and make array from arguments ... (input string will be modified!!!
290: * and output array must be free with io_arrayDestroy() after use!)
291: * @psArgs = Input arguments line, after execute string is modified!!!
292: * @nargs = Maximum requested count of arguments from input string psArgs, if 0 all psArgs
293: * @csDelim = Delimiter(s) for separate
294: * @parr = Output array of arguments ... (must be free with io_arrayDestroy() after use!)
295: * return: 0 error format; -1 error:: can`t read; >0 ok, number of readed items
296: */
297: int io_arrayMake(char * __restrict psArgs, int nargs, const char *csDelim,
298: array_t ** __restrict parr);
299:
300: /*
301: * io_MakeAV() Parse and make attribute/value pair
302: * @csArgs = Input argument line
303: * @csDelim = Delimiter for separate
304: * @psAttr = Output Attribute
305: * @attrLen = Size of attribute array
306: * @psValue = Output Value, if ==NULL this element not present value or not wanted for return
307: * @valLen = Size of value array
308: * return: 0 error format; -1 error:: can`t read; >0 ok, number of readed items
309: */
310: int io_MakeAV(const char * __restrict csArgs, const char *csDelim,
311: char * __restrict psAttr, int attrLen, char * __restrict psValue, int valLen);
312:
1.8.2.1 misho 313: /*
314: * io_sarrInit() - Create and initialize dynamic split-order array
315: * @numItems = Number of Items
316: * @segLen = Length of segment
317: * return: NULL error, != NULL allocated memory for array
318: */
319: inline sarr_t *io_sarrInit(int numItems, int segLen);
320: /*
321: * io_sarrDestroy() - Free all data in dynamic split-order array and Destroy array
322: * @parr = Array
323: * return: none
324: */
325: inline void io_sarrDestroy(sarr_t ** __restrict parr);
326: /*
1.8.2.2 misho 327: * io_sarrGrow() - Grow/Shrink dynamic split-order array, Use with care when it shrink!!!
328: * @arr = Array
329: * @newNumItems = Number of Items
330: * return: -1 error, 0 ok
331: */
332: int io_sarrGrow(sarr_t * __restrict arr, int newNumItems);
333: /*
1.8.2.1 misho 334: * io_sarrVacuum() - Vacuum dynamic split-order array, empty segments will be freed
335: * @arr = Array
336: * return: -1 error, >-1 freed segments
337: */
338: inline int io_sarrVacuum(sarr_t * __restrict arr);
339: #define io_sarrSize(_arr) ((assert(_arr)), _arr->sarr_num)
1.8.2.2 misho 340: /*
341: * io_sarrGet() - Get element from dynamic split-order array
342: * @arr = Array
343: * @idx = Index (warning 1st element is at position 1)
344: * return: NULL not found, !=NULL element
345: */
1.8.2.5 ! misho 346: inline void *io_sarrGet(sarr_t * __restrict arr, unsigned int idx);
1.8.2.2 misho 347: /*
348: * io_sarrSet() - Set element to dynamic split-order array
349: * @arr = Array
350: * @idx = Index (warning 1st element is at position 1)
351: * @data = Value
352: * return: NULL error or empty, !=NULL old value in element
353: */
1.8.2.5 ! misho 354: inline void *io_sarrSet(sarr_t * __restrict arr, unsigned int idx, void *data);
1.8.2.3 misho 355: #define io_sarrDel(_arr, _idx) io_sarrSet(_arr, _idx, NULL)
1.8.2.4 misho 356: #define io_sarr(_arr, _idx, _type) (_type)io_sarrGet(_arr, _idx)
1.8 misho 357:
358: /*
1.2 misho 359: * ioURLGet() Parse and get data from input URL
360: * @csURL = Input URL line
361: * @url = Output parsed URL
362: * return: 0 error format not find tech:// and return URL like path;
363: -1 error:: can`t read; >0 ok, up bits for known elements
364: */
365: int ioURLGet(const char *csURL, struct tagIOURL *url);
366: /*
367: * ioURLGetValue() Get value from parsed URL
368: * @url = Input parsed URL
369: * @csAttr = Attribute for search
370: * @psValue = Return value of attribute, if ==NULL only check for existence of attribute
371: * @valLen = Size of psValue array
372: * return: 0 error attribute not find; -1 error:: can`t read; >0 ok, find at position
373: */
374: int ioURLGetValue(struct tagIOURL *url, const char *csAttr, char * __restrict psValue, int valLen);
375: /*
376: * ioURLGetFile() Get file from parsed URL
377: * @url = Input parsed URL
378: * @psValue = Return filename, if not specified file in url path, replace with /
379: * @valLen = Size of psValue array
380: * return: -1 error:: can`t read; 0 ok
381: */
382: int ioURLGetFile(struct tagIOURL *url, char * __restrict psValue, int valLen);
383:
1.3 misho 384:
385: /*
1.6 misho 386: * ioXMLGet() Parse and get data from input XML request string [ns:]container[|attribute[=value]][?data]
387: * @csXML = Input XML request line
388: * @xml = Output parsed XML request
389: * return: 0 error format incorrect, -1 error:: can`t read; >0 ok readed elements bits
390: */
391: int ioXMLGet(const char *csXML, struct tagReqXML *xml);
392:
393:
394: /*
1.5 misho 395: * ioMkDir() Function for racursive directory creation and validation
396: * @csDir = Full directory path
397: * @mode = Mode for directory creation if missing dir
398: * return: -1 error, 0 directory path exist, >0 created missing dirs
399: */
400: int ioMkDir(const char *csDir, int mode);
401:
1.6 misho 402: /*
403: * ioWatchDirLoop() Function for watching changes in directory and fire callback
404: * @csDir = Full directory path
405: * @callback = Callback if raise event! nOp -1 delete, 0 change/move, 1 create
406: * return: -1 error, !=-1 ok, number of total signaled events
407: */
408: int ioWatchDirLoop(const char *csDir, int (*callback)(const char *csName, int nOp));
409:
1.5 misho 410:
411: /*
412: * io_rread() Raw VFS read function
413: * @fd = File handle
414: * @buf = Read buffer
415: * @nbytes = Read buffer size
416: * @offset = Read from position, if -1 read nbytes from current position
417: * @update = Update file handle position !0
418: * return: -1 error or !=-1 readed bytes
419: */
420: inline int io_rread(int fd, void * __restrict buf, size_t nbytes, off_t offset, int update);
421: /*
422: * io_rwrite() Raw VFS write function
423: * @fd = File handle
424: * @buf = Write buffer
425: * @nbytes = Write bytes from buffer
426: * @offset = Write at position, if -1 write nbytes from current position
427: * @update = Update file handle position !0
428: * return: -1 error or !=-1 writed bytes
429: */
430: inline int io_rwrite(int fd, void * __restrict buf, size_t nbytes, off_t offset, int update);
431:
432: /* Disk I/O helper macros */
433: #define io_read(f, b, n) io_rread(f, b, n, -1, 1)
434: #define io_write(f, b, n) io_rwrite(f, b, n, -1, 1)
435:
436:
437: /* Debug helper macros */
438: extern int io_Debug;
439:
440: #define io_initDebug(x) io_Debug = (x);
441: #define io_addDebug io_Debug++
442: #define ioDEBUG(x, fmt, ...) do { \
443: assert((fmt)); \
444: char str[STRSIZ] = { 0 }; \
445: snprintf(str, STRSIZ, (fmt), ##__VA_ARGS__); \
446: if ((x) <= io_Debug) \
447: syslog(LOG_DEBUG, "ioDebug(%d):%s(%d): %s\n", \
448: (x), __func__, __LINE__, str); \
449: } while (0)
450:
451: #define ioERROR(x, fmt, ...) do { \
452: assert((fmt)); \
453: char str[STRSIZ] = { 0 }; \
454: snprintf(str, STRSIZ, (fmt), ##__VA_ARGS__); \
455: syslog(LOG_ERR, "ioError():%s(%d): #%d - %s\n", \
456: __func__, __LINE__, (x), str); \
457: } while (0)
458: #define io_sysERROR(x) do { \
459: if (x > 0 || errno) \
460: syslog(LOG_ERR, "ioError(sys):%s(%d): #%d - %s\n", \
461: __func__, __LINE__, x > 0 ? x : errno, \
462: strerror(x > 0 ? x : errno)); \
463: } while (0)
464: #define io_aitERROR(ait) do { \
465: if (ait##_GetErrno()) \
466: syslog(LOG_ERR, "ioError(ait):%s(%d): #%d - %s\n", \
467: __func__, __LINE__, ait##_GetErrno(), \
468: ait##_GetError()); \
469: } while (0)
1.3 misho 470:
1.1 misho 471:
1.7 misho 472: /* Crypto framework */
473:
474: /*
475: * ioCipher() Cipher wrapper for all supported crypto algorythms
476: * @pInput = input buffer
477: * @inLen = input buffer len
478: * @ppOutput = output allocated buffe, must be free after use
479: * @Cipher = cipher engine, like EVP_bf_cbc() or etc...
480: * @pKey = key
481: * @pIV = IV, salt (8 bytes)
482: * @nMode = Mode 0 - decrypting or 1 - encrypting
483: * return: 0 not present data or error!; >0 number of processed and returned bytes into ppOutput
484: */
485: int ioCipher(unsigned char *pInput, int inLen, unsigned char **ppOutput, const EVP_CIPHER *Cipher,
486: unsigned char *pKey, unsigned char *pIV, int nMode);
487:
488: /*
489: * io_Blowfish() Blowfish cipher algorythm, work with ASCII hex strings
490: * @pInput = input buffer
491: * @inLen = input buffer len
492: * @ppOutput = output allocated buffe, must be free after use
493: * @pKey = key
494: * @pIV = IV, salt (8 bytes)
495: * @nMode = Mode 0 - decrypting or 1 - encrypting
496: * return: 0 not present data or error!; >0 number of processed and returned bytes into ppOutput
497: */
1.8 misho 498: int io_Blowfish(unsigned char *pInput, int inLen, unsigned char **ppOutput,
499: unsigned char *pKey, unsigned char *pIV, int nMode);
1.7 misho 500:
501:
1.1 misho 502: #endif
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>
![[BACK]](/icons/cvsweb/back.gif){kind=icon}
Return to aitio.h CVS log ![[TXT]](/icons/cvsweb/text.gif){kind=icon}
![[DIR]](/icons/cvsweb/dir.gif){kind=icon}
Up to [ELWIX - Embedded LightWeight unIX -] / libaitio / inc