Annotation of libaitio/inc/aitio.h, revision 1.9.2.2
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.9.2.2 ! misho 6: * $Id: aitio.h,v 1.9.2.1 2011/05/17 19:49:55 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.9 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)
1.9 misho 263: #define io_arrayDel(_arr, _d) do { \
264: assert(_arr && _arr->arr_num > _d); \
265: *(_arr->arr_data + _d) = NULL; \
266: } while (0)
1.8 misho 267:
268: /*
269: * io_arrayPush() - Push element into dynamic array like stack manner, place at first empty position
270: * @arr = Array
271: * @data = Element, if set NULL return only first empty position
272: * return: -1 not found empty position, array is full!, >-1 return position of stored element into array
273: */
274: inline int io_arrayPush(array_t * __restrict arr, void **data);
275: /*
276: * io_arrayPop() - Pop element from dynamic array like stack manner, last used position
277: * @arr = Array
278: * @data = Element, if set NULL return only first empty position
279: * @delAfter = Delete after Pop element, !=0 delete element from array after return data
280: * return: -1 not found used position, array is empty!, >-1 return element position
281: */
282: inline int io_arrayPop(array_t * __restrict arr, void ** __restrict data, int delAfter);
283:
284: /*
285: * io_argsNum() Parse and calculate number of arguments
286: * @csArgs = Input arguments line
287: * @csDelim = Delimiter(s) for separate
288: * return: 0 error format; -1 error:: can`t read; >0 ok, number of items
289: */
290: inline int io_argsNum(const char *csArgs, const char *csDelim);
291:
292: /*
293: * io_arrayMake() Parse and make array from arguments ... (input string will be modified!!!
294: * and output array must be free with io_arrayDestroy() after use!)
295: * @psArgs = Input arguments line, after execute string is modified!!!
296: * @nargs = Maximum requested count of arguments from input string psArgs, if 0 all psArgs
297: * @csDelim = Delimiter(s) for separate
298: * @parr = Output array of arguments ... (must be free with io_arrayDestroy() after use!)
299: * return: 0 error format; -1 error:: can`t read; >0 ok, number of readed items
300: */
301: int io_arrayMake(char * __restrict psArgs, int nargs, const char *csDelim,
302: array_t ** __restrict parr);
303:
304: /*
305: * io_MakeAV() Parse and make attribute/value pair
306: * @csArgs = Input argument line
307: * @csDelim = Delimiter for separate
308: * @psAttr = Output Attribute
309: * @attrLen = Size of attribute array
310: * @psValue = Output Value, if ==NULL this element not present value or not wanted for return
311: * @valLen = Size of value array
312: * return: 0 error format; -1 error:: can`t read; >0 ok, number of readed items
313: */
314: int io_MakeAV(const char * __restrict csArgs, const char *csDelim,
315: char * __restrict psAttr, int attrLen, char * __restrict psValue, int valLen);
316:
1.9 misho 317: /*
318: * io_sarrInit() - Create and initialize dynamic split-order array
319: * @numItems = Number of Items
320: * @segLen = Length of segment
321: * return: NULL error, != NULL allocated memory for array
322: */
323: inline sarr_t *io_sarrInit(int numItems, int segLen);
324: /*
325: * io_sarrDestroy() - Free all data in dynamic split-order array and Destroy array
326: * @parr = Array
327: * return: none
328: */
329: inline void io_sarrDestroy(sarr_t ** __restrict parr);
330: /*
331: * io_sarrGrow() - Grow/Shrink dynamic split-order array, Use with care when it shrink!!!
332: * @arr = Array
333: * @newNumItems = Number of Items
334: * return: -1 error, 0 ok
335: */
336: int io_sarrGrow(sarr_t * __restrict arr, int newNumItems);
337: /*
338: * io_sarrVacuum() - Vacuum dynamic split-order array, empty segments will be freed
339: * @arr = Array
340: * return: -1 error, >-1 freed segments
341: */
342: inline int io_sarrVacuum(sarr_t * __restrict arr);
343: #define io_sarrSize(_arr) ((assert(_arr)), _arr->sarr_num)
344: /*
345: * io_sarrGet() - Get element from dynamic split-order array
346: * @arr = Array
347: * @idx = Index (warning 1st element is at position 1)
348: * return: NULL not found, !=NULL element
349: */
350: inline void *io_sarrGet(sarr_t * __restrict arr, unsigned int idx);
351: /*
352: * io_sarrGet2() - Always get element from dynamic split-order array
353: * Function automatic grow array. Good use for Hash tables!
354: * @arr = Array
355: * @idx = Index (warning 1st element is at position 1)
356: * return: NULL not found, !=NULL element
357: */
358: void *io_sarrGet2(sarr_t * __restrict arr, unsigned int idx);
359: /*
360: * io_sarrSet() - Set element to dynamic split-order array
361: * @arr = Array
362: * @idx = Index (warning 1st element is at position 1)
363: * @data = Value
364: * return: NULL error or empty, !=NULL old value in element
365: */
366: inline void *io_sarrSet(sarr_t * __restrict arr, unsigned int idx, void *data);
367: #define io_sarrDel(_arr, _idx) io_sarrSet(_arr, _idx, NULL)
368: #define io_sarr(_arr, _idx, _type) (_type)io_sarrGet(_arr, _idx)
1.8 misho 369:
370: /*
1.9.2.1 misho 371: * io_CopyEnv() Copy environment to new environment array;
372: * @oldenv = Environment array
373: * return: NULL error; !=NULL Allocated new environment array(must be free)
374: */
375: char **io_CopyEnv(const char **oldenv);
1.9.2.2 ! misho 376: /*
! 377: * io_ExecArgs() Build exec arguments from other array
! 378: * @psProg = Program name for execute
! 379: * @oldarg = Arguments array
! 380: * return: NULL error; !=NULL Allocated execution array(must be free)
! 381: */
! 382: char **io_ExecArgs(const char *psProg, const char **oldarg);
! 383: /*
! 384: * io_FreeNullTerm() Free dynamic allocated null terminated array with strings
! 385: * @arr = Pointer to array for free
! 386: * return: none
! 387: */
! 388: inline void io_FreeNullTerm(char *** __restrict arr);
1.9.2.1 misho 389:
390: /*
1.2 misho 391: * ioURLGet() Parse and get data from input URL
392: * @csURL = Input URL line
393: * @url = Output parsed URL
394: * return: 0 error format not find tech:// and return URL like path;
395: -1 error:: can`t read; >0 ok, up bits for known elements
396: */
397: int ioURLGet(const char *csURL, struct tagIOURL *url);
398: /*
399: * ioURLGetValue() Get value from parsed URL
400: * @url = Input parsed URL
401: * @csAttr = Attribute for search
402: * @psValue = Return value of attribute, if ==NULL only check for existence of attribute
403: * @valLen = Size of psValue array
404: * return: 0 error attribute not find; -1 error:: can`t read; >0 ok, find at position
405: */
406: int ioURLGetValue(struct tagIOURL *url, const char *csAttr, char * __restrict psValue, int valLen);
407: /*
408: * ioURLGetFile() Get file from parsed URL
409: * @url = Input parsed URL
410: * @psValue = Return filename, if not specified file in url path, replace with /
411: * @valLen = Size of psValue array
412: * return: -1 error:: can`t read; 0 ok
413: */
414: int ioURLGetFile(struct tagIOURL *url, char * __restrict psValue, int valLen);
415:
1.3 misho 416:
417: /*
1.6 misho 418: * ioXMLGet() Parse and get data from input XML request string [ns:]container[|attribute[=value]][?data]
419: * @csXML = Input XML request line
420: * @xml = Output parsed XML request
421: * return: 0 error format incorrect, -1 error:: can`t read; >0 ok readed elements bits
422: */
423: int ioXMLGet(const char *csXML, struct tagReqXML *xml);
424:
425:
426: /*
1.5 misho 427: * ioMkDir() Function for racursive directory creation and validation
428: * @csDir = Full directory path
429: * @mode = Mode for directory creation if missing dir
430: * return: -1 error, 0 directory path exist, >0 created missing dirs
431: */
432: int ioMkDir(const char *csDir, int mode);
433:
1.6 misho 434: /*
435: * ioWatchDirLoop() Function for watching changes in directory and fire callback
436: * @csDir = Full directory path
437: * @callback = Callback if raise event! nOp -1 delete, 0 change/move, 1 create
438: * return: -1 error, !=-1 ok, number of total signaled events
439: */
440: int ioWatchDirLoop(const char *csDir, int (*callback)(const char *csName, int nOp));
441:
1.5 misho 442:
443: /*
444: * io_rread() Raw VFS read function
445: * @fd = File handle
446: * @buf = Read buffer
447: * @nbytes = Read buffer size
448: * @offset = Read from position, if -1 read nbytes from current position
449: * @update = Update file handle position !0
450: * return: -1 error or !=-1 readed bytes
451: */
452: inline int io_rread(int fd, void * __restrict buf, size_t nbytes, off_t offset, int update);
453: /*
454: * io_rwrite() Raw VFS write function
455: * @fd = File handle
456: * @buf = Write buffer
457: * @nbytes = Write bytes from buffer
458: * @offset = Write at position, if -1 write nbytes from current position
459: * @update = Update file handle position !0
460: * return: -1 error or !=-1 writed bytes
461: */
462: inline int io_rwrite(int fd, void * __restrict buf, size_t nbytes, off_t offset, int update);
463:
464: /* Disk I/O helper macros */
465: #define io_read(f, b, n) io_rread(f, b, n, -1, 1)
466: #define io_write(f, b, n) io_rwrite(f, b, n, -1, 1)
467:
468:
469: /* Debug helper macros */
470: extern int io_Debug;
471:
472: #define io_initDebug(x) io_Debug = (x);
473: #define io_addDebug io_Debug++
474: #define ioDEBUG(x, fmt, ...) do { \
475: assert((fmt)); \
476: char str[STRSIZ] = { 0 }; \
477: snprintf(str, STRSIZ, (fmt), ##__VA_ARGS__); \
478: if ((x) <= io_Debug) \
479: syslog(LOG_DEBUG, "ioDebug(%d):%s(%d): %s\n", \
480: (x), __func__, __LINE__, str); \
481: } while (0)
482:
483: #define ioERROR(x, fmt, ...) do { \
484: assert((fmt)); \
485: char str[STRSIZ] = { 0 }; \
486: snprintf(str, STRSIZ, (fmt), ##__VA_ARGS__); \
487: syslog(LOG_ERR, "ioError():%s(%d): #%d - %s\n", \
488: __func__, __LINE__, (x), str); \
489: } while (0)
490: #define io_sysERROR(x) do { \
491: if (x > 0 || errno) \
492: syslog(LOG_ERR, "ioError(sys):%s(%d): #%d - %s\n", \
493: __func__, __LINE__, x > 0 ? x : errno, \
494: strerror(x > 0 ? x : errno)); \
495: } while (0)
496: #define io_aitERROR(ait) do { \
497: if (ait##_GetErrno()) \
498: syslog(LOG_ERR, "ioError(ait):%s(%d): #%d - %s\n", \
499: __func__, __LINE__, ait##_GetErrno(), \
500: ait##_GetError()); \
501: } while (0)
1.3 misho 502:
1.1 misho 503:
1.7 misho 504: /* Crypto framework */
505:
506: /*
507: * ioCipher() Cipher wrapper for all supported crypto algorythms
508: * @pInput = input buffer
509: * @inLen = input buffer len
510: * @ppOutput = output allocated buffe, must be free after use
511: * @Cipher = cipher engine, like EVP_bf_cbc() or etc...
512: * @pKey = key
513: * @pIV = IV, salt (8 bytes)
514: * @nMode = Mode 0 - decrypting or 1 - encrypting
515: * return: 0 not present data or error!; >0 number of processed and returned bytes into ppOutput
516: */
517: int ioCipher(unsigned char *pInput, int inLen, unsigned char **ppOutput, const EVP_CIPHER *Cipher,
518: unsigned char *pKey, unsigned char *pIV, int nMode);
519:
520: /*
521: * io_Blowfish() Blowfish cipher algorythm, work with ASCII hex strings
522: * @pInput = input buffer
523: * @inLen = input buffer len
524: * @ppOutput = output allocated buffe, must be free after use
525: * @pKey = key
526: * @pIV = IV, salt (8 bytes)
527: * @nMode = Mode 0 - decrypting or 1 - encrypting
528: * return: 0 not present data or error!; >0 number of processed and returned bytes into ppOutput
529: */
1.8 misho 530: int io_Blowfish(unsigned char *pInput, int inLen, unsigned char **ppOutput,
531: unsigned char *pKey, unsigned char *pIV, int nMode);
1.7 misho 532:
533:
1.1 misho 534: #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