1 /*---------------------------------------------------------------------\
3 | |__ / \ / / . \ . \ |
8 \---------------------------------------------------------------------*/
9 /** \file zypp/Product.h
12 #ifndef ZYPP_PRODUCT_H
13 #define ZYPP_PRODUCT_H
18 #include "zypp/ResObject.h"
20 ///////////////////////////////////////////////////////////////////
22 { /////////////////////////////////////////////////////////////////
24 DEFINE_PTR_TYPE(Product);
26 ///////////////////////////////////////////////////////////////////
28 // CLASS NAME : Product
30 /** Product interface.
32 class Product : public ResObject
36 typedef ResTraits<Self> TraitsType;
37 typedef TraitsType::PtrType Ptr;
38 typedef TraitsType::constPtrType constPtr;
41 /** The reference package providing the product metadata,
42 * if such a package exists.
44 sat::Solvable referencePackage() const;
46 /** For installed products the name of the coddesponding
47 * \c /etc/products.d entry.
49 std::string referenceFilename() const;
51 /** List of packages included in older versions of this product and now dropped.
53 * This evaluates the \ref referencePackage \c weakremover namespace. It actually
54 * returns a \ref CapabilitySet, because we support to drop specific versions or
55 * version ranges of a package. Use \ref sat::WhatProvides to get the actually
56 * installed and available packages matching this list.
58 * const Product & openSUSE;
59 * sat::WhatProvides dropped( openSUSE.droplist() );
60 * for_( it, dropped.poolItemBegin(), dropped.poolItemEnd() )
62 * if ( it->status().isInstalled() )
64 * MIL << "Installed but no longer supported package: " << *it << endl;
69 CapabilitySet droplist() const;
73 typedef std::vector<constPtr> ReplacedProducts;
75 /** Array of \b installed Products that would be replaced by
76 * installing this one.
78 ReplacedProducts replacedProducts() const;
80 /** Vendor specific string denoting the product line. */
81 std::string productLine() const;
84 /** Untranslated short name like <tt>SLES 10</tt> (fallback: name) */
85 std::string shortName() const;
87 /** The product flavor (LiveCD Demo, FTP edition,...). */
88 std::string flavor() const;
90 /** Get the product type
91 * Well, in an ideal world there is only one base product.
92 * It's the installed product denoted by a symlink in
95 std::string type() const;
97 /** The product flags */
98 std::list<std::string> flags() const;
100 /** The date when this Product goes out of support as indicated by it's medadata. */
101 Date endOfLife() const;
103 /** ContentIdentifier of required update repositories.
104 * \todo remove and provide iterator.
106 unsigned updateContentIdentifierSize( std::list<Repository::ContentIdentifier> & ret_r ) const;
109 /** This is the \b installed product that is also targeted by the
110 * \c /etc/products.d/baseproduct symlink.
112 bool isTargetDistribution() const;
114 /** This is \c register.target attribute of a product.
115 * Used for registration and filtering service repos.
117 std::string registerTarget() const;
119 /** This is \c register.release attribute of an \b installed product.
120 * Used for registration.
122 std::string registerRelease() const;
128 /** Rerieve urls flagged with \c key_r for this product.
130 * This is the most common interface. There are convenience methods for
131 * wellknown flags like \c "releasenotes", \c "register", \c "updateurls",
132 * \c "extraurls", \c "optionalurls" and \c "smolt" below.
134 UrlList urls( const std::string & key_r ) const;
136 /** The URL to download the release notes for this product. */
137 UrlList releaseNotesUrls() const;
139 /** The URL for registration. */
140 UrlList registerUrls() const;
142 /** The URL for SMOLT \see http://smolts.org/wiki/Main_Page. */
143 UrlList smoltUrls() const;
146 * Online updates for the product.
147 * They are complementary, not alternatives. #163192
149 UrlList updateUrls() const;
152 * Additional software for the product
153 * They are complementary, not alternatives.
155 UrlList extraUrls() const;
158 * Optional software for the product.
159 * (for example. Non OSS repositories)
160 * They are complementary, not alternatives.
162 UrlList optionalUrls() const;
165 friend Ptr make<Self>( const sat::Solvable & solvable_r );
167 Product( const sat::Solvable & solvable_r );
172 /** Helper to iterate a products URL lists.
173 * \ref first is a convenience for 'lists' with just
174 * one entry (e.g. releaseNotesUrls)
176 class Product::UrlList
179 /** \todo Change to directly iterate the .solv */
180 typedef std::list<Url> ListType;
183 typedef ListType::value_type value_type;
184 typedef ListType::size_type size_type;
185 typedef ListType::const_iterator const_iterator;
188 { return _list.empty(); }
190 size_type size() const
191 { return _list.size(); }
193 const_iterator begin() const
194 { return _list.begin(); }
196 const_iterator end() const
197 { return _list.end(); }
199 /** The first Url or an empty Url. */
201 { return empty() ? value_type() : _list.front(); }
204 /** The key used to retrieve this list (for debug) */
205 std::string key() const
209 friend class Product;
210 /** Change to directly iterate the .solv */
215 /** \relates Product::UrlList Stream output. */
216 std::ostream & operator<<( std::ostream & str, const Product::UrlList & obj );
218 /////////////////////////////////////////////////////////////////
220 ///////////////////////////////////////////////////////////////////
221 #endif // ZYPP_PRODUCT_H