cache.hpp

Go to the documentation of this file.

/**************************************************************************
*   Copyright (C) 2010 by Eugene V. Lyubimkin                             *
*                                                                         *
*   This program is free software; you can redistribute it and/or modify  *
*   it under the terms of the GNU General Public License                  *
*   (version 3 or above) 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 GPL                        *
*   along with this program; if not, write to the                         *
*   Free Software Foundation, Inc.,                                       *
*   51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA               *
**************************************************************************/
#ifndef CUPT_CACHE_CACHE_SEEN
#define CUPT_CACHE_CACHE_SEEN


#include <boost/xpressive/xpressive_fwd.hpp>

#include <set>

#include <cupt/common.hpp>
#include <cupt/fwd.hpp>
#include <cupt/hashsums.hpp>

namespace cupt {

namespace internal {

struct CacheImpl;

}

using std::set;

using namespace cache;

class CUPT_API Cache
{
 public:

    struct IndexEntry
    {
        enum Type { Source, Binary } category;
        string uri; 
        string distribution; 
        string component; 
    };
    struct IndexDownloadRecord
    {
        string uri;
        uint32_t size;
        HashSums hashSums;
    };
    struct LocalizationDownloadRecord
    {
        string uri;
        string localPath;
    };
    struct ExtendedInfo
    {
        set< string > automaticallyInstalled; 
    };

 private:
    internal::CacheImpl* __impl;
    Cache(const Cache&);
    Cache& operator=(const Cache&);
 public:

    Cache(shared_ptr< const Config > config, bool useSource, bool useBinary, bool useInstalled,
            const vector< string >& packageNameGlobsToReinstall = vector< string >());
    virtual ~Cache();

    vector< shared_ptr< const ReleaseInfo > > getBinaryReleaseData() const;
    vector< shared_ptr< const ReleaseInfo > > getSourceReleaseData() const;

    vector< string > getBinaryPackageNames() const;

    shared_ptr< const BinaryPackage > getBinaryPackage(const string& packageName) const;
    vector< string > getSourcePackageNames() const;

    shared_ptr< const SourcePackage > getSourcePackage(const string& packageName) const;

    vector< shared_ptr< const BinaryVersion > > getInstalledVersions() const;


    bool isAutomaticallyInstalled(const string& packageName) const;

    vector< IndexEntry > getIndexEntries() const;

    string getPathOfReleaseList(const IndexEntry& entry) const;
    string getPathOfIndexList(const IndexEntry& entry) const;
    string getPathOfExtendedStates() const;

    string getDownloadUriOfReleaseList(const IndexEntry&) const;
    vector< IndexDownloadRecord > getDownloadInfoOfIndexList(const IndexEntry&) const;
    vector< LocalizationDownloadRecord > getDownloadInfoOfLocalizedDescriptions(const IndexEntry&) const;

    shared_ptr< const system::State > getSystemState() const;

    ssize_t getPin(const shared_ptr< const Version >&) const;

    struct PinnedVersion
    {
        shared_ptr< const Version > version; 
        ssize_t pin; 

        PinnedVersion(shared_ptr< const Version > _version, ssize_t _pin)
            : version(_version), pin(_pin) {}
    };
    vector< PinnedVersion > getSortedPinnedVersions(const shared_ptr< const Package >&) const;
    shared_ptr< const Version > getPolicyVersion(const shared_ptr< const Package >&) const;

    vector< shared_ptr< const BinaryVersion > > getSatisfyingVersions(const RelationExpression&) const;

    const ExtendedInfo& getExtendedInfo() const;


    pair< string, string > getLocalizedDescriptions(const shared_ptr< const BinaryVersion >&) const;

    static bool verifySignature(const shared_ptr< const Config >&, const string& path);

    static string getPathOfCopyright(const shared_ptr< const BinaryVersion >&);

    static string getPathOfChangelog(const shared_ptr< const BinaryVersion >&);


    static bool memoize;
};

}

#endif