1*a3cefe7fSPierre Pronchery /*
2*a3cefe7fSPierre Pronchery * audit.c
3*a3cefe7fSPierre Pronchery * package audit log functions
4*a3cefe7fSPierre Pronchery *
5*a3cefe7fSPierre Pronchery * Copyright (c) 2016 pkgconf authors (see AUTHORS).
6*a3cefe7fSPierre Pronchery *
7*a3cefe7fSPierre Pronchery * Permission to use, copy, modify, and/or distribute this software for any
8*a3cefe7fSPierre Pronchery * purpose with or without fee is hereby granted, provided that the above
9*a3cefe7fSPierre Pronchery * copyright notice and this permission notice appear in all copies.
10*a3cefe7fSPierre Pronchery *
11*a3cefe7fSPierre Pronchery * This software is provided 'as is' and without any warranty, express or
12*a3cefe7fSPierre Pronchery * implied. In no event shall the authors be liable for any damages arising
13*a3cefe7fSPierre Pronchery * from the use of this software.
14*a3cefe7fSPierre Pronchery */
15*a3cefe7fSPierre Pronchery
16*a3cefe7fSPierre Pronchery #include <libpkgconf/libpkgconf.h>
17*a3cefe7fSPierre Pronchery
18*a3cefe7fSPierre Pronchery /*
19*a3cefe7fSPierre Pronchery * !doc
20*a3cefe7fSPierre Pronchery *
21*a3cefe7fSPierre Pronchery * libpkgconf `audit` module
22*a3cefe7fSPierre Pronchery * =========================
23*a3cefe7fSPierre Pronchery *
24*a3cefe7fSPierre Pronchery * The libpkgconf `audit` module contains the functions related to attaching an audit log file
25*a3cefe7fSPierre Pronchery * to a ``pkgconf_client_t`` object.
26*a3cefe7fSPierre Pronchery *
27*a3cefe7fSPierre Pronchery * The audit log format is the same as the output generated by the ``PKG_CONFIG_LOG`` environment
28*a3cefe7fSPierre Pronchery * variable.
29*a3cefe7fSPierre Pronchery */
30*a3cefe7fSPierre Pronchery
31*a3cefe7fSPierre Pronchery /*
32*a3cefe7fSPierre Pronchery * !doc
33*a3cefe7fSPierre Pronchery *
34*a3cefe7fSPierre Pronchery * .. c:function:: void pkgconf_audit_set_log(pkgconf_client_t *client, FILE *auditf)
35*a3cefe7fSPierre Pronchery *
36*a3cefe7fSPierre Pronchery * Sets the audit log file pointer on `client` to `auditf`.
37*a3cefe7fSPierre Pronchery * The callee is responsible for closing any previous log files.
38*a3cefe7fSPierre Pronchery *
39*a3cefe7fSPierre Pronchery * :param pkgconf_client_t* client: The client object to modify.
40*a3cefe7fSPierre Pronchery * :param FILE* auditf: The file pointer for the already open log file.
41*a3cefe7fSPierre Pronchery * :return: nothing
42*a3cefe7fSPierre Pronchery */
43*a3cefe7fSPierre Pronchery void
pkgconf_audit_set_log(pkgconf_client_t * client,FILE * auditf)44*a3cefe7fSPierre Pronchery pkgconf_audit_set_log(pkgconf_client_t *client, FILE *auditf)
45*a3cefe7fSPierre Pronchery {
46*a3cefe7fSPierre Pronchery client->auditf = auditf;
47*a3cefe7fSPierre Pronchery }
48*a3cefe7fSPierre Pronchery
49*a3cefe7fSPierre Pronchery /*
50*a3cefe7fSPierre Pronchery * !doc
51*a3cefe7fSPierre Pronchery *
52*a3cefe7fSPierre Pronchery * .. c:function:: void pkgconf_audit_log(pkgconf_client_t *client, const char *format, ...)
53*a3cefe7fSPierre Pronchery *
54*a3cefe7fSPierre Pronchery * Logs a message to the opened audit log (if any).
55*a3cefe7fSPierre Pronchery *
56*a3cefe7fSPierre Pronchery * :param pkgconf_client_t* client: The client object the log message is for.
57*a3cefe7fSPierre Pronchery * :param char* format: The format string to use for the log messages.
58*a3cefe7fSPierre Pronchery * :return: nothing
59*a3cefe7fSPierre Pronchery */
60*a3cefe7fSPierre Pronchery void
pkgconf_audit_log(pkgconf_client_t * client,const char * format,...)61*a3cefe7fSPierre Pronchery pkgconf_audit_log(pkgconf_client_t *client, const char *format, ...)
62*a3cefe7fSPierre Pronchery {
63*a3cefe7fSPierre Pronchery va_list va;
64*a3cefe7fSPierre Pronchery
65*a3cefe7fSPierre Pronchery if (client->auditf == NULL)
66*a3cefe7fSPierre Pronchery return;
67*a3cefe7fSPierre Pronchery
68*a3cefe7fSPierre Pronchery va_start(va, format);
69*a3cefe7fSPierre Pronchery vfprintf(client->auditf, format, va);
70*a3cefe7fSPierre Pronchery va_end(va);
71*a3cefe7fSPierre Pronchery }
72*a3cefe7fSPierre Pronchery
73*a3cefe7fSPierre Pronchery /*
74*a3cefe7fSPierre Pronchery * !doc
75*a3cefe7fSPierre Pronchery *
76*a3cefe7fSPierre Pronchery * .. c:function:: void pkgconf_audit_log_dependency(pkgconf_client_t *client, const pkgconf_pkg_t *dep, const pkgconf_dependency_t *depnode)
77*a3cefe7fSPierre Pronchery *
78*a3cefe7fSPierre Pronchery * Convenience function which logs a dependency node to the opened audit log (if any).
79*a3cefe7fSPierre Pronchery *
80*a3cefe7fSPierre Pronchery * :param pkgconf_client_t* client: The client object the log message is for.
81*a3cefe7fSPierre Pronchery * :param pkgconf_pkg_t* dep: The dependency package object being logged.
82*a3cefe7fSPierre Pronchery * :param pkgconf_dependency_t* depnode: The dependency object itself being logged.
83*a3cefe7fSPierre Pronchery * :return: nothing
84*a3cefe7fSPierre Pronchery */
85*a3cefe7fSPierre Pronchery void
pkgconf_audit_log_dependency(pkgconf_client_t * client,const pkgconf_pkg_t * dep,const pkgconf_dependency_t * depnode)86*a3cefe7fSPierre Pronchery pkgconf_audit_log_dependency(pkgconf_client_t *client, const pkgconf_pkg_t *dep, const pkgconf_dependency_t *depnode)
87*a3cefe7fSPierre Pronchery {
88*a3cefe7fSPierre Pronchery if (client->auditf == NULL)
89*a3cefe7fSPierre Pronchery return;
90*a3cefe7fSPierre Pronchery
91*a3cefe7fSPierre Pronchery fprintf(client->auditf, "%s ", dep->id);
92*a3cefe7fSPierre Pronchery if (depnode->version != NULL && depnode->compare != PKGCONF_CMP_ANY)
93*a3cefe7fSPierre Pronchery {
94*a3cefe7fSPierre Pronchery fprintf(client->auditf, "%s %s ", pkgconf_pkg_get_comparator(depnode), depnode->version);
95*a3cefe7fSPierre Pronchery }
96*a3cefe7fSPierre Pronchery
97*a3cefe7fSPierre Pronchery fprintf(client->auditf, "[%s]\n", dep->version);
98*a3cefe7fSPierre Pronchery }
99