DwmIpv4CountryDb.hh

Go to the documentation of this file.

//===========================================================================
// @(#) $Name:$
// @(#) $Id: DwmIpv4CountryDb.hh 9123 2017-04-15 01:55:02Z dwm $
//===========================================================================
//  Copyright (c) Daniel W. McRobb 2017
//  All rights reserved.
//
//  Redistribution and use in source and binary forms, with or without
//  modification, are permitted provided that the following conditions
//  are met:
//
//  1. Redistributions of source code must retain the above copyright
//     notice, this list of conditions and the following disclaimer.
//  2. Redistributions in binary form must reproduce the above copyright
//     notice, this list of conditions and the following disclaimer in the
//     documentation and/or other materials provided with the distribution.
//  3. The names of the authors and copyright holders may not be used to
//     endorse or promote products derived from this software without
//     specific prior written permission.
//
//  IN NO EVENT SHALL DANIEL W. MCROBB BE LIABLE TO ANY PARTY FOR
//  DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES,
//  INCLUDING LOST PROFITS, ARISING OUT OF THE USE OF THIS SOFTWARE,
//  EVEN IF DANIEL W. MCROBB HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
//  DAMAGE.
//
//  THE SOFTWARE PROVIDED HEREIN IS ON AN "AS IS" BASIS, AND
//  DANIEL W. MCROBB HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT,
//  UPDATES, ENHANCEMENTS, OR MODIFICATIONS. DANIEL W. MCROBB MAKES NO
//  REPRESENTATIONS AND EXTENDS NO WARRANTIES OF ANY KIND, EITHER
//  IMPLIED OR EXPRESS, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
//  WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE,
//  OR THAT THE USE OF THIS SOFTWARE WILL NOT INFRINGE ANY PATENT,
//  TRADEMARK OR OTHER RIGHTS.
//===========================================================================

//---------------------------------------------------------------------------
//---------------------------------------------------------------------------

#ifndef _DWMIPV4COUNTRYDB_HH_
#define _DWMIPV4COUNTRYDB_HH_

#include <iostream>
#include <mutex>
#include <string>
#include <tuple>

#include "DwmIpv4Prefix.hh"
#include "DwmRDAPIpv4Routes.hh"
#include "DwmReadable.hh"
#include "DwmWritable.hh"
#include "DwmTimeValue64.hh"
#include "DwmRDAPResponse.hh"

namespace Dwm {

  //--------------------------------------------------------------------------
  //--------------------------------------------------------------------------
  class Ipv4CountryDbValue
    : public Dwm::Readable, public Dwm::Writable,
      public GZReadable, public GZWritable,
      public BZ2Readable, public BZ2Writable
  {
  public:
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    Ipv4CountryDbValue();
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    Ipv4CountryDbValue(const std::string & code,
                       const TimeValue64 & lastChanged,
                       const TimeValue64 & lastUpdated = TimeValue64(true));

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    Ipv4CountryDbValue(const Json::Value & rdapResponse);
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    const std::string & Code() const;
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    const std::string & Code(const std::string code);
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    const TimeValue64 & LastUpdated() const;
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    const TimeValue64 & LastUpdated(const TimeValue64 & lastUpdated);

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    const TimeValue64 & LastChanged() const;
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    const TimeValue64 & LastChanged(const TimeValue64 & lastUpdated);

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    std::istream & Read(std::istream & is);
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    ssize_t Read(int fd);
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    size_t Read(FILE * f);
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    int Read(gzFile gzf);
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    int BZRead(BZFILE *bzf);
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    std::ostream & Write(std::ostream & os) const;
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    ssize_t Write(int fd) const;
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    size_t Write(FILE *f) const;
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    int Write(gzFile gzf) const;
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    int BZWrite(BZFILE *bzf) const;
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    uint32_t StreamedLength() const;

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    bool operator == (const Ipv4CountryDbValue & val) const;

    Json::Value Json() const;
    
  private:
    //  <countryCode, lastUpdated, lastChanged>
    std::tuple<std::string,TimeValue64,TimeValue64>  _data;
  };
  
  //--------------------------------------------------------------------------
  //--------------------------------------------------------------------------
  class Ipv4CountryDb
    : public RDAP::Ipv4Routes<Ipv4CountryDbValue>
  {
  public:
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    Ipv4CountryDb(const std::string & fn = "/usr/local/etc/ipv4country.db");

    bool Add(const RDAP::IPv4Response & rdapResponse);

    bool Update(const RDAP::IPv4Response & rdapResponse);

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    bool Reload();
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    bool Save() const;

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    void PrintJson(std::ostream & os) const;

    void CreateCountryAggregates();
    
    std::vector<Ipv4Prefix>
    PrefixesForCountries(const std::vector<std::string> & countries);

    std::vector<Ipv4Prefix>
    PrefixesForCountries(const std::string & regExpression,
                         bool minimalSet = true);

    void AggregateAdjacents();
    
  private:
    std::string          _filename;

    void CreateCountryAggregates(uint8_t maslken);
    static void CoalesceAdjacentPrefixes(std::vector<Ipv4Prefix> & vp);
    static void CoalesceContainedPrefixes(std::vector<Ipv4Prefix> & vp);
  };
  
}  // namespace Dwm

#endif  // _DWMIPV4COUNTRYDB_HH_