crontab.c

/*
  +----------------------------------------------------------------------+
  | PHP Version 5                                                        |
  +----------------------------------------------------------------------+
  | Copyright (c) 1997-2013 The PHP Group                                |
  +----------------------------------------------------------------------+
  | This source file is subject to version 3.01 of the PHP license,      |
  | that is bundled with this package in the file LICENSE, and is        |
  | available through the world-wide-web at the following url:           |
  | http://www.php.net/license/3_01.txt                                  |
  | If you did not receive a copy of the PHP license and are unable to   |
  | obtain it through the world-wide-web, please send a note to          |
  | license@php.net so we can mail you a copy immediately.               |
  +----------------------------------------------------------------------+
  | Author:                                                              |
  +----------------------------------------------------------------------+
*/

/* $Id$ */

#include <stdint.h>

#ifdef HAVE_CONFIG_H
#include "config.h"
#endif

#include "php.h"
#include "php_ini.h"
#include "ext/standard/info.h"
#include "php_crontab.h"

/* If you declare any globals in php_crontab.h uncomment this:
ZEND_DECLARE_MODULE_GLOBALS(crontab)
*/

/* True global resources - no need for thread safety here */
static int le_crontab;
extern sapi_module_struct sapi_module;

zend_class_entry *crontab_ce;

static const char weeksAry[] ALIGN1 =
    "sun""mon""tue""wed""thu""fri""sat"
    /* "Sun""Mon""Tue""Wed""Thu""Fri""Sat" */
;

static const char monthsAry[] ALIGN1 =
    "jan""feb""mar""apr""may""jun""jul""aug""sep""oct""nov""dec"
    /* "Jan""Feb""Mar""Apr""May""Jun""Jul""Aug""Sep""Oct""Nov""Dec" */
;

typedef struct crontab_s crontab_t;
struct crontab_s {
    char                        weeks[7];           /* 0-6, beginning sunday */
    char                        months[12];         /* 0-11 */
    char                        hours[24];          /* 0-23 */
    char                        days[32];           /* 1-31 */
    char                        minutes[60];        /* 0-59 */

    char                        *execute;
    zval                        *callback;

    int                         intval;
    pid_t                       pid;

    int                         index;
    int                         count;
    crontab_t                   *next;
};

static crontab_t *crontab_head;
static crontab_t *crontab_last;
static uintptr_t last_time;
static int crontab_count;

static int flag_line(uintptr_t t1, uintptr_t t2 TSRMLS_DC);
static int parse_line(char *str, crontab_t *cron TSRMLS_DC);
static int parse_field(char *ary, int modvalue, int off, const char *names, char *ptr TSRMLS_DC);
static void sigroutine(int signo);


/* {{{ crontab_functions[]
 *
 * Every user visible function must have an entry in crontab_functions[].
 */
const zend_function_entry crontab_functions[] = {
    PHP_FE_END    /* Must be the last line in crontab_functions[] */
};
/* }}} */

/* {{{ crontab_module_entry
 */
zend_module_entry crontab_module_entry = {
#if ZEND_MODULE_API_NO >= 20010901
    STANDARD_MODULE_HEADER,
#endif
    "crontab",
    crontab_functions,
    PHP_MINIT(crontab),
    PHP_MSHUTDOWN(crontab),
    PHP_RINIT(crontab),        /* Replace with NULL if there's nothing to do at request start */
    PHP_RSHUTDOWN(crontab),    /* Replace with NULL if there's nothing to do at request end */
    PHP_MINFO(crontab),
#if ZEND_MODULE_API_NO >= 20010901
    "0.1", /* Replace with version number for your extension */
#endif
    STANDARD_MODULE_PROPERTIES
};
/* }}} */

#ifdef COMPILE_DL_CRONTAB
ZEND_GET_MODULE(crontab)
#endif

/* {{{ PHP_INI
 */
/* Remove comments and fill if you need to have entries in php.ini
PHP_INI_BEGIN()
    STD_PHP_INI_ENTRY("crontab.global_value",      "42", PHP_INI_ALL, OnUpdateLong, global_value, zend_crontab_globals, crontab_globals)
    STD_PHP_INI_ENTRY("crontab.global_string", "foobar", PHP_INI_ALL, OnUpdateString, global_string, zend_crontab_globals, crontab_globals)
PHP_INI_END()
*/
/* }}} */

/* {{{ php_crontab_init_globals
 */
/* Uncomment this function if you have INI entries
static void php_crontab_init_globals(zend_crontab_globals *crontab_globals)
{
    crontab_globals->global_value = 0;
    crontab_globals->global_string = NULL;
}
*/
/* }}} */

PHP_METHOD(crontab_ce, __construct) {
    //only cli env
    if (strcasecmp("cli", sapi_module.name) != 0)
    {
        php_error_docref(NULL TSRMLS_CC, E_ERROR, "crontab must run at cli environment.");
        RETURN_FALSE;
    }
}

PHP_METHOD(crontab_ce, __destruct) {
}

PHP_METHOD(crontab_ce, add) {
    zval *argv1, *argv2, *argv3;
    int n, l, i;
    int idx;
    zval **val;
    char *key, *key1;
    crontab_t *cb;

    if( zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "z|zz", &argv1, &argv2, &argv3) == SUCCESS ){
        // if array
        if (Z_TYPE_P(argv1) == IS_ARRAY) {
            // foreach argv1
            l = zend_hash_num_elements(Z_ARRVAL_P(argv1));
            zend_hash_internal_pointer_reset(Z_ARRVAL_P(argv1));
            array_init(return_value);
            for(i = 0; i < l; i++) {
                if(zend_hash_get_current_key(Z_ARRVAL_P(argv1), &key, &idx, 0) == HASH_KEY_IS_STRING) {
                    // is al
                    cb = emalloc(sizeof(crontab_t));
                    memset(cb, 0, sizeof(crontab_t));
                    cb->pid = -1;

                    cb->execute = estrdup(key);
                    cb->count = 0;

                    key1 = estrdup(key);
                    n = parse_line(key1, cb TSRMLS_CC);
                    efree(key1);

                    crontab_last->next = cb;
                    crontab_last = cb;

                    zend_hash_get_current_data(Z_ARRVAL_P(argv1), (void**)&val);

                    cb->callback = *val;

                    zval_copy_ctor(&cb->callback);

                    add_next_index_long(return_value, ++crontab_count);
                    cb->index = crontab_count;
                } else {
                    php_error_docref(NULL TSRMLS_CC, E_WARNING, "Invalid args(array key must be string).");
                }

                zend_hash_move_forward(Z_ARRVAL_P(argv1));
            } // for i
        } else {// IS_ARRAY
            if(ZEND_NUM_ARGS() < 2) {
                php_error_docref(NULL TSRMLS_CC, E_WARNING, "Invalid args2.");
                RETURN_FALSE;
            }

            cb = emalloc(sizeof(crontab_t));
            memset(cb, 0, sizeof(crontab_t));
            cb->pid = -1;

            cb->execute = estrdup(Z_STRVAL_P(argv1));
            cb->count = 0;

            key1 = estrdup(Z_STRVAL_P(argv1));
            n = parse_line(key1, cb TSRMLS_CC);
            efree(key1);

            crontab_last->next = cb;
            crontab_last = cb;

            cb->callback = emalloc(sizeof(zval));
            memset(cb->callback, 0, sizeof(zval));

            *(cb->callback) = *argv2;

            zval_copy_ctor(cb->callback);
            crontab_count++;
            cb->index = crontab_count;

            if(ZEND_NUM_ARGS() == 3) {
                cb->intval = Z_LVAL_P(argv3);
            }else{
                cb->intval = -1;
            }

            RETURN_LONG(crontab_count);
        }
    } else {
        php_error_docref(NULL TSRMLS_CC, E_WARNING, "Invalid args.");
        RETURN_FALSE;
    }
}

PHP_METHOD(crontab_ce, run) {
    sigset_t            set;
    struct itimerval    itv;
    uintptr_t           now, timer;
    pid_t               pid;
    crontab_t           *current;

    current = crontab_head->next;
    
    signal(SIGALRM, sigroutine);
    signal(SIGVTALRM, sigroutine);
    signal(SIGCHLD, sigroutine);

    sigemptyset(&set);
    sigaddset(&set, SIGALRM);
    sigaddset(&set, SIGCHLD);

    if ( sigprocmask(SIG_BLOCK, &set, NULL) == -1 ) {
        php_error_docref(NULL TSRMLS_CC, E_ERROR, "sigpromask() failed");
        RETURN_FALSE;
    }

    sigemptyset(&set);

    last_time = time(NULL);

    for(;;) {

        timer = 60 - time(NULL) % 60;
        timer *= 1000;

        itv.it_interval.tv_sec = 0;
        itv.it_interval.tv_usec = 0;
        itv.it_value.tv_sec = timer / 1000;
        itv.it_value.tv_usec = (timer % 1000) * 1000;

        if ( setitimer(ITIMER_REAL, &itv, NULL) == -1 ) {
            php_error_docref(NULL TSRMLS_CC, E_ERROR, "setitimer() failed");
            RETURN_FALSE;
        }

        sigsuspend(&set);

        now = time(NULL);
        flag_line(last_time, now TSRMLS_CC);
    }
}

PHP_METHOD(crontab_ce, info) {
    crontab_t *current;
    zval *row;

    array_init(return_value);

    current = crontab_head->next;
    while(current != NULL) {
        MAKE_STD_ZVAL(row);
        array_init(row);
        add_assoc_long(row, "id", current->index);
        add_assoc_string(row, "execute", current->execute, 1);
        add_assoc_long(row, "count", current->count);
        
        add_next_index_zval(return_value, row);

        current = current->next;
    }
}

zend_function_entry crontab_methods[] = {
    PHP_ME(crontab_ce, __construct,             NULL,     ZEND_ACC_PUBLIC | ZEND_ACC_CTOR)    //    final protected __construct
    PHP_ME(crontab_ce, __destruct,              NULL,     ZEND_ACC_PUBLIC | ZEND_ACC_DTOR)    //    final public __destruct
    PHP_ME(crontab_ce, add,                     NULL,     ZEND_ACC_PUBLIC )    //    static public final getInstance
    PHP_ME(crontab_ce, run,                     NULL,     ZEND_ACC_PUBLIC )    //    static public final getInstance
    PHP_ME(crontab_ce, info,                    NULL,     ZEND_ACC_PUBLIC | ZEND_ACC_STATIC )    //    static public final getInstance
    {NULL, NULL, NULL}
};

/* {{{ PHP_MINIT_FUNCTION
 */
PHP_MINIT_FUNCTION(crontab)
{
    /* If you have INI entries, uncomment these lines 
    REGISTER_INI_ENTRIES();
    */

    zend_class_entry ce;
    INIT_CLASS_ENTRY(ce, "Crontab", crontab_methods);
    crontab_ce = zend_register_internal_class(&ce TSRMLS_CC);

    crontab_head = emalloc(sizeof(crontab_t));
    memset(crontab_head, 0, sizeof(crontab_t));
    crontab_last = crontab_head;

    crontab_count = 0;

    return SUCCESS;
}
/* }}} */

/* {{{ PHP_MSHUTDOWN_FUNCTION
 */
PHP_MSHUTDOWN_FUNCTION(crontab)
{
    /* uncomment this line if you have INI entries
    UNREGISTER_INI_ENTRIES();
    */
    return SUCCESS;
}
/* }}} */

/* Remove if there's nothing to do at request start */
/* {{{ PHP_RINIT_FUNCTION
 */
PHP_RINIT_FUNCTION(crontab)
{
    return SUCCESS;
}
/* }}} */

/* Remove if there's nothing to do at request end */
/* {{{ PHP_RSHUTDOWN_FUNCTION
 */
PHP_RSHUTDOWN_FUNCTION(crontab)
{
    return SUCCESS;
}
/* }}} */

/* {{{ PHP_MINFO_FUNCTION
 */
PHP_MINFO_FUNCTION(crontab)
{
    php_info_print_table_start();
    php_info_print_table_header(2, "crontab support", "enabled");
    php_info_print_table_end();

    /* Remove comments if you have entries in php.ini
    DISPLAY_INI_ENTRIES();
    */
}
/* }}} */

static void sigroutine(int signo) {
    pid_t pid;
    crontab_t *current;

    if(signo == SIGCHLD){
        for(;;) {
            pid = waitpid(-1, NULL, WNOHANG);
            if ( pid == 0 ) {
                break;
            }

            if ( pid == -1 ) {
                if ( errno == EINTR ) {
                    continue;
                }
                break;
            }

            current = crontab_head->next;
            while(current != NULL){
                if(current->pid == pid) {
                    current->pid = -1;
                    break;
                }
                current = current->next;
            } // while current
        }// for
    } // if SIGCHLD
}

static int parse_line(char *str, crontab_t *cron TSRMLS_DC) {
    int n, i;
    char *ptr;
    char *tokens[6];
    int weekUsed = 0;
    int daysUsed = 0;

    n = strlen(str);
    i = 0;
    ptr = str;
    do {
        if(*str == NULL || *str == '\0' || i >= 5) break;
        tokens[i++] = str;

        str += strspn(str, "1234567890,/*-abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ");
        if(*str != '\0') {
            *str = '\0';
        }
        if(str - ptr < n) {
            str++;
            str = strpbrk(str, "1234567890,/*-abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ");
        }
    }while(1);

    // check
    if(i != 5){
        php_error_docref(NULL, E_ERROR, "Invaild crontab line: %s", ptr);
    }

    parse_field(cron->minutes, 60, 0, NULL, tokens[0] TSRMLS_CC);
    parse_field(cron->hours, 24, 0, NULL, tokens[1] TSRMLS_CC);
    parse_field(cron->days, 32, 0, NULL, tokens[2] TSRMLS_CC);
    parse_field(cron->months, 12, 0, monthsAry, tokens[3] TSRMLS_CC);
    parse_field(cron->weeks, 7, 0, weeksAry, tokens[4] TSRMLS_CC);

    for (i = 0; i < 7; ++i) {
        if (cron->weeks[i] == 0) {
            weekUsed = 1;
            break;
        }
    }

    for (i = 0; i < 32; ++i) {
        if (cron->days[i] == 0) {
            daysUsed = 1;
            break;
        }
    }

    if (weekUsed != daysUsed) {
        if (weekUsed) {
            memset(cron->days, 0, sizeof(cron->days));
        } else {
            // daysUsed 
            memset(cron->weeks, 0, sizeof(cron->weeks));
        }   
    }

    return 1;
}

static int parse_field(char *ary, int modvalue, int off, const char *names, char *ptr TSRMLS_DC) {
    char *base = ptr;
    int n1 = -1;
    int n2 = -1;
    int skip = 0;
    char *endp;

    // this can't happen due to config_read()
    /*if (base == NULL)
        return;*/

    while (1) {
        skip = 0;

        /* Handle numeric digit or symbol or '*' */
        if (*ptr == '*') {
            n1 = 0;  /* everything will be filled */
            n2 = modvalue - 1;
            skip = 1;
            ++ptr;
        } else if (isdigit(*ptr)) {
            if (n1 < 0) {
                n1 = strtol(ptr, &endp, 10) + off;
            } else {
                n2 = strtol(ptr, &endp, 10) + off;
            }
            ptr = endp; /* gcc likes temp var for &endp */
            skip = 1;
        } else if (names) {
            int i;

            for (i = 0; names[i]; i += 3) {
                /* was using strncmp before... */
                if (strncasecmp(ptr, &names[i], 3) == 0) {
                    ptr += 3;
                    if (n1 < 0) {
                        n1 = i / 3;
                    } else {
                        n2 = i / 3;
                    }
                    skip = 1;
                    break;
                }
            }
        }

        /* handle optional range '-' */
        if (skip == 0) {
            return 0;
        }
        if (*ptr == '-' && n2 < 0) {
            ++ptr;
            continue;
        }

        /*
         * collapse single-value ranges, handle skipmark, and fill
         * in the character array appropriately.
         */
        if (n2 < 0) {
            n2 = n1;
        }
        if (*ptr == '/') {
            char *endp;
            skip = strtol(ptr + 1, &endp, 10);
            ptr = endp; /* gcc likes temp var for &endp */
        }

        /*
         * fill array, using a failsafe is the easiest way to prevent
         * an endless loop
         */
        {
            int s0 = 1;
            int failsafe = 1024;

            --n1;
            do {
                n1 = (n1 + 1) % modvalue;

                if (--s0 == 0) {
                    ary[n1 % modvalue] = 1;
                    s0 = skip;
                }
                if (--failsafe == 0) {
                    return 0;
                }
            } while (n1 != n2);
        }
        if (*ptr != ',') {
            break;
        }
        ++ptr;
        n1 = -1;
        n2 = -1;
    }

    if (*ptr) {
        return 0;
    }

    return 1;
}

static int flag_line(uintptr_t t1, uintptr_t t2 TSRMLS_DC) {
    uintptr_t t;
    struct tm *ptm;
    crontab_t *current;
    zval *retval, *idx;
    zval **params[1];
    int i = 0;
    pid_t pid;

    current = crontab_head->next;

    for (t = t1 - t1 % 60; t <= t2; t += 60){
        if (t <= t1) continue;

        last_time = t;

        ptm = (struct tm *)localtime(&t);

        while(current != NULL){
            if ( (current->pid == -1) && (current->intval > -1 || (current->minutes[ptm->tm_min]
             && current->hours[ptm->tm_hour]
             && (current->days[ptm->tm_mday] || current->weeks[ptm->tm_wday])
             && current->months[ptm->tm_mon]))
            ){
                // fork && run callback 
                pid = fork();
                switch(pid){
                    case -1:
                        php_error_docref(NULL TSRMLS_CC, E_ERROR, "run crontab(id:%d) error: fork process failed!", current->index);
                        return FAILURE;
                    case 0:
                        current->count++;
                        MAKE_STD_ZVAL(idx);
                        ZVAL_LONG(idx, current->index);
                        params[0] = &idx;
                        
                        if(call_user_function_ex(EG(function_table), NULL, current->callback, &retval, 1, params, 0, NULL TSRMLS_CC) == FAILURE){
                            php_error_docref(NULL TSRMLS_CC, E_WARNING, "call user function(id:%d) failed!", current->index);
                        }
                        exit(0);
                    default:
                        current->pid = pid;
                        current->count++;
                }
            }
            
            current = current->next;
        }

        current = crontab_head->next;
    }

    return SUCCESS;
}

/* The previous line is meant for vim and emacs, so it can correctly fold and 
   unfold functions in source code. See the corresponding marks just before 
   function definition, where the functions purpose is also documented. Please 
   follow this convention for the convenience of others editing your code.
*/


/*
 * Local variables:
 * tab-width: 4
 * c-basic-offset: 4
 * End:
 * vim600: noet sw=4 ts=4 fdm=marker
 * vim<600: noet sw=4 ts=4
 */