mirror of
https://github.com/RetroShare/RetroShare.git
synced 2025-08-05 21:04:14 -04:00
75 lines
2 KiB
C++
75 lines
2 KiB
C++
/*
|
|
* RetroShare Web User Interface public header
|
|
*
|
|
* Copyright (C) 2019 Cyril Soler <csoler@users.sourceforge.net>
|
|
*
|
|
* This program is free software: you can redistribute it and/or modify it under
|
|
* the terms of the GNU Lesser 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 Lesser General Public License for more
|
|
* details.
|
|
*
|
|
* You should have received a copy of the GNU Lesser General Public License
|
|
* along with this program. If not, see <https://www.gnu.org/licenses/>
|
|
*
|
|
* SPDX-FileCopyrightText: 2004-2019 RetroShare Team <contact@retroshare.cc>
|
|
* SPDX-License-Identifier: LGPL-3.0-or-later
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include <string>
|
|
|
|
class RsWebUi;
|
|
|
|
/**
|
|
* Pointer to global instance of RsWebUi service implementation
|
|
* jsonapi_temporarly_disabled{development} because it breaks compilation when
|
|
* webui is disabled
|
|
*/
|
|
extern RsWebUi* rsWebUi;
|
|
|
|
class RsWebUi
|
|
{
|
|
public:
|
|
static const std::string DEFAULT_BASE_DIRECTORY;
|
|
|
|
/**
|
|
* @brief Restart WebUI
|
|
* @jsonapi{development}
|
|
*/
|
|
virtual bool restart() = 0;
|
|
|
|
/**
|
|
* @brief Stop WebUI
|
|
* @jsonapi{development}
|
|
*/
|
|
virtual bool stop() = 0;
|
|
|
|
/**
|
|
* @brief Set WebUI static files directory, need restart to apply
|
|
* @param[in] htmlDir directory path
|
|
* @jsonapi{development}
|
|
*/
|
|
virtual void setHtmlFilesDirectory(const std::string& htmlDir) = 0;
|
|
|
|
/**
|
|
* @brief Set WebUI user password
|
|
* @param[in] password new password for WebUI
|
|
* @jsonapi{development}
|
|
*/
|
|
virtual void setUserPassword(const std::string& password) =0;
|
|
|
|
/**
|
|
* @brief check if WebUI is running
|
|
* @jsonapi{development}
|
|
* @return true if running, false otherwise
|
|
*/
|
|
virtual bool isRunning() const = 0;
|
|
|
|
virtual ~RsWebUi() = default;
|
|
};
|