--- libaitcli/src/aitcli.c 2011/05/29 22:49:25 1.4 +++ libaitcli/src/aitcli.c 2013/09/02 11:26:36 1.8 @@ -3,7 +3,7 @@ * by Michael Pounov * * $Author: misho $ -* $Id: aitcli.c,v 1.4 2011/05/29 22:49:25 misho Exp $ +* $Id: aitcli.c,v 1.8 2013/09/02 11:26:36 misho Exp $ * ************************************************************************** The ELWIX and AITNET software is distributed under the following @@ -12,7 +12,7 @@ terms: All of the documentation and software included in the ELWIX and AITNET Releases is copyrighted by ELWIX - Sofia/Bulgaria -Copyright 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011 +Copyright 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013 by Michael Pounov . All rights reserved. Redistribution and use in source and binary forms, with or without @@ -49,37 +49,35 @@ SUCH DAMAGE. #pragma GCC visibility push(hidden) -// ------------------------------------------------ - int cli_Errno; char cli_Error[STRSIZ]; #pragma GCC visibility pop // cli_GetErrno() Get error code of last operation -inline int +int cli_GetErrno() { return cli_Errno; } -// io_GetError() Get error text of last operation -inline const char * +// cli_GetError() Get error text of last operation +const char * cli_GetError() { return cli_Error; } // cli_SetErr() Set error to variables for internal use!!! -inline void +void cli_SetErr(int eno, char *estr, ...) { va_list lst; cli_Errno = eno; - memset(cli_Error, 0, STRSIZ); + memset(cli_Error, 0, sizeof cli_Error); va_start(lst, estr); - vsnprintf(cli_Error, STRSIZ, estr, lst); + vsnprintf(cli_Error, sizeof cli_Error, estr, lst); va_end(lst); } @@ -138,12 +136,12 @@ printfNL(linebuffer_t * __restrict buf, int prompt) // ------------------------------------------------------------ static int -bufCHAR(int idx, void * __restrict buffer) +bufCHAR(int idx, void * __restrict cli_buffer) { - linebuffer_t *buf = buffer; + linebuffer_t *buf = cli_buffer; int pos; - if (!buffer || idx < 0 || idx > MAX_BINDKEY) + if (!cli_buffer || idx < 0 || idx > MAX_BINDKEY) return RETCODE_ERR; pos = buf->line_eol - buf->line_bol; @@ -169,20 +167,20 @@ bufCHAR(int idx, void * __restrict buffer) } static int -bufEOL(int idx, void * __restrict buffer) +bufEOL(int idx, void * __restrict cli_buffer) { - if (!buffer || idx < 0 || idx > MAX_BINDKEY) + if (!cli_buffer || idx < 0 || idx > MAX_BINDKEY) return RETCODE_ERR; - printfCR(buffer, 1); + printfCR(cli_buffer, 1); return RETCODE_EOL; } static int -bufEOF(int idx, void * __restrict buffer) +bufEOF(int idx, void * __restrict cli_buffer) { /* - if (!buffer || idx < 0 || idx > MAX_BINDKEY) + if (!cli_buffer || idx < 0 || idx > MAX_BINDKEY) return RETCODE_ERR; */ @@ -190,12 +188,12 @@ bufEOF(int idx, void * __restrict buffer) } static int -bufUP(int idx, void * __restrict buffer) +bufUP(int idx, void * __restrict cli_buffer) { - linebuffer_t *buf = buffer; + linebuffer_t *buf = cli_buffer; int pos; - if (!buffer || idx < 0 || idx > MAX_BINDKEY) + if (!cli_buffer || idx < 0 || idx > MAX_BINDKEY) return RETCODE_ERR; if (!buf->line_h) @@ -221,12 +219,12 @@ bufUP(int idx, void * __restrict buffer) } static int -bufDOWN(int idx, void * __restrict buffer) +bufDOWN(int idx, void * __restrict cli_buffer) { - linebuffer_t *buf = buffer; + linebuffer_t *buf = cli_buffer; int pos; - if (!buffer || idx < 0 || idx > MAX_BINDKEY) + if (!cli_buffer || idx < 0 || idx > MAX_BINDKEY) return RETCODE_ERR; if (!buf->line_h) @@ -252,24 +250,24 @@ bufDOWN(int idx, void * __restrict buffer) } static int -bufCLR(int idx, void * __restrict buffer) +bufCLR(int idx, void * __restrict cli_buffer) { - if (!buffer || idx < 0 || idx > MAX_BINDKEY) + if (!cli_buffer || idx < 0 || idx > MAX_BINDKEY) return RETCODE_ERR; - clrscrEOL(buffer); - cli_freeLine(buffer); + clrscrEOL(cli_buffer); + cli_freeLine(cli_buffer); - printfCR(buffer, 1); + printfCR(cli_buffer, 1); return RETCODE_OK; } static int -bufBS(int idx, void * __restrict buffer) +bufBS(int idx, void * __restrict cli_buffer) { - linebuffer_t *buf = buffer; + linebuffer_t *buf = cli_buffer; - if (!buffer || idx < 0 || idx > MAX_BINDKEY) + if (!cli_buffer || idx < 0 || idx > MAX_BINDKEY) return RETCODE_ERR; if (buf->line_bol < buf->line_eol) { @@ -290,11 +288,11 @@ bufBS(int idx, void * __restrict buffer) } static int -bufBTAB(int idx, void * __restrict buffer) +bufBTAB(int idx, void * __restrict cli_buffer) { - linebuffer_t *buf = buffer; + linebuffer_t *buf = cli_buffer; - if (!buffer || idx < 0 || idx > MAX_BINDKEY) + if (!cli_buffer || idx < 0 || idx > MAX_BINDKEY) return RETCODE_ERR; if (buf->line_bol < buf->line_eol) { @@ -310,11 +308,11 @@ bufBTAB(int idx, void * __restrict buffer) } static int -bufMODE(int idx, void * __restrict buffer) +bufMODE(int idx, void * __restrict cli_buffer) { - linebuffer_t *buf = buffer; + linebuffer_t *buf = cli_buffer; - if (!buffer || idx < 0 || idx > MAX_BINDKEY) + if (!cli_buffer || idx < 0 || idx > MAX_BINDKEY) return RETCODE_ERR; buf->line_mode = !buf->line_mode ? LINEMODE_OVER : LINEMODE_INS; @@ -322,11 +320,11 @@ bufMODE(int idx, void * __restrict buffer) } static int -bufBEGIN(int idx, void * __restrict buffer) +bufBEGIN(int idx, void * __restrict cli_buffer) { - linebuffer_t *buf = buffer; + linebuffer_t *buf = cli_buffer; - if (!buffer || idx < 0 || idx > MAX_BINDKEY) + if (!cli_buffer || idx < 0 || idx > MAX_BINDKEY) return RETCODE_ERR; buf->line_eol = buf->line_bol; @@ -336,11 +334,11 @@ bufBEGIN(int idx, void * __restrict buffer) } static int -bufEND(int idx, void * __restrict buffer) +bufEND(int idx, void * __restrict cli_buffer) { - linebuffer_t *buf = buffer; + linebuffer_t *buf = cli_buffer; - if (!buffer || idx < 0 || idx > MAX_BINDKEY) + if (!cli_buffer || idx < 0 || idx > MAX_BINDKEY) return RETCODE_ERR; buf->line_eol = buf->line_len - 1; @@ -350,11 +348,11 @@ bufEND(int idx, void * __restrict buffer) } static int -bufLEFT(int idx, void * __restrict buffer) +bufLEFT(int idx, void * __restrict cli_buffer) { - linebuffer_t *buf = buffer; + linebuffer_t *buf = cli_buffer; - if (!buffer || idx < 0 || idx > MAX_BINDKEY) + if (!cli_buffer || idx < 0 || idx > MAX_BINDKEY) return RETCODE_ERR; if (buf->line_bol < buf->line_eol) @@ -364,11 +362,11 @@ bufLEFT(int idx, void * __restrict buffer) } static int -bufRIGHT(int idx, void * __restrict buffer) +bufRIGHT(int idx, void * __restrict cli_buffer) { - linebuffer_t *buf = buffer; + linebuffer_t *buf = cli_buffer; - if (!buffer || idx < 0 || idx > MAX_BINDKEY) + if (!cli_buffer || idx < 0 || idx > MAX_BINDKEY) return RETCODE_ERR; if (buf->line_eol < buf->line_len - 1) @@ -378,11 +376,11 @@ bufRIGHT(int idx, void * __restrict buffer) } static int -bufDEL(int idx, void * __restrict buffer) +bufDEL(int idx, void * __restrict cli_buffer) { - linebuffer_t *buf = buffer; + linebuffer_t *buf = cli_buffer; - if (!buffer || idx < 0 || idx > MAX_BINDKEY) + if (!cli_buffer || idx < 0 || idx > MAX_BINDKEY) return RETCODE_ERR; clrscrEOL(buf); @@ -400,23 +398,23 @@ bufDEL(int idx, void * __restrict buffer) } static int -bufComp(int idx, void * __restrict buffer) +bufComp(int idx, void * __restrict cli_buffer) { - linebuffer_t *buf = buffer; + linebuffer_t *buf = cli_buffer; char *str, *s, **app, *items[MAX_PROMPT_ITEMS], szLine[STRSIZ]; register int i, j; struct tagCommand *cmd, *c; int pos, ret = RETCODE_OK; - if (!buffer || idx < 0 || idx > MAX_BINDKEY) + if (!cli_buffer || idx < 0 || idx > MAX_BINDKEY) return RETCODE_ERR; - str = strdup(buf->line_buf); + str = e_strdup(buf->line_buf); if (!str) return RETCODE_ERR; else { s = str; - io_TrimStr((u_char*) s); + str_Trim(s); } i = j = 0; @@ -488,16 +486,16 @@ bufComp(int idx, void * __restrict buffer) } endcomp: - free(str); + e_free(str); return ret; } static int -bufHelp(int idx, void * __restrict buffer) +bufHelp(int idx, void * __restrict cli_buffer) { - linebuffer_t *buf = buffer; + linebuffer_t *buf = cli_buffer; - if (!buffer || idx < 0 || idx > MAX_BINDKEY) + if (!cli_buffer || idx < 0 || idx > MAX_BINDKEY) return RETCODE_ERR; cli_Cmd_Help(buf, -1, NULL); @@ -507,23 +505,23 @@ bufHelp(int idx, void * __restrict buffer) return RETCODE_OK; } -// --------------------------------------------------------------- /* - * cli_Printf() Send message to CLI session - * @buffer = CLI buffer + * cli_Printf() - Send message to CLI session + * + * @cli_buffer = CLI buffer * @fmt = printf format string * @... = arguments defined in fmt * return: none */ -inline void -cli_Printf(linebuffer_t * __restrict buffer, char *fmt, ...) +void +cli_Printf(linebuffer_t * __restrict cli_buffer, char *fmt, ...) { va_list lst; FILE *f; if (fmt) { - f = fdopen(buffer->line_out, "a"); + f = fdopen(cli_buffer->line_out, "a"); if (!f) { LOGERR; return; @@ -533,45 +531,48 @@ cli_Printf(linebuffer_t * __restrict buffer, char *fmt vfprintf(f, fmt, lst); va_end(lst); } else - cli_SetErr(EINVAL, "Error:: invalid input parameters ..."); + cli_SetErr(EINVAL, "Invalid input parameters ..."); } /* - * cli_PrintHelp() Print help screen - * @buffer = CLI buffer + * cli_PrintHelp() - Print help screen + * + * @cli_buffer = CLI buffer * return: none */ -inline void -cli_PrintHelp(linebuffer_t * __restrict buffer) +void +cli_PrintHelp(linebuffer_t * __restrict cli_buffer) { - if (buffer) { - bufHelp(0, buffer); - clrscrEOL(buffer); + if (cli_buffer) { + bufHelp(0, cli_buffer); + clrscrEOL(cli_buffer); } else - cli_SetErr(EINVAL, "Error:: invalid input parameters ..."); + cli_SetErr(EINVAL, "Invalid input parameters ..."); } /* - * cli_BindKey() Bind function to key + * cli_BindKey() - Bind function to key + * * @key = key structure - * @buffer = CLI buffer + * @cli_buffer = CLI buffer * return: RETCODE_ERR error, RETCODE_OK ok, >0 bind at position */ int -cli_BindKey(bindkey_t * __restrict key, linebuffer_t * __restrict buffer) +cli_BindKey(bindkey_t * __restrict key, linebuffer_t * __restrict cli_buffer) { register int i; - if (!key || !buffer) { - cli_SetErr(EINVAL, "Error:: invalid input parameters ..."); + if (!key || !cli_buffer) { + cli_SetErr(EINVAL, "Invalid input parameters ..."); return RETCODE_ERR; } for (i = 0; i < MAX_BINDKEY; i++) - if (key->key_len == buffer->line_keys[i].key_len && - !memcmp(key->key_ch, buffer->line_keys[i].key_ch, key->key_len)) { - buffer->line_keys[i].key_func = key->key_func; + if (key->key_len == cli_buffer->line_keys[i].key_len && + !memcmp(key->key_ch, cli_buffer->line_keys[i].key_ch, + key->key_len)) { + cli_buffer->line_keys[i].key_func = key->key_func; return i; } @@ -580,8 +581,9 @@ cli_BindKey(bindkey_t * __restrict key, linebuffer_t * /* - * cli_addCommand() Add command to CLI session - * @buffer = CLI buffer + * cli_addCommand() - Add command to CLI session + * + * @cli_buffer = CLI buffer * @csCmd = Command name * @cliLevel = Level in CLI, -1 unprivi(view from all), 0 main config, 1 sub config ... * @funcCmd = Callback function when user call command @@ -590,17 +592,18 @@ cli_BindKey(bindkey_t * __restrict key, linebuffer_t * * return: RETCODE_ERR error, RETCODE_OK ok */ int -cli_addCommand(linebuffer_t * __restrict buffer, const char *csCmd, int cliLevel, cmd_func_t funcCmd, +cli_addCommand(linebuffer_t * __restrict cli_buffer, const char *csCmd, + int cliLevel, cmd_func_t funcCmd, const char *csInfo, const char *csHelp) { struct tagCommand *cmd; - if (!buffer || !csCmd) { - cli_SetErr(EINVAL, "Error:: invalid input parameters ..."); + if (!cli_buffer || !csCmd) { + cli_SetErr(EINVAL, "Invalid input parameters ..."); return RETCODE_ERR; } - cmd = malloc(sizeof(struct tagCommand)); + cmd = e_malloc(sizeof(struct tagCommand)); if (!cmd) { LOGERR; return RETCODE_ERR; @@ -614,33 +617,34 @@ cli_addCommand(linebuffer_t * __restrict buffer, const strlcpy(cmd->cmd_info, csInfo, STRSIZ); if (csHelp) strlcpy(cmd->cmd_help, csHelp, STRSIZ); - SLIST_INSERT_HEAD(&buffer->line_cmds, cmd, cmd_next); + SLIST_INSERT_HEAD(&cli_buffer->line_cmds, cmd, cmd_next); return RETCODE_OK; } /* - * cli_delCommand() Delete command from CLI session - * @buffer = CLI buffer + * cli_delCommand() - Delete command from CLI session + * + * @cli_buffer = CLI buffer * @csCmd = Command name * @cliLevel = Level in CLI, -1 unprivi(view from all), 0 main config, 1 sub config ... * return: RETCODE_ERR error, RETCODE_OK ok */ int -cli_delCommand(linebuffer_t * __restrict buffer, const char *csCmd, int cliLevel) +cli_delCommand(linebuffer_t * __restrict cli_buffer, const char *csCmd, int cliLevel) { struct tagCommand *cmd; int ret = RETCODE_OK; - if (!buffer || !csCmd) { - cli_SetErr(EINVAL, "Error:: invalid input parameters ..."); + if (!cli_buffer || !csCmd) { + cli_SetErr(EINVAL, "Invalid input parameters ..."); return RETCODE_ERR; } - SLIST_FOREACH(cmd, &buffer->line_cmds, cmd_next) + SLIST_FOREACH(cmd, &cli_buffer->line_cmds, cmd_next) if (cmd->cmd_level == cliLevel && !strcmp(cmd->cmd_name, csCmd)) { ret = 1; - SLIST_REMOVE(&buffer->line_cmds, cmd, tagCommand, cmd_next); - free(cmd); + SLIST_REMOVE(&cli_buffer->line_cmds, cmd, tagCommand, cmd_next); + e_free(cmd); break; } @@ -648,8 +652,9 @@ cli_delCommand(linebuffer_t * __restrict buffer, const } /* - * cli_updCommand() Update command in CLI session - * @buffer = CLI buffer + * cli_updCommand() - Update command in CLI session + * + * @cli_buffer = CLI buffer * @csCmd = Command name * @cliLevel = Level in CLI, -1 unprivi(view from all), 0 main config, 1 sub config ... * @funcCmd = Callback function when user call command @@ -658,18 +663,19 @@ cli_delCommand(linebuffer_t * __restrict buffer, const * return: RETCODE_ERR error, RETCODE_OK ok */ int -cli_updCommand(linebuffer_t * __restrict buffer, const char *csCmd, int cliLevel, cmd_func_t funcCmd, +cli_updCommand(linebuffer_t * __restrict cli_buffer, const char *csCmd, + int cliLevel, cmd_func_t funcCmd, const char *csInfo, const char *csHelp) { struct tagCommand *cmd; int ret = RETCODE_OK; - if (!buffer || !csCmd) { - cli_SetErr(EINVAL, "Error:: invalid input parameters ..."); + if (!cli_buffer || !csCmd) { + cli_SetErr(EINVAL, "Invalid input parameters ..."); return RETCODE_ERR; } - SLIST_FOREACH(cmd, &buffer->line_cmds, cmd_next) + SLIST_FOREACH(cmd, &cli_buffer->line_cmds, cmd_next) if (cmd->cmd_level == cliLevel && !strcmp(cmd->cmd_name, csCmd)) { ret = 1; @@ -688,22 +694,23 @@ cli_updCommand(linebuffer_t * __restrict buffer, const /* - * cli_addHistory() Add line to history - * @buffer = CLI buffer + * cli_addHistory() - Add line to history + * + * @cli_buffer = CLI buffer * @str = Add custom text or if NULL use readed line from CLI buffer * return: RETCODE_ERR error, RETCODE_OK ok */ int -cli_addHistory(linebuffer_t * __restrict buffer, const char * __restrict str) +cli_addHistory(linebuffer_t * __restrict cli_buffer, const char * __restrict str) { struct tagHistory *h; - if (!buffer) { - cli_SetErr(EINVAL, "Error:: invalid input parameters ..."); + if (!cli_buffer) { + cli_SetErr(EINVAL, "Invalid input parameters ..."); return RETCODE_ERR; } - if (!(h = malloc(sizeof(struct tagHistory)))) { + if (!(h = e_malloc(sizeof(struct tagHistory)))) { LOGERR; return RETCODE_ERR; } else @@ -711,43 +718,44 @@ cli_addHistory(linebuffer_t * __restrict buffer, const if (str) { if (!*str) { - free(h); + e_free(h); return RETCODE_OK; } h->hist_len = strlcpy(h->hist_line, str, BUFSIZ); } else { - if (!*buffer->line_buf || buffer->line_len < 2) { - free(h); + if (!*cli_buffer->line_buf || cli_buffer->line_len < 2) { + e_free(h); return RETCODE_OK; } - memcpy(h->hist_line, buffer->line_buf, (h->hist_len = buffer->line_len)); - io_TrimStr((u_char*) h->hist_line); + memcpy(h->hist_line, cli_buffer->line_buf, (h->hist_len = cli_buffer->line_len)); + str_Trim(h->hist_line); h->hist_len = strlen(h->hist_line); } - TAILQ_INSERT_HEAD(&buffer->line_history, h, hist_next); + TAILQ_INSERT_HEAD(&cli_buffer->line_history, h, hist_next); return h->hist_len; } /* - * cli_saveHistory() Save history to file - * @buffer = CLI buffer + * cli_saveHistory() - Save history to file + * + * @cli_buffer = CLI buffer * @histfile = History filename, if NULL will be use default name * @lines = Maximum history lines to save * return: RETCODE_ERR error, RETCODE_OK ok */ int -cli_saveHistory(linebuffer_t * __restrict buffer, const char *histfile, int lines) +cli_saveHistory(linebuffer_t * __restrict cli_buffer, const char *histfile, int lines) { FILE *f; mode_t mode; char szFName[MAXPATHLEN]; struct tagHistory *h; - if (!buffer) { - cli_SetErr(EINVAL, "Error:: invalid input parameters ..."); + if (!cli_buffer) { + cli_SetErr(EINVAL, "Invalid input parameters ..."); return RETCODE_ERR; } if (!histfile) @@ -762,7 +770,7 @@ cli_saveHistory(linebuffer_t * __restrict buffer, cons return RETCODE_ERR; } - TAILQ_FOREACH(h, &buffer->line_history, hist_next) { + TAILQ_FOREACH(h, &cli_buffer->line_history, hist_next) { fprintf(f, "%s\n", h->hist_line); if (lines) @@ -778,20 +786,21 @@ cli_saveHistory(linebuffer_t * __restrict buffer, cons } /* - * cli_loadHistory() Load history from file - * @buffer = CLI buffer + * cli_loadHistory() - Load history from file + * + * @cli_buffer = CLI buffer * @histfile = History filename, if NULL will be use default name * return: RETCODE_ERR error, RETCODE_OK ok */ int -cli_loadHistory(linebuffer_t * __restrict buffer, const char *histfile) +cli_loadHistory(linebuffer_t * __restrict cli_buffer, const char *histfile) { FILE *f; char szFName[MAXPATHLEN], buf[BUFSIZ]; struct tagHistory *h; - if (!buffer) { - cli_SetErr(EINVAL, "Error:: invalid input parameters ..."); + if (!cli_buffer) { + cli_SetErr(EINVAL, "Invalid input parameters ..."); return RETCODE_ERR; } if (!histfile) @@ -807,9 +816,9 @@ cli_loadHistory(linebuffer_t * __restrict buffer, cons if (!*buf || *buf == '#') continue; else - io_TrimStr((u_char*) buf); + str_Trim(buf); - if (!(h = malloc(sizeof(struct tagHistory)))) { + if (!(h = e_malloc(sizeof(struct tagHistory)))) { LOGERR; fclose(f); return RETCODE_ERR; @@ -817,7 +826,7 @@ cli_loadHistory(linebuffer_t * __restrict buffer, cons memset(h, 0, sizeof(struct tagHistory)); h->hist_len = strlcpy(h->hist_line, buf, BUFSIZ); - TAILQ_INSERT_TAIL(&buffer->line_history, h, hist_next); + TAILQ_INSERT_TAIL(&cli_buffer->line_history, h, hist_next); } fclose(f); @@ -826,113 +835,118 @@ cli_loadHistory(linebuffer_t * __restrict buffer, cons } /* - * cli_resetHistory() Reset history search in CLI session - * @buffer = CLI buffer + * cli_resetHistory() - Reset history search in CLI session + * + * @cli_buffer = CLI buffer * return: none */ -inline void -cli_resetHistory(linebuffer_t * __restrict buffer) +void +cli_resetHistory(linebuffer_t * __restrict cli_buffer) { - buffer->line_h = NULL; + cli_buffer->line_h = NULL; } /* - * cli_freeLine() Clear entire line - * @buffer = CLI buffer + * cli_freeLine() - Clear entire line + * + * @cli_buffer = CLI buffer * return: RETCODE_ERR error, RETCODE_OK ok */ -inline int -cli_freeLine(linebuffer_t * __restrict buffer) +int +cli_freeLine(linebuffer_t * __restrict cli_buffer) { int code = RETCODE_ERR; - if (buffer) { - if (buffer->line_buf) - free(buffer->line_buf); + if (cli_buffer) { + if (cli_buffer->line_buf) + e_free(cli_buffer->line_buf); - buffer->line_buf = malloc(BUFSIZ); - if (buffer->line_buf) { - memset(buffer->line_buf, 0, BUFSIZ); - buffer->line_eol = buffer->line_bol; - buffer->line_len = 1 + buffer->line_eol; + cli_buffer->line_buf = e_malloc(BUFSIZ); + if (cli_buffer->line_buf) { + memset(cli_buffer->line_buf, 0, BUFSIZ); + cli_buffer->line_eol = cli_buffer->line_bol; + cli_buffer->line_len = 1 + cli_buffer->line_eol; code = RETCODE_OK; } else LOGERR; } else - cli_SetErr(EINVAL, "Error:: invalid input parameters ..."); + cli_SetErr(EINVAL, "Invalid input parameters ..."); return code; } /* - * cli_setPrompt() Set new prompt for CLI session - * @buffer = CLI buffer + * cli_setPrompt() - Set new prompt for CLI session + * + * @cli_buffer = CLI buffer * @prompt = new text for prompt or if NULL disable prompt * return: none */ -inline void -cli_setPrompt(linebuffer_t * __restrict buffer, const char *prompt) +void +cli_setPrompt(linebuffer_t * __restrict cli_buffer, const char *prompt) { - if (buffer) { - if (buffer->line_prompt) { - free(buffer->line_prompt); - buffer->line_prompt = NULL; - buffer->line_bol = 0; + if (cli_buffer) { + if (cli_buffer->line_prompt) { + e_free(cli_buffer->line_prompt); + cli_buffer->line_prompt = NULL; + cli_buffer->line_bol = 0; } if (prompt) { - buffer->line_prompt = strdup(prompt); - if (buffer->line_prompt) { - buffer->line_bol = strlen(buffer->line_prompt); - buffer->line_eol = buffer->line_bol; - buffer->line_len = 1 + buffer->line_eol; + cli_buffer->line_prompt = e_strdup(prompt); + if (cli_buffer->line_prompt) { + cli_buffer->line_bol = strlen(cli_buffer->line_prompt); + cli_buffer->line_eol = cli_buffer->line_bol; + cli_buffer->line_len = 1 + cli_buffer->line_eol; } else LOGERR; } } else - cli_SetErr(EINVAL, "Error:: invalid input parameters ..."); + cli_SetErr(EINVAL, "Invalid input parameters ..."); } /* - * cliEnd() Clear data, Free resources and close CLI session - * @buffer = CLI buffer + * cliEnd() - Clear data, Free resources and close CLI session + * + * @cli_buffer = CLI buffer * return: RETCODE_ERR error, RETCODE_OK ok */ void -cliEnd(linebuffer_t * __restrict buffer) +cliEnd(linebuffer_t * __restrict cli_buffer) { struct tagHistory *h; struct tagCommand *c; - if (buffer) { - while ((c = SLIST_FIRST(&buffer->line_cmds))) { - SLIST_REMOVE_HEAD(&buffer->line_cmds, cmd_next); - free(c); + if (cli_buffer) { + while ((c = SLIST_FIRST(&cli_buffer->line_cmds))) { + SLIST_REMOVE_HEAD(&cli_buffer->line_cmds, cmd_next); + e_free(c); } - while ((h = TAILQ_FIRST(&buffer->line_history))) { - TAILQ_REMOVE(&buffer->line_history, h, hist_next); - free(h); + while ((h = TAILQ_FIRST(&cli_buffer->line_history))) { + TAILQ_REMOVE(&cli_buffer->line_history, h, hist_next); + e_free(h); } - if (buffer->line_prompt) - free(buffer->line_prompt); + if (cli_buffer->line_prompt) + e_free(cli_buffer->line_prompt); - if (buffer->line_keys) - free(buffer->line_keys); - if (buffer->line_buf) - free(buffer->line_buf); + if (cli_buffer->line_keys) + e_free(cli_buffer->line_keys); + if (cli_buffer->line_buf) + e_free(cli_buffer->line_buf); - free(buffer); - buffer = NULL; + e_free(cli_buffer); + cli_buffer = NULL; } else - cli_SetErr(EINVAL, "Error:: invalid input parameters ..."); + cli_SetErr(EINVAL, "Invalid input parameters ..."); } /* - * cliInit() Start CLI session, allocate memory for resources and bind keys + * cliInit() - Start CLI session, allocate memory for resources and bind keys + * * @fin = Input device handle * @fout = Output device handle * @prompt = text for prompt, if NULL disable prompt @@ -941,63 +955,64 @@ cliEnd(linebuffer_t * __restrict buffer) linebuffer_t * cliInit(int fin, int fout, const char *prompt) { - linebuffer_t *buffer; + linebuffer_t *cli_buffer; bindkey_t *keys; register int i; /* init buffer */ - buffer = malloc(sizeof(linebuffer_t)); - if (!buffer) { + cli_buffer = e_malloc(sizeof(linebuffer_t)); + if (!cli_buffer) { LOGERR; return NULL; } else { - memset(buffer, 0, sizeof(linebuffer_t)); + memset(cli_buffer, 0, sizeof(linebuffer_t)); - buffer->line_in = fin; - buffer->line_out = fout; + cli_buffer->line_in = fin; + cli_buffer->line_out = fout; - TAILQ_INIT(&buffer->line_history); - SLIST_INIT(&buffer->line_cmds); + TAILQ_INIT(&cli_buffer->line_history); + SLIST_INIT(&cli_buffer->line_cmds); if (prompt) { - buffer->line_prompt = strdup(prompt); - if (!buffer->line_prompt) { + cli_buffer->line_prompt = e_strdup(prompt); + if (!cli_buffer->line_prompt) { LOGERR; - free(buffer); + e_free(cli_buffer); return NULL; } else - buffer->line_eol = buffer->line_bol = strlen(buffer->line_prompt); + cli_buffer->line_eol = cli_buffer->line_bol = + strlen(cli_buffer->line_prompt); } } - buffer->line_buf = malloc(BUFSIZ); - if (!buffer->line_buf) { + cli_buffer->line_buf = e_malloc(BUFSIZ); + if (!cli_buffer->line_buf) { LOGERR; - if (buffer->line_prompt) - free(buffer->line_prompt); - free(buffer); + if (cli_buffer->line_prompt) + e_free(cli_buffer->line_prompt); + e_free(cli_buffer); return NULL; } else { - memset(buffer->line_buf, 0, BUFSIZ); - buffer->line_len = 1 + buffer->line_eol; + memset(cli_buffer->line_buf, 0, BUFSIZ); + cli_buffer->line_len = 1 + cli_buffer->line_eol; } - keys = calloc(MAX_BINDKEY + 1, sizeof(bindkey_t)); + keys = e_calloc(MAX_BINDKEY + 1, sizeof(bindkey_t)); if (!keys) { LOGERR; - if (buffer->line_prompt) - free(buffer->line_prompt); - free(buffer->line_buf); - free(buffer); + if (cli_buffer->line_prompt) + e_free(cli_buffer->line_prompt); + e_free(cli_buffer->line_buf); + e_free(cli_buffer); return NULL; } else memset(keys, 0, sizeof(bindkey_t) * (MAX_BINDKEY + 1)); /* add helper functions */ - cli_addCommand(buffer, "exit", 0, cli_Cmd_Exit, "exit ", "Exit from console"); - cli_addCommand(buffer, "help", 0, cli_Cmd_Help, "help [command] ", "Help screen"); - cli_addCommand(buffer, "-------", 0, NULL, "-------------------------", NULL); + cli_addCommand(cli_buffer, "exit", 0, cli_Cmd_Exit, "exit ", "Exit from console"); + cli_addCommand(cli_buffer, "help", 0, cli_Cmd_Help, "help [command] ", "Help screen"); + cli_addCommand(cli_buffer, "-------", 0, NULL, "-------------------------", NULL); /* fill key bindings */ - // ascii chars & ctrl+chars + /* ascii chars & ctrl+chars */ for (i = 0; i < 256; i++) { *keys[i].key_ch = (u_char) i; keys[i].key_len = 1; @@ -1023,14 +1038,14 @@ cliInit(int fin, int fout, const char *prompt) if (i == '?') keys[i].key_func = bufHelp; } - // alt+chars + /* alt+chars */ for (i = 256; i < 512; i++) { keys[i].key_ch[0] = 0x1b; keys[i].key_ch[1] = (u_char) i - 256; keys[i].key_len = 2; } - // 3 bytes + /* 3 bytes */ keys[i].key_len = sizeof K_F1 - 1; memcpy(keys[i].key_ch, K_F1, keys[i].key_len); i++; @@ -1143,7 +1158,7 @@ cliInit(int fin, int fout, const char *prompt) keys[i].key_func = bufBTAB; memcpy(keys[i].key_ch, K_BTAB, keys[i].key_len); i++; - // 4 bytes + /* 4 bytes */ keys[i].key_len = sizeof K_INS - 1; keys[i].key_func = bufMODE; memcpy(keys[i].key_ch, K_INS, keys[i].key_len); @@ -1158,7 +1173,7 @@ cliInit(int fin, int fout, const char *prompt) keys[i].key_len = sizeof K_PGDN - 1; memcpy(keys[i].key_ch, K_PGDN, keys[i].key_len); i++; - // 5 bytes + /* 5 bytes */ keys[i].key_len = sizeof K_F5 - 1; memcpy(keys[i].key_ch, K_F5, keys[i].key_len); i++; @@ -1184,52 +1199,54 @@ cliInit(int fin, int fout, const char *prompt) memcpy(keys[i].key_ch, K_F12, keys[i].key_len); i++; - buffer->line_keys = keys; - return buffer; + cli_buffer->line_keys = keys; + return cli_buffer; } /* - * cliInitLine() Init CLI input line terminal - * @buffer = CLI buffer + * cliInitLine() - Init CLI input line terminal + * + * @cli_buffer = CLI buffer * return: none */ int -cliInitLine(linebuffer_t * __restrict buffer) +cliInitLine(linebuffer_t * __restrict cli_buffer) { struct termios t; memset(&t, 0, sizeof t); - tcgetattr(buffer->line_in, &t); + tcgetattr(cli_buffer->line_in, &t); t.c_lflag &= ~(ICANON | ISIG | IEXTEN | ECHO | ECHOCTL | ECHOE | ECHOK | ECHOKE | ECHONL | ECHOPRT); t.c_iflag |= IGNBRK; t.c_cc[VMIN] = 1; t.c_cc[VTIME] = 0; - return tcsetattr(buffer->line_in, TCSANOW, &t); + return tcsetattr(cli_buffer->line_in, TCSANOW, &t); } /* - * cliReadLine() Read line from opened CLI session - * @buffer = CLI buffer - * return: NULL if error or !=NULL readed line, must be free after use! + * cliReadLine() - Read line from opened CLI session + * + * @cli_buffer = CLI buffer + * return: NULL if error or !=NULL readed line, must be e_free after use! */ char * -cliReadLine(linebuffer_t * __restrict buffer) +cliReadLine(linebuffer_t * __restrict cli_buffer) { int code, readLen; register int i; struct pollfd fds; char buf[BUFSIZ], *str = NULL; - if (!buffer) { - cli_SetErr(EINVAL, "Error:: invalid input parameters ..."); + if (!cli_buffer) { + cli_SetErr(EINVAL, "Invalid input parameters ..."); return NULL; } memset(&fds, 0, sizeof fds); - fds.fd = buffer->line_in; + fds.fd = cli_buffer->line_in; fds.events = POLLIN; - printfCR(buffer, 1); + printfCR(cli_buffer, 1); while (42) { if (poll(&fds, 1, -1) < 1) { LOGERR; @@ -1237,32 +1254,32 @@ cliReadLine(linebuffer_t * __restrict buffer) } memset(buf, 0, sizeof buf); - readLen = read(buffer->line_in, buf, BUFSIZ); + readLen = read(cli_buffer->line_in, buf, BUFSIZ); if (readLen == -1) { LOGERR; return str; } if (!readLen) { - if (buffer->line_buf) - str = strdup(buffer->line_buf); + if (cli_buffer->line_buf) + str = e_strdup(cli_buffer->line_buf); else - cli_SetErr(EPIPE, "Error:: unknown state ..."); + cli_SetErr(EPIPE, "Unknown state ..."); return str; } recheck: for (code = RETCODE_OK, i = MAX_BINDKEY - 1; i > -1; i--) - if (readLen >= buffer->line_keys[i].key_len && - !memcmp(buffer->line_keys[i].key_ch, buf, - buffer->line_keys[i].key_len)) { - readLen -= buffer->line_keys[i].key_len; + if (readLen >= cli_buffer->line_keys[i].key_len && + !memcmp(cli_buffer->line_keys[i].key_ch, buf, + cli_buffer->line_keys[i].key_len)) { + readLen -= cli_buffer->line_keys[i].key_len; if (readLen) - memmove(buf, buf + buffer->line_keys[i].key_len, readLen); + memmove(buf, buf + cli_buffer->line_keys[i].key_len, readLen); else - memset(buf, 0, buffer->line_keys[i].key_len); + memset(buf, 0, cli_buffer->line_keys[i].key_len); - if (buffer->line_keys[i].key_func) - if ((code = buffer->line_keys[i].key_func(i, buffer))) + if (cli_buffer->line_keys[i].key_func) + if ((code = cli_buffer->line_keys[i].key_func(i, cli_buffer))) readLen = 0; if (readLen) @@ -1275,21 +1292,22 @@ recheck: break; } - if (code != RETCODE_ERR && code != RETCODE_EOF && buffer->line_buf) - str = strdup(buffer->line_buf); + if (code != RETCODE_ERR && code != RETCODE_EOF && cli_buffer->line_buf) + str = e_strdup(cli_buffer->line_buf); return str; } /* - * cliNetLoop() CLI network main loop binded to socket - * @buffer = CLI buffer + * cliNetLoop() - CLI network main loop binded to socket + * + * @cli_buffer = CLI buffer * @csHistFile = History file name * @sock = client socket * return: RETCODE_ERR error, RETCODE_OK ok */ int -cliNetLoop(linebuffer_t * __restrict buffer, const char *csHistFile, int sock) +cliNetLoop(linebuffer_t * __restrict cli_buffer, const char *csHistFile, int sock) { u_char buf[BUFSIZ]; int pid, stat, pty, r, s, alen, flg, attrlen = 0, ret = 0; @@ -1302,16 +1320,16 @@ cliNetLoop(linebuffer_t * __restrict buffer, const cha LOGERR; return -1; case 0: - if (!buffer) { - cli_SetErr(EINVAL, "Error:: invalid input parameters ..."); + if (!cli_buffer) { + cli_SetErr(EINVAL, "Invalid input parameters ..."); return -1; } else close(sock); - ret = cliLoop(buffer, csHistFile) < 0 ? 1 : 0; - cliEnd(buffer); + ret = cliLoop(cli_buffer, csHistFile) < 0 ? 1 : 0; + cliEnd(cli_buffer); - exit(ret); + _exit(ret); default: cli_telnet_SetCmd(Attr + 0, DO, TELOPT_TTYPE); cli_telnet_SetCmd(Attr + 1, WILL, TELOPT_ECHO); @@ -1344,7 +1362,7 @@ cliNetLoop(linebuffer_t * __restrict buffer, const cha memset(buf, 0, BUFSIZ); if ((ret = cli_telnetRecv(sock, &a, &alen, buf, BUFSIZ)) < 0) { if (a) - free(a); + e_free(a); if (-2 == ret) continue; @@ -1367,7 +1385,7 @@ cliNetLoop(linebuffer_t * __restrict buffer, const cha cli_telnet_SetCmd(&Attr[attrlen++], DONT, TELOPT_LINEMODE); } if (a) - free(a); + e_free(a); if ((ret = write(pty, buf, ret)) == -1) { LOGERR; @@ -1397,13 +1415,14 @@ cliNetLoop(linebuffer_t * __restrict buffer, const cha } /* - * cliLoop() CLI main loop - * @buffer = CLI buffer + * cliLoop() - CLI main loop + * + * @cli_buffer = CLI buffer * @csHistFile = History file name * return: RETCODE_ERR error, RETCODE_OK ok */ int -cliLoop(linebuffer_t * __restrict buffer, const char *csHistFile) +cliLoop(linebuffer_t * __restrict cli_buffer, const char *csHistFile) { char *line, *s, *t, **app, *items[MAX_PROMPT_ITEMS]; register int i; @@ -1411,18 +1430,18 @@ cliLoop(linebuffer_t * __restrict buffer, const char * struct tagCommand *cmd; /* --- main body of CLI --- */ - cliInitLine(buffer); + cliInitLine(cli_buffer); - if (cli_loadHistory(buffer, csHistFile) == RETCODE_ERR) + if (cli_loadHistory(cli_buffer, csHistFile) == RETCODE_ERR) return RETCODE_ERR; do { - line = cliReadLine(buffer); + line = cliReadLine(cli_buffer); if (!line) { - printfNL(buffer, 0); + printfNL(cli_buffer, 0); break; } else - cli_addHistory(buffer, NULL); + cli_addHistory(cli_buffer, NULL); // clear whitespaces for (s = line; isspace((int) *s); s++); if (*s) { @@ -1437,7 +1456,7 @@ cliLoop(linebuffer_t * __restrict buffer, const char * // exec_cmd ... i = 0; - SLIST_FOREACH(cmd, &buffer->line_cmds, cmd_next) { + SLIST_FOREACH(cmd, &cli_buffer->line_cmds, cmd_next) { if (*items[0] && !strncmp(cmd->cmd_name, items[0], strlen(items[0]))) break; else @@ -1445,23 +1464,23 @@ cliLoop(linebuffer_t * __restrict buffer, const char * } if (!cmd) { - cli_Printf(buffer, "\nCommand '%s' not found!\n", items[0]); + cli_Printf(cli_buffer, "\nCommand '%s' not found!\n", items[0]); ret = -1; } else if (cmd->cmd_func) { - cli_Printf(buffer, "\n"); - ret = cmd->cmd_func(buffer, i, items); + cli_Printf(cli_buffer, "\n"); + ret = cmd->cmd_func(cli_buffer, i, items); } else { - clrscrEOL(buffer); - printfCR(buffer, 1); + clrscrEOL(cli_buffer); + printfCR(cli_buffer, 1); } } - cli_freeLine(buffer); - cli_resetHistory(buffer); - free(line); + cli_freeLine(cli_buffer); + cli_resetHistory(cli_buffer); + e_free(line); } while (ret < 1); - cli_saveHistory(buffer, csHistFile, HISTORY_LINES); + cli_saveHistory(cli_buffer, csHistFile, HISTORY_LINES); return ret; }