summaryrefslogtreecommitdiff
path: root/src/mongo/s/mongo_version_range.h
blob: 3e62f909a787974d66251007e4de5a442de7d73b (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
/**
 *    Copyright (C) 2012 10gen Inc.
 *
 *    This program is free software: you can redistribute it and/or  modify
 *    it under the terms of the GNU Affero General Public License, version 3,
 *    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 Affero General Public License for more details.
 *
 *    You should have received a copy of the GNU Affero General Public License
 *    along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 *    As a special exception, the copyright holders give permission to link the
 *    code of portions of this program with the OpenSSL library under certain
 *    conditions as described in each individual source file and distribute
 *    linked combinations including the program with the OpenSSL library. You
 *    must comply with the GNU Affero General Public License in all respects
 *    for all of the code used other than as permitted herein. If you modify
 *    file(s) with this exception, you may extend this exception to your
 *    version of the file(s), but you are not obligated to do so. If you do not
 *    wish to do so, delete this exception statement from your version. If you
 *    delete this exception statement from all source files in the program,
 *    then also delete it here.
 */

#pragma once

#include <string>
#include <vector>

#include "mongo/base/string_data.h"
#include "mongo/db/jsobj.h"

namespace mongo {

    /**
     * The MongoVersionRange represents a min/max of MongoDB versions, useful for
     * excluding/including particular versions.
     *
     * The ranges may be single-version, in which case maxVersion == "", where only exact prefix
     * matches are included in the range.  Alternately, the range may have a min and max version
     * and include any version with a prefix of the min and max version as well as all versions
     * between the two.
     */
    struct MongoVersionRange {

        static bool parseBSONArray(const BSONArray& arr,
                                   std::vector<MongoVersionRange>* excludes,
                                   std::string* errMsg);

        static BSONArray toBSONArray(const std::vector<MongoVersionRange>& ranges);

        bool parseBSONElement(const BSONElement& el, std::string* errMsg);

        void toBSONElement(BSONArrayBuilder* barr) const;

        bool isInRange(const StringData& version) const;

        std::string minVersion;
        std::string maxVersion;
    };

    bool isInMongoVersionRanges(const StringData& version,
                                const std::vector<MongoVersionRange>& ranges);
}