opensim/OpenSim/Data/MySQL/MySQLAssetData.cs

/*
 * Copyright (c) Contributors, http://opensimulator.org/
 * See CONTRIBUTORS.TXT for a full list of copyright holders.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of the OpenSimulator Project nor the
 *       names of its contributors may be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

using System;
using System.Data;
using System.Reflection;
using System.Collections.Generic;
using log4net;
using MySql.Data.MySqlClient;
using OpenMetaverse;
using OpenSim.Framework;

namespace OpenSim.Data.MySQL
{
    /// <summary>
    /// A MySQL Interface for the Asset Server
    /// </summary>
    public class MySQLAssetData : AssetDataBase
    {
        private static readonly ILog m_log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);

        private MySQLManager _dbConnection;

        #region IPlugin Members

        /// <summary>
        /// <para>Initialises Asset interface</para>
        /// <para>
        /// <list type="bullet">
        /// <item>Loads and initialises the MySQL storage plugin.</item>
        /// <item>Warns and uses the obsolete mysql_connection.ini if connect string is empty.</item>
        /// <item>Check for migration</item>
        /// </list>
        /// </para>
        /// </summary>
        /// <param name="connect">connect string</param>
        override public void Initialise(string connect)
        {
            // TODO: This will let you pass in the connect string in
            // the config, though someone will need to write that.
            if (connect == String.Empty)
            {
                // This is old seperate config file
                m_log.Warn("no connect string, using old mysql_connection.ini instead");
                Initialise();
            }
            else
            {
                _dbConnection = new MySQLManager(connect);
            }

            // This actually does the roll forward assembly stuff
            Assembly assem = GetType().Assembly;
            Migration m = new Migration(_dbConnection.Connection, assem, "AssetStore");

            m.Update();
        }

        /// <summary>
        /// <para>Initialises Asset interface</para>
        /// <para>
        /// <list type="bullet">
        /// <item>Loads and initialises the MySQL storage plugin</item>
        /// <item>uses the obsolete mysql_connection.ini</item>
        /// </list>
        /// </para>
        /// </summary>
        /// <remarks>DEPRECATED and shouldn't be used</remarks>
        public override void Initialise()
        {
            IniFile GridDataMySqlFile = new IniFile("mysql_connection.ini");
            string hostname = GridDataMySqlFile.ParseFileReadValue("hostname");
            string database = GridDataMySqlFile.ParseFileReadValue("database");
            string username = GridDataMySqlFile.ParseFileReadValue("username");
            string password = GridDataMySqlFile.ParseFileReadValue("password");
            string pooling = GridDataMySqlFile.ParseFileReadValue("pooling");
            string port = GridDataMySqlFile.ParseFileReadValue("port");

            _dbConnection = new MySQLManager(hostname, database, username, password, pooling, port);

        }

        public override void Dispose() { }

        /// <summary>
        /// Database provider version
        /// </summary>
        override public string Version
        {
            get { return _dbConnection.getVersion(); }
        }

        /// <summary>
        /// The name of this DB provider
        /// </summary>
        override public string Name
        {
            get { return "MySQL Asset storage engine"; }
        }

        #endregion

        #region IAssetDataPlugin Members

        /// <summary>
        /// Fetch Asset <paramref name="assetID"/> from database
        /// </summary>
        /// <param name="assetID">Asset UUID to fetch</param>
        /// <returns>Return the asset</returns>
        /// <remarks>On failure : throw an exception and attempt to reconnect to database</remarks>
        override public AssetBase GetAsset(UUID assetID)
        {
            AssetBase asset = null;
            lock (_dbConnection)
            {
                _dbConnection.CheckConnection();

                using (MySqlCommand cmd = new MySqlCommand(
                    "SELECT name, description, assetType, local, temporary, data FROM assets WHERE id=?id",
                    _dbConnection.Connection))
                {
                    cmd.Parameters.AddWithValue("?id", assetID.ToString());

                    try
                    {
                        using (MySqlDataReader dbReader = cmd.ExecuteReader(CommandBehavior.SingleRow))
                        {
                            if (dbReader.Read())
                            {
                                asset = new AssetBase();
                                asset.Data = (byte[])dbReader["data"];
                                asset.Description = (string)dbReader["description"];
                                asset.FullID = assetID;

                                string local = dbReader["local"].ToString();
                                if (local.Equals("1") || local.Equals("true", StringComparison.InvariantCultureIgnoreCase))
                                    asset.Local = true;
                                else
                                    asset.Local = false;

                                asset.Name = (string)dbReader["name"];
                                asset.Type = (sbyte)dbReader["assetType"];
                                asset.Temporary = Convert.ToBoolean(dbReader["temporary"]);
                            }
                        }

                        if (asset != null)
                            UpdateAccessTime(asset);
                    }
                    catch (Exception e)
                    {
                        m_log.ErrorFormat(
                            "[ASSETS DB]: MySql failure fetching asset {0}" + Environment.NewLine + e.ToString()
                            + Environment.NewLine + "Reconnecting", assetID);
                        _dbConnection.Reconnect();
                    }
                }
            }
            return asset;
        }

        /// <summary>
        /// Create an asset in database, or update it if existing.
        /// </summary>
        /// <param name="asset">Asset UUID to create</param>
        /// <remarks>On failure : Throw an exception and attempt to reconnect to database</remarks>
        override public void StoreAsset(AssetBase asset)
        {
            lock (_dbConnection)
            {
                _dbConnection.CheckConnection();

                MySqlCommand cmd =
                    new MySqlCommand(
                        "replace INTO assets(id, name, description, assetType, local, temporary, create_time, access_time, data)" +
                        "VALUES(?id, ?name, ?description, ?assetType, ?local, ?temporary, ?create_time, ?access_time, ?data)",
                        _dbConnection.Connection);

                string assetName = asset.Name;
                if (asset.Name.Length > 64)
                {
                    assetName = asset.Name.Substring(0, 64);
                    m_log.Warn("[ASSET DB]: Name field truncated from " + asset.Name.Length + " to " + assetName.Length + " characters on add");
                }
                
                string assetDescription = asset.Description;
                if (asset.Description.Length > 64)
                {
                    assetDescription = asset.Description.Substring(0, 64);
                    m_log.Warn("[ASSET DB]: Description field truncated from " + asset.Description.Length + " to " + assetDescription.Length + " characters on add");
                }
                
                // need to ensure we dispose
                try
                {
                    using (cmd)
                    {
                        // create unix epoch time
                        int now = (int)Utils.DateTimeToUnixTime(DateTime.UtcNow);
                        cmd.Parameters.AddWithValue("?id", asset.ID);
                        cmd.Parameters.AddWithValue("?name", assetName);
                        cmd.Parameters.AddWithValue("?description", assetDescription);
                        cmd.Parameters.AddWithValue("?assetType", asset.Type);
                        cmd.Parameters.AddWithValue("?local", asset.Local);
                        cmd.Parameters.AddWithValue("?temporary", asset.Temporary);
                        cmd.Parameters.AddWithValue("?create_time", now);
                        cmd.Parameters.AddWithValue("?access_time", now);
                        cmd.Parameters.AddWithValue("?data", asset.Data);
                        cmd.ExecuteNonQuery();
                        cmd.Dispose();
                    }
                }
                catch (Exception e)
                {
                    m_log.ErrorFormat("[ASSET DB]: MySQL failure creating asset {0} with name \"{1}\". Attempting reconnect. Error: {2}",
                        asset.FullID, asset.Name, e.Message);
                    _dbConnection.Reconnect();
                }
            }
        }

        private void UpdateAccessTime(AssetBase asset)
        {
            // Writing to the database every time Get() is called on an asset is killing us. Seriously. -jph
            return;

            lock (_dbConnection)
            {
                _dbConnection.CheckConnection();

                MySqlCommand cmd =
                    new MySqlCommand("update assets set access_time=?access_time where id=?id",
                                     _dbConnection.Connection);

                // need to ensure we dispose
                try
                {
                    using (cmd)
                    {
                        // create unix epoch time
                        int now = (int)Utils.DateTimeToUnixTime(DateTime.UtcNow);
                        cmd.Parameters.AddWithValue("?id", asset.ID);
                        cmd.Parameters.AddWithValue("?access_time", now);
                        cmd.ExecuteNonQuery();
                        cmd.Dispose();
                    }
                }
                catch (Exception e)
                {
                    m_log.ErrorFormat(
                        "[ASSETS DB]: " +
                        "MySql failure updating access_time for asset {0} with name {1}" + Environment.NewLine + e.ToString()
                        + Environment.NewLine + "Attempting reconnection", asset.FullID, asset.Name);
                    _dbConnection.Reconnect();
                }
            }

        }

        /// <summary>
        /// check if the asset UUID exist in database
        /// </summary>
        /// <param name="uuid">The asset UUID</param>
        /// <returns>true if exist.</returns>
        override public bool ExistsAsset(UUID uuid)
        {
            bool assetExists = false;

            lock (_dbConnection)
            {
                _dbConnection.CheckConnection();

                using (MySqlCommand cmd = new MySqlCommand(
                    "SELECT id FROM assets WHERE id=?id",
                    _dbConnection.Connection))
                {
                    cmd.Parameters.AddWithValue("?id", uuid.ToString());

                    try
                    {
                        using (MySqlDataReader dbReader = cmd.ExecuteReader(CommandBehavior.SingleRow))
                        {
                            if (dbReader.Read())
                                assetExists = true;
                        }
                    }
                    catch (Exception e)
                    {
                        m_log.ErrorFormat(
                            "[ASSETS DB]: MySql failure fetching asset {0}" + Environment.NewLine + e.ToString()
                            + Environment.NewLine + "Attempting reconnection", uuid);
                        _dbConnection.Reconnect();
                    }
                }
            }

            return assetExists;
        }

        /// <summary>
        /// Returns a list of AssetMetadata objects. The list is a subset of
        /// the entire data set offset by <paramref name="start" /> containing
        /// <paramref name="count" /> elements.
        /// </summary>
        /// <param name="start">The number of results to discard from the total data set.</param>
        /// <param name="count">The number of rows the returned list should contain.</param>
        /// <returns>A list of AssetMetadata objects.</returns>
        public override List<AssetMetadata> FetchAssetMetadataSet(int start, int count)
        {
            List<AssetMetadata> retList = new List<AssetMetadata>(count);

            lock (_dbConnection)
            {
                _dbConnection.CheckConnection();

                MySqlCommand cmd = new MySqlCommand("SELECT name,description,assetType,temporary,id FROM assets LIMIT ?start, ?count", _dbConnection.Connection);
                cmd.Parameters.AddWithValue("?start", start);
                cmd.Parameters.AddWithValue("?count", count);

                try
                {
                    using (MySqlDataReader dbReader = cmd.ExecuteReader())
                    {
                        while (dbReader.Read())
                        {
                            AssetMetadata metadata = new AssetMetadata();
                            metadata.Name = (string) dbReader["name"];
                            metadata.Description = (string) dbReader["description"];
                            metadata.Type = (sbyte) dbReader["assetType"];
                            metadata.Temporary = Convert.ToBoolean(dbReader["temporary"]); // Not sure if this is correct.
                            metadata.FullID = new UUID((string) dbReader["id"]);

                            // Current SHA1s are not stored/computed.
                            metadata.SHA1 = new byte[] {};

                            retList.Add(metadata);
                        }
                    }
                }
                catch (Exception e)
                {
                    m_log.Error("[ASSETS DB]: MySql failure fetching asset set" + Environment.NewLine + e.ToString() + Environment.NewLine + "Attempting reconnection");
                    _dbConnection.Reconnect();
                }
            }

            return retList;
        }

        #endregion


    }
}