added shareable annotation (#6)

* added shareable annotation

* added column 'shareable'

* added migration script & updated README

* make old attributes deprecated

Author: mariodavid

CHANGELOG.md

@@ -4,6 +4,17 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## [0.3.0] - 2018-05-21
+
+### Added
+- `@Shareable` annotation share entity instances with other users in any screen 
+
+### Change
+- BREAKING: Storage format for message record references has been changed. In order to migrate to the new storage format
+you have to download `etc/migrate-message-records-to-new-format.zip` from this repository and run it in the [Diagnose Wizard](https://github.com/mariodavid/cuba-component-runtime-diagnose/tree/de284e5cbce19bb02260b59b9dcd133f2729b0e3#diagnose-wizard).
+For that to work you have to temporarily add the [runtime-diagnose](https://github.com/mariodavid/cuba-component-runtime-diagnose) app-component to your application.
+This script has to run once, will do the migration. After that, the app component can be removed again.
+
 ## [0.2.0] - 2018-05-09
 
 ### Added

README.md

@@ -42,6 +42,16 @@ dependencies {
 }
 ```
 
+### NOTE: Dependency: declarative-controllers
+This application component requires `declarative-controllers` as another dependency you have to add to your application.
+
+The reason is, that you need to extend your screen from `AnnotatableAbstractLookup` instead of `AbstractLookup`.
+This superclass is part of the app-component: [cuba-component-declarative-controllers](https://github.com/balvi/cuba-component-declarative-controllers).
+
+Technically it is not strictly required to directly add the dependency to `declarative-controllers`, since `user-inbox` already has a dependency on it.
+
+However: since you directly depend on the app component (with extending your classes from `AnnotatableAbstractLookup`), 
+it is a best practice to explicitly declare the dependency to it.
 
 ## Using the inbox as a user
 
@@ -71,12 +81,37 @@ This screen allows to manually send a message. A message contains a subject and
 
 This feature can sometimes be helpful but oftentimes sending a regular email is not worse.
 
-##### Context-based messages
+#### Context-based messages
 
 Therefore there is another option to send a Message. In this case it is a message that is send through the context of a particular entity.
 
 This is comparable of sending a email with a link that points to a particular customer / order etc. in your application together with the information from the sender.
 
+##### Share entity instances
+
+The way to send context-based messages is to use the `@Shareable` annotation. The annotation is used in any Entity browse / editor screen.
+
+Example:
+
+```
+@Shareable(listComponent = "customersTable")
+public class CustomerBrowse extends AnnotatableAbstractLookup {
+}
+```
+
+For the `@Shareable` annotation you need to define the list component on which it should add the share button.
+Normally this is the `id` of the table you defined in your browse screen.
+
+This annotation will create a button in the buttonsPanel of the table and add the share button after the default CUBA buttons.
+
+The `@Shareable` annotations can be customized through the following attributes:
+
+* `String listComponent` - the id of the list component / table where the button will be added - REQUIRED
+* `String buttonId` - the id of the newly created button that will be created ("attachmentBtn" by default)
+* `String buttonsPanel` - the id of the buttons panel where the new button will be added ("buttonsPanel" by default)
+
+
+more information on this topic can be found here: [balvi/declarative-controllers](https://github.com/balvi/cuba-component-declarative-controllers)
 
 ### Send system messages (programmatically)
 

build.gradle

@@ -13,6 +13,9 @@ buildscript {
         maven {
             url  "https://dl.bintray.com/balvi/cuba-components"
         }
+        maven {
+            url  "https://dl.bintray.com/mariodavid/cuba-components"
+        }
     }
     dependencies {
         classpath "com.haulmont.gradle:cuba-plugin:$cubaVersion"
@@ -111,6 +114,7 @@ subprojects {
 dependencies {
     appComponent("com.haulmont.cuba:cuba-global:$cubaVersion")
     appComponent("de.balvi.cuba.declarativecontrollers:declarativecontrollers-global:0.5.0")
+    appComponent("de.diedavids.cuba.entitysoftreference:entity-soft-reference-global:0.2.0")
 
 }
 

etc/migrate-message-records-to-new-format.zip

@@ -12,6 +12,7 @@ create table DDCUI_MESSAGE (
     SENDER_ID varchar(36),
     RECEIVER_ID varchar(36) not null,
     SUBJECT varchar(255),
+    SHAREABLE varchar(255),
     ENTITY_REFERENCE_ID varchar(255),
     ENTITY_REFERENCE_CLASS varchar(255),
     ENTITY_CAPTION varchar(255),
@@ -21,4 +22,4 @@ create table DDCUI_MESSAGE (
     --
     primary key (ID)
 )^
--- end DDCUI_MESSAGE
+-- end DDCUI_MESSAGE

modules/core/db/init/hsql/10.create-db.sql

@@ -0,0 +1 @@
+alter table DDCUI_MESSAGE add column SHAREABLE varchar(255) ;

modules/core/db/update/hsql/18/180520-2-add-shareable-column-to-message.sql

@@ -20,10 +20,6 @@ class MessageServiceBean implements MessageService {
     @Inject
     UserSessionSource userSessionSource
 
-    @Inject
-    Security security
-
-
     @Override
     void sendSystemMessage(User receiver, String subject, String messageText, Entity entityReference) {
         sendMessageFromUser(null, receiver, subject, messageText, entityReference)
@@ -42,7 +38,7 @@ class MessageServiceBean implements MessageService {
     protected void sendMessageFromUser(User sender, User receiver, String subject, String messageText, Entity entityReference = null) {
         Message message = createMessageInstance()
 
-        setRecordToMessage(entityReference, message)
+        message.shareable = entityReference
 
         message.sender = sender
         message.receiver = receiver
@@ -57,12 +53,6 @@ class MessageServiceBean implements MessageService {
         metadata.create(Message)
     }
 
-    protected void setRecordToMessage(Entity entityReference, Message message) {
-        message.entityReferenceClass = entityReference.metaClass.name
-        message.entityReferenceId = entityReference.id as String
-        message.entityCaption = entityReference.instanceName
-    }
-
     private User getCurrentUser() {
         userSessionSource.userSession.currentOrSubstitutedUser
     }

modules/core/src/de/diedavids/cuba/userinbox/service/MessageServiceBean.groovy

@@ -13,7 +13,7 @@
     <!--Application components-->
     <context-param>
         <param-name>appComponents</param-name>
-        <param-value>com.haulmont.cuba de.balvi.cuba.declarativecontrollers</param-value>
+        <param-value>com.haulmont.cuba de.balvi.cuba.declarativecontrollers de.diedavids.cuba.entitysoftreference</param-value>
     </context-param>
     <listener>
         <listener-class>com.haulmont.cuba.core.sys.AppContextLoader</listener-class>

modules/core/web/WEB-INF/web.xml

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8" standalone="no"?>
 <app-component xmlns="http://schemas.haulmont.com/cuba/app-component.xsd"
-               dependsOn="de.balvi.cuba.declarativecontrollers, com.haulmont.cuba">
+               dependsOn="de.diedavids.cuba.entitysoftreference, de.balvi.cuba.declarativecontrollers, com.haulmont.cuba">
     <module blocks="*"
             name="global">
         <artifact appJar="true"

modules/global/src/de/diedavids/cuba/userinbox/app-component.xml

@@ -1,22 +1,18 @@
 package de.diedavids.cuba.userinbox.entity;
 
+import com.haulmont.chile.core.annotations.MetaProperty;
 import com.haulmont.cuba.core.entity.StandardEntity;
-import com.haulmont.cuba.core.entity.annotation.Listeners;
-import com.haulmont.cuba.core.entity.annotation.Lookup;
-import com.haulmont.cuba.core.entity.annotation.LookupType;
+import com.haulmont.cuba.core.entity.annotation.*;
+import com.haulmont.cuba.core.global.AppBeans;
+import com.haulmont.cuba.core.global.UserSessionSource;
 import com.haulmont.cuba.security.entity.User;
+import de.diedavids.cuba.entitysoftreference.EntitySoftReferenceConverter;
 
-import javax.persistence.Column;
-import javax.persistence.Entity;
-import javax.persistence.FetchType;
-import javax.persistence.JoinColumn;
-import javax.persistence.Lob;
-import javax.persistence.ManyToOne;
-import javax.persistence.Table;
-import javax.persistence.Temporal;
-import javax.persistence.TemporalType;
+import javax.annotation.PostConstruct;
+import javax.persistence.*;
 import javax.validation.constraints.NotNull;
 import java.util.Date;
+import de.diedavids.cuba.entitysoftreference.EntitySoftReferenceDatatype;
 
 @Listeners("ddcui_MessageEntityListener")
 @Table(name = "DDCUI_MESSAGE")
@@ -37,15 +33,38 @@ public class Message extends StandardEntity {
     @Column(name = "SUBJECT")
     protected String subject;
 
+
+    @SystemLevel
+    @Convert(converter = EntitySoftReferenceConverter.class)
+    @MetaProperty(datatype = "EntitySoftReference")
+    @Column(name = "SHAREABLE")
+    protected com.haulmont.cuba.core.entity.Entity shareable;
+
+    /**
+     * @deprecated use Message.shareable instead
+     */
+    @Deprecated
+    @SystemLevel
     @Column(name = "ENTITY_REFERENCE_ID")
     protected String entityReferenceId;
 
+    /**
+     * @deprecated use Message.shareable instead
+     */
+    @Deprecated
+    @SystemLevel
     @Column(name = "ENTITY_REFERENCE_CLASS")
     protected String entityReferenceClass;
 
+    /**
+     * @deprecated use Message.shareable instead
+     */
+    @Deprecated
+    @SystemLevel
     @Column(name = "ENTITY_CAPTION")
     protected String entityCaption;
 
+
     @Lob
     @Column(name = "TEXT")
     protected String text;
@@ -59,6 +78,15 @@ public class Message extends StandardEntity {
     @Column(name = "RECEIVED_AT", nullable = false)
     protected Date receivedAt;
 
+    public void setShareable(com.haulmont.cuba.core.entity.Entity shareable) {
+        this.shareable = shareable;
+    }
+
+    public com.haulmont.cuba.core.entity.Entity getShareable() {
+        return shareable;
+    }
+
+
     public void setReceivedAt(Date receivedAt) {
         this.receivedAt = receivedAt;
     }
@@ -136,4 +164,17 @@ public User getReceiver() {
     }
 
 
+
+   @PostConstruct
+   protected void initSender() {
+       setSender(getCurrentUser());
+   }
+
+    private User getCurrentUser() {
+        return getUserSessionSource().getUserSession().getCurrentOrSubstitutedUser();
+    }
+
+    private UserSessionSource getUserSessionSource() {
+        return AppBeans.get(UserSessionSource.class);
+    }
 }