frodovdr
/
kopano-ol-extension
mirror of https://github.com/Kopano-dev/kopano-ol-extension.git
1
0
Fork 0
Code Issues Releases Wiki Activity

Cleaned up debug option handling; now allows settings from HKLM and HKCU to be merged

This commit is contained in:
Patrick Simpson 2018-06-25 12:08:22 +03:00
parent 0bce4d8c22
commit c8fc2fe78d
5 changed files with 166 additions and 55 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

185
src/AcaciaZPushPlugin/AcaciaZPushPlugin/DebugOptions.cs
View File

@ -18,7 +18,9 @@ using Acacia.Utils;
using Microsoft.Win32; using Microsoft.Win32;
using System; using System;
using System.Collections.Generic; using System.Collections.Generic;
using System.Collections.ObjectModel;
using System.Text; using System.Text;
using System.Linq;
namespace Acacia namespace Acacia
{ {
@ -33,7 +35,18 @@ namespace Acacia
this.Token = token; this.Token = token;
} }
abstract public string GetToken(ValueType value); public string Key
{
get
{
string key = Token;
if (key.StartsWith("-") || key.StartsWith("+"))
key = key.Substring(1);
return key.ToLower();
}
}
abstract public string GetToken(ValueType value, bool needExplicit);
abstract public ValueType GetValue(string value); abstract public ValueType GetValue(string value);
} }
@ -43,17 +56,31 @@ namespace Acacia
public BoolOption(string token, bool inverse) public BoolOption(string token, bool inverse)
: :
base(inverse ? "-" + token : (token.Length == 0 ? "+" : token)) base(inverse ? ("-" + token) : (token.Length == 0 ? "+" : token))
{ {
this.Inverse = inverse; this.Inverse = inverse;
} }
public override string GetToken(bool value) public override string GetToken(bool value, bool needExplicit)
{ {
if (Inverse) if (Inverse)
value = !value; value = !value;
if (value) if (value)
return Token; return Token;
else if (needExplicit)
{
string inverse;
if (Token.StartsWith("-"))
{
if (Token.Length == 1)
inverse = "+";
else
inverse = Token.Substring(1);
}
else
inverse = "-" + Token;
return inverse;
}
else else
return null; return null;
} }
@ -89,9 +116,9 @@ namespace Acacia
this._defaultValue = defaultValue; this._defaultValue = defaultValue;
} }
public override string GetToken(EnumType value) public override string GetToken(EnumType value, bool needExplicit)
{ {
if (value.Equals(DefaultValue)) if (!needExplicit && value.Equals(DefaultValue))
return null; return null;
return Token + "=" + value.ToString(); return Token + "=" + value.ToString();
} }
@ -121,9 +148,9 @@ namespace Acacia
this._defaultValue = defaultValue; this._defaultValue = defaultValue;
} }
public override string GetToken(TimeSpan value) public override string GetToken(TimeSpan value, bool needExplicit)
{ {
if (value.Equals(_defaultValue)) if (!needExplicit && value.Equals(_defaultValue))
return null; return null;
return Token + "=" + value.ToString(); return Token + "=" + value.ToString();
} }
@ -153,9 +180,9 @@ namespace Acacia
this._defaultValue = defaultValue; this._defaultValue = defaultValue;
} }
public override string GetToken(string value) public override string GetToken(string value, bool needExplicit)
{ {
if (value.Equals(_defaultValue)) if (!needExplicit && value.Equals(_defaultValue))
return null; return null;
return Token + "=" + value.ToString(); return Token + "=" + value.ToString();
} }
@ -185,9 +212,9 @@ namespace Acacia
this._defaultValue = defaultValue; this._defaultValue = defaultValue;
} }
public override string GetToken(int value) public override string GetToken(int value, bool needExplicit)
{ {
if (value.Equals(_defaultValue)) if (!needExplicit && value.Equals(_defaultValue))
return null; return null;
return Token + "=" + value.ToString(); return Token + "=" + value.ToString();
} }
@ -239,57 +266,127 @@ namespace Acacia
#region Access methods #region Access methods
public static string GetOptions(string prefix) private class Token
{ {
if (ReturnDefaults) public string Key;
return null; public string Value;
public bool HasCurrentUser;
public bool HasLocalMachine;
public string LocalMachineToken;
public int Order;
return RegistryUtil.GetConfigValue<string>(prefix, null, null); public override string ToString()
}
public static ValueType GetOption<ValueType>(string prefix, Option<ValueType> option)
{
// Parse the options
Dictionary<string, string> tokens = ParseTokens(prefix);
string value;
tokens.TryGetValue(option.Token.ToLower(), out value);
return option.GetValue(value);
}
private static Dictionary<string,string> ParseTokens(string prefix)
{
Dictionary<string, string> tokens = new Dictionary<string, string>();
string value = GetOptions(prefix);
if (!string.IsNullOrEmpty(value))
{ {
foreach (string token in value.Split(',')) return string.Format("key={0}, value={1}, HKCU={2}, HLKM={3}, HLKMToken={4}", Key, Value, HasCurrentUser, HasLocalMachine, LocalMachineToken);
}
}
private static Dictionary<string, Token> GetEffectiveTokens(string prefix)
{
Dictionary<string, Token> tokens = new Dictionary<string, Token>();
foreach (bool localMachine in new bool[] {true, false})
{
string value = RegistryUtil.GetConfigValue<string>(localMachine, prefix, null);
if (!string.IsNullOrEmpty(value))
{ {
if (!string.IsNullOrEmpty(token)) foreach (string token in value.Split(','))
{ {
string[] keyVal = token.Split(new[] { '=' }, 2); if (!string.IsNullOrEmpty(token))
if (!string.IsNullOrEmpty(keyVal[0]))
{ {
tokens[keyVal[0].ToLower()] = token; string[] keyVal = token.Split(new[] { '=' }, 2);
if (!string.IsNullOrEmpty(keyVal[0]))
{
string key = keyVal[0].ToLower();
if (key.StartsWith("-") || key.StartsWith("+"))
key = key.Substring(1);
Token existing;
if (tokens.TryGetValue(key, out existing))
{
existing.Value = token;
}
else
{
existing = new Token() { Key = key, Value = token };
existing.Order = tokens.Count;
tokens.Add(key, existing);
}
if (localMachine)
{
existing.HasLocalMachine = true;
existing.LocalMachineToken = token;
}
else
{
existing.HasCurrentUser = true;
}
}
} }
} }
} }
} }
return tokens; return tokens;
} }
public static string GetTokens(string prefix)
{
// Use GetEffectiveTokens to get the effective string in case there are duplicates in local and user
Dictionary<string, Token> tokens = GetEffectiveTokens(prefix);
return String.Join(",", tokens.Values.OrderBy(t => t.Order).Select(t => t.Value));
}
public static ValueType GetOption<ValueType>(string prefix, Option<ValueType> option)
{
// Get all options
Dictionary<string, Token> tokens = GetEffectiveTokens(prefix);
// And get the effective value
Token value;
tokens.TryGetValue(option.Key, out value);
ValueType result = option.GetValue(value?.Value);
return result;
}
public static void SetOption<ValueType>(string prefix, Option<ValueType> option, ValueType value) public static void SetOption<ValueType>(string prefix, Option<ValueType> option, ValueType value)
{ {
Dictionary<string, string> tokens = ParseTokens(prefix); Dictionary<string, Token> tokens = GetEffectiveTokens(prefix);
// If the token is currently defined in HKLM, we need an explicit override. Otherwise, leave it empty for default value
string key = option.Key;
Token existing;
tokens.TryGetValue(key, out existing);
bool needExplicit = existing?.HasLocalMachine == true;
// Update the token // Update the token
string token = option.GetToken(value); string token = option.GetToken(value, needExplicit);
if (token != null)
tokens[option.Token.ToLower()] = token;
else
tokens.Remove(option.Token.ToLower());
// Write to registry // If the new value matches the value set in HKLM, remove it
string newValue = string.Join(",", tokens.Values); if (token != null && existing?.LocalMachineToken?.Equals(token) == true)
{
tokens.Remove(key);
}
else if (token != null)
{
// Set or add the token
if (tokens.ContainsKey(key))
{
tokens[key].Value = token;
tokens[key].HasCurrentUser = true;
}
else
tokens.Add(key, new Token() { Key = key, Value = token, HasCurrentUser = true });
}
else
{
// Remove the token
tokens.Remove(key);
}
// Write to registry, skipping ones only defined in HKLM
string newValue = string.Join(",", tokens.Values.Where(t => t.HasCurrentUser).Select(t => t.Value));
RegistryUtil.SetConfigValue(prefix, null, newValue, RegistryValueKind.String); RegistryUtil.SetConfigValue(prefix, null, newValue, RegistryValueKind.String);
} }

2
src/AcaciaZPushPlugin/AcaciaZPushPlugin/Features/Feature.cs
View File

@ -71,7 +71,7 @@ namespace Acacia.Features
public static string GetDebugTokens(Type featureType) public static string GetDebugTokens(Type featureType)
{ {
return DebugOptions.GetOptions(GetFeatureName(featureType)); return DebugOptions.GetTokens(GetFeatureName(featureType));
} }
public static bool IsEnabled(Type featureType) public static bool IsEnabled(Type featureType)

4
src/AcaciaZPushPlugin/AcaciaZPushPlugin/ThisAddIn.cs
View File

@ -95,7 +95,7 @@ namespace Acacia
Logger.Instance.Info(this, "Starting version {0}: {1} @ {2}. Outlook version: {3}. Options: '{4}'", Logger.Instance.Info(this, "Starting version {0}: {1} @ {2}. Outlook version: {3}. Options: '{4}'",
LibUtils.Version, BuildVersions.REVISION, LibUtils.BuildTime, LibUtils.Version, BuildVersions.REVISION, LibUtils.BuildTime,
Application.Version, Application.Version,
DebugOptions.GetOptions(null)); DebugOptions.GetTokens(null));
Logger.Instance.Initialize(); Logger.Instance.Initialize();
// Check if we're enabled // Check if we're enabled
@ -200,7 +200,7 @@ namespace Acacia
} }
else else
{ {
Logger.Instance.Trace(this, "OutlookUI is disabled: '{0}'", DebugOptions.GetOptions(null)); Logger.Instance.Trace(this, "OutlookUI is disabled: '{0}'", DebugOptions.GetTokens(null));
} }
} }
return _outlookUI; return _outlookUI;

28
src/AcaciaZPushPlugin/AcaciaZPushPlugin/Utils/RegistryUtil.cs
View File

@ -94,19 +94,33 @@ namespace Acacia.Utils
public static ValueType GetConfigValue<ValueType>(string path, string valueName, ValueType defaultValue) public static ValueType GetConfigValue<ValueType>(string path, string valueName, ValueType defaultValue)
{ {
// Try current user first // Try current user first
foreach (bool localMachine in new bool[]{ false, true}) foreach (bool localMachine in new bool[] { false, true })
{ {
using (RegistryKey key = OpenKeyImpl(Constants.PLUGIN_REGISTRY_BASE, path, localMachine, RegistryKeyPermissionCheck.ReadSubTree)) ValueType value = GetConfigValue<ValueType>(localMachine, path, valueName);
if (value != null)
return value;
}
return defaultValue;
}
public static ValueType GetConfigValue<ValueType>(bool localMachine, string path, string valueName)
{
using (RegistryKey key = OpenKeyImpl(Constants.PLUGIN_REGISTRY_BASE, path, localMachine, RegistryKeyPermissionCheck.ReadSubTree))
{
if (key != null)
{ {
if (key != null) object value = key.GetValue(valueName);
if (value != null)
{ {
object value = key.GetValue(valueName); // Treat an empty string like a missing value. Otherwise the default value used for options is always present in HKCU
if (value != null) if (typeof(ValueType) == typeof(string) && string.IsNullOrWhiteSpace((string)value))
return (ValueType)value; return default(ValueType);
return (ValueType)value;
} }
} }
} }
return defaultValue; return default(ValueType);
} }
public static void SetConfigValue(string path, string valueName, object value, RegistryValueKind kind) public static void SetConfigValue(string path, string valueName, object value, RegistryValueKind kind)

2
src/AcaciaZPushPlugin/PluginDebugger/OptionsInfra.cs
View File

@ -300,7 +300,7 @@ namespace PluginDebugger
{ {
// Show full registry string // Show full registry string
Feature feature = value as Feature; Feature feature = value as Feature;
return DebugOptions.GetOptions(feature?.Name); return DebugOptions.GetTokens(feature?.Name);
} }
return base.ConvertTo(context, culture, value, destinationType); return base.ConvertTo(context, culture, value, destinationType);
} }