Merge pull request #359 from nexB/215-add-license-policy

Add License Policy support

Author: steven-esser

assets/app/css/main.css

@@ -399,6 +399,22 @@ div.dataTables_scrollHead th:first-child {
 .fa_custom_nr {
   color: #1697af;
 }
+
+.fa_custom_approved {
+  color: #008000;
+}
+
+.fa_custom_prohibited {
+  color: #c83025;
+}
+
+.fa_custom_recommended {
+  color: #002FFF;
+}
+
+.fa_custom_restricted {
+  color: #FFcc33;
+}
 /*---------------------------------------
   Split.js
 -----------------------------------------*/

assets/app/js/controllers/jsTree.js

@@ -96,13 +96,25 @@ class JsTree extends Controller {
           },
           'packageFile': {
             'icon': 'fa fa-file fa_custom_package'
+          },
+          'approvedLicense': {
+            'icon': 'fa fa-check-circle fa_custom_approved'
+          },
+          'prohibitedLicense': {
+            'icon': 'fa fa-ban fa_custom_prohibited'
+          },
+          'recommendedLicense': {
+            'icon': 'fa fa-thumbs-up fa_custom_recommended'
+          },
+          'restrictedLicense': {
+            'icon': 'fa fa-exclamation-triangle fa_custom_restricted'
           }
         },
         'plugins': ['types', 'sort', 'contextmenu', 'wholerow'],
         // TODO: must fix sorting with these new types
         'sort': function (a, b) {
           const dir_types = ['directory', 'analyzedDir', 'naDir', 'ocDir', 'nrDir', 'packageDir'];
-          const file_types = ['file', 'analyzedFile', 'naFile', 'ocFile', 'ocDir', 'pacakgeFile'];
+          const file_types = ['file', 'analyzedFile', 'naFile', 'ocFile', 'ocDir', 'pacakgeFile', 'approvedLicense', 'prohibitedLicense', 'recommendedLicense', 'restrictedLicense'];
 
           const a1 = this.get_node(a);
           const b1 = this.get_node(b);

assets/app/js/controllers/scanDataTable.js

@@ -567,6 +567,13 @@ ScanDataTable.COPYRIGHT_COLUMNS =
 
 ScanDataTable.LICENSE_COLUMNS =
     [
+      {
+        'data': 'license_policy[<hr/>]',
+        'title': 'License Policy',
+        'name': 'license_policy',
+        'bar_char_class': 'bar-chart-licenses',
+        'visible': false
+      },
       {
         'data': 'license_expressions[<hr/>]',
         'title': 'License Expressions',
@@ -886,6 +893,7 @@ ScanDataTable.ORIGIN_COLUMN_NAMES =
   [
     'copyright_statements',
     'license_short_name',
+    'license_policy',
     'license_category',
     'email',
     'url',
@@ -896,6 +904,7 @@ ScanDataTable.ORIGIN_COLUMN_NAMES =
 
 ScanDataTable.LICENSE_COLUMN_NAMES = 
   [
+    'license_policy',
     'license_expressions',
     'license_key',
     'license_score',

assets/app/js/models/database.js

@@ -18,6 +18,7 @@ const headerModel = require('./header');
 const fileModel = require('./file');
 const licenseModel = require('./license');
 const licenseExpressionModel = require('./licenseExpression');
+const licensePolicyModel = require('./licensePolicy');
 const copyrightModel = require('./copyright');
 const packageModel = require('./package');
 const emailModel = require('./email');
@@ -31,6 +32,7 @@ module.exports = function(sequelize, DataTypes) {
   this.File = fileModel(sequelize, DataTypes);
   this.License = licenseModel(sequelize, DataTypes);
   this.LicenseExpression = licenseExpressionModel(sequelize, DataTypes);
+  this.LicensePolicy = licensePolicyModel(sequelize, DataTypes);
   this.Copyright = copyrightModel(sequelize, DataTypes);
   this.Package = packageModel(sequelize, DataTypes);
   this.Email = emailModel(sequelize, DataTypes);
@@ -43,6 +45,7 @@ module.exports = function(sequelize, DataTypes) {
   this.Header.hasMany(this.File);
   this.File.hasMany(this.License);
   this.File.hasMany(this.LicenseExpression);
+  this.File.hasMany(this.LicensePolicy);
   this.File.hasMany(this.Copyright);
   this.File.hasMany(this.Package);
   this.File.hasMany(this.Email);
@@ -53,6 +56,7 @@ module.exports = function(sequelize, DataTypes) {
   this.fileIncludes = [
     { model: this.License, separate: true },
     { model: this.LicenseExpression, separate: true },
+    { model: this.LicensePolicy, separate: true },
     { model: this.Copyright, separate: true },
     { model: this.Package, separate: true },
     { model: this.Email, separate: true },

assets/app/js/models/flatFile.js

@@ -31,6 +31,7 @@ module.exports = function(sequelize, DataTypes) {
       copyright_authors: jsonDataType('copyright_authors'),
       copyright_start_line: jsonDataType('copyright_start_line'),
       copyright_end_line: jsonDataType('copyright_end_line'),
+      license_policy: jsonDataType('license_policy'),
       license_expressions: jsonDataType('license_expressions'),
       license_key: jsonDataType('license_key'),
       license_score: jsonDataType('license_score'),
@@ -135,6 +136,7 @@ module.exports = function(sequelize, DataTypes) {
       copyright_authors: getCopyrightValues(file.authors),
       copyright_start_line: getValues(file.holders, 'start_line'),
       copyright_end_line: getValues(file.holders, 'end_line'),
+      license_policy: getLicensePolicyLabel(file.license_policy),
       license_expressions: file.license_expressions,
       license_key: getValues(file.licenses, 'key'),
       license_score: getValues(file.licenses, 'score'),
@@ -203,6 +205,15 @@ module.exports = function(sequelize, DataTypes) {
   return Model;
 };
 
+function getLicensePolicyLabel(policy) {
+  if (!policy) {
+    return;
+  } else if (!policy['label']) {
+    return;
+  }
+  return [policy['label']];
+}
+
 function getCopyrightValues(array) {
   if (!array) {
     array = [];

assets/app/js/models/licensePolicy.js

@@ -0,0 +1,29 @@
+/*
+ #
+ # Copyright (c) 2019 nexB Inc. and others. All rights reserved.
+ # https://nexb.com and https://github.com/nexB/scancode-workbench/
+ # The ScanCode Workbench software is licensed under the Apache License version 2.0.
+ # ScanCode is a trademark of nexB Inc.
+ #
+ # You may not use this software except in compliance with the License.
+ # You may obtain a copy of the License at: http://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.
+ #
+ */
+
+module.exports = function(sequelize, DataTypes) {
+  return sequelize.define(
+    'license_policy',
+    {
+      license_key: DataTypes.STRING,
+      label: DataTypes.STRING,
+      color_code: DataTypes.STRING,
+      icon: DataTypes.STRING
+    },
+    {
+      timestamps: false
+    });
+};

assets/app/js/workbenchDB.js

@@ -172,8 +172,16 @@ class WorkbenchDB {
       .then((concs) => concs.map((conc) => conc.fileId));
     const pkgPromise = this.db.Package.findAll({attributes: ['fileId']})
       .then((pkgs) => pkgs.map((pkg) => pkg.fileId));
-
-    return Promise.all([analyzedPromise, NAPromise, OCPromise, NRPromise,  pkgPromise]).then((promises) => this.sync
+    const approvedPromise = this.db.LicensePolicy.findAll({where: {label: 'Approved License'}, attributes: ['fileId']})
+      .then((policies) => policies.map((policy) => policy.fileId));
+    const prohibitedPromise = this.db.LicensePolicy.findAll({where: {label: 'Prohibited License'}, attributes: ['fileId']})
+      .then((policies) => policies.map((policy) => policy.fileId));
+    const recommendedPromise = this.db.LicensePolicy.findAll({where: {label: 'Recommended License'}, attributes: ['fileId']})
+      .then((policies) => policies.map((policy) => policy.fileId));
+    const restrictedPromise = this.db.LicensePolicy.findAll({where: {label: 'Restricted License'}, attributes: ['fileId']})
+      .then((policies) => policies.map((policy) => policy.fileId));
+
+    return Promise.all([analyzedPromise, NAPromise, OCPromise, NRPromise,  pkgPromise, approvedPromise, prohibitedPromise, recommendedPromise, restrictedPromise]).then((promises) => this.sync
       .then((db) => db.File.findAll(query))
       .then((files) => {
         return files.map((file) => {
@@ -196,6 +204,10 @@ class WorkbenchDB {
     const oc = promises[2];
     const nr = promises[3];
     const packages = promises[4];
+    const approvedPolicies = promises[5];
+    const prohibitedPolicies = promises[6];
+    const recommendedPolicies = promises[7];
+    const restrictedPolicies = promises[8];
 
     if (analyzed.includes(file.id)) {
       if (file.type === 'file') {
@@ -227,6 +239,14 @@ class WorkbenchDB {
       } else if (file.type === 'directory') {
         type = 'packageDir'; 
       }
+    } else if (approvedPolicies.includes(file.id)) {
+      type = 'approvedLicense';
+    } else if (prohibitedPolicies.includes(file.id)) {
+      type = 'prohibitedLicense';
+    } else if (recommendedPolicies.includes(file.id)) {
+      type = 'recommendedLicense';
+    } else if (restrictedPolicies.includes(file.id)) {
+      type = 'restrictedLicense';
     } else {
       type = file.type;
     }
@@ -372,6 +392,7 @@ class WorkbenchDB {
       return this.db.File.bulkCreate(files, options)
         .then(() => this.db.License.bulkCreate(this._addExtraFields(files, 'licenses'), options))
         .then(() => this.db.LicenseExpression.bulkCreate(this._addExtraFields(files, 'license_expressions'), options))
+        .then(() => this.db.LicensePolicy.bulkCreate(this._addExtraFields(files, 'license_policy'), options))
         .then(() => this.db.Copyright.bulkCreate(this._addExtraFields(files, 'copyrights'), options))
         .then(() => this.db.Package.bulkCreate(this._addExtraFields(files, 'packages'), options))
         .then(() => this.db.Email.bulkCreate(this._addExtraFields(files, 'emails'), options))
@@ -388,6 +409,8 @@ class WorkbenchDB {
     return $.map(files, (file) => {
       if (attribute === 'copyrights') {
         return this._getNewCopyrights(file);
+      } else if (attribute === 'license_policy') {
+        return this._getLicensePolicy(file);
       }
       return $.map(file[attribute] || [], (value) => {
         if (attribute === 'license_expressions') {
@@ -402,6 +425,15 @@ class WorkbenchDB {
     });
   }
 
+  _getLicensePolicy(file) {
+    if ($.isEmptyObject(file.license_policy)) {
+      return;
+    }
+    const license_policy = file.license_policy;
+    license_policy.fileId = file.id;
+    return license_policy;
+  }
+
   _getNewCopyrights(file) {
     const statements = file.copyrights;
     const holders = file.holders;