Open-Transactions  0.93.0-ge03d287
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
OTScript.hpp
Go to the documentation of this file.
1 /************************************************************
2  *
3  * OTScript.hpp
4  *
5  */
6 
7 /************************************************************
8  -----BEGIN PGP SIGNED MESSAGE-----
9  Hash: SHA1
10 
11  * OPEN TRANSACTIONS
12  *
13  * Financial Cryptography and Digital Cash
14  * Library, Protocol, API, Server, CLI, GUI
15  *
16  * -- Anonymous Numbered Accounts.
17  * -- Untraceable Digital Cash.
18  * -- Triple-Signed Receipts.
19  * -- Cheques, Vouchers, Transfers, Inboxes.
20  * -- Basket Currencies, Markets, Payment Plans.
21  * -- Signed, XML, Ricardian-style Contracts.
22  * -- Scripted smart contracts.
23  *
24  * Copyright (C) 2010-2013 by "Fellow Traveler" (A pseudonym)
25  *
26  * EMAIL:
28  *
29  * BITCOIN: 1NtTPVVjDsUfDWybS4BwvHpG2pdS9RnYyQ
30  *
31  * KEY FINGERPRINT (PGP Key in license file):
32  * 9DD5 90EB 9292 4B48 0484 7910 0308 00ED F951 BB8E
33  *
34  * OFFICIAL PROJECT WIKI(s):
35  * https://github.com/FellowTraveler/Moneychanger
36  * https://github.com/FellowTraveler/Open-Transactions/wiki
37  *
38  * WEBSITE:
39  * http://www.OpenTransactions.org/
40  *
41  * Components and licensing:
42  * -- Moneychanger..A Java client GUI.....LICENSE:.....GPLv3
43  * -- otlib.........A class library.......LICENSE:...LAGPLv3
44  * -- otapi.........A client API..........LICENSE:...LAGPLv3
45  * -- opentxs/ot....Command-line client...LICENSE:...LAGPLv3
46  * -- otserver......Server Application....LICENSE:....AGPLv3
47  * Github.com/FellowTraveler/Open-Transactions/wiki/Components
48  *
49  * All of the above OT components were designed and written by
50  * Fellow Traveler, with the exception of Moneychanger, which
51  * was contracted out to Vicky C ([email protected]).
52  * The open-source community has since actively contributed.
53  *
54  * -----------------------------------------------------
55  *
56  * LICENSE:
57  * This program is free software: you can redistribute it
58  * and/or modify it under the terms of the GNU Affero
59  * General Public License as published by the Free Software
60  * Foundation, either version 3 of the License, or (at your
61  * option) any later version.
62  *
63  * ADDITIONAL PERMISSION under the GNU Affero GPL version 3
64  * section 7: (This paragraph applies only to the LAGPLv3
65  * components listed above.) If you modify this Program, or
66  * any covered work, by linking or combining it with other
67  * code, such other code is not for that reason alone subject
68  * to any of the requirements of the GNU Affero GPL version 3.
69  * (==> This means if you are only using the OT API, then you
70  * don't have to open-source your code--only your changes to
71  * Open-Transactions itself must be open source. Similar to
72  * LGPLv3, except it applies to software-as-a-service, not
73  * just to distributing binaries.)
74  *
75  * Extra WAIVER for OpenSSL, Lucre, and all other libraries
76  * used by Open Transactions: This program is released under
77  * the AGPL with the additional exemption that compiling,
78  * linking, and/or using OpenSSL is allowed. The same is true
79  * for any other open source libraries included in this
80  * project: complete waiver from the AGPL is hereby granted to
81  * compile, link, and/or use them with Open-Transactions,
82  * according to their own terms, as long as the rest of the
83  * Open-Transactions terms remain respected, with regard to
84  * the Open-Transactions code itself.
85  *
86  * Lucre License:
87  * This code is also "dual-license", meaning that Ben Lau-
88  * rie's license must also be included and respected, since
89  * the code for Lucre is also included with Open Transactions.
90  * See Open-Transactions/src/otlib/lucre/LUCRE_LICENSE.txt
91  * The Laurie requirements are light, but if there is any
92  * problem with his license, simply remove the Lucre code.
93  * Although there are no other blind token algorithms in Open
94  * Transactions (yet. credlib is coming), the other functions
95  * will continue to operate.
96  * See Lucre on Github: https://github.com/benlaurie/lucre
97  * -----------------------------------------------------
98  * You should have received a copy of the GNU Affero General
99  * Public License along with this program. If not, see:
100  * http://www.gnu.org/licenses/
101  *
102  * If you would like to use this software outside of the free
103  * software license, please contact FellowTraveler.
104  * (Unfortunately many will run anonymously and untraceably,
105  * so who could really stop them?)
106  *
107  * DISCLAIMER:
108  * This program is distributed in the hope that it will be
109  * useful, but WITHOUT ANY WARRANTY; without even the implied
110  * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
111  * PURPOSE. See the GNU Affero General Public License for
112  * more details.
113 
114  -----BEGIN PGP SIGNATURE-----
115  Version: GnuPG v1.4.9 (Darwin)
116 
117  iQIcBAEBAgAGBQJRSsfJAAoJEAMIAO35UbuOQT8P/RJbka8etf7wbxdHQNAY+2cC
118  vDf8J3X8VI+pwMqv6wgTVy17venMZJa4I4ikXD/MRyWV1XbTG0mBXk/7AZk7Rexk
119  KTvL/U1kWiez6+8XXLye+k2JNM6v7eej8xMrqEcO0ZArh/DsLoIn1y8p8qjBI7+m
120  aE7lhstDiD0z8mwRRLKFLN2IH5rAFaZZUvj5ERJaoYUKdn4c+RcQVei2YOl4T0FU
121  LWND3YLoH8naqJXkaOKEN4UfJINCwxhe5Ke9wyfLWLUO7NamRkWD2T7CJ0xocnD1
122  sjAzlVGNgaFDRflfIF4QhBx1Ddl6wwhJfw+d08bjqblSq8aXDkmFA7HeunSFKkdn
123  oIEOEgyj+veuOMRJC5pnBJ9vV+7qRdDKQWaCKotynt4sWJDGQ9kWGWm74SsNaduN
124  TPMyr9kNmGsfR69Q2Zq/FLcLX/j8ESxU+HYUB4vaARw2xEOu2xwDDv6jt0j3Vqsg
125  x7rWv4S/Eh18FDNDkVRChiNoOIilLYLL6c38uMf1pnItBuxP3uhgY6COm59kVaRh
126  nyGTYCDYD2TK+fI9o89F1297uDCwEJ62U0Q7iTDp5QuXCoxkPfv8/kX6lS6T3y9G
127  M9mqIoLbIQ1EDntFv7/t6fUTS2+46uCrdZWbQ5RjYXdrzjij02nDmJAm2BngnZvd
128  kamH0Y/n11lCvo1oQxM+
129  =uSzz
130  -----END PGP SIGNATURE-----
131  **************************************************************/
132 
133 #ifndef OPENTXS_CORE_SCRIPT_OTSCRIPT_HPP
134 #define OPENTXS_CORE_SCRIPT_OTSCRIPT_HPP
135 
136 #include <map>
137 #include <string>
138 #include <memory>
139 
140 #ifdef _MSC_VER
141 #pragma warning(push)
142 #pragma warning(disable : 4702) // warning C4702: unreachable code
143 #endif
144 
145 #ifdef _MSC_VER
146 #pragma warning(pop)
147 #endif
148 
149 namespace opentxs
150 {
151 
152 class OTParty;
153 class OTPartyAccount;
154 class OTString;
156 
157 typedef std::map<std::string, OTParty*> mapOfParties;
158 typedef std::map<std::string, OTPartyAccount*> mapOfPartyAccounts;
159 typedef std::map<std::string, OTVariable*> mapOfVariables;
160 
161 // A script should be "Dumb", meaning that you just stick it with its
162 // parties and other resources, and it EXPECTS them to be the correct
163 // ones. It uses them low-level style.
164 //
165 // Any verification should be done at a higher level, in OTSmartContract.
166 // There, multiple parties might be loaded, as well as multiple scripts
167 // (clauses) and that is where the proper resources, accounts, etc are
168 // instantiated and validated before any use.
169 //
170 // Thus by the time you get down to OTScript, all that validation is already
171 // done. The programmatic user will interact with OTSmartContract, likely,
172 // and not with OTScript itself.
173 //
174 class OTScript
175 {
176 protected:
177  std::string m_str_script; // the script itself.
178  std::string m_str_display_filename; // for error handling, there is option
179  // to set this string for display.
180  mapOfParties m_mapParties; // no need to clean this up. Script doesn't own
181  // the parties, just references them.
182  mapOfPartyAccounts m_mapAccounts; // no need to clean this up. Script
183  // doesn't own the accounts, just
184  // references them.
185  mapOfVariables m_mapVariables; // no need to clean this up. Script doesn't
186  // own the variables, just references them.
187 
188  // List
189  // Construction -- Destruction
190 public:
191  OTScript();
192  OTScript(const OTString& strValue);
193  OTScript(const char* new_string);
194  OTScript(const char* new_string, size_t sizeLength);
195  OTScript(const std::string& new_string);
196 
197  virtual ~OTScript();
198 
199  EXPORT void SetScript(const OTString& strValue);
200  EXPORT void SetScript(const char* new_string);
201  EXPORT void SetScript(const char* new_string, size_t sizeLength);
202  EXPORT void SetScript(const std::string& new_string);
203 
204  void SetDisplayFilename(std::string str_display_filename)
205  {
206  m_str_display_filename = str_display_filename;
207  }
208 
209  // The same OTSmartContract that loads all the clauses (scripts) will
210  // also load all the parties, so it will call this function whenever before
211  // it
212  // needs to actually run a script.
213  //
214  // NOTE: OTScript does NOT take ownership of the party, since there could be
215  // multiple scripts (with all scripts and parties being owned by a
216  // OTSmartContract.)
217  // Therefore it's ASSUMED that the owner OTSmartContract will handle all the
218  // work of
219  // cleaning up the mess! theParty is passed as reference to insure it
220  // already exists.
221  //
222  void AddParty(std::string str_party_name, OTParty& theParty);
223  void AddAccount(std::string str_acct_name, OTPartyAccount& theAcct);
224  EXPORT void AddVariable(std::string str_var_name, OTVariable& theVar);
225  EXPORT OTVariable* FindVariable(std::string str_var_name);
226  EXPORT void RemoveVariable(OTVariable& theVar);
227 
228  // Note: any relevant assets or asset accounts are listed by their owner /
229  // contributor
230  // parties. Therefore there's no need to separately input any accounts or
231  // assets to
232  // a script, since the necessary ones are already present inside their
233  // respective parties.
234 
235  virtual bool ExecuteScript(OTVariable* pReturnVar = nullptr);
236 };
237 
238 EXPORT std::shared_ptr<OTScript> OTScriptFactory(
239  const std::string& script_type = "");
240 EXPORT std::shared_ptr<OTScript> OTScriptFactory(
241  const std::string& script_type, const std::string& script_contents);
242 
243 } // namespace opentxs
244 
245 #endif // OPENTXS_CORE_SCRIPT_OTSCRIPT_HPP
EXPORT void RemoveVariable(OTVariable &theVar)
Definition: OTScript.cpp:405
std::string m_str_display_filename
Definition: OTScript.hpp:178
std::map< std::string, OTPartyAccount * > mapOfPartyAccounts
Definition: OTParty.hpp:153
std::map< std::string, OTVariable * > mapOfVariables
Definition: OTBylaw.hpp:146
void AddParty(std::string str_party_name, OTParty &theParty)
Definition: OTScript.cpp:350
mapOfParties m_mapParties
Definition: OTScript.hpp:180
EXPORT OTVariable * FindVariable(std::string str_var_name)
Definition: OTScript.cpp:392
void AddAccount(std::string str_acct_name, OTPartyAccount &theAcct)
Definition: OTScript.cpp:363
virtual ~OTScript()
Definition: OTScript.cpp:299
std::string m_str_script
Definition: OTScript.hpp:177
EXPORT void SetScript(const OTString &strValue)
Definition: OTScript.cpp:318
void SetDisplayFilename(std::string str_display_filename)
Definition: OTScript.hpp:204
EXPORT void AddVariable(std::string str_var_name, OTVariable &theVar)
Definition: OTScript.cpp:380
mapOfPartyAccounts m_mapAccounts
Definition: OTScript.hpp:182
mapOfVariables m_mapVariables
Definition: OTScript.hpp:185
EXPORT std::shared_ptr< OTScript > OTScriptFactory(const std::string &script_type="")
Definition: OTScript.cpp:203
virtual bool ExecuteScript(OTVariable *pReturnVar=nullptr)
Definition: OTScript.cpp:416
std::map< std::string, OTParty * > mapOfParties
Definition: OTScript.hpp:155