CapFactory.cc

Go to the documentation of this file.

/*---------------------------------------------------------------------\
|                          ____ _   __ __ ___                          |
|                         |__  / \ / / . \ . \                         |
|                           / / \ V /|  _/  _/                         |
|                          / /__ | | | | | |                           |
|                         /_____||_| |_| |_|                           |
|                                                                      |
\---------------------------------------------------------------------*/
#include <iostream>
#include <functional>
#include <set>
#include <map>

#include <ext/hash_set>
#include <ext/hash_fun.h>

#include "zypp/base/Logger.h"
#include "zypp/base/Exception.h"
#include "zypp/base/String.h"
#include "zypp/base/Counter.h"

#include "zypp/CapFactory.h"
#include "zypp/capability/Capabilities.h"

using std::endl;

namespace
{ 
  using ::zypp::Resolvable;
  using ::zypp::capability::CapabilityImpl;
  using ::zypp::capability::CapImplOrder;

  struct CapImplHashFun
  {
    size_t operator() ( const CapabilityImpl::Ptr & p ) const
    {
      return __gnu_cxx::hash<const char*>()( p->encode().c_str() );
    }
  };

  struct CapImplHashEqual
  {
    bool operator() ( const CapabilityImpl::Ptr & lhs, const CapabilityImpl::Ptr & rhs ) const
    {
      return (    lhs->encode() == rhs->encode()
               && lhs->kind()   == rhs->kind()
               && lhs->refers() == rhs->refers() );
    }
  };

  //typedef std::set<CapabilityImpl::Ptr,CapImplOrder> USet;
  typedef __gnu_cxx::hash_set<CapabilityImpl::Ptr, CapImplHashFun, CapImplHashEqual> USet;


  USet _uset;

  CapabilityImpl::Ptr usetInsert( CapabilityImpl * allocated_r )
  {
    return *(_uset.insert( CapabilityImpl::Ptr(allocated_r) ).first);
  }

  struct USetStatsCollect : public std::unary_function<CapabilityImpl::constPtr, void>
  {
    typedef ::zypp::Counter<unsigned> Counter;

    Counter _caps;
    std::map<CapabilityImpl::Kind,Counter> _capKind;
    std::map<Resolvable::Kind,Counter>     _capRefers;

    void operator()( const CapabilityImpl::constPtr & cap_r )
    {
      //DBG << *cap_r << endl;
      ++_caps;
      ++(_capKind[cap_r->kind()]);
      ++(_capRefers[cap_r->refers()]);
    }

    std::ostream & dumpOn( std::ostream & str ) const
    {
      str << "  Capabilities total: " << _caps << endl;
      str << "  Capability kinds:" << endl;
      for ( std::map<CapabilityImpl::Kind,Counter>::const_iterator it = _capKind.begin();
            it != _capKind.end(); ++it )
        {
          str << "    " << it->first << '\t' << it->second << endl;
        }
      str << "  Capability refers:" << endl;
      for ( std::map<Resolvable::Kind,Counter>::const_iterator it = _capRefers.begin();
            it != _capRefers.end(); ++it )
        {
          str << "    " << it->first << '\t' << it->second << endl;
        }
      return str;
    }
  };

} // namespace

namespace zypp
{ 

  //
  //    CLASS NAME : CapFactoryImpl
  //
  struct CapFactory::Impl
  {
    static void assertResKind( const Resolvable::Kind & refers_r )
    {
      if ( refers_r == Resolvable::Kind() )
        ZYPP_THROW( Exception("Missing or empty  Resolvable::Kind in Capability") );
    }

    static bool isEditionSpec( Rel op_r, const Edition & edition_r )
    {
      switch ( op_r.inSwitch() )
        {
        case Rel::ANY_e:
          if ( edition_r != Edition::noedition )
            WAR << "Operator " << op_r << " causes Edition "
            << edition_r << " to be ignored." << endl;
          return false;
          break;

        case Rel::NONE_e:
          ZYPP_THROW( Exception("Operator NONE is not allowed in Capability") );
          break;

        case Rel::EQ_e:
        case Rel::NE_e:
        case Rel::LT_e:
        case Rel::LE_e:
        case Rel::GT_e:
        case Rel::GE_e:
          return true;
          break;
        }
      // SHOULD NOT GET HERE
      ZYPP_THROW( Exception("Unknow Operator NONE is not allowed in Capability") );
      return false; // not reached
    }

    static bool isFileSpec( const std::string & name_r )
    {
      return *name_r.c_str() == '/';
    }

    static bool isSplitSpec( const std::string & name_r )
    {
      return name_r.find( ":/" ) != std::string::npos;
    }

    static bool isHalSpec( const std::string & name_r )
    {
      return name_r.substr(0,4) == "hal(";
    }

    static bool isModaliasSpec( const std::string & name_r )
    {
      return name_r.substr(0,9) == "modalias(";
    }

    static CapabilityImpl::Ptr buildFile( const Resolvable::Kind & refers_r,
                                          const std::string & name_r )
    {
      // NullCap check first:
      if ( name_r.empty() )
        {
          // Singleton, so no need to put it into _uset !?
          return capability::NullCap::instance();
        }

      assertResKind( refers_r );

      return usetInsert
      ( new capability::FileCap( refers_r, name_r ) );
    }

    static CapabilityImpl::Ptr buildNamed( const Resolvable::Kind & refers_r,
                                           const std::string & name_r )
    {
      // NullCap check first:
      if ( name_r.empty() )
        {
          // Singleton, so no need to put it into _uset !?
          return capability::NullCap::instance();
        }

      assertResKind( refers_r );

      // file:    /absolute/path
      if ( isFileSpec( name_r ) )
        return usetInsert
        ( new capability::FileCap( refers_r, name_r ) );

      //split:   name:/absolute/path
      static const str::regex  rx( "([^/]*):(/.*)" );
      str::smatch what;
      if( str::regex_match( name_r.begin(), name_r.end(), what, rx ) )
        {
          return usetInsert
          ( new capability::SplitCap( refers_r, what[1].str(), what[2].str() ) );
        }

      //name:    name
      return usetInsert
      ( new capability::NamedCap( refers_r, name_r ) );
    }

    static CapabilityImpl::Ptr buildVersioned( const Resolvable::Kind & refers_r,
                                               const std::string & name_r,
                                               Rel op_r,
                                               const Edition & edition_r )
    {
      if ( Impl::isEditionSpec( op_r, edition_r ) )
        {
          assertResKind( refers_r );

          // build a VersionedCap
          return usetInsert
          ( new capability::VersionedCap( refers_r, name_r, op_r, edition_r ) );
        }
      //else
      // build a NamedCap

      return buildNamed( refers_r, name_r );
    }

    static CapabilityImpl::Ptr buildHal( const Resolvable::Kind & refers_r,
                                         const std::string & name_r,
                                         Rel op_r = Rel::ANY,
                                         const std::string & value_r = std::string() )
    {
      if ( op_r != Rel::ANY )
        {
          ZYPP_THROW( Exception("Unsupported kind of Hal Capability '" + op_r.asString() + "'") );
        }

      //split:   hal(name) [op string]
      static const str::regex  rx( "hal\\(([^)]*)\\)" );
      str::smatch what;
      if( str::regex_match( name_r.begin(), name_r.end(), what, rx ) )
        {
          // Hal always refers to 'System' kind of Resolvable.
          return usetInsert
          ( new capability::HalCap( ResTraits<SystemResObject>::kind,
                                    what[1].str() ) );
        }
      // otherwise
      ZYPP_THROW( Exception("Unsupported kind of Hal Capability '" + name_r + "'") );
      return NULL; // make gcc happy
    }


    static CapabilityImpl::Ptr buildModalias( const Resolvable::Kind & refers_r,
                                              const std::string & name_r,
                                              Rel op_r = Rel::ANY,
                                              const std::string & value_r = std::string() )
    {
      if ( op_r != Rel::ANY )
        {
          ZYPP_THROW( Exception("Unsupported kind of Modalias Capability  '" + op_r.asString() + "'") );
        }

      //split:   modalias(name) [op string]
      static const str::regex  rx( "modalias\\(([^)]*)\\)" );
      str::smatch what;
      if( str::regex_match( name_r.begin(), name_r.end(), what, rx ) )
        {
          // Modalias always refers to 'System' kind of Resolvable.
          return usetInsert
          ( new capability::ModaliasCap( ResTraits<SystemResObject>::kind,
                                         what[1].str() ) );
        }
      // otherwise
      ZYPP_THROW( Exception("Unsupported kind of Modalias Capability'" + name_r + "'") );
      return NULL; // make gcc happy
    }
  };


  //
  //    CLASS NAME : CapFactory
  //

  //
  //    METHOD NAME : CapFactory::CapFactory
  //    METHOD TYPE : Ctor
  //
  CapFactory::CapFactory()
  {}

  //
  //    METHOD NAME : CapFactory::~CapFactory
  //    METHOD TYPE : Dtor
  //
  CapFactory::~CapFactory()
  {}

  //
  //    METHOD NAME : CapFactory::parse
  //    METHOD TYPE : Capability
  //
  Capability CapFactory::parse( const Resolvable::Kind & refers_r,
                                const std::string & strval_r ) const

  try
    {
      if ( Impl::isHalSpec( strval_r ) )
        {
          return Capability( Impl::buildHal( refers_r, strval_r ) );
        }
      if ( Impl::isModaliasSpec( strval_r ) )
        {
          return Capability( Impl::buildModalias( refers_r, strval_r ) );
        }
      if ( Impl::isFileSpec( strval_r ) )
        {
          return Capability( Impl::buildFile( refers_r, strval_r ) );
        }

      // strval_r has at least two words which could make 'op edition'?
      // improve regex!
      static const str::regex  rx( "(.*[^ \t])([ \t]+)([^ \t]+)([ \t]+)([^ \t]+)" );
      str::smatch what;
      if( str::regex_match( strval_r.begin(), strval_r.end(),what, rx ) )
        {
          Rel op;
          Edition edition;
          try
            {
              op = Rel(what[3].str());
              edition = Edition(what[5].str());
            }
          catch ( Exception & excpt )
            {
              // So they don't make valid 'op edition'
              ZYPP_CAUGHT( excpt );
              DBG << "Trying named cap for: " << strval_r << endl;
              // See whether it makes a named cap.
              return Capability( Impl::buildNamed( refers_r, strval_r ) );
            }

          // Valid 'op edition'
          return Capability ( Impl::buildVersioned( refers_r,
                                                    what[1].str(), op, edition ) );
        }
      //else
      // not a VersionedCap
      return Capability( Impl::buildNamed( refers_r, strval_r ) );
    }
  catch ( Exception & excpt )
    {
      ZYPP_RETHROW( excpt );
      return Capability(); // not reached
    }


  //
  //    METHOD NAME : CapFactory::parse
  //    METHOD TYPE : Capability
  //
  Capability CapFactory::parse( const Resolvable::Kind & refers_r,
                                const std::string & name_r,
                                const std::string & op_r,
                                const std::string & edition_r ) const
  try
    {
      if ( Impl::isHalSpec( name_r ) )
        {
          return Capability( Impl::buildHal( refers_r, name_r, Rel(op_r), edition_r ) );
        }
      if ( Impl::isModaliasSpec( name_r ) )
        {
          return Capability( Impl::buildModalias( refers_r, name_r, Rel(op_r), edition_r ) );
        }
      // Try creating Rel and Edition, then parse
      return parse( refers_r, name_r, Rel(op_r), Edition(edition_r) );
    }
  catch ( Exception & excpt )
    {
      ZYPP_RETHROW( excpt );
      return Capability(); // not reached
    }

  //
  //    METHOD NAME : CapFactory::parse
  //    METHOD TYPE : Capability
  //
  Capability CapFactory::parse( const Resolvable::Kind & refers_r,
                                const std::string & name_r,
                                Rel op_r,
                                const Edition & edition_r ) const
  try
    {
      if ( Impl::isHalSpec( name_r ) )
        {
          return Capability( Impl::buildHal( refers_r, name_r, op_r, edition_r.asString() ) );
        }
      if ( Impl::isModaliasSpec( name_r ) )
        {
          return Capability( Impl::buildModalias( refers_r, name_r, op_r, edition_r.asString() ) );
        }
      return Capability( Impl::buildVersioned( refers_r, name_r, op_r, edition_r ) );
    }
  catch ( Exception & excpt )
    {
      ZYPP_RETHROW( excpt );
      return Capability(); // not reached
    }

  //
  //    METHOD NAME : CapFactory::halEvalCap
  //    METHOD TYPE : Capability
  //
  Capability CapFactory::halEvalCap() const
  try
    {
      return Capability( Impl::buildHal( Resolvable::Kind(), "hal()" ) );
    }
  catch ( Exception & excpt )
    {
      ZYPP_RETHROW( excpt );
      return Capability(); // not reached
    }

  //
  //    METHOD NAME : CapFactory::modaliasEvalCap
  //    METHOD TYPE : Capability
  //
  Capability CapFactory::modaliasEvalCap() const
  try
    {
      return Capability( Impl::buildModalias( Resolvable::Kind(), "modalias()" ) );
    }
  catch ( Exception & excpt )
    {
      ZYPP_RETHROW( excpt );
      return Capability(); // not reached
    }

  //
  //    METHOD NAME : CapFactory::encode
  //    METHOD TYPE : std::string
  //
  std::string CapFactory::encode( const Capability & cap_r ) const
  {
    return cap_r._pimpl->encode();
  }

  /******************************************************************
  **
  **    FUNCTION NAME : operator<<
  **    FUNCTION TYPE : std::ostream &
  */
  std::ostream & operator<<( std::ostream & str, const CapFactory & obj )
  {
    str << "CapFactory stats:" << endl;

    return for_each( _uset.begin(), _uset.end(), USetStatsCollect() ).dumpOn( str );
  }

} // namespace zypp

---