src/jabber_whiteboard/pedroxmpp.h

   1 #ifndef __XMPP_H__
   2 #define __XMPP_H__
   3 /*
   4  * API for the Pedro mini-XMPP client.
   5  *
   6  * Authors:
   7  *   Bob Jamison
   8  *
   9  * Copyright (C) 2005 Bob Jamison
  10  *
  11  *  This library is free software; you can redistribute it and/or
  12  *  modify it under the terms of the GNU Lesser General Public
  13  *  License as published by the Free Software Foundation; either
  14  *  version 2.1 of the License, or (at your option) any later version.
  15  *
  16  *  This library is distributed in the hope that it will be useful,
  17  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19  *  Lesser General Public License for more details.
  20  *
  21  *  You should have received a copy of the GNU Lesser General Public
  22  *  License along with this library; if not, write to the Free Software
  23  *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  24  */
  25
  26 #include <stdio.h>
  27 #include <vector>
  28
  29 #include <string>
  30
  31 #include "pedrodom.h"
  32
  33 namespace Pedro
  34 {
  35
  36 typedef std::string DOMString;
  37
  38
  39 //########################################################################
  40 //# X M P P    E V E N T
  41 //########################################################################
  42 class XmppUser
  43 {
  44 public:
  45     XmppUser()
  46         {
  47         }
  48     XmppUser(const DOMString &jidArg, const DOMString &nickArg)
  49         {
  50         jid  = jidArg;
  51         nick = nickArg;
  52         }
  53     XmppUser(const DOMString &jidArg,          const DOMString &nickArg,
  54              const DOMString &subscriptionArg, const DOMString &groupArg)
  55         {
  56         jid          = jidArg;
  57         nick         = nickArg;
  58         subscription = subscriptionArg;
  59         group        = groupArg;
  60         }
  61     XmppUser(const XmppUser &other)
  62         {
  63         jid          = other.jid;
  64         nick         = other.nick;
  65         subscription = other.subscription;
  66         group        = other.group;
  67         show         = other.show;
  68         }
  69     XmppUser &operator=(const XmppUser &other)
  70         {
  71         jid          = other.jid;
  72         nick         = other.nick;
  73         subscription = other.subscription;
  74         group        = other.group;
  75         show         = other.show;
  76         return *this;
  77         }
  78     virtual ~XmppUser()
  79         {}
  80     DOMString jid;
  81     DOMString nick;
  82     DOMString subscription;
  83     DOMString group;
  84     DOMString show;
  85 };
  86
  87 class XmppEvent
  88 {
  89
  90 public:
  91
  92 typedef enum
  93     {
  94     EVENT_NONE,
  95     EVENT_STATUS,
  96     EVENT_ERROR,
  97     EVENT_CONNECTED,
  98     EVENT_DISCONNECTED,
  99     EVENT_PRESENCE,
 100     EVENT_ROSTER,
 101     EVENT_MESSAGE,
 102     EVENT_MUC_JOIN,
 103     EVENT_MUC_LEAVE,
 104     EVENT_MUC_PRESENCE,
 105     EVENT_MUC_MESSAGE,
 106     EVENT_STREAM_RECEIVE_INIT,
 107     EVENT_STREAM_RECEIVE,
 108     EVENT_STREAM_RECEIVE_CLOSE,
 109     EVENT_FILE_ACCEPTED,
 110     EVENT_FILE_RECEIVE
 111     } XmppEventType;
 112
 113
 114     /**
 115      *
 116      */
 117     XmppEvent(int type);
 118
 119     /**
 120      *
 121      */
 122     XmppEvent(const XmppEvent &other);
 123
 124     /**
 125      *
 126      */
 127     virtual XmppEvent &operator=(const XmppEvent &other);
 128
 129     /**
 130      *
 131      */
 132     virtual ~XmppEvent();
 133
 134     /**
 135      *
 136      */
 137     virtual void assign(const XmppEvent &other);
 138
 139     /**
 140      *
 141      */
 142     virtual int getType() const;
 143
 144
 145     /**
 146      *
 147      */
 148     virtual DOMString getIqId() const;
 149
 150
 151     /**
 152      *
 153      */
 154     virtual void setIqId(const DOMString &val);
 155
 156     /**
 157      *
 158      */
 159     virtual DOMString getStreamId() const;
 160
 161
 162     /**
 163      *
 164      */
 165     virtual void setStreamId(const DOMString &val);
 166
 167     /**
 168      *
 169      */
 170     virtual bool getPresence() const;
 171
 172
 173     /**
 174      *
 175      */
 176     virtual void setPresence(bool val);
 177
 178     /**
 179      *
 180      */
 181     virtual DOMString getShow() const;
 182
 183
 184     /**
 185      *
 186      */
 187     virtual void setShow(const DOMString &val);
 188
 189     /**
 190      *
 191      */
 192     virtual DOMString getStatus() const;
 193
 194     /**
 195      *
 196      */
 197     virtual void setStatus(const DOMString &val);
 198
 199     /**
 200      *
 201      */
 202     virtual DOMString getTo() const;
 203
 204     /**
 205      *
 206      */
 207     virtual void setTo(const DOMString &val);
 208
 209     /**
 210      *
 211      */
 212     virtual DOMString getFrom() const;
 213
 214     /**
 215      *
 216      */
 217     virtual void setFrom(const DOMString &val);
 218
 219     /**
 220      *
 221      */
 222     virtual DOMString getGroup() const;
 223
 224     /**
 225      *
 226      */
 227     virtual void setGroup(const DOMString &val);
 228
 229     /**
 230      *
 231      */
 232     virtual Element *getDOM() const;
 233
 234
 235     /**
 236      *
 237      */
 238     virtual void setDOM(const Element *val);
 239
 240     /**
 241      *
 242      */
 243     virtual std::vector<XmppUser> getUserList() const;
 244
 245     /**
 246      *
 247      */
 248     virtual void setUserList(const std::vector<XmppUser> &userList);
 249
 250     /**
 251      *
 252      */
 253     virtual DOMString getFileName() const;
 254
 255
 256     /**
 257      *
 258      */
 259     virtual void setFileName(const DOMString &val);
 260
 261
 262     /**
 263      *
 264      */
 265     virtual DOMString getFileDesc() const;
 266
 267
 268     /**
 269      *
 270      */
 271     virtual void setFileDesc(const DOMString &val);
 272
 273
 274     /**
 275      *
 276      */
 277     virtual long getFileSize() const;
 278
 279
 280     /**
 281      *
 282      */
 283     virtual void setFileSize(long val);
 284
 285     /**
 286      *
 287      */
 288     virtual DOMString getFileHash() const;
 289
 290     /**
 291      *
 292      */
 293     virtual void setFileHash(const DOMString &val);
 294
 295     /**
 296      *
 297      */
 298     virtual DOMString getData() const;
 299
 300
 301     /**
 302      *
 303      */
 304     virtual void setData(const DOMString &val);
 305
 306 private:
 307
 308     int eventType;
 309
 310     DOMString iqId;
 311
 312     DOMString streamId;
 313
 314     bool      presence;
 315
 316     DOMString show;
 317
 318     DOMString status;
 319
 320     DOMString to;
 321
 322     DOMString from;
 323
 324     DOMString group;
 325
 326     DOMString data;
 327
 328     DOMString fileName;
 329     DOMString fileDesc;
 330     long      fileSize;
 331     DOMString fileHash;
 332
 333     Element *dom;
 334
 335     std::vector<XmppUser>userList;
 336
 337 };
 338
 339
 340 //########################################################################
 341 //# X M P P    E V E N T    L I S T E N E R
 342 //########################################################################
 343
 344 class XmppEventListener
 345 {
 346 public:
 347
 348     /**
 349      *
 350      */
 351     XmppEventListener()
 352         {}
 353
 354     /**
 355      *
 356      */
 357     XmppEventListener(const XmppEventListener &other)
 358         {}
 359
 360     /**
 361      *
 362      */
 363     virtual void operator=(const XmppEventListener &other)
 364         {}
 365
 366     /**
 367      *
 368      */
 369     virtual ~XmppEventListener()
 370         {}
 371
 372     /**
 373      *
 374      */
 375     virtual void processXmppEvent(const XmppEvent &event)
 376         {}
 377
 378 };
 379
 380
 381
 382 //########################################################################
 383 //# X M P P    E V E N T    T A R G E T
 384 //########################################################################
 385
 386 class XmppEventTarget
 387 {
 388 public:
 389
 390     /**
 391      *
 392      */
 393     XmppEventTarget();
 394
 395     /**
 396      *
 397      */
 398     XmppEventTarget(const XmppEventTarget &other);
 399
 400     /**
 401      *
 402      */
 403     virtual ~XmppEventTarget();
 404
 405
 406     //###########################
 407     //# M E S S A G E S
 408     //###########################
 409
 410
 411     /**
 412      * Send an error message to all subscribers
 413      */
 414     void error(char *fmt, ...);
 415
 416
 417     /**
 418      * Send a status message to all subscribers
 419      */
 420     void status(char *fmt, ...);
 421
 422     //###########################
 423     //# LISTENERS
 424     //###########################
 425
 426     /**
 427      *
 428      */
 429     virtual void dispatchXmppEvent(const XmppEvent &event);
 430
 431     /**
 432      *
 433      */
 434     virtual void addXmppEventListener(const XmppEventListener &listener);
 435
 436     /**
 437      *
 438      */
 439     virtual void removeXmppEventListener(const XmppEventListener &listener);
 440
 441     /**
 442      *
 443      */
 444     virtual void clearXmppEventListeners();
 445
 446     /**
 447      *
 448      */
 449     void eventQueueEnable(bool val);
 450
 451     /**
 452      *
 453      */
 454     int eventQueueAvailable();
 455
 456     /**
 457      *
 458      */
 459     XmppEvent eventQueuePop();
 460
 461
 462 private:
 463
 464     std::vector<XmppEventListener *> listeners;
 465
 466     std::vector<XmppEvent> eventQueue;
 467     bool eventQueueEnabled;
 468
 469     static const int targetWriteBufLen = 2048;
 470
 471     char targetWriteBuf[targetWriteBufLen];
 472 };
 473
 474
 475
 476
 477
 478 //########################################################################
 479 //# X M P P    C L I E N T
 480 //########################################################################
 481
 482
 483 class TcpSocket;
 484 class XmppChat;
 485 class XmppGroupChat;
 486 class XmppStream;
 487
 488 class XmppClient : public XmppEventTarget
 489 {
 490
 491 public:
 492
 493     //###########################
 494     //# CONSTRUCTORS
 495     //###########################
 496
 497     /**
 498      *
 499      */
 500     XmppClient();
 501
 502     /**
 503      *
 504      */
 505     XmppClient(const XmppClient &other);
 506
 507     /**
 508      *
 509      */
 510     void assign(const XmppClient &other);
 511
 512     /**
 513      *
 514      */
 515     virtual ~XmppClient();
 516
 517
 518     //###########################
 519     //# UTILITY
 520     //###########################
 521
 522     /**
 523      *
 524      */
 525     virtual bool pause(unsigned long millis);
 526
 527     //###########################
 528     //# CONNECTION
 529     //###########################
 530
 531     /**
 532      *
 533      */
 534     virtual bool connect();
 535
 536     /**
 537      *
 538      */
 539     virtual bool connect(DOMString host, int port,
 540                          DOMString userName,
 541                          DOMString password,
 542                          DOMString resource);
 543
 544     /**
 545      *
 546      */
 547     virtual bool disconnect();
 548
 549
 550     /**
 551      *
 552      */
 553     virtual bool write(char *fmt, ...);
 554
 555     /**
 556      *
 557      */
 558     virtual bool isConnected()
 559         { return connected; }
 560
 561     /**
 562      *
 563      */
 564     virtual DOMString getHost()
 565         { return host; }
 566
 567     /**
 568      *
 569      */
 570     virtual void setHost(const DOMString &val)
 571         { host = val; }
 572
 573     /**
 574      *
 575      */
 576     virtual DOMString getRealm()
 577         { return realm; }
 578
 579     /**
 580      *
 581      */
 582     virtual void setRealm(const DOMString &val)
 583         { realm = val; }
 584
 585     /**
 586      *
 587      */
 588     virtual int getPort()
 589         { return port; }
 590
 591     /**
 592      *
 593      */
 594     virtual void setPort(int val)
 595         { port = val; }
 596
 597     /**
 598      *
 599      */
 600     virtual DOMString getUsername();
 601
 602     /**
 603      *
 604      */
 605     virtual void setUsername(const DOMString &val);
 606
 607     /**
 608      *
 609      */
 610     virtual DOMString getPassword()
 611         { return password; }
 612
 613     /**
 614      *
 615      */
 616     virtual void setPassword(const DOMString &val)
 617         { password = val; }
 618
 619     /**
 620      *
 621      */
 622     virtual DOMString getResource()
 623         { return resource; }
 624
 625     /**
 626      *
 627      */
 628     virtual void setResource(const DOMString &val)
 629         { resource = val; }
 630
 631     /**
 632      *
 633      */
 634     virtual DOMString getJid()
 635         { return jid; }
 636     /**
 637      *
 638      */
 639     virtual int getMsgId()
 640         { return msgId++; }
 641
 642     /**
 643      *
 644      */
 645     bool processMessage(Element *root);
 646
 647     /**
 648      *
 649      */
 650     bool processPresence(Element *root);
 651
 652     /**
 653      *
 654      */
 655     bool processIq(Element *root);
 656
 657     /**
 658      *
 659      */
 660     virtual bool receiveAndProcess();
 661
 662     /**
 663      *
 664      */
 665     virtual bool receiveAndProcessLoop();
 666
 667     //#######################
 668     //# ROSTER
 669     //#######################
 670
 671     /**
 672      *
 673      */
 674     bool rosterAdd(const DOMString &rosterGroup,
 675                    const DOMString &otherJid,
 676                    const DOMString &name);
 677
 678     /**
 679      *
 680      */
 681     bool rosterDelete(const DOMString &otherJid);
 682
 683     /**
 684      *
 685      */
 686     std::vector<XmppUser> getRoster();
 687
 688
 689     //#######################
 690     //# CHAT (individual)
 691     //#######################
 692
 693     /**
 694      *
 695      */
 696     virtual bool message(const DOMString &user, const DOMString &subj,
 697                          const DOMString &text);
 698
 699     /**
 700      *
 701      */
 702     virtual bool message(const DOMString &user, const DOMString &text);
 703
 704     /**
 705      *
 706      */
 707     virtual bool presence(const DOMString &presence);
 708
 709     //#######################
 710     //# GROUP CHAT
 711     //#######################
 712
 713     /**
 714      *
 715      */
 716     virtual bool groupChatCreate(const DOMString &groupJid);
 717
 718     /**
 719      *
 720      */
 721     virtual void groupChatDelete(const DOMString &groupJid);
 722
 723     /**
 724      *
 725      */
 726     bool groupChatExists(const DOMString &groupJid);
 727
 728     /**
 729      *
 730      */
 731     virtual void groupChatsClear();
 732
 733     /**
 734      *
 735      */
 736     virtual void groupChatUserAdd(const DOMString &groupJid,
 737                                   const DOMString &nick);
 738
 739     /**
 740      *
 741      */
 742     virtual void groupChatUserDelete(const DOMString &groupJid,
 743                                      const DOMString &nick);
 744
 745     /**
 746      *
 747      */
 748     virtual std::vector<XmppUser>
 749           groupChatGetUserList(const DOMString &groupJid);
 750
 751     /**
 752      *
 753      */
 754     virtual bool groupChatJoin(const DOMString &groupJid,
 755                                const DOMString &nick,
 756                                const DOMString &pass);
 757
 758     /**
 759      *
 760      */
 761     virtual bool groupChatLeave(const DOMString &groupJid,
 762                                 const DOMString &nick);
 763
 764     /**
 765      *
 766      */
 767     virtual bool groupChatMessage(const DOMString &groupJid,
 768                                   const DOMString &msg);
 769
 770     /**
 771      *
 772      */
 773     virtual bool groupChatPrivateMessage(const DOMString &groupJid,
 774                                          const DOMString &toNick,
 775                                          const DOMString &msg);
 776
 777     /**
 778      *
 779      */
 780     virtual bool groupChatPresence(const DOMString &groupJid,
 781                                    const DOMString &nick,
 782                                    const DOMString &presence);
 783
 784
 785     //#######################
 786     //# STREAMS
 787     //#######################
 788
 789     typedef enum
 790         {
 791         STREAM_AVAILABLE,
 792         STREAM_OPENING,
 793         STREAM_OPEN,
 794         STREAM_CLOSING,
 795         STREAM_CLOSED,
 796         STREAM_ERROR
 797         } StreamStates;
 798
 799     /**
 800      *
 801      */
 802     virtual int outputStreamOpen(const DOMString &jid,
 803                                  const DOMString &streamId);
 804
 805     /**
 806      *
 807      */
 808     virtual int outputStreamWrite(int streamId,
 809                           const unsigned char *buf, unsigned long len);
 810
 811     /**
 812      *
 813      */
 814     virtual int outputStreamClose(int streamId);
 815
 816     /**
 817      *
 818      */
 819     virtual int inputStreamOpen(const DOMString &jid,
 820                                 const DOMString &streamId,
 821                                 const DOMString &iqId);
 822
 823     /**
 824      *
 825      */
 826     virtual int inputStreamAvailable(int streamId);
 827
 828     /**
 829      *
 830      */
 831     virtual std::vector<unsigned char> inputStreamRead(int streamId);
 832
 833     /**
 834      *
 835      */
 836     virtual bool inputStreamClosing(int streamId);
 837
 838     /**
 839      *
 840      */
 841     virtual int inputStreamClose(int streamId);
 842
 843
 844     //#######################
 845     //# FILE   TRANSFERS
 846     //#######################
 847
 848     /**
 849      *
 850      */
 851     virtual bool fileSend(const DOMString &destJid,
 852                           const DOMString &offeredName,
 853                           const DOMString &fileName,
 854                           const DOMString &description);
 855
 856     /**
 857      *
 858      */
 859     virtual bool fileSendBackground(const DOMString &destJid,
 860                                     const DOMString &offeredName,
 861                                     const DOMString &fileName,
 862                                     const DOMString &description);
 863
 864     /**
 865      *
 866      */
 867     virtual bool fileReceive(const DOMString &fromJid,
 868                              const DOMString &iqId,
 869                              const DOMString &streamId,
 870                              const DOMString &fileName,
 871                              long  fileSize,
 872                              const DOMString &fileHash);
 873     /**
 874      *
 875      */
 876     virtual bool fileReceiveBackground(const DOMString &fromJid,
 877                                        const DOMString &iqId,
 878                                        const DOMString &streamId,
 879                                        const DOMString &fileName,
 880                                        long  fileSize,
 881                                        const DOMString &fileHash);
 882
 883
 884 private:
 885
 886     void init();
 887
 888     DOMString host;
 889
 890     /**
 891      * will be same as host, unless username is
 892      * user@realm
 893      */
 894     DOMString realm;
 895
 896     int port;
 897
 898     DOMString username;
 899
 900     DOMString password;
 901
 902     DOMString resource;
 903
 904     DOMString jid;
 905
 906     int msgId;
 907
 908     TcpSocket *sock;
 909
 910     bool connected;
 911
 912     bool createSession();
 913
 914     bool checkConnect();
 915
 916     DOMString readStanza();
 917
 918     bool saslMd5Authenticate();
 919
 920     bool saslPlainAuthenticate();
 921
 922     bool saslAuthenticate();
 923
 924     bool iqAuthenticate(const DOMString &streamId);
 925
 926     bool keepGoing;
 927
 928     static const int writeBufLen = 2048;
 929
 930     unsigned char writeBuf[writeBufLen];
 931
 932     std::vector<XmppGroupChat *>groupChats;
 933
 934     static const int outputStreamCount = 16;
 935
 936     XmppStream *outputStreams[outputStreamCount];
 937
 938     static const int inputStreamCount = 16;
 939
 940     XmppStream *inputStreams[inputStreamCount];
 941
 942     static const int fileSendCount = 16;
 943
 944     XmppStream *fileSends[fileSendCount];
 945
 946     std::vector<XmppUser>roster;
 947 };
 948
 949
 950
 951
 952 //########################################################################
 953 //# X M P P    G R O U P    C H A T
 954 //########################################################################
 955
 956 /**
 957  *
 958  */
 959 class XmppGroupChat
 960 {
 961 public:
 962
 963     /**
 964      *
 965      */
 966     XmppGroupChat(const DOMString &groupJid);
 967
 968     /**
 969      *
 970      */
 971     XmppGroupChat(const XmppGroupChat &other);
 972
 973     /**
 974      *
 975      */
 976     virtual ~XmppGroupChat();
 977
 978     /**
 979      *
 980      */
 981     virtual DOMString getGroupJid();
 982
 983     /**
 984      *
 985      */
 986     virtual void userAdd(const DOMString &jid, const DOMString &nick);
 987
 988     /**
 989      *
 990      */
 991     virtual void userDelete(const DOMString &jid, const DOMString &nick);
 992
 993     /**
 994      *
 995      */
 996     virtual std::vector<XmppUser> getUserList() const;
 997
 998
 999 private:
1000
1001     DOMString groupJid;
1002
1003     std::vector<XmppUser>userList;
1004
1005 };
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016 } //namespace Pedro
1017
1018 #endif /* __XMPP_H__ */
1019
1020 //########################################################################
1021 //# E N D    O F     F I L E
1022 //########################################################################
1023