mirror of
https://github.com/mongodb/mongo.git
synced 2024-11-30 00:56:44 +01:00
1363 lines
45 KiB
C++
1363 lines
45 KiB
C++
/** @file jsobj.h */
|
|
|
|
/**
|
|
BSONObj and its helpers
|
|
|
|
"BSON" stands for "binary JSON" -- ie a binary way to represent objects that would be
|
|
represented in JSON (plus a few extensions useful for databases & other languages).
|
|
*/
|
|
|
|
/**
|
|
* Copyright (C) 2008 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/>.
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include "../stdafx.h"
|
|
#include "../util/builder.h"
|
|
#include "boost/utility.hpp"
|
|
|
|
#include <set>
|
|
|
|
namespace mongo {
|
|
|
|
class BSONObj;
|
|
class Record;
|
|
class BSONObjBuilder;
|
|
class BSONObjBuilderValueStream;
|
|
|
|
#pragma pack(1)
|
|
|
|
/**
|
|
the complete list of valid BSON types
|
|
*/
|
|
enum BSONType {
|
|
/** smaller than all other types */
|
|
MinKey=-1,
|
|
/** end of object */
|
|
EOO=0,
|
|
/** double precision floating point value */
|
|
NumberDouble=1,
|
|
/** character string, stored in utf8 */
|
|
String=2,
|
|
/** an embedded object */
|
|
Object=3,
|
|
/** an embedded array */
|
|
Array=4,
|
|
/** binary data */
|
|
BinData=5,
|
|
/** Undefined type */
|
|
Undefined=6,
|
|
/** ObjectId */
|
|
jstOID=7,
|
|
/** boolean type */
|
|
Bool=8,
|
|
/** date type */
|
|
Date=9,
|
|
/** null type */
|
|
jstNULL=10,
|
|
/** regular expression, a pattern with options */
|
|
RegEx=11,
|
|
/** deprecated / will be redesigned */
|
|
DBRef=12,
|
|
/** deprecated / use CodeWScope */
|
|
Code=13,
|
|
/** a programming language (e.g., Python) symbol */
|
|
Symbol=14,
|
|
/** javascript code that can execute on the database server, with context */
|
|
CodeWScope=15,
|
|
/** 32 bit signed integer */
|
|
NumberInt = 16,
|
|
/** Updated to a Date with value next OpTime on insert */
|
|
Timestamp = 17,
|
|
/** max type that is not MaxKey */
|
|
JSTypeMax=17,
|
|
/** larger than all other types */
|
|
MaxKey=127
|
|
};
|
|
|
|
/* subtypes of BinData.
|
|
bdtCustom and above are ones that the JS compiler understands, but are
|
|
opaque to the database.
|
|
*/
|
|
enum BinDataType { Function=1, ByteArray=2, bdtUUID = 3, MD5Type=5, bdtCustom=128 };
|
|
|
|
/** Object ID type.
|
|
BSON objects typically have an _id field for the object id. This field should be the first
|
|
member of the object when present. class OID is a special type that is a 12 byte id which
|
|
is likely to be unique to the system. You may also use other types for _id's.
|
|
When _id field is missing from a BSON object, on an insert the database may insert one
|
|
automatically in certain circumstances.
|
|
*/
|
|
class OID {
|
|
union {
|
|
long long a;
|
|
unsigned char data[8];
|
|
};
|
|
unsigned b;
|
|
public:
|
|
const unsigned char *getData() const { return data; }
|
|
|
|
bool operator==(const OID& r) {
|
|
return a==r.a&&b==r.b;
|
|
}
|
|
bool operator!=(const OID& r) {
|
|
return a!=r.a||b!=r.b;
|
|
}
|
|
|
|
/** The object ID output as 24 hex digits. */
|
|
string str() const {
|
|
stringstream s;
|
|
s << hex;
|
|
// s.fill( '0' );
|
|
// s.width( 2 );
|
|
// fill wasn't working so doing manually...
|
|
for( int i = 0; i < 8; i++ ) {
|
|
unsigned u = data[i];
|
|
if( u < 16 ) s << '0';
|
|
s << u;
|
|
}
|
|
const unsigned char * raw = (const unsigned char*)&b;
|
|
for( int i = 0; i < 4; i++ ) {
|
|
unsigned u = raw[i];
|
|
if( u < 16 ) s << '0';
|
|
s << u;
|
|
}
|
|
/*
|
|
s.width( 16 );
|
|
s << a;
|
|
s.width( 8 );
|
|
s << b;
|
|
s << dec;
|
|
*/
|
|
return s.str();
|
|
}
|
|
|
|
/**
|
|
sets the contents to a new oid / randomized value
|
|
*/
|
|
void init();
|
|
|
|
/** Set to the hex string value specified. */
|
|
void init( string s );
|
|
|
|
};
|
|
ostream& operator<<( ostream &s, const OID &o );
|
|
|
|
/** Formatting mode for generating JSON from BSON.
|
|
See <http://mongodb.onconfluence.com/display/DOCS/Mongo+Extended+JSON>
|
|
for details.
|
|
*/
|
|
enum JsonStringFormat {
|
|
/** strict RFC format */
|
|
Strict,
|
|
/** 10gen format, which is close to JS format. This form is understandable by
|
|
javascript running inside the Mongo server via eval() */
|
|
TenGen,
|
|
/** Javascript JSON compatible */
|
|
JS
|
|
};
|
|
|
|
#pragma pack()
|
|
|
|
/* internals
|
|
<type><fieldName ><value>
|
|
-------- size() ------------
|
|
-fieldNameSize-
|
|
value()
|
|
type()
|
|
*/
|
|
/** BSONElement represents an "element" in a BSONObj. So for the object { a : 3, b : "abc" },
|
|
'a : 3' is the first element (key+value).
|
|
|
|
The BSONElement object points into the BSONObj's data. Thus the BSONObj must stay in scope
|
|
for the life of the BSONElement.
|
|
*/
|
|
class BSONElement {
|
|
friend class BSONObjIterator;
|
|
friend class BSONObj;
|
|
public:
|
|
string toString() const;
|
|
operator string() const { return toString(); }
|
|
string jsonString( JsonStringFormat format, bool includeFieldNames = true ) const;
|
|
|
|
/** Returns the type of the element */
|
|
BSONType type() const {
|
|
return (BSONType) *data;
|
|
}
|
|
|
|
/** Indicates if it is the end-of-object element, which is present at the end of
|
|
every BSON object.
|
|
*/
|
|
bool eoo() const {
|
|
return type() == EOO;
|
|
}
|
|
|
|
/** Size of the element.
|
|
@param maxLen If maxLen is specified, don't scan more than maxLen bytes to calculate size.
|
|
*/
|
|
int size( int maxLen = -1 ) const;
|
|
|
|
/** Wrap this element up as a singleton object. */
|
|
BSONObj wrap() const;
|
|
|
|
/** field name of the element. e.g., for
|
|
name : "Joe"
|
|
"name" is the fieldname
|
|
*/
|
|
const char * fieldName() const {
|
|
if ( eoo() ) return ""; // no fieldname for it.
|
|
return data + 1;
|
|
}
|
|
|
|
/** raw data of the element's value (so be careful). */
|
|
const char * value() const {
|
|
return (data + fieldNameSize() + 1);
|
|
}
|
|
/** size in bytes of the element's value (when applicable). */
|
|
int valuesize() const {
|
|
return size() - fieldNameSize() - 1;
|
|
}
|
|
|
|
bool isBoolean() const {
|
|
return type() == Bool;
|
|
}
|
|
|
|
/** @return value of a boolean element.
|
|
You must assure element is a boolean before
|
|
calling. */
|
|
bool boolean() const {
|
|
return *value() ? true : false;
|
|
}
|
|
|
|
/** Retrieve a java style date value from the element.
|
|
Ensure element is of type Date before calling.
|
|
*/
|
|
unsigned long long date() const {
|
|
return *reinterpret_cast< const unsigned long long* >( value() );
|
|
}
|
|
|
|
/** True if element is of a numeric type. */
|
|
bool isNumber() const {
|
|
return type() == NumberDouble || type() == NumberInt;
|
|
}
|
|
/** Retrieve the numeric value of the element. If not of a numeric type, returns 0. */
|
|
double number() const {
|
|
switch( type() ) {
|
|
case NumberDouble:
|
|
return *reinterpret_cast< const double* >( value() );
|
|
case NumberInt:
|
|
return *reinterpret_cast< const int* >( value() );
|
|
default:
|
|
return 0;
|
|
}
|
|
}
|
|
/** Retrieve the object ID stored in the object.
|
|
You must ensure the element is of type jstOID first. */
|
|
const OID &__oid() const {
|
|
return *reinterpret_cast< const OID* >( value() );
|
|
}
|
|
|
|
/** True if element is null. */
|
|
bool isNull() const {
|
|
return type() == jstNULL;
|
|
}
|
|
|
|
/** Size (length) of a string element.
|
|
You must assure of type String first. */
|
|
int valuestrsize() const {
|
|
return *reinterpret_cast< const int* >( value() );
|
|
}
|
|
|
|
// for objects the size *includes* the size of the size field
|
|
int objsize() const {
|
|
return *reinterpret_cast< const int* >( value() );
|
|
}
|
|
|
|
/** Get a string's value. Also gives you start of the real data for an embedded object.
|
|
You must assure data is of an appropriate type first -- see also valuestrsafe().
|
|
*/
|
|
const char * valuestr() const {
|
|
return value() + 4;
|
|
}
|
|
|
|
/** Get the string value of the element. If not a string returns "". */
|
|
const char *valuestrsafe() const {
|
|
return type() == String ? valuestr() : "";
|
|
}
|
|
/** Get the string value of the element. If not a string returns "". */
|
|
string str() const { return valuestrsafe(); }
|
|
|
|
/** Get javascript code of a CodeWScope data element. */
|
|
const char * codeWScopeCode() const {
|
|
return value() + 8;
|
|
}
|
|
/** Get the scope context of a CodeWScope data element. */
|
|
const char * codeWScopeScopeData() const {
|
|
// TODO fix
|
|
return codeWScopeCode() + strlen( codeWScopeCode() ) + 1;
|
|
}
|
|
|
|
/** Get the embedded object this element holds. */
|
|
BSONObj embeddedObject() const;
|
|
|
|
/* uasserts if not an object */
|
|
BSONObj embeddedObjectUserCheck();
|
|
|
|
BSONObj codeWScopeObject() const;
|
|
|
|
/** Get binary data. Element must be of type BinData */
|
|
const char *binData(int& len) const {
|
|
// BinData: <int len> <byte subtype> <byte[len] data>
|
|
assert( type() == BinData );
|
|
len = valuestrsize();
|
|
return value() + 5;
|
|
}
|
|
|
|
BinDataType binDataType() const {
|
|
// BinData: <int len> <byte subtype> <byte[len] data>
|
|
assert( type() == BinData );
|
|
char c = (value() + 4)[0];
|
|
return (BinDataType)c;
|
|
}
|
|
|
|
/** Retrieve the regex string for a Regex element */
|
|
const char *regex() const {
|
|
assert(type() == RegEx);
|
|
return value();
|
|
}
|
|
const char *simpleRegex() const;
|
|
/** Retrieve the regex flags (options) for a Regex element */
|
|
const char *regexFlags() const {
|
|
const char *p = regex();
|
|
return p + strlen(p) + 1;
|
|
}
|
|
|
|
/** like operator== but doesn't check the fieldname,
|
|
just the value.
|
|
*/
|
|
bool valuesEqual(const BSONElement& r) const {
|
|
if ( isNumber() )
|
|
return number() == r.number() && r.isNumber();
|
|
bool match= valuesize() == r.valuesize() &&
|
|
memcmp(value(),r.value(),valuesize()) == 0;
|
|
return match && type() == r.type();
|
|
// todo: make "0" == 0.0
|
|
}
|
|
|
|
/** Returns true if elements are equal. */
|
|
bool operator==(const BSONElement& r) const {
|
|
if ( strcmp(fieldName(), r.fieldName()) != 0 )
|
|
return false;
|
|
return valuesEqual(r);
|
|
}
|
|
|
|
|
|
/** Well ordered comparison.
|
|
@return <0: l<r. 0:l==r. >0:l>r
|
|
order by type, field name, and field value.
|
|
If considerFieldName is true, pay attention to the field name.
|
|
*/
|
|
int woCompare( const BSONElement &e, bool considerFieldName = true ) const;
|
|
|
|
const char * rawdata() const {
|
|
return data;
|
|
}
|
|
|
|
int getGtLtOp() const;
|
|
|
|
/** Constructs an empty element */
|
|
BSONElement();
|
|
|
|
/** Check that data is internally consistent. */
|
|
void validate() const;
|
|
|
|
/** True if this element may contain subobjects. */
|
|
bool mayEncapsulate() const {
|
|
return type() == Object ||
|
|
type() == Array ||
|
|
type() == CodeWScope;
|
|
}
|
|
|
|
unsigned long long timestampTime() const{
|
|
unsigned long long t = ((unsigned int*)(value() + 4 ))[0];
|
|
return t * 1000;
|
|
}
|
|
unsigned int timestampInc() const{
|
|
return ((unsigned int*)(value() ))[0];
|
|
}
|
|
|
|
protected:
|
|
// If maxLen is specified, don't scan more than maxLen bytes.
|
|
BSONElement(const char *d, int maxLen = -1) : data(d) {
|
|
fieldNameSize_ = -1;
|
|
if ( eoo() )
|
|
fieldNameSize_ = 0;
|
|
else {
|
|
if ( maxLen != -1 ) {
|
|
int size = strnlen( fieldName(), maxLen - 1 );
|
|
massert( "Invalid field name", size != -1 );
|
|
fieldNameSize_ = size + 1;
|
|
}
|
|
}
|
|
totalSize = -1;
|
|
}
|
|
private:
|
|
const char *data;
|
|
mutable int fieldNameSize_; // cached value
|
|
int fieldNameSize() const {
|
|
if ( fieldNameSize_ == -1 )
|
|
fieldNameSize_ = strlen( fieldName() ) + 1;
|
|
return fieldNameSize_;
|
|
}
|
|
mutable int totalSize; /* caches the computed size */
|
|
};
|
|
|
|
/* l and r MUST have same type when called: check that first. */
|
|
int compareElementValues(const BSONElement& l, const BSONElement& r);
|
|
int getGtLtOp(const BSONElement& e);
|
|
|
|
/* compare values with type check.
|
|
note: as is now, not smart about int/double comingling. TODO
|
|
*/
|
|
inline int compareValues(const BSONElement& l, const BSONElement& r)
|
|
{
|
|
int x = (int) l.type() - (int) r.type();
|
|
if( x ) return x;
|
|
return compareElementValues(l,r);
|
|
}
|
|
|
|
/**
|
|
C++ representation of a "BSON" object -- that is, an extended JSON-style
|
|
object in a binary representation.
|
|
|
|
Note that BSONObj's have a smart pointer capability built in -- so you can
|
|
pass them around by value. The reference counts used to implement this
|
|
do not use locking, so copying and destroying BSONObj's are not thread-safe
|
|
operations.
|
|
|
|
BSON object format:
|
|
|
|
\code
|
|
<unsigned totalSize> {<byte BSONType><cstring FieldName><Data>}* EOO
|
|
|
|
totalSize includes itself.
|
|
|
|
Data:
|
|
Bool: <byte>
|
|
EOO: nothing follows
|
|
Undefined: nothing follows
|
|
OID: an OID object
|
|
NumberDouble: <double>
|
|
NumberInt: <int32>
|
|
String: <unsigned32 strsizewithnull><cstring>
|
|
Date: <8bytes>
|
|
Regex: <cstring regex><cstring options>
|
|
Object: a nested object, leading with its entire size, which terminates with EOO.
|
|
Array: same as object
|
|
DBRef: <strlen> <cstring ns> <oid>
|
|
DBRef: a database reference: basically a collection name plus an Object ID
|
|
BinData: <int len> <byte subtype> <byte[len] data>
|
|
Code: a function (not a closure): same format as String.
|
|
Symbol: a language symbol (say a python symbol). same format as String.
|
|
Code With Scope: <total size><String><Object>
|
|
\endcode
|
|
*/
|
|
class BSONObj {
|
|
friend class BSONObjIterator;
|
|
class Holder {
|
|
public:
|
|
Holder( const char *objdata ) :
|
|
_objdata( objdata ) {
|
|
}
|
|
~Holder() {
|
|
free((void *)_objdata);
|
|
_objdata = 0;
|
|
}
|
|
private:
|
|
const char *_objdata;
|
|
};
|
|
const char *_objdata;
|
|
boost::shared_ptr< Holder > _holder;
|
|
void init(const char *data, bool ifree) {
|
|
if ( ifree )
|
|
_holder.reset( new Holder( data ) );
|
|
_objdata = data;
|
|
massert( "Invalid BSONObj spec size", isValid() );
|
|
}
|
|
#pragma pack(1)
|
|
static struct EmptyObject {
|
|
EmptyObject() {
|
|
len = 5;
|
|
jstype = EOO;
|
|
}
|
|
int len;
|
|
char jstype;
|
|
} emptyObject;
|
|
#pragma pack()
|
|
public:
|
|
/** Construct a BSONObj from data in the proper format.
|
|
@param ifree true if the BSONObj should free() the msgdata when
|
|
it destructs.
|
|
*/
|
|
explicit BSONObj(const char *msgdata, bool ifree = false) {
|
|
init(msgdata, ifree);
|
|
}
|
|
BSONObj(const Record *r);
|
|
/** Construct an empty BSONObj -- that is, {}. */
|
|
BSONObj() : _objdata( reinterpret_cast< const char * >( &emptyObject ) ) { }
|
|
// defensive
|
|
~BSONObj() { _objdata = 0; }
|
|
|
|
void appendSelfToBufBuilder(BufBuilder& b) const {
|
|
assert( objsize() );
|
|
b.append(reinterpret_cast<const void *>( objdata() ), objsize());
|
|
}
|
|
|
|
/** Readable representation of a BSON object in an extended JSON-style notation.
|
|
This is an abbreviated representation which might be used for logging.
|
|
*/
|
|
string toString() const;
|
|
operator string() const { return toString(); }
|
|
|
|
/** Properly formatted JSON string. */
|
|
string jsonString( JsonStringFormat format = Strict ) const;
|
|
|
|
/** note: addFields always adds _id even if not specified */
|
|
int addFields(BSONObj& from, set<string>& fields); /* returns n added */
|
|
|
|
/** returns # of top level fields in the object
|
|
note: iterates to count the fields
|
|
*/
|
|
int nFields() const;
|
|
|
|
/** adds the field names to the fields set. does NOT clear it (appends). */
|
|
int getFieldNames(set<string>& fields) const;
|
|
|
|
/** return has eoo() true if no match
|
|
supports "." notation to reach into embedded objects
|
|
*/
|
|
BSONElement getFieldDotted(const char *name) const;
|
|
/** Like getFieldDotted(), but returns first array encountered while traversing the
|
|
dotted fields of name. The name variable is updated to represent field
|
|
names with respect to the returned element. */
|
|
BSONElement getFieldDottedOrArray(const char *&name) const;
|
|
|
|
/** Get the field of the specified name. eoo() is true on the returned
|
|
element if not found.
|
|
*/
|
|
BSONElement getField(const string name) const {
|
|
return getField( name.c_str() );
|
|
};
|
|
|
|
/** Get the field of the specified name. eoo() is true on the returned
|
|
element if not found.
|
|
*/
|
|
BSONElement getField(const char *name) const; /* return has eoo() true if no match */
|
|
|
|
/** Get the field of the specified name. eoo() is true on the returned
|
|
element if not found.
|
|
*/
|
|
BSONElement operator[] (const char *field) const {
|
|
return getField(field);
|
|
}
|
|
|
|
/** @return true if field exists */
|
|
bool hasField( const char * name )const {
|
|
return ! getField( name ).eoo();
|
|
}
|
|
|
|
/** @return "" if DNE or wrong type */
|
|
const char * getStringField(const char *name) const;
|
|
|
|
/** @return subobject of the given name */
|
|
BSONObj getObjectField(const char *name) const;
|
|
|
|
/** @return INT_MIN if not present */
|
|
int getIntField(const char *name) const;
|
|
|
|
/** @return false if not present */
|
|
bool getBoolField(const char *name) const;
|
|
|
|
/** makes a new BSONObj with the fields specified in pattern.
|
|
fields returned in the order they appear in pattern.
|
|
if any field is missing from the object, that field in the
|
|
key will be null.
|
|
|
|
sets element field names to empty string
|
|
If an array is encountered while scanning the dotted names in pattern,
|
|
that array is added to the returned obj, rather than any subobjects
|
|
referenced within the array. The variable nameWithinArray is set to the
|
|
name of the requested field within the returned array.
|
|
*/
|
|
BSONObj extractFieldsDotted(BSONObj pattern, BSONObjBuilder& b, const char *&nameWithinArray) const; // this version, builder owns the returned obj buffer
|
|
|
|
/**
|
|
sets element field names to empty string
|
|
If a field in pattern is missing, it is omitted from the returned
|
|
object.
|
|
*/
|
|
BSONObj extractFieldsUnDotted(BSONObj pattern) const;
|
|
|
|
/** extract items from object which match a pattern object.
|
|
e.g., if pattern is { x : 1, y : 1 }, builds an object with
|
|
x and y elements of this object, if they are present.
|
|
returns elements with original field names
|
|
*/
|
|
BSONObj extractFields(const BSONObj &pattern) const;
|
|
|
|
BSONObj filterFieldsUndotted(const BSONObj &filter, bool inFilter) const;
|
|
|
|
BSONElement getFieldUsingIndexNames(const char *fieldName, const BSONObj &indexKey) const;
|
|
|
|
/** @return the raw data of the object */
|
|
const char *objdata() const {
|
|
return _objdata;
|
|
}
|
|
/** @return total size of the BSON object in bytes */
|
|
int objsize() const {
|
|
return *(reinterpret_cast<const int*>(objdata()));
|
|
}
|
|
|
|
bool isValid();
|
|
|
|
/** @return true if object is empty -- i.e., {} */
|
|
bool isEmpty() const {
|
|
return objsize() <= 5;
|
|
}
|
|
|
|
void dump() {
|
|
out() << hex;
|
|
const char *p = objdata();
|
|
for ( int i = 0; i < objsize(); i++ ) {
|
|
out() << i << '\t' << (unsigned) *p;
|
|
if ( *p >= 'A' && *p <= 'z' )
|
|
out() << '\t' << *p;
|
|
out() << endl;
|
|
p++;
|
|
}
|
|
}
|
|
|
|
// Alternative output format
|
|
string hexDump() const;
|
|
|
|
/**wo='well ordered'. fields must be in same order in each object.
|
|
Ordering is with respect to the signs of the elements in idxKey.
|
|
@return <0 if l<r. 0 if l==r. >0 if l>r
|
|
*/
|
|
int woCompare(const BSONObj& r, const BSONObj &idxKey = BSONObj(),
|
|
bool considerFieldName=true) const;
|
|
|
|
int woSortOrder( const BSONObj& r , const BSONObj& sortKey ) const;
|
|
|
|
/** This is "shallow equality" -- ints and doubles won't match. for a
|
|
deep equality test use woCompare (which is slower).
|
|
*/
|
|
bool woEqual(const BSONObj& r) const {
|
|
int os = objsize();
|
|
if ( os == r.objsize() ) {
|
|
return (os == 0 || memcmp(objdata(),r.objdata(),os)==0);
|
|
}
|
|
return false;
|
|
}
|
|
|
|
/** @return first field of the object */
|
|
BSONElement firstElement() const {
|
|
return BSONElement(objdata() + 4);
|
|
}
|
|
|
|
/** @return element with fieldname "name". returnvalue.eoo() is true if not found */
|
|
BSONElement findElement(const char *name) const;
|
|
|
|
/** @return element with fieldname "name". returnvalue.eoo() is true if not found */
|
|
BSONElement findElement(string name) const {
|
|
return findElement(name.c_str());
|
|
}
|
|
|
|
/** @return true if field exists in the object */
|
|
bool hasElement(const char *name) const;
|
|
|
|
/** Get the _id field from the object. For good performance drivers should
|
|
assure that _id is the first element of the object; however, correct operation
|
|
is assured regardless.
|
|
@return true if found
|
|
*/
|
|
bool getObjectID(BSONElement& e);
|
|
|
|
/** makes a copy of the object.
|
|
*/
|
|
BSONObj copy() const;
|
|
|
|
/* make sure the data buffer is under the control of BSONObj's and not a remote buffer */
|
|
BSONObj getOwned() const{
|
|
if ( !isOwned() )
|
|
return copy();
|
|
return *this;
|
|
}
|
|
bool isOwned() const { return _holder.get() != 0; }
|
|
|
|
/** @return A hash code for the object */
|
|
int hash() const {
|
|
unsigned x = 0;
|
|
const char *p = objdata();
|
|
for ( int i = 0; i < objsize(); i++ )
|
|
x = x * 131 + p[i];
|
|
return (x & 0x7fffffff) | 0x8000000; // must be > 0
|
|
}
|
|
|
|
// Return a version of this object where top level elements of types
|
|
// that are not part of the bson wire protocol are replaced with
|
|
// string identifier equivalents.
|
|
// TODO Support conversion of element types other than min and max.
|
|
BSONObj clientReadable() const;
|
|
|
|
/** Return new object with the field names replaced by those in the
|
|
passed object. */
|
|
BSONObj replaceFieldNames( const BSONObj &obj ) const;
|
|
|
|
/** true unless corrupt */
|
|
bool valid() const;
|
|
};
|
|
ostream& operator<<( ostream &s, const BSONObj &o );
|
|
ostream& operator<<( ostream &s, const BSONElement &e );
|
|
|
|
class BSONObjCmp {
|
|
public:
|
|
BSONObjCmp( const BSONObj &_order ) : order( _order ) {}
|
|
bool operator()( const BSONObj &l, const BSONObj &r ) const {
|
|
return l.woCompare( r, order ) < 0;
|
|
}
|
|
private:
|
|
BSONObj order;
|
|
};
|
|
|
|
class BSONObjCmpDefaultOrder : public BSONObjCmp {
|
|
public:
|
|
BSONObjCmpDefaultOrder() : BSONObjCmp( BSONObj() ) {}
|
|
};
|
|
|
|
typedef set< BSONObj, BSONObjCmpDefaultOrder > BSONObjSetDefaultOrder;
|
|
|
|
/** Use BSON macro to build a BSONObj from a stream
|
|
e.g.,
|
|
BSON( "name" << "joe" << "age" << 33 )
|
|
|
|
The labels GT, GTE, LT, LTE, NE can be helpful for stream-oriented construction
|
|
of a BSONObj, particularly when assembling a Query. For example,
|
|
BSON( "a" << GT << 23.4 << NE << 30 << "b" << 2 ) produces the object
|
|
{ a: { \$gt: 23.4, \$ne: 30 }, b: 2 }.
|
|
*/
|
|
#define BSON(x) (( BSONObjBuilder() << x ).obj())
|
|
|
|
class Labeler {
|
|
public:
|
|
struct Label {
|
|
Label( const char *l ) : l_( l ) {}
|
|
const char *l_;
|
|
};
|
|
Labeler( const Label &l, BSONObjBuilderValueStream *s ) : l_( l ), s_( s ) {}
|
|
template<class T>
|
|
BSONObjBuilder& operator<<( T value );
|
|
|
|
/* the value of the element e is appended i.e. for
|
|
"age" << GT << someElement
|
|
one gets
|
|
{ age : { $gt : someElement's value } }
|
|
*/
|
|
BSONObjBuilder& operator<<( const BSONElement& e );
|
|
private:
|
|
const Label &l_;
|
|
BSONObjBuilderValueStream *s_;
|
|
};
|
|
|
|
extern Labeler::Label GT;
|
|
extern Labeler::Label GTE;
|
|
extern Labeler::Label LT;
|
|
extern Labeler::Label LTE;
|
|
extern Labeler::Label NE;
|
|
extern Labeler::Label SIZE;
|
|
|
|
class BSONObjBuilderValueStream : public boost::noncopyable {
|
|
public:
|
|
friend class Labeler;
|
|
BSONObjBuilderValueStream( BSONObjBuilder * builder );
|
|
|
|
template<class T>
|
|
BSONObjBuilder& operator<<( T value );
|
|
|
|
Labeler operator<<( const Labeler::Label &l );
|
|
|
|
void endField( const char *nextFieldName = 0 );
|
|
bool subobjStarted() const { return _fieldName != 0; }
|
|
|
|
private:
|
|
const char * _fieldName;
|
|
BSONObjBuilder * _builder;
|
|
|
|
bool haveSubobj() const { return _subobj.get() != 0; }
|
|
BSONObjBuilder *subobj();
|
|
auto_ptr< BSONObjBuilder > _subobj;
|
|
};
|
|
|
|
/**
|
|
utility for creating a BSONObj
|
|
*/
|
|
class BSONObjBuilder : boost::noncopyable {
|
|
public:
|
|
/** @param initsize this is just a hint as to the final size of the object */
|
|
BSONObjBuilder(int initsize=512) : b(buf_), buf_(initsize), offset_( 0 ), s_( this ) {
|
|
b.skip(4); /*leave room for size field*/
|
|
}
|
|
|
|
/** @param baseBuilder construct a BSONObjBuilder using an existing BufBuilder */
|
|
BSONObjBuilder( BufBuilder &baseBuilder ) : b( baseBuilder ), buf_( 0 ), offset_( baseBuilder.len() ), s_( this ) {
|
|
b.skip( 4 );
|
|
}
|
|
|
|
/** add all the fields from the object specified to this object */
|
|
BSONObjBuilder& appendElements(BSONObj x);
|
|
|
|
/** append element to the object we are building */
|
|
void append( const BSONElement& e) {
|
|
assert( !e.eoo() ); // do not append eoo, that would corrupt us. the builder auto appends when done() is called.
|
|
b.append((void*) e.rawdata(), e.size());
|
|
}
|
|
|
|
/** append an element but with a new name */
|
|
void appendAs(const BSONElement& e, const char *as) {
|
|
b.append((char) e.type());
|
|
b.append(as);
|
|
b.append((void *) e.value(), e.valuesize());
|
|
}
|
|
|
|
/** add a subobject as a member */
|
|
void append(const char *fieldName, BSONObj subObj) {
|
|
b.append((char) Object);
|
|
b.append(fieldName);
|
|
b.append((void *) subObj.objdata(), subObj.objsize());
|
|
}
|
|
|
|
/** add header for a new subobject and return bufbuilder for writing to
|
|
the subobject's body */
|
|
BufBuilder &subobjStart(const char *fieldName) {
|
|
b.append((char) Object);
|
|
b.append(fieldName);
|
|
return b;
|
|
}
|
|
|
|
/** add a subobject as a member with type Array. Thus arr object should have "0", "1", ...
|
|
style fields in it.
|
|
*/
|
|
void appendArray(const char *fieldName, BSONObj subObj) {
|
|
b.append((char) Array);
|
|
b.append(fieldName);
|
|
b.append((void *) subObj.objdata(), subObj.objsize());
|
|
}
|
|
|
|
/** add header for a new subarray and return bufbuilder for writing to
|
|
the subarray's body */
|
|
BufBuilder &subarrayStart(const char *fieldName) {
|
|
b.append((char) Array);
|
|
b.append(fieldName);
|
|
return b;
|
|
}
|
|
|
|
/** Append a boolean element */
|
|
void appendBool(const char *fieldName, int val) {
|
|
b.append((char) Bool);
|
|
b.append(fieldName);
|
|
b.append((char) (val?1:0));
|
|
}
|
|
/** Append a 32 bit integer element */
|
|
void append(const char *fieldName, int n) {
|
|
b.append((char) NumberInt);
|
|
b.append(fieldName);
|
|
b.append(n);
|
|
}
|
|
/** Append a 32 bit integer element */
|
|
void append(const string &fieldName, int n) {
|
|
append( fieldName.c_str(), n );
|
|
}
|
|
void append(const char *fieldName, unsigned n) { append(fieldName, (int) n); }
|
|
/** Append a double element */
|
|
BSONObjBuilder& append(const char *fieldName, double n) {
|
|
b.append((char) NumberDouble);
|
|
b.append(fieldName);
|
|
b.append(n);
|
|
return *this;
|
|
}
|
|
/** Append a BSON Object ID (OID type). */
|
|
void appendOID(const char *fieldName, OID *oid = 0) {
|
|
b.append((char) jstOID);
|
|
b.append(fieldName);
|
|
if ( oid )
|
|
b.append( (void *) oid, 12 );
|
|
else {
|
|
OID tmp;
|
|
memset( &tmp, 0, 12 );
|
|
b.append( (void *) &tmp, 12 );
|
|
}
|
|
}
|
|
void append( const char *fieldName, OID oid ) {
|
|
appendOID( fieldName, &oid );
|
|
}
|
|
/** Append a date.
|
|
@param dt a Java-style 64 bit date value, that is
|
|
the number of milliseconds since January 1, 1970, 00:00:00 GMT
|
|
*/
|
|
void appendDate(const char *fieldName, unsigned long long dt) {
|
|
b.append((char) Date);
|
|
b.append(fieldName);
|
|
b.append(dt);
|
|
}
|
|
/** Append a regular expression value
|
|
@param regex the regular expression pattern
|
|
@param regex options such as "i" or "g"
|
|
*/
|
|
void appendRegex(const char *fieldName, const char *regex, const char *options = "") {
|
|
b.append((char) RegEx);
|
|
b.append(fieldName);
|
|
b.append(regex);
|
|
b.append(options);
|
|
}
|
|
/** Append a regular expression value
|
|
@param regex the regular expression pattern
|
|
@param regex options such as "i" or "g"
|
|
*/
|
|
void appendRegex(string fieldName, string regex, string options = "") {
|
|
appendRegex(fieldName.c_str(), regex.c_str(), options.c_str());
|
|
}
|
|
void appendCode(const char *fieldName, const char *code) {
|
|
b.append((char) Code);
|
|
b.append(fieldName);
|
|
b.append((int) strlen(code)+1);
|
|
b.append(code);
|
|
}
|
|
/** Append a string element */
|
|
BSONObjBuilder& append(const char *fieldName, const char *str) {
|
|
b.append((char) String);
|
|
b.append(fieldName);
|
|
b.append((int) strlen(str)+1);
|
|
b.append(str);
|
|
return *this;
|
|
}
|
|
/** Append a string element */
|
|
void append(const char *fieldName, string str) {
|
|
append(fieldName, str.c_str());
|
|
}
|
|
void appendSymbol(const char *fieldName, const char *symbol) {
|
|
b.append((char) Symbol);
|
|
b.append(fieldName);
|
|
b.append((int) strlen(symbol)+1);
|
|
b.append(symbol);
|
|
}
|
|
|
|
/** Append a Null element to the object */
|
|
void appendNull( const char *fieldName ) {
|
|
b.append( (char) jstNULL );
|
|
b.append( fieldName );
|
|
}
|
|
|
|
// Append an element that is less than all other keys.
|
|
void appendMinKey( const char *fieldName ) {
|
|
b.append( (char) MinKey );
|
|
b.append( fieldName );
|
|
}
|
|
// Append an element that is greater than all other keys.
|
|
void appendMaxKey( const char *fieldName ) {
|
|
b.append( (char) MaxKey );
|
|
b.append( fieldName );
|
|
}
|
|
|
|
// Append a Timestamp field -- will be updated to next OpTime on db insert.
|
|
void appendTimestamp( const char *fieldName ) {
|
|
b.append( (char) Timestamp );
|
|
b.append( fieldName );
|
|
b.append( (unsigned long long) 0 );
|
|
}
|
|
|
|
void appendTimestamp( const char *fieldName , unsigned long long val ) {
|
|
b.append( (char) Timestamp );
|
|
b.append( fieldName );
|
|
b.append( val );
|
|
}
|
|
|
|
/* Deprecated (but supported) */
|
|
void appendDBRef( const char *fieldName, const char *ns, const OID &oid ) {
|
|
b.append( (char) DBRef );
|
|
b.append( fieldName );
|
|
b.append( (int) strlen( ns ) + 1 );
|
|
b.append( ns );
|
|
b.append( (void *) &oid, 12 );
|
|
}
|
|
|
|
/** Append a binary data element
|
|
@param fieldName name of the field
|
|
@param len length of the binary data in bytes
|
|
@param type type information for the data. @see BinDataType. Use ByteArray if you
|
|
don't care about the type.
|
|
@param data the byte array
|
|
*/
|
|
void appendBinData( const char *fieldName, int len, BinDataType type, const char *data ) {
|
|
b.append( (char) BinData );
|
|
b.append( fieldName );
|
|
b.append( len );
|
|
b.append( (char) type );
|
|
b.append( (void *) data, len );
|
|
}
|
|
|
|
/**
|
|
@param len the length of data
|
|
*/
|
|
void appendBinDataArray( const char * fieldName , const char * data , int len ){
|
|
b.append( (char) BinData );
|
|
b.append( fieldName );
|
|
b.append( len + 4 );
|
|
b.append( (char)0x2 );
|
|
b.append( len );
|
|
b.append( (void *) data, len );
|
|
}
|
|
|
|
/** Append to the BSON object a field of type CodeWScope. This is a javascript code
|
|
fragment accompanied by some scope that goes with it.
|
|
*/
|
|
void appendCodeWScope( const char *fieldName, const char *code, const BSONObj &scope ) {
|
|
b.append( (char) CodeWScope );
|
|
b.append( fieldName );
|
|
b.append( ( int )( 4 + 4 + strlen( code ) + 1 + scope.objsize() ) );
|
|
b.append( ( int ) strlen( code ) + 1 );
|
|
b.append( code );
|
|
b.append( ( void * )scope.objdata(), scope.objsize() );
|
|
}
|
|
|
|
/* helper function -- see Query::where() for primary way to do this. */
|
|
void appendWhere( const char *code, const BSONObj &scope ){
|
|
appendCodeWScope( "$where" , code , scope );
|
|
}
|
|
void appendWhere( const string &code, const BSONObj &scope ){
|
|
appendWhere( code.c_str(), scope );
|
|
}
|
|
|
|
/** Append an array of values. */
|
|
template < class T >
|
|
void append( const char *fieldName, const vector< T >& vals ) {
|
|
BSONObjBuilder arrBuilder;
|
|
for ( unsigned int i = 0; i < vals.size(); ++i )
|
|
arrBuilder.append( numStr( i ).c_str(), vals[ i ] );
|
|
marshalArray( fieldName, arrBuilder.done() );
|
|
}
|
|
|
|
/* Append an array of ints
|
|
void appendArray( const char *fieldName, const vector< int >& vals ) {
|
|
BSONObjBuilder arrBuilder;
|
|
for ( unsigned i = 0; i < vals.size(); ++i )
|
|
arrBuilder.append( numStr( i ).c_str(), vals[ i ] );
|
|
marshalArray( fieldName, arrBuilder.done() );
|
|
}*/
|
|
|
|
/** The returned BSONObj will free the buffer when it is finished. */
|
|
BSONObj obj() {
|
|
massert( "builder does not own memory", owned() );
|
|
int l;
|
|
return BSONObj(decouple(l), true);
|
|
}
|
|
|
|
/** Fetch the object we have built.
|
|
BSONObjBuilder still frees the object when the builder goes out of
|
|
scope -- very important to keep in mind. Use obj() if you
|
|
would like the BSONObj to last longer than the builder.
|
|
*/
|
|
BSONObj done() {
|
|
return BSONObj(_done());
|
|
}
|
|
|
|
/* assume ownership of the buffer - you must then free it (with free()) */
|
|
char* decouple(int& l) {
|
|
char *x = _done();
|
|
assert( x );
|
|
l = b.len();
|
|
b.decouple();
|
|
return x;
|
|
}
|
|
void decouple() {
|
|
b.decouple(); // post done() call version. be sure jsobj frees...
|
|
}
|
|
|
|
static string numStr( int i ) {
|
|
stringstream o;
|
|
o << i;
|
|
return o.str();
|
|
}
|
|
|
|
/** Stream oriented way to add field names and values. */
|
|
BSONObjBuilderValueStream &operator<<(const char * name ) {
|
|
s_.endField( name );
|
|
return s_;
|
|
}
|
|
|
|
/** Stream oriented way to add field names and values. */
|
|
BSONObjBuilderValueStream &operator<<( const string& name ) {
|
|
return operator<<( name.c_str() );
|
|
}
|
|
|
|
Labeler operator<<( const Labeler::Label &l ) {
|
|
massert( "No subobject started", s_.subobjStarted() );
|
|
return s_ << l;
|
|
}
|
|
|
|
bool owned() const {
|
|
return &b == &buf_;
|
|
}
|
|
|
|
private:
|
|
// Append the provided arr object as an array.
|
|
void marshalArray( const char *fieldName, const BSONObj &arr ) {
|
|
b.append( (char) Array );
|
|
b.append( fieldName );
|
|
b.append( (void *) arr.objdata(), arr.objsize() );
|
|
}
|
|
|
|
char* _done() {
|
|
s_.endField();
|
|
b.append((char) EOO);
|
|
char *data = b.buf() + offset_;
|
|
*((int*)data) = b.len() - offset_;
|
|
return data;
|
|
}
|
|
|
|
BufBuilder &b;
|
|
BufBuilder buf_;
|
|
int offset_;
|
|
BSONObjBuilderValueStream s_;
|
|
};
|
|
|
|
|
|
/** iterator for a BSONObj
|
|
|
|
Note each BSONObj ends with an EOO element: so you will get more() on an empty
|
|
object, although next().eoo() will be true.
|
|
|
|
todo: we may want to make a more stl-like iterator interface for this
|
|
with things like begin() and end()
|
|
*/
|
|
class BSONObjIterator {
|
|
public:
|
|
/** Create an iterator for a BSON object.
|
|
*/
|
|
BSONObjIterator(const BSONObj& jso) {
|
|
int sz = jso.objsize();
|
|
if ( sz == 0 ) {
|
|
pos = theend = 0;
|
|
return;
|
|
}
|
|
pos = jso.objdata() + 4;
|
|
theend = jso.objdata() + sz;
|
|
}
|
|
/** @return true if more elements exist to be enumerated. */
|
|
bool more() {
|
|
return pos < theend;
|
|
}
|
|
/** @return the next element in the object. For the final element, element.eoo() will be true. */
|
|
BSONElement next( bool checkEnd = false ) {
|
|
assert( pos < theend );
|
|
BSONElement e( pos, checkEnd ? theend - pos : -1 );
|
|
pos += e.size( checkEnd ? theend - pos : -1 );
|
|
return e;
|
|
}
|
|
private:
|
|
const char *pos;
|
|
const char *theend;
|
|
};
|
|
|
|
/* iterator a BSONObj which is an array, in array order.
|
|
class JSArrayIter {
|
|
public:
|
|
BSONObjIterator(const BSONObj& jso) {
|
|
...
|
|
}
|
|
bool more() { return ... }
|
|
BSONElement next() {
|
|
...
|
|
}
|
|
};
|
|
*/
|
|
|
|
} // namespace mongo
|
|
|
|
#include "matcher.h"
|
|
|
|
namespace mongo {
|
|
|
|
extern BSONObj maxKey;
|
|
extern BSONObj minKey;
|
|
|
|
/*- just for testing -- */
|
|
|
|
#pragma pack(1)
|
|
struct JSObj1 {
|
|
JSObj1() {
|
|
totsize=sizeof(JSObj1);
|
|
n = NumberDouble;
|
|
strcpy_s(nname, 5, "abcd");
|
|
N = 3.1;
|
|
s = String;
|
|
strcpy_s(sname, 7, "abcdef");
|
|
slen = 10;
|
|
strcpy_s(sval, 10, "123456789");
|
|
eoo = EOO;
|
|
}
|
|
unsigned totsize;
|
|
|
|
char n;
|
|
char nname[5];
|
|
double N;
|
|
|
|
char s;
|
|
char sname[7];
|
|
unsigned slen;
|
|
char sval[10];
|
|
|
|
char eoo;
|
|
};
|
|
#pragma pack()
|
|
extern JSObj1 js1;
|
|
|
|
#ifdef _DEBUG
|
|
#define CHECK_OBJECT( o , msg ) massert( (string)"object not valid" + (msg) , (o).isValid() )
|
|
#else
|
|
#define CHECK_OBJECT( o , msg )
|
|
#endif
|
|
|
|
inline BSONObj BSONElement::embeddedObjectUserCheck() {
|
|
uassert( "invalid parameter: expected an object", type()==Object || type()==Array );
|
|
return BSONObj(value());
|
|
}
|
|
|
|
inline BSONObj BSONElement::embeddedObject() const {
|
|
assert( type()==Object || type()==Array );
|
|
return BSONObj(value());
|
|
}
|
|
|
|
inline BSONObj BSONElement::codeWScopeObject() const {
|
|
assert( type() == CodeWScope );
|
|
int strSizeWNull = *(int *)( value() + 4 );
|
|
return BSONObj( value() + 4 + 4 + strSizeWNull );
|
|
}
|
|
|
|
inline BSONObj BSONObj::copy() const {
|
|
char *p = (char*) malloc(objsize());
|
|
memcpy(p, objdata(), objsize());
|
|
return BSONObj(p, true);
|
|
}
|
|
|
|
// wrap this element up as a singleton object.
|
|
inline BSONObj BSONElement::wrap() const {
|
|
BSONObjBuilder b;
|
|
b.append(*this);
|
|
return b.obj();
|
|
}
|
|
|
|
inline bool BSONObj::hasElement(const char *name) const {
|
|
if ( !isEmpty() ) {
|
|
BSONObjIterator it(*this);
|
|
while ( it.more() ) {
|
|
BSONElement e = it.next();
|
|
if ( strcmp(name, e.fieldName()) == 0 )
|
|
return true;
|
|
}
|
|
}
|
|
return false;
|
|
}
|
|
|
|
inline BSONElement BSONObj::findElement(const char *name) const {
|
|
if ( !isEmpty() ) {
|
|
BSONObjIterator it(*this);
|
|
while ( it.more() ) {
|
|
BSONElement e = it.next();
|
|
if ( strcmp(name, e.fieldName()) == 0 )
|
|
return e;
|
|
}
|
|
}
|
|
return BSONElement();
|
|
}
|
|
|
|
/* add all the fields from the object specified to this object */
|
|
inline BSONObjBuilder& BSONObjBuilder::appendElements(BSONObj x) {
|
|
BSONObjIterator it(x);
|
|
while ( it.more() ) {
|
|
BSONElement e = it.next();
|
|
if ( e.eoo() ) break;
|
|
append(e);
|
|
}
|
|
return *this;
|
|
}
|
|
|
|
inline bool BSONObj::isValid(){
|
|
return objsize() > 0 && objsize() <= 1024 * 1024 * 16 ;
|
|
}
|
|
|
|
inline bool BSONObj::getObjectID(BSONElement& e) {
|
|
BSONElement f = findElement("_id");
|
|
if( !f.eoo() ) {
|
|
e = f;
|
|
return true;
|
|
}
|
|
return false;
|
|
}
|
|
|
|
inline BSONObjBuilderValueStream::BSONObjBuilderValueStream( BSONObjBuilder * builder ) {
|
|
_fieldName = 0;
|
|
_builder = builder;
|
|
}
|
|
|
|
template<class T> inline
|
|
BSONObjBuilder& BSONObjBuilderValueStream::operator<<( T value ) {
|
|
_builder->append(_fieldName, value);
|
|
_fieldName = 0;
|
|
return *_builder;
|
|
}
|
|
|
|
inline Labeler BSONObjBuilderValueStream::operator<<( const Labeler::Label &l ) {
|
|
return Labeler( l, this );
|
|
}
|
|
|
|
inline void BSONObjBuilderValueStream::endField( const char *nextFieldName ) {
|
|
if ( _fieldName && haveSubobj() ) {
|
|
_builder->append( _fieldName, subobj()->done() );
|
|
}
|
|
_subobj.reset();
|
|
_fieldName = nextFieldName;
|
|
}
|
|
|
|
inline BSONObjBuilder *BSONObjBuilderValueStream::subobj() {
|
|
if ( !haveSubobj() )
|
|
_subobj.reset( new BSONObjBuilder() );
|
|
return _subobj.get();
|
|
}
|
|
|
|
template<class T> inline
|
|
BSONObjBuilder& Labeler::operator<<( T value ) {
|
|
s_->subobj()->append( l_.l_, value );
|
|
return *s_->_builder;
|
|
}
|
|
|
|
inline
|
|
BSONObjBuilder& Labeler::operator<<( const BSONElement& e ) {
|
|
s_->subobj()->appendAs( e, l_.l_ );
|
|
return *s_->_builder;
|
|
}
|
|
|
|
} // namespace mongo
|