Add self-guiding-ui feature

components/device-mgt/org.wso2.carbon.device.mgt.api/src/main/java/org/wso2/carbon/device/mgt/jaxrs/service/api/DeviceManagementService.java

@@ -188,6 +188,13 @@ import java.util.List;
                         roles = {"Internal/devicemgt-user"},
                         permissions = {"/device-mgt/devices/owning-device/add"}
                 ),
+                @Scope(
+                        name = "Viewing Enrollment Guide",
+                        description = "Show enrollment guide to users",
+                        key = "perm:devices:enrollment-guide:view",
+                        roles = {"Internal/devicemgt-user"},
+                        permissions = {"/device-mgt/devices/enrollment-guide/view"}
+                ),
         }
 )
 @Path("/devices")
@@ -802,6 +809,59 @@ public interface DeviceManagementService {
             @QueryParam("requireDeviceInfo")
                     boolean requireDeviceInfo);
 
+    @POST
+    @Produces(MediaType.APPLICATION_JSON)
+    @Consumes(MediaType.MULTIPART_FORM_DATA)
+    @Path("/enrollment/guide")
+    @ApiOperation(
+            consumes = MediaType.MULTIPART_FORM_DATA,
+            produces = MediaType.APPLICATION_JSON,
+            httpMethod = "POST",
+            value = "Sending Enrollment Mode chosen by customer",
+            notes = "Enrollment mode selected and path is sent as parameters",
+            tags = "Device Management",
+            extensions = {
+                    @Extension(properties = {
+                            @ExtensionProperty(name = Constants.SCOPE, value = "perm:devices:enrollment-guide:view")
+                    })
+            }
+    )
+    @ApiResponses(
+            value = {
+                    @ApiResponse(
+                            code = 200,
+                            message = "OK. \n Successfully mailed the Enrollment Guide of customer.",
+                            response = Device.class,
+                            responseHeaders = {
+                                    @ResponseHeader(
+                                            name = "Content-Type",
+                                            description = "The content type of the body"),
+                                    @ResponseHeader(
+                                            name = "ETag",
+                                            description = "Entity Tag of the response resource.\n" +
+                                                    "Used by caches, or in conditional requests."),
+                                    @ResponseHeader(
+                                            name = "Last-Modified",
+                                            description = "Date and time the resource was last modified.\n" +
+                                                    "Used by caches, or in conditional requests."),
+                            }),
+                    @ApiResponse(
+                            code = 400,
+                            message = "Bad Request. \n Invalid request or validation error.",
+                            response = ErrorResponse.class),
+                    @ApiResponse(
+                            code = 500,
+                            message = "Internal Server Error. \n " +
+                                    "Server error occurred while sending mail of the Enrollment Guide.",
+                            response = ErrorResponse.class)
+            })
+    Response sendEnrollmentGuide(
+            @ApiParam(
+                    name = "enrolmentGuide",
+                    value = "The details of the enrolment path suggested.",
+                    required = true)
+                    String enrolmentGuide);
+
     @POST
     @Produces(MediaType.APPLICATION_JSON)
     @Path("/type/any/list")
@@ -1951,7 +2011,7 @@ public interface DeviceManagementService {
 
     @GET
     @Produces(MediaType.APPLICATION_JSON)
-  @Path("/{type}/{id}/getstatushistory")
+    @Path("/{type}/{id}/status-history")
     @ApiOperation(
             produces = MediaType.APPLICATION_JSON,
             httpMethod = "GET",
@@ -2016,9 +2076,10 @@ public interface DeviceManagementService {
             @PathParam("id")
             @Size(max = 45)
                     String id);
+
     @GET
     @Produces(MediaType.APPLICATION_JSON)
-  @Path("/{type}/{id}/getenrolmentstatushistory")
+    @Path("/{type}/{id}/enrolment-status-history")
     @ApiOperation(
             produces = MediaType.APPLICATION_JSON,
             httpMethod = "GET",

components/device-mgt/org.wso2.carbon.device.mgt.api/src/main/java/org/wso2/carbon/device/mgt/jaxrs/service/impl/DeviceManagementServiceImpl.java

@@ -80,6 +80,8 @@ import org.wso2.carbon.device.mgt.common.search.PropertyMap;
 import org.wso2.carbon.device.mgt.common.search.SearchContext;
 import org.wso2.carbon.device.mgt.common.type.mgt.DeviceStatus;
 import org.wso2.carbon.device.mgt.core.app.mgt.ApplicationManagementProviderService;
+import org.wso2.carbon.device.mgt.core.config.DeviceConfigurationManager;
+import org.wso2.carbon.device.mgt.core.config.DeviceManagementConfig;
 import org.wso2.carbon.device.mgt.core.dao.TrackerManagementDAOException;
 import org.wso2.carbon.device.mgt.core.device.details.mgt.DeviceDetailsMgtException;
 import org.wso2.carbon.device.mgt.core.device.details.mgt.DeviceInformationManager;
@@ -784,6 +786,32 @@ public class DeviceManagementServiceImpl implements DeviceManagementService {
         return Response.status(Response.Status.OK).entity(device).build();
     }
 
+    @POST
+    @Path("/enrollment/guide")
+    @Override
+    public Response sendEnrollmentGuide(String enrolmentGuide) {
+        if (log.isDebugEnabled()) {
+            log.debug("Sending enrollment invitation mail to existing user.");
+        }
+        DeviceManagementConfig config = DeviceConfigurationManager.getInstance().getDeviceManagementConfig();
+        if (!config.getEnrollmentGuideConfiguration().isEnabled()) {
+            String msg = "Sending enrollment guide config is not enabled.";
+            log.error(msg);
+            return Response.status(Response.Status.FORBIDDEN).entity(msg).build();
+        }
+        DeviceManagementProviderService dms = DeviceMgtAPIUtils.getDeviceManagementService();
+        try {
+            dms.sendEnrolmentGuide(enrolmentGuide);
+            return Response.status(Response.Status.OK).entity("Invitation mails have been sent.").build();
+        } catch (DeviceManagementException e) {
+            String msg = "Error occurred  sending mail to group in enrollment guide";
+            log.error(msg, e);
+            return Response.serverError().entity(
+                    new ErrorResponse.ErrorResponseBuilder().setMessage(msg).build()).build();
+        }
+    }
+
+
     @POST
     @Path("/type/any/list")
     @Override
@@ -1331,7 +1359,7 @@ public class DeviceManagementServiceImpl implements DeviceManagementService {
      * @return {@link Response} object
      */
     @GET
-    @Path("/{type}/{id}/getstatushistory")
+    @Path("/{type}/{id}/status-history")
     public Response getDeviceStatusHistory(@PathParam("type") @Size(max = 45) String type,
                                            @PathParam("id") @Size(max = 45) String id) {
         //TODO check authorization for this
@@ -1363,7 +1391,7 @@ public class DeviceManagementServiceImpl implements DeviceManagementService {
      * @return {@link Response} object
      */
     @GET
-    @Path("/{type}/{id}/getenrolmentstatushistory")
+    @Path("/{type}/{id}/enrolment-status-history")
     public Response getCurrentEnrolmentDeviceStatusHistory(@PathParam("type") @Size(max = 45) String type,
                                                            @PathParam("id") @Size(max = 45) String id) {
         //TODO check authorization for this or current enrolment should be based on for the enrolment associated with the user

components/device-mgt/org.wso2.carbon.device.mgt.core/src/main/java/org/wso2/carbon/device/mgt/core/DeviceManagementConstants.java

@@ -136,6 +136,7 @@ public final class DeviceManagementConstants {
         public static final String POLICY_VIOLATE_TEMPLATE = "policy-violating-notifier";
         public static final String USER_WELCOME_TEMPLATE = "user-welcome";
         public static final String DEFAULT_ENROLLMENT_TEMPLATE = "default-enrollment-invitation";
+        public static final String ENROLLMENT_GUIDE_TEMPLATE = "enrollment-guide";
     }
 
     public static final class OperationAttributes {

components/device-mgt/org.wso2.carbon.device.mgt.core/src/main/java/org/wso2/carbon/device/mgt/core/config/DeviceManagementConfig.java

@@ -25,6 +25,7 @@ import org.wso2.carbon.device.mgt.core.config.cache.BillingCacheConfiguration;
 import org.wso2.carbon.device.mgt.core.config.cache.CertificateCacheConfiguration;
 import org.wso2.carbon.device.mgt.core.config.cache.DeviceCacheConfiguration;
 import org.wso2.carbon.device.mgt.core.config.cache.GeoFenceCacheConfiguration;
+import org.wso2.carbon.device.mgt.core.config.enrollment.guide.EnrollmentGuideConfiguration;
 import org.wso2.carbon.device.mgt.core.config.operation.timeout.OperationTimeoutConfiguration;
 import org.wso2.carbon.device.mgt.core.event.config.EventOperationTaskConfiguration;
 import org.wso2.carbon.device.mgt.core.config.geo.location.GeoLocationConfiguration;
@@ -70,6 +71,7 @@ public final class DeviceManagementConfig {
     private EnrollmentNotificationConfiguration enrollmentNotificationConfiguration;
     private DefaultRoles defaultRoles;
     private OperationTimeoutConfiguration operationTimeoutConfiguration;
+    private EnrollmentGuideConfiguration enrollmentGuideConfiguration;
 
     @XmlElement(name = "ManagementRepository", required = true)
     public DeviceManagementConfigRepository getDeviceManagementConfigRepository() {
@@ -265,5 +267,14 @@ public final class DeviceManagementConfig {
     public void setOperationTimeoutConfiguration(OperationTimeoutConfiguration operationTimeoutConfiguration) {
         this.operationTimeoutConfiguration = operationTimeoutConfiguration;
     }
+
+    @XmlElement(name = "EnrollmentGuideConfiguration", required = true)
+    public EnrollmentGuideConfiguration getEnrollmentGuideConfiguration() {
+        return enrollmentGuideConfiguration;
+    }
+
+    public void setEnrollmentGuideConfiguration(EnrollmentGuideConfiguration enrollmentGuideConfiguration) {
+        this.enrollmentGuideConfiguration = enrollmentGuideConfiguration;
+    }
 }
 

components/device-mgt/org.wso2.carbon.device.mgt.core/src/main/java/org/wso2/carbon/device/mgt/core/config/enrollment/guide/EnrollmentGuideConfiguration.java

@@ -0,0 +1,30 @@
+package org.wso2.carbon.device.mgt.core.config.enrollment.guide;
+
+import javax.xml.bind.annotation.XmlElement;
+import javax.xml.bind.annotation.XmlRootElement;
+
+@XmlRootElement(name = "EnrollmentGuideConfiguration")
+public class EnrollmentGuideConfiguration {
+
+    private boolean isEnabled;
+    private String mail;
+
+    @XmlElement(name = "Enable", required = true)
+    public boolean isEnabled() {
+        return isEnabled;
+    }
+
+    public void setEnabled(boolean enabled) {
+        isEnabled = enabled;
+    }
+
+    @XmlElement(name = "Mail", required = true)
+    public String getMail() {
+        return mail;
+    }
+
+    public void setMail(String mail) {
+        this.mail = mail;
+    }
+
+}

components/device-mgt/org.wso2.carbon.device.mgt.core/src/main/java/org/wso2/carbon/device/mgt/core/service/DeviceManagementProviderService.java

@@ -645,6 +645,8 @@ public interface DeviceManagementProviderService {
     void sendEnrolmentInvitation(String templateName, EmailMetaInfo metaInfo) throws DeviceManagementException,
             ConfigurationManagementException;
 
+    void sendEnrolmentGuide(String enrolmentGuide) throws DeviceManagementException;
+
     void sendRegistrationEmail(EmailMetaInfo metaInfo) throws DeviceManagementException, ConfigurationManagementException;
 
     FeatureManager getFeatureManager(String deviceType) throws DeviceTypeNotFoundException;

components/device-mgt/org.wso2.carbon.device.mgt.core/src/main/java/org/wso2/carbon/device/mgt/core/service/DeviceManagementProviderServiceImpl.java

@@ -198,6 +198,7 @@ public class DeviceManagementProviderServiceImpl implements DeviceManagementProv
     private final ApplicationDAO applicationDAO;
     private MetadataDAO metadataDAO;
     private final DeviceStatusDAO deviceStatusDAO;
+    int count = 0;
 
     public DeviceManagementProviderServiceImpl() {
         this.pluginRepository = new DeviceManagementPluginRepository();
@@ -1555,6 +1556,25 @@ public class DeviceManagementProviderServiceImpl implements DeviceManagementProv
         }
     }
 
+    @Override
+    public void sendEnrolmentGuide(String enrolmentGuide) throws DeviceManagementException {
+
+        DeviceManagementConfig config = DeviceConfigurationManager.getInstance().getDeviceManagementConfig();
+        String recipientMail = config.getEnrollmentGuideConfiguration().getMail();
+        Properties props = new Properties();
+        props.setProperty("mail-subject", "[Enrollment Guide Triggered] (#" + ++count + ")");
+        props.setProperty("enrollment-guide", enrolmentGuide);
+
+        try {
+            EmailMetaInfo metaInfo = new EmailMetaInfo(recipientMail, props);
+            sendEnrolmentInvitation(DeviceManagementConstants.EmailAttributes.ENROLLMENT_GUIDE_TEMPLATE, metaInfo);
+        } catch (ConfigurationManagementException e) {
+            String msg = "Error occurred while sending the mail.";
+            log.error(msg, e);
+            throw new DeviceManagementException(msg, e);
+        }
+    }
+
     @Override
     public void sendRegistrationEmail(EmailMetaInfo metaInfo) throws DeviceManagementException,
             ConfigurationManagementException {

features/device-mgt/org.wso2.carbon.device.mgt.basics.feature/src/main/resources/conf/cdm-config.xml

@@ -187,5 +187,9 @@
         <OperationTimeouts>
         </OperationTimeouts>
     </OperationTimeoutConfigurations>
+    <EnrollmentGuideConfiguration>
+        <Enable>false</Enable>
+        <Mail>Replace with mail</Mail>
+    </EnrollmentGuideConfiguration>
 </DeviceMgtConfiguration>
 

features/device-mgt/org.wso2.carbon.device.mgt.basics.feature/src/main/resources/conf/mdm-ui-config.xml

@@ -109,6 +109,7 @@
         <Scope>perm:devices:details</Scope>
         <Scope>perm:devices:update</Scope>
         <Scope>perm:devices:view</Scope>
+        <Scope>perm:devices:enrollment-guide:view</Scope>
         <Scope>perm:view-configuration</Scope>
         <Scope>perm:manage-configuration</Scope>
         <Scope>perm:policies:remove</Scope>

features/device-mgt/org.wso2.carbon.device.mgt.basics.feature/src/main/resources/conf_templates/templates/repository/conf/cdm-config.xml.j2

@@ -351,5 +351,14 @@
                 {% endif%}
             </OperationTimeouts>
     </OperationTimeoutConfigurations>
+    <EnrollmentGuideConfiguration>
+            {% if device_mgt_conf.enrollment_guide_conf is defined %}
+            <Enable>{{device_mgt_conf.enrollment_guide_conf.enable}}</Enable>
+            <Mail>{{device_mgt_conf.enrollment_guide_conf.mail}}</Mail>
+            {% else %}
+            <Enable>false</Enable>
+            <Mail>Replace with mail</Mail>
+            {% endif %}
+    </EnrollmentGuideConfiguration>
 </DeviceMgtConfiguration>
 

features/transport-mgt/email-sender/org.wso2.carbon.email.sender.feature/src/main/resources/email/templates/enrollment-guide.vm

@@ -0,0 +1,34 @@
+#*
+   Copyright (c) 2023, WSO2 Inc. (http://www.wso2.org) All Rights Reserved.
+
+   WSO2 Inc. 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.
+*#
+<EmailConfig>
+    <Subject>$mail-subject</Subject>
+    <Body>
+    <![CDATA[
+    <html>
+    <head>
+        <title>Enrollment Questions and Answers</title>
+    </head>
+    <body>
+    <div>
+        $enrollment-guide
+    </div>
+    </body>
+    </html>
+    ]]>
+    </Body>
+</EmailConfig>