OTMessageBuffer.cpp

Go to the documentation of this file.

/************************************************************
 *
 *  OTMessageBuffer.cpp
 *
 */

/************************************************************
 -----BEGIN PGP SIGNED MESSAGE-----
 Hash: SHA1

 *                 OPEN TRANSACTIONS
 *
 *       Financial Cryptography and Digital Cash
 *       Library, Protocol, API, Server, CLI, GUI
 *
 *       -- Anonymous Numbered Accounts.
 *       -- Untraceable Digital Cash.
 *       -- Triple-Signed Receipts.
 *       -- Cheques, Vouchers, Transfers, Inboxes.
 *       -- Basket Currencies, Markets, Payment Plans.
 *       -- Signed, XML, Ricardian-style Contracts.
 *       -- Scripted smart contracts.
 *
 *  Copyright (C) 2010-2013 by "Fellow Traveler" (A pseudonym)
 *
 *  EMAIL:
 *  [email protected]
 *
 *  BITCOIN:  1NtTPVVjDsUfDWybS4BwvHpG2pdS9RnYyQ
 *
 *  KEY FINGERPRINT (PGP Key in license file):
 *  9DD5 90EB 9292 4B48 0484  7910 0308 00ED F951 BB8E
 *
 *  OFFICIAL PROJECT WIKI(s):
 *  https://github.com/FellowTraveler/Moneychanger
 *  https://github.com/FellowTraveler/Open-Transactions/wiki
 *
 *  WEBSITE:
 *  http://www.OpenTransactions.org/
 *
 *  Components and licensing:
 *   -- Moneychanger..A Java client GUI.....LICENSE:.....GPLv3
 *   -- otlib.........A class library.......LICENSE:...LAGPLv3
 *   -- otapi.........A client API..........LICENSE:...LAGPLv3
 *   -- opentxs/ot....Command-line client...LICENSE:...LAGPLv3
 *   -- otserver......Server Application....LICENSE:....AGPLv3
 *  Github.com/FellowTraveler/Open-Transactions/wiki/Components
 *
 *  All of the above OT components were designed and written by
 *  Fellow Traveler, with the exception of Moneychanger, which
 *  was contracted out to Vicky C ([email protected]).
 *  The open-source community has since actively contributed.
 *
 *  -----------------------------------------------------
 *
 *   LICENSE:
 *   This program is free software: you can redistribute it
 *   and/or modify it under the terms of the GNU Affero
 *   General Public License as published by the Free Software
 *   Foundation, either version 3 of the License, or (at your
 *   option) any later version.
 *
 *   ADDITIONAL PERMISSION under the GNU Affero GPL version 3
 *   section 7: (This paragraph applies only to the LAGPLv3
 *   components listed above.) If you modify this Program, or
 *   any covered work, by linking or combining it with other
 *   code, such other code is not for that reason alone subject
 *   to any of the requirements of the GNU Affero GPL version 3.
 *   (==> This means if you are only using the OT API, then you
 *   don't have to open-source your code--only your changes to
 *   Open-Transactions itself must be open source. Similar to
 *   LGPLv3, except it applies to software-as-a-service, not
 *   just to distributing binaries.)
 *
 *   Extra WAIVER for OpenSSL, Lucre, and all other libraries
 *   used by Open Transactions: This program is released under
 *   the AGPL with the additional exemption that compiling,
 *   linking, and/or using OpenSSL is allowed. The same is true
 *   for any other open source libraries included in this
 *   project: complete waiver from the AGPL is hereby granted to
 *   compile, link, and/or use them with Open-Transactions,
 *   according to their own terms, as long as the rest of the
 *   Open-Transactions terms remain respected, with regard to
 *   the Open-Transactions code itself.
 *
 *   Lucre License:
 *   This code is also "dual-license", meaning that Ben Lau-
 *   rie's license must also be included and respected, since
 *   the code for Lucre is also included with Open Transactions.
 *   See Open-Transactions/src/otlib/lucre/LUCRE_LICENSE.txt
 *   The Laurie requirements are light, but if there is any
 *   problem with his license, simply remove the Lucre code.
 *   Although there are no other blind token algorithms in Open
 *   Transactions (yet. credlib is coming), the other functions
 *   will continue to operate.
 *   See Lucre on Github:  https://github.com/benlaurie/lucre
 *   -----------------------------------------------------
 *   You should have received a copy of the GNU Affero General
 *   Public License along with this program.  If not, see:
 *   http://www.gnu.org/licenses/
 *
 *   If you would like to use this software outside of the free
 *   software license, please contact FellowTraveler.
 *   (Unfortunately many will run anonymously and untraceably,
 *   so who could really stop them?)
 *
 *   DISCLAIMER:
 *   This program 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 Affero General Public License for
 *   more details.

 -----BEGIN PGP SIGNATURE-----
 Version: GnuPG v1.4.9 (Darwin)

 iQIcBAEBAgAGBQJRSsfJAAoJEAMIAO35UbuOQT8P/RJbka8etf7wbxdHQNAY+2cC
 vDf8J3X8VI+pwMqv6wgTVy17venMZJa4I4ikXD/MRyWV1XbTG0mBXk/7AZk7Rexk
 KTvL/U1kWiez6+8XXLye+k2JNM6v7eej8xMrqEcO0ZArh/DsLoIn1y8p8qjBI7+m
 aE7lhstDiD0z8mwRRLKFLN2IH5rAFaZZUvj5ERJaoYUKdn4c+RcQVei2YOl4T0FU
 LWND3YLoH8naqJXkaOKEN4UfJINCwxhe5Ke9wyfLWLUO7NamRkWD2T7CJ0xocnD1
 sjAzlVGNgaFDRflfIF4QhBx1Ddl6wwhJfw+d08bjqblSq8aXDkmFA7HeunSFKkdn
 oIEOEgyj+veuOMRJC5pnBJ9vV+7qRdDKQWaCKotynt4sWJDGQ9kWGWm74SsNaduN
 TPMyr9kNmGsfR69Q2Zq/FLcLX/j8ESxU+HYUB4vaARw2xEOu2xwDDv6jt0j3Vqsg
 x7rWv4S/Eh18FDNDkVRChiNoOIilLYLL6c38uMf1pnItBuxP3uhgY6COm59kVaRh
 nyGTYCDYD2TK+fI9o89F1297uDCwEJ62U0Q7iTDp5QuXCoxkPfv8/kX6lS6T3y9G
 M9mqIoLbIQ1EDntFv7/t6fUTS2+46uCrdZWbQ5RjYXdrzjij02nDmJAm2BngnZvd
 kamH0Y/n11lCvo1oQxM+
 =uSzz
 -----END PGP SIGNATURE-----
 **************************************************************/

#include "../core/stdafx.hpp"

#include "OTMessageBuffer.hpp"
#include "../core/util/OTDataFolder.hpp"
#include "../core/util/OTFolders.hpp"
#include "../core/OTLog.hpp"
#include "../core/OTMessage.hpp"
#include "../core/util/OTPaths.hpp"
#include "../core/OTPseudonym.hpp"
#include "../core/OTStorage.hpp"
#include "../core/OTTransaction.hpp"

namespace opentxs
{

void OTMessageBuffer::Push(OTMessage& theMessage)
{
    messages_.push_back(&theMessage);
}

// **YOU** are responsible to delete the OTMessage object.
// once you receive the pointer that comes back from this function.
//
// This would be a good place to return a smart pointer.
//
// Update: added arguments for: ServerID AND NymID AND request number
// NOTE: Any messages, when popping, which have the CORRECT serverID
// and the CORRECT NymID, but the wrong Request number, will be discarded.
//
// (Why? Because the client using the OT API will have already treated
// that message as "dropped" by now, if it's already on to the next one,
// and the protocol is designed to move forward properly based specifically
// on this function returning the one EXPECTED... outgoing messages flush
// the incoming buffer anyway, so the client will have assumed the wrong
// reply was flushed by now anyway.)
//
// However, if the Server ID and the User ID are wrong, this just means that
// some other code is still expecting that reply, and hasn't even popped yet!
// Therefore, we do NOT want to discard THOSE replies, but put them back if
// necessary -- only discarding the ones where the IDs match.
//
OTMessage* OTMessageBuffer::Pop(const int64_t& lRequestNum,
                                const OTString& strServerID,
                                const OTString& strNymID)
{
    OTMessage* pReturnValue = nullptr;

    Messages temp_list;

    while (!messages_.empty()) {

        OTMessage* pMsg = messages_.front();

        messages_.pop_front();

        if (nullptr == pMsg) {
            otErr << "OTMessageBuffer::Pop: Error: List of incoming server "
                     "replies "
                     "is NOT empty, yet when Pop was called, pMsg was nullptr! "
                     "(Skipping.)\n";
            continue;
        }

        // Below this point, pMsg has been popped, and it's NOT nullptr, and it
        // will be lost if not tracked or returned.
        //
        if (!strServerID.Compare(pMsg->m_strServerID) ||
            !strNymID.Compare(pMsg->m_strNymID)) {
            temp_list.push_front(
                pMsg); // Save it, so we can push it back again after this loop.
            continue;
        }
        // Below this point, we KNOW that pMsg has the CORRECT ServerID and
        // NymID.
        // (And that all others, though popped, were pushed to temp_list in
        // order.)

        const int64_t lMsgRequest = atol(pMsg->m_strRequestNum.Get());

        // Now we only need to see if the request number matches...
        //
        if (lMsgRequest == lRequestNum) {
            pReturnValue = pMsg;
            break;
        }
        else // Server/Nym IDs match, BUT -- Wrong request num! (Discard
               // message and skip.)
        {
            otOut << "OTMessageBuffer::Pop: Warning: While looking for server ("
                  << strServerID << ") reply to request number " << lRequestNum
                  << " for Nym (" << strNymID
                  << "), "
                     "discovered (and discarded) an old server reply for "
                     "request number " << lMsgRequest << " "
                                                         "(A "
                  << pMsg->m_strCommand
                  << " command. The client should have flushed it by now "
                     "anyway, so it was probably slow on the network "
                     "and then assumed to have been dropped. It's okay--the "
                     "protocol is designed to handle these occurrences.)\n";
            delete pMsg;
            pMsg = nullptr;
            continue;
        }

    } // while

    // Put the other messages back, in order...
    //
    while (!temp_list.empty()) {
        OTMessage* pMsg = temp_list.front();
        temp_list.pop_front();
        messages_.push_front(pMsg);
    }

    return pReturnValue;
}

OTMessageBuffer::~OTMessageBuffer()
{
    Clear();
}

void OTMessageBuffer::Clear()
{
    while (!messages_.empty()) {
        OTMessage* pMsg = messages_.front();
        messages_.pop_front();

        if (nullptr != pMsg) delete pMsg;
        pMsg = nullptr;
    }
}

} // namespace opentxs