Merge pull request #1434

5df92877 GUI address book (Jaquee)

src/wallet/CMakeLists.txt

@@ -40,7 +40,8 @@ set(wallet_sources
   api/transaction_info.cpp
   api/transaction_history.cpp
   api/pending_transaction.cpp
-  api/utils.cpp)
+  api/utils.cpp
+  api/address_book.cpp)
 
 set(wallet_api_headers
     wallet2_api.h)
@@ -59,7 +60,8 @@ set(wallet_private_headers
   api/transaction_info.h
   api/transaction_history.h
   api/pending_transaction.h
-  api/common_defines.h)
+  api/common_defines.h
+  api/address_book.h)
 
 monero_private_headers(wallet
   ${wallet_private_headers})

src/wallet/api/address_book.cpp

@@ -0,0 +1,128 @@
+// Copyright (c) 2014-2016, The Monero Project
+//
+// All rights reserved.
+//
+// Redistribution and use in source and binary forms, with or without modification, are
+// permitted provided that the following conditions are met:
+//
+// 1. Redistributions of source code must retain the above copyright notice, this list of
+//    conditions and the following disclaimer.
+//
+// 2. Redistributions in binary form must reproduce the above copyright notice, this list
+//    of conditions and the following disclaimer in the documentation and/or other
+//    materials provided with the distribution.
+//
+// 3. Neither the name of the copyright holder nor the names of its contributors may be
+//    used to endorse or promote products derived from this software without specific
+//    prior written permission.
+//
+// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY
+// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+// MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
+// THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+// STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
+// THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+//
+// Parts of this file are originally copyright (c) 2012-2013 The Cryptonote developers
+
+
+#include "address_book.h"
+#include "wallet.h"
+#include "crypto/hash.h"
+#include "wallet/wallet2.h"
+
+#include <vector>
+
+namespace Bitmonero {
+  
+AddressBook::~AddressBook() {}
+  
+AddressBookImpl::AddressBookImpl(WalletImpl *wallet)
+    : m_wallet(wallet) {}
+
+bool AddressBookImpl::addRow(const std::string &dst_addr , const std::string &payment_id, const std::string &description)
+{
+  LOG_PRINT_L2("Adding row");
+  
+  clearStatus();
+  
+  cryptonote::account_public_address addr;
+  bool has_payment_id;
+  crypto::hash8 payment_id_short;
+  if(!cryptonote::get_account_integrated_address_from_str(addr, has_payment_id, payment_id_short, m_wallet->m_wallet->testnet(), dst_addr)) {
+    m_errorString = "Invalid destination address";
+    m_errorCode = Invalid_Address;
+    return false;
+  }
+
+  crypto::hash pid32 = cryptonote::null_hash;
+  bool long_pid =  (payment_id.empty())? false : tools::wallet2::parse_long_payment_id(payment_id, pid32);
+  if(!payment_id.empty() && !long_pid) {
+    m_errorString = "Invalid payment ID";
+    m_errorCode = Invalid_Payment_Id;
+    return false;
+  }
+
+  bool r =  m_wallet->m_wallet->add_address_book_row(addr,pid32,description);
+  if (r)
+    refresh();
+  else
+    m_errorCode = General_Error;
+  return r;
+}
+
+void AddressBookImpl::refresh() 
+{
+  LOG_PRINT_L2("Refreshing addressbook");
+  
+  clearRows();
+
+  // Fetch from Wallet2 and create vector
+  for (auto const &a : m_wallet->m_wallet->get_address_book() ) {
+    auto row = a.second;
+    int rowId = a.first;
+
+    std::string payment_id = (row.m_payment_id == cryptonote::null_hash)? "" : epee::string_tools::pod_to_hex(row.m_payment_id);
+    std::string address = cryptonote::get_account_address_as_str(m_wallet->m_wallet->testnet(),row.m_address);
+
+    AddressBookRow * abr = new AddressBookRow(rowId, address, payment_id, row.m_description);
+    m_rows.push_back(abr);
+  }
+  
+}
+
+bool AddressBookImpl::deleteRow(int rowId) 
+{
+  LOG_PRINT_L2("Deleting address book row " << rowId);
+  bool r = m_wallet->m_wallet->delete_address_book_row(rowId);
+  refresh();
+  return r;
+} 
+
+void AddressBookImpl::clearRows() {
+   for (auto r : m_rows) {
+     delete r;
+   }
+   m_rows.clear();
+}
+
+void AddressBookImpl::clearStatus(){
+  m_errorString = "";
+  m_errorCode = 0;
+}
+
+std::vector<AddressBookRow*> AddressBookImpl::getAll() const
+{
+  return m_rows;
+}
+
+
+AddressBookImpl::~AddressBookImpl()
+{
+  clearRows();
+}
+
+} // namespace

src/wallet/api/address_book.h

@@ -0,0 +1,67 @@
+// Copyright (c) 2014-2016, The Monero Project
+//
+// All rights reserved.
+//
+// Redistribution and use in source and binary forms, with or without modification, are
+// permitted provided that the following conditions are met:
+//
+// 1. Redistributions of source code must retain the above copyright notice, this list of
+//    conditions and the following disclaimer.
+//
+// 2. Redistributions in binary form must reproduce the above copyright notice, this list
+//    of conditions and the following disclaimer in the documentation and/or other
+//    materials provided with the distribution.
+//
+// 3. Neither the name of the copyright holder nor the names of its contributors may be
+//    used to endorse or promote products derived from this software without specific
+//    prior written permission.
+//
+// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY
+// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+// MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
+// THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+// STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
+// THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+//
+// Parts of this file are originally copyright (c) 2012-2013 The Cryptonote developers
+
+#include "wallet/wallet2_api.h"
+#include "wallet/wallet2.h"
+
+namespace Bitmonero {
+    
+class AddressBookRow;
+class WalletImpl;
+
+class AddressBookImpl : public AddressBook
+{
+public:
+    AddressBookImpl(WalletImpl * wallet);
+    ~AddressBookImpl();
+    
+    // Fetches addresses from Wallet2
+    void refresh();
+    std::vector<AddressBookRow*> getAll() const;
+    bool addRow(const std::string &dst_addr , const std::string &payment_id, const std::string &description);
+    bool deleteRow(int rowId);
+     
+    // Error codes. See AddressBook:ErrorCode enum in wallet2_api.h
+    std::string errorString() const {return m_errorString;}
+    int errorCode() const {return m_errorCode;}
+    
+private:
+    void clearRows();
+    void clearStatus();
+    
+private:
+    WalletImpl *m_wallet;
+    std::vector<AddressBookRow*> m_rows;
+    std::string m_errorString;
+    int m_errorCode;
+};
+
+}
+

src/wallet/api/wallet.cpp

@@ -32,11 +32,13 @@
 #include "wallet.h"
 #include "pending_transaction.h"
 #include "transaction_history.h"
+#include "address_book.h"
 #include "common_defines.h"
 
 #include "mnemonics/electrum-words.h"
 #include <boost/format.hpp>
 #include <sstream>
+#include <unordered_map>
 
 using namespace std;
 using namespace cryptonote;
@@ -209,6 +211,7 @@ WalletImpl::WalletImpl(bool testnet)
     m_wallet->callback(m_wallet2Callback);
     m_refreshThreadDone = false;
     m_refreshEnabled = false;
+    m_addressBook = new AddressBookImpl(this);
 
 
     m_refreshIntervalMillis = DEFAULT_REFRESH_INTERVAL_MILLIS;
@@ -223,6 +226,7 @@ WalletImpl::~WalletImpl()
 {
     stopRefresh();
     delete m_history;
+    delete m_addressBook;
     delete m_wallet;
     delete m_wallet2Callback;
 }
@@ -327,9 +331,7 @@ bool WalletImpl::close()
     bool result = false;
     LOG_PRINT_L3("closing wallet...");
     try {
-        // do not store wallet with invalid status
-        if (status() == Status_Ok)
-            m_wallet->store();
+        m_wallet->store();
         LOG_PRINT_L3("wallet::store done");
         LOG_PRINT_L3("Calling wallet::stop...");
         m_wallet->stop();
@@ -823,6 +825,11 @@ TransactionHistory *WalletImpl::history() const
     return m_history;
 }
 
+AddressBook *WalletImpl::addressBook() const
+{
+    return m_addressBook;
+}
+
 void WalletImpl::setListener(WalletListener *l)
 {
     // TODO thread synchronization;

src/wallet/api/wallet.h

@@ -43,6 +43,7 @@
 namespace Bitmonero {
 class TransactionHistoryImpl;
 class PendingTransactionImpl;
+class AddressBookImpl;
 struct Wallet2CallbackImpl;
 
 class WalletImpl : public Wallet
@@ -97,13 +98,13 @@ public:
 
     virtual void disposeTransaction(PendingTransaction * t);
     virtual TransactionHistory * history() const;
+    virtual AddressBook * addressBook() const;
     virtual void setListener(WalletListener * l);
     virtual uint32_t defaultMixin() const;
     virtual void setDefaultMixin(uint32_t arg);
     virtual bool setUserNote(const std::string &txid, const std::string &note);
     virtual std::string getUserNote(const std::string &txid) const;
     virtual std::string getTxKey(const std::string &txid) const;
-
     virtual std::string signMessage(const std::string &message);
     virtual bool verifySignedMessage(const std::string &message, const std::string &address, const std::string &signature) const;
 
@@ -121,6 +122,7 @@ private:
     friend class PendingTransactionImpl;
     friend class TransactionHistoryImpl;
     friend class Wallet2CallbackImpl;
+    friend class AddressBookImpl;
 
     tools::wallet2 * m_wallet;
     mutable std::atomic<int>  m_status;
@@ -130,6 +132,7 @@ private:
     bool        m_trustedDaemon;
     WalletListener * m_walletListener;
     Wallet2CallbackImpl * m_wallet2Callback;
+    AddressBookImpl *  m_addressBook;
 
     // multi-threaded refresh stuff
     std::atomic<bool> m_refreshEnabled;

src/wallet/api/wallet_manager.cpp

@@ -56,6 +56,8 @@ Wallet *WalletManagerImpl::openWallet(const std::string &path, const std::string
 {
     WalletImpl * wallet = new WalletImpl(testnet);
     wallet->open(path, password);
+    //Refresh addressBook
+    wallet->addressBook()->refresh(); 
     return wallet;
 }
 

src/wallet/wallet2.cpp

@@ -1561,6 +1561,23 @@ void wallet2::fast_refresh(uint64_t stop_height, uint64_t &blocks_start_height,
   }
 }
 
+
+bool wallet2::add_address_book_row(const cryptonote::account_public_address &address, const crypto::hash &payment_id, const std::string &description)
+{
+  wallet2::address_book_row a;
+  a.m_address = address;
+  a.m_payment_id = payment_id;
+  a.m_description = description;
+  
+  int key = (m_address_book.empty())? 0 : m_address_book.rbegin()->first;
+  bool r =  m_address_book.emplace(++key,a).second;
+  return r;
+}
+
+bool wallet2::delete_address_book_row(int row_id) {
+  return (m_address_book.erase(row_id) > 0);
+}
+
 //----------------------------------------------------------------------------------------------------
 void wallet2::refresh(uint64_t start_height, uint64_t & blocks_fetched, bool& received_money)
 {

src/wallet/wallet2.h

@@ -286,6 +286,14 @@ namespace tools
         FIELD(cache_data)
       END_SERIALIZE()
     };
+    
+    // GUI Address book
+    struct address_book_row
+    {
+      cryptonote::account_public_address m_address;
+      crypto::hash m_payment_id;
+      std::string m_description;
+    };
 
     /*!
      * \brief Generates a wallet or restores one.
@@ -471,6 +479,9 @@ namespace tools
         return;
       }
       a & m_pub_keys;
+      if(ver < 16)
+        return;
+      a & m_address_book;
     }
 
     /*!
@@ -509,6 +520,13 @@ namespace tools
 
     bool get_tx_key(const crypto::hash &txid, crypto::secret_key &tx_key) const;
 
+   /*!
+    * \brief GUI Address book get/store
+    */
+    std::map<int, address_book_row> get_address_book() const { return m_address_book; }
+    bool add_address_book_row(const cryptonote::account_public_address &address, const crypto::hash &payment_id, const std::string &description);
+    bool delete_address_book_row(int row_id);
+        
     uint64_t get_num_rct_outputs();
     const transfer_details &get_transfer_details(size_t idx) const;
 
@@ -623,6 +641,7 @@ namespace tools
     std::unordered_map<crypto::public_key, size_t> m_pub_keys;
     cryptonote::account_public_address m_account_public_address;
     std::unordered_map<crypto::hash, std::string> m_tx_notes;
+    std::map<int, tools::wallet2::address_book_row> m_address_book;
     uint64_t m_upper_transaction_size_limit; //TODO: auto-calc this value or request from daemon, now use some fixed value
 
     std::atomic<bool> m_run;
@@ -645,11 +664,12 @@ namespace tools
     bool m_confirm_missing_payment_id;
   };
 }
-BOOST_CLASS_VERSION(tools::wallet2, 15)
+BOOST_CLASS_VERSION(tools::wallet2, 16)
 BOOST_CLASS_VERSION(tools::wallet2::transfer_details, 7)
 BOOST_CLASS_VERSION(tools::wallet2::payment_details, 1)
 BOOST_CLASS_VERSION(tools::wallet2::unconfirmed_transfer_details, 6)
 BOOST_CLASS_VERSION(tools::wallet2::confirmed_transfer_details, 3)
+BOOST_CLASS_VERSION(tools::wallet2::address_book_row, 16)    
 
 namespace boost
 {
@@ -839,6 +859,14 @@ namespace boost
       a & x.amount;
       a & x.addr;
     }
+    
+    template <class Archive>
+    inline void serialize(Archive& a, tools::wallet2::address_book_row& x, const boost::serialization::version_type ver)
+    {
+      a & x.m_address;
+      a & x.m_payment_id;
+      a & x.m_description;
+    }
   }
 }
 

src/wallet/wallet2_api.h

@@ -34,6 +34,7 @@
 #include <string>
 #include <vector>
 #include <ctime>
+#include <iostream>
 
 //  Public interface for libwallet library
 namespace Bitmonero {
@@ -130,6 +131,50 @@ struct TransactionHistory
     virtual void refresh() = 0;
 };
 
+/**
+ * @brief AddressBookRow - provides functions to manage address book
+ */
+struct AddressBookRow {
+public:
+    AddressBookRow(int _rowId, const std::string &_address, const std::string &_paymentId, const std::string &_description):
+        m_rowId(_rowId),
+        m_address(_address),
+        m_paymentId(_paymentId), 
+        m_description(_description) {}
+ 
+private:
+    int m_rowId;
+    std::string m_address;
+    std::string m_paymentId;
+    std::string m_description;
+public:
+    std::string extra;
+    std::string getAddress() const {return m_address;} 
+    std::string getDescription() const {return m_description;} 
+    std::string getPaymentId() const {return m_paymentId;} 
+    int getRowId() const {return m_rowId;} 
+};
+
+/**
+ * @brief The AddressBook - interface for 
+Book
+ */
+struct AddressBook
+{
+    enum ErrorCode {
+        Status_Ok,
+        General_Error,
+        Invalid_Address,
+        Invalid_Payment_Id
+    };
+    virtual ~AddressBook() = 0;
+    virtual std::vector<AddressBookRow*> getAll() const = 0;
+    virtual bool addRow(const std::string &dst_addr , const std::string &payment_id, const std::string &description) = 0;  
+    virtual bool deleteRow(int rowId) = 0;  
+    virtual void refresh() = 0;  
+    virtual std::string errorString() const = 0;
+    virtual int errorCode() const = 0;
+};
 
 struct WalletListener
 {
@@ -370,6 +415,7 @@ struct Wallet
      */
     virtual void disposeTransaction(PendingTransaction * t) = 0;
     virtual TransactionHistory * history() const = 0;
+    virtual AddressBook * addressBook() const = 0;
     virtual void setListener(WalletListener *) = 0;
     /*!
      * \brief defaultMixin - returns number of mixins used in transactions