apt-pkg/indexfile.h

   1 // -*- mode: cpp; mode: fold -*-
   2 // Description                                                          /*{{{*/
   3 /* ######################################################################
   4
   5    Index File - Abstraction for an index of archive/source file.
   6
   7    There are 4 primary sorts of index files, all represented by this
   8    class:
   9
  10    Binary index files
  11    Binary translation files
  12    Binary index files describing the local system
  13    Source index files
  14
  15    They are all bundled together here, and the interfaces for
  16    sources.list, acquire, cache gen and record parsing all use this class
  17    to access the underlying representation.
  18
  19    ##################################################################### */
  20                                                                         /*}}}*/
  21 #ifndef PKGLIB_INDEXFILE_H
  22 #define PKGLIB_INDEXFILE_H
  23
  24 #include <apt-pkg/srcrecords.h>
  25 #include <apt-pkg/pkgrecords.h>
  26 #include <apt-pkg/pkgcache.h>
  27 #include <apt-pkg/cacheiterators.h>
  28 #include <apt-pkg/macros.h>
  29
  30 #include <map>
  31 #include <string>
  32
  33 #ifndef APT_8_CLEANER_HEADERS
  34 using std::string;
  35 #endif
  36 #ifndef APT_10_CLEANER_HEADERS
  37 class pkgAcquire;
  38 #endif
  39
  40 class pkgCacheGenerator;
  41 class pkgCacheListParser;
  42 class OpProgress;
  43
  44 class IndexTarget                                                       /*{{{*/
  45 /** \brief Information about an index file. */
  46 {
  47    public:
  48    /** \brief A URI from which the index file can be downloaded. */
  49    std::string URI;
  50
  51    /** \brief A description of the index file. */
  52    std::string Description;
  53
  54    /** \brief A shorter description of the index file. */
  55    std::string ShortDesc;
  56
  57    /** \brief The key by which this index file should be
  58        looked up within the meta index file. */
  59    std::string MetaKey;
  60
  61    /** \brief Is it okay if the file isn't found in the meta index */
  62    bool IsOptional;
  63
  64    /** \brief If the file is downloaded compressed, do not unpack it */
  65    bool KeepCompressed;
  66
  67    /** \brief options with which this target was created
  68        Prefer the usage of #Option if at all possible.
  69        Beware: Not all of these options are intended for public use */
  70    std::map<std::string, std::string> Options;
  71
  72    IndexTarget(std::string const &MetaKey, std::string const &ShortDesc,
  73          std::string const &LongDesc, std::string const &URI, bool const IsOptional,
  74          bool const KeepCompressed, std::map<std::string, std::string> const &Options);
  75
  76    enum OptionKeys {
  77       SITE,
  78       RELEASE,
  79       COMPONENT,
  80       LANGUAGE,
  81       ARCHITECTURE,
  82       BASE_URI,
  83       REPO_URI,
  84       CREATED_BY,
  85       TARGET_OF,
  86       FILENAME,
  87       EXISTING_FILENAME,
  88       PDIFFS,
  89       COMPRESSIONTYPES,
  90       DEFAULTENABLED,
  91       SOURCESENTRY,
  92       BY_HASH,
  93       KEEPCOMPRESSEDAS,
  94    };
  95    std::string Option(OptionKeys const Key) const;
  96    bool OptionBool(OptionKeys const Key) const;
  97    std::string Format(std::string format) const;
  98 };
  99                                                                         /*}}}*/
 100
 101 class pkgIndexFile
 102 {
 103    void * const d;
 104    protected:
 105    bool Trusted;
 106
 107    public:
 108
 109    class Type
 110    {
 111       public:
 112
 113       // Global list of Items supported
 114       static Type **GlobalList;
 115       static unsigned long GlobalListLen;
 116       static Type *GetType(const char * const Type) APT_PURE;
 117
 118       const char *Label;
 119
 120       virtual pkgRecords::Parser *CreatePkgParser(pkgCache::PkgFileIterator const &/*File*/) const {return 0;};
 121       virtual pkgSrcRecords::Parser *CreateSrcPkgParser(std::string const &/*File*/) const {return 0;};
 122       Type();
 123       virtual ~Type() {};
 124    };
 125
 126    virtual const Type *GetType() const = 0;
 127
 128    // Return descriptive strings of various sorts
 129    virtual std::string ArchiveInfo(pkgCache::VerIterator const &Ver) const;
 130    virtual std::string SourceInfo(pkgSrcRecords::Parser const &Record,
 131                              pkgSrcRecords::File const &File) const;
 132    virtual std::string Describe(bool const Short = false) const = 0;
 133
 134    // Interface for acquire
 135    virtual std::string ArchiveURI(std::string const &/*File*/) const {return std::string();};
 136
 137    // Interface for the record parsers
 138    virtual pkgSrcRecords::Parser *CreateSrcParser() const {return 0;};
 139
 140    // Interface for the Cache Generator
 141    virtual bool Exists() const = 0;
 142    virtual bool HasPackages() const = 0;
 143    virtual unsigned long Size() const = 0;
 144    virtual bool Merge(pkgCacheGenerator &/*Gen*/, OpProgress* const /*Prog*/) { return true; };
 145    virtual pkgCache::PkgFileIterator FindInCache(pkgCache &Cache) const;
 146
 147    APT_DEPRECATED_MSG("These methods make no sense anymore with multi-language support") static bool TranslationsAvailable();
 148    /* No intern need for this method anymore as the check for correctness
 149       is already done in getLanguages(). Note also that this check is
 150       rather bad (doesn't take three character like ast into account).*/
 151    APT_DEPRECATED_MSG("These methods make no sense anymore with multi-language support") static bool CheckLanguageCode(const char * const Lang);
 152    /* As we have now possibly more than one LanguageCode this method is
 153       superseeded by a) private classmembers or b) getLanguages() */
 154    APT_DEPRECATED_MSG("These methods make no sense anymore with multi-language support") static std::string LanguageCode();
 155
 156    bool IsTrusted() const { return Trusted; };
 157
 158    explicit pkgIndexFile(bool const Trusted);
 159    virtual ~pkgIndexFile();
 160 };
 161
 162 class pkgDebianIndexFile : public pkgIndexFile
 163 {
 164 protected:
 165    virtual std::string IndexFileName() const = 0;
 166    virtual std::string GetComponent() const = 0;
 167    virtual std::string GetArchitecture() const = 0;
 168    virtual std::string GetProgressDescription() const = 0;
 169    virtual uint8_t GetIndexFlags() const = 0;
 170    virtual bool OpenListFile(FileFd &Pkg, std::string const &FileName) = 0;
 171    APT_HIDDEN virtual pkgCacheListParser * CreateListParser(FileFd &Pkg);
 172
 173 public:
 174    virtual bool Merge(pkgCacheGenerator &Gen, OpProgress* const Prog) APT_OVERRIDE;
 175    virtual pkgCache::PkgFileIterator FindInCache(pkgCache &Cache) const APT_OVERRIDE;
 176
 177    explicit pkgDebianIndexFile(bool const Trusted);
 178    virtual ~pkgDebianIndexFile();
 179 };
 180
 181 class pkgDebianIndexTargetFile : public pkgDebianIndexFile
 182 {
 183    void * const d;
 184 protected:
 185    IndexTarget const Target;
 186
 187    virtual std::string IndexFileName() const APT_OVERRIDE;
 188    virtual std::string GetComponent() const APT_OVERRIDE;
 189    virtual std::string GetArchitecture() const APT_OVERRIDE;
 190    virtual std::string GetProgressDescription() const APT_OVERRIDE;
 191    virtual bool OpenListFile(FileFd &Pkg, std::string const &FileName) APT_OVERRIDE;
 192
 193 public:
 194    virtual std::string ArchiveURI(std::string const &File) const APT_OVERRIDE;
 195    virtual std::string Describe(bool const Short = false) const APT_OVERRIDE;
 196    virtual bool Exists() const APT_OVERRIDE;
 197    virtual unsigned long Size() const APT_OVERRIDE;
 198
 199    pkgDebianIndexTargetFile(IndexTarget const &Target, bool const Trusted);
 200    virtual ~pkgDebianIndexTargetFile();
 201 };
 202
 203 class pkgDebianIndexRealFile : public pkgDebianIndexFile
 204 {
 205    void * const d;
 206 protected:
 207    std::string File;
 208
 209    virtual std::string IndexFileName() const APT_OVERRIDE;
 210    virtual std::string GetProgressDescription() const APT_OVERRIDE;
 211    virtual bool OpenListFile(FileFd &Pkg, std::string const &FileName) APT_OVERRIDE;
 212 public:
 213    virtual std::string Describe(bool const /*Short*/ = false) const APT_OVERRIDE;
 214    virtual bool Exists() const APT_OVERRIDE;
 215    virtual unsigned long Size() const APT_OVERRIDE;
 216    virtual std::string ArchiveURI(std::string const &/*File*/) const APT_OVERRIDE;
 217
 218    pkgDebianIndexRealFile(std::string const &File, bool const Trusted);
 219    virtual ~pkgDebianIndexRealFile();
 220 };
 221
 222 #endif