10e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.org/* 20e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.org * libjingle 30e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.org * Copyright 2011, Google Inc. 40e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.org * 50e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.org * Redistribution and use in source and binary forms, with or without 60e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.org * modification, are permitted provided that the following conditions are met: 70e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.org * 80e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.org * 1. Redistributions of source code must retain the above copyright notice, 90e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.org * this list of conditions and the following disclaimer. 100e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.org * 2. Redistributions in binary form must reproduce the above copyright notice, 110e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.org * this list of conditions and the following disclaimer in the documentation 120e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.org * and/or other materials provided with the distribution. 130e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.org * 3. The name of the author may not be used to endorse or promote products 140e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.org * derived from this software without specific prior written permission. 150e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.org * 160e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.org * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED 170e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.org * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 180e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.org * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO 190e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.org * EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 200e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.org * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, 210e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.org * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; 220e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.org * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 230e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.org * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR 240e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.org * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF 250e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.org * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 260e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.org */ 270e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.org 280e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.org#ifndef TALK_XMPP_PUBSUBCLIENT_H_ 290e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.org#define TALK_XMPP_PUBSUBCLIENT_H_ 300e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.org 310e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.org#include <string> 320e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.org#include <vector> 330e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.org 340e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.org#include "talk/base/sigslot.h" 350e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.org#include "talk/base/sigslotrepeater.h" 360e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.org#include "talk/base/task.h" 370e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.org#include "talk/xmpp/jid.h" 380e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.org#include "talk/xmpp/pubsubtasks.h" 390e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.org 400e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.org// Easy to use clients built on top of the tasks for XEP-0060 410e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.org// (http://xmpp.org/extensions/xep-0060.html). 420e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.org 430e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.orgnamespace buzz { 440e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.org 450e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.orgclass Jid; 460e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.orgclass XmlElement; 470e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.orgclass XmppTaskParentInterface; 480e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.org 490e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.org// An easy-to-use pubsub client that handles the three tasks of 500e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.org// getting, publishing, and listening for updates. Tied to a specific 510e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.org// pubsub jid and node. All you have to do is RequestItems, listen 520e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.org// for SignalItems and PublishItems. 530e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.orgclass PubSubClient : public sigslot::has_slots<> { 540e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.org public: 550e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.org PubSubClient(XmppTaskParentInterface* parent, 560e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.org const Jid& pubsubjid, 570e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.org const std::string& node) 580e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.org : parent_(parent), 590e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.org pubsubjid_(pubsubjid), 600e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.org node_(node) {} 610e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.org 620e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.org const std::string& node() const { return node_; } 630e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.org 640e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.org // Requests the <pubsub><items>, which will be returned via 650e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.org // SignalItems, or SignalRequestError if there is a failure. Should 660e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.org // auto-subscribe. 670e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.org void RequestItems(); 680e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.org // Fired when either <pubsub><items> are returned or when 690e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.org // <event><items> are received. 700e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.org sigslot::signal2<PubSubClient*, 710e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.org const std::vector<PubSubItem>&> SignalItems; 720e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.org // Signal (this, error stanza) 730e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.org sigslot::signal2<PubSubClient*, 740e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.org const XmlElement*> SignalRequestError; 750e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.org // Signal (this, task_id, item, error stanza) 760e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.org sigslot::signal4<PubSubClient*, 770e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.org const std::string&, 780e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.org const XmlElement*, 790e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.org const XmlElement*> SignalPublishError; 800e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.org // Signal (this, task_id, item) 810e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.org sigslot::signal3<PubSubClient*, 820e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.org const std::string&, 830e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.org const XmlElement*> SignalPublishResult; 840e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.org // Signal (this, task_id, error stanza) 850e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.org sigslot::signal3<PubSubClient*, 860e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.org const std::string&, 870e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.org const XmlElement*> SignalRetractError; 880e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.org // Signal (this, task_id) 890e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.org sigslot::signal2<PubSubClient*, 900e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.org const std::string&> SignalRetractResult; 910e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.org 920e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.org // Publish an item. Takes ownership of payload. 930e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.org void PublishItem(const std::string& itemid, 940e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.org XmlElement* payload, 950e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.org std::string* task_id_out); 960e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.org // Publish an item. Takes ownership of children. 970e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.org void PublishItem(const std::string& itemid, 980e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.org const std::vector<XmlElement*>& children, 990e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.org std::string* task_id_out); 1000e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.org // Retract (delete) an item. 1010e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.org void RetractItem(const std::string& itemid, 1020e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.org std::string* task_id_out); 1030e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.org 1041b5713169ff3f21791214c4500e5d775048c3ba9wu@webrtc.org // Get the publisher nick if it exists from the pubsub item. 1051b5713169ff3f21791214c4500e5d775048c3ba9wu@webrtc.org const std::string GetPublisherNickFromPubSubItem(const XmlElement* item_elem); 1061b5713169ff3f21791214c4500e5d775048c3ba9wu@webrtc.org 1070e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.org private: 1080e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.org void OnRequestError(IqTask* task, 1090e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.org const XmlElement* stanza); 1100e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.org void OnRequestResult(PubSubRequestTask* task, 1110e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.org const std::vector<PubSubItem>& items); 1120e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.org void OnReceiveUpdate(PubSubReceiveTask* task, 1130e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.org const std::vector<PubSubItem>& items); 1140e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.org void OnPublishResult(PubSubPublishTask* task); 1150e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.org void OnPublishError(IqTask* task, 1160e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.org const XmlElement* stanza); 1170e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.org void OnRetractResult(PubSubRetractTask* task); 1180e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.org void OnRetractError(IqTask* task, 1190e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.org const XmlElement* stanza); 1200e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.org 1210e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.org XmppTaskParentInterface* parent_; 1220e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.org Jid pubsubjid_; 1230e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.org std::string node_; 1240e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.org}; 1250e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.org 1260e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.org} // namespace buzz 1270e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.org 1280e118e7129884fbea117e78d6f2068139a414dbhenrike@webrtc.org#endif // TALK_XMPP_PUBSUBCLIENT_H_ 129