Zend_Feed_Pubsubhubbub.xml 40 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- EN-Revision: 21588 -->
  3. <!-- Reviewed: no -->
  4. <sect1 id="zend.feed.pubsubhubbub.introduction">
  5. <title>Zend_Feed_Pubsubhubbub</title>
  6. <para>
  7. <classname>Zend_Feed_Pubsubhubbub</classname> ist eine Implementation der PubSubHubbub Core
  8. 0.2 Spezifikation (Working Draft). Sie bietet eine Implementation eines Pubsubhubbub
  9. Publizisten und Abonnenten geeignet für den Zend Framework und andere PHP Anwendungen.
  10. </para>
  11. <sect2 id="zend.feed.pubsubhubbub.what.is.pubsubhubbub">
  12. <title>Was ist Pubsubhubbub?</title>
  13. <para>
  14. Pubsubhubbub ist ein offenes, einfaches Web-skalierbares Pubsub Protokoll. Der normale
  15. Anwendungsfall ist es Blogs (Publizist) zu erlauben Aktualisierungen von deren RSS oder
  16. Atom Feeds (Themen) an Abonnenten zu "senden". Diese Abonenten müssen dem RSS oder Atom
  17. Feed des Blogs über einen Hub abonniert haben. Das ist ein zentraler Server der
  18. benachrichtigt wird wenn es Aktualisierungen des Publizisten gibt und diese anschließend
  19. an alle Abonnenten verteilt. Jeder Feed kann bekanntgeben das er ein oder mehrere Hubs
  20. unterstützen indem ein Atom Namespaced Linkelement mit dem Rel Attribut "hub" verwendet
  21. wird.
  22. </para>
  23. <para>
  24. Pubsubhubbub hat Aufmerksamkeit erlangt weil es ein Pubsub Protokoll ist das einfach zu
  25. implementieren ist und über HTTP arbeitet. Seine Philosophie ist es das traditionelle
  26. Modell zu ersetzen indem Blog Feeds mit einem regulären Interfall abgefragt werden um
  27. Aktualisierungen zu erkennen und zu empfangen. Abhängig von der Frequenz der Abfrage
  28. kann es viel Zeit in Anspruch nehmen Aktualisierungen an interessierte Menschen bei
  29. Sammelstellen bis zu Desktop Lesern, bekannt zu machen. Mit der Verwendung eines
  30. Pubsub Systems werden Aktualisierungen nicht einfach von Abonnenten abgefragt sondern
  31. an die Abonnenten geschickt, was jegliche Verzögerung ausschaltet. Aus diesem Grund
  32. fungiert Pubsubhubbub als Teil von dem was als Echt-Zeit Web bekannt ist.
  33. </para>
  34. <para>
  35. Das Protokoll existiert nicht isoliert. PubSub Systems gibt es schon seit einiger Zeit,
  36. wie auch das übliche Jabber Publish-Subscribe Protokoll, XEP-0060, oder das nicht so
  37. bekannte rssCloud (beschrieben 2001). Trotzdem haben diese keine keine breite Anwendung
  38. gefunden weil Sie entweder komplex sind, ein schlechtes Timing haben, oder nicht für
  39. Web Anwendungen verwendbar sind. Bei rssCloud, welches zuletzt als Antwort auf das
  40. Erscheinen von Pubsubhubbub revidiert wurde, wurde auch eine signifikante Steigerung
  41. gesehen obwohl es an einer formalen Spezifikation fehlt und es aktuell keine Atom 1.0
  42. Feeds unterstützt.
  43. </para>
  44. <para>
  45. Warscheinlich überraschend weil es noch relativ Jung ist, ist Pubsubhubbub trotzdem
  46. bereits in Verwendung unter anderem bei Google Reader, Feedburner und es sind Plugins
  47. für Wordpress Blogs vorhanden.
  48. </para>
  49. </sect2>
  50. <sect2 id="zend.feed.pubsubhubbub.architecture">
  51. <title>Architektur</title>
  52. <para>
  53. <classname>Zend_Feed_Pubsubhubbub</classname> implementiert zwei Seiten der Pubsubhubbub
  54. 0.2 Spezifikation: einen Publizisten und einen Abonnenten. Es implementiert aktuell
  55. keinen Hub Server. Dieser ist aber in Arbeit für ein zukünftiges Zend Framework Release.
  56. </para>
  57. <para>
  58. Ein Publizist ist verantwortlich für die Mitteilung aller Aktualisierungen seines Feeds
  59. an alle unterstützten Hubs (es können viele unterstützt werden um Redundanz zu einem
  60. System hinzuzufügen), egal ob es sich um Atom oder RSS basierte handelt. Das wird getan
  61. indem die unterstützten Hub Server mit der URL des aktualisierten Feeds gepingt werden.
  62. In der Pubsubhubbub Terminologie wird jede aktualisierbare Ressource welche in der Lage
  63. ist abonniert zu werden als Thema bezeichnet. Sobald ein Ping empfangen wird, frägt der
  64. Hub den aktualisierten Feed ab, bearbeitet die aktualisierten Elemente, und leitet alle
  65. Aktualisierungen an alle Abonnenten weiter die diesen Feed abonniert haben.
  66. </para>
  67. <para>
  68. Ein Abonnent ist jedes Mitglied oder jede Anwendung welche einen oder mehrere Hubs
  69. abonniert um Aktuslisierungen von einem Thema zu empfangen welches von einem Publizisten
  70. gehostet wird. Der Abonnent kommuniziert niemals direkt mit dem Publizisten da der Hub
  71. als Zwischenglied fungiert welches Abos akzeptiert und Aktualisierungen an Abonnenten
  72. sendet. Der Abonnent kommuniziert seinerseits nur mit dem Hub um Themen entweder zu
  73. abonnieren und Abos zu entfernen, oder wenn er Aktualisierungen vom Hub empfängt. Dieses
  74. Design der Kommunikation ("Fat Pings") entfernt effektiverweise die Möglichkeit eines
  75. "Thundering Herd" Problems. Dieses findet in einem Pubsub System statt in dem der Hub
  76. Abonnenten über eine vorhandene Aktualisierung informiert, und alle Abonnenten dazu
  77. auffordert den Feed sofort vom Publizisten zu empfangen, was zu einer Verkehrsspitze
  78. führt. In Pubsubhubbub verteilt der Hub das aktuelle Update in einem "Fat Ping" so dass
  79. der Publizist keine Verkehrsspitze aushalten muss.
  80. </para>
  81. <para>
  82. <classname>Zend_Feed_Pubsubhubbub</classname> implementiert Pubsubhubbub Publizisten und
  83. Abonnenten mit den Klassen <classname>Zend_Feed_Pubsubhubbub_Publisher</classname> und
  84. <classname>Zend_Feed_Pubsubhubbub_Subscriber</classname>. Zusätzlich kann die
  85. Implementation des Abonnenten alle Feed Aktualisierungen behandeln die von einem Hub
  86. weitergeleitet werden indem
  87. <classname>Zend_Feed_Pubsubhubbub_Subscriber_Callback</classname> verwendet wird. Diese
  88. Klassen, deren Verwendungszweck, und die APIs werden in den weiterführenden Abschnitten
  89. behandelt.
  90. </para>
  91. </sect2>
  92. <sect2 id="zend.feed.pubsubhubbub.zend.feed.pubsubhubbub.publisher">
  93. <title>Zend_Feed_Pubsubhubbub_Publisher</title>
  94. <para>
  95. In Pubsubhubbub ist der Publizist der Teilnehmer welcher einen lebenden Feed
  96. veröffentlicht und Ihn regelmäßig mit neuem Inhalt aktualisiert. Das kann ein Blog, eine
  97. Sammlung, oder sogar ein Webservice mit einer öffentlichen Feed basierenden API sein.
  98. Damit diese Aktualisierungen zu den Abonnenten geschickt werden können, muss der
  99. Publizist alle seine unterstützten Hubs darüber informieren das eine Aktualisierung
  100. stattgefunden hat, indem eine einfache HTTP POST Anfrage verwendet wird, welche die URI
  101. oder das aktualisierte Thema enthält (z.B. den aktualisierten RSS oder Atom Feed). Der
  102. Hub bestätigt den Empfang der Benachrichtigung, holt den aktualisierten Feed, und leitet
  103. alle Aktualisierungen an alle Abonnenten weiter welche sich bei diesem Hub für
  104. Aktualisierungen für den relevanten Feed angemeldet haben.
  105. </para>
  106. <para>
  107. Vom Design her bedeutet dies dass der Publizist sehr wenig zu tun hat ausser diese Hub
  108. Pings jedesmal zu senden wenn sich seine Feeds ändern. Als Ergebnis hiervon ist die
  109. Implementation des Publizisten extrem einfach zu verwenden und benötigt sehr wenig
  110. Arbeit für die Einrichtung und Verwendung wenn Feeds aktualisiert werden.
  111. </para>
  112. <para>
  113. <classname>Zend_Feed_Pubsubhubbub_Publisher</classname> implementiert einen kompletten
  114. Pubsubhubbub Publizisten. Sein Setup ist sehr einfach und hauptsächlich müssen bei Ihm
  115. nur die URI Endpunkte für alle Hubs konfiguriert werden welche bei Aktualisierungen
  116. benachrichtigt werden müssen, und die URIs aller Themen die in Benachrichtigungen
  117. einzubinden sind.
  118. </para>
  119. <para>
  120. Das folgende Beispiel zeigt einen Publizisten der eine Sammlung von Hubs über
  121. Aktualisierungen zu einem Paar von lokalen RSS und Atom Feeds benachrichtigt. Die Klasse
  122. enthält eine Anzahl von Fehlern welche die URLs des Hubs enthalten, damit
  123. Benachrichtigungen stäter wieder ausgeführt oder protokolliert werden können wenn
  124. irgendeine Benachrichtigung fehlschlägt. Jedes resultierende Fehlerarray enthält auch
  125. einen "response" Schlüssel welche das betreffende HTTP Antwortobjekt enthält. In Falle
  126. irgendeines Fehlers wird empfohlen die Operation für den fehlgeschlagenen Hub Endpunkt
  127. in Zukunft zumindest noch einmal zu versuchen. Das kann die Verwendung einer geplanten
  128. Aufgabe für diesen Zweck oder einer Job Queue wenn solche extra Schritte optional sind.
  129. </para>
  130. <programlisting language="php"><![CDATA[
  131. $publisher = new Zend_Feed_Pubsubhubbub_Publisher;
  132. $publisher->addHubUrls(array(
  133. 'http://pubsubhubbub.appspot.com/',
  134. 'http://hubbub.example.com',
  135. ));
  136. $publisher->addUpdatedTopicUrls(array(
  137. 'http://www.example.net/rss',
  138. 'http://www.example.net/atom',
  139. ));
  140. $publisher->notifyAll();
  141. if (!$publisher->isSuccess()) {
  142. // Auf Fehler prüfen
  143. $errors = $publisher->getErrors();
  144. $failedHubs = array()
  145. foreach ($errors as $error) {
  146. $failedHubs[] = $error['hubUrl'];
  147. }
  148. }
  149. // Benachrichtigung für fehlgeschlagene Hubs in $failedHubs nochmals planen
  150. ]]></programlisting>
  151. <para>
  152. Wenn man eine konkretere Kontrolle über den Publizisten bevorzugt, gibt es die Methoden
  153. <methodname>addHubUrls()</methodname> und <methodname>addUpdatedTopicUrls()</methodname>
  154. welche jeden Arraywert an die einzelnen öffentlichen Methoden
  155. <methodname>addHubUrl()</methodname> und <methodname>addUpdatedTopicUrl()</methodname>
  156. übergeben. Es gibt auch passende <methodname>removeUpdatedTopicUrl()</methodname> und
  157. <methodname>removeHubUrl()</methodname> Methoden.
  158. </para>
  159. <para>
  160. Man kann das Setzen der Hub URIs auch überspringen und jeden in Folge benachrichtigen
  161. indem die Methode <methodname>notifyHub()</methodname> verwendet wird welche die URI
  162. eines Hub Endpunkts als sein einziges Argument akzeptiert.
  163. </para>
  164. <para>
  165. Es gibt keine anderen Aufgaben die abzudecken sind. Die Implementation des Publizisten
  166. ist sehr einfach da das meiste der Feedbearbeitung und Verteilung von den ausgewählten
  167. Hubs durchgeführt wird. Es ist trotzdem wichtig Fehler zu erkennen und
  168. Benachrichtigungen wieder so früh wie möglich zu planen (mit einer vernünftigen
  169. maximalen Anzahl an Versuchen) um sicherzustellen das Benachrichtigungen alle
  170. Abonnenten erreichen. In vielen Fällen können Hubs, als endgültige Alternative, den
  171. eigenen Feed regelmäßig abfragen um zusätzliche Toleranzen bei Fehlern anzubieten
  172. sowohl wegen deren eigenen temporären Downtime als auch den Fehlern und der Downtime
  173. des Publizisten.
  174. </para>
  175. </sect2>
  176. <sect2 id="zend.feed.pubsubhubbub.zend.feed.pubsubhubbub.subscriber">
  177. <title>Zend_Feed_Pubsubhubbub_Subscriber</title>
  178. <para>
  179. In Pubsubhubbub ist der Abonnent ein Teilnehmer welcher Aktualisierungen zu irgendeinem
  180. Thema (einem RSS oder Atom Feed) empfangen will. Er kann das bewerkstelligen indem er
  181. einen oder mehrere Hubs abonniert welche von diesem Thema beworben werden, normalerweise
  182. als ein Set von ein oder mehreren Atom 1.0 Links mit dem Rel Attribut "hub". Ab diesem
  183. Punkt sendet der Hub, wenn er eine Benachrichtigung über eine Aktualisierung des
  184. Publizisten empfängt, einen Atom oder RSS Feed, welcher alle Aktualisierungen enthält,
  185. zur Callback URL des Abonnenten. Über diesen Weg muss der Abonnent niemals den
  186. originalen Feed besuchen (obwohl es trotzdem empfohlen wird um sicherzustellen das
  187. Aktualisierungen empfangen werden wenn ein Hub jemals offline geht). Alle Anfragen für
  188. Abos müssen die URI des Themas enthalten welches abonniert werden soll, und eine
  189. Callback URL welche der Hub verwendet um das Abo zu bestätigen und um Aktualisierungen
  190. weiterzuleiten.
  191. </para>
  192. <para>
  193. Der Abonnent hat deswegen zwei Rollen. Abos zu erstellen und zu managen, inklusive der
  194. Abonnierung von neuen Themen mit einem Hub, dem kündigen von Abos (wenn notwendig), und
  195. periodisch Abos zu erneuern da diese eine begrenzte Gültigkeit haben können was durch
  196. den Hub gesetzt wird. Dies wird von
  197. </para>
  198. <para>
  199. Die zweite Rolle ist es Aktualisierungen zu akzeptieren welche vom Hub zur Callback
  200. URL des Abonnenten gesendet werden, wenn z.B. die URI des Abonnenten zugeordnet wurde
  201. um Aktualisierungen zu behandeln. Die Callback URL behandelt auch Events wenn der Hub
  202. den Abonnenten kontaktiert um alle Abos zu das Löschen von Abos zu bestätigen. Dies wird
  203. behandelt indem eine Instanz von
  204. <classname>Zend_Feed_Pubsubhubbub_Subscriber_Callback</classname> verwendet wird wenn
  205. auf die Callback URL zugegriffen wird.
  206. </para>
  207. <important>
  208. <para>
  209. <classname>Zend_Feed_Pubsubhubbub_Subscriber</classname> implementiert die
  210. Pubsubhubbub Spezifikation 0.2. Da dies eine Version der Spezifikation ist
  211. implementieren Sie aktuell nicht alle Hubs. Die neue Spezifikation erlaubt der
  212. Callback URL einen Abfragestring einzubinden welcher von dieser Klasse verwendet,
  213. aber nicht von allen Hubs unterstützt wird. Im Interesse einer maximalen
  214. Kompatibilität wird deshalb empfohlen die Komponente des Abfragestrings der
  215. Callback URI des Abonnenten als Pfadelement darzustellen, z.B. als Parameter in der
  216. Route erkannt und mit der Callback URI assoziiert und vom Router der Anwendung
  217. verwendet.
  218. </para>
  219. </important>
  220. <sect3
  221. id="zend.feed.pubsubhubbub.zend.feed.pubsubhubbub.subscriber.subscribing.and.unsubscribing">
  222. <title>Abonnieren und Abos löschen</title>
  223. <para>
  224. <classname>Zend_Feed_Pubsubhubbub_Subscriber</classname> implementiert einen
  225. kompletten Pubsubhubbub Abonnenten der in der Lage ist jedes Thema über jeden Hub
  226. der von diesem Thema vermittelt wird zu abonnieren und Abos zu löschen. Er arbeitet
  227. in Verbindung mit <classname>Zend_Feed_Pubsubhubbub_Subscriber_Callback</classname>
  228. welcher Anfragen von einem Hub akzeptiert um alle Aboanfragen und das Löschen von
  229. Abos zu bestätigen (um Missbrauch durch andere zu verhindern).
  230. </para>
  231. <para>
  232. Jedes Abo (oder Löschen eines Abos) benötigt die betreffende Information bevor
  233. es bearbeitet werden kann, z.B. die URI des Themas (Atom oder RSS Feed) das für
  234. Aktualisierungen abonniert werden soll, und die URI des Endpunkts für den Hub
  235. welcher die Anmeldung auf das Abo bearbeitet und die Aktualisierungen weiterleitet.
  236. Die Lebenszeit eines Abos kann durch den Hub ermittelt werden, aber die meisten
  237. Hubs sollten die automatische Auffrischung des Abos unterstützen indem der
  238. Abonnenten geprüft wird. Das wird von
  239. <classname>Zend_Feed_Pubsubhubbub_Subscriber_Callback</classname> unterstützt und
  240. benötigt keine weitere Arbeit. Es wird trotzdem empfohlen dass man die vom Hub
  241. kommende Lebenszeit des Abos (time to live, ttl) verwendet um die Erstellung neuer
  242. Abos zu planen (der Prozess ist identisch mit dem eines neuen Abos) um es beim Hub
  243. zu aktualisieren. Wärend das per se nicht notwendig ist, deckt es Fälle ab in denen
  244. ein Hub die automatische Aktualisierung des Abos nicht unterstützt und deckt damit
  245. Fehler des Hubs mit zusätzlicher Redundanz ab.
  246. </para>
  247. <para>
  248. Mit der relevanten Information an der Hand kann eine Abonnierung wie anbei gezeigt
  249. versucht werden:
  250. </para>
  251. <programlisting language="php"><![CDATA[
  252. $storage = new Zend_Feed_Pubsubhubbub_Model_Subscription;
  253. $subscriber = new Zend_Feed_Pubsubhubbub_Subscriber;
  254. $subscriber->setStorage($storage);
  255. $subscriber->addHubUrl('http://hubbub.example.com');
  256. $subscriber->setTopicUrl('http://www.example.net/rss.xml');
  257. $subscriber->setCallbackUrl('http://www.mydomain.com/hubbub/callback');
  258. $subscriber->subscribeAll();
  259. ]]></programlisting>
  260. <para>
  261. Um Abos zu speichern und Zugriff auf dessen Daten für eine generelle Verwendung zu
  262. Speichern benötigt die Komponente eine Datenbank (ein Schema wird später in diesem
  263. Abschnitt angeboten). Standardmäßig wird angenommen das der Name der Tabelle
  264. "subscription" ist und im Hintergrund <classname>Zend_Db_Table_Abstract</classname>
  265. anwendet, was bedeutet das der Standardadapter verwendet wird welcher in der
  266. Anwendung gesetzt ist. Man kann auch eine eigene spezielle Instanz von
  267. <classname>Zend_Db_Table_Abstract</classname> in das assoziierte Modell von
  268. <classname>Zend_Feed_Pubsubhubbub_Model_Subscription</classname> übergeben. Dieser
  269. eigene Adapter kann so einfach wie gewünscht sein indem der Name der Tabelle welche
  270. zu verwenden ist geändert wird, oder so komplex wie es notwendig ist.
  271. </para>
  272. <para>
  273. Wärend das Modell als standardmäßige bereits verwendbare Lösung angeboten wird, kann
  274. man sein eigenes Modell verwenden indem irgendein anderes Backend oder
  275. Datenbanklayer (z.B. Doctrine) verwendet wird, solange die resultierende Klasse das
  276. Interface <classname>Zend_Feed_Pubsubhubbub_Model_SubscriptionInterface</classname>
  277. implementiert.
  278. </para>
  279. <para>
  280. Ein Beispielschema (MySQL) für eine Abotabelle auf welche vom angebotenen Modell aus
  281. zugegriffen werden kann, könnte wie folgt aussehen:
  282. </para>
  283. <programlisting language="sql"><![CDATA[
  284. CREATE TABLE IF NOT EXISTS `subscription` (
  285. `id` varchar(32) COLLATE utf8_unicode_ci NOT NULL DEFAULT '',
  286. `topic_url` varchar(255) COLLATE utf8_unicode_ci DEFAULT NULL,
  287. `hub_url` varchar(255) COLLATE utf8_unicode_ci DEFAULT NULL,
  288. `created_time` datetime DEFAULT NULL,
  289. `lease_seconds` bigint(20) DEFAULT NULL,
  290. `verify_token` varchar(255) COLLATE utf8_unicode_ci DEFAULT NULL,
  291. `secret` varchar(255) COLLATE utf8_unicode_ci DEFAULT NULL,
  292. `expiration_time` datetime DEFAULT NULL,
  293. `subscription_state` varchar(12) COLLATE utf8_unicode_ci DEFAULT NULL,
  294. PRIMARY KEY (`id`)
  295. ) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_unicode_ci;
  296. ]]></programlisting>
  297. <para>
  298. Im Hintergrund sendet der Abonnent eine Anfrage an den Endpunkt des Hubs welche die
  299. folgenden Parameter enthält (basierend auf dem vorhergehenden Beispiel):
  300. </para>
  301. <table
  302. id="zend.feed.pubsubhubbub.zend.feed.pubsubhubbub.subscriber.subscribing.and.unsubscribing.table">
  303. <title>Anfrageparameter beim Abonnieren</title>
  304. <tgroup cols="3">
  305. <thead>
  306. <row>
  307. <entry>Parameter</entry>
  308. <entry>Wert</entry>
  309. <entry>Beschreibung</entry>
  310. </row>
  311. </thead>
  312. <tbody>
  313. <row>
  314. <entry>hub.callback</entry>
  315. <entry>http://www.mydomain.com/hubbub/callback?xhub.subscription=5536df06b5dcb966edab3a4c4d56213c16a8184</entry>
  316. <entry>
  317. <para>
  318. Die URI welche von einem Hub verwendet wird um den Abonnenten
  319. zu kontaktieren und entweder eine Bestätigung für eine Anfrage
  320. oder das Löschen eines Abos abzufragen oder Aktualisierungen für
  321. abonnierte Feeds zu senden. Der angehängte Abfragestring enthält
  322. einen eigenen Parameter (demzufolge der Zweck von xhub). Es ist
  323. ein Parameter für einen Abfragestring welcher vom Hub
  324. aufbewahrt um mit allen Anfragen des Abonnenten wieder versendet
  325. wird. Sein Zweck ist es dem Abonnenten zu erlauben sich zu
  326. identifizieren und die Abos zu betrachten welche mit einer
  327. beliebigen Hubanfrage in einem Backend-Speichermedium assoziiert
  328. sind. Das ist kein Standardparameter welcher von dieser
  329. Komponente verwendet wird statt einen Aboschlüssel im URI Pfad
  330. zu kodieren, was in einer Zend Framework Anwendung viel
  331. komplizierter zu implementieren wäre.
  332. </para>
  333. <para>
  334. Trotzdem, da nicht alle Hubs Parameter für den Abfragestring
  335. unterstützen wird empfohlen den Aboschlüssel als Pfadkomponente
  336. in der Form von
  337. http://www.mydomain.com/hubbub/callback/5536df06b5dcb966edab3a4c4d56213c16a8184
  338. hinzuzufügen. Um das zu bewerkstelligen, wird die Definition
  339. einer Route benötigt welche in der Lage ist den endgültigen
  340. Wert des Schlüssels herauszuparsen den Wert zu erhalten und Ihn
  341. an das Callback Objekt des Abonnenten zu übergeben. Der Wert
  342. würde an die Methode
  343. <methodname>Zend_Pubsubhubbub_Subscriber_Callback::setSubscriptionKey()</methodname>
  344. übergeben. Ein detailiertes Beispiel wird später gezeigt.
  345. </para>
  346. </entry>
  347. </row>
  348. <row>
  349. <entry>hub.lease_seconds</entry>
  350. <entry>2592000</entry>
  351. <entry>
  352. <para>
  353. Die Anzahl an Sekunden für welche der Abonnenten will dass
  354. ein neues Abo gültig bleibt (z.B. ein TTL). Hubs können Ihre
  355. eigene maximale Abodauer erzwingen. Alle Abos sollten erneuert
  356. werden indem einfach erneut abonniert wird bevor die Abodauer
  357. endet um die Kontinuierlichkeit der Aktualisierungen zu
  358. gewährleisten. Hubs sollten zusätzlich versuchen Abos
  359. automatisch zu aktualisieren bevor diese auslaufen indem die
  360. Abonnenten kontaktiert werden (dies wird automatisch von der
  361. Callback Klasse behandelt).
  362. </para>
  363. </entry>
  364. </row>
  365. <row>
  366. <entry>hub.mode</entry>
  367. <entry>subscribe</entry>
  368. <entry>
  369. <para>
  370. Ein einfacher Wert welche anzeigt das dies eine Aboanfrage ist.
  371. Anfragen für das Löschen von Abos würden den Wert
  372. "unsubscribe" verwenden.
  373. </para>
  374. </entry>
  375. </row>
  376. <row>
  377. <entry>hub.topic</entry>
  378. <entry>http://www.example.net/rss.xml</entry>
  379. <entry>
  380. <para>
  381. Die URI des Themas (z.B. Atom oder RSS Feed) welche der Abonnent
  382. zu abonnieren wünscht damit er Aktualisierungen bekommt.
  383. </para>
  384. </entry>
  385. </row>
  386. <row>
  387. <entry>hub.verify</entry>
  388. <entry>sync</entry>
  389. <entry>
  390. <para>
  391. Zeigt dem Hub die bevorzugte Methode der Prüfung von Abos und
  392. dem Löschen von Abos. Sie wird im Normalfall zwei mal
  393. wiederholt. Technisch gesehen unterscheidet diese Komponente
  394. nicht zwischen den zwei Modi und behandelt beide gleich.
  395. </para>
  396. </entry>
  397. </row>
  398. <row>
  399. <entry>hub.verify</entry>
  400. <entry>async</entry>
  401. <entry>
  402. <para>
  403. Zeigt dem Hub die bevorzugte Methode der Prüfung von Abos und
  404. dem Löschen von Abos. Sie wird im Normalfall zwei mal
  405. wiederholt. Technisch gesehen unterscheidet diese Komponente
  406. nicht zwischen den zwei Modi und behandelt beide gleich.
  407. </para>
  408. </entry>
  409. </row>
  410. <row>
  411. <entry>hub.verify_token</entry>
  412. <entry>3065919804abcaa7212ae89.879827871253878386</entry>
  413. <entry>
  414. <para>
  415. Ein Prüftoken welcher dem Abonnenten vom Hub zurückgegeben wird
  416. wenn er ein Abos oder das Löschen eines Abos bestätigt. Bietet
  417. ein Maß an Vertrauen dass die Bestätigung der Anfrage vom
  418. aktuellen Hub kommt um Missbrauch zu vermeiden.
  419. </para>
  420. </entry>
  421. </row>
  422. </tbody>
  423. </tgroup>
  424. </table>
  425. <para>
  426. Man kann verschiedene dieser Parameter verändern um eine andere Vorliebe anzuzeigen.
  427. Zum Beispiel kann man eine anderen Wert der Gültigkeit in Sekunden setzen indem man
  428. <methodname>Zend_Pubsubhubbub_Subscriber::setLeaseSeconds()</methodname> verwendet,
  429. oder eine Vorliebe für eine asynchrone Prüfung zeigen indem
  430. <methodname>setPreferredVerificationMode(Zend_Feed_Pubsubhubbub::VERIFICATION_MODE_ASYNC)</methodname>
  431. verwendet wird. Trotzdem bleiben die Hubs in der Lage Ihre eigenen Vorlieben zu
  432. erzwingen, und aus diesem Grund wurde die Komponente so designt dass Sie mit fast
  433. jedem Set an Optionen arbeitet und eine minimale Konfiguration des End-Benutzers
  434. erfordert. Konventionen sind toll wenn Sie funktionieren!
  435. </para>
  436. <note>
  437. <para>
  438. Wärend Hubs die Verwendung eines spezifischen Prüfmodus benötigen können (beide
  439. werden von <classname>Zend_Pubsubhubbub</classname> unterstützt), kann eine
  440. spezifische die zu bevorzugen ist durch Verwendung der Method
  441. <classname>Zend_Pubsubhubbub</classname> angezeigt werden. Im Modus "sync"
  442. (synchron) versucht der Hub eine Aboanfrage sofort zu bestätigen sobald diese
  443. empfangen, und noch bevor auf die Aboanfrage geantwortet wird. Im Modus "async"
  444. (asynchron) gibt der Hub sofort eine Antwort auf die Aboanfrage zurück, und die
  445. Prüfanfrage kann später stattfinden. Da <classname>Zend_Pubsubhubbub</classname>
  446. die Rolle der Aboprüfung als eigene Callback Klasse implementiert, und die
  447. Verwendung eines Backend Speichermediums, unterstützt Sie beide transparent im
  448. Sinne der Geschwindigkeit des Endbenutzers. Die acynchrone Prüfung ist stark zu
  449. bevorzugen um die Nachteile eines schlecht performenden Hubs zu eliminieren,
  450. und die Server Ressourcen des End-Benutzers und die Verbindungen nicht zu lange
  451. zu binden.
  452. </para>
  453. </note>
  454. <para>
  455. Das Löschen eines Abos folgt exakt dem gleichen Pattern wie im vorherigen Beispiel,
  456. mit der Ausnahme das stattdessen <methodname>unsubscribeAll()</methodname>
  457. aufgerufen wird. Die enthaltenen Parameter sind identisch mit einer Aboanfrage mit
  458. der Ausnahme das "hub.mode" auf "unsubscribe" gesetzt wird.
  459. </para>
  460. <para>
  461. Standardmäßig versucht eine neue Instanz von
  462. <classname>Zend_Pubsubhubbub_Subscriber</classname> ein Datenbank Backend
  463. Speichermedium zu verwenden mit Standardwerten um den standardmäßigen
  464. <classname>Zend_Db</classname> Adapter mit dem Tabellennamen "subscription" zu
  465. verwenden. Es wird empfohlen eine eigene Speicherlösung zu setzen welche diese
  466. Standardwerte nicht verwendet, entweder duch übergabe eines neuen Modells welches
  467. das benötigte Interface unterstützt, oder durch Übergabe einer neuen Instanz von
  468. <classname>Zend_Db_Table_Abstract</classname> an dem Constructor des standardmäßigen
  469. Modells um den verwendeten Tabellennamen zu verändern.
  470. </para>
  471. </sect3>
  472. <sect3 id="zend.feed.pubsubhubbub.zend.feed.pubsubhubbub.subscriber.handling.hub.callbacks">
  473. <title>Callbacks von Abonnenten behandeln</title>
  474. <para>
  475. Wann auch immer eine Aboanfrage oder eine Anfrage auf Löschen eines Abos gemacht
  476. wird muss der Hub die Anfrage prüfen indem er eine neue Prüfanfrage an die Callback
  477. URL weiterleitet welche in den Abo/Abo löschen Parametern gesetzt ist. Um diese Hub
  478. Anfragen zu behandeln, welche alle zukünftigen Kommunikationen enthalten können wie
  479. z.B. Themenaktualisierungen (Feed), sollte die Callback URL die Ausführung einer
  480. Instanz von <classname>Zend_Pubsubhubbub_Subscriber_Callback</classname> auslösen um
  481. die Anfrage zu behandeln.
  482. </para>
  483. <para>
  484. Die Callback Klasse sollte konfiguriert werden dass Sie das selbe Speichermedium wie
  485. die Subscriber Klasse verwendet. Ihre Verwendung ist sehr einfach da die meiste
  486. Arbeit intern erledigt wird.
  487. </para>
  488. <programlisting language="php"><![CDATA[
  489. $storage = new Zend_Feed_Pubsubhubbub_Model_Subscription;
  490. $callback = new Zend_Feed_Pubsubhubbub_Subscriber_Callback;
  491. $callback->setStorage($storage);
  492. $callback->handle();
  493. $callback->sendResponse();
  494. /**
  495. * Prüfe ob der resultierende Callback das Ergebnis eines Feed Updates ist.
  496. * Andernfalls war es entweder eine (De-)Abo-Prüfanfrage oder ungültig.
  497. * Typischerweise müssen wir nicht mehr tun als die Behandlung der
  498. * Aktualisierungen vom Feed hinzuzufügen - der Rest wird intern von der
  499. * Klasse behandelt.
  500. */
  501. if ($callback->hasFeedUpdate()) {
  502. $feedString = $callback->getFeedUpdate();
  503. /**
  504. * Die Aktualisierung des Feeds asynchron bearbeiten um ein Timeout
  505. * des Hubs zu vermeiden.
  506. */
  507. }
  508. ]]></programlisting>
  509. <note>
  510. <para>
  511. Es sollte beachtet werden dass
  512. <classname>Zend_Feed_Pubsubhubbub_Subscriber_Callback</classname> jeden
  513. hereinkommenden Anfragestring und andere Parameter unabhängig parsen kann. Dies
  514. ist notwendig da PHP die Struktur und Schlüssel eines Abfragestrings ändert wenn
  515. diese in die Superglobals <varname>$_GET</varname> oder
  516. <varname>$_POST</varname> geparst wird. Zum Beispiel werden alle doppelten
  517. Schlüssel ignoriert und Punkte werden in Unterstriche konvertiert.
  518. Pubsubhubbub unterstützt beide in den Abfragestring die es erzeugt.
  519. </para>
  520. </note>
  521. <important>
  522. <para>
  523. Es ist wichtig das Entwickler erkennen das Hubs nur mit dem Senden von Anfragen
  524. und dem Empfangen einer Antwort beschäftigt sind welche den Empfang prüft. Wenn
  525. eine Feedaktualisierung empfangen wird sollte Sie niemals nachfolgend bearbeitet
  526. werden da Sie den Hub auf eine Antwort warten lässt. Stattdessen sollte jede
  527. Bearbeitung auf einen anderen Prozess ausgelagert werden oder verzögert bis eine
  528. Antwort zum Hub zurückgesendet wird. Ein Symptom des Fehlers Hubanfragen sofort
  529. zu komplettieren besteht darin das ein Hub weitere Versuche durchführen kann die
  530. Aktualisierungs- oder Prüfanfrage zuzustellen was zu doppelten
  531. Aktualisierungsversuchen führen kann die vom Abonnenten bearbeitet werden. Das
  532. scheint problematisch zu sein -- aber in Wirklichkeit kann ein Hub ein Timeout
  533. von ein paar Sekunden anwenden, und wenn keine Antwort in dieser Zeit empfangen
  534. wird kann er trennen (in der annahme eines Zustellfehlers) und es später nochmal
  535. versuchen. Es ist zu beachten das von Hubs erwartet wird das Wie große Mengen an
  536. Aktualisierungen verteilen und Ihre Ressources deswegen gestreckt sind - bitte
  537. bearbeiten Sie Feeds asynchron (z.B. in einem separaten Prozess oder einer Job
  538. Queue oder sogar in einem geplanten Cron Task) soweit das möglich ist.
  539. </para>
  540. </important>
  541. </sect3>
  542. <sect3
  543. id="zend.feed.pubsubhubbub.zend.feed.pubsubhubbub.subscriber.setting.up.and.using.a.callback.url.route">
  544. <title>Eine Callback URL Route einstellen und verwenden</title>
  545. <para>
  546. Wie vorher erwähnt empfängt die Klasse
  547. <classname>Zend_Feed_Pubsubhubbub_Subscriber_Callback</classname> den kombinierten
  548. Schlüssel welche mit jedem Abo assoziiert ist vom Hub über eine oder zwei Methoden.
  549. Die technisch bevorzugte Methode ist das Hinzufügen dieses Schlüssels zur Callback
  550. URL welcher für den Hub in allen zukünftigen Anfragen tätig ist indem ein
  551. Stringparameter in der Abfrage mit dem Schlüssel "xhub.subscription" verwendet wird.
  552. Trotzdem, aus historischen Gründen, weil es in Pubsubhubbub 0.1 nicht unterstützt
  553. wurde (es wurde kürzlich nur in 0.2 hinzugefügt) ist es stärkstens empfohlen das
  554. kompatibelste zu verwenden und den Schlüssel der Callback URL hinzuzugefügen indem
  555. er den URL Pfaden angehängt wird.
  556. </para>
  557. <para>
  558. Deshalb würde die URL http://www.example.com/callback?xhub.subscription=key zu
  559. http://www.example.com/callback/key werden.
  560. </para>
  561. <para>
  562. Da die Abfragestring Methode der Standard in der Vermeidung eines größeren Levels
  563. der zukünftigen Unterstützung der kompletten 0.2 Spezifikation ist, benötigt es
  564. etwas zusätzliche Arbeit um Sie zu implementieren.
  565. </para>
  566. <para>
  567. Der erste Schritt besteht darin der Klasse
  568. <classname>Zend_Feed_Pubsubhubbub_Subscriber_Callback</classname> dem Pfad bewusst
  569. zu machen welcher den Aboschlüssel enthält. Er wird hierfür manuell injiziert, da
  570. man für diesen Zweck auch eine Route manuell definieren muss. Das wird erzielt indem
  571. einfach die Methode
  572. <methodname>Zend_Feed_Pubsubhubbub_Subscriber_Callback::setSubscriptionKey()</methodname>
  573. mit dem Parameter aufgerufen wird welcher der Schlüsselwert ist der vom Router
  574. kommt. Das folgende Beispiel zeigt dies durch Verwendung eines Zend Framework
  575. Controllers.
  576. </para>
  577. <programlisting language="php"><![CDATA[
  578. class CallbackController extends Zend_Controller_Action
  579. {
  580. public function indexAction()
  581. {
  582. $storage = new Zend_Feed_Pubsubhubbub_Model_Subscription;
  583. $callback = new Zend_Feed_Pubsubhubbub_Subscriber_Callback;
  584. $callback->setStorage($storage);
  585. /**
  586. * Injiziert den Aboschlüssel welcher er vom URL Pfad geparst wird
  587. * indem ein Parameter vom Router verwendet wird
  588. */
  589. $subscriptionKey = $this->_getParam('subkey');
  590. $callback->setSubscriptionKey($subscriptionKey);
  591. $callback->handle();
  592. $callback->sendResponse();
  593. /**
  594. * Prüfen ob der Callback als Ergebnis den Empfang eines Feed Updates
  595. * enthält. Anderfalls war es entweder eine De-Aboprüfungsanfrage oder
  596. * eine ungültige Anfrage. Typischerweise muss nichts anderes getan
  597. * werden als das Handling der Feedaktualisierungen hinzuzufügen - der
  598. * Rest wird intern von der Klasse behandelt.
  599. */
  600. if ($callback->hasFeedUpdate()) {
  601. $feedString = $callback->getFeedUpdate();
  602. /**
  603. * Die Aktualisierung des Feeds asynchron behandeln um Hub
  604. * Timeouts zu vermeiden.
  605. */
  606. }
  607. }
  608. }
  609. ]]></programlisting>
  610. <para>
  611. Aktuell kann das Hinzufügen der Route zu einem Parameter welcher den Schlüssel der an
  612. den Pfad angehängt wird mappen würde durchgeführt werden indem eine Routenkonfiguration
  613. wie im kommenden INI formatierten Beispiel für die Verwendung mit dem Bootstrapping von
  614. <classname>Zend_Application</classname> verwendet wird.
  615. </para>
  616. <programlisting language="dosini"><![CDATA[
  617. ; Callback Route fürs Hinzufügen einer PuSH Aboschlüssel Abfrage zu aktivieren
  618. resources.router.routes.callback.route = "callback/:subkey"
  619. resources.router.routes.callback.defaults.module = "default"
  620. resources.router.routes.callback.defaults.controller = "callback"
  621. resources.router.routes.callback.defaults.action = "index"
  622. ]]></programlisting>
  623. </sect3>
  624. </sect2>
  625. </sect1>