/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 4 -*- */
/* SATResolver.h
 *
 * Copyright (C) 2000-2002 Ximian, Inc.
 * Copyright (C) 2005 SUSE Linux Products GmbH
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License,
 * version 2, as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
 * 02111-1307, USA.
 */

#ifndef ZYPP_SOLVER_DETAIL_SAT_RESOLVER_H
#define ZYPP_SOLVER_DETAIL_SAT_RESOLVER_H
#ifndef ZYPP_USE_RESOLVER_INTERNALS
#error Do not directly include this file!
#else
extern "C"
{
#include <solv/solver.h>
#include <solv/pool.h>
}

#include <iosfwd>
#include <list>
#include <map>
#include <string>

#include <zypp/solver/Types.h>

/////////////////////////////////////////////////////////////////////////
namespace zypp
{ ///////////////////////////////////////////////////////////////////////

  namespace sat
  {
    class Transaction;
  }

  ///////////////////////////////////////////////////////////////////////
  namespace solver
  { /////////////////////////////////////////////////////////////////////
    /////////////////////////////////////////////////////////////////////
    namespace detail
    { ///////////////////////////////////////////////////////////////////


///////////////////////////////////////////////////////////////////
//
//	CLASS NAME : SATResolver
/**
 * \todo The way solver options are passed as individual booleans from Resolver
 * via solver::detail::Resolver to SATResolver is pedestrian and error prone.
 * Introdce a dedicated solver option structure which is passed down as a whole.
*/
class SATResolver : public base::ReferenceCounted, private base::NonCopyable, private sat::detail::PoolMember
{

  private:
    ResPool _pool;
    sat::detail::CPool *_satPool;
    sat::detail::CSolver *_satSolver;
    sat::detail::CQueue _jobQueue;

    // list of problematic items (orphaned)
    PoolItemList _problem_items;

    // list populated by calls to addPoolItemTo*()
    PoolItemList _items_to_install;
    PoolItemList _items_to_remove;
    PoolItemList _items_to_lock;
    PoolItemList _items_to_keep;

    // solve results
    PoolItemList _result_items_to_install;
    PoolItemList _result_items_to_remove;

  public:
    ResolverFocus _focus;		// The resolver's general attitude

    bool _fixsystem:1;			// repair errors in rpm dependency graph
    bool _allowdowngrade:1;		// allow one to downgrade installed solvable
    bool _allownamechange:1;		// allow one to change name of installed solvable
    bool _allowarchchange:1;		// allow one to change architecture of installed solvables
    bool _allowvendorchange:1;		// allow one to change vendor of installed solvables
    bool _allowuninstall:1;		// allow removal of installed solvables
    bool _updatesystem:1;		// update
    bool _noUpdateProvide:1;		// true: do not prefer update candidates also providing the old package
    bool _dosplitprovides:1;		// true: consider legacy split provides
    bool _onlyRequires:1;		// true: consider required packages only (but recommended namespaces)
    bool _ignorealreadyrecommended:1;	// true: ignore recommended packages that were already recommended by the installed packages
    bool _distupgrade:1;
    bool _removeOrphaned:1;
    bool _removeUnneeded:1;
    bool _dup_allowdowngrade:1;		// dup mode: allow one to downgrade installed solvable
    bool _dup_allownamechange:1;	// dup mode: allow one to change name of installed solvable
    bool _dup_allowarchchange:1;	// dup mode: allow one to change architecture of installed solvables
    bool _dup_allowvendorchange:1;	// dup mode: allow one to change vendor of installed solvables
    bool _solveSrcPackages:1;		// false: generate no job rule for source packages selected in the pool
    bool _cleandepsOnRemove:1;		// whether removing a package should also remove no longer needed requirements

  private:
    bool _protectPTFs:1;		// protect from accidental removal of PTFs if only @System is present (bsc#1203248)

    // ---------------------------------- methods
    std::string SATprobleminfoString (Id problem, std::string &detail, Id &ignoreId);
    std::string SATproblemRuleInfoString (Id rule, std::string &detail, Id &ignoreId);
    std::vector<std::string> SATgetCompleteProblemInfoStrings ( Id problem );
    void resetItemTransaction (PoolItem item);

    // Create a SAT solver and
    void solverInit(const PoolItemList & weakItems);
    void solverInitSetLocks();
    void solverInitSetSystemRequirements();
    void solverInitSetModeJobsAndFlags();

    void solverAddJobsFromPool();
    void solverAddJobsFromExtraQueues( const CapabilitySet & requires_caps, const CapabilitySet & conflict_caps );

    // common solver run with the _jobQueue; Save results back to pool
    bool solving(const CapabilitySet & requires_caps = CapabilitySet(),
                 const CapabilitySet & conflict_caps = CapabilitySet());
    // cleanup solver
    void solverEnd();

   // Checking if this solvable/item has a buddy which reflect the real
   // user visible description of an item
   // e.g. The release package has a buddy to the concerning product item.
   // This user want's the message "Product foo conflicts with product bar" and
   // NOT "package release-foo conflicts with package release-bar"
   // So these functions return the concerning buddy (e.g. product item)
    sat::Solvable mapSolvable (const Id &id);
    PoolItem mapItem (const PoolItem &item);

  public:

    SATResolver (ResPool  pool, sat::detail::CPool *satPool);
    virtual ~SATResolver();

    // ---------------------------------- I/O

    virtual std::ostream & dumpOn( std::ostream & str ) const;
    friend std::ostream& operator<<(std::ostream& str, const SATResolver & obj)
    { return obj.dumpOn (str); }

    ResPool pool (void) const;
    void setPool (const ResPool & pool) { _pool = pool; }

    // solver run with pool selected items
    bool resolvePool(const CapabilitySet & requires_caps,
                     const CapabilitySet & conflict_caps,
                     const PoolItemList & weakItems,
                     const std::set<Repository> & upgradeRepos
                     );
    // solver run with the given request queue
    bool resolveQueue(const SolverQueueItemList &requestQueue,
                      const PoolItemList & weakItems
                      );
    // searching for new packages
    void doUpdate();

    ResolverProblemList problems ();
    void applySolutions (const ProblemSolutionList &solutions);

    bool fixsystem () const {return _fixsystem;}
    void setFixsystem ( const bool fixsystem) { _fixsystem = fixsystem;}

    bool ignorealreadyrecommended () const {return _ignorealreadyrecommended;}
    void setIgnorealreadyrecommended ( const bool ignorealreadyrecommended) { _ignorealreadyrecommended = ignorealreadyrecommended;}

    bool distupgrade () const {return _distupgrade;}
    void setDistupgrade ( const bool distupgrade) { _distupgrade = distupgrade;}

    bool removeOrphaned () const {return _removeOrphaned;}
    void setRemoveOrphaned ( const bool removeOrphaned) { _removeOrphaned = removeOrphaned;}

    bool allowdowngrade () const {return _allowdowngrade;}
    void setAllowdowngrade ( const bool allowdowngrade) { _allowdowngrade = allowdowngrade;}

    bool allowarchchange () const {return _allowarchchange;}
    void setAllowarchchange ( const bool allowarchchange) { _allowarchchange = allowarchchange;}

    bool allowvendorchange () const {return _allowvendorchange;}
    void setAllowvendorchange ( const bool allowvendorchange) { _allowvendorchange = allowvendorchange;}

    bool allowuninstall () const {return _allowuninstall;}
    void setAllowuninstall ( const bool allowuninstall) { _allowuninstall = allowuninstall;}

    bool updatesystem () const {return _updatesystem;}
    void setUpdatesystem ( const bool updatesystem) { _updatesystem = updatesystem;}

    bool noUpdateProvide () const {return _noUpdateProvide;}
    void setNoUpdateProvide ( const bool noUpdateProvide) { _noUpdateProvide = noUpdateProvide;}

    bool dosplitprovides () const {return _dosplitprovides;}
    void setDosplitprovides ( const bool dosplitprovides) { _dosplitprovides = dosplitprovides;}

    bool onlyRequires () const {return _onlyRequires;}
    void setOnlyRequires ( const bool onlyRequires) { _onlyRequires = onlyRequires;}

    bool solveSrcPackages() const 		{ return _solveSrcPackages; }
    void setSolveSrcPackages( bool state_r )	{ _solveSrcPackages = state_r; }

    bool cleandepsOnRemove() const 		{ return _cleandepsOnRemove; }
    void setCleandepsOnRemove( bool state_r )	{ _cleandepsOnRemove = state_r; }

    PoolItemList problematicUpdateItems( void ) const { return _problem_items; }
    PoolItemList problematicUpdateItems() { return _problem_items; }

    PoolItemList resultItemsToInstall () { return _result_items_to_install; }
    PoolItemList resultItemsToRemove () { return _result_items_to_remove; }

    sat::StringQueue autoInstalled() const;
    sat::StringQueue userInstalled() const;

public:
  /** Expert backdoor. */
  sat::detail::CSolver * get() const { return _satSolver; }
};

///////////////////////////////////////////////////////////////////
    };// namespace detail
    /////////////////////////////////////////////////////////////////////
    /////////////////////////////////////////////////////////////////////
  };// namespace solver
  ///////////////////////////////////////////////////////////////////////
  ///////////////////////////////////////////////////////////////////////
};// namespace zypp
/////////////////////////////////////////////////////////////////////////
#endif // ZYPP_USE_RESOLVER_INTERNALS
#endif // ZYPP_SOLVER_DETAIL_SAT_RESOLVER_H
