OTCron.hpp

Go to the documentation of this file.

/************************************************************
 *
 *  OTCron.hpp
 *
 */

/************************************************************
 -----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-----
 **************************************************************/

// OTCron has a list of OTCronItems. (Really subclasses of that such as OTTrade
// and OTAgreement.)

#ifndef OPENTXS_CORE_CRON_OTCRON_HPP
#define OPENTXS_CORE_CRON_OTCRON_HPP

#include "../OTContract.hpp"
#include "../util/StringUtils.hpp"
#include "../util/Assert.hpp"

namespace opentxs
{

class OTCronItem;
class OTMarket;
class OTPseudonym;

// mapOfCronItems:      Mapped (uniquely) to transaction number.
// multimapOfCronItems: Mapped to date the item was added to Cron.
//
// (Any given CronItem will be found on BOTH lists.)
typedef std::map<int64_t, OTCronItem*> mapOfCronItems;
typedef std::multimap<time64_t, OTCronItem*> multimapOfCronItems;

// Mapped (uniquely) to market ID.
typedef std::map<std::string, OTMarket*> mapOfMarkets;

// Cron stores a bunch of these on this list,
// which the server refreshes from time to time.
typedef std::list<int64_t> listOfLongNumbers;

class OTCron : public OTContract
{
private: // Private prevents erroneous use by other classes.
    typedef OTContract ot_super;

private:
    mapOfMarkets m_mapMarkets;     // A list of all valid markets.
    mapOfCronItems m_mapCronItems; // Cron Items are found on both lists.
    multimapOfCronItems m_multimapCronItems;
    OTIdentifier m_SERVER_ID; // Always store this in any object that's
                              // associated with a specific server.

    listOfLongNumbers m_listTransactionNumbers; // I can't put receipts in
                                                // people's inboxes without a
                                                // supply of these.

    bool m_bIsActivated; // I don't want to start Cron processing until
                         // everything else is all loaded up and ready to go.

    OTPseudonym* m_pServerNym;            // I'll need this for later.
    static int32_t __trans_refill_amount; // Number of transaction numbers Cron
                                          // will grab for itself, when it gets
                                          // low, before each round.
    static int32_t __cron_ms_between_process; // Number of milliseconds
                                              // (ideally) between each "Cron
                                              // Process" event.

    static int32_t __cron_max_items_per_nym; // Int. The maximum number of cron
                                             // items any given Nym can have
                                             // active at the same time.

public:
    static int32_t GetCronMsBetweenProcess()
    {
        return __cron_ms_between_process;
    }
    static void SetCronMsBetweenProcess(int32_t lMS)
    {
        __cron_ms_between_process = lMS;
    }

    static int32_t GetCronRefillAmount()
    {
        return __trans_refill_amount;
    }
    static void SetCronRefillAmount(int32_t nAmount)
    {
        __trans_refill_amount = nAmount;
    }
    static int32_t GetCronMaxItemsPerNym()
    {
        return __cron_max_items_per_nym;
    }
    static void SetCronMaxItemsPerNym(int32_t nMax)
    {
        __cron_max_items_per_nym = nMax;
    }
    inline bool IsActivated() const
    {
        return m_bIsActivated;
    }
    inline bool ActivateCron()
    {
        if (!m_bIsActivated)
            return m_bIsActivated = true;
        else
            return false;
    }
    // RECURRING TRANSACTIONS
    //
    EXPORT bool AddCronItem(OTCronItem& theItem, OTPseudonym* pActivator,
                            bool bSaveReceipt,
                            time64_t tDateAdded); // Date it was FIRST added to
                                                  // Cron.
    EXPORT bool RemoveCronItem(int64_t lTransactionNum,
                               OTPseudonym& theRemover); // if returns false,
                                                         // item wasn't found.
    EXPORT OTCronItem* GetItemByOfficialNum(int64_t lTransactionNum);
    EXPORT OTCronItem* GetItemByValidOpeningNum(int64_t lOpeningNum);
    EXPORT mapOfCronItems::iterator FindItemOnMap(int64_t lTransactionNum);
    EXPORT multimapOfCronItems::iterator FindItemOnMultimap(
        int64_t lTransactionNum);
    // MARKETS
    //
    bool AddMarket(OTMarket& theMarket, bool bSaveMarketFile = true);
    bool RemoveMarket(const OTIdentifier& MARKET_ID); // if returns false,
                                                      // market wasn't found.

    EXPORT OTMarket* GetMarket(const OTIdentifier& MARKET_ID);
    OTMarket* GetOrCreateMarket(const OTIdentifier& ASSET_ID,
                                const OTIdentifier& CURRENCY_ID,
                                const int64_t& lScale);
    // This is informational only. It returns OTStorage-type data objects,
    // packed in a string.
    //
    EXPORT bool GetMarketList(OTASCIIArmor& ascOutput, int32_t& nMarketCount);
    EXPORT bool GetNym_OfferList(OTASCIIArmor& ascOutput,
                                 const OTIdentifier& NYM_ID,
                                 int32_t& nOfferCount);
    // TRANSACTION NUMBERS
    //
    // The server starts out putting a bunch of numbers in here so Cron can use
    // them.
    // Then the internal trades and payment plans get numbers from here as
    // needed.
    // Server MUST replenish from time-to-time, or Cron will stop working.
    // Part of using Cron properly is to call ProcessCron() regularly, as well
    // as to call AddTransactionNumber() regularly, in order to keep
    // GetTransactionCount()
    // at some minimum threshold.
    EXPORT void AddTransactionNumber(const int64_t& lTransactionNum);
    int64_t GetNextTransactionNumber();
    EXPORT int32_t GetTransactionCount() const; // How many numbers do I
                                                // currently have on the list?

    // Make sure every time you call this, you check the GetTransactionCount()
    // first and replenish it
    // to whatever your minimum supply is. (The transaction numbers in there
    // must be enough to last for
    // the entire ProcessCronItems() call, and all the trades and payment plans
    // within, since it will not
    // be replenished again at least until the call has finished.)
    //
    EXPORT void ProcessCronItems();

    inline void SetServerID(const OTIdentifier& SERVER_ID)
    {
        m_SERVER_ID = SERVER_ID;
    }
    inline const OTIdentifier& GetServerID() const
    {
        return m_SERVER_ID;
    }

    inline void SetServerNym(OTPseudonym* pServerNym)
    {
        OT_ASSERT(nullptr != pServerNym);
        m_pServerNym = pServerNym;
    }
    inline OTPseudonym* GetServerNym() const
    {
        return m_pServerNym;
    }

    EXPORT bool LoadCron();
    EXPORT bool SaveCron();

    EXPORT OTCron();
    OTCron(const OTIdentifier& SERVER_ID);
    OTCron(const char* szFilename);

    EXPORT virtual ~OTCron();

    void InitCron();

    virtual void Release();
    void Release_Cron();

    // return -1 if error, 0 if nothing, and 1 if the node was processed.
    virtual int32_t ProcessXMLNode(irr::io::IrrXMLReader*& xml);

    virtual void UpdateContents(); // Before transmission or serialization, this
                                   // is where the ledger saves its contents

    virtual bool SaveContractWallet(std::ofstream& ofs) const;
};

} // namespace opentxs

#endif // OPENTXS_CORE_CRON_OTCRON_HPP