123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269 |
- /*!
- * Module dependencies.
- */
- 'use strict';
- const MongooseBuffer = require('../types/buffer');
- const SchemaBufferOptions = require('../options/SchemaBufferOptions');
- const SchemaType = require('../schematype');
- const handleBitwiseOperator = require('./operators/bitwise');
- const utils = require('../utils');
- const Binary = MongooseBuffer.Binary;
- const CastError = SchemaType.CastError;
- /**
- * Buffer SchemaType constructor
- *
- * @param {String} key
- * @param {Object} options
- * @inherits SchemaType
- * @api public
- */
- function SchemaBuffer(key, options) {
- SchemaType.call(this, key, options, 'Buffer');
- }
- /**
- * This schema type's name, to defend against minifiers that mangle
- * function names.
- *
- * @api public
- */
- SchemaBuffer.schemaName = 'Buffer';
- SchemaBuffer.defaultOptions = {};
- /*!
- * Inherits from SchemaType.
- */
- SchemaBuffer.prototype = Object.create(SchemaType.prototype);
- SchemaBuffer.prototype.constructor = SchemaBuffer;
- SchemaBuffer.prototype.OptionsConstructor = SchemaBufferOptions;
- /*!
- * ignore
- */
- SchemaBuffer._checkRequired = v => !!(v && v.length);
- /**
- * Sets a default option for all Buffer instances.
- *
- * #### Example:
- *
- * // Make all buffers have `required` of true by default.
- * mongoose.Schema.Buffer.set('required', true);
- *
- * const User = mongoose.model('User', new Schema({ test: Buffer }));
- * new User({ }).validateSync().errors.test.message; // Path `test` is required.
- *
- * @param {String} option - The option you'd like to set the value for
- * @param {*} value - value for option
- * @return {undefined}
- * @function set
- * @static
- * @api public
- */
- SchemaBuffer.set = SchemaType.set;
- /**
- * Override the function the required validator uses to check whether a string
- * passes the `required` check.
- *
- * #### Example:
- *
- * // Allow empty strings to pass `required` check
- * mongoose.Schema.Types.String.checkRequired(v => v != null);
- *
- * const M = mongoose.model({ buf: { type: Buffer, required: true } });
- * new M({ buf: Buffer.from('') }).validateSync(); // validation passes!
- *
- * @param {Function} fn
- * @return {Function}
- * @function checkRequired
- * @static
- * @api public
- */
- SchemaBuffer.checkRequired = SchemaType.checkRequired;
- /**
- * Check if the given value satisfies a required validator. To satisfy a
- * required validator, a buffer must not be null or undefined and have
- * non-zero length.
- *
- * @param {Any} value
- * @param {Document} doc
- * @return {Boolean}
- * @api public
- */
- SchemaBuffer.prototype.checkRequired = function(value, doc) {
- if (SchemaType._isRef(this, value, doc, true)) {
- return !!value;
- }
- return this.constructor._checkRequired(value);
- };
- /**
- * Casts contents
- *
- * @param {Object} value
- * @param {Document} doc document that triggers the casting
- * @param {Boolean} init
- * @api private
- */
- SchemaBuffer.prototype.cast = function(value, doc, init) {
- let ret;
- if (SchemaType._isRef(this, value, doc, init)) {
- if (value && value.isMongooseBuffer) {
- return value;
- }
- if (Buffer.isBuffer(value)) {
- if (!value || !value.isMongooseBuffer) {
- value = new MongooseBuffer(value, [this.path, doc]);
- if (this.options.subtype != null) {
- value._subtype = this.options.subtype;
- }
- }
- return value;
- }
- if (value instanceof Binary) {
- ret = new MongooseBuffer(value.value(true), [this.path, doc]);
- if (typeof value.sub_type !== 'number') {
- throw new CastError('Buffer', value, this.path, null, this);
- }
- ret._subtype = value.sub_type;
- return ret;
- }
- if (value == null || utils.isNonBuiltinObject(value)) {
- return this._castRef(value, doc, init);
- }
- }
- // documents
- if (value && value._id) {
- value = value._id;
- }
- if (value && value.isMongooseBuffer) {
- return value;
- }
- if (Buffer.isBuffer(value)) {
- if (!value || !value.isMongooseBuffer) {
- value = new MongooseBuffer(value, [this.path, doc]);
- if (this.options.subtype != null) {
- value._subtype = this.options.subtype;
- }
- }
- return value;
- }
- if (value instanceof Binary) {
- ret = new MongooseBuffer(value.value(true), [this.path, doc]);
- if (typeof value.sub_type !== 'number') {
- throw new CastError('Buffer', value, this.path, null, this);
- }
- ret._subtype = value.sub_type;
- return ret;
- }
- if (value === null) {
- return value;
- }
- const type = typeof value;
- if (
- type === 'string' || type === 'number' || Array.isArray(value) ||
- (type === 'object' && value.type === 'Buffer' && Array.isArray(value.data)) // gh-6863
- ) {
- if (type === 'number') {
- value = [value];
- }
- ret = new MongooseBuffer(value, [this.path, doc]);
- if (this.options.subtype != null) {
- ret._subtype = this.options.subtype;
- }
- return ret;
- }
- throw new CastError('Buffer', value, this.path, null, this);
- };
- /**
- * Sets the default [subtype](https://studio3t.com/whats-new/best-practices-uuid-mongodb/)
- * for this buffer. You can find a [list of allowed subtypes here](https://api.mongodb.com/python/current/api/bson/binary.html).
- *
- * #### Example:
- *
- * const s = new Schema({ uuid: { type: Buffer, subtype: 4 });
- * const M = db.model('M', s);
- * const m = new M({ uuid: 'test string' });
- * m.uuid._subtype; // 4
- *
- * @param {Number} subtype the default subtype
- * @return {SchemaType} this
- * @api public
- */
- SchemaBuffer.prototype.subtype = function(subtype) {
- this.options.subtype = subtype;
- return this;
- };
- /*!
- * ignore
- */
- function handleSingle(val) {
- return this.castForQuery(val);
- }
- SchemaBuffer.prototype.$conditionalHandlers =
- utils.options(SchemaType.prototype.$conditionalHandlers, {
- $bitsAllClear: handleBitwiseOperator,
- $bitsAnyClear: handleBitwiseOperator,
- $bitsAllSet: handleBitwiseOperator,
- $bitsAnySet: handleBitwiseOperator,
- $gt: handleSingle,
- $gte: handleSingle,
- $lt: handleSingle,
- $lte: handleSingle
- });
- /**
- * Casts contents for queries.
- *
- * @param {String} $conditional
- * @param {any} [value]
- * @api private
- */
- SchemaBuffer.prototype.castForQuery = function($conditional, val) {
- let handler;
- if (arguments.length === 2) {
- handler = this.$conditionalHandlers[$conditional];
- if (!handler) {
- throw new Error('Can\'t use ' + $conditional + ' with Buffer.');
- }
- return handler.call(this, val);
- }
- val = $conditional;
- const casted = this._castForQuery(val);
- return casted ? casted.toObject({ transform: false, virtuals: false }) : casted;
- };
- /*!
- * Module exports.
- */
- module.exports = SchemaBuffer;
|