16 | {
17 |
18 | }
19 | public class Configuration
20 | : MFiles.VAF.Configuration.ConfigurationBase
21 | {
22 |
23 | }
24 | ```
25 |
26 | ## Naming formats
27 |
28 | Releases follow a naming format based upon the M-Files versioning; releases are named using a combination of the year and month they are released in and an incrementing build number. Releases may also optionally contain a suffix (starting with a hyphen) denoting that the release is a preview release and should not be used in production environments.
29 |
30 | * `22.6.123` - this full release was made in June 2022. Full releases come from the `release` branch.
31 | * `22.6.140` - this full release was also made in June 2022, but is newer than the one above.
32 | * `22.7.141-preview` - this release was made in July 2022 from the main branch. Releases from the main branch are often close to release quality, but should only be used for testing.
33 | * `22.7.0.13-test-feature-1` - this release was made in July 2022 from a specific feature branch. This release will contain in-development functionality and should only be used when needing to test the specific feature being developed. Significant breaking changes may still be made when this functionality progresses to preview or release builds.
34 |
35 | Any problems can be logged as [issues against the repository](https://github.com/M-Files/VAF.Extensions.Community/issues), or discussed on the [M-Files Community](https://community.m-files.com).
36 |
--------------------------------------------------------------------------------
/MFiles.VAF.Extensions/Dashboards/DashboardHelpersEx.cs:
--------------------------------------------------------------------------------
1 | using MFiles.VAF.Configuration.Domain.Dashboards;
2 | using System;
3 | using System.Collections.Generic;
4 | using System.Linq;
5 | using System.Reflection;
6 | using System.Text;
7 | using System.Threading.Tasks;
8 |
9 | namespace MFiles.VAF.Extensions.Dashboards
10 | {
11 | public static class DashboardHelpersEx
12 | {
13 | ///
14 | /// Converts an icon image file to a valid path.
15 | /// Also works with resources.
16 | ///
17 | /// The icon URI.
18 | /// A value that can be used as an icon source.
19 | public static string ImageFileToDataUri(string iconUri, Assembly assembly = null)
20 | {
21 | // Sanity.
22 | if(string.IsNullOrWhiteSpace(iconUri))
23 | return string.Empty;
24 |
25 | // If it starts with http/https then assume remote and reference it.
26 | if (iconUri.StartsWith("http:") || iconUri.StartsWith("https:"))
27 | return iconUri;
28 | // If it exists on the disk then load that and convert to base64.
29 | else if (System.IO.File.Exists(iconUri))
30 | return DashboardHelper.ImageFileToDataUri(iconUri);
31 | else
32 | {
33 |
34 | // Default to the calling assembly.
35 | assembly = assembly ?? Assembly.GetCallingAssembly() ?? Assembly.GetExecutingAssembly();
36 | if (null == assembly)
37 | return String.Empty;
38 |
39 | // Is it in a resource?
40 | foreach (var resource in assembly.GetManifestResourceNames())
41 | {
42 | // Is this good enough?
43 | if (resource.EndsWith(iconUri.Replace("/", ".")))
44 | {
45 | // Resolve the mime type.
46 | string mimeType = "image/unknown";
47 | string ext = iconUri.Substring(iconUri.LastIndexOf(".")).ToLower();
48 | Microsoft.Win32.RegistryKey regKey = Microsoft.Win32.Registry.ClassesRoot.OpenSubKey(ext);
49 | if (regKey != null && regKey.GetValue("Content Type") != null)
50 | mimeType = regKey.GetValue("Content Type").ToString();
51 |
52 | // Base64 encode the image file content.
53 | using (var memoryStream = new System.IO.MemoryStream())
54 | {
55 | using (var stream = assembly.GetManifestResourceStream(resource))
56 | {
57 | stream.CopyTo(memoryStream);
58 | }
59 | // Create and return the data uri.
60 | return String.Format
61 | (
62 | "data:{0};base64,{1}",
63 | mimeType,
64 | Convert.ToBase64String(memoryStream.ToArray())
65 | );
66 | }
67 |
68 | }
69 | }
70 |
71 | // If we're not in the executing assembly then check that.
72 | if (assembly != Assembly.GetExecutingAssembly())
73 | return ImageFileToDataUri(iconUri, Assembly.GetExecutingAssembly());
74 |
75 | return String.Format("'{0}'", iconUri);
76 | }
77 | }
78 | }
79 | }
80 |
--------------------------------------------------------------------------------
/MFiles.VAF.Extensions/ExtensionMethods/TaskQueueManagerExtensionMethods.cs:
--------------------------------------------------------------------------------
1 | using MFiles.VAF.Common.ApplicationTaskQueue;
2 | using MFiles.VAF;
3 | using MFilesAPI;
4 | using System;
5 | using MFiles.VAF.MultiserverMode;
6 |
7 | namespace MFiles.VAF.Extensions
8 | {
9 | ///
10 | /// Contains helper methods for .
11 | ///
12 | public static class TaskQueueManagerExtensionMethods
13 | {
14 | ///
15 | /// Updates the data associated with ,
16 | /// setting the state to and the progress
17 | /// data to .
18 | ///
19 | /// The task manager to update the job using.
20 | /// The job to update.
21 | /// The new job state.
22 | /// Any progress data to report.
23 | [Obsolete("You should migrate to using VAF 2.3+ task queues (in the MFiles.VAF.AppTasks namespace), not VAF 2.2 task queues (in the MFiles.VAF.MultiserverMode namespace)")]
24 | public static void UpdateTask
25 | (
26 | this TaskQueueManager taskQueueManager,
27 | TaskProcessorJob job,
28 | MFTaskState state,
29 | string progressData = ""
30 | )
31 | {
32 | // Sanity.
33 | if (null == taskQueueManager)
34 | throw new ArgumentNullException(nameof(taskQueueManager));
35 | if (null == job)
36 | throw new ArgumentNullException(nameof(job));
37 |
38 | // Use the default UpdateTask implementation.
39 | taskQueueManager.UpdateTask(job.AppTaskId, state, progressData);
40 | }
41 |
42 | ///
43 | /// Updates the data associated with .
44 | /// Only use this overload to represent an exception having occurred whilst processing a job.
45 | ///
46 | /// The task manager to update the job using.
47 | /// The job to update.
48 | /// The exception that was thrown.
49 | [Obsolete("You should migrate to using VAF 2.3+ task queues (in the MFiles.VAF.AppTasks namespace), not VAF 2.2 task queues (in the MFiles.VAF.MultiserverMode namespace)")]
50 | public static void UpdateTask
51 | (
52 | this TaskQueueManager taskQueueManager,
53 | TaskProcessorJob job,
54 | Exception exception
55 | )
56 | {
57 | // Sanity.
58 | if (null == taskQueueManager)
59 | throw new ArgumentNullException(nameof(taskQueueManager));
60 | if (null == job)
61 | throw new ArgumentNullException(nameof(job));
62 | if (null == exception)
63 | throw new ArgumentNullException(nameof(exception));
64 |
65 | // Use the other overload.
66 | taskQueueManager.UpdateTask
67 | (
68 | job.AppTaskId,
69 | MFTaskState.MFTaskStateFailed,
70 | exception.ToString()
71 | );
72 | }
73 | }
74 | }
75 |
--------------------------------------------------------------------------------
/MFiles.VAF.Extensions.Tests/ExtensionMethods/FormattingExtensionMethods.cs:
--------------------------------------------------------------------------------
1 | using Microsoft.VisualStudio.TestTools.UnitTesting;
2 | using System;
3 | using System.Collections.Generic;
4 | using System.Threading;
5 |
6 | namespace MFiles.VAF.Extensions.Tests.ExtensionMethods
7 | {
8 | [TestClass]
9 | public class FormattingExtensionMethods
10 | {
11 | public FormattingExtensionMethods()
12 | {
13 | Thread.CurrentThread.CurrentCulture = new System.Globalization.CultureInfo("en-US");
14 | Thread.CurrentThread.CurrentUICulture = new System.Globalization.CultureInfo("en-US");
15 | }
16 |
17 | [TestMethod]
18 | public void ToDashboardDisplayString_HoursMinutesSeconds()
19 | {
20 | var interval = new TimeSpan(1, 30, 32);
21 | Assert.AreEqual
22 | (
23 | "Runs on vault startup and every 1 hour, 30 minutes, and 32 seconds.
",
24 | interval.ToDashboardDisplayString()
25 | );
26 | }
27 |
28 | [TestMethod]
29 | public void ToDashboardDisplayString_RunOnStartup_False()
30 | {
31 | var interval = new TimeSpanEx(new TimeSpan(1, 30, 32))
32 | {
33 | RunOnVaultStartup = false
34 | };
35 | Assert.AreEqual
36 | (
37 | "Runs every 1 hour, 30 minutes, and 32 seconds.
",
38 | interval.ToDashboardDisplayString()
39 | );
40 | }
41 |
42 | [TestMethod]
43 | public void ToDashboardDisplayString_RunOnStartup_True()
44 | {
45 | var interval = new TimeSpanEx(new TimeSpan(1, 30, 32))
46 | {
47 | RunOnVaultStartup = true
48 | };
49 | Assert.AreEqual
50 | (
51 | "Runs on vault startup and every 1 hour, 30 minutes, and 32 seconds.
",
52 | interval.ToDashboardDisplayString()
53 | );
54 | }
55 |
56 | [TestMethod]
57 | public void ToDisplayString_2hours_0minutes_23seconds()
58 | {
59 | TimeSpan? interval = new TimeSpan(2, 0, 23);
60 | Assert.AreEqual
61 | (
62 | "2 hours, and 23 seconds",
63 | interval.ToDisplayString()
64 | );
65 | }
66 |
67 | [TestMethod]
68 | public void ToDisplayString_2hours_1minute_23seconds()
69 | {
70 | TimeSpan? interval = new TimeSpan(2, 1, 23);
71 | Assert.AreEqual
72 | (
73 | "2 hours, 1 minute, and 23 seconds",
74 | interval.ToDisplayString()
75 | );
76 | }
77 |
78 | [TestMethod]
79 | public void ToDisplayString_2hours_10minutes_23seconds()
80 | {
81 | TimeSpan? interval = new TimeSpan(2, 10, 23);
82 | Assert.AreEqual
83 | (
84 | "2 hours, 10 minutes, and 23 seconds",
85 | interval.ToDisplayString()
86 | );
87 | }
88 |
89 | [TestMethod]
90 | public void ToDisplayString_2days_2hours_10minutes_23seconds()
91 | {
92 | TimeSpan? interval = new TimeSpan(2, 2, 10, 23);
93 | Assert.AreEqual
94 | (
95 | "2 days, 2 hours, 10 minutes, and 23 seconds",
96 | interval.ToDisplayString()
97 | );
98 | }
99 | }
100 | }
101 |
--------------------------------------------------------------------------------
/MFiles.VAF.Extensions/ExtensionMethods/MFSearchBuilderExtensionMethods/Owner.cs:
--------------------------------------------------------------------------------
1 | using System;
2 | using MFiles.VAF.Common;
3 | using MFilesAPI;
4 |
5 | namespace MFiles.VAF.Extensions
6 | {
7 | ///
8 | /// Extension methods for the class.
9 | ///
10 | // ReSharper disable once InconsistentNaming
11 | public static partial class MFSearchBuilderExtensionMethods
12 | {
13 | ///
14 | /// Adds a to the collection to find items with the given owner.
15 | ///
16 | /// The to add the condition to.
17 | /// The owner item.
18 | /// The provided, for chaining.
19 | public static MFSearchBuilder Owner
20 | (
21 | this MFSearchBuilder searchBuilder,
22 | ObjVerEx owner
23 | )
24 | {
25 | // Sanity.
26 | if (null == owner)
27 | throw new ArgumentNullException(nameof(owner));
28 |
29 | // Use the other overload.
30 | return searchBuilder.Owner(owner.ObjVer);
31 | }
32 |
33 | ///
34 | /// Adds a to the collection to find items with the given owner.
35 | ///
36 | /// The to add the condition to.
37 | /// The owner item.
38 | /// The provided, for chaining.
39 | public static MFSearchBuilder Owner
40 | (
41 | this MFSearchBuilder searchBuilder,
42 | ObjVer owner
43 | )
44 | {
45 | // Sanity.
46 | if (null == owner)
47 | throw new ArgumentNullException(nameof(owner));
48 |
49 | // Use the other overload.
50 | return searchBuilder.Owner(owner.ObjID);
51 | }
52 |
53 | ///
54 | /// Adds a to the collection to find items with the given owner.
55 | ///
56 | /// The to add the condition to.
57 | /// The owner item.
58 | /// The provided, for chaining.
59 | public static MFSearchBuilder Owner
60 | (
61 | this MFSearchBuilder searchBuilder,
62 | ObjID objID
63 | )
64 | {
65 | // Sanity.
66 | if (null == objID)
67 | throw new ArgumentNullException(nameof(objID));
68 |
69 | // Get the owner object type.
70 | var ownerObjType = searchBuilder
71 | .Vault
72 | .ObjectTypeOperations
73 | .GetObjectType(objID.Type);
74 |
75 | // Use the other method.
76 | return searchBuilder.AddPropertyValueSearchCondition
77 | (
78 | ownerObjType.OwnerPropertyDef,
79 | MFDataType.MFDatatypeLookup, // Owner must be single-select
80 | objID.ID,
81 | MFConditionType.MFConditionTypeEqual
82 | );
83 | }
84 |
85 | }
86 | }
87 |
--------------------------------------------------------------------------------
/MFiles.VAF.Extensions.Tests/ExtensionMethods/TimeZoneInformationExtensionMethodsTests.cs:
--------------------------------------------------------------------------------
1 | using MFilesAPI;
2 | using Microsoft.VisualStudio.TestTools.UnitTesting;
3 | using Moq;
4 | using System;
5 | using System.Collections.Generic;
6 |
7 | namespace MFiles.VAF.Extensions.Tests.ExtensionMethods
8 | {
9 | [TestClass]
10 | public class TimeZoneInformationExtensionMethodsTests
11 | {
12 | [TestMethod]
13 | [DynamicData(nameof(GetEnsureLocalTimeData), DynamicDataSourceType.Method)]
14 | public void EnsureLocalTime
15 | (
16 | string timezoneName,
17 | DateTime input,
18 | DateTime expected
19 | )
20 | {
21 | var tzMock = new Mock();
22 | tzMock.Setup(m => m.StandardName).Returns(timezoneName);
23 |
24 | var output = tzMock.Object.EnsureLocalTime(input);
25 | Assert.AreEqual(expected.ToString(), output.ToString());
26 | Assert.AreEqual(expected.Kind, output.Kind);
27 | }
28 |
29 | public static IEnumerable GetEnsureLocalTimeData()
30 | {
31 | yield return new object[]
32 | {
33 | "GMT Standard Time",
34 | new DateTime(2023, 08, 01, 10, 00, 00, DateTimeKind.Utc),
35 | new DateTime(2023, 08, 01, 11, 00, 00, DateTimeKind.Local)
36 | };
37 | yield return new object[]
38 | {
39 | "GMT Standard Time",
40 | new DateTime(2023, 08, 01, 10, 00, 00, DateTimeKind.Local),
41 | new DateTime(2023, 08, 01, 10, 00, 00, DateTimeKind.Local),
42 | };
43 | yield return new object[]
44 | {
45 | "GMT Standard Time",
46 | new DateTime(2023, 08, 01, 10, 00, 00, DateTimeKind.Unspecified),
47 | new DateTime(2023, 08, 01, 10, 00, 00, DateTimeKind.Unspecified),
48 | };
49 | }
50 |
51 | [TestMethod]
52 | [DynamicData(nameof(GetEnsureUtcTimeData), DynamicDataSourceType.Method)]
53 | public void EnsureUtcTime
54 | (
55 | string timezoneName,
56 | DateTime input,
57 | DateTime expected
58 | )
59 | {
60 | var tzMock = new Mock();
61 | tzMock.Setup(m => m.StandardName).Returns(timezoneName);
62 |
63 | var output = tzMock.Object.EnsureUTCTime(input);
64 | Assert.AreEqual(expected.ToString(), output.ToString());
65 | Assert.AreEqual(expected.Kind, output.Kind);
66 | }
67 |
68 | public static IEnumerable GetEnsureUtcTimeData()
69 | {
70 | yield return new object[]
71 | {
72 | "GMT Standard Time",
73 | new DateTime(2023, 08, 01, 10, 00, 00, DateTimeKind.Local),
74 | new DateTime(2023, 08, 01, 09, 00, 00, DateTimeKind.Utc)
75 | };
76 | yield return new object[]
77 | {
78 | "GMT Standard Time",
79 | new DateTime(2023, 08, 01, 10, 00, 00, DateTimeKind.Utc),
80 | new DateTime(2023, 08, 01, 10, 00, 00, DateTimeKind.Utc)
81 | };
82 | yield return new object[]
83 | {
84 | "GMT Standard Time",
85 | new DateTime(2023, 08, 01, 10, 00, 00, DateTimeKind.Unspecified),
86 | new DateTime(2023, 08, 01, 10, 00, 00, DateTimeKind.Unspecified)
87 | };
88 | }
89 | }
90 | }
91 |
--------------------------------------------------------------------------------
/MFiles.VAF.Extensions.Tests/ExtensionMethods/MFSearchBuilderExtensionMethods/ExternalID.cs:
--------------------------------------------------------------------------------
1 | using System;
2 | using System.Collections.Generic;
3 | using System.Linq;
4 | using System.Text;
5 | using System.Threading.Tasks;
6 | using MFilesAPI;
7 | using Microsoft.VisualStudio.TestTools.UnitTesting;
8 |
9 | namespace MFiles.VAF.Extensions.Tests.ExtensionMethods.MFSearchBuilderExtensionMethods
10 | {
11 | [TestClass]
12 | public class ExternalId
13 | : MFSearchBuilderExtensionMethodTestBase
14 | {
15 | ///
16 | /// Tests that calling
17 | ///
18 | /// adds a search condition.
19 | ///
20 | [TestMethod]
21 | public void AddsSearchCondition()
22 | {
23 | // Create the search builder.
24 | var mfSearchBuilder = this.GetSearchBuilder();
25 |
26 | // Ensure it has no items in the collection.
27 | Assert.AreEqual(0, mfSearchBuilder.Conditions.Count);
28 |
29 | // Add the search condition for the external ID.
30 | mfSearchBuilder.ExternalId("hello-world");
31 |
32 | // Ensure that there is one item in the collection.
33 | Assert.AreEqual(1, mfSearchBuilder.Conditions.Count);
34 | }
35 |
36 | [TestMethod]
37 | [ExpectedException(typeof(ArgumentNullException))]
38 | public void NullExternalIdThrows()
39 | {
40 | // Create the search builder.
41 | var mfSearchBuilder = this.GetSearchBuilder();
42 |
43 | // Attempt to search by null.
44 | mfSearchBuilder.ExternalId(null);
45 | }
46 |
47 | ///
48 | /// Tests that calling
49 | ///
50 | /// adds a valid search condition.
51 | ///
52 | [TestMethod]
53 | public void SearchConditionIsCorrect()
54 | {
55 | // Create the search builder.
56 | var mfSearchBuilder = this.GetSearchBuilder();
57 |
58 | // Add the search condition for the external ID.
59 | mfSearchBuilder.ExternalId("hello-world");
60 |
61 | // If there's anything other than one condition then fail.
62 | if (mfSearchBuilder.Conditions.Count != 1)
63 | Assert.Inconclusive("Only one search condition should exist");
64 |
65 | // Retrieve the just-added condition.
66 | var condition = mfSearchBuilder.Conditions[mfSearchBuilder.Conditions.Count];
67 |
68 | // Ensure the condition type is correct.
69 | Assert.AreEqual(MFConditionType.MFConditionTypeEqual, condition.ConditionType);
70 |
71 | // Ensure the expression type is correct.
72 | Assert.AreEqual(MFExpressionType.MFExpressionTypeStatusValue, condition.Expression.Type);
73 |
74 | // Ensure the status value is correct.
75 | Assert.AreEqual(MFStatusType.MFStatusTypeExtID, condition.Expression.DataStatusValueType);
76 |
77 | // Ensure that the typed value is correct.
78 | Assert.AreEqual(MFDataType.MFDatatypeText, condition.TypedValue.DataType);
79 | Assert.AreEqual("hello-world", condition.TypedValue.Value as string);
80 | }
81 | }
82 | }
83 |
--------------------------------------------------------------------------------
/MFiles.VAF.Extensions.Tests/Configuration/Upgrading/ConfigurationUpgradeManager.cs:
--------------------------------------------------------------------------------
1 | using MFiles.VAF.Configuration;
2 | using MFiles.VAF.Extensions.Configuration.Upgrading;
3 | using MFilesAPI;
4 | using Microsoft.VisualStudio.TestTools.UnitTesting;
5 | using Moq;
6 | using Newtonsoft.Json.Linq;
7 | using System;
8 | using System.Collections.Generic;
9 | using System.Linq;
10 | using System.Text;
11 | using System.Threading.Tasks;
12 |
13 | namespace MFiles.VAF.Extensions.Tests.Configuration.Upgrading
14 | {
15 | [TestClass]
16 | public partial class ConfigurationUpgradeManager
17 | : TestBaseWithVaultMock
18 | {
19 | delegate void readConfigurationDataCallback(Vault v, string @namespace, string @name, out string value);
20 |
21 | protected IConfigurationStorage GetConfigurationStorage(TConfigurationType configuration)
22 | => GetConfigurationStorage(configuration == null ? (string)null : Newtonsoft.Json.JsonConvert.SerializeObject(configuration));
23 |
24 | protected IConfigurationStorage GetConfigurationStorage(string configurationData = null)
25 | {
26 | var storage = new Mock();
27 |
28 | // Reading of data.
29 | storage
30 | .Setup(m => m.ReadConfigurationData(It.IsAny(), It.IsAny(), It.IsAny()))
31 | .Returns(() => configurationData);
32 | storage
33 | .Setup(m => m.ReadConfigurationData(It.IsAny(), It.IsAny(), It.IsAny(), out It.Ref.IsAny))
34 | .Callback(new readConfigurationDataCallback((Vault v, string @namespace, string @name, out string value) =>
35 | {
36 | value = configurationData;
37 | }))
38 | .Returns(configurationData != null);
39 |
40 | // Writing of data.
41 | storage
42 | .Setup(m => m.SaveConfigurationData(It.IsAny(), It.IsAny(), It.IsAny(), It.IsAny()))
43 | .Callback((Vault v, string @namespace, string @data, string @key) =>
44 | {
45 | configurationData = @data;
46 | });
47 |
48 | // Deserialisation.
49 | // Note: this isn't a true mock, but we'll assume that Newtonsoft is capable of doing these actions as it makes the method more flexible.
50 | storage
51 | .Setup(m => m.Deserialize(It.IsAny(), It.IsAny()))
52 | .Returns((Type t, string s) => Newtonsoft.Json.JsonConvert.DeserializeObject(s, t));
53 | storage
54 | .Setup(m => m.Deserialize(It.IsAny()))
55 | .Returns
56 | (
57 | // The generic method is a bit awkward to mock...
58 | new InvocationFunc((invocation) =>
59 | {
60 | return Newtonsoft.Json.JsonConvert.DeserializeObject(invocation.Arguments[0] as string, invocation.Method.GetGenericArguments()[0]);
61 | })
62 | );
63 |
64 | // Serialisation.
65 | storage
66 | .Setup(m => m.Serialize(It.IsAny