openmct/src/plugins/plugins.js

/*****************************************************************************
 * Open MCT, Copyright (c) 2014-2016, United States Government
 * as represented by the Administrator of the National Aeronautics and Space
 * Administration. All rights reserved.
 *
 * Open MCT is licensed under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * http://www.apache.org/licenses/LICENSE-2.0.
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations
 * under the License.
 *
 * Open MCT includes source code licensed under additional open source
 * licenses. See the Open Source Licenses file (LICENSES.md) included with
 * this source code distribution or the Licensing information page available
 * at runtime from the About dialog for additional information.
 *****************************************************************************/

define([
    'lodash',
    '../../platform/features/conductor/utcTimeSystem/src/UTCTimeSystem',
    '../../example/generator/plugin'
], function (
    _,
    UTCTimeSystem,
    GeneratorPlugin
) {
    var bundleMap = {
        CouchDB: 'platform/persistence/couch',
        Elasticsearch: 'platform/persistence/elastic',
        Espresso: 'platform/commonUI/themes/espresso',
        LocalStorage: 'platform/persistence/local',
        MyItems: 'platform/features/my-items',
        Snow: 'platform/commonUI/themes/snow'
    };

    var plugins = _.mapValues(bundleMap, function (bundleName, pluginName) {
        return function pluginConstructor() {
            return function (openmct) {
                openmct.legacyRegistry.enable(bundleName);
            };
        };
    });

    plugins.UTCTimeSystem = function () {
        return function (openmct) {
            openmct.legacyExtension("timeSystems", {
                "implementation": UTCTimeSystem,
                "depends": ["$timeout"]
            });
        };
    };

    var conductorInstalled = false;

    plugins.Conductor = function (options) {
        if (!options) {
            options = {};
        }

        function applyDefaults(openmct, timeConductorViewService) {
            var defaults = {};
            var timeSystem = timeConductorViewService.systems.find(function (ts) {
                return ts.metadata.key === options.defaultTimeSystem;
            });
            if (timeSystem !== undefined) {
                defaults = timeSystem.defaults();

                if (options.defaultTimespan !== undefined) {
                    defaults.deltas.start = options.defaultTimespan;
                    defaults.bounds.start = defaults.bounds.end - options.defaultTimespan;
                    timeSystem.defaults(defaults);
                }

                openmct.conductor.timeSystem(timeSystem, defaults.bounds);
            }
        }

        return function (openmct) {
            openmct.legacyExtension('constants', {
                key: 'DEFAULT_TIMECONDUCTOR_MODE',
                value: options.showConductor ? 'fixed' : 'realtime',
                priority: conductorInstalled ? 'mandatory' : 'fallback'
            });
            if (options.showConductor !== undefined) {
                openmct.legacyExtension('constants', {
                    key: 'SHOW_TIMECONDUCTOR',
                    value: options.showConductor,
                    priority: conductorInstalled ? 'mandatory' : 'fallback'
                });
            }
            if (options.defaultTimeSystem !== undefined || options.defaultTimespan !== undefined) {
                openmct.legacyExtension('runs', {
                    implementation: applyDefaults,
                    depends: ["openmct", "timeConductorViewService"]
                });
            }

            if (!conductorInstalled) {
                openmct.legacyRegistry.enable('platform/features/conductor/core');
                openmct.legacyRegistry.enable('platform/features/conductor/compatibility');
            }
            conductorInstalled = true;
        };
    };

    plugins.CouchDB = function (url) {
        return function (openmct) {
            if (url) {
                var bundleName = "config/couch";
                openmct.legacyRegistry.register(bundleName, {
                    "extensions": {
                        "constants": [
                            {
                                "key": "COUCHDB_PATH",
                                "value": url,
                                "priority": "mandatory"
                            }
                        ]
                    }
                });
                openmct.legacyRegistry.enable(bundleName);
            }

            openmct.legacyRegistry.enable(bundleMap.CouchDB);
        };
    };

    plugins.Elasticsearch = function (url) {
        return function (openmct) {
            if (url) {
                var bundleName = "config/elastic";
                openmct.legacyRegistry.register(bundleName, {
                    "extensions": {
                        "constants": [
                            {
                                "key": "ELASTIC_ROOT",
                                "value": url,
                                "priority": "mandatory"
                            }
                        ]
                    }
                });
                openmct.legacyRegistry.enable(bundleName);
            }

            openmct.legacyRegistry.enable(bundleMap.Elasticsearch);
        };
    };

    plugins.Generator = function () {
        return GeneratorPlugin;
    };

    return plugins;
});