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 /** Null implementation */
82 static Target_Ptr nullimpl();
84 /** Refference to the RPM database */
85 target::rpm::RpmDb & rpmDb();
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;
91 /** Return name of package owning \a path_str
92 * or empty string if no installed package owns \a path_str.
94 std::string whoOwnsFile (const std::string & path_str) const;
96 /** Return the root set for this target */
97 Pathname root() const;
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 ); }
103 /** return the last modification date of the target */
104 Date timestamp() const;
107 * returns the target base installed product, also known as
108 * the distribution or platform.
110 * returns 0 if there is no base installed product in the
113 * \note this method requires the target to be loaded,
114 * otherwise it will return 0 as no product is found.
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.
122 Product::constPtr baseProduct() const;
125 * \brief Languages to be supported by the system.
126 * E.g. language specific packages to be installed.
128 LocaleSet requestedLocales() const;
129 /** \overload Use a specific root_r, if empty the default targets root, or '/'
131 static LocaleSet requestedLocales( const Pathname & root_r );
134 /** \name Base product and registration.
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.
142 /** This is \c register.target attribute of the installed base product.
143 * Used for registration and \ref Service refresh.
145 std::string targetDistribution() const;
147 static std::string targetDistribution( const Pathname & root_r );
149 /** This is \c register.release attribute of the installed base product.
150 * Used for registration.
152 std::string targetDistributionRelease() const;
154 static std::string targetDistributionRelease( const Pathname & root_r );
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
160 std::string targetDistributionFlavor() const;
162 static std::string targetDistributionFlavor( const Pathname & root_r );
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.
168 DistributionLabel distributionLabel() const;
170 static DistributionLabel distributionLabel( const Pathname & root_r );
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.
176 std::string distributionVersion() const;
178 static std::string distributionVersion( const Pathname & root_r );
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
188 std::string distributionFlavor() const;
190 static std::string distributionFlavor( const Pathname & root_r );
193 * anonymous unique id
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.
200 std::string anonymousUniqueId() const;
202 static std::string anonymousUniqueId( const Pathname & root_r );
206 /** Ctor. If \c doRebuild_r is \c true, an already existing
207 * database is rebuilt (rpm --rebuilddb ).
210 Target( const Pathname & root = "/", bool doRebuild_r = false );
213 Target( const Impl_Ptr & impl_r );
216 friend std::ostream & operator<<( std::ostream & str, const Target & obj );
217 /** Stream output. */
218 std::ostream & dumpOn( std::ostream & str ) const;
221 /** Direct access to Impl. */
222 friend class zypp_detail::ZYppImpl;
224 /** Pointer to implementation */
225 RW_pointer<Impl,rw_pointer::Intrusive<Impl> > _pimpl;
227 static Target_Ptr _nullimpl;
229 ///////////////////////////////////////////////////////////////////
231 /** \relates Target Stream output. */
232 inline std::ostream & operator<<( std::ostream & str, const Target & obj )
233 { return obj.dumpOn( str ); }
235 /** \relates Target::DistributionLabel Stream output.
236 * Write out the content as key/value pairs:
238 * summary=Beautiful Name
242 std::ostream & operator<<( std::ostream & str, const Target::DistributionLabel & obj );
244 /////////////////////////////////////////////////////////////////
246 ///////////////////////////////////////////////////////////////////
247 #endif // ZYPP_TARGET_H