client_protocol.h

/*
    Copyright (c) 2014 by Elvis Angelaccio

    Permission is hereby granted, free of charge, to any person obtaining a copy
    of this software and associated documentation files (the "Software"), to deal
    in the Software without restriction, including without limitation the rights
    to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
    copies of the Software, and to permit persons to whom the Software is
    furnished to do so, subject to the following conditions:

    The above copyright notice and this permission notice shall be included in
    all copies or substantial portions of the Software.

    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
    THE SOFTWARE.
*/

#ifndef CLIENT_PROTOCOL_H
#define CLIENT_PROTOCOL_H

#include <string>
#include <vector>
#include <map>
#include <set>

#include "protocol.h"

namespace net
{

    class ResponseMessage 
    {
    public:
        ResponseMessage();
        ResponseMessage(ResponseCode code);
        
        ResponseCode getResponseCode() const;
        
        friend std::ostream& operator<<(std::ostream& os, const ResponseMessage& msg);
        
    protected:
        
        ResponseCode responseCode;
    };
    
    
    class InsertResponse : public ResponseMessage
    {
    public:
        InsertResponse(ResponseCode code);
        
        void setSequenceNumber(int sn);
        
        friend std::ostream& operator<<(std::ostream& os, const InsertResponse& msg);
        
    private:
        
        int sequenceNumber;
    };

    class GetResponse : public ResponseMessage
    {  
    public:
        GetResponse(ResponseCode code);
        
        void setSdSize(int s);
        int getSdSize() const;
        void setSequenceNumber(int sn);
        int getSequenceNumber() const;
        void setFilesNumber(int n);
        int getFilesNumber() const;     
        const std::map<std::string, std::string>& getSdFields() const;
        const std::map<std::string, std::string>& getDataItems() const;
        std::map<std::string, std::string>& getDataItems();
        void addSetDescriptorField(const std::string& key, const std::string& value);
        void addDataItem(const std::string& itemName, const std::string& itemFile);
        
        friend std::ostream& operator<<(std::ostream& os, const GetResponse& msg);
        
    private:
        
        int sdSize;                                             
        int sequenceNumber;                                         
        int filesNumber;                                            
        std::map<std::string, std::string> setDescriptorFields;     
        std::map<std::string, std::string> dataItems;               
    };
    
    
    class SearchResponse : public ResponseMessage
    {
    public:
        SearchResponse(ResponseCode code);

        void setFoundCount(int c);
        int getFoundCount() const;
        void addSdFields(int sn, const std::map<std::string, std::string>& fields);

        friend std::ostream& operator<<(std::ostream& os, const SearchResponse& msg);

    private:

        int foundCount;                                                         
        std::map<int, std::map<std::string, std::string> > setDescriptorFields;     
    };

    class SpeclistResponse : public ResponseMessage
    {
    public:
                    
        SpeclistResponse(ResponseCode code);
        
        void setDssNumber(int n);
        void addDssEntry(const std::string& dssEntry);
        
        friend std::ostream& operator<<(std::ostream& os, const SpeclistResponse& msg);

    private:
        
        int dssNumber;                      
        std::vector<std::string> dssList;       
    };


    class ProtocolHandler
    {
    public:
        
       /*
        * Create the "raw" messages with the client requests, starting from a "structured" input (i.e. single strings and containters).
        * The given input is formatted in a single string according to the protocol syntax.
        */
        std::string createInsertRequest(const std::string& dssName, std::map<std::string, std::string>& sdFields, const std::map<std::string, std::string>& dataItems);
        std::string createRemoveRequest(const std::string& sequenceNumber, const std::string& dssName);
        std::string createGetRequest(const std::string& sequenceNumber, const std::string& dssName);
        std::string createSearchRequest(const std::string& dssName, std::map<std::string, std::string>& sdQueryFields);
        
        
       /*
        * Create the "raw" messages with the client requests, starting form a "raw, non-structured" input (i.e. one single string).
        * The given string is parsed and a new string is formatted according to the protocol syntax, for simple REMOVE and GET requests.
        * For INSERT and SEARCH requests the given string is parsed and the above functions are called.
        */
        std::string createInsertRequest(const std::string& input, std::map<std::string, std::string>& dataItems);
        std::string createRemoveRequest(const std::string& input);
        std::string createGetRequest(const std::string& input);
        std::string createSearchRequest(const std::string& input);
        
        
       /*
        * Convenience functions to parse a server "raw"response into a much more handy ResponseMessage.
        * @param response The raw server response message.
        * @return The resulting ResponseMessage object.
        */
        ResponseMessage parseResponseMessage(const std::string& response);
        InsertResponse parseInsertResponse(const std::string& response);
        GetResponse parseGetResponse(const std::string& response);
        SearchResponse parseSearchResponse(const std::string& response);
        SpeclistResponse parseSpeclistResponse(const std::string& response);
                
        std::string getExtendedErrorMessage(ResponseCode code);
    };


    std::string responseCodeString(ResponseCode code);

}

#endif