/**
* @brief Export content of the specified datastore for the given module into a file
* referenced by the descriptor 'fd_out'
*/
static int
srcfg_export_datastore(struct ly_ctx *ly_ctx, int fd_out, const char *module_name, LYD_FORMAT format)
{
int rc = SR_ERR_INTERNAL;
struct lyd_node *data_tree = NULL;
int ret = 0;
CHECK_NULL_ARG2(ly_ctx, module_name);
/* get data tree of currently stored configuration */
rc = srcfg_get_module_data(ly_ctx, module_name, &data_tree);
if (SR_ERR_OK != rc) {
goto cleanup;
}
/* dump data */
ret = lyd_print_fd(fd_out, data_tree, format, LYP_WITHSIBLINGS | LYP_FORMAT);
CHECK_ZERO_LOG_GOTO(ret, rc, SR_ERR_INTERNAL, cleanup, "Unable to print the data: %s", ly_errmsg());
rc = SR_ERR_OK;
cleanup:
if (NULL != data_tree) {
lyd_free_withsiblings(data_tree);
}
return rc;
}
/**
* @brief Adds a new session to the session list of the connection.
*/
static int
cl_conn_add_session(sr_conn_ctx_t *connection, sr_session_ctx_t *session)
{
sr_session_list_t *session_item = NULL, *tmp = NULL;
CHECK_NULL_ARG2(connection, session);
session_item = calloc(1, sizeof(*session_item));
if (NULL == session_item) {
SR_LOG_ERR_MSG("Cannot allocate memory for new session list entry.");
return SR_ERR_NOMEM;
}
session_item->session = session;
pthread_mutex_lock(&connection->lock);
/* append session entry at the end of list */
if (NULL == connection->session_list) {
connection->session_list = session_item;
} else {
tmp = connection->session_list;
while (NULL != tmp->next) {
tmp = tmp->next;
}
tmp->next = session_item;
}
pthread_mutex_unlock(&connection->lock);
return SR_ERR_OK;
}
int
cl_session_set_errors(sr_session_ctx_t *session, Sr__Error **errors, size_t error_cnt)
{
sr_error_info_t *tmp_info = NULL;
CHECK_NULL_ARG2(session, errors);
pthread_mutex_lock(&session->lock);
/* first release already allocated space for errors */
for (size_t i = 0; i < session->error_info_size; i++) {
if (NULL != session->error_info[i].message) {
free((void*)session->error_info[i].message);
session->error_info[i].message = NULL;
}
if (NULL != session->error_info[i].xpath) {
free((void*)session->error_info[i].xpath);
session->error_info[i].xpath = NULL;
}
}
if (session->error_info_size < error_cnt) {
tmp_info = realloc(session->error_info, (error_cnt * sizeof(*tmp_info)));
if (NULL == tmp_info) {
SR_LOG_ERR_MSG("Unable to allocate error information.");
pthread_mutex_unlock(&session->lock);
return SR_ERR_NOMEM;
}
session->error_info = tmp_info;
session->error_info_size = error_cnt;
}
for (size_t i = 0; i < error_cnt; i++) {
if (NULL != errors[i]->message) {
session->error_info[i].message = strdup(errors[i]->message);
if (NULL == session->error_info[i].message) {
SR_LOG_WRN_MSG("Unable to allocate error message, will be left NULL.");
}
} else {
session->error_info[i].message = NULL;
}
if (NULL != errors[i]->xpath) {
session->error_info[i].xpath = strdup(errors[i]->xpath);
if (NULL == session->error_info[i].xpath) {
SR_LOG_WRN_MSG("Unable to allocate error xpath, will be left NULL.");
}
} else {
session->error_info[i].xpath = NULL;
}
}
session->error_cnt = error_cnt;
pthread_mutex_unlock(&session->lock);
return SR_ERR_OK;
}
/**
* @brief Sends a message via provided connection.
*/
static int
cl_message_send(sr_conn_ctx_t *conn_ctx, Sr__Msg *msg)
{
size_t msg_size = 0;
int pos = 0, sent = 0;
int rc = SR_ERR_OK;
CHECK_NULL_ARG2(conn_ctx, msg);
/* find out required message size */
msg_size = sr__msg__get_packed_size(msg);
if ((msg_size <= 0) || (msg_size > SR_MAX_MSG_SIZE)) {
SR_LOG_ERR("Unable to send the message of size %zuB.", msg_size);
return SR_ERR_INTERNAL;
}
/* expand the buffer if needed */
rc = cl_conn_msg_buf_expand(conn_ctx, msg_size + SR_MSG_PREAM_SIZE);
if (SR_ERR_OK != rc) {
SR_LOG_ERR_MSG("Cannot expand buffer for the message.");
return rc;
}
/* write 4-byte length */
sr_uint32_to_buff(msg_size, conn_ctx->msg_buf);
/* pack the message */
sr__msg__pack(msg, (conn_ctx->msg_buf + SR_MSG_PREAM_SIZE));
/* send the message */
do {
sent = send(conn_ctx->fd, (conn_ctx->msg_buf + pos), (msg_size + SR_MSG_PREAM_SIZE - pos), 0);
if (sent > 0) {
pos += sent;
} else {
if (errno == EINTR) {
continue;
}
SR_LOG_ERR("Error by sending of the message: %s.", sr_strerror_safe(errno));
return SR_ERR_DISCONNECT;
}
} while ((pos < (msg_size + SR_MSG_PREAM_SIZE)) && (sent > 0));
return SR_ERR_OK;
}
int
cl_socket_connect(sr_conn_ctx_t *conn_ctx, const char *socket_path)
{
struct sockaddr_un addr;
struct timeval tv = { 0, };
int fd = -1, rc = -1;
CHECK_NULL_ARG2(socket_path, socket_path);
SR_LOG_DBG("Connecting to socket=%s", socket_path);
/* prepare a socket */
fd = socket(AF_UNIX, SOCK_STREAM, 0);
if (-1 == fd) {
SR_LOG_ERR("Unable to create a new socket: %s", sr_strerror_safe(errno));
return SR_ERR_INTERNAL;
}
memset(&addr, 0, sizeof(addr));
addr.sun_family = AF_UNIX;
strncpy(addr.sun_path, socket_path, sizeof(addr.sun_path)-1);
/* connect to server */
rc = connect(fd, (struct sockaddr*)&addr, sizeof(addr));
if (-1 == rc) {
SR_LOG_DBG("Unable to connect to socket=%s: %s", socket_path, sr_strerror_safe(errno));
close(fd);
return SR_ERR_DISCONNECT;
}
/* set timeout for receive operation */
if (SR_REQUEST_TIMEOUT > 0) {
tv.tv_sec = SR_REQUEST_TIMEOUT;
tv.tv_usec = 0;
rc = setsockopt(fd, SOL_SOCKET, SO_RCVTIMEO, (char *)&tv, sizeof(tv));
if (-1 == rc) {
SR_LOG_ERR("Unable to set timeout for socket operations on socket=%s: %s", socket_path, sr_strerror_safe(errno));
close(fd);
return SR_ERR_DISCONNECT;
}
}
conn_ctx->fd = fd;
return SR_ERR_OK;
}
/**
* @brief Initializes a plugin.
*/
static int
sr_pd_init_plugin(sr_session_ctx_t *session, sr_pd_plugin_ctx_t *plugin_ctx)
{
int rc = SR_ERR_OK;
CHECK_NULL_ARG2(session, plugin_ctx);
/* call init callback */
rc = plugin_ctx->init_cb(session, &plugin_ctx->private_ctx);
if (SR_ERR_OK != rc) {
SR_LOG_ERR("'%s' in '%s' returned an error: %s.", SR_PLUGIN_INIT_FN_NAME, plugin_ctx->filename, sr_strerror(rc));
plugin_ctx->initialized = false;
} else {
plugin_ctx->initialized = true;
}
return rc;
}
/**
* @brief Convert data tree difference of type LYD_DIFF_CHANGED to corresponding set of Sysrepo public API calls.
*/
static int
srcfg_convert_lydiff_changed(const char *xpath, struct lyd_node *node)
{
int rc = SR_ERR_INTERNAL;
sr_val_t value = { 0, SR_UNKNOWN_T };
struct lyd_node_leaf_list *data_leaf = NULL;
CHECK_NULL_ARG2(xpath, node);
switch (node->schema->nodetype) {
case LYS_LEAF:
case LYS_LEAFLIST:
data_leaf = (struct lyd_node_leaf_list *) node;
value.type = sr_libyang_leaf_get_type(data_leaf);
rc = sr_libyang_leaf_copy_value(data_leaf, &value);
if (SR_ERR_OK != rc) {
SR_LOG_ERR("Error returned from sr_libyang_leaf_copy_value: %s.", sr_strerror(rc));
goto cleanup;
}
break;
case LYS_ANYXML:
SR_LOG_ERR_MSG("The anyxml statement is not yet supported by Sysrepo.");
goto cleanup;
default:
SR_LOG_ERR_MSG("Unexpected node type for LYD_DIFF_CHANGED.");
goto cleanup;
}
rc = sr_set_item(srcfg_session, xpath, &value, SR_EDIT_NON_RECURSIVE);
if (SR_ERR_OK != rc) {
SR_LOG_ERR("Error returned from sr_set_item: %s.", sr_strerror(rc));
}
cleanup:
sr_free_val_content(&value);
return rc;
}
/**
* @brief Performs the program's main operation: lets user to edit specified module and datastore
* using the preferred editor. New configuration is validated before it is saved.
*/
static int
srcfg_edit_operation(const char *module_name, srcfg_datastore_t datastore, LYD_FORMAT format,
const char *editor, bool keep, bool permanent)
{
int rc = SR_ERR_INTERNAL, ret = 0;
struct ly_ctx *ly_ctx = NULL;
char tmpfile_path[PATH_MAX] = { 0, }, cmd[2*PATH_MAX+4] = { 0, };
char *dest = NULL;
int fd_tmp = -1;
bool locked = false;
pid_t child_pid = -1;
int child_status = 0, first_attempt = 1;
CHECK_NULL_ARG2(module_name, editor);
/* init libyang context */
ret = srcfg_ly_init(&ly_ctx, module_name);
CHECK_RC_MSG_GOTO(ret, fail, "Failed to initialize libyang context.");
/* lock module for the time of editing if requested */
if (keep) {
rc = sr_lock_module(srcfg_session, module_name);
if (SR_ERR_OK != rc) {
srcfg_report_error(rc);
goto fail;
}
locked = true;
}
/* export: */
/* create temporary file for datastore editing */
mode_t orig_umask = umask(S_IRWXO|S_IRWXG);
snprintf(tmpfile_path, PATH_MAX, "/tmp/srcfg.%s%s.XXXXXX", module_name,
datastore == SRCFG_STORE_RUNNING ? SR_RUNNING_FILE_EXT : SR_STARTUP_FILE_EXT);
fd_tmp = mkstemp(tmpfile_path);
umask(orig_umask);
CHECK_NOT_MINUS1_MSG_GOTO(fd_tmp, rc, SR_ERR_INTERNAL, fail,
"Failed to create temporary file for datastore editing.");
/* export datastore content into a temporary file */
ret = srcfg_export_datastore(ly_ctx, fd_tmp, module_name, format);
if (SR_ERR_OK != ret) {
goto fail;
}
close(fd_tmp);
fd_tmp = -1;
edit:
if (!first_attempt) {
if (!srcfg_prompt("Unable to apply the changes. "
"Would you like to continue editing the configuration?", "y", "n")) {
goto save;
}
}
first_attempt = 0;
/* Open the temporary file inside the preferred text editor */
child_pid = fork();
if (0 <= child_pid) { /* fork succeeded */
if (0 == child_pid) { /* child process */
/* Open text editor */
return execlp(editor, editor, tmpfile_path, (char *)NULL);
} else { /* parent process */
/* wait for the child to exit */
ret = waitpid(child_pid, &child_status, 0);
if (child_pid != ret) {
SR_LOG_ERR_MSG("Unable to wait for the editor to exit.");
goto save;
}
/* Check return status from the child */
if (!WIFEXITED(child_status) || 0 != WEXITSTATUS(child_status)) {
SR_LOG_ERR_MSG("Text editor didn't start/terminate properly.");
goto save;
}
}
}
else /* fork failed */
{
SR_LOG_ERR_MSG("Failed to fork a new process for the text editor.");
goto fail;
}
/* import: */
/* re-open temporary file */
fd_tmp = open(tmpfile_path, O_RDONLY);
CHECK_NOT_MINUS1_MSG_GOTO(fd_tmp, rc, SR_ERR_INTERNAL, save,
"Unable to re-open the configuration after it was edited using the text editor.");
/* import temporary file content into the datastore */
ret = srcfg_import_datastore(ly_ctx, fd_tmp, module_name, datastore, format, permanent);
close(fd_tmp);
fd_tmp = -1;
if (SR_ERR_OK != ret) {
goto edit;
}
/* operation succeeded */
rc = SR_ERR_OK;
printf("The new configuration was successfully applied.\n");
goto cleanup;
save:
/* save to a (ordinary) file if requested */
if (srcfg_prompt("Failed to commit the new configuration. "
"Would you like to save your changes to a file?", "y", "n")) {
/* copy whatever is in the temporary file right now */
snprintf(cmd, PATH_MAX + 4, "cp %s ", tmpfile_path);
dest = cmd + strlen(cmd);
do {
printf("Enter a file path: ");
ret = scanf("%" PATH_MAX_STR "s", dest);
if (EOF == ret) {
SR_LOG_ERR_MSG("Scanf failed: end of the input stream.");
goto discard;
}
sr_str_trim(dest);
ret = system(cmd);
if (0 != ret) {
printf("Unable to save the configuration to '%s'. ", dest);
if (!srcfg_prompt("Retry?", "y", "n")) {
goto discard;
}
}
} while (0 != ret);
printf("Your changes have been saved to '%s'. "
"You may try to apply them again using the import operation.\n", dest);
goto cleanup;
}
discard:
printf("Your changes were discarded.\n");
goto cleanup;
fail:
printf("Errors were encountered during editing. Cancelling the operation.\n");
cleanup:
if (-1 != fd_tmp) {
close(fd_tmp);
}
if ('\0' != tmpfile_path[0]) {
unlink(tmpfile_path);
}
if (locked) {
rc = sr_unlock_module(srcfg_session, module_name);
if (SR_ERR_OK != rc) {
srcfg_report_error(rc);
}
}
if (ly_ctx) {
ly_ctx_destroy(ly_ctx, NULL);
}
return rc;
}
/**
* @brief Import content of the specified datastore for the given module from a file
* referenced by the descriptor 'fd_in'
*/
static int
srcfg_import_datastore(struct ly_ctx *ly_ctx, int fd_in, const char *module_name, srcfg_datastore_t datastore,
LYD_FORMAT format, bool permanent)
{
int rc = SR_ERR_INTERNAL;
unsigned i = 0;
struct lyd_node *new_data_tree = NULL;
struct lyd_node *current_data_tree = NULL;
struct lyd_difflist *diff = NULL;
char *first_xpath = NULL, *second_xpath = NULL;
char *input_data = NULL;
int ret = 0;
struct stat info;
CHECK_NULL_ARG2(ly_ctx, module_name);
/* parse input data */
ret = fstat(fd_in, &info);
CHECK_NOT_MINUS1_LOG_GOTO(ret, rc, SR_ERR_INTERNAL, cleanup,
"Unable to obtain input file info: %s.", sr_strerror_safe(errno));
ly_errno = LY_SUCCESS;
if (S_ISREG(info.st_mode)) {
/* load (using mmap) and parse the input data in one step */
new_data_tree = lyd_parse_fd(ly_ctx, fd_in, format, LYD_OPT_STRICT | LYD_OPT_CONFIG);
} else { /* most likely STDIN */
/* load input data into the memory first */
ret = srcfg_read_file_content(fd_in, &input_data);
CHECK_RC_MSG_GOTO(ret, cleanup, "Unable to read the input data.");
/* parse the input data stored inside memory buffer */
new_data_tree = lyd_parse_mem(ly_ctx, input_data, format, LYD_OPT_STRICT | LYD_OPT_CONFIG);
}
if (NULL == new_data_tree && LY_SUCCESS != ly_errno) {
SR_LOG_ERR("Unable to parse the input data: %s", ly_errmsg());
goto cleanup;
}
/* validate input data */
if (NULL != new_data_tree) {
ret = lyd_validate(&new_data_tree, LYD_OPT_STRICT | LYD_OPT_CONFIG | LYD_WD_IMPL_TAG);
CHECK_ZERO_LOG_GOTO(ret, rc, SR_ERR_INTERNAL, cleanup, "Input data are not valid: %s", ly_errmsg());
}
/* remove default nodes */
lyd_wd_cleanup(&new_data_tree, 0);
/* get data tree of currently stored configuration */
rc = srcfg_get_module_data(ly_ctx, module_name, ¤t_data_tree);
if (SR_ERR_OK != rc) {
goto cleanup;
}
/* get the list of changes made by the user */
diff = lyd_diff(current_data_tree, new_data_tree, 0);
if (NULL == diff) {
SR_LOG_ERR("Unable to get the list of changes: %s", ly_errmsg());
goto cleanup;
}
/* iterate over the list of differences and for each issue corresponding Sysrepo command(s) */
while (diff->type && LYD_DIFF_END != diff->type[i]) {
if (NULL != diff->first[i]) {
first_xpath = lyd_path(diff->first[i]);
if (NULL == first_xpath) {
SR_LOG_ERR("Error returned from lyd_path: %s.", ly_errmsg());
goto cleanup;
}
}
if (NULL != diff->second[i]) {
second_xpath = lyd_path(diff->second[i]);
if (NULL == second_xpath) {
free(first_xpath);
first_xpath = NULL;
SR_LOG_ERR("Error returned from lyd_path: %s.", ly_errmsg());
goto cleanup;
}
}
switch (diff->type[i]) {
case LYD_DIFF_DELETED:
SR_LOG_DBG("<LYD_DIFF_DELETED> node: %s", first_xpath);
rc = srcfg_convert_lydiff_deleted(first_xpath);
break;
case LYD_DIFF_CHANGED:
SR_LOG_DBG("<LYD_DIFF_CHANGED> orig: %s, new: %s", first_xpath, second_xpath);
rc = srcfg_convert_lydiff_changed(first_xpath, diff->second[i]);
break;
case LYD_DIFF_MOVEDAFTER1:
SR_LOG_DBG("<LYD_DIFF_MOVEDAFTER1> moved: %s, after: %s", first_xpath, second_xpath);
rc = srcfg_convert_lydiff_movedafter(first_xpath, second_xpath);
break;
case LYD_DIFF_CREATED:
SR_LOG_DBG("<LYD_DIFF_CREATED> parent: %s, new node: %s", first_xpath, second_xpath);
rc = srcfg_convert_lydiff_created(diff->second[i]);
break;
case LYD_DIFF_MOVEDAFTER2:
SR_LOG_DBG("<LYD_DIFF_MOVEDAFTER2> after: %s, this new node was inserted: %s", first_xpath, second_xpath);
rc = srcfg_convert_lydiff_movedafter(second_xpath, first_xpath);
break;
default:
assert(0 && "not reachable");
}
free(first_xpath);
free(second_xpath);
first_xpath = second_xpath = NULL;
if (SR_ERR_OK != rc) {
goto cleanup;
}
++i;
}
if (0 == i) {
SR_LOG_DBG_MSG("No changes were made.");
} else {
/* commit the changes */
rc = sr_commit(srcfg_session);
if (SR_ERR_OK != rc) {
SR_LOG_ERR("Error returned from sr_commit: %s.", sr_strerror(rc));
goto cleanup;
}
if (SRCFG_STORE_RUNNING == datastore && permanent) {
/* copy running datastore data into the startup datastore */
rc = sr_copy_config(srcfg_session, module_name, SR_DS_RUNNING, SR_DS_STARTUP);
if (SR_ERR_OK != rc) {
SR_LOG_ERR("Error returned from sr_copy_config: %s.", sr_strerror(rc));
goto cleanup;
}
}
}
rc = SR_ERR_OK;
cleanup:
if (NULL != diff) {
lyd_free_diff(diff);
}
if (NULL != current_data_tree) {
lyd_free_withsiblings(current_data_tree);
}
if (NULL != new_data_tree) {
lyd_free_withsiblings(new_data_tree);
}
if (input_data) {
free(input_data);
}
return rc;
}
/**
* @brief Initializes libyang ctx with all schemas installed for specified module in sysrepo.
*/
static int
srcfg_ly_init(struct ly_ctx **ly_ctx, const char *module_name)
{
DIR *dp = NULL;
struct dirent *ep = NULL;
char *delim = NULL;
char schema_filename[PATH_MAX] = { 0, };
const struct lys_module *module = NULL;
CHECK_NULL_ARG2(ly_ctx, module_name);
*ly_ctx = ly_ctx_new(srcfg_schema_search_dir);
if (NULL == *ly_ctx) {
SR_LOG_ERR("Unable to initialize libyang context: %s", ly_errmsg());
return SR_ERR_INTERNAL;
}
ly_set_log_clb(srcfg_ly_log_cb, 1);
/* iterate over all files in the directory with schemas */
dp = opendir(srcfg_schema_search_dir);
if (NULL == dp) {
SR_LOG_ERR("Failed to open the schema directory: %s.", sr_strerror_safe(errno));
return SR_ERR_INTERNAL;
}
while (NULL != (ep = readdir(dp))) {
/* test file extension */
LYS_INFORMAT fmt = LYS_IN_UNKNOWN;
if (sr_str_ends_with(ep->d_name, SR_SCHEMA_YIN_FILE_EXT)) {
fmt = LYS_IN_YIN;
} else if (sr_str_ends_with(ep->d_name, SR_SCHEMA_YANG_FILE_EXT)) {
fmt = LYS_IN_YANG;
}
if (fmt != LYS_IN_UNKNOWN) {
/* strip extension and revision */
strcpy(schema_filename, ep->d_name);
delim = strrchr(schema_filename, '.');
assert(delim);
*delim = '\0';
delim = strrchr(schema_filename, '@');
if (delim) {
*delim = '\0';
}
/* TODO install all revisions and dependencies of the specified module, but not more */
#if 0 /* XXX install all schemas until we can resolve all dependencies */
if (strcmp(schema_filename, module_name) == 0) {
#endif
/* construct full file path */
snprintf(schema_filename, PATH_MAX, "%s%s", srcfg_schema_search_dir, ep->d_name);
/* load the schema into the context */
SR_LOG_DBG("Loading module schema: '%s'.", schema_filename);
module = lys_parse_path(*ly_ctx, schema_filename, fmt);
if (NULL == module) {
continue;
}
for (uint8_t i = 0; i < module->features_size; i++) {
lys_features_enable(module, module->features[i].name);
}
#if 0
}
#endif
}
}
closedir(dp);
return SR_ERR_OK;
}
