From 6603dbd913a0b01867adc8a5285b280f3447f176 Mon Sep 17 00:00:00 2001 From: csoler Date: Sun, 10 Nov 2019 17:38:16 +0100 Subject: [PATCH 01/31] code to embed webUI server in the main executable (initial version, not yet working) --- libretroshare/src/libretroshare.pro | 6 + libretroshare/src/rsserver/p3webui.cc | 202 ++++++++++++++++++ libretroshare/src/rsserver/p3webui.h | 49 +++++ retroshare-gui/src/gui/AboutWidget.cpp | 20 +- retroshare-gui/src/gui/HelpDialog.cpp | 18 +- retroshare-gui/src/gui/MainWindow.cpp | 8 +- retroshare-gui/src/gui/MainWindow.h | 2 +- retroshare-gui/src/gui/settings/WebuiPage.cpp | 54 ++--- retroshare-gui/src/gui/settings/WebuiPage.h | 1 + retroshare-gui/src/gui/settings/WebuiPage.ui | 59 +++-- .../src/gui/settings/rsettingswin.cpp | 6 +- .../src/gui/settings/rsharesettings.cpp | 10 +- .../src/gui/settings/rsharesettings.h | 3 + retroshare-gui/src/main.cpp | 8 +- retroshare-gui/src/retroshare-gui.pro | 2 +- retroshare-nogui/src/retroshare.cc | 10 +- retroshare.pri | 8 +- 17 files changed, 355 insertions(+), 111 deletions(-) create mode 100644 libretroshare/src/rsserver/p3webui.cc create mode 100644 libretroshare/src/rsserver/p3webui.h diff --git a/libretroshare/src/libretroshare.pro b/libretroshare/src/libretroshare.pro index 01cbc8852..06c8938a9 100644 --- a/libretroshare/src/libretroshare.pro +++ b/libretroshare/src/libretroshare.pro @@ -159,6 +159,12 @@ PUBLIC_HEADERS = retroshare/rsdisc.h \ retroshare/rsservicecontrol.h \ retroshare/rsgxsdistsync.h +rs_webui { + PUBLIC_HEADERS += retroshare/rswebui.h + SOURCES += rsserver/p3webui.cc + HEADERS += rsserver/p3webui.h +} + HEADERS += plugins/pluginmanager.h \ plugins/dlfcn_win32.h \ rsitems/rspluginitems.h \ diff --git a/libretroshare/src/rsserver/p3webui.cc b/libretroshare/src/rsserver/p3webui.cc new file mode 100644 index 000000000..fc1b2def1 --- /dev/null +++ b/libretroshare/src/rsserver/p3webui.cc @@ -0,0 +1,202 @@ +/******************************************************************************* + * libretroshare/src/rsserver: p3webui.cc * + * * + * libretroshare: retroshare core library * + * * + * Copyright 2019-2019 Cyril Soler * + * * + * 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 . * + * * + *******************************************************************************/ + +#include "p3webui.h" + +#include +#include +#include +#include +#include +#include +#include +#include "util/rsthreads.h" +#include "util/rsdebug.h" +#include "retroshare/rswebui.h" + +#define TEXT_HTML 0 +#define TEXT_CSS 1 +#define TEXT_SVG 2 + +#define DEBUG_RS_WEBUI 1 + +RsWebUI *rsWebUI = new p3WebUI; + +static constexpr char *mime_types[3] = { + "text/html", + "text/css", + "image/svg+xml" +}; + +template class handler +{ + public: + static void get_handler( const std::shared_ptr< restbed::Session > session ) + { + const auto request = session->get_request( ); + const std::string filename = request->get_path_parameter( "filename" ); + const std::string directory = request->get_path_parameter( "dir" ); + + std::string resource_filename = _base_directory + directory + "/" + filename; + std::cerr << "Reading file: \"" << resource_filename << "\"" << std::endl; + std::ifstream stream( resource_filename, std::ifstream::in ); + + if ( stream.is_open( ) ) + { + const std::string body = std::string( std::istreambuf_iterator< char >( stream ), std::istreambuf_iterator< char >( ) ); + + std::cerr << " body length=" << body.length() << std::endl; + const std::multimap< std::string, std::string > headers + { + { "Content-Type", mime_types[MIME_TYPE_INDEX] }, + { "Content-Length", std::to_string( body.length( ) ) } + }; + + session->close( restbed::OK, body, headers ); + } + else + { + std::cerr << "Could not open file " << resource_filename << std::endl; + session->close( restbed::NOT_FOUND ); + } + } + + static std::string _base_directory ; +}; + +template std::string handler::_base_directory = "/home/csoler/Desktop/Code/retroshare/RSNewWebUI/webui/"; + +static void service_ready_handler( restbed::Service& ) +{ + fprintf( stderr, "Hey! The service is up and running." ); +} + +class WebUIThread: public RsThread +{ +public: + WebUIThread() + { + _service = std::make_shared(); + + } + + void runloop() override + { + auto resource1 = std::make_shared< restbed::Resource >( ); + resource1->set_paths( { + "/{filename: index.html}", + "/{filename: app.js}", + } + ); + resource1->set_method_handler( "GET", handler::get_handler ); + + auto resource2 = std::make_shared< restbed::Resource >(); + resource2->set_paths( { + "/{dir: css]/{filename: fontawesome.css}", + "/{dir: css}/{filename: solid.css}", + "/{filename: app.css}", + } ); + resource2->set_method_handler( "GET", handler::get_handler ); + + auto resource3 = std::make_shared< restbed::Resource >(); + resource3->set_paths( { + "/{filename: retroshare.svg}", + } ); + resource3->set_method_handler( "GET", handler::get_handler ); + + auto settings = std::make_shared< restbed::Settings >( ); + settings->set_port( 1984 ); + settings->set_default_header( "Connection", "close" ); + + _service->publish( resource1 ); + _service->publish( resource2 ); + _service->publish( resource3 ); + + _service->set_ready_handler( service_ready_handler ); + _service->start( settings ); + } + void stop() + { + _service->stop(); + + RsThread::ask_for_stop(); + + while(isRunning()) + sleep(1); + } + +private: + std::shared_ptr _service; +}; + +p3WebUI::p3WebUI() +{ + _webui_thread = new WebUIThread; +} +p3WebUI::~p3WebUI() +{ + while(_webui_thread->isRunning()) + { + stop(); + std::cerr << "Deleting webUI object while webUI thread is still running. Trying shutdown...." << std::endl; + rstime::rs_usleep(1000*1000); + } + delete _webui_thread; +} + +bool p3WebUI::restart() +{ + RsDbg() << "Restarting web interface listening on port " << _listening_port << std::endl; + + if(_webui_thread->isRunning()) + _webui_thread->stop(); + + _webui_thread->start(); + return true; +} + +bool p3WebUI::stop() +{ + _webui_thread->stop(); + return true; +} + +void p3WebUI::setHtmlFilesDirectory(const std::string& html_dir) +{ + _html_files_directory = html_dir; +} +void p3WebUI::setListeningPort(uint16_t port) +{ + _listening_port = port; + + if(_webui_thread->isRunning()) + restart(); +} + +int p3WebUI::status() const +{ + if(_webui_thread->isRunning()) + return WEBUI_STATUS_RUNNING; + else + return WEBUI_STATUS_NOT_RUNNING; +} + diff --git a/libretroshare/src/rsserver/p3webui.h b/libretroshare/src/rsserver/p3webui.h new file mode 100644 index 000000000..90d00db4c --- /dev/null +++ b/libretroshare/src/rsserver/p3webui.h @@ -0,0 +1,49 @@ +/******************************************************************************* + * libretroshare/src/rsserver: p3webui.h * + * * + * libretroshare: retroshare core library * + * * + * Copyright 2019-2019 Cyril Soler * + * * + * 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 . * + * * + *******************************************************************************/ + +#include +#include "retroshare/rswebui.h" + +class WebUIThread; + +class p3WebUI: public RsWebUI +{ +public: + p3WebUI(); + virtual ~p3WebUI(); + + virtual bool restart() override; + virtual bool stop() override; + + virtual void setHtmlFilesDirectory(const std::string& html_dir) override; + virtual void setListeningPort(uint16_t port) override; + + virtual int status() const override; + +private: + WebUIThread *_webui_thread; + + std::string _html_files_directory; + uint16_t _listening_port; +}; + + diff --git a/retroshare-gui/src/gui/AboutWidget.cpp b/retroshare-gui/src/gui/AboutWidget.cpp index a0a038594..a6ec24358 100644 --- a/retroshare-gui/src/gui/AboutWidget.cpp +++ b/retroshare-gui/src/gui/AboutWidget.cpp @@ -23,16 +23,14 @@ #include "HelpDialog.h" #include "rshare.h" +#include "restbed" + #include #include #include #include #include "settings/rsharesettings.h" -#ifdef ENABLE_WEBUI -#include -#endif - #include #include #include @@ -972,13 +970,13 @@ void AboutWidget::on_copy_button_clicked() RsControl::instance()->getLibraries(libraries); verInfo+=addLibraries("libretroshare", libraries); -#ifdef ENABLE_WEBUI - /* Add version numbers of RetroShare */ - // Add versions here. Find a better place. - libraries.clear(); - libraries.push_back(RsLibraryInfo("Libmicrohttpd", MHD_get_version())); - verInfo+=addLibraries("RetroShare", libraries); -#endif // ENABLE_WEBUI +// #ifdef RS_WEBUI +// /* Add version numbers of RetroShare */ +// // Add versions here. Find a better place. +// libraries.clear(); +// libraries.push_back(RsLibraryInfo("RestBed", restbed::get_version())); +// verInfo+=addLibraries("RetroShare", libraries); +// #endif /* Add version numbers of plugins */ if (rsPlugins) { diff --git a/retroshare-gui/src/gui/HelpDialog.cpp b/retroshare-gui/src/gui/HelpDialog.cpp index 3bbef144e..cc3f1d407 100644 --- a/retroshare-gui/src/gui/HelpDialog.cpp +++ b/retroshare-gui/src/gui/HelpDialog.cpp @@ -25,10 +25,6 @@ #include #include "rshare.h" -#ifdef ENABLE_WEBUI -#include -#endif // ENABLE_WEBUI - #include #include @@ -91,13 +87,13 @@ HelpDialog::HelpDialog(QWidget *parent) : RsControl::instance()->getLibraries(libraries); addLibraries(ui->libraryLayout, "libretroshare", libraries); -#ifdef ENABLE_WEBUI - /* Add version numbers of RetroShare */ - // Add versions here. Find a better place. - libraries.clear(); - libraries.push_back(RsLibraryInfo("Libmicrohttpd", MHD_get_version())); - addLibraries(ui->libraryLayout, "RetroShare", libraries); -#endif // ENABLE_WEBUI +// #ifdef RS_WEBUI +// /* Add version numbers of RetroShare */ +// // Add versions here. Find a better place. +// libraries.clear(); +// libraries.push_back(RsLibraryInfo("Restbed", restbed::get_version())); +// addLibraries(ui->libraryLayout, "RetroShare", libraries); +// #endif // ENABLE_WEBUI /* Add version numbers of plugins */ if (rsPlugins) { diff --git a/retroshare-gui/src/gui/MainWindow.cpp b/retroshare-gui/src/gui/MainWindow.cpp index b0a438930..e410ff215 100644 --- a/retroshare-gui/src/gui/MainWindow.cpp +++ b/retroshare-gui/src/gui/MainWindow.cpp @@ -113,7 +113,7 @@ #include "common/StatusDefs.h" #include "gui/notifyqt.h" -#ifdef ENABLE_WEBUI +#ifdef RS_WEBUI # include "settings/WebuiPage.h" #endif @@ -605,9 +605,9 @@ void MainWindow::createTrayIcon() trayMenu->addAction(QIcon(IMAGE_MESSENGER), tr("Open Messenger"), this, SLOT(showMessengerWindow())); #endif trayMenu->addAction(QIcon(IMAGE_MESSAGES), tr("Open Messages"), this, SLOT(showMess())); -#ifdef ENABLE_WEBUI +#ifdef RS_WEBUI trayMenu->addAction(QIcon(":/images/emblem-web.png"), tr("Show web interface"), this, SLOT(showWebinterface())); -#endif // ENABLE_WEBUI +#endif trayMenu->addAction(QIcon(IMAGE_BWGRAPH), tr("Bandwidth Graph"), this, SLOT(showBandwidthGraph())); trayMenu->addAction(QIcon(IMAGE_DHT), tr("Statistics"), this, SLOT(showStatisticsWindow())); @@ -1116,7 +1116,7 @@ void MainWindow::showStatisticsWindow() StatisticsWindow::showYourself(); } -#ifdef ENABLE_WEBUI +#ifdef RS_WEBUI void MainWindow::showWebinterface() { WebuiPage::showWebui(); diff --git a/retroshare-gui/src/gui/MainWindow.h b/retroshare-gui/src/gui/MainWindow.h index 00c2b2664..d60524bd2 100644 --- a/retroshare-gui/src/gui/MainWindow.h +++ b/retroshare-gui/src/gui/MainWindow.h @@ -230,7 +230,7 @@ private slots: void showMessengerWindow(); #endif void showStatisticsWindow(); -#ifdef ENABLE_WEBUI +#ifdef RS_WEBUI void showWebinterface(); #endif //void servicePermission(); diff --git a/retroshare-gui/src/gui/settings/WebuiPage.cpp b/retroshare-gui/src/gui/settings/WebuiPage.cpp index a11f94cf8..fd9ab5d0a 100644 --- a/retroshare-gui/src/gui/settings/WebuiPage.cpp +++ b/retroshare-gui/src/gui/settings/WebuiPage.cpp @@ -27,11 +27,7 @@ #include #include "util/misc.h" -#include "api/ApiServer.h" -#include "api/ApiServerMHD.h" -#include "api/ApiServerLocal.h" -#include "api/RsControlModule.h" -#include "api/GetPluginInterfaces.h" +#include "retroshare/rswebui.h" #include "rsharesettings.h" @@ -51,6 +47,7 @@ WebuiPage::WebuiPage(QWidget */*parent*/, Qt::WindowFlags /*flags*/) connect(ui.port_SB, SIGNAL(valueChanged(int)), this, SLOT(onPortValueChanged(int))); connect(ui.allIp_CB, SIGNAL(clicked(bool)), this, SLOT(onAllIPCBClicked(bool))); connect(ui.applyStartBrowser_PB, SIGNAL(clicked()), this, SLOT(onApplyClicked())); + connect(ui.webInterfaceFiles_LE, SIGNAL(clicked()), this, SLOT(selectWebInterfaceDirectory())); } WebuiPage::~WebuiPage() @@ -58,6 +55,11 @@ WebuiPage::~WebuiPage() } +void WebuiPage::selectWebInterfaceDirectory() +{ + QString dirname = QFileDialog::getExistingDirectory(NULL,tr("Please select the directory were to find retroshare webinterface files"),ui.webInterfaceFiles_LE->text()); +} + bool WebuiPage::updateParams(QString &errmsg) { std::cerr << "WebuiPage::save()" << std::endl; @@ -90,6 +92,7 @@ void WebuiPage::load() std::cerr << "WebuiPage::load()" << std::endl; whileBlocking(ui.enableWebUI_CB)->setChecked(Settings->getWebinterfaceEnabled()); whileBlocking(ui.port_SB)->setValue(Settings->getWebinterfacePort()); + whileBlocking(ui.webInterfaceFiles_LE)->setText(Settings->getWebinterfaceFilesDirectory()); whileBlocking(ui.allIp_CB)->setChecked(Settings->getWebinterfaceAllowAllIps()); onEnableCBClicked(Settings->getWebinterfaceEnabled()); } @@ -105,49 +108,18 @@ QString WebuiPage::helpText() const { if(!Settings->getWebinterfaceEnabled()) return true; - if(apiServer || apiServerMHD || controlModule) - return true; - apiServer = new resource_api::ApiServer(); - controlModule = new resource_api::RsControlModule(0, 0, apiServer->getStateTokenServer(), apiServer, false); - apiServer->addResourceHandler("control", dynamic_cast(controlModule), &resource_api::RsControlModule::handleRequest); + rsWebUI->setListeningPort(Settings->getWebinterfacePort()); + rsWebUI->setHtmlFilesDirectory(Settings->getWebinterfaceFilesDirectory().toStdString()); - RsPlugInInterfaces ifaces; - resource_api::getPluginInterfaces(ifaces); - apiServer->loadMainModules(ifaces); + rsWebUI->restart(); - apiServerMHD = new resource_api::ApiServerMHD(apiServer); - bool ok = apiServerMHD->configure(resource_api::getDefaultDocroot(), - Settings->getWebinterfacePort(), - "", - Settings->getWebinterfaceAllowAllIps()); - apiServerMHD->start(); - -// TODO: LIBRESAPI_LOCAL_SERVER Move in appropriate place -#ifdef LIBRESAPI_LOCAL_SERVER - apiServerLocal = new resource_api::ApiServerLocal(apiServer, resource_api::ApiServerLocal::serverPath()); -#endif - - return ok; + return true; } /*static*/ void WebuiPage::checkShutdownWebui() { - if(apiServer || apiServerMHD) - { - apiServerMHD->stop(); - delete apiServerMHD; - apiServerMHD = 0; -// TODO: LIBRESAPI_LOCAL_SERVER Move in appropriate place -#ifdef LIBRESAPI_LOCAL_SERVER - delete apiServerLocal; - apiServerLocal = 0; -#endif - delete apiServer; - apiServer = 0; - delete controlModule; - controlModule = 0; - } + rsWebUI->stop(); } /*static*/ void WebuiPage::showWebui() diff --git a/retroshare-gui/src/gui/settings/WebuiPage.h b/retroshare-gui/src/gui/settings/WebuiPage.h index 03bade956..5141c143b 100644 --- a/retroshare-gui/src/gui/settings/WebuiPage.h +++ b/retroshare-gui/src/gui/settings/WebuiPage.h @@ -58,6 +58,7 @@ public: static void showWebui(); public slots: + void selectWebInterfaceDirectory(); void onEnableCBClicked(bool checked); void onPortValueChanged(int value); void onAllIPCBClicked(bool checked); diff --git a/retroshare-gui/src/gui/settings/WebuiPage.ui b/retroshare-gui/src/gui/settings/WebuiPage.ui index 25b26468c..8460149c6 100644 --- a/retroshare-gui/src/gui/settings/WebuiPage.ui +++ b/retroshare-gui/src/gui/settings/WebuiPage.ui @@ -6,8 +6,8 @@ 0 0 - 497 - 404 + 960 + 717 @@ -29,25 +29,42 @@ Web parameters - - - - - 1024 - - - 65535 - - + + + + + + + Listening port: + + + + + + + 1024 + + + 65535 + + + 1984 + + + + + + + Web interface directory: + + + + + + + - - - - Port: - - - - + Allow access from all IP addresses (Default: localhost only) @@ -67,7 +84,7 @@ - Note: these settings do not affect retroshare-nogui. Retroshare-nogui has a command line switch to activate the web interface. + <html><head/><body><p>Note: these settings do not affect retroshare-service, which has a command line switch to activate the web interface and select the listening port.</p></body></html> true diff --git a/retroshare-gui/src/gui/settings/rsettingswin.cpp b/retroshare-gui/src/gui/settings/rsettingswin.cpp index fa9336c91..b5a3fd4f6 100644 --- a/retroshare-gui/src/gui/settings/rsettingswin.cpp +++ b/retroshare-gui/src/gui/settings/rsettingswin.cpp @@ -44,7 +44,7 @@ #include "gui/common/FloatingHelpBrowser.h" #include "gui/common/RSElidedItemDelegate.h" -#ifdef ENABLE_WEBUI +#ifdef RS_WEBUI # include "WebuiPage.h" #endif @@ -164,9 +164,9 @@ SettingsPage::initStackedWidget() addPage(new AppearancePage()); // APPEARENCE addPage(new SoundPage() ); // SOUND addPage(new ServicePermissionsPage() ); // PERMISSIONS -#ifdef ENABLE_WEBUI +#ifdef RS_WEBUI addPage(new WebuiPage() ); -#endif // ENABLE_WEBUI +#endif #ifdef RS_JSONAPI addPage(new JsonApiPage()); diff --git a/retroshare-gui/src/gui/settings/rsharesettings.cpp b/retroshare-gui/src/gui/settings/rsharesettings.cpp index 873438d70..58f0cc305 100644 --- a/retroshare-gui/src/gui/settings/rsharesettings.cpp +++ b/retroshare-gui/src/gui/settings/rsharesettings.cpp @@ -1152,7 +1152,15 @@ void RshareSettings::setWebinterfaceEnabled(bool enabled) uint16_t RshareSettings::getWebinterfacePort() { - return valueFromGroup("Webinterface", "port", 9090).toUInt(); + return valueFromGroup("Webinterface", "port", 1984).toUInt(); +} + +QString RshareSettings::getWebinterfaceFilesDirectory() +{ +#ifdef WINDOWS_SYS + return valueFromGroup("Webinterface","directory","data/webui/").toString().toStdString(); +#endif + return valueFromGroup("Webinterface","directory","/usr/share/retroshare/webui/").toString(); } void RshareSettings::setWebinterfacePort(uint16_t port) diff --git a/retroshare-gui/src/gui/settings/rsharesettings.h b/retroshare-gui/src/gui/settings/rsharesettings.h index 32f9f169f..df276db21 100644 --- a/retroshare-gui/src/gui/settings/rsharesettings.h +++ b/retroshare-gui/src/gui/settings/rsharesettings.h @@ -334,6 +334,9 @@ public: uint16_t getWebinterfacePort(); void setWebinterfacePort(uint16_t port); + QString getWebinterfaceFilesDirectory(); + void setWebinterfaceFilesDirectory(const QString& dirname); + bool getWebinterfaceAllowAllIps(); void setWebinterfaceAllowAllIps(bool allow_all); diff --git a/retroshare-gui/src/main.cpp b/retroshare-gui/src/main.cpp index 8da9ab0fc..7d75b5c2c 100644 --- a/retroshare-gui/src/main.cpp +++ b/retroshare-gui/src/main.cpp @@ -56,7 +56,7 @@ CrashStackTrace gCrashStackTrace; #ifdef MESSENGER_WINDOW #include "gui/MessengerWindow.h" #endif -#ifdef ENABLE_WEBUI +#ifdef RS_WEBUI # include "gui/settings/WebuiPage.h" #endif @@ -574,7 +574,7 @@ feenableexcept(FE_INVALID | FE_DIVBYZERO); notify->enable() ; // enable notification system after GUI creation, to avoid data races in Qt. -#ifdef ENABLE_WEBUI +#ifdef RS_WEBUI WebuiPage::checkStartWebui(); #endif // ENABLE_WEBUI @@ -595,9 +595,9 @@ feenableexcept(FE_INVALID | FE_DIVBYZERO); JsonApiPage::checkShutdownJsonApi(); #endif // RS_JSONAPI -#ifdef ENABLE_WEBUI +#ifdef RS_WEBUI WebuiPage::checkShutdownWebui(); -#endif // ENABLE_WEBUI +#endif /* cleanup */ ChatDialog::cleanupChat(); diff --git a/retroshare-gui/src/retroshare-gui.pro b/retroshare-gui/src/retroshare-gui.pro index 6597d652e..59f4dc0b9 100644 --- a/retroshare-gui/src/retroshare-gui.pro +++ b/retroshare-gui/src/retroshare-gui.pro @@ -28,7 +28,7 @@ DEFINES += TARGET=\\\"$${TARGET}\\\" DEPENDPATH *= $${PWD} $${RS_INCLUDE_DIR} retroshare-gui INCLUDEPATH *= $${PWD} retroshare-gui -libresapihttpserver { +rs_webui { !include("../../libresapi/src/use_libresapi.pri"):error("Including") HEADERS *= gui/settings/WebuiPage.h SOURCES *= gui/settings/WebuiPage.cpp diff --git a/retroshare-nogui/src/retroshare.cc b/retroshare-nogui/src/retroshare.cc index 1e90edd7d..9ffe191d4 100644 --- a/retroshare-nogui/src/retroshare.cc +++ b/retroshare-nogui/src/retroshare.cc @@ -37,14 +37,6 @@ #include "introserver.h" #endif -#ifdef ENABLE_WEBUI -#include -#include -#include "api/ApiServerMHD.h" -#include "api/RsControlModule.h" -#include "TerminalApiClient.h" -#endif - /* Basic instructions for running libretroshare as background thread. * ******************************************************************* * * This allows your program to communicate with authenticated peers. @@ -60,7 +52,7 @@ int main(int argc, char **argv) RsConfigOptions conf; conf.main_executable_path = argv[0]; -#ifdef ENABLE_WEBUI +#ifdef RS_WEBUI std::string docroot = resource_api::getDefaultDocroot(); uint16_t httpPort = 0; std::string listenAddress; diff --git a/retroshare.pri b/retroshare.pri index e266755bb..8826f9e9a 100644 --- a/retroshare.pri +++ b/retroshare.pri @@ -200,10 +200,10 @@ rs_use_native_dialogs:CONFIG -= no_rs_use_native_dialogs CONFIG *= rs_broadcast_discovery no_rs_broadcast_discovery:CONFIG -= rs_broadcast_discovery -# To enable webui append the following assignation to qmake -# command line "CONFIG+=rs_webui" -CONFIG *= no_rs_webui -rs_webui:CONFIG -= no_rs_webui +# To disable webui append the following assignation to qmake +# command line "CONFIG+=rs_no_webui" +CONFIG *= rs_webui +rs_no_webui:CONFIG -= rs_webui # To enable webui append the following assignation to qmake # command line "CONFIG+=rs_service_webui_terminal_password" From 0103a741d67003667b63917e290d329252637fca Mon Sep 17 00:00:00 2001 From: csoler Date: Sun, 10 Nov 2019 17:56:04 +0100 Subject: [PATCH 02/31] updated default directory value --- libretroshare/src/rsserver/p3webui.cc | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/libretroshare/src/rsserver/p3webui.cc b/libretroshare/src/rsserver/p3webui.cc index fc1b2def1..671d7e27a 100644 --- a/libretroshare/src/rsserver/p3webui.cc +++ b/libretroshare/src/rsserver/p3webui.cc @@ -83,7 +83,11 @@ template class handler static std::string _base_directory ; }; -template std::string handler::_base_directory = "/home/csoler/Desktop/Code/retroshare/RSNewWebUI/webui/"; +#ifdef WINDOWS_SYS +template std::string handler::_base_directory = "data/webui"; +#else +template std::string handler::_base_directory = "/usr/share/retroshare/webui/"; +#endif static void service_ready_handler( restbed::Service& ) { From 3446f0b6779b0dcc4e7b32f6f2743c945d60cdd8 Mon Sep 17 00:00:00 2001 From: csoler Date: Sun, 10 Nov 2019 21:29:26 +0100 Subject: [PATCH 03/31] fixed a few bugs. First running version. --- libretroshare/src/rsserver/p3webui.cc | 40 ++++++++++++------- libretroshare/src/rsserver/p3webui.h | 3 -- retroshare-gui/src/gui/settings/WebuiPage.cpp | 11 ++++- retroshare-gui/src/gui/settings/WebuiPage.ui | 28 ++++++++++++- .../src/gui/settings/rsharesettings.cpp | 16 +++++--- 5 files changed, 73 insertions(+), 25 deletions(-) diff --git a/libretroshare/src/rsserver/p3webui.cc b/libretroshare/src/rsserver/p3webui.cc index 671d7e27a..a5dbf6486 100644 --- a/libretroshare/src/rsserver/p3webui.cc +++ b/libretroshare/src/rsserver/p3webui.cc @@ -47,6 +47,13 @@ static constexpr char *mime_types[3] = { "image/svg+xml" }; +#ifdef WINDOWS_SYS +static std::string _base_directory = "data/webui"; +#else +static std::string _base_directory = "/usr/share/retroshare/webui/"; +#endif + + template class handler { public: @@ -79,16 +86,8 @@ template class handler session->close( restbed::NOT_FOUND ); } } - - static std::string _base_directory ; }; -#ifdef WINDOWS_SYS -template std::string handler::_base_directory = "data/webui"; -#else -template std::string handler::_base_directory = "/usr/share/retroshare/webui/"; -#endif - static void service_ready_handler( restbed::Service& ) { fprintf( stderr, "Hey! The service is up and running." ); @@ -100,7 +99,7 @@ public: WebUIThread() { _service = std::make_shared(); - + _listening_port = 1984; } void runloop() override @@ -128,7 +127,7 @@ public: resource3->set_method_handler( "GET", handler::get_handler ); auto settings = std::make_shared< restbed::Settings >( ); - settings->set_port( 1984 ); + settings->set_port( _listening_port ); settings->set_default_header( "Connection", "close" ); _service->publish( resource1 ); @@ -136,7 +135,16 @@ public: _service->publish( resource3 ); _service->set_ready_handler( service_ready_handler ); - _service->start( settings ); + + try + { + _service->start( settings ); + } + catch(std::exception& e) + { + RsErr() << "Could not start web interface: " << e.what() << std::endl; + return; + } } void stop() { @@ -148,8 +156,12 @@ public: sleep(1); } + void setListeningPort(uint16_t p) { _listening_port = p ; } + uint16_t listeningPort() const { return _listening_port;} + private: std::shared_ptr _service; + uint16_t _listening_port; }; p3WebUI::p3WebUI() @@ -169,7 +181,7 @@ p3WebUI::~p3WebUI() bool p3WebUI::restart() { - RsDbg() << "Restarting web interface listening on port " << _listening_port << std::endl; + RsDbg() << "Restarting web interface listening on port " << _webui_thread->listeningPort() << std::endl; if(_webui_thread->isRunning()) _webui_thread->stop(); @@ -186,11 +198,11 @@ bool p3WebUI::stop() void p3WebUI::setHtmlFilesDirectory(const std::string& html_dir) { - _html_files_directory = html_dir; + _base_directory = html_dir; } void p3WebUI::setListeningPort(uint16_t port) { - _listening_port = port; + _webui_thread->setListeningPort(port); if(_webui_thread->isRunning()) restart(); diff --git a/libretroshare/src/rsserver/p3webui.h b/libretroshare/src/rsserver/p3webui.h index 90d00db4c..a051ffd50 100644 --- a/libretroshare/src/rsserver/p3webui.h +++ b/libretroshare/src/rsserver/p3webui.h @@ -41,9 +41,6 @@ public: private: WebUIThread *_webui_thread; - - std::string _html_files_directory; - uint16_t _listening_port; }; diff --git a/retroshare-gui/src/gui/settings/WebuiPage.cpp b/retroshare-gui/src/gui/settings/WebuiPage.cpp index fd9ab5d0a..0a1c40e4c 100644 --- a/retroshare-gui/src/gui/settings/WebuiPage.cpp +++ b/retroshare-gui/src/gui/settings/WebuiPage.cpp @@ -47,7 +47,7 @@ WebuiPage::WebuiPage(QWidget */*parent*/, Qt::WindowFlags /*flags*/) connect(ui.port_SB, SIGNAL(valueChanged(int)), this, SLOT(onPortValueChanged(int))); connect(ui.allIp_CB, SIGNAL(clicked(bool)), this, SLOT(onAllIPCBClicked(bool))); connect(ui.applyStartBrowser_PB, SIGNAL(clicked()), this, SLOT(onApplyClicked())); - connect(ui.webInterfaceFiles_LE, SIGNAL(clicked()), this, SLOT(selectWebInterfaceDirectory())); + connect(ui.webInterfaceFilesDirectory_PB, SIGNAL(clicked()), this, SLOT(selectWebInterfaceDirectory())); } WebuiPage::~WebuiPage() @@ -58,6 +58,11 @@ WebuiPage::~WebuiPage() void WebuiPage::selectWebInterfaceDirectory() { QString dirname = QFileDialog::getExistingDirectory(NULL,tr("Please select the directory were to find retroshare webinterface files"),ui.webInterfaceFiles_LE->text()); + + if(dirname.isNull()) + return; + + whileBlocking(ui.webInterfaceFiles_LE)->setText(dirname); } bool WebuiPage::updateParams(QString &errmsg) @@ -71,12 +76,16 @@ bool WebuiPage::updateParams(QString &errmsg) changed = true; if(ui.allIp_CB->isChecked() != Settings->getWebinterfaceAllowAllIps()) changed = true; + if(ui.webInterfaceFiles_LE->text() != Settings->getWebinterfaceFilesDirectory()) + changed = true; + if(changed) { // store config Settings->setWebinterfaceEnabled(ui.enableWebUI_CB->isChecked()); Settings->setWebinterfacePort(ui.port_SB->value()); Settings->setWebinterfaceAllowAllIps(ui.allIp_CB->isChecked()); + Settings->setWebinterfaceFilesDirectory(ui.webInterfaceFiles_LE->text()); // apply config checkShutdownWebui(); diff --git a/retroshare-gui/src/gui/settings/WebuiPage.ui b/retroshare-gui/src/gui/settings/WebuiPage.ui index 8460149c6..69d375090 100644 --- a/retroshare-gui/src/gui/settings/WebuiPage.ui +++ b/retroshare-gui/src/gui/settings/WebuiPage.ui @@ -60,7 +60,29 @@ - + + + + + true + + + + + + + <html><head/><body><p>Select directory for webinterface files (advanced)</p></body></html> + + + + + + + :/images/folder-draft24-pressed.png:/images/folder-draft24-pressed.png + + + + @@ -106,6 +128,8 @@ - + + + diff --git a/retroshare-gui/src/gui/settings/rsharesettings.cpp b/retroshare-gui/src/gui/settings/rsharesettings.cpp index 58f0cc305..c58d61539 100644 --- a/retroshare-gui/src/gui/settings/rsharesettings.cpp +++ b/retroshare-gui/src/gui/settings/rsharesettings.cpp @@ -1150,11 +1150,6 @@ void RshareSettings::setWebinterfaceEnabled(bool enabled) setValueToGroup("Webinterface", "enabled", enabled); } -uint16_t RshareSettings::getWebinterfacePort() -{ - return valueFromGroup("Webinterface", "port", 1984).toUInt(); -} - QString RshareSettings::getWebinterfaceFilesDirectory() { #ifdef WINDOWS_SYS @@ -1163,6 +1158,17 @@ QString RshareSettings::getWebinterfaceFilesDirectory() return valueFromGroup("Webinterface","directory","/usr/share/retroshare/webui/").toString(); } +void RshareSettings::setWebinterfaceFilesDirectory(const QString& s) +{ + setValueToGroup("Webinterface","directory",s); +} + + +uint16_t RshareSettings::getWebinterfacePort() +{ + return valueFromGroup("Webinterface", "port", 1984).toUInt(); +} + void RshareSettings::setWebinterfacePort(uint16_t port) { setValueToGroup("Webinterface", "port", port); From 9dc78d66c1d824cb2ef21c89624e5781791b4106 Mon Sep 17 00:00:00 2001 From: csoler Date: Sun, 10 Nov 2019 22:05:55 +0100 Subject: [PATCH 04/31] fixed changing ports and restarting --- libretroshare/src/rsserver/p3webui.cc | 14 +++++++++++++- retroshare-gui/src/gui/settings/WebuiPage.cpp | 17 +++++++++-------- retroshare-gui/src/gui/settings/WebuiPage.h | 1 + 3 files changed, 23 insertions(+), 9 deletions(-) diff --git a/libretroshare/src/rsserver/p3webui.cc b/libretroshare/src/rsserver/p3webui.cc index a5dbf6486..a1b6ea824 100644 --- a/libretroshare/src/rsserver/p3webui.cc +++ b/libretroshare/src/rsserver/p3webui.cc @@ -130,11 +130,21 @@ public: settings->set_port( _listening_port ); settings->set_default_header( "Connection", "close" ); + if(_service->is_up()) + { + std::cerr << "WebUI is already running. Killing it." << std::endl; + _service->stop(); + } + + _service = std::make_shared(); + _service->publish( resource1 ); _service->publish( resource2 ); _service->publish( resource3 ); - _service->set_ready_handler( service_ready_handler ); + std::cerr << "Starting web service on port " << std::dec << _listening_port << std::endl; + //_service->set_ready_handler( service_ready_handler ); + try { @@ -145,6 +155,8 @@ public: RsErr() << "Could not start web interface: " << e.what() << std::endl; return; } + + std::cerr << "(II) Shutting down webui service." << std::endl; } void stop() { diff --git a/retroshare-gui/src/gui/settings/WebuiPage.cpp b/retroshare-gui/src/gui/settings/WebuiPage.cpp index 0a1c40e4c..26f7f3a0f 100644 --- a/retroshare-gui/src/gui/settings/WebuiPage.cpp +++ b/retroshare-gui/src/gui/settings/WebuiPage.cpp @@ -86,16 +86,17 @@ bool WebuiPage::updateParams(QString &errmsg) Settings->setWebinterfacePort(ui.port_SB->value()); Settings->setWebinterfaceAllowAllIps(ui.allIp_CB->isChecked()); Settings->setWebinterfaceFilesDirectory(ui.webInterfaceFiles_LE->text()); - - // apply config - checkShutdownWebui(); - ok = checkStartWebui(); } - if(!ok) - errmsg = "Could not start webinterface."; return ok; } +bool WebuiPage::restart() +{ + // apply config + checkShutdownWebui(); + + return checkStartWebui(); +} void WebuiPage::load() { std::cerr << "WebuiPage::load()" << std::endl; @@ -166,8 +167,8 @@ void WebuiPage::onAllIPCBClicked(bool /*checked*/) void WebuiPage::onApplyClicked() { QString errmsg; - bool ok = updateParams(errmsg); - if(!ok) + + if(!restart()) { QMessageBox::warning(0, tr("failed to start Webinterface"), "Failed to start the webinterface."); return; diff --git a/retroshare-gui/src/gui/settings/WebuiPage.h b/retroshare-gui/src/gui/settings/WebuiPage.h index 5141c143b..65402ed2f 100644 --- a/retroshare-gui/src/gui/settings/WebuiPage.h +++ b/retroshare-gui/src/gui/settings/WebuiPage.h @@ -68,6 +68,7 @@ private: /** Qt Designer generated object */ Ui::WebuiPage ui; + bool restart(); bool updateParams(QString &errmsg); static resource_api::ApiServer* apiServer; From 93376d34618c82628e2d95e722bcb2e2a13c22a9 Mon Sep 17 00:00:00 2001 From: csoler Date: Sun, 10 Nov 2019 22:39:21 +0100 Subject: [PATCH 05/31] added (not yet working) password field --- libretroshare/src/rsserver/p3webui.cc | 7 +--- retroshare-gui/src/gui/settings/WebuiPage.cpp | 16 ++++++-- retroshare-gui/src/gui/settings/WebuiPage.h | 4 +- retroshare-gui/src/gui/settings/WebuiPage.ui | 41 +++++++++++++++---- 4 files changed, 51 insertions(+), 17 deletions(-) diff --git a/libretroshare/src/rsserver/p3webui.cc b/libretroshare/src/rsserver/p3webui.cc index a1b6ea824..557b02a4d 100644 --- a/libretroshare/src/rsserver/p3webui.cc +++ b/libretroshare/src/rsserver/p3webui.cc @@ -98,7 +98,7 @@ class WebUIThread: public RsThread public: WebUIThread() { - _service = std::make_shared(); + _service = std::make_shared(); // this is a place holder, in case we request some internal values. _listening_port = 1984; } @@ -142,12 +142,9 @@ public: _service->publish( resource2 ); _service->publish( resource3 ); - std::cerr << "Starting web service on port " << std::dec << _listening_port << std::endl; - //_service->set_ready_handler( service_ready_handler ); - - try { + std::cerr << "Starting web service on port " << std::dec << _listening_port << std::endl; _service->start( settings ); } catch(std::exception& e) diff --git a/retroshare-gui/src/gui/settings/WebuiPage.cpp b/retroshare-gui/src/gui/settings/WebuiPage.cpp index 26f7f3a0f..1fa8f4ddc 100644 --- a/retroshare-gui/src/gui/settings/WebuiPage.cpp +++ b/retroshare-gui/src/gui/settings/WebuiPage.cpp @@ -46,7 +46,9 @@ WebuiPage::WebuiPage(QWidget */*parent*/, Qt::WindowFlags /*flags*/) connect(ui.enableWebUI_CB, SIGNAL(clicked(bool)), this, SLOT(onEnableCBClicked(bool))); connect(ui.port_SB, SIGNAL(valueChanged(int)), this, SLOT(onPortValueChanged(int))); connect(ui.allIp_CB, SIGNAL(clicked(bool)), this, SLOT(onAllIPCBClicked(bool))); - connect(ui.applyStartBrowser_PB, SIGNAL(clicked()), this, SLOT(onApplyClicked())); + connect(ui.apply_PB, SIGNAL(clicked()), this, SLOT(onApplyClicked())); + connect(ui.password_LE, SIGNAL(textChanged(QString)), this, SLOT(onPasswordValueChanged(QString))); + connect(ui.startWebBrowser_PB, SIGNAL(clicked()), this, SLOT(onStartWebBrowserClicked())); connect(ui.webInterfaceFilesDirectory_PB, SIGNAL(clicked()), this, SLOT(selectWebInterfaceDirectory())); } @@ -55,6 +57,10 @@ WebuiPage::~WebuiPage() } +void WebuiPage::onPasswordValueChanged(QString password) +{ + std::cerr << "Setting new password to \"" << password.toStdString() << "\"" << std::endl; +} void WebuiPage::selectWebInterfaceDirectory() { QString dirname = QFileDialog::getExistingDirectory(NULL,tr("Please select the directory were to find retroshare webinterface files"),ui.webInterfaceFiles_LE->text()); @@ -147,7 +153,8 @@ QString WebuiPage::helpText() const void WebuiPage::onEnableCBClicked(bool checked) { ui.params_GB->setEnabled(checked); - ui.applyStartBrowser_PB->setEnabled(checked); + ui.apply_PB->setEnabled(checked); + ui.startWebBrowser_PB->setEnabled(checked); QString S; updateParams(S); } @@ -163,7 +170,6 @@ void WebuiPage::onAllIPCBClicked(bool /*checked*/) QString S; updateParams(S); } - void WebuiPage::onApplyClicked() { QString errmsg; @@ -173,5 +179,9 @@ void WebuiPage::onApplyClicked() QMessageBox::warning(0, tr("failed to start Webinterface"), "Failed to start the webinterface."); return; } +} + +void WebuiPage::onStartWebBrowserClicked() +{ QDesktopServices::openUrl(QUrl(QString("http://localhost:")+QString::number(ui.port_SB->value()))); } diff --git a/retroshare-gui/src/gui/settings/WebuiPage.h b/retroshare-gui/src/gui/settings/WebuiPage.h index 65402ed2f..8781a1829 100644 --- a/retroshare-gui/src/gui/settings/WebuiPage.h +++ b/retroshare-gui/src/gui/settings/WebuiPage.h @@ -58,11 +58,13 @@ public: static void showWebui(); public slots: - void selectWebInterfaceDirectory(); + void selectWebInterfaceDirectory(); void onEnableCBClicked(bool checked); void onPortValueChanged(int value); + void onPasswordValueChanged(QString password); void onAllIPCBClicked(bool checked); void onApplyClicked(); + void onStartWebBrowserClicked(); private: /** Qt Designer generated object */ diff --git a/retroshare-gui/src/gui/settings/WebuiPage.ui b/retroshare-gui/src/gui/settings/WebuiPage.ui index 69d375090..2b8b758a2 100644 --- a/retroshare-gui/src/gui/settings/WebuiPage.ui +++ b/retroshare-gui/src/gui/settings/WebuiPage.ui @@ -13,7 +13,7 @@ Form - + @@ -52,14 +52,14 @@ - + Web interface directory: - + @@ -84,6 +84,20 @@ + + + + Password: + + + + + + + QLineEdit::Password + + + @@ -97,11 +111,22 @@ - - - Apply setting and start browser - - + + + + + Apply settings + + + + + + + Start web browser + + + + From 3b45fc5199869b84af9d8ae0475e547c800c7636 Mon Sep 17 00:00:00 2001 From: csoler Date: Mon, 11 Nov 2019 22:48:35 +0100 Subject: [PATCH 06/31] added user-based token management to jsonApiServer --- libretroshare/src/jsonapi/jsonapi.cpp | 100 +++++++++++++++++++---- libretroshare/src/jsonapi/jsonapi.h | 28 ++++--- libretroshare/src/jsonapi/jsonapiitems.h | 4 +- 3 files changed, 102 insertions(+), 30 deletions(-) diff --git a/libretroshare/src/jsonapi/jsonapi.cpp b/libretroshare/src/jsonapi/jsonapi.cpp index be808b163..e85fe7fd7 100644 --- a/libretroshare/src/jsonapi/jsonapi.cpp +++ b/libretroshare/src/jsonapi/jsonapi.cpp @@ -432,31 +432,71 @@ bool JsonApiServer::requestNewTokenAutorization(const std::string& token) return false; } +static bool is_alphanumeric(char c) { return (c>='0' && c<'9') || (c>='a' && c<='z') || (c>='A' && c<='Z') ;} +static bool is_alphanumeric(const std::string& s) +{ + for(uint32_t i=0;isecond.size() && ( noOptimiz = CRYPTO_memcmp( passwd.data(), it->second.data(), it->second.size() ) ) == 0 ) return true; // Make token size guessing harder - else noOptimiz = CRYPTO_memcmp(token.data(), token.data(), token.size()); - } + else + noOptimiz = CRYPTO_memcmp(passwd.data(), passwd.data(), passwd.size()); // attempt avoiding +else CRYPTO_memcmp+ being optimized away return static_cast(noOptimiz) + 1 == 0; } -std::set JsonApiServer::getAuthorizedTokens() +std::map JsonApiServer::getAuthorizedTokens() { RS_STACK_MUTEX(configMutex); return mAuthTokenStorage.mAuthorizedTokens; @@ -473,33 +513,57 @@ bool JsonApiServer::revokeAuthToken(const std::string& token) return false; } -bool JsonApiServer::authorizeToken(const std::string& token) +bool JsonApiServer::authorizeUser(const std::string& user,const std::string& passwd) { - if(token.empty()) return false; + if(!is_alphanumeric(user) || !is_alphanumeric(passwd)) + return false; RS_STACK_MUTEX(configMutex); - if(mAuthTokenStorage.mAuthorizedTokens.insert(token).second) + + std::string& p(mAuthTokenStorage.mAuthorizedTokens[user]); + + if(p != passwd) { + p = passwd; IndicateConfigChanged(); - return true; } - return false; + return true; } -/*static*/ std::string JsonApiServer::decodeToken(const std::string& token) + +bool JsonApiServer::authorizeToken(const std::string& token) { - std::vector decodedVect(Radix64::decode(token)); + std::string user,password; + + if(!parseToken(token,user,password)) + return false; + + RS_STACK_MUTEX(configMutex); + + std::string& p(mAuthTokenStorage.mAuthorizedTokens[user]); + + if(p != password) + { + p = password; + IndicateConfigChanged(); + } + return true; +} + +/*static*/ std::string JsonApiServer::decodeToken(const std::string& radix64_token) +{ + std::vector decodedVect(Radix64::decode(radix64_token)); std::string decodedToken( reinterpret_cast(&decodedVect[0]), decodedVect.size() ); return decodedToken; } -/*static*/ std::string JsonApiServer::encondeToken(const std::string& token) +/*static*/ std::string JsonApiServer::encodeToken(const std::string& clear_token) { std::string encoded; - Radix64::encode( reinterpret_cast(token.c_str()), - token.length(), encoded ); + Radix64::encode( reinterpret_cast(clear_token.c_str()), + clear_token.length(), encoded ); return encoded; } diff --git a/libretroshare/src/jsonapi/jsonapi.h b/libretroshare/src/jsonapi/jsonapi.h index 886687917..f3ed1682e 100644 --- a/libretroshare/src/jsonapi/jsonapi.h +++ b/libretroshare/src/jsonapi/jsonapi.h @@ -120,40 +120,48 @@ struct JsonApiServer : RsSingleJobThread, p3Config * @jsonapi{development} * @return the set of authorized encoded tokens */ - std::set getAuthorizedTokens(); + std::map getAuthorizedTokens(); /** * @brief Revoke given auth token * @jsonapi{development} - * @param[in] token decoded + * @param[in] user par of the decoded token * @return true if the token has been revoked, false otherwise */ - bool revokeAuthToken(const std::string& token); + bool revokeAuthToken(const std::string& user); /** * @brief Add new auth token to the authorized set * @jsonapi{development} - * @param[in] token toke to autorize decoded - * @return true if the token has been added to authorized, false if error - * occurred or if the token was already authorized + * @param[in] token token to autorize decoded, in format user:passwd where user and passwd are alphanumeric strings + * @return true if the token has been added to authorized, false if error occurred (e.g. token format is invalid) */ bool authorizeToken(const std::string& token); + /** + * @brief Add new auth (user,passwd) token to the authorized set, creating the token user:passwd internally. + * @jsonapi{development} + * @param[in] alphanumeric_user username to autorize decoded + * @param[in] alphanumeric_passwd passwd to autorize decoded + * @return true if the token has been added to authorized, false if error occurred + */ + bool authorizeUser(const std::string& alphanumeric_user,const std::string& alphanumeric_passwd); + /** * @brief Get decoded version of the given encoded token * @jsonapi{development,unauthenticated} - * @param[in] token encoded + * @param[in] radix64_token encoded * @return token decoded */ - static std::string decodeToken(const std::string& token); + static std::string decodeToken(const std::string& radix64_token); /** * @brief Get encoded version of the given decoded token * @jsonapi{development,unauthenticated} - * @param[in] token decoded + * @param[in] clear_token decoded * @return token encoded */ - static std::string encondeToken(const std::string& token); + static std::string encodeToken(const std::string& clear_token); /** * @brief Write version information to given paramethers diff --git a/libretroshare/src/jsonapi/jsonapiitems.h b/libretroshare/src/jsonapi/jsonapiitems.h index 4c67bf79c..ac6ac8b25 100644 --- a/libretroshare/src/jsonapi/jsonapiitems.h +++ b/libretroshare/src/jsonapi/jsonapiitems.h @@ -29,7 +29,7 @@ #include "serialiser/rsserializer.h" #include "serialiser/rsserializable.h" -enum class JsonApiItemsType : uint8_t { AuthTokenItem = 0 }; +enum class JsonApiItemsType : uint8_t { AuthTokenItem_deprecated = 0, AuthTokenItem = 1 }; struct JsonApiServerAuthTokenStorage : RsItem { @@ -47,7 +47,7 @@ struct JsonApiServerAuthTokenStorage : RsItem /// @see RsItem virtual void clear() { mAuthorizedTokens.clear(); } - std::set mAuthorizedTokens; + std::map mAuthorizedTokens; }; From d19d1685de4e9def08441dd4bf3bcbd04762a26d Mon Sep 17 00:00:00 2001 From: csoler Date: Tue, 12 Nov 2019 22:32:18 +0100 Subject: [PATCH 07/31] made JsonApiServer an singleton through static method instance() --- libretroshare/src/jsonapi/jsonapi.cpp | 39 ++++++-- libretroshare/src/jsonapi/jsonapi.h | 57 +++++++----- libretroshare/src/pqi/p3cfgmgr.cc | 11 +-- libretroshare/src/pqi/p3cfgmgr.h | 3 +- libretroshare/src/rsserver/p3face-config.cc | 2 +- libretroshare/src/rsserver/rsinit.cc | 17 +--- .../src/gui/settings/JsonApiPage.cc | 88 +++++++++---------- .../src/gui/settings/rsharesettings.cpp | 5 +- retroshare-gui/src/main.cpp | 2 - 9 files changed, 129 insertions(+), 95 deletions(-) diff --git a/libretroshare/src/jsonapi/jsonapi.cpp b/libretroshare/src/jsonapi/jsonapi.cpp index e85fe7fd7..2ad54c8ac 100644 --- a/libretroshare/src/jsonapi/jsonapi.cpp +++ b/libretroshare/src/jsonapi/jsonapi.cpp @@ -44,6 +44,9 @@ /*extern*/ JsonApiServer* jsonApiServer = nullptr; +const std::string JsonApiServer::DEFAULT_LISTENING_ADDRESS = "127.0.0.1"; +p3ConfigMgr *JsonApiServer::_config_mgr = nullptr; + /*static*/ const std::multimap JsonApiServer::corsHeaders = { @@ -115,11 +118,33 @@ JsonApiServer::corsOptionsHeaders = return false; } -JsonApiServer::JsonApiServer(uint16_t port, const std::string& bindAddress, - const std::function newAccessRequestCallback ) : - mPort(port), mBindAddress(bindAddress), - mNewAccessRequestCallback(newAccessRequestCallback), - configMutex("JsonApiServer config") +JsonApiServer& JsonApiServer::instance() +{ + static JsonApiServer *_instance = nullptr; + + if(_instance == NULL) + { + _instance = new JsonApiServer(); + + if(_config_mgr == nullptr) + RsErr() << "JsonApiServer::instance() called before JsonApiServer::setConfigManager(). This is a bug!" << std::endl; + + _config_mgr->addConfiguration("jsonapi.cfg",_instance); + } + + return *_instance; +} + +void JsonApiServer::start(uint16_t port, const std::string& bindAddress, const std::function callback) +{ + mPort = port; + mBindAddress = bindAddress; + mNewAccessRequestCallback = callback; + + RsThread::start("JsonApiServer"); +} + +JsonApiServer::JsonApiServer(): configMutex("JsonApiServer config") { registerHandler("/rsLoginHelper/createLocation", [this](const std::shared_ptr session) @@ -342,6 +367,10 @@ JsonApiServer::JsonApiServer(uint16_t port, const std::string& bindAddress, } ); }, true); + RsFileHash dummyHash; + setFilename("jsonapi.cfg"); // hack + loadConfiguration(dummyHash); + // Generated at compile time #include "jsonapi-wrappers.inl" } diff --git a/libretroshare/src/jsonapi/jsonapi.h b/libretroshare/src/jsonapi/jsonapi.h index f3ed1682e..39176d437 100644 --- a/libretroshare/src/jsonapi/jsonapi.h +++ b/libretroshare/src/jsonapi/jsonapi.h @@ -35,11 +35,11 @@ namespace rb = restbed; struct JsonApiServer; -/** - * Pointer to global instance of JsonApiServer - * @jsonapi{development} - */ -extern JsonApiServer* jsonApiServer; +// /** +// * Pointer to global instance of JsonApiServer +// * @jsonapi{development} +// */ +// extern JsonApiServer* jsonApiServer; /** * Simple usage @@ -53,20 +53,9 @@ extern JsonApiServer* jsonApiServer; struct JsonApiServer : RsSingleJobThread, p3Config { static const uint16_t DEFAULT_PORT = 9092 ; + static const std::string DEFAULT_LISTENING_ADDRESS ; - /** - * @brief construct a JsonApiServer instance with given parameters - * @param[in] port listening port fpt the JSON API socket - * @param[in] bindAddress binding address for the JSON API socket - * @param newAccessRequestCallback called when a new auth token is asked to - * be authorized via JSON API, the auth token is passed as parameter, and - * the callback should return true if the new token get access granted and - * false otherwise, this usually requires user interacion to confirm access - */ - JsonApiServer( - uint16_t port = DEFAULT_PORT, - const std::string& bindAddress = "127.0.0.1", - const std::function newAccessRequestCallback = [](const std::string&){return false;} ); + static JsonApiServer& instance() ; /** * @param[in] path Path itno which publish the API call @@ -96,6 +85,17 @@ struct JsonApiServer : RsSingleJobThread, p3Config */ void shutdown(); + /** + * @brief start + * Starts the json Api server. + * + * @param port port to listen to + * @param listen_address bind address to listen to + */ + void start( uint16_t port = DEFAULT_PORT, + const std::string& bindAddress = "127.0.0.1", + const std::function newAccessRequestCallback = [](const std::string&){return false;}); + /** * @brief This function should be used by JSON API clients that aren't * authenticated yet, to ask their token to be authorized, the success or @@ -175,10 +175,25 @@ struct JsonApiServer : RsSingleJobThread, p3Config static void version( uint32_t& major, uint32_t& minor, uint32_t& mini, std::string& extra, std::string&human ); + + static void setConfigMgr(p3ConfigMgr *cfg) { _config_mgr = cfg; } +protected: /// @see RsSingleJobThread virtual void run(); private: + /** + * @brief construct a JsonApiServer instance with given parameters + * @param[in] port listening port fpt the JSON API socket + * @param[in] bindAddress binding address for the JSON API socket + * @param newAccessRequestCallback called when a new auth token is asked to + * be authorized via JSON API, the auth token is passed as parameter, and + * the callback should return true if the new token get access granted and + * false otherwise, this usually requires user interacion to confirm access + */ + JsonApiServer( ); + + /// @see p3Config::setupSerialiser virtual RsSerialiser* setupSerialiser(); @@ -191,8 +206,8 @@ private: /// @see p3Config::saveDone virtual void saveDone(); - const uint16_t mPort; - const std::string mBindAddress; + uint16_t mPort; + std::string mBindAddress; rb::Service mService; /// Called when new JSON API auth token is requested to be authorized @@ -220,5 +235,7 @@ private: return checkRsServicePtrReady( serviceInstance.get(), serviceName, ctx, session ); } + + static p3ConfigMgr *_config_mgr; }; diff --git a/libretroshare/src/pqi/p3cfgmgr.cc b/libretroshare/src/pqi/p3cfgmgr.cc index 890b8d3aa..e51f9fe52 100644 --- a/libretroshare/src/pqi/p3cfgmgr.cc +++ b/libretroshare/src/pqi/p3cfgmgr.cc @@ -173,15 +173,16 @@ void p3ConfigMgr::addConfiguration(std::string file, pqiConfig *conf) } // Also check that the filename is not already registered for another config - for(std::list::const_iterator it = mConfigs.begin(); it!= mConfigs.end(); ++it) + for(std::list::iterator it = mConfigs.begin(); it!= mConfigs.end();) if((*it)->filename == filename) { - std::cerr << "!!!!!!!!!! Trying to register a config for file \"" << filename << "\" that is already registered" << std::endl; - std::cerr << "!!!!!!!!!! Please correct the code !" << std::endl; - return; + std::cerr << "(WW) Registering a config for file \"" << filename << "\" that is already registered. Replacing previous component." << std::endl; + it = mConfigs.erase(it); } + else + ++it; - conf->setFilename(filename); + conf->setFilename(filename);// (cyril) this is quite terrible. The constructor of pqiConfig should take the filename as parameter and hold the information. mConfigs.push_back(conf); } diff --git a/libretroshare/src/pqi/p3cfgmgr.h b/libretroshare/src/pqi/p3cfgmgr.h index b1e554c98..768855d38 100644 --- a/libretroshare/src/pqi/p3cfgmgr.h +++ b/libretroshare/src/pqi/p3cfgmgr.h @@ -106,13 +106,12 @@ void setHash(const RsFileHash& h); RsMutex cfgMtx; - private: - /** * This sets the name of the pqi configuation file */ void setFilename(const std::string& name); +private: /** * @param an index for the Confind which contains list of configuarations that can be tracked */ diff --git a/libretroshare/src/rsserver/p3face-config.cc b/libretroshare/src/rsserver/p3face-config.cc index 8e4bf64cb..f0e73f975 100644 --- a/libretroshare/src/rsserver/p3face-config.cc +++ b/libretroshare/src/rsserver/p3face-config.cc @@ -91,7 +91,7 @@ void RsServer::rsGlobalShutDown() mNetMgr->shutdown(); /* Handles UPnP */ #ifdef RS_JSONAPI - if(jsonApiServer) jsonApiServer->shutdown(); + JsonApiServer::instance().shutdown(); #endif rsAutoProxyMonitor::instance()->stopAllRSShutdown(); diff --git a/libretroshare/src/rsserver/rsinit.cc b/libretroshare/src/rsserver/rsinit.cc index cbf2ff1c9..f4d197a85 100644 --- a/libretroshare/src/rsserver/rsinit.cc +++ b/libretroshare/src/rsserver/rsinit.cc @@ -410,10 +410,8 @@ int RsInit::InitRetroShare(const RsConfigOptions& conf) #ifdef RS_JSONAPI if(rsInitConfig->jsonApiPort) - { - jsonApiServer = new JsonApiServer( rsInitConfig->jsonApiPort, rsInitConfig->jsonApiBindAddress ); - jsonApiServer->start("JSON API Server"); - } + JsonApiServer::instance().start(rsInitConfig->jsonApiPort, rsInitConfig->jsonApiBindAddress); + #endif // ifdef RS_JSONAPI return RS_INIT_OK; @@ -1214,14 +1212,7 @@ int RsServer::StartupRetroShare() // mPluginsManager->loadPlugins(programatically_inserted_plugins) ; -#ifdef RS_JSONAPI - if(jsonApiServer) // JsonApiServer may be disabled at runtime - { - mConfigMgr->addConfiguration("jsonApi.cfg", jsonApiServer); - RsFileHash dummyHash; - jsonApiServer->loadConfiguration(dummyHash); - } -#endif + JsonApiServer::setConfigMgr(mConfigMgr); /**** Reputation system ****/ @@ -1230,7 +1221,7 @@ int RsServer::StartupRetroShare() #ifdef RS_ENABLE_GXS - std::string currGxsDir = RsAccounts::AccountDirectory() + "/gxs"; + std::string currGxsDir = RsAccounts::AccountDirectory() + "/gxs"; RsDirUtil::checkCreateDirectory(currGxsDir); RsNxsNetMgr* nxsMgr = new RsNxsNetMgrImpl(serviceCtrl); diff --git a/retroshare-gui/src/gui/settings/JsonApiPage.cc b/retroshare-gui/src/gui/settings/JsonApiPage.cc index 78d2aa458..d7d10a8c5 100644 --- a/retroshare-gui/src/gui/settings/JsonApiPage.cc +++ b/retroshare-gui/src/gui/settings/JsonApiPage.cc @@ -83,7 +83,13 @@ void JsonApiPage::load() whileBlocking(ui.enableCheckBox)->setChecked(Settings->getJsonApiEnabled()); whileBlocking(ui.portSpinBox)->setValue(Settings->getJsonApiPort()); whileBlocking(ui.listenAddressLineEdit)->setText(Settings->getJsonApiListenAddress()); - whileBlocking(ui.tokensListView)->setModel(new QStringListModel(Settings->getJsonApiAuthTokens())); + + QStringList newTk; + + for(const auto& it : JsonApiServer::instance().getAuthorizedTokens()) + newTk.push_back(QString::fromStdString(it.first)+":"+QString::fromStdString(it.second)) ; + + whileBlocking(ui.tokensListView)->setModel(new QStringListModel(newTk)); } QString JsonApiPage::helpText() const { return ""; } @@ -93,52 +99,38 @@ QString JsonApiPage::helpText() const { return ""; } checkShutdownJsonApi(); if(Settings->getJsonApiEnabled()) - { - jsonApiServer = new JsonApiServer( - Settings->getJsonApiPort(), - Settings->getJsonApiListenAddress().toStdString() ); - jsonApiServer->start("jsonApiServer"); - - for(const QString& token : Settings->getJsonApiAuthTokens()) - jsonApiServer->authorizeToken(token.toStdString()); - } + JsonApiServer::instance().start( Settings->getJsonApiPort(), Settings->getJsonApiListenAddress().toStdString() ); return true; } /*static*/ void JsonApiPage::checkShutdownJsonApi() { - if(jsonApiServer) - { - /* It is important to make a copy of +jsonApiServer+ pointer so the old + JsonApiServer::instance().shutdown(); + + /* It is important to make a copy of +jsonApiServer+ pointer so the old * object can be deleted later, while the original pointer is * reassigned */ - JsonApiServer* oldJsonApiServer = jsonApiServer; - jsonApiServer = nullptr; - oldJsonApiServer->shutdown(); + QProgressDialog* pd = new QProgressDialog( + "Stopping JSON API Server", QString(), 0, 3000); + QTimer* prtm = new QTimer; + prtm->setInterval(16); // 60 FPS + connect( prtm, &QTimer::timeout, + pd, [=](){pd->setValue(pd->value()+16);} ); + pd->show(); + prtm->start(); - QProgressDialog* pd = new QProgressDialog( - "Stopping JSON API Server", QString(), 0, 3000); - QTimer* prtm = new QTimer; - prtm->setInterval(16); // 60 FPS - connect( prtm, &QTimer::timeout, - pd, [=](){pd->setValue(pd->value()+16);} ); - pd->show(); - prtm->start(); - - /* Must wait for deletion because stopping of the server is async. + /* Must wait for deletion because stopping of the server is async. * It is important to capture a copy so it "survive" after * safeStopJsonApiServer returns */ - QTimer::singleShot(3*1000, [=]() - { - delete oldJsonApiServer; - prtm->stop(); - pd->close(); - prtm->deleteLater(); - pd->deleteLater(); - }); - } + QTimer::singleShot(3*1000, [=]() + { + prtm->stop(); + pd->close(); + prtm->deleteLater(); + pd->deleteLater(); + }); } void JsonApiPage::onApplyClicked(bool) @@ -150,23 +142,27 @@ void JsonApiPage::onApplyClicked(bool) void JsonApiPage::addTokenClicked(bool) { QString token(ui.tokenLineEdit->text()); - if(jsonApiServer) jsonApiServer->authorizeToken(token.toStdString()); - QStringList newTk(Settings->getJsonApiAuthTokens()); - newTk.removeAll(token); - newTk.append(token); - Settings->setJsonApiAuthTokens(newTk); + JsonApiServer::instance().authorizeToken(token.toStdString()); + + QStringList newTk; + + for(const auto& it : JsonApiServer::instance().getAuthorizedTokens()) + newTk.push_back(QString::fromStdString(it.first)+":"+QString::fromStdString(it.second)) ; + whileBlocking(ui.tokensListView)->setModel(new QStringListModel(newTk)); } void JsonApiPage::removeTokenClicked(bool) { QString token(ui.tokenLineEdit->text()); - if(jsonApiServer) jsonApiServer->revokeAuthToken(token.toStdString()); - QStringList newTk(Settings->getJsonApiAuthTokens()); - newTk.removeAll(token); - Settings->setJsonApiAuthTokens(newTk); - whileBlocking(ui.tokensListView)->setModel( - new QStringListModel(Settings->getJsonApiAuthTokens()) ); + JsonApiServer::instance().revokeAuthToken(token.toStdString()); + + QStringList newTk; + + for(const auto& it : JsonApiServer::instance().getAuthorizedTokens()) + newTk.push_back(QString::fromStdString(it.first)+":"+QString::fromStdString(it.second)) ; + + whileBlocking(ui.tokensListView)->setModel(new QStringListModel(Settings->getJsonApiAuthTokens()) ); } void JsonApiPage::tokenClicked(const QModelIndex& index) diff --git a/retroshare-gui/src/gui/settings/rsharesettings.cpp b/retroshare-gui/src/gui/settings/rsharesettings.cpp index c58d61539..fbb8f6e3c 100644 --- a/retroshare-gui/src/gui/settings/rsharesettings.cpp +++ b/retroshare-gui/src/gui/settings/rsharesettings.cpp @@ -30,6 +30,9 @@ #include "rsharesettings.h" #include "gui/MainWindow.h" +// for this one, we'd rather use a file in retroshare/*h list. +#include + #include #include @@ -1208,7 +1211,7 @@ void RshareSettings::setJsonApiEnabled(bool enabled) uint16_t RshareSettings::getJsonApiPort() { - return valueFromGroup("JsonApi", "port", 9092).toUInt(); + return valueFromGroup("JsonApi", "port", JsonApiServer::DEFAULT_PORT).toUInt(); } void RshareSettings::setJsonApiPort(uint16_t port) diff --git a/retroshare-gui/src/main.cpp b/retroshare-gui/src/main.cpp index 7d75b5c2c..7cca199be 100644 --- a/retroshare-gui/src/main.cpp +++ b/retroshare-gui/src/main.cpp @@ -233,8 +233,6 @@ feenableexcept(FE_INVALID | FE_DIVBYZERO); RsConfigOptions conf; - conf.jsonApiPort = 0 ; // disable JSon API at start. The JSonAPI preference UI will enable it according to saved parameters. - argstream as(argc,argv); as >> option('s',"stderr" ,conf.outStderr ,"output to stderr instead of log file." ) >> option('u',"udp" ,conf.udpListenerOnly,"Only listen to UDP." ) From 9007d266a8fa3d6749627424df3ad4bc9f985a92 Mon Sep 17 00:00:00 2001 From: csoler Date: Wed, 13 Nov 2019 21:06:20 +0100 Subject: [PATCH 08/31] fixed start/stop of webinterface from GUI --- libretroshare/src/jsonapi/jsonapi.cpp | 17 ++++++++++++++++- libretroshare/src/rsserver/p3webui.cc | 9 ++++++--- retroshare-gui/src/gui/settings/JsonApiPage.cc | 12 +++++++++--- retroshare-gui/src/gui/settings/JsonApiPage.ui | 6 +++--- retroshare-gui/src/gui/settings/WebuiPage.cpp | 12 +++++++++--- retroshare-gui/src/main.cpp | 4 ---- 6 files changed, 43 insertions(+), 17 deletions(-) diff --git a/libretroshare/src/jsonapi/jsonapi.cpp b/libretroshare/src/jsonapi/jsonapi.cpp index 2ad54c8ac..3b3ab0e6f 100644 --- a/libretroshare/src/jsonapi/jsonapi.cpp +++ b/libretroshare/src/jsonapi/jsonapi.cpp @@ -452,7 +452,22 @@ void JsonApiServer::setNewAccessRequestCallback( const std::function& callback ) { mNewAccessRequestCallback = callback; } -void JsonApiServer::shutdown() { mService.stop(); } +void JsonApiServer::shutdown() +{ + mService.stop(); + + RsThread::ask_for_stop(); + + std::cerr << "Stopping JsonApiServer" ; + + while(isRunning()) + { + sleep(1); + std::cerr << "." ; + std::cerr.flush(); + } + std::cerr << std::endl; +} bool JsonApiServer::requestNewTokenAutorization(const std::string& token) { diff --git a/libretroshare/src/rsserver/p3webui.cc b/libretroshare/src/rsserver/p3webui.cc index 557b02a4d..8384bb8f5 100644 --- a/libretroshare/src/rsserver/p3webui.cc +++ b/libretroshare/src/rsserver/p3webui.cc @@ -144,7 +144,7 @@ public: try { - std::cerr << "Starting web service on port " << std::dec << _listening_port << std::endl; + std::cerr << "(II) Starting web service on port " << std::dec << _listening_port << std::endl; _service->start( settings ); } catch(std::exception& e) @@ -153,7 +153,7 @@ public: return; } - std::cerr << "(II) Shutting down webui service." << std::endl; + std::cerr << "(II) webui service stopped." << std::endl; } void stop() { @@ -162,7 +162,10 @@ public: RsThread::ask_for_stop(); while(isRunning()) - sleep(1); + { + std::cerr << "(II) shutting down webui service." << std::endl; + rstime::rs_usleep(1000*1000); + } } void setListeningPort(uint16_t p) { _listening_port = p ; } diff --git a/retroshare-gui/src/gui/settings/JsonApiPage.cc b/retroshare-gui/src/gui/settings/JsonApiPage.cc index d7d10a8c5..f8a045dff 100644 --- a/retroshare-gui/src/gui/settings/JsonApiPage.cc +++ b/retroshare-gui/src/gui/settings/JsonApiPage.cc @@ -48,6 +48,7 @@ bool JsonApiPage::updateParams(QString &errmsg) bool changed = false; bool enabled = ui.enableCheckBox->isChecked(); + if( enabled != Settings->getJsonApiEnabled()) { Settings->setJsonApiEnabled(enabled); @@ -55,6 +56,7 @@ bool JsonApiPage::updateParams(QString &errmsg) } uint16_t port = static_cast(ui.portSpinBox->value()); + if(port != Settings->getJsonApiPort()) { Settings->setJsonApiPort(port); @@ -106,14 +108,17 @@ QString JsonApiPage::helpText() const { return ""; } /*static*/ void JsonApiPage::checkShutdownJsonApi() { - JsonApiServer::instance().shutdown(); + if(!JsonApiServer::instance().isRunning()) + return; + JsonApiServer::instance().shutdown(); // this is a blocking call until the thread is terminated. + +#ifdef SUSPENDED_CODE /* It is important to make a copy of +jsonApiServer+ pointer so the old * object can be deleted later, while the original pointer is * reassigned */ - QProgressDialog* pd = new QProgressDialog( - "Stopping JSON API Server", QString(), 0, 3000); + QProgressDialog* pd = new QProgressDialog("Stopping JSON API Server", QString(), 0, 3000); QTimer* prtm = new QTimer; prtm->setInterval(16); // 60 FPS connect( prtm, &QTimer::timeout, @@ -131,6 +136,7 @@ QString JsonApiPage::helpText() const { return ""; } prtm->deleteLater(); pd->deleteLater(); }); +#endif } void JsonApiPage::onApplyClicked(bool) diff --git a/retroshare-gui/src/gui/settings/JsonApiPage.ui b/retroshare-gui/src/gui/settings/JsonApiPage.ui index 0408c8403..d2a1ab16b 100644 --- a/retroshare-gui/src/gui/settings/JsonApiPage.ui +++ b/retroshare-gui/src/gui/settings/JsonApiPage.ui @@ -6,8 +6,8 @@ 0 0 - 521 - 393 + 545 + 569 @@ -123,7 +123,7 @@ - Restart JSON API Server to apply settings + Apply settings diff --git a/retroshare-gui/src/gui/settings/WebuiPage.cpp b/retroshare-gui/src/gui/settings/WebuiPage.cpp index 1fa8f4ddc..84a3e38ee 100644 --- a/retroshare-gui/src/gui/settings/WebuiPage.cpp +++ b/retroshare-gui/src/gui/settings/WebuiPage.cpp @@ -50,6 +50,8 @@ WebuiPage::WebuiPage(QWidget */*parent*/, Qt::WindowFlags /*flags*/) connect(ui.password_LE, SIGNAL(textChanged(QString)), this, SLOT(onPasswordValueChanged(QString))); connect(ui.startWebBrowser_PB, SIGNAL(clicked()), this, SLOT(onStartWebBrowserClicked())); connect(ui.webInterfaceFilesDirectory_PB, SIGNAL(clicked()), this, SLOT(selectWebInterfaceDirectory())); + + checkStartWebui(); } WebuiPage::~WebuiPage() @@ -110,9 +112,9 @@ void WebuiPage::load() whileBlocking(ui.port_SB)->setValue(Settings->getWebinterfacePort()); whileBlocking(ui.webInterfaceFiles_LE)->setText(Settings->getWebinterfaceFilesDirectory()); whileBlocking(ui.allIp_CB)->setChecked(Settings->getWebinterfaceAllowAllIps()); - onEnableCBClicked(Settings->getWebinterfaceEnabled()); } + QString WebuiPage::helpText() const { return tr("

  Webinterface

\ @@ -123,7 +125,7 @@ QString WebuiPage::helpText() const /*static*/ bool WebuiPage::checkStartWebui() { if(!Settings->getWebinterfaceEnabled()) - return true; + return false; rsWebUI->setListeningPort(Settings->getWebinterfacePort()); rsWebUI->setHtmlFilesDirectory(Settings->getWebinterfaceFilesDirectory().toStdString()); @@ -156,7 +158,11 @@ void WebuiPage::onEnableCBClicked(bool checked) ui.apply_PB->setEnabled(checked); ui.startWebBrowser_PB->setEnabled(checked); QString S; - updateParams(S); + + if(checked) + checkStartWebui(); + else + checkShutdownWebui(); } void WebuiPage::onPortValueChanged(int /*value*/) diff --git a/retroshare-gui/src/main.cpp b/retroshare-gui/src/main.cpp index 7cca199be..3b17e2e76 100644 --- a/retroshare-gui/src/main.cpp +++ b/retroshare-gui/src/main.cpp @@ -572,10 +572,6 @@ feenableexcept(FE_INVALID | FE_DIVBYZERO); notify->enable() ; // enable notification system after GUI creation, to avoid data races in Qt. -#ifdef RS_WEBUI - WebuiPage::checkStartWebui(); -#endif // ENABLE_WEBUI - #ifdef RS_JSONAPI JsonApiPage::checkStartJsonApi(); #endif // RS_JSONAPI From 1b8f137dee446c6379755c4e248f92172681752e Mon Sep 17 00:00:00 2001 From: csoler Date: Wed, 13 Nov 2019 21:35:57 +0100 Subject: [PATCH 09/31] improved UI for jsonapi and webui pages --- libretroshare/src/jsonapi/jsonapi.cpp | 1 + .../src/gui/settings/JsonApiPage.cc | 44 +++++++++++-------- retroshare-gui/src/gui/settings/JsonApiPage.h | 1 + retroshare-gui/src/gui/settings/WebuiPage.cpp | 4 +- retroshare-gui/src/main.cpp | 4 ++ 5 files changed, 33 insertions(+), 21 deletions(-) diff --git a/libretroshare/src/jsonapi/jsonapi.cpp b/libretroshare/src/jsonapi/jsonapi.cpp index 3b3ab0e6f..74511dcbd 100644 --- a/libretroshare/src/jsonapi/jsonapi.cpp +++ b/libretroshare/src/jsonapi/jsonapi.cpp @@ -141,6 +141,7 @@ void JsonApiServer::start(uint16_t port, const std::string& bindAddress, const s mBindAddress = bindAddress; mNewAccessRequestCallback = callback; + std::cerr << "(II) Srtating Json API on port " << port << ", address " << bindAddress << std::endl; RsThread::start("JsonApiServer"); } diff --git a/retroshare-gui/src/gui/settings/JsonApiPage.cc b/retroshare-gui/src/gui/settings/JsonApiPage.cc index f8a045dff..f5226da10 100644 --- a/retroshare-gui/src/gui/settings/JsonApiPage.cc +++ b/retroshare-gui/src/gui/settings/JsonApiPage.cc @@ -32,14 +32,26 @@ JsonApiPage::JsonApiPage(QWidget */*parent*/, Qt::WindowFlags /*flags*/) { ui.setupUi(this); - connect( ui.addTokenPushButton, &QPushButton::clicked, - this, &JsonApiPage::addTokenClicked); - connect( ui.removeTokenPushButton, &QPushButton::clicked, - this, &JsonApiPage::removeTokenClicked ); - connect( ui.tokensListView, &QListView::clicked, - this, &JsonApiPage::tokenClicked ); - connect( ui.applyConfigPushButton, &QPushButton::clicked, - this, &JsonApiPage::onApplyClicked ); + connect( ui.enableCheckBox, SIGNAL(toggled(bool)), this, SLOT(enableJsonApi(bool))); + connect( ui.addTokenPushButton, SIGNAL(clicked()), this, SLOT(addTokenClicked())); + connect( ui.removeTokenPushButton, SIGNAL(clicked()), this, SLOT(removeTokenClicked() )); + connect( ui.tokensListView, SIGNAL(clicked()), this, SLOT(tokenClicked() )); + connect( ui.applyConfigPushButton, SIGNAL(clicked()), this, SLOT(onApplyClicked() )); +} + +void JsonApiPage::enableJsonApi(bool checked) +{ + ui.addTokenPushButton->setEnabled(checked); + ui.applyConfigPushButton->setEnabled(checked); + ui.removeTokenPushButton->setEnabled(checked); + ui.tokensListView->setEnabled(checked); + + Settings->setJsonApiEnabled(checked); + + if(checked) + checkStartJsonApi(); + else + checkShutdownJsonApi(); } bool JsonApiPage::updateParams(QString &errmsg) @@ -64,19 +76,13 @@ bool JsonApiPage::updateParams(QString &errmsg) } QString listenAddress = ui.listenAddressLineEdit->text(); + if(listenAddress != Settings->getJsonApiListenAddress()) { Settings->setJsonApiListenAddress(listenAddress); changed = true; } - if(changed) - { - checkShutdownJsonApi(); - ok = checkStartJsonApi(); - } - - if(!ok) errmsg = "Could not start JSON API Server!"; return ok; } @@ -98,8 +104,6 @@ QString JsonApiPage::helpText() const { return ""; } /*static*/ bool JsonApiPage::checkStartJsonApi() { - checkShutdownJsonApi(); - if(Settings->getJsonApiEnabled()) JsonApiServer::instance().start( Settings->getJsonApiPort(), Settings->getJsonApiListenAddress().toStdString() ); @@ -141,8 +145,10 @@ QString JsonApiPage::helpText() const { return ""; } void JsonApiPage::onApplyClicked(bool) { - QString errmsg; - updateParams(errmsg); + // restart + + checkShutdownJsonApi(); + checkStartJsonApi(); } void JsonApiPage::addTokenClicked(bool) diff --git a/retroshare-gui/src/gui/settings/JsonApiPage.h b/retroshare-gui/src/gui/settings/JsonApiPage.h index a6e12de9a..97eb5407b 100644 --- a/retroshare-gui/src/gui/settings/JsonApiPage.h +++ b/retroshare-gui/src/gui/settings/JsonApiPage.h @@ -53,6 +53,7 @@ public slots: void addTokenClicked(bool); void removeTokenClicked(bool); void tokenClicked(const QModelIndex& index); + void enableJsonApi(bool checked); private: Ui::JsonApiPage ui; /// Qt Designer generated object diff --git a/retroshare-gui/src/gui/settings/WebuiPage.cpp b/retroshare-gui/src/gui/settings/WebuiPage.cpp index 84a3e38ee..d1337a4a4 100644 --- a/retroshare-gui/src/gui/settings/WebuiPage.cpp +++ b/retroshare-gui/src/gui/settings/WebuiPage.cpp @@ -50,8 +50,6 @@ WebuiPage::WebuiPage(QWidget */*parent*/, Qt::WindowFlags /*flags*/) connect(ui.password_LE, SIGNAL(textChanged(QString)), this, SLOT(onPasswordValueChanged(QString))); connect(ui.startWebBrowser_PB, SIGNAL(clicked()), this, SLOT(onStartWebBrowserClicked())); connect(ui.webInterfaceFilesDirectory_PB, SIGNAL(clicked()), this, SLOT(selectWebInterfaceDirectory())); - - checkStartWebui(); } WebuiPage::~WebuiPage() @@ -159,6 +157,8 @@ void WebuiPage::onEnableCBClicked(bool checked) ui.startWebBrowser_PB->setEnabled(checked); QString S; + Settings->setWebinterfaceEnabled(checked); + if(checked) checkStartWebui(); else diff --git a/retroshare-gui/src/main.cpp b/retroshare-gui/src/main.cpp index 3b17e2e76..2ca3e1284 100644 --- a/retroshare-gui/src/main.cpp +++ b/retroshare-gui/src/main.cpp @@ -572,6 +572,10 @@ feenableexcept(FE_INVALID | FE_DIVBYZERO); notify->enable() ; // enable notification system after GUI creation, to avoid data races in Qt. +#ifdef RS_WEBUI + WebuiPage::checkStartWebui(); // normally we should rather save the UI flags internally to p3webui +#endif + #ifdef RS_JSONAPI JsonApiPage::checkStartJsonApi(); #endif // RS_JSONAPI From a584b822a8fa16421b12760b20b8e927759663c9 Mon Sep 17 00:00:00 2001 From: csoler Date: Wed, 13 Nov 2019 21:54:11 +0100 Subject: [PATCH 10/31] fixed typo --- libretroshare/src/jsonapi/jsonapi.cpp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/libretroshare/src/jsonapi/jsonapi.cpp b/libretroshare/src/jsonapi/jsonapi.cpp index 74511dcbd..9935e8b0c 100644 --- a/libretroshare/src/jsonapi/jsonapi.cpp +++ b/libretroshare/src/jsonapi/jsonapi.cpp @@ -141,7 +141,7 @@ void JsonApiServer::start(uint16_t port, const std::string& bindAddress, const s mBindAddress = bindAddress; mNewAccessRequestCallback = callback; - std::cerr << "(II) Srtating Json API on port " << port << ", address " << bindAddress << std::endl; + std::cerr << "(II) Starting Json API on port " << port << ", address " << bindAddress << std::endl; RsThread::start("JsonApiServer"); } From 3ca22f005234399ff965053ab7ce11d8b514cf77 Mon Sep 17 00:00:00 2001 From: csoler Date: Thu, 14 Nov 2019 22:02:42 +0100 Subject: [PATCH 11/31] created separate class for restbed services --- libretroshare/src/jsonapi/jsonapi.h | 11 +- libretroshare/src/jsonapi/restbedservice.cc | 137 +++++++++++++++++++ libretroshare/src/jsonapi/restbedservice.h | 47 +++++++ libretroshare/src/libretroshare.pro | 4 +- libretroshare/src/retroshare/rsjsonapi.h | 38 ++++++ libretroshare/src/rsserver/p3webui.cc | 141 ++++---------------- libretroshare/src/rsserver/p3webui.h | 23 ++-- 7 files changed, 267 insertions(+), 134 deletions(-) create mode 100644 libretroshare/src/jsonapi/restbedservice.cc create mode 100644 libretroshare/src/jsonapi/restbedservice.h create mode 100644 libretroshare/src/retroshare/rsjsonapi.h diff --git a/libretroshare/src/jsonapi/jsonapi.h b/libretroshare/src/jsonapi/jsonapi.h index 39176d437..1ccdeb37e 100644 --- a/libretroshare/src/jsonapi/jsonapi.h +++ b/libretroshare/src/jsonapi/jsonapi.h @@ -35,11 +35,11 @@ namespace rb = restbed; struct JsonApiServer; -// /** -// * Pointer to global instance of JsonApiServer -// * @jsonapi{development} -// */ -// extern JsonApiServer* jsonApiServer; +/** + * Pointer to global instance of JsonApiServer + * @jsonapi{development} + */ +extern JsonApiServer* jsonApiServer; /** * Simple usage @@ -236,6 +236,7 @@ private: serviceInstance.get(), serviceName, ctx, session ); } + JsonApiServer *_instance; static p3ConfigMgr *_config_mgr; }; diff --git a/libretroshare/src/jsonapi/restbedservice.cc b/libretroshare/src/jsonapi/restbedservice.cc new file mode 100644 index 000000000..0eee943f3 --- /dev/null +++ b/libretroshare/src/jsonapi/restbedservice.cc @@ -0,0 +1,137 @@ +/******************************************************************************* + * libretroshare/src/jsonapi/: restbedservice.cc * + * * + * libretroshare: retroshare core library * + * * + * Copyright 2019-2019 Cyril Soler * + * * + * 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 . * + * * + *******************************************************************************/ + +#include "util/rsthreads.h" +#include "util/rsdebug.h" +#include "restbedservice.h" + +class RestbedThread: public RsThread +{ +public: + RestbedThread() + { + _service = std::make_shared(); // this is a place holder, in case we request some internal values. + _listening_port = 1984; + } + + void runloop() override + { + if(_resources.empty()) + { + RsErr() << "(EE) please call RestbedService::setResources() before launching the service!" << std::endl; + return; + } + auto settings = std::make_shared< restbed::Settings >( ); + settings->set_port( _listening_port ); + settings->set_default_header( "Connection", "close" ); + + if(_service->is_up()) + { + std::cerr << "(II) WebUI is already running. Killing it." << std::endl; + _service->stop(); + } + + _service = std::make_shared(); + + for(auto& r:_resources) + _service->publish( r ); + + try + { + std::cerr << "(II) Starting web service on port " << std::dec << _listening_port << std::endl; + _service->start( settings ); + } + catch(std::exception& e) + { + RsErr() << "Could not start web interface: " << e.what() << std::endl; + return; + } + + std::cerr << "(II) webui service stopped." << std::endl; + } + void stop() + { + _service->stop(); + + RsThread::ask_for_stop(); + + while(isRunning()) + { + std::cerr << "(II) shutting down webui service." << std::endl; + rstime::rs_usleep(1000*1000); + } + } + + void setListeningPort(uint16_t p) { _listening_port = p ; } + void setResources(const std::vector >& r) { _resources = r ; } + uint16_t listeningPort() const { return _listening_port;} + +private: + std::shared_ptr _service; + uint16_t _listening_port; + std::vector > _resources; +}; + +RestbedService::RestbedService() +{ + _restbed_thread = new RestbedThread(); +} +RestbedService::~RestbedService() +{ + while(_restbed_thread->isRunning()) + { + stop(); + std::cerr << "Deleting webUI object while webUI thread is still running. Trying shutdown...." << std::endl; + rstime::rs_usleep(1000*1000); + } + delete _restbed_thread; +} + +bool RestbedService::restart() +{ + RsDbg() << "Restarting web interface listening on port " << _restbed_thread->listeningPort() << std::endl; + + if(_restbed_thread->isRunning()) + _restbed_thread->stop(); + + _restbed_thread->setResources(getResources()); + _restbed_thread->start(); + return true; +} + +bool RestbedService::stop() +{ + _restbed_thread->stop(); + return true; +} +bool RestbedService::isRunning() const +{ + return _restbed_thread->isRunning(); +} +void RestbedService::setListeningPort(uint16_t port) +{ + _restbed_thread->setListeningPort(port); + + if(_restbed_thread->isRunning()) + restart(); +} + diff --git a/libretroshare/src/jsonapi/restbedservice.h b/libretroshare/src/jsonapi/restbedservice.h new file mode 100644 index 000000000..56027d1d2 --- /dev/null +++ b/libretroshare/src/jsonapi/restbedservice.h @@ -0,0 +1,47 @@ +/******************************************************************************* + * libretroshare/src/jsonapi/: restbedservice.h * + * * + * libretroshare: retroshare core library * + * * + * Copyright 2019-2019 Cyril Soler * + * * + * 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 . * + * * + *******************************************************************************/ + +#pragma once + +#include + +class RestbedThread; + +class RestbedService +{ +public: + RestbedService() ; + virtual ~RestbedService(); + + bool isRunning() const ; + + virtual bool restart(); + virtual bool stop(); + + virtual void setListeningPort(uint16_t port) ; + + virtual std::vector > getResources()const =0; + +private: + RestbedThread *_restbed_thread; +}; + diff --git a/libretroshare/src/libretroshare.pro b/libretroshare/src/libretroshare.pro index 06c8938a9..96f287425 100644 --- a/libretroshare/src/libretroshare.pro +++ b/libretroshare/src/libretroshare.pro @@ -901,8 +901,8 @@ rs_jsonapi { # Force recalculation of libretroshare dependencies see https://stackoverflow.com/a/47884045 QMAKE_EXTRA_TARGETS += libretroshare - HEADERS += jsonapi/jsonapi.h jsonapi/jsonapiitems.h - SOURCES += jsonapi/jsonapi.cpp + HEADERS += jsonapi/jsonapi.h jsonapi/jsonapiitems.h jsonapi/restbedservice.h retroshare/rsjsonapi.h + SOURCES += jsonapi/jsonapi.cpp jsonapi/restbedservice.cc } rs_deep_channels_index { diff --git a/libretroshare/src/retroshare/rsjsonapi.h b/libretroshare/src/retroshare/rsjsonapi.h new file mode 100644 index 000000000..8799c6461 --- /dev/null +++ b/libretroshare/src/retroshare/rsjsonapi.h @@ -0,0 +1,38 @@ +/******************************************************************************* + * libretroshare/src/retroshare: rsjsonapi.h * + * * + * Copyright (C) 2019-2019 Cyril Soler * + * * + * 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 . * + * + *******************************************************************************/ +#pragma once + +class RsJsonAPI +{ +public: + static const uint16_t DEFAULT_PORT = 9092 ; + static const std::string DEFAULT_BINDING_ADDRESS ; // 127.0.0.1 + + virtual bool restart() =0; + virtual bool stop() =0; + + virtual void setHtmlFilesDirectory(const std::string& html_dir) =0; + virtual void setListeningPort(uint16_t port) =0; + + virtual int status() const=0; +}; + +extern RsJsonAPI *rsJsonAPI; + diff --git a/libretroshare/src/rsserver/p3webui.cc b/libretroshare/src/rsserver/p3webui.cc index 8384bb8f5..65b233328 100644 --- a/libretroshare/src/rsserver/p3webui.cc +++ b/libretroshare/src/rsserver/p3webui.cc @@ -28,7 +28,6 @@ #include #include #include -#include #include "util/rsthreads.h" #include "util/rsdebug.h" #include "retroshare/rswebui.h" @@ -93,136 +92,48 @@ static void service_ready_handler( restbed::Service& ) fprintf( stderr, "Hey! The service is up and running." ); } -class WebUIThread: public RsThread +std::vector > p3WebUI::getResources() const { -public: - WebUIThread() - { - _service = std::make_shared(); // this is a place holder, in case we request some internal values. - _listening_port = 1984; - } + std::vector > rtab; - void runloop() override - { - auto resource1 = std::make_shared< restbed::Resource >( ); - resource1->set_paths( { - "/{filename: index.html}", - "/{filename: app.js}", - } - ); - resource1->set_method_handler( "GET", handler::get_handler ); + auto resource1 = std::make_shared< restbed::Resource >( ); + resource1->set_paths( { + "/{filename: index.html}", + "/{filename: app.js}", + } + ); + resource1->set_method_handler( "GET", handler::get_handler ); - auto resource2 = std::make_shared< restbed::Resource >(); - resource2->set_paths( { - "/{dir: css]/{filename: fontawesome.css}", - "/{dir: css}/{filename: solid.css}", - "/{filename: app.css}", - } ); - resource2->set_method_handler( "GET", handler::get_handler ); + auto resource2 = std::make_shared< restbed::Resource >(); + resource2->set_paths( { + "/{dir: css]/{filename: fontawesome.css}", + "/{dir: css}/{filename: solid.css}", + "/{filename: app.css}", + } ); + resource2->set_method_handler( "GET", handler::get_handler ); - auto resource3 = std::make_shared< restbed::Resource >(); - resource3->set_paths( { - "/{filename: retroshare.svg}", - } ); - resource3->set_method_handler( "GET", handler::get_handler ); + auto resource3 = std::make_shared< restbed::Resource >(); + resource3->set_paths( { + "/{filename: retroshare.svg}", + } ); + resource3->set_method_handler( "GET", handler::get_handler ); - auto settings = std::make_shared< restbed::Settings >( ); - settings->set_port( _listening_port ); - settings->set_default_header( "Connection", "close" ); + rtab.push_back(resource1); + rtab.push_back(resource2); + rtab.push_back(resource3); - if(_service->is_up()) - { - std::cerr << "WebUI is already running. Killing it." << std::endl; - _service->stop(); - } - - _service = std::make_shared(); - - _service->publish( resource1 ); - _service->publish( resource2 ); - _service->publish( resource3 ); - - try - { - std::cerr << "(II) Starting web service on port " << std::dec << _listening_port << std::endl; - _service->start( settings ); - } - catch(std::exception& e) - { - RsErr() << "Could not start web interface: " << e.what() << std::endl; - return; - } - - std::cerr << "(II) webui service stopped." << std::endl; - } - void stop() - { - _service->stop(); - - RsThread::ask_for_stop(); - - while(isRunning()) - { - std::cerr << "(II) shutting down webui service." << std::endl; - rstime::rs_usleep(1000*1000); - } - } - - void setListeningPort(uint16_t p) { _listening_port = p ; } - uint16_t listeningPort() const { return _listening_port;} - -private: - std::shared_ptr _service; - uint16_t _listening_port; -}; - -p3WebUI::p3WebUI() -{ - _webui_thread = new WebUIThread; -} -p3WebUI::~p3WebUI() -{ - while(_webui_thread->isRunning()) - { - stop(); - std::cerr << "Deleting webUI object while webUI thread is still running. Trying shutdown...." << std::endl; - rstime::rs_usleep(1000*1000); - } - delete _webui_thread; + return rtab; } -bool p3WebUI::restart() -{ - RsDbg() << "Restarting web interface listening on port " << _webui_thread->listeningPort() << std::endl; - - if(_webui_thread->isRunning()) - _webui_thread->stop(); - - _webui_thread->start(); - return true; -} - -bool p3WebUI::stop() -{ - _webui_thread->stop(); - return true; -} void p3WebUI::setHtmlFilesDirectory(const std::string& html_dir) { _base_directory = html_dir; } -void p3WebUI::setListeningPort(uint16_t port) -{ - _webui_thread->setListeningPort(port); - - if(_webui_thread->isRunning()) - restart(); -} int p3WebUI::status() const { - if(_webui_thread->isRunning()) + if(isRunning()) return WEBUI_STATUS_RUNNING; else return WEBUI_STATUS_NOT_RUNNING; diff --git a/libretroshare/src/rsserver/p3webui.h b/libretroshare/src/rsserver/p3webui.h index a051ffd50..fa8b843d6 100644 --- a/libretroshare/src/rsserver/p3webui.h +++ b/libretroshare/src/rsserver/p3webui.h @@ -21,26 +21,25 @@ *******************************************************************************/ #include +#include +#include #include "retroshare/rswebui.h" +#include "jsonapi/restbedservice.h" -class WebUIThread; - -class p3WebUI: public RsWebUI +class p3WebUI: public RsWebUI, public RestbedService { public: - p3WebUI(); - virtual ~p3WebUI(); - - virtual bool restart() override; - virtual bool stop() override; + p3WebUI(){} + virtual ~p3WebUI(){} virtual void setHtmlFilesDirectory(const std::string& html_dir) override; - virtual void setListeningPort(uint16_t port) override; + + virtual bool restart() override { return RestbedService::restart();} + virtual bool stop() override { return RestbedService::stop();} + virtual void setListeningPort(uint16_t port) override { RestbedService::setListeningPort(port) ;} virtual int status() const override; - -private: - WebUIThread *_webui_thread; + virtual std::vector > getResources() const override; }; From a304ec20eff809174b4750c931501c4d7711ca61 Mon Sep 17 00:00:00 2001 From: csoler Date: Sat, 16 Nov 2019 00:02:02 +0100 Subject: [PATCH 12/31] converted JsonAPI with public api and using RestbedService system --- libretroshare/src/jsonapi/jsonapi.cpp | 120 +++++-------- libretroshare/src/jsonapi/jsonapi.h | 164 +++++------------- libretroshare/src/jsonapi/restbedservice.cc | 14 +- libretroshare/src/jsonapi/restbedservice.h | 1 + libretroshare/src/retroshare/rsjsonapi.h | 64 ++++++- libretroshare/src/rsserver/p3face-config.cc | 2 +- libretroshare/src/rsserver/p3face.h | 2 + libretroshare/src/rsserver/p3webui.h | 1 + libretroshare/src/rsserver/rsinit.cc | 16 +- .../src/gui/settings/JsonApiPage.cc | 20 ++- 10 files changed, 198 insertions(+), 206 deletions(-) diff --git a/libretroshare/src/jsonapi/jsonapi.cpp b/libretroshare/src/jsonapi/jsonapi.cpp index 9935e8b0c..88dd58c02 100644 --- a/libretroshare/src/jsonapi/jsonapi.cpp +++ b/libretroshare/src/jsonapi/jsonapi.cpp @@ -42,10 +42,9 @@ // Generated at compile time #include "jsonapi-includes.inl" -/*extern*/ JsonApiServer* jsonApiServer = nullptr; +/*extern*/ RsJsonAPI* rsJsonAPI = nullptr; -const std::string JsonApiServer::DEFAULT_LISTENING_ADDRESS = "127.0.0.1"; -p3ConfigMgr *JsonApiServer::_config_mgr = nullptr; +const std::string RsJsonAPI::DEFAULT_BINDING_ADDRESS = "127.0.0.1"; /*static*/ const std::multimap JsonApiServer::corsHeaders = @@ -118,33 +117,6 @@ JsonApiServer::corsOptionsHeaders = return false; } -JsonApiServer& JsonApiServer::instance() -{ - static JsonApiServer *_instance = nullptr; - - if(_instance == NULL) - { - _instance = new JsonApiServer(); - - if(_config_mgr == nullptr) - RsErr() << "JsonApiServer::instance() called before JsonApiServer::setConfigManager(). This is a bug!" << std::endl; - - _config_mgr->addConfiguration("jsonapi.cfg",_instance); - } - - return *_instance; -} - -void JsonApiServer::start(uint16_t port, const std::string& bindAddress, const std::function callback) -{ - mPort = port; - mBindAddress = bindAddress; - mNewAccessRequestCallback = callback; - - std::cerr << "(II) Starting Json API on port " << port << ", address " << bindAddress << std::endl; - RsThread::start("JsonApiServer"); -} - JsonApiServer::JsonApiServer(): configMutex("JsonApiServer config") { registerHandler("/rsLoginHelper/createLocation", @@ -179,7 +151,7 @@ JsonApiServer::JsonApiServer(): configMutex("JsonApiServer config") makeAutoTor ); if(retval) - authorizeToken(location.mLocationId.toStdString()+":"+password); + authorizeUser(location.mLocationId.toStdString(),password); // serialize out parameters and return value to JSON { @@ -221,7 +193,7 @@ JsonApiServer::JsonApiServer(): configMutex("JsonApiServer config") rsLoginHelper->attemptLogin(account, password); if( retval == RsInit::OK ) - authorizeToken(account.toStdString()+":"+password); + authorizeUser(account.toStdString(),password); // serialize out parameters and return value to JSON { @@ -367,11 +339,6 @@ JsonApiServer::JsonApiServer(): configMutex("JsonApiServer config") session->yield(message.str()); } ); }, true); - - RsFileHash dummyHash; - setFilename("jsonapi.cfg"); // hack - loadConfiguration(dummyHash); - // Generated at compile time #include "jsonapi-wrappers.inl" } @@ -398,6 +365,11 @@ void JsonApiServer::run() mService.start(settings); } +std::vector > JsonApiServer::getResources() const +{ + return _resources; +} + void JsonApiServer::registerHandler( const std::string& path, const std::function)>& handler, @@ -446,34 +418,21 @@ void JsonApiServer::registerHandler( else session->close(rb::UNAUTHORIZED); } ); - mService.publish(resource); + _resources.push_back(resource); } -void JsonApiServer::setNewAccessRequestCallback( - const std::function& callback ) -{ mNewAccessRequestCallback = callback; } - -void JsonApiServer::shutdown() +void JsonApiServer::setNewAccessRequestCallback( const std::function& callback ) { - mService.stop(); - - RsThread::ask_for_stop(); - - std::cerr << "Stopping JsonApiServer" ; - - while(isRunning()) - { - sleep(1); - std::cerr << "." ; - std::cerr.flush(); - } - std::cerr << std::endl; + mNewAccessRequestCallback = callback; } -bool JsonApiServer::requestNewTokenAutorization(const std::string& token) +bool JsonApiServer::requestNewTokenAutorization(const std::string& user) { - if(rsLoginHelper->isLoggedIn() && mNewAccessRequestCallback(token)) - return authorizeToken(token); + std::string passwd; + + if(rsLoginHelper->isLoggedIn() && mNewAccessRequestCallback(user,passwd)) + return authorizeUser(user,passwd); + return false; } @@ -576,24 +535,24 @@ bool JsonApiServer::authorizeUser(const std::string& user,const std::string& pas } -bool JsonApiServer::authorizeToken(const std::string& token) -{ - std::string user,password; - - if(!parseToken(token,user,password)) - return false; - - RS_STACK_MUTEX(configMutex); - - std::string& p(mAuthTokenStorage.mAuthorizedTokens[user]); - - if(p != password) - { - p = password; - IndicateConfigChanged(); - } - return true; -} +// bool JsonApiServer::authorizeToken(const std::string& token) +// { +// std::string user,password; +// +// if(!parseToken(token,user,password)) +// return false; +// +// RS_STACK_MUTEX(configMutex); +// +// std::string& p(mAuthTokenStorage.mAuthorizedTokens[user]); +// +// if(p != password) +// { +// p = password; +// IndicateConfigChanged(); +// } +// return true; +// } /*static*/ std::string JsonApiServer::decodeToken(const std::string& radix64_token) { @@ -660,3 +619,10 @@ void JsonApiServer::handleCorsOptions( const std::shared_ptr session ) { session->close(rb::NO_CONTENT, corsOptionsHeaders); } +int JsonApiServer::status() const +{ + if(isRunning()) + return JSONAPI_STATUS_RUNNING; + else + return JSONAPI_STATUS_NOT_RUNNING; +} diff --git a/libretroshare/src/jsonapi/jsonapi.h b/libretroshare/src/jsonapi/jsonapi.h index 1ccdeb37e..7c8e9ca5d 100644 --- a/libretroshare/src/jsonapi/jsonapi.h +++ b/libretroshare/src/jsonapi/jsonapi.h @@ -29,18 +29,12 @@ #include "pqi/p3cfgmgr.h" #include "rsitems/rsitem.h" #include "jsonapi/jsonapiitems.h" +#include "jsonapi/restbedservice.h" +#include "retroshare/rsjsonapi.h" #include "util/rsthreads.h" namespace rb = restbed; -struct JsonApiServer; - -/** - * Pointer to global instance of JsonApiServer - * @jsonapi{development} - */ -extern JsonApiServer* jsonApiServer; - /** * Simple usage * \code{.cpp} @@ -50,102 +44,27 @@ extern JsonApiServer* jsonApiServer; * \endcode * Uses p3Config to securely store persistent JSON API authorization tokens */ -struct JsonApiServer : RsSingleJobThread, p3Config +class JsonApiServer : public p3Config, public RestbedService, public RsJsonAPI { - static const uint16_t DEFAULT_PORT = 9092 ; - static const std::string DEFAULT_LISTENING_ADDRESS ; +public: + JsonApiServer() ; + virtual ~JsonApiServer() = default; - static JsonApiServer& instance() ; + // public API - /** - * @param[in] path Path itno which publish the API call - * @param[in] handler function which will be called to handle the requested - * @param[in] requiresAutentication specify if the API call must be - * autenticated or not - * path, the function must be declared like: - * \code{.cpp} - * void functionName(const shared_ptr session) - * \endcode - */ - void registerHandler( - const std::string& path, - const std::function)>& handler, - bool requiresAutentication = true ); + virtual bool restart() override { return RestbedService::restart();} + virtual bool stop() override { return RestbedService::stop();} + virtual void setListeningPort(uint16_t port) override { RestbedService::setListeningPort(port) ;} + virtual void setBindingAddress(const std::string& address) override { RestbedService::setBindAddress(address); } + virtual int status() const override; - /** - * @brief Set new access request callback - * @param callback function to call when a new JSON API access is requested - */ - void setNewAccessRequestCallback( - const std::function& callback ); + virtual bool authorizeUser(const std::string& alphanumeric_user,const std::string& alphanumeric_passwd) override; + virtual std::map getAuthorizedTokens() override; + bool revokeAuthToken(const std::string& user) override; + bool isAuthTokenValid(const std::string& token) override; + bool requestNewTokenAutorization(const std::string& user) override; - /** - * @brief Shutdown the JSON API server - * Beware that this method shout down only the JSON API server instance not - */ - void shutdown(); - - /** - * @brief start - * Starts the json Api server. - * - * @param port port to listen to - * @param listen_address bind address to listen to - */ - void start( uint16_t port = DEFAULT_PORT, - const std::string& bindAddress = "127.0.0.1", - const std::function newAccessRequestCallback = [](const std::string&){return false;}); - - /** - * @brief This function should be used by JSON API clients that aren't - * authenticated yet, to ask their token to be authorized, the success or - * failure will depend on mNewAccessRequestCallback return value, and it - * will likely need human user interaction in the process. - * @jsonapi{development,unauthenticated} - * @param[in] token token to autorize - * @return true if authorization succeded, false otherwise. - */ - bool requestNewTokenAutorization(const std::string& token); - - /** - * @brief Check if given JSON API auth token is authorized - * @jsonapi{development} - * @param[in] token decoded - * @return tru if authorized, false otherwise - */ - bool isAuthTokenValid(const std::string& token); - - /** - * @brief Get uthorized tokens - * @jsonapi{development} - * @return the set of authorized encoded tokens - */ - std::map getAuthorizedTokens(); - - /** - * @brief Revoke given auth token - * @jsonapi{development} - * @param[in] user par of the decoded token - * @return true if the token has been revoked, false otherwise - */ - bool revokeAuthToken(const std::string& user); - - /** - * @brief Add new auth token to the authorized set - * @jsonapi{development} - * @param[in] token token to autorize decoded, in format user:passwd where user and passwd are alphanumeric strings - * @return true if the token has been added to authorized, false if error occurred (e.g. token format is invalid) - */ - bool authorizeToken(const std::string& token); - - /** - * @brief Add new auth (user,passwd) token to the authorized set, creating the token user:passwd internally. - * @jsonapi{development} - * @param[in] alphanumeric_user username to autorize decoded - * @param[in] alphanumeric_passwd passwd to autorize decoded - * @return true if the token has been added to authorized, false if error occurred - */ - bool authorizeUser(const std::string& alphanumeric_user,const std::string& alphanumeric_passwd); + // private API /** * @brief Get decoded version of the given encoded token @@ -176,23 +95,35 @@ struct JsonApiServer : RsSingleJobThread, p3Config std::string& extra, std::string&human ); - static void setConfigMgr(p3ConfigMgr *cfg) { _config_mgr = cfg; } + // /!\ These methods shouldn't be accessible through http! + + /** + * @param[in] path Path itno which publish the API call + * @param[in] handler function which will be called to handle the requested + * @param[in] requiresAutentication specify if the API call must be + * autenticated or not + * path, the function must be declared like: + * \code{.cpp} + * void functionName(const shared_ptr session) + * \endcode + */ + void registerHandler( + const std::string& path, + const std::function)>& handler, + bool requiresAutentication = true ); + + /** + * @brief Set new access request callback + * @param callback function to call when a new JSON API access is requested + */ + void setNewAccessRequestCallback(const std::function& callback ); + protected: /// @see RsSingleJobThread virtual void run(); + virtual std::vector > getResources() const; private: - /** - * @brief construct a JsonApiServer instance with given parameters - * @param[in] port listening port fpt the JSON API socket - * @param[in] bindAddress binding address for the JSON API socket - * @param newAccessRequestCallback called when a new auth token is asked to - * be authorized via JSON API, the auth token is passed as parameter, and - * the callback should return true if the new token get access granted and - * false otherwise, this usually requires user interacion to confirm access - */ - JsonApiServer( ); - /// @see p3Config::setupSerialiser virtual RsSerialiser* setupSerialiser(); @@ -211,7 +142,9 @@ private: rb::Service mService; /// Called when new JSON API auth token is requested to be authorized - std::function mNewAccessRequestCallback; + /// The callback supplies the password to be used to make the token + /// + std::function mNewAccessRequestCallback; /// Encrypted persistent storage for authorized JSON API tokens JsonApiServerAuthTokenStorage mAuthTokenStorage; @@ -224,19 +157,18 @@ private: static bool checkRsServicePtrReady( const void* serviceInstance, const std::string& serviceName, RsGenericSerializer::SerializeContext& ctx, - const std::shared_ptr session ); + const std::shared_ptr session ); static inline bool checkRsServicePtrReady( const std::shared_ptr serviceInstance, const std::string& serviceName, RsGenericSerializer::SerializeContext& ctx, - const std::shared_ptr session ) + const std::shared_ptr session ) { return checkRsServicePtrReady( serviceInstance.get(), serviceName, ctx, session ); } - JsonApiServer *_instance; - static p3ConfigMgr *_config_mgr; + std::vector > _resources; }; diff --git a/libretroshare/src/jsonapi/restbedservice.cc b/libretroshare/src/jsonapi/restbedservice.cc index 0eee943f3..4d4bfb72a 100644 --- a/libretroshare/src/jsonapi/restbedservice.cc +++ b/libretroshare/src/jsonapi/restbedservice.cc @@ -42,6 +42,7 @@ public: } auto settings = std::make_shared< restbed::Settings >( ); settings->set_port( _listening_port ); + settings->set_bind_address( _binding_address ); settings->set_default_header( "Connection", "close" ); if(_service->is_up()) @@ -82,13 +83,16 @@ public: } void setListeningPort(uint16_t p) { _listening_port = p ; } + void setBindAddress(const std::string& bindAddress) { _binding_address = bindAddress ; } void setResources(const std::vector >& r) { _resources = r ; } uint16_t listeningPort() const { return _listening_port;} private: std::shared_ptr _service; - uint16_t _listening_port; std::vector > _resources; + + uint16_t _listening_port; + std::string _binding_address; }; RestbedService::RestbedService() @@ -135,3 +139,11 @@ void RestbedService::setListeningPort(uint16_t port) restart(); } +void RestbedService::setBindAddress(const std::string& bind_address) +{ + _restbed_thread->setBindAddress(bind_address); + + if(_restbed_thread->isRunning()) + restart(); +} + diff --git a/libretroshare/src/jsonapi/restbedservice.h b/libretroshare/src/jsonapi/restbedservice.h index 56027d1d2..79efd9660 100644 --- a/libretroshare/src/jsonapi/restbedservice.h +++ b/libretroshare/src/jsonapi/restbedservice.h @@ -38,6 +38,7 @@ public: virtual bool stop(); virtual void setListeningPort(uint16_t port) ; + virtual void setBindAddress(const std::string& bind_address); virtual std::vector > getResources()const =0; diff --git a/libretroshare/src/retroshare/rsjsonapi.h b/libretroshare/src/retroshare/rsjsonapi.h index 8799c6461..8886ce15a 100644 --- a/libretroshare/src/retroshare/rsjsonapi.h +++ b/libretroshare/src/retroshare/rsjsonapi.h @@ -1,6 +1,7 @@ /******************************************************************************* * libretroshare/src/retroshare: rsjsonapi.h * * * + * Copyright (C) 2018-2019 Gioacchino Mazzurco * * Copyright (C) 2019-2019 Cyril Soler * * * * This program is free software: you can redistribute it and/or modify * @@ -22,16 +23,77 @@ class RsJsonAPI { public: + enum { + JSONAPI_STATUS_UNKNOWN = 0x00, + JSONAPI_STATUS_RUNNING = 0x01, + JSONAPI_STATUS_NOT_RUNNING = 0x02 + }; + static const uint16_t DEFAULT_PORT = 9092 ; static const std::string DEFAULT_BINDING_ADDRESS ; // 127.0.0.1 virtual bool restart() =0; virtual bool stop() =0; - virtual void setHtmlFilesDirectory(const std::string& html_dir) =0; + virtual void setBindingAddress(const std::string& address) =0; virtual void setListeningPort(uint16_t port) =0; + /** + * @brief Get status of the json api server + * @jsonapi{development} + * @return the status picked in the enum JSONAPI_STATUS_UNKNOWN/RUNNING/NOT_RUNNING + */ virtual int status() const=0; + + //=============================================================================================// + // API methods that are also accessible through http // + //=============================================================================================// + /** + * @brief This function should be used by JSON API clients that aren't + * authenticated yet, to ask their token to be authorized, the success or + * failure will depend on mNewAccessRequestCallback return value, and it + * will likely need human user interaction in the process. + * @jsonapi{development,unauthenticated} + * @param[in] token token to autorize + * @return true if authorization succeded, false otherwise. + */ + virtual bool requestNewTokenAutorization(const std::string& token)=0; + + //=============================================================================================// + // API methods that SHOULD NOT be accessible through http // + //=============================================================================================// + + //////////////// @Gio: The methods below should not be accessible from the API server ! + /// + /** + * @brief Add new auth (user,passwd) token to the authorized set, creating the token user:passwd internally. + * @param[in] alphanumeric_user username to autorize decoded + * @param[in] alphanumeric_passwd passwd to autorize decoded + * @return true if the token has been added to authorized, false if error occurred + */ + virtual bool authorizeUser(const std::string& alphanumeric_user,const std::string& alphanumeric_passwd)=0; + + /** + * @brief Revoke given auth token + * @param[in] user par of the decoded token + * @return true if the token has been revoked, false otherwise + */ + virtual bool revokeAuthToken(const std::string& user)=0; + + /** + * @brief Get authorized tokens + * @return the set of authorized encoded tokens + */ + virtual std::map getAuthorizedTokens() =0; + + /** + * @brief Check if given JSON API auth token is authorized + * @param[in] token decoded + * @return tru if authorized, false otherwise + */ + virtual bool isAuthTokenValid(const std::string& token); + + }; extern RsJsonAPI *rsJsonAPI; diff --git a/libretroshare/src/rsserver/p3face-config.cc b/libretroshare/src/rsserver/p3face-config.cc index f0e73f975..986167b53 100644 --- a/libretroshare/src/rsserver/p3face-config.cc +++ b/libretroshare/src/rsserver/p3face-config.cc @@ -91,7 +91,7 @@ void RsServer::rsGlobalShutDown() mNetMgr->shutdown(); /* Handles UPnP */ #ifdef RS_JSONAPI - JsonApiServer::instance().shutdown(); + rsJsonAPI->stop(); #endif rsAutoProxyMonitor::instance()->stopAllRSShutdown(); diff --git a/libretroshare/src/rsserver/p3face.h b/libretroshare/src/rsserver/p3face.h index 01a51caeb..62267e06b 100644 --- a/libretroshare/src/rsserver/p3face.h +++ b/libretroshare/src/rsserver/p3face.h @@ -34,6 +34,7 @@ #include "retroshare/rsiface.h" #include "retroshare/rstypes.h" #include "util/rsthreads.h" +#include "jsonapi/jsonapi.h" #include "chat/p3chatservice.h" #include "gxstunnel/p3gxstunnel.h" @@ -157,6 +158,7 @@ public: RsPluginManager *mPluginsManager; //sslroot *sslr; + JsonApiServer *mJsonAPIServer; /* services */ p3heartbeat *mHeart; diff --git a/libretroshare/src/rsserver/p3webui.h b/libretroshare/src/rsserver/p3webui.h index fa8b843d6..6493b6a1e 100644 --- a/libretroshare/src/rsserver/p3webui.h +++ b/libretroshare/src/rsserver/p3webui.h @@ -37,6 +37,7 @@ public: virtual bool restart() override { return RestbedService::restart();} virtual bool stop() override { return RestbedService::stop();} virtual void setListeningPort(uint16_t port) override { RestbedService::setListeningPort(port) ;} + virtual void setBindingAddress(const std::string& address) override { RestbedService::setBindAddress(address) ;} virtual int status() const override; virtual std::vector > getResources() const override; diff --git a/libretroshare/src/rsserver/rsinit.cc b/libretroshare/src/rsserver/rsinit.cc index f4d197a85..9efe1bc6b 100644 --- a/libretroshare/src/rsserver/rsinit.cc +++ b/libretroshare/src/rsserver/rsinit.cc @@ -410,7 +410,11 @@ int RsInit::InitRetroShare(const RsConfigOptions& conf) #ifdef RS_JSONAPI if(rsInitConfig->jsonApiPort) - JsonApiServer::instance().start(rsInitConfig->jsonApiPort, rsInitConfig->jsonApiBindAddress); + { + rsJsonAPI->setListeningPort(rsInitConfig->jsonApiPort); + rsJsonAPI->setBindingAddress(rsInitConfig->jsonApiBindAddress); + rsJsonAPI->restart(); + } #endif // ifdef RS_JSONAPI @@ -1212,7 +1216,15 @@ int RsServer::StartupRetroShare() // mPluginsManager->loadPlugins(programatically_inserted_plugins) ; - JsonApiServer::setConfigMgr(mConfigMgr); +#ifdef RS_JSONAPI + mJsonAPIServer = new JsonApiServer; + rsJsonAPI = mJsonAPIServer; + + mConfigMgr->addConfiguration("jsonapi.cfg",mJsonAPIServer); + + RsFileHash dummyHash; + mJsonAPIServer->loadConfiguration(dummyHash); +#endif /**** Reputation system ****/ diff --git a/retroshare-gui/src/gui/settings/JsonApiPage.cc b/retroshare-gui/src/gui/settings/JsonApiPage.cc index f5226da10..5d8e202a4 100644 --- a/retroshare-gui/src/gui/settings/JsonApiPage.cc +++ b/retroshare-gui/src/gui/settings/JsonApiPage.cc @@ -94,7 +94,7 @@ void JsonApiPage::load() QStringList newTk; - for(const auto& it : JsonApiServer::instance().getAuthorizedTokens()) + for(const auto& it : rsJsonAPI->getAuthorizedTokens()) newTk.push_back(QString::fromStdString(it.first)+":"+QString::fromStdString(it.second)) ; whileBlocking(ui.tokensListView)->setModel(new QStringListModel(newTk)); @@ -105,17 +105,17 @@ QString JsonApiPage::helpText() const { return ""; } /*static*/ bool JsonApiPage::checkStartJsonApi() { if(Settings->getJsonApiEnabled()) - JsonApiServer::instance().start( Settings->getJsonApiPort(), Settings->getJsonApiListenAddress().toStdString() ); + rsJsonAPI->restart(); return true; } /*static*/ void JsonApiPage::checkShutdownJsonApi() { - if(!JsonApiServer::instance().isRunning()) + rsJsonAPI->isRunning()) return; - JsonApiServer::instance().shutdown(); // this is a blocking call until the thread is terminated. + rsJsonAPI->stop(); // this is a blocking call until the thread is terminated. #ifdef SUSPENDED_CODE /* It is important to make a copy of +jsonApiServer+ pointer so the old @@ -148,17 +148,21 @@ void JsonApiPage::onApplyClicked(bool) // restart checkShutdownJsonApi(); + + rsJsonAPI->setListeningPort(ui.portSpinBox->value()); + rsJsonAPI->setBindingAddress(ui.listenAddressLineEdit->text().toStdString()); + checkStartJsonApi(); } void JsonApiPage::addTokenClicked(bool) { QString token(ui.tokenLineEdit->text()); - JsonApiServer::instance().authorizeToken(token.toStdString()); + rsJsonAPI->authorizeUser(token.toStdString()); QStringList newTk; - for(const auto& it : JsonApiServer::instance().getAuthorizedTokens()) + for(const auto& it : rsJsonAPI->getAuthorizedTokens()) newTk.push_back(QString::fromStdString(it.first)+":"+QString::fromStdString(it.second)) ; whileBlocking(ui.tokensListView)->setModel(new QStringListModel(newTk)); @@ -167,11 +171,11 @@ void JsonApiPage::addTokenClicked(bool) void JsonApiPage::removeTokenClicked(bool) { QString token(ui.tokenLineEdit->text()); - JsonApiServer::instance().revokeAuthToken(token.toStdString()); + rsJsonAPI->revokeAuthToken(token.toStdString()); QStringList newTk; - for(const auto& it : JsonApiServer::instance().getAuthorizedTokens()) + for(const auto& it : rsJsonAPI->getAuthorizedTokens()) newTk.push_back(QString::fromStdString(it.first)+":"+QString::fromStdString(it.second)) ; whileBlocking(ui.tokensListView)->setModel(new QStringListModel(Settings->getJsonApiAuthTokens()) ); From 6878a7773dd4595dc2ec824f511e6a9fe0b1b2d7 Mon Sep 17 00:00:00 2001 From: csoler Date: Sat, 16 Nov 2019 14:30:36 +0100 Subject: [PATCH 13/31] fixed start/stop of jsonapi in GUI --- libretroshare/src/jsonapi/jsonapi.cpp | 65 ++++++++--------- libretroshare/src/jsonapi/jsonapi.h | 2 +- libretroshare/src/jsonapi/restbedservice.cc | 8 +-- libretroshare/src/retroshare/rsjsonapi.h | 10 ++- .../src/gui/settings/JsonApiPage.cc | 72 +++++++++++-------- retroshare-gui/src/gui/settings/JsonApiPage.h | 3 +- 6 files changed, 89 insertions(+), 71 deletions(-) diff --git a/libretroshare/src/jsonapi/jsonapi.cpp b/libretroshare/src/jsonapi/jsonapi.cpp index 88dd58c02..88281a4d7 100644 --- a/libretroshare/src/jsonapi/jsonapi.cpp +++ b/libretroshare/src/jsonapi/jsonapi.cpp @@ -117,6 +117,39 @@ JsonApiServer::corsOptionsHeaders = return false; } +static bool is_alphanumeric(char c) { return (c>='0' && c<'9') || (c>='a' && c<='z') || (c>='A' && c<='Z') ;} +static bool is_alphanumeric(const std::string& s) +{ + for(uint32_t i=0;i='0' && c<'9') || (c>='a' && c<='z') || (c>='A' && c<='Z') ;} -static bool is_alphanumeric(const std::string& s) -{ - for(uint32_t i=0;istart( settings ); } catch(std::exception& e) @@ -67,7 +67,7 @@ public: return; } - std::cerr << "(II) webui service stopped." << std::endl; + std::cerr << "(II) restbed service stopped." << std::endl; } void stop() { @@ -77,7 +77,7 @@ public: while(isRunning()) { - std::cerr << "(II) shutting down webui service." << std::endl; + std::cerr << "(II) shutting down restbed service." << std::endl; rstime::rs_usleep(1000*1000); } } @@ -112,7 +112,7 @@ RestbedService::~RestbedService() bool RestbedService::restart() { - RsDbg() << "Restarting web interface listening on port " << _restbed_thread->listeningPort() << std::endl; + RsDbg() << "Restarting restbed service listening on port " << _restbed_thread->listeningPort() << std::endl; if(_restbed_thread->isRunning()) _restbed_thread->stop(); diff --git a/libretroshare/src/retroshare/rsjsonapi.h b/libretroshare/src/retroshare/rsjsonapi.h index 8886ce15a..0c741a4c9 100644 --- a/libretroshare/src/retroshare/rsjsonapi.h +++ b/libretroshare/src/retroshare/rsjsonapi.h @@ -20,6 +20,8 @@ *******************************************************************************/ #pragma once +#include + class RsJsonAPI { public: @@ -59,6 +61,12 @@ public: */ virtual bool requestNewTokenAutorization(const std::string& token)=0; + //=============================================================================================// + // Utility methods // + //=============================================================================================// + + static bool parseToken(const std::string& clear_token,std::string& user,std::string& passwd); + //=============================================================================================// // API methods that SHOULD NOT be accessible through http // //=============================================================================================// @@ -91,7 +99,7 @@ public: * @param[in] token decoded * @return tru if authorized, false otherwise */ - virtual bool isAuthTokenValid(const std::string& token); + virtual bool isAuthTokenValid(const std::string& token)=0; }; diff --git a/retroshare-gui/src/gui/settings/JsonApiPage.cc b/retroshare-gui/src/gui/settings/JsonApiPage.cc index 5d8e202a4..532373976 100644 --- a/retroshare-gui/src/gui/settings/JsonApiPage.cc +++ b/retroshare-gui/src/gui/settings/JsonApiPage.cc @@ -37,6 +37,26 @@ JsonApiPage::JsonApiPage(QWidget */*parent*/, Qt::WindowFlags /*flags*/) connect( ui.removeTokenPushButton, SIGNAL(clicked()), this, SLOT(removeTokenClicked() )); connect( ui.tokensListView, SIGNAL(clicked()), this, SLOT(tokenClicked() )); connect( ui.applyConfigPushButton, SIGNAL(clicked()), this, SLOT(onApplyClicked() )); + connect( ui.portSpinBox, SIGNAL(valueChanged(int)), this, SLOT(updateParams() )); + connect( ui.listenAddressLineEdit, SIGNAL(textChanged(QString)), this, SLOT(updateParams() )); + + // This limits the possible tokens to alphanumeric + + QString anRange = "{[a-z]|[A-Z]|[0-9]}+"; + QRegExp anRegex ("^" + anRange + ":" + anRange + "$"); + QRegExpValidator *anValidator = new QRegExpValidator(anRegex, this); + + ui.tokenLineEdit->setValidator(anValidator); + + // This limits the possible tokens to alphanumeric + + QString ipRange = "(?:[0-1]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])"; + // You may want to use QRegularExpression for new code with Qt 5 (not mandatory). + QRegExp ipRegex ("^" + ipRange + "\\." + ipRange + "\\." + ipRange + "\\." + ipRange + "$"); + QRegExpValidator *ipValidator = new QRegExpValidator(ipRegex, this); + + ui.listenAddressLineEdit->setValidator(ipValidator); + } void JsonApiPage::enableJsonApi(bool checked) @@ -45,6 +65,8 @@ void JsonApiPage::enableJsonApi(bool checked) ui.applyConfigPushButton->setEnabled(checked); ui.removeTokenPushButton->setEnabled(checked); ui.tokensListView->setEnabled(checked); + ui.portSpinBox->setEnabled(checked); + ui.listenAddressLineEdit->setEnabled(checked); Settings->setJsonApiEnabled(checked); @@ -54,43 +76,26 @@ void JsonApiPage::enableJsonApi(bool checked) checkShutdownJsonApi(); } -bool JsonApiPage::updateParams(QString &errmsg) +bool JsonApiPage::updateParams() { bool ok = true; bool changed = false; - bool enabled = ui.enableCheckBox->isChecked(); - - if( enabled != Settings->getJsonApiEnabled()) - { - Settings->setJsonApiEnabled(enabled); - changed = true; - } - uint16_t port = static_cast(ui.portSpinBox->value()); - - if(port != Settings->getJsonApiPort()) - { - Settings->setJsonApiPort(port); - changed = true; - } - QString listenAddress = ui.listenAddressLineEdit->text(); - if(listenAddress != Settings->getJsonApiListenAddress()) - { - Settings->setJsonApiListenAddress(listenAddress); - changed = true; - } + Settings->setJsonApiEnabled(ui.enableCheckBox->isChecked()); + Settings->setJsonApiPort(port); + Settings->setJsonApiListenAddress(listenAddress); return ok; } void JsonApiPage::load() { - whileBlocking(ui.enableCheckBox)->setChecked(Settings->getJsonApiEnabled()); whileBlocking(ui.portSpinBox)->setValue(Settings->getJsonApiPort()); whileBlocking(ui.listenAddressLineEdit)->setText(Settings->getJsonApiListenAddress()); + whileBlocking(ui.enableCheckBox)->setChecked(Settings->getJsonApiEnabled()); QStringList newTk; @@ -102,17 +107,21 @@ void JsonApiPage::load() QString JsonApiPage::helpText() const { return ""; } -/*static*/ bool JsonApiPage::checkStartJsonApi() +bool JsonApiPage::checkStartJsonApi() { - if(Settings->getJsonApiEnabled()) - rsJsonAPI->restart(); + if(!Settings->getJsonApiEnabled()) + return false; + + rsJsonAPI->setListeningPort(Settings->getJsonApiPort()); + rsJsonAPI->setBindingAddress(Settings->getJsonApiListenAddress().toStdString()); + rsJsonAPI->restart(); return true; } /*static*/ void JsonApiPage::checkShutdownJsonApi() { - rsJsonAPI->isRunning()) + if(RsJsonAPI::JSONAPI_STATUS_RUNNING != rsJsonAPI->status()) return; rsJsonAPI->stop(); // this is a blocking call until the thread is terminated. @@ -148,17 +157,18 @@ void JsonApiPage::onApplyClicked(bool) // restart checkShutdownJsonApi(); - - rsJsonAPI->setListeningPort(ui.portSpinBox->value()); - rsJsonAPI->setBindingAddress(ui.listenAddressLineEdit->text().toStdString()); - checkStartJsonApi(); } void JsonApiPage::addTokenClicked(bool) { QString token(ui.tokenLineEdit->text()); - rsJsonAPI->authorizeUser(token.toStdString()); + std::string user,passwd; + + if(!RsJsonAPI::parseToken(token.toStdString(),user,passwd)) + return; + + rsJsonAPI->authorizeUser(user,passwd); QStringList newTk; diff --git a/retroshare-gui/src/gui/settings/JsonApiPage.h b/retroshare-gui/src/gui/settings/JsonApiPage.h index 97eb5407b..fff404087 100644 --- a/retroshare-gui/src/gui/settings/JsonApiPage.h +++ b/retroshare-gui/src/gui/settings/JsonApiPage.h @@ -54,9 +54,8 @@ public slots: void removeTokenClicked(bool); void tokenClicked(const QModelIndex& index); void enableJsonApi(bool checked); + bool updateParams(); private: Ui::JsonApiPage ui; /// Qt Designer generated object - - bool updateParams(QString &errmsg); }; From 9491f1a78eed61dff35b3db2f35490a9a0379bb3 Mon Sep 17 00:00:00 2001 From: csoler Date: Sat, 16 Nov 2019 18:19:07 +0100 Subject: [PATCH 14/31] fixed interactions between webui and jsonapi in GUI --- libretroshare/src/jsonapi/jsonapi.cpp | 2 +- libretroshare/src/rsserver/p3webui.cc | 10 ++++++ libretroshare/src/rsserver/p3webui.h | 1 + .../src/gui/settings/JsonApiPage.cc | 30 +++++++++++++--- retroshare-gui/src/gui/settings/JsonApiPage.h | 10 +++--- .../src/gui/settings/JsonApiPage.ui | 2 +- retroshare-gui/src/gui/settings/WebuiPage.cpp | 36 ++++++++++++++++--- retroshare-gui/src/gui/settings/WebuiPage.h | 3 ++ .../src/gui/settings/rsettingswin.cpp | 11 +++--- retroshare-gui/src/main.cpp | 16 ++++----- 10 files changed, 94 insertions(+), 27 deletions(-) diff --git a/libretroshare/src/jsonapi/jsonapi.cpp b/libretroshare/src/jsonapi/jsonapi.cpp index 88281a4d7..e8836448b 100644 --- a/libretroshare/src/jsonapi/jsonapi.cpp +++ b/libretroshare/src/jsonapi/jsonapi.cpp @@ -144,7 +144,7 @@ bool RsJsonAPI::parseToken(const std::string& clear_token,std::string& user,std: return false; user = clear_token.substr(0,last_index); - passwd = clear_token.substr(last_index+1,(int)clear_token.size()-(int)last_index-2); + passwd = clear_token.substr(last_index+1,(int)clear_token.size()-(int)last_index-1); return true; } diff --git a/libretroshare/src/rsserver/p3webui.cc b/libretroshare/src/rsserver/p3webui.cc index 65b233328..96279bd0d 100644 --- a/libretroshare/src/rsserver/p3webui.cc +++ b/libretroshare/src/rsserver/p3webui.cc @@ -31,6 +31,7 @@ #include "util/rsthreads.h" #include "util/rsdebug.h" #include "retroshare/rswebui.h" +#include "retroshare/rsjsonapi.h" #define TEXT_HTML 0 #define TEXT_CSS 1 @@ -139,3 +140,12 @@ int p3WebUI::status() const return WEBUI_STATUS_NOT_RUNNING; } +void p3WebUI::setUserPassword(const std::string& passwd) +{ +#ifdef RS_JSONAPI + if(!rsJsonAPI->authorizeUser("webui",passwd)) + std::cerr << "(EE) Cannot register webui token. Some error occurred when calling authorizeUser()" << std::endl; +#else + std::cerr << "(EE) JsonAPI is not available in this buildof Retroshare! Cannot register a user password for the WebUI" << std::endl; +#endif +} diff --git a/libretroshare/src/rsserver/p3webui.h b/libretroshare/src/rsserver/p3webui.h index 6493b6a1e..aaeb7bb7c 100644 --- a/libretroshare/src/rsserver/p3webui.h +++ b/libretroshare/src/rsserver/p3webui.h @@ -38,6 +38,7 @@ public: virtual bool stop() override { return RestbedService::stop();} virtual void setListeningPort(uint16_t port) override { RestbedService::setListeningPort(port) ;} virtual void setBindingAddress(const std::string& address) override { RestbedService::setBindAddress(address) ;} + virtual void setUserPassword(const std::string& passwd) override; virtual int status() const override; virtual std::vector > getResources() const override; diff --git a/retroshare-gui/src/gui/settings/JsonApiPage.cc b/retroshare-gui/src/gui/settings/JsonApiPage.cc index 532373976..8d35f2fb2 100644 --- a/retroshare-gui/src/gui/settings/JsonApiPage.cc +++ b/retroshare-gui/src/gui/settings/JsonApiPage.cc @@ -35,14 +35,15 @@ JsonApiPage::JsonApiPage(QWidget */*parent*/, Qt::WindowFlags /*flags*/) connect( ui.enableCheckBox, SIGNAL(toggled(bool)), this, SLOT(enableJsonApi(bool))); connect( ui.addTokenPushButton, SIGNAL(clicked()), this, SLOT(addTokenClicked())); connect( ui.removeTokenPushButton, SIGNAL(clicked()), this, SLOT(removeTokenClicked() )); - connect( ui.tokensListView, SIGNAL(clicked()), this, SLOT(tokenClicked() )); + connect( ui.tokensListView, SIGNAL(clicked(const QModelIndex&)), this, SLOT(tokenClicked(const QModelIndex&) )); connect( ui.applyConfigPushButton, SIGNAL(clicked()), this, SLOT(onApplyClicked() )); connect( ui.portSpinBox, SIGNAL(valueChanged(int)), this, SLOT(updateParams() )); connect( ui.listenAddressLineEdit, SIGNAL(textChanged(QString)), this, SLOT(updateParams() )); + connect( ui.tokenLineEdit, SIGNAL(textChanged(QString)), this, SLOT(checkToken(QString) )); // This limits the possible tokens to alphanumeric - QString anRange = "{[a-z]|[A-Z]|[0-9]}+"; + QString anRange = "[a-zA-Z0-9]+"; QRegExp anRegex ("^" + anRange + ":" + anRange + "$"); QRegExpValidator *anValidator = new QRegExpValidator(anRegex, this); @@ -152,7 +153,7 @@ bool JsonApiPage::checkStartJsonApi() #endif } -void JsonApiPage::onApplyClicked(bool) +void JsonApiPage::onApplyClicked() { // restart @@ -160,7 +161,26 @@ void JsonApiPage::onApplyClicked(bool) checkStartJsonApi(); } -void JsonApiPage::addTokenClicked(bool) +void JsonApiPage::checkToken(QString s) +{ + std::string user,passwd; + + bool valid = RsJsonAPI::parseToken(s.toStdString(),user,passwd) && !user.empty() && !passwd.empty(); + QColor color; + + if(!valid) + color = QApplication::palette().color(QPalette::Disabled, QPalette::Base); + else + color = QApplication::palette().color(QPalette::Active, QPalette::Base); + + /* unpolish widget to clear the stylesheet's palette cache */ + //ui.searchLineFrame->style()->unpolish(ui.searchLineFrame); + + QPalette palette = ui.tokenLineEdit->palette(); + palette.setColor(ui.tokenLineEdit->backgroundRole(), color); + ui.tokenLineEdit->setPalette(palette); +} +void JsonApiPage::addTokenClicked() { QString token(ui.tokenLineEdit->text()); std::string user,passwd; @@ -178,7 +198,7 @@ void JsonApiPage::addTokenClicked(bool) whileBlocking(ui.tokensListView)->setModel(new QStringListModel(newTk)); } -void JsonApiPage::removeTokenClicked(bool) +void JsonApiPage::removeTokenClicked() { QString token(ui.tokenLineEdit->text()); rsJsonAPI->revokeAuthToken(token.toStdString()); diff --git a/retroshare-gui/src/gui/settings/JsonApiPage.h b/retroshare-gui/src/gui/settings/JsonApiPage.h index fff404087..646016662 100644 --- a/retroshare-gui/src/gui/settings/JsonApiPage.h +++ b/retroshare-gui/src/gui/settings/JsonApiPage.h @@ -33,7 +33,6 @@ public: ~JsonApiPage() {} /** Loads the settings for this page */ - virtual void load(); virtual QPixmap iconPixmap() const { return QPixmap(":/icons/svg/empty-circle.svg"); } @@ -49,12 +48,15 @@ public: static void checkShutdownJsonApi(); public slots: - void onApplyClicked(bool); - void addTokenClicked(bool); - void removeTokenClicked(bool); + void load() override; + + void onApplyClicked(); + void addTokenClicked(); + void removeTokenClicked(); void tokenClicked(const QModelIndex& index); void enableJsonApi(bool checked); bool updateParams(); + void checkToken(QString); private: Ui::JsonApiPage ui; /// Qt Designer generated object diff --git a/retroshare-gui/src/gui/settings/JsonApiPage.ui b/retroshare-gui/src/gui/settings/JsonApiPage.ui index d2a1ab16b..24b534712 100644 --- a/retroshare-gui/src/gui/settings/JsonApiPage.ui +++ b/retroshare-gui/src/gui/settings/JsonApiPage.ui @@ -87,7 +87,7 @@ - <html><head/><body><p>ApiUser:ApiPassword</p></body></html> + <html><head/><body><p>Tokens should spell as &quot;user:password&quot; where both user and password are alphanumeric strings.</p></body></html> diff --git a/retroshare-gui/src/gui/settings/WebuiPage.cpp b/retroshare-gui/src/gui/settings/WebuiPage.cpp index d1337a4a4..092a0973c 100644 --- a/retroshare-gui/src/gui/settings/WebuiPage.cpp +++ b/retroshare-gui/src/gui/settings/WebuiPage.cpp @@ -28,6 +28,7 @@ #include "util/misc.h" #include "retroshare/rswebui.h" +#include "retroshare/rsjsonapi.h" #include "rsharesettings.h" @@ -57,10 +58,6 @@ WebuiPage::~WebuiPage() } -void WebuiPage::onPasswordValueChanged(QString password) -{ - std::cerr << "Setting new password to \"" << password.toStdString() << "\"" << std::endl; -} void WebuiPage::selectWebInterfaceDirectory() { QString dirname = QFileDialog::getExistingDirectory(NULL,tr("Please select the directory were to find retroshare webinterface files"),ui.webInterfaceFiles_LE->text()); @@ -96,6 +93,25 @@ bool WebuiPage::updateParams(QString &errmsg) return ok; } +void WebuiPage::onPasswordValueChanged(QString password) +{ + QColor color; + + bool valid = password.length() >= 1; + + if(!valid) + color = QApplication::palette().color(QPalette::Disabled, QPalette::Base); + else + color = QApplication::palette().color(QPalette::Active, QPalette::Base); + + /* unpolish widget to clear the stylesheet's palette cache */ + //ui.searchLineFrame->style()->unpolish(ui.searchLineFrame); + + QPalette palette = ui.password_LE->palette(); + palette.setColor(ui.password_LE->backgroundRole(), color); + ui.password_LE->setPalette(palette); +} + bool WebuiPage::restart() { // apply config @@ -110,6 +126,14 @@ void WebuiPage::load() whileBlocking(ui.port_SB)->setValue(Settings->getWebinterfacePort()); whileBlocking(ui.webInterfaceFiles_LE)->setText(Settings->getWebinterfaceFilesDirectory()); whileBlocking(ui.allIp_CB)->setChecked(Settings->getWebinterfaceAllowAllIps()); + +#ifdef RS_JSONAPI + auto smap = rsJsonAPI->getAuthorizedTokens(); + auto it = smap.find("webui"); + + if(it != smap.end()) + whileBlocking(ui.password_LE)->setText(QString::fromStdString(it->second)); +#endif } @@ -180,11 +204,15 @@ void WebuiPage::onApplyClicked() { QString errmsg; + rsWebUI->setUserPassword(ui.password_LE->text().toStdString()); + if(!restart()) { QMessageBox::warning(0, tr("failed to start Webinterface"), "Failed to start the webinterface."); return; } + + emit passwordChanged(); } void WebuiPage::onStartWebBrowserClicked() diff --git a/retroshare-gui/src/gui/settings/WebuiPage.h b/retroshare-gui/src/gui/settings/WebuiPage.h index 8781a1829..ebbf0045c 100644 --- a/retroshare-gui/src/gui/settings/WebuiPage.h +++ b/retroshare-gui/src/gui/settings/WebuiPage.h @@ -66,6 +66,9 @@ public slots: void onApplyClicked(); void onStartWebBrowserClicked(); +signals: + void passwordChanged(); + private: /** Qt Designer generated object */ Ui::WebuiPage ui; diff --git a/retroshare-gui/src/gui/settings/rsettingswin.cpp b/retroshare-gui/src/gui/settings/rsettingswin.cpp index b5a3fd4f6..ac064397d 100644 --- a/retroshare-gui/src/gui/settings/rsettingswin.cpp +++ b/retroshare-gui/src/gui/settings/rsettingswin.cpp @@ -164,12 +164,15 @@ SettingsPage::initStackedWidget() addPage(new AppearancePage()); // APPEARENCE addPage(new SoundPage() ); // SOUND addPage(new ServicePermissionsPage() ); // PERMISSIONS -#ifdef RS_WEBUI - addPage(new WebuiPage() ); -#endif - #ifdef RS_JSONAPI + JsonApiPage *jsonapi_p = new JsonApiPage() ; addPage(new JsonApiPage()); +#ifdef RS_WEBUI + WebuiPage *webui_p = new WebuiPage() ; + addPage(new WebuiPage() ); + + QObject::connect(webui_p,SIGNAL(passwordChanged()),jsonapi_p,SLOT(load())); +#endif #endif // add widgets from plugins diff --git a/retroshare-gui/src/main.cpp b/retroshare-gui/src/main.cpp index 2ca3e1284..aa1d90dc1 100644 --- a/retroshare-gui/src/main.cpp +++ b/retroshare-gui/src/main.cpp @@ -572,14 +572,14 @@ feenableexcept(FE_INVALID | FE_DIVBYZERO); notify->enable() ; // enable notification system after GUI creation, to avoid data races in Qt. -#ifdef RS_WEBUI - WebuiPage::checkStartWebui(); // normally we should rather save the UI flags internally to p3webui -#endif - #ifdef RS_JSONAPI JsonApiPage::checkStartJsonApi(); #endif // RS_JSONAPI +#ifdef RS_WEBUI + WebuiPage::checkStartWebui(); // normally we should rather save the UI flags internally to p3webui +#endif + // This is done using a timer, because the passphrase request from notify is asynchrouneous and therefore clearing the // passphrase here makes it request for a passphrase when creating the default chat identity. @@ -589,14 +589,14 @@ feenableexcept(FE_INVALID | FE_DIVBYZERO); int ti = rshare.exec(); delete w ; -#ifdef RS_JSONAPI - JsonApiPage::checkShutdownJsonApi(); -#endif // RS_JSONAPI - #ifdef RS_WEBUI WebuiPage::checkShutdownWebui(); #endif +#ifdef RS_JSONAPI + JsonApiPage::checkShutdownJsonApi(); +#endif // RS_JSONAPI + /* cleanup */ ChatDialog::cleanupChat(); #ifdef RS_ENABLE_GXS From 0fdbcf6b57051d507640ba6f5c2b40c177b0c983 Mon Sep 17 00:00:00 2001 From: csoler Date: Sat, 16 Nov 2019 23:37:23 +0100 Subject: [PATCH 15/31] added dbg info --- libretroshare/src/rsserver/p3webui.cc | 2 ++ 1 file changed, 2 insertions(+) diff --git a/libretroshare/src/rsserver/p3webui.cc b/libretroshare/src/rsserver/p3webui.cc index 96279bd0d..f1a7fffce 100644 --- a/libretroshare/src/rsserver/p3webui.cc +++ b/libretroshare/src/rsserver/p3webui.cc @@ -143,6 +143,8 @@ int p3WebUI::status() const void p3WebUI::setUserPassword(const std::string& passwd) { #ifdef RS_JSONAPI + std::cerr << "Updating webui token with new passwd \"" << passwd << "\"" << std::endl; + if(!rsJsonAPI->authorizeUser("webui",passwd)) std::cerr << "(EE) Cannot register webui token. Some error occurred when calling authorizeUser()" << std::endl; #else From 2123ad76458375a90716d4f7f64dcef54378766e Mon Sep 17 00:00:00 2001 From: csoler Date: Sun, 17 Nov 2019 13:23:08 +0100 Subject: [PATCH 16/31] enable terminal login and webui passwd except on android --- retroshare.pri | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/retroshare.pri b/retroshare.pri index 8826f9e9a..ffcff0520 100644 --- a/retroshare.pri +++ b/retroshare.pri @@ -207,13 +207,13 @@ rs_no_webui:CONFIG -= rs_webui # To enable webui append the following assignation to qmake # command line "CONFIG+=rs_service_webui_terminal_password" -CONFIG *= no_rs_service_webui_terminal_password -rs_service_webui_terminal_password:CONFIG -= no_rs_service_webui_terminal_password +CONFIG *= rs_service_webui_terminal_password +no_rs_service_webui_terminal_password:CONFIG -= rs_service_webui_terminal_password # To enable retroshare-service terminal login append the following assignation # to qmake command line "CONFIG+=rs_service_terminal_login" -CONFIG *= no_rs_service_terminal_login -rs_service_terminal_login:CONFIG -= no_rs_service_terminal_login +CONFIG *= rs_service_terminal_login +no_rs_service_terminal_login:CONFIG -= rs_service_terminal_login # Specify host precompiled jsonapi-generator path, appending the following # assignation to qmake command line @@ -652,6 +652,10 @@ android-* { } CONFIG *= no_libresapihttpserver CONFIG -= libresapihttpserver + + CONFIG += no_rs_service_terminal_login + CONFIG += no_rs_service_webui_terminal_password + QT *= androidextras INCLUDEPATH *= $$NATIVE_LIBS_TOOLCHAIN_PATH/sysroot/usr/include QMAKE_LIBDIR *= "$$NATIVE_LIBS_TOOLCHAIN_PATH/sysroot/usr/lib/" From 997501a24d92288dd67d4bbe4542dd0655077c48 Mon Sep 17 00:00:00 2001 From: csoler Date: Sun, 17 Nov 2019 22:01:49 +0100 Subject: [PATCH 17/31] fixed retroshare_service with embedded webui --- libretroshare/src/jsonapi/jsonapi.cpp | 8 ++++ libretroshare/src/jsonapi/jsonapi.h | 2 + libretroshare/src/jsonapi/restbedservice.cc | 3 +- libretroshare/src/retroshare/rsjsonapi.h | 4 ++ libretroshare/src/rsserver/p3webui.cc | 6 ++- libretroshare/src/rsserver/rsinit.cc | 36 +++++++++-------- retroshare-gui/src/gui/settings/WebuiPage.cpp | 2 - retroshare-service/src/retroshare-service.cc | 40 ++++++++++++------- 8 files changed, 66 insertions(+), 35 deletions(-) diff --git a/libretroshare/src/jsonapi/jsonapi.cpp b/libretroshare/src/jsonapi/jsonapi.cpp index e8836448b..dae45308c 100644 --- a/libretroshare/src/jsonapi/jsonapi.cpp +++ b/libretroshare/src/jsonapi/jsonapi.cpp @@ -518,6 +518,14 @@ bool JsonApiServer::revokeAuthToken(const std::string& token) return false; } +void JsonApiServer::connectToConfigManager(p3ConfigMgr *cfgmgr) +{ + cfgmgr->addConfiguration("jsonapi.cfg",this); + + RsFileHash hash; + loadConfiguration(hash); +} + bool JsonApiServer::authorizeUser(const std::string& user,const std::string& passwd) { if(!is_alphanumeric(user) || !is_alphanumeric(passwd)) diff --git a/libretroshare/src/jsonapi/jsonapi.h b/libretroshare/src/jsonapi/jsonapi.h index 1dc9ec7b7..84d7d5e24 100644 --- a/libretroshare/src/jsonapi/jsonapi.h +++ b/libretroshare/src/jsonapi/jsonapi.h @@ -58,6 +58,8 @@ public: virtual void setBindingAddress(const std::string& address) override { RestbedService::setBindAddress(address); } virtual int status() const override; + virtual void connectToConfigManager(p3ConfigMgr *cfgmgr); + virtual bool authorizeUser(const std::string& alphanumeric_user,const std::string& alphanumeric_passwd) override; virtual std::map getAuthorizedTokens() override; bool revokeAuthToken(const std::string& user) override; diff --git a/libretroshare/src/jsonapi/restbedservice.cc b/libretroshare/src/jsonapi/restbedservice.cc index 05e1078d7..7e609a297 100644 --- a/libretroshare/src/jsonapi/restbedservice.cc +++ b/libretroshare/src/jsonapi/restbedservice.cc @@ -31,6 +31,7 @@ public: { _service = std::make_shared(); // this is a place holder, in case we request some internal values. _listening_port = 1984; + _binding_address = "127.0.0.1"; } void runloop() override @@ -58,7 +59,7 @@ public: try { - std::cerr << "(II) Starting restbed service on port " << std::dec << _listening_port << std::endl; + std::cerr << "(II) Starting restbed service on port " << std::dec << _listening_port << " and binding address \"" << _binding_address << "\"" << std::endl; _service->start( settings ); } catch(std::exception& e) diff --git a/libretroshare/src/retroshare/rsjsonapi.h b/libretroshare/src/retroshare/rsjsonapi.h index 0c741a4c9..9b82b63f2 100644 --- a/libretroshare/src/retroshare/rsjsonapi.h +++ b/libretroshare/src/retroshare/rsjsonapi.h @@ -22,6 +22,8 @@ #include +class p3ConfigMgr; + class RsJsonAPI { public: @@ -40,6 +42,8 @@ public: virtual void setBindingAddress(const std::string& address) =0; virtual void setListeningPort(uint16_t port) =0; + virtual void connectToConfigManager(p3ConfigMgr *cfgmgr)=0; + /** * @brief Get status of the json api server * @jsonapi{development} diff --git a/libretroshare/src/rsserver/p3webui.cc b/libretroshare/src/rsserver/p3webui.cc index f1a7fffce..688bcdd7b 100644 --- a/libretroshare/src/rsserver/p3webui.cc +++ b/libretroshare/src/rsserver/p3webui.cc @@ -48,11 +48,13 @@ static constexpr char *mime_types[3] = { }; #ifdef WINDOWS_SYS -static std::string _base_directory = "data/webui"; +const std::string RsWebUI::DEFAULT_BASE_DIRECTORY = "data/webui"; #else -static std::string _base_directory = "/usr/share/retroshare/webui/"; +const std::string RsWebUI::DEFAULT_BASE_DIRECTORY = "/usr/share/retroshare/webui/"; #endif +static std::string _base_directory = RsWebUI::DEFAULT_BASE_DIRECTORY; + template class handler { diff --git a/libretroshare/src/rsserver/rsinit.cc b/libretroshare/src/rsserver/rsinit.cc index 9efe1bc6b..13f15d3c2 100644 --- a/libretroshare/src/rsserver/rsinit.cc +++ b/libretroshare/src/rsserver/rsinit.cc @@ -61,6 +61,7 @@ #include "gxstunnel/p3gxstunnel.h" #include "retroshare/rsgxsdistsync.h" #include "file_sharing/p3filelists.h" +#include "jsonapi/jsonapi.h" #define ENABLE_GROUTER @@ -391,6 +392,22 @@ int RsInit::InitRetroShare(const RsConfigOptions& conf) if(!RsAccounts::init(rsInitConfig->optBaseDir,error_code)) return error_code ; +#ifdef RS_JSONAPI + // We create the JsonApiServer this early, because it is needed *before* login + + RsInfo() << "Allocating jsonAPI server (not launched yet) " << std::endl; + JsonApiServer *jas = new JsonApiServer(); + jas->setListeningPort(conf.jsonApiPort); + jas->setBindingAddress(conf.jsonApiBindAddress); + + if(conf.jsonApiPort != NULL) + { + RsInfo() << "Launching jsonAPI server on port " << conf.jsonApiPort << std::endl; + jas->restart(); + } + + rsJsonAPI = jas; +#endif #ifdef RS_AUTOLOGIN /* check that we have selected someone */ @@ -408,16 +425,6 @@ int RsInit::InitRetroShare(const RsConfigOptions& conf) } #endif -#ifdef RS_JSONAPI - if(rsInitConfig->jsonApiPort) - { - rsJsonAPI->setListeningPort(rsInitConfig->jsonApiPort); - rsJsonAPI->setBindingAddress(rsInitConfig->jsonApiBindAddress); - rsJsonAPI->restart(); - } - -#endif // ifdef RS_JSONAPI - return RS_INIT_OK; } @@ -1217,13 +1224,10 @@ int RsServer::StartupRetroShare() mPluginsManager->loadPlugins(programatically_inserted_plugins) ; #ifdef RS_JSONAPI - mJsonAPIServer = new JsonApiServer; - rsJsonAPI = mJsonAPIServer; + // add jsonapi server to config manager so that it can save/load its tokens - mConfigMgr->addConfiguration("jsonapi.cfg",mJsonAPIServer); - - RsFileHash dummyHash; - mJsonAPIServer->loadConfiguration(dummyHash); + if(rsJsonAPI) + rsJsonAPI->connectToConfigManager(mConfigMgr); #endif /**** Reputation system ****/ diff --git a/retroshare-gui/src/gui/settings/WebuiPage.cpp b/retroshare-gui/src/gui/settings/WebuiPage.cpp index 092a0973c..2a0f0125c 100644 --- a/retroshare-gui/src/gui/settings/WebuiPage.cpp +++ b/retroshare-gui/src/gui/settings/WebuiPage.cpp @@ -202,8 +202,6 @@ void WebuiPage::onAllIPCBClicked(bool /*checked*/) } void WebuiPage::onApplyClicked() { - QString errmsg; - rsWebUI->setUserPassword(ui.password_LE->text().toStdString()); if(!restart()) diff --git a/retroshare-service/src/retroshare-service.cc b/retroshare-service/src/retroshare-service.cc index 601878a40..79382e827 100644 --- a/retroshare-service/src/retroshare-service.cc +++ b/retroshare-service/src/retroshare-service.cc @@ -22,7 +22,11 @@ #include "retroshare/rsinit.h" #ifdef RS_JSONAPI -#include "jsonapi/jsonapi.h" +#include "retroshare/rsjsonapi.h" +#endif + +#ifdef RS_WEBUI +#include "retroshare/rswebui.h" #endif static CrashStackTrace gCrashStackTrace; @@ -120,8 +124,10 @@ int main(int argc, char* argv[]) std::string prefUserString; RsConfigOptions conf; + std::string webui_base_directory = RsWebUI::DEFAULT_BASE_DIRECTORY; + #ifdef RS_JSONAPI - conf.jsonApiPort = JsonApiServer::DEFAULT_PORT; // enable JSonAPI by default + conf.jsonApiPort = RsJsonAPI::DEFAULT_PORT; // enable JSonAPI by default #endif argstream as(argc,argv); @@ -148,7 +154,7 @@ int main(int argc, char* argv[]) "[node Id] Selected account to use and asks for passphrase" ". Use \"-U list\" in order to list available accounts.", false ); -#endif // RS_SERVICE_TERMINAL_LOGIN +#endif #ifdef RS_JSONAPI as >> parameter( 'J', "jsonApiPort", conf.jsonApiPort, "TCP Port", @@ -156,12 +162,12 @@ int main(int argc, char* argv[]) >> parameter( 'P', "jsonApiBindAddress", conf.jsonApiBindAddress, "TCP bind address", "JSON API Bind Address default " "127.0.0.1.", false ); -#endif // def RS_JSONAPI +#endif #if (defined(RS_JSONAPI) || defined(RS_WEBUI)) && defined(RS_SERVICE_TERMINAL_WEBUI_PASSWORD) bool askWebUiPassword = false; - as >> option( 'W', "webui-password", askWebUiPassword, - "Ask WebUI password on the console." ); + as >> parameter( 'B', "webui-directory", webui_base_directory, "Place where to find the html/js files for the webui.",false ); + as >> option( 'W', "webui-password", askWebUiPassword, "Ask WebUI password on the console." ); #endif /* defined(RS_JSONAPI) && defined(RS_WEBUI) \ && defined(RS_SERVICE_TERMINAL_WEBUI_PASSWORD) */ @@ -169,12 +175,12 @@ int main(int argc, char* argv[]) #ifdef LOCALNET_TESTING as >> parameter( 'R', "restrict-port" , portRestrictions, "port1-port2", "Apply port restriction", false); -#endif // ifdef LOCALNET_TESTING +#endif #ifdef RS_AUTOLOGIN as >> option( 'a', "auto-login", conf.autoLogin, "enable auto-login." ); -#endif // ifdef RS_AUTOLOGIN +#endif as >> help( 'h', "help", "Display this Help" ); as.defaultErrorHandling(true, true); @@ -212,6 +218,7 @@ int main(int argc, char* argv[]) conf.main_executable_path = argv[0]; int initResult = RsInit::InitRetroShare(conf); + if(initResult != RS_INIT_OK) { RsErr() << "Retroshare core initalization failed with: " << initResult @@ -274,8 +281,7 @@ int main(int argc, char* argv[]) rsNotify->registerNotifyClient(notify); // supply empty passwd so that it is properly asked 3 times on console - RsInit::LoadCertificateStatus result = - rsLoginHelper->attemptLogin(ssl_id, ""); + RsInit::LoadCertificateStatus result = rsLoginHelper->attemptLogin(ssl_id, ""); switch(result) { @@ -297,14 +303,20 @@ int main(int argc, char* argv[]) << std::endl; return -result; } + + /* Start-up libretroshare server threads */ + RsControl::instance()->StartupRetroShare(); } #endif // def RS_SERVICE_TERMINAL_LOGIN #if (defined(RS_JSONAPI) || defined(RS_WEBUI)) && defined(RS_SERVICE_TERMINAL_WEBUI_PASSWORD) - if(jsonApiServer && !webui_pass1.empty()) - jsonApiServer->authorizeToken("webui:"+webui_pass1); -#endif /* defined(RS_JSONAPI) && defined(RS_WEBUI) \ - && defined(RS_SERVICE_TERMINAL_WEBUI_PASSWORD) */ + if(rsJsonAPI && !webui_pass1.empty()) + { + rsWebUI->setHtmlFilesDirectory(webui_base_directory); + rsWebUI->setUserPassword(webui_pass1); + rsWebUI->restart(); + } +#endif #ifdef __ANDROID__ rsControl->setShutdownCallback(QCoreApplication::exit); From 009ed54ce29f6d96c538b9a9eddd6fc39a218237 Mon Sep 17 00:00:00 2001 From: csoler Date: Sat, 23 Nov 2019 00:17:17 +0100 Subject: [PATCH 18/31] changed layout of restbed/json/webui so that JsonApi is the only server (with thread functionality in a separate class) and webui is a resource provider --- libretroshare/src/jsonapi/jsonapi.cpp | 53 +++---- libretroshare/src/jsonapi/jsonapi.h | 38 +++-- libretroshare/src/jsonapi/restbedservice.cc | 162 ++++++-------------- libretroshare/src/jsonapi/restbedservice.h | 24 ++- libretroshare/src/retroshare/rsjsonapi.h | 5 + libretroshare/src/rsserver/p3webui.cc | 21 ++- libretroshare/src/rsserver/p3webui.h | 19 ++- libretroshare/src/rsserver/rsinit.cc | 4 +- 8 files changed, 156 insertions(+), 170 deletions(-) diff --git a/libretroshare/src/jsonapi/jsonapi.cpp b/libretroshare/src/jsonapi/jsonapi.cpp index dae45308c..22cc50148 100644 --- a/libretroshare/src/jsonapi/jsonapi.cpp +++ b/libretroshare/src/jsonapi/jsonapi.cpp @@ -376,33 +376,6 @@ JsonApiServer::JsonApiServer(): configMutex("JsonApiServer config") #include "jsonapi-wrappers.inl" } -void JsonApiServer::run() -{ - std::shared_ptr settings(new rb::Settings); - settings->set_port(mPort); - settings->set_bind_address(mBindAddress); - settings->set_default_header("Cache-Control", "no-cache"); - - { - sockaddr_storage tmp; - sockaddr_storage_inet_pton(tmp, mBindAddress); - sockaddr_storage_setport(tmp, mPort); - sockaddr_storage_ipv6_to_ipv4(tmp); - RsUrl tmpUrl(sockaddr_storage_tostring(tmp)); - tmpUrl.setScheme("http"); - - std::cerr << "JSON API listening on " << tmpUrl.toString() - << std::endl; - } - - mService.start(settings); -} - -std::vector > JsonApiServer::getResources() const -{ - return _resources; -} - void JsonApiServer::registerHandler( const std::string& path, const std::function)>& handler, @@ -630,8 +603,32 @@ void JsonApiServer::handleCorsOptions( int JsonApiServer::status() const { - if(isRunning()) + if(RestbedService::isRunning() && RestbedService::isClient(this)) return JSONAPI_STATUS_RUNNING; else return JSONAPI_STATUS_NOT_RUNNING; } + +void JsonApiServer::registerResourceProvider(const JsonApiResourceProvider *rp) +{ + _resource_providers.insert(rp); +} +void JsonApiServer::unregisterResourceProvider(const JsonApiResourceProvider *rp) +{ + _resource_providers.erase(rp); +} +bool JsonApiServer::hasResourceProvider(const JsonApiResourceProvider *rp) +{ + return _resource_providers.find(rp) != _resource_providers.end(); +} + +std::vector > JsonApiServer::getResources() const +{ + auto tab = _resources; + + for(auto& rp: _resource_providers) + for(auto r: rp->getResources()) + tab.push_back(r); + + return tab; +} diff --git a/libretroshare/src/jsonapi/jsonapi.h b/libretroshare/src/jsonapi/jsonapi.h index 84d7d5e24..f505bc009 100644 --- a/libretroshare/src/jsonapi/jsonapi.h +++ b/libretroshare/src/jsonapi/jsonapi.h @@ -24,6 +24,7 @@ #include #include #include +#include #include "util/rsthreads.h" #include "pqi/p3cfgmgr.h" @@ -35,6 +36,16 @@ namespace rb = restbed; +class JsonApiResourceProvider +{ +public: + JsonApiResourceProvider() {} + virtual ~JsonApiResourceProvider() = default; + + virtual std::string getName() const =0; + virtual std::vector > getResources() const =0; +}; + /** * Simple usage * \code{.cpp} @@ -50,13 +61,18 @@ public: JsonApiServer() ; virtual ~JsonApiServer() = default; - // public API + // implements RestbedService - virtual bool restart() override { return RestbedService::restart();} - virtual bool stop() override { return RestbedService::stop();} - virtual void setListeningPort(uint16_t port) override { RestbedService::setListeningPort(port) ;} - virtual void setBindingAddress(const std::string& address) override { RestbedService::setBindAddress(address); } - virtual int status() const override; + virtual std::vector > getResources() const override ; + + // RsJsonAPI public API + + bool restart() override { return RestbedService::restart(); } + bool stop() override { return RestbedService::stop();} + int status() const override; + + void setListeningPort(uint16_t port) override { return RestbedService::setListeningPort(port); } + void setBindingAddress(const std::string& bind_address) override { return RestbedService::setBindAddress(bind_address); } virtual void connectToConfigManager(p3ConfigMgr *cfgmgr); @@ -66,6 +82,10 @@ public: bool isAuthTokenValid(const std::string& token) override; bool requestNewTokenAutorization(const std::string& user) override; + void registerResourceProvider(const JsonApiResourceProvider *); + void unregisterResourceProvider(const JsonApiResourceProvider *); + bool hasResourceProvider(const JsonApiResourceProvider *); + // private API. These methods may be moved to RsJsonAPI so as to be visible in http mode, if needed. /** @@ -123,7 +143,6 @@ public: protected: /// @see RsSingleJobThread virtual void run(); - virtual std::vector > getResources() const; private: @@ -141,7 +160,6 @@ private: uint16_t mPort; std::string mBindAddress; - rb::Service mService; /// Called when new JSON API auth token is requested to be authorized /// The callback supplies the password to be used to make the token @@ -167,10 +185,10 @@ private: RsGenericSerializer::SerializeContext& ctx, const std::shared_ptr session ) { - return checkRsServicePtrReady( - serviceInstance.get(), serviceName, ctx, session ); + return checkRsServicePtrReady( serviceInstance.get(), serviceName, ctx, session ); } std::vector > _resources; + std::set _resource_providers; }; diff --git a/libretroshare/src/jsonapi/restbedservice.cc b/libretroshare/src/jsonapi/restbedservice.cc index 7e609a297..7d313d970 100644 --- a/libretroshare/src/jsonapi/restbedservice.cc +++ b/libretroshare/src/jsonapi/restbedservice.cc @@ -24,127 +24,63 @@ #include "util/rsdebug.h" #include "restbedservice.h" -class RestbedThread: public RsThread -{ -public: - RestbedThread() - { - _service = std::make_shared(); // this is a place holder, in case we request some internal values. - _listening_port = 1984; - _binding_address = "127.0.0.1"; - } - - void runloop() override - { - if(_resources.empty()) - { - RsErr() << "(EE) please call RestbedService::setResources() before launching the service!" << std::endl; - return; - } - auto settings = std::make_shared< restbed::Settings >( ); - settings->set_port( _listening_port ); - settings->set_bind_address( _binding_address ); - settings->set_default_header( "Connection", "close" ); - - if(_service->is_up()) - { - std::cerr << "(II) WebUI is already running. Killing it." << std::endl; - _service->stop(); - } - - _service = std::make_shared(); - - for(auto& r:_resources) - _service->publish( r ); - - try - { - std::cerr << "(II) Starting restbed service on port " << std::dec << _listening_port << " and binding address \"" << _binding_address << "\"" << std::endl; - _service->start( settings ); - } - catch(std::exception& e) - { - RsErr() << "Could not start web interface: " << e.what() << std::endl; - return; - } - - std::cerr << "(II) restbed service stopped." << std::endl; - } - void stop() - { - _service->stop(); - - RsThread::ask_for_stop(); - - while(isRunning()) - { - std::cerr << "(II) shutting down restbed service." << std::endl; - rstime::rs_usleep(1000*1000); - } - } - - void setListeningPort(uint16_t p) { _listening_port = p ; } - void setBindAddress(const std::string& bindAddress) { _binding_address = bindAddress ; } - void setResources(const std::vector >& r) { _resources = r ; } - uint16_t listeningPort() const { return _listening_port;} - -private: - std::shared_ptr _service; - std::vector > _resources; - - uint16_t _listening_port; - std::string _binding_address; -}; - RestbedService::RestbedService() { - _restbed_thread = new RestbedThread(); + mService = std::make_shared(); // this is a place holder, in case we request some internal values. + mListeningPort = 9092; + mBindingAddress = "127.0.0.1"; } -RestbedService::~RestbedService() + +void RestbedService::stop() { - while(_restbed_thread->isRunning()) - { - stop(); - std::cerr << "Deleting webUI object while webUI thread is still running. Trying shutdown...." << std::endl; + mService->stop(); + + RsThread::ask_for_stop(); + + while(isRunning()) + { + std::cerr << "(II) shutting down restbed service." << std::endl; rstime::rs_usleep(1000*1000); - } - delete _restbed_thread; + } } -bool RestbedService::restart() +void RestbedService::setListeningPort(uint16_t p) { mListeningPort = p ; } +void RestbedService::setBindAddress(const std::string& bindAddress) { mBindingAddress = bindAddress ; } +uint16_t RestbedService::listeningPort() const { return mListeningPort;} + +void RestbedService::runloop() override { - RsDbg() << "Restarting restbed service listening on port " << _restbed_thread->listeningPort() << std::endl; + if(_resources.empty()) + { + RsErr() << "(EE) please call RestbedService::setResources() before launching the service!" << std::endl; + return; + } + auto settings = std::make_shared< restbed::Settings >( ); + settings->set_port( mListeningPort ); + settings->set_bind_address( mBindingAddress ); + settings->set_default_header( "Connection", "close" ); - if(_restbed_thread->isRunning()) - _restbed_thread->stop(); + if(mService->is_up()) + { + std::cerr << "(II) WebUI is already running. Killing it." << std::endl; + mService->stop(); + } - _restbed_thread->setResources(getResources()); - _restbed_thread->start(); - return true; + mService = std::make_shared(); // re-allocating mService is important because it deletes the existing service and therefore leaves the listening port open + + for(auto& r:getResources()) + mService->publish(r); + + try + { + std::cerr << "(II) Starting restbed service on port " << std::dec << mListeningPort << " and binding address \"" << mBindingAddress << "\"" << std::endl; + mService->start( settings ); + } + catch(std::exception& e) + { + RsErr() << "Could not start web interface: " << e.what() << std::endl; + return; + } + + std::cerr << "(II) restbed service stopped." << std::endl; } - -bool RestbedService::stop() -{ - _restbed_thread->stop(); - return true; -} -bool RestbedService::isRunning() const -{ - return _restbed_thread->isRunning(); -} -void RestbedService::setListeningPort(uint16_t port) -{ - _restbed_thread->setListeningPort(port); - - if(_restbed_thread->isRunning()) - restart(); -} - -void RestbedService::setBindAddress(const std::string& bind_address) -{ - _restbed_thread->setBindAddress(bind_address); - - if(_restbed_thread->isRunning()) - restart(); -} - diff --git a/libretroshare/src/jsonapi/restbedservice.h b/libretroshare/src/jsonapi/restbedservice.h index 79efd9660..93b2c805b 100644 --- a/libretroshare/src/jsonapi/restbedservice.h +++ b/libretroshare/src/jsonapi/restbedservice.h @@ -23,26 +23,34 @@ #pragma once #include +#include "util/rsthreads.h" class RestbedThread; -class RestbedService +class RestbedService: public RsThread { public: RestbedService() ; virtual ~RestbedService(); - bool isRunning() const ; + bool restart(); + bool stop(); + bool isRunning(); - virtual bool restart(); - virtual bool stop(); + void setListeningPort(uint16_t port) ; + void setBindAddress(const std::string& bind_address); - virtual void setListeningPort(uint16_t port) ; - virtual void setBindAddress(const std::string& bind_address); + // should be overloaded by sub-class in order to provide resources to the restbed Service. - virtual std::vector > getResources()const =0; + virtual std::vector > getResources() const = 0; + +protected: + void runloop() override; private: - RestbedThread *_restbed_thread; + std::shared_ptr mService; // managed by RestbedService because it needs to be properly deleted when restarted. + + uint16_t mListeningPort; + std::string mBindingAddress; }; diff --git a/libretroshare/src/retroshare/rsjsonapi.h b/libretroshare/src/retroshare/rsjsonapi.h index 9b82b63f2..2ed67aeca 100644 --- a/libretroshare/src/retroshare/rsjsonapi.h +++ b/libretroshare/src/retroshare/rsjsonapi.h @@ -23,6 +23,7 @@ #include class p3ConfigMgr; +class JsonApiResourceProvider; class RsJsonAPI { @@ -44,6 +45,10 @@ public: virtual void connectToConfigManager(p3ConfigMgr *cfgmgr)=0; + virtual void registerResourceProvider(const JsonApiResourceProvider *)=0; + virtual void unregisterResourceProvider(const JsonApiResourceProvider *)=0; + virtual bool hasResourceProvider(const JsonApiResourceProvider *)=0; + /** * @brief Get status of the json api server * @jsonapi{development} diff --git a/libretroshare/src/rsserver/p3webui.cc b/libretroshare/src/rsserver/p3webui.cc index 688bcdd7b..68bdbf93d 100644 --- a/libretroshare/src/rsserver/p3webui.cc +++ b/libretroshare/src/rsserver/p3webui.cc @@ -136,7 +136,7 @@ void p3WebUI::setHtmlFilesDirectory(const std::string& html_dir) int p3WebUI::status() const { - if(isRunning()) + if(rsJsonAPI->status()==RsJsonAPI::JSONAPI_STATUS_RUNNING && rsJsonAPI->hasResourceProvider(this)) return WEBUI_STATUS_RUNNING; else return WEBUI_STATUS_NOT_RUNNING; @@ -153,3 +153,22 @@ void p3WebUI::setUserPassword(const std::string& passwd) std::cerr << "(EE) JsonAPI is not available in this buildof Retroshare! Cannot register a user password for the WebUI" << std::endl; #endif } + +bool p3WebUI::restart() +{ + rsJsonAPI->registerResourceProvider(this); + + return rsJsonAPI->restart(); +} + +bool p3WebUI::stop() +{ + rsJsonAPI->unregisterResourceProvider(this); + + if(rsJsonAPI->status()==RsJsonAPI::JSONAPI_STATUS_RUNNING) + return rsJsonAPI->restart(); + else + return true; +} + + diff --git a/libretroshare/src/rsserver/p3webui.h b/libretroshare/src/rsserver/p3webui.h index aaeb7bb7c..d6ccbe778 100644 --- a/libretroshare/src/rsserver/p3webui.h +++ b/libretroshare/src/rsserver/p3webui.h @@ -24,23 +24,26 @@ #include #include #include "retroshare/rswebui.h" -#include "jsonapi/restbedservice.h" +#include "jsonapi/jsonapi.h" -class p3WebUI: public RsWebUI, public RestbedService +class p3WebUI: public RsWebUI, public JsonApiResourceProvider { public: p3WebUI(){} virtual ~p3WebUI(){} - virtual void setHtmlFilesDirectory(const std::string& html_dir) override; + // implements RsWebUI - virtual bool restart() override { return RestbedService::restart();} - virtual bool stop() override { return RestbedService::stop();} - virtual void setListeningPort(uint16_t port) override { RestbedService::setListeningPort(port) ;} - virtual void setBindingAddress(const std::string& address) override { RestbedService::setBindAddress(address) ;} + virtual void setHtmlFilesDirectory(const std::string& html_dir) override; virtual void setUserPassword(const std::string& passwd) override; - virtual int status() const override; + virtual bool restart() override ; + virtual bool stop() override ; + virtual int status() const override; + + // implements JsonApiResourceProvider + + virtual std::string getName() const override { return "Web Interface" ;} virtual std::vector > getResources() const override; }; diff --git a/libretroshare/src/rsserver/rsinit.cc b/libretroshare/src/rsserver/rsinit.cc index 13f15d3c2..5d529c816 100644 --- a/libretroshare/src/rsserver/rsinit.cc +++ b/libretroshare/src/rsserver/rsinit.cc @@ -398,9 +398,9 @@ int RsInit::InitRetroShare(const RsConfigOptions& conf) RsInfo() << "Allocating jsonAPI server (not launched yet) " << std::endl; JsonApiServer *jas = new JsonApiServer(); jas->setListeningPort(conf.jsonApiPort); - jas->setBindingAddress(conf.jsonApiBindAddress); + jas->setBindAddress(conf.jsonApiBindAddress); - if(conf.jsonApiPort != NULL) + if(conf.jsonApiPort != 0) { RsInfo() << "Launching jsonAPI server on port " << conf.jsonApiPort << std::endl; jas->restart(); From b8b7d103e1c79e52192e4da2dc9db2d4411e6243 Mon Sep 17 00:00:00 2001 From: csoler Date: Sat, 23 Nov 2019 15:11:22 +0100 Subject: [PATCH 19/31] fixed compilation by modifying wrappers to account for the shared_ptr mService --- .../async-method-wrapper-template.cpp.tmpl | 2 +- jsonapi-generator/src/jsonapi-generator.cpp | 2 +- libretroshare/src/jsonapi/jsonapi.cpp | 6 +-- libretroshare/src/jsonapi/jsonapi.h | 5 ++- libretroshare/src/jsonapi/restbedservice.cc | 12 ++--- libretroshare/src/jsonapi/restbedservice.h | 5 ++- libretroshare/src/retroshare/rsjsonapi.h | 3 +- retroshare-gui/src/gui/settings/WebuiPage.cpp | 10 +---- retroshare-gui/src/gui/settings/WebuiPage.ui | 45 ++++++------------- 9 files changed, 33 insertions(+), 57 deletions(-) diff --git a/jsonapi-generator/src/async-method-wrapper-template.cpp.tmpl b/jsonapi-generator/src/async-method-wrapper-template.cpp.tmpl index 81b97265b..4345532e7 100644 --- a/jsonapi-generator/src/async-method-wrapper-template.cpp.tmpl +++ b/jsonapi-generator/src/async-method-wrapper-template.cpp.tmpl @@ -55,7 +55,7 @@ $%callbackParamsSerialization%$ sStream << "data: " << compactJSON << ctx.mJson << "\n\n"; const std::string message = sStream.str(); - mService.schedule( [weakSession, message]() + mService->schedule( [weakSession, message]() { auto session = weakSession.lock(); if(!session || session->is_closed()) return; diff --git a/jsonapi-generator/src/jsonapi-generator.cpp b/jsonapi-generator/src/jsonapi-generator.cpp index 0a6bf3231..4a80b88e2 100644 --- a/jsonapi-generator/src/jsonapi-generator.cpp +++ b/jsonapi-generator/src/jsonapi-generator.cpp @@ -326,7 +326,7 @@ int main(int argc, char *argv[]) QString sessionDelayedClose; if(hasMultiCallback) - sessionDelayedClose = "RsThread::async( [=](){ std::this_thread::sleep_for(std::chrono::seconds(maxWait+120)); mService.schedule( [=](){ auto session = weakSession.lock(); if(session && session->is_open()) session->close(); } ); } );"; + sessionDelayedClose = "RsThread::async( [=](){ std::this_thread::sleep_for(std::chrono::seconds(maxWait+120)); mService->schedule( [=](){ auto session = weakSession.lock(); if(session && session->is_open()) session->close(); } ); } );"; QString callbackParamsSerialization; diff --git a/libretroshare/src/jsonapi/jsonapi.cpp b/libretroshare/src/jsonapi/jsonapi.cpp index 22cc50148..e0e96838f 100644 --- a/libretroshare/src/jsonapi/jsonapi.cpp +++ b/libretroshare/src/jsonapi/jsonapi.cpp @@ -337,7 +337,7 @@ JsonApiServer::JsonApiServer(): configMutex("JsonApiServer config") std::function)> multiCallback = [this, weakSession, hId](std::shared_ptr event) { - mService.schedule( [weakSession, hId, event]() + mService->schedule( [weakSession, hId, event]() { auto session = weakSession.lock(); if(!session || session->is_closed()) @@ -601,9 +601,9 @@ void JsonApiServer::handleCorsOptions( const std::shared_ptr session ) { session->close(rb::NO_CONTENT, corsOptionsHeaders); } -int JsonApiServer::status() const +int JsonApiServer::status() { - if(RestbedService::isRunning() && RestbedService::isClient(this)) + if(RestbedService::isRunning()) return JSONAPI_STATUS_RUNNING; else return JSONAPI_STATUS_NOT_RUNNING; diff --git a/libretroshare/src/jsonapi/jsonapi.h b/libretroshare/src/jsonapi/jsonapi.h index f505bc009..71f7223dd 100644 --- a/libretroshare/src/jsonapi/jsonapi.h +++ b/libretroshare/src/jsonapi/jsonapi.h @@ -69,10 +69,11 @@ public: bool restart() override { return RestbedService::restart(); } bool stop() override { return RestbedService::stop();} - int status() const override; + int status() override; void setListeningPort(uint16_t port) override { return RestbedService::setListeningPort(port); } void setBindingAddress(const std::string& bind_address) override { return RestbedService::setBindAddress(bind_address); } + uint16_t listeningPort() const override { return RestbedService::listeningPort() ; } virtual void connectToConfigManager(p3ConfigMgr *cfgmgr); @@ -189,6 +190,6 @@ private: } std::vector > _resources; - std::set _resource_providers; + std::set _resource_providers; }; diff --git a/libretroshare/src/jsonapi/restbedservice.cc b/libretroshare/src/jsonapi/restbedservice.cc index 7d313d970..b12d6f4d2 100644 --- a/libretroshare/src/jsonapi/restbedservice.cc +++ b/libretroshare/src/jsonapi/restbedservice.cc @@ -31,7 +31,7 @@ RestbedService::RestbedService() mBindingAddress = "127.0.0.1"; } -void RestbedService::stop() +bool RestbedService::stop() { mService->stop(); @@ -42,19 +42,15 @@ void RestbedService::stop() std::cerr << "(II) shutting down restbed service." << std::endl; rstime::rs_usleep(1000*1000); } + return true; } +uint16_t RestbedService::listeningPort() const { return mListeningPort ; } void RestbedService::setListeningPort(uint16_t p) { mListeningPort = p ; } void RestbedService::setBindAddress(const std::string& bindAddress) { mBindingAddress = bindAddress ; } -uint16_t RestbedService::listeningPort() const { return mListeningPort;} -void RestbedService::runloop() override +void RestbedService::runloop() { - if(_resources.empty()) - { - RsErr() << "(EE) please call RestbedService::setResources() before launching the service!" << std::endl; - return; - } auto settings = std::make_shared< restbed::Settings >( ); settings->set_port( mListeningPort ); settings->set_bind_address( mBindingAddress ); diff --git a/libretroshare/src/jsonapi/restbedservice.h b/libretroshare/src/jsonapi/restbedservice.h index 93b2c805b..b633ce7e0 100644 --- a/libretroshare/src/jsonapi/restbedservice.h +++ b/libretroshare/src/jsonapi/restbedservice.h @@ -35,10 +35,11 @@ public: bool restart(); bool stop(); - bool isRunning(); + bool isRunning() const; void setListeningPort(uint16_t port) ; void setBindAddress(const std::string& bind_address); + uint16_t listeningPort() const ; // should be overloaded by sub-class in order to provide resources to the restbed Service. @@ -47,9 +48,9 @@ public: protected: void runloop() override; -private: std::shared_ptr mService; // managed by RestbedService because it needs to be properly deleted when restarted. +private: uint16_t mListeningPort; std::string mBindingAddress; }; diff --git a/libretroshare/src/retroshare/rsjsonapi.h b/libretroshare/src/retroshare/rsjsonapi.h index 2ed67aeca..448dddda5 100644 --- a/libretroshare/src/retroshare/rsjsonapi.h +++ b/libretroshare/src/retroshare/rsjsonapi.h @@ -42,6 +42,7 @@ public: virtual void setBindingAddress(const std::string& address) =0; virtual void setListeningPort(uint16_t port) =0; + virtual uint16_t listeningPort() const =0; virtual void connectToConfigManager(p3ConfigMgr *cfgmgr)=0; @@ -54,7 +55,7 @@ public: * @jsonapi{development} * @return the status picked in the enum JSONAPI_STATUS_UNKNOWN/RUNNING/NOT_RUNNING */ - virtual int status() const=0; + virtual int status() =0; //=============================================================================================// // API methods that are also accessible through http // diff --git a/retroshare-gui/src/gui/settings/WebuiPage.cpp b/retroshare-gui/src/gui/settings/WebuiPage.cpp index 2a0f0125c..e9e88a81c 100644 --- a/retroshare-gui/src/gui/settings/WebuiPage.cpp +++ b/retroshare-gui/src/gui/settings/WebuiPage.cpp @@ -45,7 +45,6 @@ WebuiPage::WebuiPage(QWidget */*parent*/, Qt::WindowFlags /*flags*/) { ui.setupUi(this); connect(ui.enableWebUI_CB, SIGNAL(clicked(bool)), this, SLOT(onEnableCBClicked(bool))); - connect(ui.port_SB, SIGNAL(valueChanged(int)), this, SLOT(onPortValueChanged(int))); connect(ui.allIp_CB, SIGNAL(clicked(bool)), this, SLOT(onAllIPCBClicked(bool))); connect(ui.apply_PB, SIGNAL(clicked()), this, SLOT(onApplyClicked())); connect(ui.password_LE, SIGNAL(textChanged(QString)), this, SLOT(onPasswordValueChanged(QString))); @@ -75,8 +74,6 @@ bool WebuiPage::updateParams(QString &errmsg) bool changed = false; if(ui.enableWebUI_CB->isChecked() != Settings->getWebinterfaceEnabled()) changed = true; - if(ui.port_SB->value() != Settings->getWebinterfacePort()) - changed = true; if(ui.allIp_CB->isChecked() != Settings->getWebinterfaceAllowAllIps()) changed = true; if(ui.webInterfaceFiles_LE->text() != Settings->getWebinterfaceFilesDirectory()) @@ -86,7 +83,6 @@ bool WebuiPage::updateParams(QString &errmsg) { // store config Settings->setWebinterfaceEnabled(ui.enableWebUI_CB->isChecked()); - Settings->setWebinterfacePort(ui.port_SB->value()); Settings->setWebinterfaceAllowAllIps(ui.allIp_CB->isChecked()); Settings->setWebinterfaceFilesDirectory(ui.webInterfaceFiles_LE->text()); } @@ -123,7 +119,6 @@ void WebuiPage::load() { std::cerr << "WebuiPage::load()" << std::endl; whileBlocking(ui.enableWebUI_CB)->setChecked(Settings->getWebinterfaceEnabled()); - whileBlocking(ui.port_SB)->setValue(Settings->getWebinterfacePort()); whileBlocking(ui.webInterfaceFiles_LE)->setText(Settings->getWebinterfaceFilesDirectory()); whileBlocking(ui.allIp_CB)->setChecked(Settings->getWebinterfaceAllowAllIps()); @@ -149,9 +144,7 @@ QString WebuiPage::helpText() const if(!Settings->getWebinterfaceEnabled()) return false; - rsWebUI->setListeningPort(Settings->getWebinterfacePort()); rsWebUI->setHtmlFilesDirectory(Settings->getWebinterfaceFilesDirectory().toStdString()); - rsWebUI->restart(); return true; @@ -215,5 +208,6 @@ void WebuiPage::onApplyClicked() void WebuiPage::onStartWebBrowserClicked() { - QDesktopServices::openUrl(QUrl(QString("http://localhost:")+QString::number(ui.port_SB->value()))); + QDesktopServices::openUrl(QUrl(QString("http://localhost:")+QString::number(rsJsonAPI->listeningPort()))); } + diff --git a/retroshare-gui/src/gui/settings/WebuiPage.ui b/retroshare-gui/src/gui/settings/WebuiPage.ui index 2b8b758a2..5ca37e9b6 100644 --- a/retroshare-gui/src/gui/settings/WebuiPage.ui +++ b/retroshare-gui/src/gui/settings/WebuiPage.ui @@ -33,33 +33,27 @@ - + - Listening port: + Password: - - - - 1024 - - - 65535 - - - 1984 - - - - + Web interface directory: - + + + + QLineEdit::Password + + + + @@ -84,24 +78,13 @@ - - - - Password: - - - - - - - QLineEdit::Password - - - + + false + Allow access from all IP addresses (Default: localhost only) From d1a9f839a4e4d7e989b2e2f1c51574a5fd3d54f7 Mon Sep 17 00:00:00 2001 From: csoler Date: Sat, 23 Nov 2019 18:40:31 +0100 Subject: [PATCH 20/31] fixed restart of webui --- libretroshare/src/jsonapi/jsonapi.h | 4 ---- libretroshare/src/jsonapi/restbedservice.cc | 8 ++++++++ libretroshare/src/jsonapi/restbedservice.h | 3 +-- libretroshare/src/rsserver/p3webui.cc | 9 ++++++--- retroshare-gui/src/gui/settings/WebuiPage.cpp | 4 +--- 5 files changed, 16 insertions(+), 12 deletions(-) diff --git a/libretroshare/src/jsonapi/jsonapi.h b/libretroshare/src/jsonapi/jsonapi.h index 71f7223dd..68e53cdcf 100644 --- a/libretroshare/src/jsonapi/jsonapi.h +++ b/libretroshare/src/jsonapi/jsonapi.h @@ -141,10 +141,6 @@ public: */ void setNewAccessRequestCallback(const std::function& callback ); -protected: - /// @see RsSingleJobThread - virtual void run(); - private: /// @see p3Config::setupSerialiser diff --git a/libretroshare/src/jsonapi/restbedservice.cc b/libretroshare/src/jsonapi/restbedservice.cc index b12d6f4d2..22dae7288 100644 --- a/libretroshare/src/jsonapi/restbedservice.cc +++ b/libretroshare/src/jsonapi/restbedservice.cc @@ -31,6 +31,14 @@ RestbedService::RestbedService() mBindingAddress = "127.0.0.1"; } +bool RestbedService::restart() +{ + stop(); + start("Restbed Service"); + + return true; +} + bool RestbedService::stop() { mService->stop(); diff --git a/libretroshare/src/jsonapi/restbedservice.h b/libretroshare/src/jsonapi/restbedservice.h index b633ce7e0..5dd357643 100644 --- a/libretroshare/src/jsonapi/restbedservice.h +++ b/libretroshare/src/jsonapi/restbedservice.h @@ -31,11 +31,10 @@ class RestbedService: public RsThread { public: RestbedService() ; - virtual ~RestbedService(); + virtual ~RestbedService() = default; bool restart(); bool stop(); - bool isRunning() const; void setListeningPort(uint16_t port) ; void setBindAddress(const std::string& bind_address); diff --git a/libretroshare/src/rsserver/p3webui.cc b/libretroshare/src/rsserver/p3webui.cc index 68bdbf93d..6038a79b3 100644 --- a/libretroshare/src/rsserver/p3webui.cc +++ b/libretroshare/src/rsserver/p3webui.cc @@ -63,9 +63,12 @@ template class handler { const auto request = session->get_request( ); const std::string filename = request->get_path_parameter( "filename" ); - const std::string directory = request->get_path_parameter( "dir" ); + std::string directory = request->get_path_parameter( "dir" ); - std::string resource_filename = _base_directory + directory + "/" + filename; + if(!directory.empty()) + directory += "/"; + + std::string resource_filename = _base_directory + "/" + directory + filename; std::cerr << "Reading file: \"" << resource_filename << "\"" << std::endl; std::ifstream stream( resource_filename, std::ifstream::in ); @@ -109,7 +112,7 @@ std::vector > p3WebUI::getResources() const auto resource2 = std::make_shared< restbed::Resource >(); resource2->set_paths( { - "/{dir: css]/{filename: fontawesome.css}", + "/{dir: css}/{filename: fontawesome.css}", "/{dir: css}/{filename: solid.css}", "/{filename: app.css}", } ); diff --git a/retroshare-gui/src/gui/settings/WebuiPage.cpp b/retroshare-gui/src/gui/settings/WebuiPage.cpp index e9e88a81c..96fedc6da 100644 --- a/retroshare-gui/src/gui/settings/WebuiPage.cpp +++ b/retroshare-gui/src/gui/settings/WebuiPage.cpp @@ -110,11 +110,9 @@ void WebuiPage::onPasswordValueChanged(QString password) bool WebuiPage::restart() { - // apply config - checkShutdownWebui(); - return checkStartWebui(); } + void WebuiPage::load() { std::cerr << "WebuiPage::load()" << std::endl; From 131d73cd1149453a37e34e3a2632a4b55f0cdad1 Mon Sep 17 00:00:00 2001 From: csoler Date: Sat, 23 Nov 2019 21:46:18 +0100 Subject: [PATCH 21/31] added resources for local fonts in webui --- libretroshare/src/rsserver/p3webui.cc | 32 ++++++++++++++++++++++++--- 1 file changed, 29 insertions(+), 3 deletions(-) diff --git a/libretroshare/src/rsserver/p3webui.cc b/libretroshare/src/rsserver/p3webui.cc index 6038a79b3..e01a1bc92 100644 --- a/libretroshare/src/rsserver/p3webui.cc +++ b/libretroshare/src/rsserver/p3webui.cc @@ -36,15 +36,21 @@ #define TEXT_HTML 0 #define TEXT_CSS 1 #define TEXT_SVG 2 +#define TEXT_TTF 3 +#define TEXT_WOFF 4 +#define APPLICATION_OCTET_STREAM 5 #define DEBUG_RS_WEBUI 1 RsWebUI *rsWebUI = new p3WebUI; -static constexpr char *mime_types[3] = { +static constexpr char *mime_types[6] = { "text/html", "text/css", - "image/svg+xml" + "image/svg+xml", + "font/ttf", + "font/woff", + "application/octet-stream", }; #ifdef WINDOWS_SYS @@ -120,10 +126,30 @@ std::vector > p3WebUI::getResources() const auto resource3 = std::make_shared< restbed::Resource >(); resource3->set_paths( { - "/{filename: retroshare.svg}", + "/{dir: data}/{filename: retroshare.svg}", + "/{dir: webfonts}/{filename: fa-solid-900.svg}", } ); resource3->set_method_handler( "GET", handler::get_handler ); + auto resource4 = std::make_shared< restbed::Resource >(); + resource4->set_paths( { + "/{dir: webfonts}/{filename: fa-solid-900.ttf}", + } ); + resource4->set_method_handler( "GET", handler::get_handler ); + + auto resource5 = std::make_shared< restbed::Resource >(); + resource5->set_paths( { + "/{dir: webfonts}/{filename: fa-solid-900.woff}", + "/{dir: webfonts}/{filename: fa-solid-900.woff2}", + } ); + resource5->set_method_handler( "GET", handler::get_handler ); + + auto resource6 = std::make_shared< restbed::Resource >(); + resource6->set_paths( { + "/{dir: webfonts}/{filename: fa-solid-900.eot}", + } ); + resource6->set_method_handler( "GET", handler::get_handler ); + rtab.push_back(resource1); rtab.push_back(resource2); rtab.push_back(resource3); From 52b0729b31de0ea1979c24d07047451ea2cec287 Mon Sep 17 00:00:00 2001 From: csoler Date: Sat, 23 Nov 2019 21:51:56 +0100 Subject: [PATCH 22/31] added missing pushback in resources --- libretroshare/src/rsserver/p3webui.cc | 3 +++ 1 file changed, 3 insertions(+) diff --git a/libretroshare/src/rsserver/p3webui.cc b/libretroshare/src/rsserver/p3webui.cc index e01a1bc92..c23a5553e 100644 --- a/libretroshare/src/rsserver/p3webui.cc +++ b/libretroshare/src/rsserver/p3webui.cc @@ -153,6 +153,9 @@ std::vector > p3WebUI::getResources() const rtab.push_back(resource1); rtab.push_back(resource2); rtab.push_back(resource3); + rtab.push_back(resource4); + rtab.push_back(resource5); + rtab.push_back(resource6); return rtab; } From c2d47b01df940216104ae23dbc6514d7ca184238 Mon Sep 17 00:00:00 2001 From: csoler Date: Sun, 24 Nov 2019 09:40:35 +0100 Subject: [PATCH 23/31] added extra check when restarting rb service --- libretroshare/src/jsonapi/restbedservice.cc | 3 +++ 1 file changed, 3 insertions(+) diff --git a/libretroshare/src/jsonapi/restbedservice.cc b/libretroshare/src/jsonapi/restbedservice.cc index 22dae7288..ce9b08164 100644 --- a/libretroshare/src/jsonapi/restbedservice.cc +++ b/libretroshare/src/jsonapi/restbedservice.cc @@ -41,6 +41,9 @@ bool RestbedService::restart() bool RestbedService::stop() { + if(!mService->is_up()) + return true; + mService->stop(); RsThread::ask_for_stop(); From c7af86b4c1feac86b0dfb99d9fb3ff8664fec908 Mon Sep 17 00:00:00 2001 From: csoler Date: Sun, 24 Nov 2019 10:50:58 +0100 Subject: [PATCH 24/31] using static resources for webui --- libretroshare/src/jsonapi/jsonapi.cpp | 4 +- libretroshare/src/rsserver/p3webui.cc | 98 +++++++++++++-------------- 2 files changed, 50 insertions(+), 52 deletions(-) diff --git a/libretroshare/src/jsonapi/jsonapi.cpp b/libretroshare/src/jsonapi/jsonapi.cpp index e0e96838f..c0a451e85 100644 --- a/libretroshare/src/jsonapi/jsonapi.cpp +++ b/libretroshare/src/jsonapi/jsonapi.cpp @@ -454,8 +454,8 @@ bool JsonApiServer::isAuthTokenValid(const std::string& token) auto it = mAuthTokenStorage.mAuthorizedTokens.find(user); - if(it == mAuthTokenStorage.mAuthorizedTokens.end()) - return false; + if(it == mAuthTokenStorage.mAuthorizedTokens.end()) + return false; // attempt avoiding +else CRYPTO_memcmp+ being optimized away int noOptimiz = 1; diff --git a/libretroshare/src/rsserver/p3webui.cc b/libretroshare/src/rsserver/p3webui.cc index c23a5553e..8781ea029 100644 --- a/libretroshare/src/rsserver/p3webui.cc +++ b/libretroshare/src/rsserver/p3webui.cc @@ -106,56 +106,59 @@ static void service_ready_handler( restbed::Service& ) std::vector > p3WebUI::getResources() const { - std::vector > rtab; + static std::vector > rtab; - auto resource1 = std::make_shared< restbed::Resource >( ); - resource1->set_paths( { - "/{filename: index.html}", - "/{filename: app.js}", - } - ); - resource1->set_method_handler( "GET", handler::get_handler ); + if(rtab.empty()) + { + auto resource1 = std::make_shared< restbed::Resource >( ); + resource1->set_paths( { + "/{filename: index.html}", + "/{filename: app.js}", + } + ); + resource1->set_method_handler( "GET", handler::get_handler ); - auto resource2 = std::make_shared< restbed::Resource >(); - resource2->set_paths( { - "/{dir: css}/{filename: fontawesome.css}", - "/{dir: css}/{filename: solid.css}", - "/{filename: app.css}", - } ); - resource2->set_method_handler( "GET", handler::get_handler ); + auto resource2 = std::make_shared< restbed::Resource >(); + resource2->set_paths( { + "/{dir: css}/{filename: fontawesome.css}", + "/{dir: css}/{filename: solid.css}", + "/{filename: app.css}", + } ); + resource2->set_method_handler( "GET", handler::get_handler ); - auto resource3 = std::make_shared< restbed::Resource >(); - resource3->set_paths( { - "/{dir: data}/{filename: retroshare.svg}", - "/{dir: webfonts}/{filename: fa-solid-900.svg}", - } ); - resource3->set_method_handler( "GET", handler::get_handler ); + auto resource3 = std::make_shared< restbed::Resource >(); + resource3->set_paths( { + "/{dir: data}/{filename: retroshare.svg}", + "/{dir: webfonts}/{filename: fa-solid-900.svg}", + } ); + resource3->set_method_handler( "GET", handler::get_handler ); - auto resource4 = std::make_shared< restbed::Resource >(); - resource4->set_paths( { - "/{dir: webfonts}/{filename: fa-solid-900.ttf}", - } ); - resource4->set_method_handler( "GET", handler::get_handler ); + auto resource4 = std::make_shared< restbed::Resource >(); + resource4->set_paths( { + "/{dir: webfonts}/{filename: fa-solid-900.ttf}", + } ); + resource4->set_method_handler( "GET", handler::get_handler ); - auto resource5 = std::make_shared< restbed::Resource >(); - resource5->set_paths( { - "/{dir: webfonts}/{filename: fa-solid-900.woff}", - "/{dir: webfonts}/{filename: fa-solid-900.woff2}", - } ); - resource5->set_method_handler( "GET", handler::get_handler ); + auto resource5 = std::make_shared< restbed::Resource >(); + resource5->set_paths( { + "/{dir: webfonts}/{filename: fa-solid-900.woff}", + "/{dir: webfonts}/{filename: fa-solid-900.woff2}", + } ); + resource5->set_method_handler( "GET", handler::get_handler ); - auto resource6 = std::make_shared< restbed::Resource >(); - resource6->set_paths( { - "/{dir: webfonts}/{filename: fa-solid-900.eot}", - } ); - resource6->set_method_handler( "GET", handler::get_handler ); + auto resource6 = std::make_shared< restbed::Resource >(); + resource6->set_paths( { + "/{dir: webfonts}/{filename: fa-solid-900.eot}", + } ); + resource6->set_method_handler( "GET", handler::get_handler ); - rtab.push_back(resource1); - rtab.push_back(resource2); - rtab.push_back(resource3); - rtab.push_back(resource4); - rtab.push_back(resource5); - rtab.push_back(resource6); + rtab.push_back(resource1); + rtab.push_back(resource2); + rtab.push_back(resource3); + rtab.push_back(resource4); + rtab.push_back(resource5); + rtab.push_back(resource6); + } return rtab; } @@ -189,18 +192,13 @@ void p3WebUI::setUserPassword(const std::string& passwd) bool p3WebUI::restart() { rsJsonAPI->registerResourceProvider(this); - - return rsJsonAPI->restart(); + return true; } bool p3WebUI::stop() { rsJsonAPI->unregisterResourceProvider(this); - - if(rsJsonAPI->status()==RsJsonAPI::JSONAPI_STATUS_RUNNING) - return rsJsonAPI->restart(); - else - return true; + return true; } From ef76b571c8415f08758b7d85a3daa02086eee732 Mon Sep 17 00:00:00 2001 From: csoler Date: Sun, 24 Nov 2019 11:04:26 +0100 Subject: [PATCH 25/31] added missing restart --- libretroshare/src/rsserver/p3webui.cc | 2 ++ 1 file changed, 2 insertions(+) diff --git a/libretroshare/src/rsserver/p3webui.cc b/libretroshare/src/rsserver/p3webui.cc index 8781ea029..457b4019d 100644 --- a/libretroshare/src/rsserver/p3webui.cc +++ b/libretroshare/src/rsserver/p3webui.cc @@ -192,12 +192,14 @@ void p3WebUI::setUserPassword(const std::string& passwd) bool p3WebUI::restart() { rsJsonAPI->registerResourceProvider(this); + rsJsonAPI->restart(); return true; } bool p3WebUI::stop() { rsJsonAPI->unregisterResourceProvider(this); + rsJsonAPI->restart(); return true; } From b842936ae7674e4d4495ba7d4e59dc072a880d9d Mon Sep 17 00:00:00 2001 From: csoler Date: Sun, 24 Nov 2019 15:47:41 +0100 Subject: [PATCH 26/31] removed webUI shutdown when quiting because it duplicates jsonapi shutdown. --- retroshare-gui/src/main.cpp | 4 ---- 1 file changed, 4 deletions(-) diff --git a/retroshare-gui/src/main.cpp b/retroshare-gui/src/main.cpp index aa1d90dc1..d0d68b2dc 100644 --- a/retroshare-gui/src/main.cpp +++ b/retroshare-gui/src/main.cpp @@ -589,10 +589,6 @@ feenableexcept(FE_INVALID | FE_DIVBYZERO); int ti = rshare.exec(); delete w ; -#ifdef RS_WEBUI - WebuiPage::checkShutdownWebui(); -#endif - #ifdef RS_JSONAPI JsonApiPage::checkShutdownJsonApi(); #endif // RS_JSONAPI From 5223ff751ab2cb87b9048d9b2ad925f91d60344b Mon Sep 17 00:00:00 2001 From: csoler Date: Sun, 24 Nov 2019 18:39:36 +0100 Subject: [PATCH 27/31] removed .gitignore --- .gitignore | 14 -------------- 1 file changed, 14 deletions(-) delete mode 100644 .gitignore diff --git a/.gitignore b/.gitignore deleted file mode 100644 index 9a8091201..000000000 --- a/.gitignore +++ /dev/null @@ -1,14 +0,0 @@ -*.o -*.sw? -*.so -*.so.* -moc_*.cpp -qrc_*.cpp -ui_*.h -Makefile* -*.sw? -*~ -Thumbs.db -*.pro.user -.kdev4 -*.kdev4 \ No newline at end of file From 7aa51423a41b25c2fff53c22e76242158f9e1690 Mon Sep 17 00:00:00 2001 From: csoler Date: Mon, 25 Nov 2019 22:16:32 +0100 Subject: [PATCH 28/31] fixes required by review of pr1700 --- libretroshare/src/jsonapi/jsonapi.cpp | 56 ++++------------- libretroshare/src/jsonapi/jsonapi.h | 8 +-- libretroshare/src/jsonapi/restbedservice.cc | 17 +++--- libretroshare/src/jsonapi/restbedservice.h | 10 +-- libretroshare/src/retroshare/rsjsonapi.h | 61 ++++++++++++------- libretroshare/src/rsserver/p3webui.cc | 16 ++--- libretroshare/src/rsserver/p3webui.h | 2 +- libretroshare/src/util/rsstring.cc | 13 ++++ libretroshare/src/util/rsstring.h | 10 ++- .../src/gui/settings/JsonApiPage.cc | 27 +------- retroshare-gui/src/gui/settings/WebuiPage.cpp | 6 +- .../src/gui/settings/rsharesettings.cpp | 20 ------ .../src/gui/settings/rsharesettings.h | 6 -- 13 files changed, 98 insertions(+), 154 deletions(-) diff --git a/libretroshare/src/jsonapi/jsonapi.cpp b/libretroshare/src/jsonapi/jsonapi.cpp index c0a451e85..e5de874b1 100644 --- a/libretroshare/src/jsonapi/jsonapi.cpp +++ b/libretroshare/src/jsonapi/jsonapi.cpp @@ -117,15 +117,6 @@ JsonApiServer::corsOptionsHeaders = return false; } -static bool is_alphanumeric(char c) { return (c>='0' && c<'9') || (c>='a' && c<='z') || (c>='A' && c<='Z') ;} -static bool is_alphanumeric(const std::string& s) -{ - for(uint32_t i=0;iclose(rb::UNAUTHORIZED); } ); - _resources.push_back(resource); + mResources.push_back(resource); } void JsonApiServer::setNewAccessRequestCallback( const std::function& callback ) @@ -501,8 +492,11 @@ void JsonApiServer::connectToConfigManager(p3ConfigMgr *cfgmgr) bool JsonApiServer::authorizeUser(const std::string& user,const std::string& passwd) { - if(!is_alphanumeric(user) || !is_alphanumeric(passwd)) + if(!librs::util::is_alphanumeric(user) || !librs::util::is_alphanumeric(passwd)) + { + RsErr() << "Password or username for jsonapi token is not alphanumeric." << std::endl; return false; + } RS_STACK_MUTEX(configMutex); @@ -516,26 +510,6 @@ bool JsonApiServer::authorizeUser(const std::string& user,const std::string& pas return true; } - -// bool JsonApiServer::authorizeToken(const std::string& token) -// { -// std::string user,password; -// -// if(!parseToken(token,user,password)) -// return false; -// -// RS_STACK_MUTEX(configMutex); -// -// std::string& p(mAuthTokenStorage.mAuthorizedTokens[user]); -// -// if(p != password) -// { -// p = password; -// IndicateConfigChanged(); -// } -// return true; -// } - /*static*/ std::string JsonApiServer::decodeToken(const std::string& radix64_token) { std::vector decodedVect(Radix64::decode(radix64_token)); @@ -601,32 +575,24 @@ void JsonApiServer::handleCorsOptions( const std::shared_ptr session ) { session->close(rb::NO_CONTENT, corsOptionsHeaders); } -int JsonApiServer::status() -{ - if(RestbedService::isRunning()) - return JSONAPI_STATUS_RUNNING; - else - return JSONAPI_STATUS_NOT_RUNNING; -} - void JsonApiServer::registerResourceProvider(const JsonApiResourceProvider *rp) { - _resource_providers.insert(rp); + mResourceProviders.insert(rp); } void JsonApiServer::unregisterResourceProvider(const JsonApiResourceProvider *rp) { - _resource_providers.erase(rp); + mResourceProviders.erase(rp); } bool JsonApiServer::hasResourceProvider(const JsonApiResourceProvider *rp) { - return _resource_providers.find(rp) != _resource_providers.end(); + return mResourceProviders.find(rp) != mResourceProviders.end(); } std::vector > JsonApiServer::getResources() const { - auto tab = _resources; + auto tab = mResources; - for(auto& rp: _resource_providers) + for(auto& rp: mResourceProviders) for(auto r: rp->getResources()) tab.push_back(r); diff --git a/libretroshare/src/jsonapi/jsonapi.h b/libretroshare/src/jsonapi/jsonapi.h index 68e53cdcf..c5eceb9ab 100644 --- a/libretroshare/src/jsonapi/jsonapi.h +++ b/libretroshare/src/jsonapi/jsonapi.h @@ -68,8 +68,8 @@ public: // RsJsonAPI public API bool restart() override { return RestbedService::restart(); } - bool stop() override { return RestbedService::stop();} - int status() override; + bool stop() override { return RestbedService::fullstop();} + bool isRunning() override { return RestbedService::isRunning(); } void setListeningPort(uint16_t port) override { return RestbedService::setListeningPort(port); } void setBindingAddress(const std::string& bind_address) override { return RestbedService::setBindAddress(bind_address); } @@ -185,7 +185,7 @@ private: return checkRsServicePtrReady( serviceInstance.get(), serviceName, ctx, session ); } - std::vector > _resources; - std::set _resource_providers; + std::vector > mResources; + std::set mResourceProviders; }; diff --git a/libretroshare/src/jsonapi/restbedservice.cc b/libretroshare/src/jsonapi/restbedservice.cc index ce9b08164..72365909f 100644 --- a/libretroshare/src/jsonapi/restbedservice.cc +++ b/libretroshare/src/jsonapi/restbedservice.cc @@ -6,7 +6,7 @@ * Copyright 2019-2019 Cyril Soler * * * * This program is free software: you can redistribute it and/or modify * - * it under the terms of the GNU Lesser General Public License as * + * 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. * * * @@ -15,31 +15,32 @@ * 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 * + * You should have received a copy of the GNU Affero General Public License * * along with this program. If not, see . * * * *******************************************************************************/ +#include "retroshare/rsjsonapi.h" #include "util/rsthreads.h" #include "util/rsdebug.h" #include "restbedservice.h" RestbedService::RestbedService() + : mService(std::make_shared()), // this is a place holder, in case we request some internal values. + mListeningPort(RsJsonAPI::DEFAULT_PORT), + mBindingAddress(RsJsonAPI::DEFAULT_BINDING_ADDRESS) { - mService = std::make_shared(); // this is a place holder, in case we request some internal values. - mListeningPort = 9092; - mBindingAddress = "127.0.0.1"; } bool RestbedService::restart() { - stop(); + fullstop(); start("Restbed Service"); return true; } -bool RestbedService::stop() +bool RestbedService::fullstop() { if(!mService->is_up()) return true; @@ -69,7 +70,7 @@ void RestbedService::runloop() if(mService->is_up()) { - std::cerr << "(II) WebUI is already running. Killing it." << std::endl; + RsWarn() << "(II) WebUI is already running. Killing it." << std::endl; mService->stop(); } diff --git a/libretroshare/src/jsonapi/restbedservice.h b/libretroshare/src/jsonapi/restbedservice.h index 5dd357643..6affb46a9 100644 --- a/libretroshare/src/jsonapi/restbedservice.h +++ b/libretroshare/src/jsonapi/restbedservice.h @@ -6,16 +6,16 @@ * Copyright 2019-2019 Cyril Soler * * * * This program is free software: you can redistribute it and/or modify * - * it under the terms of the GNU Lesser General Public License as * + * 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 Lesser General Public License for more details. * + * 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 Lesser General Public License * + * You should have received a copy of the GNU Affero General Public License * * along with this program. If not, see . * * * *******************************************************************************/ @@ -34,7 +34,7 @@ public: virtual ~RestbedService() = default; bool restart(); - bool stop(); + bool fullstop(); void setListeningPort(uint16_t port) ; void setBindAddress(const std::string& bind_address); diff --git a/libretroshare/src/retroshare/rsjsonapi.h b/libretroshare/src/retroshare/rsjsonapi.h index 448dddda5..4e690da94 100644 --- a/libretroshare/src/retroshare/rsjsonapi.h +++ b/libretroshare/src/retroshare/rsjsonapi.h @@ -5,7 +5,7 @@ * Copyright (C) 2019-2019 Cyril Soler * * * * This program is free software: you can redistribute it and/or modify * - * it under the terms of the GNU Lesser General Public License as * + * 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. * * * @@ -14,12 +14,13 @@ * 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 * + * You should have received a copy of the GNU Affero General Public License * * along with this program. If not, see . * * *******************************************************************************/ #pragma once +#include #include class p3ConfigMgr; @@ -28,34 +29,52 @@ class JsonApiResourceProvider; class RsJsonAPI { public: - enum { - JSONAPI_STATUS_UNKNOWN = 0x00, - JSONAPI_STATUS_RUNNING = 0x01, - JSONAPI_STATUS_NOT_RUNNING = 0x02 - }; - static const uint16_t DEFAULT_PORT = 9092 ; static const std::string DEFAULT_BINDING_ADDRESS ; // 127.0.0.1 virtual bool restart() =0; virtual bool stop() =0; - - virtual void setBindingAddress(const std::string& address) =0; - virtual void setListeningPort(uint16_t port) =0; - virtual uint16_t listeningPort() const =0; - - virtual void connectToConfigManager(p3ConfigMgr *cfgmgr)=0; - - virtual void registerResourceProvider(const JsonApiResourceProvider *)=0; - virtual void unregisterResourceProvider(const JsonApiResourceProvider *)=0; - virtual bool hasResourceProvider(const JsonApiResourceProvider *)=0; - /** * @brief Get status of the json api server * @jsonapi{development} - * @return the status picked in the enum JSONAPI_STATUS_UNKNOWN/RUNNING/NOT_RUNNING + * @return Returns true if the server is running */ - virtual int status() =0; + virtual bool isRunning() =0; + + /*! + * \brief setBindingAddress + * Sets the binding address of the jsonapi server. Will only take effect after the server is restarted + * \param address + * Address in IPv4 or IPv6 format. + */ + + virtual void setBindingAddress(const std::string& address) =0; + + /*! + * \brief setListeningPort + * Port to use when talking to the jsonAPI server. + * \param port + * Should be a non system-reserved 16 bits port number (1024 to 65535) + */ + virtual void setListeningPort(uint16_t port) =0; + virtual uint16_t listeningPort() const =0; + + /*! + * \brief connectToConfigManager + * Should be called after creating the JsonAPI object so that it publishes itself with the proper config file. + * Since JsonAPI is created *before* login, the config manager does not exist at this time. + * \param cfgmgr + */ + virtual void connectToConfigManager(p3ConfigMgr *cfgmgr)=0; + + /*! + * \brief registerResourceProvider + * This is used to add/remove new web services to JsonAPI. The client should take care of not using a path range already + * used by the jsonAPI server. + */ + virtual void registerResourceProvider(const JsonApiResourceProvider *)=0; + virtual void unregisterResourceProvider(const JsonApiResourceProvider *)=0; + virtual bool hasResourceProvider(const JsonApiResourceProvider *)=0; //=============================================================================================// // API methods that are also accessible through http // diff --git a/libretroshare/src/rsserver/p3webui.cc b/libretroshare/src/rsserver/p3webui.cc index 457b4019d..af47d9689 100644 --- a/libretroshare/src/rsserver/p3webui.cc +++ b/libretroshare/src/rsserver/p3webui.cc @@ -31,6 +31,7 @@ #include "util/rsthreads.h" #include "util/rsdebug.h" #include "retroshare/rswebui.h" +#include "rsserver/rsaccounts.h" #include "retroshare/rsjsonapi.h" #define TEXT_HTML 0 @@ -53,12 +54,7 @@ static constexpr char *mime_types[6] = { "application/octet-stream", }; -#ifdef WINDOWS_SYS -const std::string RsWebUI::DEFAULT_BASE_DIRECTORY = "data/webui"; -#else -const std::string RsWebUI::DEFAULT_BASE_DIRECTORY = "/usr/share/retroshare/webui/"; -#endif - +const std::string RsWebUI::DEFAULT_BASE_DIRECTORY = RsAccountsDetail::PathDataDirectory(false); //"/usr/share/retroshare/webui/"; static std::string _base_directory = RsWebUI::DEFAULT_BASE_DIRECTORY; @@ -75,14 +71,14 @@ template class handler directory += "/"; std::string resource_filename = _base_directory + "/" + directory + filename; - std::cerr << "Reading file: \"" << resource_filename << "\"" << std::endl; + RsDbg() << "Reading file: \"" << resource_filename << "\"" << std::endl; std::ifstream stream( resource_filename, std::ifstream::in ); if ( stream.is_open( ) ) { const std::string body = std::string( std::istreambuf_iterator< char >( stream ), std::istreambuf_iterator< char >( ) ); - std::cerr << " body length=" << body.length() << std::endl; + RsDbg() << " body length=" << body.length() << std::endl; const std::multimap< std::string, std::string > headers { { "Content-Type", mime_types[MIME_TYPE_INDEX] }, @@ -93,7 +89,7 @@ template class handler } else { - std::cerr << "Could not open file " << resource_filename << std::endl; + RsErr() << "Could not open file " << resource_filename << std::endl; session->close( restbed::NOT_FOUND ); } } @@ -171,7 +167,7 @@ void p3WebUI::setHtmlFilesDirectory(const std::string& html_dir) int p3WebUI::status() const { - if(rsJsonAPI->status()==RsJsonAPI::JSONAPI_STATUS_RUNNING && rsJsonAPI->hasResourceProvider(this)) + if(rsJsonAPI->isRunning() && rsJsonAPI->hasResourceProvider(this)) return WEBUI_STATUS_RUNNING; else return WEBUI_STATUS_NOT_RUNNING; diff --git a/libretroshare/src/rsserver/p3webui.h b/libretroshare/src/rsserver/p3webui.h index d6ccbe778..fe148700f 100644 --- a/libretroshare/src/rsserver/p3webui.h +++ b/libretroshare/src/rsserver/p3webui.h @@ -30,7 +30,7 @@ class p3WebUI: public RsWebUI, public JsonApiResourceProvider { public: p3WebUI(){} - virtual ~p3WebUI(){} + virtual ~p3WebUI() = default; // implements RsWebUI diff --git a/libretroshare/src/util/rsstring.cc b/libretroshare/src/util/rsstring.cc index db7000cec..c938ea82f 100644 --- a/libretroshare/src/util/rsstring.cc +++ b/libretroshare/src/util/rsstring.cc @@ -205,6 +205,19 @@ bool ConvertUtf16ToUtf8(const std::wstring& source, std::string& dest) return true; } +bool is_alphanumeric(char c) +{ + return (c>='0' && c<'9') || (c>='a' && c<='z') || (c>='A' && c<='Z') ; +} + +bool is_alphanumeric(const std::string& s) +{ + for(uint32_t i=0;i #include -namespace librs { namespace util { +namespace librs { + namespace util { -bool ConvertUtf8ToUtf16(const std::string& source, std::wstring& dest); -bool ConvertUtf16ToUtf8(const std::wstring& source, std::string& dest); + bool ConvertUtf8ToUtf16(const std::string& source, std::wstring& dest); + bool ConvertUtf16ToUtf8(const std::wstring& source, std::string& dest); + + bool is_alphanumeric(char c) ; + bool is_alphanumeric(const std::string& s); } } // librs::util diff --git a/retroshare-gui/src/gui/settings/JsonApiPage.cc b/retroshare-gui/src/gui/settings/JsonApiPage.cc index 8d35f2fb2..38b5ffe1f 100644 --- a/retroshare-gui/src/gui/settings/JsonApiPage.cc +++ b/retroshare-gui/src/gui/settings/JsonApiPage.cc @@ -122,35 +122,10 @@ bool JsonApiPage::checkStartJsonApi() /*static*/ void JsonApiPage::checkShutdownJsonApi() { - if(RsJsonAPI::JSONAPI_STATUS_RUNNING != rsJsonAPI->status()) + if(!rsJsonAPI->isRunning()) return; rsJsonAPI->stop(); // this is a blocking call until the thread is terminated. - -#ifdef SUSPENDED_CODE - /* It is important to make a copy of +jsonApiServer+ pointer so the old - * object can be deleted later, while the original pointer is - * reassigned */ - - QProgressDialog* pd = new QProgressDialog("Stopping JSON API Server", QString(), 0, 3000); - QTimer* prtm = new QTimer; - prtm->setInterval(16); // 60 FPS - connect( prtm, &QTimer::timeout, - pd, [=](){pd->setValue(pd->value()+16);} ); - pd->show(); - prtm->start(); - - /* Must wait for deletion because stopping of the server is async. - * It is important to capture a copy so it "survive" after - * safeStopJsonApiServer returns */ - QTimer::singleShot(3*1000, [=]() - { - prtm->stop(); - pd->close(); - prtm->deleteLater(); - pd->deleteLater(); - }); -#endif } void JsonApiPage::onApplyClicked() diff --git a/retroshare-gui/src/gui/settings/WebuiPage.cpp b/retroshare-gui/src/gui/settings/WebuiPage.cpp index 96fedc6da..c58e5214d 100644 --- a/retroshare-gui/src/gui/settings/WebuiPage.cpp +++ b/retroshare-gui/src/gui/settings/WebuiPage.cpp @@ -74,8 +74,6 @@ bool WebuiPage::updateParams(QString &errmsg) bool changed = false; if(ui.enableWebUI_CB->isChecked() != Settings->getWebinterfaceEnabled()) changed = true; - if(ui.allIp_CB->isChecked() != Settings->getWebinterfaceAllowAllIps()) - changed = true; if(ui.webInterfaceFiles_LE->text() != Settings->getWebinterfaceFilesDirectory()) changed = true; @@ -83,7 +81,6 @@ bool WebuiPage::updateParams(QString &errmsg) { // store config Settings->setWebinterfaceEnabled(ui.enableWebUI_CB->isChecked()); - Settings->setWebinterfaceAllowAllIps(ui.allIp_CB->isChecked()); Settings->setWebinterfaceFilesDirectory(ui.webInterfaceFiles_LE->text()); } return ok; @@ -118,7 +115,6 @@ void WebuiPage::load() std::cerr << "WebuiPage::load()" << std::endl; whileBlocking(ui.enableWebUI_CB)->setChecked(Settings->getWebinterfaceEnabled()); whileBlocking(ui.webInterfaceFiles_LE)->setText(Settings->getWebinterfaceFilesDirectory()); - whileBlocking(ui.allIp_CB)->setChecked(Settings->getWebinterfaceAllowAllIps()); #ifdef RS_JSONAPI auto smap = rsJsonAPI->getAuthorizedTokens(); @@ -157,7 +153,7 @@ QString WebuiPage::helpText() const { if(Settings->getWebinterfaceEnabled()) { - QDesktopServices::openUrl(QUrl(QString("http://localhost:")+QString::number(Settings->getWebinterfacePort()))); + QDesktopServices::openUrl(QUrl(QString("http://localhost:")+QString::number(rsJsonAPI->listeningPort()))); } else { diff --git a/retroshare-gui/src/gui/settings/rsharesettings.cpp b/retroshare-gui/src/gui/settings/rsharesettings.cpp index fbb8f6e3c..3f5ced4fc 100644 --- a/retroshare-gui/src/gui/settings/rsharesettings.cpp +++ b/retroshare-gui/src/gui/settings/rsharesettings.cpp @@ -1167,26 +1167,6 @@ void RshareSettings::setWebinterfaceFilesDirectory(const QString& s) } -uint16_t RshareSettings::getWebinterfacePort() -{ - return valueFromGroup("Webinterface", "port", 1984).toUInt(); -} - -void RshareSettings::setWebinterfacePort(uint16_t port) -{ - setValueToGroup("Webinterface", "port", port); -} - -bool RshareSettings::getWebinterfaceAllowAllIps() -{ - return valueFromGroup("Webinterface", "allowAllIps", false).toBool(); -} - -void RshareSettings::setWebinterfaceAllowAllIps(bool allow_all) -{ - setValueToGroup("Webinterface", "allowAllIps", allow_all); -} - bool RshareSettings::getPageAlreadyDisplayed(const QString& page_name) { return valueFromGroup("PageAlreadyDisplayed",page_name,false).toBool(); diff --git a/retroshare-gui/src/gui/settings/rsharesettings.h b/retroshare-gui/src/gui/settings/rsharesettings.h index df276db21..fe35209ab 100644 --- a/retroshare-gui/src/gui/settings/rsharesettings.h +++ b/retroshare-gui/src/gui/settings/rsharesettings.h @@ -331,15 +331,9 @@ public: bool getWebinterfaceEnabled(); void setWebinterfaceEnabled(bool enabled); - uint16_t getWebinterfacePort(); - void setWebinterfacePort(uint16_t port); - QString getWebinterfaceFilesDirectory(); void setWebinterfaceFilesDirectory(const QString& dirname); - bool getWebinterfaceAllowAllIps(); - void setWebinterfaceAllowAllIps(bool allow_all); - // proxy function that computes the best icon size among sizes passed as array, to match the recommended size on screen. int computeBestIconSize(int n_sizes, int *sizes, int recommended_size); From 3af234f4b003fa14c7108bc212273e9a536f2122 Mon Sep 17 00:00:00 2001 From: csoler Date: Tue, 26 Nov 2019 14:00:20 +0100 Subject: [PATCH 29/31] added missing file --- libretroshare/src/retroshare/rswebui.h | 44 ++++++++++++++++++++++++++ 1 file changed, 44 insertions(+) create mode 100644 libretroshare/src/retroshare/rswebui.h diff --git a/libretroshare/src/retroshare/rswebui.h b/libretroshare/src/retroshare/rswebui.h new file mode 100644 index 000000000..ce31e6f2c --- /dev/null +++ b/libretroshare/src/retroshare/rswebui.h @@ -0,0 +1,44 @@ +/******************************************************************************* + * libretroshare/src/rsserver: rswebui.h * + * * + * libretroshare: retroshare core library * + * * + * Copyright 2019-2019 Cyril Soler * + * * + * 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 . * + * * + *******************************************************************************/ + +#pragma once + +class RsWebUI +{ +public: + enum { + WEBUI_STATUS_UNKNOWN = 0x00, + WEBUI_STATUS_NOT_RUNNING = 0x01, + WEBUI_STATUS_RUNNING = 0x02 + }; + static const std::string DEFAULT_BASE_DIRECTORY ; + + virtual bool restart() =0; + virtual bool stop() =0; + + virtual void setHtmlFilesDirectory(const std::string& html_dir) =0; + virtual void setUserPassword(const std::string& passwd) =0; + + virtual int status() const=0; +}; + +extern RsWebUI *rsWebUI; From b1860d868203be34241190f94cbad3fa79f1e3d1 Mon Sep 17 00:00:00 2001 From: csoler Date: Tue, 26 Nov 2019 18:52:39 +0100 Subject: [PATCH 30/31] fixed two warnings --- libretroshare/src/rsserver/p3webui.cc | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/libretroshare/src/rsserver/p3webui.cc b/libretroshare/src/rsserver/p3webui.cc index af47d9689..392defb49 100644 --- a/libretroshare/src/rsserver/p3webui.cc +++ b/libretroshare/src/rsserver/p3webui.cc @@ -34,18 +34,20 @@ #include "rsserver/rsaccounts.h" #include "retroshare/rsjsonapi.h" -#define TEXT_HTML 0 -#define TEXT_CSS 1 -#define TEXT_SVG 2 -#define TEXT_TTF 3 -#define TEXT_WOFF 4 -#define APPLICATION_OCTET_STREAM 5 +enum { + TEXT_HTML = 0, + TEXT_CSS = 1, + TEXT_SVG = 2, + TEXT_TTF = 3, + TEXT_WOFF = 4, + APPLICATION_OCTET_STREAM = 5 +}; #define DEBUG_RS_WEBUI 1 RsWebUI *rsWebUI = new p3WebUI; -static constexpr char *mime_types[6] = { +static const std::string mime_types[6] = { "text/html", "text/css", "image/svg+xml", From 1d4ca64deecc33472462f9faada74b02abf6f112 Mon Sep 17 00:00:00 2001 From: Gioacchino Mazzurco Date: Wed, 27 Nov 2019 18:44:10 +0100 Subject: [PATCH 31/31] Prepare for merging --- .gitignore | 14 + LICENSE.txt | 339 --------- LICENSE.AGPL.txt => LICENSES/agpl-3.0.txt | 0 LICENSES/gpl-3.0.txt | 674 ++++++++++++++++++ LICENSES/lgpl-3.0.txt | 165 +++++ RetroShare.pro | 50 +- .../async-method-wrapper-template.cpp.tmpl | 13 +- jsonapi-generator/src/jsonapi-generator.cpp | 15 +- libretroshare/src/jsonapi/jsonapi.cpp | 264 ++++--- libretroshare/src/jsonapi/jsonapi.h | 160 +++-- libretroshare/src/jsonapi/restbedservice.cc | 94 --- libretroshare/src/libretroshare.pro | 5 +- libretroshare/src/retroshare/rsjsonapi.h | 163 +++-- libretroshare/src/retroshare/rsversion.h | 46 +- libretroshare/src/retroshare/rswebui.h | 66 +- libretroshare/src/rsserver/p3face-config.cc | 2 +- libretroshare/src/rsserver/p3face.h | 6 +- libretroshare/src/rsserver/p3webui.cc | 136 ++-- libretroshare/src/rsserver/p3webui.h | 16 +- libretroshare/src/rsserver/rsinit.cc | 26 +- .../rsversion.cxx} | 53 +- libretroshare/src/util/radix64.h | 9 +- .../src/gui/settings/JsonApiPage.cc | 42 +- retroshare-gui/src/gui/settings/WebuiPage.cpp | 20 +- retroshare-gui/src/retroshare-gui.pro | 11 +- retroshare-service/src/retroshare-service.cc | 9 +- retroshare.pri | 36 - 27 files changed, 1442 insertions(+), 992 deletions(-) create mode 100644 .gitignore delete mode 100644 LICENSE.txt rename LICENSE.AGPL.txt => LICENSES/agpl-3.0.txt (100%) create mode 100644 LICENSES/gpl-3.0.txt create mode 100644 LICENSES/lgpl-3.0.txt delete mode 100644 libretroshare/src/jsonapi/restbedservice.cc rename libretroshare/src/{jsonapi/restbedservice.h => services/rsversion.cxx} (52%) diff --git a/.gitignore b/.gitignore new file mode 100644 index 000000000..9a8091201 --- /dev/null +++ b/.gitignore @@ -0,0 +1,14 @@ +*.o +*.sw? +*.so +*.so.* +moc_*.cpp +qrc_*.cpp +ui_*.h +Makefile* +*.sw? +*~ +Thumbs.db +*.pro.user +.kdev4 +*.kdev4 \ No newline at end of file diff --git a/LICENSE.txt b/LICENSE.txt deleted file mode 100644 index 23cb79033..000000000 --- a/LICENSE.txt +++ /dev/null @@ -1,339 +0,0 @@ - GNU GENERAL PUBLIC LICENSE - Version 2, June 1991 - - Copyright (C) 1989, 1991 Free Software Foundation, Inc., - 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - - Preamble - - The licenses for most software are designed to take away your -freedom to share and change it. By contrast, the GNU General Public -License is intended to guarantee your freedom to share and change free -software--to make sure the software is free for all its users. This -General Public License applies to most of the Free Software -Foundation's software and to any other program whose authors commit to -using it. (Some other Free Software Foundation software is covered by -the GNU Lesser General Public License instead.) You can apply it to -your programs, too. - - When we speak of free software, we are referring to freedom, not -price. Our General Public Licenses are designed to make sure that you -have the freedom to distribute copies of free software (and charge for -this service if you wish), that you receive source code or can get it -if you want it, that you can change the software or use pieces of it -in new free programs; and that you know you can do these things. - - To protect your rights, we need to make restrictions that forbid -anyone to deny you these rights or to ask you to surrender the rights. -These restrictions translate to certain responsibilities for you if you -distribute copies of the software, or if you modify it. - - For example, if you distribute copies of such a program, whether -gratis or for a fee, you must give the recipients all the rights that -you have. You must make sure that they, too, receive or can get the -source code. And you must show them these terms so they know their -rights. - - We protect your rights with two steps: (1) copyright the software, and -(2) offer you this license which gives you legal permission to copy, -distribute and/or modify the software. - - Also, for each author's protection and ours, we want to make certain -that everyone understands that there is no warranty for this free -software. If the software is modified by someone else and passed on, we -want its recipients to know that what they have is not the original, so -that any problems introduced by others will not reflect on the original -authors' reputations. - - Finally, any free program is threatened constantly by software -patents. We wish to avoid the danger that redistributors of a free -program will individually obtain patent licenses, in effect making the -program proprietary. To prevent this, we have made it clear that any -patent must be licensed for everyone's free use or not licensed at all. - - The precise terms and conditions for copying, distribution and -modification follow. - - GNU GENERAL PUBLIC LICENSE - TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION - - 0. This License applies to any program or other work which contains -a notice placed by the copyright holder saying it may be distributed -under the terms of this General Public License. The "Program", below, -refers to any such program or work, and a "work based on the Program" -means either the Program or any derivative work under copyright law: -that is to say, a work containing the Program or a portion of it, -either verbatim or with modifications and/or translated into another -language. (Hereinafter, translation is included without limitation in -the term "modification".) Each licensee is addressed as "you". - -Activities other than copying, distribution and modification are not -covered by this License; they are outside its scope. The act of -running the Program is not restricted, and the output from the Program -is covered only if its contents constitute a work based on the -Program (independent of having been made by running the Program). -Whether that is true depends on what the Program does. - - 1. You may copy and distribute verbatim copies of the Program's -source code as you receive it, in any medium, provided that you -conspicuously and appropriately publish on each copy an appropriate -copyright notice and disclaimer of warranty; keep intact all the -notices that refer to this License and to the absence of any warranty; -and give any other recipients of the Program a copy of this License -along with the Program. - -You may charge a fee for the physical act of transferring a copy, and -you may at your option offer warranty protection in exchange for a fee. - - 2. You may modify your copy or copies of the Program or any portion -of it, thus forming a work based on the Program, and copy and -distribute such modifications or work under the terms of Section 1 -above, provided that you also meet all of these conditions: - - a) You must cause the modified files to carry prominent notices - stating that you changed the files and the date of any change. - - b) You must cause any work that you distribute or publish, that in - whole or in part contains or is derived from the Program or any - part thereof, to be licensed as a whole at no charge to all third - parties under the terms of this License. - - c) If the modified program normally reads commands interactively - when run, you must cause it, when started running for such - interactive use in the most ordinary way, to print or display an - announcement including an appropriate copyright notice and a - notice that there is no warranty (or else, saying that you provide - a warranty) and that users may redistribute the program under - these conditions, and telling the user how to view a copy of this - License. (Exception: if the Program itself is interactive but - does not normally print such an announcement, your work based on - the Program is not required to print an announcement.) - -These requirements apply to the modified work as a whole. If -identifiable sections of that work are not derived from the Program, -and can be reasonably considered independent and separate works in -themselves, then this License, and its terms, do not apply to those -sections when you distribute them as separate works. But when you -distribute the same sections as part of a whole which is a work based -on the Program, the distribution of the whole must be on the terms of -this License, whose permissions for other licensees extend to the -entire whole, and thus to each and every part regardless of who wrote it. - -Thus, it is not the intent of this section to claim rights or contest -your rights to work written entirely by you; rather, the intent is to -exercise the right to control the distribution of derivative or -collective works based on the Program. - -In addition, mere aggregation of another work not based on the Program -with the Program (or with a work based on the Program) on a volume of -a storage or distribution medium does not bring the other work under -the scope of this License. - - 3. You may copy and distribute the Program (or a work based on it, -under Section 2) in object code or executable form under the terms of -Sections 1 and 2 above provided that you also do one of the following: - - a) Accompany it with the complete corresponding machine-readable - source code, which must be distributed under the terms of Sections - 1 and 2 above on a medium customarily used for software interchange; or, - - b) Accompany it with a written offer, valid for at least three - years, to give any third party, for a charge no more than your - cost of physically performing source distribution, a complete - machine-readable copy of the corresponding source code, to be - distributed under the terms of Sections 1 and 2 above on a medium - customarily used for software interchange; or, - - c) Accompany it with the information you received as to the offer - to distribute corresponding source code. (This alternative is - allowed only for noncommercial distribution and only if you - received the program in object code or executable form with such - an offer, in accord with Subsection b above.) - -The source code for a work means the preferred form of the work for -making modifications to it. For an executable work, complete source -code means all the source code for all modules it contains, plus any -associated interface definition files, plus the scripts used to -control compilation and installation of the executable. However, as a -special exception, the source code distributed need not include -anything that is normally distributed (in either source or binary -form) with the major components (compiler, kernel, and so on) of the -operating system on which the executable runs, unless that component -itself accompanies the executable. - -If distribution of executable or object code is made by offering -access to copy from a designated place, then offering equivalent -access to copy the source code from the same place counts as -distribution of the source code, even though third parties are not -compelled to copy the source along with the object code. - - 4. You may not copy, modify, sublicense, or distribute the Program -except as expressly provided under this License. Any attempt -otherwise to copy, modify, sublicense or distribute the Program is -void, and will automatically terminate your rights under this License. -However, parties who have received copies, or rights, from you under -this License will not have their licenses terminated so long as such -parties remain in full compliance. - - 5. You are not required to accept this License, since you have not -signed it. However, nothing else grants you permission to modify or -distribute the Program or its derivative works. These actions are -prohibited by law if you do not accept this License. Therefore, by -modifying or distributing the Program (or any work based on the -Program), you indicate your acceptance of this License to do so, and -all its terms and conditions for copying, distributing or modifying -the Program or works based on it. - - 6. Each time you redistribute the Program (or any work based on the -Program), the recipient automatically receives a license from the -original licensor to copy, distribute or modify the Program subject to -these terms and conditions. You may not impose any further -restrictions on the recipients' exercise of the rights granted herein. -You are not responsible for enforcing compliance by third parties to -this License. - - 7. If, as a consequence of a court judgment or allegation of patent -infringement or for any other reason (not limited to patent issues), -conditions are imposed on you (whether by court order, agreement or -otherwise) that contradict the conditions of this License, they do not -excuse you from the conditions of this License. If you cannot -distribute so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you -may not distribute the Program at all. For example, if a patent -license would not permit royalty-free redistribution of the Program by -all those who receive copies directly or indirectly through you, then -the only way you could satisfy both it and this License would be to -refrain entirely from distribution of the Program. - -If any portion of this section is held invalid or unenforceable under -any particular circumstance, the balance of the section is intended to -apply and the section as a whole is intended to apply in other -circumstances. - -It is not the purpose of this section to induce you to infringe any -patents or other property right claims or to contest validity of any -such claims; this section has the sole purpose of protecting the -integrity of the free software distribution system, which is -implemented by public license practices. Many people have made -generous contributions to the wide range of software distributed -through that system in reliance on consistent application of that -system; it is up to the author/donor to decide if he or she is willing -to distribute software through any other system and a licensee cannot -impose that choice. - -This section is intended to make thoroughly clear what is believed to -be a consequence of the rest of this License. - - 8. If the distribution and/or use of the Program is restricted in -certain countries either by patents or by copyrighted interfaces, the -original copyright holder who places the Program under this License -may add an explicit geographical distribution limitation excluding -those countries, so that distribution is permitted only in or among -countries not thus excluded. In such case, this License incorporates -the limitation as if written in the body of this License. - - 9. The Free Software Foundation may publish revised and/or new versions -of the General Public License from time to time. Such new versions will -be similar in spirit to the present version, but may differ in detail to -address new problems or concerns. - -Each version is given a distinguishing version number. If the Program -specifies a version number of this License which applies to it and "any -later version", you have the option of following the terms and conditions -either of that version or of any later version published by the Free -Software Foundation. If the Program does not specify a version number of -this License, you may choose any version ever published by the Free Software -Foundation. - - 10. If you wish to incorporate parts of the Program into other free -programs whose distribution conditions are different, write to the author -to ask for permission. For software which is copyrighted by the Free -Software Foundation, write to the Free Software Foundation; we sometimes -make exceptions for this. Our decision will be guided by the two goals -of preserving the free status of all derivatives of our free software and -of promoting the sharing and reuse of software generally. - - NO WARRANTY - - 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY -FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN -OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES -PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED -OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF -MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS -TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE -PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, -REPAIR OR CORRECTION. - - 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING -WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR -REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, -INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING -OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED -TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY -YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER -PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE -POSSIBILITY OF SUCH DAMAGES. - - END OF TERMS AND CONDITIONS - - How to Apply These Terms to Your New Programs - - If you develop a new program, and you want it to be of the greatest -possible use to the public, the best way to achieve this is to make it -free software which everyone can redistribute and change under these terms. - - To do so, attach the following notices to the program. It is safest -to attach them to the start of each source file to most effectively -convey the exclusion of warranty; and each file should have at least -the "copyright" line and a pointer to where the full notice is found. - - {description} - Copyright (C) {year} {fullname} - - This program 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; either version 2 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 General Public License for more details. - - You should have received a copy of the GNU General Public License along - with this program; if not, write to the Free Software Foundation, Inc., - 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. - -Also add information on how to contact you by electronic and paper mail. - -If the program is interactive, make it output a short notice like this -when it starts in an interactive mode: - - Gnomovision version 69, Copyright (C) year name of author - Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. - This is free software, and you are welcome to redistribute it - under certain conditions; type `show c' for details. - -The hypothetical commands `show w' and `show c' should show the appropriate -parts of the General Public License. Of course, the commands you use may -be called something other than `show w' and `show c'; they could even be -mouse-clicks or menu items--whatever suits your program. - -You should also get your employer (if you work as a programmer) or your -school, if any, to sign a "copyright disclaimer" for the program, if -necessary. Here is a sample; alter the names: - - Yoyodyne, Inc., hereby disclaims all copyright interest in the program - `Gnomovision' (which makes passes at compilers) written by James Hacker. - - {signature of Ty Coon}, 1 April 1989 - Ty Coon, President of Vice - -This General Public License does not permit incorporating your program into -proprietary programs. If your program is a subroutine library, you may -consider it more useful to permit linking proprietary applications with the -library. If this is what you want to do, use the GNU Lesser General -Public License instead of this License. diff --git a/LICENSE.AGPL.txt b/LICENSES/agpl-3.0.txt similarity index 100% rename from LICENSE.AGPL.txt rename to LICENSES/agpl-3.0.txt diff --git a/LICENSES/gpl-3.0.txt b/LICENSES/gpl-3.0.txt new file mode 100644 index 000000000..f288702d2 --- /dev/null +++ b/LICENSES/gpl-3.0.txt @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program 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, 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 General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/LICENSES/lgpl-3.0.txt b/LICENSES/lgpl-3.0.txt new file mode 100644 index 000000000..0a041280b --- /dev/null +++ b/LICENSES/lgpl-3.0.txt @@ -0,0 +1,165 @@ + GNU LESSER GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + + This version of the GNU Lesser General Public License incorporates +the terms and conditions of version 3 of the GNU General Public +License, supplemented by the additional permissions listed below. + + 0. Additional Definitions. + + As used herein, "this License" refers to version 3 of the GNU Lesser +General Public License, and the "GNU GPL" refers to version 3 of the GNU +General Public License. + + "The Library" refers to a covered work governed by this License, +other than an Application or a Combined Work as defined below. + + An "Application" is any work that makes use of an interface provided +by the Library, but which is not otherwise based on the Library. +Defining a subclass of a class defined by the Library is deemed a mode +of using an interface provided by the Library. + + A "Combined Work" is a work produced by combining or linking an +Application with the Library. The particular version of the Library +with which the Combined Work was made is also called the "Linked +Version". + + The "Minimal Corresponding Source" for a Combined Work means the +Corresponding Source for the Combined Work, excluding any source code +for portions of the Combined Work that, considered in isolation, are +based on the Application, and not on the Linked Version. + + The "Corresponding Application Code" for a Combined Work means the +object code and/or source code for the Application, including any data +and utility programs needed for reproducing the Combined Work from the +Application, but excluding the System Libraries of the Combined Work. + + 1. Exception to Section 3 of the GNU GPL. + + You may convey a covered work under sections 3 and 4 of this License +without being bound by section 3 of the GNU GPL. + + 2. Conveying Modified Versions. + + If you modify a copy of the Library, and, in your modifications, a +facility refers to a function or data to be supplied by an Application +that uses the facility (other than as an argument passed when the +facility is invoked), then you may convey a copy of the modified +version: + + a) under this License, provided that you make a good faith effort to + ensure that, in the event an Application does not supply the + function or data, the facility still operates, and performs + whatever part of its purpose remains meaningful, or + + b) under the GNU GPL, with none of the additional permissions of + this License applicable to that copy. + + 3. Object Code Incorporating Material from Library Header Files. + + The object code form of an Application may incorporate material from +a header file that is part of the Library. You may convey such object +code under terms of your choice, provided that, if the incorporated +material is not limited to numerical parameters, data structure +layouts and accessors, or small macros, inline functions and templates +(ten or fewer lines in length), you do both of the following: + + a) Give prominent notice with each copy of the object code that the + Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the object code with a copy of the GNU GPL and this license + document. + + 4. Combined Works. + + You may convey a Combined Work under terms of your choice that, +taken together, effectively do not restrict modification of the +portions of the Library contained in the Combined Work and reverse +engineering for debugging such modifications, if you also do each of +the following: + + a) Give prominent notice with each copy of the Combined Work that + the Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the Combined Work with a copy of the GNU GPL and this license + document. + + c) For a Combined Work that displays copyright notices during + execution, include the copyright notice for the Library among + these notices, as well as a reference directing the user to the + copies of the GNU GPL and this license document. + + d) Do one of the following: + + 0) Convey the Minimal Corresponding Source under the terms of this + License, and the Corresponding Application Code in a form + suitable for, and under terms that permit, the user to + recombine or relink the Application with a modified version of + the Linked Version to produce a modified Combined Work, in the + manner specified by section 6 of the GNU GPL for conveying + Corresponding Source. + + 1) Use a suitable shared library mechanism for linking with the + Library. A suitable mechanism is one that (a) uses at run time + a copy of the Library already present on the user's computer + system, and (b) will operate properly with a modified version + of the Library that is interface-compatible with the Linked + Version. + + e) Provide Installation Information, but only if you would otherwise + be required to provide such information under section 6 of the + GNU GPL, and only to the extent that such information is + necessary to install and execute a modified version of the + Combined Work produced by recombining or relinking the + Application with a modified version of the Linked Version. (If + you use option 4d0, the Installation Information must accompany + the Minimal Corresponding Source and Corresponding Application + Code. If you use option 4d1, you must provide the Installation + Information in the manner specified by section 6 of the GNU GPL + for conveying Corresponding Source.) + + 5. Combined Libraries. + + You may place library facilities that are a work based on the +Library side by side in a single library together with other library +facilities that are not Applications and are not covered by this +License, and convey such a combined library under terms of your +choice, if you do both of the following: + + a) Accompany the combined library with a copy of the same work based + on the Library, uncombined with any other library facilities, + conveyed under the terms of this License. + + b) Give prominent notice with the combined library that part of it + is a work based on the Library, and explaining where to find the + accompanying uncombined form of the same work. + + 6. Revised Versions of the GNU Lesser General Public License. + + The Free Software Foundation may publish revised and/or new versions +of the GNU Lesser General Public License from time to time. Such new +versions will be similar in spirit to the present version, but may +differ in detail to address new problems or concerns. + + Each version is given a distinguishing version number. If the +Library as you received it specifies that a certain numbered version +of the GNU Lesser General Public License "or any later version" +applies to it, you have the option of following the terms and +conditions either of that published version or of any later version +published by the Free Software Foundation. If the Library as you +received it does not specify a version number of the GNU Lesser +General Public License, you may choose any version of the GNU Lesser +General Public License ever published by the Free Software Foundation. + + If the Library as you received it specifies that a proxy can decide +whether future versions of the GNU Lesser General Public License shall +apply, that proxy's public statement of acceptance of any version is +permanent authorization for you to choose that version for the +Library. diff --git a/RetroShare.pro b/RetroShare.pro index c04c62ed2..e04442e4d 100644 --- a/RetroShare.pro +++ b/RetroShare.pro @@ -36,59 +36,11 @@ libretroshare.depends += openpgpsdk libbitdht SUBDIRS += libretroshare libretroshare.file = libretroshare/src/libretroshare.pro -libresapi { - SUBDIRS += libresapi - libresapi.file = libresapi/src/libresapi.pro - libresapi.depends += libretroshare -} - retroshare_gui { SUBDIRS += retroshare_gui retroshare_gui.file = retroshare-gui/src/retroshare-gui.pro retroshare_gui.target = retroshare_gui - - libresapi { - retroshare_gui.depends = libresapi - } else { - retroshare_gui.depends = libretroshare - } -} - -retroshare_nogui { - SUBDIRS += retroshare_nogui - retroshare_nogui.file = retroshare-nogui/src/retroshare-nogui.pro - retroshare_nogui.target = retroshare_nogui - - libresapi { - retroshare_nogui.depends = libresapi - } else { - retroshare_nogui.depends = libretroshare - } -} - -retroshare_android_service { - SUBDIRS += retroshare_android_service - retroshare_android_service.file = retroshare-android-service/src/retroshare-android-service.pro - retroshare_android_service.depends = libresapi - retroshare_android_service.target = retroshare_android_service -} - -retroshare_android_notify_service { - SUBDIRS += retroshare_android_notify_service - retroshare_android_notify_service.file = retroshare-android-notify-service/src/retroshare-android-notify-service.pro - retroshare_android_notify_service.depends = retroshare_android_service - retroshare_android_notify_service.target = retroshare_android_notify_service -} - -retroshare_qml_app { - SUBDIRS += retroshare_qml_app - retroshare_qml_app.file = retroshare-qml-app/src/retroshare-qml-app.pro - retroshare_qml_app.depends = retroshare_android_service - retroshare_qml_app.target = retroshare_qml_app - - android-g++ { - retroshare_qml_app.depends += retroshare_android_notify_service - } + retroshare_gui.depends = libretroshare } retroshare_service { diff --git a/jsonapi-generator/src/async-method-wrapper-template.cpp.tmpl b/jsonapi-generator/src/async-method-wrapper-template.cpp.tmpl index 4345532e7..16bfe3304 100644 --- a/jsonapi-generator/src/async-method-wrapper-template.cpp.tmpl +++ b/jsonapi-generator/src/async-method-wrapper-template.cpp.tmpl @@ -4,9 +4,8 @@ * Copyright (C) 2018-2019 Gioacchino Mazzurco * * * * 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. * + * it under the terms of the GNU Affero General Public License version 3 as * + * published by the Free Software Foundation. * * * * This program is distributed in the hope that it will be useful, * * but WITHOUT ANY WARRANTY; without even the implied warranty of * @@ -43,19 +42,23 @@ $%paramsDeclaration%$ $%inputParamsDeserialization%$ + const std::weak_ptr weakService(mService); const std::weak_ptr weakSession(session); - $%callbackName%$ = [this, weakSession]($%callbackParams%$) + $%callbackName%$ = [this, weakService, weakSession]($%callbackParams%$) { auto session = weakSession.lock(); if(!session || session->is_closed()) return; + auto lService = weakService.lock(); + if(!lService || lService->is_down()) return; + $%callbackParamsSerialization%$ std::stringstream sStream; sStream << "data: " << compactJSON << ctx.mJson << "\n\n"; const std::string message = sStream.str(); - mService->schedule( [weakSession, message]() + lService->schedule( [weakSession, message]() { auto session = weakSession.lock(); if(!session || session->is_closed()) return; diff --git a/jsonapi-generator/src/jsonapi-generator.cpp b/jsonapi-generator/src/jsonapi-generator.cpp index 4a80b88e2..e56082ce6 100644 --- a/jsonapi-generator/src/jsonapi-generator.cpp +++ b/jsonapi-generator/src/jsonapi-generator.cpp @@ -326,7 +326,20 @@ int main(int argc, char *argv[]) QString sessionDelayedClose; if(hasMultiCallback) - sessionDelayedClose = "RsThread::async( [=](){ std::this_thread::sleep_for(std::chrono::seconds(maxWait+120)); mService->schedule( [=](){ auto session = weakSession.lock(); if(session && session->is_open()) session->close(); } ); } );"; + sessionDelayedClose = + "RsThread::async( [=]()" + "{" + "std::this_thread::sleep_for(" + "std::chrono::seconds(maxWait+120) );" + "auto lService = weakService.lock();" + "if(!lService || lService->is_down()) return;" + "lService->schedule( [=]()" + "{" + "auto session = weakSession.lock();" + "if(session && session->is_open())" + "session->close();" + "} );" + "} );"; QString callbackParamsSerialization; diff --git a/libretroshare/src/jsonapi/jsonapi.cpp b/libretroshare/src/jsonapi/jsonapi.cpp index e5de874b1..3884775da 100644 --- a/libretroshare/src/jsonapi/jsonapi.cpp +++ b/libretroshare/src/jsonapi/jsonapi.cpp @@ -4,14 +4,13 @@ * Copyright (C) 2018-2019 Gioacchino Mazzurco * * * * 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. * + * it under the terms of the GNU Affero General Public License version 3 as * + * published by the Free Software Foundation. * * * * 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. * + * 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 Affero General Public License * * along with this program. If not, see . * @@ -30,7 +29,6 @@ #include "util/rsjson.h" #include "retroshare/rsfiles.h" #include "util/radix64.h" -#include "retroshare/rsversion.h" #include "retroshare/rsinit.h" #include "util/rsnet.h" #include "retroshare/rsiface.h" @@ -42,16 +40,18 @@ // Generated at compile time #include "jsonapi-includes.inl" -/*extern*/ RsJsonAPI* rsJsonAPI = nullptr; +/*extern*/ RsJsonApi* rsJsonApi = nullptr; -const std::string RsJsonAPI::DEFAULT_BINDING_ADDRESS = "127.0.0.1"; +const std::string RsJsonApi::DEFAULT_BINDING_ADDRESS = "127.0.0.1"; /*static*/ const std::multimap JsonApiServer::corsHeaders = { { "Access-Control-Allow-Origin", "*" }, { "Access-Control-Allow-Methods", "GET, POST, OPTIONS"}, - { "Access-Control-Allow-Headers", "Authorization,DNT,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,Range" }, + { "Access-Control-Allow-Headers", "Authorization,DNT,User-Agent," + "X-Requested-With,If-Modified-Since," + "Cache-Control,Content-Type,Range" }, { "Access-Control-Expose-Headers", "Content-Length,Content-Range" } }; @@ -60,7 +60,9 @@ JsonApiServer::corsOptionsHeaders = { { "Access-Control-Allow-Origin", "*" }, { "Access-Control-Allow-Methods", "GET, POST, OPTIONS"}, - { "Access-Control-Allow-Headers", "Authorization,DNT,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,Range" }, + { "Access-Control-Allow-Headers", "Authorization,DNT,User-Agent," + "X-Requested-With,If-Modified-Since," + "Cache-Control,Content-Type,Range" }, { "Access-Control-Max-Age", "1728000" }, // 20 days { "Content-Type", "text/plain; charset=utf-8" }, { "Content-Length", "0" } @@ -100,7 +102,7 @@ JsonApiServer::corsOptionsHeaders = /*static*/ bool JsonApiServer::checkRsServicePtrReady( const void* serviceInstance, const std::string& serviceName, RsGenericSerializer::SerializeContext& ctx, - const std::shared_ptr session) + const std::shared_ptr session ) { if(serviceInstance) return true; @@ -117,37 +119,36 @@ JsonApiServer::corsOptionsHeaders = return false; } -bool RsJsonAPI::parseToken(const std::string& clear_token,std::string& user,std::string& passwd) +bool RsJsonApi::parseToken( + const std::string& clear_token, std::string& user,std::string& passwd ) { - uint32_t last_index=0; - uint32_t nb_colons=0; + uint32_t colonIndex = 0; + uint32_t colonCounter = 0; + const auto tkLen = clear_token.length(); - for(uint32_t i=0;i()), + mListeningPort(RsJsonApi::DEFAULT_PORT), + mBindingAddress(RsJsonApi::DEFAULT_BINDING_ADDRESS) { registerHandler("/rsLoginHelper/createLocation", [this](const std::shared_ptr session) { - size_t reqSize = session->get_request()->get_header("Content-Length", 0); - session->fetch( reqSize, [this]( + auto reqSize = session->get_request()->get_header("Content-Length", 0); + session->fetch( static_cast(reqSize), [this]( const std::shared_ptr session, const rb::Bytes& body ) { @@ -194,8 +195,8 @@ JsonApiServer::JsonApiServer(): configMutex("JsonApiServer config") registerHandler("/rsLoginHelper/attemptLogin", [this](const std::shared_ptr session) { - size_t reqSize = session->get_request()->get_header("Content-Length", 0); - session->fetch( reqSize, [this]( + auto reqSize = session->get_request()->get_header("Content-Length", 0); + session->fetch( static_cast(reqSize), [this]( const std::shared_ptr session, const rb::Bytes& body ) { @@ -234,8 +235,8 @@ JsonApiServer::JsonApiServer(): configMutex("JsonApiServer config") registerHandler("/rsControl/rsGlobalShutDown", [](const std::shared_ptr session) { - size_t reqSize = session->get_request()->get_header("Content-Length", 0); - session->fetch( reqSize, []( + auto reqSize = session->get_request()->get_header("Content-Length", 0); + session->fetch( static_cast(reqSize), []( const std::shared_ptr session, const rb::Bytes& body ) { @@ -248,8 +249,8 @@ JsonApiServer::JsonApiServer(): configMutex("JsonApiServer config") registerHandler("/rsFiles/getFileData", [](const std::shared_ptr session) { - size_t reqSize = session->get_request()->get_header("Content-Length", 0); - session->fetch( reqSize, []( + auto reqSize = session->get_request()->get_header("Content-Length", 0); + session->fetch( static_cast(reqSize), []( const std::shared_ptr session, const rb::Bytes& body ) { @@ -415,38 +416,31 @@ void JsonApiServer::registerHandler( else session->close(rb::UNAUTHORIZED); } ); - mResources.push_back(resource); + mResources.push_back(resource); } -void JsonApiServer::setNewAccessRequestCallback( const std::function& callback ) -{ - mNewAccessRequestCallback = callback; -} +void JsonApiServer::setNewAccessRequestCallback( + const std::function& callback ) +{ mNewAccessRequestCallback = callback; } -bool JsonApiServer::requestNewTokenAutorization(const std::string& user) +bool JsonApiServer::requestNewTokenAutorization( + const std::string& user, const std::string& passwd ) { - std::string passwd; - - if(rsLoginHelper->isLoggedIn() && mNewAccessRequestCallback(user,passwd)) - return authorizeUser(user,passwd); + if(rsLoginHelper->isLoggedIn() && mNewAccessRequestCallback(user, passwd)) + return authorizeUser(user, passwd); return false; } - bool JsonApiServer::isAuthTokenValid(const std::string& token) { RS_STACK_MUTEX(configMutex); - std::string user,passwd; + std::string user,passwd; + if(!parseToken(token,user,passwd)) return false; - if(!parseToken(token,user,passwd)) - return false; - - auto it = mAuthTokenStorage.mAuthorizedTokens.find(user); - - if(it == mAuthTokenStorage.mAuthorizedTokens.end()) - return false; + auto it = mAuthTokenStorage.mAuthorizedTokens.find(user); + if(it == mAuthTokenStorage.mAuthorizedTokens.end()) return false; // attempt avoiding +else CRYPTO_memcmp+ being optimized away int noOptimiz = 1; @@ -455,11 +449,12 @@ bool JsonApiServer::isAuthTokenValid(const std::string& token) * std::string comparison is usually not constant time on content to be * faster, so an attacker may use timings to guess authorized tokens */ - if( passwd.size() == it->second.size() && ( noOptimiz = CRYPTO_memcmp( passwd.data(), it->second.data(), it->second.size() ) ) == 0 ) - return true; - // Make token size guessing harder - else - noOptimiz = CRYPTO_memcmp(passwd.data(), passwd.data(), passwd.size()); + if( passwd.size() == it->second.size() && + ( noOptimiz = CRYPTO_memcmp( + passwd.data(), it->second.data(), it->second.size() ) ) == 0 ) + return true; + // Make token size guessing harder + else noOptimiz = CRYPTO_memcmp(passwd.data(), passwd.data(), passwd.size()); // attempt avoiding +else CRYPTO_memcmp+ being optimized away return static_cast(noOptimiz) + 1 == 0; @@ -482,29 +477,37 @@ bool JsonApiServer::revokeAuthToken(const std::string& token) return false; } -void JsonApiServer::connectToConfigManager(p3ConfigMgr *cfgmgr) +void JsonApiServer::connectToConfigManager(p3ConfigMgr& cfgmgr) { - cfgmgr->addConfiguration("jsonapi.cfg",this); + cfgmgr.addConfiguration("jsonapi.cfg",this); - RsFileHash hash; - loadConfiguration(hash); + RsFileHash hash; + loadConfiguration(hash); } -bool JsonApiServer::authorizeUser(const std::string& user,const std::string& passwd) +bool JsonApiServer::authorizeUser( + const std::string& user, const std::string& passwd ) { - if(!librs::util::is_alphanumeric(user) || !librs::util::is_alphanumeric(passwd)) - { - RsErr() << "Password or username for jsonapi token is not alphanumeric." << std::endl; - return false; - } + if(!librs::util::is_alphanumeric(user)) + { + RsErr() << __PRETTY_FUNCTION__ << " User name is not alphanumeric" + << std::endl; + return false; + } + + if(!librs::util::is_alphanumeric(passwd)) + { + RsErr() << __PRETTY_FUNCTION__ << " Password is not alphanumeric" + << std::endl; + return false; + } RS_STACK_MUTEX(configMutex); - std::string& p(mAuthTokenStorage.mAuthorizedTokens[user]); - - if(p != passwd) + std::string& p(mAuthTokenStorage.mAuthorizedTokens[user]); + if(p != passwd) { - p = passwd; + p = passwd; IndicateConfigChanged(); } return true; @@ -519,25 +522,6 @@ bool JsonApiServer::authorizeUser(const std::string& user,const std::string& pas return decodedToken; } -/*static*/ std::string JsonApiServer::encodeToken(const std::string& clear_token) -{ - std::string encoded; - Radix64::encode( reinterpret_cast(clear_token.c_str()), - clear_token.length(), encoded ); - return encoded; -} - -/*static*/ void JsonApiServer::version( - uint32_t& major, uint32_t& minor, uint32_t& mini, std::string& extra, - std::string& human ) -{ - major = RS_MAJOR_VERSION; - minor = RS_MINOR_VERSION; - mini = RS_MINI_VERSION; - extra = RS_EXTRA_VERSION; - human = RS_HUMAN_READABLE_VERSION; -} - RsSerialiser* JsonApiServer::setupSerialiser() { RsSerialiser* rss = new RsSerialiser; @@ -575,26 +559,88 @@ void JsonApiServer::handleCorsOptions( const std::shared_ptr session ) { session->close(rb::NO_CONTENT, corsOptionsHeaders); } -void JsonApiServer::registerResourceProvider(const JsonApiResourceProvider *rp) -{ - mResourceProviders.insert(rp); -} -void JsonApiServer::unregisterResourceProvider(const JsonApiResourceProvider *rp) -{ - mResourceProviders.erase(rp); -} -bool JsonApiServer::hasResourceProvider(const JsonApiResourceProvider *rp) -{ - return mResourceProviders.find(rp) != mResourceProviders.end(); -} +void JsonApiServer::registerResourceProvider(const JsonApiResourceProvider& rp) +{ mResourceProviders.insert(rp); } +void JsonApiServer::unregisterResourceProvider(const JsonApiResourceProvider& rp) +{ mResourceProviders.erase(rp); } +bool JsonApiServer::hasResourceProvider(const JsonApiResourceProvider& rp) +{ return mResourceProviders.find(rp) != mResourceProviders.end(); } std::vector > JsonApiServer::getResources() const { - auto tab = mResources; + auto tab = mResources; - for(auto& rp: mResourceProviders) - for(auto r: rp->getResources()) - tab.push_back(r); + for(auto& rp: mResourceProviders) + for(auto r: rp.get().getResources()) tab.push_back(r); - return tab; + return tab; +} + +bool JsonApiServer::restart() +{ + fullstop(); + RsThread::start("JSON API Server"); + + return true; +} + +bool JsonApiServer::fullstop() +{ + if(!mService->is_up()) return true; + + mService->stop(); + RsThread::ask_for_stop(); + + while(isRunning()) + { + RsDbg() << __PRETTY_FUNCTION__ << " shutting down JSON API service." + << std::endl; + std::this_thread::sleep_for(std::chrono::milliseconds(200)); + } + return true; +} + +uint16_t JsonApiServer::listeningPort() const { return mListeningPort; } +void JsonApiServer::setListeningPort(uint16_t p) { mListeningPort = p; } +void JsonApiServer::setBindingAddress(const std::string& bindAddress) +{ mBindingAddress = bindAddress; } +std::string JsonApiServer::getBindingAddress() const { return mBindingAddress; } + +void JsonApiServer::runloop() +{ + auto settings = std::make_shared(); + settings->set_port(mListeningPort); + settings->set_bind_address(mBindingAddress); + settings->set_default_header("Connection", "close"); + + if(mService->is_up()) + { + RsWarn() << __PRETTY_FUNCTION__ << " restbed is already running. " + << " stopping it before starting again!" << std::endl; + mService->stop(); + } + + /* re-allocating mService is important because it deletes the existing + * service and therefore leaves the listening port open */ + mService = std::make_shared(); + + for(auto& r: getResources()) mService->publish(r); + + try + { + RsUrl apiUrl; apiUrl.setScheme("http").setHost(mBindingAddress) + .setPort(mListeningPort); + RsDbg() << __PRETTY_FUNCTION__ << " JSON API server listening on " + << apiUrl.toString() << std::endl; + mService->start(settings); + } + catch(std::exception& e) + { + RsErr() << __PRETTY_FUNCTION__ << " Failure starting JSON API server: " + << e.what() << std::endl; + print_stacktrace(); + return; + } + + RsInfo() << __PRETTY_FUNCTION__ << " finished!" << std::endl; } diff --git a/libretroshare/src/jsonapi/jsonapi.h b/libretroshare/src/jsonapi/jsonapi.h index c5eceb9ab..9c0fa502d 100644 --- a/libretroshare/src/jsonapi/jsonapi.h +++ b/libretroshare/src/jsonapi/jsonapi.h @@ -4,14 +4,13 @@ * Copyright (C) 2018-2019 Gioacchino Mazzurco * * * * 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. * + * it under the terms of the GNU Affero General Public License version 3 as * + * published by the Free Software Foundation. * * * * 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. * + * 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 Affero General Public License * * along with this program. If not, see . * @@ -25,12 +24,13 @@ #include #include #include +#include +#include #include "util/rsthreads.h" #include "pqi/p3cfgmgr.h" #include "rsitems/rsitem.h" #include "jsonapi/jsonapiitems.h" -#include "jsonapi/restbedservice.h" #include "retroshare/rsjsonapi.h" #include "util/rsthreads.h" @@ -39,96 +39,89 @@ namespace rb = restbed; class JsonApiResourceProvider { public: - JsonApiResourceProvider() {} - virtual ~JsonApiResourceProvider() = default; + virtual ~JsonApiResourceProvider() = default; - virtual std::string getName() const =0; - virtual std::vector > getResources() const =0; + virtual std::vector> getResources() const = 0; + + inline bool operator< (const JsonApiResourceProvider& rp) const + { return this < &rp; } }; /** - * Simple usage - * \code{.cpp} - * JsonApiServer jas(9092); - * jsonApiServer = &jas; - * jas.start("JsonApiServer"); - * \endcode * Uses p3Config to securely store persistent JSON API authorization tokens */ -class JsonApiServer : public p3Config, public RestbedService, public RsJsonAPI +class JsonApiServer : public p3Config, public RsThread, public RsJsonApi { public: - JsonApiServer() ; - virtual ~JsonApiServer() = default; + JsonApiServer(); + ~JsonApiServer() override = default; - // implements RestbedService + std::vector> getResources() const; - virtual std::vector > getResources() const override ; + /// @see RsJsonApi + bool restart() override; - // RsJsonAPI public API + /// @see RsJsonApi + bool fullstop() override; - bool restart() override { return RestbedService::restart(); } - bool stop() override { return RestbedService::fullstop();} - bool isRunning() override { return RestbedService::isRunning(); } + /// @see RsJsonApi + inline bool isRunning() override { return RsThread::isRunning(); } - void setListeningPort(uint16_t port) override { return RestbedService::setListeningPort(port); } - void setBindingAddress(const std::string& bind_address) override { return RestbedService::setBindAddress(bind_address); } - uint16_t listeningPort() const override { return RestbedService::listeningPort() ; } + /// @see RsJsonApi + void setListeningPort(uint16_t port) override; - virtual void connectToConfigManager(p3ConfigMgr *cfgmgr); + /// @see RsJsonApi + void setBindingAddress(const std::string& bindAddress) override; - virtual bool authorizeUser(const std::string& alphanumeric_user,const std::string& alphanumeric_passwd) override; - virtual std::map getAuthorizedTokens() override; + /// @see RsJsonApi + std::string getBindingAddress() const override; + + /// @see RsJsonApi + uint16_t listeningPort() const override; + + /// @see RsJsonApi + void connectToConfigManager(p3ConfigMgr& cfgmgr) override; + + /// @see RsJsonApi + virtual bool authorizeUser( + const std::string& alphanumeric_user, + const std::string& alphanumeric_passwd ) override; + + /// @see RsJsonApi + std::map getAuthorizedTokens() override; + + /// @see RsJsonApi bool revokeAuthToken(const std::string& user) override; + + /// @see RsJsonApi bool isAuthTokenValid(const std::string& token) override; - bool requestNewTokenAutorization(const std::string& user) override; - void registerResourceProvider(const JsonApiResourceProvider *); - void unregisterResourceProvider(const JsonApiResourceProvider *); - bool hasResourceProvider(const JsonApiResourceProvider *); + /// @see RsJsonAPI + bool requestNewTokenAutorization( + const std::string& user, const std::string& password ) override; - // private API. These methods may be moved to RsJsonAPI so as to be visible in http mode, if needed. + /// @see RsJsonApi + void registerResourceProvider(const JsonApiResourceProvider&) override; + + /// @see RsJsonApi + void unregisterResourceProvider(const JsonApiResourceProvider&) override; + + /// @see RsJsonApi + bool hasResourceProvider(const JsonApiResourceProvider&) override; /** * @brief Get decoded version of the given encoded token - * @jsonapi{development,unauthenticated} * @param[in] radix64_token encoded * @return token decoded */ static std::string decodeToken(const std::string& radix64_token); /** - * @brief Get encoded version of the given decoded token - * @jsonapi{development,unauthenticated} - * @param[in] clear_token decoded - * @return token encoded - */ - static std::string encodeToken(const std::string& clear_token); - - /** - * @brief Write version information to given paramethers - * @jsonapi{development,unauthenticated} - * @param[out] major storage - * @param[out] minor storage - * @param[out] mini storage - * @param[out] extra storage - * @param[out] human storage - */ - static void version( uint32_t& major, uint32_t& minor, uint32_t& mini, - std::string& extra, std::string&human ); - - - // /!\ These methods shouldn't be accessible through http! - - /** - * @param[in] path Path itno which publish the API call + * Register an unique handler for a resource path + * @param[in] path Path into which publish the API call * @param[in] handler function which will be called to handle the requested * @param[in] requiresAutentication specify if the API call must be - * autenticated or not - * path, the function must be declared like: - * \code{.cpp} - * void functionName(const shared_ptr session) - * \endcode + * autenticated or not. */ void registerHandler( const std::string& path, @@ -139,29 +132,29 @@ public: * @brief Set new access request callback * @param callback function to call when a new JSON API access is requested */ - void setNewAccessRequestCallback(const std::function& callback ); + void setNewAccessRequestCallback( + const std::function& + callback ); private: - /// @see p3Config::setupSerialiser - virtual RsSerialiser* setupSerialiser(); + RsSerialiser* setupSerialiser() override; /// @see p3Config::saveList - virtual bool saveList(bool &cleanup, std::list& saveItems); + bool saveList(bool &cleanup, std::list& saveItems) override; /// @see p3Config::loadList - virtual bool loadList(std::list& loadList); + bool loadList(std::list& loadList) override; /// @see p3Config::saveDone - virtual void saveDone(); + void saveDone() override; uint16_t mPort; std::string mBindAddress; /// Called when new JSON API auth token is requested to be authorized - /// The callback supplies the password to be used to make the token - /// - std::function mNewAccessRequestCallback; + std::function + mNewAccessRequestCallback; /// Encrypted persistent storage for authorized JSON API tokens JsonApiServerAuthTokenStorage mAuthTokenStorage; @@ -182,10 +175,21 @@ private: RsGenericSerializer::SerializeContext& ctx, const std::shared_ptr session ) { - return checkRsServicePtrReady( serviceInstance.get(), serviceName, ctx, session ); + return checkRsServicePtrReady( + serviceInstance.get(), serviceName, ctx, session ); } - std::vector > mResources; - std::set mResourceProviders; + std::vector> mResources; + std::set< + std::reference_wrapper, + std::less > mResourceProviders; + + /// @see RsThread + void runloop() override; + + std::shared_ptr mService; + + uint16_t mListeningPort; + std::string mBindingAddress; }; diff --git a/libretroshare/src/jsonapi/restbedservice.cc b/libretroshare/src/jsonapi/restbedservice.cc deleted file mode 100644 index 72365909f..000000000 --- a/libretroshare/src/jsonapi/restbedservice.cc +++ /dev/null @@ -1,94 +0,0 @@ -/******************************************************************************* - * libretroshare/src/jsonapi/: restbedservice.cc * - * * - * libretroshare: retroshare core library * - * * - * Copyright 2019-2019 Cyril Soler * - * * - * 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 Lesser 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 . * - * * - *******************************************************************************/ - -#include "retroshare/rsjsonapi.h" -#include "util/rsthreads.h" -#include "util/rsdebug.h" -#include "restbedservice.h" - -RestbedService::RestbedService() - : mService(std::make_shared()), // this is a place holder, in case we request some internal values. - mListeningPort(RsJsonAPI::DEFAULT_PORT), - mBindingAddress(RsJsonAPI::DEFAULT_BINDING_ADDRESS) -{ -} - -bool RestbedService::restart() -{ - fullstop(); - start("Restbed Service"); - - return true; -} - -bool RestbedService::fullstop() -{ - if(!mService->is_up()) - return true; - - mService->stop(); - - RsThread::ask_for_stop(); - - while(isRunning()) - { - std::cerr << "(II) shutting down restbed service." << std::endl; - rstime::rs_usleep(1000*1000); - } - return true; -} - -uint16_t RestbedService::listeningPort() const { return mListeningPort ; } -void RestbedService::setListeningPort(uint16_t p) { mListeningPort = p ; } -void RestbedService::setBindAddress(const std::string& bindAddress) { mBindingAddress = bindAddress ; } - -void RestbedService::runloop() -{ - auto settings = std::make_shared< restbed::Settings >( ); - settings->set_port( mListeningPort ); - settings->set_bind_address( mBindingAddress ); - settings->set_default_header( "Connection", "close" ); - - if(mService->is_up()) - { - RsWarn() << "(II) WebUI is already running. Killing it." << std::endl; - mService->stop(); - } - - mService = std::make_shared(); // re-allocating mService is important because it deletes the existing service and therefore leaves the listening port open - - for(auto& r:getResources()) - mService->publish(r); - - try - { - std::cerr << "(II) Starting restbed service on port " << std::dec << mListeningPort << " and binding address \"" << mBindingAddress << "\"" << std::endl; - mService->start( settings ); - } - catch(std::exception& e) - { - RsErr() << "Could not start web interface: " << e.what() << std::endl; - return; - } - - std::cerr << "(II) restbed service stopped." << std::endl; -} diff --git a/libretroshare/src/libretroshare.pro b/libretroshare/src/libretroshare.pro index da167a9c5..fb85a060b 100644 --- a/libretroshare/src/libretroshare.pro +++ b/libretroshare/src/libretroshare.pro @@ -172,6 +172,7 @@ HEADERS += plugins/pluginmanager.h \ HEADERS += $$PUBLIC_HEADERS +SOURCES *= services/rsversion.cxx ################################# Linux ########################################## linux-* { @@ -902,8 +903,8 @@ rs_jsonapi { # Force recalculation of libretroshare dependencies see https://stackoverflow.com/a/47884045 QMAKE_EXTRA_TARGETS += libretroshare - HEADERS += jsonapi/jsonapi.h jsonapi/jsonapiitems.h jsonapi/restbedservice.h retroshare/rsjsonapi.h - SOURCES += jsonapi/jsonapi.cpp jsonapi/restbedservice.cc + HEADERS += jsonapi/jsonapi.h jsonapi/jsonapiitems.h retroshare/rsjsonapi.h + SOURCES += jsonapi/jsonapi.cpp } rs_deep_channels_index { diff --git a/libretroshare/src/retroshare/rsjsonapi.h b/libretroshare/src/retroshare/rsjsonapi.h index 4e690da94..e5c59c496 100644 --- a/libretroshare/src/retroshare/rsjsonapi.h +++ b/libretroshare/src/retroshare/rsjsonapi.h @@ -5,9 +5,8 @@ * Copyright (C) 2019-2019 Cyril Soler * * * * 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. * + * it under the terms of the GNU Affero General Public License version 3 as * + * published by the Free Software Foundation. * * * * This program is distributed in the hope that it will be useful, * * but WITHOUT ANY WARRANTY; without even the implied warranty of * @@ -16,7 +15,7 @@ * * * You should have received a copy of the GNU Affero General Public License * * along with this program. If not, see . * - * + * * *******************************************************************************/ #pragma once @@ -25,113 +24,139 @@ class p3ConfigMgr; class JsonApiResourceProvider; +class RsJsonApi; -class RsJsonAPI +/** + * Pointer to global instance of RsJsonApi service implementation + * @jsonapi{development} + */ +extern RsJsonApi* rsJsonApi; + +class RsJsonApi { public: - static const uint16_t DEFAULT_PORT = 9092 ; - static const std::string DEFAULT_BINDING_ADDRESS ; // 127.0.0.1 + static const uint16_t DEFAULT_PORT = 9092; + static const std::string DEFAULT_BINDING_ADDRESS; // 127.0.0.1 + + /** + * @brief Restart RsJsonApi server + * @jsonapi{development} + */ + virtual bool restart() = 0; + + /** + * @brief Request RsJsonApi to stop and wait until ti has stopped. + * Be expecially carefull to call this from JSON API because you will loose + * access to the API. + * @jsonapi{development} + */ + virtual bool fullstop() = 0; - virtual bool restart() =0; - virtual bool stop() =0; /** * @brief Get status of the json api server - * @jsonapi{development} * @return Returns true if the server is running */ - virtual bool isRunning() =0; + virtual bool isRunning() = 0; - /*! - * \brief setBindingAddress - * Sets the binding address of the jsonapi server. Will only take effect after the server is restarted - * \param address - * Address in IPv4 or IPv6 format. - */ + /** + * Sets the binding address of the JSON API server. Will only take effect + * after the server is restarted. + * @jsonapi{development} + * @param[in] address Binding address in IPv4 or IPv6 format. + */ + virtual void setBindingAddress(const std::string& address) = 0; - virtual void setBindingAddress(const std::string& address) =0; + /** + * Get the binding address of the JSON API server. + * @jsonapi{development} + * @return string representing binding address + */ + virtual std::string getBindingAddress() const = 0; - /*! - * \brief setListeningPort - * Port to use when talking to the jsonAPI server. - * \param port - * Should be a non system-reserved 16 bits port number (1024 to 65535) - */ - virtual void setListeningPort(uint16_t port) =0; - virtual uint16_t listeningPort() const =0; + /*! + * Set port on which JSON API server will listen. Will only take effect + * after the server is restarted. + * @jsonapi{development} + * @param[in] port Must be available otherwise the binding will fail + */ + virtual void setListeningPort(uint16_t port) = 0; - /*! - * \brief connectToConfigManager - * Should be called after creating the JsonAPI object so that it publishes itself with the proper config file. - * Since JsonAPI is created *before* login, the config manager does not exist at this time. - * \param cfgmgr - */ - virtual void connectToConfigManager(p3ConfigMgr *cfgmgr)=0; + /*! + * Get port on which JSON API server will listen. + * @jsonapi{development} + */ + virtual uint16_t listeningPort() const = 0; - /*! - * \brief registerResourceProvider - * This is used to add/remove new web services to JsonAPI. The client should take care of not using a path range already - * used by the jsonAPI server. - */ - virtual void registerResourceProvider(const JsonApiResourceProvider *)=0; - virtual void unregisterResourceProvider(const JsonApiResourceProvider *)=0; - virtual bool hasResourceProvider(const JsonApiResourceProvider *)=0; + /*! + * Should be called after creating the JsonAPI object so that it publishes + * itself with the proper config file. + * Since JsonAPI is created *before* login, the config manager does not + * exist at that time. + * @param cfgmgr + */ + virtual void connectToConfigManager(p3ConfigMgr& cfgmgr) = 0; + + /** + * This is used to add/remove new web services to JsonAPI. The client + * should take care of not using a path range already used by the jsonAPI + * server + */ + virtual void registerResourceProvider(const JsonApiResourceProvider&) = 0; + virtual void unregisterResourceProvider(const JsonApiResourceProvider&) = 0; + virtual bool hasResourceProvider(const JsonApiResourceProvider&) = 0; - //=============================================================================================// - // API methods that are also accessible through http // - //=============================================================================================// /** * @brief This function should be used by JSON API clients that aren't * authenticated yet, to ask their token to be authorized, the success or * failure will depend on mNewAccessRequestCallback return value, and it * will likely need human user interaction in the process. * @jsonapi{development,unauthenticated} - * @param[in] token token to autorize + * @param[in] user user name to authorize + * @param[in] password password for the new user * @return true if authorization succeded, false otherwise. */ - virtual bool requestNewTokenAutorization(const std::string& token)=0; + virtual bool requestNewTokenAutorization( + const std::string& user, const std::string& password) = 0; - //=============================================================================================// - // Utility methods // - //=============================================================================================// + /** Split a token in USER:PASSWORD format into user and password */ + static bool parseToken( + const std::string& clear_token, + std::string& user, std::string& passwd ); - static bool parseToken(const std::string& clear_token,std::string& user,std::string& passwd); - - //=============================================================================================// - // API methods that SHOULD NOT be accessible through http // - //=============================================================================================// - - //////////////// @Gio: The methods below should not be accessible from the API server ! - /// /** - * @brief Add new auth (user,passwd) token to the authorized set, creating the token user:passwd internally. - * @param[in] alphanumeric_user username to autorize decoded - * @param[in] alphanumeric_passwd passwd to autorize decoded - * @return true if the token has been added to authorized, false if error occurred + * Add new auth (user,passwd) token to the authorized set, creating the + * token user:passwd internally. + * @jsonapi{development} + * @param[in] user user name to autorize, must be alphanumerinc + * @param[in] password password for the user, must be alphanumerinc + * @return true if the token has been added to authorized, false if error + * occurred */ - virtual bool authorizeUser(const std::string& alphanumeric_user,const std::string& alphanumeric_passwd)=0; + virtual bool authorizeUser( + const std::string& user, const std::string& password ) = 0; /** * @brief Revoke given auth token - * @param[in] user par of the decoded token + * @jsonapi{development} + * @param[in] user user name of which to revoke authorization * @return true if the token has been revoked, false otherwise */ virtual bool revokeAuthToken(const std::string& user)=0; /** * @brief Get authorized tokens + * @jsonapi{development} * @return the set of authorized encoded tokens */ - virtual std::map getAuthorizedTokens() =0; + virtual std::map getAuthorizedTokens() = 0; /** * @brief Check if given JSON API auth token is authorized + * @jsonapi{development,unauthenticated} * @param[in] token decoded * @return tru if authorized, false otherwise */ - virtual bool isAuthTokenValid(const std::string& token)=0; - + virtual bool isAuthTokenValid(const std::string& token) = 0; + virtual ~RsJsonApi() = default; }; - -extern RsJsonAPI *rsJsonAPI; - diff --git a/libretroshare/src/retroshare/rsversion.h b/libretroshare/src/retroshare/rsversion.h index 8452cbec8..dde4fde89 100644 --- a/libretroshare/src/retroshare/rsversion.h +++ b/libretroshare/src/retroshare/rsversion.h @@ -3,7 +3,8 @@ * * * libretroshare: retroshare core library * * * - * Copyright 2012-2018 by Retroshare Team * + * Copyright (C) 2012-2018 Retroshare Team * + * Copyright (C) 2018-2019 Gioacchino Mazzurco * * * * This program is free software: you can redistribute it and/or modify * * it under the terms of the GNU Lesser General Public License as * @@ -21,7 +22,6 @@ *******************************************************************************/ #pragma once - /** * @def RS_MINI_VERSION * First number of RetroShare versioning scheme @@ -69,13 +69,45 @@ (RS_MINOR_VERSION == (B) && RS_MINI_VERSION >= (C))))) -#define __RS_PRIVATE_STRINGIFY2(X) #X -#define __RS_PRIVATE_STRINGIFY(X) __RS_PRIVATE_STRINGIFY2(X) +#define RS_PRIVATE_STRINGIFY2(X) #X +#define RS_PRIVATE_STRINGIFY(X) RS_PRIVATE_STRINGIFY2(X) /** * Human readable string describing RetroShare version */ constexpr auto RS_HUMAN_READABLE_VERSION = - __RS_PRIVATE_STRINGIFY(RS_MAJOR_VERSION) "." \ - __RS_PRIVATE_STRINGIFY(RS_MINOR_VERSION) "." \ - __RS_PRIVATE_STRINGIFY(RS_MINI_VERSION) RS_EXTRA_VERSION; + RS_PRIVATE_STRINGIFY(RS_MAJOR_VERSION) "." \ + RS_PRIVATE_STRINGIFY(RS_MINOR_VERSION) "." \ + RS_PRIVATE_STRINGIFY(RS_MINI_VERSION) RS_EXTRA_VERSION; + + +#include +#include + +/** + * Helper to expose version information to JSON API. + * From C++ you should use directly the macro and constants defined upstair + * @jsonapi{development} + */ +class RsVersion +{ +public: + /** + * @brief Write version information to given paramethers + * @jsonapi{development,unauthenticated} + * @param[out] major storage + * @param[out] minor storage + * @param[out] mini storage + * @param[out] extra storage + * @param[out] human storage + */ + static void version( uint32_t& major, uint32_t& minor, uint32_t& mini, + std::string& extra, std::string& human ); +}; + +/** + * Pointer to global instance of RsVersion, for the sake of JSON API, from C++ + * you can use directly the macro and constants defined upstair + * @jsonapi{development} + */ +extern RsVersion* rsVersion; diff --git a/libretroshare/src/retroshare/rswebui.h b/libretroshare/src/retroshare/rswebui.h index ce31e6f2c..d09fa0b64 100644 --- a/libretroshare/src/retroshare/rswebui.h +++ b/libretroshare/src/retroshare/rswebui.h @@ -6,39 +6,67 @@ * Copyright 2019-2019 Cyril Soler * * * * 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. * + * it under the terms of the GNU Affero General Public License version 3 as * + * published by the Free Software Foundation. * * * * 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 * + * You should have received a copy of the GNU Affero General Public License * * along with this program. If not, see . * * * *******************************************************************************/ - #pragma once -class RsWebUI +#include + +class RsWebUi; + +/** + * Pointer to global instance of RsWebUi service implementation + * @jsonapi{development} + */ +extern RsWebUi* rsWebUI; + +class RsWebUi { public: - enum { - WEBUI_STATUS_UNKNOWN = 0x00, - WEBUI_STATUS_NOT_RUNNING = 0x01, - WEBUI_STATUS_RUNNING = 0x02 - }; - static const std::string DEFAULT_BASE_DIRECTORY ; + static const std::string DEFAULT_BASE_DIRECTORY; - virtual bool restart() =0; - virtual bool stop() =0; + /** + * @brief Restart WebUI + * @jsonapi{development} + */ + virtual bool restart() = 0; - virtual void setHtmlFilesDirectory(const std::string& html_dir) =0; - virtual void setUserPassword(const std::string& passwd) =0; + /** + * @brief Stop WebUI + * @jsonapi{development} + */ + virtual bool stop() = 0; - virtual int status() const=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; }; - -extern RsWebUI *rsWebUI; diff --git a/libretroshare/src/rsserver/p3face-config.cc b/libretroshare/src/rsserver/p3face-config.cc index 986167b53..3251f33eb 100644 --- a/libretroshare/src/rsserver/p3face-config.cc +++ b/libretroshare/src/rsserver/p3face-config.cc @@ -91,7 +91,7 @@ void RsServer::rsGlobalShutDown() mNetMgr->shutdown(); /* Handles UPnP */ #ifdef RS_JSONAPI - rsJsonAPI->stop(); + rsJsonApi->fullstop(); #endif rsAutoProxyMonitor::instance()->stopAllRSShutdown(); diff --git a/libretroshare/src/rsserver/p3face.h b/libretroshare/src/rsserver/p3face.h index 62267e06b..156641a25 100644 --- a/libretroshare/src/rsserver/p3face.h +++ b/libretroshare/src/rsserver/p3face.h @@ -34,7 +34,6 @@ #include "retroshare/rsiface.h" #include "retroshare/rstypes.h" #include "util/rsthreads.h" -#include "jsonapi/jsonapi.h" #include "chat/p3chatservice.h" #include "gxstunnel/p3gxstunnel.h" @@ -141,7 +140,7 @@ public: private: - std::string getSQLCipherVersion(); + std::string getSQLCipherVersion(); // TODO: move to rsversion.h // The real Server Parts. @@ -157,9 +156,6 @@ public: RsPluginManager *mPluginsManager; - //sslroot *sslr; - JsonApiServer *mJsonAPIServer; - /* services */ p3heartbeat *mHeart; p3discovery2 *mDisc; diff --git a/libretroshare/src/rsserver/p3webui.cc b/libretroshare/src/rsserver/p3webui.cc index 392defb49..1cbc2fb46 100644 --- a/libretroshare/src/rsserver/p3webui.cc +++ b/libretroshare/src/rsserver/p3webui.cc @@ -6,16 +6,15 @@ * Copyright 2019-2019 Cyril Soler * * * * 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. * + * it under the terms of the GNU Lesser General Public License version 3 as * + * published by the Free Software Foundation. * * * * 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 * + * You should have received a copy of the GNU Affero General Public License * * along with this program. If not, see . * * * *******************************************************************************/ @@ -28,26 +27,29 @@ #include #include #include + #include "util/rsthreads.h" #include "util/rsdebug.h" #include "retroshare/rswebui.h" #include "rsserver/rsaccounts.h" #include "retroshare/rsjsonapi.h" -enum { - TEXT_HTML = 0, - TEXT_CSS = 1, - TEXT_SVG = 2, - TEXT_TTF = 3, - TEXT_WOFF = 4, - APPLICATION_OCTET_STREAM = 5 -}; - #define DEBUG_RS_WEBUI 1 -RsWebUI *rsWebUI = new p3WebUI; +RsWebUi *rsWebUI = new p3WebUI; -static const std::string mime_types[6] = { +enum MimeTypeIndex +{ + TEXT_HTML, + TEXT_CSS, + TEXT_SVG, + TEXT_TTF, + TEXT_WOFF, + APPLICATION_OCTET_STREAM, +}; + +static const constexpr char* const mime_types[] = +{ "text/html", "text/css", "image/svg+xml", @@ -56,59 +58,59 @@ static const std::string mime_types[6] = { "application/octet-stream", }; -const std::string RsWebUI::DEFAULT_BASE_DIRECTORY = RsAccountsDetail::PathDataDirectory(false); //"/usr/share/retroshare/webui/"; -static std::string _base_directory = RsWebUI::DEFAULT_BASE_DIRECTORY; +const std::string RsWebUi::DEFAULT_BASE_DIRECTORY = + RsAccountsDetail::PathDataDirectory(false) + "/webui/"; +static std::string _base_directory = RsWebUi::DEFAULT_BASE_DIRECTORY; -template class handler +template class handler { - public: - static void get_handler( const std::shared_ptr< restbed::Session > session ) +public: + static void get_handler( const std::shared_ptr< restbed::Session > session ) + { + const auto request = session->get_request( ); + const std::string filename = request->get_path_parameter( "filename" ); + std::string directory = request->get_path_parameter( "dir" ); + + if(!directory.empty()) directory += "/"; + + std::string resource_filename = _base_directory + "/" + directory + filename; + RsDbg() << "Reading file: \"" << resource_filename << "\"" << std::endl; + std::ifstream stream( resource_filename, std::ifstream::in ); + + if(stream.is_open()) { - const auto request = session->get_request( ); - const std::string filename = request->get_path_parameter( "filename" ); - std::string directory = request->get_path_parameter( "dir" ); + const std::string body = std::string( + std::istreambuf_iterator(stream), + std::istreambuf_iterator() ); - if(!directory.empty()) - directory += "/"; + RsDbg() << __PRETTY_FUNCTION__ + << " body length=" << body.length() << std::endl; - std::string resource_filename = _base_directory + "/" + directory + filename; - RsDbg() << "Reading file: \"" << resource_filename << "\"" << std::endl; - std::ifstream stream( resource_filename, std::ifstream::in ); - - if ( stream.is_open( ) ) + const std::multimap headers { - const std::string body = std::string( std::istreambuf_iterator< char >( stream ), std::istreambuf_iterator< char >( ) ); + { "Content-Type", mime_types[MIME_TYPE_INDEX] }, + { "Content-Length", std::to_string(body.length()) } + }; - RsDbg() << " body length=" << body.length() << std::endl; - const std::multimap< std::string, std::string > headers - { - { "Content-Type", mime_types[MIME_TYPE_INDEX] }, - { "Content-Length", std::to_string( body.length( ) ) } - }; - - session->close( restbed::OK, body, headers ); - } - else - { - RsErr() << "Could not open file " << resource_filename << std::endl; - session->close( restbed::NOT_FOUND ); - } + session->close(restbed::OK, body, headers); } + else + { + RsErr() << __PRETTY_FUNCTION__ << "Could not open file: " + << resource_filename << std::endl; + session->close(restbed::NOT_FOUND); + } + } }; -static void service_ready_handler( restbed::Service& ) +std::vector< std::shared_ptr > p3WebUI::getResources() const { - fprintf( stderr, "Hey! The service is up and running." ); -} + static std::vector< std::shared_ptr > rtab; -std::vector > p3WebUI::getResources() const -{ - static std::vector > rtab; - - if(rtab.empty()) + if(rtab.empty()) { - auto resource1 = std::make_shared< restbed::Resource >( ); + auto resource1 = std::make_shared< restbed::Resource >(); resource1->set_paths( { "/{filename: index.html}", "/{filename: app.js}", @@ -167,37 +169,29 @@ void p3WebUI::setHtmlFilesDirectory(const std::string& html_dir) _base_directory = html_dir; } -int p3WebUI::status() const -{ - if(rsJsonAPI->isRunning() && rsJsonAPI->hasResourceProvider(this)) - return WEBUI_STATUS_RUNNING; - else - return WEBUI_STATUS_NOT_RUNNING; -} +bool p3WebUI::isRunning() const +{ return rsJsonApi->isRunning() && rsJsonApi->hasResourceProvider(*this); } void p3WebUI::setUserPassword(const std::string& passwd) { -#ifdef RS_JSONAPI - std::cerr << "Updating webui token with new passwd \"" << passwd << "\"" << std::endl; + RsDbg() << __PRETTY_FUNCTION__ << " Updating webui token with new passwd \"" + << passwd << "\"" << std::endl; - if(!rsJsonAPI->authorizeUser("webui",passwd)) + if(!rsJsonApi->authorizeUser("webui",passwd)) std::cerr << "(EE) Cannot register webui token. Some error occurred when calling authorizeUser()" << std::endl; -#else - std::cerr << "(EE) JsonAPI is not available in this buildof Retroshare! Cannot register a user password for the WebUI" << std::endl; -#endif } bool p3WebUI::restart() { - rsJsonAPI->registerResourceProvider(this); - rsJsonAPI->restart(); + rsJsonApi->registerResourceProvider(*this); + rsJsonApi->restart(); return true; } bool p3WebUI::stop() { - rsJsonAPI->unregisterResourceProvider(this); - rsJsonAPI->restart(); + rsJsonApi->unregisterResourceProvider(*this); + rsJsonApi->restart(); return true; } diff --git a/libretroshare/src/rsserver/p3webui.h b/libretroshare/src/rsserver/p3webui.h index fe148700f..0a2a7450f 100644 --- a/libretroshare/src/rsserver/p3webui.h +++ b/libretroshare/src/rsserver/p3webui.h @@ -6,16 +6,15 @@ * Copyright 2019-2019 Cyril Soler * * * * 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. * + * it under the terms of the GNU Lesser General Public License version 3 as * + * published by the Free Software Foundation. * * * * 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 * + * You should have received a copy of the GNU Affero General Public License * * along with this program. If not, see . * * * *******************************************************************************/ @@ -26,11 +25,10 @@ #include "retroshare/rswebui.h" #include "jsonapi/jsonapi.h" -class p3WebUI: public RsWebUI, public JsonApiResourceProvider +class p3WebUI: public RsWebUi, public JsonApiResourceProvider { public: - p3WebUI(){} - virtual ~p3WebUI() = default; + ~p3WebUI() override = default; // implements RsWebUI @@ -39,11 +37,9 @@ public: virtual bool restart() override ; virtual bool stop() override ; - virtual int status() const override; - + bool isRunning() const override; // implements JsonApiResourceProvider - virtual std::string getName() const override { return "Web Interface" ;} virtual std::vector > getResources() const override; }; diff --git a/libretroshare/src/rsserver/rsinit.cc b/libretroshare/src/rsserver/rsinit.cc index 5d529c816..48dae7fa0 100644 --- a/libretroshare/src/rsserver/rsinit.cc +++ b/libretroshare/src/rsserver/rsinit.cc @@ -393,20 +393,16 @@ int RsInit::InitRetroShare(const RsConfigOptions& conf) return error_code ; #ifdef RS_JSONAPI - // We create the JsonApiServer this early, because it is needed *before* login + // We create the JsonApiServer this early, because it is needed *before* login + RsInfo() << __PRETTY_FUNCTION__ + << "Allocating jsonAPI server (not launched yet)" << std::endl; + JsonApiServer* jas = new JsonApiServer(); + jas->setListeningPort(conf.jsonApiPort); + jas->setBindingAddress(conf.jsonApiBindAddress); - RsInfo() << "Allocating jsonAPI server (not launched yet) " << std::endl; - JsonApiServer *jas = new JsonApiServer(); - jas->setListeningPort(conf.jsonApiPort); - jas->setBindAddress(conf.jsonApiBindAddress); + if(conf.jsonApiPort != 0) jas->restart(); - if(conf.jsonApiPort != 0) - { - RsInfo() << "Launching jsonAPI server on port " << conf.jsonApiPort << std::endl; - jas->restart(); - } - - rsJsonAPI = jas; + rsJsonApi = jas; #endif #ifdef RS_AUTOLOGIN @@ -1224,10 +1220,8 @@ int RsServer::StartupRetroShare() mPluginsManager->loadPlugins(programatically_inserted_plugins) ; #ifdef RS_JSONAPI - // add jsonapi server to config manager so that it can save/load its tokens - - if(rsJsonAPI) - rsJsonAPI->connectToConfigManager(mConfigMgr); + // add jsonapi server to config manager so that it can save/load its tokens + if(rsJsonApi) rsJsonApi->connectToConfigManager(*mConfigMgr); #endif /**** Reputation system ****/ diff --git a/libretroshare/src/jsonapi/restbedservice.h b/libretroshare/src/services/rsversion.cxx similarity index 52% rename from libretroshare/src/jsonapi/restbedservice.h rename to libretroshare/src/services/rsversion.cxx index 6affb46a9..b4a06f7f7 100644 --- a/libretroshare/src/jsonapi/restbedservice.h +++ b/libretroshare/src/services/rsversion.cxx @@ -1,56 +1,35 @@ /******************************************************************************* - * libretroshare/src/jsonapi/: restbedservice.h * * * * libretroshare: retroshare core library * * * - * Copyright 2019-2019 Cyril Soler * + * Copyright (C) 2019 Gioacchino Mazzurco * * * * This program is free software: you can redistribute it and/or modify * - * it under the terms of the GNU Affero General Public License as * + * 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 Affero General Public License for more details. * + * 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 Affero General Public License * + * You should have received a copy of the GNU Lesser General Public License * * along with this program. If not, see . * * * *******************************************************************************/ -#pragma once +#include "retroshare/rsversion.h" -#include -#include "util/rsthreads.h" +/*extern*/ RsVersion* rsVersion = new RsVersion; -class RestbedThread; - -class RestbedService: public RsThread +/*static*/ void RsVersion::version( + uint32_t& major, uint32_t& minor, uint32_t& mini, std::string& extra, + std::string& human ) { -public: - RestbedService() ; - virtual ~RestbedService() = default; - - bool restart(); - bool fullstop(); - - void setListeningPort(uint16_t port) ; - void setBindAddress(const std::string& bind_address); - uint16_t listeningPort() const ; - - // should be overloaded by sub-class in order to provide resources to the restbed Service. - - virtual std::vector > getResources() const = 0; - -protected: - void runloop() override; - - std::shared_ptr mService; // managed by RestbedService because it needs to be properly deleted when restarted. - -private: - uint16_t mListeningPort; - std::string mBindingAddress; -}; - + major = RS_MAJOR_VERSION; + minor = RS_MINOR_VERSION; + mini = RS_MINI_VERSION; + extra = RS_EXTRA_VERSION; + human = RS_HUMAN_READABLE_VERSION; +} diff --git a/libretroshare/src/util/radix64.h b/libretroshare/src/util/radix64.h index 82a5af9d3..de6eb21f4 100644 --- a/libretroshare/src/util/radix64.h +++ b/libretroshare/src/util/radix64.h @@ -28,8 +28,8 @@ class Radix64 { - public: - static std::vector decode(const std::string& buffer) +public: + static std::vector decode(const std::string& buffer) { char val; int c = 0, c2;/* init c because gcc is not clever @@ -122,13 +122,14 @@ again: /**************** * create a radix64 encoded string. */ - static void encode(const unsigned char *data,int len,std::string& out_string) + static void encode( + const unsigned char* data, size_t len, std::string& out_string ) { char *buffer, *p; radix64_init(); - int size = (len + 2) / 3 * 4 +1; + size_t size = (len + 2) / 3 * 4 +1; buffer = p = new char[size] ; for (; len >= 3; len -= 3, data += 3) diff --git a/retroshare-gui/src/gui/settings/JsonApiPage.cc b/retroshare-gui/src/gui/settings/JsonApiPage.cc index 38b5ffe1f..6c6dee018 100644 --- a/retroshare-gui/src/gui/settings/JsonApiPage.cc +++ b/retroshare-gui/src/gui/settings/JsonApiPage.cc @@ -100,8 +100,10 @@ void JsonApiPage::load() QStringList newTk; - for(const auto& it : rsJsonAPI->getAuthorizedTokens()) - newTk.push_back(QString::fromStdString(it.first)+":"+QString::fromStdString(it.second)) ; + for(const auto& it : rsJsonApi->getAuthorizedTokens()) + newTk.push_back( + QString::fromStdString(it.first) + ":" + + QString::fromStdString(it.second) ); whileBlocking(ui.tokensListView)->setModel(new QStringListModel(newTk)); } @@ -113,19 +115,17 @@ bool JsonApiPage::checkStartJsonApi() if(!Settings->getJsonApiEnabled()) return false; - rsJsonAPI->setListeningPort(Settings->getJsonApiPort()); - rsJsonAPI->setBindingAddress(Settings->getJsonApiListenAddress().toStdString()); - rsJsonAPI->restart(); + rsJsonApi->setListeningPort(Settings->getJsonApiPort()); + rsJsonApi->setBindingAddress(Settings->getJsonApiListenAddress().toStdString()); + rsJsonApi->restart(); return true; } /*static*/ void JsonApiPage::checkShutdownJsonApi() { - if(!rsJsonAPI->isRunning()) - return; - - rsJsonAPI->stop(); // this is a blocking call until the thread is terminated. + if(!rsJsonApi->isRunning()) return; + rsJsonApi->fullstop(); // this is a blocks until the thread is terminated. } void JsonApiPage::onApplyClicked() @@ -138,9 +138,10 @@ void JsonApiPage::onApplyClicked() void JsonApiPage::checkToken(QString s) { - std::string user,passwd; + std::string user,passwd; + bool valid = RsJsonApi::parseToken(s.toStdString(), user, passwd) && + !user.empty() && !passwd.empty(); - bool valid = RsJsonAPI::parseToken(s.toStdString(),user,passwd) && !user.empty() && !passwd.empty(); QColor color; if(!valid) @@ -160,15 +161,16 @@ void JsonApiPage::addTokenClicked() QString token(ui.tokenLineEdit->text()); std::string user,passwd; - if(!RsJsonAPI::parseToken(token.toStdString(),user,passwd)) - return; + if(!RsJsonApi::parseToken(token.toStdString(),user,passwd)) return; - rsJsonAPI->authorizeUser(user,passwd); + rsJsonApi->authorizeUser(user,passwd); QStringList newTk; - for(const auto& it : rsJsonAPI->getAuthorizedTokens()) - newTk.push_back(QString::fromStdString(it.first)+":"+QString::fromStdString(it.second)) ; + for(const auto& it : rsJsonApi->getAuthorizedTokens()) + newTk.push_back( + QString::fromStdString(it.first) + ":" + + QString::fromStdString(it.second) ); whileBlocking(ui.tokensListView)->setModel(new QStringListModel(newTk)); } @@ -176,12 +178,14 @@ void JsonApiPage::addTokenClicked() void JsonApiPage::removeTokenClicked() { QString token(ui.tokenLineEdit->text()); - rsJsonAPI->revokeAuthToken(token.toStdString()); + rsJsonApi->revokeAuthToken(token.toStdString()); QStringList newTk; - for(const auto& it : rsJsonAPI->getAuthorizedTokens()) - newTk.push_back(QString::fromStdString(it.first)+":"+QString::fromStdString(it.second)) ; + for(const auto& it : rsJsonApi->getAuthorizedTokens()) + newTk.push_back( + QString::fromStdString(it.first) + ":" + + QString::fromStdString(it.second) ); whileBlocking(ui.tokensListView)->setModel(new QStringListModel(Settings->getJsonApiAuthTokens()) ); } diff --git a/retroshare-gui/src/gui/settings/WebuiPage.cpp b/retroshare-gui/src/gui/settings/WebuiPage.cpp index c58e5214d..e6a275626 100644 --- a/retroshare-gui/src/gui/settings/WebuiPage.cpp +++ b/retroshare-gui/src/gui/settings/WebuiPage.cpp @@ -117,7 +117,7 @@ void WebuiPage::load() whileBlocking(ui.webInterfaceFiles_LE)->setText(Settings->getWebinterfaceFilesDirectory()); #ifdef RS_JSONAPI - auto smap = rsJsonAPI->getAuthorizedTokens(); + auto smap = rsJsonApi->getAuthorizedTokens(); auto it = smap.find("webui"); if(it != smap.end()) @@ -151,10 +151,14 @@ QString WebuiPage::helpText() const /*static*/ void WebuiPage::showWebui() { - if(Settings->getWebinterfaceEnabled()) - { - QDesktopServices::openUrl(QUrl(QString("http://localhost:")+QString::number(rsJsonAPI->listeningPort()))); - } + if(Settings->getWebinterfaceEnabled()) + { + QUrl webuiUrl; + webuiUrl.setScheme("http"); + webuiUrl.setHost(QString::fromStdString(rsJsonApi->getBindingAddress())); + webuiUrl.setPort(rsJsonApi->listeningPort()); + QDesktopServices::openUrl(webuiUrl); + } else { QMessageBox::warning(0, tr("Webinterface not enabled"), tr("The webinterface is not enabled. Enable it in Settings -> Webinterface.")); @@ -200,8 +204,4 @@ void WebuiPage::onApplyClicked() emit passwordChanged(); } -void WebuiPage::onStartWebBrowserClicked() -{ - QDesktopServices::openUrl(QUrl(QString("http://localhost:")+QString::number(rsJsonAPI->listeningPort()))); -} - +void WebuiPage::onStartWebBrowserClicked() { showWebui(); } diff --git a/retroshare-gui/src/retroshare-gui.pro b/retroshare-gui/src/retroshare-gui.pro index 59f4dc0b9..86a393a33 100644 --- a/retroshare-gui/src/retroshare-gui.pro +++ b/retroshare-gui/src/retroshare-gui.pro @@ -28,13 +28,12 @@ DEFINES += TARGET=\\\"$${TARGET}\\\" DEPENDPATH *= $${PWD} $${RS_INCLUDE_DIR} retroshare-gui INCLUDEPATH *= $${PWD} retroshare-gui +!include("../../libretroshare/src/use_libretroshare.pri"):error("Including") + rs_webui { - !include("../../libresapi/src/use_libresapi.pri"):error("Including") HEADERS *= gui/settings/WebuiPage.h SOURCES *= gui/settings/WebuiPage.cpp FORMS *= gui/settings/WebuiPage.ui -} else { - !include("../../libretroshare/src/use_libretroshare.pri"):error("Including") } rs_jsonapi { @@ -273,9 +272,9 @@ macx { mac_icon.files = $$files($$PWD/rsMacIcon.icns) mac_icon.path = Contents/Resources QMAKE_BUNDLE_DATA += mac_icon - mac_webui.files = $$files($$PWD/../../libresapi/src/webui) - mac_webui.path = Contents/Resources - QMAKE_BUNDLE_DATA += mac_webui +# mac_webui.files = $$files($$PWD/../../libresapi/src/webui) +# mac_webui.path = Contents/Resources +# QMAKE_BUNDLE_DATA += mac_webui CONFIG += version_detail_bash_script LIBS += -lssl -lcrypto -lz diff --git a/retroshare-service/src/retroshare-service.cc b/retroshare-service/src/retroshare-service.cc index 79382e827..bceddf983 100644 --- a/retroshare-service/src/retroshare-service.cc +++ b/retroshare-service/src/retroshare-service.cc @@ -124,10 +124,10 @@ int main(int argc, char* argv[]) std::string prefUserString; RsConfigOptions conf; - std::string webui_base_directory = RsWebUI::DEFAULT_BASE_DIRECTORY; + std::string webui_base_directory = RsWebUi::DEFAULT_BASE_DIRECTORY; #ifdef RS_JSONAPI - conf.jsonApiPort = RsJsonAPI::DEFAULT_PORT; // enable JSonAPI by default + conf.jsonApiPort = RsJsonApi::DEFAULT_PORT; // enable JSonAPI by default #endif argstream as(argc,argv); @@ -154,7 +154,7 @@ int main(int argc, char* argv[]) "[node Id] Selected account to use and asks for passphrase" ". Use \"-U list\" in order to list available accounts.", false ); -#endif +#endif // def RS_SERVICE_TERMINAL_LOGIN #ifdef RS_JSONAPI as >> parameter( 'J', "jsonApiPort", conf.jsonApiPort, "TCP Port", @@ -162,7 +162,7 @@ int main(int argc, char* argv[]) >> parameter( 'P', "jsonApiBindAddress", conf.jsonApiBindAddress, "TCP bind address", "JSON API Bind Address default " "127.0.0.1.", false ); -#endif +#endif // def RS_JSONAPI #if (defined(RS_JSONAPI) || defined(RS_WEBUI)) && defined(RS_SERVICE_TERMINAL_WEBUI_PASSWORD) bool askWebUiPassword = false; @@ -218,7 +218,6 @@ int main(int argc, char* argv[]) conf.main_executable_path = argv[0]; int initResult = RsInit::InitRetroShare(conf); - if(initResult != RS_INIT_OK) { RsErr() << "Retroshare core initalization failed with: " << initResult diff --git a/retroshare.pri b/retroshare.pri index 73a1ebe3a..d140f9867 100644 --- a/retroshare.pri +++ b/retroshare.pri @@ -68,27 +68,6 @@ retroshare_qml_app:CONFIG -= no_retroshare_qml_app CONFIG *= retroshare_service no_retroshare_service:CONFIG -= retroshare_service -# To enable libresapi (deprecated) append the following assignation to qmake command line -# "CONFIG+=libresapi" -CONFIG+=no_libresapi -libresapi:CONFIG -= no_libresapi - -# To enable libresapi via local socket (unix domain socket or windows named -# pipes) append the following assignation to qmake command line -# "CONFIG+=libresapilocalserver" -CONFIG *= no_libresapilocalserver -libresapilocalserver:CONFIG -= no_libresapilocalserver - -# To enable libresapi settings handler in libresapi append the following -# assignation to qmake command line "CONFIG+=libresapi_settings" -CONFIG *= no_libresapi_settings -libresapi_settings:CONFIG -= no_libresapi_settings - -# To enable libresapi via HTTP (based on libmicrohttpd) append the following -# assignation to qmake command line "CONFIG+=libresapihttpserver" -CONFIG *= no_libresapihttpserver -libresapihttpserver:CONFIG -= no_libresapihttpserver - # To disable SQLCipher support append the following assignation to qmake # command line "CONFIG+=no_sqlcipher" CONFIG *= sqlcipher @@ -554,21 +533,6 @@ to contain the path to an host executable jsonapi-generator") DEFINES *= RS_JSONAPI } -libresapilocalserver { - warning("QMAKE: you have enabled libresapilocalserver which is deprecated") - DEFINES *= LIBRESAPI_LOCAL_SERVER -} - -libresapi_settings { - warning("QMAKE: you have enabled libresapi_settings which is deprecated") - DEFINES *= LIBRESAPI_SETTINGS -} - -libresapihttpserver { - warning("QMAKE: you have enabled libresapihttpserver which is deprecated") - DEFINES *= ENABLE_WEBUI -} - retroshare_nogui { warning("QMAKE: you have enabled retroshare_nogui which is deprecated") }