pkgconf/libpkgconf/audit.c

99 lines
2.8 KiB
C
Raw Permalink Normal View History

/*
* audit.c
* package audit log functions
*
* Copyright (c) 2016 pkgconf authors (see AUTHORS).
*
* Permission to use, copy, modify, and/or distribute this software for any
* purpose with or without fee is hereby granted, provided that the above
* copyright notice and this permission notice appear in all copies.
*
* This software is provided 'as is' and without any warranty, express or
* implied. In no event shall the authors be liable for any damages arising
* from the use of this software.
*/
#include <libpkgconf/libpkgconf.h>
2016-12-11 01:28:34 +00:00
/*
* !doc
*
* libpkgconf `audit` module
* =========================
*
* The libpkgconf `audit` module contains the functions related to attaching an audit log file
* to a ``pkgconf_client_t`` object.
*
* The audit log format is the same as the output generated by the ``PKG_CONFIG_LOG`` environment
* variable.
*/
/*
* !doc
*
* .. c:function:: void pkgconf_audit_set_log(pkgconf_client_t *client, FILE *auditf)
*
* Sets the audit log file pointer on `client` to `auditf`.
* The callee is responsible for closing any previous log files.
*
* :param pkgconf_client_t* client: The client object to modify.
* :param FILE* auditf: The file pointer for the already open log file.
* :return: nothing
*/
void
pkgconf_audit_set_log(pkgconf_client_t *client, FILE *auditf)
{
client->auditf = auditf;
}
2016-12-11 01:28:34 +00:00
/*
* !doc
*
* .. c:function:: void pkgconf_audit_log(pkgconf_client_t *client, const char *format, ...)
*
* Logs a message to the opened audit log (if any).
*
* :param pkgconf_client_t* client: The client object the log message is for.
* :param char* format: The format string to use for the log messages.
* :return: nothing
*/
void
pkgconf_audit_log(pkgconf_client_t *client, const char *format, ...)
{
va_list va;
if (client->auditf == NULL)
return;
va_start(va, format);
vfprintf(client->auditf, format, va);
va_end(va);
}
2016-12-11 01:28:34 +00:00
/*
* !doc
*
* .. c:function:: void pkgconf_audit_log_dependency(pkgconf_client_t *client, const pkgconf_pkg_t *dep, const pkgconf_dependency_t *depnode)
*
* Convenience function which logs a dependency node to the opened audit log (if any).
*
* :param pkgconf_client_t* client: The client object the log message is for.
* :param pkgconf_pkg_t* dep: The dependency package object being logged.
* :param pkgconf_dependency_t* depnode: The dependency object itself being logged.
* :return: nothing
*/
void
pkgconf_audit_log_dependency(pkgconf_client_t *client, const pkgconf_pkg_t *dep, const pkgconf_dependency_t *depnode)
{
if (client->auditf == NULL)
return;
fprintf(client->auditf, "%s ", dep->id);
if (depnode->version != NULL && depnode->compare != PKGCONF_CMP_ANY)
{
fprintf(client->auditf, "%s %s ", pkgconf_pkg_get_comparator(depnode), depnode->version);
}
fprintf(client->auditf, "[%s]\n", dep->version);
}