KSGNetwork/KSGNetwork/EditorClient.h

#pragma once

#include "../Include/KSGNetwork.h"
#include <Critical.h>

namespace KSGClient
{
    // Wird verwendet um Karten für Spiele zu erstellen
    //  Kann nur von eingeloggten Clients verwendet werden
    class EditorClient : public EditorServerClient
    {
    private:
        int ref;
        Framework::Text ip;
        unsigned short port;
        int cId;
        Network::Klient *k;
        char *key;
        unsigned char keyLen;
        Framework::Critical cs;
        Framework::Text err;

    public:
        // Konstruktor
        EditorClient( int klientId, unsigned short port, char *ip, char *key, unsigned char keyLen );
        // Destruktor
        ~EditorClient();
        // verbindet sich mit dem zugewiesenen Editor Server
        //  Gibt 1 zurück, falls der Vorgang erfolgreich ist, 0 sonnst
        bool verbinde() override;
        // Erstellt eine neue Karte
        //  name: Der Name der Karte
        //  spielArt: Die Id des Spiels
        //  Gibt 1 zurück, falls der Vorgang erfolgreich ist, 0 sonnst
        bool karteErstellen( char *name, int spielArt ) override;
        // lädt eine bestimmte Karte
        //  id: Die Id der Karte
        //  Gibt 1 zurück, falls der Vorgang erfolgreich ist, 0 sonnst
        bool ladeKarte( int id ) override;
        // gibt eine Liste mit Abbildern der geladenen Karte zurück
        //  name: Enthält nach erfolgreichem Aufruf eine Liste mit Namen der Abbilder
        //  datum: Enthält nach erfolgreichem Aufruf eine Liste mit dem Datum der Erstellung für jedes Abbild
        //  Gibt die Anzahl der Abbilder zurück
        int getAbbildListe( Framework::RCArray< Framework::Text > *name, Framework::RCArray< Framework::Zeit > *datum ) override;
        // Erstellt ein neues Abbild der geladenen Karte
        //  name: Der Name des Abbildes
        //  Gibt 1 zurück, falls der Vorgang erfolgreich ist, 0 sonnst
        bool abbildErstellen( char *name ) override;
        // Löscht ein altes Abbild der geladenen Karte
        //  name: Der Name des Abbildes
        //  Gibt 1 zurück, falls der Vorgang erfolgreich ist, 0 sonnst
        bool abbildLöschen( char *name ) override;
        // Stellt ein altes Abbild der geladenen Karte wieder her
        //  name: Der Name des Abbildes
        //  Gibt 1 zurück, falls der Vorgang erfolgreich ist, 0 sonnst
        bool abbildHerstellen( char *name ) override;
        // Verüffentlich eine neue Version der geladenen Karte
        //  Gibt 1 zurück, falls der Vorgang erfolgreich ist, 0 sonnst
        bool veröffentlichen() override;
        // Veröffentlich eine neue Version der Shop Seite der geladenen Karte
        //  Gibt 1 zurück, falls der Vorgang erfolgreich ist, 0 sonnst
        bool shopSeiteVeröffentlichen() override;
        // Läht die Vorschau der Shop Seite der geladenen Karte herrunter und speichert sie unter data/tmp/ke/ssv
        //  Gibt 1 zurück, falls der Vorgang erfolgreich ist, 0 sonnst
        bool ladeShopSeiteVorschau() override;
        // Erstellt eine neue Shop Seiten Datei
        //  name: Der Name der Datei
        //  typ: 0=Ordner, 1=Bild, 2=Text
        //  Gibt 1 zurück, falls der Vorgang erfolgreich ist, 0 sonnst
        bool ssDateiErstellen( char *name, int typ ) override;
        // Öffnet einen Ordner der Shop Seite
        //  name: Der Name des Ordners
        //  Gibt 1 zurück, falls der Vorgang erfolgreich ist, 0 sonnst
        bool ssOrdnerÖffnen( char *name ) override;
        // Lädt das ein Bild der Shop Seite und gibt es zurück
        //  datei: Der Name der Bilddatei
        //  bild: Der Name des Bildes
        //  Gibt bei misserfolg 0 zurück
        Framework::Bild *ssBildLaden( char *datei, char *bild ) override;
        // Löscht eine Datei der Shop Seite
        //  name: Der Name der Datei
        //  Gibt 1 zurück, falls der Vorgang erfolgreich ist, 0 sonnst
        bool ssDateiLöschen( char *name ) override;
        // Läd eine KSGS Datei der Shop Seite und gibt den Quellcode zurück
        //  datei: Der Name der Datei
        //  Gibt bei misserfolg 0 zurück
        Framework::Text *ssTextLaden( char *datei ) override;
        // Spechert eine KSGS Datei der Shop Seite
        //  datei: Der Name der Datei
        //  zText: Ein Zeiger auf den neuen Quellcode (ohne erhöhten Reference Counter)
        //  Gibt 1 zurück, falls der Vorgang erfolgreich ist, 0 sonnst
        bool ssTextSpeichern( char *datei, Framework::Text *zText ) override;
        // Löscht ein Bild der Shop Seite
        //  datei: Der Name der Bilddatei
        //  bild: Der Name des Bildes
        //  Gibt 1 zurück, falls der Vorgang erfolgreich ist, 0 sonnst
        bool ssBildLöschen( char *datei, char *bild ) override;
        // Speichert ein Bild einer ShopSeite
        //  datei: Der name der Bilddatei
        //  name: Der Name des Bildes
        //  zBild: Ein Zeiger auf das Bild (ohne erhöhten Reference Counter)
        //  Gibt 1 zurück, falls der Vorgang erfolgreich ist, 0 sonnst
        bool ssBildSpeichern( char *datei, char *name, Framework::Bild *zBild ) override;
        // Lädt eine Liste mit Dateien von der Shop Seite
        //  zList: Enthält nach erfolgreichem Aufruf die Liste mit Dateinamen
        //  Gibt 1 zurück, falls der Vorgang erfolgreich ist, 0 sonnst
        int ssGetDateiListe( Framework::RCArray< Framework::Text > *zList ) override;
        // Lädt die Bild Liste einer Bild Datei der Shop Seite
        //  name: Der Name der Bilddatei
        //  zList: Enthält nach erfolgreichem Aufruf eine Liste mit Bildnamen
        //  Gibt 1 zurück, falls der Vorgang erfolgreich ist, 0 sonnst
        int ssGetBildListe( char *name, Framework::RCArray< Framework::Text > *zList ) override;
        // Lädt die Shop Daten
        //  es: Enthält nach erfolgreichem aufruf den Erwerbbarkeits Status (0 = nichts, 1 = nur Testversion, 2 = nur Vollversion, 3 = beides)
        //  tp: Enthält nach erfolgreichem Aufruf den Preis der Testversion in Kupfer
        //  vp: Enthält nach erfolgreichem Aufruf den Preis der Vollversion in Kupfer
        //  Gibt 1 zurück, falls der Vorgang erfolgreich ist, 0 sonnst
        bool getShopDaten( int &es, int &tp, int &vp ) override;
        // Setzt die Shop Daten
        //  es: der Erwerbbarkeits Status (0 = nichts, 1 = nur Testversion, 2 = nur Vollversion, 3 = beides)
        //  tp: der Preis der Testversion in Kupfer
        //  vp: der Preis der Vollversion in Kupfer
        //  Gibt 1 zurück, falls der Vorgang erfolgreich ist, 0 sonnst
        bool setShopDaten( int es, int tp, int vp ) override;
        // gibt die Kartenbeschreibung als KSGScript Quellcode zurück
        //  Gibt bei misserfolg 0 zurück
        Framework::Text *beschreibungLaden() override;
        // gibt das Titelbild der Karte zurück
        //  Gibt bei misserfolg 0 zurück
        Framework::Bild *titelbildLaden() override;
        // gibt das Minimap Bild der Karte zurück
        //  Gibt bei misserfolg 0 zurück
        Framework::Bild *minimapLaden() override;
        // gibt das Ladebild der Karte zurück
        //  Gibt bei misserfolg 0 zurück
        Framework::Bild *ladebildLaden() override;
        // speichert den KSGScript Quellcode der Kartenbeschreibung
        //  zText: Der KSGScript Quellcode (ohne erhöhten reference Counter)
        //  Gibt 1 zurück, falls der Vorgang erfolgreich ist, 0 sonnst
        bool beschreibungSpeichern( Framework::Text *zText ) override;
        // speichert das Titelbild der Karte
        //  zBild: das neue Titelbild
        //  Gibt 1 zurück, falls der Vorgang erfolgreich ist, 0 sonnst
        bool titelbildSpeichern( Framework::Bild *zBild ) override;
        // speichert das Minimapbild der Karte
        //  zBild: das neue Minimapbild
        //  Gibt 1 zurück, falls der Vorgang erfolgreich ist, 0 sonnst
        bool minimapSpeichern( Framework::Bild *zBild ) override;
        // speichert das Ladebild der Karte
        //  zBild: das neue Ladebild
        //  Gibt 1 zurück, falls der Vorgang erfolgreich ist, 0 sonnst
        bool ladebildSpeichern( Framework::Bild *zBild ) override;
        // lädt die Spieler Team Daten der Karte
        //  sts: Enthält nach erfolgreichem Aufruf die Spieler Team Daten
        //  Gibt 1 zurück, falls der Vorgang erfolgreich ist, 0 sonnst
        bool ladeTeamDaten( SpielerTeamStrukturV *sts ) override;
        // speichert die Team Daten
        //  sts: die neuen Spieler Team Daten
        //  Gibt 1 zurück, falls der Vorgang erfolgreich ist, 0 sonnst
        bool speicherTeamDaten( SpielerTeamStrukturV *sts ) override;
        // Erstellt neue Datei im Datei Editor
        //  typ: 0=ordner 1=bild 2=modell2d 3=sound
        //  Gibt 1 zurück, falls der Vorgang erfolgreich ist, 0 sonnst
        bool deNeueDatei( char typ, Framework::Text *zName ) override;
        // Öffnet Ordner im Datei Editor
        //  zName: Der Name des Ordners
        //  Gibt 1 zurück, falls der Vorgang erfolgreich ist, 0 sonnst
        bool deOrdnerÖffnen( Framework::Text *zName ) override;
        // Gibt ein Bild aus dem Datei Editor zurück
        //  zDatei: Der Name der Datei (ohne erhöhten Reference Counter)
        //  zBild: Der Name des Bildes (ohne erhöhten Reference Counter)
        //  zF: Ein Fortschrittsbalken, der automatisch aktualisiert wird (ohne erhöhten Reference Counter)
        //  Gibt bei misserfolg 0 zurück
        Framework::Bild *deBildLaden( Framework::Text *zDatei, Framework::Text *zBild, Framework::FBalken *zF ) override;
        // Löscht eine Datei aus dem Datei Editor
        //  zName: Der Name der Datei
        //  Gibt 1 zurück, falls der Vorgang erfolgreich ist, 0 sonnst
        bool deDateiLöschen( Framework::Text *zName ) override;
        // Löscht Bild aus Datei im Datei Editor
        //  zDatei: Der Name der Bilddatei (ohne erhöhten Reference Counter)
        //  zBild: Der Name des Bildes (ohne erhöhten Reference Counter)
        //  Gibt 1 zurück, falls der Vorgang erfolgreich ist, 0 sonnst
        bool deBildLöschen( Framework::Text *zDatei, Framework::Text *zBild ) override;
        // Speichert Bild in Datei im Datei Editor
        //  zDatei: Der Name der Bilddatei (ohne erhöhten Reference Counter)
        //  zName: Der Name des Bildes (ohne erhöhten Reference Counter)
        //  zBild: Das neue Bild (ohne erhöhten Reference Counter)
        //  zF: Ein Fortschrittsbalken, der automatisch aktualisiert wird (ohne erhöhten Reference Counter)
        //  Gibt 1 zurück, falls der Vorgang erfolgreich ist, 0 sonnst
        bool deBildSpeichern( Framework::Text *zDatei, Framework::Text *zName, Framework::Bild *zBild, Framework::FBalken *zF ) override;
        // Lädt eine Liste mit Dateien im aktuellen Ordner des Datei Editors
        //  zNamen: Enthält nach erfolgreichem Aufruf eine Liste mit Dateinamen (ohne erhöhten Reference Counter)
        //  Gibt die Anzahl der Dateien zurück
        int deGetDateiListe( Framework::RCArray< Framework::Text > *zNamen ) override;
        // Lädt eine Liste mit Bildern aus einer Bilddatei des Datei Editors
        //  zNamen: Enthält nach erfolgreichem Aufruf eine Liste mit den Bildnamen (ohne erhöhten Reference Counter)
        //  Gibt die Anzahl der Bilder zurück
        int deGetBildListe( Framework::Text *zDatei, Framework::RCArray< Framework::Text > *zNamen ) override;
        // Lädt eine Liste mit 2D Modellen aus einer Modeldatei im Datei Editor
        //  zDatei: Der Name der Modeldatei (ohne erhöhten Reference Counter)
        //  zNamen: Enthält nach erfolgreichem Aufruf eine Liste mit den Modelnamen (ohne erhöhten Reference Counter)
        //  Gibt die Anzahl der Modelle zurück
        int deGetModelListe( Framework::Text *zDatei, Framework::RCArray< Framework::Text > *zNamen ) override;
        // Lädt eine Liste mit Sounds aus einer Sounddatei im Datei Editor
        //  zDatei: Der Name der Sounddatei (ohne erhöhten Reference Counter)
        //  zNamen: Enthält nach erfolgreichem Aufruf eine Liste mit den Soundnamen (ohne erhöhten Reference Counter)
        //  Gibt die Anzahl der Sounds zurück
        int deGetSoundListe( Framework::Text *zDatei, Framework::RCArray<  Framework::Text > *zNamen ) override;
        // Löscht ein Model aus einer Modeldatei des Datei Editors
        //  zDatei: Der Name der Modeldatei (ohne erhöhten Reference Counter)
        //  zModel: Der Name des Models (ohne erhöhten Reference Counter)
        //  Gibt 1 zurück, falls der Vorgang erfolgreich ist, 0 sonnst
        bool deModelLöschen( Framework::Text *zDatei, Framework::Text *zModel ) override;
        // Löscht einen Sound aus einer Sounddatei des Datei Editors
        //  zDatei: Der Name der Sounddatei (ohne erhöhten Reference Counter)
        //  zSound: Der Name des Sounds (ohne erhöhten Reference Counter)
        //  Gibt 1 zurück, falls der Vorgang erfolgreich ist, 0 sonnst
        bool deSoundLöschen( Framework::Text *zDatei, Framework::Text *zSound ) override;
        // Lädt ein Model aus einer Modeldatei des Datei Editors
        //  zDatei: Der Name der Modeldatei (ohne erhöhten Reference Counter)
        //  zModel: Enthält nach erfolgreichem Aufruf das Model (ohne erhöhten Reference Counter)
        //  zF: Ein Fortschrittsbalken, der automatisch aktualisiert wird (ohne erhöhten Reference Counter)
        //  Gibt 1 zurück, falls der Vorgang erfolgreich ist, 0 sonnst
        Framework::Model2DData *deModelLaden( Framework::Text *zDatei, Framework::Text *zModel, Framework::FBalken *zF ) override;
        // Lädt einen Sound herunter und gibt ihn zurück
        //  file: Ein Zeiger auf die GSLDatei, in der der Sound gespeichert werden soll
        //  zDatei: Der Name der Sounddatei (ohne erhöhten Reference Counter)
        //  zSound: Der Name des Sounds (ohne erhöhten Reference Counter)
        //  zF: Ein Fortschrittsbalken, der automatisch aktualisiert wird (ohne erhöhten Reference Counter)
        //  Gibt bei misserfolg 0 zurück
        GSL::GSLSoundV *deSoundLaden( GSL::GSLDateiV *file, Framework::Text *zDatei, Framework::Text *zSound, Framework::FBalken *zF ) override;
        // Speichert ein Model in eine Modeldatei des Datei Editors
        //  zDatei: Der Name der Modeldatei (ohne erhöhten Reference Counter)
        //  zModel: Der Name des Models (ohne erhöhten Reference Counter)
        //  zData: Die Daten des Models (ohne erhöhten Reference Counter)
        //  zF: Ein Fortschrittsbalken, der automatisch aktualisiert wird (ohne erhöhten Reference Counter)
        //  Gibt 1 zurück, falls der Vorgang erfolgreich ist, 0 sonnst
        bool deModelSpeichern( Framework::Text *zDatei, Framework::Text *zModel, Framework::Model2DData *zData, Framework::FBalken *zF ) override;
        // Speichert einen Sound in einer Sounddatei des Datei Editors
        //  zDatei: Der Name der Modeldatei (ohne erhöhten Reference Counter)
        //  zSound: Der Name des Sounds (ohne erhöhten Reference Counter)
        //  zData: Die Daten des Sounts (ohne erhöhten Reference Counter)
        //  zF: Ein Fortschrittsbalken, der automatisch aktualisiert wird (ohne erhöhten Reference Counter)
        //  Gibt 1 zurück, falls der Vorgang erfolgreich ist, 0 sonnst
        bool deSoundSpeichern( Framework::Text *zDatei, Framework::Text *zSound, GSL::GSLSoundV *zData, Framework::FBalken *zF ) override;
        // Lädt die Kauf Statistik der geladenen Karte
        //  verkauft: Enthält nach erfolgreichem Aurfuf eine Liste mit den Anzahlen der Käufe der Karte der letzten 30 Tage
        //  einkommen: Enthält nach erfolgreichem Aurfuf eine Liste mit den Anzahlen der verdinten Kupfer in den letzten 30 Tagen
        //  gespielt: Enthält nach erfolgreichem Aurfuf eine Liste mit den Anzahlen der Spielen der letzten 30 Tage
        //  Gibt 1 zurück, falls der Vorgang erfolgreich ist, 0 sonnst
        int getVerkaufStatistik( Framework::Array< int > *verkauft, Framework::Array< int > *einkommen, Framework::Array< int > *gespielt ) override;
        // Startet den Editor Modus, welcher für jedes Spiel unterschiedlich funktioniert
        //  Gibt 1 zurück, falls der Vorgang erfolgreich ist, 0 sonnst
        bool initEditor() override;
        // Erhält die Verbindung aufrecht
        //  Gibt 1 zurück, falls der Vorgang erfolgreich ist, 0 sonnst
        //  Sollte während einer bestehenden Verbindung etwa einmal alle 60 Sekunden aufgerufen werden, da sonst der Router die Verbindung automatisch trennt
        bool keepAlive() override;
        // Trennt die Verbindung zum Server
        //  Gibt 1 zurück, falls der Vorgang erfolgreich ist, 0 sonnst
        //  Sollte erst nach einem erfolgreichen Aufruf von verbinde aufgerufen werden
        bool trenne( bool abmelden ) override;
        // Gibt 1 zurück, falls der Client verbunden ist, 0 sonst
        bool istVerbunden() const override;
        // gibt den Letzten Fehlertext zuück
        //  sollte erst aufgerufen werden, nachdem eine andere aufgerufene Methode fehlgeschlagen ist
        char *getLetzterFehler() const override;
        // Erhöht den Reference Counter um 1 un gibt this zurück
        EditorServerClient *getThis() override;
        // Verringert den Reference Counter um 1 und gibt 0 zurück.
        //  Falls der Reference Counter nach dem Aufruf auf 0 ist löscht sich das Objekt selbst 
        EditorServerClient *release() override;
    };
}