1 /*---------------------------------------------------------------------\
3 | |__ / \ / / . \ . \ |
8 \---------------------------------------------------------------------*/
9 /** \file zypp/Target.h
17 #include "zypp/base/ReferenceCounted.h"
18 #include "zypp/base/NonCopyable.h"
19 #include "zypp/base/PtrTypes.h"
20 #include "zypp/APIConfig.h"
22 #include "zypp/Product.h"
23 #include "zypp/Pathname.h"
24 #include "zypp/ResPool.h"
26 ///////////////////////////////////////////////////////////////////
28 { /////////////////////////////////////////////////////////////////
41 DEFINE_PTR_TYPE(Target);
43 ///////////////////////////////////////////////////////////////////
45 // CLASS NAME : Target
49 class Target : public base::ReferenceCounted, public base::NonCopyable
52 typedef target::TargetImpl Impl;
53 typedef intrusive_ptr<Impl> Impl_Ptr;
54 typedef std::list<PoolItem> PoolItemList;
59 * builds or refreshes the target cache
64 * cleans the target cache (.solv files)
69 * load resolvables into the pool
76 * unload target resolvables from the
81 /** Refference to the RPM database */
82 target::rpm::RpmDb & rpmDb();
84 /** If the package is installed and provides the file
85 Needed to evaluate split provides during Resolver::Upgrade() */
86 bool providesFile (const std::string & name_str, const std::string & path_str) const;
88 /** Return name of package owning \a path_str
89 * or empty string if no installed package owns \a path_str.
91 std::string whoOwnsFile (const std::string & path_str) const;
93 /** Return the root set for this target */
94 Pathname root() const;
96 /** Return the path prefixed by the target root, unless it already is prefixed. */
97 Pathname assertRootPrefix( const Pathname & path_r ) const
98 { return Pathname::assertprefix( root(), path_r ); }
100 /** return the last modification date of the target */
101 Date timestamp() const;
104 * returns the target base installed product, also known as
105 * the distribution or platform.
107 * returns 0 if there is no base installed product in the
110 * \note this method requires the target to be loaded,
111 * otherwise it will return 0 as no product is found.
113 * if you require some base product attributes when the
114 * target is not loaded into the pool, see
115 * \ref targetDistribution , \ref targetDistributionRelease
116 * and \ref distributionVersion that obtain the data
117 * on demand from the installed product information.
119 Product::constPtr baseProduct() const;
122 * \brief Languages to be supported by the system.
123 * E.g. language specific packages to be installed.
125 LocaleSet requestedLocales() const;
126 /** \overload Use a specific root_r, if empty the default targets root, or '/'
128 static LocaleSet requestedLocales( const Pathname & root_r );
131 /** \name Base product and registration.
133 * Static methods herein allow to retrieve the values without explicitly
134 * initializing the \ref Target. They take a targets root directory as
135 * argument. If an empty \ref Pathname is passed, an already existing
136 * Targets root is used, otherwise \c "/" is assumed.
139 /** This is \c register.target attribute of the installed base product.
140 * Used for registration and \ref Service refresh.
142 std::string targetDistribution() const;
144 static std::string targetDistribution( const Pathname & root_r );
146 /** This is \c register.release attribute of the installed base product.
147 * Used for registration.
149 std::string targetDistributionRelease() const;
151 static std::string targetDistributionRelease( const Pathname & root_r );
153 /** This is \c register.flavor attribute of the installed base product.
154 * Used for registration.
155 * \note don't mistake this for \ref distributionFlavor
157 std::string targetDistributionFlavor() const;
159 static std::string targetDistributionFlavor( const Pathname & root_r );
161 struct DistributionLabel { std::string shortName; std::string summary; };
162 /** This is \c shortName and \c summary attribute of the installed base product.
163 * Used e.g. for the bootloader menu.
165 DistributionLabel distributionLabel() const;
167 static DistributionLabel distributionLabel( const Pathname & root_r );
169 /** This is \c version attribute of the installed base product.
170 * For example http://download.opensue.org/update/11.0
171 * The 11.0 corresponds to the base product version.
173 std::string distributionVersion() const;
175 static std::string distributionVersion( const Pathname & root_r );
178 * This is \c flavor attribute of the installed base product
179 * but does not require the target to be loaded as it remembers
180 * the last used one. It can be empty is the target has never
181 * been loaded, as the value is not present in the system
182 * but computer from a package provides
183 * \note don't mistake this for \ref targetDistributionFlavor
185 std::string distributionFlavor() const;
187 static std::string distributionFlavor( const Pathname & root_r );
190 * anonymous unique id
192 * This id is generated once and stays in the
193 * saved in the target.
194 * It is unique and is used only for statistics.
197 std::string anonymousUniqueId() const;
199 static std::string anonymousUniqueId( const Pathname & root_r );
203 /** Ctor. If \c doRebuild_r is \c true, an already existing
204 * database is rebuilt (rpm --rebuilddb ).
207 Target( const Pathname & root = "/", bool doRebuild_r = false );
210 Target( const Impl_Ptr & impl_r );
213 friend std::ostream & operator<<( std::ostream & str, const Target & obj );
214 /** Stream output. */
215 std::ostream & dumpOn( std::ostream & str ) const;
218 /** Direct access to Impl. */
219 friend class zypp_detail::ZYppImpl;
221 /** Pointer to implementation */
222 RW_pointer<Impl,rw_pointer::Intrusive<Impl> > _pimpl;
224 ///////////////////////////////////////////////////////////////////
226 /** \relates Target Stream output. */
227 inline std::ostream & operator<<( std::ostream & str, const Target & obj )
228 { return obj.dumpOn( str ); }
230 /** \relates Target::DistributionLabel Stream output.
231 * Write out the content as key/value pairs:
233 * summary=Beautiful Name
237 std::ostream & operator<<( std::ostream & str, const Target::DistributionLabel & obj );
239 /////////////////////////////////////////////////////////////////
241 ///////////////////////////////////////////////////////////////////
242 #endif // ZYPP_TARGET_H