Merge branch 'feature-plugin'

# Conflicts:
#	lib/form/index.js

README.md

@@ -32,7 +32,6 @@ More info are [here](https://github.com/crowi/crowi/wiki/Install-and-Configurati
 Don't use `master` branch because it is unstable but use released tag version expect when you want to contribute the project.
 `master` branch is prepared for v1.6. See [here](https://github.com/crowi/crowi/wiki/Roadmaps-v1.6) to know further info.
 
-
 Dependencies
 -------------
 
@@ -66,6 +65,29 @@ $ PASSWORD_SEED=somesecretstring MONGO_URI=mongodb://username:password@localhost
 * `SECRET_TOKEN`: A secret key for verifying the integrity of signed cookies.
 * `FILE_UPLOAD`: `aws` (default), `local`, `none`
 
+(Opt.) Install Plugins
+-----------------------
+
+Install plugins from github:
+
+    $ npm run install-plugin https://github.com/sopmeone/crowi-plugin-something.git
+
+Modify `plugin/plugin.js`:
+
+    const plugins = [
+      require('crowi-plugin-something')
+    ]
+
+Build plugins:
+
+    $ npm run webpack:plugin
+    
+After above process, rebooting Crowi is required.
+
+### CAUTION
+
+Plugins are DISABLED in default settings.  
+Change it on admin page.
 
 License
 ---------

lib/crowi/index.js

@@ -32,7 +32,9 @@ function Crowi (rootdir, env)
 
   this.assets    = {};
   try {
-    this.assets = require(this.publicDir + '/js/manifest.json') || {};
+    var assets = require(this.publicDir + '/js/manifest.json') || {};
+    var pluginAssets = require(this.publicDir + '/js/manifest-plugin.json') || {};
+    this.assets = Object.assign(assets, pluginAssets);
   } catch (e) {
     // ignore
   }
@@ -123,7 +125,9 @@ Crowi.prototype.getAssetList = function() {
 
   // reload manifest
   try {
-    this.assets = JSON.parse(fs.readFileSync(this.publicDir + '/js/manifest.json'))|| {};
+    var assets = require(this.publicDir + '/js/manifest.json') || {};
+    var pluginAssets = require(this.publicDir + '/js/manifest-plugin.json') || {};
+    this.assets = Object.assign(assets, pluginAssets);
   } catch (e) {
     // ignore
     debug('Failed to reload assets on development', e);

lib/form/admin/plugin.js

@@ -0,0 +1,9 @@
+'use strict';
+
+var form = require('express-form')
+  , field = form.field;
+
+module.exports = form(
+  field('settingForm[plugin:isEnabledPlugins]').trim().toBooleanStrict()
+);
+

lib/form/index.js

@@ -15,6 +15,7 @@ module.exports = {
     mail: require('./admin/mail'),
     aws: require('./admin/aws'),
     google: require('./admin/google'),
+    plugin: require('./admin/plugin'),
     userInvite: require('./admin/userInvite'),
     slackSetting: require('./admin/slackSetting'),
   },

lib/models/config.js

@@ -42,6 +42,8 @@ module.exports = function(crowi) {
       'google:clientId'     : '',
       'google:clientSecret' : '',
 
+      'plugin:isEnabledPlugins' : false,
+
     };
   }
 
@@ -60,7 +62,7 @@ module.exports = function(crowi) {
     var originalConfig = crowi.getConfig();
     var newNSConfig = originalConfig[ns] || {};
     Object.keys(config).forEach(function (key) {
-      if (config[key] || config[key] === '') {
+      if (config[key] || config[key] === '' || config[key] === false) {
         newNSConfig[key] = config[key];
       }
     });

lib/routes/index.js

@@ -45,6 +45,7 @@ module.exports = function(crowi, app) {
   app.post('/_api/admin/settings/mail'  , loginRequired(crowi, app) , middleware.adminRequired() , csrf, form.admin.mail, admin.api.appSetting);
   app.post('/_api/admin/settings/aws'   , loginRequired(crowi, app) , middleware.adminRequired() , csrf, form.admin.aws, admin.api.appSetting);
   app.post('/_api/admin/settings/google', loginRequired(crowi, app) , middleware.adminRequired() , csrf, form.admin.google, admin.api.appSetting);
+  app.post('/_api/admin/settings/plugin', loginRequired(crowi, app) , middleware.adminRequired() , csrf, form.admin.plugin, admin.api.appSetting);
 
   // search admin
   app.get('/admin/search'              , loginRequired(crowi, app) , middleware.adminRequired() , admin.search.index);

lib/views/admin/app.html

@@ -237,13 +237,44 @@
       </fieldset>
       </form>
 
+      <form action="/_api/admin/settings/plugin" method="post" class="form-horizontal" id="pluginSettingForm" role="form">
+      <fieldset>
+      <legend>プラグイン設定</legend>
+        <p class="well">プラグインの読み込みを有効にします。</p>
+
+        <div class="form-group">
+          <label for="settingForm[plugin:isEnabledPlugins]" class="col-xs-3 control-label">プラグインを読み込む</label>
+          <div class="col-xs-6">
+            <div class="btn-group btn-toggle" data-toggle="buttons">
+              <label class="btn {% if settingForm['plugin:isEnabledPlugins'] %}btn-primary active{% else %}btn-default{% endif %}">
+                <input name="settingForm[plugin:isEnabledPlugins]" value="true" type="radio"
+                    {% if true === settingForm['plugin:isEnabledPlugins'] %}checked{% endif %}> 有効
+              </label>
+              <label class="btn {% if !settingForm['plugin:isEnabledPlugins'] %}btn-primary active{% else %}btn-default{% endif %}">
+                <input name="settingForm[plugin:isEnabledPlugins]" value="false" type="radio"
+                    {% if !settingForm['plugin:isEnabledPlugins'] %}checked{% endif %}> 無効
+              </label>
+            </div>
+          </div>
+        </div>
+
+        <div class="form-group">
+          <div class="col-xs-offset-3 col-xs-6">
+            <input type="hidden" name="_csrf" value="{{ csrf() }}">
+            <button type="submit" class="btn btn-primary">更新</button>
+          </div>
+        </div>
+
+      </fieldset>
+      </form>
+
     </div>
   </div>
 
   <script>
     $(function()
     {
-      $('#appSettingForm, #secSettingForm, #mailSettingForm, #awsSettingForm, #googleSettingForm').each(function() {
+      $('#appSettingForm, #secSettingForm, #mailSettingForm, #awsSettingForm, #googleSettingForm, #pluginSettingForm').each(function() {
         $(this).submit(function()
         {
           function showMessage(formId, msg, status) {
@@ -291,6 +322,27 @@
         });
       });
 
+      // Bootstrap 3 Toggle Switch Snippet
+      // http://www.bootply.com/92189
+      $('.btn-toggle').click(function() {
+        $(this).find('.btn').toggleClass('active');  
+        
+        if ($(this).find('.btn-primary').size()>0) {
+          $(this).find('.btn').toggleClass('btn-primary');
+        }
+        if ($(this).find('.btn-danger').size()>0) {
+          $(this).find('.btn').toggleClass('btn-danger');
+        }
+        if ($(this).find('.btn-success').size()>0) {
+          $(this).find('.btn').toggleClass('btn-success');
+        }
+        if ($(this).find('.btn-info').size()>0) {
+          $(this).find('.btn').toggleClass('btn-info');
+        }
+        
+        $(this).find('.btn').toggleClass('btn-default');
+      });
+      
     });
   </script>
 

lib/views/layout/layout.html

@@ -22,6 +22,7 @@
 <body
   class="crowi main-container {% block html_base_css %}{% endblock %}"
   data-me="{{ user._id.toString() }}"
+  data-plugin-enabled="{{ config.crowi['plugin:isEnabledPlugins'] }}"
  {% block html_base_attr %}{% endblock %}
  >
 
@@ -131,6 +132,9 @@
 </body>
 {% endblock %}
 
+{% if config.crowi['plugin:isEnabledPlugins'] %}
+<script src="{{ assets('/js/plugin.js') }}"></script>
+{% endif %}
 <script src="{{ assets('/js/crowi.js') }}"></script>
 <script src="{{ assets('/js/app.js') }}"></script>
 </html>

package.json

@@ -113,7 +113,9 @@
     "start": "node app.js",
     "test": "gulp test",
     "build": "gulp",
+    "install-plugin": "npm -prefix ./plugin install -- ",
     "webpack": "webpack",
+    "webpack:plugin": "webpack --config webpack.plugin.config.js",
     "postinstall": "gulp"
   },
   "env": {

plugin/package.json

@@ -0,0 +1,10 @@
+{
+  "name": "crowi-plugin",
+  "version": "1.0.0",
+  "description": "",
+  "main": "plugin.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "license": "MIT"
+}

plugin/plugin.js

@@ -0,0 +1,41 @@
+const plugins = [
+  // require('crowi-plugin-...')
+]
+
+// import all plugins
+var pluginMetaDatas = [];
+plugins.forEach((plugin) => {
+  pluginMetaDatas.push(plugin.meta);
+})
+
+export default class CrowiPlugin {
+
+  /**
+   * plug-in PreProcessors
+   * 
+   * @param {Crowi} crowi
+   * @param {CrowiRenderer} crowiRenderer
+   * 
+   * @memberof CrowiPlugin
+   */
+  pluginPreProcessors(crowi, crowiRenderer) {
+    var additionalPreProcessors = [];
+
+    pluginMetaDatas.forEach((meta) => {
+      // v1
+      if (meta.pluginSchemaVersion === 1) {
+        meta.preProcessorFactories.forEach((f) => {
+          // instanciate PreProcessor
+          var preProcessor = f(crowi);
+          additionalPreProcessors.push(preProcessor);
+        })
+      }
+    });
+
+    crowiRenderer.preProcessors = crowiRenderer.preProcessors.concat(
+        crowiRenderer.preProcessors, additionalPreProcessors);
+  }
+
+}
+
+window.crowiPlugin = new CrowiPlugin();     // FIXME

resource/js/app.js

@@ -29,6 +29,13 @@ crowi.fetchUsers();
 const crowiRenderer = new CrowiRenderer();
 window.crowiRenderer = crowiRenderer;
 
+// FIXME
+var isEnabledPlugins = $('body').data('plugin-enabled');
+if (isEnabledPlugins) {
+  var crowiPlugin = window.crowiPlugin;
+  crowiPlugin.pluginPreProcessors(crowi, crowiRenderer);
+}
+  
 const componentMappings = {
   'search-top': <HeaderSearchBox />,
   'search-page': <SearchPage />,

webpack.plugin.config.js

@@ -0,0 +1,52 @@
+var path = require('path');
+var webpack = require('webpack');
+
+var ManifestPlugin = require('webpack-manifest-plugin');
+
+var config = {
+  entry: {
+    plugin: './plugin/plugin.js',
+  },
+  output: {
+    path: path.join(__dirname + "/public/js"),
+    filename: "[name].[hash].js"
+  },
+  resolve: {
+    modulesDirectories: [
+      './node_modules', './plugin/node_modules',
+    ],
+  },
+  module: {
+    loaders: [
+      {
+        test: /.jsx?$/,
+        loader: 'babel-loader',
+        query: {
+          presets: ['es2015', 'react']
+        }
+      }
+    ]
+  },
+  plugins: []
+};
+
+if (process.env && process.env.NODE_ENV !== 'development') {
+  config.plugins = [
+    new webpack.DefinePlugin({
+      'process.env':{
+        'NODE_ENV': JSON.stringify('production')
+      }
+    }),
+    new webpack.optimize.UglifyJsPlugin({
+      compress:{
+        warnings: false
+      }
+    }),
+  ];
+}
+
+config.plugins.push(new ManifestPlugin({
+  fileName: 'manifest-plugin.json'
+}));
+
+module.exports = config;