Merge pull request #1176 from jan-cerny/fix_common_util

cipherboy · web-flow · commit 1df38bda2808 · 2018-08-22T08:41:25.000-04:00
Move public symbols to a public header
diff --git a/src/CPE/cpe_session.c b/src/CPE/cpe_session.c
@@ -34,6 +34,7 @@
 #include "OVAL/public/oval_agent_api.h"
 #include "source/public/oscap_source.h"
 #include "source/oscap_source_priv.h"
+#include "oscap_helpers.h"
 
 static inline bool cpe_session_add_default_cpe(struct cpe_session *session)
 {
diff --git a/src/CPE/cpename.c b/src/CPE/cpename.c
@@ -42,6 +42,7 @@
 
 #include "cpe_name.h"
 #include "common/util.h"
+#include "oscap_helpers.h"
 
 #define CPE_URI_SUPPORTED "2.3"
 
diff --git a/src/CVRF/cvrf_priv.c b/src/CVRF/cvrf_priv.c
@@ -49,6 +49,7 @@
 
 #include "source/oscap_source_priv.h"
 #include "source/public/oscap_source.h"
+#include "oscap_helpers.h"
 
 
 /***************************************************************************
diff --git a/src/CVSS/cvss.c b/src/CVSS/cvss.c
@@ -41,6 +41,7 @@
 #include "public/cvss_score.h"
 #include "cvss_priv.h"
 #include "common/elements.h"
+#include "oscap_helpers.h"
 
 #define CVSS_SUPPORTED "2.0"
 #define NS_VULN_STR BAD_CAST "vuln"
diff --git a/src/DS/ds_common.c b/src/DS/ds_common.c
@@ -30,6 +30,7 @@
 #include "common/oscap_acquire.h"
 #include "source/oscap_source_priv.h"
 #include "source/public/oscap_source.h"
+#include "oscap_helpers.h"
 
 #include <libxml/tree.h>
 
diff --git a/src/DS/ds_sds_session.c b/src/DS/ds_sds_session.c
@@ -41,6 +41,7 @@
 #include "source/public/oscap_source.h"
 #include "source/xslt_priv.h"
 #include <libxml/tree.h>
+#include "oscap_helpers.h"
 
 struct ds_sds_session {
 	struct oscap_source *source;            ///< Source DataStream raw representation
diff --git a/src/DS/rds.c b/src/DS/rds.c
@@ -48,6 +48,7 @@
 #include <libxml/tree.h>
 #include <libxml/xpath.h>
 #include <libxml/xpathInternals.h>
+#include "oscap_helpers.h"
 
 static const char* arf_ns_uri = "http://scap.nist.gov/schema/asset-reporting-format/1.1";
 static const char* core_ns_uri = "http://scap.nist.gov/schema/reporting-core/1.1";
diff --git a/src/DS/sds.c b/src/DS/sds.c
@@ -42,6 +42,7 @@
 #include "common/oscap_acquire.h"
 #include "source/oscap_source_priv.h"
 #include "source/public/oscap_source.h"
+#include "oscap_helpers.h"
 
 #include <sys/stat.h>
 #include <time.h>
diff --git a/src/OVAL/oval_session.c b/src/OVAL/oval_session.c
@@ -43,6 +43,7 @@
 #include "public/oval_session.h"
 #include "../DS/public/ds_sds_session.h"
 #include "oscap_source.h"
+#include "oscap_helpers.h"
 
 
 static const char *oscap_productname = "cpe:/a:open-scap:oscap";
diff --git a/src/OVAL/probes/independent/system_info_probe.c b/src/OVAL/probes/independent/system_info_probe.c
@@ -83,6 +83,7 @@
 #include <errno.h>
 #include <limits.h>
 #include "system_info_probe.h"
+#include "oscap_helpers.h"
 
 #if defined(OS_LINUX)
 #include <sys/socket.h>
diff --git a/src/OVAL/probes/oval_fts.c b/src/OVAL/probes/oval_fts.c
@@ -34,6 +34,7 @@
 #include <errno.h>
 #include <pcre.h>
 
+#include "oscap_helpers.h"
 #include "fsdev.h"
 #include "_probe-api.h"
 #include "probe/entcmp.h"
diff --git a/src/OVAL/probes/probe-api.c b/src/OVAL/probes/probe-api.c
@@ -53,6 +53,7 @@
 #include "probe/entcmp.h"
 #include "probe/probe.h"
 #include "SEAP/generic/strto.h"
+#include "oscap_helpers.h"
 
 extern probe_rcache_t  *OSCAP_GSYM(pcache);
 extern probe_ncache_t  *OSCAP_GSYM(ncache);
diff --git a/src/OVAL/probes/unix/linux/systemdshared.h b/src/OVAL/probes/unix/linux/systemdshared.h
@@ -37,6 +37,7 @@
 
 #include <dbus/dbus.h>
 #include "common/debug_priv.h"
+#include "oscap_helpers.h"
 
 // Old versions of libdbus API don't have DBusBasicValue and DBus8ByteStruct
 // as a public typedefs.
diff --git a/src/OVAL/probes/unix/process58_probe.c b/src/OVAL/probes/unix/process58_probe.c
@@ -102,6 +102,7 @@ extern char const *_cap_names[];
 #include <ctype.h>
 #include "common/oscap_buffer.h"
 #include "process58_probe.h"
+#include "oscap_helpers.h"
 
 #define CHUNK_SIZE 1024
 
diff --git a/src/OVAL/probes/unix/process_probe.c b/src/OVAL/probes/unix/process_probe.c
@@ -56,6 +56,7 @@
 #include "probe/entcmp.h"
 #include "common/debug_priv.h"
 #include "process_probe.h"
+#include "oscap_helpers.h"
 
 oval_schema_version_t over;
 
diff --git a/src/OVAL/probes/unix/symlink_probe.c b/src/OVAL/probes/unix/symlink_probe.c
@@ -39,6 +39,7 @@
 #include <errno.h>
 #include <limits.h>
 #include <stdlib.h>
+#include "oscap_helpers.h"
 
 #include <probe/probe.h>
 #include <probe/option.h>
diff --git a/src/OVAL/probes/windows/registry_probe.c b/src/OVAL/probes/windows/registry_probe.c
@@ -32,6 +32,7 @@
 #include "probe/entcmp.h"
 #include "probe/probe.h"
 #include "registry_probe.h"
+#include "oscap_helpers.h"
 
 #define UNLIMITED_DEPTH -1
 
diff --git a/src/OVAL/probes/windows/wmi57_probe.c b/src/OVAL/probes/windows/wmi57_probe.c
@@ -38,6 +38,7 @@
 #include "oval_definitions.h"
 #include "oval_sexp.h"
 #include "wmi57_probe.h"
+#include "oscap_helpers.h"
 
 static struct oscap_list *get_wql_fields(WCHAR *wql)
 {
diff --git a/src/SCE/sce_engine.c b/src/SCE/sce_engine.c
@@ -36,6 +36,7 @@
 #include "common/oscap_string.h"
 #include "common/debug_priv.h"
 #include "sce_engine_api.h"
+#include "oscap_helpers.h"
 
 #include <stdlib.h>
 #include <string.h>
diff --git a/src/XCCDF/profile.c b/src/XCCDF/profile.c
@@ -30,6 +30,7 @@
 #include "helpers.h"
 #include "xccdf_impl.h"
 #include "common/debug_priv.h"
+#include "oscap_helpers.h"
 
 struct xccdf_setvalue *xccdf_setvalue_new(void)
 {
diff --git a/src/XCCDF/resolve.c b/src/XCCDF/resolve.c
@@ -29,6 +29,7 @@
 #include "item.h"
 #include "helpers.h"
 #include "common/tsort.h"
+#include "oscap_helpers.h"
 
 typedef void (*xccdf_textresolve_func)(void *child, void *parent);
 
diff --git a/src/XCCDF/result.c b/src/XCCDF/result.c
@@ -65,6 +65,7 @@
 #include "oscap_text.h"
 #include "common/debug_priv.h"
 #include "source/oscap_source_priv.h"
+#include "oscap_helpers.h"
 
 #define XCCDF_NUMERIC_SIZE 32
 
diff --git a/src/XCCDF/rule.c b/src/XCCDF/rule.c
@@ -35,6 +35,7 @@
 #include "helpers.h"
 #include "xccdf_impl.h"
 #include "common/debug_priv.h"
+#include "oscap_helpers.h"
 
 bool xccdf_content_parse(xmlTextReaderPtr reader, struct xccdf_item *parent)
 {
diff --git a/src/XCCDF/value.c b/src/XCCDF/value.c
@@ -33,6 +33,7 @@
 #include "xccdf_impl.h"
 #include "common/elements.h"
 #include "common/debug_priv.h"
+#include "oscap_helpers.h"
 
 static struct xccdf_value_instance *xccdf_value_instance_new(xccdf_value_type_t type);
 static struct xccdf_value_instance *_xccdf_value_get_instance_by_selector_internal(const struct xccdf_value *value, const char *selector);
diff --git a/src/XCCDF/xccdf_session.c b/src/XCCDF/xccdf_session.c
@@ -57,6 +57,7 @@
 #include "item.h"
 #include "public/xccdf_session.h"
 #include "XCCDF_POLICY/public/check_engine_plugin.h"
+#include "oscap_helpers.h"
 
 struct oval_content_resource {
 	char *href;					///< Coresponds with xccdf:check-content-ref/\@href.
diff --git a/src/XCCDF_POLICY/check_engine_plugin.c b/src/XCCDF_POLICY/check_engine_plugin.c
@@ -25,6 +25,7 @@
 
 #include "public/check_engine_plugin.h"
 #include "common/util.h"
+#include "oscap_helpers.h"
 #include "common/_error.h"
 
 #ifndef _WIN32
diff --git a/src/XCCDF_POLICY/xccdf_policy.c b/src/XCCDF_POLICY/xccdf_policy.c
@@ -53,6 +53,7 @@
 #include "common/text_priv.h"
 #include "XCCDF/result_scoring_priv.h"
 #include "xccdf_policy_resolve.h"
+#include "oscap_helpers.h"
 
 /* Macros to generate iterators, getters and setters */
 OSCAP_GETTER(struct xccdf_benchmark *, xccdf_policy_model, benchmark)
diff --git a/src/XCCDF_POLICY/xccdf_policy_remediate.c b/src/XCCDF_POLICY/xccdf_policy_remediate.c
@@ -46,6 +46,7 @@
 #include "xccdf_policy_priv.h"
 #include "xccdf_policy_model_priv.h"
 #include "public/xccdf_policy.h"
+#include "oscap_helpers.h"
 
 static int _rule_add_info_message(struct xccdf_rule_result *rr, ...)
 {
diff --git a/src/common/elements.c b/src/common/elements.c
@@ -43,6 +43,7 @@
 #include "_error.h"
 #include "debug_priv.h"
 #include "elements.h"
+#include "oscap_helpers.h"
 
 
 const struct oscap_string_map OSCAP_BOOL_MAP[] = {
diff --git a/src/common/error.c b/src/common/error.c
@@ -34,6 +34,7 @@
 #include "_error.h"
 #include "err_queue.h"
 #include "debug_priv.h"
+#include "oscap_helpers.h"
 
 #ifdef OSCAP_THREAD_SAFE
 static pthread_key_t __key;
diff --git a/src/common/oscap_acquire.c b/src/common/oscap_acquire.c
@@ -48,6 +48,7 @@
 #include "common/oscap_buffer.h"
 #include "common/_error.h"
 #include "oscap_string.h"
+#include "oscap_helpers.h"
 
 #ifndef OSCAP_TEMP_DIR
 #define OSCAP_TEMP_DIR "/tmp"
diff --git a/src/common/oscapxml.c b/src/common/oscapxml.c
@@ -52,6 +52,7 @@
 #include "source/schematron_priv.h"
 #include "source/validate_priv.h"
 #include "source/xslt_priv.h"
+#include "oscap_helpers.h"
 
 const char *const OSCAP_SCHEMA_PATH = OSCAP_DEFAULT_SCHEMA_PATH;
 const char *const OSCAP_XSLT_PATH = OSCAP_DEFAULT_XSLT_PATH;
diff --git a/src/common/public/oscap_helpers.h b/src/common/public/oscap_helpers.h
@@ -0,0 +1,71 @@
+/*
+ * Copyright 2018 Red Hat Inc., Durham, North Carolina.
+ * All Rights Reserved.
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ *
+ * Authors:
+ *      Jan Černý <jcerny@redhat.com>
+ */
+
+#ifndef OSCAP_HELPERS_H
+#define OSCAP_HELPERS_H
+
+#include <stdarg.h>
+#include "oscap_export.h"
+
+/**
+ * Print to a newly allocated string using variable arguments.
+ * @param fmt printf-like format string
+ * @return a string
+ */
+OSCAP_API char *oscap_sprintf(const char *fmt, ...);
+
+/**
+ * Return the canonicalized absolute pathname.
+ * @param path path
+ * @param resolved_path pointer to a buffer
+ * @return resolved_path or NULL in case of error
+ */
+OSCAP_API char *oscap_realpath(const char *path, char *resolved_path);
+
+/**
+ * Return filename component of a path
+ * @param path path
+ * The function can modify the contents of path, so the caller should pass a copy of path.
+ * @return filename component of path
+ * The caller is responsible to free the returned buffer.
+ */
+OSCAP_API char *oscap_basename(char *path);
+
+/**
+ * Return directory component of a path
+ * @param path path
+ * The function can modify the contents of path, so the caller should pass a copy of path.
+ * @return dirname component of path
+ * The caller is responsible to free the returned buffer.
+ */
+OSCAP_API char *oscap_dirname(char *path);
+
+/**
+ * Extract tokens from strings
+ * @param str string
+ * @param delim st of delimiters
+ * @param saveptr Used to store position information between calls to strtok_s
+ * @return token
+ */
+OSCAP_API char *oscap_strtok_r(char *str, const char *delim, char **saveptr);
+
+#endif /* OSCAP_HELPERS_H */
diff --git a/src/common/text.c b/src/common/text.c
@@ -38,6 +38,7 @@
 #include "text_priv.h"
 #include "util.h"
 #include "list.h"
+#include "oscap_helpers.h"
 
 const char * const OSCAP_LANG_ENGLISH    = "en";
 const char * const OSCAP_LANG_ENGLISH_US = "en-US";
diff --git a/src/common/util.c b/src/common/util.c
@@ -34,6 +34,7 @@
 #include "util.h"
 #include "_error.h"
 #include "oscap.h"
+#include "oscap_helpers.h"
 
 #ifdef _WIN32
 #include <stdlib.h>
diff --git a/src/common/util.h b/src/common/util.h
diff --git a/src/common/xml_iterate.c b/src/common/xml_iterate.c
diff --git a/src/source/validate.c b/src/source/validate.c
diff --git a/src/source/xslt.c b/src/source/xslt.c
diff --git a/utils/oscap-ds.c b/utils/oscap-ds.c
diff --git a/utils/oscap-tool.c b/utils/oscap-tool.c
diff --git a/utils/oscap-xccdf.c b/utils/oscap-xccdf.c

Original file line number	Diff line number	Diff line change
`@@ -34,6 +34,7 @@`
`34`	`34`	`#include "OVAL/public/oval_agent_api.h"`
`35`	`35`	`#include "source/public/oscap_source.h"`
`36`	`36`	`#include "source/oscap_source_priv.h"`
	`37`	`+#include "oscap_helpers.h"`
`37`	`38`
`38`	`39`	`static inline bool cpe_session_add_default_cpe(struct cpe_session *session)`
`39`	`40`	`{`