Merge branch 'release/3.0.9rc2'

Author: simon-brooke

.gitignore

@@ -46,7 +46,7 @@ lang_cmp.php
 packages/
 *.suo
 *.user
-
+.vs/
 obj
 bin
 

Doxyfile

@@ -38,7 +38,7 @@ PROJECT_NAME           = "SuiteCRM Outlook Add-in"
 # could be handy for archiving the generated documentation or if some version
 # control system is used.
 
-PROJECT_NUMBER         = 3.0.7.0
+PROJECT_NUMBER         = 3.0.9.0
 
 # Using the PROJECT_BRIEF tag one can provide an optional one line description
 # for a project that appears at the top of each page and should give viewer a

README.md

@@ -2,7 +2,7 @@
 
 ### What's in this repository 
 
-SuiteCRM Outlook Plug-In v3.0.8
+SuiteCRM Outlook Plug-In v 3.0.9.0
 
 This repository has been created to allow community members to collaborate and contribute to the project.
 

SuiteCRMAddIn/BusinessLogic/AppointmentSyncState.cs

@@ -22,7 +22,9 @@
  */
 namespace SuiteCRMAddIn.BusinessLogic
 {
-    using SuiteCRMAddIn.ProtoItems;
+    using Extensions;
+    using ProtoItems;
+    using System.Text;
     using Outlook = Microsoft.Office.Interop.Outlook;
 
     public class AppointmentSyncState: SyncState<Outlook.AppointmentItem>
@@ -34,6 +36,25 @@ public AppointmentSyncState(string crmType)
 
         public override string CrmType { get; }
 
+        public override string Description
+        {
+            get
+            {
+                Outlook.UserProperty olPropertyEntryId = olItem.UserProperties[AppointmentSyncing.CrmIdPropertyName];
+                string crmId = olPropertyEntryId == null ?
+                    "[not present]" :
+                    olPropertyEntryId.Value;
+                StringBuilder bob = new StringBuilder();
+                bob.Append($"\tOutlook Id  : {olItem.EntryID}\n\tCRM Id      : {crmId}\n\tSubject     : '{olItem.Subject}'\n\tSensitivity : {olItem.Sensitivity}\n\tRecipients:\n");
+                foreach (Outlook.Recipient recipient in olItem.Recipients)
+                {
+                    bob.Append($"\t\t{recipient.Name}: {recipient.GetSmtpAddress()}\n");
+                }
+
+                return bob.ToString();
+            }
+        }
+
         public override string OutlookItemEntryId => OutlookItem.EntryID;
 
         public override Outlook.OlSensitivity OutlookItemSensitivity => OutlookItem.Sensitivity;

SuiteCRMAddIn/BusinessLogic/AppointmentSyncing.cs

@@ -163,20 +163,20 @@ public bool HasAccess(string moduleName, string permission)
 
                             foreach (AvailableModule item in RestAPIWrapper.GetModules().items)
                             {
-                                if (!string.IsNullOrWhiteSpace(item.module_label))
+                                if (!string.IsNullOrWhiteSpace(item.module_key))
                                 {
                                     CacheAccessPermission(
-                                        item.module_label,
+                                        item.module_key,
                                         ImportPermissionToken,
                                         item.module_acls1.FirstOrDefault(b => b.action == ImportPermissionToken)?.access ?? false);
                                     CacheAccessPermission(
-                                        item.module_label,
+                                        item.module_key,
                                         ExportPermissionToken,
                                         item.module_acls1.FirstOrDefault(b => b.action == ExportPermissionToken)?.access ?? false);
 
                                     try
                                     {
-                                        Log.Debug($"Cached {CRMPermissionsCache.cache[item.module_label]} permission for {item.module_label}");
+                                        Log.Debug($"Cached {CRMPermissionsCache.cache[item.module_key]} permission for {item.module_key}");
                                     }
                                     catch (KeyNotFoundException)
                                     {

SuiteCRMAddIn/BusinessLogic/CRMPermissionsCache.cs

@@ -22,6 +22,7 @@
  */
 namespace SuiteCRMAddIn.BusinessLogic
 {
+    using System;
     using SuiteCRMAddIn.ProtoItems;
     using Outlook = Microsoft.Office.Interop.Outlook;
 
@@ -40,6 +41,18 @@ public class ContactSyncState: SyncState<Outlook.ContactItem>
 
         public override Outlook.UserProperties OutlookUserProperties => OutlookItem.UserProperties;
 
+        public override string Description
+        {
+            get
+            {
+                Outlook.UserProperty olPropertyEntryId = olItem.UserProperties[Synchroniser<Outlook.ContactItem>.CrmIdPropertyName];
+                string crmId = olPropertyEntryId == null ?
+                    "[not present]" :
+                    olPropertyEntryId.Value;
+                return $"\tOutlook Id  : {olItem.EntryID}\n\tCRM Id      : {crmId}\n\tFull name   : '{olItem.FullName}'\n\tSensitivity : {olItem.Sensitivity}";
+            }
+        }
+
         /// <summary>
         /// Don't actually delete contact items from Outlook; instead, mark them private so they
         /// don't get copied back to CRM.

SuiteCRMAddIn/BusinessLogic/ContactSyncState.cs

@@ -77,7 +77,14 @@ public override string DefaultCrmModule
 
         protected override void SaveItem(Outlook.ContactItem olItem)
         {
-            olItem.Save();
+            try
+            {
+                olItem.Save();
+            }
+            catch (System.Exception any)
+            {
+                Log.Error($"Error while saving contact {olItem?.Email1Address}", any);
+            }
         }
 
         /// <summary>
@@ -87,7 +94,7 @@ protected override void SaveItem(Outlook.ContactItem olItem)
         /// <param name="crmModule">The module to snychronise with.</param>
         protected override void SyncFolder(Outlook.MAPIFolder folder, string crmModule)
         {
-            Log.Info($"ContactSyncing.SyncFolder: '{folder}'");
+            Log.Info($"ContactSyncing.SyncFolder: '{folder.FolderPath}'");
             try
             {
                 if (this.permissionsCache.HasExportAccess())
@@ -219,29 +226,19 @@ private bool ShouldSyncFlagChanged(Outlook.ContactItem olItem, EntryValue crmIte
 
             this.SetOutlookItemPropertiesFromCrmItem(crmItem, olItem);
 
-            var newState = new ContactSyncState
-            {
-                OutlookItem = olItem,
-                OModifiedDate = DateTime.ParseExact(crmItem.GetValueAsString("date_modified"), "yyyy-MM-dd HH:mm:ss", null),
-                CrmEntryId = crmItem.GetValueAsString("id"),
-            };
-            ItemsSyncState.Add(newState);
-
-            LogItemAction(newState.OutlookItem, "AppointmentSyncing.AddNewItemFromCrmToOutlook, saved item");
-
-            return newState;
+            return this.AddOrGetSyncState(olItem);
         }
 
         /// <summary>
         /// Log a message regarding this Outlook item, with detail of the item.
         /// </summary>
         /// <param name="olItem">The outlook item.</param>
         /// <param name="message">The message to be logged.</param>
-        protected override void LogItemAction(Outlook.ContactItem olItem, string message)
+        internal override void LogItemAction(Outlook.ContactItem olItem, string message)
         {
             try
             {
-                Outlook.UserProperty olPropertyEntryId = olItem.UserProperties["SEntryID"];
+                Outlook.UserProperty olPropertyEntryId = olItem.UserProperties[CrmIdPropertyName];
                 string crmId = olPropertyEntryId == null ?
                     "[not present]" :
                     olPropertyEntryId.Value;
@@ -280,7 +277,7 @@ private bool ShouldSyncContact(EntryValue crmItem)
         /// <returns>True if either of these propertyies differ between the representations.</returns>
         private bool CrmItemChanged(EntryValue crmItem, Outlook.ContactItem olItem)
         {
-            Outlook.UserProperty dateModifiedProp = olItem.UserProperties["SOModifiedDate"];
+            Outlook.UserProperty dateModifiedProp = olItem.UserProperties[ModifiedDatePropertyName];
 
             return (dateModifiedProp.Value != crmItem.GetValueAsString("date_modified") ||
                 ShouldSyncFlagChanged(olItem, crmItem));
@@ -298,7 +295,7 @@ private bool CrmItemChanged(EntryValue crmItem, Outlook.ContactItem olItem)
             if (!itemSyncState.IsDeletedInOutlook)
             {
                 Outlook.ContactItem olItem = itemSyncState.OutlookItem;
-                Outlook.UserProperty dateModifiedProp = olItem.UserProperties["SOModifiedDate"];
+                Outlook.UserProperty dateModifiedProp = olItem.UserProperties[ModifiedDatePropertyName];
                 Outlook.UserProperty shouldSyncProp = olItem.UserProperties["SShouldSync"];
                 this.LogItemAction(olItem, "ContactSyncing.UpdateExistingOutlookItemFromCrm");
 
@@ -490,8 +487,8 @@ protected override string ConstructAndDespatchCrmItem(Outlook.ContactItem olItem
             return new ContactSyncState
             {
                 OutlookItem = oItem,
-                CrmEntryId = oItem.UserProperties["SEntryID"]?.Value.ToString(),
-                OModifiedDate = ParseDateTimeFromUserProperty(oItem.UserProperties["SOModifiedDate"]?.Value.ToString()),
+                CrmEntryId = oItem.UserProperties[CrmIdPropertyName]?.Value.ToString(),
+                OModifiedDate = ParseDateTimeFromUserProperty(oItem.UserProperties[ModifiedDatePropertyName]?.Value.ToString()),
             };
         }
 
@@ -530,6 +527,12 @@ internal override string GetOutlookEntryId(Outlook.ContactItem olItem)
             return olItem.EntryID;
         }
 
+        protected override string GetCrmEntryId(Outlook.ContactItem olItem)
+        {
+            return olItem?.UserProperties[CrmIdPropertyName]?.Value.ToString();
+        }
+
+
         internal override Outlook.OlSensitivity GetSensitivity(Outlook.ContactItem item)
         {
             return item.Sensitivity;

SuiteCRMAddIn/BusinessLogic/ContactSyncing.cs

@@ -226,7 +226,7 @@ public ArchiveResult ArchiveEmailWithEntityRelationships(Outlook.MailItem olItem
         private IList<System.Exception> CreateEmailRelationshipsWithEntities(string crmMailId, IEnumerable<CrmEntity> selectedCrmEntities)
         {
             var failures = new List<System.Exception>();
-            foreach (var entity in selectedCrmEntities)
+            foreach (CrmEntity entity in selectedCrmEntities)
             {
                 try
                 {

SuiteCRMAddIn/BusinessLogic/EmailArchiving.cs

@@ -60,6 +60,11 @@ public abstract class SyncState
 
         public abstract Outlook.UserProperties OutlookUserProperties { get; }
 
+        /// <summary>
+        /// A description of the item, suitable for use in debugging logs.
+        /// </summary>
+        public abstract string Description { get; }
+
         public bool IsDeletedInOutlook
         {
             get