|
|
@@ -0,0 +1,176 @@
|
|
|
+import loggerFactory from '~/utils/logger';
|
|
|
+import { isSearchError } from '../models/vo/error-search';
|
|
|
+
|
|
|
+const logger = loggerFactory('growi:routes:search');
|
|
|
+
|
|
|
+/**
|
|
|
+ * @swagger
|
|
|
+ *
|
|
|
+ * components:
|
|
|
+ * schemas:
|
|
|
+ * ElasticsearchResult:
|
|
|
+ * description: Elasticsearch result v1
|
|
|
+ * type: object
|
|
|
+ * properties:
|
|
|
+ * meta:
|
|
|
+ * type: object
|
|
|
+ * properties:
|
|
|
+ * took:
|
|
|
+ * type: number
|
|
|
+ * description: Time Elasticsearch took to execute a search(milliseconds)
|
|
|
+ * example: 34
|
|
|
+ * total:
|
|
|
+ * type: number
|
|
|
+ * description: Number of documents matching search criteria
|
|
|
+ * example: 2
|
|
|
+ * results:
|
|
|
+ * type: number
|
|
|
+ * description: Actual array length of search results
|
|
|
+ * example: 2
|
|
|
+ *
|
|
|
+ */
|
|
|
+module.exports = function(crowi, app) {
|
|
|
+ // var debug = require('debug')('growi:routes:search')
|
|
|
+ const ApiResponse = require('../util/apiResponse');
|
|
|
+ const ApiPaginate = require('../util/apiPaginate');
|
|
|
+
|
|
|
+ const actions: any = {};
|
|
|
+ const api: any = {};
|
|
|
+
|
|
|
+ actions.searchPage = function(req, res) {
|
|
|
+ const keyword = req.query.q || null;
|
|
|
+
|
|
|
+ return res.render('search', {
|
|
|
+ q: keyword,
|
|
|
+ });
|
|
|
+ };
|
|
|
+
|
|
|
+ /**
|
|
|
+ * @swagger
|
|
|
+ *
|
|
|
+ * /search:
|
|
|
+ * get:
|
|
|
+ * tags: [Search, CrowiCompatibles]
|
|
|
+ * operationId: searchPages
|
|
|
+ * summary: /search
|
|
|
+ * description: Search pages
|
|
|
+ * parameters:
|
|
|
+ * - in: query
|
|
|
+ * name: q
|
|
|
+ * schema:
|
|
|
+ * type: string
|
|
|
+ * description: keyword
|
|
|
+ * example: daily report
|
|
|
+ * required: true
|
|
|
+ * - in: query
|
|
|
+ * name: path
|
|
|
+ * schema:
|
|
|
+ * $ref: '#/components/schemas/Page/properties/path'
|
|
|
+ * - in: query
|
|
|
+ * name: offset
|
|
|
+ * schema:
|
|
|
+ * $ref: '#/components/schemas/V1PaginateResult/properties/meta/properties/offset'
|
|
|
+ * - in: query
|
|
|
+ * name: limit
|
|
|
+ * schema:
|
|
|
+ * $ref: '#/components/schemas/V1PaginateResult/properties/meta/properties/limit'
|
|
|
+ * responses:
|
|
|
+ * 200:
|
|
|
+ * description: Succeeded to get list of pages.
|
|
|
+ * content:
|
|
|
+ * application/json:
|
|
|
+ * schema:
|
|
|
+ * properties:
|
|
|
+ * ok:
|
|
|
+ * $ref: '#/components/schemas/V1Response/properties/ok'
|
|
|
+ * meta:
|
|
|
+ * $ref: '#/components/schemas/ElasticsearchResult/properties/meta'
|
|
|
+ * totalCount:
|
|
|
+ * type: integer
|
|
|
+ * description: total count of pages
|
|
|
+ * example: 35
|
|
|
+ * data:
|
|
|
+ * type: array
|
|
|
+ * items:
|
|
|
+ * $ref: '#/components/schemas/Page'
|
|
|
+ * description: page list
|
|
|
+ * 403:
|
|
|
+ * $ref: '#/components/responses/403'
|
|
|
+ * 500:
|
|
|
+ * $ref: '#/components/responses/500'
|
|
|
+ */
|
|
|
+ /**
|
|
|
+ * @api {get} /search search page
|
|
|
+ * @apiName Search
|
|
|
+ * @apiGroup Search
|
|
|
+ *
|
|
|
+ * @apiParam {String} q keyword
|
|
|
+ * @apiParam {String} path
|
|
|
+ * @apiParam {String} offset
|
|
|
+ * @apiParam {String} limit
|
|
|
+ */
|
|
|
+ api.search = async function(req, res) {
|
|
|
+ const user = req.user;
|
|
|
+ const {
|
|
|
+ q = null, nq = null, type = null, sort = null, order = null,
|
|
|
+ } = req.query;
|
|
|
+ let paginateOpts;
|
|
|
+
|
|
|
+ try {
|
|
|
+ paginateOpts = ApiPaginate.parseOptionsForElasticSearch(req.query);
|
|
|
+ }
|
|
|
+ catch (e) {
|
|
|
+ res.json(ApiResponse.error(e));
|
|
|
+ }
|
|
|
+
|
|
|
+ if (q === null || q === '') {
|
|
|
+ return res.json(ApiResponse.error('The param "q" should not empty.'));
|
|
|
+ }
|
|
|
+
|
|
|
+ const { searchService } = crowi;
|
|
|
+ if (!searchService.isReachable) {
|
|
|
+ return res.json(ApiResponse.error('SearchService is not reachable.'));
|
|
|
+ }
|
|
|
+
|
|
|
+ let userGroups = [];
|
|
|
+ if (user != null) {
|
|
|
+ const UserGroupRelation = crowi.model('UserGroupRelation');
|
|
|
+ userGroups = await UserGroupRelation.findAllUserGroupIdsRelatedToUser(user);
|
|
|
+ }
|
|
|
+
|
|
|
+ const searchOpts = {
|
|
|
+ ...paginateOpts, type, sort, order,
|
|
|
+ };
|
|
|
+
|
|
|
+ let searchResult;
|
|
|
+ let delegatorName;
|
|
|
+ try {
|
|
|
+ const keyword = decodeURIComponent(q);
|
|
|
+ const nqName = nq ?? decodeURIComponent(nq);
|
|
|
+ [searchResult, delegatorName] = await searchService.searchKeyword(keyword, nqName, user, userGroups, searchOpts);
|
|
|
+ }
|
|
|
+ catch (err) {
|
|
|
+ logger.error('Failed to search', err);
|
|
|
+
|
|
|
+ if (isSearchError(err)) {
|
|
|
+ const { unavailableTermsKeys } = err;
|
|
|
+ return res.json(ApiResponse.error(err, 400, { unavailableTermsKeys }));
|
|
|
+ }
|
|
|
+
|
|
|
+ return res.json(ApiResponse.error(err));
|
|
|
+ }
|
|
|
+
|
|
|
+ let result;
|
|
|
+ try {
|
|
|
+ result = await searchService.formatSearchResult(searchResult, delegatorName, user, userGroups);
|
|
|
+ }
|
|
|
+ catch (err) {
|
|
|
+ logger.error(err);
|
|
|
+ return res.json(ApiResponse.error(err));
|
|
|
+ }
|
|
|
+ return res.json(ApiResponse.success(result));
|
|
|
+ };
|
|
|
+
|
|
|
+ actions.api = api;
|
|
|
+ return actions;
|
|
|
+};
|