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

// Copyright 2020 MaidSafe.net limited.
//
// This SAFE Network Software is licensed to you under the MIT license <LICENSE-MIT
// https://opensource.org/licenses/MIT> or the Modified BSD license <LICENSE-BSD
// https://opensource.org/licenses/BSD-3-Clause>, at your option. This file may not be copied,
// modified, or distributed except according to those terms. Please review the Licences for the
// specific language governing permissions and limitations relating to use of the SAFE Network
// Software.

use super::{AuthorisationKind, Type};
use crate::{
    Error, MData, MDataAddress, MDataEntryActions, MDataPermissionSet, PublicKey, Response, XorName,
};
use serde::{Deserialize, Serialize};
use std::{borrow::Cow, fmt};

/// MutableData request that is sent to vaults.
#[allow(clippy::large_enum_variant)]
#[derive(Hash, Eq, PartialEq, PartialOrd, Ord, Clone, Serialize, Deserialize)]
pub enum MDataRequest {
    /// Put MutableData.
    Put(MData),
    /// Get MutableData.
    Get(MDataAddress),
    /// Get MutableData value.
    GetValue {
        /// MutableData address.
        address: MDataAddress,
        /// Key to get.
        key: Vec<u8>,
    },
    /// Delete MutableData.
    Delete(MDataAddress),
    /// Get MutableData shell.
    GetShell(MDataAddress),
    /// Get MutableData version.
    GetVersion(MDataAddress),
    /// List MutableData entries.
    ListEntries(MDataAddress),
    /// List MutableData keys.
    ListKeys(MDataAddress),
    /// List MutableData values.
    ListValues(MDataAddress),
    /// Set MutableData user permissions.
    SetUserPermissions {
        /// MutableData address.
        address: MDataAddress,
        /// User to set permissions for.
        user: PublicKey,
        /// New permissions.
        permissions: MDataPermissionSet,
        /// Version to set.
        version: u64,
    },
    /// Delete MutableData user permissions.
    DelUserPermissions {
        /// MutableData address.
        address: MDataAddress,
        /// User to delete permissions for.
        user: PublicKey,
        /// Version to delete.
        version: u64,
    },
    /// List MutableData permissions.
    ListPermissions(MDataAddress),
    /// Get MutableData permissions for a user.
    ListUserPermissions {
        /// MutableData address.
        address: MDataAddress,
        /// User to get permissions for.
        user: PublicKey,
    },
    /// Mutate MutableData entries.
    MutateEntries {
        /// MutableData address.
        address: MDataAddress,
        /// Mutation actions to perform.
        actions: MDataEntryActions,
    },
}

impl MDataRequest {
    /// Get the `Type` of this `Request`.
    pub fn get_type(&self) -> Type {
        use MDataRequest::*;

        match *self {
            // MData requests (always unpub)
            Get(_)
            | GetValue { .. }
            | GetShell(_)
            | GetVersion(_)
            | ListEntries(_)
            | ListKeys(_)
            | ListValues(_)
            | ListPermissions(_)
            | ListUserPermissions { .. } => Type::PrivateGet,
            Put(_)
            | Delete(_)
            | SetUserPermissions { .. }
            | DelUserPermissions { .. }
            | MutateEntries { .. } => Type::Mutation,
        }
    }

    /// Creates a Response containing an error, with the Response variant corresponding to the
    /// Request variant.
    pub fn error_response(&self, error: Error) -> Response {
        use MDataRequest::*;

        match *self {
            Get(_) => Response::GetMData(Err(error)),
            GetValue { .. } => Response::GetMDataValue(Err(error)),
            GetShell(_) => Response::GetMDataShell(Err(error)),
            GetVersion(_) => Response::GetMDataVersion(Err(error)),
            ListEntries(_) => Response::ListMDataEntries(Err(error)),
            ListKeys(_) => Response::ListMDataKeys(Err(error)),
            ListValues(_) => Response::ListMDataValues(Err(error)),
            ListPermissions(_) => Response::ListMDataPermissions(Err(error)),
            ListUserPermissions { .. } => Response::ListMDataUserPermissions(Err(error)),
            Put(_)
            | Delete(_)
            | SetUserPermissions { .. }
            | DelUserPermissions { .. }
            | MutateEntries { .. } => Response::Mutation(Err(error)),
        }
    }

    /// Returns the type of authorisation needed for the request.
    pub fn authorisation_kind(&self) -> AuthorisationKind {
        use MDataRequest::*;
        match *self {
            Put(_)
            | Delete(_)
            | SetUserPermissions { .. }
            | DelUserPermissions { .. }
            | MutateEntries { .. } => AuthorisationKind::Mutation,
            Get(_)
            | GetValue { .. }
            | GetShell(_)
            | GetVersion(_)
            | ListEntries(_)
            | ListKeys(_)
            | ListValues(_)
            | ListPermissions(_)
            | ListUserPermissions { .. } => AuthorisationKind::GetPriv,
        }
    }

    /// Returns the address of the destination for `request`.
    pub fn dest_address(&self) -> Option<Cow<XorName>> {
        use MDataRequest::*;
        match self {
            Put(ref data) => Some(Cow::Borrowed(data.name())),
            Get(ref address)
            | GetValue { ref address, .. }
            | Delete(ref address)
            | GetShell(ref address)
            | GetVersion(ref address)
            | ListEntries(ref address)
            | ListKeys(ref address)
            | ListValues(ref address)
            | SetUserPermissions { ref address, .. }
            | DelUserPermissions { ref address, .. }
            | ListPermissions(ref address)
            | ListUserPermissions { ref address, .. }
            | MutateEntries { ref address, .. } => Some(Cow::Borrowed(address.name())),
        }
    }
}

impl fmt::Debug for MDataRequest {
    fn fmt(&self, formatter: &mut fmt::Formatter) -> fmt::Result {
        use MDataRequest::*;

        write!(
            formatter,
            "Request::{}",
            match *self {
                Put(_) => "PutMData",
                Get(_) => "GetMData",
                GetValue { .. } => "GetMDataValue",
                Delete(_) => "DeleteMData",
                GetShell(_) => "GetMDataShell",
                GetVersion(_) => "GetMDataVersion",
                ListEntries(_) => "ListMDataEntries",
                ListKeys(_) => "ListMDataKeys",
                ListValues(_) => "ListMDataValues",
                SetUserPermissions { .. } => "SetMDataUserPermissions",
                DelUserPermissions { .. } => "DelMDataUserPermissions",
                ListPermissions(_) => "ListMDataPermissions",
                ListUserPermissions { .. } => "ListMDataUserPermissions",
                MutateEntries { .. } => "MutateMDataEntries",
            }
        )
    }
}