mirror of
https://github.com/RetroShare/RetroShare.git
synced 2024-12-31 18:36:24 -05:00
121 lines
5.3 KiB
C++
121 lines
5.3 KiB
C++
/*******************************************************************************
|
|
* libresapi/api/RsControlModule.h *
|
|
* *
|
|
* LibResAPI: API for local socket server *
|
|
* *
|
|
* Copyright 2018 by Retroshare Team <retroshare.project@gmail.com> *
|
|
* *
|
|
* This program is free software: you can redistribute it and/or modify *
|
|
* it under the terms of the GNU Affero General Public License as *
|
|
* published by the Free Software Foundation, either version 3 of the *
|
|
* License, or (at your option) any later version. *
|
|
* *
|
|
* This program 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 Affero General Public License for more details. *
|
|
* *
|
|
* You should have received a copy of the GNU Affero General Public License *
|
|
* along with this program. If not, see <https://www.gnu.org/licenses/>. *
|
|
* *
|
|
*******************************************************************************/
|
|
#pragma once
|
|
|
|
#include <util/rsthreads.h>
|
|
#include <util/cxx11retrocompat.h>
|
|
#include <retroshare/rsnotify.h>
|
|
#include "api/ResourceRouter.h"
|
|
|
|
namespace resource_api{
|
|
|
|
class StateTokenServer;
|
|
class ApiServer;
|
|
|
|
// resource api module to control accounts, startup and shutdown of retroshare
|
|
// - this module handles everything, no things are required from outside
|
|
// - exception: users of this module have to create an api server and register this module
|
|
// tasks:
|
|
// - show, import, export and create private pgp keys
|
|
// - show existing and create new locations
|
|
// - load certificate, startup retroshare
|
|
// - handle password callback
|
|
// - confirm plugin loading
|
|
// - shutdown retroshare
|
|
class RsControlModule: public ResourceRouter, NotifyClient, private RsSingleJobThread
|
|
{
|
|
public:
|
|
enum RunState { WAITING_INIT, FATAL_ERROR, WAITING_ACCOUNT_SELECT, WAITING_STARTUP, RUNNING_OK, RUNNING_OK_NO_FULL_CONTROL};
|
|
|
|
// ApiServer will be called once RS is started, to load additional api modules
|
|
// full_control: set to true if this module should handle rsinit and login
|
|
// set to false if rsinit is handled by the Qt gui
|
|
RsControlModule(int argc, char **argv, StateTokenServer* sts, ApiServer* apiserver, bool full_control);
|
|
~RsControlModule() override;
|
|
|
|
// returns true if the process should terminate
|
|
bool processShouldExit();
|
|
|
|
// returns the current state of the software booting process
|
|
RunState runState() const { return mRunState ; }
|
|
|
|
// from NotifyClient
|
|
virtual bool askForPassword(const std::string &title, const std::string& key_details, bool prev_is_bad , std::string& password,bool& canceled) override;
|
|
virtual bool askForDeferredSelfSignature(const void *data, const uint32_t len, unsigned char *sign, unsigned int *signlen,int& signature_result, std::string reason = "") override;
|
|
|
|
virtual void requestShutdown();
|
|
|
|
protected:
|
|
// from RsThread
|
|
// wee need a thread to call into things which block like askForPassword()
|
|
virtual void run() override;
|
|
|
|
private:
|
|
void handleRunState(Request& req, Response& resp);
|
|
void handleIdentities(Request& req, Response& resp);
|
|
void handleLocations(Request& req, Response& resp);
|
|
void handlePassword(Request& req, Response& resp);
|
|
void handleLogin(Request& req, Response& resp);
|
|
void handleShutdown(Request& req, Response& resp);
|
|
void handleImportPgp(Request& req, Response& resp);
|
|
void handleCreateLocation(Request& req, Response& resp);
|
|
|
|
void setRunState(RunState s, std::string errstr = "");
|
|
// for startup
|
|
int argc;
|
|
char **argv;
|
|
|
|
StateTokenServer* const mStateTokenServer;
|
|
ApiServer* const mApiServer;
|
|
|
|
RsMutex mExitFlagMtx;
|
|
bool mProcessShouldExit;
|
|
|
|
RsMutex mDataMtx;
|
|
|
|
StateToken mStateToken; // one state token for everything, to make life easier
|
|
|
|
RunState mRunState;
|
|
std::string mLastErrorString;
|
|
|
|
// id of the account to load
|
|
// null when no account was selected
|
|
RsPeerId mLoadPeerId;
|
|
bool mAutoLoginNextTime;
|
|
|
|
// to notify that a password callback is waiting
|
|
// to answer the request, clear the flag and set the password
|
|
bool mWantPassword;
|
|
bool mPrevIsBad;
|
|
int mCountAttempts;
|
|
std::string mTitle;
|
|
std::string mKeyName;
|
|
std::string mPassword;
|
|
// for ssl cert generation:
|
|
// we know the password already, so we want to avoid to rpompt the user
|
|
// we store the password in this variable, it has higher priority than the normal password variable
|
|
// it is also to avoid a lock, when we make a synchronous call into librs, like in ssl cert generation
|
|
std::string mFixedPassword;
|
|
};
|
|
|
|
} // namespace resource_api
|