Aaru.Server/DiscImageChef.Core/Statistics.cs

// /***************************************************************************
// The Disc Image Chef
// ----------------------------------------------------------------------------
//
// Filename       : Statistics.cs
// Author(s)      : Natalia Portillo <claunia@claunia.com>
//
// Component      : Core algorithms.
//
// --[ Description ] ----------------------------------------------------------
//
//     Handles usage statistics.
//
// --[ 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 <http://www.gnu.org/licenses/>.
//
// ----------------------------------------------------------------------------
// Copyright © 2011-2018 Natalia Portillo
// ****************************************************************************/

using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Net;
using System.Threading;
using System.Xml.Serialization;
using DiscImageChef.Metadata;

namespace DiscImageChef.Core
{
    public static class Statistics
    {
        public static Stats AllStats;
        public static Stats CurrentStats;

        static bool submitStatsLock;

        public static void LoadStats()
        {
            if(File.Exists(Path.Combine(Settings.Settings.StatsPath, "Statistics.xml")))
            {
                AllStats = new Stats();
                CurrentStats = new Stats
                {
                    OperatingSystems =
                        new List<OsStats>
                        {
                            new OsStats
                            {
                                name = Interop.DetectOS.GetRealPlatformID().ToString(),
                                Value = 1,
                                version = Interop.DetectOS.GetVersion()
                            }
                        },
                    Versions = new List<NameValueStats> {new NameValueStats {name = Version.GetVersion(), Value = 1}}
                };
                XmlSerializer xs = new XmlSerializer(AllStats.GetType());
                StreamReader sr = new StreamReader(Path.Combine(Settings.Settings.StatsPath, "Statistics.xml"));
                AllStats = (Stats)xs.Deserialize(sr);
                sr.Close();
            }
            else if(Settings.Settings.Current.Stats != null)
            {
                AllStats = new Stats();
                CurrentStats = new Stats
                {
                    OperatingSystems =
                        new List<OsStats>
                        {
                            new OsStats
                            {
                                name = Interop.DetectOS.GetRealPlatformID().ToString(),
                                Value = 1,
                                version = Interop.DetectOS.GetVersion()
                            }
                        },
                    Versions = new List<NameValueStats> {new NameValueStats {name = Version.GetVersion(), Value = 1}}
                };
            }
            else
            {
                AllStats = null;
                CurrentStats = null;
            }
        }

        public static void SaveStats()
        {
            if(AllStats == null) return;

            if(AllStats.OperatingSystems != null)
            {
                long count = 0;

                OsStats old = null;
                foreach(OsStats nvs in AllStats.OperatingSystems.Where(nvs => nvs.name == Interop.DetectOS.GetRealPlatformID().ToString() &&
                                                                              nvs.version == Interop.DetectOS.GetVersion())) {
                    count = nvs.Value + 1;
                    old = nvs;
                    break;
                }

                if(old != null) AllStats.OperatingSystems.Remove(old);

                count++;
                AllStats.OperatingSystems.Add(new OsStats
                {
                    name = Interop.DetectOS.GetRealPlatformID().ToString(),
                    Value = count,
                    version = Interop.DetectOS.GetVersion()
                });
            }
            else if(CurrentStats != null) AllStats.OperatingSystems = CurrentStats.OperatingSystems;

            if(AllStats.Versions != null)
            {
                long count = 0;

                NameValueStats old = null;
                foreach(NameValueStats nvs in AllStats.Versions.Where(nvs => nvs.name == Version.GetVersion())) {
                    count = nvs.Value + 1;
                    old = nvs;
                    break;
                }

                if(old != null) AllStats.Versions.Remove(old);

                count++;
                AllStats.Versions.Add(new NameValueStats {name = Version.GetVersion(), Value = count});
            }
            else if(CurrentStats != null) AllStats.Versions = CurrentStats.Versions;

            FileStream fs = new FileStream(Path.Combine(Settings.Settings.StatsPath, "Statistics.xml"),
                                           FileMode.Create);
            XmlSerializer xs = new XmlSerializer(AllStats.GetType());
            xs.Serialize(fs, AllStats);
            fs.Close();

            if(CurrentStats != null)
            {
                string partial = string.Format("PartialStats_{0:yyyyMMddHHmmssfff}.xml", DateTime.UtcNow);

                fs = new FileStream(Path.Combine(Settings.Settings.StatsPath, partial), FileMode.Create);
                xs = new XmlSerializer(CurrentStats.GetType());
                xs.Serialize(fs, CurrentStats);
                fs.Close();
            }

            if(Settings.Settings.Current.Stats.ShareStats) SubmitStats();
        }

        public static void SubmitStats()
        {
            Thread submitThread = new Thread(() =>
            {
                if(submitStatsLock) return;

                submitStatsLock = true;

                var statsFiles = Directory.EnumerateFiles(Settings.Settings.StatsPath, "PartialStats_*.xml",
                                                          SearchOption.TopDirectoryOnly);

                foreach(string statsFile in statsFiles)
                    try
                    {
                        if(!File.Exists(statsFile)) continue;

                        Stats stats = new Stats();

                        // This can execute before debug console has been inited
#if DEBUG
                        System.Console.WriteLine("Uploading partial statistics file {0}", statsFile);
#else
                    DicConsole.DebugWriteLine("Submit stats", "Uploading partial statistics file {0}", statsFile);
#endif

                        FileStream fs = new FileStream(statsFile, FileMode.Open, FileAccess.Read);
                        XmlSerializer xs = new XmlSerializer(stats.GetType());
                        stats = (Stats)xs.Deserialize(fs);
                        fs.Seek(0, SeekOrigin.Begin);

                        WebRequest request = WebRequest.Create("http://discimagechef.claunia.com/api/uploadstats");
                        ((HttpWebRequest)request).UserAgent =
                            string.Format("DiscImageChef {0}", typeof(Version).Assembly.GetName().Version);
                        request.Method = "POST";
                        request.ContentLength = fs.Length;
                        request.ContentType = "application/xml";
                        Stream reqStream = request.GetRequestStream();
                        fs.CopyTo(reqStream);
                        reqStream.Close();
                        WebResponse response = request.GetResponse();

                        if(((HttpWebResponse)response).StatusCode != HttpStatusCode.OK) return;

                        Stream data = response.GetResponseStream();
                        StreamReader reader = new StreamReader(data);

                        string responseFromServer = reader.ReadToEnd();
                        data.Close();
                        response.Close();
                        fs.Close();
                        if(responseFromServer == "ok") File.Delete(statsFile);
                    }
                    catch(WebException)
                    {
                        // Can't connect to the server, postpone til next try
                        break;
                    }
                    catch
                    {
#if DEBUG
                        submitStatsLock = false;
                        throw;
#else
                        continue;
#endif
                    }

                submitStatsLock = false;
            });
            submitThread.Start();
        }

        public static void AddCommand(string command)
        {
            if(Settings.Settings.Current.Stats == null || !Settings.Settings.Current.Stats.DeviceStats) return;

            if(AllStats.Commands == null) AllStats.Commands = new CommandsStats();

            if(CurrentStats.Commands == null) CurrentStats.Commands = new CommandsStats();

            switch(command)
            {
                case "analyze":
                    AllStats.Commands.Analyze++;
                    CurrentStats.Commands.Analyze++;
                    break;
                case "benchmark":
                    AllStats.Commands.Benchmark++;
                    CurrentStats.Commands.Benchmark++;
                    break;
                case "checksum":
                    AllStats.Commands.Checksum++;
                    CurrentStats.Commands.Checksum++;
                    break;
                case "compare":
                    AllStats.Commands.Compare++;
                    CurrentStats.Commands.Compare++;
                    break;
                case "create-sidecar":
                    AllStats.Commands.CreateSidecar++;
                    CurrentStats.Commands.CreateSidecar++;
                    break;
                case "decode":
                    AllStats.Commands.Decode++;
                    CurrentStats.Commands.Decode++;
                    break;
                case "device-info":
                    AllStats.Commands.DeviceInfo++;
                    CurrentStats.Commands.DeviceInfo++;
                    break;
                case "device-report":
                    AllStats.Commands.DeviceReport++;
                    CurrentStats.Commands.DeviceReport++;
                    break;
                case "dump-media":
                    AllStats.Commands.DumpMedia++;
                    CurrentStats.Commands.DumpMedia++;
                    break;
                case "entropy":
                    AllStats.Commands.Entropy++;
                    CurrentStats.Commands.Entropy++;
                    break;
                case "extract-files":
                    AllStats.Commands.ExtractFiles++;
                    CurrentStats.Commands.ExtractFiles++;
                    break;
                case "formats":
                    AllStats.Commands.Formats++;
                    CurrentStats.Commands.Formats++;
                    break;
                case "ls":
                    AllStats.Commands.Ls++;
                    CurrentStats.Commands.Ls++;
                    break;
                case "media-info":
                    AllStats.Commands.MediaInfo++;
                    CurrentStats.Commands.MediaInfo++;
                    break;
                case "media-scan":
                    AllStats.Commands.MediaScan++;
                    CurrentStats.Commands.MediaScan++;
                    break;
                case "print-hex":
                    AllStats.Commands.PrintHex++;
                    CurrentStats.Commands.PrintHex++;
                    break;
                case "verify":
                    AllStats.Commands.Verify++;
                    CurrentStats.Commands.Verify++;
                    break;
                case "list-devices":
                    AllStats.Commands.ListDevices++;
                    CurrentStats.Commands.ListDevices++;
                    break;
                case "list-encodings":
                    AllStats.Commands.ListEncodings++;
                    CurrentStats.Commands.ListEncodings++;
                    break;
            }
        }

        public static void AddFilesystem(string filesystem)
        {
            if(Settings.Settings.Current.Stats == null || !Settings.Settings.Current.Stats.FilesystemStats) return;

            if(AllStats.Filesystems == null) AllStats.Filesystems = new List<NameValueStats>();
            if(CurrentStats.Filesystems == null) CurrentStats.Filesystems = new List<NameValueStats>();

            NameValueStats old = AllStats.Filesystems.FirstOrDefault(nvs => nvs.name == filesystem);

            NameValueStats nw = new NameValueStats();
            if(old != null)
            {
                nw.name = old.name;
                nw.Value = old.Value + 1;
                AllStats.Filesystems.Remove(old);
            }
            else
            {
                nw.name = filesystem;
                nw.Value = 1;
            }
            AllStats.Filesystems.Add(nw);

            old = CurrentStats.Filesystems.FirstOrDefault(nvs => nvs.name == filesystem);

            nw = new NameValueStats();
            if(old != null)
            {
                nw.name = old.name;
                nw.Value = old.Value + 1;
                CurrentStats.Filesystems.Remove(old);
            }
            else
            {
                nw.name = filesystem;
                nw.Value = 1;
            }
            CurrentStats.Filesystems.Add(nw);
        }

        public static void AddPartition(string partition)
        {
            if(Settings.Settings.Current.Stats == null || !Settings.Settings.Current.Stats.PartitionStats) return;

            if(AllStats.Partitions == null) AllStats.Partitions = new List<NameValueStats>();
            if(CurrentStats.Partitions == null) CurrentStats.Partitions = new List<NameValueStats>();

            NameValueStats old = AllStats.Partitions.FirstOrDefault(nvs => nvs.name == partition);

            NameValueStats nw = new NameValueStats();
            if(old != null)
            {
                nw.name = old.name;
                nw.Value = old.Value + 1;
                AllStats.Partitions.Remove(old);
            }
            else
            {
                nw.name = partition;
                nw.Value = 1;
            }
            AllStats.Partitions.Add(nw);

            old = CurrentStats.Partitions.FirstOrDefault(nvs => nvs.name == partition);

            nw = new NameValueStats();
            if(old != null)
            {
                nw.name = old.name;
                nw.Value = old.Value + 1;
                CurrentStats.Partitions.Remove(old);
            }
            else
            {
                nw.name = partition;
                nw.Value = 1;
            }
            CurrentStats.Partitions.Add(nw);
        }

        public static void AddFilter(string format)
        {
            if(Settings.Settings.Current.Stats == null || !Settings.Settings.Current.Stats.FilterStats) return;

            if(AllStats.Filters == null) AllStats.Filters = new List<NameValueStats>();
            if(CurrentStats.Filters == null) CurrentStats.Filters = new List<NameValueStats>();

            NameValueStats old = AllStats.Filters.FirstOrDefault(nvs => nvs.name == format);

            NameValueStats nw = new NameValueStats();
            if(old != null)
            {
                nw.name = old.name;
                nw.Value = old.Value + 1;
                AllStats.Filters.Remove(old);
            }
            else
            {
                nw.name = format;
                nw.Value = 1;
            }
            AllStats.Filters.Add(nw);

            old = CurrentStats.Filters.FirstOrDefault(nvs => nvs.name == format);

            nw = new NameValueStats();
            if(old != null)
            {
                nw.name = old.name;
                nw.Value = old.Value + 1;
                CurrentStats.Filters.Remove(old);
            }
            else
            {
                nw.name = format;
                nw.Value = 1;
            }
            CurrentStats.Filters.Add(nw);
        }

        public static void AddMediaFormat(string format)
        {
            if(Settings.Settings.Current.Stats == null || !Settings.Settings.Current.Stats.MediaImageStats) return;

            if(AllStats.MediaImages == null) AllStats.MediaImages = new List<NameValueStats>();
            if(CurrentStats.MediaImages == null) CurrentStats.MediaImages = new List<NameValueStats>();

            NameValueStats old = AllStats.MediaImages.FirstOrDefault(nvs => nvs.name == format);

            NameValueStats nw = new NameValueStats();
            if(old != null)
            {
                nw.name = old.name;
                nw.Value = old.Value + 1;
                AllStats.MediaImages.Remove(old);
            }
            else
            {
                nw.name = format;
                nw.Value = 1;
            }
            AllStats.MediaImages.Add(nw);

            old = CurrentStats.MediaImages.FirstOrDefault(nvs => nvs.name == format);

            nw = new NameValueStats();
            if(old != null)
            {
                nw.name = old.name;
                nw.Value = old.Value + 1;
                CurrentStats.MediaImages.Remove(old);
            }
            else
            {
                nw.name = format;
                nw.Value = 1;
            }
            CurrentStats.MediaImages.Add(nw);
        }

        public static void AddDevice(DiscImageChef.Devices.Device dev)
        {
            if(Settings.Settings.Current.Stats == null || !Settings.Settings.Current.Stats.DeviceStats) return;

            if(AllStats.Devices == null) AllStats.Devices = new List<DeviceStats>();
            if(CurrentStats.Devices == null) CurrentStats.Devices = new List<DeviceStats>();

            string deviceBus;
            if(dev.IsUsb) deviceBus = "USB";
            else if(dev.IsFireWire) deviceBus = "FireWire";
            else deviceBus = dev.Type.ToString();

            DeviceStats old = AllStats.Devices.FirstOrDefault(ds => ds.Manufacturer == dev.Manufacturer && ds.Model == dev.Model && ds.Revision == dev.Revision && ds.Bus == deviceBus);

            if(old != null) AllStats.Devices.Remove(old);

            DeviceStats nw = new DeviceStats();
            nw.Model = dev.Model;
            nw.Manufacturer = dev.Manufacturer;
            nw.Revision = dev.Revision;
            nw.Bus = deviceBus;
            nw.ManufacturerSpecified = true;
            AllStats.Devices.Add(nw);

            old = CurrentStats.Devices.FirstOrDefault(ds => ds.Manufacturer == dev.Manufacturer && ds.Model == dev.Model && ds.Revision == dev.Revision && ds.Bus == deviceBus);

            if(old != null) CurrentStats.Devices.Remove(old);

            nw = new DeviceStats();
            nw.Model = dev.Model;
            nw.Manufacturer = dev.Manufacturer;
            nw.Revision = dev.Revision;
            nw.Bus = deviceBus;
            nw.ManufacturerSpecified = true;
            CurrentStats.Devices.Add(nw);
        }

        public static void AddMedia(CommonTypes.MediaType type, bool real)
        {
            if(Settings.Settings.Current.Stats == null || !Settings.Settings.Current.Stats.MediaStats) return;

            if(AllStats.Medias == null) AllStats.Medias = new List<MediaStats>();
            if(CurrentStats.Medias == null) CurrentStats.Medias = new List<MediaStats>();

            MediaStats old = AllStats.Medias.FirstOrDefault(ms => ms.real == real && ms.type == type.ToString());

            MediaStats nw = new MediaStats();
            if(old != null)
            {
                nw.type = old.type;
                nw.real = old.real;
                nw.Value = old.Value + 1;
                AllStats.Medias.Remove(old);
            }
            else
            {
                nw.type = type.ToString();
                nw.real = real;
                nw.Value = 1;
            }
            AllStats.Medias.Add(nw);

            old = CurrentStats.Medias.FirstOrDefault(ms => ms.real == real && ms.type == type.ToString());

            nw = new MediaStats();
            if(old != null)
            {
                nw.type = old.type;
                nw.real = old.real;
                nw.Value = old.Value + 1;
                CurrentStats.Medias.Remove(old);
            }
            else
            {
                nw.type = type.ToString();
                nw.real = real;
                nw.Value = 1;
            }
            CurrentStats.Medias.Add(nw);
        }

        public static void AddBenchmark(Dictionary<string, double> checksums, double entropy, double all,
                                        double sequential, long maxMemory, long minMemory)
        {
            if(Settings.Settings.Current.Stats == null || !Settings.Settings.Current.Stats.BenchmarkStats) return;

            CurrentStats.Benchmark = new BenchmarkStats();
            CurrentStats.Benchmark.Checksum = new List<ChecksumStats>();
            AllStats.Benchmark = new BenchmarkStats();
            AllStats.Benchmark.Checksum = new List<ChecksumStats>();

            foreach(KeyValuePair<string, double> kvp in checksums)
            {
                ChecksumStats st = new ChecksumStats();
                st.algorithm = kvp.Key;
                st.Value = kvp.Value;
                CurrentStats.Benchmark.Checksum.Add(st);
                AllStats.Benchmark.Checksum.Add(st);
            }

            CurrentStats.Benchmark.All = all;
            CurrentStats.Benchmark.Entropy = entropy;
            CurrentStats.Benchmark.MaxMemory = maxMemory;
            CurrentStats.Benchmark.MinMemory = minMemory;
            CurrentStats.Benchmark.Sequential = sequential;

            AllStats.Benchmark.All = all;
            AllStats.Benchmark.Entropy = entropy;
            AllStats.Benchmark.MaxMemory = maxMemory;
            AllStats.Benchmark.MinMemory = minMemory;
            AllStats.Benchmark.Sequential = sequential;
        }

        public static void AddVerify(bool? mediaVerified, long correct, long failed, long unknown, long total)
        {
            if(Settings.Settings.Current.Stats == null || !Settings.Settings.Current.Stats.VerifyStats) return;

            if(CurrentStats.Verify == null)
            {
                CurrentStats.Verify = new VerifyStats();
                CurrentStats.Verify.MediaImages = new VerifiedItems();
                CurrentStats.Verify.Sectors = new ScannedSectors();
            }

            if(AllStats.Verify == null)
            {
                AllStats.Verify = new VerifyStats();
                AllStats.Verify.MediaImages = new VerifiedItems();
                AllStats.Verify.Sectors = new ScannedSectors();
            }

            if(mediaVerified.HasValue)
                if(mediaVerified.Value)
                {
                    CurrentStats.Verify.MediaImages.Correct++;
                    AllStats.Verify.MediaImages.Correct++;
                }
                else
                {
                    CurrentStats.Verify.MediaImages.Failed++;
                    AllStats.Verify.MediaImages.Failed++;
                }

            CurrentStats.Verify.Sectors.Correct += correct;
            CurrentStats.Verify.Sectors.Error += failed;
            CurrentStats.Verify.Sectors.Unverifiable += unknown;
            CurrentStats.Verify.Sectors.Total += total;

            AllStats.Verify.Sectors.Correct += correct;
            AllStats.Verify.Sectors.Error += failed;
            AllStats.Verify.Sectors.Unverifiable += unknown;
            AllStats.Verify.Sectors.Total += total;
        }

        public static void AddMediaScan(long lessThan3ms, long lessThan10ms, long lessThan50ms, long lessThan150ms,
                                        long lessThan500ms, long moreThan500ms, long total, long error, long correct)
        {
            if(Settings.Settings.Current.Stats == null || !Settings.Settings.Current.Stats.MediaScanStats) return;

            if(CurrentStats.MediaScan == null)
            {
                CurrentStats.MediaScan = new MediaScanStats();
                CurrentStats.MediaScan.Sectors = new ScannedSectors();
                CurrentStats.MediaScan.Times = new TimeStats();
            }

            if(AllStats.MediaScan == null)
            {
                AllStats.MediaScan = new MediaScanStats();
                AllStats.MediaScan.Sectors = new ScannedSectors();
                AllStats.MediaScan.Times = new TimeStats();
            }

            CurrentStats.MediaScan.Sectors.Correct += correct;
            CurrentStats.MediaScan.Sectors.Error += error;
            CurrentStats.MediaScan.Sectors.Total += total;
            CurrentStats.MediaScan.Times.LessThan3ms += lessThan3ms;
            CurrentStats.MediaScan.Times.LessThan10ms += lessThan10ms;
            CurrentStats.MediaScan.Times.LessThan50ms += lessThan50ms;
            CurrentStats.MediaScan.Times.LessThan150ms += lessThan150ms;
            CurrentStats.MediaScan.Times.LessThan500ms += lessThan500ms;
            CurrentStats.MediaScan.Times.MoreThan500ms += moreThan500ms;

            AllStats.MediaScan.Sectors.Correct += correct;
            AllStats.MediaScan.Sectors.Error += error;
            AllStats.MediaScan.Sectors.Total += total;
            AllStats.MediaScan.Times.LessThan3ms += lessThan3ms;
            AllStats.MediaScan.Times.LessThan10ms += lessThan10ms;
            AllStats.MediaScan.Times.LessThan50ms += lessThan50ms;
            AllStats.MediaScan.Times.LessThan150ms += lessThan150ms;
            AllStats.MediaScan.Times.LessThan500ms += lessThan500ms;
            AllStats.MediaScan.Times.MoreThan500ms += moreThan500ms;
        }
    }
}