Dokumentace třídy Httpd::ControllerServer

Vrací informace o serveru. ...

#include <controllerserver.h>

Diagram dědičnosti pro třídu Httpd::ControllerServer:

Veřejné metody
	ControllerServer (HobrasoftHttpd::HttpConnection *parent)
Veřejné metody dědí se z Httpd::AbstractController
	AbstractController (HobrasoftHttpd::HttpConnection *parent)
	Konstruktor.
virtual void	service (HobrasoftHttpd::HttpRequest *request, HobrasoftHttpd::HttpResponse *response)
	Obsluha požadavku.
void	setCheckId (bool x)
	Nastavuje kontrolu položky ID v datech při PUT a POST.
void	setAuthorizer (RequestAuthorizer *authorizer)
AuthenticatedUser *	authenticatedUser () const
bool	checkId () const
	Vrací stav kontroly položky ID v datech při PUT a POST.
Db::Database *	db ()

Chráněné metody
void	serviceIdGet (HobrasoftHttpd::HttpRequest *request, HobrasoftHttpd::HttpResponse *response, const QString &id) Q_DECL_OVERRIDE
	Pošle odpověď na požadavek konkrétního ID metodou GET.
void	serviceIdPut (HobrasoftHttpd::HttpRequest *request, HobrasoftHttpd::HttpResponse *response, const QVariantMap &data) Q_DECL_OVERRIDE
	Pošle odpověď na požadavek konkrétního ID metodou PUT - obvykle vloží nový objekt nebo přepíše existující objekt.
void	serviceIdPost (HobrasoftHttpd::HttpRequest *request, HobrasoftHttpd::HttpResponse *response, const QVariantMap &data) Q_DECL_OVERRIDE
	Pošle odpověď na požadavek konkrétního ID metodou PUT - obvykle vloží nový objekt nebo přepíše existující objekt.
Chráněné metody dědí se z Httpd::AbstractController
virtual bool	exists (const QString &id)
	Kontrola existence zadaného ID.
virtual bool	exists (HobrasoftHttpd::HttpRequest *request, const QString &id)
	Kontrola existence zadaného ID.
virtual void	serviceOK (HobrasoftHttpd::HttpRequest *request, HobrasoftHttpd::HttpResponse *response, const QVariant &data=QVariant())
	Pošle odpověď 200 OK.
virtual void	serviceError (HobrasoftHttpd::HttpRequest *request, HobrasoftHttpd::HttpResponse *response, int code, const QString &error, const QVariantMap &data)
	Pošle chybovou odpověď
virtual void	serviceList (HobrasoftHttpd::HttpRequest *request, HobrasoftHttpd::HttpResponse *response)
	Měl by poslat v odpovědi kompletní seznam všech objektů ve třídě a ukončit se.
virtual void	serviceEvents (HobrasoftHttpd::HttpRequest *request, HobrasoftHttpd::HttpResponse *response)
	Pošle v odpovědi kompletní seznam všech objektů ve třídě a následně
virtual void	serviceIdEvents (HobrasoftHttpd::HttpRequest *request, HobrasoftHttpd::HttpResponse *response, const QString &id)
	Pošle v odpovědi proud událostí spojených se všemi objekty ve třídě
virtual void	serviceIdDelete (HobrasoftHttpd::HttpRequest *request, HobrasoftHttpd::HttpResponse *response, const QString &id)
	Pošle odpověď na požadavek konkrétního ID metodou DELETE - obvykle objekt smaže.
virtual void	serviceEvent (HobrasoftHttpd::HttpRequest *request, HobrasoftHttpd::HttpResponse *response, const QVariant &data)
	Pošle do otevřeného proudu událostí jednu událost.
virtual bool	isAuthorized (Security::Permissions::Permission)
HobrasoftHttpd::HttpRequest *	request () const
	Vrací ukazatel na aktuální request.
HobrasoftHttpd::HttpConnection *	connection () const
	Vrací ukazatel na aktuální connection.

Privátní metody
QVariantList	objects (const QObject *object, int dept=0)

Další zděděné členy
Statické chráněné metody dědí se z Httpd::AbstractController
static QVariantMap	putKey (const QVariant &key)

Detailní popis

Vrací informace o serveru.

GET /server/about

Vrací informace o serveru

{
  "configfile": "/home/tycho/.timesheet-server.conf",               // Cesta k použitému konfiguračnímu souboru
  "name":       "Hobrasoft",                                        // Krátké jméno serveru
  "description": "Pokusný server pro vývoj pracovních výkazů",      // Podrobnější popis serveru
  "git_branch": "master",                                           // Použitá větev GITu, nastavuje se při překladu
  "git_commit": "7dfd959",                                          // Použitý commit GITu, nastavuje se při překladu
  "version":    "1.0.0"                                             // Verze, bere se z version.h
}

GET /server/configfile

Vrací obsah konfiguračního souboru, hesla (položka password) jsou zamaskovaná:

{
  "config": "[db]\nplugin   = postgres\nname     = timesheets\nserver   = hrabos.hobrasoft.cz\nport     = 5432\nuser     = tycho\npassword = ***\n\n[httpd]\nthreads = false\n\n[server]\nname = Hobrasoft\ndescription = Pokusný server pro vývoj pracovních výkazů\n\n[log]\nall = true\n\n",
  "configfile": "/home/tycho/.timesheet-server.conf"
}

GET /server/restart?reallyrestart=YES

Restartuje server. Závisí na položce "server/enable-remote-restart" v konfiguračním souboru. Ve skutečnosti se server nerestartuje, ale ukončí. O opětovné nastartování by se měl postarat systemd.

Vrací jednoduchou informaci, že požadavek byl přijat. Pokud není restartovaní umožněno, vrací chybu 405.

{
    "ok": true;
}

GET /server/objects

Vypíše objekty v paměti, pouze pro ladění serveru.

[
  {
    "address": 94788673941232,
    "children": [],
    "class": "MSettings",
    "name": "unnamed"
  },
  {
    "address": 94788673967808,
    "children": [],
    "class": "Logger",
    "name": "unnamed"
  },
  {
    "address": 94788673960384,
    "children": [
      {
        "address": 94788673966688,
        "children": [],
        "class": "Db::Plugins::DatabasePluginPostgres",
        "name": "DatabasePluginPostgres"
      }
    ],
    "class": "Db::Database",
    "name": "Database 94788673922752"
  },
  {
    "address": 94788674023968,
    "children": [],
    "class": "Security::Guard",
    "name": "unnamed"
  },
  {
    "address": 94788674024368,
    "children": [],
    "class": "HobrasoftHttpd::HttpSettings",
    "name": "unnamed"
  },
  {
    "address": 94788674028784,
    "children": [],
    "class": "MyThread",
    "name": "threadHttpServer"
  }
]

Definice je uvedena na řádku 120 v souboru controllerserver.h.

Dokumentace konstruktoru a destruktoru

ControllerServer()

ControllerServer::ControllerServer

(

HobrasoftHttpd::HttpConnection *

parent

)

Definice je uvedena na řádku 22 v souboru controllerserver.cpp.

                                                                       : AbstractController(parent) {
}

Dokumentace členských funkcí

objects()

QVariantList ControllerServer::objects ( const QObject * object, int dept = 0 )

private

Definice je uvedena na řádku 94 v souboru controllerserver.cpp.

                                                                       {
    QVariantList data;
    if (depth > 10) {
        return data;
        }
    QObjectList list = object->children();
    for (int i=0; i<list.size(); i++) {
        const QObject *x = list[i];
        QVariantMap objectdata;
        objectdata["address"]  = (quint64)x;
        objectdata["name"]     = x->objectName().isEmpty() ? "unnamed" : x->objectName();
        objectdata["class"]    = x->metaObject()->className();
        objectdata["children"] = objects(x, depth+1);
        data << objectdata;
        }
    return data;
}

serviceIdGet()

void ControllerServer::serviceIdGet ( HobrasoftHttpd::HttpRequest * request, HobrasoftHttpd::HttpResponse * response, const QString & id )

protectedvirtual

Pošle odpověď na požadavek konkrétního ID metodou GET.

Defaultní implementace posílá chybu 501 Not Implemented

Reimplementuje stejnojmenný prvek z Httpd::AbstractController.

Definice je uvedena na řádku 25 v souboru controllerserver.cpp.

                                                                                                                                {
 
    if (id == "about") {
        AUTHORIZEREQUEST(Security::Permissions::Server);
 
        QList<Dbt::ServerInfo> list = db()->serverInfo();
        QString serverName        = (list.isEmpty()) ? MSETTINGS->serverName()        : list.first().name;
        QString serverDescription = (list.isEmpty()) ? MSETTINGS->serverDescription() : list.first().description;
 
        QVariantMap data;
        data["configfile"]  = MSETTINGS->fileName();
        data["name"]        = serverName;
        data["description"] = serverDescription;
        data["git_commit"]  = GIT_COMMIT;
        data["git_branch"]  = GIT_BRANCH;
        data["version"]     = VERSION;
        data["qt_version"]  = qtVersion();
        serviceOK(request, response, data);
        return;
        }
 
    if (id == "configfile") {
        AUTHORIZEREQUEST(Security::Permissions::ServerConfigFile);
        QString configstring;
        QString configfile = MSETTINGS->fileName();
        QFile file(configfile);
        if (file.open(QIODevice::ReadOnly)) {
            configstring = QString::fromUtf8(file.readAll());
            configstring = configstring.replace(QRegExp("password\\s*=[^\\n]*\\n"), "password = ***\n");
            file.close();
            }
        QVariantMap data;
        data["configfile"]  = MSETTINGS->fileName();
        data["config"]      = configstring;
        serviceOK(request, response, data);
        return;
        }
 
    if (id == "restart") {
        // AUTHORIZEREQUEST(Security::Permissions::ServerRestart);
        QVariantMap data;
        PDEBUG << "restart :-)))";
        if (request->parameter("reallyrestart") == "YES" && MSETTINGS->serverEnableRemoteRestart()) {
            // nelze volat přímo, je v jiném vláknu
            QTimer::singleShot(100, TimesheetServer::instance(), &TimesheetServer::restart);
            QVariantMap data;
            data["ok"] = true;
            PDEBUG << "restarting";
            serviceOK(request, response, data);
            return;
          } else {
            PDEBUG << "restart disabled";
            serviceError(request, response, 405, "bad-request", "Could not restart server");
            return;
            }
        PDEBUG << "a doprdele....";
        return;
        }
 
    if (id == "objects") {
        serviceOK(request, response, objects(TimesheetServer::instance()));
        return;
        }
 
    serviceError(request, response, 404, "not-found", "Not found");
 
}

serviceIdPost()

void ControllerServer::serviceIdPost ( HobrasoftHttpd::HttpRequest * request, HobrasoftHttpd::HttpResponse * response, const QVariantMap & data )

protectedvirtual

Pošle odpověď na požadavek konkrétního ID metodou PUT - obvykle vloží nový objekt nebo přepíše existující objekt.

Defaultní implementace posílá chybu 501 Not Implemented

Reimplementuje stejnojmenný prvek z Httpd::AbstractController.

Definice je uvedena na řádku 118 v souboru controllerserver.cpp.

                                                                                                                                      {
    serviceIdPut(request, response, data);
}

serviceIdPut()

void ControllerServer::serviceIdPut ( HobrasoftHttpd::HttpRequest * request, HobrasoftHttpd::HttpResponse * response, const QVariantMap & data )

protectedvirtual

Pošle odpověď na požadavek konkrétního ID metodou PUT - obvykle vloží nový objekt nebo přepíše existující objekt.

Defaultní implementace posílá chybu 501 Not Implemented

Reimplementuje stejnojmenný prvek z Httpd::AbstractController.

Definice je uvedena na řádku 113 v souboru controllerserver.cpp.

                                                                                                                                     {
    serviceOK(request, response, putKey(db()->save(Dbt::ServerInfo::fromMap(data))));
}

---

Dokumentace pro tuto třídu byla vygenerována z následujících souborů:

• httpd/controllerserver.h
• httpd/controllerserver.cpp