NCPackageSelector.h

/****************************************************************************
|
| Copyright (c) [2002-2011] Novell, Inc.
| All Rights Reserved.
|
| This program is free software; you can redistribute it and/or
| modify it under the terms of version 2 of the GNU General Public License 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, contact Novell, Inc.
|
| To contact Novell about this file by physical or electronic mail,
| you may find current contact information at www.novell.com
|
|***************************************************************************/


/*---------------------------------------------------------------------\
|                                                                      |
|                      __   __    ____ _____ ____                      |
|                      \ \ / /_ _/ ___|_   _|___ \                     |
|                       \ V / _` \___ \ | |   __) |                    |
|                        | | (_| |___) || |  / __/                     |
|                        |_|\__,_|____/ |_| |_____|                    |
|                                                                      |
|                               core system                            |
|                                                        (C) SuSE GmbH |
\----------------------------------------------------------------------/

   File:       NCPackageSelector.h

   Author:     Gabriele Strattner <gs@suse.de>

/-*/
#ifndef NCPackageSelector_h
#define NCPackageSelector_h

#include <iosfwd>
#include <map>
#include <string>
#include <utility>      // for STL std::pair

#include <zypp/ResObject.h>
#include <zypp/Patch.h>
#include <zypp/ui/Selectable.h>

#define YUILogComponent "ncurses-pkg"
#include <yui/YUILog.h>

#include <yui/YWidgetID.h>
#include <yui/ncurses/NCEmpty.h>
#include <yui/ncurses/YNCursesUI.h>

#include "NCPkgFilterInstSummary.h"
#include "NCPkgFilterMain.h"
#include "NCPkgFilterSearch.h"
#include "NCPkgMenuFilter.h"
#include "NCPkgPackageDetails.h"
#include "NCPkgPopupDeps.h"
#include "NCPkgSearchSettings.h"
#include "NCPkgSelMapper.h"
#include "NCPkgStrings.h"
#include "NCPkgTable.h"

class LangCode;
class NCMenuButton;
class NCPkgDiskspace;
class NCPkgFilterClassification;
class NCPkgFilterInstSummary;
class NCPkgFilterMain;
class NCPkgFilterPattern;
class NCPkgFilterSearch;
class NCPkgLocaleTable;
class NCPkgMenuAction;
class NCPkgMenuConfig;
class NCPkgMenuDeps;
class NCPkgMenuExtras;
class NCPkgMenuHelp;
class NCPkgMenuView;
class NCPkgPackageDetails;
class NCPkgPopupDeps;
class NCPkgPopupFile;
class NCPkgRepoTable;
class NCPkgSearchSettings;
class NCPkgServiceTable;
class NCPushButton;
class YNCursesUI;
class YReplacePoint;

inline bool ic_compare ( char c1, char c2 )
{
    return ( toupper( c1 ) == toupper( c2 ) );
}

#define DOCTYPETAG "<!-- DT:Rich -->"   // Special doctype for preformatted HTML

//
//  CLASS NAME : NCPackageSelector
//
//  DESCRIPTION : Specialized high-level widget for package selection
//
class NCPackageSelector
{

    friend std::ostream & operator<<( std::ostream & STREAM, const NCPackageSelector & OBJ );

    NCPackageSelector & operator=( const NCPackageSelector & );
    NCPackageSelector            ( const NCPackageSelector & );

private:

    // typedef for the pointer to handler member function
    typedef bool (NCPackageSelector::* tHandlerFctPtr) ( const NCursesEvent& event );

    // typedef for the internal map: key=nameId, value=handler-fct-ptr
    typedef std::map<std::string, tHandlerFctPtr> tHandlerMap;

    tHandlerMap eventHandlerMap;        // event handler map

    NCPkgPopupDeps * depsPopup;     // the package dependeny popup

    NCPkgFilterPattern * patternPopup;  // the pattern popup
    NCPkgLocaleTable * languagePopup;   // language popup
    NCPkgRepoTable * repoPopup;
    NCPkgServiceTable * servicePopup;

    NCPkgDiskspace * diskspacePopup;    // the popup showing the disk usage

    NCPkgFilterSearch * searchPopup;    // the package search popup
    NCPkgFilterInstSummary *inst_summary;

    NCPkgFilterClassification * pkgClass;   // classification of packages

    bool youMode;           // YOU
    bool updateMode;            // Update
    bool testMode;          // testing
    bool repoMgrEnabled;        // Manage repositories (add menu button "Configuration")
    bool repoMode;          // Start with "Repositories" filter view
    bool summaryMode;           // Start with "Summary" filter view
    bool onlineSearchEnabled;       // Add a "Search Online" option in the "Extras" menu

    std::map <std::string, std::string> sysconfig;      // sysconfig values

    bool autoCheck;                     // dependency check on every 'click'
    bool verifySystem;                  // system verification mode
    bool installRecommended;            // option install recommended packages

    std::string actionAtExit;

    // the package table
    NCPkgTable * pkgList;

    NCPkgMenuDeps *depsMenu;
    NCPkgMenuView *viewMenu;
    NCPkgMenuConfig *configMenu;
    NCPkgMenuExtras *extrasMenu;
    NCPkgMenuHelp *helpMenu;
    NCPkgFilterMain *filterMain;
    NCPkgMenuAction *actionMenu;
    NCPkgMenuFilter *filterMenu;
    // FIXME - add update list to NCPkgFilterMain
    YMenuItem * updatelistItem;

    // labels
    YLabel * packageLabel;
    YLabel * diskspaceLabel;
    YLabel *patternLabel;

    // information about packages
    NCPkgPackageDetails * infoText; // short/longdecsription, filelist
    NCRichText * filter_desc;
    NCInputField *searchField;
    NCPkgSearchSettings *searchSet;
    YReplacePoint * replacePoint;       // replace point for info text
    YReplacePoint * replPoint;
    YReplacePoint * replPoint2;

    NCPkgTable * versionsList;          // list of available package versions
    // information about patches
    NCPkgTable * patchPkgs;             // pakages belonging to a patch
    NCPkgTable * patchPkgsVersions; // versions of packages above

    NCPushButton * okButton;
    NCPushButton * cancelButton;

    YMenuItem * visibleInfo;        // current visible package info (description, file list, ...)

    // Mapping from ZyppPkg to the corresponding ZyppSel.
    NCPkgSelMapper selMapper;

    std::set<std::string> verified_pkgs;


public:

    enum FilterMode
    {
        Patterns,
        Languages,
        Repositories,
        Services,
        Search,
        Summary,
        PkgClassification
    };

    NCPackageSelector( long modeFlags );

    virtual ~NCPackageSelector();

    void setFlags( long modeFlags);

    void readSysconfig();
    void writeSysconfig();

    void createPkgLayout( YWidget * parent, NCPkgTable::NCPkgTableType type );

    void createYouLayout( YWidget * parent );

    bool anyRetractedPkgInstalled();

    // returns the package table widget
    NCPkgTable * PackageList();
    NCPkgPopupDeps *DepsPopup() { return depsPopup; }
    NCPkgDiskspace *diskSpacePopup() { return diskspacePopup; }
    YLabel *PackageLabel() { return packageLabel; }
    YLabel *PatternLabel() { return patternLabel; }

    NCPkgPackageDetails *InfoText() { return infoText; }
    void setInfoText ( NCPkgPackageDetails *itext ) { infoText = itext;}

    NCPkgTable *VersionsList() { return versionsList; }
    void setVersionsList ( NCPkgTable *table ) { versionsList = table; }

    NCPkgTable * PatchPkgs() { return patchPkgs; }
    NCPkgTable * PatchPkgsVersions() { return patchPkgsVersions; }

    YReplacePoint *ReplacePoint() { return replacePoint; }
    NCRichText *FilterDescription() { return filter_desc; }
    NCPkgSearchSettings *SearchSettings() { return searchSet; }

    bool checkNow( bool *ok );
    bool systemVerification( bool *ok );
    bool doInstallRecommended( bool *ok );


    bool fillPatchList( NCPkgMenuFilter::PatchFilter filter );

    bool fillUpdateList();


    bool fillPatchPackages ( NCPkgTable * pkgTable, ZyppObj youPatch );

    bool fillPatchSearchList( const std::string & expr, bool checkName, bool checkSum );

    bool fillDefaultList();

    bool isYouMode() { return youMode; }

    bool isUpdateMode() { return updateMode; }

    bool isRepoMgrEnabled() { return repoMgrEnabled; }

    bool isTestMode() { return testMode; }

    bool isOnlineSearchEnabled() { return onlineSearchEnabled; }

    //
    // Action at exit (means "summary", "restart" or "close") is written to
    // /etc/sysconfig/yast2 and gets evaluated by the YaST packager workflow.
    //
    std::string ActionAtExit() { return actionAtExit; }
    void setActionAtExit( std::string action ) { actionAtExit = action; }

    //
    // The solver options 'cleanup dependencies on remove' and
    // 'is allow vendor change' can only be set in /etc/zypp/zypp.conf.
    //
    bool isCleanDepsOnRemove();
    void setCleanDepsOnRemove( bool on );

    bool isAllowVendorChange();
    void setAllowVendorChange( bool on );

    //
    // The solver options 'Install recommended packages' and
    // 'verify system' can be changed in UI and are written to /etc/sysconfig/yast2.
    //
    bool isInstallRecommended();
    void setInstallRecommended( bool on );
    bool InstallRecommended() { return installRecommended; }

    bool isVerifySystem();
    void setVerifySystem( bool on );
    bool VerifySystem() { return verifySystem; }
    //
    // The 'automatic dependency check' setting is also saved in /etc/sysconfig/yast2
    //
    bool isAutoCheck();
    void setAutoCheck( bool check) { autoCheck = check; }
    bool AutoCheck() { return autoCheck; }

    bool handleEvent( const NCursesEvent& event );

    void showPatchPkgVersions();

    void showPatchPackages();

    void showVersionsList();

    void showInformation();

    void clearInfoArea();

    wrect deleteReplacePoint();

    void replaceFilter ( FilterMode mode);
    void replaceFilterDescr ( bool b );
    bool OkButtonHandler ( const NCursesEvent& event );

    bool CancelHandler ( const NCursesEvent& event );

    bool LinkHandler ( std::string link );

    bool showPackageDependencies ( bool doit );

    void showSelectionDependencies();

    void updatePackageList();

    bool checkPatch( ZyppPatch patch,
             ZyppSel selectable,
             NCPkgMenuFilter::PatchFilter filter );

    bool showLicensePopup( std::string pkgName, std::string license );

    void showDiskSpace();

    void showDownloadSize();

    void saveState();
    void restoreState();
    bool diffState();

    bool showPendingLicenseAgreements();
    bool showPendingLicenseAgreements( ZyppPoolIterator begin, ZyppPoolIterator end );

    bool showLicenseAgreement( ZyppSel & slbPtr , std::string licenseText );

    std::set <std::string> getVerifiedPkgs()
    {
        return verified_pkgs;
    }

    void insertVerifiedPkg( std::string pkgname )
    {
    verified_pkgs.insert( pkgname);
    }

    void clearVerifiedPkgs()
    {
    if ( !verified_pkgs.empty() )
    {
        yuiMilestone() << "Discarding auto-dependency changes" << std::endl;
        verified_pkgs.clear();
    }
    }

};


#endif // NCPackageSelector_h