aboutsummaryrefslogtreecommitdiff
path: root/paludis/repositories/e/glsa.hh
blob: 726b8c4af73835b63a67bf73e5ac3fd777bce449 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
/* vim: set sw=4 sts=4 et foldmethod=syntax : */

/*
 * Copyright (c) 2006, 2007, 2008, 2010, 2011 Ciaran McCreesh
 *
 * This file is part of the Paludis package manager. Paludis 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.
 *
 * Paludis 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 PALUDIS_GUARD_PALUDIS_REPOSITORIES_E_GLSA_HH
#define PALUDIS_GUARD_PALUDIS_REPOSITORIES_E_GLSA_HH 1

#include <paludis/util/pimp.hh>
#include <paludis/util/wrapped_forward_iterator-fwd.hh>
#include <paludis/util/named_value.hh>
#include <paludis/name.hh>
#include <paludis/version_spec.hh>
#include <memory>
#include <string>

namespace paludis
{
    namespace n
    {
        typedef Name<struct name_op> op;
        typedef Name<struct name_slot> slot;
        typedef Name<struct name_version> version;
    }

    namespace erepository
    {
        struct GLSARange
        {
            NamedValue<n::op, std::string> op;
            NamedValue<n::slot, std::string> slot;
            NamedValue<n::version, std::string> version;
        };
    }

    /**
     * Thrown if a bad GLSA is found.
     *
     * \ingroup grpexceptions
     * \nosubgrouping
     */
    class PALUDIS_VISIBLE GLSAError :
        public ConfigurationError
    {
        public:
            ///\name Basic operations
            ///\{

            GLSAError(const std::string & message,
                    const std::string & filename = "") throw ();

            ///\}
    };

    /**
     * Represents a package entry in a GLSA.
     *
     * \see GLSA
     * \ingroup grperepository
     * \nosubgrouping
     */
    class PALUDIS_VISIBLE GLSAPackage
    {
        private:
            Pimp<GLSAPackage> _imp;

        public:
            ///\name Basic operations
            ///\{

            GLSAPackage(const QualifiedPackageName & name);
            ~GLSAPackage();

            ///\}

            ///\name Iterate over our archs.
            ///\{

            struct ArchsConstIteratorTag;
            typedef WrappedForwardIterator<ArchsConstIteratorTag, const std::string> ArchsConstIterator;
            ArchsConstIterator begin_archs() const;
            ArchsConstIterator end_archs() const;

            ///\}

            /**
             * Add an arch.
             */
            void add_arch(const std::string &);

            ///\name Iterate over our ranges.
            ///\{

            struct RangesConstIteratorTag;
            typedef WrappedForwardIterator<RangesConstIteratorTag, const erepository::GLSARange> RangesConstIterator;
            RangesConstIterator begin_unaffected() const;
            RangesConstIterator end_unaffected() const;
            RangesConstIterator begin_vulnerable() const;
            RangesConstIterator end_vulnerable() const;

            ///\}

            /**
             * Add an unaffected package.
             */
            void add_unaffected(const erepository::GLSARange &);

            /**
             * Add a vulnerable package.
             */
            void add_vulnerable(const erepository::GLSARange &);

            /**
             * Our package's name.
             */
            QualifiedPackageName name() const;
    };

    /**
     * Represents a GLSA (security advisory).
     *
     * \ingroup grperepository
     * \nosubgrouping
     */
    class PALUDIS_VISIBLE GLSA
    {
        private:
            Pimp<GLSA> _imp;

        public:
            ///\name Basic operations
            ///\{

            GLSA();
            ~GLSA();

            ///\}

            /**
             * Create a GLSA from an XML file.
             */
            static std::shared_ptr<GLSA> create_from_xml_file(const std::string & filename);

            ///\name Iterate over our packages.
            ///\{

            struct PackagesConstIteratorTag;
            typedef WrappedForwardIterator<PackagesConstIteratorTag, const GLSAPackage> PackagesConstIterator;
            PackagesConstIterator begin_packages() const;
            PackagesConstIterator end_packages() const;

            ///\}

            /**
             * Add a package.
             */
            void add_package(const std::shared_ptr<const GLSAPackage> &);

            /**
             * Set our ID.
             */
            void set_id(const std::string &);

            /**
             * Fetch our ID.
             */
            std::string id() const;

            /**
             * Set our title.
             */
            void set_title(const std::string &);

            /**
             * Fetch our title.
             */
            std::string title() const;
    };

    extern template class PALUDIS_VISIBLE WrappedForwardIterator<GLSAPackage::ArchsConstIteratorTag, const std::string>;
    extern template class PALUDIS_VISIBLE WrappedForwardIterator<GLSAPackage::RangesConstIteratorTag, const erepository::GLSARange>;
    extern template class PALUDIS_VISIBLE WrappedForwardIterator<GLSA::PackagesConstIteratorTag, const GLSAPackage>;
}

#endif