1 /*---------------------------------------------------------------------\
3 | |__ / \ / / . \ . \ |
8 \---------------------------------------------------------------------*/
9 /** \file zypp/RepoInfo.cc
14 #include "zypp/base/Logger.h"
15 #include "zypp/base/DefaultIntegral.h"
16 #include "zypp/parser/xml/XmlEscape.h"
18 #include "zypp/RepoInfo.h"
19 #include "zypp/repo/RepoInfoBaseImpl.h"
20 #include "zypp/ExternalProgram.h"
21 #include "zypp/media/MediaAccess.h"
24 using zypp::xml::escape;
26 ///////////////////////////////////////////////////////////////////
28 { /////////////////////////////////////////////////////////////////
30 ///////////////////////////////////////////////////////////////////
32 // CLASS NAME : RepoInfo::Impl
34 /** RepoInfo implementation. */
35 struct RepoInfo::Impl : public repo::RepoInfoBase::Impl
38 : repo::RepoInfoBase::Impl()
39 , gpgcheck(indeterminate)
40 , keeppackages(indeterminate)
41 , type(repo::RepoType::NONE_e)
48 static const unsigned defaultPriority = 99;
50 void setProbedType( const repo::RepoType & t ) const
52 if ( type == repo::RepoType::NONE
53 && t != repo::RepoType::NONE )
56 const_cast<Impl*>(this)->type = t;
61 Pathname licenseTgz() const
62 { return metadatapath.empty() ? Pathname() : metadatapath / path / "license.tar.gz"; }
71 std::set<Url> baseUrls;
74 std::string targetDistro;
75 Pathname metadatapath;
76 Pathname packagespath;
77 DefaultIntegral<unsigned,defaultPriority> priority;
81 friend Impl * rwcowClone<Impl>( const Impl * rhs );
82 /** clone for RWCOW_pointer */
84 { return new Impl( *this ); }
86 ///////////////////////////////////////////////////////////////////
88 /** \relates RepoInfo::Impl Stream output */
89 inline std::ostream & operator<<( std::ostream & str, const RepoInfo::Impl & obj )
91 return str << "RepoInfo::Impl";
94 ///////////////////////////////////////////////////////////////////
96 // CLASS NAME : RepoInfo
98 ///////////////////////////////////////////////////////////////////
100 const RepoInfo RepoInfo::noRepo;
102 ///////////////////////////////////////////////////////////////////
104 // METHOD NAME : RepoInfo::RepoInfo
105 // METHOD TYPE : Ctor
108 : _pimpl( new Impl() )
111 ///////////////////////////////////////////////////////////////////
113 // METHOD NAME : RepoInfo::~RepoInfo
114 // METHOD TYPE : Dtor
116 RepoInfo::~RepoInfo()
121 unsigned RepoInfo::priority() const
122 { return _pimpl->priority; }
123 unsigned RepoInfo::defaultPriority()
124 { return Impl::defaultPriority; }
125 void RepoInfo::setPriority( unsigned newval_r )
127 _pimpl->priority = newval_r ? newval_r : Impl::defaultPriority;
130 void RepoInfo::setGpgCheck( bool check )
132 _pimpl->gpgcheck = check;
135 void RepoInfo::setMirrorListUrl( const Url &url )
137 _pimpl->mirrorlist_url = url;
140 void RepoInfo::setGpgKeyUrl( const Url &url )
142 _pimpl->gpgkey_url = url;
145 void RepoInfo::addBaseUrl( const Url &url )
147 _pimpl->baseUrls.insert(url);
150 void RepoInfo::setBaseUrl( const Url &url )
152 _pimpl->baseUrls.clear();
156 void RepoInfo::setPath( const Pathname &path )
161 void RepoInfo::setType( const repo::RepoType &t )
166 void RepoInfo::setProbedType( const repo::RepoType &t ) const
167 { _pimpl->setProbedType( t ); }
170 void RepoInfo::setMetadataPath( const Pathname &path )
172 _pimpl->metadatapath = path;
175 void RepoInfo::setPackagesPath( const Pathname &path )
177 _pimpl->packagespath = path;
180 void RepoInfo::setKeepPackages( bool keep )
182 _pimpl->keeppackages = keep;
185 void RepoInfo::setService( const std::string& name )
187 _pimpl->service = name;
190 void RepoInfo::setTargetDistribution(
191 const std::string & targetDistribution)
193 _pimpl->targetDistro = targetDistribution;
196 bool RepoInfo::gpgCheck() const
197 { return indeterminate(_pimpl->gpgcheck) ? true : (bool) _pimpl->gpgcheck; }
199 Pathname RepoInfo::metadataPath() const
200 { return _pimpl->metadatapath; }
202 Pathname RepoInfo::packagesPath() const
203 { return _pimpl->packagespath; }
205 repo::RepoType RepoInfo::type() const
206 { return _pimpl->type; }
208 Url RepoInfo::mirrorListUrl() const
209 { return _pimpl->mirrorlist_url; }
211 Url RepoInfo::gpgKeyUrl() const
212 { return _pimpl->gpgkey_url; }
214 std::set<Url> RepoInfo::baseUrls() const
216 RepoInfo::url_set replaced_urls;
217 repo::RepoVariablesUrlReplacer replacer;
218 for ( url_set::const_iterator it = _pimpl->baseUrls.begin();
219 it != _pimpl->baseUrls.end();
222 replaced_urls.insert(replacer(*it));
224 return replaced_urls;
227 Pathname RepoInfo::path() const
228 { return _pimpl->path; }
230 std::string RepoInfo::service() const
231 { return _pimpl->service; }
233 std::string RepoInfo::targetDistribution() const
234 { return _pimpl->targetDistro; }
236 RepoInfo::urls_const_iterator RepoInfo::baseUrlsBegin() const
238 return make_transform_iterator( _pimpl->baseUrls.begin(),
239 repo::RepoVariablesUrlReplacer() );
240 //return _pimpl->baseUrls.begin();
243 RepoInfo::urls_const_iterator RepoInfo::baseUrlsEnd() const
245 //return _pimpl->baseUrls.end();
246 return make_transform_iterator( _pimpl->baseUrls.end(),
247 repo::RepoVariablesUrlReplacer() );
250 RepoInfo::urls_size_type RepoInfo::baseUrlsSize() const
251 { return _pimpl->baseUrls.size(); }
253 bool RepoInfo::baseUrlsEmpty() const
254 { return _pimpl->baseUrls.empty(); }
256 // false by default (if not set by setKeepPackages)
257 bool RepoInfo::keepPackages() const
259 if (indeterminate(_pimpl->keeppackages))
261 if (_pimpl->baseUrls.empty())
263 else if ( baseUrlsBegin()->schemeIsDownloading() )
269 return (bool) _pimpl->keeppackages;
272 ///////////////////////////////////////////////////////////////////
274 bool RepoInfo::hasLicense() const
276 Pathname licenseTgz( _pimpl->licenseTgz() );
277 SEC << licenseTgz << endl;
278 SEC << PathInfo(licenseTgz) << endl;
280 return ! licenseTgz.empty() && PathInfo(licenseTgz).isFile();
283 std::string RepoInfo::getLicense( const Locale & lang_r )
285 LocaleSet avlocales( getLicenseLocales() );
286 if ( avlocales.empty() )
287 return std::string();
289 Locale getLang( Locale::bestMatch( avlocales, lang_r ) );
290 if ( getLang == Locale::noCode
291 && avlocales.find( Locale::noCode ) == avlocales.end() )
293 WAR << "License.tar.gz contains no fallback text! " << *this << endl;
294 // Using the fist locale instead of returning no text at all.
295 // So the user might recognize that there is a license, even if he
297 getLang = *avlocales.begin();
300 // now extract the license file.
301 static const std::string licenseFileFallback( "license.txt" );
302 std::string licenseFile( getLang == Locale::noCode
303 ? licenseFileFallback
304 : str::form( "license.%s.txt", getLang.code().c_str() ) );
306 ExternalProgram::Arguments cmd;
307 cmd.push_back( "tar" );
308 cmd.push_back( "-x" );
309 cmd.push_back( "-z" );
310 cmd.push_back( "-O" );
311 cmd.push_back( "-f" );
312 cmd.push_back( _pimpl->licenseTgz().asString() ); // if it not exists, avlocales was empty.
313 cmd.push_back( licenseFile );
316 ExternalProgram prog( cmd, ExternalProgram::Discard_Stderr );
317 for ( std::string output( prog.receiveLine() ); output.length(); output = prog.receiveLine() )
325 LocaleSet RepoInfo::getLicenseLocales() const
327 Pathname licenseTgz( _pimpl->licenseTgz() );
328 if ( licenseTgz.empty() || ! PathInfo( licenseTgz ).isFile() )
331 ExternalProgram::Arguments cmd;
332 cmd.push_back( "tar" );
333 cmd.push_back( "-t" );
334 cmd.push_back( "-z" );
335 cmd.push_back( "-f" );
336 cmd.push_back( licenseTgz.asString() );
339 ExternalProgram prog( cmd, ExternalProgram::Stderr_To_Stdout );
340 for ( std::string output( prog.receiveLine() ); output.length(); output = prog.receiveLine() )
342 static const C_Str license( "license." );
343 static const C_Str dotTxt( ".txt\n" );
344 if ( str::hasPrefix( output, license ) && str::hasSuffix( output, dotTxt ) )
346 if ( output.size() <= license.size() + dotTxt.size() ) // license.txt
347 ret.insert( Locale() );
349 ret.insert( Locale( std::string( output.c_str()+license.size(), output.size()- license.size() - dotTxt.size() ) ) );
353 WAR << " " << output;
360 ///////////////////////////////////////////////////////////////////
362 std::ostream & RepoInfo::dumpOn( std::ostream & str ) const
364 RepoInfoBase::dumpOn(str);
365 for ( urls_const_iterator it = baseUrlsBegin();
369 str << "- url : " << *it << std::endl;
371 str << "- path : " << path() << std::endl;
372 str << "- type : " << type() << std::endl;
373 str << "- priority : " << priority() << std::endl;
375 str << "- gpgcheck : " << gpgCheck() << std::endl;
376 str << "- gpgkey : " << gpgKeyUrl() << std::endl;
377 str << "- keeppackages: " << keepPackages() << std::endl;
378 str << "- service : " << service() << std::endl;
380 if (!targetDistribution().empty())
381 str << "- targetdistro: " << targetDistribution() << std::endl;
383 if (!metadataPath().empty())
384 str << "- metadataPath: " << metadataPath() << std::endl;
386 if (!packagesPath().empty())
387 str << "- packagesPath: " << packagesPath() << std::endl;
392 std::ostream & RepoInfo::dumpAsIniOn( std::ostream & str ) const
394 RepoInfoBase::dumpAsIniOn(str);
396 if ( ! _pimpl->baseUrls.empty() )
398 for ( url_set::const_iterator it = _pimpl->baseUrls.begin();
399 it != _pimpl->baseUrls.end();
405 if ( ! _pimpl->path.empty() )
406 str << "path="<< path() << endl;
408 if ( ! (_pimpl->mirrorlist_url.asString().empty()) )
409 str << "mirrorlist=" << _pimpl->mirrorlist_url << endl;
411 str << "type=" << type().asString() << endl;
413 if ( priority() != defaultPriority() )
414 str << "priority=" << priority() << endl;
416 if (!indeterminate(_pimpl->gpgcheck))
417 str << "gpgcheck=" << (gpgCheck() ? "1" : "0") << endl;
418 if ( ! (gpgKeyUrl().asString().empty()) )
419 str << "gpgkey=" <<gpgKeyUrl() << endl;
421 if (!indeterminate(_pimpl->keeppackages))
422 str << "keeppackages=" << keepPackages() << endl;
424 if( ! service().empty() )
425 str << "service=" << service() << endl;
430 std::ostream & RepoInfo::dumpAsXMLOn( std::ostream & str) const
431 { return dumpAsXMLOn(str, ""); }
433 std::ostream & RepoInfo::dumpAsXMLOn( std::ostream & str, const std::string & content) const
438 << " alias=\"" << escape(alias()) << "\""
439 << " name=\"" << escape(name()) << "\"";
440 if (type() != repo::RepoType::NONE)
441 str << " type=\"" << type().asString() << "\"";
443 << " enabled=\"" << enabled() << "\""
444 << " autorefresh=\"" << autorefresh() << "\""
445 << " gpgcheck=\"" << gpgCheck() << "\"";
446 if (!(tmpstr = gpgKeyUrl().asString()).empty())
447 str << " gpgkey=\"" << escape(tmpstr) << "\"";
448 if (!(tmpstr = mirrorListUrl().asString()).empty())
449 str << " mirrorlist=\"" << escape(tmpstr) << "\"";
452 for (RepoInfo::urls_const_iterator urlit = baseUrlsBegin();
453 urlit != baseUrlsEnd(); ++urlit)
454 str << "<url>" << escape(urlit->asString()) << "</url>" << endl;
456 str << "</repo>" << endl;
461 std::ostream & operator<<( std::ostream & str, const RepoInfo & obj )
463 return obj.dumpOn(str);
467 /////////////////////////////////////////////////////////////////
469 ///////////////////////////////////////////////////////////////////