DarthAffe/Artemis
1
0
Fork 0
mirror of https://github.com/Artemis-RGB/Artemis synced 2025-12-13 05:48:35 +00:00
Code Issues Releases Wiki Activity

Move data directory to ApplicationData instead of Documents

Browse Source
This commit is contained in:
Robert Beekman 2017-11-30 12:06:47 +01:00
parent bc64ac33f8
commit ea2b7f6622
10 changed files with 85 additions and 69 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
Artemis/Artemis/ArtemisBootstrapper.cs
View File

@ -1,5 +1,6 @@
using System;
using System.Collections.Generic;
using System.IO;
using System.Windows;
using System.Windows.Controls;
using System.Windows.Input;
@ -24,6 +25,9 @@ namespace Artemis
public ArtemisBootstrapper()
{
// Make sure the data folder exists
GeneralHelpers.SetupDataFolder();
// Start logging before anything else
Logging.SetupLogging(SettingsProvider.Load<GeneralSettings>().LogLevel);
// Restore DDLs before interacting with any SDKs

38
Artemis/Artemis/DAL/ProfileProvider.cs
View File

@ -19,10 +19,8 @@ namespace Artemis.DAL
{
public static class ProfileProvider
{
public static readonly string ProfileFolder = GeneralHelpers.DataFolder + "profiles\\";
private static readonly Logger Logger = LogManager.GetCurrentClassLogger();
public static readonly string ProfileFolder = Environment.GetFolderPath(Environment.SpecialFolder.MyDocuments) + @"\Artemis\profiles";
private static bool _installedDefaults;
static ProfileProvider()
@ -32,7 +30,7 @@ namespace Artemis.DAL
CheckProfiles();
InstallDefaults();
}
public static List<string> GetProfileNames(KeyboardProvider keyboard, ModuleModel module)
{
if (keyboard == null || module == null)
@ -69,7 +67,7 @@ namespace Artemis.DAL
if (!(prof.GameName?.Length > 1) || !(prof.KeyboardSlug?.Length > 1) || !(prof.Slug?.Length > 1))
throw new ArgumentException("Profile is invalid. Name, GameName and KeyboardSlug are required");
var path = ProfileFolder + $@"\{prof.KeyboardSlug}\{prof.GameName}";
var path = ProfileFolder + $"{prof.KeyboardSlug}\\{prof.GameName}";
if (!Directory.Exists(path))
Directory.CreateDirectory(path);
@ -87,7 +85,7 @@ namespace Artemis.DAL
return;
}
File.WriteAllText(path + $@"\{prof.Slug}.json", json);
File.WriteAllText(path + $"\\{prof.Slug}.json", json);
Logger.Debug("Saved profile {0}/{1}/{2}", prof.KeyboardSlug, prof.GameName, prof.Name);
}
}
@ -103,7 +101,7 @@ namespace Artemis.DAL
return;
// Store the profile path before it is renamed
var oldPath = ProfileFolder + $@"\{profile.KeyboardSlug}\{profile.GameName}\{profile.Slug}.json";
var oldPath = ProfileFolder + $"{profile.KeyboardSlug}\\{profile.GameName}\\{profile.Slug}.json";
// Update the profile, creating a new file
profile.Name = name;
@ -117,7 +115,7 @@ namespace Artemis.DAL
public static void DeleteProfile(ProfileModel prof)
{
// Remove the file
var path = ProfileFolder + $@"\{prof.KeyboardSlug}\{prof.GameName}\{prof.Slug}.json";
var path = ProfileFolder + $"{prof.KeyboardSlug}\\{prof.GameName}\\{prof.Slug}.json";
if (File.Exists(path))
File.Delete(path);
}
@ -145,7 +143,7 @@ namespace Artemis.DAL
}
/// <summary>
/// Exports the given profile to the provided path in JSON
/// Exports the given profile to the provided path in JSON
/// </summary>
/// <param name="prof">The profile to export</param>
/// <param name="path">The path to save the profile to</param>
@ -155,16 +153,15 @@ namespace Artemis.DAL
File.WriteAllText(path, json);
}
public static void InsertGif(string effectName, string profileName, string layerName, Bitmap gifFile,
string fileName)
public static void InsertGif(string moduleName, string profileName, string layerName, Bitmap gifFile, string fileName)
{
var directories = new DirectoryInfo(ProfileFolder).GetDirectories();
var profiles = new List<ProfileModel>();
foreach (var directoryInfo in directories)
profiles.AddRange(ReadProfiles(directoryInfo.Name + "/effectName").Where(d => d.Name == profileName));
profiles.AddRange(ReadProfiles(directoryInfo.Name + "\\" + moduleName).Where(d => d.Name == profileName));
// Extract the GIF file
var gifDir = Environment.GetFolderPath(Environment.SpecialFolder.MyDocuments) + @"\Artemis\gifs";
var gifDir = GeneralHelpers.DataFolder + "gifs";
Directory.CreateDirectory(gifDir);
var gifPath = gifDir + $"\\{fileName}.gif";
if (!File.Exists(gifPath))
@ -184,7 +181,7 @@ namespace Artemis.DAL
public static List<ProfileModel> ReadProfiles(string subDirectory)
{
var profiles = new List<ProfileModel>();
var directory = ProfileFolder + "/" + subDirectory;
var directory = ProfileFolder + subDirectory;
if (!Directory.Exists(directory))
return profiles;
@ -193,7 +190,6 @@ namespace Artemis.DAL
// Parse the JSON files into objects and add them if they are valid
foreach (var path in profilePaths)
{
try
{
var prof = LoadProfileIfValid(path);
@ -201,21 +197,15 @@ namespace Artemis.DAL
continue;
// Only add unique profiles
if (profiles.Any(p => p.GameName == prof.GameName && p.Name == prof.Name &&
p.KeyboardSlug == prof.KeyboardSlug))
{
if (profiles.Any(p => p.GameName == prof.GameName && p.Name == prof.Name && p.KeyboardSlug == prof.KeyboardSlug))
Logger.Info("Didn't load duplicate profile: {0}", path);
}
else
{
profiles.Add(prof);
}
}
catch (Exception e)
{
Logger.Error("Failed to load profile: {0} - {1}", path, e);
}
}
return profiles;
}
@ -232,8 +222,7 @@ namespace Artemis.DAL
_installedDefaults = true;
// Load the ZIP from resources
var stream = Assembly.GetExecutingAssembly()
.GetManifestResourceStream("Artemis.Resources.Keyboards.default-profiles.zip");
var stream = Assembly.GetExecutingAssembly().GetManifestResourceStream("Artemis.Resources.Keyboards.default-profiles.zip");
// Extract it over the old defaults in case one was updated
if (stream == null)
@ -241,7 +230,6 @@ namespace Artemis.DAL
var archive = new ZipArchive(stream);
archive.ExtractToDirectory(ProfileFolder, true);
InsertGif("GeneralProfile", "Demo (duplicate to keep changes)", "GIF", Resources.demo_gif, "demo-gif");
}
catch (IOException e)

12
Artemis/Artemis/DAL/SettingsProvider.cs
View File

@ -3,6 +3,7 @@ using System.Collections.Generic;
using System.IO;
using System.Linq;
using Artemis.Settings;
using Artemis.Utilities;
using Newtonsoft.Json;
using NLog;
@ -11,10 +12,7 @@ namespace Artemis.DAL
public static class SettingsProvider
{
private static readonly Logger Logger = LogManager.GetCurrentClassLogger();
private static readonly string SettingsFolder =
Environment.GetFolderPath(Environment.SpecialFolder.MyDocuments) + @"\Artemis\settings";
private static readonly string SettingsFolder = GeneralHelpers.DataFolder + "settings";
private static readonly List<IArtemisSettings> Settings = new List<IArtemisSettings>();
/// <summary>
@ -35,9 +33,7 @@ namespace Artemis.DAL
try
{
var loadSettings = (IArtemisSettings) JsonConvert
.DeserializeObject<T>(File.ReadAllText(SettingsFolder + $@"\{typeof(T)}.json"));
var loadSettings = (IArtemisSettings) JsonConvert.DeserializeObject<T>(File.ReadAllText(SettingsFolder + $"{typeof(T)}.json"));
if (loadSettings == null)
{
loadSettings = (IArtemisSettings) new T();
@ -80,7 +76,7 @@ namespace Artemis.DAL
return;
}
File.WriteAllText(SettingsFolder + $@"\{artemisSettings.GetType()}.json", json);
File.WriteAllText(SettingsFolder + $"{artemisSettings.GetType()}.json", json);
}
/// <summary>

3
Artemis/Artemis/Modules/Games/Witcher3/Witcher3Model.cs
View File

@ -40,8 +40,7 @@ namespace Artemis.Modules.Games.Witcher3
public override void Enable()
{
// Ensure the config file is found
var witcherSettings = Environment.GetFolderPath(Environment.SpecialFolder.Personal) +
@"\The Witcher 3\user.settings";
var witcherSettings = Environment.GetFolderPath(Environment.SpecialFolder.Personal) + "\\The Witcher 3\\user.settings";
if (File.Exists(witcherSettings))
_witcherSettings = witcherSettings;

24
Artemis/Artemis/Modules/Games/Witcher3/Witcher3ViewModel.cs
View File

@ -1,5 +1,4 @@
using System;
using System.Diagnostics;
using System.Diagnostics;
using System.IO;
using System.IO.Compression;
using System.Linq;
@ -14,8 +13,7 @@ namespace Artemis.Modules.Games.Witcher3
{
public sealed class Witcher3ViewModel : ModuleViewModel
{
public Witcher3ViewModel(MainManager mainManager, [Named(nameof(Witcher3Model))] ModuleModel moduleModel,
IKernel kernel) : base(mainManager, moduleModel, kernel)
public Witcher3ViewModel(MainManager mainManager, [Named(nameof(Witcher3Model))] ModuleModel moduleModel, IKernel kernel) : base(mainManager, moduleModel, kernel)
{
DisplayName = "The Witcher 3";
}
@ -54,11 +52,9 @@ namespace Artemis.Modules.Games.Witcher3
using (var archive = new ZipArchive(stream))
{
// Look for any conflicting mods
if (Directory.Exists(dialog.SelectedPath + @"\mods"))
if (Directory.Exists(dialog.SelectedPath + "\\mods"))
{
var file = Directory.GetFiles(dialog.SelectedPath + @"\mods", "playerWitcher.ws",
SearchOption.AllDirectories)
.FirstOrDefault();
var file = Directory.GetFiles(dialog.SelectedPath + "\\mods", "playerWitcher.ws", SearchOption.AllDirectories).FirstOrDefault();
if (file != null)
if (!file.Contains("modArtemis"))
{
@ -70,15 +66,9 @@ namespace Artemis.Modules.Games.Witcher3
if (!viewHelp.Value)
return;
// Put the mod in the documents folder instead
// Create the directory structure
var folder = Environment.GetFolderPath(Environment.SpecialFolder.MyDocuments) +
@"\Artemis";
archive.ExtractToDirectory(folder + @"witcher3-mod", true);
System.Diagnostics.Process.Start(
new ProcessStartInfo("https://github.com/SpoinkyNL/Artemis/wiki/The-Witcher-3"));
// Put the mod in the data folder instead, not user friendly but access to documents is unsure
archive.ExtractToDirectory(GeneralHelpers.DataFolder + "witcher3-mod", true);
System.Diagnostics.Process.Start(new ProcessStartInfo("https://github.com/SpoinkyNL/Artemis/wiki/The-Witcher-3"));
return;
}
}

16
Artemis/Artemis/Utilities/DataReaders/DllManager.cs
View File

@ -29,8 +29,8 @@ namespace Artemis.Utilities.DataReaders
#region Logitech
private static readonly string LogitechPath = @"C:\Program Files\Logitech Gaming Software\SDK\LED\x64\";
private static readonly string DllPath = Environment.GetFolderPath(Environment.SpecialFolder.MyDocuments) + @"\Artemis\dll";
private static readonly string LogitechPath = "C:\\Program Files\\Logitech Gaming Software\\SDK\\LED\\x64\\";
private static readonly string DllPath = GeneralHelpers.DataFolder + "dll\\";
public static void PlaceLogitechDll()
{
@ -40,14 +40,14 @@ namespace Artemis.Utilities.DataReaders
// Key doesn't exist yet on systems without LGS installed
var key = Registry.LocalMachine.OpenSubKey(@"SOFTWARE\Classes\CLSID\{a6519e67-7632-4375-afdf-caa889744403}\ServerBinary", true) ??
Registry.LocalMachine.CreateSubKey(@"SOFTWARE\Classes\CLSID\{a6519e67-7632-4375-afdf-caa889744403}\ServerBinary", true);
key.SetValue(null, DllPath + @"\LogitechLed.dll");
key.SetValue(null, DllPath + "LogitechLed.dll");
// Make sure the fake DLL is in place
if (!Directory.Exists(DllPath))
Directory.CreateDirectory(DllPath);
if (!File.Exists(DllPath + @"\LogitechLed.dll"))
File.WriteAllBytes(DllPath + @"\LogitechLED.dll", Resources.LogitechLED);
if (!File.Exists(DllPath + "LogitechLed.dll"))
File.WriteAllBytes(DllPath + "LogitechLED.dll", Resources.LogitechLED);
}
catch (Exception e)
{
@ -59,9 +59,9 @@ namespace Artemis.Utilities.DataReaders
{
// Change the registry key to point to the real DLL
var key = Registry.LocalMachine.OpenSubKey(@"SOFTWARE\Classes\CLSID\{a6519e67-7632-4375-afdf-caa889744403}\ServerBinary", true);
key?.SetValue(null, LogitechPath + @"\LogitechLed.dll");
key?.SetValue(null, LogitechPath + "LogitechLed.dll");
}
#endregion
}
}
}

50
Artemis/Artemis/Utilities/GeneralHelpers.cs
View File

@ -13,6 +13,29 @@ namespace Artemis.Utilities
{
public static class GeneralHelpers
{
public static string DataFolder = Environment.GetFolderPath(Environment.SpecialFolder.CommonApplicationData) + "\\Artemis\\";
public static void SetupDataFolder()
{
if (!Directory.Exists(DataFolder))
Directory.CreateDirectory(DataFolder);
var oldDataFolder = Environment.GetFolderPath(Environment.SpecialFolder.MyDocuments) + "\\Artemis\\";
try
{
if (!Directory.Exists(oldDataFolder))
return;
// Migrate the old Artemis folder if it's present and access to it can be gained
MoveDirectory(oldDataFolder, DataFolder);
}
catch (Exception)
{
// ignored, could be blocked, in that case tough luck!
}
}
/// <summary>
/// Perform a deep Copy of the object, using Json as a serialisation method.
/// </summary>
@ -66,7 +89,6 @@ namespace Artemis.Utilities
// At this point the loop is in the item type contained in the list
PropertyCollection parent;
if (path.Contains("Item") && inList)
{
parent = new PropertyCollection
{
Type = propInfo.PropertyType.Name,
@ -74,9 +96,7 @@ namespace Artemis.Utilities
Display = $"{path.Replace("Item.", "").Replace(".", " → ")}{propInfo.Name}",
Path = $"{path.Replace("Item.", "")}{propInfo.Name}"
};
}
else
{
parent = new PropertyCollection
{
Type = propInfo.PropertyType.Name,
@ -84,7 +104,6 @@ namespace Artemis.Utilities
Display = $"{path.Replace(".", " → ")}{propInfo.Name}",
Path = $"{path}{propInfo.Name}"
};
}
if (propInfo.PropertyType.BaseType?.Name == "Enum")
{
@ -154,6 +173,27 @@ namespace Artemis.Utilities
return (T) Enum.Parse(typeof(T), value, true);
}
public static void MoveDirectory(string source, string target)
{
var sourcePath = source.TrimEnd('\\', ' ');
var targetPath = target.TrimEnd('\\', ' ');
var files = Directory.EnumerateFiles(sourcePath, "*", SearchOption.AllDirectories).GroupBy(Path.GetDirectoryName);
foreach (var folder in files)
{
var targetFolder = folder.Key.Replace(sourcePath, targetPath);
Directory.CreateDirectory(targetFolder);
foreach (var file in folder)
{
var fileName = Path.GetFileName(file);
if (fileName == null) continue;
var targetFile = Path.Combine(targetFolder, fileName);
if (File.Exists(targetFile)) File.Delete(targetFile);
File.Move(file, targetFile);
}
}
Directory.Delete(source, true);
}
public struct PropertyCollection
{
public string Display { get; set; }
@ -169,4 +209,4 @@ namespace Artemis.Utilities
public string DisplayType { get; set; }
}
}
}
}

2
Artemis/Artemis/Utilities/Updater.cs
View File

@ -119,7 +119,7 @@ namespace Artemis.Utilities
// Ensure the update folder exists
var artemisFolder = AppDomain.CurrentDomain.BaseDirectory.Substring(0, AppDomain.CurrentDomain.BaseDirectory.Length - 1);
var updateFolder = Environment.GetFolderPath(Environment.SpecialFolder.MyDocuments) + "\\Artemis\\updates";
var updateFolder = GeneralHelpers.DataFolder + "updates";
var updatePath = updateFolder + "\\" + releaseFile["name"].Value<string>();
if (!Directory.Exists(updateFolder))
Directory.CreateDirectory(updateFolder);

3
Artemis/Artemis/ViewModels/DebugViewModel.cs
View File

@ -96,8 +96,7 @@ namespace Artemis.ViewModels
public void OpenLog()
{
// Get the logging directory
var logDir = new DirectoryInfo(Environment.GetFolderPath(Environment.SpecialFolder.MyDocuments)
+ @"\Artemis\logs");
var logDir = new DirectoryInfo(GeneralHelpers.DataFolder + "logs");
// Get the newest log file
var currentLog = logDir.GetFiles().OrderByDescending(f => f.LastWriteTime).FirstOrDefault();
// Open the file with the user's default program

2
Artemis/Artemis/ViewModels/Flyouts/FlyoutSettingsViewModel.cs
View File

@ -227,7 +227,7 @@ namespace Artemis.ViewModels.Flyouts
public void ShowLogs()
{
var logPath = Environment.GetFolderPath(Environment.SpecialFolder.MyDocuments) + @"\Artemis\logs";
var logPath = GeneralHelpers.DataFolder + "logs";
System.Diagnostics.Process.Start(logPath);
}