gh #98 Extend kvp open function to also support URLs #99
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -37,6 +37,15 @@ ut_kvp_instance_t *gKVP_Instance = NULL; | |
| #define UT_KVP_MAGIC (0xdeadbeef) | ||
| #define UT_KVP_MAX_INCLUDE_DEPTH 5 | ||
|
|
||
| #define UT_KVP_HTTPS_PREFIX "https://" | ||
| #define UT_KVP_HTTP_PREFIX "http://" | ||
| #define UT_KVP_FILE_PREFIX "file://" | ||
|
|
||
| // Automatically calculate lengths by subtracting the '\0' null terminator | ||
| #define UT_KVP_HTTPS_PREFIX_LEN (sizeof(UT_KVP_HTTPS_PREFIX) - 1) | ||
| #define UT_KVP_HTTP_PREFIX_LEN (sizeof(UT_KVP_HTTP_PREFIX) - 1) | ||
| #define UT_KVP_FILE_PREFIX_LEN (sizeof(UT_KVP_FILE_PREFIX) - 1) | ||
|
|
||
| typedef struct | ||
| { | ||
| uint32_t magic; | ||
|
|
@@ -95,51 +104,117 @@ void ut_kvp_destroyInstance(ut_kvp_instance_t *pInstance) | |
| pInternal = NULL; | ||
| } | ||
|
|
||
| static bool is_url(const char *input) | ||
| { | ||
| if (input == NULL) | ||
| { | ||
| return false; | ||
| } | ||
|
|
||
| // Check for http:// | ||
| if (strncmp(input, UT_KVP_HTTP_PREFIX, UT_KVP_HTTP_PREFIX_LEN) == 0) | ||
| { | ||
| return true; | ||
| } | ||
|
|
||
| // Check for https:// | ||
| if (strncmp(input, UT_KVP_HTTPS_PREFIX, UT_KVP_HTTPS_PREFIX_LEN) == 0) | ||
| { | ||
| return true; | ||
| } | ||
|
|
||
| // No matches found | ||
| return false; | ||
| } | ||
|
|
||
| ut_kvp_status_t ut_kvp_open(ut_kvp_instance_t *pInstance, const char *fileNameOrUrl) | ||
| { | ||
| struct fy_node *node; | ||
|
|
||
| ut_kvp_instance_internal_t *pInternal = validateInstance(pInstance); | ||
|
|
||
| // Validate KVP instance handle | ||
| if (pInternal == NULL) | ||
| { | ||
| return UT_KVP_STATUS_INVALID_INSTANCE; | ||
| } | ||
|
|
||
| // Validate fileNameOrUrl parameter | ||
| if (fileNameOrUrl == NULL) | ||
| { | ||
| UT_LOG_ERROR("NULL PARAM [fileNameOrUrl]"); | ||
| return UT_KVP_STATUS_NULL_PARAM; | ||
kanjoe24 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| } | ||
|
|
||
| // Determine if input is a URL(e.g., http:// or https://) | ||
KarthikeyanR470 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| bool bFilenameIsAUrl = is_url(fileNameOrUrl); | ||
|
|
||
| // Handle URL-based input | ||
| if(bFilenameIsAUrl == true) | ||
| { | ||
| char *pYaml = NULL; | ||
|
|
||
| pYaml = malloc(UT_KVP_MAX_ELEMENT_SIZE); | ||
|
|
||
| if ( pYaml == NULL ) | ||
| { | ||
| UT_LOG_ERROR("Malloc was not able to provide memory\n"); | ||
| return UT_KVP_STATUS_PARSING_ERROR; | ||
| } | ||
|
|
||
| snprintf(pYaml, UT_KVP_MAX_ELEMENT_SIZE, "include: %s\n", fileNameOrUrl); | ||
KarthikeyanR470 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| // Pass the dynamically allocated YAML string to openMemory() for parsing | ||
| ut_kvp_status_t status = ut_kvp_openMemory(pInstance, pYaml, strlen(pYaml)); | ||
| free(pYaml); | ||
| return status; | ||
| } | ||
|
|
||
| // Handle file-based input | ||
| if (strncmp(fileNameOrUrl, UT_KVP_FILE_PREFIX, UT_KVP_FILE_PREFIX_LEN) == 0) | ||
| { | ||
| // Skip "file://" | ||
| fileNameOrUrl = fileNameOrUrl + UT_KVP_FILE_PREFIX_LEN; | ||
| } | ||
|
|
||
| // Verify that the file is accessible | ||
| if (access(fileNameOrUrl, F_OK) != 0) | ||
|
Contributor
There was a problem hiding this comment. doesn't this fail if the filename is a URL? Since the URL hasn't been downloaded you can't call access on it? Why don't you get the error
Contributor
Author
There was a problem hiding this comment. The URL path does not reach the access() check. Line 151 in 60483b5 1.If the input is a URL (is_url(...) == true), the function immediately enters the 'if' block, constructs an in-memory YAML string, calls ut_kvp_openMemory(), and returns. So URLs never fall through to the access() path. 2.The access(fileNameOrUrl, F_OK) check is executed only for non-URL file-based inputs. So the code does not attempt to call access() on a URL, and therefore we do not get UT_KVP_STATUS_FILE_OPEN_ERROR for URL cases. |
||
| { | ||
| UT_LOG_ERROR("[%s] cannot be accessed", fileNameOrUrl); | ||
| return UT_KVP_STATUS_FILE_OPEN_ERROR; | ||
| } | ||
|
|
||
| // If there’s already a handle, merge the new document into existing YAML | ||
| if(pInternal->fy_handle) | ||
| { | ||
| merge_nodes(fy_document_root(pInternal->fy_handle), fy_document_root(fy_document_build_from_file(NULL, fileNameOrUrl))); | ||
KarthikeyanR470 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
KarthikeyanR470 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| } | ||
| else | ||
| { | ||
| // Otherwise, create a new YAML document handle | ||
| pInternal->fy_handle = fy_document_create(NULL); | ||
| } | ||
|
|
||
| // Ensure the handle is valid | ||
| if (NULL == pInternal->fy_handle) | ||
| { | ||
| UT_LOG_ERROR("Unable to parse file/memory"); | ||
| ut_kvp_close( pInstance ); | ||
Ulrond marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| return UT_KVP_STATUS_PARSING_ERROR; | ||
| } | ||
|
|
||
| // Build a source YAML document from the file | ||
| struct fy_document *srcDoc = fy_document_build_from_file(NULL, fileNameOrUrl); | ||
|
|
||
| if(fy_document_resolve(srcDoc) != 0) | ||
| { | ||
| UT_LOG_ERROR("Error resolving document for anchors, aliases and merge keys"); | ||
| ut_kvp_close(pInstance); | ||
| fy_document_destroy(srcDoc); | ||
| return UT_KVP_STATUS_PARSING_ERROR; | ||
| } | ||
|
|
||
| // Process and copy nodes from source document into internal handle | ||
| node = process_node_copy(fy_document_root(srcDoc), pInternal->fy_handle, 0); | ||
|
|
||
| if (node == NULL) | ||
|
|
@@ -1218,4 +1293,4 @@ static const void *find_pattern_from_buffer(const void *buffer, size_t bufferLen | |
| } | ||
|
|
||
| return NULL; | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Also update about url here