1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243
// Copyright 2016 MaidSafe.net limited. // // This SAFE Network Software is licensed to you under (1) the MaidSafe.net Commercial License, // version 1.0 or later, or (2) The General Public License (GPL), version 3, depending on which // licence you accepted on initial access to the Software (the "Licences"). // // By contributing code to the SAFE Network Software, or to this project generally, you agree to be // bound by the terms of the MaidSafe Contributor Agreement, version 1.1. This, along with the // Licenses can be found in the root directory of this project at LICENSE, COPYING and CONTRIBUTOR. // // Unless required by applicable law or agreed to in writing, the SAFE Network Software distributed // under the GPL Licence is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY // KIND, either express or implied. // // Please review the Licences for the specific language governing permissions and limitations // relating to use of the SAFE Network Software. use client_error::ClientError; use data::{ImmutableData, MutableData, PermissionSet, User, Value}; use rust_sodium::crypto::sign; use std::collections::{BTreeMap, BTreeSet}; use types::MessageId as MsgId; /// Response message types #[derive(Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd, Serialize, Deserialize)] pub enum Response { /// Returns a success or failure status of account information retrieval. GetAccountInfo { /// Result of fetching account info from the network. res: Result<AccountInfo, ClientError>, /// Unique message identifier msg_id: MsgId, }, // --- ImmutableData --- // ========================== /// Returns a success or failure status of putting ImmutableData to the network. PutIData { /// Result of putting ImmutableData to the network. res: Result<(), ClientError>, /// Unique message identifier msg_id: MsgId, }, /// Returns a result of fetching ImmutableData from the network. GetIData { /// Result of fetching ImmutableData from the network. res: Result<ImmutableData, ClientError>, /// Unique message identifier msg_id: MsgId, }, // --- MutableData --- // ========================== /// Returns a success or failure status of putting MutableData to the network. PutMData { /// Result of putting MutableData to the network. res: Result<(), ClientError>, /// Unique message identifier msg_id: MsgId, }, /// Returns a result of fetching MutableData from the network. GetMData { /// Result of fetching MutableData from the network. res: Result<MutableData, ClientError>, /// Unique message identifier msg_id: MsgId, }, /// Returns a current version of MutableData stored in the network. GetMDataVersion { /// Result of getting a version of MutableData res: Result<u64, ClientError>, /// Unique message identifier msg_id: MsgId, }, /// Returns the shell of MutableData (everything except the entries). GetMDataShell { /// Result of getting the shell of MutableData. res: Result<MutableData, ClientError>, /// Unique message identifier msg_id: MsgId, }, // Data Actions /// Returns a complete list of entries in MutableData or an error in case of failure. ListMDataEntries { /// Result of getting a list of entries in MutableData res: Result<BTreeMap<Vec<u8>, Value>, ClientError>, /// Unique message identifier msg_id: MsgId, }, /// Returns a list of keys in MutableData or an error in case of failure. ListMDataKeys { /// Result of getting a list of keys in MutableData res: Result<BTreeSet<Vec<u8>>, ClientError>, /// Unique message identifier msg_id: MsgId, }, /// Returns a list of values in MutableData or an error in case of failure. ListMDataValues { /// Result of getting a list of values in MutableData res: Result<Vec<Value>, ClientError>, /// Unique message identifier msg_id: MsgId, }, /// Returns a single entry from MutableData or an error in case of failure. GetMDataValue { /// Result of getting a value from MutableData res: Result<Value, ClientError>, /// Unique message identifier msg_id: MsgId, }, /// Returns a success or failure status of mutating MutableData in the network. MutateMDataEntries { /// Result of mutating an entry in MutableData res: Result<(), ClientError>, /// Unique message identifier msg_id: MsgId, }, // Permission Actions /// Returns a complete list of MutableData permissions stored on the network /// or an error in case of failure. ListMDataPermissions { /// Result of getting a list of permissions in MutableData res: Result<BTreeMap<User, PermissionSet>, ClientError>, /// Unique message identifier msg_id: MsgId, }, /// Returns a list of permissions for a particular User in MutableData or an /// error in case of failure. ListMDataUserPermissions { /// Result of getting a list of user permissions in MutableData res: Result<PermissionSet, ClientError>, /// Unique message identifier msg_id: MsgId, }, /// Returns a success or failure status of setting permissions for a particular /// User in MutableData. SetMDataUserPermissions { /// Result of setting a list of user permissions in MutableData res: Result<(), ClientError>, /// Unique message identifier msg_id: MsgId, }, /// Returns a success or failure status of deleting permissions for a particular /// User in MutableData. DelMDataUserPermissions { /// Result of deleting a list of user permissions in MutableData res: Result<(), ClientError>, /// Unique message identifier msg_id: MsgId, }, // Ownership Actions /// Returns a success or failure status of chaning an owner of MutableData. ChangeMDataOwner { /// Result of chaning an owner of MutableData res: Result<(), ClientError>, /// Unique message identifier msg_id: MsgId, }, // --- Client (Owner) to MM --- // ========================== /// Returns a list of authorised keys from MaidManager and the account version. ListAuthKeysAndVersion { /// Result of getting a list of authorised keys and version res: Result<(BTreeSet<sign::PublicKey>, u64), ClientError>, /// Unique message identifier msg_id: MsgId, }, /// Returns a success or failure status of inserting an authorised key into MaidManager. InsAuthKey { /// Result of inserting an authorised key res: Result<(), ClientError>, /// Unique message identifier msg_id: MsgId, }, /// Returns a success or failure status of deleting an authorised key from MaidManager. DelAuthKey { /// Result of deleting an authorised key res: Result<(), ClientError>, /// Unique message identifier msg_id: MsgId, }, } impl Response { /// The priority Crust should send this message with. pub fn priority(&self) -> u8 { match *self { Response::GetIData { res: Ok(_), .. } => 5, Response::GetMDataValue { res: Ok(_), .. } | Response::GetMDataShell { res: Ok(_), .. } => 4, _ => 3, } } /// Message ID getter. pub fn message_id(&self) -> &MsgId { use Response::*; match *self { GetAccountInfo { ref msg_id, .. } | PutIData { ref msg_id, .. } | GetIData { ref msg_id, .. } | PutMData { ref msg_id, .. } | GetMData { ref msg_id, .. } | GetMDataVersion { ref msg_id, .. } | GetMDataShell { ref msg_id, .. } | ListMDataEntries { ref msg_id, .. } | ListMDataKeys { ref msg_id, .. } | ListMDataValues { ref msg_id, .. } | GetMDataValue { ref msg_id, .. } | MutateMDataEntries { ref msg_id, .. } | ListMDataPermissions { ref msg_id, .. } | ListMDataUserPermissions { ref msg_id, .. } | SetMDataUserPermissions { ref msg_id, .. } | DelMDataUserPermissions { ref msg_id, .. } | ChangeMDataOwner { ref msg_id, .. } | ListAuthKeysAndVersion { ref msg_id, .. } | InsAuthKey { ref msg_id, .. } | DelAuthKey { ref msg_id, .. } => msg_id, } } /// Is this response cacheable? pub fn is_cacheable(&self) -> bool { if let Response::GetIData { .. } = *self { true } else { false } } } /// Account information #[derive(Clone, Copy, Eq, Hash, Ord, PartialEq, PartialOrd, Serialize, Deserialize, Debug)] pub struct AccountInfo { /// Number of mutate operations performed by the account. pub mutations_done: u64, /// Number of mutate operations remaining for the account. pub mutations_available: u64, }