7 |
--------------------------------------------------------------------------------
/client/assets/img/iconic/menu.svg:
--------------------------------------------------------------------------------
1 |
2 |
--------------------------------------------------------------------------------
/client/assets/js/services/services.js:
--------------------------------------------------------------------------------
1 | // Module initialization
2 | angular.module('lucidworksView.services', [
3 | 'lucidworksView.services.apiBase',
4 | 'lucidworksView.services.auth',
5 | 'lucidworksView.services.authInterceptor',
6 | 'lucidworksView.services.config',
7 | 'lucidworksView.services.document',
8 | 'lucidworksView.services.landingPage',
9 | 'lucidworksView.services.query',
10 | 'lucidworksView.services.queryData',
11 | 'lucidworksView.services.signals',
12 | 'lucidworksView.services.url',
13 | 'lucidworksView.services.localParams',
14 | 'lucidworksView.services.clientStats'
15 | ]);
16 |
--------------------------------------------------------------------------------
/NOTICE:
--------------------------------------------------------------------------------
1 |
2 | Copyright 2016 Lucidworks Inc.
3 |
4 | Licensed under the Apache License, Version 2.0 (the "License");
5 | you may not use this file except in compliance with the License.
6 | You may obtain a copy of the License at
7 |
8 | http://www.apache.org/licenses/LICENSE-2.0
9 |
10 | Unless required by applicable law or agreed to in writing, software
11 | distributed under the License is distributed on an "AS IS" BASIS,
12 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | See the License for the specific language governing permissions and
14 | limitations under the License.
15 |
--------------------------------------------------------------------------------
/client/assets/components/document/document_EXAMPLE/document_EXAMPLE.html:
--------------------------------------------------------------------------------
1 |
2 |
29 |
--------------------------------------------------------------------------------
/client/assets/components/document/document_slack/document_slack.js:
--------------------------------------------------------------------------------
1 | (function() {
2 | 'use strict';
3 |
4 | angular
5 | .module('lucidworksView.components.document_slack', ['lucidworksView.services.signals'])
6 | .directive('documentSlack', documentSlack);
7 |
8 | function documentSlack() {
9 | 'ngInject';
10 | var directive = {
11 | restrict: 'EA',
12 | templateUrl: 'assets/components/document/document_slack/document_slack.html',
13 | scope: true,
14 | controller: Controller,
15 | controllerAs: 'vm',
16 | bindToController: {
17 | doc: '=',
18 | position: '=',
19 | highlight: '='
20 | }
21 | };
22 |
23 | return directive;
24 |
25 | }
26 |
27 |
28 | function Controller($filter, DocumentService) {
29 | 'ngInject';
30 | var vm = this;
31 | var templateFields = ['text', 'channel', 'user', 'timestamp', 'id'];
32 | vm.postSignal = postSignal;
33 | vm.getTemplateDisplayFieldName = getTemplateDisplayFieldName;
34 |
35 | activate();
36 |
37 | function activate() {
38 | vm.doc = processDocument(vm.doc);
39 | }
40 |
41 | function processDocument(doc) {
42 | //set properties needed for display
43 | doc._templateDisplayFields = DocumentService.setTemplateDisplayFields(doc, templateFields);
44 |
45 | doc._templateDisplayFields.timestamp_Formatted = $filter('date')(vm.doc._templateDisplayFields.timestamp, 'M/d/yy h:mm:ss a');
46 | // For multivalued fields
47 | doc._templateDisplayFields.text = _.isArray(doc._templateDisplayFields.text) ? _.join(doc._templateDisplayFields.text, ' ') : doc._templateDisplayFields.text;
48 | doc._templateDisplayFields._lw_id_decoded = DocumentService.decodeFieldValue(doc._templateDisplayFields, 'id');
49 |
50 | //set properties needed for signals
51 | doc._signals = DocumentService.setSignalsProperties(doc, vm.position);
52 |
53 | return doc;
54 | }
55 |
56 | function postSignal(options){
57 | DocumentService.postSignal(vm.doc._signals, options);
58 | }
59 |
60 | function getTemplateDisplayFieldName(field){
61 | return DocumentService.getTemplateDisplayFieldName(vm.doc, field);
62 | }
63 | }
64 | })();
65 |
--------------------------------------------------------------------------------
/win64/installer/Lucidworks View Windows Installer Creation Guide.md:
--------------------------------------------------------------------------------
1 | # Lucidworks View Windows Installer Creation Guide
2 |
3 | ## How to build the lucidworks view windows installer:
4 |
5 | Do the following steps from a windows box
6 |
7 | 1. Pull the latest changes from lucidworks-view repository and build the tar.gz file from Linux with option `--buildTarget=win64`. (See the README.md for build instructions on how to build lucidworks-view tar ball or download the latest tar at )
8 |
9 | 2. Move the tar build on Linux and Untar on Windows to a directory we will refer to as **VIEW_HOME**.
10 |
11 | **Note:** Run your extraction utility as an administrator in order to properly keep the symlinks intact. You can do this by opening the extraction utility (7zip) by right clicking on the menu icon in programs and selecting run as administrator.
12 |
13 | 3. Get latest version of **inno setup** installed
14 |
15 | 4. Launch **VIEW_HOME**\installer\create-installer.cmd
16 | - This will create the Installer `Lucidworks-View-Installer.exe` in **VIEW_HOME**\installer\Output directory.
17 |
18 | ## How to use the Windows Installer:
19 |
20 | * Launch the `Lucidworks-View-Installer.exe` **as an administrator**.
21 |
22 | **Note:** At the end of the installer, it attempts to run npm installs. If the install cmd script closes too fast, you probably didn't have admin permissions and it abruptly failed. Right click on the install.cmd and run as administrator if that happens.
23 |
24 | ## How to Uninstall the Lucidworks-view service
25 |
26 | * To uninstall the service simply run the **VIEW_HOME**\uninstall-service.cmd as administrator
27 |
28 | ## Common issues:
29 |
30 | - File could not be access, file in use
31 |
32 | - Or you have one of the installer files open with a CMD or locked somewhere. Close it and try again.
33 |
34 | - Services didn't install.
35 |
36 | - You probably forgot to Run installer "as administrator"
37 |
38 | - Services won't start.
39 |
40 | - Did you enter correct password when prompted for the user that is launch the service?
41 |
42 | - Don't forget windows domain if needed. If my domain is **CORPORATE** then **"CORPORATE\nicholas"**
43 |
--------------------------------------------------------------------------------
/client/assets/js/app.js:
--------------------------------------------------------------------------------
1 | (function () {
2 | 'use strict';
3 |
4 | angular
5 | .module('lucidworksView', [
6 | 'ui.router',
7 | 'ngAnimate',
8 | 'ngSanitize',
9 |
10 | // Foundation
11 | 'foundation',
12 | 'foundation.dynamicRouting',
13 | 'foundation.dynamicRouting.animations',
14 |
15 | // Libraries
16 | 'ngOrwell',
17 | 'rison',
18 | 'MassAutoComplete',
19 |
20 | // Fusion Seed App
21 | 'lucidworksView.components',
22 | 'lucidworksView.services',
23 | 'lucidworksView.controllers'
24 | ])
25 | .constant('_', window._) //eslint-disable-line
26 | .config(config)
27 | .run(run);
28 |
29 | /**
30 | * Main app config
31 | *
32 | * @param {Provider} $urlRouterProvider Provider for url
33 | * @param {Provider} $httpProvider Provider for http
34 | * @param {Provider} $locationProvider Provider for location
35 | * @param {Provider} ApiBaseProvider Provider for ApiBase
36 | * @param {Provider} ConfigServiceProvider Provider for ConfigService
37 | */
38 | function config($urlRouterProvider, $httpProvider, $locationProvider, ApiBaseProvider,
39 | ConfigServiceProvider, $windowProvider) {
40 | 'ngInject';
41 | $urlRouterProvider.otherwise('/search');
42 | $httpProvider.interceptors.push('AuthInterceptor');
43 | $httpProvider.defaults['withCredentials'] = true; //eslint-disable-line
44 |
45 | $locationProvider.html5Mode({
46 | enabled: true,
47 | requireBase: false
48 | });
49 |
50 | $locationProvider.hashPrefix('!');
51 | // If using a proxy use the same url.
52 | if (ConfigServiceProvider.config.use_proxy) {
53 | var $window = $windowProvider.$get();
54 | ApiBaseProvider.setEndpoint($window.location.protocol + '//' + $window.location.host +
55 | '/');
56 | } else {
57 | ApiBaseProvider.setEndpoint(ConfigServiceProvider.getFusionUrl());
58 | }
59 | }
60 |
61 | /**
62 | * Main app run time
63 | *
64 | * @param {Service} $document Document service
65 | */
66 | function run($document, $rootScope, ConfigService) {
67 | 'ngInject';
68 | $rootScope.title = ConfigService.config.search_app_title;
69 | }
70 | })();
71 |
--------------------------------------------------------------------------------
/karma.conf.js:
--------------------------------------------------------------------------------
1 | /*global module */
2 | // Karma configuration
3 | // Generated on Tue Jan 19 2016 21:47:15 GMT+0530 (IST)
4 |
5 | module.exports = function(config) {
6 | config.set({
7 |
8 | // base path that will be used to resolve all patterns (eg. files, exclude)
9 | basePath: '',
10 |
11 |
12 | // frameworks to use
13 | // available frameworks: https://npmjs.org/browse/keyword/karma-adapter
14 | frameworks: ['jasmine'],
15 |
16 |
17 | // list of files / patterns to load in the browser
18 | files: [
19 | 'build/assets/js/foundation.js',
20 | 'build/assets/js/templates.js',
21 | 'build/assets/js/routes.js',
22 | // 'build/assets/js/FUSION_CONFIG.js',
23 | 'bower_components/angular-mocks/angular-mocks.js',
24 | 'build/assets/js/app.js',
25 | 'node_modules/ng-describe/dist/ng-describe.js',
26 | 'tests/test_config.js',
27 | 'tests/**/*Test.js'
28 | ],
29 |
30 | // list of files to exclude
31 | exclude: [
32 | ],
33 |
34 |
35 | // preprocess matching files before serving them to the browser
36 | // available preprocessors: https://npmjs.org/browse/keyword/karma-preprocessor
37 | preprocessors: {
38 | },
39 |
40 |
41 | // test results reporter to use
42 | // possible values: 'dots', 'progress'
43 | // available reporters: https://npmjs.org/browse/keyword/karma-reporter
44 | reporters: ['progress'],
45 |
46 |
47 | // web server port
48 | port: 9876,
49 |
50 |
51 | // enable / disable colors in the output (reporters and logs)
52 | colors: true,
53 |
54 |
55 | // level of logging
56 | // possible values: config.LOG_DISABLE || config.LOG_ERROR || config.LOG_WARN || config.LOG_INFO || config.LOG_DEBUG
57 | logLevel: config.LOG_INFO,
58 |
59 |
60 | // enable / disable watching file and executing tests whenever any file changes
61 | autoWatch: true,
62 |
63 |
64 | // start these browsers
65 | // available browser launchers: https://npmjs.org/browse/keyword/karma-launcher
66 | browsers: ['Chrome'],
67 |
68 |
69 | // Continuous Integration mode
70 | // if true, Karma captures browsers, runs the tests and exits
71 | singleRun: false,
72 |
73 | // Concurrency level
74 | // how many browser should be started simultaneous
75 | concurrency: Infinity
76 | });
77 | };
78 |
--------------------------------------------------------------------------------
/win64/installer/inno-setup-installer.iss:
--------------------------------------------------------------------------------
1 | ; Script generated by the Inno Setup Script Wizard.
2 | ; SEE THE DOCUMENTATION FOR DETAILS ON CREATING INNO SETUP SCRIPT FILES!
3 |
4 | #define MyAppName "Lucidworks View"
5 | #define MyAppVersion "1.3.0"
6 | #define MyAppPublisher "Lucidworks"
7 | #define MyAppURL "https://www.lucidworks.com/products/view"
8 | #define MyAppExeName "view.cmd"
9 |
10 | [Setup]
11 | ; NOTE: The value of AppId uniquely identifies this application.
12 | ; Do not use the same AppId value in installers for other applications.
13 | ; (To generate a new GUID, click Tools | Generate GUID inside the IDE.)
14 | AppId={{088A54F9-BABA-4F09-A288-0F8BB4DD9E54}
15 | AppName={#MyAppName}
16 | AppVersion={#MyAppVersion}
17 | ;AppVerName={#MyAppName} {#MyAppVersion}
18 | AppPublisher={#MyAppPublisher}
19 | AppPublisherURL={#MyAppURL}
20 | AppSupportURL={#MyAppURL}
21 | AppUpdatesURL={#MyAppURL}
22 | DefaultDirName=\lucidworks-view
23 | DefaultGroupName={#MyAppName}
24 | DisableProgramGroupPage=yes
25 | OutputBaseFilename=Lucidworks-View-Installer
26 | SetupIconFile={#SourcePath}\Lucidworks-Glyph.ico
27 | Compression=lzma
28 | SolidCompression=yes
29 |
30 | [Registry]
31 | Root: HKLM; Subkey: "SYSTEM\CurrentControlSet\Control\Session Manager\Environment"; ValueType:expandsz; ValueName:"PATH"; ValueData:"{olddata};{app}\lib\nodejs"; Flags: preservestringtype
32 | Root: HKLM; Subkey: "SYSTEM\CurrentControlSet\Control\Session Manager\Environment"; ValueType:expandsz; ValueName:"PATH"; ValueData:"{olddata};{app}\node_modules\.bin"; Flags: preservestringtype
33 |
34 | [Languages]
35 | Name: "english"; MessagesFile: "compiler:Default.isl"
36 |
37 | [Files]
38 | Source: "{#SourcePath}\..\*"; Excludes: "\installer"; DestDir: "{app}"; Flags: ignoreversion recursesubdirs createallsubdirs
39 | ; NOTE: Don't use "Flags: ignoreversion" on any shared system files
40 |
41 | [Icons]
42 | Name: "{group}\Uninstall Lucidworks View"; Filename: "{uninstallexe}"
43 |
44 | [Code]
45 | procedure CurPageChanged(CurPageID: Integer);
46 | var
47 | ErrorCode : Integer ;
48 | begin
49 | if CurPageID = wpFinished then
50 | ShellExecAsOriginalUser('', ExpandConstant('{app}\install.cmd'), '', '',SW_SHOWNORMAL, ewNoWait, ErrorCode);
51 | end;
52 |
53 | [Run]
54 | Filename: "{app}\getting-started-on-windows.md"; Description: "View the README file"; Flags: postinstall shellexec skipifsilent
55 |
--------------------------------------------------------------------------------
/gulp/serve.js:
--------------------------------------------------------------------------------
1 | /*eslint-env node*/
2 | var log = require('connect-logger');
3 | var argv = require('yargs').argv;
4 | var gulp = require('gulp');
5 | var browserSync = require('browser-sync').create();
6 | var historyFallback = require('connect-history-api-fallback');
7 | var proxyMiddleware = require('http-proxy-middleware');
8 |
9 | // Static Server + watching build and live reload accross all the browsers
10 | gulp.task('browsersync', ['build'], function() {
11 | var fusionConfig = require('../tmp/fusion_config');
12 | var openPath = getOpenPath();
13 |
14 | var proxyConfig = {
15 | target: fusionConfig.host+':'+fusionConfig.port
16 | };
17 |
18 | // Allow self signed proxys to pass through with setting.
19 | if(fusionConfig.proxy_allow_self_signed_cert === true) {
20 | proxyConfig['secure'] = false;
21 | }
22 |
23 | // build middleware.
24 | var middleware = [
25 | log(),
26 | proxyMiddleware('/api', proxyConfig),
27 | historyFallback({ index: '/' + openPath + '/index.html' })
28 | ];
29 |
30 | var browserSyncConfig = {
31 | baseDir: './build/',
32 | middleware: middleware
33 | };
34 |
35 | if(fusionConfig.use_https === true){
36 | browserSyncConfig['https'] = true;
37 | if(fusionConfig.hasOwnProperty('https') && fusionConfig.https.hasOwnProperty('key') && fusionConfig.https.hasOwnProperty('cert')){
38 | browserSyncConfig['https'] = {
39 | key: fusionConfig.https.key,
40 | cert: fusionConfig.https.cert
41 | };
42 | }
43 | }
44 |
45 | var serverPort = 3000;
46 | if(fusionConfig.server_port && fusionConfig.server_port !== false){
47 | serverPort = fusionConfig.server_port;
48 | }
49 |
50 | browserSync.init({
51 | server: browserSyncConfig,
52 | ghostMode: false,
53 | ui: false,
54 | port: serverPort
55 | });
56 |
57 | // gulp.watch("app/scss/*.scss", ['sass']);
58 | // gulp.watch("app/*.html").on('change', browserSync.reload);
59 | });
60 |
61 | //Reloads all the browsers
62 | gulp.task('reloadBrowsers', function(cb){
63 | browserSync.reload();
64 | //callback so sequences are aware when this is done
65 | cb();
66 | });
67 |
68 | gulp.task('serve', ['browsersync', 'watch']);
69 |
70 | gulp.task('default', ['browsersync', 'watch']);
71 |
72 | function getOpenPath() {
73 | var src = argv.open || '';
74 | if (!src) {
75 | return '.';
76 | }
77 | return src;
78 | }
79 |
--------------------------------------------------------------------------------
/client/assets/components/searchBox/_searchBox.scss:
--------------------------------------------------------------------------------
1 | /*
2 | SEARCH BOX
3 | ----------
4 |
5 | The search box lets you search content, and see typeahead results.
6 | */
7 |
8 | /// @Lucidworks-view.settings
9 | // Search-box
10 | $search-box-typeahead-border: 1px solid #ddd;
11 | $search-box-typeahead-background: $body-background;
12 | $search-box-typeahead-text-color: grayscale($primary-color);
13 | $search-box-typeahead-selected-background: $gray-light;
14 | $search-box-typeahead-highlight-color: $success-color;
15 | $search-box-empty-content: '';
16 |
17 | @include exports(search-box) {
18 |
19 | .search-box {
20 | > span {position:relative;display: block;}
21 | .query-input {
22 | margin-bottom: 0px;
23 | color: $search-box-typeahead-text-color;
24 | }
25 | .ac-container {z-index: 1000;backface-visibility: hidden;transform: translate3d(0, 0, 0);}
26 |
27 | .ac-menu,.no-results-message {
28 | background: $search-box-typeahead-background;
29 | border: $search-box-typeahead-border;
30 | color: $search-box-typeahead-text-color;
31 | list-style-type: none;
32 | margin: 0;
33 | padding: 4px;
34 | text-align:left;
35 | }
36 | .no-results-message {
37 | font-size:0.9rem;
38 | position:absolute;
39 | top:100%;
40 | width: 100%;
41 | padding: 8px;
42 | font-style: italic;
43 | }
44 |
45 | .ac-menu-item.ac-state-focus a {background: $search-box-typeahead-selected-background;}
46 | .ac-menu-item a {
47 | padding: .5rem 0 .5rem .5rem;
48 | color:inherit;
49 | display: block;
50 | position:relative;
51 | //extra element for title tag
52 | .title-wrapper {
53 | padding-right:1.5rem;
54 | white-space: nowrap;
55 | overflow: hidden;
56 | text-overflow: ellipsis;
57 | }
58 | &:hover {color: $search-box-typeahead-highlight-color;background: $search-box-typeahead-selected-background;}
59 | &:active {background: $search-box-typeahead-selected-background;}
60 | &:after {
61 | content:$search-box-empty-content;
62 | position:absolute;
63 | right:0;
64 | top:8px;
65 | background-image: url('../img/iconic/expand.svg');
66 | transform: scaleX(-1);
67 | background-repeat: no-repeat;
68 | width: 1.5rem;
69 | height: 1.3rem;
70 | }
71 | .highlight {
72 | color: $search-box-typeahead-highlight-color;
73 | }
74 | }
75 | }
76 | }
77 |
--------------------------------------------------------------------------------
/client/assets/js/services/DocumentService.js:
--------------------------------------------------------------------------------
1 | (function () {
2 | 'use strict';
3 |
4 | angular
5 | .module('lucidworksView.services.document', [])
6 | .factory('DocumentService', DocumentService);
7 |
8 | function DocumentService(PaginateService, SignalsService) {
9 | 'ngInject';
10 |
11 | return {
12 | setSignalsProperties: setSignalsProperties,
13 | setTemplateDisplayFields: setTemplateDisplayFields,
14 | postSignal: postSignal,
15 | getTemplateDisplayFieldName: getTemplateDisplayFieldName,
16 | decodeFieldValue: decodeFieldValue
17 | };
18 |
19 | function setSignalsProperties(doc,position) {
20 | var signalsProperties = {};
21 | signalsProperties.signals_doc_id = SignalsService.getSignalsDocumentId(doc);
22 | signalsProperties.position = position;
23 | signalsProperties.page = PaginateService.getNormalizedCurrentPage();
24 |
25 | return signalsProperties;
26 | }
27 |
28 | function setTemplateDisplayFields(doc,fieldsList) {
29 | var displayFields = {};
30 | //TODO: refactor this
31 | _.forEach(fieldsList,function(field) {
32 | var fieldValue = _.get(doc,field+'_s')
33 | || _.get(doc,field+'_l')
34 | || _.get(doc,field+'_dt')
35 | || _.get(doc,field+'_t')
36 | || _.get(doc,field);
37 | displayFields[field] = _.isArray(fieldValue) ? fieldValue[0] : fieldValue;
38 | });
39 |
40 | return displayFields;
41 | }
42 |
43 | function postSignal(_signals, options){
44 | var paramsObj = {
45 | params: {
46 | position: _signals.position,
47 | page: _signals.page
48 | }
49 | };
50 | _.defaultsDeep(paramsObj, options);
51 | SignalsService.postClickSignal(_signals.signals_doc_id, paramsObj);
52 | }
53 |
54 | function getTemplateDisplayFieldName(doc, field){
55 | if(_.has(doc, field+'_s')){
56 | return field + '_s';
57 | } else if (_.has(doc, field+'_l')){
58 | return field + '_l';
59 | } else if (_.has(doc, field+'_dt')){
60 | return field + '_dt';
61 | } else if (_.has(doc, field+'_t')){
62 | return field + '_t';
63 | }
64 | return field;
65 | }
66 |
67 | function decodeFieldValue(doc, field){
68 | if(_.has(doc, field) && _.isArray(doc[field])){
69 | var x = _.has(doc, field + '[0]') ? decodeURIComponent(doc[field]) : doc[field];
70 | return x;
71 | }
72 | var y = doc[field] ? decodeURIComponent(doc[field]) : doc[field];
73 | return y;
74 | }
75 | }
76 | })();
77 |
--------------------------------------------------------------------------------
/client/assets/components/document/document_default/document_default.html:
--------------------------------------------------------------------------------
1 |
29 |
30 |
31 |
32 |
33 |
34 |
35 |
36 |
37 |
38 |
39 |
40 |
41 |
42 |
43 |
44 |
45 |
46 |
47 |
48 |
49 |
50 |
51 | {{::field}}:
52 |
53 |
54 |
55 |
56 |
57 |
58 |
--------------------------------------------------------------------------------
/client/assets/components/field/field.js:
--------------------------------------------------------------------------------
1 | (function () {
2 | angular.module('lucidworksView.components.field', ['lucidworksView.services.config',
3 | 'lucidworksView.utils.docs'
4 | ])
5 | .directive('field', fieldItem);
6 |
7 |
8 | function fieldItem() {
9 | 'ngInject';
10 | return {
11 | restrict: 'EA',
12 | templateUrl: 'assets/components/field/field.html',
13 | scope: true,
14 | controller: Controller,
15 | controllerAs: 'fc',
16 | bindToController: {
17 | formattingHandler: '=',
18 | value: '=',
19 | highlight: '=',
20 | hkey: '@', //The Highlight key, used to look up the proper highlighting snippet by name.
21 | maxlength: '='
22 | },
23 | replace: true
24 | };
25 | }
26 |
27 | function Controller($log, $sanitize) {
28 | 'ngInject';
29 | var fc = this;
30 | fc.limit = false;
31 | fc.limitValue = fc.maxlength;//keep track of the limitValue, as the user can toggle this w/ the Read More/Less toggle, but not the max length value
32 | fc.showMore = false;
33 | fc.totalLength = -1;
34 | fc.toggleRead = toggleRead;
35 | activate();
36 |
37 | ///////////
38 |
39 | function activate() {
40 | fc.value = processField(fc.value, fc.hkey, fc.highlight, fc.maxlength);
41 | }
42 |
43 | function toggleRead(){
44 | if (fc.limit) {//this only applies when we have more than the limitValue chars
45 | if (!fc.showMore) {
46 | //toggle to true, meaning user wants to see more
47 | fc.showMore = true;
48 | fc.limitValue = fc.totalLength;
49 | } else {
50 | fc.showMore = false;
51 | fc.limitValue = fc.maxlength;
52 | }
53 | }
54 | }
55 |
56 | function processField(field, highlightKey, highlight, maxlength) {
57 | var result = $sanitize(_.escape(field));
58 | var hasHighlight = false;
59 | if (highlight && Object.keys(highlight).length > 0) {
60 | if (highlight[highlightKey]) {
61 | result = highlight[highlightKey];
62 | }
63 | }
64 | // Only shorten if not highlighting, since highlighing in solr can control
65 | // snippet size there and b/c we have a Trusted object and not a plain
66 | // old string.
67 |
68 | // If field is multivalued, join the items before trimming
69 | result = _.isArray(result)?_.join(result, ' '):result;
70 |
71 | if (hasHighlight === false && result && result.length > maxlength) {
72 | // Mark this as being trimmed, but don't actually physically trim it
73 | fc.limit = true;
74 | }
75 | fc.totalLength = result.length;
76 | if (fc.formattingHandler){
77 | result = fc.formattingHandler(result);
78 | }
79 | return result;
80 | }
81 | }
82 | })();
83 |
--------------------------------------------------------------------------------
/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "lucidworks-view",
3 | "version": "1.4.0",
4 | "description": "Lucidworks View: Create custom user experiences for your Fusion-powered apps.",
5 | "repository": {
6 | "type": "git",
7 | "url": "git+https://github.com/lucidworks/lucidworks-view.git"
8 | },
9 | "keywords": [
10 | "lucidworks",
11 | "fusion",
12 | "angular",
13 | "search"
14 | ],
15 | "author": "Joshua Ellinger ",
16 | "contributors": [
17 | "Joshua Ellinger ",
18 | "Arjit Dasgupta ",
19 | "Ariel Isaacs ",
20 | "Josh Lipps "
21 | ],
22 | "license": "Apache-2.0",
23 | "bugs": {
24 | "url": "https://github.com/lucidworks/lucidworks-view/issues"
25 | },
26 | "changelog": "https://github.com/lucidworks/lucidworks-view/blob/master/CHANGELOG.md",
27 | "homepage": "https://lucidworks.com/products/view",
28 | "scripts": {
29 | "start": "./node_modules/gulp/bin/gulp.js --production",
30 | "prestart-dev": "npm install",
31 | "start-dev": "./node_modules/gulp/bin/gulp.js",
32 | "build": "./node_modules/gulp/bin/gulp.js build --production",
33 | "test": "./node_modules/karma/bin/karma start karma.conf.js"
34 | },
35 | "devDependencies": {
36 | "bower": "1.8.8",
37 | "browser-sync": "^2.11.0",
38 | "connect-history-api-fallback": "^1.1.0",
39 | "connect-logger": "0.0.1",
40 | "eslint": "^3.3.1",
41 | "eslint-config-angular": "^0.5.0",
42 | "eslint-plugin-angular": "^1.3.1",
43 | "front-router": "^1.0.0",
44 | "gulp": "^3.9.0",
45 | "gulp-angular-templatecache": "^1.8.0",
46 | "gulp-autoprefixer": "^3.1.0",
47 | "gulp-chmod": "^1.3.0",
48 | "gulp-concat": "^2.6.0",
49 | "gulp-cssnano": "^2.1.2",
50 | "gulp-directive-replace": "^0.2.0",
51 | "gulp-eslint": "^3.0.1",
52 | "gulp-htmlmin": "^1.3.0",
53 | "gulp-if": "^2.0.0",
54 | "gulp-json-editor": "^2.2.1",
55 | "gulp-load-plugins": "^1.1.0",
56 | "gulp-ng-annotate": "^1.1.0",
57 | "gulp-ng-html2js": "^0.2.0",
58 | "gulp-plumber": "^1.0.1",
59 | "gulp-rename": "^1.2.2",
60 | "gulp-requirejs": "^0.1.3",
61 | "gulp-sass": "^2.0.4",
62 | "gulp-shell": "^0.5.2",
63 | "gulp-sourcemaps": "^1.6.0",
64 | "gulp-uglify": "^1.2.0",
65 | "gulp-webserver": "^0.9.1",
66 | "http-proxy-middleware": "^0.17.3",
67 | "jasmine-core": "^2.4.1",
68 | "karma": "^0.13.19",
69 | "karma-chrome-launcher": "^0.2.2",
70 | "karma-jasmine": "^0.3.6",
71 | "ng-describe": "^1.6.0",
72 | "require-dir": "^0.3.0",
73 | "rimraf": "^2.4.1",
74 | "run-sequence": "^1.1.1",
75 | "sass-lint": "^1.5.1",
76 | "yargs": "^6.6.0"
77 | },
78 | "engine": "node >=5.2.0"
79 | }
80 |
--------------------------------------------------------------------------------
/tests/assets/js/services/QueryDataServiceTest.js:
--------------------------------------------------------------------------------
1 | /*global ngDescribe, describe, it, expect*/
2 | ngDescribe({
3 | name: 'QueryService',
4 | modules: 'lucidworksView.services',
5 | inject: ['ConfigService', 'QueryDataService', 'ApiBase', '$httpBackend'],
6 | http:{
7 | get:{
8 | 'templates/home.html': ''
9 | }
10 | },
11 | tests: function(deps){
12 | beforeEach(function(){
13 | deps.ConfigService.init(window.appConfig);
14 | deps.ApiBase.setEndpoint(deps.ConfigService.getFusionUrl());
15 | });
16 |
17 | describe('it should make the right call', function(){
18 | it('with the right query', function(){
19 | deps.$httpBackend.expectGET('http://localhost:8764/api/apollo/collections/MyCollection/query-profiles/default/select?q=hello&wt=json').respond({'key':'value'});
20 | deps.QueryDataService.getQueryResults({
21 | q: 'hello',
22 | wt: 'json'
23 | }).then(function(resp){
24 | expect(resp).toEqual({'key':'value'});
25 | });
26 | deps.step();
27 | });
28 |
29 | it('with the right query with multiple query params', function(){
30 | deps.$httpBackend.expectGET('http://localhost:8764/api/apollo/collections/MyCollection/query-profiles/default/select?q=hello&fq=hello2u2&wt=json').respond({'key':'value'});
31 | deps.QueryDataService.getQueryResults({
32 | q: 'hello',
33 | fq: 'hello2u2',
34 | wt: 'json'
35 | }).then(function(resp){
36 | expect(resp).toEqual({'key':'value'});
37 | });
38 | deps.step();
39 | });
40 | });
41 |
42 | describe('it should make the right call with query pipelines as well', function(){
43 | it('with the right query', function(){
44 | deps.ConfigService.init({use_query_profile: false});
45 | deps.$httpBackend.expectGET('http://localhost:8764/api/apollo/query-pipelines/default/collections/MyCollection/select?q=hello&wt=json').respond({'key':'value'});
46 | deps.QueryDataService.getQueryResults({
47 | q: 'hello',
48 | wt: 'json'
49 | }).then(function(resp){
50 | expect(resp).toEqual({'key':'value'});
51 | });
52 | deps.step();
53 | });
54 |
55 | it('with the right query with multiple query params', function(){
56 | deps.ConfigService.init({use_query_profile: false});
57 | deps.$httpBackend.expectGET('http://localhost:8764/api/apollo/query-pipelines/default/collections/MyCollection/select?q=hello&fq=hello2u2&wt=json').respond({'key':'value'});
58 | deps.QueryDataService.getQueryResults({
59 | q: 'hello',
60 | fq: 'hello2u2',
61 | wt: 'json'
62 | }).then(function(resp){
63 | expect(resp).toEqual({'key':'value'});
64 | });
65 | deps.step();
66 | });
67 | });
68 | }
69 | });
70 |
--------------------------------------------------------------------------------
/gulp/build.js:
--------------------------------------------------------------------------------
1 | /*eslint-env node*/
2 | /*global global*/
3 | /*eslint no-console:0*/
4 |
5 | var $ = require('gulp-load-plugins')();
6 | var gulp = require('gulp');
7 | var router = require('front-router');
8 | var sequence = require('run-sequence');
9 |
10 | // Builds your entire app once, without starting a server
11 | gulp.task('build', function(cb) {
12 | sequence('clean', 'copy:config', 'writeDevConfig', ['copy', 'copy:foundation', 'sass', 'uglify'], 'copy:templates', cb);
13 | });
14 |
15 | // Copies everything in the client folder except templates, Sass, and JS
16 | gulp.task('copy', function() {
17 | return gulp.src(global.paths.assets, {
18 | base: './client/'
19 | })
20 | .pipe(gulp.dest('./build'));
21 | });
22 |
23 | // Copies your app's page templates and generates URLs for them
24 | gulp.task('copy:templates', function() {
25 | return gulp.src('./client/templates/**/*.html')
26 | .pipe(router({
27 | path: 'build/assets/js/routes.js',
28 | root: 'client'
29 | }))
30 | .pipe(gulp.dest('./build/templates'));
31 | });
32 |
33 | // Compiles the Foundation for Apps directive partials into a single JavaScript file
34 | gulp.task('copy:foundation', function(cb) {
35 | gulp.src('bower_components/foundation-apps/js/angular/components/**/*.html')
36 | .pipe($.ngHtml2js({
37 | prefix: 'components/',
38 | moduleName: 'foundation',
39 | declareModule: false
40 | }))
41 | .pipe($.uglify())
42 | .pipe($.concat('templates.js'))
43 | .pipe(gulp.dest('./build/assets/js'));
44 |
45 | // Iconic SVG icons
46 | gulp.src('./bower_components/foundation-apps/iconic/**/*')
47 | .pipe(gulp.dest('./build/assets/img/iconic/'));
48 |
49 | cb();
50 | });
51 |
52 | // Compiles and copies the Foundation for Apps JavaScript, as well as your app's custom JS
53 | gulp.task('uglify', ['uglify:foundation', 'uglify:app']);
54 |
55 | gulp.task('uglify:foundation', function() {
56 | var uglify = $.if(global.isProduction, $.uglify()
57 | .on('error', function (e) {
58 | console.log(e);
59 | }));
60 |
61 | return gulp.src(global.paths.foundationJS)
62 | .pipe(uglify)
63 | .pipe($.concat('foundation.js'))
64 | .pipe(gulp.dest('./build/assets/js/'));
65 | });
66 |
67 | gulp.task('uglify:app', function() {
68 | var uglify = $.if(global.isProduction, $.uglify()
69 | .on('error', function (e) {
70 | console.log(e);
71 | })),
72 | sourcemapsInit = $.if(!global.isProduction, $.sourcemaps.init()),
73 | sourcemapsWrite = $.if(!global.isProduction, $.sourcemaps.write('.'));
74 |
75 | return gulp.src(global.paths.appJS, { base: 'client' })
76 | .pipe($.plumber())
77 | .pipe(sourcemapsInit)
78 | .pipe($.ngAnnotate())
79 | .pipe(uglify)
80 | .pipe($.directiveReplace({root: 'client'}))
81 | .pipe($.concat('app.js'))
82 | .pipe(sourcemapsWrite)
83 | .pipe(gulp.dest('./build/assets/js/'));
84 | });
85 |
--------------------------------------------------------------------------------
/docs/HowToUseQueryBuilder.md:
--------------------------------------------------------------------------------
1 | # How to use query builder
2 |
3 | Query builder creates query strings from an object.
4 |
5 | ## First level of a query object
6 |
7 | This is where you can define different options which will be joined
8 | together by standard query syntax.
9 |
10 | An object when passed through `objectToURLString` will return a string:
11 |
12 | * object:
13 |
14 | ```javascript
15 | {aa: 'abcd', bb: 'defg'}
16 | ```
17 |
18 | * string:
19 |
20 | ```
21 | aa=abcd&bb=defg
22 | ```
23 |
24 | ## Second level of a query object and beyond
25 |
26 | Acceptable types:
27 |
28 | * string
29 |
30 | Will be concatenated to the query string.
31 |
32 | * array
33 |
34 | Each element is run through the reducer.
35 |
36 | * key value object
37 |
38 | A key/value pair that will be concatenated together.
39 |
40 | The values in a key/value pair can contain an array, a string, or even another key value object, allowing you to nest as many as you need to create your query.
41 |
42 | ## Transformers
43 |
44 | Transformers enable you to extend query builder by using different syntax to join or mutate data.
45 |
46 | Transformers are called on each step of a reduction of a key value object. Each step runs in order, transforming the data at each step:
47 |
48 | 1. `preEncodeWrapper`
49 | - Wraps the output before encode is run.
50 | - Ex: Used in `facetField` for adding inner quotes to a value.
51 | - default = no transformation
52 | 2. `encode`
53 | - encodes the data into another format.
54 | - Ex: Used in `facetField` to encode the value into a URI-encoded component.
55 | - default = no transformation
56 | 3. `wrapper`
57 | - Wraps the data after `encode` has been called.
58 | - Ex. In `facetField`, adds braces around a value.
59 | - default = no transformation
60 | 4. `keyValue`
61 | - Joins a key and a value.
62 | - Ex. In `facetField`, it joins a key and a value with `:`.
63 | - default = '='
64 | 5. `join`
65 | - Joins the key/value to the rest of the query string.
66 | - Ex. In `facetField`, it joins a the key value with ''.
67 | - default = ''
68 |
69 | ### Writing your own transformers
70 | You can add transformers in a service or in a module configuration. Just inject `QueryBuilderProvider` or `QueryBuilder`.
71 |
72 | The `registerTransformer` function allows you to register any transformers you want for use. These are then used in a key/value object and are triggered via the `transformer` property of a key/value object.
73 |
74 | Here's an example of registering a transformer:
75 |
76 | ```javascript
77 | QueryBuilderProvider.registerTransformer('wrapper', 'fq:field', fqFieldWrapper);
78 | function fqFieldWrapper(data){
79 | return '('+data+')';
80 | }
81 | ```
82 |
83 | Now every time an object has that transformer it will be output with that wrapper.
84 |
85 | ```javascript
86 | {fq: [{
87 | key: 'name',
88 | value: 'value',
89 | transformer: 'fq:field'
90 | }]}
91 | ```
92 |
93 | if the above object just had that one transformer it would produce the string.
94 |
95 | ```
96 | fq=name(value)
97 | ```
98 |
--------------------------------------------------------------------------------
/client/assets/js/services/SignalService.js:
--------------------------------------------------------------------------------
1 | (function () {
2 | 'use strict';
3 |
4 | angular
5 | .module('lucidworksView.services.signals', ['lucidworksView.services.apiBase',
6 | 'lucidworksView.services.config'
7 | ])
8 | .factory('SignalsService', SignalsService);
9 |
10 | function SignalsService(ApiBase, ConfigService, $http, $q, QueryService, ClientStatsService) {
11 | 'ngInject';
12 | var service = {
13 | postClickSignal: postClickSignal,
14 | postSignalData: postSignalData,
15 | getSignalsDocumentId: getSignalsDocumentId
16 | };
17 |
18 | return service;
19 |
20 | /**
21 | * Helper method to document click events.
22 | * @param {string} docId The document id
23 | * @param {object} options An object containing parameter overrides and options.
24 | * - The object can be any parameter which will be passed through, including parameters.
25 | * Ex: {type: 'custom', params: {filterQueries: ['something']}}
26 | * @return {promise}
27 | */
28 | function postClickSignal(docId, options) {
29 | var date = new Date(),
30 | data = {
31 | params: {
32 | docId: docId,
33 | head_field: ConfigService.config.head_field,
34 | language: ClientStatsService.getBrowserLanguage(),
35 | platform: ClientStatsService.getBrowserPlatform(),
36 | user_agent: ClientStatsService.getBrowserUserAgent(),
37 | user_name: ConfigService.getLoginCredentials().username || ConfigService.config.anonymous_access.username,
38 | query: QueryService.getQueryObject().q
39 | },
40 | pipeline: ConfigService.config.signals_pipeline,
41 | timestamp: date.toISOString(),
42 | type: ConfigService.config.signal_type
43 | };
44 |
45 | _.defaultsDeep(data, options);
46 |
47 | return postSignalData([data]);
48 | }
49 |
50 | //Use if you want to post a raw signal where you have control of every signal entry. See postClickSignal for an example data structure
51 | function postSignalData(data) {
52 | var deferred = $q.defer();
53 | $http
54 | .post(ApiBase.getEndpoint() + 'api/apollo/signals/' + ConfigService.config.collection,
55 | data)
56 | .then(success)
57 | .catch(failure);
58 |
59 | function success(response) {
60 | deferred.resolve(response.data);
61 | }
62 |
63 | function failure(err) {
64 | deferred.reject(err.data);
65 | }
66 |
67 | return deferred.promise;
68 | }
69 |
70 | /**
71 | * Given a document return a signals document ID value.
72 | * @param {object} doc The document
73 | * @return {string|Number} The document ID value
74 | */
75 | function getSignalsDocumentId(doc) {
76 | var documentIdField = ConfigService.config.signals_document_id;
77 | if (doc.hasOwnProperty(documentIdField)) {
78 | return doc[documentIdField];
79 | }
80 | else {
81 | return null;
82 | }
83 |
84 | }
85 | }
86 | })();
87 |
--------------------------------------------------------------------------------
/CHANGELOG.md:
--------------------------------------------------------------------------------
1 | # CHANGELOG
2 |
3 | ## 1.4.0 - Ra Ra Rasputin's Disco Tiara
4 | **New Features**
5 | * Now works out of the box with Fusion 3
6 | * Added support for changing the default query via FUSION_CONFIG.js
7 | * Added support for date range facets type
8 | * Added support for simple grouped results
9 | * New loading state for range facets to prevent multiple selections while page is loading
10 |
11 | **Bug Fixes**
12 | * When redirected through login, inital page query will no longer be cleared
13 | * Linked URLS with parameters now click through correctly
14 | * Only show pagination arrows when pagination is possible
15 | * Fixed typeahead autocomplete user entry race condition
16 |
17 | **Package Updates**
18 | * Updated ESLint to version 3.3.1.
19 | * Updated angular-ui-router to version 0.4.2
20 |
21 | **Deprecated API functions**
22 | * URLService.setQuery()
23 |
24 | Instead of using `URLService.setQuery()` use `QueryService.setQuery()`
25 | > `URLService.setQuery()` will be removed in View 1.5.0.
26 |
27 | ## 1.3.0 - Pikachu's Invisible Tiara - August 5, 2016
28 | **New Features**
29 | * Added a Windows packaged build, you can now run View on Windows
30 | * Improved performance by minifying builds by default and turning off page change animations
31 | * You can now specify which port View runs on
32 | * Introduced developer mode, which allows you to develop with unminified build objects, just `npm run start-dev`
33 |
34 | **Bug Fixes**
35 | * Fixed a bug in `npm run build` command
36 |
37 | ## 1.2.0 - Cersei's Iron Tiara - June 30, 2016
38 | **New Features**
39 | * Now support range facet type
40 | * Added multi select faceting, meaning you can facet on multiple items within a single query
41 | * Added 'clear all' button to facet lists, clearing all selected facets
42 | * Improved signals now pass in more information including position, language, and platform
43 | * Enhanced signals service, adding additional functionality
44 | * Improved field display in templates by setting set max-length
45 |
46 | **Bug fixes**
47 | * Fix typeahead of a query profile or pipeline
48 | * Fixed field values: HTML entities are now properly truncated
49 |
50 | ## 1.1.0 - Tsarina Alexandra Tiara - May 4, 2016
51 | **New Features**
52 | * Highlighting support for fields when configured in Fusion
53 | * Grouped results are now displayed when configured in the Fusion pipeline
54 | * Add support for self signed certs with https on connections between Fusion and View
55 | * Add ability to use View with https enabled. (You can even use your own cert!)
56 | * Add context and instructions when starting via view.sh command
57 | * Improved signals to work with more complex inputs
58 |
59 | **Bug fixes**
60 | * Fixed npm start command: NPM start command now tracks changes to HTML files. Now you can change your HTML and templates with reckless abandon
61 | * Fixed landing pages: Landing are now unique
62 |
63 | ## 1.0.0 - Initial release (Paper Tiara) - April 6, 2016
64 |
65 | The first release of Lucidworks View
66 |
67 | Contains out of the box support for:
68 |
69 | Landing pages
70 | - Fusion Field facets
71 | - Document display templates
72 | - Slack, Twitter, JIRA, web, local file, default
73 | - Color and logo customization
74 | - Authentication
75 | - Signals
76 | - Typeahead
77 | - Sorting
78 |
--------------------------------------------------------------------------------
/docs/Customizing_Documents.md:
--------------------------------------------------------------------------------
1 | # How to customize documents
2 |
3 | Lucidworks View lets you customize the display of different document types, which correspond to datasources in Fusion. It includes built-in templates to display some of the most common document types:
4 |
5 | - `document_file` (filesystem)
6 | - `document_jira` (repository)
7 | - `document_slack` (social)
8 | - `document_twitter` (social)
9 | - `document_web` (web)
10 |
11 | All templates are located in the ```client/assets/components/document``` folder.
12 |
13 | ## Default document display
14 |
15 | There's also a `document_default` template to display any document type that doesn't match the above. You can configure this template in `FUSION_CONFIG.js` to expose different fields, depending on your data.
16 |
17 | Open `FUSION_CONFIG.js` and scroll to this line to see the available options:
18 |
19 | ```
20 | * Document_default display
21 | ```
22 |
23 | ## Adding custom document types
24 |
25 | You can add new document types by
26 |
27 | 1. creating a new document component and
28 | 2. modifying the `getDocType` function to trigger your template.
29 |
30 | ### Creating a new document component
31 | 1. Copy one of the existing template directories and give it a name like `document_`.
32 | 1. Give the files in the new directory names that match the directory name, like this:
33 |
34 | ```
35 | _document_.scss
36 | document_.html
37 | document_.js
38 | ```
39 |
40 | See the `client/assets/components/document/document_EXAMPLE` directory for an example.
41 |
42 | 1. Customize the templates as needed.
43 | At a minimum, you _must_ modify the following values in `document_.js`:
44 |
45 | * `module`
46 | * `directive`
47 | * `templateURL`
48 |
49 | For more information about customizing Angular templates, see https://code.angularjs.org/1.4.8/docs/guide/templates.
50 |
51 | 1. Add the value of `module` to the list in ```client/assets/components/components.js```.
52 |
53 | 1. Add the value of `directive` to ```client/assets/components/documentList/documentList.html```.
54 | * You will need to add the value in 2 places in this file. Once in the first list, and once in the grouped results section, if you want the doc type to show up when you have regular and grouped results.
55 |
56 | ### Modifying the getDocType function
57 |
58 | The `getDocType` method specifies the data field that the app uses to select a template. The default is `_lw_data_source_type_s`, but you can add conditional statements to read additional fields.
59 |
60 | 1. Open ```client/assets/components/documentList/documentList.js``` and locate this section:
61 |
62 | ```javascript
63 | /**
64 | * Get the document type for the document.
65 | * @param {object} doc Document object
66 | * @return {string} Type of document
67 | */
68 | function getDocType(doc){
69 | // Change to your collection datasource type name
70 | // if(doc['_lw_data_source_s'] === 'MyDatasource-default'){
71 | // return doc['_lw_data_source_s'];
72 | // }
73 | return doc['_lw_data_source_type_s'];
74 | }
75 | ```
76 | 1. Uncomment the `if` statement.
77 | 1. Replace `_lw_data_source_s` with the name of a field from your data.
78 | 1. Replace `MyDatasource-default` with the name of your template.
79 |
--------------------------------------------------------------------------------
/client/assets/components/document/document_web/document_web.html:
--------------------------------------------------------------------------------
1 |
2 |
Your results will live here
28 |Try searching any query above in the search box
29 |There are no results for “{{hc.lastQuery}}”
34 |Try searching on a different term or using different facets to refine your search
35 |