zypp/Target.h

   1 /*---------------------------------------------------------------------\
   2 |                          ____ _   __ __ ___                          |
   3 |                         |__  / \ / / . \ . \                         |
   4 |                           / / \ V /|  _/  _/                         |
   5 |                          / /__ | | | | | |                           |
   6 |                         /_____||_| |_| |_|                           |
   7 |                                                                      |
   8 \---------------------------------------------------------------------*/
   9 /** \file zypp/Target.h
  10  *
  11 */
  12 #ifndef ZYPP_TARGET_H
  13 #define ZYPP_TARGET_H
  14
  15 #include <iosfwd>
  16
  17 #include "zypp/base/ReferenceCounted.h"
  18 #include "zypp/base/NonCopyable.h"
  19 #include "zypp/base/PtrTypes.h"
  20 #include "zypp/APIConfig.h"
  21
  22 #include "zypp/Product.h"
  23 #include "zypp/Pathname.h"
  24 #include "zypp/ResPool.h"
  25
  26 ///////////////////////////////////////////////////////////////////
  27 namespace zypp
  28 { /////////////////////////////////////////////////////////////////
  29   namespace target
  30   {
  31     class TargetImpl;
  32     namespace rpm {
  33       class RpmDb;
  34     }
  35   }
  36   namespace zypp_detail
  37   {
  38     class ZYppImpl;
  39   }
  40
  41   DEFINE_PTR_TYPE(Target);
  42
  43   ///////////////////////////////////////////////////////////////////
  44   //
  45   //    CLASS NAME : Target
  46   //
  47   /**
  48   */
  49   class Target : public base::ReferenceCounted, public base::NonCopyable
  50   {
  51   public:
  52     typedef target::TargetImpl  Impl;
  53     typedef intrusive_ptr<Impl> Impl_Ptr;
  54     typedef std::list<PoolItem> PoolItemList;
  55
  56   public:
  57
  58     /**
  59      * builds or refreshes the target cache
  60      */
  61     void buildCache();
  62
  63     /**
  64      * cleans the target cache (.solv files)
  65      */
  66     void cleanCache();
  67
  68    /**
  69      * load resolvables into the pool
  70      */
  71     void load();
  72
  73     void reload();
  74
  75     /**
  76      * unload target resolvables from the
  77      * pool
  78      */
  79     void unload();
  80
  81     /** Null implementation */
  82     static Target_Ptr nullimpl();
  83
  84     /** Refference to the RPM database */
  85     target::rpm::RpmDb & rpmDb();
  86
  87     /** If the package is installed and provides the file
  88      Needed to evaluate split provides during Resolver::Upgrade() */
  89     bool providesFile (const std::string & name_str, const std::string & path_str) const;
  90
  91     /** Return name of package owning \a path_str
  92      * or empty string if no installed package owns \a path_str.
  93      **/
  94     std::string whoOwnsFile (const std::string & path_str) const;
  95
  96     /** Return the root set for this target */
  97     Pathname root() const;
  98
  99     /** Return the path prefixed by the target root, unless it already is prefixed. */
 100     Pathname assertRootPrefix( const Pathname & path_r ) const
 101     { return Pathname::assertprefix( root(), path_r ); }
 102
 103     /** return the last modification date of the target */
 104     Date timestamp() const;
 105
 106     /**
 107      * returns the target base installed product, also known as
 108      * the distribution or platform.
 109      *
 110      * returns 0 if there is no base installed product in the
 111      * pool.
 112      *
 113      * \note this method requires the target to be loaded,
 114      * otherwise it will return 0 as no product is found.
 115      *
 116      * if you require some base product attributes when the
 117      * target is not loaded into the pool, see
 118      * \ref targetDistribution , \ref targetDistributionRelease
 119      * and \ref distributionVersion that obtain the data
 120      * on demand from the installed product information.
 121      */
 122     Product::constPtr baseProduct() const;
 123
 124     /**
 125      * \brief Languages to be supported by the system.
 126      * E.g. language specific packages to be installed.
 127      */
 128     LocaleSet requestedLocales() const;
 129     /** \overload Use a specific root_r, if empty the default targets root, or '/'
 130      */
 131     static LocaleSet requestedLocales( const Pathname & root_r );
 132
 133   public:
 134     /** \name Base product and registration.
 135      *
 136      * Static methods herein allow to retrieve the values without explicitly
 137      * initializing the \ref Target. They take a targets root directory as
 138      * argument. If an empty \ref Pathname is passed, an already existing
 139      * Targets root is used, otherwise \c "/" is assumed.
 140      */
 141     //@{
 142     /** This is \c register.target attribute of the installed base product.
 143      * Used for registration and \ref Service refresh.
 144      */
 145     std::string targetDistribution() const;
 146     /** \overload */
 147     static std::string targetDistribution( const Pathname & root_r );
 148
 149     /** This is \c register.release attribute of the installed base product.
 150      * Used for registration.
 151      */
 152     std::string targetDistributionRelease() const;
 153     /** \overload */
 154     static std::string targetDistributionRelease( const Pathname & root_r );
 155
 156     /** This is \c register.flavor attribute of the installed base product.
 157      * Used for registration.
 158      * \note don't mistake this for \ref distributionFlavor
 159      */
 160     std::string targetDistributionFlavor() const;
 161     /** \overload */
 162     static std::string targetDistributionFlavor( const Pathname & root_r );
 163
 164     struct DistributionLabel { std::string shortName; std::string summary; };
 165     /** This is \c shortName and \c summary attribute of the installed base product.
 166      * Used e.g. for the bootloader menu.
 167      */
 168     DistributionLabel distributionLabel() const;
 169     /** \overload */
 170     static DistributionLabel distributionLabel( const Pathname & root_r );
 171
 172     /** This is \c version attribute of the installed base product.
 173      * For example http://download.opensue.org/update/11.0
 174      * The 11.0 corresponds to the base product version.
 175      */
 176     std::string distributionVersion() const;
 177     /** \overload */
 178     static std::string distributionVersion( const Pathname & root_r );
 179
 180     /**
 181      * This is \c flavor attribute of the installed base product
 182      * but does not require the target to be loaded as it remembers
 183      * the last used one. It can be empty is the target has never
 184      * been loaded, as the value is not present in the system
 185      * but computer from a package provides
 186      * \note don't mistake this for \ref targetDistributionFlavor
 187      */
 188     std::string distributionFlavor() const;
 189     /** \overload */
 190     static std::string distributionFlavor( const Pathname & root_r );
 191
 192     /**
 193      * anonymous unique id
 194      *
 195      * This id is generated once and stays in the
 196      * saved in the target.
 197      * It is unique and is used only for statistics.
 198      *
 199      */
 200     std::string anonymousUniqueId() const;
 201     /** \overload */
 202     static std::string anonymousUniqueId( const Pathname & root_r );
 203     //@}
 204
 205   public:
 206     /** Ctor. If \c doRebuild_r is \c true, an already existing
 207      * database is rebuilt (rpm --rebuilddb ).
 208     */
 209     explicit
 210     Target( const Pathname & root = "/", bool doRebuild_r = false );
 211     /** Ctor */
 212     explicit
 213     Target( const Impl_Ptr & impl_r );
 214
 215   private:
 216     friend std::ostream & operator<<( std::ostream & str, const Target & obj );
 217     /** Stream output. */
 218     std::ostream & dumpOn( std::ostream & str ) const;
 219
 220   private:
 221     /** Direct access to Impl. */
 222     friend class zypp_detail::ZYppImpl;
 223
 224     /** Pointer to implementation */
 225     RW_pointer<Impl,rw_pointer::Intrusive<Impl> > _pimpl;
 226
 227     static Target_Ptr _nullimpl;
 228   };
 229   ///////////////////////////////////////////////////////////////////
 230
 231   /** \relates Target Stream output. */
 232   inline std::ostream & operator<<( std::ostream & str, const Target & obj )
 233   { return obj.dumpOn( str ); }
 234
 235   /** \relates Target::DistributionLabel Stream output.
 236    * Write out the content as key/value pairs:
 237    * \code
 238    * summary=Beautiful Name
 239    * shortName=BN
 240    * \endcode
 241    */
 242   std::ostream & operator<<( std::ostream & str, const Target::DistributionLabel & obj );
 243
 244   /////////////////////////////////////////////////////////////////
 245 } // namespace zypp
 246 ///////////////////////////////////////////////////////////////////
 247 #endif // ZYPP_TARGET_H