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
/*
 * SPDX-License-Identifier: Apache-2.0
 */
#![allow(unused_variables)]
#![allow(dead_code)]

use super::DataType;
use crate::ledgerapi::{state::*, statequerylist::*};
use crate::{error::LedgerError, runtimeapi::ledgerservice::*};
use std::fmt;

/// Collection Name
///
/// An enumeration that be one of
///
/// - World for the ledger's world state
/// - Private(<string>) for a private data collection with the given name
/// - Organization<mspid> for an organizations implicit private data collection
///
/// Note for the ogranization the underlying prefix of _implict_org is automatically added
pub enum CollectionName {
    World,
    Private(String),
    Organization(String),
}

impl fmt::Display for CollectionName {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        match self {
            CollectionName::World => write!(f, ""),
            CollectionName::Private(p) => write!(f, "{:?}", p),
            CollectionName::Organization(org) => write!(f, "_implicit_{:?}", org),
        }
    }
}

/// Key Queryhandler
///
/// Enumeration to define the Key Range queries that can take place.
///
pub enum KeyQueryHandler {
    /// Range(string,string) The start and end keys  
    Range(String, String),

    /// RangeFrom(string)    From the given key to the end
    RangeFrom(String),

    /// RangeTo(string)      From the start to the given key
    RangeTo(String),

    /// RangeAll(),  All composite keys. use with caution
    RangeAll(),
}

/// Specify the Rich Query Handler
pub enum RichQueryHandler {
    /// The query string to pass to the state database (currently only supported for CouchDB)
    Query(String),
}

pub struct Collection {
    name: CollectionName,
}

impl Collection {
    pub fn new(name: CollectionName) -> Self {
        Collection { name }
    }

    pub fn create<T>(&self, asset: T) -> Result<State, LedgerError>
    where
        T: DataType,
    {
        let s = asset.to_state();
        LedgerService::create_state(s.key(), self.name.to_string(), s.value())
    }

    pub fn retrieve<T>(&self, key: &String) -> Result<T, LedgerError>
    where
        T: Default + DataType,
    {
        let s = LedgerService::read_state(&T::form_key(key), &self.name.to_string()).unwrap();
        // let mut asset = T::default();
        // asset.from_state(s);
        Ok(T::build_from_state(s))
    }

    pub fn retrieve_hash<T>(&self, key: &String) -> Result<T, LedgerError>
    where
        T: Default + DataType,
    {
        let s = LedgerService::read_state(&T::form_key(key), &self.name.to_string()).unwrap();
        // let mut asset = T::default();
        // asset.from_state(s);
        Ok(T::build_from_state(s))
    }

    pub fn update<T>(&self, asset: T) -> Result<State, LedgerError>
    where
        T: DataType,
    {
        let s = asset.to_state();
        LedgerService::update_state(s.key(), self.name.to_string(), s.value())
    }

    /// Does this key exist
    pub fn state_exists(&self, key: &str) -> Result<bool, LedgerError> {
        LedgerService::exists_state(&key.to_string(), self.name.to_string())
    }

    /// Return the state for this key
    ///
    pub fn retrieve_state(&self, key: &String) -> Result<State, LedgerError> {
        LedgerService::read_state(&key, &self.name.to_string())
    }

    /// Return the state has ONLY for this key
    ///
    pub fn retrieve_state_hash(&self, key: &String) -> Result<StateHash, LedgerError> {
        Ok(StateHash {
            hash: LedgerService::get_hash(&key, &self.name.to_string())?,
        })
    }

    /// Creates the state
    ///
    /// If it it already exists, this is an error
    pub fn create_state(&self, key: String, data: Vec<u8>) -> Result<State, LedgerError> {
        let state = LedgerService::create_state(key, self.name.to_string(), data); 
        state
    }

    /// Update the states
    ///
    /// If it doesn't exist, this is an error
    pub fn update_state(&self, key: String, data: Vec<u8>) -> Result<State, LedgerError> {
        LedgerService::update_state(key, self.name.to_string(), data)
    }

    /// Deletes the key
    pub fn delete_state(&self, key: &String) -> Result<(), LedgerError> {
        LedgerService::delete_state(&key, self.name.to_string())
    }

    /// Performs a key range query
    ///
    /// # Example
    ///
    /// ```ignore
    /// use fabric_contract::contract::*;
    ///
    /// let collection = Ledger::access_ledger().get_collection(CollectionName::World);
    /// collection.get_states(KeyQueryHandler::Range("Car001","Car002"));
    ///
    pub fn get_states(&self, handler: KeyQueryHandler) -> Result<StateQueryList, LedgerError> {
        let states = match handler {
            KeyQueryHandler::Range(start_key, end_key) => LedgerService::get_range_states(
                start_key.as_str(),
                end_key.as_str(),
                &self.name.to_string(),
            ),
            KeyQueryHandler::RangeTo(end_key) => {
                LedgerService::get_range_states("", end_key.as_str(), &self.name.to_string())
            }
            KeyQueryHandler::RangeFrom(start_key) => {
                LedgerService::get_range_states(start_key.as_str(), "", &self.name.to_string())
            }
            KeyQueryHandler::RangeAll() => {
                LedgerService::get_range_states("", "", &self.name.to_string())
            }
        }?;
        Ok(StateQueryList::new(states))
    }

    /// Rich query support - query is sent to CouchDB
    /// 
    /// NOT IMPLEMENTED (yet)
    pub fn query_states(&self, handler: RichQueryHandler) -> Result<(), LedgerError> {
        todo!("getstates");
    }
}

/// Collection Iterator
///
/// Standard Rust iterator over the returned states
pub trait CollectionIterator: Iterator {
    /// sets the paging size
    fn set_paging_size(pagesize: u32);

    /// number of fetched states
    fn get_fetched_count() -> u32;

    /// set the bookmark to a previous returned value
    fn set_bookmark(bookmark: String);

    /// get currentmark
    fn get_bookmark() -> String;

    // close
    // hope this can be done automatiacally....
    //
}