Merge pull request #280 from cap-java/linkSupport

Link support

Author: yashmeet29

README.md

@@ -13,10 +13,12 @@ This plugin can be consumed by the CAP application deployed on BTP to store thei
 - Virus scanning : Provides the capability to support virus scan for virus scan enabled repositories.
 - Draft functionality : Provides the capability of working with draft attachments.
 - Display attachments specific to repository: Lists attachments contained in the repository that is configured with the CAP application.
+- Custom properties : Provides the capability to define custom properties for attachments.
 - Maximum allowed uploads: Provides the capability to define the maximum number of uploads allowed for the user.
 - Multiple attachment facets: Provides the capability to define multiple attachment facets/sections in the CAP Entity.
 - Technical user support: Provides the capability to consume the plugin using technical user.
 - Copy attachments: Provides the capability to copy attachments from one entity to another entity.
+- Link as attachments: Provides the capability to support link or URL as attachments.
 
 ## Table of Contents
 
@@ -30,6 +32,7 @@ This plugin can be consumed by the CAP application deployed on BTP to store thei
 - [Support for Multiple attachment facets](#support-for-multiple-attachment-facets)
 - [Support for Technical user](#support-for-technical-user)
 - [Support for Copy attachments](#support-for-copy-attachments)
+- [Support for Link type attachments](#support-for-link-type-attachments)
 - [Known Restrictions](#known-restrictions)
 - [Support, Feedback, Contributing](#support-feedback-contributing)
 - [Code of Conduct](#code-of-conduct)
@@ -556,6 +559,189 @@ This plugin provides capability to copy attachments from one entity to another.
    }
    ```
 
+## Support for link type attachments
+
+> **Note:** Row-press is the new recommended approach for handling actions on attachment rows. With row-press enabled, the Attachments column will no longer appear as a separate action button. Instead, clicking on a row will automatically perform the appropriate action — opening a link or downloading a file, based on the attachment type.
+
+This plugin provides the capability to create, open, rename and delete attachments of link type.
+
+### Steps to Enable Row-Press for Open Link
+
+1. **Add the `openAttachment` action to application's service definition**
+   
+   See this [example](https://github.com/cap-java/sdm/blob/90cfc716967d844e114457a710daebdd55431965/cap-notebook/demoapp/srv/admin-service.cds#L19) from a sample Bookshop app.
+
+   ```cds
+   action openAttachment() returns String;
+   ```
+
+2. **Add a custom controller extension** 
+
+   In webapp/controller/custom.controller.js, copy and paste below content.
+   
+   See this [example](https://github.com/cap-java/sdm/blob/develop_deploy/cap-notebook/demoapp/app/admin-books/webapp/controller/custom.controller.js) from a sample Bookshop app.
+   
+   ```js
+   sap.ui.define(
+      [
+      "sap/ui/core/mvc/ControllerExtension",
+      "sap/m/library"
+      ], 
+      function (ControllerExtension,library) {
+         "use strict";
+      
+         return ControllerExtension.extend("books.controller.custom", {
+               onRowPress: function(oContext) {
+                  this.base.editFlow
+                  .invokeAction("AdminService.openAttachment", {
+                     contexts: oContext.getParameter("bindingContext")
+                  })
+                  .then(function (res) {
+                     let odataurl = "";
+                     if(res.getObject().value == "None") {
+                           const lastSlashIndex = res.oModel.getServiceUrl().lastIndexOf('/');
+                           let str = res.oModel.getServiceUrl();
+                           if (lastSlashIndex !== -1) {
+                              str = str.substring(0, lastSlashIndex)  + str.substring(lastSlashIndex + 1);
+                           }
+                           odataurl = str+res.oBinding.oContext.sPath+"/content";
+                     } else {
+                           odataurl = res.getObject().value;
+                     }
+                     library.URLHelper.redirect(odataurl, true);
+                              
+                  });
+               }
+         });
+      }
+   );
+   ```
+   
+   - Replace `books` in `ControllerExtension.extend` with the `SAPUI5.Component` name from your `app/appconfig/fioriSandboxConfig.json` file. See this [example](https://github.com/cap-java/sdm/blob/90cfc716967d844e114457a710daebdd55431965/cap-notebook/demoapp/app/appconfig/fioriSandboxConfig.json#L86).
+   - Replace `AdminService` in `invokeAction("AdminService.openAttachment")` with the name of your service.
+
+3. **Add controlConfiguration for Row Press**
+
+   In your `sap.ui5.routing.targets` section, under the relevant Object Page (e.g., `BooksDetails`), add or extend the `controlConfiguration` for the facet you want to enhance by copy and pasting below content. See this [example](https://github.com/cap-java/sdm/blob/90cfc716967d844e114457a710daebdd55431965/cap-notebook/demoapp/app/admin-books/webapp/manifest.json#L121)
+
+   ```json
+   "controlConfiguration": {
+      "attachments/@com.sap.vocabularies.UI.v1.LineItem": {
+         "tableSettings": {
+            "type": "ResponsiveTable",
+            "selectionMode": "Auto",
+            "rowPress": ".extension.books.controller.custom.onRowPress"
+         }
+      }
+   }
+   ```
+   - Replace `attachments` with your entity’s facet name as needed.
+   - Repeat for other facets's if required.
+   - Replace `books` in `"rowPress": ".extension.books.controller.custom.onRowPress"` with the SAPUI5.Component name from your 
+   `app/appconfig/fioriSandboxConfig.json` file. Refer this [example](https://github.com/cap-java/sdm/blob/90cfc716967d844e114457a710daebdd55431965/cap-notebook/demoapp/app/appconfig/fioriSandboxConfig.json#L86) from a sample Bookshop app.
+
+4. **Register the Custom Controller Extension**
+   
+   In the root of your `sap.ui5` section, add or extend the `extends` property to register your custom controller by copy and pasting below content. See this [example](https://github.com/cap-java/sdm/blob/90cfc716967d844e114457a710daebdd55431965/cap-notebook/demoapp/app/admin-books/webapp/manifest.json#L159)
+
+   ```json
+   "extends": {
+      "extensions": {
+         "sap.ui.controllerExtensions": {
+            "sap.fe.templates.ObjectPage.ObjectPageController#books::BooksDetailsList": {
+            "controllerName": "books.controller.custom"
+            }
+         }
+      }
+   }
+   ```
+   - Replace `books` in `"sap.fe.templates.ObjectPage.ObjectPageController#books::BooksDetailsList"` with the SAPUI5.Component name from your 
+   `app/appconfig/fioriSandboxConfig.json` file. Refer this [example](https://github.com/cap-java/sdm/blob/90cfc716967d844e114457a710daebdd55431965/cap-notebook/demoapp/app/appconfig/fioriSandboxConfig.json#L86) from a sample Bookshop app.
+   - Replace `BooksDetailsList` in `"sap.fe.templates.ObjectPage.ObjectPageController#books::BooksDetailsList"` with id of the relevant Object Page (e.g., BooksDetails). Refer this [example](https://github.com/cap-java/sdm/blob/90cfc716967d844e114457a710daebdd55431965/cap-notebook/demoapp/app/admin-books/webapp/manifest.json#L109) from a sample Bookshop app.
+   - Replace `books` in `"controllerName": "books.controller.custom"` with the SAPUI5.Component name from your 
+   `app/appconfig/fioriSandboxConfig.json` file. Refer this [example](https://github.com/cap-java/sdm/blob/90cfc716967d844e114457a710daebdd55431965/cap-notebook/demoapp/app/appconfig/fioriSandboxConfig.json#L86) from a sample Bookshop app.
+
+### Steps to Enable Create Link Feature in CAP Application
+
+> **Note:** Enabling row-press for open link (see steps above) is a prerequisite for link support.
+
+1. **Add the `createLink` action to application's service definition** 
+   
+   See this [example](https://github.com/cap-java/sdm/blob/90cfc716967d844e114457a710daebdd55431965/cap-notebook/demoapp/srv/admin-service.cds#L12) from a sample Bookshop app:
+
+   ```cds
+   action createLink(
+         in:many $self,
+         @mandatory @Common.Label:'Name' name: String @UI.Placeholder: 'Enter a name for the link',
+         @mandatory @assert.format:'^(https?:\/\/)(([a-zA-Z0-9\-]+\.)+[a-zA-Z]{2,}|localhost)(:\d{2,5})?(\/[^\s]*)?$'
+         @Common.Label:'URL' url: String @UI.Placeholder: 'Example: https://www.example.com'
+      ); 
+   ```
+   - Purpose: Enables users to create links with name and URL.
+   - Validation: Ensures only valid HTTP(S) URLs are accepted.
+   - UI Support: Provides labels and placeholders for better user experience.
+
+### UI Annotation Setup
+
+To enable the creation of links, you need to add a new button to the attachments table toolbar. This button will appear as a **menu button labeled "Create"** on the toolbar of the attachments table. When clicked, it will display a menu with the **"Link"** option, allowing users to create a new link-type attachment.
+
+Add the following annotation block to your app/common.cds file. See this [example](https://github.com/cap-java/sdm/blob/4288ce6f58bc415a171a9e0340fa075aeac835ff/cap-notebook/demoapp/app/common.cds#L60)
+
+```cds
+annotate my.Books.attachments with @UI: {
+  HeaderInfo: {
+    $Type         : 'UI.HeaderInfoType',
+    TypeName      : '{i18n>Attachment}',
+    TypeNamePlural: '{i18n>Attachments}',
+  },
+  LineItem  : [
+    {Value: type, @HTML5.CssDefaults: {width: '10%'}},
+    {Value: fileName, @HTML5.CssDefaults: {width: '25%'}},
+    {Value: content, @HTML5.CssDefaults: {width: '0%'}},
+    {Value: createdAt, @HTML5.CssDefaults: {width: '20%'}},
+    {Value: createdBy, @HTML5.CssDefaults: {width: '20%'}},
+    {Value: note, @HTML5.CssDefaults: {width: '25%'}},
+    {
+      $Type  : 'UI.DataFieldForActionGroup',
+      ID     : 'TableActionGroup',
+      Label  : 'Create',
+      ![@UI.Hidden]: {$edmJson: {$Eq: [ {$Path: 'IsActiveEntity'}, true ]}},
+      Actions: [
+        {
+          $Type : 'UI.DataFieldForAction',
+          Label : 'Link',
+          Action: 'AdminService.createLink',
+        }
+      ]
+    },
+  ],
+} 
+{
+  note       @(title: '{i18n>Note}');
+  type       @(title: '{i18n>Type}');
+  linkUrl       @(title: '{i18n>LinkURL}');
+  fileName  @(title: '{i18n>Filename}');
+  modifiedAt @(odata.etag: null);
+  content
+    @Core.ContentDisposition: { Filename: fileName }
+    @(title: '{i18n>Attachment}');
+  folderId @UI.Hidden;
+  repositoryId  @UI.Hidden ;
+  objectId  @UI.Hidden ;
+  mimeType @UI.Hidden;
+  status @UI.Hidden;
+}
+annotate Attachments with @Common: {SideEffects #ContentChanged: {
+  SourceProperties: [content],
+  TargetProperties: ['status'],
+  TargetEntities : [Books.attachments]
+}}{};
+```
+
+- Replace `my.Books.attachments` with the correct path for your entity and element (for example, `my.YourEntity.yourElement`) where you have defined `composition of many Attachments`.
+- Replace `AdminService` in `Action: 'AdminService.createLink'` with the name of your service.
+- Repeat for other entities and elements if you have defined multiple `composition of many Attachments`.
+
 ## Known Restrictions
 
 - UI5 Version 1.135.0: This version causes error in upload of attachments.

sdm/src/main/java/com/sap/cds/sdm/configuration/Registration.java

@@ -87,7 +87,15 @@ public void eventHandlers(CdsRuntimeConfigurer configurer) {
             documentService,
             tokenHandlerInstance,
             dbQueryInstance));
-    configurer.eventHandler(new SDMServiceGenericHandler(attachmentService));
+    configurer.eventHandler(
+        new SDMServiceGenericHandler(
+            attachmentService,
+            persistenceService,
+            sdmService,
+            documentService,
+            draftServiceList,
+            dbQueryInstance,
+            tokenHandlerInstance));
     configurer.eventHandler(
         new SDMCustomServiceHandler(sdmService, draftServiceList, tokenHandlerInstance));
   }

sdm/src/main/java/com/sap/cds/sdm/constants/SDMConstants.java

@@ -45,6 +45,8 @@ private SDMConstants() {
   public static final String SDM_CONNECTIONPOOL_PREFIX = "cds.attachments.sdm.http.%s";
   public static final String USER_NOT_AUTHORISED_ERROR =
       "You do not have the required permissions to upload attachments. Please contact your administrator for access.";
+  public static final String USER_NOT_AUTHORISED_ERROR_LINK =
+      "You do not have the required permissions to create links. Please contact your administrator for access.";
   public static final String FILE_NOT_FOUND_ERROR = "Object not found in repository";
   public static final Integer MAX_CONNECTIONS = 100;
   public static final int CONNECTION_TIMEOUT = 1200;
@@ -100,6 +102,26 @@ public static String nameConstraintMessage(
     return bulletPoints.toString();
   }
 
+  public static String linkNameConstraintMessage(
+      List<String> fileNameWithRestrictedCharacters, String operation) {
+    // Create the base message
+    String prefixMessage =
+        "Link could not be %s. The following name(s) contain unsupported characters (/, \\). \n\n";
+
+    // Create the formatted prefix message
+    String formattedPrefixMessage = String.format(prefixMessage, operation);
+
+    // Initialize the StringBuilder with the formatted message prefix
+    StringBuilder bulletPoints = new StringBuilder(formattedPrefixMessage);
+
+    // Append each unsupported file name to the StringBuilder
+    for (String file : fileNameWithRestrictedCharacters) {
+      bulletPoints.append(String.format("\t• %s%n", file));
+    }
+    bulletPoints.append("\nRename the link and try again.");
+    return bulletPoints.toString();
+  }
+
   public static String fileNotFound(List<String> fileNameNotFound) {
     // Create the base message
     String prefixMessage =

sdm/src/main/java/com/sap/cds/sdm/model/AttachmentReadContext.java

@@ -0,0 +1,16 @@
+package com.sap.cds.sdm.model;
+
+import com.sap.cds.services.EventContext;
+import com.sap.cds.services.EventName;
+
+@EventName("openAttachment")
+public interface AttachmentReadContext extends EventContext {
+
+  static AttachmentReadContext create() {
+    return (AttachmentReadContext) EventContext.create(AttachmentReadContext.class, null);
+  }
+
+  void setResult(String res);
+
+  String getResult();
+}

sdm/src/main/java/com/sap/cds/sdm/model/CmisDocument.java

@@ -24,4 +24,6 @@ public class CmisDocument {
   private String mimeType;
   private long contentLength;
   private String subdomain;
+  private String url;
+  private String contentId;
 }

sdm/src/main/java/com/sap/cds/sdm/persistence/DBQuery.java

@@ -35,11 +35,33 @@ public Result getAttachmentsForUPID(
       String upIdKey) {
     CqnSelect q =
         Select.from(attachmentEntity)
-            .columns("fileName", "ID", "IsActiveEntity", "folderId", "repositoryId")
+            .columns("fileName", "ID", "IsActiveEntity", "folderId", "repositoryId", "mimeType")
             .where(doc -> doc.get(upIdKey).eq(upID));
     return persistenceService.run(q);
   }
 
+  public CmisDocument getObjectIdForAttachmentID(
+      CdsEntity attachmentEntity, PersistenceService persistenceService, String id) {
+    CqnSelect q =
+        Select.from(attachmentEntity)
+            .columns("objectId", "folderId", "fileName", "mimeType", "contentId", "linkUrl")
+            .where(doc -> doc.get("ID").eq(id));
+    Result result = persistenceService.run(q);
+    Optional<Row> res = result.first();
+    CmisDocument cmisDocument = new CmisDocument();
+    if (res.isPresent()) {
+      Row row = res.get();
+      cmisDocument.setObjectId(row.get("objectId").toString());
+      cmisDocument.setFileName(row.get("fileName").toString());
+      cmisDocument.setFolderId(row.get("folderId").toString());
+      cmisDocument.setMimeType(row.get("mimeType").toString());
+      cmisDocument.setContentId(
+          row.get("contentId") != null ? row.get("contentId").toString() : null);
+      cmisDocument.setUrl(row.get("linkUrl") != null ? row.get("linkUrl").toString() : null);
+    }
+    return cmisDocument;
+  }
+
   public Result getAttachmentsForUPIDAndRepository(
       CdsEntity attachmentEntity,
       PersistenceService persistenceService,
@@ -74,6 +96,8 @@ public void addAttachmentToDraft(
     updatedFields.put("repositoryId", repositoryId);
     updatedFields.put("folderId", cmisDocument.getFolderId());
     updatedFields.put("status", "Clean");
+    String icon = getIconForMimeType(cmisDocument.getMimeType());
+    updatedFields.put("type", icon);
 
     CqnUpdate updateQuery =
         Update.entity(attachmentEntity)
@@ -82,6 +106,66 @@ public void addAttachmentToDraft(
     persistenceService.run(updateQuery);
   }
 
+  private static String getIconForMimeType(String mimeType) {
+    if (isExcel(mimeType)) {
+      return "sap-icon://excel-attachment";
+    } else if (isImage(mimeType)) {
+      return "sap-icon://attachment-photo";
+    } else if (isText(mimeType)) {
+      return "sap-icon://attachment-text-file";
+    } else if (isPdf(mimeType)) {
+      return "sap-icon://pdf-attachment";
+    } else if (isPowerPoint(mimeType)) {
+      return "sap-icon://ppt-attachment";
+    } else if (isVideo(mimeType)) {
+      return "sap-icon://attachment-video";
+    } else if (isAudio(mimeType)) {
+      return "sap-icon://attachment-audio";
+    } else if (isZip(mimeType)) {
+      return "sap-icon://attachment-zip-file";
+    } else if (isHtml(mimeType)) {
+      return "sap-icon://attachment-html";
+    }
+    return "sap-icon://document";
+  }
+
+  private static boolean isExcel(String mimeType) {
+    return mimeType.contains("vnd.ms-excel")
+        || mimeType.contains("vnd.openxmlformats-officedocument.spreadsheetml.sheet");
+  }
+
+  private static boolean isImage(String mimeType) {
+    return mimeType.contains("image");
+  }
+
+  private static boolean isText(String mimeType) {
+    return mimeType.contains("text");
+  }
+
+  private static boolean isPdf(String mimeType) {
+    return mimeType.contains("pdf");
+  }
+
+  private static boolean isPowerPoint(String mimeType) {
+    return mimeType.contains("powerpoint") || mimeType.contains("presentation");
+  }
+
+  private static boolean isVideo(String mimeType) {
+    return mimeType.contains("video");
+  }
+
+  private static boolean isAudio(String mimeType) {
+    return mimeType.contains("audio");
+  }
+
+  private static boolean isZip(String mimeType) {
+    return mimeType.contains("zip");
+  }
+
+  private static boolean isHtml(String mimeType) {
+    return mimeType.contains("html");
+  }
+
   public List<CmisDocument> getAttachmentsForFolder(
       String entity,
       PersistenceService persistenceService,