http.xml 15.3 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907
<?xml version="1.0" encoding="iso8859-1"?>
<chapter id="http"><title id="thttp">
Die HTTP-Oberfläche
</title>

<sect1><title>Einführung</title>

<para><emphasis>


Diese Seite ist nicht komplett
.</emphasis></para>

<sect2><title>


Präsentation
</title>

<para>


VLC enthält einen kleinen HTTP-Server. Er kann zum 
Streamen über HTTP und für die HTTP-Fernsteuerungsoberfläche benutzt
werden
.</para>

<para>


Um VLC mit der HTTP-Oberfläche zu starten, machen
Sie folgendes
:</para>

<screen>
<prompt>% </prompt><userinput>vlc -I http (--http-src /directory/ --http-host host:port)</userinput>
</screen>

<para>


Das HTTP-Interface wird anfangen, unter host:port
(standardmäßig localhost:8080) nach Anfragen zu hören und die Struktur von
/directory unter http://host:port/ reproduzieren (standardmäßig
vlc_quell_pfad/share/http)
.</para>

<para>


VLC wird mit einer Reihe von Dateien ausgeliefert, die
für übliche Zwecke ausreichend sein sollten. Der Rest dieses Kapitels wird die
Wege aufzeigen, diese Seiten dem persönlichen Bedarf anzupassen
.</para>

<para>


Einige Dateien müssen besonders behandelt werden 
:</para>

<itemizedlist>

<listitem><para>


Datei, die mit "." beginnen, werden nicht exportiert
.</para></listitem>


<listitem><para>


Eine '.access'-Datei wird geöffnet werden und die
HTTP-Oberfläche wird in der ersten Zeile einen Loginnamen/Passwort
(geschrieben als Loginname:Passwort) erwarten. Dieser Loginname/Passwort
werden zum Schutz aller Dateien in diesem Verzeichnis benutzt. Bitte beachten
Sie, dass nur Dateien in diesem Verzeichnis geschützt werden.
(Unterverzeichnisse werden nicht geschützt.)
</para></listitem>


<listitem><para>


Die Datei &lt;dir&gt;/index.html wird als 
&lt;Verzeichnis&gt; und &lt;Verzeichnis&gt;/ exportiert, aber nicht als
index.html
.</para></listitem>

</itemizedlist>

<para>


Der MIME-Typ wird durch einen Blick an die
Dateiendung festgelegt und kann durch eine Einstellungsdatei weder
angegeben noch verändert werden. Unbekannte Endungen haben 
"application/octet-stream" als MIME-Typ
.</para>

<para>


Sie sollten den Export von großen Dateien
vermeiden. Jede Datei wird erst in den Speicher geladen, bevor sie an
den Client gesendet wird. Seien Sie also vorsichtig.
</para>

</sect2>


<sect2><title>


VLC-Makros
</title>


<para> 



Jede angeforderte .html/.htm - Seite wird von
VLC geparst, bevor sie gesendet wird. Der Parser sucht nach VLC-Makros
und führt sie aus oder ersetzt sie. Desweiteren können von der GET-Methode
empfangene Argumente ausgeführt werden
 .</para>


<para>


Ein VLC-Makro sieht folgendermaßen aus:
<emphasis>&lt;vlc id="Makro-Name" param1="Macro-Parameter1"
param2="Makro-Parameters2" /&gt;</emphasis>.
</para>


<para>


"id" ist das einzige zwingend erforderliche Feld, param1
und param2 können präsent sein oder nicht und sind angewiesen auf "id".
</para>

<para>


Sie sollten darauf achten, dass Sie diese Syntax
respektieren müssen, da VLC keine ungültige Syntax mag (diese könnte leicht
zu Abstürzen führen)
.</para>

<para>


Beispiele
:</para>


<para>


</para>

<para>


Inkorrekt: <emphasis>&lt;vlc id="value"
param1="version" &gt; </emphasis> (fehlendes Tag-Ende),
<emphasis>&lt;vlc id=value param1="version" /&gt;</emphasis> (fehlende "" )

</para>

<para>


Gültige Makros sind:
</para>

<itemizedlist>

<listitem><para>


<emphasis>control</emphasis> (1 optionaler Parameter)
</para>
</listitem>

<listitem><para>


<emphasis>get</emphasis> (2 Parameter)
</para>
</listitem>

<listitem><para>


<emphasis>set</emphasis> (2 Parameter)
</para>
</listitem>

<listitem><para>


<emphasis>rpn</emphasis> (1 Parameter)
</para>
</listitem>

<listitem><para>


<emphasis>if</emphasis> (1 optionaler Parameter)
</para>
</listitem>

<listitem><para>


<emphasis>else</emphasis> (ohne Parameter)
</para>
</listitem>

<listitem><para>


<emphasis>end</emphasis> (ohne Parameter)
</para>
</listitem>


<listitem><para>


<emphasis>value</emphasis> (1 optionaler Parameter)
</para>
</listitem>

<listitem><para>


<emphasis>foreach</emphasis> (2 Parameter)
</para>
</listitem>

</itemizedlist>

<para>


Für fortgeschrittene Makros können Sie diese Werkzeuge
benutzen
:</para>

<itemizedlist>

<listitem><para>


RPN-Bewerter (siehe Teil 2)
</para></listitem>

<listitem><para>


Stapel: Der Stapel ist ein Platz, an den Sie Nummern
und Zeichenketten schieben und von dort zurückholen können. Er wird
mit dem RPN-Bewerter benutzt.
</para></listitem>


<listitem><para>


Lokale Variablen: Sie können dynamische neue
Variablen erzeugen und deren Werte ändern. Einige lokale Variablen sind
vordefiniert:

<itemizedlist>

<listitem><para>
<emphasis>url_value</emphasis>


: Parameter der URL
</para></listitem>

<listitem><para>
<emphasis>url_param</emphasis>


: 1 wenn url_value nicht leer ist, sonst 0
</para></listitem>

<listitem><para>
<emphasis>version</emphasis>


: die VLC-Version
</para></listitem>

<listitem><para>
<emphasis>copyright</emphasis>


: das VLC-Copyright
</para></listitem>

</itemizedlist>

</para></listitem>

</itemizedlist>

<para>


Anmerkung: Die Stapel und die lokalen Variablen
werden vor der Ausführung der Seite zurückgesetzt
.</para>

</sect2>

</sect1>

<sect1><title>


Der RPN-Bewerter
</title>

<para>


RPN bedeutet Umgekehrte Polonaisennotation
(Reverse Polish Notation)
</para>

<sect2><title>


Einführung
</title>

<para>


RPN kann merkwürdig aussehen, aber es ist ein
einfacher und schneller Weg, Ausdrücke zu schreiben. Es vermeidet
außerdem die Benutzung von ( und ).
</para>

<para>


Anstatt ( 1 + 2 ) * 5 können Sie einfach 1 2 + 5 *
schreiben.
</para>

<para>


Die Idee dahinter ist: Wenn man eine Nummer oder
eine Zeichenkette hat, legt man sie auf den Stapel. Wenn man einen Operator
(wie +) hat, nimmt man die Argumente vom Stapel, führt die Operatoren aus
legt das Ergebnis wieder auf den Stapel. Das Ergebnis der RPN-Sequenu ist
der oberste Wert des Stapels 
.</para>

<para>
<programlisting>
 stack:      Word processed
 empty      1                   1 is pushed on the stack
 1          2                   2 same things
 1 | 2      +                   + : remove 1 and 2 and write 3 on the stack
 3          5                   5 is pushed on the stack
 3 | 5      *                   * : remove 3 and 5 and write 15
 15                             &lt;- result
</programlisting>
</para>

</sect2>

<sect2><title>


Die Operatoren
</title>

<para> 

Notation: ST(1) meint das erste Stapelelement,
ST(2) das zweite, usw. und op den Operator
</para>

<para>


Sie haben Zugriff auf
:</para>

<itemizedlist>

<listitem><para>


Die artithmetrischen Standardoperatoren: +, -, /,
%: Diese legen das Ergebnis von ST(1) op ST(2) auf den Stapel
</para></listitem>

<listitem><para>


Die binären Operatoren: ! (bearbeitet !ST(1)); ^, &amp;, | :
legen das Ergebnis von ST(1) op ST(2) ab
</para></listitem>

<listitem><para>


Tests: =, &lt;, &lt;=, &gt;, &gt;= : führen  ST(1) op
ST(2) aus und legen -1 ab, wenn das Ergebnis wahr oder 0 wenn nicht
</para>
</listitem>

<listitem><para>


Zeichenketten: strcat legt das Ergebnis von
'ST(1)ST(2)' ab, strcmp vergleicht ST(1) und ST(2) und legt -1 ab, wenn 
ST(1)&lt;ST(2), 0 wenn sie gleich sind und 1, wenn nicht. strlen legt die
Länge von ST(1) ab.
</para>
</listitem>

<listitem><para>


Manipulation des Stapels: dup verdoppelt ST(1), drop
entfernt ST(1), swap vertauscht ST(1) und ST(2) und flush leert den Stapel.
</para>
</listitem>

<listitem><para>


Manipulation von Variablen: store speichert ST(2)
in einer lokalen Variable namens ST(1), value legt den Wert der Variablen
namens ST(1) ab und url_extract legt den Wert des ST(1)-Teils der
URL-Parameter ab.
</para></listitem>

</itemizedlist>

</sect2>

</sect1>


<sect1><title>


Die Makros
</title>

<sect2><title>


Das <emphasis>control</emphasis>-Makro
</title>

<para>


Wenn Sie eine Seite abrufen, können Sie dieser Argumente durch
die URL geben. Beispielsweise: http://host:port/page.html?var=value&amp;var2=value2&amp;...
Das "control"-Makro gibt einer Seite Bescheid, diese Argumente zu parsen und die erlaubten
auszuführen. param1 dieses Makros sagt aus, welche Befehle erlaubt sind. Wenn es leer ist,
sind alle Befehle erlaubt.
</para>
<para>


Einige Befehle benötigen ein Argument, welches auch über die URL
mitgegeben werden muss
.</para>


<table frame="all">
<title>


Die URL-Befehle
</title>

<tgroup cols="3">
<thead>
<row>
 <entry>Name</entry>
 <entry>Argument</entry>
 <entry>
    
    
    Beschreibung
 </entry>
</row>
</thead>
<tbody>
<row>
 <entry>play</entry>
 <entry>
    
    
    Objekt (Ganzzahl)
 </entry>
 <entry>
    
    
    Gibt das angegebene Wiedergabelistenobjekt wieder
 </entry>
</row>
<row>
 <entry>stop</entry><entry/>
 <entry>
    
    
    Stopp
 </entry>
</row>
<row>
 <entry>pause</entry><entry/>
 <entry>Pause</entry>
</row>
<row>
 <entry>next</entry><entry/>
 <entry>
    
    
    Zum nächsten Wiedergabelistenobjekt gehen
 </entry>
</row>
<row>
 <entry>previous</entry><entry/>
 <entry>
    
    
    Zum vorherigen Wiedergabelistenobjekt gehen
 </entry>
</row>
<row>
 <entry>add</entry>
 <entry>
    
    
    mrl (Zeichenkette)
 </entry>
 <entry>
    
    
    Fügt eine MRL (Media Resource Locator) der Wiedergabeliste hinzu
 </entry>
</row>
<row>
 <entry>delete</entry>
 <entry>
    
    
    Objekt (Ganzzahl)
 </entry>
 <entry>
    
    
    Löscht das angegebene Wiedergabelistenobjekt oder die angegebene Liste
 </entry>
</row>
<row>
 <entry>empty</entry><entry/>
 <entry>
    
    
    Leert die Wiedergabeliste
 </entry>
</row>
<row>
 <entry>close</entry>
    <entry>
        
        
        ID (hexadezimal)
    </entry>
 <entry>
    
    
    Schließt die angegebene Verbindung
 </entry>
</row>
<row>
 <entry>shutdown</entry><entry/>
 <entry>
    
    
    VLC beenden
 </entry>
</row>
</tbody>
</tgroup>
</table>

<para>


Beispielsweise können Sie die Ausführung des 
<command>shutdown</command>-Befehls auf geschützte Seiten (durch eine
<emphasis>.access</emphasis>-Datei) beschränken, in dem Sie das control-Makro
in allen ungeschützten Seiten benutzen.
</para>


</sect2>


<sect2><title>


Das <emphasis>get</emphasis>-Makro
</title>

<para>


Dies Makro wird durch den Wert der Einstellungsvariablen
ersetzt, die param1 gespeichert ist und deren Typ durch param2 bestimmt wird.
</para>

<para>


param1 muss der Name einer existierenden Einstellungsvariablen
sein. param2 muss der richtige Typ der Variablen sein. Dies kann einer der folgenden sein:
<emphasis>int</emphasis> (Ganzzahl), <emphasis>float</emphasis> (Fließkommazahl)
oder <emphasis>string</emphasis> (Zeichenkette). 
</para>

<para>


Beispiel: &lt;vlc id="get" param1="sout"
param2="string" /&gt; wird in der ausgegebenen Seite durch den Wert
von sout ersetzt.
</para>

</sect2>


<sect2><title>


Das <emphasis>set</emphasis>-Makro
</title>

<para>


Dieses Makro erlaubt Ihnen den Wert einer
Konfigurationsvariablen einzustellen. Der Name wird über param1 und der
Typ param2 gesteuert (wie bei get). Der Wert wird der URL, über den in param1
angegebenen Namen, entnommen.
</para>

<para>


Zum Beispiel: Wenn player.html &lt;vlc
id="set" param1="sout" param2="string" /&gt; enthält und die URL
<emphasis> http://host:ip/player.html?sout=sout_value</emphasis> ist,
wird die sout-Variable den Wert "sout_value" erhalten. Wenn die URL nicht
sout enthält, wird nichts geschehen.
</para>

</sect2>


<sect2><title>


Das <emphasis>rpn</emphasis>-Makro
</title>
<para>


Dieses Makro erlaubt Ihnen RPN-Befehle (siehe II)
auszuwerten.
</para>
</sect2>

<sect2><title>


Das Makro <emphasis>if,else,end</emphasis>
</title>

<para>


Dieses Makro erlaubt Ihnen das Parsen der HTML-Seite
zu kontrollieren.
</para>

<para>


Wenn param1 nicht leer ist, wird es mit dem 
RPN-Bewerter ausgeführt. Wenn das erste Element auf dem Stapel nicht 0
ist, ist der Testwert wahr, sonst unwahr 
.</para>

<para>



<programlisting> &lt;vlc id="if" param1="1 2 =" /&gt;
    &lt;!-- Nicht erreicht --&gt;
 &lt;vlc id="else" /&gt;
    &lt;p&gt; Test erfolgreich: 1 ist nicht gleich mit 2 &lt;/p&gt;
 &lt;vlc id="end" /&gt;
</programlisting>

</para>

<para>


Sie können auch einfach "if" und "end" benutzen
.</para>

</sect2>

<sect2><title>


Das <emphasis>value</emphasis>-Makro
</title>

<para>


Wenn param1 nicht leer ist, wird es über den
RPN-Bewerter ausgeführt. Das Makro ersetzt den Wert des ersten Elements
des Stapels.
</para>

<para>


Beachten Sie: Wenn das Element der Name einer
lokalen Variable ist, wird deren Wert und nicht ihr Name angezeigt.
</para>

</sect2>

<sect2><title>


Das <emphasis>foreach,end</emphasis> Makro
</title>

<para>



param1 ist der Name der Variable, die für die
Schleife benutzt wird. param2 ist der Name der Variable, deren Werte
benutzt werden:

</para>


<itemizedlist>

<listitem><para>


<emphasis>integer</emphasis>: nimmt das
erste Element des Stapels um ein Set von Ganzzahlen zu erzeugen. Das
Stapelelement sollte folgendermaßen aussehen:
<emphasis>erste:letzte[:Schritt][,erste2:letzte2[:Schritt2][,...]</emphasis>
(Beispiel: 1:5:2,6:8:1 wird zu 1,3,5,6,7,8)
</para></listitem>

<listitem><para>


<emphasis>directory</emphasis>: nimmt das erste
Element des Stapels als Ausgangsverzeichnis und erzeugt ein Set von
Dateinamen direkt darin. Jedes Element hat die folgenden Felder:
</para>

<itemizedlist>

<listitem><para>


name: Name der Datei/des Verzeichnisses
</para></listitem>

<listitem><para>


type: "directory" (Verzeichnis) oder "file" (Datei)
oder "unknown" (unbekannt)
</para></listitem>

<listitem><para>


size: die Größe der Datei
</para></listitem>

<listitem><para>


date: das Datum
</para></listitem>

</itemizedlist>

</listitem>

<listitem><para>


playlist: ein auf der Wiedergabeliste mit folgenden
Feldern basierendes Set: current ist 1, wenn das Objekt derzeit ausgewählt
ist, sonst 0. index ist der Index-Wert, der von den play oder delete - Befehlen
benutzt werden kann. name ist der Name des Objekts 
.</para></listitem>

<listitem><para>


"informations": Erzeugt Informationen für den derzeit
abgespielten Stream. name ist der Name der Kategorie, value ist dessen Wert,
info ist ein neues Set, dass Sie erneut parsen können (Unterfelder von info
sind name und value)
.</para></listitem>

<listitem><para>


"hosts": Erzeugt eine Liste von hörenden Hosts.
Enthält die "id" (interne ID), host, ip und port-Felder.
</para></listitem>

<listitem><para>


"urls": Erzeugt eine Liste der derzeit verfügbaren
URLs. Felder sind id, stream (1 wenn wir einen Stream haben, sonst 0),
url, mime, protected (1 wenn geschützt, sonst 0), used (wird es derzeit
benutzt?).
</para></listitem>

<listitem><para>


"connections": Erzeugt eine Liste der derzeitigen
Verbindungen. Die Felder sind: id, eine interne ID, die mit dem
close-Befehl benutzt werden kann, ip, url und status
(HTTP-Fehlercode).
</para></listitem>

<listitem><para>


Der Name einer foreach-Variablen, wenn es ein
Set von eingestellten Werten ist.
</para>

<programlisting>;&lt;vlc id="foreach" param1="cat" param2="informations" /&gt;
                &lt;p&gt; &lt;vlc id="value" param1="cat.name" /&gt;
                &lt;ul&gt;
                &lt;vlc id="foreach" param1="info" param2="cat.info" /&gt;
                    &lt;li&gt;
                    &lt;vlc id="value" param1="info.name" /&gt; :
                            &lt;vlc id="value" param1="info.value" /&gt;
                    &lt;/li&gt;
                &lt;vlc id="end" /&gt;
                &lt;/ul&gt;
            &lt;vlc id="end" /&gt;
</programlisting>

</listitem>

</itemizedlist>

<para>

Schauen Sie für weitere Details in das share/http
- Verzeichnis der Quellen von VLC...
</para>

</sect2>
</sect1>

</chapter>