Merge pull request #1476 from fledge-iot/2.6.0RC

2.6.0RC

Author: Mohit04tomar

C/common/config_category.cpp

@@ -21,6 +21,7 @@
 #include <logger.h>
 #include <stdexcept>
 #include <string_utils.h>
+#include <boost/algorithm/string/replace.hpp>
 
 
 using namespace std;
@@ -872,6 +873,50 @@ vector<string> ConfigCategory::getOptions(const string& name) const
 	throw new ConfigItemNotFound();
 }
 
+/**
+ * Return the permissions of the configuration category item
+ *
+ * @param name	The name of the configuration item to return
+ * @return vector<string>	The configuration item permissions
+ * @throws exception if the item does not exist in the category
+ */
+vector<string> ConfigCategory::getPermissions(const string& name) const
+{
+	for (unsigned int i = 0; i < m_items.size(); i++)
+	{
+		if (name.compare(m_items[i]->m_name) == 0)
+		{
+			return m_items[i]->m_permissions;
+		}
+	}
+	throw new ConfigItemNotFound();
+}
+
+/**
+ * Return true if the user has permission to update the named item
+ *
+ * @param name	The name of the configuration item to return
+ * @param rolename	The name of the user role to test
+ * @return bool	True if the named user can update the configuration item
+ * @throws exception if the item does not exist in the category
+ */
+bool ConfigCategory::hasPermission(const std::string& name, const std::string& rolename) const
+{
+	for (unsigned int i = 0; i < m_items.size(); i++)
+	{
+		if (name.compare(m_items[i]->m_name) == 0)
+		{
+			if (m_items[i]->m_permissions.empty())
+				return true;
+			for (auto& perm : m_items[i]->m_permissions)
+				if (rolename.compare(perm) == 0)
+					return true;
+			return false;
+		}
+	}
+	throw new ConfigItemNotFound();
+}
+
 /**
  * Return if the configuration item is a string item
  *
@@ -1300,6 +1345,18 @@ ConfigCategory::CategoryItem::CategoryItem(const string& name,
 		}
 	}
 
+	if (item.HasMember("permissions"))
+	{
+		const Value& permissions = item["permissions"];
+		if (permissions.IsArray())
+		{
+			for (SizeType i = 0; i < permissions.Size(); i++)
+			{
+				m_permissions.push_back(string(permissions[i].GetString()));
+			}
+		}
+	}
+
 	if (item.HasMember("items"))
 	{
 		if (item["items"].IsString())
@@ -1358,6 +1415,7 @@ ConfigCategory::CategoryItem::CategoryItem(const string& name,
 		// If it's not a real eject, check the string buffer it is:
 		if (!item["value"].IsObject())
 		{
+			boost::replace_all(m_value, "\\n", "");
 			Document check;
 			check.Parse(m_value.c_str());
 			if (check.HasParseError())
@@ -1466,6 +1524,7 @@ ConfigCategory::CategoryItem::CategoryItem(const string& name,
 		// If it's not a real eject, check the string buffer it is:
 		if (!item["default"].IsObject())
 		{
+			boost::replace_all(m_default, "\\n", "");
 			Document check;
 			check.Parse(m_default.c_str());
 			if (check.HasParseError())
@@ -1624,6 +1683,10 @@ ConfigCategory::CategoryItem::CategoryItem(const CategoryItem& rhs)
 	m_listSize = rhs.m_listSize;
 	m_listItemType = rhs.m_listItemType;
 	m_listName = rhs.m_listName;
+	for (auto it = rhs.m_permissions.cbegin(); it != rhs.m_permissions.cend(); it++)
+	{
+		m_permissions.push_back(*it);
+	}
 }
 
 /**
@@ -1655,6 +1718,18 @@ ostringstream convert;
 		convert << "], ";
 	}
 
+	if (m_permissions.size() > 0)
+	{
+		convert << "\"permissions\" : [ ";
+		for (int i = 0; i < m_permissions.size(); i++)
+		{
+			if (i > 0)
+				convert << ",";
+			convert << "\"" << m_permissions[i] << "\"";
+		}
+		convert << "], ";
+	}
+
 	if (m_itemType == StringItem ||
 	    m_itemType == BoolItem ||
 	    m_itemType == EnumerationItem ||
@@ -1835,6 +1910,17 @@ ostringstream convert;
 		}
 		convert << "]";
 	}
+	if (m_permissions.size() > 0)
+	{
+		convert << ", \"permissions\" : [ ";
+		for (int i = 0; i < m_permissions.size(); i++)
+		{
+			if (i > 0)
+				convert << ",";
+			convert << "\"" << m_permissions[i] << "\"";
+		}
+		convert << "]";
+	}
 	if (!m_listSize.empty())
 	{
 		convert << ", \"listSize\" : \"" << m_listSize << "\"";

C/common/file_utils.cpp

@@ -0,0 +1,130 @@
+/*
+ * Fledge utilities functions for handling files and directories
+ *
+ * Copyright (c) 2024 Dianomic Systems
+ *
+ * Released under the Apache 2.0 Licence
+ *
+ * Author: Ray Verhoeff
+ */
+
+#include <stdio.h>
+#include <unistd.h>
+#include <fcntl.h>
+#include <ftw.h>
+#include <stdexcept>
+#include "file_utils.h"
+
+/**
+ * Callback for Linux file walk routine 'nftw'
+ *
+ * @param filePath	File full path
+ * @param sb		struct stat to hold file information
+ * @param typeflag	File type flag: FTW_F = file, FTW_D = directory
+ * @param ftwbuf	struct FTW to hold name offset and file depth
+ * @return			Zero if successful
+ */
+static int fileDeleteCallback(const char *filePath, const struct stat *sb, int typeflag, struct FTW *ftwbuf)
+{
+    return remove(filePath);
+}
+
+/**
+ * Copy a file
+ * 
+ * @param to	Full path of the destination file
+ * @param from	Full path of the source file
+ * @return		Zero if successful
+ */
+int copyFile(const char *to, const char *from)
+{
+	int fd_to, fd_from;
+	char buf[4096];
+	ssize_t nread;
+	int saved_errno;
+
+	fd_from = open(from, O_RDONLY);
+	if (fd_from < 0)
+		return -1;
+
+	fd_to = open(to, O_WRONLY | O_CREAT | O_EXCL, 0666);
+	if (fd_to < 0)
+		goto out_error;
+
+	while (nread = read(fd_from, buf, sizeof buf), nread > 0)
+	{
+		char *out_ptr = buf;
+		ssize_t nwritten;
+
+		do
+		{
+			nwritten = write(fd_to, out_ptr, nread);
+
+			if (nwritten >= 0)
+			{
+				nread -= nwritten;
+				out_ptr += nwritten;
+			}
+			else if (errno != EINTR)
+			{
+				goto out_error;
+			}
+		} while (nread > 0);
+	}
+
+	if (nread == 0)
+	{
+		if (close(fd_to) < 0)
+		{
+			fd_to = -1;
+			goto out_error;
+		}
+		close(fd_from);
+
+		/* Success! */
+		return 0;
+	}
+
+out_error:
+	saved_errno = errno;
+
+	close(fd_from);
+	if (fd_to >= 0)
+		close(fd_to);
+
+	errno = saved_errno;
+	return -1;
+}
+
+/**
+ * Create a single directory.
+ * This routine cannot create a directory tree from a full path.
+ * This routine throws a std::runtime_error exception if the directory cannot be created.
+ *
+ * @param directoryName		Full path of the directory to create
+ */
+void createDirectory(const std::string &directoryName)
+{
+	const char *path = directoryName.c_str();
+	struct stat sb;
+	if (stat(path, &sb) != 0)
+	{
+		int retcode;
+		if ((retcode = mkdir(path, S_IRWXU | S_IRWXG)) != 0)
+		{
+			std::string exceptionMessage = "Unable to create directory " + directoryName + ": error: " + std::to_string(retcode);
+			throw std::runtime_error(exceptionMessage.c_str());
+		}
+	}
+}
+
+/**
+ * Remove a directory with all subdirectories and files
+ *
+ * @param path		Full path of the directory
+ * @return			Zero if successful
+ */
+int removeDirectory(const char *path)
+{
+    return nftw(path, fileDeleteCallback, 64, FTW_DEPTH | FTW_PHYS);
+}