protocol_message_formatter.h

Go to the documentation of this file.

/*                                      -*-C++-*-
    Classified Ads is Copyright (c) Antti Jarvinen 2013.

    This file is part of Classified Ads.

    Classified Ads is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    Classified Ads is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with Classified Ads.  If not, see <http://www.gnu.org/licenses/>.
*/



#ifndef PROTOCOL_MESSAGE_FORMATTER_H
#define PROTOCOL_MESSAGE_FORMATTER_H
#include "protocol.h"
#include <QByteArray>
#include <QPair>
#include "../datamodel/searchmodel.h"

class Connection ;
class Node ;

class ProtocolMessageFormatter {
public:
  static QByteArray nodeGreeting(const Node& aNode) ;
  static QByteArray randomNumbers(void) ;

  static QByteArray requestForNodesAroundHash (const Hash& aHash) ;

  static QByteArray requestForBinaryBlob(const Hash& aHash) ;
  static QByteArray requestForUserProfile(const Hash& aHash) ;
  static QByteArray requestForUserProfileComment(const Hash& aIndividualCommentHash) ;
  static QByteArray requestForClassifiedAd(const Hash& aHash) ;
  static QByteArray requestForPrivateMessages(const Hash& aMessageHash) ;
  static QByteArray requestForPrivateMessagesForProfile(const Hash& aProfileHash,
                            const quint32 aTimeOfOldestMsgToSend) ;
  static QByteArray requestForProfileComments(const Hash& aCommentedProfileHash,
                          const quint32 aTimeOfOldestMsgToSend) ;
  static QByteArray requestForAdsClassified(const Hash& aHashOfClassification,
                        const quint32 aStartingTimestamp,
                        const quint32 aEndingTimestamp) ;
  static QByteArray contentPublish(const unsigned char aContentMagicNumber,
                   const Hash& aContentHash,
                   const QByteArray& aContent,
                   const QByteArray& aSignature,
                   const QList<quint32>& aBangPath,
                   const QByteArray& aSigningKey,
                   bool aIsContentEncrypted,
                   bool aIsContentCompressed,
                   quint32 aTimeStamp ) ;
  static QByteArray privMsgPublish(const Hash& aContentHash,
                   const QByteArray& aContent,
                   const QByteArray& aSignature,
                   const QList<quint32>& aBangPath,
                   const Hash& aDestination,
                   const Hash& aRecipient,
                   quint32 aTimeStamp ) ;
  static QByteArray privMsgSend(const Hash& aContentHash,
                const QByteArray& aContent,
                const QByteArray& aSignature,
                const Hash& aDestination,
                const Hash& aRecipient,
                quint32 aTimeStamp ) ;
  static QByteArray profileCommentPublish(const Hash& aContentHash,
                      const QByteArray& aContent,
                      const QByteArray& aSignature,
                      const QList<quint32>& aBangPath,
                      const Hash& aProfileCommented,
                      quint32 aTimeStamp,
                      quint32 aFlags ) ;
  static QByteArray profileCommentSend(const Hash& aContentHash,
                       const QByteArray& aContent,
                       const QByteArray& aSignature,
                       const Hash& aProfileCommented,
                       quint32 aTimeStamp,
                       quint32 aFlags ) ;
  static QByteArray contentSend(const unsigned char aContentMagicNumber,
                const Hash& aContentHash,
                const QByteArray& aContent,
                const QByteArray& aSignature,
                const QByteArray& aSigningKey,
                bool aIsContentEncrypted,
                bool aIsContentCompressed,
                quint32 aTimeStamp ) ;

  static QByteArray replyToAdsClassified(const Hash& aClassificationHash,
                     const QList<QPair<Hash,quint32> >& aListOfAds  ) ;

  static QByteArray searchSend(const QString& aSearch,
                   bool aSearchAds,
                   bool aSearchProfiles,
                   bool aSearchComments,
                   const Hash& aSearchIdentifier) ;

  static QByteArray searchResultsSend(const QList<SearchModel::SearchResultItem>& aResults,
                      quint32 aSearchId) ;

private:
  static QByteArray doContentSendOrPublish(QByteArray& retval,
                     const unsigned char aContentMagicNumber,
                     const Hash& aContentHash,
                     const QByteArray& aContent,
                     const QByteArray& aSignature,
                     const QList<quint32>& aBangPath,
                     const QByteArray& aSigningKey,
                     bool aIsContentEncrypted,
                     bool aIsContentCompressed,
                     quint32 aTimeStamp,
                     bool aIsPublish) ;
  static QByteArray doCommentSendOrPublish(const Hash& aContentHash,
                       const QByteArray& aContent,
                       const QByteArray& aSignature,
                       const QList<quint32>& aBangPath,
                       const Hash& aProfileCommented,
                       quint32 aTimeStamp,
                       quint32 aFlags,
                       bool aIsPublish) ;
} ;

#endif