database.h 19.4 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
// Copyright (C) 2011  Internet Systems Consortium, Inc. ("ISC")
//
// Permission to use, copy, modify, and/or distribute this software for any
// purpose with or without fee is hereby granted, provided that the above
// copyright notice and this permission notice appear in all copies.
//
// THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
// REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
// AND FITNESS.  IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
// INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
// LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
// PERFORMANCE OF THIS SOFTWARE.

#ifndef __DATABASE_DATASRC_H
#define __DATABASE_DATASRC_H

#include <datasrc/client.h>

20
#include <dns/name.h>
21
#include <exceptions/exceptions.h>
22

23 24 25
namespace isc {
namespace datasrc {

26
/**
27
 * \brief Abstraction of lowlevel database with DNS data
28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44
 *
 * This class is defines interface to databases. Each supported database
 * will provide methods for accessing the data stored there in a generic
 * manner. The methods are meant to be low-level, without much or any knowledge
 * about DNS and should be possible to translate directly to queries.
 *
 * On the other hand, how the communication with database is done and in what
 * schema (in case of relational/SQL database) is up to the concrete classes.
 *
 * This class is non-copyable, as copying connections to database makes little
 * sense and will not be needed.
 *
 * \todo Is it true this does not need to be copied? For example the zone
 *     iterator might need it's own copy. But a virtual clone() method might
 *     be better for that than copy constructor.
 *
 * \note The same application may create multiple connections to the same
45 46 47
 *     database, having multiple instances of this class. If the database
 *     allows having multiple open queries at one connection, the connection
 *     class may share it.
48
 */
49
class DatabaseAccessor : boost::noncopyable {
50
public:
51 52 53
    /// The number of fields the columns array passed to getNext should have
    static const size_t COLUMN_COUNT = 5;

54 55 56 57 58 59
    /**
     * \brief Destructor
     *
     * It is empty, but needs a virtual one, since we will use the derived
     * classes in polymorphic way.
     */
60
    virtual ~DatabaseAccessor() { }
61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76
    /**
     * \brief Retrieve a zone identifier
     *
     * This method looks up a zone for the given name in the database. It
     * should match only exact zone name (eg. name is equal to the zone's
     * apex), as the DatabaseClient will loop trough the labels itself and
     * find the most suitable zone.
     *
     * It is not specified if and what implementation of this method may throw,
     * so code should expect anything.
     *
     * \param name The name of the zone's apex to be looked up.
     * \return The first part of the result indicates if a matching zone
     *     was found. In case it was, the second part is internal zone ID.
     *     This one will be passed to methods finding data in the zone.
     *     It is not required to keep them, in which case whatever might
77
     *     be returned - the ID is only passed back to the database as
78 79
     *     an opaque handle.
     */
80
    virtual std::pair<bool, int> getZone(const isc::dns::Name& name) const = 0;
81

82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103
    /**
     * \brief This holds the internal context of ZoneIterator for databases
     *
     * While the ZoneIterator implementation from DatabaseClient does all the
     * translation from strings to DNS classes and validation, this class
     * holds the pointer to where the database is at reading the data.
     *
     * It can either hold shared pointer to the connection which created it
     * and have some kind of statement inside (in case single database
     * connection can handle multiple concurrent SQL statements) or it can
     * create a new connection (or, if it is more convenient, the connection
     * itself can inherit both from DatabaseConnection and IteratorContext
     * and just clone itself).
     */
    class IteratorContext : public boost::noncopyable {
    public:
        /**
         * \brief Destructor
         *
         * Virtual destructor, so any descendand class is destroyed correctly.
         */
        virtual ~IteratorContext() { }
Jelte Jansen's avatar
Jelte Jansen committed
104

105 106 107 108 109 110
        /**
         * \brief Function to provide next resource record
         *
         * This function should provide data about the next resource record
         * from the iterated zone. The data are not converted yet.
         *
Jelte Jansen's avatar
Jelte Jansen committed
111 112
         * \note The order of RRs is not strictly set, but the RRs for single
         * RRset must not be interleaved with any other RRs (eg. RRsets must be
113 114
         * "together").
         *
115 116 117 118
         * \param columns The data will be returned through here. The order
         *     is specified by the RecordColumns enum.
         * \param Size of the columns array. Must be equal to COLUMN_COUNT,
         *     otherwise DataSourceError is thrown.
119 120
         * \todo Do we consider databases where it is stored in binary blob
         *     format?
121 122 123
         * \throw DataSourceError if there's database-related error. If the
         *     exception (or any other in case of derived class) is thrown,
         *     the iterator can't be safely used any more.
124
         */
125
        virtual bool getNext(std::string (&columns)[COLUMN_COUNT]) = 0;
126
    };
Jelte Jansen's avatar
Jelte Jansen committed
127

128
    typedef boost::shared_ptr<IteratorContext> IteratorContextPtr;
Jelte Jansen's avatar
Jelte Jansen committed
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
    /**
     * \brief Creates an iterator context for a specific name.
     *
     * This should create a new iterator context to be used by
     * DatabaseConnection's ZoneIterator. It can be created based on the name
     * or the ID (returned from getZone()), what is more comfortable for the
     * database implementation. Both are provided (and are guaranteed to match,
     * the DatabaseClient first looks up the zone ID and then calls this).
     *
     * The default implementation throws isc::NotImplemented, to allow
     * "minimal" implementations of the connection not supporting optional
     * functionality.
     *
     * \param name The name to search for.
     * \param id The ID of the zone, returned from getZone().
     * \return Newly created iterator context. Must not be NULL.
     */
    virtual IteratorContextPtr getRecords(const isc::dns::Name& name,
                                          int id) const
    {
        /*
         * This is a compromise. We need to document the parameters in doxygen,
         * so they need a name, but then it complains about unused parameter.
         * This is a NOP that "uses" the parameters.
         */
        static_cast<void>(name);
        static_cast<void>(id);

        isc_throw(isc::NotImplemented,
                  "This database datasource can't be iterated");
    }

162
    /**
163
     * \brief Creates an iterator context for the whole zone.
164 165 166 167 168 169 170 171 172 173 174 175 176 177 178
     *
     * This should create a new iterator context to be used by
     * DatabaseConnection's ZoneIterator. It can be created based on the name
     * or the ID (returned from getZone()), what is more comfortable for the
     * database implementation. Both are provided (and are guaranteed to match,
     * the DatabaseClient first looks up the zone ID and then calls this).
     *
     * The default implementation throws isc::NotImplemented, to allow
     * "minimal" implementations of the connection not supporting optional
     * functionality.
     *
     * \param name The name of the zone.
     * \param id The ID of the zone, returned from getZone().
     * \return Newly created iterator context. Must not be NULL.
     */
179
    virtual IteratorContextPtr getAllRecords(int id) const
180 181 182 183 184 185 186 187 188 189 190
    {
        /*
         * This is a compromise. We need to document the parameters in doxygen,
         * so they need a name, but then it complains about unused parameter.
         * This is a NOP that "uses" the parameters.
         */
        static_cast<void>(id);

        isc_throw(isc::NotImplemented,
                  "This database datasource can't be iterated");
    }
191

192 193 194
    /**
     * Definitions of the fields as they are required to be filled in
     * by getNextRecord()
Jelte Jansen's avatar
Jelte Jansen committed
195
     *
196 197
     * When implementing getNextRecord(), the columns array should
     * be filled with the values as described in this enumeration,
Jelte Jansen's avatar
Jelte Jansen committed
198 199 200
     * in this order, i.e. TYPE_COLUMN should be the first element
     * (index 0) of the array, TTL_COLUMN should be the second element
     * (index 1), etc.
201 202 203 204 205 206 207
     */
    enum RecordColumns {
        TYPE_COLUMN = 0,    ///< The RRType of the record (A/NS/TXT etc.)
        TTL_COLUMN = 1,     ///< The TTL of the record (a
        SIGTYPE_COLUMN = 2, ///< For RRSIG records, this contains the RRTYPE
                            ///< the RRSIG covers. In the current implementation,
                            ///< this field is ignored.
208
        RDATA_COLUMN = 3,   ///< Full text representation of the record's RDATA
209
        NAME_COLUMN = 4     ///< The domain name of this RR
210 211
    };

212
    /**
Michal 'vorner' Vaner's avatar
Michal 'vorner' Vaner committed
213 214 215 216 217 218 219 220 221 222 223
     * \brief Returns a string identifying this dabase backend
     *
     * The returned string is mainly intended to be used for
     * debugging/logging purposes.
     *
     * Any implementation is free to choose the exact string content,
     * but it is advisable to make it a name that is distinguishable
     * from the others.
     *
     * \return the name of the database
     */
224
    virtual const std::string& getDBName() const = 0;
225 226
};

227 228 229 230 231
/**
 * \brief Concrete data source client oriented at database backends.
 *
 * This class (together with corresponding versions of ZoneFinder,
 * ZoneIterator, etc.) translates high-level data source queries to
232
 * low-level calls on DatabaseAccessor. It calls multiple queries
233
 * if necessary and validates data from the database, allowing the
234
 * DatabaseAccessor to be just simple translation to SQL/other
235 236 237 238
 * queries to database.
 *
 * While it is possible to subclass it for specific database in case
 * of special needs, it is not expected to be needed. This should just
239
 * work as it is with whatever DatabaseAccessor.
240
 */
241 242
class DatabaseClient : public DataSourceClient {
public:
243 244 245
    /**
     * \brief Constructor
     *
246
     * It initializes the client with a database.
247
     *
248
     * \exception isc::InvalidParameter if database is NULL. It might throw
249 250
     * standard allocation exception as well, but doesn't throw anything else.
     *
251 252
     * \param database The database to use to get data. As the parameter
     *     suggests, the client takes ownership of the database and will
253 254
     *     delete it when itself deleted.
     */
255
    DatabaseClient(boost::shared_ptr<DatabaseAccessor> database);
256 257 258 259 260
    /**
     * \brief Corresponding ZoneFinder implementation
     *
     * The zone finder implementation for database data sources. Similarly
     * to the DatabaseClient, it translates the queries to methods of the
261
     * database.
262 263 264 265 266 267 268 269 270 271 272 273 274 275
     *
     * Application should not come directly in contact with this class
     * (it should handle it trough generic ZoneFinder pointer), therefore
     * it could be completely hidden in the .cc file. But it is provided
     * to allow testing and for rare cases when a database needs slightly
     * different handling, so it can be subclassed.
     *
     * Methods directly corresponds to the ones in ZoneFinder.
     */
    class Finder : public ZoneFinder {
    public:
        /**
         * \brief Constructor
         *
276
         * \param database The database (shared with DatabaseClient) to
277 278
         *     be used for queries (the one asked for ID before).
         * \param zone_id The zone ID which was returned from
279
         *     DatabaseAccessor::getZone and which will be passed to further
280
         *     calls to the database.
281 282 283
         * \param origin The name of the origin of this zone. It could query
         *     it from database, but as the DatabaseClient just searched for
         *     the zone using the name, it should have it.
284
         */
285 286
        Finder(boost::shared_ptr<DatabaseAccessor> database, int zone_id,
               const isc::dns::Name& origin);
Michal 'vorner' Vaner's avatar
Michal 'vorner' Vaner committed
287 288
        // The following three methods are just implementations of inherited
        // ZoneFinder's pure virtual methods.
289 290
        virtual isc::dns::Name getOrigin() const;
        virtual isc::dns::RRClass getClass() const;
291 292 293

        /**
         * \brief Find an RRset in the datasource
294
         *
Jelte Jansen's avatar
Jelte Jansen committed
295 296 297 298 299 300 301 302 303 304 305
         * Searches the datasource for an RRset of the given name and
         * type. If there is a CNAME at the given name, the CNAME rrset
         * is returned.
         * (this implementation is not complete, and currently only
         * does full matches, CNAMES, and the signatures for matches and
         * CNAMEs)
         * \note target was used in the original design to handle ANY
         *       queries. This is not implemented yet, and may use
         *       target again for that, but it might also use something
         *       different. It is left in for compatibility at the moment.
         * \note options are ignored at this moment
Jelte Jansen's avatar
Jelte Jansen committed
306
         *
307 308 309 310 311 312 313 314 315 316 317 318 319 320
         * \note Maybe counter intuitively, this method is not a const member
         * function.  This is intentional; some of the underlying implementations
         * are expected to use a database backend, and would internally contain
         * some abstraction of "database connection".  In the most strict sense
         * any (even read only) operation might change the internal state of
         * such a connection, and in that sense the operation cannot be considered
         * "const".  In order to avoid giving a false sense of safety to the
         * caller, we indicate a call to this method may have a surprising
         * side effect.  That said, this view may be too strict and it may
         * make sense to say the internal database connection doesn't affect
         * external behavior in terms of the interface of this method.  As
         * we gain more experiences with various kinds of backends we may
         * revisit the constness.
         *
Jelte Jansen's avatar
Jelte Jansen committed
321 322 323 324 325 326 327 328
         * \exception DataSourceError when there is a problem reading
         *                            the data from the dabase backend.
         *                            This can be a connection, code, or
         *                            data (parse) error.
         *
         * \param name The name to find
         * \param type The RRType to find
         * \param target Unused at this moment
329 330
         * \param options Options about how to search.
         *     See ZoneFinder::FindOptions.
331
         */
332 333 334
        virtual FindResult find(const isc::dns::Name& name,
                                const isc::dns::RRType& type,
                                isc::dns::RRsetList* target = NULL,
Jelte Jansen's avatar
Jelte Jansen committed
335
                                const FindOptions options = FIND_DEFAULT);
Jelte Jansen's avatar
Jelte Jansen committed
336

337 338 339 340 341 342 343 344 345
        /**
         * \brief The zone ID
         *
         * This function provides the stored zone ID as passed to the
         * constructor. This is meant for testing purposes and normal
         * applications shouldn't need it.
         */
        int zone_id() const { return (zone_id_); }
        /**
346
         * \brief The database.
347
         *
348
         * This function provides the database stored inside as
349 350 351
         * passed to the constructor. This is meant for testing purposes and
         * normal applications shouldn't need it.
         */
352
        const DatabaseAccessor& database() const {
353
            return (*database_);
354
        }
355
    private:
356
        boost::shared_ptr<DatabaseAccessor> database_;
357
        const int zone_id_;
358
        const isc::dns::Name origin_;
359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379
        /**
         * \brief Searches database for an RRset
         *
         * This method scans RRs of single domain specified by name and finds
         * RRset with given type or any of redirection RRsets that are
         * requested.
         *
         * This function is used internally by find(), because this part is
         * called multiple times with slightly different parameters.
         *
         * \param name Which domain name should be scanned.
         * \param type The RRType which is requested. This can be NULL, in
         *     which case the method will look for the redirections only.
         * \param want_cname If this is true, CNAME redirection may be returned
         *     instead of the RRset with given type. If there's CNAME and
         *     something else or the CNAME has multiple RRs, it throws
         *     DataSourceError.
         * \param want_dname If this is true, DNAME redirection may be returned
         *     instead. This is with type = NULL only and is not checked in
         *     other circumstances. If the DNAME has multiple RRs, it throws
         *     DataSourceError.
380 381 382 383 384 385
         * \param want_ns This allows redirection by NS to be returned. If
         *     any other data is met as well, DataSourceError is thrown.
         * \note It may happen that some of the above error conditions are not
         *     detected in some circumstances. The goal here is not to validate
         *     the domain in DB, but to avoid bad behaviour resulting from
         *     broken data.
386 387 388 389 390 391 392
         * \return First part of the result tells if the domain contains any
         *     RRs. This can be used to decide between NXDOMAIN and NXRRSET.
         *     The second part is the RRset found (if any) with any relevant
         *     signatures attached to it.
         * \todo This interface doesn't look very elegant. Any better idea
         *     would be nice.
         */
393 394
        std::pair<bool, isc::dns::RRsetPtr> getRRset(const isc::dns::Name&
                                                     name,
395 396 397 398 399
                                                     const isc::dns::RRType*
                                                     type,
                                                     bool want_cname,
                                                     bool want_dname,
                                                     bool want_ns);
400 401 402 403
    };
    /**
     * \brief Find a zone in the database
     *
404
     * This queries database's getZone to find the best matching zone.
405 406 407 408
     * It will propagate whatever exceptions are thrown from that method
     * (which is not restricted in any way).
     *
     * \param name Name of the zone or data contained there.
Michal 'vorner' Vaner's avatar
Michal 'vorner' Vaner committed
409 410 411 412 413
     * \return FindResult containing the code and an instance of Finder, if
     *     anything is found. However, application should not rely on the
     *     ZoneFinder being instance of Finder (possible subclass of this class
     *     may return something else and it may change in future versions), it
     *     should use it as a ZoneFinder only.
414
     */
415
    virtual FindResult findZone(const isc::dns::Name& name) const;
416

417 418 419 420 421 422 423 424 425 426
    /**
     * \brief Get the zone iterator
     *
     * The iterator allows going through the whole zone content. If the
     * underlying DatabaseConnection is implemented correctly, it should
     * be possible to have multiple ZoneIterators at once and query data
     * at the same time.
     *
     * \exception DataSourceError if the zone doesn't exist.
     * \exception isc::NotImplemented if the underlying DatabaseConnection
427 428
     *     doesn't implement iteration. But in case it is not implemented
     *     and the zone doesn't exist, DataSourceError is thrown.
429 430 431 432 433 434
     * \exception Anything else the underlying DatabaseConnection might
     *     want to throw.
     * \param name The origin of the zone to iterate.
     * \return Shared pointer to the iterator (it will never be NULL)
     */
    virtual ZoneIteratorPtr getIterator(const isc::dns::Name& name) const;
Jelte Jansen's avatar
Jelte Jansen committed
435

436
private:
437
    /// \brief Our database.
438
    const boost::shared_ptr<DatabaseAccessor> database_;
439 440 441 442 443 444
};

}
}

#endif