Cover Image

Websocket in Python
Juni 14, 2022 - Lesezeit: 10 Minuten

Wenn man mit dem Symolo Server kommunizieren will, ist nicht einfacher als mit einem Websocket darauf zuzugreifen. Das Protokoll ist einfach und lässt sich schnell umsetzten. Keine kompizierten XML Querys oder umfangreiche Anmeldung ist erforderlich. Lediglich ein Autentifizierungstoken muss vorliegen und kann im Vorfeld angefragt werden. Oder, wenn es komplizierter sein soll, kann man auch eine Sitzung anfordern und ist da sogar mit einer Benutzerkennung unterwegs. Mithilfe dieses Verfahrens lassen sich kleinere Anforderungen schnell umsetzten und der Websocket ist inzwischen in den meisten höheren Programmiersprachen Out-of-the-Box verfügbar. Zumindest in den Programmiersprachen in denen Symolo am meisten unterwegs ist. Inzwischen gehört auch Python dazu, da getreu dem Motto, "the right tool for the job", Python bestimmte Aufgaben deutlich eleganter oder effektiver erledigen kann als eine andere höhere Programmiersprache.

Um nun mit dem Symoloserver in Kontakt zu treten ist lediglich das websocket-client paket erforderlich.

from websocket import create_connection # pip install websocket-client

Um die Kommunikation zu vereinfachen können wir noch die JSON Bibliothek importieren, die unser Nachrichtenerstellen nochmal vereinfacht.

import json

Nun ist es uns zum Beispiel möglich ein einfaches Dateihochladen zu realisieren:

ws = create_connection("<myWebsocketEndpoint>")
ws.send(json.dumps({
    "sid": "<mySecretCode>",
    "cmd": "dsf.cmd.verwaltung.FileManager.WriteFileBase64",
    "par": [
        '<myFilename>',
        '<myBase64Data>'
    ]
}))
ws.close()

Damit kann nun eine Datei im Server hinterlegt werden. Wir verzichten hier auf die Auswertung der Antwort, weil diese hier nicht relevant ist. Wenn das schief geht, kann das im Serverlog eingesehen werden.

Natürlich kann man den Server auch nach Informationen fragen und bekommt sogar Antwort. Auch hier ist das Protokoll einfach gehalten:

ws = create_connection("<myWebsocketEndpoint>")

ws.send(json.dumps({
    "sid": "<mySecretCode>",
    "cmd": "dsf.server.Info.GetInstanceName",
    "par": []
}))

result = ws.recv()

print(result)

ws.close()

Hier ist die Interpretation der Antwort von der Frage abhängig, der Server versucht immer den einfachsten Datentypen zu senden. Kompliziertere Strukturen werden in JSON abgebildet. Das lässt sich in Python aber auch wieder einfach laden:

data = json.loads(result)

Mithilfe dieser Werkzeuge wird die Kommunikation mit dem Symoloserver einfach möglich und sämtliche Funktionen des Servers können nun verwendet werden. Hierzu zählen z.B. dynamicszugriff via SQL, erstellen und drucken von PDFs unter Windows wie Linux, Zugriff auf verschiedenste objektrelationale Datenbanken, Dateiverwaltung oder Nachrichtenverteilsystem. Darüber sollte ich mal was schreiben.

Nachdem das jetzt geklärt ist, bin ich mal gespannt, was in Python damit alles angestellt wird.

Kategorien

Navigation

Tags