refactor: Move strings to resource.

4 files changed, 257 insertions, 5 deletions

diff --git a/BackEnd/Timeline/SignalRHub/Resource.Designer.cs b/BackEnd/Timeline/SignalRHub/Resource.Designer.cs
new file mode 100644
index 00000000..cdef0940
--- /dev/null
+++ b/BackEnd/Timeline/SignalRHub/Resource.Designer.cs
@@ -0,0 +1,108 @@
+//------------------------------------------------------------------------------

+// <auto-generated>

+//     This code was generated by a tool.

+//     Runtime Version:4.0.30319.42000

+//

+//     Changes to this file may cause incorrect behavior and will be lost if

+//     the code is regenerated.

+// </auto-generated>

+//------------------------------------------------------------------------------

+

+namespace Timeline.SignalRHub {

+    using System;

+    

+    

+    /// <summary>

+    ///   A strongly-typed resource class, for looking up localized strings, etc.

+    /// </summary>

+    // This class was auto-generated by the StronglyTypedResourceBuilder

+    // class via a tool like ResGen or Visual Studio.

+    // To add or remove a member, edit your .ResX file then rerun ResGen

+    // with the /str option, or rebuild your VS project.

+    [global::System.CodeDom.Compiler.GeneratedCodeAttribute("System.Resources.Tools.StronglyTypedResourceBuilder", "16.0.0.0")]

+    [global::System.Diagnostics.DebuggerNonUserCodeAttribute()]

+    [global::System.Runtime.CompilerServices.CompilerGeneratedAttribute()]

+    internal class Resource {

+        

+        private static global::System.Resources.ResourceManager resourceMan;

+        

+        private static global::System.Globalization.CultureInfo resourceCulture;

+        

+        [global::System.Diagnostics.CodeAnalysis.SuppressMessageAttribute("Microsoft.Performance", "CA1811:AvoidUncalledPrivateCode")]

+        internal Resource() {

+        }

+        

+        /// <summary>

+        ///   Returns the cached ResourceManager instance used by this class.

+        /// </summary>

+        [global::System.ComponentModel.EditorBrowsableAttribute(global::System.ComponentModel.EditorBrowsableState.Advanced)]

+        internal static global::System.Resources.ResourceManager ResourceManager {

+            get {

+                if (object.ReferenceEquals(resourceMan, null)) {

+                    global::System.Resources.ResourceManager temp = new global::System.Resources.ResourceManager("Timeline.SignalRHub.Resource", typeof(Resource).Assembly);

+                    resourceMan = temp;

+                }

+                return resourceMan;

+            }

+        }

+        

+        /// <summary>

+        ///   Overrides the current thread's CurrentUICulture property for all

+        ///   resource lookups using this strongly typed resource class.

+        /// </summary>

+        [global::System.ComponentModel.EditorBrowsableAttribute(global::System.ComponentModel.EditorBrowsableState.Advanced)]

+        internal static global::System.Globalization.CultureInfo Culture {

+            get {

+                return resourceCulture;

+            }

+            set {

+                resourceCulture = value;

+            }

+        }

+        

+        /// <summary>

+        ///   Looks up a localized string similar to Connection {0} is added to group {1} to listen to timeline post change..

+        /// </summary>

+        internal static string LogSubscribeTimelinePostChange {

+            get {

+                return ResourceManager.GetString("LogSubscribeTimelinePostChange", resourceCulture);

+            }

+        }

+        

+        /// <summary>

+        ///   Looks up a localized string similar to Remove connection {0} from group {1} to stop listening to timeline post change..

+        /// </summary>

+        internal static string LogUnsubscribeTimelinePostChange {

+            get {

+                return ResourceManager.GetString("LogUnsubscribeTimelinePostChange", resourceCulture);

+            }

+        }

+        

+        /// <summary>

+        ///   Looks up a localized string similar to You are forbidden to do this..

+        /// </summary>

+        internal static string MessageForbidden {

+            get {

+                return ResourceManager.GetString("MessageForbidden", resourceCulture);

+            }

+        }

+        

+        /// <summary>

+        ///   Looks up a localized string similar to Timeline name is illegal..

+        /// </summary>

+        internal static string MessageTimelineNameInvalid {

+            get {

+                return ResourceManager.GetString("MessageTimelineNameInvalid", resourceCulture);

+            }

+        }

+        

+        /// <summary>

+        ///   Looks up a localized string similar to Timeline does not exist..

+        /// </summary>

+        internal static string MessageTimelineNotExist {

+            get {

+                return ResourceManager.GetString("MessageTimelineNotExist", resourceCulture);

+            }

+        }

+    }

+}

diff --git a/BackEnd/Timeline/SignalRHub/Resource.resx b/BackEnd/Timeline/SignalRHub/Resource.resx
new file mode 100644
index 00000000..699521d1
--- /dev/null
+++ b/BackEnd/Timeline/SignalRHub/Resource.resx
@@ -0,0 +1,135 @@
+<?xml version="1.0" encoding="utf-8"?>

+<root>

+  <!-- 

+    Microsoft ResX Schema 

+    

+    Version 2.0

+    

+    The primary goals of this format is to allow a simple XML format 

+    that is mostly human readable. The generation and parsing of the 

+    various data types are done through the TypeConverter classes 

+    associated with the data types.

+    

+    Example:

+    

+    ... ado.net/XML headers & schema ...

+    <resheader name="resmimetype">text/microsoft-resx</resheader>

+    <resheader name="version">2.0</resheader>

+    <resheader name="reader">System.Resources.ResXResourceReader, System.Windows.Forms, ...</resheader>

+    <resheader name="writer">System.Resources.ResXResourceWriter, System.Windows.Forms, ...</resheader>

+    <data name="Name1"><value>this is my long string</value><comment>this is a comment</comment></data>

+    <data name="Color1" type="System.Drawing.Color, System.Drawing">Blue</data>

+    <data name="Bitmap1" mimetype="application/x-microsoft.net.object.binary.base64">

+        <value>[base64 mime encoded serialized .NET Framework object]</value>

+    </data>

+    <data name="Icon1" type="System.Drawing.Icon, System.Drawing" mimetype="application/x-microsoft.net.object.bytearray.base64">

+        <value>[base64 mime encoded string representing a byte array form of the .NET Framework object]</value>

+        <comment>This is a comment</comment>

+    </data>

+                

+    There are any number of "resheader" rows that contain simple 

+    name/value pairs.

+    

+    Each data row contains a name, and value. The row also contains a 

+    type or mimetype. Type corresponds to a .NET class that support 

+    text/value conversion through the TypeConverter architecture. 

+    Classes that don't support this are serialized and stored with the 

+    mimetype set.

+    

+    The mimetype is used for serialized objects, and tells the 

+    ResXResourceReader how to depersist the object. This is currently not 

+    extensible. For a given mimetype the value must be set accordingly:

+    

+    Note - application/x-microsoft.net.object.binary.base64 is the format 

+    that the ResXResourceWriter will generate, however the reader can 

+    read any of the formats listed below.

+    

+    mimetype: application/x-microsoft.net.object.binary.base64

+    value   : The object must be serialized with 

+            : System.Runtime.Serialization.Formatters.Binary.BinaryFormatter

+            : and then encoded with base64 encoding.

+    

+    mimetype: application/x-microsoft.net.object.soap.base64

+    value   : The object must be serialized with 

+            : System.Runtime.Serialization.Formatters.Soap.SoapFormatter

+            : and then encoded with base64 encoding.

+

+    mimetype: application/x-microsoft.net.object.bytearray.base64

+    value   : The object must be serialized into a byte array 

+            : using a System.ComponentModel.TypeConverter

+            : and then encoded with base64 encoding.

+    -->

+  <xsd:schema id="root" xmlns="" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:msdata="urn:schemas-microsoft-com:xml-msdata">

+    <xsd:import namespace="http://www.w3.org/XML/1998/namespace" />

+    <xsd:element name="root" msdata:IsDataSet="true">

+      <xsd:complexType>

+        <xsd:choice maxOccurs="unbounded">

+          <xsd:element name="metadata">

+            <xsd:complexType>

+              <xsd:sequence>

+                <xsd:element name="value" type="xsd:string" minOccurs="0" />

+              </xsd:sequence>

+              <xsd:attribute name="name" use="required" type="xsd:string" />

+              <xsd:attribute name="type" type="xsd:string" />

+              <xsd:attribute name="mimetype" type="xsd:string" />

+              <xsd:attribute ref="xml:space" />

+            </xsd:complexType>

+          </xsd:element>

+          <xsd:element name="assembly">

+            <xsd:complexType>

+              <xsd:attribute name="alias" type="xsd:string" />

+              <xsd:attribute name="name" type="xsd:string" />

+            </xsd:complexType>

+          </xsd:element>

+          <xsd:element name="data">

+            <xsd:complexType>

+              <xsd:sequence>

+                <xsd:element name="value" type="xsd:string" minOccurs="0" msdata:Ordinal="1" />

+                <xsd:element name="comment" type="xsd:string" minOccurs="0" msdata:Ordinal="2" />

+              </xsd:sequence>

+              <xsd:attribute name="name" type="xsd:string" use="required" msdata:Ordinal="1" />

+              <xsd:attribute name="type" type="xsd:string" msdata:Ordinal="3" />

+              <xsd:attribute name="mimetype" type="xsd:string" msdata:Ordinal="4" />

+              <xsd:attribute ref="xml:space" />

+            </xsd:complexType>

+          </xsd:element>

+          <xsd:element name="resheader">

+            <xsd:complexType>

+              <xsd:sequence>

+                <xsd:element name="value" type="xsd:string" minOccurs="0" msdata:Ordinal="1" />

+              </xsd:sequence>

+              <xsd:attribute name="name" type="xsd:string" use="required" />

+            </xsd:complexType>

+          </xsd:element>

+        </xsd:choice>

+      </xsd:complexType>

+    </xsd:element>

+  </xsd:schema>

+  <resheader name="resmimetype">

+    <value>text/microsoft-resx</value>

+  </resheader>

+  <resheader name="version">

+    <value>2.0</value>

+  </resheader>

+  <resheader name="reader">

+    <value>System.Resources.ResXResourceReader, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>

+  </resheader>

+  <resheader name="writer">

+    <value>System.Resources.ResXResourceWriter, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>

+  </resheader>

+  <data name="LogSubscribeTimelinePostChange" xml:space="preserve">

+    <value>Connection {0} is added to group {1} to listen to timeline post change.</value>

+  </data>

+  <data name="LogUnsubscribeTimelinePostChange" xml:space="preserve">

+    <value>Remove connection {0} from group {1} to stop listening to timeline post change.</value>

+  </data>

+  <data name="MessageForbidden" xml:space="preserve">

+    <value>You are forbidden to do this.</value>

+  </data>

+  <data name="MessageTimelineNameInvalid" xml:space="preserve">

+    <value>Timeline name is illegal.</value>

+  </data>

+  <data name="MessageTimelineNotExist" xml:space="preserve">

+    <value>Timeline does not exist.</value>

+  </data>

+</root>
\ No newline at end of file
diff --git a/BackEnd/Timeline/SignalRHub/TimelineHub.cs b/BackEnd/Timeline/SignalRHub/TimelineHub.cs
index 2ad7bd66..0bfda84c 100644
--- a/BackEnd/Timeline/SignalRHub/TimelineHub.cs
+++ b/BackEnd/Timeline/SignalRHub/TimelineHub.cs
@@ -32,19 +32,19 @@ namespace Timeline.SignalRHub
                 var timelineId = await _timelineService.GetTimelineIdByNameAsync(timelineName);

                 var user = Context.User;

                 if (!user.HasPermission(UserPermission.AllTimelineManagement) && !await _timelineService.HasReadPermissionAsync(timelineId, user.GetOptionalUserId()))

-                    throw new HubException("Forbidden.");

+                    throw new HubException(Resource.MessageForbidden);

 

                 var group = GenerateTimelinePostChangeListeningGroupName(timelineName);

                 await Groups.AddToGroupAsync(Context.ConnectionId, group);

-                _logger.LogInformation("Add connection {0} to group {1}", Context.ConnectionId, group);

+                _logger.LogInformation(Resource.LogSubscribeTimelinePostChange, Context.ConnectionId, group);

             }

             catch (ArgumentException)

             {

-                throw new HubException("Timeline name is illegal.");

+                throw new HubException(Resource.MessageTimelineNameInvalid);

             }

             catch (EntityNotExistException)

             {

-                throw new HubException("Timeline not exist.");

+                throw new HubException(Resource.MessageTimelineNotExist);

             }

         }

 

@@ -52,7 +52,7 @@ namespace Timeline.SignalRHub
         {

             var group = GenerateTimelinePostChangeListeningGroupName(timelineName);

             await Groups.RemoveFromGroupAsync(Context.ConnectionId, group);

-            _logger.LogInformation("Remove connection {0} from group {1}", Context.ConnectionId, group);

+            _logger.LogInformation(Resource.LogUnsubscribeTimelinePostChange, Context.ConnectionId, group);

         }

     }

 }

diff --git a/BackEnd/Timeline/Timeline.csproj b/BackEnd/Timeline/Timeline.csproj
index 955947af..0d0c08a0 100644
--- a/BackEnd/Timeline/Timeline.csproj
+++ b/BackEnd/Timeline/Timeline.csproj
@@ -123,6 +123,11 @@
             <AutoGen>True</AutoGen>

             <DependentUpon>Resource.resx</DependentUpon>

         </Compile>

+        <Compile Update="SignalRHub\Resource.Designer.cs">

+          <DesignTime>True</DesignTime>

+          <AutoGen>True</AutoGen>

+          <DependentUpon>Resource.resx</DependentUpon>

+        </Compile>

     </ItemGroup>

 

     <ItemGroup>

@@ -186,5 +191,9 @@
             <Generator>ResXFileCodeGenerator</Generator>

             <LastGenOutput>Resource.Designer.cs</LastGenOutput>

         </EmbeddedResource>

+        <EmbeddedResource Update="SignalRHub\Resource.resx">

+          <Generator>ResXFileCodeGenerator</Generator>

+          <LastGenOutput>Resource.Designer.cs</LastGenOutput>

+        </EmbeddedResource>

     </ItemGroup>

 </Project>
\ No newline at end of file