-
-#ifndef ZYPP_REPOSITORY_H
-#define ZYPP_REPOSITORY_H
+/*---------------------------------------------------------------------\
+| ____ _ __ __ ___ |
+| |__ / \ / / . \ . \ |
+| / / \ V /| _/ _/ |
+| / /__ | | | | | | |
+| /_____||_| |_| |_| |
+| |
+\---------------------------------------------------------------------*/
+/** \file zypp/Repository.h
+ *
+*/
+#ifndef ZYPP_SAT_REPOSITORY_H
+#define ZYPP_SAT_REPOSITORY_H
#include <iosfwd>
-#include <string>
-
-#include "zypp/base/PtrTypes.h"
#include "zypp/base/SafeBool.h"
+#include "zypp/Pathname.h"
+#include "zypp/sat/detail/PoolMember.h"
+#include "zypp/sat/LookupAttr.h" // LookupAttrTools.h included at EOF
+#include "zypp/sat/Solvable.h"
#include "zypp/RepoInfo.h"
-#include "zypp/repo/PackageDelta.h"
+#include "zypp/Date.h"
+///////////////////////////////////////////////////////////////////
namespace zypp
-{
- namespace repo
- {
- DEFINE_PTR_TYPE(RepositoryImpl);
- class RepositoryImpl;
- }
+{ /////////////////////////////////////////////////////////////////
- class Repository : private base::SafeBool<Repository>
- {
- public:
- typedef repo::RepositoryImpl Impl;
- typedef repo::RepositoryImpl_Ptr Impl_Ptr;
+ namespace detail
+ {
+ struct ByRepository;
+ }
- public:
+ ///////////////////////////////////////////////////////////////////
+ //
+ // CLASS NAME : Repository
+ //
+ /** */
+ class Repository : protected sat::detail::PoolMember,
+ private base::SafeBool<Repository>
+ {
+ public:
+ typedef filter_iterator<detail::ByRepository, sat::detail::SolvableIterator> SolvableIterator;
+ typedef sat::detail::size_type size_type;
+ typedef sat::detail::RepoIdType IdType;
- /**
- * \short Default ctor: noRepository.
- * \see RepoManager::createFromCache.
- */
- Repository();
-
- /** \short Factory ctor taking a RepositoryImpl.
- * This is quite low level. You usually want to use RepoManager to
- * manage the repositories.
- * \see RepoManager
- */
- explicit
- Repository( const Impl_Ptr & impl_r );
-
- /** \short Factory ctor taking a RepositoryImpl.
- */
- explicit
- Repository( const RepoInfo & info_r );
+ typedef sat::ArrayAttr<std::string,std::string> Keywords;
- /**
- * A dummy Repository (Id \c 0) providing nothing, doing nothing.
- */
- static const Repository noRepository;
+ public:
+ /** Default ctor creates \ref noRepository.*/
+ Repository()
+ : _id( sat::detail::noRepoId ) {}
- /** Validate Repository in a boolean context.
- * \c FALSE iff == noRepository.
- */
- using base::SafeBool<Repository>::operator bool_type;
+ /** \ref PoolImpl ctor. */
+ explicit Repository( IdType id_r )
+ : _id( id_r ) {}
- public:
- typedef unsigned long NumericId;
+ public:
+ /** Represents no \ref Repository. */
+ static const Repository noRepository;
- /** Runtime unique numeric Repository Id. */
- NumericId numericId() const;
+#ifndef SWIG // Swig treats it as syntax error
+ /** Evaluate \ref Repository in a boolean context (\c != \c noRepository). */
+ using base::SafeBool<Repository>::operator bool_type;
+#endif
+ /** Reserved system repository alias \c @System. */
+ static const std::string & systemRepoAlias();
- /**
- * \short Repository info used to create this repository
- */
- const RepoInfo & info() const;
+ /** Return whether this is the system repository. */
+ bool isSystemRepo() const;
+
+ public:
+ /**
+ * Short unique string to identify a repo.
+ * ie: openSUSE-10.3
+ *
+ * If you are looking for a label to display
+ * see \ref name().
+ * ie: "openSUSE 10.3 Main repository"
+ *
+ */
+ std::string alias() const;
+
+ /** Label to display for this repo. */
+ std::string name() const;
+
+ /**
+ * Timestamp when this repository was generated
+ *
+ * Usually this value is calculated as the newer
+ * timestamp from the timestamp of all the resources
+ * that conform the repository's metadata.
+ *
+ * For example in a rpm-md repository, it would be
+ * the resource specified in the xml file whith
+ * the newest timestamp attribute (which is the
+ * timestamp of the file in the server ).
+ *
+ * The timestamp is 0 if the repository does not
+ * specify when it was generated.
+ *
+ */
+ Date generatedTimestamp() const;
+
+ /**
+ * Suggested expiration timestamp.
+ *
+ * Repositories can define an amount of time
+ * they expire, with the generated timestamp as
+ * the base point of time.
+ *
+ * Note that is the responsability of the repository
+ * to freshen the generated timestamp to tell the
+ * client that the repo is alive and updating the
+ * metadata.
+ *
+ * The timestamp is 0 if the repository does not specify
+ * an expiration date.
+ *
+ */
+ Date suggestedExpirationTimestamp() const;
+
+ /**
+ * repository keywords (tags)
+ */
+ Keywords keywords() const;
+
+ /**
+ * The suggested expiration date of this repository
+ * already passed
+ *
+ * rpm-md repositories can provide this tag using the
+ * expire extension tag:
+ * \see http://en.opensuse.org/Standards/Rpm_Metadata#SUSE_repository_info_.28suseinfo.xml.29.2C_extensions_to_repomd.xml
+ */
+ bool maybeOutdated() const;
+
+ /**
+ * if the repository claims to update something then
+ * it is an update repository
+ *
+ * This is implemented by looking at the repository updates
+ * tag.
+ * \see http://en.opensuse.org/Standards/Rpm_Metadata#SUSE_repository_info_.28suseinfo.xml.29.2C_extensions_to_repomd.xml
+ */
+ bool isUpdateRepo() const;
+
+ /**
+ * wether the repository claims to update something \ref prod
+ * with key \ref cpeid
+ *
+ * \see zypp::Product::cpeId()
+ *
+ * See http://cpe.mitre.org/ for more information on the
+ * Common Platform Enumearation.
+ */
+ bool providesUpdatesFor( const std::string &cpeid ) const;
+
+ /** Whether \ref Repository contains solvables. */
+ bool solvablesEmpty() const;
+
+ /** Number of solvables in \ref Repository. */
+ size_type solvablesSize() const;
+
+ /** Iterator to the first \ref Solvable. */
+ SolvableIterator solvablesBegin() const;
+
+ /** Iterator behind the last \ref Solvable. */
+ SolvableIterator solvablesEnd() const;
+
+ public:
+
+ /** Query class for Repository */
+ class ProductInfoIterator;
+
+ /**
+ * Get an iterator to the beginning of the repository
+ * compatible distros.
+ * \note This is only a hint. There is no guarantee that
+ * the repository is built for that product.
+ * \see Repository::ProductInfoIterator
+ */
+ ProductInfoIterator compatibleWithProductBegin() const;
+
+ /**
+ * Get an iterator to the end of the repository
+ * compatible distros.
+ * \see Repository::ProductInfoIterator
+ */
+ ProductInfoIterator compatibleWithProductEnd() const;
+
+ /**
+ * Get an iterator to the beginning of the repository
+ * compatible distros.
+ * \see Repository::ProductInfoIterator
+ */
+ ProductInfoIterator updatesProductBegin() const;
+
+ /**
+ * Get an iterator to the end of the repository
+ * compatible distros.
+ * \see Repository::ProductInfoIterator
+ */
+ ProductInfoIterator updatesProductEnd() const;
+
+ public:
+ /** Return any associated \ref RepoInfo. */
+ RepoInfo info() const;
+ /** Set \ref RepoInfo for this repository.
+ * \throws Exception if this is \ref noRepository
+ * \throws Exception if the \ref RepoInfo::alias
+ * does not match the \ref Repository::name.
+ */
+ void setInfo( const RepoInfo & info_r );
+
+ /** Remove any \ref RepoInfo set for this repository. */
+ void clearInfo();
+
+ public:
+ /** Remove this \ref Repository from it's \ref Pool. */
+ void eraseFromPool();
+
+ /** Functor calling \ref eraseFromPool. */
+ struct EraseFromPool;
+
+ public:
+ /** Return next Repository in \ref Pool (or \ref noRepository). */
+ Repository nextInPool() const;
+
+ public:
+ /** \name Repository content manipulating methods.
+ * \todo maybe a separate Repository/Solvable content manip interface
+ * provided by the pool.
+ */
+ //@{
+ /** Load \ref Solvables from a solv-file.
+ * In case of an exception the repository remains in the \ref Pool.
+ * \throws Exception if this is \ref noRepository
+ * \throws Exception if loading the solv-file fails.
+ * \see \ref Pool::addRepoSolv and \ref Repository::EraseFromPool
+ */
+ void addSolv( const Pathname & file_r );
+
+ /** Load \ref Solvables from a helix-file.
+ * Supports loading of gzip compressed files (.gz). In case of an exception
+ * the repository remains in the \ref Pool.
+ * \throws Exception if this is \ref noRepository
+ * \throws Exception if loading the helix-file fails.
+ * \see \ref Pool::addRepoHelix and \ref Repository::EraseFromPool
+ */
+ void addHelix( const Pathname & file_r );
+
+ /** Add \c count_r new empty \ref Solvable to this \ref Repository. */
+ sat::Solvable::IdType addSolvables( unsigned count_r );
+ /** \overload Add only one new \ref Solvable. */
+ sat::Solvable::IdType addSolvable()
+ { return addSolvables( 1 ); }
+ //@}
+
+ public:
+ /** Expert backdoor. */
+ ::_Repo * get() const;
+ /** Expert backdoor. */
+ IdType id() const { return _id; }
+ /** libsolv internal priorities.
+ * Unlike the \ref RepoInfo priority which tries to be YUM conform
+ * (H[1-99]L), this one is the solvers internal priority representation.
+ * It is type \c int and as one might expect it, the higher the value
+ * the higher the priority. Subpriority is currently used to express
+ * media preferences (\see \ref MediaPriority).
+ */
+ //@{
+ int satInternalPriority() const;
+ int satInternalSubPriority() const;
+ //@}
+ private:
+#ifndef SWIG // Swig treats it as syntax error
+ friend base::SafeBool<Repository>::operator bool_type() const;
+#endif
+ bool boolTest() const { return get(); }
+ private:
+ IdType _id;
+ };
+ ///////////////////////////////////////////////////////////////////
+
+ /** \relates Repository Stream output */
+ std::ostream & operator<<( std::ostream & str, const Repository & obj );
+
+ /** \relates Repository */
+ inline bool operator==( const Repository & lhs, const Repository & rhs )
+ { return lhs.get() == rhs.get(); }
+
+ /** \relates Repository */
+ inline bool operator!=( const Repository & lhs, const Repository & rhs )
+ { return lhs.get() != rhs.get(); }
+
+ /** \relates Repository */
+ inline bool operator<( const Repository & lhs, const Repository & rhs )
+ { return lhs.get() < rhs.get(); }
+
+ ///////////////////////////////////////////////////////////////////
/**
- * \short Patch RPMs the repository provides
+ * Query class for Repository related products
+ *
+ * The iterator does not provide a dereference
+ * operator so you can do * on it, but you can
+ * access the attributes of each related product
+ * directly from the iterator.
+ *
+ * \code
+ * for_( it, repo.compatibleWithProductBegin(), repo.compatibleWithProductEnd() )
+ * {
+ * cout << it.cpeid() << endl;
+ * }
+ * \endcode
+ *
*/
- const std::list<packagedelta::PatchRpm> & patchRpms() const;
+ class Repository::ProductInfoIterator : public boost::iterator_adaptor<
+ Repository::ProductInfoIterator // Derived
+ , sat::LookupAttr::iterator // Base
+ , int // Value
+ , boost::forward_traversal_tag // CategoryOrTraversal
+ , int // Reference
+ >
+ {
+ public:
+ ProductInfoIterator()
+ {}
- /**
- * \short Delta RPMs the repository provides
+ /**
+ * Product label
+ */
+ std::string label() const;
+
+ /**
+ * The Common Platform Enumeration name
+ * for this product.
+ *
+ * See http://cpe.mitre.org
+ */
+ std::string cpeId() const;
+
+ private:
+ friend class Repository;
+ /** Hide ctor as just a limited set of attributes is valid. */
+ explicit ProductInfoIterator( sat::SolvAttr attr_r, Repository repo_r );
+
+ private:
+ friend class boost::iterator_core_access;
+ int dereference() const { return 0; }
+ };
+ ///////////////////////////////////////////////////////////////////
+
+ ///////////////////////////////////////////////////////////////////
+ //
+ // CLASS NAME : Repository::EraseFromPool
+ //
+ /** Functor removing \ref Repository from it's \ref Pool.
+ *
+ * E.g. used as dispose function in. \ref AutoDispose
+ * to provide a convenient and exception safe temporary
+ * \ref Repository.
+ * \code
+ * sat::Pool satpool;
+ * MIL << "1 " << satpool << endl;
+ * {
+ * AutoDispose<Repository> tmprepo( (Repository::EraseFromPool()) );
+ * *tmprepo = satpool.reposInsert( "A" );
+ * tmprepo->addSolv( "sl10.1-beta7-packages.solv" );
+ * DBG << "2 " << satpool << endl;
+ * // Calling 'tmprepo.resetDispose();' here
+ * // would keep the Repo.
+ * }
+ * MIL << "3 " << satpool << endl;
+ * \endcode
+ * \code
+ * 1 sat::pool(){0repos|2slov}
+ * 2 sat::pool(){1repos|2612slov}
+ * 3 sat::pool(){0repos|2slov}
+ * \endcode
+ * Leaving the block without calling <tt>tmprepo.resetDispose();</tt>
+ * before, will automatically remove the \ref Repo from it's \ref Pool.
*/
- const std::list<packagedelta::DeltaRpm> & deltaRpms() const;
-
- private:
- friend base::SafeBool<Repository>::operator bool_type() const;
- /** \ref SafeBool test. */
- bool boolTest() const
- { return _pimpl != noRepository._pimpl; }
-
- private:
- /** Pointer to implementation */
- RW_pointer<Impl,rw_pointer::Intrusive<Impl> > _pimpl;
- };
-
- /** \relates Repository */
- std::ostream & operator<<( std::ostream & str, const Repository & obj );
- /** \relates Repository */
- bool operator==( const Repository & lhs, const Repository & rhs );
- /** \relates Repository */
- inline bool operator!=( const Repository & lhs, const Repository & rhs )
- { return !( lhs == rhs ); }
- /** \relates Repository */
- bool operator<( const Repository & lhs, const Repository & rhs );
-
-}
+ struct Repository::EraseFromPool
+ {
+ void operator()( Repository repository_r ) const
+ { repository_r.eraseFromPool(); }
+ };
+ ///////////////////////////////////////////////////////////////////
-#endif
+ ///////////////////////////////////////////////////////////////////
+ namespace detail
+ { /////////////////////////////////////////////////////////////////
+ ///////////////////////////////////////////////////////////////////
+ //
+ // CLASS NAME : RepositoryIterator
+ //
+ /** */
+ class RepositoryIterator : public boost::iterator_adaptor<
+ RepositoryIterator // Derived
+ , ::_Repo ** // Base
+ , Repository // Value
+ , boost::forward_traversal_tag // CategoryOrTraversal
+ , Repository // Reference
+ >
+ {
+ public:
+ RepositoryIterator()
+ : RepositoryIterator::iterator_adaptor_( 0 )
+ {}
+
+ explicit RepositoryIterator( ::_Repo ** p )
+ : RepositoryIterator::iterator_adaptor_( p )
+ {}
+
+ private:
+ friend class boost::iterator_core_access;
+
+ Repository dereference() const
+ { return Repository( *base() ); }
+ };
+ ///////////////////////////////////////////////////////////////////
+ ///////////////////////////////////////////////////////////////////
+ //
+ // CLASS NAME : ByRepository
+ //
+ /** Functor filtering \ref Solvable by \ref Repository.*/
+ struct ByRepository
+ {
+ public:
+ ByRepository( const Repository & repository_r ) : _repository( repository_r ) {}
+ ByRepository( sat::detail::RepoIdType id_r ) : _repository( id_r ) {}
+ ByRepository() {}
+
+ bool operator()( const sat::Solvable & slv_r ) const
+ { return slv_r.repository() == _repository; }
+
+ private:
+ Repository _repository;
+ };
+ ///////////////////////////////////////////////////////////////////
+ /////////////////////////////////////////////////////////////////
+ } // namespace detail
+ ///////////////////////////////////////////////////////////////////
+ /////////////////////////////////////////////////////////////////
+} // namespace zypp
+///////////////////////////////////////////////////////////////////
+// Late include as sat::ArrayAttr requires Repository.h
+#include "zypp/sat/LookupAttrTools.h"
+#endif // ZYPP_SAT_REPOSITORY_H
projects / platform / upstream / libzypp.git / blobdiff