mirror of
https://github.com/mongodb/mongo.git
synced 2024-11-30 17:10:48 +01:00
5f7500bf01
The code on both the new header files is essentially the same. This commit just adjusted #include in dependent modules. The new headers did not make to pch.h. This change is in preparation for some improvements in code that is now in time_support.h
134 lines
4.7 KiB
C++
134 lines
4.7 KiB
C++
// commands.h
|
|
|
|
/* Copyright 2009 10gen Inc.
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include "../pch.h"
|
|
|
|
#include "jsobj.h"
|
|
#include "../util/timer.h"
|
|
|
|
namespace mongo {
|
|
|
|
class BSONObj;
|
|
class BSONObjBuilder;
|
|
class BufBuilder;
|
|
class Client;
|
|
|
|
/** mongodb "commands" (sent via db.$cmd.findOne(...))
|
|
subclass to make a command. define a singleton object for it.
|
|
*/
|
|
class Command {
|
|
public:
|
|
|
|
enum LockType { READ = -1 , NONE = 0 , WRITE = 1 };
|
|
|
|
const string name;
|
|
|
|
/* run the given command
|
|
implement this...
|
|
|
|
fromRepl - command is being invoked as part of replication syncing. In this situation you
|
|
normally do not want to log the command to the local oplog.
|
|
|
|
return value is true if succeeded. if false, set errmsg text.
|
|
*/
|
|
virtual bool run(const string& db, BSONObj& cmdObj, string& errmsg, BSONObjBuilder& result, bool fromRepl) = 0;
|
|
|
|
/*
|
|
note: logTheTop() MUST be false if READ
|
|
if NONE, can't use Client::Context setup
|
|
use with caution
|
|
*/
|
|
virtual LockType locktype() const = 0;
|
|
|
|
/* Return true if only the admin ns has privileges to run this command. */
|
|
virtual bool adminOnly() const {
|
|
return false;
|
|
}
|
|
|
|
void htmlHelp(stringstream&) const;
|
|
|
|
/* Like adminOnly, but even stricter: we must either be authenticated for admin db,
|
|
or, if running without auth, on the local interface.
|
|
|
|
When localHostOnlyIfNoAuth() is true, adminOnly() must also be true.
|
|
*/
|
|
virtual bool localHostOnlyIfNoAuth(const BSONObj& cmdObj) { return false; }
|
|
|
|
/* Return true if slaves of a replication pair are allowed to execute the command
|
|
(the command directly from a client -- if fromRepl, always allowed).
|
|
*/
|
|
virtual bool slaveOk() const = 0;
|
|
|
|
/* Return true if the client force a command to be run on a slave by
|
|
turning on the 'slaveok' option in the command query.
|
|
*/
|
|
virtual bool slaveOverrideOk() {
|
|
return false;
|
|
}
|
|
|
|
/* Override and return true to if true,log the operation (logOp()) to the replication log.
|
|
(not done if fromRepl of course)
|
|
|
|
Note if run() returns false, we do NOT log.
|
|
*/
|
|
virtual bool logTheOp() { return false; }
|
|
|
|
virtual void help( stringstream& help ) const;
|
|
|
|
/* Return true if authentication and security applies to the commands. Some commands
|
|
(e.g., getnonce, authenticate) can be done by anyone even unauthorized.
|
|
*/
|
|
virtual bool requiresAuth() { return true; }
|
|
|
|
/** @param webUI expose the command in the web ui as localhost:28017/<name>
|
|
@param oldName an optional old, deprecated name for the command
|
|
*/
|
|
Command(const char *_name, bool webUI = false, const char *oldName = 0);
|
|
|
|
virtual ~Command() {}
|
|
|
|
protected:
|
|
BSONObj getQuery( const BSONObj& cmdObj ){
|
|
if ( cmdObj["query"].type() == Object )
|
|
return cmdObj["query"].embeddedObject();
|
|
if ( cmdObj["q"].type() == Object )
|
|
return cmdObj["q"].embeddedObject();
|
|
return BSONObj();
|
|
}
|
|
|
|
static void logIfSlow( const Timer& cmdTimer, const string& msg);
|
|
|
|
static map<string,Command*> * _commands;
|
|
static map<string,Command*> * _commandsByBestName;
|
|
static map<string,Command*> * _webCommands;
|
|
|
|
public:
|
|
static const map<string,Command*>* commandsByBestName() { return _commandsByBestName; }
|
|
static const map<string,Command*>* webCommands() { return _webCommands; }
|
|
/** @return if command was found and executed */
|
|
static bool runAgainstRegistered(const char *ns, BSONObj& jsobj, BSONObjBuilder& anObjBuilder);
|
|
static LockType locktype( const string& name );
|
|
static Command * findCommand( const string& name );
|
|
};
|
|
|
|
bool _runCommands(const char *ns, BSONObj& jsobj, BufBuilder &b, BSONObjBuilder& anObjBuilder, bool fromRepl, int queryOptions);
|
|
|
|
|
|
} // namespace mongo
|