rippled
Unsubscribe.cpp
1 //------------------------------------------------------------------------------
2 /*
3  This file is part of rippled: https://github.com/ripple/rippled
4  Copyright (c) 2012-2014 Ripple Labs Inc.
5 
6  Permission to use, copy, modify, and/or distribute this software for any
7  purpose with or without fee is hereby granted, provided that the above
8  copyright notice and this permission notice appear in all copies.
9 
10  THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11  WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12  MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13  ANY SPECIAL , DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14  WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15  ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16  OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17 */
18 //==============================================================================
19 
20 #include <ripple/app/misc/NetworkOPs.h>
21 #include <ripple/basics/Log.h>
22 #include <ripple/net/RPCErr.h>
23 #include <ripple/protocol/ErrorCodes.h>
24 #include <ripple/protocol/jss.h>
25 #include <ripple/rpc/Context.h>
26 #include <ripple/rpc/Role.h>
27 #include <ripple/rpc/impl/RPCHelpers.h>
28 
29 namespace ripple {
30 
33 {
34  InfoSub::pointer ispSub;
36  bool removeUrl{false};
37 
38  if (!context.infoSub && !context.params.isMember(jss::url))
39  {
40  // Must be a JSON-RPC call.
42  }
43 
44  if (context.params.isMember(jss::url))
45  {
46  if (context.role != Role::ADMIN)
47  return rpcError(rpcNO_PERMISSION);
48 
49  std::string strUrl = context.params[jss::url].asString();
50  ispSub = context.netOps.findRpcSub(strUrl);
51  if (!ispSub)
52  return jvResult;
53  removeUrl = true;
54  }
55  else
56  {
57  ispSub = context.infoSub;
58  }
59 
60  if (context.params.isMember(jss::streams))
61  {
62  if (!context.params[jss::streams].isArray())
64 
65  for (auto& it : context.params[jss::streams])
66  {
67  if (!it.isString())
69 
70  std::string streamName = it.asString();
71  if (streamName == "server")
72  {
73  context.netOps.unsubServer(ispSub->getSeq());
74  }
75  else if (streamName == "ledger")
76  {
77  context.netOps.unsubLedger(ispSub->getSeq());
78  }
79  else if (streamName == "manifests")
80  {
81  context.netOps.unsubManifests(ispSub->getSeq());
82  }
83  else if (streamName == "transactions")
84  {
85  context.netOps.unsubTransactions(ispSub->getSeq());
86  }
87  else if (
88  streamName == "transactions_proposed" ||
89  streamName == "rt_transactions") // DEPRECATED
90  {
91  context.netOps.unsubRTTransactions(ispSub->getSeq());
92  }
93  else if (streamName == "validations")
94  {
95  context.netOps.unsubValidations(ispSub->getSeq());
96  }
97  else if (streamName == "peer_status")
98  {
99  context.netOps.unsubPeerStatus(ispSub->getSeq());
100  }
101  else if (streamName == "consensus")
102  {
103  context.netOps.unsubConsensus(ispSub->getSeq());
104  }
105  else
106  {
108  }
109  }
110  }
111 
112  auto accountsProposed = context.params.isMember(jss::accounts_proposed)
113  ? jss::accounts_proposed
114  : jss::rt_accounts; // DEPRECATED
115  if (context.params.isMember(accountsProposed))
116  {
117  if (!context.params[accountsProposed].isArray())
118  return rpcError(rpcINVALID_PARAMS);
119 
120  auto ids = RPC::parseAccountIds(context.params[accountsProposed]);
121  if (ids.empty())
122  return rpcError(rpcACT_MALFORMED);
123  context.netOps.unsubAccount(ispSub, ids, true);
124  }
125 
126  if (context.params.isMember(jss::accounts))
127  {
128  if (!context.params[jss::accounts].isArray())
129  return rpcError(rpcINVALID_PARAMS);
130 
131  auto ids = RPC::parseAccountIds(context.params[jss::accounts]);
132  if (ids.empty())
133  return rpcError(rpcACT_MALFORMED);
134  context.netOps.unsubAccount(ispSub, ids, false);
135  }
136 
137  if (context.params.isMember(jss::books))
138  {
139  if (!context.params[jss::books].isArray())
140  return rpcError(rpcINVALID_PARAMS);
141 
142  for (auto& jv : context.params[jss::books])
143  {
144  if (!jv.isObject() || !jv.isMember(jss::taker_pays) ||
145  !jv.isMember(jss::taker_gets) ||
146  !jv[jss::taker_pays].isObjectOrNull() ||
147  !jv[jss::taker_gets].isObjectOrNull())
148  {
149  return rpcError(rpcINVALID_PARAMS);
150  }
151 
152  Json::Value taker_pays = jv[jss::taker_pays];
153  Json::Value taker_gets = jv[jss::taker_gets];
154 
155  Book book;
156 
157  // Parse mandatory currency.
158  if (!taker_pays.isMember(jss::currency) ||
159  !to_currency(
160  book.in.currency, taker_pays[jss::currency].asString()))
161  {
162  JLOG(context.j.info()) << "Bad taker_pays currency.";
164  }
165  // Parse optional issuer.
166  else if (
167  ((taker_pays.isMember(jss::issuer)) &&
168  (!taker_pays[jss::issuer].isString() ||
169  !to_issuer(
170  book.in.account, taker_pays[jss::issuer].asString())))
171  // Don't allow illegal issuers.
172  || !isConsistent(book.in) || noAccount() == book.in.account)
173  {
174  JLOG(context.j.info()) << "Bad taker_pays issuer.";
175 
177  }
178 
179  // Parse mandatory currency.
180  if (!taker_gets.isMember(jss::currency) ||
181  !to_currency(
182  book.out.currency, taker_gets[jss::currency].asString()))
183  {
184  JLOG(context.j.info()) << "Bad taker_gets currency.";
185 
187  }
188  // Parse optional issuer.
189  else if (
190  ((taker_gets.isMember(jss::issuer)) &&
191  (!taker_gets[jss::issuer].isString() ||
192  !to_issuer(
193  book.out.account, taker_gets[jss::issuer].asString())))
194  // Don't allow illegal issuers.
195  || !isConsistent(book.out) || noAccount() == book.out.account)
196  {
197  JLOG(context.j.info()) << "Bad taker_gets issuer.";
198 
200  }
201 
202  if (book.in == book.out)
203  {
204  JLOG(context.j.info()) << "taker_gets same as taker_pays.";
205  return rpcError(rpcBAD_MARKET);
206  }
207 
208  context.netOps.unsubBook(ispSub->getSeq(), book);
209 
210  // both_sides is deprecated.
211  if ((jv.isMember(jss::both) && jv[jss::both].asBool()) ||
212  (jv.isMember(jss::both_sides) && jv[jss::both_sides].asBool()))
213  {
214  context.netOps.unsubBook(ispSub->getSeq(), reversed(book));
215  }
216  }
217  }
218 
219  if (removeUrl)
220  {
221  context.netOps.tryRemoveRpcSub(context.params[jss::url].asString());
222  }
223 
224  return jvResult;
225 }
226 
227 } // namespace ripple
ripple::to_currency
bool to_currency(Currency &currency, std::string const &code)
Tries to convert a string to a Currency, returns true on success.
Definition: UintTypes.cpp:83
ripple::RPC::Context::infoSub
InfoSub::pointer infoSub
Definition: Context.h:49
ripple::RPC::JsonContext
Definition: Context.h:53
ripple::rpcDST_AMT_MALFORMED
@ rpcDST_AMT_MALFORMED
Definition: ErrorCodes.h:106
std::string
STL class.
std::shared_ptr< InfoSub >
ripple::rpcINVALID_PARAMS
@ rpcINVALID_PARAMS
Definition: ErrorCodes.h:84
Json::Value::isString
bool isString() const
Definition: json_value.cpp:1009
ripple::isConsistent
bool isConsistent(Book const &book)
Definition: Book.cpp:25
ripple::InfoSub::Source::unsubTransactions
virtual bool unsubTransactions(std::uint64_t uListener)=0
ripple::Book::out
Issue out
Definition: Book.h:36
ripple::InfoSub::Source::unsubConsensus
virtual bool unsubConsensus(std::uint64_t uListener)=0
ripple::Issue::currency
Currency currency
Definition: Issue.h:37
ripple::RPC::Context::role
Role role
Definition: Context.h:47
ripple::InfoSub::Source::unsubValidations
virtual bool unsubValidations(std::uint64_t uListener)=0
ripple::RPC::Context::j
const beast::Journal j
Definition: Context.h:41
ripple::InfoSub::Source::findRpcSub
virtual pointer findRpcSub(std::string const &strUrl)=0
ripple::Role::ADMIN
@ ADMIN
Json::objectValue
@ objectValue
object value (collection of name/value pairs).
Definition: json_value.h:43
ripple::InfoSub::Source::unsubBook
virtual bool unsubBook(std::uint64_t uListener, Book const &)=0
ripple::reversed
Book reversed(Book const &book)
Definition: Book.cpp:45
ripple::rpcSRC_ISR_MALFORMED
@ rpcSRC_ISR_MALFORMED
Definition: ErrorCodes.h:125
beast::Journal::info
Stream info() const
Definition: Journal.h:321
ripple::rpcSTREAM_MALFORMED
@ rpcSTREAM_MALFORMED
Definition: ErrorCodes.h:126
ripple::InfoSub::Source::unsubAccount
virtual void unsubAccount(ref isplistener, hash_set< AccountID > const &vnaAccountIDs, bool realTime)=0
Json::Value::isMember
bool isMember(const char *key) const
Return true if the object has a member named key.
Definition: json_value.cpp:932
ripple::rpcDST_ISR_MALFORMED
@ rpcDST_ISR_MALFORMED
Definition: ErrorCodes.h:108
ripple::InfoSub::Source::unsubRTTransactions
virtual bool unsubRTTransactions(std::uint64_t uListener)=0
ripple::InfoSub::Source::unsubPeerStatus
virtual bool unsubPeerStatus(std::uint64_t uListener)=0
ripple::rpcError
Json::Value rpcError(int iError, Json::Value jvResult)
Definition: RPCErr.cpp:29
ripple::RPC::Context::netOps
NetworkOPs & netOps
Definition: Context.h:44
Json::Value::isArray
bool isArray() const
Definition: json_value.cpp:1015
ripple::InfoSub::Source::unsubServer
virtual bool unsubServer(std::uint64_t uListener)=0
ripple::doUnsubscribe
Json::Value doUnsubscribe(RPC::JsonContext &)
Definition: Unsubscribe.cpp:32
ripple
Use hash_* containers for keys that do not need a cryptographically secure hashing algorithm.
Definition: RCLCensorshipDetector.h:29
ripple::rpcACT_MALFORMED
@ rpcACT_MALFORMED
Definition: ErrorCodes.h:90
ripple::InfoSub::getSeq
std::uint64_t getSeq()
Definition: InfoSub.cpp:81
ripple::InfoSub::Source::unsubManifests
virtual bool unsubManifests(std::uint64_t uListener)=0
ripple::rpcNO_PERMISSION
@ rpcNO_PERMISSION
Definition: ErrorCodes.h:53
ripple::InfoSub::Source::tryRemoveRpcSub
virtual bool tryRemoveRpcSub(std::string const &strUrl)=0
ripple::Book
Specifies an order book.
Definition: Book.h:32
ripple::rpcBAD_MARKET
@ rpcBAD_MARKET
Definition: ErrorCodes.h:97
ripple::rpcSRC_CUR_MALFORMED
@ rpcSRC_CUR_MALFORMED
Definition: ErrorCodes.h:124
ripple::RPC::parseAccountIds
hash_set< AccountID > parseAccountIds(Json::Value const &jvArray)
Definition: RPCHelpers.cpp:523
ripple::RPC::JsonContext::params
Json::Value params
Definition: Context.h:64
ripple::noAccount
AccountID const & noAccount()
A placeholder for empty accounts.
Definition: AccountID.cpp:97
ripple::Book::in
Issue in
Definition: Book.h:35
ripple::Issue::account
AccountID account
Definition: Issue.h:38
Json::Value
Represents a JSON value.
Definition: json_value.h:145
ripple::to_issuer
bool to_issuer(AccountID &, std::string const &)
Convert hex or base58 string to AccountID.
Definition: AccountID.cpp:104
ripple::InfoSub::Source::unsubLedger
virtual bool unsubLedger(std::uint64_t uListener)=0
Json::Value::asString
std::string asString() const
Returns the unquoted string value.
Definition: json_value.cpp:469