[206] Add support for disabling migration log messages

Bug: #206 Signed-off-by: Pierre-Charles David <[email protected]>
eclipse-sirius · Dec 18, 2023 · bd5abff · bd5abff
1 parent b058b58
commit bd5abff
Show file tree

Hide file tree

Showing 13 changed files with 28 additions and 24 deletions.
diff --git a/...gram/ui/business/internal/migration/DeleteMultipleConnectorStyleMigrationParticipant.java b/...gram/ui/business/internal/migration/DeleteMultipleConnectorStyleMigrationParticipant.java
@@ -26,7 +26,6 @@
 import org.eclipse.sirius.diagram.DDiagram;
 import org.eclipse.sirius.diagram.DSemanticDiagram;
 import org.eclipse.sirius.diagram.business.api.refresh.DiagramCreationUtil;
-import org.eclipse.sirius.diagram.tools.api.DiagramPlugin;
 import org.eclipse.sirius.diagram.ui.provider.Messages;
 import org.eclipse.sirius.viewpoint.DAnalysis;
 import org.eclipse.sirius.viewpoint.DRepresentation;
@@ -80,7 +79,7 @@ protected void postLoad(DAnalysis dAnalysis, Version loadedVersion) {
                     }
                 }
                 if (migrationOccured) {
-                    DiagramPlugin.getDefault().logInfo(sb.toString());
+                    logMigrationInfo(sb.toString());
                     migrationOccured = false;
                 }
             }

diff --git a/...clipse/sirius/diagram/ui/business/internal/migration/EdgesZOrderMigrationParticipant.java b/...clipse/sirius/diagram/ui/business/internal/migration/EdgesZOrderMigrationParticipant.java
@@ -24,7 +24,6 @@
 import org.eclipse.sirius.business.api.migration.AbstractRepresentationsFileMigrationParticipant;
 import org.eclipse.sirius.business.api.query.DViewQuery;
 import org.eclipse.sirius.diagram.DDiagram;
-import org.eclipse.sirius.diagram.tools.api.DiagramPlugin;
 import org.eclipse.sirius.diagram.ui.business.api.query.DDiagramGraphicalQuery;
 import org.eclipse.sirius.diagram.ui.provider.Messages;
 import org.eclipse.sirius.ext.base.Option;
@@ -92,7 +91,7 @@ protected void postLoad(DAnalysis dAnalysis, Version loadedVersion) {
             }
 
             if (isModified) {
-                DiagramPlugin.getDefault().logInfo(sb.toString());
+                logMigrationInfo(sb.toString());
             }
         }
     }

diff --git a/...ipse/sirius/diagram/ui/business/internal/migration/LabelOnBorderMigrationParticipant.java b/...ipse/sirius/diagram/ui/business/internal/migration/LabelOnBorderMigrationParticipant.java
@@ -31,7 +31,6 @@
 import org.eclipse.sirius.diagram.DNode;
 import org.eclipse.sirius.diagram.LabelPosition;
 import org.eclipse.sirius.diagram.business.internal.migration.ActivatedFilterSortingMigrationParticipant;
-import org.eclipse.sirius.diagram.tools.api.DiagramPlugin;
 import org.eclipse.sirius.diagram.ui.business.api.query.DDiagramGraphicalQuery;
 import org.eclipse.sirius.diagram.ui.internal.edit.parts.DNode2EditPart;
 import org.eclipse.sirius.diagram.ui.internal.edit.parts.DNode3EditPart;
@@ -99,7 +98,7 @@ protected void postLoad(DAnalysis dAnalysis, Version loadedVersion) {
                         }
                     });
             if (migrationOccured) {
-                DiagramPlugin.getDefault().logInfo(sb.toString());
+                logMigrationInfo(sb.toString());
                 migrationOccured = false;
             }
         }

diff --git a/...irius/diagram/ui/business/internal/migration/RepairGMFbendpointsMigrationParticipant.java b/...irius/diagram/ui/business/internal/migration/RepairGMFbendpointsMigrationParticipant.java
@@ -37,7 +37,6 @@
 import org.eclipse.sirius.business.api.migration.AbstractRepresentationsFileMigrationParticipant;
 import org.eclipse.sirius.business.api.query.DViewQuery;
 import org.eclipse.sirius.diagram.DDiagram;
-import org.eclipse.sirius.diagram.tools.api.DiagramPlugin;
 import org.eclipse.sirius.diagram.ui.business.api.query.EdgeQuery;
 import org.eclipse.sirius.diagram.ui.internal.refresh.GMFHelper;
 import org.eclipse.sirius.diagram.ui.internal.refresh.edge.SlidableAnchor;
@@ -100,7 +99,7 @@ protected void postLoad(DAnalysis dAnalysis, Version loadedVersion) {
                 }
             }
             if (isModified) {
-                DiagramPlugin.getDefault().logInfo(sb.toString());
+                logMigrationInfo(sb.toString());
             }
         }
     }

diff --git a/...sirius/diagram/ui/business/internal/migration/RepresentationLinkMigrationParticipant.java b/...sirius/diagram/ui/business/internal/migration/RepresentationLinkMigrationParticipant.java
@@ -22,7 +22,6 @@
 import org.eclipse.sirius.business.api.migration.AbstractRepresentationsFileMigrationParticipant;
 import org.eclipse.sirius.business.api.query.DViewQuery;
 import org.eclipse.sirius.diagram.DDiagram;
-import org.eclipse.sirius.diagram.tools.api.DiagramPlugin;
 import org.eclipse.sirius.diagram.ui.business.api.query.DDiagramGraphicalQuery;
 import org.eclipse.sirius.diagram.ui.internal.view.factories.SiriusNoteViewFactory;
 import org.eclipse.sirius.diagram.ui.provider.Messages;
@@ -80,7 +79,7 @@ protected void postLoad(DAnalysis dAnalysis, Version loadedVersion) {
             if (isModified) {
                 builder.insert(0, System.lineSeparator());
                 builder.insert(0, Messages.RepresentationLinkMigrationParticipant_title);
-                DiagramPlugin.getDefault().logInfo(builder.toString());
+                logMigrationInfo(builder.toString());
             }
         }
     }

diff --git a/...clipse/sirius/diagram/ui/business/internal/migration/SetChangeIdMigrationParticipant.java b/...clipse/sirius/diagram/ui/business/internal/migration/SetChangeIdMigrationParticipant.java
@@ -17,7 +17,6 @@
 import org.eclipse.emf.common.util.EList;
 import org.eclipse.sirius.business.api.helper.RepresentationHelper;
 import org.eclipse.sirius.business.api.migration.AbstractRepresentationsFileMigrationParticipant;
-import org.eclipse.sirius.diagram.tools.api.DiagramPlugin;
 import org.eclipse.sirius.diagram.ui.provider.Messages;
 import org.eclipse.sirius.viewpoint.DAnalysis;
 import org.eclipse.sirius.viewpoint.DRepresentationDescriptor;
@@ -58,7 +57,7 @@ protected void postLoad(DAnalysis dAnalysis, Version loadedVersion) {
                 }
             }
             if (migrationOccured) {
-                DiagramPlugin.getDefault().logInfo(Messages.SetChangeIdMigrationParticipant_title);
+                logMigrationInfo(Messages.SetChangeIdMigrationParticipant_title);
                 migrationOccured = false;
             }
         }

diff --git a/...ius/diagram/ui/business/internal/migration/SnapBackDistantLabelsMigrationParticipant.java b/...ius/diagram/ui/business/internal/migration/SnapBackDistantLabelsMigrationParticipant.java
@@ -42,7 +42,6 @@
 import org.eclipse.sirius.business.api.migration.AbstractRepresentationsFileMigrationParticipant;
 import org.eclipse.sirius.business.api.query.DViewQuery;
 import org.eclipse.sirius.diagram.DDiagram;
-import org.eclipse.sirius.diagram.tools.api.DiagramPlugin;
 import org.eclipse.sirius.diagram.ui.business.api.query.DDiagramGraphicalQuery;
 import org.eclipse.sirius.diagram.ui.business.api.query.NodeQuery;
 import org.eclipse.sirius.diagram.ui.business.api.query.ViewQuery;
@@ -194,7 +193,7 @@ protected void postLoad(DAnalysis dAnalysis, Version loadedVersion) {
             }
 
             if (isModified) {
-                DiagramPlugin.getDefault().logInfo(sb.toString());
+                logMigrationInfo(sb.toString());
             }
         }
     }

diff --git a/...s/diagram/ui/business/internal/migration/WorkspaceImageGMFBoundsMigrationParticipant.java b/...s/diagram/ui/business/internal/migration/WorkspaceImageGMFBoundsMigrationParticipant.java
@@ -33,7 +33,6 @@
 import org.eclipse.sirius.diagram.DNode;
 import org.eclipse.sirius.diagram.ResizeKind;
 import org.eclipse.sirius.diagram.description.style.WorkspaceImageDescription;
-import org.eclipse.sirius.diagram.tools.api.DiagramPlugin;
 import org.eclipse.sirius.diagram.ui.business.api.query.DDiagramGraphicalQuery;
 import org.eclipse.sirius.diagram.ui.business.api.query.NodeQuery;
 import org.eclipse.sirius.diagram.ui.business.internal.query.WorkspaceImageQuery;
@@ -108,7 +107,7 @@ protected void postLoad(DAnalysis dAnalysis, Version loadedVersion) {
                 }
             }
             if (migrationOccurred) {
-                DiagramPlugin.getDefault().logInfo(sb.toString());
+                logMigrationInfo(sb.toString());
                 migrationOccurred = false;
             }
         }

diff --git a/...irius/diagram/business/internal/migration/ActivatedFilterSortingMigrationParticipant.java b/...irius/diagram/business/internal/migration/ActivatedFilterSortingMigrationParticipant.java
@@ -23,7 +23,6 @@
 import org.eclipse.sirius.diagram.DDiagram;
 import org.eclipse.sirius.diagram.business.api.helper.filter.FilterService;
 import org.eclipse.sirius.diagram.description.filter.FilterDescription;
-import org.eclipse.sirius.diagram.tools.api.DiagramPlugin;
 import org.eclipse.sirius.diagram.tools.api.Messages;
 import org.eclipse.sirius.viewpoint.DAnalysis;
 import org.eclipse.sirius.viewpoint.DRepresentation;
@@ -64,7 +63,7 @@ protected void postLoad(DAnalysis dAnalysis, Version loadedVersion) {
 
             if (updateDiagrams > 0) {
                 String migrationMessage = MessageFormat.format(Messages.ActivatedFilterSortingMigrationParticipant_updatedDiagrams, updateDiagrams);
-                DiagramPlugin.getDefault().logInfo(migrationMessage);
+                logMigrationInfo(migrationMessage);
             }
         }
     }

diff --git a/.../business/internal/migration/NoteAttachmentWithoutSourceOrTargetMigrationParticipant.java b/.../business/internal/migration/NoteAttachmentWithoutSourceOrTargetMigrationParticipant.java
@@ -26,7 +26,6 @@
 import org.eclipse.sirius.business.api.query.DViewQuery;
 import org.eclipse.sirius.diagram.DDiagram;
 import org.eclipse.sirius.diagram.business.api.refresh.DiagramCreationUtil;
-import org.eclipse.sirius.diagram.tools.api.DiagramPlugin;
 import org.eclipse.sirius.diagram.tools.api.Messages;
 import org.eclipse.sirius.viewpoint.DAnalysis;
 import org.eclipse.sirius.viewpoint.DRepresentation;
@@ -115,7 +114,7 @@ public void postLoad(XMLResource resource, String loadedVersion) {
         sb = new StringBuilder(MessageFormat.format(Messages.NoteAttachmentWithoutSourceOrTargetMigrationParticipant_title, resource.getURI().toPlatformString(true)));
         super.postLoad(resource, loadedVersion);
         if (deletionOccured) {
-            DiagramPlugin.getDefault().logInfo(sb.toString());
+            logMigrationInfo(sb.toString());
         }
     }
 

diff --git a/...us/diagram/business/internal/migration/UnsetOriginalStyleFeatureMigrationParticipant.java b/...us/diagram/business/internal/migration/UnsetOriginalStyleFeatureMigrationParticipant.java
@@ -33,7 +33,6 @@
 import org.eclipse.sirius.diagram.DNodeListElement;
 import org.eclipse.sirius.diagram.DiagramPackage;
 import org.eclipse.sirius.diagram.business.api.query.DDiagramQuery;
-import org.eclipse.sirius.diagram.tools.api.DiagramPlugin;
 import org.eclipse.sirius.diagram.tools.api.Messages;
 import org.eclipse.sirius.viewpoint.DAnalysis;
 import org.osgi.framework.Version;
@@ -127,7 +126,7 @@ public void postLoad(XMLResource resource, String loadedVersion) {
             if (numberOfOrignalStyeDanglingFeature > 0) {
                 message.append(MessageFormat.format(Messages.UnsetOriginalStyleFeatureMigrationParticipant_danglingFeatures, numberOfOrignalStyeDanglingFeature));
             }
-            DiagramPlugin.getDefault().logInfo(message.toString());
+            logMigrationInfo(message.toString());
 
             numberOfOrignalStyeFeatureUnset = 0;
         }

diff --git a/...e/sirius/diagram/business/internal/migration/ViewWithNullElementMigrationParticipant.java b/...e/sirius/diagram/business/internal/migration/ViewWithNullElementMigrationParticipant.java
@@ -29,7 +29,6 @@
 import org.eclipse.sirius.business.api.query.DViewQuery;
 import org.eclipse.sirius.diagram.DDiagram;
 import org.eclipse.sirius.diagram.business.api.refresh.DiagramCreationUtil;
-import org.eclipse.sirius.diagram.tools.api.DiagramPlugin;
 import org.eclipse.sirius.diagram.tools.api.Messages;
 import org.eclipse.sirius.viewpoint.DAnalysis;
 import org.eclipse.sirius.viewpoint.DRepresentation;
@@ -110,7 +109,7 @@ public void postLoad(XMLResource resource, String loadedVersion) {
         sb = new StringBuilder(Messages.ViewWithNullElementMigrationParticipant_title);
         super.postLoad(resource, loadedVersion);
         if (repairOccurred) {
-            DiagramPlugin.getDefault().logInfo(sb.toString());
+            logMigrationInfo(sb.toString());
         }
     }
 

diff --git a/...se.sirius/src/org/eclipse/sirius/business/api/migration/AbstractMigrationParticipant.java b/...se.sirius/src/org/eclipse/sirius/business/api/migration/AbstractMigrationParticipant.java
@@ -25,6 +25,7 @@
 import org.eclipse.emf.ecore.xml.type.AnyType;
 import org.eclipse.sirius.ext.base.Option;
 import org.eclipse.sirius.ext.base.Options;
+import org.eclipse.sirius.tools.api.SiriusPlugin;
 import org.osgi.framework.Version;
 import org.xml.sax.Attributes;
 
@@ -42,6 +43,7 @@
  * @author fbarbin
  */
 public abstract class AbstractMigrationParticipant implements IMigrationParticipant {
+
     /**
      * Version number return when the representations file has never been loaded since the rewrite of migration
      * framework.
@@ -53,6 +55,8 @@ public abstract class AbstractMigrationParticipant implements IMigrationParticip
      */
     public static final Version VERSION_VP_6_5_0 = Version.parseVersion("6.5.0"); //$NON-NLS-1$
 
+    private static final String DISABLE_LOG_MIGRATION_INFO = "org.eclipse.sirius.migration.disableLogMigrationInfo"; //$NON-NLS-1$
+
     @Override
     public EStructuralFeature getAttribute(EClass eClass, String name, String loadedVersion) {
         // Nothing to migrate by default.
@@ -159,4 +163,16 @@ public void postXMLEndElement(Object doneObject, Attributes xmlAttributes, Strin
         // nothing to do by default.
     }
 
+    /**
+     * Log a migration message (unless disabled).
+     * 
+     * @param message
+     *            the migration message.
+     */
+    protected void logMigrationInfo(String message) {
+        if (!Boolean.getBoolean(DISABLE_LOG_MIGRATION_INFO)) {
+            SiriusPlugin.getDefault().getLog().info(message);
+        }
+    }
+
 }