OTBylaw.hpp

Go to the documentation of this file.

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

#ifndef OPENTXS_CORE_SCRIPT_OTBYLAW_HPP
#define OPENTXS_CORE_SCRIPT_OTBYLAW_HPP

#include "OTVariable.hpp"

namespace opentxs
{

class OTClause;
class OTScriptable;

typedef std::map<std::string, std::string> mapOfCallbacks;
typedef std::map<std::string, OTClause*> mapOfClauses;
typedef std::map<std::string, OTVariable*> mapOfVariables;

// First is the name of some standard OT hook, like OnActivate, and Second is
// name of clause.
// It's a multimap because you might have 6 or 7 clauses that all trigger on the
// same hook.
//
typedef std::multimap<std::string, std::string> mapOfHooks;

// A section of law, including its own clauses (scripts). A bylaw is kind of
// like an OT script "program", so it makes sense to be able to collect them,
// and to have them as discrete "packages".
//
class OTBylaw
{
    OTString m_strName;     // Name of this Bylaw.
    OTString m_strLanguage; // Language that the scripts are written in, for
                            // this bylaw.

    mapOfVariables m_mapVariables; // constant, persistant, and important
                                   // variables (strings and longs)
    mapOfClauses m_mapClauses;     // map of scripts associated with this bylaw.

    mapOfHooks m_mapHooks; // multimap of server hooks associated with clauses.
                           // string / string
    mapOfCallbacks m_mapCallbacks; // map of standard callbacks associated with
                                   // script clauses. string / string

    OTScriptable* m_pOwnerAgreement; // This Bylaw is owned by an agreement
                                     // (OTScriptable-derived.)
public:
    EXPORT const OTString& GetName() const
    {
        return m_strName;
    }
    EXPORT const char* GetLanguage() const;
    EXPORT bool AddVariable(OTVariable& theVariable);
    EXPORT bool AddVariable(
        std::string str_Name, std::string str_Value,
        OTVariable::OTVariable_Access theAccess = OTVariable::Var_Persistent);
    EXPORT bool AddVariable(
        std::string str_Name, int32_t nValue,
        OTVariable::OTVariable_Access theAccess = OTVariable::Var_Persistent);
    EXPORT bool AddVariable(
        std::string str_Name, bool bValue,
        OTVariable::OTVariable_Access theAccess = OTVariable::Var_Persistent);
    EXPORT bool AddClause(OTClause& theClause);
    EXPORT bool AddClause(const char* szName, const char* szCode);
    EXPORT bool AddHook(std::string str_HookName,
                        std::string str_ClauseName); // name of hook such
                                                     // as cron_process or
                                                     // hook_activate, and
                                                     // name of clause,
                                                     // such as sectionA
                                                     // (corresponding to
                                                     // an actual script
                                                     // in the clauses
                                                     // map.)
    EXPORT bool AddCallback(std::string str_CallbackName,
                            std::string str_ClauseName); // name of
                                                         // callback such
                                                         // as
    // callback_party_may_execute_clause,
    // and name of clause, such as
    // custom_party_may_execute_clause
    // (corresponding to an actual script
    // in the clauses map.)
    EXPORT OTVariable* GetVariable(std::string str_Name); // not a
                                                          // reference, so
                                                          // you can pass
                                                          // in char *.
                                                          // Maybe that's
                                                          // bad? todo:
                                                          // research
                                                          // that.
    EXPORT OTClause* GetClause(std::string str_Name) const;
    EXPORT OTClause* GetCallback(std::string str_CallbackName);
    EXPORT bool GetHooks(std::string str_HookName,
                         mapOfClauses& theResults); // Look up all clauses
                                                    // matching a specific hook.
    EXPORT int32_t GetVariableCount() const
    {
        return static_cast<int32_t>(m_mapVariables.size());
    }
    EXPORT int32_t GetClauseCount() const
    {
        return static_cast<int32_t>(m_mapClauses.size());
    }
    EXPORT int32_t GetCallbackCount() const
    {
        return static_cast<int32_t>(m_mapCallbacks.size());
    }
    EXPORT int32_t GetHookCount() const
    {
        return static_cast<int32_t>(m_mapHooks.size());
    }
    EXPORT OTVariable* GetVariableByIndex(int32_t nIndex);
    EXPORT OTClause* GetClauseByIndex(int32_t nIndex);
    EXPORT OTClause* GetCallbackByIndex(int32_t nIndex);
    EXPORT OTClause* GetHookByIndex(int32_t nIndex);
    EXPORT const std::string GetCallbackNameByIndex(int32_t nIndex);
    EXPORT const std::string GetHookNameByIndex(int32_t nIndex);
    EXPORT void RegisterVariablesForExecution(OTScript& theScript);
    EXPORT bool IsDirty() const; // So you can tell if any of the persistent or
                                 // important variables have CHANGED since it
                                 // was last set clean.
    EXPORT bool IsDirtyImportant() const; // So you can tell if ONLY the
                                          // IMPORTANT variables have CHANGED
                                          // since it was last set clean.
    EXPORT void SetAsClean(); // Sets the variables as clean, so you can check
                              // later and see if any have been changed (if it's
                              // DIRTY again.)
    // This pointer isn't owned -- just stored for convenience.
    //
    EXPORT OTScriptable* GetOwnerAgreement()
    {
        return m_pOwnerAgreement;
    }
    EXPORT void SetOwnerAgreement(OTScriptable& theOwner)
    {
        m_pOwnerAgreement = &theOwner;
    }
    EXPORT OTBylaw();
    EXPORT OTBylaw(const char* szName, const char* szLanguage);
    virtual ~OTBylaw();

    EXPORT bool Compare(OTBylaw& rhs);

    EXPORT void Serialize(OTString& strAppend,
                          bool bCalculatingID = false) const;
};

} // namespace opentxs

#endif // OPENTXS_CORE_SCRIPT_OTBYLAW_HPP