term.c File Reference

Terminal Routines. More...

#include "asterisk.h"
#include "asterisk/_private.h"
#include <sys/time.h>
#include <signal.h>
#include <sys/stat.h>
#include <fcntl.h>
#include "asterisk/term.h"
#include "asterisk/lock.h"
#include "asterisk/utils.h"
#include "asterisk/threadstorage.h"

Include dependency graph for term.c:

Go to the source code of this file.

Data Structures
struct	commonbuf

Macros
#define	HEADER_LEN   (12)
#define	MAGIC_EXTNUM   (01036)
#define	MAGIC_LEGACY   (00432)
#define	MAX_COLORS_INDEX   (13)

Functions
static void	__init_commonbuf (void)
const char *	ast_term_color (int fgcolor, int bgcolor)
	Return a color sequence string. More...
int	ast_term_color_code (struct ast_str **str, int fgcolor, int bgcolor)
	Append a color sequence to an ast_str. More...
int	ast_term_init (void)
const char *	ast_term_reset (void)
	Returns the terminal reset code. More...
static void	check_bgcolor (int *bgcolor)
static int	check_colors_allowed (void)
static void	check_fgcolor (int *fgcolor, int *attr)
static int	convint (unsigned char *s)
static short	convshort (unsigned char *s)
static int	opposite (int color)
static int	parse_terminfo_file (int fd)
char *	term_color (char *outbuf, const char *inbuf, int fgcolor, int bgcolor, int maxout)
	Colorize a specified string by adding terminal color codes. More...
char *	term_color_code (char *outbuf, int fgcolor, int bgcolor, int maxout)
	Write a color sequence to a string. More...
const char *	term_end (void)
void	term_filter_escapes (char *line)
const char *	term_quit (void)
char *	term_strip (char *outbuf, const char *inbuf, int maxout)
	Remove colorings from a specified string. More...

Variables
static struct ast_threadstorage	commonbuf = { .once = PTHREAD_ONCE_INIT , .key_init = __init_commonbuf , .custom_init = NULL , }
static char	enddata [80] = ""
static char	quitdata [80] = ""
static const char *const	termpath []
static int	vt100compat

Detailed Description

Terminal Routines.

Author

Mark Spencer marks.nosp@m.ter@.nosp@m.digiu.nosp@m.m.co.nosp@m.m

Definition in file term.c.

Macro Definition Documentation

HEADER_LEN

#define HEADER_LEN   (12)

Definition at line 103 of file term.c.

MAGIC_EXTNUM

#define MAGIC_EXTNUM   (01036)

Definition at line 101 of file term.c.

MAGIC_LEGACY

#define MAGIC_LEGACY   (00432)

Definition at line 100 of file term.c.

MAX_COLORS_INDEX

#define MAX_COLORS_INDEX   (13)

Definition at line 104 of file term.c.

Function Documentation

__init_commonbuf()

static void __init_commonbuf ( void  )

static

Definition at line 55 of file term.c.

{

ast_term_color()

const char * ast_term_color	(	int	fgcolor,
		int	bgcolor
	)

Return a color sequence string.

Parameters

fgcolor	foreground color
bgcolor	background color

Note

This function may be called up to 15 times within the arguments to a single function without the danger of overwriting a common buffer.

Returns

A color sequence string, or the empty string, on error

Definition at line 341 of file term.c.

{
    struct commonbuf *cb = ast_threadstorage_get(&commonbuf, sizeof(*cb));
    char *buf;
 
    if (!cb) {
        return "";
    }
    buf = cb->buffer[cb->which++];
    if (cb->which == AST_TERM_MAX_ROTATING_BUFFERS) {
        cb->which = 0;
    }
 
    return term_color_code(buf, fgcolor, bgcolor, AST_TERM_MAX_ESCAPE_CHARS);
}

References AST_TERM_MAX_ESCAPE_CHARS, AST_TERM_MAX_ROTATING_BUFFERS, ast_threadstorage_get(), buf, commonbuf::buffer, term_color_code(), and commonbuf::which.

Referenced by print_app_docs(), print_queue(), and set_header().

ast_term_color_code()

int ast_term_color_code	(	struct ast_str **	str,
		int	fgcolor,
		int	bgcolor
	)

Append a color sequence to an ast_str.

Parameters

str	The string to append to
fgcolor	foreground color
bgcolor	background color

Return values

0	success
-1	failure

Definition at line 296 of file term.c.

{
    int attr = 0;
 
    if (!check_colors_allowed()) {
        return -1;
    }
 
    check_fgcolor(&fgcolor, &attr);
    check_bgcolor(&bgcolor);
 
    if (ast_opt_force_black_background) {
        ast_str_append(str, 0, "%c[%d;%d;%dm", ESC, attr, fgcolor, COLOR_BLACK + 10);
    } else if (bgcolor) {
        ast_str_append(str, 0, "%c[%d;%d;%dm", ESC, attr, fgcolor, bgcolor + 10);
    } else {
        ast_str_append(str, 0, "%c[%d;%dm", ESC, attr, fgcolor);
    }
 
    return 0;
}

References ast_opt_force_black_background, ast_str_append(), check_bgcolor(), check_colors_allowed(), check_fgcolor(), COLOR_BLACK, ESC, and str.

Referenced by ast_xmldoc_printable(), and cli_prompt().

ast_term_init()

int ast_term_init

(

void

)

Provided by term.c

Definition at line 165 of file term.c.

{
    char *term = getenv("TERM");
    char termfile[256] = "";
    int termfd = -1, parseokay = 0, i;
 
    if (ast_opt_no_color) {
        return 0;
    }
 
    if (!ast_opt_console) {
        /* If any remote console is not compatible, we'll strip the color codes at that point */
        vt100compat = 1;
        goto end;
    }
 
    if (!term) {
        return 0;
    }
 
    for (i = 0; !parseokay && termpath[i]; i++) {
        snprintf(termfile, sizeof(termfile), "%s/%c/%s", termpath[i], *term, term);
 
        termfd = open(termfile, O_RDONLY);
        if (termfd > -1) {
            parseokay = parse_terminfo_file(termfd);
            close(termfd);
        }
    }
 
    if (!parseokay) {
        /* These comparisons should not be substrings nor case-insensitive, as
         * terminal types are very particular about how they treat suffixes and
         * capitalization.  For example, terminal type 'linux-m' does NOT
         * support color, while 'linux' does.  Not even all vt100* terminals
         * support color, either (e.g. 'vt100+fnkeys'). */
        if (!strcmp(term, "linux")) {
            vt100compat = 1;
        } else if (!strcmp(term, "xterm")) {
            vt100compat = 1;
        } else if (!strcmp(term, "xterm-color")) {
            vt100compat = 1;
        } else if (!strcmp(term, "xterm-256color")) {
            vt100compat = 1;
        } else if (!strncmp(term, "Eterm", 5)) {
            /* Both entries which start with Eterm support color */
            vt100compat = 1;
        } else if (!strcmp(term, "vt100")) {
            vt100compat = 1;
        } else if (!strncmp(term, "crt", 3)) {
            /* Both crt terminals support color */
            vt100compat = 1;
        }
    }
 
end:
    if (vt100compat) {
        /* Make commands show up in nice colors */
        if (ast_opt_light_background) {
            snprintf(enddata, sizeof(enddata), "%c[%dm", ESC, COLOR_BLACK);
        } else if (ast_opt_force_black_background) {
            snprintf(enddata, sizeof(enddata), "%c[%d;%d;%dm", ESC, ATTR_RESET, COLOR_WHITE, COLOR_BLACK + 10);
        } else {
            snprintf(enddata, sizeof(enddata), "%c[%dm", ESC, ATTR_RESET);
        }
        snprintf(quitdata, sizeof(quitdata), "%c[%dm", ESC, ATTR_RESET);
    }
    return 0;
}

References ast_opt_console, ast_opt_force_black_background, ast_opt_light_background, ast_opt_no_color, ATTR_RESET, COLOR_BLACK, COLOR_WHITE, end, enddata, ESC, parse_terminfo_file(), quitdata, termpath, and vt100compat.

Referenced by ast_remotecontrol(), asterisk_daemon(), and main().

ast_term_reset()

const char * ast_term_reset

(

void

)

Returns the terminal reset code.

Returns

String which, when sent to the screen, resets the terminal colors

Definition at line 357 of file term.c.

{
    return term_end();
}

References term_end().

Referenced by ast_xmldoc_printable(), cli_show_module_options(), print_app_docs(), print_queue(), and set_header().

check_bgcolor()

static void check_bgcolor ( int *  bgcolor )

static

Definition at line 284 of file term.c.

{
    if (*bgcolor) {
        *bgcolor &= ~128;
    }
}

Referenced by ast_term_color_code(), and term_color_code().

check_colors_allowed()

static int check_colors_allowed ( void  )

static

Definition at line 291 of file term.c.

{
    return vt100compat;
}

References vt100compat.

Referenced by ast_term_color_code(), and term_color_code().

check_fgcolor()

static void check_fgcolor ( int *  fgcolor, int *  attr  )

static

Definition at line 272 of file term.c.

{
    *attr = ast_opt_light_background ? 0 : ATTR_BRIGHT;
    if (*fgcolor & 128) {
        *fgcolor &= ~128;
    }
 
    if (ast_opt_light_background) {
        *fgcolor = opposite(*fgcolor);
    }
}

References ast_opt_light_background, ATTR_BRIGHT, and opposite().

Referenced by ast_term_color_code(), and term_color_code().

convint()

static int convint ( unsigned char *  s )

inlinestatic

Definition at line 92 of file term.c.

{
    return s[0]
        | s[1] << 8
        | s[2] << 16
        | s[3] << 24;
}

Referenced by parse_terminfo_file().

convshort()

static short convshort ( unsigned char *  s )

static

Definition at line 77 of file term.c.

{
    register int a, b;
 
    a = (int) s[0] & 0377;
    b = (int) s[1] & 0377;
 
    if (a == 0377 && b == 0377)
        return -1;
    if (a == 0376 && b == 0377)
        return -2;
 
    return a + b * 256;
}

References a, and b.

Referenced by parse_terminfo_file().

opposite()

static int opposite ( int  color )

static

Definition at line 62 of file term.c.

{
    int lookup[] = {
        /* BLACK */ COLOR_BLACK,
        /* RED */ COLOR_MAGENTA,
        /* GREEN */ COLOR_GREEN,
        /* BROWN */ COLOR_BROWN,
        /* BLUE */ COLOR_CYAN,
        /* MAGENTA */ COLOR_RED,
        /* CYAN */ COLOR_BLUE,
        /* WHITE */ COLOR_BLACK };
    return color ? lookup[color - 30] : 0;
}

References COLOR_BLACK, COLOR_BLUE, COLOR_BROWN, COLOR_CYAN, COLOR_GREEN, COLOR_MAGENTA, and COLOR_RED.

Referenced by check_fgcolor(), and term_color().

parse_terminfo_file()

static int parse_terminfo_file ( int  fd )

static

Definition at line 106 of file term.c.

{
    int bytes_read, bytes_needed, num_size;
    short magic, sz_names, sz_bools;
    unsigned char buffer[1024];
 
    bytes_read = read(fd, buffer, sizeof(buffer));
    if (bytes_read < HEADER_LEN) {
        return 0;
    }
 
    magic = convshort(buffer);
 
    if (magic == MAGIC_LEGACY) {
        num_size = 2;
    } else if (magic == MAGIC_EXTNUM) {
        /* Extended number format (ncurses 6.1) */
        num_size = 4;
    } else {
        /* We don't know how to parse this file */
        return 0;
    }
 
    sz_names = convshort(buffer + 2);
    sz_bools = convshort(buffer + 4);
 
    /* From term(5):
     * Between the boolean section and the number section, a null byte will be
     * inserted, if necessary, to ensure that the number section begins on an
     * even byte. */
    if ((sz_names + sz_bools) & 1) {
        sz_bools++;
    }
 
    bytes_needed = HEADER_LEN + sz_names + sz_bools + ((MAX_COLORS_INDEX + 1) * num_size);
    if (bytes_needed <= bytes_read) {
        /* Offset 13 is defined in /usr/include/term.h, though we do not
         * include it here, as it conflicts with include/asterisk/term.h */
        int max_colors;
        int offset = HEADER_LEN + sz_names + sz_bools + MAX_COLORS_INDEX * num_size;
 
        if (num_size == 2) {
            /* In the legacy terminfo format, numbers are signed shorts */
            max_colors = convshort(buffer + offset);
        } else {
            /* Extended number format makes them signed ints */
            max_colors = convint(buffer + offset);
        }
 
        if (max_colors > 0) {
            vt100compat = 1;
        }
 
        return 1;
    }
 
    return 0;
}

References convint(), convshort(), HEADER_LEN, MAGIC_EXTNUM, MAGIC_LEGACY, MAX_COLORS_INDEX, and vt100compat.

Referenced by ast_term_init().

term_color()

char * term_color	(	char *	outbuf,
		const char *	inbuf,
		int	fgcolor,
		int	bgcolor,
		int	maxout
	)

Colorize a specified string by adding terminal color codes.

Parameters

outbuf	Result buffer
inbuf	Starting string
fgcolor	Foreground color, specified as one of the constants in include/asterisk/term.h. Use '0' if the want the normal terminal foreground color.
bgcolor	Background color, specified as one of the constants in include/asterisk/term.h. Use '0' if you want the normal terminal background color.
maxout	Maximum size of outbuf

Returns

outbuf

Deprecated:

Due to the necessity of pre-sizing a result buffer, new code should avoid using this function in preference to ast_term_color_code() or ast_term_color().

Definition at line 235 of file term.c.

{
    int attr = 0;
 
    if (!vt100compat) {
        ast_copy_string(outbuf, inbuf, maxout);
        return outbuf;
    }
    if (!fgcolor) {
        ast_copy_string(outbuf, inbuf, maxout);
        return outbuf;
    }
 
    if (fgcolor & 128) {
        attr = ast_opt_light_background ? 0 : ATTR_BRIGHT;
        fgcolor &= ~128;
    }
 
    if (bgcolor) {
        bgcolor &= ~128;
    }
 
    if (ast_opt_light_background) {
        fgcolor = opposite(fgcolor);
    }
 
    if (ast_opt_force_black_background) {
        if (!bgcolor) {
            bgcolor = COLOR_BLACK;
        }
        snprintf(outbuf, maxout, "%c[%d;%d;%dm%s%s", ESC, attr, fgcolor, bgcolor + 10, inbuf, term_end());
    } else {
        snprintf(outbuf, maxout, "%c[%d;%dm%s%s", ESC, attr, fgcolor, inbuf, term_end());
    }
    return outbuf;
}

References ast_copy_string(), ast_opt_force_black_background, ast_opt_light_background, ATTR_BRIGHT, COLOR_BLACK, ESC, inbuf(), opposite(), term_end(), and vt100compat.

Referenced by __ast_register_translator(), ast_frame_dump(), ast_unregister_translator(), cli_show_module_options(), cli_show_module_type(), handle_cli_agi_show(), handle_dahdi_show_cadences(), handle_show_function(), handle_showmancmd(), lua_pbx_exec(), print_event_instance(), realtime_exec(), and start_resource().

term_color_code()

char * term_color_code	(	char *	outbuf,
		int	fgcolor,
		int	bgcolor,
		int	maxout
	)

Write a color sequence to a string.

Parameters

outbuf	the location to write to
fgcolor	foreground color
bgcolor	background color
maxout	maximum number of characters to write

Deprecated:

You should use ast_term_color_code or ast_term_color, instead.

Returns

outbuf

Definition at line 318 of file term.c.

{
    int attr = 0;
 
    if (!check_colors_allowed()) {
        *outbuf = '\0';
        return outbuf;
    }
 
    check_fgcolor(&fgcolor, &attr);
    check_bgcolor(&bgcolor);
 
    if (ast_opt_force_black_background) {
        snprintf(outbuf, maxout, "%c[%d;%d;%dm", ESC, attr, fgcolor, COLOR_BLACK + 10);
    } else if (bgcolor) {
        snprintf(outbuf, maxout, "%c[%d;%d;%dm", ESC, attr, fgcolor, bgcolor + 10);
    } else {
        snprintf(outbuf, maxout, "%c[%d;%dm", ESC, attr, fgcolor);
    }
 
    return outbuf;
}

References ast_opt_force_black_background, check_bgcolor(), check_colors_allowed(), check_fgcolor(), COLOR_BLACK, and ESC.

Referenced by ast_term_color().

term_end()

const char * term_end

(

void

)

Definition at line 407 of file term.c.

{
    return enddata;
}

References enddata.

Referenced by ast_remotecontrol(), ast_term_reset(), asterisk_daemon(), consolehandler(), main(), and term_color().

term_filter_escapes()

void term_filter_escapes

(

char *

line

)

Definition at line 385 of file term.c.

{
    int i;
    int len = strlen(line);
 
    for (i = 0; i < len; i++) {
        if (line[i] != ESC)
            continue;
        if ((i < (len - 2)) &&
            (line[i + 1] == 0x5B)) {
            switch (line[i + 2]) {
            case 0x30:
            case 0x31:
            case 0x33:
                continue;
            }
        }
        /* replace ESC with a space */
        line[i] = ' ';
    }
}

References ESC, and len().

term_quit()

const char * term_quit

(

void

)

Definition at line 412 of file term.c.

{
    return quitdata;
}

References quitdata.

Referenced by ast_el_read_char(), check_init(), main(), and really_quit().

term_strip()

char * term_strip	(	char *	outbuf,
		const char *	inbuf,
		int	maxout
	)

Remove colorings from a specified string.

Parameters

outbuf	the location to write to
inbuf	the original string
maxout	the available size of outbuf

Returns

outbuf

Definition at line 362 of file term.c.

{
    char *outbuf_ptr = outbuf;
    const char *inbuf_ptr = inbuf;
 
    while (outbuf_ptr < outbuf + maxout) {
        switch (*inbuf_ptr) {
            case ESC:
                while (*inbuf_ptr && (*inbuf_ptr != 'm'))
                    inbuf_ptr++;
                break;
            default:
                *outbuf_ptr = *inbuf_ptr;
                outbuf_ptr++;
        }
        if (! *inbuf_ptr)
            break;
        inbuf_ptr++;
    }
    return outbuf;
}

References ESC, and inbuf().

Referenced by action_command(), format_log_default(), format_log_json(), and format_log_plain().

Variable Documentation

commonbuf

struct ast_threadstorage commonbuf = { .once = PTHREAD_ONCE_INIT , .key_init = __init_commonbuf , .custom_init = NULL , }

static

Definition at line 55 of file term.c.

enddata

char enddata[80] = ""

static

Definition at line 45 of file term.c.

Referenced by ast_term_init(), and term_end().

quitdata

char quitdata[80] = ""

static

Definition at line 46 of file term.c.

Referenced by ast_term_init(), and term_quit().

termpath

const char* const termpath[]

static

Definition at line 48 of file term.c.

Referenced by ast_term_init().

vt100compat

int vt100compat

static

Definition at line 43 of file term.c.

Referenced by ast_term_init(), check_colors_allowed(), parse_terminfo_file(), and term_color().