/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * Copyright (C) 2015 Simon Stürz * * Copyright (C) 2014 Michael Zanetti * * * * This file is part of nymea. * * * * nymea 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, version 2 of the License. * * * * nymea 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 nymea. If not, see . * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ /*! \class nymeaserver::ActionHandler \brief This subclass of \l{JsonHandler} processes the JSON requests for the \tt Actions namespace. \ingroup json \inmodule core This \l{JsonHandler} will be created in the \l{JsonRPCServer} and used to handle JSON-RPC requests for the \tt {Action} namespace of the API. \sa Action, JsonHandler, JsonRPCServer */ #include "actionhandler.h" #include "devicehandler.h" #include "nymeacore.h" #include "devices/devicemanager.h" #include "devices/deviceactioninfo.h" #include "devices/browseractioninfo.h" #include "devices/browseritemactioninfo.h" #include "types/action.h" #include "loggingcategories.h" namespace nymeaserver { /*! Constructs a new \l ActionHandler with the given \a parent. */ ActionHandler::ActionHandler(QObject *parent) : JsonHandler(parent) { // Objects QVariantMap action; action.insert("actionTypeId", enumValueName(Uuid)); action.insert("deviceId", enumValueName(Uuid)); action.insert("o:params", QVariantList() << objectRef("Param")); registerObject("Action", action); // Methods QString description; QVariantMap params; QVariantMap returns; description = "Execute a single action."; params.insert("actionTypeId", enumValueName(Uuid)); params.insert("deviceId", enumValueName(Uuid)); params.insert("o:params", QVariantList() << objectRef("Param")); returns.insert("deviceError", enumRef()); returns.insert("o:displayMessage", enumValueName(String)); registerMethod("ExecuteAction", description, params, returns); params.clear(); returns.clear(); description = "Get the ActionType for the given ActionTypeId"; params.insert("actionTypeId", enumValueName(Uuid)); returns.insert("deviceError", enumRef()); returns.insert("o:actionType", objectRef("ActionType")); registerMethod("GetActionType", description, params, returns); params.clear(); returns.clear(); description = "Execute the item identified by itemId on the given device."; params.insert("deviceId", enumValueName(Uuid)); params.insert("itemId", enumValueName(String)); returns.insert("deviceError", enumRef()); registerMethod("ExecuteBrowserItem", description, params, returns); params.clear(); returns.clear(); description = "Execute the action for the browser item identified by actionTypeId and the itemId on the given device."; params.insert("deviceId", enumValueName(Uuid)); params.insert("itemId", enumValueName(String)); params.insert("actionTypeId", enumValueName(Uuid)); params.insert("o:params", QVariantList() << objectRef("Param")); returns.insert("deviceError", enumRef()); registerMethod("ExecuteBrowserItemAction", description, params, returns); } /*! Returns the name of the \l{ActionHandler}. In this case \b Actions.*/ QString ActionHandler::name() const { return "Actions"; } JsonReply* ActionHandler::ExecuteAction(const QVariantMap ¶ms) { DeviceId deviceId(params.value("deviceId").toString()); ActionTypeId actionTypeId(params.value("actionTypeId").toString()); ParamList actionParams = DeviceHandler::unpackParams(params.value("params").toList()); QLocale locale = params.value("locale").toLocale(); Action action(actionTypeId, deviceId); action.setParams(actionParams); JsonReply *jsonReply = createAsyncReply("ExecuteAction"); DeviceActionInfo *info = NymeaCore::instance()->executeAction(action); connect(info, &DeviceActionInfo::finished, jsonReply, [info, jsonReply, locale](){ QVariantMap data; data.insert("deviceError", enumValueName(info->status())); if (!info->displayMessage().isEmpty()) { data.insert("displayMessage", info->translatedDisplayMessage(locale)); } jsonReply->setData(data); jsonReply->finished(); }); return jsonReply; } JsonReply *ActionHandler::GetActionType(const QVariantMap ¶ms) const { qCDebug(dcJsonRpc) << "asked for action type" << params; ActionTypeId actionTypeId(params.value("actionTypeId").toString()); foreach (const DeviceClass &deviceClass, NymeaCore::instance()->deviceManager()->supportedDevices()) { foreach (const ActionType &actionType, deviceClass.actionTypes()) { if (actionType.id() == actionTypeId) { QVariantMap data; data.insert("deviceError", enumValueName(Device::DeviceErrorNoError)); data.insert("actionType", DeviceHandler::packActionType(actionType, deviceClass.pluginId(), params.value("locale").toLocale())); return createReply(data); } } } QVariantMap data; data.insert("deviceError", enumValueName(Device::DeviceErrorActionTypeNotFound)); return createReply(data); } JsonReply *ActionHandler::ExecuteBrowserItem(const QVariantMap ¶ms) { DeviceId deviceId = DeviceId(params.value("deviceId").toString()); QString itemId = params.value("itemId").toString(); BrowserAction action(deviceId, itemId); JsonReply *jsonReply = createAsyncReply("ExecuteBrowserItem"); BrowserActionInfo *info = NymeaCore::instance()->executeBrowserItem(action); connect(info, &BrowserActionInfo::finished, jsonReply, [info, jsonReply](){ QVariantMap data; data.insert("deviceError", enumValueName(info->status())); jsonReply->setData(data); jsonReply->finished(); }); return jsonReply; } JsonReply *ActionHandler::ExecuteBrowserItemAction(const QVariantMap ¶ms) { DeviceId deviceId = DeviceId(params.value("deviceId").toString()); QString itemId = params.value("itemId").toString(); ActionTypeId actionTypeId = ActionTypeId(params.value("actionTypeId").toString()); ParamList paramList = DeviceHandler::unpackParams(params.value("params").toList()); BrowserItemAction browserItemAction(deviceId, itemId, actionTypeId, paramList); JsonReply *jsonReply = createAsyncReply("ExecuteBrowserItemAction"); BrowserItemActionInfo *info = NymeaCore::instance()->executeBrowserItemAction(browserItemAction); connect(info, &BrowserItemActionInfo::finished, jsonReply, [info, jsonReply](){ QVariantMap data; data.insert("deviceError", enumValueName(info->status())); jsonReply->setData(data); jsonReply->finished(); }); return jsonReply; } }