2017-11-01 18:18:53 +03:00
|
|
|
var _debug = require('ghost-ignition').debug._base,
|
|
|
|
debug = _debug('ghost-query'),
|
2017-11-01 16:44:54 +03:00
|
|
|
_ = require('lodash');
|
2015-11-03 14:38:29 +03:00
|
|
|
|
|
|
|
module.exports = function (Bookshelf) {
|
|
|
|
var modelProto = Bookshelf.Model.prototype,
|
|
|
|
Model,
|
|
|
|
countQueryBuilder;
|
|
|
|
|
|
|
|
countQueryBuilder = {
|
|
|
|
tags: {
|
2018-01-25 19:54:28 +03:00
|
|
|
posts: function addPostCountToTags(model, options) {
|
2015-11-03 14:38:29 +03:00
|
|
|
model.query('columns', 'tags.*', function (qb) {
|
2015-11-16 20:09:27 +03:00
|
|
|
qb.count('posts.id')
|
|
|
|
.from('posts')
|
|
|
|
.leftOuterJoin('posts_tags', 'posts.id', 'posts_tags.post_id')
|
|
|
|
.whereRaw('posts_tags.tag_id = tags.id')
|
2015-11-20 15:04:49 +03:00
|
|
|
.as('count__posts');
|
2015-11-16 20:09:27 +03:00
|
|
|
|
2018-01-25 19:54:28 +03:00
|
|
|
if (options.context && options.context.public) {
|
2015-11-16 20:09:27 +03:00
|
|
|
// @TODO use the filter behavior for posts
|
|
|
|
qb.andWhere('posts.page', '=', false);
|
|
|
|
qb.andWhere('posts.status', '=', 'published');
|
|
|
|
}
|
|
|
|
});
|
|
|
|
}
|
|
|
|
},
|
|
|
|
users: {
|
2018-08-30 19:05:29 +03:00
|
|
|
posts: function addPostCountToUsers(model, options) {
|
2015-11-16 20:09:27 +03:00
|
|
|
model.query('columns', 'users.*', function (qb) {
|
|
|
|
qb.count('posts.id')
|
|
|
|
.from('posts')
|
2018-08-30 19:05:29 +03:00
|
|
|
.join('posts_authors', 'posts.id', 'posts_authors.post_id')
|
|
|
|
.whereRaw('posts_authors.author_id = users.id')
|
2015-11-20 15:04:49 +03:00
|
|
|
.as('count__posts');
|
2015-11-16 20:09:27 +03:00
|
|
|
|
2018-01-25 19:54:28 +03:00
|
|
|
if (options.context && options.context.public) {
|
2015-11-16 20:09:27 +03:00
|
|
|
// @TODO use the filter behavior for posts
|
|
|
|
qb.andWhere('posts.page', '=', false);
|
|
|
|
qb.andWhere('posts.status', '=', 'published');
|
|
|
|
}
|
2015-11-03 14:38:29 +03:00
|
|
|
});
|
|
|
|
}
|
|
|
|
}
|
|
|
|
};
|
|
|
|
|
|
|
|
Model = Bookshelf.Model.extend({
|
|
|
|
addCounts: function (options) {
|
|
|
|
if (!options) {
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
|
|
|
var tableName = _.result(this, 'tableName');
|
|
|
|
|
Sorted out the mixed usages of `include` and `withRelated` (#9425)
no issue
- this commit cleans up the usages of `include` and `withRelated`.
### API layer (`include`)
- as request parameter e.g. `?include=roles,tags`
- as theme API parameter e.g. `{{get .... include="author"}}`
- as internal API access e.g. `api.posts.browse({include: 'author,tags'})`
- the `include` notation is more readable than `withRelated`
- and it allows us to use a different easier format (comma separated list)
- the API utility transforms these more readable properties into model style (or into Ghost style)
### Model access (`withRelated`)
- e.g. `models.Post.findPage({withRelated: ['tags']})`
- driven by bookshelf
---
Commits explained.
* Reorder the usage of `convertOptions`
- 1. validation
- 2. options convertion
- 3. permissions
- the reason is simple, the permission layer access the model layer
- we have to prepare the options before talking to the model layer
- added `convertOptions` where it was missed (not required, but for consistency reasons)
* Use `withRelated` when accessing the model layer and use `include` when accessing the API layer
* Change `convertOptions` API utiliy
- API Usage
- ghost.api(..., {include: 'tags,authors'})
- `include` should only be used when calling the API (either via request or via manual usage)
- `include` is only for readability and easier format
- Ghost (Model Layer Usage)
- models.Post.findOne(..., {withRelated: ['tags', 'authors']})
- should only use `withRelated`
- model layer cannot read 'tags,authors`
- model layer has no idea what `include` means, speaks a different language
- `withRelated` is bookshelf
- internal usage
* include-count plugin: use `withRelated` instead of `include`
- imagine you outsource this plugin to git and publish it to npm
- `include` is an unknown option in bookshelf
* Updated `permittedOptions` in base model
- `include` is no longer a known option
* Remove all occurances of `include` in the model layer
* Extend `filterOptions` base function
- this function should be called as first action
- we clone the unfiltered options
- check if you are using `include` (this is a protection which could help us in the beginning)
- check for permitted and (later on default `withRelated`) options
- the usage is coming in next commit
* Ensure we call `filterOptions` as first action
- use `ghostBookshelf.Model.filterOptions` as first action
- consistent naming pattern for incoming options: `unfilteredOptions`
- re-added allowed options for `toJSON`
- one unsolved architecture problem:
- if you override a function e.g. `edit`
- then you should call `filterOptions` as first action
- the base implementation of e.g. `edit` will call it again
- future improvement
* Removed `findOne` from Invite model
- no longer needed, the base implementation is the same
2018-02-15 12:53:53 +03:00
|
|
|
if (options.withRelated && options.withRelated.indexOf('count.posts') > -1) {
|
|
|
|
// remove post_count from withRelated
|
2015-11-20 15:04:49 +03:00
|
|
|
options.withRelated = _.pull([].concat(options.withRelated), 'count.posts');
|
2015-11-03 14:38:29 +03:00
|
|
|
|
|
|
|
// Call the query builder
|
2018-01-25 19:54:28 +03:00
|
|
|
countQueryBuilder[tableName].posts(this, options);
|
2015-11-03 14:38:29 +03:00
|
|
|
}
|
|
|
|
},
|
|
|
|
fetch: function () {
|
|
|
|
this.addCounts.apply(this, arguments);
|
|
|
|
|
2017-11-01 18:18:53 +03:00
|
|
|
// Useful when debugging no. database queries, GQL, etc
|
|
|
|
// To output this, use DEBUG=ghost:*,ghost-query
|
|
|
|
if (_debug.enabled('ghost-query')) {
|
|
|
|
debug('QUERY', this.query().toQuery());
|
|
|
|
}
|
2015-11-12 17:21:04 +03:00
|
|
|
|
2015-11-03 14:38:29 +03:00
|
|
|
// Call parent fetch
|
|
|
|
return modelProto.fetch.apply(this, arguments);
|
|
|
|
},
|
|
|
|
fetchAll: function () {
|
|
|
|
this.addCounts.apply(this, arguments);
|
|
|
|
|
2017-11-01 18:18:53 +03:00
|
|
|
// Useful when debugging no. database queries, GQL, etc
|
|
|
|
// To output this, use DEBUG=ghost:*,ghost-query
|
|
|
|
if (_debug.enabled('ghost-query')) {
|
|
|
|
debug('QUERY', this.query().toQuery());
|
|
|
|
}
|
2015-11-12 17:21:04 +03:00
|
|
|
|
2015-11-03 14:38:29 +03:00
|
|
|
// Call parent fetchAll
|
|
|
|
return modelProto.fetchAll.apply(this, arguments);
|
2015-11-20 15:04:49 +03:00
|
|
|
},
|
|
|
|
|
2018-02-14 19:32:11 +03:00
|
|
|
serialize: function serialize(options) {
|
|
|
|
var attrs = modelProto.serialize.call(this, options),
|
|
|
|
countRegex = /^(count)(__)(.*)$/;
|
|
|
|
|
2015-11-20 15:04:49 +03:00
|
|
|
_.forOwn(attrs, function (value, key) {
|
|
|
|
var match = key.match(countRegex);
|
|
|
|
if (match) {
|
|
|
|
attrs[match[1]] = attrs[match[1]] || {};
|
|
|
|
attrs[match[1]][match[3]] = value;
|
|
|
|
delete attrs[key];
|
|
|
|
}
|
|
|
|
});
|
|
|
|
|
|
|
|
return attrs;
|
2015-11-03 14:38:29 +03:00
|
|
|
}
|
|
|
|
});
|
|
|
|
|
|
|
|
Bookshelf.Model = Model;
|
|
|
|
};
|