Add function psl_check_version_number()

This commit is contained in:
Tim Rühsen 2015-09-23 14:04:17 +02:00
parent eabf39c174
commit 00b9cfb119
3 changed files with 35 additions and 125 deletions

View File

@ -1,124 +0,0 @@
/*
* Copyright(c) 2014 Tim Ruehsen
*
* 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.
*
* This file is part of libpsl.
*
* Header file for libpsl library routines
*
* Changelog
* 20.03.2014 Tim Ruehsen created
*
*/
#ifndef _LIBPSL_LIBPSL_H
#define _LIBPSL_LIBPSL_H
#include <stdio.h>
#include <time.h>
#ifdef __cplusplus
extern "C" {
#endif
/**
* psl_error_t:
* @PSL_SUCCESS: Successful return.
* @PSL_ERR_INVALID_ARG: Invalid argument.
* @PSL_ERR_CONVERTER: Failed to open libicu utf-16 converter
* @PSL_ERR_TO_UTF16: Failed to convert to utf-16.
* @PSL_ERR_TO_LOWER: Failed to convert utf-16 to lowercase.
* @PSL_ERR_TO_UTF8: Failed to convert utf-16 to utf-8.
*
* Return codes for PSL functions.
* Negative return codes mean failure.
* Positive values are reserved for non-error return codes.
*/
typedef enum {
PSL_SUCCESS = 0,
PSL_ERR_INVALID_ARG = -1,
PSL_ERR_CONVERTER = -2, /* failed to open libicu utf-16 converter */
PSL_ERR_TO_UTF16 = -3, /* failed to convert to utf-16 */
PSL_ERR_TO_LOWER = -4, /* failed to convert utf-16 to lowercase */
PSL_ERR_TO_UTF8 = -5 /* failed to convert utf-16 to utf-8 */
} psl_error_t;
typedef struct _psl_ctx_st psl_ctx_t;
/* frees PSL context */
void
psl_free(psl_ctx_t *psl);
/* loads PSL data from file */
psl_ctx_t *
psl_load_file(const char *fname);
/* loads PSL data from FILE pointer */
psl_ctx_t *
psl_load_fp(FILE *fp);
/* retrieves builtin PSL data */
const psl_ctx_t *
psl_builtin(void);
/* checks whether domain is a public suffix or not */
int
psl_is_public_suffix(const psl_ctx_t *psl, const char *domain);
/* checks whether cookie_domain is acceptable for domain or not */
int
psl_is_cookie_domain_acceptable(const psl_ctx_t *psl, const char *hostname, const char *cookie_domain);
/* returns the longest not registrable domain within 'domain' or NULL if none found */
const char *
psl_unregistrable_domain(const psl_ctx_t *psl, const char *domain);
/* returns the shortest possible registrable domain part or NULL if domain is not registrable at all */
const char *
psl_registrable_domain(const psl_ctx_t *psl, const char *domain);
/* convert a string into lowercase UTF-8 */
psl_error_t
psl_str_to_utf8lower(const char *str, const char *encoding, const char *locale, char **lower);
/* does not include exceptions */
int
psl_suffix_count(const psl_ctx_t *psl);
/* just counts exceptions */
int
psl_suffix_exception_count(const psl_ctx_t *psl);
/* just counts wildcards */
int
psl_suffix_wildcard_count(const psl_ctx_t *psl);
/* returns compilation time */
time_t
psl_builtin_compile_time(void);
/* returns mtime of PSL source file */
time_t
psl_builtin_file_time(void);
/* returns SHA1 checksum (hex-encoded, lowercase) of PSL source file */
const char *
psl_builtin_sha1sum(void);
/* returns file name of PSL source file */
const char *
psl_builtin_filename(void);
/* returns library version */
const char *
psl_get_version(void);
/* returns wether the built-in data is outdated or not */
int
psl_builtin_outdated(void);
#ifdef __cplusplus
}
#endif
#endif /* _LIBPSL_LIBPSL_H */

View File

@ -116,9 +116,12 @@ const char *
/* returns file name of PSL source file */ /* returns file name of PSL source file */
const char * const char *
psl_builtin_filename(void); psl_builtin_filename(void);
/* returns library version */ /* returns library version string */
const char * const char *
psl_get_version(void); psl_get_version(void);
/* checks library version number */
int
psl_check_version_number(int version);
/* returns wether the built-in data is outdated or not */ /* returns wether the built-in data is outdated or not */
int int
psl_builtin_outdated(void); psl_builtin_outdated(void);

View File

@ -1000,6 +1000,37 @@ const char *psl_get_version(void)
#endif #endif
} }
/**
* psl_check_version_number:
* @version: Version number (hex) to check against.
*
* Check the given version number is at minimum the current library version number.
* The version number must be a hexadecimal number like 0x000a01 (V0.10.1).
*
* Returns: Returns the library version number if the given version number is at least
* the version of the library, else return 0; If the argument is 0, the function returns
* the library version number without performing a check.
*
* Since: 0.11.0
**/
int psl_check_version_number(int version)
{
if (version) {
int major = version >> 16;
int minor = (version >> 8) & 0xFF;
int patch = version & 0xFF;
if (major < PSL_VERSION_MAJOR
|| (major == PSL_VERSION_MAJOR && minor < PSL_VERSION_MINOR)
|| (major == PSL_VERSION_MAJOR && minor == PSL_VERSION_MINOR && patch < PSL_VERSION_PATCH))
{
return 0;
}
}
return PSL_VERSION_NUMBER;
}
/* return whether hostname is an IP address or not */ /* return whether hostname is an IP address or not */
static int _isip(const char *hostname) static int _isip(const char *hostname)
{ {