mcs/class/System.Data.Linq/src/DbLinq/Schema/Dbml/DbmlSerializer.cs

   1 #region MIT license\r
   2 // \r
   3 // MIT license\r
   4 //\r
   5 // Copyright (c) 2007-2008 Jiri Moudry, Pascal Craponne\r
   6 // \r
   7 // Permission is hereby granted, free of charge, to any person obtaining a copy\r
   8 // of this software and associated documentation files (the "Software"), to deal\r
   9 // in the Software without restriction, including without limitation the rights\r
  10 // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\r
  11 // copies of the Software, and to permit persons to whom the Software is\r
  12 // furnished to do so, subject to the following conditions:\r
  13 // \r
  14 // The above copyright notice and this permission notice shall be included in\r
  15 // all copies or substantial portions of the Software.\r
  16 // \r
  17 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
  18 // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\r
  19 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\r
  20 // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\r
  21 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\r
  22 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\r
  23 // THE SOFTWARE.\r
  24 // \r
  25 #endregion\r
  26 using System.Collections.Generic;\r
  27 using System.IO;\r
  28 using System.Reflection;\r
  29 using System.Xml;\r
  30 using System.Xml.Schema;\r
  31 using System.Xml.Serialization;\r
  32 \r
  33 namespace DbLinq.Schema.Dbml\r
  34 {\r
  35     /// <summary>\r
  36     /// Serializes DBML\r
  37     /// </summary>\r
  38 #if MONO_STRICT\r
  39     internal\r
  40 #else\r
  41     public\r
  42 #endif\r
  43     static class DbmlSerializer\r
  44     {\r
  45         private class ValidationException : XmlSchemaValidationException\r
  46         {\r
  47             public ValidationException(IList<string> errors)\r
  48             {\r
  49                 Data["Errors"] = errors;\r
  50             }\r
  51         }\r
  52 \r
  53         /// <summary>\r
  54         /// Opens the XML stream, given an XSD validation.\r
  55         /// </summary>\r
  56         /// <param name="xmlStream">The XML stream.</param>\r
  57         /// <param name="xsdStream">The XSD stream.</param>\r
  58         /// <param name="validationErrors">The validation errors.</param>\r
  59         /// <returns></returns>\r
  60         private static XmlReader OpenXml(Stream xmlStream, Stream xsdStream, ICollection<string> validationErrors)\r
  61         {\r
  62             validationErrors.Clear();\r
  63 \r
  64             var xmlReaderSettings = new XmlReaderSettings();\r
  65             xmlReaderSettings.Schemas.Add(null, XmlReader.Create(xsdStream));\r
  66             xmlReaderSettings.ValidationType = ValidationType.Schema;\r
  67             xmlReaderSettings.ValidationEventHandler += ((sender, e) => validationErrors.Add(e.Message));\r
  68             var xmlValidator = XmlReader.Create(xmlStream, xmlReaderSettings);\r
  69             return xmlValidator;\r
  70         }\r
  71 \r
  72         /// <summary>\r
  73         /// Opens the XSD file.\r
  74         /// </summary>\r
  75         /// <returns></returns>\r
  76         private static Stream OpenXsd()\r
  77         {\r
  78             return Assembly.GetExecutingAssembly().GetManifestResourceStream(typeof(DbmlSerializer), "DbmlSchema.xsd");\r
  79         }\r
  80 \r
  81         /// <summary>\r
  82         /// Checks if validation contains error.\r
  83         /// </summary>\r
  84         /// <param name="validationErrors">The validation errors.</param>\r
  85         private static void CheckValidation(IList<string> validationErrors)\r
  86         {\r
  87             if (validationErrors.Count > 0)\r
  88             {\r
  89                 throw new ValidationException(validationErrors);\r
  90             }\r
  91         }\r
  92 \r
  93         /// <summary>\r
  94         /// Reads the specified XML stream for a Database schema.\r
  95         /// </summary>\r
  96         /// <param name="xmlStream">The XML stream.</param>\r
  97         /// <param name="validationErrors">The validation errors.</param>\r
  98         /// <returns></returns>\r
  99         public static Database Read(Stream xmlStream, IList<string> validationErrors)\r
 100         {\r
 101             using (Stream xsdStream = OpenXsd())\r
 102             using (XmlReader xmlReader = OpenXml(xmlStream, xsdStream, validationErrors))\r
 103             {\r
 104                 var xmlSerializer = new XmlSerializer(typeof(Database));\r
 105                 var dbml = (Database)xmlSerializer.Deserialize(xmlReader);\r
 106                 return dbml;\r
 107             }\r
 108         }\r
 109 \r
 110         /// <summary>\r
 111         /// Reads the specified XML stream for a DBML schema.\r
 112         /// </summary>\r
 113         /// <param name="xmlStream">The XML stream.</param>\r
 114         /// <returns></returns>\r
 115         public static Database Read(Stream xmlStream)\r
 116         {\r
 117             var validationErrors = new List<string>();\r
 118             var dbml = Read(xmlStream, validationErrors);\r
 119             CheckValidation(validationErrors);\r
 120             return dbml;\r
 121         }\r
 122 \r
 123         /// <summary>\r
 124         /// Writes the specified XML stream.\r
 125         /// </summary>\r
 126         /// <param name="xmlStream">The XML stream.</param>\r
 127         /// <param name="dbml">The DBML.</param>\r
 128         public static void Write(Stream xmlStream, Database dbml)\r
 129         {\r
 130             var xmlSerializer = new XmlSerializer(dbml.GetType());\r
 131             xmlSerializer.Serialize(xmlStream, dbml);\r
 132         }\r
 133     }\r
 134 }