MmsValue*
Control_readAccessControlObject(MmsMapping* self, MmsDomain* domain, char* variableIdOrig)
{
MmsValue* value = NULL;
char* variableId = copyString(variableIdOrig);
char* separator = strchr(variableId, '$');
*separator = 0;
char* lnName = variableId;
if (lnName == NULL )
return NULL;
char* objectName = MmsMapping_getNextNameElement(separator + 1);
if (objectName == NULL )
return NULL;
char* varName = MmsMapping_getNextNameElement(objectName);
if (varName != NULL)
*(varName - 1) = 0;
ControlObject* controlObject = Control_lookupControlObject(self, domain, lnName, objectName);
if (controlObject != NULL) {
if (varName != NULL) {
if (strcmp(varName, "Oper") == 0)
value = ControlObject_getOper(controlObject);
else if (strcmp(varName, "SBOw") == 0)
value = ControlObject_getSBOw(controlObject);
else if (strcmp(varName, "SBO") == 0) {
if ((controlObject->ctlModel == 2) || (controlObject->ctlModel == 4)) {
if (ControlObject_select(controlObject)) {
value = ControlObject_getSBO(controlObject);
}
else {
value = emptyString;
}
}
else
value = NULL;
}
else if (strcmp(varName, "Cancel") == 0)
value = ControlObject_getCancel(controlObject);
}
else
value = ControlObject_getMmsValue(controlObject);
}
free(variableId);
return value;
}
MmsValueIndication
Control_writeAccessControlObject(MmsMapping* self, MmsDomain* domain, char* variableIdOrig, MmsValue* value)
{
MmsValueIndication indication = MMS_VALUE_ACCESS_DENIED;
char* variableId = copyString(variableIdOrig);
char* separator = strchr(variableId, '$');
*separator = 0;
char* lnName = variableId;
if (lnName == NULL )
goto free_and_return;
char* objectName = MmsMapping_getNextNameElement(separator + 1);
if (objectName == NULL )
goto free_and_return;
char* varName = MmsMapping_getNextNameElement(objectName);
if (varName != NULL)
*(varName - 1) = 0;
else
goto free_and_return;
ControlObject* controlObject = Control_lookupControlObject(self, domain, lnName, objectName);
if (controlObject == NULL) {
indication = MMS_VALUE_ACCESS_DENIED;
goto free_and_return;
}
if (strcmp(varName, "SBOw") == 0) { /* select and operate */
if (ControlObject_select(controlObject)) {
MmsValue* ctlVal = getCtlVal(value);
if (ctlVal != NULL) {
if (ControlObject_operate(controlObject, ctlVal))
indication = MMS_VALUE_OK;
}
}
else {
//TODO send error message
}
}
else if (strcmp(varName, "Oper") == 0) {
MmsValue* ctlVal = getCtlVal(value);
if (ctlVal != NULL) {
if (ControlObject_operate(controlObject, ctlVal))
indication = MMS_VALUE_OK;
}
}
free_and_return:
free(variableId);
return indication;
}
MmsDataAccessError
Control_writeAccessControlObject(MmsMapping* self, MmsDomain* domain, char* variableIdOrig,
MmsValue* value, MmsServerConnection connection)
{
MmsDataAccessError indication = DATA_ACCESS_ERROR_OBJECT_ACCESS_DENIED;
if (DEBUG_IED_SERVER)
printf("IED_SERVER: writeAccessControlObject: %s\n", variableIdOrig);
char variableId[65];
strncpy(variableId, variableIdOrig, 64);
variableId[64] = 0;
char* separator = strchr(variableId, '$');
if (separator == NULL)
goto free_and_return;
*separator = 0;
char* lnName = variableId;
if (lnName == NULL)
goto free_and_return;
char* objectName = MmsMapping_getNextNameElement(separator + 1);
if (objectName == NULL)
goto free_and_return;
char* varName = MmsMapping_getNextNameElement(objectName);
if (varName != NULL) {
bool foundVar = false;
char* nextVarName = varName;
do {
if (doesElementEquals(varName, "Oper") ||
doesElementEquals(varName, "SBO") ||
doesElementEquals(varName, "SBOw") ||
doesElementEquals(varName, "Cancel"))
{
*(varName - 1) = 0;
foundVar = true;
break;
}
nextVarName = MmsMapping_getNextNameElement(varName);
if (nextVarName != NULL)
varName = nextVarName;
} while (nextVarName != NULL);
if (foundVar == false)
varName = NULL;
}
if (DEBUG_IED_SERVER)
printf("IED_SERVER: write access control: objectName: (%s) varName: (%s)\n", objectName, varName);
if (varName == NULL) {
indication = DATA_ACCESS_ERROR_OBJECT_ACCESS_DENIED;
goto free_and_return;
}
ControlObject* controlObject = Control_lookupControlObject(self, domain, lnName, objectName);
if (controlObject == NULL) {
indication = DATA_ACCESS_ERROR_OBJECT_ACCESS_DENIED;
goto free_and_return;
}
initialize(controlObject);
if (strcmp(varName, "SBOw") == 0) { /* select with value */
if (controlObject->ctlModel == 4) {
MmsValue* ctlVal = getCtlVal(value);
if (ctlVal != NULL) {
MmsValue* ctlNum = getOperParameterCtlNum(value);
MmsValue* origin = getOperParameterOrigin(value);
MmsValue* check = getOperParameterCheck(value);
MmsValue* test = getOperParameterTest(value);
if (checkValidityOfOriginParameter(origin) == false) {
indication = DATA_ACCESS_ERROR_OBJECT_VALUE_INVALID;
goto free_and_return;
}
uint64_t currentTime = Hal_getTimeInMs();
checkSelectTimeout(controlObject, currentTime);
int state = getState(controlObject);
if (state != STATE_UNSELECTED) {
indication = DATA_ACCESS_ERROR_TEMPORARILY_UNAVAILABLE;
if (connection != controlObject->mmsConnection)
ControlObject_sendLastApplError(controlObject, connection, "SBOw", 0,
ADD_CAUSE_LOCKED_BY_OTHER_CLIENT, ctlNum, origin, true);
else
ControlObject_sendLastApplError(controlObject, connection, "SBOw", 0,
ADD_CAUSE_OBJECT_ALREADY_SELECTED, ctlNum, origin, true);
if (DEBUG_IED_SERVER)
printf("SBOw: select failed!\n");
}
else {
CheckHandlerResult checkResult = CONTROL_ACCEPTED;
bool interlockCheck = MmsValue_getBitStringBit(check, 1);
bool testCondition = MmsValue_getBoolean(test);
if (controlObject->checkHandler != NULL) { /* perform operative tests */
ClientConnection clientConnection = private_IedServer_getClientConnectionByHandle(self->iedServer,
connection);
checkResult = controlObject->checkHandler(
controlObject->checkHandlerParameter, ctlVal, testCondition, interlockCheck,
clientConnection);
}
if (checkResult == CONTROL_ACCEPTED) {
selectObject(controlObject, currentTime, connection);
updateControlParameters(controlObject, ctlVal, ctlNum, origin);
indication = DATA_ACCESS_ERROR_SUCCESS;
if (DEBUG_IED_SERVER)
printf("SBOw: selected successful\n");
}
else {
indication = getDataAccessErrorFromCheckHandlerResult(checkResult);
ControlObject_sendLastApplError(controlObject, connection, "SBOw", 0,
ADD_CAUSE_SELECT_FAILED, ctlNum, origin, true);
if (DEBUG_IED_SERVER)
printf("SBOw: select rejected by application!\n");
}
}
}
else {
indication = DATA_ACCESS_ERROR_OBJECT_VALUE_INVALID;
}
}
else {
indication = DATA_ACCESS_ERROR_OBJECT_ACCESS_DENIED;
goto free_and_return;
}
}
else if (strcmp(varName, "Oper") == 0) {
MmsValue* ctlVal = getCtlVal(value);
MmsValue* test = getOperParameterTest(value);
MmsValue* ctlNum = getOperParameterCtlNum(value);
MmsValue* origin = getOperParameterOrigin(value);
MmsValue* check = getOperParameterCheck(value);
MmsValue* timeParameter = getOperParameterTime(value);
if ((ctlVal == NULL) || (test == NULL) || (ctlNum == NULL) || (origin == NULL) || (check == NULL)
|| (timeParameter == NULL)) {
indication = DATA_ACCESS_ERROR_OBJECT_VALUE_INVALID;
goto free_and_return;
}
if (checkValidityOfOriginParameter(origin) == false) {
indication = DATA_ACCESS_ERROR_OBJECT_VALUE_INVALID;
goto free_and_return;
}
uint64_t currentTime = Hal_getTimeInMs();
checkSelectTimeout(controlObject, currentTime);
int state = getState(controlObject);
if (state == STATE_WAIT_FOR_ACTIVATION_TIME) {
indication = DATA_ACCESS_ERROR_TEMPORARILY_UNAVAILABLE;
ControlObject_sendLastApplError(controlObject, connection, "Oper",
CONTROL_ERROR_NO_ERROR, ADD_CAUSE_COMMAND_ALREADY_IN_EXECUTION,
ctlNum, origin, true);
goto free_and_return;
}
else if (state == STATE_READY) {
bool interlockCheck = MmsValue_getBitStringBit(check, 1);
bool synchroCheck = MmsValue_getBitStringBit(check, 0);
bool testCondition = MmsValue_getBoolean(test);
controlObject->testMode = testCondition;
if ((controlObject->ctlModel == 2) || (controlObject->ctlModel == 4)) {
if (controlObject->mmsConnection != connection) {
indication = DATA_ACCESS_ERROR_TEMPORARILY_UNAVAILABLE;
if (DEBUG_IED_SERVER)
printf("Oper: operate from wrong client connection!\n");
goto free_and_return;
}
if (controlObject->ctlModel == 4) { /* select-before-operate with enhanced security */
if ((MmsValue_equals(ctlVal, controlObject->ctlVal) &&
MmsValue_equals(origin, controlObject->origin) &&
MmsValue_equals(ctlNum, controlObject->ctlNum)) == false)
{
indication = DATA_ACCESS_ERROR_TYPE_INCONSISTENT;
ControlObject_sendLastApplError(controlObject, connection, "Oper",
CONTROL_ERROR_NO_ERROR, ADD_CAUSE_INCONSISTENT_PARAMETERS,
ctlNum, origin, true);
goto free_and_return;
}
}
}
updateControlParameters(controlObject, ctlVal, ctlNum, origin);
MmsValue* operTm = getOperParameterOperTime(value);
if (operTm != NULL) {
controlObject->operateTime = MmsValue_getUtcTimeInMs(operTm);
if (controlObject->operateTime != 0) {
controlObject->timeActivatedOperate = true;
controlObject->synchroCheck = synchroCheck;
controlObject->interlockCheck = interlockCheck;
controlObject->mmsConnection = connection;
initiateControlTask(controlObject);
setState(controlObject, STATE_WAIT_FOR_ACTIVATION_TIME);
if (DEBUG_IED_SERVER)
printf("Oper: activate time activated control\n");
indication = DATA_ACCESS_ERROR_SUCCESS;
}
}
MmsValue_update(controlObject->oper, value);
if (controlObject->timeActivatedOperate == false) {
CheckHandlerResult checkResult = CONTROL_ACCEPTED;
if (controlObject->checkHandler != NULL) { /* perform operative tests */
ClientConnection clientConnection = private_IedServer_getClientConnectionByHandle(self->iedServer,
connection);
checkResult = controlObject->checkHandler(
controlObject->checkHandlerParameter, ctlVal, testCondition, interlockCheck,
clientConnection);
}
if (checkResult == CONTROL_ACCEPTED) {
indication = DATA_ACCESS_ERROR_NO_RESPONSE;
controlObject->mmsConnection = connection;
controlObject->operateInvokeId = MmsServerConnection_getLastInvokeId(connection);
setState(controlObject, STATE_WAIT_FOR_EXECUTION);
initiateControlTask(controlObject);
#if (CONFIG_MMS_THREADLESS_STACK == 1)
//TODO call this in single threaded version to increase response time!?
//executeControlTask(controlObject);
#endif
}
else {
indication = getDataAccessErrorFromCheckHandlerResult(checkResult);
abortControlOperation(controlObject);
}
}
}
else if (state == STATE_UNSELECTED) {
if (DEBUG_IED_SERVER)
printf("IED_SERVER: Oper failed - control not selected!\n");
indication = DATA_ACCESS_ERROR_OBJECT_ACCESS_DENIED;
ControlObject_sendLastApplError(controlObject, connection, "Oper",
CONTROL_ERROR_NO_ERROR, ADD_CAUSE_OBJECT_NOT_SELECTED,
ctlNum, origin, true);
goto free_and_return;
}
}
else if (strcmp(varName, "Cancel") == 0) {
if (DEBUG_IED_SERVER)
printf("IED_SERVER: control received cancel!\n");
int state = getState(controlObject);
MmsValue* ctlNum = getCancelParameterCtlNum(value);
MmsValue* origin = getCancelParameterOrigin(value);
if ((ctlNum == NULL) || (origin == NULL)) {
indication = DATA_ACCESS_ERROR_TYPE_INCONSISTENT;
if (DEBUG_IED_SERVER)
printf("IED_SERVER: Invalid cancel message!\n");
goto free_and_return;
}
if ((controlObject->ctlModel == 2) || (controlObject->ctlModel == 4)) {
if (state != STATE_UNSELECTED) {
if (controlObject->mmsConnection == connection) {
indication = DATA_ACCESS_ERROR_SUCCESS;
setState(controlObject, STATE_UNSELECTED);
goto free_and_return;
}
else {
indication = DATA_ACCESS_ERROR_TEMPORARILY_UNAVAILABLE;
ControlObject_sendLastApplError(controlObject, connection, "Cancel",
CONTROL_ERROR_NO_ERROR, ADD_CAUSE_LOCKED_BY_OTHER_CLIENT,
ctlNum, origin, true);
}
}
}
if (controlObject->timeActivatedOperate) {
controlObject->timeActivatedOperate = false;
abortControlOperation(controlObject);
indication = DATA_ACCESS_ERROR_SUCCESS;
goto free_and_return;
}
}
free_and_return:
return indication;
}
MmsValue*
Control_readAccessControlObject(MmsMapping* self, MmsDomain* domain, char* variableIdOrig,
MmsServerConnection connection)
{
MmsValue* value = NULL;
if (DEBUG_IED_SERVER)
printf("IED_SERVER: readAccessControlObject: %s\n", variableIdOrig);
char variableId[129];
strncpy(variableId, variableIdOrig, 128);
variableId[128] = 0;
char* separator = strchr(variableId, '$');
if (separator == NULL)
return NULL;
*separator = 0;
char* lnName = variableId;
if (lnName == NULL)
return NULL;
char* objectName = MmsMapping_getNextNameElement(separator + 1);
if (objectName == NULL)
return NULL;
char* varName = MmsMapping_getNextNameElement(objectName);
if (varName != NULL) {
bool foundVar = false;
char* nextVarName = varName;
do {
if (doesElementEquals(varName, "Oper") ||
doesElementEquals(varName, "SBO") ||
doesElementEquals(varName, "SBOw") ||
doesElementEquals(varName, "Cancel"))
{
*(varName - 1) = 0;
foundVar = true;
break;
}
nextVarName = MmsMapping_getNextNameElement(varName);
if (nextVarName != NULL)
varName = nextVarName;
} while (nextVarName != NULL);
if (foundVar == false)
varName = NULL;
}
if (DEBUG_IED_SERVER)
printf("IED_SERVER: read_access control object: objectName: (%s) varName: (%s)\n", objectName, varName);
ControlObject* controlObject = Control_lookupControlObject(self, domain, lnName, objectName);
if (controlObject != NULL) {
initialize(controlObject);
if (varName != NULL) {
if (strcmp(varName, "Oper") == 0)
value = ControlObject_getOper(controlObject);
else if (strcmp(varName, "SBOw") == 0)
value = ControlObject_getSBOw(controlObject);
else if (strcmp(varName, "SBO") == 0) {
if (controlObject->ctlModel == 2) {
uint64_t currentTime = Hal_getTimeInMs();
value = controlObject->emptyString;
checkSelectTimeout(controlObject, currentTime);
if (getState(controlObject) == STATE_UNSELECTED) {
CheckHandlerResult checkResult = CONTROL_ACCEPTED;
if (controlObject->checkHandler != NULL) { /* perform operative tests */
checkResult = controlObject->checkHandler(
controlObject->checkHandlerParameter, NULL, false, false,
(ClientConnection) connection);
}
if (checkResult == CONTROL_ACCEPTED) {
selectObject(controlObject, currentTime, connection);
value = ControlObject_getSBO(controlObject);
}
}
}
else {
if (DEBUG_IED_SERVER)
printf("IED_SERVER: select not applicable for control model %i\n", controlObject->ctlModel);
value = ControlObject_getSBO(controlObject);
}
}
else if (strcmp(varName, "Cancel") == 0)
value = ControlObject_getCancel(controlObject);
else {
value = MmsValue_getSubElement(ControlObject_getMmsValue(controlObject),
ControlObject_getTypeSpec(controlObject), varName);
}
}
else
value = ControlObject_getMmsValue(controlObject);
}
return value;
}
