Added generation report page from project page

scripts/build.js

@@ -21,7 +21,7 @@ process.env.NODE_ENV = 'production';
 
 const chalk = require('chalk');
 const webpack = require('webpack');
-const config = require('../conf/webpack/webpack.config.prod.js');
+const config = require('../src/main/js/conf/webpack/webpack.config.prod.js');
 
 function formatSize(bytes) {
   if (bytes === 0) {

src/main/java/fr/cnes/sonar/plugin/web/ReportPluginPageDefinition.java

@@ -30,9 +30,13 @@ public class ReportPluginPageDefinition implements PageDefinition {
      */
     @Override
     public void define(Context context) {
-        Page.Builder page = Page.builder(PluginStringManager.getProperty("homepage.url"));
-        page.setName(PluginStringManager.getProperty("homepage.name"));
-        page.setScope(Page.Scope.GLOBAL);
-        context.addPage(page.build());
+        context.addPage(Page.builder(PluginStringManager.getProperty("homepage.url"))
+                .setName(PluginStringManager.getProperty("homepage.name"))
+                .setScope(Page.Scope.GLOBAL)
+                .build());
+        context.addPage(Page.builder(PluginStringManager.getProperty("projectpage.url"))
+                .setName(PluginStringManager.getProperty("projectpage.name"))
+                .setScope(Page.Scope.COMPONENT)
+                .build());
     }
 }

src/main/js/project_page/index.js

@@ -0,0 +1,34 @@
+/*
+ * Copyright (C) 2009-2020 SonarSource SA
+ * mailto:info AT sonarsource DOT com
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 3 of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+ */
+// Necessary for setting up, because of Webpack.
+
+import React from "react";
+import CnesReportProject from "./view/CnesReportProject";
+import "./style.css";
+
+
+// This creates a page for any component (project, portfolio, etc).
+//
+//  You can access it at /project/extension/example/project_page?id={COMPONENT_ID}
+window.registerExtension('cnesreport/projectreport', function (options) {
+  // options.el contains the DOM node we can use for our app. Prepare our node
+  // so our Backbone View can correctly target it.
+  return <CnesReportProject options={options} />;
+
+});

src/main/js/project_page/style.css

@@ -0,0 +1,81 @@
+/* General Styles */
+.maintenance-title {
+    font-size: 35px;
+    color: #333;
+    margin-top: 20px;
+    text-align: center;
+}
+
+#generation-form {
+    margin: 20px auto;
+    max-width: 500px;
+    padding: 20px;
+    background-color: #f9f9f9;
+    border: 1px solid #ccc;
+    border-radius: 5px;
+}
+
+.forminput {
+    margin-bottom: 15px;
+}
+
+.login-label {
+    display: block;
+    margin-bottom: 5px;
+    color: #555;
+}
+
+.login-input {
+    width: 100%;
+    padding: 10px;
+    font-size: 16px;
+    border: 1px solid #ccc;
+    border-radius: 5px;
+    box-sizing: border-box;
+}
+
+/* Button Styles */
+#generation {
+    display: block;
+    margin: 0 auto;
+    font-size: 20px;
+    padding: 10px 20px;
+    background-color: #4CAF50;
+    color: white;
+    border: none;
+    border-radius: 5px;
+    cursor: pointer;
+    transition: background-color 0.3s ease;
+}
+
+#generation:hover {
+    background-color: #45a049;
+}
+
+#generation:active {
+    transform: translateY(2px);
+}
+
+/* Checkbox Styles */
+.checkbox-label {
+    display: block;
+    margin-bottom: 5px;
+    color: #555;
+}
+
+.checkbox-input {
+    margin-right: 5px;
+}
+
+/* Optional: Styles for success/error messages */
+.success-message {
+    color: green;
+    font-weight: bold;
+    margin-top: 10px;
+}
+
+.error-message {
+    color: red;
+    font-weight: bold;
+    margin-top: 10px;
+}

src/main/js/project_page/view/CnesReportProject.js

@@ -0,0 +1,177 @@
+/**
+ * Main JS component of the plugin
+ * Written with ReactJS
+ */
+
+import React from "react";
+
+import { initiatePluginToken, isCompatible } from "../../common/api";
+
+export default class CnesReportProject extends React.PureComponent {
+    state = {
+        loading: true,
+        token: "",
+        author: "",
+        languages: [{id: 'en_US', name: 'English'}, {id: 'fr_FR', name: 'French'}],
+        enableDocx: true,
+        enableMd: true,
+        enableXlsx: true,
+        enableCsv: true,
+        enableConf: true,
+        isSupported: true
+    };
+
+    onChangeAuthor = (event) => {
+        this.setState({ author: event.target.value })
+    };
+
+    onChangeCheckbox = (stateParam) => {
+        switch (stateParam) {
+            case 'enableDocx':
+                this.setState({enableDocx: !this.state.enableDocx});
+                break;
+            case 'enableMd':
+                this.setState({enableMd: !this.state.enableMd});
+                break;
+            case 'enableXlsx':
+                this.setState({enableXlsx: !this.state.enableXlsx});
+                break;
+            case 'enableCsv':
+                this.setState({enableCsv: !this.state.enableCsv});
+                break;
+            case 'enableConf':
+                this.setState({enableConf: !this.state.enableConf});
+                break;
+          }
+    }
+
+    // disable generate button if no checkbox is checked to prevent the generation of an empty zip
+    shouldDisableGeneration = () => {
+        return !(this.state.enableDocx || this.state.enableMd || this.state.enableXlsx
+            || this.state.enableCsv || this.state.enableConf);
+    }
+
+    componentDidMount() {
+        // Initialize compatibility check
+        isCompatible().then(isSupported => {
+            this.setState({ isSupported });
+        });
+
+        // Initialize data in form
+        initiatePluginToken().then(tokenInfo => {
+            this.setState({ token: tokenInfo.token, author: tokenInfo.author, loading: false });
+        });
+    }
+
+    render() {
+        if (this.state.loading) {
+            return <div className="page page-limited"><p>Loading ...</p></div>;
+        }
+
+        const options = this.props.options;
+
+        let languagesList = this.state.languages.map((item, i) => {
+            return (
+                <option key={i} value={item.id}>{item.name}</option>
+            )
+        })
+
+        return (
+            <div class="page-wrapper-simple">
+                <div class="page-simple">
+                    <h1 class="maintenance-title text-center">Generate a report for this project and branch</h1>
+                    { !this.state.isSupported &&
+                        <div class="compatibility-warning">
+                            <p>This SonarQube version is not supported by this cnesreport version.</p>
+                            <p>For further information, please refer to the <a href="https://github.com/cnescatlab/sonar-cnes-report#compatibility-matrix">compatibility matrix</a> on the project GitHub page.</p>
+                        </div>
+                    }
+                    <form id="generation-form" action="../../../api/cnesreport/report" method="get">
+                        <div class='forminput'>
+                            <label for="language" id="languageLabel" class="login-label"><strong>Report language</strong></label>
+                            <select id="language"
+                                name="language"
+                                class="login-input" required>
+                                {languagesList}
+                            </select>
+                        </div>
+                        <div class='forminput'>
+                            <label for="author" id="authorLabel" class="login-label"><strong>Author</strong></label>
+                            <input type="text"
+                                id="author"
+                                name="author"
+                                class="login-input"
+                                maxlength="255"
+                                required
+                                placeholder="Report's author" value={this.state.author}
+                                onChange={this.onChangeAuthor} />
+                            <input type="hidden" name="token" id="token_cnesreport" defaultValue={this.state.token} />
+                            <input type="hidden" name="key" id="key" defaultValue={options.component.key} />
+                            <input type="hidden" name="branch" id="branch" defaultValue={options.component.branch} />
+                        </div>
+                        <div>
+                            {/*
+                                We need a hidden field for each checkbox in case it is unchecked because otherwise no value is sent and
+                                we want that if we don't fill in a parameter then the api uses the default value i.e. the document is
+                                generated.
+                            */}
+                            <input id="enableDocxHidden" type="hidden" value="false" name="enableDocx" disabled={this.state.enableDocx}/>
+                            <input type="checkbox"
+                                id="enableDocx"
+                                name="enableDocx"
+                                value="true"
+                                defaultChecked={this.state.enableDocx}
+                                onChange={() => this.onChangeCheckbox('enableDocx')}/>
+                            <label for="enableDocx" id="enableDocxLabel"><strong>Enable DOCX generation</strong></label>
+                        </div>
+                        <div>
+                            <input id="enableMdHidden" type="hidden" value="false" name="enableMd" disabled={this.state.enableMd}/>
+                            <input type="checkbox"
+                                id="enableMd"
+                                name="enableMd"
+                                value="true"
+                                defaultChecked={this.state.enableMd}
+                                onChange={() => this.onChangeCheckbox('enableMd')}/>
+                            <label for="enableMd" id="enableMdLabel"><strong>Enable MD generation</strong></label>
+                        </div>
+                        <div>
+                            <input id="enableXlsxHidden" type="hidden" value="false" name="enableXlsx" disabled={this.state.enableXlsx}/>
+                            <input type="checkbox"
+                                id="enableXlsx"
+                                name="enableXlsx"
+                                value="true"
+                                defaultChecked={this.state.enableXlsx}
+                                onChange={() => this.onChangeCheckbox('enableXlsx')}/>
+                            <label for="enableXlsx" id="enableXlsxLabel"><strong>Enable XLSX generation</strong></label>
+                        </div>
+                        <div>
+                            <input id="enableCsvHidden" type="hidden" value="false" name="enableCsv" disabled={this.state.enableCsv}/>
+                            <input type="checkbox"
+                                id="enableCsv"
+                                name="enableCsv"
+                                value="true"
+                                defaultChecked={this.state.enableCsv}
+                                onChange={() => this.onChangeCheckbox('enableCsv')}/>
+                            <label for="enableCsv" id="enableCsvLabel"><strong>Enable CSV generation</strong></label>
+                        </div>
+                        <div>
+                            <input id="enableConfHidden" type="hidden" value="false" name="enableConf" disabled={this.state.enableConf}/>
+                            <input type="checkbox"
+                                id="enableConf"
+                                name="enableConf"
+                                value="true"
+                                defaultChecked={this.state.enableConf}
+                                onChange={() => this.onChangeCheckbox('enableConf')}/>
+                            <label for="enableConf" id="enableConfLabel"><strong>Enable quality configuration generation</strong></label>
+                        </div>
+                        <br />
+                        <input id="generation" name="generation" type="submit" value="Generate"
+                            disabled={this.shouldDisableGeneration()}/>
+                        <br />
+                        <em class="info-message">This operation may take some time, please wait while the report is being generated.</em>
+                    </form>
+                </div>
+            </div>
+        );
+    }
+}

src/main/resources/plugin.properties

@@ -17,6 +17,8 @@
 
 homepage.url=cnesreport/report
 homepage.name=CNES Report
+projectpage.url=cnesreport/projectreport
+projectpage.name=Generate Project Report
 
 plugin.since=6.5
 plugin.defaultHost=http://localhost:%s%s