summaryrefslogtreecommitdiff
path: root/src/mongo/db/fts/fts_enabled.cpp
blob: fb261194db1b08e173552326a171d3ed1dde9def (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
// fts_enabled.cpp

/**
*    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 in the license file.
*/

#define MONGO_LOG_DEFAULT_COMPONENT ::mongo::logger::LogComponent::kCommand

#include "mongo/db/server_parameters.h"

#include "mongo/util/log.h"

namespace mongo {
namespace fts {
namespace {

bool dummyEnabledFlag = true;  // Unused, needed for server parameter.

/**
 * Declaration for the "textSearchEnabled" server parameter, which is now deprecated.
 * Note that:
 * - setting to true performs a no-op and logs a deprecation message.
 * - setting to false will fail.
 */
class ExportedTextSearchEnabledParameter : public ExportedServerParameter<bool> {
public:
    ExportedTextSearchEnabledParameter()
        : ExportedServerParameter<bool>(
              ServerParameterSet::getGlobal(), "textSearchEnabled", &dummyEnabledFlag, true, true) {
    }

    virtual Status validate(const bool& potentialNewValue) {
        if (!potentialNewValue) {
            return Status(ErrorCodes::BadValue, "textSearchEnabled cannot be set to false");
        }

        log() << "Attempted to set textSearchEnabled server parameter.";
        log() << "Text search is enabled by default and cannot be disabled.";
        log() << "The following are now deprecated and will be removed in a future "
              << "release:";
        log() << "- the \"textSearchEnabled\" server parameter (setting it has no "
              << "effect)";
        log() << "- the \"text\" command (has been replaced by the $text query "
                 "operator)";

        return Status::OK();
    }

} exportedTextSearchEnabledParam;
}
}
}