MySQLGenericTableHandler.cs 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297
  1. /*
  2. * Copyright (c) Contributors, http://opensimulator.org/
  3. * See CONTRIBUTORS.TXT for a full list of copyright holders.
  4. *
  5. * Redistribution and use in source and binary forms, with or without
  6. * modification, are permitted provided that the following conditions are met:
  7. * * Redistributions of source code must retain the above copyright
  8. * notice, this list of conditions and the following disclaimer.
  9. * * Redistributions in binary form must reproduce the above copyright
  10. * notice, this list of conditions and the following disclaimer in the
  11. * documentation and/or other materials provided with the distribution.
  12. * * Neither the name of the OpenSimulator Project nor the
  13. * names of its contributors may be used to endorse or promote products
  14. * derived from this software without specific prior written permission.
  15. *
  16. * THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY
  17. * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  18. * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  19. * DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY
  20. * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  21. * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  22. * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  23. * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  24. * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  25. * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26. */
  27. using System;
  28. using System.Collections.Generic;
  29. using System.Data;
  30. using System.Reflection;
  31. using log4net;
  32. using MySql.Data.MySqlClient;
  33. using OpenMetaverse;
  34. using OpenSim.Framework;
  35. using OpenSim.Region.Framework.Interfaces;
  36. namespace OpenSim.Data.MySQL
  37. {
  38. public class MySQLGenericTableHandler<T> : MySqlFramework where T: class, new()
  39. {
  40. // private static readonly ILog m_log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);
  41. protected Dictionary<string, FieldInfo> m_Fields =
  42. new Dictionary<string, FieldInfo>();
  43. protected List<string> m_ColumnNames = null;
  44. protected string m_Realm;
  45. protected FieldInfo m_DataField = null;
  46. protected virtual Assembly Assembly
  47. {
  48. get { return GetType().Assembly; }
  49. }
  50. public MySQLGenericTableHandler(string connectionString,
  51. string realm, string storeName) : base(connectionString)
  52. {
  53. m_Realm = realm;
  54. m_connectionString = connectionString;
  55. if (storeName != String.Empty)
  56. {
  57. using (MySqlConnection dbcon = new MySqlConnection(m_connectionString))
  58. {
  59. dbcon.Open();
  60. Migration m = new Migration(dbcon, Assembly, storeName);
  61. m.Update();
  62. }
  63. }
  64. Type t = typeof(T);
  65. FieldInfo[] fields = t.GetFields(BindingFlags.Public |
  66. BindingFlags.Instance |
  67. BindingFlags.DeclaredOnly);
  68. if (fields.Length == 0)
  69. return;
  70. foreach (FieldInfo f in fields)
  71. {
  72. if (f.Name != "Data")
  73. m_Fields[f.Name] = f;
  74. else
  75. m_DataField = f;
  76. }
  77. }
  78. private void CheckColumnNames(IDataReader reader)
  79. {
  80. if (m_ColumnNames != null)
  81. return;
  82. m_ColumnNames = new List<string>();
  83. DataTable schemaTable = reader.GetSchemaTable();
  84. foreach (DataRow row in schemaTable.Rows)
  85. {
  86. if (row["ColumnName"] != null &&
  87. (!m_Fields.ContainsKey(row["ColumnName"].ToString())))
  88. m_ColumnNames.Add(row["ColumnName"].ToString());
  89. }
  90. }
  91. public virtual T[] Get(string field, string key)
  92. {
  93. return Get(new string[] { field }, new string[] { key });
  94. }
  95. public virtual T[] Get(string[] fields, string[] keys)
  96. {
  97. if (fields.Length != keys.Length)
  98. return new T[0];
  99. List<string> terms = new List<string>();
  100. using (MySqlCommand cmd = new MySqlCommand())
  101. {
  102. for (int i = 0 ; i < fields.Length ; i++)
  103. {
  104. cmd.Parameters.AddWithValue(fields[i], keys[i]);
  105. terms.Add("`" + fields[i] + "` = ?" + fields[i]);
  106. }
  107. string where = String.Join(" and ", terms.ToArray());
  108. string query = String.Format("select * from {0} where {1}",
  109. m_Realm, where);
  110. cmd.CommandText = query;
  111. return DoQuery(cmd);
  112. }
  113. }
  114. protected T[] DoQuery(MySqlCommand cmd)
  115. {
  116. List<T> result = new List<T>();
  117. using (MySqlConnection dbcon = new MySqlConnection(m_connectionString))
  118. {
  119. dbcon.Open();
  120. cmd.Connection = dbcon;
  121. using (IDataReader reader = cmd.ExecuteReader())
  122. {
  123. if (reader == null)
  124. return new T[0];
  125. CheckColumnNames(reader);
  126. while (reader.Read())
  127. {
  128. T row = new T();
  129. foreach (string name in m_Fields.Keys)
  130. {
  131. if (reader[name] is DBNull)
  132. {
  133. continue;
  134. }
  135. if (m_Fields[name].FieldType == typeof(bool))
  136. {
  137. int v = Convert.ToInt32(reader[name]);
  138. m_Fields[name].SetValue(row, v != 0 ? true : false);
  139. }
  140. else if (m_Fields[name].FieldType == typeof(UUID))
  141. {
  142. m_Fields[name].SetValue(row, DBGuid.FromDB(reader[name]));
  143. }
  144. else if (m_Fields[name].FieldType == typeof(int))
  145. {
  146. int v = Convert.ToInt32(reader[name]);
  147. m_Fields[name].SetValue(row, v);
  148. }
  149. else
  150. {
  151. m_Fields[name].SetValue(row, reader[name]);
  152. }
  153. }
  154. if (m_DataField != null)
  155. {
  156. Dictionary<string, string> data =
  157. new Dictionary<string, string>();
  158. foreach (string col in m_ColumnNames)
  159. {
  160. data[col] = reader[col].ToString();
  161. if (data[col] == null)
  162. data[col] = String.Empty;
  163. }
  164. m_DataField.SetValue(row, data);
  165. }
  166. result.Add(row);
  167. }
  168. }
  169. }
  170. return result.ToArray();
  171. }
  172. public virtual T[] Get(string where)
  173. {
  174. using (MySqlCommand cmd = new MySqlCommand())
  175. {
  176. string query = String.Format("select * from {0} where {1}",
  177. m_Realm, where);
  178. cmd.CommandText = query;
  179. return DoQuery(cmd);
  180. }
  181. }
  182. public virtual bool Store(T row)
  183. {
  184. using (MySqlCommand cmd = new MySqlCommand())
  185. {
  186. string query = "";
  187. List<String> names = new List<String>();
  188. List<String> values = new List<String>();
  189. foreach (FieldInfo fi in m_Fields.Values)
  190. {
  191. names.Add(fi.Name);
  192. values.Add("?" + fi.Name);
  193. // Temporarily return more information about what field is unexpectedly null for
  194. // http://opensimulator.org/mantis/view.php?id=5403. This might be due to a bug in the
  195. // InventoryTransferModule or we may be required to substitute a DBNull here.
  196. if (fi.GetValue(row) == null)
  197. throw new NullReferenceException(
  198. string.Format(
  199. "[MYSQL GENERIC TABLE HANDLER]: Trying to store field {0} for {1} which is unexpectedly null",
  200. fi.Name, row));
  201. cmd.Parameters.AddWithValue(fi.Name, fi.GetValue(row).ToString());
  202. }
  203. if (m_DataField != null)
  204. {
  205. Dictionary<string, string> data =
  206. (Dictionary<string, string>)m_DataField.GetValue(row);
  207. foreach (KeyValuePair<string, string> kvp in data)
  208. {
  209. names.Add(kvp.Key);
  210. values.Add("?" + kvp.Key);
  211. cmd.Parameters.AddWithValue("?" + kvp.Key, kvp.Value);
  212. }
  213. }
  214. query = String.Format("replace into {0} (`", m_Realm) + String.Join("`,`", names.ToArray()) + "`) values (" + String.Join(",", values.ToArray()) + ")";
  215. cmd.CommandText = query;
  216. if (ExecuteNonQuery(cmd) > 0)
  217. return true;
  218. return false;
  219. }
  220. }
  221. public virtual bool Delete(string field, string key)
  222. {
  223. return Delete(new string[] { field }, new string[] { key });
  224. }
  225. public virtual bool Delete(string[] fields, string[] keys)
  226. {
  227. if (fields.Length != keys.Length)
  228. return false;
  229. List<string> terms = new List<string>();
  230. using (MySqlCommand cmd = new MySqlCommand())
  231. {
  232. for (int i = 0 ; i < fields.Length ; i++)
  233. {
  234. cmd.Parameters.AddWithValue(fields[i], keys[i]);
  235. terms.Add("`" + fields[i] + "` = ?" + fields[i]);
  236. }
  237. string where = String.Join(" and ", terms.ToArray());
  238. string query = String.Format("delete from {0} where {1}", m_Realm, where);
  239. cmd.CommandText = query;
  240. return ExecuteNonQuery(cmd) > 0;
  241. }
  242. }
  243. }
  244. }