Open-Transactions  0.93.0-ge03d287
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
OTCheque.cpp
Go to the documentation of this file.
1 /************************************************************
2  *
3  * OTCheque.cpp
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 #include "stdafx.hpp"
134 
135 #include "OTCheque.hpp"
136 
137 #include "crypto/OTASCIIArmor.hpp"
138 #include "OTLog.hpp"
139 
140 #include <irrxml/irrXML.hpp>
141 
142 using namespace irr;
143 using namespace io;
144 
145 namespace opentxs
146 {
147 
148 void OTCheque::UpdateContents()
149 {
150  OTString ASSET_TYPE_ID(GetAssetID()), SERVER_ID(GetServerID()),
151  SENDER_ACCT_ID(GetSenderAcctID()), SENDER_USER_ID(GetSenderUserID()),
152  RECIPIENT_USER_ID(GetRecipientUserID()),
153  REMITTER_USER_ID(GetRemitterUserID()),
154  REMITTER_ACCT_ID(GetRemitterAcctID());
155 
156  int64_t lFrom = OTTimeGetSecondsFromTime(GetValidFrom());
157  int64_t lTo = OTTimeGetSecondsFromTime(GetValidTo());
158 
159  // I release this because I'm about to repopulate it.
160  m_xmlUnsigned.Release();
161 
162  m_xmlUnsigned.Concatenate("<?xml version=\"%s\"?>\n\n", "1.0");
163 
164  m_xmlUnsigned.Concatenate(
165  "<cheque\n version=\"%s\"\n"
166  " amount=\"%lld\"\n"
167  " assetTypeID=\"%s\"\n"
168  " transactionNum=\"%lld\"\n"
169  " serverID=\"%s\"\n"
170  " senderAcctID=\"%s\"\n"
171  " senderUserID=\"%s\"\n"
172  " hasRecipient=\"%s\"\n"
173  " recipientUserID=\"%s\"\n"
174  " hasRemitter=\"%s\"\n"
175  " remitterUserID=\"%s\"\n"
176  " remitterAcctID=\"%s\"\n"
177  " validFrom=\"%" PRId64 "\"\n"
178  " validTo=\"%" PRId64 "\""
179  " >\n\n",
180  m_strVersion.Get(), m_lAmount, ASSET_TYPE_ID.Get(), GetTransactionNum(),
181  SERVER_ID.Get(), SENDER_ACCT_ID.Get(), SENDER_USER_ID.Get(),
182  (m_bHasRecipient ? "true" : "false"),
183  (m_bHasRecipient ? RECIPIENT_USER_ID.Get() : ""),
184  (m_bHasRemitter ? "true" : "false"),
185  (m_bHasRemitter ? REMITTER_USER_ID.Get() : ""),
186  (m_bHasRemitter ? REMITTER_ACCT_ID.Get() : ""), lFrom, lTo);
187 
188  if (m_strMemo.Exists() && m_strMemo.GetLength() > 2) {
189  OTASCIIArmor ascMemo(m_strMemo);
190  m_xmlUnsigned.Concatenate("<memo>\n%s</memo>\n\n", ascMemo.Get());
191  }
192 
193  m_xmlUnsigned.Concatenate("</cheque>\n");
194 }
195 
196 // return -1 if error, 0 if nothing, and 1 if the node was processed.
197 int32_t OTCheque::ProcessXMLNode(IrrXMLReader*& xml)
198 {
199  int32_t nReturnVal = 0;
200 
201  // Here we call the parent class first.
202  // If the node is found there, or there is some error,
203  // then we just return either way. But if it comes back
204  // as '0', then nothing happened, and we'll continue executing.
205  //
206  // -- Note you can choose not to call the parent if
207  // you don't want to use any of those xml tags.
208  // As I do below, in the case of OTAccount.
209  // if (nReturnVal = OTContract::ProcessXMLNode(xml))
210  // return nReturnVal;
211 
212  if (!strcmp("cheque", xml->getNodeName())) {
213  OTString strHasRecipient = xml->getAttributeValue("hasRecipient");
214  m_bHasRecipient = strHasRecipient.Compare("true");
215 
216  OTString strHasRemitter = xml->getAttributeValue("hasRemitter");
217  m_bHasRemitter = strHasRemitter.Compare("true");
218 
219  m_strVersion = xml->getAttributeValue("version");
220  m_lAmount = atol(xml->getAttributeValue("amount"));
221 
222  SetTransactionNum(atol(xml->getAttributeValue("transactionNum")));
223 
224  const OTString str_valid_from = xml->getAttributeValue("validFrom");
225  const OTString str_valid_to = xml->getAttributeValue("validTo");
226 
227  SetValidFrom(OTTimeGetTimeFromSeconds(str_valid_from.ToLong()));
228  SetValidTo(OTTimeGetTimeFromSeconds(str_valid_to.ToLong()));
229 
230  OTString strAssetTypeID(xml->getAttributeValue("assetTypeID")),
231  strServerID(xml->getAttributeValue("serverID")),
232  strSenderAcctID(xml->getAttributeValue("senderAcctID")),
233  strSenderUserID(xml->getAttributeValue("senderUserID")),
234  strRecipientUserID(xml->getAttributeValue("recipientUserID")),
235  strRemitterUserID(xml->getAttributeValue("remitterUserID")),
236  strRemitterAcctID(xml->getAttributeValue("remitterAcctID"));
237 
238  OTIdentifier ASSET_ID(strAssetTypeID), SERVER_ID(strServerID),
239  SENDER_ACCT_ID(strSenderAcctID), SENDER_USER_ID(strSenderUserID);
240 
241  SetAssetID(ASSET_ID);
242  SetServerID(SERVER_ID);
243  SetSenderAcctID(SENDER_ACCT_ID);
244  SetSenderUserID(SENDER_USER_ID);
245 
246  // Recipient ID
247  if (m_bHasRecipient)
248  m_RECIPIENT_USER_ID.SetString(strRecipientUserID);
249  else
250  m_RECIPIENT_USER_ID.Release();
251 
252  // Remitter ID (for vouchers)
253  if (m_bHasRemitter) {
254  m_REMITTER_USER_ID.SetString(strRemitterUserID);
255  m_REMITTER_ACCT_ID.SetString(strRemitterAcctID);
256  }
257  else {
258  m_REMITTER_USER_ID.Release();
259  m_REMITTER_ACCT_ID.Release();
260  }
261 
262  otInfo << "\n\nCheque Amount: " << m_lAmount
263  << ". Transaction Number: " << m_lTransactionNum
264  << "\n Valid From: " << str_valid_from.ToLong()
265  << "\n Valid To: " << str_valid_to.ToLong()
266  << "\n AssetTypeID: " << strAssetTypeID
267  << "\n ServerID: " << strServerID
268  << "\n"
269  " senderAcctID: " << strSenderAcctID
270  << "\n senderUserID: " << strSenderUserID << "\n "
271  " Has Recipient? "
272  << (m_bHasRecipient ? "Yes" : "No")
273  << ". If yes, UserID of Recipient: " << strRecipientUserID
274  << "\n"
275  " Has Remitter? " << (m_bHasRemitter ? "Yes" : "No")
276  << ". If yes, UserID/Acct of Remitter: " << strRemitterUserID
277  << " / " << strRemitterAcctID << "\n";
278 
279  nReturnVal = 1;
280  }
281  else if (!strcmp("memo", xml->getNodeName())) {
282  if (!OTContract::LoadEncodedTextField(xml, m_strMemo)) {
283  otErr << "Error in OTCheque::ProcessXMLNode: memo field without "
284  "value.\n";
285  return (-1); // error condition
286  }
287 
288  return 1;
289  }
290 
291  return nReturnVal;
292 }
293 
294 // You still need to re-sign the cheque after doing this.
295 void OTCheque::CancelCheque()
296 {
297  m_lAmount = 0;
298 
299  // When cancelling a cheque, it is basically just deposited back into the
300  // account it was originally drawn from. The purpose of this is to "beat the
301  // original recipient to the punch" by invalidating the cheque before he can
302  // redeem it. Therefore when we do this "deposit" we don't actually intend
303  // to
304  // change the account balance -- so we set the cheque amount to 0.
305  //
306  // So why deposit the cheque, with a 0 balance? Because we just want to
307  // invalidate the transaction number that was used on the cheque. We're
308  // still
309  // going to use a balance agreement, which the server will still verify, but
310  // it
311  // will be for a zero balance, and the transaction number will still be
312  // marked
313  // off via a cheque receipt.
314  //
315  // Since this is really just about marking off transaction numbers, not
316  // changing any balances, we set the cheque amount to 0 and re-sign it.
317 }
318 
319 // Imagine that you are actually writing a cheque.
320 // That's basically what this function does.
321 // Make sure to sign it afterwards.
322 bool OTCheque::IssueCheque(
323  const int64_t& lAmount, const int64_t& lTransactionNum,
324  const time64_t& VALID_FROM,
325  const time64_t& VALID_TO, // The expiration date (valid from/to dates) of
326  // the cheque
327  const OTIdentifier& SENDER_ACCT_ID, // The asset account the cheque is drawn
328  // on.
329  const OTIdentifier& SENDER_USER_ID, // This ID must match the user ID on the
330  // asset account,
331  // AND must verify the cheque signature with that user's key.
332  const OTString& strMemo, // Optional memo field.
333  const OTIdentifier* pRECIPIENT_USER_ID) // Recipient optional.
334  // (Might be a blank
335  // cheque.)
336 {
337  m_lAmount = lAmount;
338  m_strMemo = strMemo;
339 
340  SetValidFrom(VALID_FROM);
341  SetValidTo(VALID_TO);
342 
343  SetTransactionNum(lTransactionNum);
344 
345  SetSenderAcctID(SENDER_ACCT_ID);
346  SetSenderUserID(SENDER_USER_ID);
347 
348  if (nullptr == pRECIPIENT_USER_ID) {
349  m_bHasRecipient = false;
350  m_RECIPIENT_USER_ID.Release();
351  }
352  else {
353  m_bHasRecipient = true;
354  m_RECIPIENT_USER_ID = *pRECIPIENT_USER_ID;
355  }
356 
357  m_bHasRemitter = false; // OTCheque::SetAsVoucher() will set this to true.
358 
359  if (m_lAmount < 0) m_strContractType.Set("INVOICE");
360 
361  return true;
362 }
363 
364 void OTCheque::InitCheque()
365 {
366  m_strContractType.Set("CHEQUE");
367 
368  m_lAmount = 0;
369  m_bHasRecipient = false;
370  m_bHasRemitter = false;
371 }
372 
373 OTCheque::OTCheque()
374  : ot_super()
375  , m_lAmount(0)
376  , m_bHasRecipient(false)
377  , m_bHasRemitter(false)
378 {
379  InitCheque();
380 }
381 
382 OTCheque::OTCheque(const OTIdentifier& SERVER_ID, const OTIdentifier& ASSET_ID)
383  : ot_super(SERVER_ID, ASSET_ID)
384  , m_lAmount(0)
385  , m_bHasRecipient(false)
386  , m_bHasRemitter(false)
387 {
388  InitCheque();
389 
390  // m_ServerID and m_AssetTypeID are now in a grandparent class
391  // (OTInstrument)
392  // So they are initialized there now.
393 }
394 
396 {
397  // If there were any dynamically allocated objects, clean them up here.
398  m_strMemo.Release();
399 
400  // m_SENDER_ACCT_ID.Release(); // in parent class now.
401  // m_SENDER_USER_ID.Release(); // in parent class now.
403 
404  ot_super::Release(); // since I've overridden the base class, I call it
405  // now...
406 
407  // Then I call this to re-initialize everything
408  InitCheque();
409 }
410 
412 {
413  Release_Cheque();
414 }
415 
417 {
418  Release_Cheque();
419 }
420 
421 bool OTCheque::SaveContractWallet(std::ofstream&) const
422 {
423 
424  return true;
425 }
426 
427 } // namespace opentxs
OTString m_strMemo
Definition: OTCheque.hpp:150
void Release_Cheque()
Definition: OTCheque.cpp:395
virtual bool SaveContractWallet(std::ofstream &ofs) const
Definition: OTCheque.cpp:421
EXPORT int64_t ToLong() const
Definition: OTString.cpp:702
time64_t OTTimeGetTimeFromSeconds(int64_t seconds)
Definition: Common.hpp:215
int64_t time64_t
Definition: Common.hpp:209
EXPORT bool Compare(const char *compare) const
Definition: OTString.cpp:1102
OTLOG_IMPORT OTLogStream otInfo
EXPORT const char * Get() const
Definition: OTString.cpp:1045
OTLOG_IMPORT OTLogStream otErr
virtual void Release()
Definition: OTCheque.cpp:411
OTIdentifier m_RECIPIENT_USER_ID
Definition: OTCheque.hpp:151
EXPORT OTCheque()
Definition: OTCheque.cpp:373
int64_t OTTimeGetSecondsFromTime(time64_t time)
Definition: Common.hpp:230
virtual EXPORT void Release()
Definition: OTData.cpp:257
virtual EXPORT void Release()
Definition: OTString.cpp:765
virtual void Release()
virtual EXPORT ~OTCheque()
Definition: OTCheque.cpp:416