summaryrefslogtreecommitdiff
path: root/src/mongo/tools/tool.h
blob: df6bf67149195d14e6aa1135fc2e8d5445a45ae6 (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
/*
 *    Copyright (C) 2010 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.
 */

// Tool.h

#pragma once

#include <iosfwd>
#include <string>

#if defined(_WIN32)
#include <io.h>
#endif

#include "mongo/db/instance.h"
#include "mongo/db/matcher/matcher.h"
#include "mongo/tools/tool_logger.h"
#include "mongo/tools/tool_options.h"
#include "mongo/util/options_parser/environment.h"

using std::string;

namespace mongo {

    class Tool {
    public:
        Tool();
        virtual ~Tool();

        static std::auto_ptr<Tool> (*createInstance)();

        int main( int argc , char ** argv, char ** envp );

        std::string getNS() {
            if (toolGlobalParams.coll.size() == 0) {
                cerr << "no collection specified!" << std::endl;
                throw -1;
            }
            return toolGlobalParams.db + "." + toolGlobalParams.coll;
        }

        std::string getAuthenticationDatabase();

        bool isMaster();
        bool isMongos();

        virtual int run() = 0;

        virtual void printHelp(std::ostream &out) = 0;

    protected:

        mongo::DBClientBase &conn( bool slaveIfPaired = false );

        bool _autoreconnect;

    protected:

        mongo::DBClientBase * _conn;
        mongo::DBClientBase * _slaveConn;

        scoped_ptr<OperationContext> _txn;

    private:
        void auth();
    };

    class BSONTool : public Tool {
        std::auto_ptr<Matcher> _matcher;

    public:
        BSONTool();

        virtual int doRun() = 0;
        virtual void gotObject(const BSONObj& obj, std::ostream* out) = 0;

        virtual int run();

        /**
         * Read BSON documents from file and invoke gotObject() for every document.
         * Output stream will be passed along to gotObject().
         * If output stream is not provided, a NULL output stream will be passed to gotObject().
         */
        long long processFile(const boost::filesystem::path& file, std::ostream* out);

    };

}

#define REGISTER_MONGO_TOOL(TYPENAME) \
    std::auto_ptr<Tool> createInstanceOfThisTool() {return std::auto_ptr<Tool>(new TYPENAME());} \
    std::auto_ptr<Tool> (*Tool::createInstance)() = createInstanceOfThisTool;