keystone/lib/schemaPlugins/track.js

Web Application Framework and Admin GUI / Content Management System built on Express.js and Mongoose

var _ = require('lodash');
var keystone = require('../../');
var Types = require('../fieldTypes');

/**
 * List track option
 *
 * When enabled, it tracks when a document are created/updated,
 * as well as the user who created/updated it.
 */

module.exports = function track () {

	var list = this;
	var options = list.get('track');
	var userModel = keystone.get('user model');

	if (!options) {
		// if the track setting is falsy, bail
		return;
	}

	var defaultOptions = {
		createdAt: false,
		createdBy: false,
		updatedAt: false,
		updatedBy: false,
	};
	var fields = {};

	// ensure track is a boolean or an object
	if (!_.isBoolean(options) && !_.isObject(options)) {
		throw new Error('Invalid List "track" option for ' + list.key + '\n'
			+ '"track" must be a boolean or an object.\n\n'
			+ 'See http://keystonejs.com/docs/database/#lists-options for more information.');
	}

	if (_.isBoolean(options)) {
		// shorthand: { track: true } sets all tracked fields to true
		options = {
			createdAt: true,
			createdBy: true,
			updatedAt: true,
			updatedBy: true,
		};
	}

	// if all track fields are set to false, then there's nothing to track
	if (!options.createdAt && !options.createdBy && !options.updatedAt && !options.updatedBy) {
		return;
	}

	// merge user options with default options
	options = _.extend({}, defaultOptions, options);

	// validate option fields
	_.forEach(options, function (value, key) {

		var fieldName;

		// make sure the key isn't already defined as a field
		if (_.has(list.fields, key)) {
			throw new Error('Invalid List "track" option for ' + list.key + '\n'
				+ '"' + key + '" is already defined in the Schema.');
		}

		// make sure it's a valid track option field
		if (_.has(defaultOptions, key)) {

			// make sure the option field value is either a boolean or a string
			if (!_.isBoolean(value) && typeof value !== 'string') {
				throw new Error('Invalid List "track" option for ' + list.key + '\n'
					+ '"' + key + '" must be a boolean or a string.\n\n'
					+ 'See http://keystonejs.com/docs/database/#lists-options for more information.');
			}

			if (value) {
				// determine
				fieldName = value === true ? key : value;
				options[key] = fieldName;
				list.map(key, fieldName);

				switch (key) {
					case 'createdAt':
					case 'updatedAt':
						fields[fieldName] = { type: Date, noedit: true, collapse: true, index: true };
						break;

					case 'createdBy':
					case 'updatedBy':
						fields[fieldName] = { type: Types.Relationship, ref: userModel, noedit: true, collapse: true, index: true };
						break;
				}
			}
		} else {
			throw new Error('Invalid List "track" option for ' + list.key + '\n'
				+ 'valid field options are "createdAt", "createdBy", "updatedAt", an "updatedBy".\n\n'
				+ 'See http://keystonejs.com/docs/database/#lists-options for more information.');
		}

	});

	// add track fields to schema
	list.add('Meta', fields);

	list.tracking = options;

	// add the pre-save schema plugin
	list.schema.pre('save', function (next) {

		var now = new Date();

		// set createdAt/createdBy on new docs
		if (this.isNew) {
			if (options.createdAt && !this.get(options.createdAt)) {
				this.set(options.createdAt, now);
			}
			if (options.createdBy && this._req_user && !this.get(options.createdBy)) {
				this.set(options.createdBy, this._req_user._id);
			}
		}

		// set updatedAt/updatedBy when doc is modified
		if (this.isNew || this.isModified()) {
			if (options.updatedAt) {
				this.set(options.updatedAt, now);
			}
			if (options.updatedBy && this._req_user) {
				this.set(options.updatedBy, this._req_user._id);
			}
		}

		next();

	});

};