Artifact Content
Not logged in

Artifact e9be0ae4d9904adff04e7594d332cb50760e942c:

// Copyright 2016 limited.
// This SAFE Network Software is licensed to you under (1) the 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 id::PublicId;
use itertools::Itertools;
use messages::SectionList;
use routing_table::Prefix;
use rust_sodium::crypto::sign::Signature;
use std::collections::HashMap;
use super::QUORUM;
use super::XorName;

pub type Signatures = HashMap<PublicId, Signature>;
pub type PrefixMap<T> = HashMap<Prefix<XorName>, T>;

pub struct SectionListCache {
    // all signatures for a section list for a given prefix
    signatures: PrefixMap<HashMap<SectionList, Signatures>>,
    // section lists signed by a given public id
    signed_by: HashMap<PublicId, PrefixMap<SectionList>>,
    // the latest section list for each prefix with a quorum of signatures
    lists_cache: PrefixMap<(SectionList, Signatures)>,

impl SectionListCache {
    pub fn new() -> SectionListCache {

    /// Removes all signatures authored by `author`
    pub fn remove_signatures_by(&mut self, author: PublicId, our_section_size: usize) {
        if let Some(lists) = self.signed_by.remove(&author) {
            for (prefix, list) in lists {
                let _ = self.signatures.get_mut(&prefix).map_or(None, |map| {
                    map.get_mut(&list).map_or(None, |sigmap| sigmap.remove(&author))

    /// Adds a new signature for a section list
    pub fn add_signature(&mut self,
                         prefix: Prefix<XorName>,
                         pub_id: PublicId,
                         list: SectionList,
                         sig: Signature,
                         our_section_size: usize) {
        // remove all conflicting signatures
        self.remove_signatures_for_prefix_by(prefix, pub_id);
        // remember that this public id signed this section list
        let _ =
            self.signed_by.entry(pub_id).or_insert_with(HashMap::new).insert(prefix, list.clone());
        // remember that this section list has a new signature
        let _ = self.signatures
            .insert(pub_id, sig);

    /// Returns the currently signed section list for `prefix` along with a quorum of signatures.
    // TODO: Remove this when the method is used in production
    pub fn get_signatures(&self, prefix: Prefix<XorName>) -> Option<&(SectionList, Signatures)> {

    fn prune(&mut self) {
        let mut to_remove = vec![];
        for (prefix, map) in &mut self.signatures {
            // prune section lists with 0 signatures
            let lists_to_remove = map.iter()
                .filter(|&(_, sigs)| sigs.is_empty())
                .map(|(list, _)| list.clone())
            for list in lists_to_remove {
                let _ = map.remove(&list);
            if map.is_empty() {
        // prune prefixes with no section lists
        for prefix in to_remove {
            let _ = self.signatures.remove(&prefix);
            // if we lose a prefix from `signatures`, there is no point in holding it in
            // `lists_cache`
            let _ = self.lists_cache.remove(&prefix);

        let to_remove = self.signed_by
            .filter(|&(_, map)| map.is_empty())
            .map(|(pub_id, _)| *pub_id)
        // prune pub_ids signing nothing
        for pub_id in to_remove {
            let _ = self.signed_by.remove(&pub_id);

    fn update_lists_cache(&mut self, our_section_size: usize) {
        for (prefix, map) in &self.signatures {
            // find the entries with the most signatures
            let entries = map.iter()
                .map(|(list, sigs)| (list, sigs.len()))
                .sorted_by(|lhs, rhs| rhs.1.cmp(&lhs.1));
            if let Some(&(list, sig_count)) = entries.first() {
                // entry.0 = list, entry.1 = num of signatures
                if 100 * sig_count >= QUORUM * our_section_size {
                    // we have a list with a quorum of signatures
                    let signatures = unwrap!(map.get(list));
                    let _ = self.lists_cache.insert(*prefix, (list.clone(), signatures.clone()));

    fn remove_signatures_for_prefix_by(&mut self, prefix: Prefix<XorName>, author: PublicId) {
        // vector of tuples (prefix, section list) to be removed
        let to_remove = self.signed_by
            .flat_map(|map| map.iter())
            .filter(|&(p, _)| p.is_compatible(&prefix))
            .map(|(&prefix, list)| (prefix, list.clone()))
        for (prefix, list) in to_remove {
            // remove the signatures from self.signatures
            let _ = self.signatures.get_mut(&prefix).map_or(None, |map| {
                map.get_mut(&list).map_or(None, |sigmap| sigmap.remove(&author))
            // remove those entries from self.signed_by
            let _ = self.signed_by.get_mut(&author).map_or(None, |map| map.remove(&prefix));

        // not updating the cache - removal of signatures shouldn't change it anyway, but even if
        // it does, this function is only called from `add_signature` and we update the cache there