feat(#2975): Add configurable documentation links (#2978)

* feat(#2975): Add documentation links to model, modify info view

* feat(#2975): Add configurable application links

* Fix checkstyle

---------

Co-authored-by: Dominik Riemer <[email protected]>

ui/src/app/info/about/about.component.scss → streampipes-model/src/main/java/org/apache/streampipes/model/configuration/DefaultGeneralConfig.java

@@ -16,16 +16,13 @@
  *
  */
 
-.about-logo {
-    width: 300px;
-}
+package org.apache.streampipes.model.configuration;
 
-.about-container {
-    margin-top: 20px;
-    margin-left: auto;
-    margin-right: auto;
-}
+public class DefaultGeneralConfig {
 
-.p-10 {
-    padding: 10px;
+  public GeneralConfig make() {
+    var generalConfig = new GeneralConfig();
+    generalConfig.setLinkSettings(new DefaultLinkSettings().make());
+    return generalConfig;
+  }
 }

ui/src/app/info/license/license.component.ts → streampipes-model/src/main/java/org/apache/streampipes/model/configuration/DefaultLinkSettings.java

@@ -16,13 +16,18 @@
  *
  */
 
-import { Component } from '@angular/core';
+package org.apache.streampipes.model.configuration;
 
-@Component({
-    selector: 'sp-license',
-    templateUrl: './license.component.html',
-    styleUrls: ['./license.component.scss'],
-})
-export class LicenseComponent {
-    constructor() {}
+public class DefaultLinkSettings {
+
+  public LinkSettings make() {
+    return new LinkSettings(
+        "https://streampipes.apache.org",
+        "",
+        true,
+        true,
+        false,
+        true
+    );
+  }
 }

streampipes-model/src/main/java/org/apache/streampipes/model/configuration/DefaultSpCoreConfiguration.java

@@ -29,7 +29,7 @@ public class DefaultSpCoreConfiguration {
   public SpCoreConfiguration make() {
     var coreCfg = new SpCoreConfiguration();
 
-    coreCfg.setGeneralConfig(new GeneralConfig());
+    coreCfg.setGeneralConfig(new DefaultGeneralConfig().make());
     coreCfg.setMessagingSettings(new DefaultMessagingSettings().make());
     coreCfg.setEmailConfig(EmailConfig.fromDefaults());
     coreCfg.setEmailTemplateConfig(new DefaultEmailTemplateConfiguration().getDefaultTemplates());

streampipes-model/src/main/java/org/apache/streampipes/model/configuration/GeneralConfig.java

@@ -31,6 +31,7 @@ public class GeneralConfig {
   private boolean allowPasswordRecovery;
 
   private List<String> defaultUserRoles;
+  private LinkSettings linkSettings;
 
   public GeneralConfig() {
   }
@@ -104,4 +105,12 @@ public String getAppName() {
   public void setAppName(String appName) {
     this.appName = appName;
   }
+
+  public LinkSettings getLinkSettings() {
+    return linkSettings;
+  }
+
+  public void setLinkSettings(LinkSettings linkSettings) {
+    this.linkSettings = linkSettings;
+  }
 }

ui/src/app/info/info.component.scss → streampipes-model/src/main/java/org/apache/streampipes/model/configuration/LinkSettings.java

@@ -16,14 +16,14 @@
  *
  */
 
-.pageheadbar {
-    padding: 0 0 0 10px;
-    background-color: #f6f6f6;
-    font-size: 14px;
-    line-height: 24px;
-    border-bottom: 1px solid #ccc;
-}
+package org.apache.streampipes.model.configuration;
 
-.margin-top {
-    margin-top: 5px;
-}
+import org.apache.streampipes.model.shared.annotation.TsModel;
+
+@TsModel
+public record LinkSettings(String documentationUrl,
+                           String supportUrl,
+                           boolean showDocumentationLinkOnStartScreen,
+                           boolean showApiDocumentationLinkOnStartScreen,
+                           boolean showSupportUrlOnStartScreen,
+                           boolean showDocumentationLinkInProfileMenu) {}

streampipes-rest/src/main/java/org/apache/streampipes/rest/impl/Authentication.java

@@ -138,6 +138,7 @@ public ResponseEntity<Map<String, Object>> getAuthSettings() {
     Map<String, Object> response = new HashMap<>();
     response.put("allowSelfRegistration", config.isAllowSelfRegistration());
     response.put("allowPasswordRecovery", config.isAllowPasswordRecovery());
+    response.put("linkSettings", config.getLinkSettings());
 
     return ok(response);
   }

streampipes-service-core/src/main/java/org/apache/streampipes/service/core/migrations/AvailableMigrations.java

@@ -26,6 +26,7 @@
 import org.apache.streampipes.service.core.migrations.v093.AdapterMigration;
 import org.apache.streampipes.service.core.migrations.v093.StoreEmailTemplatesMigration;
 import org.apache.streampipes.service.core.migrations.v095.MergeFilenamesAndRenameDuplicatesMigration;
+import org.apache.streampipes.service.core.migrations.v970.AddLinkSettingsMigration;
 
 import java.util.Arrays;
 import java.util.List;
@@ -40,7 +41,8 @@ public List<Migration> getAvailableMigrations() {
         new UpdateUsernameViewMigration(),
         new AdapterMigration(),
         new StoreEmailTemplatesMigration(),
-        new MergeFilenamesAndRenameDuplicatesMigration()
+        new MergeFilenamesAndRenameDuplicatesMigration(),
+        new AddLinkSettingsMigration()
     );
   }
 }

streampipes-service-core/src/main/java/org/apache/streampipes/service/core/migrations/v970/AddLinkSettingsMigration.java

@@ -0,0 +1,52 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You 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.
+ *
+ */
+
+package org.apache.streampipes.service.core.migrations.v970;
+
+import org.apache.streampipes.model.configuration.DefaultLinkSettings;
+import org.apache.streampipes.service.core.migrations.Migration;
+import org.apache.streampipes.storage.api.ISpCoreConfigurationStorage;
+import org.apache.streampipes.storage.management.StorageDispatcher;
+
+import java.io.IOException;
+
+public class AddLinkSettingsMigration implements Migration {
+
+  private final ISpCoreConfigurationStorage coreConfigStore = StorageDispatcher
+      .INSTANCE
+      .getNoSqlStore()
+      .getSpCoreConfigurationStorage();
+
+  @Override
+  public boolean shouldExecute() {
+    return coreConfigStore.get().getGeneralConfig().getLinkSettings() == null;
+  }
+
+  @Override
+  public void executeMigration() throws IOException {
+    var linkSettings = new DefaultLinkSettings().make();
+    var coreConfig = coreConfigStore.get();
+    coreConfig.getGeneralConfig().setLinkSettings(linkSettings);
+    coreConfigStore.updateElement(coreConfig);
+  }
+
+  @Override
+  public String getDescription() {
+    return "Adding link settings to general config";
+  }
+}

ui/projects/streampipes/platform-services/src/lib/model/config/general-config.model.ts

@@ -16,6 +16,8 @@
  *
  */
 
+import { LinkSettings } from '../gen/streampipes-model';
+
 export interface GeneralConfigModel {
     hostname: string;
     port: number;
@@ -25,4 +27,5 @@ export interface GeneralConfigModel {
     allowSelfRegistration: boolean;
     defaultUserRoles: string[];
     appName: string;
+    linkSettings: LinkSettings;
 }