Files
MuditaOS/module-services/service-appmgr/ApplicationManager.cpp
2019-08-28 09:00:25 +02:00

538 lines
19 KiB
C++

/*
* @file ApplicationManager.cpp
* @author Robert Borzecki (robert.borzecki@mudita.com)
* @date 3 cze 2019
* @brief
* @copyright Copyright (C) 2019 mudita.com
* @details
*/
#include "SystemManager/SystemManager.hpp"
#include "service-appmgr/ApplicationManager.hpp"
#include "service-evtmgr/EventManager.hpp"
#include "messages/APMMessage.hpp"
#include "application-call/data/CallSwitchData.hpp"
#include "service-db/api/DBServiceAPI.hpp"
#include "service-cellular/ServiceCellular.hpp"
#include "service-cellular/api/CellularServiceAPI.hpp"
#include <utility>
#include <memory>
//services
#include "service-gui/ServiceGUI.hpp"
#include "service-eink/ServiceEink.hpp"
//module-utils
#include "log/log.hpp"
#include "i18/i18.hpp"
namespace sapm {
ApplicationDescription::ApplicationDescription( std::string name, std::unique_ptr<app::ApplicationLauncher> lanucher, bool closeable ) :
name{name}, closeable{closeable}, state{app::Application::State::DEACTIVATED}, switchData{nullptr} {
this->lanucher = std::move(lanucher);
}
ApplicationManager::ApplicationManager( const std::string& name, sys::SystemManager* sysmgr,
std::vector< std::unique_ptr<app::ApplicationLauncher> >& launchers ) : Service(name), systemManager{sysmgr} {
// busChannels.push_back(sys::BusChannels::ServiceCellularNotifications);
//store the pointers in the map where key is the name of the app and value is the launcher
for( uint32_t i=0; i<launchers.size(); ++i ) {
std::string name = launchers[i]->getName();
bool isCloseable = launchers[i]->isCloseable();
ApplicationDescription* desc = new ApplicationDescription(name, std::move(launchers[i]), isCloseable );
applications.insert(std::pair<std::string, ApplicationDescription*>(name, desc) );
}
}
ApplicationManager::~ApplicationManager() {
closeApplications();
closeServices();
for( auto it = applications.begin(); it!=applications.end(); it++ ) {
delete it->second;
}
systemManager = nullptr;
}
bool ApplicationManager::closeServices() {
bool ret = sys::SystemManager::DestroyService( "ServiceGUI", this );
if( ret ) {
LOG_INFO("Service: %s closed", "ServiceGUI");
}else {
LOG_FATAL("Service: %s is still running", "ServiceGUI");
}
ret = sys::SystemManager::DestroyService( "ServiceEink", this );
if( ret ) {
LOG_INFO("Service: %s closed", "ServiceEink");
}else {
LOG_FATAL("Service: %s is still running", "ServiceEink");
}
return true;
}
bool ApplicationManager::closeApplications() {
//if application is started, its in first plane or it's working in background
//it will be closed using SystemManager's API.
for( auto it = applications.begin(); it!=applications.end(); it++ ) {
if( ( it->second->state == app::Application::State::ACTIVE_FORGROUND ) ||
( it->second->state == app::Application::State::ACTIVE_BACKGROUND ) ||
( it->second->state == app::Application::State::ACTIVATING )) {
LOG_INFO("Closing application: %s", it->second->name.c_str());
bool ret = sys::SystemManager::DestroyService( it->second->name, this );
if( ret ) {
LOG_INFO("Application: %s closed", it->second->name.c_str());
}else {
LOG_FATAL("Application: %s is still running", it->second->name.c_str());
}
it->second->state = app::Application::State::DEACTIVATED;
}
}
return true;
}
sys::Message_t ApplicationManager::DataReceivedHandler(sys::DataMessage* msgl,sys::ResponseMessage* resp) {
uint32_t msgType = msgl->messageType;
switch( msgType ) {
case static_cast<uint32_t>(MessageType::APMSwitch): {
sapm::APMSwitch* msg = reinterpret_cast<sapm::APMSwitch*>( msgl );
handleSwitchApplication( msg );
}break;
case static_cast<uint32_t>(MessageType::APMSwitchPrevApp): {
sapm::APMSwitchPrevApp* msg = reinterpret_cast<sapm::APMSwitchPrevApp*>( msgl );
LOG_INFO("APMSwitchPrevApp %s", msg->getSenderName().c_str());
handleSwitchPrevApplication( msg );
}break;
case static_cast<uint32_t>(MessageType::APMConfirmSwitch): {
sapm::APMConfirmSwitch* msg = reinterpret_cast<sapm::APMConfirmSwitch*>( msgl );
handleSwitchConfirmation( msg );
}break;
case static_cast<uint32_t>(MessageType::APMConfirmClose): {
sapm::APMConfirmClose* msg = reinterpret_cast<sapm::APMConfirmClose*>( msgl );
LOG_INFO("APMConfirmClose %s", msg->getSenderName().c_str());
handleCloseConfirmation( msg );
//if application manager was waiting for close confirmation and name of the application
//for launching is defined then start application function is called
if( ( state == State::WAITING_CLOSE_CONFIRMATION) &&
( launchApplicationName.empty() == false ) ) {
startApplication( launchApplicationName );
}
}break;
case static_cast<int32_t>(MessageType::APMDeleydClose) : {
sapm::APMDelayedClose* msg = reinterpret_cast<sapm::APMDelayedClose*>( msgl );
LOG_INFO("APMDeleydClose %s", msg->getApplication().c_str() );
sys::SystemManager::DestroyService(msg->getApplication().c_str(),this);
} break;
case static_cast<int32_t>(MessageType::APMRegister) : {
sapm::APMRegister* msg = reinterpret_cast<sapm::APMRegister*>( msgl );
LOG_INFO("APMregister %s %s", msg->getSenderName().c_str(), (msg->getStatus()?"true":"false"));
handleRegisterApplication( msg );
} break;
case static_cast<int32_t>(MessageType::APMChangeLanguage) : {
sapm::APMChangeLanguage* msg = reinterpret_cast<sapm::APMChangeLanguage*>( msgl );
std::string lang;
if( msg->getLanguage() == utils::Lang::En ) lang = "English";
if( msg->getLanguage() == utils::Lang::Pl ) lang = "Polish";
if( msg->getLanguage() == utils::Lang::De ) lang = "German";
if( msg->getLanguage() == utils::Lang::Sp ) lang = "Spanish";
LOG_INFO("APChangeLanguage; %s %s", msg->getSenderName().c_str(), lang.c_str());
handleLanguageChange( msg );
} break;
case static_cast<uint32_t>(MessageType::APMClose): {
closeApplications();
closeServices();
} break;
default : {
} break;
};
return std::make_shared<sys::ResponseMessage>();
}
// Invoked when timer ticked
void ApplicationManager::TickHandler(uint32_t id) {
}
// Invoked during initialization
sys::ReturnCodes ApplicationManager::InitHandler() {
//get settings to initialize language in applications
settings = DBServiceAPI::SettingsGet(this);
if( settings.language == SettingsLanguage::ENGLISH ) {
utils::localize.Switch( utils::Lang::En );
}
else if( settings.language == SettingsLanguage::POLISH ) {
utils::localize.Switch( utils::Lang::Pl );
}
else if( settings.language == SettingsLanguage::GERMAN ) {
utils::localize.Switch( utils::Lang::De );
}
else if( settings.language == SettingsLanguage::SPANISH ) {
utils::localize.Switch( utils::Lang::Sp );
}
bool ret;
ret = sys::SystemManager::CreateService(std::make_shared<sgui::ServiceGUI>("ServiceGUI", 480, 600), this );
if( !ret ) {
LOG_ERROR("Failed to initialize GUI service");
}
ret = sys::SystemManager::CreateService(std::make_shared<ServiceEink>("ServiceEink"), this );
if( !ret ) {
LOG_ERROR("Failed to initialize EINK service");
}
//search for application with specified name and run it
#if 1 //change to 0 if you want to run only viewer application for kickstarter
std::string runDesktopName = "ApplicationDesktop";
std::string runCallAppName = "ApplicationCall";
auto it = applications.find(runCallAppName);
if( it!= applications.end()){
it->second->lanucher->runBackground(reinterpret_cast<sys::SystemManager*>(this));
}
it = applications.find(runDesktopName);
if( it!= applications.end()){
messageSwitchApplication( this, it->second->lanucher->getName(), "", nullptr );
}
#else
std::string runCallAppName = "ApplicationViewer";
auto it = applications.find(runCallAppName);
if( it!= applications.end()){
messageSwitchApplication( this, it->second->lanucher->getName(), "", nullptr );
}
#endif
return sys::ReturnCodes::Success;
}
sys::ReturnCodes ApplicationManager::DeinitHandler() {
closeApplications();
closeServices();
delete systemManager;
return sys::ReturnCodes::Success;
}
sys::ReturnCodes ApplicationManager::WakeUpHandler() {
return sys::ReturnCodes::Success;
}
sys::ReturnCodes ApplicationManager::SleepHandler() {
return sys::ReturnCodes::Success;
}
bool ApplicationManager::startApplication( const std::string& appName ) {
state = State::STARTING_NEW_APP;
//search map for application's description structure with specified name
auto it = applications.find(appName);
if( it == applications.end() ) {
LOG_WARN("Failed to find specified application");
return false;
}
if( it->second->state == app::Application::State::ACTIVE_BACKGROUND ) {
state = State::WAITING_GET_FOCUS_CONFIRMATION;
LOG_INFO( "switching focus to application: [%s] window [%s]", appName.c_str(), it->second->switchWindow.c_str());
app::Application::messageSwitchApplication( this, launchApplicationName, it->second->switchWindow, std::move(it->second->switchData) );
}
else {
state = State::WAITING_NEW_APP_REGISTRATION;
LOG_INFO( "starting application: %s", appName.c_str());
it->second->lanucher->run(reinterpret_cast<sys::SystemManager*>(this));
}
return true;
}
//tries to switch the application
bool ApplicationManager::handleSwitchApplication( APMSwitch* msg ) {
//first check if there is application specified in the message
auto it = applications.find(msg->getName());
if( it == applications.end() ) {
//specified application was not found, exiting
LOG_ERROR("Unable to find specified application");
return false;
}
//check if specified application is not the application that is currently running
if( focusApplicationName == msg->getName()) {
LOG_WARN("Trying to rerun currently active application");
return false;
}
//store the name of the application to be executed and start closing previous application
launchApplicationName = msg->getName();
//store window and data if there is any
it->second->switchData = std::move(msg->getData());
it->second->switchWindow = msg->getWindow();
state = State::CLOSING_PREV_APP;
//notify event manager which application should receive keyboard messages
EventManager::messageSetApplication( this, launchApplicationName );
//check if there was previous application
if( !focusApplicationName.empty() ) {
previousApplicationName = focusApplicationName;
auto it = applications.find( previousApplicationName );
//if application's launcher defines that it can be closed send message with close signal
if( it->second->closeable ){
LOG_INFO("APMSwitch waiting for close confirmation from: %s", msg->getSenderName().c_str());
state = State::WAITING_CLOSE_CONFIRMATION;
app::Application::messageCloseApplication( this, previousApplicationName );
}
//if application is not closeable send lost focus message
else {
LOG_INFO("APMSwitch Waiting for lost focus from: %s", msg->getSenderName().c_str());
state = State::WAITING_LOST_FOCUS_CONFIRMATION;
app::Application::messageSwitchApplication(this, previousApplicationName, "", nullptr);
}
}
//if there was no application to close or application can't be closed change internal state to
//STARTING_NEW_APP and send execute lanuchers for that application
else {
startApplication( it->second->name);
}
return true;
}
//tries to switch the application
bool ApplicationManager::handleSwitchPrevApplication( APMSwitchPrevApp* msg ) {
//if there is no previous application return false and do nothing
if( previousApplicationName.empty() ) {
return false;
}
//check if previous application is stored in the description vector
auto it = applications.find( previousApplicationName );
if( it == applications.end() ) {
//specified application was not found, exiting
LOG_ERROR("Unable to find previous application");
return false;
}
//check if specified application is not the application that is currently running
if( focusApplicationName == previousApplicationName ) {
LOG_WARN("Trying to return currently active application");
return false;
}
//set name of the application to be executed and start closing previous application
launchApplicationName = previousApplicationName;
//store window and data if there is any
it->second->switchData = std::move(msg->getData());
state = State::CLOSING_PREV_APP;
//notify event manager which application should receive keyboard messages
EventManager::messageSetApplication( this, launchApplicationName );
//check if there was previous application
if( !focusApplicationName.empty() ) {
previousApplicationName = focusApplicationName;
auto it = applications.find( previousApplicationName );
//if application's launcher defines that it can be closed send message with close signal
if( it->second->closeable ){
LOG_INFO( "Closing application: %s", previousApplicationName.c_str() );
state = State::WAITING_CLOSE_CONFIRMATION;
app::Application::messageCloseApplication( this, previousApplicationName );
}
//if application is not closeable send lost focus message
else {
state = State::WAITING_LOST_FOCUS_CONFIRMATION;
app::Application::messageSwitchApplication(this, previousApplicationName, "LastWindow", nullptr);
}
}
//if there was no application to close or application can't be closed change internal state to
//STARTING_NEW_APP and send execute lanuchers for that application
else {
startApplication( it->second->name);
}
return true;
}
bool ApplicationManager::handleRegisterApplication( APMRegister* msg ) {
if( msg->getSenderName() == launchApplicationName ) {
//check if this is register message from recently launched application
auto it = applications.find(msg->getSenderName());
if( it == applications.end())
return false;
//application starts in background
if( msg->getStartBackground()) {
it->second->state = app::Application::State::ACTIVE_BACKGROUND;
state = State::IDLE;
}
else {
it->second->state = app::Application::State::ACTIVATING;
state = State::WAITING_GET_FOCUS_CONFIRMATION;
app::Application::messageSwitchApplication( this, launchApplicationName, it->second->switchWindow, std::move(it->second->switchData) );
}
}
else {
auto it = applications.find(msg->getSenderName());
it->second->state = app::Application::State::ACTIVE_BACKGROUND;
}
return true;
}
bool ApplicationManager::handleLanguageChange( sapm::APMChangeLanguage* msg ) {
//check if selected language is different than the one that is in the settings
//if they are the same, return doing nothing
SettingsLanguage requestedLanguage;
switch( msg->getLanguage()) {
case utils::Lang::En : requestedLanguage = SettingsLanguage::ENGLISH; break;
case utils::Lang::Pl : requestedLanguage = SettingsLanguage::POLISH; break;
case utils::Lang::De : requestedLanguage = SettingsLanguage::GERMAN; break;
case utils::Lang::Sp : requestedLanguage = SettingsLanguage::SPANISH; break;
default: requestedLanguage = SettingsLanguage::ENGLISH; break;
};
//if requested language is different than current update settings and i18 translations
if( requestedLanguage != settings.language ) {
settings = DBServiceAPI::SettingsGet(this);
settings.language = requestedLanguage;
DBServiceAPI::SettingsUpdate( this, settings );
utils::localize.Switch( msg->getLanguage() );
}
else {
LOG_WARN("Selected language is already set. Ignoring command.");
return true;
}
//iterate over all applications in the background or foreground state and send them rebuild command
for( auto it = applications.begin(); it!=applications.end(); it++ ) {
if( it->second->state == app::Application::State::ACTIVE_BACKGROUND ||
it->second->state == app::Application::State::ACTIVE_FORGROUND ) {
app::Application::messageRebuildApplication(this, it->second->name);
}
}
return true;
}
bool ApplicationManager::handleSwitchConfirmation( APMConfirmSwitch* msg ) {
//this is the case when application manager is waiting for newly started application to confim that it has
//successfully gained focus.
if( state == State::WAITING_GET_FOCUS_CONFIRMATION ) {
if( msg->getSenderName() == launchApplicationName ) {
LOG_INFO("APMConfirmSwitch focus confirmed by: %s", msg->getSenderName().c_str());
focusApplicationName = launchApplicationName;
launchApplicationName = "";
auto it = applications.find(focusApplicationName);
it->second->state = app::Application::State::ACTIVE_FORGROUND;
state = State::IDLE;
return true;
}
}
//this is the case where application manager is waiting for non-closeable application
//to confirm that it has lost focus.
else if( state == State::WAITING_LOST_FOCUS_CONFIRMATION ) {
if( msg->getSenderName() == focusApplicationName ) {
LOG_INFO("APMConfirmSwitch Lost focus confirmed by: %s", msg->getSenderName().c_str());
previousApplicationName = focusApplicationName;
focusApplicationName = "";
auto it = applications.find(previousApplicationName);
it->second->state = app::Application::State::ACTIVE_BACKGROUND;
it->second->switchWindow = "LastWindow";
startApplication( launchApplicationName );
return true;
}
}
LOG_INFO("APMConfirmSwitch error");
return false;
}
bool ApplicationManager::handleCloseConfirmation( APMConfirmClose* msg ) {
auto it = applications.find( msg->getSenderName() );
//if application is running and it's not closeable set state to active background
//otherwise it means that application is ready to be closed by using DestroyService api
if( it->second->closeable ) {
//internally send close message to allow response message to be sended to application
//that has confirmed close request.
it->second->state = app::Application::State::DEACTIVATED;
auto msg = std::make_shared<sapm::APMDelayedClose>( this->GetName(), previousApplicationName );
sys::Bus::SendUnicast(msg, "ApplicationManager", this );
}
else {
it->second->state = app::Application::State::ACTIVE_BACKGROUND;
}
return true;
}
//Static methods
bool ApplicationManager::messageSwitchApplication( sys::Service* sender, const std::string& applicationName, const std::string& windowName, std::unique_ptr<gui::SwitchData> data ) {
auto msg = std::make_shared<sapm::APMSwitch>( sender->GetName(), applicationName, windowName, std::move(data) );
sys::Bus::SendUnicast(msg, "ApplicationManager", sender);
return true;
}
bool ApplicationManager::messageConfirmSwitch( sys::Service* sender) {
auto msg = std::make_shared<sapm::APMConfirmSwitch>(sender->GetName() );
sys::Bus::SendUnicast(msg, "ApplicationManager", sender);
return true;
}
bool ApplicationManager::messageConfirmClose( sys::Service* sender) {
auto msg = std::make_shared<sapm::APMConfirmClose>(sender->GetName() );
sys::Bus::SendUnicast(msg, "ApplicationManager", sender);
return true;
}
bool ApplicationManager::messageSwitchPreviousApplication( sys::Service* sender ) {
auto msg = std::make_shared<sapm::APMSwitchPrevApp>(sender->GetName() );
sys::Bus::SendUnicast(msg, "ApplicationManager", sender);
return true;
}
bool ApplicationManager::messageRegisterApplication( sys::Service* sender, const bool& status, const bool& startBackground ) {
auto msg = std::make_shared<sapm::APMRegister>(sender->GetName(), status, startBackground );
sys::Bus::SendUnicast(msg, "ApplicationManager", sender);
return true;
}
bool ApplicationManager::messageChangeLanguage( sys::Service* sender, utils::Lang language ) {
auto msg = std::make_shared<sapm::APMChangeLanguage>( sender->GetName(), language );
sys::Bus::SendUnicast(msg, "ApplicationManager", sender);
return true;
}
bool ApplicationManager::messageCloseApplicationManager( sys::Service* sender ) {
auto msg = std::make_shared<sapm::APMClose>( sender->GetName() );
sys::Bus::SendUnicast(msg, "ApplicationManager", sender);
return true;
}
} /* namespace sapm */