amxp_cron_parser.c File Reference

#include <stdlib.h>
#include <stdio.h>
#include <errno.h>
#include <string.h>
#include <time.h>
#include <amxc/amxc.h>
#include <amxp/amxp_cron.h>
#include <amxc/amxc_macros.h>
#include "amxp_cron_parser_priv.h"

Go to the source code of this file.

Macros
#define	_GNU_SOURCE
#define	CRON_MONTHS_ARR_LEN   13
#define	CRON_DAYS_ARR_LEN   7

Functions
static void	cron_set_bit (uint8_t *rbyte, int idx)
static void	cron_del_bit (uint8_t *rbyte, int idx)
static bool	has_char (const char *str, char ch)
static uint32_t	parse_uint (const char *str, bool *invalid)
static void	replace_ordinals (amxc_string_t *value, const char *const *arr, uint32_t arr_len)
static int	split_string (amxc_llist_t *parts, char *str, const char sep, uint32_t expected_len)
static uint32_t *	get_range (char *field, uint32_t min, uint32_t max, const char **error)
static uint32_t *	get_range_increment (char *field, uint32_t min, uint32_t max, uint32_t *increment, const char **error)
uint8_t	cron_get_bit (const uint8_t *rbyte, int idx)
int	amxp_cron_reset (amxp_cron_expr_t *cron_expr)
int	amxp_cron_set_hits (amxc_var_t *value, uint8_t *target, uint32_t min, uint32_t max, const char **error)
int	amxp_cron_set_months (amxc_var_t *value, uint8_t *target, uint32_t min, uint32_t max, const char **error)
int	amxp_cron_set_days_of_week (amxc_var_t *value, uint8_t *target, uint32_t min, uint32_t max, const char **error)
int	amxp_cron_set_days_of_month (amxc_var_t *value, uint8_t *target, uint32_t min, uint32_t max, const char **error)

Variables
static const char *const	MONTHS_ARR []
static const char *const	DAYS_ARR []
static const char *const	DAYS_ARR_FULL []

Macro Definition Documentation

_GNU_SOURCE

#define _GNU_SOURCE

Definition at line 56 of file amxp_cron_parser.c.

CRON_DAYS_ARR_LEN

#define CRON_DAYS_ARR_LEN   7

Definition at line 88 of file amxp_cron_parser.c.

CRON_MONTHS_ARR_LEN

#define CRON_MONTHS_ARR_LEN   13

Definition at line 87 of file amxp_cron_parser.c.

Function Documentation

amxp_cron_reset()

int amxp_cron_reset

(

amxp_cron_expr_t *

cron_expr

)

Definition at line 285 of file amxp_cron_parser.c.

                                                 {
    int retval = -1;
    when_null(cron_expr, exit);
    memset(cron_expr, 0, sizeof(amxp_cron_expr_t));
 
exit:
    return retval;
}

amxp_cron_set_days_of_month()

int amxp_cron_set_days_of_month	(	amxc_var_t *	value,
		uint8_t *	target,
		uint32_t	min,
		uint32_t	max,
		const char **	error
	)

Definition at line 404 of file amxp_cron_parser.c.

                                                    {
    const char* field = GET_CHAR(value, NULL);
 
    if((strlen(field) == 1) && (field[0] == '?')) {
        amxc_var_set(cstring_t, value, "*");
    }
 
    return amxp_cron_set_hits(value, target, min, max, error);
}

amxp_cron_set_days_of_week()

int amxp_cron_set_days_of_week	(	amxc_var_t *	value,
		uint8_t *	target,
		uint32_t	min,
		uint32_t	max,
		const char **	error
	)

Definition at line 370 of file amxp_cron_parser.c.

                                                   {
    int rv = -1;
    amxc_string_t str_value;
    char* v = amxc_var_take(cstring_t, value);
 
    amxc_string_init(&str_value, 0);
 
    amxc_string_push_buffer(&str_value, v, strlen(v) + 1);
    amxc_string_to_upper(&str_value);
 
    if((amxc_string_text_length(&str_value) == 1) && (str_value.buffer[0] == '?')) {
        str_value.buffer[0] = '*';
    }
 
    replace_ordinals(&str_value, DAYS_ARR_FULL, CRON_DAYS_ARR_LEN);
    replace_ordinals(&str_value, DAYS_ARR, CRON_DAYS_ARR_LEN);
    amxc_var_set(cstring_t, value, amxc_string_get(&str_value, 0));
 
    rv = amxp_cron_set_hits(value, target, min, max, error);
 
    if(cron_get_bit(target, 7)) {
        // Sunday can be represented as 0 or 7
        cron_set_bit(target, 0);
        cron_del_bit(target, 7);
    }
 
    amxc_string_clean(&str_value);
    return rv;
}

amxp_cron_set_hits()

int amxp_cron_set_hits	(	amxc_var_t *	value,
		uint8_t *	target,
		uint32_t	min,
		uint32_t	max,
		const char **	error
	)

Definition at line 294 of file amxp_cron_parser.c.

                                           {
    amxc_var_t fields;
    uint32_t delta = 1;
    uint32_t* range = NULL;
    char* field_expr = NULL;
    int rv = -1;
 
    amxc_var_init(&fields);
    amxc_var_set(csv_string_t, &fields, GET_CHAR(value, NULL));
    amxc_var_cast(&fields, AMXC_VAR_ID_LIST);
 
    amxc_var_for_each(field, &fields) {
        field_expr = amxc_var_take(cstring_t, field);
        if(!has_char(field_expr, '/')) {
            range = get_range(field_expr, min, max, error);
            when_null(range, exit);
            when_not_null_status(*error, exit, free(range));
        } else {
            range = get_range_increment(field_expr, min, max, &delta, error);
            when_null(range, exit);
            when_not_null_status(*error, exit, free(range));
            if(delta == 0) {
                *error = "Incrementer may not be zero";
                free(range);
                goto exit;
            }
        }
 
        for(size_t i = range[0]; i <= range[1]; i += delta) {
            cron_set_bit(target, i);
        }
        free(range);
        free(field_expr);
        field_expr = NULL;
    }
 
    rv = 0;
 
exit:
    free(field_expr);
    amxc_var_clean(&fields);
    return rv;
}

amxp_cron_set_months()

int amxp_cron_set_months	(	amxc_var_t *	value,
		uint8_t *	target,
		uint32_t	min,
		uint32_t	max,
		const char **	error
	)

Definition at line 342 of file amxp_cron_parser.c.

                                             {
    int rv = -1;
    amxc_string_t str_value;
    char* v = amxc_var_take(cstring_t, value);
    amxc_string_init(&str_value, 0);
 
    amxc_string_push_buffer(&str_value, v, strlen(v) + 1);
    amxc_string_to_upper(&str_value);
    replace_ordinals(&str_value, MONTHS_ARR, CRON_MONTHS_ARR_LEN);
    amxc_var_set(cstring_t, value, amxc_string_get(&str_value, 0));
    rv = amxp_cron_set_hits(value, target, min, max, error);
 
    /* ... and then rotate it to the front of the months */
    for(uint32_t i = 1; i <= max; i++) {
        if(cron_get_bit(target, i)) {
            cron_set_bit(target, i - 1);
            cron_del_bit(target, i);
        }
    }
 
    amxc_string_clean(&str_value);
    return rv;
}

cron_del_bit()

static void cron_del_bit ( uint8_t *  rbyte, int  idx  )

static

Definition at line 97 of file amxp_cron_parser.c.

                                                  {
    uint8_t j = (uint8_t) (idx / 8);
    uint8_t k = (uint8_t) (idx % 8);
 
    rbyte[j] &= ~(1 << k);
}

cron_get_bit()

uint8_t cron_get_bit	(	const uint8_t *	rbyte,
		int	idx
	)

Definition at line 274 of file amxp_cron_parser.c.

                                                    {
    uint8_t j = (uint8_t) (idx / 8);
    uint8_t k = (uint8_t) (idx % 8);
 
    if(rbyte[j] & (1 << k)) {
        return 1;
    } else {
        return 0;
    }
}

cron_set_bit()

static void cron_set_bit ( uint8_t *  rbyte, int  idx  )

static

Definition at line 90 of file amxp_cron_parser.c.

                                                  {
    uint8_t j = (uint8_t) (idx / 8);
    uint8_t k = (uint8_t) (idx % 8);
 
    rbyte[j] |= (1 << k);
}

get_range()

static uint32_t* get_range ( char *  field, uint32_t  min, uint32_t  max, const char **  error  )

static

Definition at line 183 of file amxp_cron_parser.c.

                                               {
    size_t len = 0;
    uint32_t* res = (uint32_t*) calloc(2, sizeof(uint32_t));
    bool invalid = true;
 
    when_null(res, exit);
 
    if((strlen(field) == 1) && (field[0] == '*')) {
        res[0] = min;
        res[1] = max - 1;
    } else if(!has_char(field, '-')) {
        uint32_t val = parse_uint(field, &invalid);
        when_true_status(invalid, exit, *error = "Invalid value (1)");
        res[0] = val;
        res[1] = val;
    } else {
        amxc_llist_t parts;
        amxc_llist_init(&parts);
        when_failed_status(split_string(&parts, field, '-', 2), exit, *error = "Specified range requires two fields");
        len = 0;
        amxc_llist_for_each(it, &parts) {
            amxc_string_t* strpart = amxc_string_from_llist_it(it);
            amxc_string_trim(strpart, NULL);
            res[len] = parse_uint(amxc_string_get(strpart, 0), &invalid);
            if(invalid) {
                *error = "Invalid value (2)";
                break;
            }
            len++;
        }
        amxc_llist_clean(&parts, amxc_string_list_it_free);
        when_true(invalid, exit);
    }
 
    invalid = true;
    when_true_status(res[0] >= max || res[1] >= max, exit, *error = "Specified range exceeds maximum");
    when_true_status(res[0] < min || res[1] < min, exit, *error = "Specified range is less than minimum");
    when_true_status(res[0] > res[1], exit, *error = "Specified range start exceeds range end");
 
    invalid = false;
    *error = NULL;
 
exit:
    if(invalid && (res != NULL)) {
        free(res);
        res = NULL;
    }
 
    return res;
}

get_range_increment()

static uint32_t* get_range_increment ( char *  field, uint32_t  min, uint32_t  max, uint32_t *  increment, const char **  error  )

static

Definition at line 237 of file amxp_cron_parser.c.

                                                         {
    amxc_llist_it_t* it = NULL;
    amxc_string_t* strpart = NULL;
    amxc_llist_t parts;
    bool invalid = true;
    uint32_t* range = NULL;
 
    amxc_llist_init(&parts);
    when_failed_status(split_string(&parts, field, '/', 2), exit, *error = "Incrementer must have two fields");
 
    it = amxc_llist_get_first(&parts);
    strpart = amxc_string_from_llist_it(it);
    range = get_range(strpart->buffer, min, max, error);
    when_null(range, exit);
    if(*error != NULL) {
        free(range);
        range = NULL;
        goto exit;
    }
    if(!has_char(amxc_string_get(strpart, 0), '-')) {
        range[1] = max - 1;
    }
 
    it = amxc_llist_it_get_next(it);
    strpart = amxc_string_from_llist_it(it);
    *increment = parse_uint(amxc_string_get(strpart, 0), &invalid);
    when_true_status(invalid, exit, *error = "Invalid value (3)");
 
exit:
    amxc_llist_clean(&parts, amxc_string_list_it_free);
    return range;
}

has_char()

static bool has_char ( const char *  str, char  ch  )

static

Definition at line 104 of file amxp_cron_parser.c.

                                               {
    size_t i = 0;
    size_t len = 0;
    bool rv = false;
 
    len = strlen(str);
 
    for(i = 0; i < len; i++) {
        if(str[i] == ch) {
            rv = true;
            break;
        }
    }
 
    return rv;
}

parse_uint()

static uint32_t parse_uint ( const char *  str, bool *  invalid  )

static

Definition at line 121 of file amxp_cron_parser.c.

                                                           {
    char* endptr = NULL;
    int64_t value = 0;
 
    errno = 0;
    *invalid = false;
    if(str[0] == 0) {
        *invalid = true;
    } else {
        value = strtol(str, &endptr, 10);
        if((errno == ERANGE) || (*endptr != '\0') || (value < 0) || (value > INT32_MAX)) {
            *invalid = true;
            value = 0;
        } else {
            *invalid = false;
        }
    }
    return (uint32_t) value;
}

replace_ordinals()

static void replace_ordinals ( amxc_string_t *  value, const char *const *  arr, uint32_t  arr_len  )

static

Definition at line 141 of file amxp_cron_parser.c.

                                               {
    char* cur = NULL;
    amxc_var_t num;
    amxc_var_init(&num);
    for(uint32_t i = 0; i < arr_len; i++) {
        amxc_var_set(uint32_t, &num, i);
        cur = amxc_var_dyncast(cstring_t, &num);
        amxc_string_replace(value, arr[i], cur, UINT32_MAX);
        free(cur);
    }
    amxc_var_clean(&num);
}

split_string()

static int split_string ( amxc_llist_t *  parts, char *  str, const char  sep, uint32_t  expected_len  )

static

Definition at line 156 of file amxp_cron_parser.c.

                                               {
    uint32_t len = 0;
    int rv = -1;
    amxc_string_t strfield;
    amxc_string_init(&strfield, 0);
 
    amxc_string_push_buffer(&strfield, str, strlen(str) + 1);
    amxc_string_split_to_llist(&strfield, parts, sep);
 
    len = amxc_llist_size(parts);
    when_false(len == expected_len, exit);
 
    rv = 0;
 
exit:
    if(rv != 0) {
        amxc_llist_clean(parts, amxc_string_list_it_free);
    }
 
    amxc_string_take_buffer(&strfield);
    amxc_string_clean(&strfield);
    return rv;
}

Variable Documentation

DAYS_ARR

const char* const DAYS_ARR[]

static

Initial value:

= {
    "SUN", "MON", "TUE", "WED",
    "THU", "FRI", "SAT"
}

Definition at line 77 of file amxp_cron_parser.c.

DAYS_ARR_FULL

const char* const DAYS_ARR_FULL[]

static

Initial value:

= {
    "SUNDAY", "MONDAY", "TUESDAY", "WEDNESDAY",
    "THURSDAY", "FRIDAY", "SATURDAY"
}

Definition at line 82 of file amxp_cron_parser.c.

MONTHS_ARR

const char* const MONTHS_ARR[]

static

Initial value:

= {
    "FOO", "JAN", "FEB", "MAR", "APR",
    "MAY", "JUN", "JUL", "AUG", "SEP",
    "OCT", "NOV", "DEC"
}

Definition at line 71 of file amxp_cron_parser.c.