php_libtld.c

Go to the documentation of this file.

/* TLD library -- PHP extension to call tld() and tld_check_uri() from PHP
 * Copyright (c) 2013-2025  Made to Order Software Corp.  All Rights Reserved
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the
 * "Software"), to deal in the Software without restriction, including
 * without limitation the rights to use, copy, modify, merge, publish,
 * distribute, sublicense, and/or sell copies of the Software, and to
 * permit persons to whom the Software is furnished to do so, subject to
 * the following conditions:
 *
 * The above copyright notice and this permission notice shall be included
 * in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
 * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
 * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
 * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */
 
#include <php.h>
#include "libtld/tld.h"
 
PHP_FUNCTION(check_tld);
ZEND_BEGIN_ARG_INFO_EX(arginfo_check_tld, 0, 0, 1)
    ZEND_ARG_INFO(0, uri)
ZEND_END_ARG_INFO()
 
PHP_FUNCTION(check_uri);
ZEND_BEGIN_ARG_INFO_EX(arginfo_check_uri, 0, 0, 1)
    ZEND_ARG_INFO(0, uri)
ZEND_END_ARG_INFO()
 
PHP_FUNCTION(check_email);
ZEND_BEGIN_ARG_INFO_EX(arginfo_check_email, 0, 0, 1)
    ZEND_ARG_INFO(0, email)
ZEND_END_ARG_INFO()
 
/* {{{ pgsql_functions[]
 */
const zend_function_entry libtld_functions[] = {
    PHP_FE(check_tld,   arginfo_check_tld)
    PHP_FE(check_uri,   arginfo_check_uri)
    PHP_FE(check_email, arginfo_check_email)
    PHP_FE_END
};
/* }}} */
 
/* {{{ pgsql_module_entry
 */
zend_module_entry libtld_module_entry = {
    STANDARD_MODULE_HEADER,
    "libtld",
    libtld_functions,
    NULL, //PHP_MINIT(libtld),
    NULL, //PHP_MSHUTDOWN(libtld),
    NULL, //PHP_RINIT(libtld),
    NULL, //PHP_RSHUTDOWN(libtld),
    NULL, //PHP_MINFO(libtld),
    NO_VERSION_YET,
    0, //PHP_MODULE_GLOBALS(libtld),
    NULL, //PHP_GINIT(libtld),
    NULL, // Global constructor
    NULL, // Global destructor
    NULL, // Post deactivate
    STANDARD_MODULE_PROPERTIES_EX
};
/* }}} */
 
zend_module_entry *get_module(void)
{
    return &libtld_module_entry;
}
 
 
/* {{{ proto mixed check_tld(string uri)
   Check a URI and return the result or FALSE */
PHP_FUNCTION(check_tld)
{
    char *query;
    int query_len;
    int argc = ZEND_NUM_ARGS();
    struct tld_info info;
    enum tld_result r;
 
    if (argc != 1)
    {
        WRONG_PARAM_COUNT;
    }
 
    if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s", &query, &query_len) == FAILURE)
    {
        RETURN_FALSE;
    }
 
    r = tld(query, &info);
 
    array_init(return_value);
    add_assoc_long(return_value, "result", r);
    add_assoc_long(return_value, "category", info.f_category);
    add_assoc_long(return_value, "status", info.f_status);
    add_assoc_long(return_value, "offset", info.f_offset);
    if(info.f_country != NULL)
    {
        add_assoc_string(return_value, "country", (char *) info.f_country, 1);
    }
    if(info.f_tld != NULL)
    {
        add_assoc_string(return_value, "tld", (char *) info.f_tld, 1);
    }
}
/* }}} */
 
/* {{{ proto mixed check_uri(string uri, string protocols, int flags)
   Check a complete URI for validity */
PHP_FUNCTION(check_uri)
{
    char *query, *protocols;
    int query_len, *protocols_len;
    int argc = ZEND_NUM_ARGS();
    long flags = 0;
    struct tld_info info;
    enum tld_result r;
 
    if (argc != 3)
    {
        WRONG_PARAM_COUNT;
    }
 
    if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "ssl", &query, &query_len, &protocols, &protocols_len, &flags) == FAILURE)
    {
        RETURN_FALSE;
    }
 
    r = tld_check_uri(query, &info, protocols, flags);
 
    array_init(return_value);
    add_assoc_long(return_value, "result", r);
    add_assoc_long(return_value, "category", info.f_category);
    add_assoc_long(return_value, "status", info.f_status);
    add_assoc_long(return_value, "offset", info.f_offset);
    if(info.f_country != NULL)
    {
        add_assoc_string(return_value, "country", (char *) info.f_country, 1);
    }
    if(info.f_tld != NULL)
    {
        add_assoc_string(return_value, "tld", (char *) info.f_tld, 1);
    }
}
/* }}} */
 
/* {{{ proto mixed check_email(string eamil, int flags)
   Check a string of emails as defined in an email field like the From: or To:
   fields found in the email header. */
PHP_FUNCTION(check_email)
{
    char *emails;
    int emails_len;
    int argc = ZEND_NUM_ARGS();
    int idx;
    long flags = 0;
    struct tld_email_list *list;
    struct tld_email email;
    zval *email_arr;
    enum tld_result r;
 
    if (argc != 2)
    {
        WRONG_PARAM_COUNT;
    }
 
    if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "sl", &emails, &emails_len, &flags) == FAILURE)
    {
        RETURN_FALSE;
    }
 
    list = tld_email_alloc();
    if(list == NULL)
    {
        RETURN_FALSE;
    }
 
    array_init(return_value);
 
    r = tld_email_parse(list, emails, flags);
 
    idx = 0;
    if(r == TLD_RESULT_SUCCESS)
    {
        while(tld_email_next(list, &email))
        {
            ALLOC_INIT_ZVAL(email_arr);
            array_init(email_arr);
            // only the group is optional because it is so rarely used
            if(*email.f_group != '\0')
            {
                add_assoc_string(email_arr, "group",         (char *) email.f_group, 1);
            }
            add_assoc_string(email_arr, "original_email",    (char *) email.f_original_email, 1);
            add_assoc_string(email_arr, "fullname",          (char *) email.f_fullname, 1);
            add_assoc_string(email_arr, "username",          (char *) email.f_username, 1);
            add_assoc_string(email_arr, "domain",            (char *) email.f_domain, 1);
            add_assoc_string(email_arr, "email_only",        (char *) email.f_email_only, 1);
            add_assoc_string(email_arr, "canonicalized_email", (char *) email.f_canonicalized_email, 1);
 
            add_index_zval(return_value, idx, email_arr);
            ++idx;
        }
    }
    add_assoc_long(return_value, "count", idx);
 
    // also return the result of the call
    add_assoc_long(return_value, "result", r);
 
    tld_email_free(list);
}
/* }}} */
 
/* additional Doxygen documentation to not interfer with the PHP documentation. */
 
/* vim: ts=4 sw=4 et
 */