RestConsole/de

From OpenSimulator

Revision as of 06:12, 16 April 2016 by Manni (Talk | contribs)

Jump to: navigation, search
Languages Languages: 

En.png English   De.png Deutsch   Jp.png 日本語

Contents

Über

Die REST-Konsole macht Remote-Administration der verschiedenen Open Dienste möglich.

Die Schnittstelle ermöglicht Befehle an den Server und Abrufen von Befehlsausgabe zu senden. Senden und Empfangen von Daten über RESTful HTTP-Aufrufe erfolgen.

Während das Senden sehr einfach ist, wird nicht mit. Empfangen verwendet HTTP-Reverse, eine lange Umfrage zu einer CAPS URI durchführen.

Um das Protokoll effizienter zu gestalten, die Hilfefunktion zu machen wurde auf der Client-Seite geschoben. Anstatt jeden Tastendruck an den Server senden, werden nur validierte Befehlszeilen gesendet. Um dies möglich zu machen, sendet der Server eine Burst-on-Connect von Daten, die der Baum der erlaubten Befehle und deren Hilfeinformationen. Dies kann durch den Kunden verwendet werden, um die "Hilfe" Befehlsausgabe sowohl lokal als auch zu schaffen als Kommandozeilen-Hilfe interaktiv zur Verfügung stellen.

Die Probe Konsolen-Client, OpenSim.ConsoleClient.exe, zeigt, wie das gemacht wird.

Verwendung

Um die Remote - Konsole zu verwenden, starten Sie Open Dienste mit dem Parameter -console rest.

Beispiel für Robust-Server im Grid-Modus: 

mono Robust.exe -console rest

Beispiel für Simulatoren (sowohl im Grid und Standalone-Modus): 

mono OpenSim.exe -console rest

Syntax

Wir nehmen den Opensimulator Dienstleistungsadresse http://foo.bar:8002 als Beispiel.

Zunächst eine neue Sitzung starten, indem Sie eine HTTP-POST-Anforderung senden. Benutzername und Passwort sollten Sie die Einstellungen für ConsoleUser und ConsolePass im Abschnitt [Network] der OpenSim.ini.
Parameter: USER, PASS 

http://foo.bar:8002/StartSession/

Rückgabe: (XML) <ConsoleSession><SessionID></SessionID><Prompt></Prompt></ConsoleSession>

Jetzt haben wir die SessionID, die verwendet werden können, um einen Befehl zu senden und Ausgang zu empfangen. Zuerst wird der Puffer Rückholung Konsole abrufen.
Parameter: keine 

http://foo.bar:8002/ReadResponses/<SessionID>/

Rückgabe: (XML) <ConsoleSession><Line Number=x></Line></ConsoleSession>
Die Antwort enthält alle Linien derzeit im Puffer. Nachfolgende Abrufe werden nur neue Zeilen abzurufen. Die Abruf wird für bis zu 30 Sekunden lang gedrückt, wenn es keine Daten gibt, dann einen Fehler zurück. Der Kunde wird voraussichtlich wieder (Polling), um zu versuchen.

Verwenden Sie die Sitzungs-ID als Parameter, und senden Sie erneut eine POST-Anfrage. Parameter: ID, COMMAND 

http://foo.bar:8002/SessionCommand/

Rückgabe: (XML) <ConsoleSession><Result></Result></ConsoleSession>
Wenn alles gut gegangen ist, sollte der Befehl ausgeführt worden sind. Versuchen Sie einen anderen Befehl.

Wenn Sie die Verbindung zu schließen möchten, senden Sie erneut eine POST-Anfrage. Parameter: ID 

http://foo.bar:8002/CloseSession/

Rückgabe: (XML) <ConsoleSession><Result></Result></ConsoleSession>
Die Sitzung ist geschlossen, und Sie müssen sich erneut anmelden, wenn Sie wollen, erneut einen Befehl zu senden.

Beispiele

Python 

#!/usr/bin/python
# This piece of code is published by thomax (txOh) (c) 2010 under the
# Artistic License 1.0 (http://www.perlfoundation.org/artistic_license_1_0)

import urllib, urllib2
import xml.dom.minidom

class UserConsoleClient():

   def __init__(self, addr):
       self.addr = addr
       url = self.addr + 'StartSession/'

       params = urllib.urlencode({
           'USER': 'Test',         # REST username
           'PASS': 'secret'        # REST password
       })
       data = urllib2.urlopen(url, params).read()

       dom = xml.dom.minidom.parseString(data)
       elem =  dom.getElementsByTagName('SessionID')
       self.sessionid = elem[0].childNodes[0].nodeValue

   def close(self):
       url = self.addr + 'CloseSession/'
       params = urllib.urlencode({
           'ID': self.sessionid
       })
       print urllib2.urlopen(url, params).read()

   def do_cmd(self, cmd):
       url = self.addr + '/SessionCommand/'
       params = urllib.urlencode({
           'ID': self.sessionid,
           'COMMAND': cmd
       })
       print urllib2.urlopen(url, params).read()

   def read_buffer(self):
       url = self.addr + 'ReadResponses/' + self.sessionid + '/'
       params = urllib.urlencode({
           'ID': self.sessionid
       })

       print urllib2.urlopen(url, params).read()

# set the base url to the REST console (with port)
console = UserConsoleClient('http://127.0.0.1:8300/')
console.read_buffer()
print 'quit with a "."'
cmd = ""
while cmd != ".":
   if cmd != "":
       console.do_cmd(cmd)
       console.read_buffer()
   cmd = raw_input("> ")

console.close()

Python (Updated) 

#!/usr/bin/python
# This piece of code is published by thomax (txOh) (c) 2010 under the
# Artistic License 1.0 (http://www.perlfoundation.org/artistic_license_1_0)
# Modifications (c) 2013 BlueWall
 
import urllib, urllib2
import xml.dom.minidom
 
class UserConsoleClient():
 
   def __init__(self, addr):
       self.addr = addr
       url = self.addr + 'StartSession/'
 
       params = urllib.urlencode({
           'USER': 'username',       # REST username
           'PASS': 'userpass'        # REST password
       })
       data = urllib2.urlopen(url, params).read()
       print data
 
       dom = xml.dom.minidom.parseString(data)
       elem =  dom.getElementsByTagName('SessionID')
       self.sessionid = elem[0].childNodes[0].nodeValue
       elem = dom.getElementsByTagName('Prompt')
       self.prompt = elem[0].childNodes[0].nodeValue + '# '
 
   def close(self):
       url = self.addr + 'CloseSession/'
       params = urllib.urlencode({
           'ID': self.sessionid
       })
       print urllib2.urlopen(url, params).read()
 
   def do_cmd(self, cmd):
       url = self.addr + 'SessionCommand/'
       params = urllib.urlencode({
           'ID': self.sessionid,
           'COMMAND': cmd
       })
       data = urllib2.urlopen(url, params).read()
       dom = xml.dom.minidom.parseString(data)
       elem =  dom.getElementsByTagName('Result')
       return elem[0].childNodes[0].nodeValue
 
   def read_buffer(self):
       url = self.addr + 'ReadResponses/' + self.sessionid + '/'
       params = urllib.urlencode({
           'ID': self.sessionid
       })
 
       # print urllib2.urlopen(url, params).read()
 
       result = urllib2.urlopen(url, params).read()
       dom = xml.dom.minidom.parseString(result)
 
       elem =  dom.getElementsByTagName('Line')
       for line in elem:
         x0 = line.childNodes[0].nodeValue
         x1 = str.replace(str(x0),':','~',2)
         x2 = x1.split("~")
         for lv in x2[2:]:
           if not '+++' in lv:
             print lv
 
# set the base url to the REST console (with port)
console = UserConsoleClient('http://example.com:8003/')
console.read_buffer()
print 'quit with a "."'
cmd = ""
while cmd != ".":
   if cmd != "":
     if 'OK' in console.do_cmd(cmd):
       console.read_buffer()
   cmd = raw_input("%s " % console.prompt)
 
console.close()

JavaScript/HTML 

<html>
  <head>

    <!-- This JavaScript code is published by Marck (c) 2010 under a -->
    <!-- Creative Commons Attribution 3.0 Germany License            -->
    <!-- http://creativecommons.org/licenses/by/3.0/de/              -->
    <script type="text/javascript">

      var sessionId;
      var hostUrl;

      function StartSession(url, user, password) {
        hostUrl = url;
        var response = SendRequest("/StartSession/", "USER=" + user + "&PASS=" + password);
        sessionId = response.getElementsByTagName("SessionID")[0].firstChild.nodeValue;
      };

      function ReadResponses() {
        var response = this.SendRequest("/ReadResponses/" + sessionId + "/", '');
        var lines = response.getElementsByTagName("Line");
        for (var i = 0; i < lines.length; ++i) {
          var element = document.createElement("div");
          element.appendChild(document.createTextNode(lines[i].firstChild.nodeValue));
          document.getElementById("output").appendChild(element);
        };
        document.getElementById("output").scrollTop = document.getElementById("output").scrollHeight;
      };

      function Command(cmd) {
        void SendRequest("/SessionCommand/", "ID=" + sessionId + "&COMMAND=" + cmd);
      };

      function CloseSession() {
        void SendRequest("/CloseSession/", "ID=" + sessionId);
      };

      function SendRequest(path, data) {
        var request = new XMLHttpRequest();
        request.open("POST", hostUrl + path, false);
        request.send(data);
        return request.responseXML;
      };

      window.onunload = CloseSession;

    </script>
  </head>
  <body>

    <form action="#" onsubmit="
        StartSession(this.address.value, this.user.value, this.password.value);
        ReadResponses();
        return false">
      <input name="address" type="text" value="http://localhost:9000" />
      <input name="user" type="text" value="ConsoleUser" />
      <input name="password" type="text" value="ConsolePass" />
      <input type="submit" value="Login" />
    </form>

    <div id="output" style="height:15em; border:thin solid; overflow:auto;"></div>

    <form action="#" onsubmit="
        Command(this.command.value);
        ReadResponses();
        return false">
      <input type="text" name="command" value="Enter command here" size="40"/>
      <input type="submit" value="Send Command" />
    </form>

  </body>
</html>
Retrieved from "http://opensimulator.org/index.php?title=RestConsole/de&oldid=42229"
Personal tools
General
About This Wiki