/****************************************************************************** // Canary Islands Computer Museum Website // ---------------------------------------------------------------------------- // // Filename : Log.cs // Author(s) : Natalia Portillo // // --[ Description ] ---------------------------------------------------------- // // Contains operations to manage log entries. // // --[ License ] -------------------------------------------------------------- // // This program is free software: you can redistribute it and/or modify // it under the terms of the GNU General Public License as // published by the Free Software Foundation, either version 3 of the // License, or (at your option) any later version. // // This program is distributed in the hope that it will be useful, // but WITHOUT ANY WARRANTY; without even the implied warranty of // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // GNU General Public License for more details. // // You should have received a copy of the GNU General Public License // along with this program. If not, see . // // ---------------------------------------------------------------------------- // Copyright © 2003-2018 Natalia Portillo *******************************************************************************/ using System; using System.Collections.Generic; using System.Data; using Cicm.Database.Schemas; namespace Cicm.Database { public partial class Operations { /// /// Gets all log entries /// /// All log entries /// true if is correct, false otherwise public bool GetLogs(out List entries) { #if DEBUG Console.WriteLine("Getting all logs..."); #endif try { const string SQL = "SELECT * from log"; IDbCommand dbCmd = dbCon.CreateCommand(); IDbDataAdapter dataAdapter = dbCore.GetNewDataAdapter(); dbCmd.CommandText = SQL; DataSet dataSet = new DataSet(); dataAdapter.SelectCommand = dbCmd; dataAdapter.Fill(dataSet); entries = LogsFromDataTable(dataSet.Tables[0]); return true; } catch(Exception ex) { Console.WriteLine("Error getting logs."); Console.WriteLine(ex); entries = null; return false; } } /// /// Gets the specified number of log entries since the specified start /// /// List of log entries /// Start of query /// How many entries to retrieve /// true if is correct, false otherwise public bool GetLogs(out List entries, ulong start, ulong count) { #if DEBUG Console.WriteLine("Getting {0} logs from {1}...", count, start); #endif try { string sql = $"SELECT * FROM log LIMIT {start}, {count}"; IDbCommand dbCmd = dbCon.CreateCommand(); IDbDataAdapter dataAdapter = dbCore.GetNewDataAdapter(); dbCmd.CommandText = sql; DataSet dataSet = new DataSet(); dataAdapter.SelectCommand = dbCmd; dataAdapter.Fill(dataSet); entries = LogsFromDataTable(dataSet.Tables[0]); return true; } catch(Exception ex) { Console.WriteLine("Error getting logs."); Console.WriteLine(ex); entries = null; return false; } } /// /// Gets log entry by specified id /// /// Id /// Log entry with specified id, null if not found or error public Log GetLog(int id) { #if DEBUG Console.WriteLine("Getting log with id {0}...", id); #endif try { string sql = $"SELECT * from log WHERE id = '{id}'"; IDbCommand dbCmd = dbCon.CreateCommand(); IDbDataAdapter dataAdapter = dbCore.GetNewDataAdapter(); dbCmd.CommandText = sql; DataSet dataSet = new DataSet(); dataAdapter.SelectCommand = dbCmd; dataAdapter.Fill(dataSet); List entries = LogsFromDataTable(dataSet.Tables[0]); return entries == null || entries.Count == 0 ? null : entries[0]; } catch(Exception ex) { Console.WriteLine("Error getting log."); Console.WriteLine(ex); return null; } } /// /// Counts the number of log entries in the database /// /// Entries in database public long CountLogs() { #if DEBUG Console.WriteLine("Counting logs..."); #endif IDbCommand dbcmd = dbCon.CreateCommand(); dbcmd.CommandText = "SELECT COUNT(*) FROM log"; object count = dbcmd.ExecuteScalar(); dbcmd.Dispose(); try { return Convert.ToInt64(count); } catch { return 0; } } /// /// Adds a new access log entry to the database /// /// Entry to add /// ID of added entry /// true if added correctly, false otherwise public bool AddLog(Log entry, out long id) { #if DEBUG Console.Write("Adding log `{0}`...", entry.UserAgent); #endif IDbCommand dbcmd = GetCommandLog(entry); IDbTransaction trans = dbCon.BeginTransaction(); dbcmd.Transaction = trans; const string SQL = "INSERT INTO log (browser, date, ip, referer)" + " VALUES (@browser, @date, @ip, @referer)"; dbcmd.CommandText = SQL; dbcmd.ExecuteNonQuery(); trans.Commit(); dbcmd.Dispose(); id = dbCore.LastInsertRowId; #if DEBUG Console.WriteLine(" id {0}", id); #endif return true; } /// /// Updated an access log in the database /// /// Updated entry /// true if updated correctly, false otherwise public bool UpdateLog(Log entry) { #if DEBUG Console.WriteLine("Updating log `{0}`...", entry.UserAgent); #endif IDbCommand dbcmd = GetCommandLog(entry); IDbTransaction trans = dbCon.BeginTransaction(); dbcmd.Transaction = trans; string sql = "UPDATE log SET browser = @browser, date = @date, ip = @ip, referer = @referer " + $"WHERE id = {entry.Id}"; dbcmd.CommandText = sql; dbcmd.ExecuteNonQuery(); trans.Commit(); dbcmd.Dispose(); return true; } /// /// Removes an access log entry from the database /// /// ID of entry to remove /// true if removed correctly, false otherwise public bool RemoveLog(long id) { #if DEBUG Console.WriteLine("Removing log widh id `{0}`...", id); #endif IDbCommand dbcmd = dbCon.CreateCommand(); IDbTransaction trans = dbCon.BeginTransaction(); dbcmd.Transaction = trans; string sql = $"DELETE FROM log WHERE id = '{id}';"; dbcmd.CommandText = sql; dbcmd.ExecuteNonQuery(); trans.Commit(); dbcmd.Dispose(); return true; } IDbCommand GetCommandLog(Log entry) { IDbCommand dbcmd = dbCon.CreateCommand(); IDbDataParameter param1 = dbcmd.CreateParameter(); IDbDataParameter param2 = dbcmd.CreateParameter(); IDbDataParameter param3 = dbcmd.CreateParameter(); IDbDataParameter param4 = dbcmd.CreateParameter(); param1.ParameterName = "@browser"; param2.ParameterName = "@date"; param3.ParameterName = "@ip"; param4.ParameterName = "@referer"; param1.DbType = DbType.String; param2.DbType = DbType.String; param3.DbType = DbType.String; param4.DbType = DbType.String; param1.Value = entry.UserAgent; param2.Value = entry.Date; param3.Value = entry.Ip; param4.Value = entry.Referer; dbcmd.Parameters.Add(param1); dbcmd.Parameters.Add(param2); dbcmd.Parameters.Add(param3); dbcmd.Parameters.Add(param4); return dbcmd; } static List LogsFromDataTable(DataTable dataTable) { List entries = new List(); foreach(DataRow dataRow in dataTable.Rows) { Log entry = new Log { Id = (int)dataRow["id"], UserAgent = (string)dataRow["browser"], Date = (string)dataRow["date"], Ip = (string)dataRow["ip"], Referer = (string)dataRow["referer"] }; entries.Add(entry); } return entries; } } }