API: libcrmcommon: Deprecate xml_acl_enabled()

Signed-off-by: Reid Wahl <[email protected]>

Author: nrwahl2

include/crm/common/Makefile.am

@@ -1,5 +1,5 @@
 #
-# Copyright 2004-2024 the Pacemaker project contributors
+# Copyright 2004-2025 the Pacemaker project contributors
 #
 # The version control history for this file may have further details.
 #
@@ -12,6 +12,7 @@ include $(top_srcdir)/mk/common.mk
 headerdir=$(pkgincludedir)/crm/common
 
 header_HEADERS = acl.h 			\
+		 acl_compat.h		\
 		 actions.h		\
 		 agents.h 		\
 		 cib.h 			\

include/crm/common/acl.h

@@ -1,5 +1,5 @@
 /*
- * Copyright 2004-2024 the Pacemaker project contributors
+ * Copyright 2004-2025 the Pacemaker project contributors
  *
  * The version control history for this file may have further details.
  *
@@ -23,14 +23,17 @@ extern "C" {
  * \ingroup core
  */
 
-bool xml_acl_enabled(const xmlNode *xml);
 void xml_acl_disable(xmlNode *xml);
 bool xml_acl_denied(const xmlNode *xml);
 bool xml_acl_filtered_copy(const char *user, xmlNode* acl_source, xmlNode *xml,
                            xmlNode **result);
 
 bool pcmk_acl_required(const char *user);
 
+#if !defined(PCMK_ALLOW_DEPRECATED) || (PCMK_ALLOW_DEPRECATED == 1)
+#include <crm/common/acl_compat.h>
+#endif  // !defined(PCMK_ALLOW_DEPRECATED) || (PCMK_ALLOW_DEPRECATED == 1)
+
 #ifdef __cplusplus
 }
 #endif

include/crm/common/acl_compat.h

@@ -0,0 +1,37 @@
+/*
+ * Copyright 2004-2025 the Pacemaker project contributors
+ *
+ * The version control history for this file may have further details.
+ *
+ * This source code is licensed under the GNU Lesser General Public License
+ * version 2.1 or later (LGPLv2.1+) WITHOUT ANY WARRANTY.
+ */
+
+#ifndef PCMK__CRM_COMMON_ACL_COMPAT__H
+#define PCMK__CRM_COMMON_ACL_COMPAT__H
+
+#include <stdbool.h>
+
+#include <libxml/tree.h>        // xmlNode
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/**
+ * \file
+ * \brief Deprecated Pacemaker ACL API
+ * \ingroup core
+ * \deprecated Do not include this header directly. The XML APIs in this
+ *             header, and the header itself, will be removed in a future
+ *             release.
+ */
+
+//! \deprecated Do not use
+bool xml_acl_enabled(const xmlNode *xml);
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif  // PCMK__CRM_COMMON_ACL_COMPAT__H

lib/common/acl.c

@@ -697,24 +697,6 @@ xml_acl_disable(xmlNode *xml)
     }
 }
 
-/*!
- * \brief Check whether or not an XML node is ACL-enabled
- *
- * \param[in]  xml node to check
- *
- * \return true if XML node exists and is ACL-enabled, false otherwise
- */
-bool
-xml_acl_enabled(const xmlNode *xml)
-{
-    if (xml && xml->doc && xml->doc->_private){
-        xml_doc_private_t *docpriv = xml->doc->_private;
-
-        return pcmk_is_set(docpriv->flags, pcmk__xf_acl_enabled);
-    }
-    return false;
-}
-
 /*!
  * \internal
  * \brief Deny access to an XML tree's document based on ACLs
@@ -924,3 +906,22 @@ pcmk__update_acl_user(xmlNode *request, const char *field,
 
     return requested_user;
 }
+
+// Deprecated functions kept only for backward API compatibility
+// LCOV_EXCL_START
+
+#include <crm/common/xml_compat.h>
+
+bool
+xml_acl_enabled(const xmlNode *xml)
+{
+    if (xml && xml->doc && xml->doc->_private){
+        xml_doc_private_t *docpriv = xml->doc->_private;
+
+        return pcmk_is_set(docpriv->flags, pcmk__xf_acl_enabled);
+    }
+    return false;
+}
+
+// LCOV_EXCL_STOP
+// End deprecated API