blob: d566764101dbbab294310677e38afddd54bcae7b [file] [log] [blame]
/*****************************************************************************\
* accounts.c - Slurm REST API accounting accounts http operations handlers
*****************************************************************************
* Copyright (C) SchedMD LLC.
*
* This file is part of Slurm, a resource management program.
* For details, see <https://slurm.schedmd.com/>.
* Please also read the included file: DISCLAIMER.
*
* Slurm is free software; you can redistribute it and/or modify it under
* the terms of the GNU General Public License as published by the Free
* Software Foundation; either version 2 of the License, or (at your option)
* any later version.
*
* In addition, as a special exception, the copyright holders give permission
* to link the code of portions of this program with the OpenSSL library under
* certain conditions as described in each individual source file, and
* distribute linked combinations including the two. You must obey the GNU
* General Public License in all respects for all of the code used other than
* OpenSSL. If you modify file(s) with this exception, you may extend this
* exception to your version of the file(s), but you are not obligated to do
* so. If you do not wish to do so, delete this exception statement from your
* version. If you delete this exception statement from all source files in
* the program, then also delete it here.
*
* Slurm 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 General Public License for more
* details.
*
* You should have received a copy of the GNU General Public License along
* with Slurm; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
\*****************************************************************************/
#include "config.h"
#include <stdint.h>
#include "slurm/slurm.h"
#include "slurm/slurmdb.h"
#include "src/common/list.h"
#include "src/common/log.h"
#include "src/common/parse_time.h"
#include "src/common/ref.h"
#include "src/common/slurmdbd_defs.h"
#include "src/common/slurm_protocol_api.h"
#include "src/common/strlcpy.h"
#include "src/common/uid.h"
#include "src/common/xassert.h"
#include "src/common/xmalloc.h"
#include "src/common/xstring.h"
#include "src/slurmrestd/openapi.h"
#include "src/slurmrestd/operations.h"
#include "api.h"
#define MAGIC_FOREACH_COORD 0xabfbf9fa
typedef struct {
int magic; /* MAGIC_FOREACH_COORD */
ctxt_t *ctxt;
slurmdb_account_rec_t *acct;
slurmdb_account_rec_t *orig_acct;
} foreach_update_acct_coord_t;
/* based on sacctmgr_list_account() */
static void _dump_accounts(ctxt_t *ctxt, slurmdb_account_cond_t *acct_cond)
{
list_t *acct_list = NULL;
(void) db_query_list(ctxt, &acct_list, slurmdb_accounts_get, acct_cond);
DUMP_OPENAPI_RESP_SINGLE(OPENAPI_ACCOUNTS_RESP, acct_list, ctxt);
FREE_NULL_LIST(acct_list);
}
static int _foreach_match_coord(void *x, void *key)
{
slurmdb_coord_rec_t *coord1 = x;
slurmdb_coord_rec_t *coord2 = key;
return !xstrcasecmp(coord1->name, coord2->name) ? 1 : 0;
}
static int _foreach_add_acct_coord(void *x, void *arg)
{
int rc;
slurmdb_coord_rec_t *coord = x;
foreach_update_acct_coord_t *args = arg;
ctxt_t *ctxt = args->ctxt;
list_t *acct_list;
slurmdb_assoc_cond_t assoc_cond = {};
slurmdb_user_cond_t user_cond = {
.assoc_cond = &assoc_cond,
};
xassert(args->magic == MAGIC_FOREACH_COORD);
if (args->orig_acct && args->orig_acct->coordinators &&
list_find_first(args->orig_acct->coordinators, _foreach_match_coord,
coord)) {
/* account already has coordinator -> nothing to do here */
return SLURM_SUCCESS;
}
acct_list = list_create(NULL);
list_append(acct_list, args->acct->name);
assoc_cond.user_list = list_create(NULL);
list_append(assoc_cond.user_list, coord->name);
errno = 0;
if ((rc = slurmdb_coord_add(ctxt->db_conn, acct_list, &user_cond))) {
if (errno)
rc = errno;
resp_error(ctxt, rc, "slurmdb_coord_add()",
"adding coordinator %s to account %s failed",
coord->name, args->acct->name);
}
FREE_NULL_LIST(acct_list);
FREE_NULL_LIST(assoc_cond.user_list);
return rc ? SLURM_ERROR : SLURM_SUCCESS;
}
static int _foreach_rm_acct_coord(void *x, void *arg)
{
int rc = SLURM_SUCCESS;
slurmdb_coord_rec_t *coord = x;
foreach_update_acct_coord_t *args = arg;
ctxt_t *ctxt = args->ctxt;
list_t *acct_list = NULL, *rm_list = NULL;
slurmdb_assoc_cond_t assoc_cond = {};
slurmdb_user_cond_t user_cond = {
.assoc_cond = &assoc_cond,
};
xassert(args->magic == MAGIC_FOREACH_COORD);
if (args->acct->coordinators &&
list_find_first(args->acct->coordinators, _foreach_match_coord,
coord)) {
/* account already has coordinator -> nothing to do here */
return SLURM_SUCCESS;
}
/* coordinator not in new acct list -> must be removed */
acct_list = list_create(NULL);
list_append(acct_list, args->acct->name);
assoc_cond.user_list = list_create(NULL);
list_append(assoc_cond.user_list, coord->name);
errno = 0;
if (!(rm_list = slurmdb_coord_remove(ctxt->db_conn, acct_list, &user_cond))) {
if (errno)
rc = errno;
else
rc = SLURM_ERROR;
resp_error(ctxt, rc, "slurmdb_coord_remove()",
"removing coordinator %s from account %s failed",
coord->name, args->acct->name);
} else {
xassert(list_count(rm_list) == 1);
}
FREE_NULL_LIST(acct_list);
FREE_NULL_LIST(rm_list);
FREE_NULL_LIST(assoc_cond.user_list);
return rc ? SLURM_ERROR : SLURM_SUCCESS;
}
static int _foreach_update_acct(void *x, void *arg)
{
slurmdb_account_rec_t *acct = x;
ctxt_t *ctxt = arg;
list_t *acct_list = NULL;
slurmdb_assoc_cond_t assoc_cond = {};
slurmdb_account_cond_t acct_cond = {
.assoc_cond = &assoc_cond,
.flags = SLURMDB_ACCT_FLAG_WCOORD,
};
assoc_cond.acct_list = list_create(NULL);
list_append(assoc_cond.acct_list, acct->name);
if (db_query_list_xempty(ctxt, &acct_list, slurmdb_accounts_get,
&acct_cond))
goto cleanup;
if (acct->assoc_list && list_count(acct->assoc_list)) {
resp_warn(ctxt, __func__, "Account associations ignored. They must be set via the associations end point.");
}
if (acct->flags & SLURMDB_ACCT_FLAG_DELETED) {
resp_warn(ctxt, __func__,
"Ignoring request to set flag: DELETED");
}
if (!acct_list || list_is_empty(acct_list)) {
debug("%s: [%s] add account request: acct=%s",
__func__, ctxt->id, acct->name);
if (!acct_list)
acct_list = list_create(NULL);
list_append(acct_list, acct);
db_query_rc(ctxt, acct_list, slurmdb_accounts_add);
if (acct->coordinators) {
foreach_update_acct_coord_t cargs = {
.magic = MAGIC_FOREACH_COORD,
.ctxt = ctxt,
.acct = acct,
};
list_for_each(acct->coordinators,
_foreach_add_acct_coord, &cargs);
}
} else if (list_count(acct_list) > 1) {
resp_error(ctxt, ESLURM_DATA_AMBIGUOUS_MODIFY, __func__,
"ambiguous account modify request");
} else {
debug("%s: [%s] modifying account request: acct=%s", __func__,
ctxt->id, acct->name);
if (!db_modify_rc(ctxt, &acct_cond, acct,
slurmdb_accounts_modify)) {
foreach_update_acct_coord_t cargs = {
.magic = MAGIC_FOREACH_COORD,
.ctxt = ctxt,
.acct = acct,
.orig_acct = list_peek(acct_list),
};
if (acct->coordinators)
list_for_each(acct->coordinators,
_foreach_add_acct_coord, &cargs);
if (cargs.orig_acct->coordinators)
list_for_each(cargs.orig_acct->coordinators,
_foreach_rm_acct_coord, &cargs);
}
}
cleanup:
FREE_NULL_LIST(assoc_cond.acct_list);
FREE_NULL_LIST(acct_list);
return ctxt->rc ? SLURM_ERROR : SLURM_SUCCESS;
}
extern int update_accounts(ctxt_t *ctxt, bool commit, list_t *acct_list)
{
if (!(list_for_each(acct_list, _foreach_update_acct, ctxt) < 0) &&
!ctxt->rc && commit)
db_query_commit(ctxt);
return ctxt->rc;
}
static void _add_accounts_association(ctxt_t *ctxt,
slurmdb_add_assoc_cond_t *add_assoc,
slurmdb_account_rec_t *acct)
{
int rc = SLURM_SUCCESS;
char *ret_str = NULL;
errno = 0;
ret_str = slurmdb_accounts_add_cond(ctxt->db_conn, add_assoc, acct);
if ((rc = errno))
resp_error(ctxt, rc, __func__,
"slurmdb_accounts_add_cond() failed");
else
db_query_commit(ctxt);
DUMP_OPENAPI_RESP_SINGLE(OPENAPI_ACCOUNTS_ADD_COND_RESP_STR, ret_str,
ctxt);
xfree(ret_str);
}
static void _update_accts(ctxt_t *ctxt)
{
openapi_resp_single_t resp = {0};
openapi_resp_single_t *resp_ptr = &resp;
if (!DATA_PARSE(ctxt->parser, OPENAPI_ACCOUNTS_RESP, resp, ctxt->query,
ctxt->parent_path)) {
list_t *acct_list = resp.response;
update_accounts(ctxt, true, acct_list);
FREE_NULL_LIST(acct_list);
}
FREE_OPENAPI_RESP_COMMON_CONTENTS(resp_ptr);
}
static void _parse_add_accounts_assoc(ctxt_t *ctxt)
{
openapi_resp_accounts_add_cond_t resp = {0};
openapi_resp_accounts_add_cond_t *resp_ptr = &resp;
if (!DATA_PARSE(ctxt->parser, OPENAPI_ACCOUNTS_ADD_COND_RESP, resp,
ctxt->query, ctxt->parent_path)) {
_add_accounts_association(ctxt, resp_ptr->add_assoc,
resp_ptr->acct);
slurmdb_destroy_add_assoc_cond(resp_ptr->add_assoc);
slurmdb_destroy_account_rec(resp_ptr->acct);
}
FREE_OPENAPI_RESP_COMMON_CONTENTS(resp_ptr);
}
static void _delete_account(ctxt_t *ctxt, char *account)
{
list_t *removed = NULL;
slurmdb_assoc_cond_t assoc_cond = {
.acct_list = list_create(NULL),
.user_list = list_create(NULL),
};
slurmdb_account_cond_t acct_cond = {
.assoc_cond = &assoc_cond,
};
list_append(assoc_cond.acct_list, account);
if (db_query_list(ctxt, &removed, slurmdb_accounts_remove, &acct_cond))
goto cleanup;
DUMP_OPENAPI_RESP_SINGLE(OPENAPI_ACCOUNTS_REMOVED_RESP, removed, ctxt);
if (!list_is_empty(removed))
db_query_commit(ctxt);
cleanup:
FREE_NULL_LIST(removed);
FREE_NULL_LIST(assoc_cond.acct_list);
FREE_NULL_LIST(assoc_cond.user_list);
}
extern int op_handler_account(ctxt_t *ctxt)
{
openapi_account_param_t params = {0};
if (DATA_PARSE(ctxt->parser, OPENAPI_ACCOUNT_PARAM, params,
ctxt->parameters, ctxt->parent_path))
goto cleanup;
if (ctxt->method == HTTP_REQUEST_GET) {
openapi_account_query_t query = {0};
slurmdb_assoc_cond_t assoc_cond = {0};
slurmdb_account_cond_t acct_cond = {
.assoc_cond = &assoc_cond,
};
if (DATA_PARSE(ctxt->parser, OPENAPI_ACCOUNT_QUERY, query,
ctxt->query, ctxt->parent_path))
goto cleanup;
if (query.with_assocs)
acct_cond.flags |= SLURMDB_ACCT_FLAG_WASSOC;
if (query.with_coords)
acct_cond.flags |= SLURMDB_ACCT_FLAG_WCOORD;
if (query.with_deleted)
acct_cond.flags |= SLURMDB_ACCT_FLAG_DELETED;
assoc_cond.acct_list = list_create(NULL);
list_append(assoc_cond.acct_list, params.name);
_dump_accounts(ctxt, &acct_cond);
FREE_NULL_LIST(assoc_cond.acct_list);
} else if (ctxt->method == HTTP_REQUEST_DELETE) {
_delete_account(ctxt, params.name);
} else {
resp_error(ctxt, ESLURM_REST_INVALID_QUERY, __func__,
"Unsupported HTTP method requested: %s",
get_http_method_string(ctxt->method));
}
cleanup:
xfree(params.name);
return SLURM_SUCCESS;
}
/* based on sacctmgr_list_account() */
extern int op_handler_accounts(ctxt_t *ctxt)
{
if (ctxt->method == HTTP_REQUEST_GET) {
slurmdb_account_cond_t *acct_cond = NULL;
if (DATA_PARSE(ctxt->parser, ACCOUNT_CONDITION_PTR, acct_cond,
ctxt->query, ctxt->parent_path)) {
slurmdb_destroy_account_cond(acct_cond);
return SLURM_SUCCESS;
}
_dump_accounts(ctxt, acct_cond);
slurmdb_destroy_account_cond(acct_cond);
} else if (ctxt->method == HTTP_REQUEST_POST) {
_update_accts(ctxt);
} else {
resp_error(ctxt, ESLURM_REST_INVALID_QUERY, __func__,
"Unsupported HTTP method requested: %s",
get_http_method_string(ctxt->method));
}
return SLURM_SUCCESS;
}
extern int op_handler_accounts_association(ctxt_t *ctxt)
{
if (ctxt->method == HTTP_REQUEST_POST)
_parse_add_accounts_assoc(ctxt);
else
resp_error(ctxt, ESLURM_REST_INVALID_QUERY, __func__,
"Unsupported HTTP method requested: %s",
get_http_method_string(ctxt->method));
return SLURM_SUCCESS;
}