mirror of
https://github.com/greenshot/greenshot
synced 2025-07-16 10:03:44 -07:00
Code quality changes
This commit is contained in:
Robin
parent
f07ed83722
commit
610f45d082
189 changed files with 4609 additions and 5203 deletions
|
|
@ -30,27 +30,27 @@ using System.Collections.Generic;
|
|||
|
||||
namespace GreenshotPlugin.Core {
|
||||
public static class FilenameHelper {
|
||||
private static readonly ILog LOG = LogManager.GetLogger(typeof(FilenameHelper));
|
||||
private static readonly ILog Log = LogManager.GetLogger(typeof(FilenameHelper));
|
||||
// Specify the regular expression for the filename formatting:
|
||||
// Starting with ${
|
||||
// than the varname, which ends with a : or }
|
||||
// If a parameters needs to be supplied, than a ":" should follow the name... everything from the : until the } is considered to be part of the parameters.
|
||||
// The parameter format is a single alpha followed by the value belonging to the parameter, e.g. :
|
||||
// ${capturetime:d"yyyy-MM-dd HH_mm_ss"}
|
||||
private static readonly Regex VAR_REGEXP = new Regex(@"\${(?<variable>[^:}]+)[:]?(?<parameters>[^}]*)}", RegexOptions.Compiled);
|
||||
private static readonly Regex CMD_VAR_REGEXP = new Regex(@"%(?<variable>[^%]+)%", RegexOptions.Compiled);
|
||||
private static readonly Regex VarRegexp = new Regex(@"\${(?<variable>[^:}]+)[:]?(?<parameters>[^}]*)}", RegexOptions.Compiled);
|
||||
private static readonly Regex CmdVarRegexp = new Regex(@"%(?<variable>[^%]+)%", RegexOptions.Compiled);
|
||||
|
||||
private static readonly Regex SPLIT_REGEXP = new Regex(";(?=(?:[^\"]*\"[^\"]*\")*[^\"]*$)", RegexOptions.Compiled);
|
||||
private const int MAX_TITLE_LENGTH = 80;
|
||||
private static readonly CoreConfiguration conf = IniConfig.GetIniSection<CoreConfiguration>();
|
||||
private const string UNSAFE_REPLACEMENT = "_";
|
||||
private static readonly Regex SplitRegexp = new Regex(";(?=(?:[^\"]*\"[^\"]*\")*[^\"]*$)", RegexOptions.Compiled);
|
||||
private const int MaxTitleLength = 80;
|
||||
private static readonly CoreConfiguration CoreConfig = IniConfig.GetIniSection<CoreConfiguration>();
|
||||
private const string UnsafeReplacement = "_";
|
||||
|
||||
/// <summary>
|
||||
/// Remove invalid characters from the fully qualified filename
|
||||
/// </summary>
|
||||
/// <param name="fullPath">string with the full path to a file</param>
|
||||
/// <returns>string with the full path to a file, without invalid characters</returns>
|
||||
public static string MakeFQFilenameSafe(string fullPath) {
|
||||
public static string MakeFqFilenameSafe(string fullPath) {
|
||||
string path = MakePathSafe(Path.GetDirectoryName(fullPath));
|
||||
string filename = MakeFilenameSafe(Path.GetFileName(fullPath));
|
||||
// Make the fullpath again and return
|
||||
|
|
@ -66,7 +66,7 @@ namespace GreenshotPlugin.Core {
|
|||
// Make the filename save!
|
||||
if (filename != null) {
|
||||
foreach (char disallowed in Path.GetInvalidFileNameChars()) {
|
||||
filename = filename.Replace(disallowed.ToString(), UNSAFE_REPLACEMENT);
|
||||
filename = filename.Replace(disallowed.ToString(), UnsafeReplacement);
|
||||
}
|
||||
}
|
||||
return filename;
|
||||
|
|
@ -81,7 +81,7 @@ namespace GreenshotPlugin.Core {
|
|||
// Make the path save!
|
||||
if (path != null) {
|
||||
foreach (char disallowed in Path.GetInvalidPathChars()) {
|
||||
path = path.Replace(disallowed.ToString(), UNSAFE_REPLACEMENT);
|
||||
path = path.Replace(disallowed.ToString(), UnsafeReplacement);
|
||||
}
|
||||
}
|
||||
return path;
|
||||
|
|
@ -108,15 +108,16 @@ namespace GreenshotPlugin.Core {
|
|||
/// that is specified in the configuration
|
||||
/// </summary>
|
||||
/// <param name="format">A string with the format</param>
|
||||
/// <param name="captureDetails"></param>
|
||||
/// <returns>The filename which should be used to save the image</returns>
|
||||
public static string GetFilename(OutputFormat format, ICaptureDetails captureDetails) {
|
||||
string pattern = conf.OutputFileFilenamePattern;
|
||||
if (pattern == null || string.IsNullOrEmpty(pattern.Trim())) {
|
||||
string pattern = CoreConfig.OutputFileFilenamePattern;
|
||||
if (string.IsNullOrEmpty(pattern?.Trim())) {
|
||||
pattern = "greenshot ${capturetime}";
|
||||
}
|
||||
return GetFilenameFromPattern(pattern, format, captureDetails);
|
||||
}
|
||||
|
||||
|
||||
|
||||
/// <summary>
|
||||
/// This method will be called by the regexp.replace as a MatchEvaluator delegate!
|
||||
|
|
@ -127,14 +128,15 @@ namespace GreenshotPlugin.Core {
|
|||
/// <param name="processVars">Variables from the process</param>
|
||||
/// <param name="userVars">Variables from the user</param>
|
||||
/// <param name="machineVars">Variables from the machine</param>
|
||||
/// <param name="filenameSafeMode"></param>
|
||||
/// <returns>string with the match replacement</returns>
|
||||
private static string MatchVarEvaluator(Match match, ICaptureDetails captureDetails, IDictionary processVars, IDictionary userVars, IDictionary machineVars, bool filenameSafeMode) {
|
||||
try {
|
||||
return MatchVarEvaluatorInternal(match, captureDetails, processVars, userVars, machineVars, filenameSafeMode);
|
||||
} catch (Exception e) {
|
||||
LOG.Error("Error in MatchVarEvaluatorInternal", e);
|
||||
Log.Error("Error in MatchVarEvaluatorInternal", e);
|
||||
}
|
||||
return "";
|
||||
return string.Empty;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
|
|
@ -159,17 +161,20 @@ namespace GreenshotPlugin.Core {
|
|||
string variable = match.Groups["variable"].Value;
|
||||
string parameters = match.Groups["parameters"].Value;
|
||||
|
||||
if (parameters != null && parameters.Length > 0) {
|
||||
string[] parms = SPLIT_REGEXP.Split(parameters);
|
||||
if (parameters.Length > 0) {
|
||||
string[] parms = SplitRegexp.Split(parameters);
|
||||
foreach (string parameter in parms) {
|
||||
switch (parameter.Substring(0, 1)) {
|
||||
// Padding p<width>[,pad-character]
|
||||
case "p":
|
||||
string[] padParams = parameter.Substring(1).Split(new[] { ',' });
|
||||
string[] padParams = parameter.Substring(1).Split(',');
|
||||
try {
|
||||
padWidth = int.Parse(padParams[0]);
|
||||
} catch {
|
||||
};
|
||||
}
|
||||
catch
|
||||
{
|
||||
// ignored
|
||||
}
|
||||
if (padParams.Length > 1) {
|
||||
padChar = padParams[1][0];
|
||||
}
|
||||
|
|
@ -177,7 +182,7 @@ namespace GreenshotPlugin.Core {
|
|||
// replace
|
||||
// r<old string>,<new string>
|
||||
case "r":
|
||||
string[] replaceParameters = parameter.Substring(1).Split(new[] { ',' });
|
||||
string[] replaceParameters = parameter.Substring(1).Split(',');
|
||||
if (replaceParameters != null && replaceParameters.Length == 2) {
|
||||
replacements.Add(replaceParameters[0], replaceParameters[1]);
|
||||
}
|
||||
|
|
@ -197,7 +202,7 @@ namespace GreenshotPlugin.Core {
|
|||
// s<start>[,length]
|
||||
case "s":
|
||||
string range = parameter.Substring(1);
|
||||
string[] rangelist = range.Split(new[] { ',' });
|
||||
string[] rangelist = range.Split(',');
|
||||
if (rangelist.Length > 0) {
|
||||
try {
|
||||
startIndex = int.Parse(rangelist[0]);
|
||||
|
|
@ -231,7 +236,7 @@ namespace GreenshotPlugin.Core {
|
|||
if (filenameSafeMode) {
|
||||
replaceValue = MakePathSafe(replaceValue);
|
||||
}
|
||||
} else if (captureDetails != null && captureDetails.MetaData != null && captureDetails.MetaData.ContainsKey(variable)) {
|
||||
} else if (captureDetails?.MetaData != null && captureDetails.MetaData.ContainsKey(variable)) {
|
||||
replaceValue = captureDetails.MetaData[variable];
|
||||
if (filenameSafeMode) {
|
||||
replaceValue = MakePathSafe(replaceValue);
|
||||
|
|
@ -248,8 +253,8 @@ namespace GreenshotPlugin.Core {
|
|||
capturetime = captureDetails.DateTime;
|
||||
if (captureDetails.Title != null) {
|
||||
title = captureDetails.Title;
|
||||
if (title.Length > MAX_TITLE_LENGTH) {
|
||||
title = title.Substring(0, MAX_TITLE_LENGTH);
|
||||
if (title.Length > MaxTitleLength) {
|
||||
title = title.Substring(0, MaxTitleLength);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -318,9 +323,9 @@ namespace GreenshotPlugin.Core {
|
|||
}
|
||||
break;
|
||||
case "NUM":
|
||||
conf.OutputFileIncrementingNumber++;
|
||||
CoreConfig.OutputFileIncrementingNumber++;
|
||||
IniConfig.Save();
|
||||
replaceValue = conf.OutputFileIncrementingNumber.ToString();
|
||||
replaceValue = CoreConfig.OutputFileIncrementingNumber.ToString();
|
||||
if (padWidth == 0) {
|
||||
padWidth = -6;
|
||||
padChar = '0';
|
||||
|
|
@ -412,7 +417,7 @@ namespace GreenshotPlugin.Core {
|
|||
}
|
||||
catch (Exception e)
|
||||
{
|
||||
LOG.Error("Error retrieving EnvironmentVariableTarget.Process", e);
|
||||
Log.Error("Error retrieving EnvironmentVariableTarget.Process", e);
|
||||
}
|
||||
|
||||
try
|
||||
|
|
@ -421,7 +426,7 @@ namespace GreenshotPlugin.Core {
|
|||
}
|
||||
catch (Exception e)
|
||||
{
|
||||
LOG.Error("Error retrieving EnvironmentVariableTarget.User", e);
|
||||
Log.Error("Error retrieving EnvironmentVariableTarget.User", e);
|
||||
}
|
||||
|
||||
try
|
||||
|
|
@ -430,13 +435,11 @@ namespace GreenshotPlugin.Core {
|
|||
}
|
||||
catch (Exception e)
|
||||
{
|
||||
LOG.Error("Error retrieving EnvironmentVariableTarget.Machine", e);
|
||||
Log.Error("Error retrieving EnvironmentVariableTarget.Machine", e);
|
||||
}
|
||||
|
||||
return CMD_VAR_REGEXP.Replace(pattern,
|
||||
delegate (Match m) {
|
||||
return MatchVarEvaluator(m, null, processVars, userVars, machineVars, filenameSafeMode);
|
||||
}
|
||||
return CmdVarRegexp.Replace(pattern,
|
||||
m => MatchVarEvaluator(m, null, processVars, userVars, machineVars, filenameSafeMode)
|
||||
);
|
||||
}
|
||||
|
||||
|
|
@ -453,25 +456,23 @@ namespace GreenshotPlugin.Core {
|
|||
try {
|
||||
processVars = Environment.GetEnvironmentVariables(EnvironmentVariableTarget.Process);
|
||||
} catch (Exception e) {
|
||||
LOG.Error("Error retrieving EnvironmentVariableTarget.Process", e);
|
||||
Log.Error("Error retrieving EnvironmentVariableTarget.Process", e);
|
||||
}
|
||||
|
||||
try {
|
||||
userVars = Environment.GetEnvironmentVariables(EnvironmentVariableTarget.User);
|
||||
} catch (Exception e) {
|
||||
LOG.Error("Error retrieving EnvironmentVariableTarget.User", e);
|
||||
Log.Error("Error retrieving EnvironmentVariableTarget.User", e);
|
||||
}
|
||||
|
||||
try {
|
||||
machineVars = Environment.GetEnvironmentVariables(EnvironmentVariableTarget.Machine);
|
||||
} catch (Exception e) {
|
||||
LOG.Error("Error retrieving EnvironmentVariableTarget.Machine", e);
|
||||
Log.Error("Error retrieving EnvironmentVariableTarget.Machine", e);
|
||||
}
|
||||
|
||||
return VAR_REGEXP.Replace(pattern,
|
||||
delegate(Match m) {
|
||||
return MatchVarEvaluator(m, null, processVars, userVars, machineVars, filenameSafeMode);
|
||||
}
|
||||
return VarRegexp.Replace(pattern,
|
||||
m => MatchVarEvaluator(m, null, processVars, userVars, machineVars, filenameSafeMode)
|
||||
);
|
||||
}
|
||||
|
||||
|
|
@ -489,26 +490,24 @@ namespace GreenshotPlugin.Core {
|
|||
try {
|
||||
processVars = Environment.GetEnvironmentVariables(EnvironmentVariableTarget.Process);
|
||||
} catch (Exception e) {
|
||||
LOG.Error("Error retrieving EnvironmentVariableTarget.Process", e);
|
||||
Log.Error("Error retrieving EnvironmentVariableTarget.Process", e);
|
||||
}
|
||||
|
||||
try {
|
||||
userVars = Environment.GetEnvironmentVariables(EnvironmentVariableTarget.User);
|
||||
} catch (Exception e) {
|
||||
LOG.Error("Error retrieving EnvironmentVariableTarget.User", e);
|
||||
Log.Error("Error retrieving EnvironmentVariableTarget.User", e);
|
||||
}
|
||||
|
||||
try {
|
||||
machineVars = Environment.GetEnvironmentVariables(EnvironmentVariableTarget.Machine);
|
||||
} catch (Exception e) {
|
||||
LOG.Error("Error retrieving EnvironmentVariableTarget.Machine", e);
|
||||
Log.Error("Error retrieving EnvironmentVariableTarget.Machine", e);
|
||||
}
|
||||
|
||||
try {
|
||||
return VAR_REGEXP.Replace(pattern,
|
||||
delegate(Match m) {
|
||||
return MatchVarEvaluator(m, captureDetails, processVars, userVars, machineVars, filenameSafeMode);
|
||||
}
|
||||
return VarRegexp.Replace(pattern,
|
||||
m => MatchVarEvaluator(m, captureDetails, processVars, userVars, machineVars, filenameSafeMode)
|
||||
);
|
||||
} catch (Exception e) {
|
||||
// adding additional data for bug tracking
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue