├── ObsidianTools ├── Properties │ └── launchSettings.json ├── plugins │ ├── PluginPayload.cs │ ├── PluginCount.cs │ ├── Plugin.cs │ ├── PluginListDead.cs │ ├── PluginCreateDead.cs │ ├── PluginCleanupDead.cs │ ├── PluginCleanupAssets.cs │ ├── PluginIdentifyHotspots.cs │ ├── PluginFindReferences.cs │ ├── PluginCreateReferences.cs │ ├── PluginReduceNoise.cs │ └── PluginAnalyze.cs ├── ObsidianTools.csproj ├── CollectionHelper.cs ├── LogHelper.cs ├── MarkdownFile.cs ├── Program.cs ├── MarkdownLink.cs └── FileHelper.cs ├── ObsidianTools.Test ├── ObsidianTools.Test.csproj ├── TestPluginCleanupEmptyFiles.cs ├── TestPluginCount.cs ├── TestPluginListDead.cs ├── TestPluginFindReferences.cs ├── TestPluginAnalyze.cs ├── TestPluginCreateDeadLinks.cs ├── TestPluginReduceNoise.cs ├── TestPluginCleanupAssets.cs ├── TestPluginCleanupDeadLinks.cs ├── TestPluginIdentifyHotspots.cs ├── TestPluginCreateReferences.cs └── BaseTest.cs ├── ObsidianTools.sln ├── .gitignore ├── README.md └── LICENSE /ObsidianTools/Properties/launchSettings.json: -------------------------------------------------------------------------------- 1 | { 2 | "profiles": { 3 | "ObsidianTools": { 4 | "commandName": "Project", 5 | "commandLineArgs": "C:\\Users\\Tobias\\Desktop\\tmp --list-dead" 6 | } 7 | } 8 | } -------------------------------------------------------------------------------- /ObsidianTools/plugins/PluginPayload.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | 3 | namespace ObsidianTools.plugins 4 | { 5 | public class PluginPayload 6 | { 7 | public String VaultDirectory { get; set; } 8 | public String[] ConsoleArguments { get; set; } 9 | } 10 | } 11 | -------------------------------------------------------------------------------- /ObsidianTools/plugins/PluginCount.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | using System.Linq; 3 | 4 | namespace ObsidianTools.plugins 5 | { 6 | public class PluginCount : Plugin 7 | { 8 | public PluginCount() : base("--count", "Counts all markdown files") { } 9 | public Int32 LinkCount { get; private set; } 10 | 11 | protected override void Handle(PluginPayload payload) 12 | { 13 | LinkCount = GetMarkdownFilePaths(payload.VaultDirectory).Count(); 14 | Console.WriteLine($"Found {LinkCount} markdown files in given directory"); 15 | } 16 | } 17 | } 18 | -------------------------------------------------------------------------------- /ObsidianTools/ObsidianTools.csproj: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | Exe 5 | netcoreapp3.0 6 | ObsidianTools.Program 7 | ch.wuerth.tobias.ObsidianTools 8 | Tobias Würth 9 | https://github.com/tobiaswuerth/obsidian-tools 10 | https://github.com/tobiaswuerth/obsidian-tools 11 | 1.0.1 12 | 13 | 14 | -------------------------------------------------------------------------------- /ObsidianTools.Test/ObsidianTools.Test.csproj: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | netcoreapp3.0 5 | 6 | false 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | -------------------------------------------------------------------------------- /ObsidianTools.Test/TestPluginCleanupEmptyFiles.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | using System.IO; 3 | using NUnit.Framework; 4 | using ObsidianTools.plugins; 5 | 6 | namespace ObsidianTools.Test 7 | { 8 | public class TestPluginCleanupEmptyFiles : BaseTest 9 | { 10 | [ Test ] 11 | public void Test() 12 | { 13 | String path = RandomFilePath; 14 | PrepareFile(path, " \n \r \t "); 15 | 16 | new PluginCleanupDead().Execute(new[] 17 | { 18 | VaultDirectory 19 | } 20 | , VaultDirectory); 21 | 22 | if (File.Exists(path)) 23 | { 24 | Assert.Fail("file not properly deleted"); 25 | } 26 | } 27 | } 28 | } 29 | -------------------------------------------------------------------------------- /ObsidianTools/CollectionHelper.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | using System.Collections.Generic; 3 | using System.Linq; 4 | 5 | namespace ObsidianTools 6 | { 7 | public static class CollectionHelper 8 | { 9 | public static String AggregateWithComma(String a, String b) 10 | { 11 | return $"{a}, {b}"; 12 | } 13 | 14 | public static String CommaSeparatedList(IEnumerable eEntries) 15 | { 16 | List entries = eEntries?.ToList() ?? new List(); 17 | if (1 > entries.Count) 18 | { 19 | return ""; 20 | } 21 | 22 | if (2 > entries.Count) 23 | { 24 | return entries.First(); 25 | } 26 | 27 | return entries.Aggregate(AggregateWithComma); 28 | } 29 | } 30 | } 31 | -------------------------------------------------------------------------------- /ObsidianTools.Test/TestPluginCount.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | using System.Collections.Generic; 3 | using NUnit.Framework; 4 | using ObsidianTools.plugins; 5 | 6 | namespace ObsidianTools.Test 7 | { 8 | public class TestPluginCount : BaseTest 9 | { 10 | [ Test ] 11 | public void Test() 12 | { 13 | List paths = new List 14 | { 15 | RandomFilePath 16 | , RandomFilePath 17 | , RandomFilePath 18 | }; 19 | 20 | paths.ForEach(p => PrepareFile(p, "some [[a]], [[b#c]] `yea` #()!content")); 21 | 22 | PluginCount plugin = new PluginCount(); 23 | plugin.Execute(new[] 24 | { 25 | VaultDirectory 26 | } 27 | , VaultDirectory); 28 | 29 | Assert.AreEqual(3, plugin.LinkCount); 30 | } 31 | } 32 | } 33 | -------------------------------------------------------------------------------- /ObsidianTools.Test/TestPluginListDead.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | using System.IO; 3 | using NUnit.Framework; 4 | using ObsidianTools.plugins; 5 | 6 | namespace ObsidianTools.Test 7 | { 8 | public class TestPluginListDead : BaseTest 9 | { 10 | [ Test ] 11 | public void Test() 12 | { 13 | String path = Path.Join(VaultDirectory, "Index.md"); 14 | PrepareFile(path 15 | , "pre [[a]], [[b#c]], [[d|e]], [[f#g|h]]\r\n[[Index]], [[a.b.c]] [[Index#2]], [[Index|index]], [[Index#3|yea]] suf"); 16 | PrepareFile(GetFilePathForName("a.b.c"), "abc"); 17 | new PluginListDead().Execute(new[] 18 | { 19 | VaultDirectory 20 | } 21 | , VaultDirectory); 22 | 23 | MarkdownFile file = GetPluginOutputFile(); 24 | Assert.IsTrue(file.IsHealthy()); 25 | Assert.AreEqual(8, file.Links.Count); 26 | } 27 | } 28 | } 29 | -------------------------------------------------------------------------------- /ObsidianTools.Test/TestPluginFindReferences.cs: -------------------------------------------------------------------------------- 1 | using NUnit.Framework; 2 | using ObsidianTools.plugins; 3 | 4 | namespace ObsidianTools.Test 5 | { 6 | public class TestPluginFindReferences : BaseTest 7 | { 8 | [ Test ] 9 | public void Test() 10 | { 11 | PrepareFile(RandomFilePath, "pre this is a sample project aprojekt [[a]], [[ndex]], [[Index#3|yea]] suf"); 12 | PrepareFile(RandomFilePath, "hier haben wir ei anderes projekt, inkl. projektmanagement"); 13 | PrepareFile(RandomFilePath, "dieser hat nichts als referenz"); 14 | 15 | new PluginFindReferences().Execute(new[] 16 | { 17 | VaultDirectory 18 | , "--find-references" 19 | , "project" 20 | , "Projekt" 21 | } 22 | , VaultDirectory); 23 | 24 | MarkdownFile file = GetPluginOutputFile(); 25 | Assert.IsTrue(file.IsHealthy()); 26 | Assert.AreEqual(2, file.Links.Count); 27 | } 28 | } 29 | } 30 | -------------------------------------------------------------------------------- /ObsidianTools/LogHelper.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | 3 | namespace ObsidianTools 4 | { 5 | public static class LogHelper 6 | { 7 | public static void LogException(String prefix, Exception x) 8 | { 9 | if (null == x) 10 | { 11 | return; 12 | } 13 | 14 | prefix = prefix?.Trim() ?? String.Empty; 15 | if (!String.IsNullOrEmpty(prefix)) 16 | { 17 | Console.Error.WriteLine(prefix); 18 | } 19 | 20 | Console.Error.WriteLine($"Message: {x.Message}"); 21 | Console.Error.WriteLine($"Stacktrace: {x.StackTrace}"); 22 | Console.Error.WriteLine($"Source: {x.Source}"); 23 | Console.Error.WriteLine($"TargetSite: {x.TargetSite}"); 24 | Console.Error.WriteLine($"HelpLink: {x.HelpLink}"); 25 | if (null != x.InnerException) 26 | { 27 | Console.Error.WriteLine("+ Inner Exception:"); 28 | LogException(null, x.InnerException); 29 | } 30 | } 31 | } 32 | } 33 | -------------------------------------------------------------------------------- /ObsidianTools.Test/TestPluginAnalyze.cs: -------------------------------------------------------------------------------- 1 | using NUnit.Framework; 2 | using ObsidianTools.plugins; 3 | 4 | namespace ObsidianTools.Test 5 | { 6 | public class TestPluginAnalyze : BaseTest 7 | { 8 | [ Test ] 9 | public void Test() 10 | { 11 | PrepareFile(GetFilePathForName("Index"), "das ist ein [[Index]], find [[SubA#b]], [[SubB|abc]]"); 12 | PrepareFile(GetFilePathForName("SubA"), "dead end, back to [[Index]]"); 13 | PrepareFile(GetFilePathForName("SubB"), "anther one, might be interested in [[SubA]] ? or [[Hub]]"); 14 | PrepareFile(GetFilePathForName("Hub"), "[[SubC]], [[SubD]]"); 15 | PrepareFile(GetFilePathForName("SubC"), "nichts, nicht wie HubD"); 16 | PrepareFile(GetFilePathForName("SubD"), "go back to [[Hub]], or [[Index]]"); 17 | 18 | new PluginAnalyze().Execute(new[] 19 | { 20 | VaultDirectory 21 | } 22 | , VaultDirectory); 23 | 24 | MarkdownFile file = GetPluginOutputFile(); 25 | Assert.IsTrue(file.IsHealthy()); 26 | Assert.AreEqual(28, file.Links.Count); 27 | } 28 | } 29 | } 30 | -------------------------------------------------------------------------------- /ObsidianTools.Test/TestPluginCreateDeadLinks.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | using System.Collections.Generic; 3 | using System.IO; 4 | using NUnit.Framework; 5 | using ObsidianTools.plugins; 6 | 7 | namespace ObsidianTools.Test 8 | { 9 | public class TestPluginCreateDeadLinks : BaseTest 10 | { 11 | [ Test ] 12 | public void Test() 13 | { 14 | String path = Path.Join(VaultDirectory, "Index.md"); 15 | PrepareFile(path 16 | , "pre [[a]], [[b#c]], [[d|e]], [[f#g|h]]\r\n[[Index]], [[Index#2]], [[Index|index]], [[Index#3|yea]] suf"); 17 | 18 | List targetFiles = new List 19 | { 20 | Path.Join(VaultDirectory, "a.md") 21 | , Path.Join(VaultDirectory, "b.md") 22 | , Path.Join(VaultDirectory, "d.md") 23 | , Path.Join(VaultDirectory, "f.md") 24 | }; 25 | 26 | targetFiles.ForEach(f => Assert.IsFalse(File.Exists(f))); 27 | 28 | new PluginCreateDead().Execute(new[] 29 | { 30 | VaultDirectory 31 | } 32 | , VaultDirectory); 33 | 34 | targetFiles.ForEach(f => Assert.IsTrue(File.Exists(f))); 35 | } 36 | } 37 | } 38 | -------------------------------------------------------------------------------- /ObsidianTools.Test/TestPluginReduceNoise.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | using System.Collections.Generic; 3 | using System.IO; 4 | using NUnit.Framework; 5 | using ObsidianTools.plugins; 6 | 7 | namespace ObsidianTools.Test 8 | { 9 | public class TestPluginReduceNoise : BaseTest 10 | { 11 | [ Test ] 12 | public void Test() 13 | { 14 | PrepareFile(GetFilePathForName("Index"), "[[a1]] [[a2]] [[b]]"); 15 | PrepareFile(GetFilePathForName("a1"), "[[a1.1]] [[a1.2]] [[a1.3]], siehe auch: [[a2]]"); 16 | PrepareFile(GetFilePathForName("a2"), "[[a2.1]] [[a2.2]]"); 17 | PrepareFile(GetFilePathForName("b"), "[[b1]] [[b2]] [[b3]] [[b4]] [[b5]]"); 18 | PrepareFile(GetFilePathForName("b1"), "[[b]] [[b1.1]]"); 19 | PrepareFile(GetFilePathForName("b2"), "[[b]] [[b2.1]]"); 20 | PrepareFile(GetFilePathForName("b3"), "[[b]] [[b3.1]]"); 21 | PrepareFile(GetFilePathForName("b4"), "[[b]] [[b4.1]]"); 22 | PrepareFile(GetFilePathForName("b5"), "[[b]] [[b5.1]]"); 23 | PrepareFile(GetFilePathForName("b5.1"), "[[b5]] [[b5.1]]"); 24 | 25 | new PluginReduceNoise().Execute(new[] 26 | { 27 | VaultDirectory, 28 | "b", "b" 29 | } 30 | , VaultDirectory); 31 | 32 | 33 | } 34 | } 35 | } 36 | -------------------------------------------------------------------------------- /ObsidianTools.Test/TestPluginCleanupAssets.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | using System.IO; 3 | using System.Linq; 4 | using NUnit.Framework; 5 | using ObsidianTools.plugins; 6 | 7 | namespace ObsidianTools.Test 8 | { 9 | public class TestPluginCleanupAssets : BaseTest 10 | { 11 | [ Test ] 12 | public void Test() 13 | { 14 | PrepareFile(Path.Join(VaultDirectory, "index.md"), "this is a test for ![[image askdl - 27.png]] image embedding"); 15 | PrepareFile(Path.Join(VaultDirectory, "image askdl - 27.png"), "a"); 16 | PrepareFile(Path.Join(VaultDirectory, "image2.png"), "b"); 17 | PrepareFile(Path.Join(VaultDirectory, "image 3 more.png"), "d"); 18 | PrepareFile(Path.Join(VaultDirectory, "style.css"), "d"); 19 | new PluginCleanupAssets().Execute(new[] 20 | { 21 | VaultDirectory 22 | } 23 | , VaultDirectory); 24 | 25 | String targetDir = Path.Join(VaultDirectory, "_UNUSED"); 26 | Assert.IsTrue(Directory.Exists(targetDir)); 27 | String[] files = Directory.GetFiles(targetDir); 28 | Assert.AreEqual(2, files.Length); 29 | Assert.IsTrue(files.Contains(Path.Join(targetDir, "image2.png"))); 30 | Assert.IsFalse(files.Contains(Path.Join(targetDir, "style.css"))); 31 | } 32 | } 33 | } 34 | -------------------------------------------------------------------------------- /ObsidianTools.Test/TestPluginCleanupDeadLinks.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | using System.IO; 3 | using System.Text; 4 | using NUnit.Framework; 5 | using ObsidianTools.plugins; 6 | 7 | namespace ObsidianTools.Test 8 | { 9 | public class TestPluginCleanupDeadLinks : BaseTest 10 | { 11 | [ Test ] 12 | public void Test() 13 | { 14 | const String TEXT_BEFORE = 15 | "pre [[a]], [[b#c]], [[d|e]], [[f#g|h]]\r\n[[Index]], [[Index#2]], [[Index|index]], [[Index#3|yea]] suf ![[embedded]] [[image2.png|text]] [[image3.png]] [[image4.png|text2]] [[image5.png]]"; 16 | const String TEXT_AFTER = 17 | "pre a, b#c, e, h\r\n[[Index]], [[Index#2]], [[Index|index]], [[Index#3|yea]] suf ![[embedded]] [[image2.png|text]] [[image3.png]] text2 image5.png"; 18 | 19 | String path = GetFilePathForName("Index"); 20 | PrepareFile(path, TEXT_BEFORE); 21 | PrepareFile(Path.Join(VaultDirectory, "image2.png"), "a"); 22 | PrepareFile(Path.Join(VaultDirectory, "image3.png"), "a"); 23 | new PluginCleanupDead().Execute(new[] 24 | { 25 | VaultDirectory 26 | } 27 | , VaultDirectory); 28 | 29 | String isText = File.ReadAllText(path, Encoding.UTF8); 30 | if (!isText.Equals(TEXT_AFTER)) 31 | { 32 | Assert.Fail("text not properly cleaned up"); 33 | } 34 | } 35 | } 36 | } 37 | -------------------------------------------------------------------------------- /ObsidianTools.Test/TestPluginIdentifyHotspots.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | using System.IO; 3 | using NUnit.Framework; 4 | using ObsidianTools.plugins; 5 | 6 | namespace ObsidianTools.Test 7 | { 8 | public class TestPluginIdentifyHotspots : BaseTest 9 | { 10 | [ Test ] 11 | public void Test() 12 | { 13 | PrepareFile(GetFilePathForName("Index"), "[[a1]] [[a2]] [[b]]"); 14 | PrepareFile(GetFilePathForName("a1"), "[[a1.1]] [[a1.2]] [[a1.3]], siehe auch: [[a2]]"); 15 | PrepareFile(GetFilePathForName("a2"), "[[a2.1]] [[a2.2]]"); 16 | PrepareFile(GetFilePathForName("b"), "[[b1]] [[b2]] [[b3]] [[b4]] [[b5]]"); 17 | PrepareFile(GetFilePathForName("b1"), "[[b]] [[b1.1]]"); 18 | PrepareFile(GetFilePathForName("b2"), "[[b]] [[b2.1]]"); 19 | PrepareFile(GetFilePathForName("b3"), "[[b]] [[b3.1]]"); 20 | PrepareFile(GetFilePathForName("b4"), "[[b]] [[b4.1]]"); 21 | PrepareFile(GetFilePathForName("b5"), "[[b]] [[b5.1]]"); 22 | PrepareFile(GetFilePathForName("b5.1"), "[[b5]] [[b5.1]]"); 23 | new PluginIdentifyHotspots().Execute(new[] 24 | { 25 | VaultDirectory 26 | } 27 | , VaultDirectory); 28 | 29 | MarkdownFile file = GetPluginOutputFile(); 30 | Assert.IsTrue(file.IsHealthy()); 31 | Assert.AreEqual(10, file.Links.Count); 32 | Assert.IsTrue(file.Content.Contains("6x [[b]]")); 33 | Assert.IsTrue(file.Content.Contains("2x [[b5.1]]")); 34 | } 35 | } 36 | } 37 | -------------------------------------------------------------------------------- /ObsidianTools.sln: -------------------------------------------------------------------------------- 1 | 2 | Microsoft Visual Studio Solution File, Format Version 12.00 3 | # Visual Studio Version 16 4 | VisualStudioVersion = 16.0.29424.173 5 | MinimumVisualStudioVersion = 10.0.40219.1 6 | Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "ObsidianTools", "ObsidianTools\ObsidianTools.csproj", "{A0F5C745-F7BC-4786-BE62-E25462E29B63}" 7 | EndProject 8 | Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "ObsidianTools.Test", "ObsidianTools.Test\ObsidianTools.Test.csproj", "{C116DF1F-A4A3-447D-9441-B3A4D1FA6986}" 9 | EndProject 10 | Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "global", "global", "{BAE6808F-29B5-4F5D-8E2C-D69280F0C04D}" 11 | ProjectSection(SolutionItems) = preProject 12 | .gitignore = .gitignore 13 | LICENSE = LICENSE 14 | README.md = README.md 15 | EndProjectSection 16 | EndProject 17 | Global 18 | GlobalSection(SolutionConfigurationPlatforms) = preSolution 19 | Debug|Any CPU = Debug|Any CPU 20 | Release|Any CPU = Release|Any CPU 21 | EndGlobalSection 22 | GlobalSection(ProjectConfigurationPlatforms) = postSolution 23 | {A0F5C745-F7BC-4786-BE62-E25462E29B63}.Debug|Any CPU.ActiveCfg = Debug|Any CPU 24 | {A0F5C745-F7BC-4786-BE62-E25462E29B63}.Debug|Any CPU.Build.0 = Debug|Any CPU 25 | {A0F5C745-F7BC-4786-BE62-E25462E29B63}.Release|Any CPU.ActiveCfg = Release|Any CPU 26 | {A0F5C745-F7BC-4786-BE62-E25462E29B63}.Release|Any CPU.Build.0 = Release|Any CPU 27 | {C116DF1F-A4A3-447D-9441-B3A4D1FA6986}.Debug|Any CPU.ActiveCfg = Debug|Any CPU 28 | {C116DF1F-A4A3-447D-9441-B3A4D1FA6986}.Debug|Any CPU.Build.0 = Debug|Any CPU 29 | {C116DF1F-A4A3-447D-9441-B3A4D1FA6986}.Release|Any CPU.ActiveCfg = Release|Any CPU 30 | {C116DF1F-A4A3-447D-9441-B3A4D1FA6986}.Release|Any CPU.Build.0 = Release|Any CPU 31 | EndGlobalSection 32 | GlobalSection(SolutionProperties) = preSolution 33 | HideSolutionNode = FALSE 34 | EndGlobalSection 35 | GlobalSection(ExtensibilityGlobals) = postSolution 36 | SolutionGuid = {32741955-EF1A-4DC3-A019-FD3C3DEE0AF8} 37 | EndGlobalSection 38 | EndGlobal 39 | -------------------------------------------------------------------------------- /ObsidianTools/plugins/Plugin.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | using System.Collections.Generic; 3 | using System.IO; 4 | 5 | namespace ObsidianTools.plugins 6 | { 7 | public abstract class Plugin 8 | { 9 | public readonly String ConsoleArgument; 10 | public readonly String Description; 11 | 12 | protected Plugin(String consoleArgument, String description) 13 | { 14 | ConsoleArgument = consoleArgument; 15 | Description = description; 16 | } 17 | 18 | public void Execute(String[] cliArgs, String vaultDirectory) 19 | { 20 | Handle(new PluginPayload 21 | { 22 | ConsoleArguments = cliArgs 23 | , VaultDirectory = vaultDirectory 24 | }); 25 | } 26 | 27 | protected IEnumerable GetMarkdownFilePaths(String directory) 28 | { 29 | return Directory.EnumerateFiles(directory, "*.md", SearchOption.AllDirectories); 30 | } 31 | 32 | protected IEnumerable GetVaultFilePaths(String directory) 33 | { 34 | return Directory.EnumerateFiles(directory, "*.*", SearchOption.AllDirectories); 35 | } 36 | 37 | protected abstract void Handle(PluginPayload payload); 38 | 39 | protected List ReadFiles(IEnumerable paths) 40 | { 41 | List content = new List(); 42 | 43 | Console.WriteLine("Loading files into memory..."); 44 | foreach (String path in paths) 45 | { 46 | try 47 | { 48 | content.Add(new MarkdownFile(path)); 49 | } 50 | catch (Exception x) 51 | { 52 | LogHelper.LogException($"An error occurred reading file '{path}'", x); 53 | } 54 | } 55 | 56 | Console.WriteLine("Files loaded"); 57 | 58 | return content; 59 | } 60 | } 61 | } 62 | -------------------------------------------------------------------------------- /ObsidianTools/plugins/PluginListDead.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | using System.Collections.Generic; 3 | using System.IO; 4 | 5 | namespace ObsidianTools.plugins 6 | { 7 | public class PluginListDead : Plugin 8 | { 9 | public PluginListDead() : base("--list-dead", "List all dead links") { } 10 | 11 | protected override void Handle(PluginPayload payload) 12 | { 13 | Console.WriteLine("Searching for dead links..."); 14 | IEnumerable filePaths = GetMarkdownFilePaths(payload.VaultDirectory); 15 | List files = ReadFiles(filePaths); 16 | String outputPath = $"obsidiantools-output-dead-{DateTime.Now:yyyyMMdd-HHmmss}.md"; 17 | using (StreamWriter writer = File.CreateText(outputPath)) 18 | { 19 | writer.WriteLine("### Dead Links"); 20 | writer.WriteLine("The following dead links were found:"); 21 | foreach (MarkdownFile file in files) 22 | { 23 | MarkdownLink fileLink = MarkdownLink.ForFile(file); 24 | foreach (MarkdownLink link in file.Links) 25 | { 26 | String filePath = FileHelper.GetAbsoluteFileName(payload.VaultDirectory, link.FileName); 27 | if (!File.Exists(filePath)) 28 | { 29 | writer.WriteLine($" - Referenced file NOT FOUND @ {fileLink} -> {link} (`{filePath}`)"); 30 | } 31 | else if (!FileHelper.HasContent(filePath)) 32 | { 33 | writer.WriteLine($" - Referenced file IS EMPTY @ {fileLink} -> {link} (`{filePath}`)"); 34 | } 35 | } 36 | } 37 | } 38 | 39 | Console.WriteLine("Searching for dead links done"); 40 | Console.WriteLine($"Creating result file done, you can find it here: {outputPath}"); 41 | } 42 | } 43 | } 44 | -------------------------------------------------------------------------------- /ObsidianTools/plugins/PluginCreateDead.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | using System.Collections.Generic; 3 | using System.IO; 4 | using System.Linq; 5 | 6 | namespace ObsidianTools.plugins 7 | { 8 | public class PluginCreateDead : Plugin 9 | { 10 | public PluginCreateDead() : base("--create-dead", "Create all dead link files") { } 11 | 12 | protected override void Handle(PluginPayload payload) 13 | { 14 | Console.WriteLine("Creating dead links..."); 15 | IEnumerable filePaths = GetMarkdownFilePaths(payload.VaultDirectory); 16 | List files = ReadFiles(filePaths); 17 | List newLinks = new List(); 18 | String outputPath = $"obsidiantools-output-created-{DateTime.Now:yyyyMMdd-HHmmss}.md"; 19 | 20 | foreach (MarkdownFile file in files) 21 | { 22 | MarkdownLink fileLink = MarkdownLink.ForFile(file); 23 | foreach (MarkdownLink link in file.Links) 24 | { 25 | String filePath = FileHelper.GetAbsoluteFileName(payload.VaultDirectory, link.FileName); 26 | if (File.Exists(filePath)) 27 | { 28 | continue; 29 | } 30 | 31 | File.WriteAllText(filePath 32 | , "_automatically created by [obsidian-tools](https://github.com/tobiaswuerth/obsidian-tools)_ ==#todo=="); 33 | MarkdownLink newLink = MarkdownLink.ForFile(link.FileName); 34 | newLinks.Add(newLink); 35 | } 36 | } 37 | 38 | using (StreamWriter writer = File.CreateText(outputPath)) 39 | { 40 | writer.WriteLine("Created the following files and tagged them with #todo"); 41 | writer.WriteLine("### Newly Created Files"); 42 | String references = CollectionHelper.CommaSeparatedList(newLinks.Select(n => n.ToString())); 43 | writer.WriteLine(references); 44 | } 45 | 46 | Console.WriteLine("Created dead links"); 47 | Console.WriteLine($"Creating result file done, you can find it here: {outputPath}"); 48 | Console.WriteLine( 49 | "Note: You might have to restart your Obsidian.md client in order to correctly index all new files"); 50 | } 51 | } 52 | } 53 | -------------------------------------------------------------------------------- /ObsidianTools/MarkdownFile.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | using System.Collections.Generic; 3 | using System.IO; 4 | using System.Text; 5 | 6 | namespace ObsidianTools 7 | { 8 | public class MarkdownFile 9 | { 10 | private List _links; 11 | private List _linksEmbedded; 12 | 13 | public MarkdownFile(String path) 14 | { 15 | try 16 | { 17 | Info = new FileInfo(path); 18 | Content = File.ReadAllText(path, Encoding.UTF8); 19 | HasContents = !String.IsNullOrEmpty(Content.Trim()); 20 | } 21 | catch (Exception x) 22 | { 23 | LogHelper.LogException($"An error occurred creating a markdown file instance @ '{path}'", x); 24 | } 25 | } 26 | 27 | public Boolean HasChanged { get; private set; } 28 | 29 | public FileInfo Info { get; } 30 | public String Content { get; private set; } 31 | public Boolean HasContents { get; } 32 | 33 | public List Links 34 | { 35 | get 36 | { 37 | return _links ??= MarkdownLink.ForContent(Content); 38 | } 39 | } 40 | public String FileName 41 | { 42 | get 43 | { 44 | return Info?.Name.Replace(Info?.Extension, ""); 45 | } 46 | } 47 | public List LinksInklEmbedded 48 | { 49 | get 50 | { 51 | return _linksEmbedded ??= MarkdownLink.ForContent(Content, false); 52 | } 53 | } 54 | 55 | public Boolean IsHealthy() 56 | { 57 | return Info.Exists && HasContents; 58 | } 59 | 60 | public void SaveChanges() 61 | { 62 | if (!HasChanged) 63 | { 64 | return; 65 | } 66 | 67 | File.WriteAllText(Info.FullName, Content); 68 | } 69 | 70 | public void SetContent(String content) 71 | { 72 | if (String.Equals(Content, content)) 73 | { 74 | return; 75 | } 76 | 77 | HasChanged = true; 78 | Content = content; 79 | _links = null; 80 | } 81 | 82 | public override String ToString() 83 | { 84 | return Info.Name.Replace(Info.Extension, String.Empty); 85 | } 86 | } 87 | } 88 | -------------------------------------------------------------------------------- /ObsidianTools/plugins/PluginCleanupDead.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | using System.Collections.Generic; 3 | using System.IO; 4 | using System.Linq; 5 | using System.Text; 6 | 7 | namespace ObsidianTools.plugins 8 | { 9 | public class PluginCleanupDead : Plugin 10 | { 11 | public PluginCleanupDead() : base("--cleanup", "Cleanup dead links") { } 12 | 13 | protected override void Handle(PluginPayload payload) 14 | { 15 | Console.WriteLine("Starting to cleanup..."); 16 | List filePaths = GetMarkdownFilePaths(payload.VaultDirectory).ToList(); 17 | List files = ReadFiles(filePaths); 18 | Int32 replacementsTotal = 0; 19 | foreach (MarkdownFile file in files) 20 | { 21 | try 22 | { 23 | if (!file.IsHealthy() && FileHelper.TryDeleteEmptyFile(file.Info.FullName)) 24 | { 25 | continue; 26 | } 27 | 28 | // get all links 29 | String text = file.Content; 30 | Int32 replacements = 0; 31 | foreach (MarkdownLink link in file.Links) 32 | { 33 | // validate existance 34 | String filePath = FileHelper.GetAbsoluteFileName(payload.VaultDirectory, link.FileName); 35 | if (!FileHelper.TryDeleteEmptyFile(filePath)) 36 | { 37 | continue; 38 | } 39 | 40 | // cleanup text 41 | Console.WriteLine($"Dead link found: link '{filePath}' for match '{link}'"); 42 | text = text.Replace(link.ToString(), link.GetCleanedDisplayName()).Trim(); 43 | replacements++; 44 | } 45 | 46 | if (0 < replacements) 47 | { 48 | // persist cleaned up text 49 | File.WriteAllText(file.Info.FullName, text, new UTF8Encoding(false)); 50 | replacementsTotal += replacements; 51 | } 52 | } 53 | catch (Exception x) 54 | { 55 | LogHelper.LogException($"An error occurred cleaning up in path '{file.Info.FullName}'", x); 56 | } 57 | } 58 | 59 | Console.WriteLine($"Cleaning up done, removed {replacementsTotal} dead links"); 60 | } 61 | } 62 | } 63 | -------------------------------------------------------------------------------- /ObsidianTools/Program.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | using System.Collections.Generic; 3 | using System.IO; 4 | using System.Linq; 5 | using ObsidianTools.plugins; 6 | 7 | namespace ObsidianTools 8 | { 9 | internal class Program 10 | { 11 | private readonly String[] _args; 12 | 13 | private readonly List _plugins = new List 14 | { 15 | new PluginCount() 16 | , new PluginAnalyze() 17 | , new PluginFindReferences() 18 | , new PluginCreateReferences() 19 | , new PluginCleanupDead() 20 | , new PluginCleanupAssets() 21 | , new PluginIdentifyHotspots() 22 | , new PluginListDead() 23 | , new PluginCreateDead() 24 | , new PluginReduceNoise() 25 | }; 26 | 27 | private Program(String[] args) 28 | { 29 | _args = args; 30 | } 31 | 32 | private static void Main(String[] args) 33 | { 34 | new Program(args).Run(); 35 | } 36 | 37 | private void PrintPluginOverview() 38 | { 39 | Console.WriteLine("Plugins:"); 40 | _plugins.ForEach(p => Console.WriteLine($"\t{p.ConsoleArgument}\t\t{p.Description}")); 41 | } 42 | 43 | private void Run() 44 | { 45 | if (_args.Length < 2) 46 | { 47 | Console.WriteLine("Usage: exe [, ...]"); 48 | PrintPluginOverview(); 49 | return; 50 | } 51 | 52 | String directory = _args[0].Trim(); 53 | if (!Directory.Exists(directory)) 54 | { 55 | Console.WriteLine($"Directory: '{directory}' could not be found"); 56 | return; 57 | } 58 | 59 | String pluginName = _args[1].Trim().ToLower(); 60 | Plugin plugin = _plugins.FirstOrDefault(p => p.ConsoleArgument.Equals(pluginName)); 61 | if (null == plugin) 62 | { 63 | Console.WriteLine($"Plugin for argument '{pluginName}' not found"); 64 | PrintPluginOverview(); 65 | return; 66 | } 67 | 68 | Console.WriteLine($"Starting plugin: {plugin.Description}"); 69 | Console.WriteLine("==========================================="); 70 | plugin.Execute(_args, directory); 71 | Console.WriteLine("==========================================="); 72 | Console.WriteLine($"Finished plugin: {plugin.Description}"); 73 | } 74 | } 75 | } 76 | -------------------------------------------------------------------------------- /ObsidianTools/MarkdownLink.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | using System.Collections.Generic; 3 | using System.Text.RegularExpressions; 4 | 5 | namespace ObsidianTools 6 | { 7 | public class MarkdownLink 8 | { 9 | private const String REGEX_MARKDOWN_LINK_PATTERN = 10 | @"(.?)\[\[([^\#|\]\n\r\t]+)(\#([^\#|\]\n\r\t]+))?(\|([^\#|\]\n\r\t]+))?\]\]"; 11 | 12 | private MarkdownLink() { } 13 | 14 | public String FileName { get; set; } 15 | public String ChapterName { get; set; } 16 | public String DisplayName { get; set; } 17 | 18 | public static List ForContent(String content, Boolean ignoreEmbedded = true) 19 | { 20 | List links = new List(); 21 | 22 | MatchCollection matches = Regex.Matches(content, REGEX_MARKDOWN_LINK_PATTERN, RegexOptions.IgnoreCase); 23 | foreach (Match match in matches) 24 | { 25 | if (ignoreEmbedded && match.Value.StartsWith("!")) 26 | { 27 | // ignore embedded links 28 | continue; 29 | } 30 | 31 | links.Add(new MarkdownLink 32 | { 33 | FileName = match.Groups[2].Value.Trim() 34 | , ChapterName = match.Groups[4].Value.Trim() 35 | , DisplayName = match.Groups[6].Value.Trim() 36 | }); 37 | } 38 | 39 | return links; 40 | } 41 | 42 | public static MarkdownLink ForFile(String name) 43 | { 44 | return new MarkdownLink 45 | { 46 | FileName = name.Trim() 47 | }; 48 | } 49 | 50 | public static MarkdownLink ForFile(MarkdownFile file) 51 | { 52 | return ForFile(file.ToString()); 53 | } 54 | 55 | public String GetCleanedDisplayName() 56 | { 57 | if (!String.IsNullOrEmpty(DisplayName)) 58 | { 59 | return DisplayName; 60 | } 61 | 62 | return String.IsNullOrEmpty(ChapterName) ? FileName : $"{FileName}#{ChapterName}"; 63 | } 64 | 65 | public override String ToString() 66 | { 67 | String link = $"[[{FileName}"; 68 | if (!String.IsNullOrEmpty(ChapterName)) 69 | { 70 | link += $"#{ChapterName}"; 71 | } 72 | 73 | if (!String.IsNullOrEmpty(DisplayName)) 74 | { 75 | link += $"|{DisplayName}"; 76 | } 77 | 78 | link += "]]"; 79 | return link; 80 | } 81 | } 82 | } 83 | -------------------------------------------------------------------------------- /ObsidianTools/FileHelper.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | using System.Collections.Generic; 3 | using System.IO; 4 | using System.Linq; 5 | using System.Text; 6 | 7 | namespace ObsidianTools 8 | { 9 | public static class FileHelper 10 | { 11 | public static String CreateMarkdownLinkList(List links) 12 | { 13 | if (null == links || 1 > links.Count) 14 | { 15 | return ""; 16 | } 17 | 18 | links.Sort((a, b) => String.Compare(a.ToString(), b.ToString(), StringComparison.Ordinal)); 19 | return links.Select(f => f.ToString()).Aggregate(CollectionHelper.AggregateWithComma); 20 | } 21 | 22 | public static String GetAbsoluteFileName(String directory, String name) 23 | { 24 | List knownFileExtensions = new List 25 | { 26 | ".pdf" 27 | , ".png" 28 | , ".jpg" 29 | , ".jpeg" 30 | }; 31 | String lowerName = name.ToLower(); 32 | if (!knownFileExtensions.Any(e => lowerName.EndsWith(e))) 33 | { 34 | name += ".md"; 35 | } 36 | 37 | return Path.Join(directory, name); 38 | } 39 | 40 | public static Boolean HasContent(String path) 41 | { 42 | if (null == path) 43 | { 44 | return false; 45 | } 46 | 47 | try 48 | { 49 | if (!File.Exists(path)) 50 | { 51 | return false; 52 | } 53 | 54 | String text = File.ReadAllText(path, Encoding.UTF8); 55 | return !String.IsNullOrEmpty(text?.Trim()); 56 | } 57 | catch (Exception x) 58 | { 59 | LogHelper.LogException($"Warning: Could read contents of file @ {path}. Assuming it exists", x); 60 | return true; 61 | } 62 | } 63 | 64 | /** 65 | * Deletes the file, if it exists, only if it has no content 66 | * returns true if the file does not exist (anymore) 67 | */ 68 | public static Boolean TryDeleteEmptyFile(String file) 69 | { 70 | try 71 | { 72 | Boolean hasContents = HasContent(file); 73 | if (hasContents) 74 | { 75 | return false; 76 | } 77 | 78 | File.Delete(file); 79 | return !File.Exists(file); 80 | } 81 | catch (Exception x) 82 | { 83 | LogHelper.LogException($"Warning: Could not delete empty file @ {file}", x); 84 | return false; 85 | } 86 | } 87 | } 88 | } 89 | -------------------------------------------------------------------------------- /ObsidianTools/plugins/PluginCleanupAssets.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | using System.Collections.Generic; 3 | using System.IO; 4 | using System.Linq; 5 | using System.Text; 6 | 7 | namespace ObsidianTools.plugins 8 | { 9 | public class PluginCleanupAssets : Plugin 10 | { 11 | public PluginCleanupAssets() : base("--cleanup-assets", "Move all unreferenced [jpg|jpeg|pdf|png] files into subfolder .\\_UNUSED\\") { } 12 | 13 | protected override void Handle(PluginPayload payload) 14 | { 15 | Console.WriteLine("Starting to cleanup-assets..."); 16 | List unusedVaultFiles = GetVaultFilePaths(payload.VaultDirectory).ToList(); 17 | unusedVaultFiles.RemoveAll(p => p.EndsWith(".md")); 18 | List markdownFiles = GetMarkdownFilePaths(payload.VaultDirectory).ToList(); 19 | List files = ReadFiles(markdownFiles); 20 | Int32 movementsTotal = 0; 21 | List relevantFileExtensions = new List 22 | { 23 | ".jpg" 24 | , ".jpeg" 25 | , ".pdf" 26 | , ".png" 27 | }; 28 | unusedVaultFiles.RemoveAll(f => 29 | { 30 | String lowerName = f.ToLower(); 31 | return !relevantFileExtensions.Any(e => lowerName.EndsWith(e)); 32 | }); 33 | foreach (MarkdownFile file in files) 34 | { 35 | try 36 | { 37 | if (!file.IsHealthy() && FileHelper.TryDeleteEmptyFile(file.Info.FullName)) 38 | { 39 | continue; 40 | } 41 | 42 | // get all links 43 | IEnumerable referencedFiles = file.LinksInklEmbedded.Select(l => FileHelper.GetAbsoluteFileName(payload.VaultDirectory, l.FileName)); 44 | unusedVaultFiles = unusedVaultFiles.Except(referencedFiles).ToList(); 45 | } 46 | catch (Exception x) 47 | { 48 | LogHelper.LogException($"An error occurred cleaning up in path '{file.Info.FullName}'", x); 49 | } 50 | } 51 | 52 | String targetDirectory = Path.Join(payload.VaultDirectory, "_UNUSED"); 53 | if (!Directory.Exists(targetDirectory)) 54 | { 55 | Console.WriteLine("Creating \\_UNUSED target directory..."); 56 | Directory.CreateDirectory(targetDirectory); 57 | Console.WriteLine("Creating \\_UNUSED target directory done"); 58 | } 59 | 60 | Console.WriteLine($"Moving assets ({unusedVaultFiles.Count}x) assets:"); 61 | 62 | foreach (String unusedVaultFile in unusedVaultFiles) 63 | { 64 | String fileName = Path.GetFileName(unusedVaultFile); 65 | String newFileName = Path.Join(targetDirectory, fileName); 66 | Console.WriteLine($" > Moving asset {unusedVaultFiles} -> {newFileName}..."); 67 | File.Move(unusedVaultFile, newFileName); 68 | Console.WriteLine($" < Moving asset done"); 69 | } 70 | 71 | Console.WriteLine("Cleanup of unreferenced assets done"); 72 | } 73 | } 74 | } 75 | -------------------------------------------------------------------------------- /ObsidianTools/plugins/PluginIdentifyHotspots.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | using System.Collections.Generic; 3 | using System.IO; 4 | using System.Linq; 5 | using System.Text; 6 | 7 | namespace ObsidianTools.plugins 8 | { 9 | public class PluginIdentifyHotspots : Plugin 10 | { 11 | public PluginIdentifyHotspots() : base("--identify-hotspots", "Find the top nodes which are most often linked to") { } 12 | 13 | protected override void Handle(PluginPayload payload) 14 | { 15 | Console.WriteLine("Starting to identify-hotspots..."); 16 | List markdownFiles = GetMarkdownFilePaths(payload.VaultDirectory).ToList(); 17 | List files = ReadFiles(markdownFiles); 18 | Dictionary> referenceCount = CreateReferenceDict(files); 19 | 20 | Console.WriteLine($"Found the following reference counds:"); 21 | List>> orderedResult = referenceCount.OrderByDescending(kv => kv.Value.Count).ToList(); 22 | 23 | String outputPath = $"obsidiantools-output-hotspots-{DateTime.Now:yyyyMMdd-HHmmss}.md"; 24 | using (StreamWriter writer = File.CreateText(outputPath)) 25 | { 26 | writer.WriteLine("### Identified Hotspots"); 27 | writer.WriteLine("The following were counted:"); 28 | foreach ((String source, HashSet linkedTo) in orderedResult.Take(10)) 29 | { 30 | writer.WriteLine($" - {linkedTo.Count}x [[{source}]]"); 31 | Console.WriteLine($" - {linkedTo.Count}x {source}"); 32 | } 33 | } 34 | 35 | Console.WriteLine("Identify-hotspots done"); 36 | Console.WriteLine($"Creating result file done, you can find it here: {outputPath}"); 37 | } 38 | 39 | public static Dictionary> CreateReferenceDict(List files) 40 | { 41 | Dictionary> referenceCount = new Dictionary>(); 42 | foreach (MarkdownFile file in files) 43 | { 44 | try 45 | { 46 | if (!file.IsHealthy() && FileHelper.TryDeleteEmptyFile(file.Info.FullName)) 47 | { 48 | continue; 49 | } 50 | 51 | foreach (MarkdownLink link in file.Links) 52 | { 53 | if (referenceCount.ContainsKey(link.FileName)) 54 | { 55 | referenceCount[link.FileName].Add(file.Info.Name); 56 | } 57 | else 58 | { 59 | referenceCount[link.FileName] = new HashSet 60 | { 61 | file.Info.Name 62 | }; 63 | } 64 | } 65 | } 66 | catch (Exception x) 67 | { 68 | LogHelper.LogException($"An error occurred cleaning up in path '{file.Info.FullName}'", x); 69 | } 70 | } 71 | 72 | return referenceCount; 73 | } 74 | } 75 | } 76 | -------------------------------------------------------------------------------- /ObsidianTools.Test/TestPluginCreateReferences.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | using System.Collections.Generic; 3 | using System.IO; 4 | using System.Text; 5 | using NUnit.Framework; 6 | using ObsidianTools.plugins; 7 | 8 | namespace ObsidianTools.Test 9 | { 10 | public class TestPluginCreateReferences : BaseTest 11 | { 12 | [ Test ] 13 | public void Test() 14 | { 15 | List<(String Name, String Before, String After)> files = new List<(String, String, String)> 16 | { 17 | ("Index", "das hier ist der Index. ich habe Projekte und Management Aufgaben" 18 | , "das hier ist der Index. ich habe [[Projekt]]e und Management Aufgaben") 19 | , ("Projekt", "ein Unterfangen, AnotherDocument welches vom Manager oder der Managerin geleitet wird" 20 | , "ein Unterfangen, [[AnotherDocument]] welches vom [[Manager]] oder der [[Manager]]in geleitet wird") 21 | , ("Manager", "chef, siehe Index, leitet Projekte, Projektmanager auch Projektmanagement, Seniormanager" 22 | , "chef, siehe [[Index]], leitet [[Projekt]]e, [[Projektmanager]] auch [[Projekt]]management, Seniormanager") 23 | , ("AnotherDocument", "chef, siehe Index,[[ leitet Projekte]], auch Projektmanagement AnotherDocument, Seniormanager" 24 | , "chef, siehe [[Index]],[[ leitet Projekte]], auch [[Projekt]]management AnotherDocument, Senior[[Manager|manager]]") 25 | , ("Projektmanager", "chef, siehe [[Index, leitet Projekte, auch Projektmanagement]], SENIORMANAGER" 26 | , "chef, siehe [[Index, leitet Projekte, auch Projektmanagement]], SENIOR[[Manager|MANAGER]]") 27 | }; 28 | 29 | files.ForEach(f => PrepareFile(GetFilePathForName(f.Name), f.Before)); 30 | 31 | new PluginCreateReferences().Execute(new[] 32 | { 33 | VaultDirectory 34 | } 35 | , VaultDirectory); 36 | 37 | files.ForEach(f => 38 | { 39 | String path = Path.Combine(VaultDirectory, $"{f.Name}.md"); 40 | String content = File.ReadAllText(path, Encoding.UTF8); 41 | Assert.AreEqual(f.After, content); 42 | }); 43 | } 44 | 45 | [ Test ] 46 | public void Test_Links() 47 | { 48 | List<(String Name, String Before, String After)> files = new List<(String, String, String)> 49 | { 50 | ("Index", "this is Job anjobother Room aroom- [Job Room](https://www.job-room.ch/) url test blub" 51 | , "this is [[Job]] an[[Job|job]]other [[Room]] a[[Room|room]]- [Job Room](https://www.job-room.ch/) url test blub") 52 | , ("Room", "a", "a") 53 | , ("Job", "c", "c") 54 | }; 55 | 56 | files.ForEach(f => PrepareFile(GetFilePathForName(f.Name), f.Before)); 57 | 58 | new PluginCreateReferences().Execute(new[] 59 | { 60 | VaultDirectory 61 | } 62 | , VaultDirectory); 63 | 64 | files.ForEach(f => 65 | { 66 | String path = Path.Combine(VaultDirectory, $"{f.Name}.md"); 67 | String content = File.ReadAllText(path, Encoding.UTF8); 68 | Assert.AreEqual(f.After, content); 69 | }); 70 | } 71 | } 72 | } 73 | -------------------------------------------------------------------------------- /ObsidianTools.Test/BaseTest.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | using System.IO; 3 | using System.Text; 4 | using NUnit.Framework; 5 | 6 | namespace ObsidianTools.Test 7 | { 8 | public abstract class BaseTest 9 | { 10 | protected static readonly String TestDirectory = 11 | Path.Join(Environment.CurrentDirectory, $"\\_tmp_ObsidianTool-Test-Files-{Guid.NewGuid()}"); 12 | 13 | protected static readonly String VaultDirectory = Path.Join(TestDirectory, "\\vault"); 14 | private readonly String _directoryBefore = Environment.CurrentDirectory; 15 | 16 | protected static String RandomFilePath 17 | { 18 | get 19 | { 20 | String randomString = Guid.NewGuid().ToString("N"); 21 | String fileName = $"ObsidianTool-Test-{randomString}.md"; 22 | return Path.Join(VaultDirectory, fileName); 23 | } 24 | } 25 | 26 | protected void CleanupFile(String path) 27 | { 28 | try 29 | { 30 | if (!File.Exists(path)) 31 | { 32 | return; 33 | } 34 | 35 | File.Delete(path); 36 | if (File.Exists(path)) 37 | { 38 | Assert.Fail("Cannot cleanup file"); 39 | } 40 | } 41 | catch (Exception x) 42 | { 43 | Assert.Fail("Cannot cleanup file", x); 44 | } 45 | } 46 | 47 | protected static String GetFilePathForName(String name) 48 | { 49 | return Path.Join(VaultDirectory, $"{name}.md"); 50 | } 51 | 52 | protected MarkdownFile GetPluginOutputFile() 53 | { 54 | String[] markdownFiles = Directory.GetFiles(TestDirectory, "*.md", SearchOption.TopDirectoryOnly); 55 | String outputFile = 0 < markdownFiles.Length ? markdownFiles[0] : String.Empty; 56 | if (!String.IsNullOrEmpty(outputFile)) 57 | { 58 | return new MarkdownFile(outputFile); 59 | } 60 | 61 | Assert.Fail("Output file not found"); 62 | return null; 63 | } 64 | 65 | protected void PrepareFile(String path, String content) 66 | { 67 | try 68 | { 69 | File.WriteAllText(path, content, Encoding.UTF8); 70 | String isText = File.ReadAllText(path, Encoding.UTF8); 71 | if (!content.Equals(isText)) 72 | { 73 | Assert.Fail("File content not correct"); 74 | } 75 | } 76 | catch (Exception x) 77 | { 78 | CleanupFile(path); 79 | Assert.Fail("Cannot prepare file", x); 80 | } 81 | } 82 | 83 | [ SetUp ] 84 | public void SetUp() 85 | { 86 | if (!Directory.Exists(TestDirectory)) 87 | { 88 | Directory.CreateDirectory(TestDirectory); 89 | } 90 | 91 | Directory.CreateDirectory(VaultDirectory); 92 | Environment.CurrentDirectory = TestDirectory; 93 | } 94 | 95 | [ TearDown ] 96 | public void TearDown() 97 | { 98 | Environment.CurrentDirectory = _directoryBefore; 99 | if (Directory.Exists(TestDirectory)) 100 | { 101 | Directory.Delete(TestDirectory, true); 102 | } 103 | } 104 | } 105 | } 106 | -------------------------------------------------------------------------------- /ObsidianTools/plugins/PluginFindReferences.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | using System.Collections.Generic; 3 | using System.IO; 4 | using System.Linq; 5 | 6 | namespace ObsidianTools.plugins 7 | { 8 | public class PluginFindReferences : Plugin 9 | { 10 | public PluginFindReferences() : base("--find-references", "Find all files referencing the given keywords") { } 11 | 12 | private void CreateResultFile(HashSet keywords, List files) 13 | { 14 | Console.WriteLine("Creating result file..."); 15 | String outputPath = $"obsidiantools-output-references-{DateTime.Now:yyyyMMdd-HHmmss}.md"; 16 | using (StreamWriter writer = File.CreateText(outputPath)) 17 | { 18 | writer.WriteLine("Found the following references"); 19 | writer.WriteLine($"### {CollectionHelper.CommaSeparatedList(keywords)}"); 20 | List links = files.Select(MarkdownLink.ForFile).ToList(); 21 | String referenceList = FileHelper.CreateMarkdownLinkList(links); 22 | writer.WriteLine(referenceList); 23 | } 24 | 25 | Console.WriteLine($"Creating result file done, you can find it here: {outputPath}"); 26 | } 27 | 28 | private HashSet FindReferences(IEnumerable eFiles, HashSet keywords) 29 | { 30 | Console.WriteLine("Starting to search for word references..."); 31 | HashSet files = new HashSet(); 32 | foreach (String filePath in eFiles) 33 | { 34 | try 35 | { 36 | MarkdownFile file = new MarkdownFile(filePath); 37 | String lText = file.Content.ToLower(); 38 | if (keywords.Any(k => lText.Contains(k))) 39 | { 40 | files.Add(file); 41 | } 42 | } 43 | catch (Exception x) 44 | { 45 | LogHelper.LogException($"An error occurred searching for file references in path '{filePath}'", x); 46 | } 47 | } 48 | 49 | Console.WriteLine("Searching for references done"); 50 | return files; 51 | } 52 | 53 | private HashSet GetKeywords(String[] args) 54 | { 55 | HashSet keywords = new HashSet(); 56 | if (3 > args.Length) 57 | { 58 | Console.WriteLine("Provide additional parameters [, ..]"); 59 | return keywords; 60 | } 61 | 62 | for (Int32 i = 2 ; i < args.Length ; i++) 63 | { 64 | String keyword = args[i]?.Trim().ToLower() ?? String.Empty; 65 | if (!String.IsNullOrEmpty(keyword)) 66 | { 67 | keywords.Add(keyword); 68 | } 69 | } 70 | 71 | return keywords; 72 | } 73 | 74 | protected override void Handle(PluginPayload payload) 75 | { 76 | HashSet keywords = GetKeywords(payload.ConsoleArguments); 77 | if (1 > keywords.Count) 78 | { 79 | Console.WriteLine("No valid keyword found"); 80 | return; 81 | } 82 | 83 | IEnumerable filePaths = GetMarkdownFilePaths(payload.VaultDirectory); 84 | List files = FindReferences(filePaths, keywords).ToList(); 85 | CreateResultFile(keywords, files); 86 | } 87 | } 88 | } 89 | -------------------------------------------------------------------------------- /ObsidianTools/plugins/PluginCreateReferences.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | using System.Collections.Generic; 3 | using System.IO; 4 | using System.Linq; 5 | 6 | namespace ObsidianTools.plugins 7 | { 8 | public class PluginCreateReferences : Plugin 9 | { 10 | public PluginCreateReferences() : base("--create-references", "Create file reference for all unlinked mentions") { } 11 | 12 | protected override void Handle(PluginPayload payload) 13 | { 14 | Console.WriteLine("Creating references..."); 15 | IEnumerable filePaths = GetMarkdownFilePaths(payload.VaultDirectory); 16 | List files = ReadFiles(filePaths); 17 | files.Sort((a, b) => -1 * a.Info.Name.Length.CompareTo(b.Info.Name.Length)); 18 | foreach (MarkdownFile file in files) 19 | { 20 | FileInfo info = file.Info; 21 | String word = info.Name.Replace(info.Extension, String.Empty); 22 | Console.WriteLine($"Processing '{word}'..."); 23 | files.Except(new []{file}).ToList().ForEach(f => 24 | { 25 | ProcessFile(f, word, word); 26 | ProcessFile(f, word, word.ToLower()); 27 | ProcessFile(f, word, word.ToUpper()); 28 | }); 29 | } 30 | 31 | Console.WriteLine("Updating files..."); 32 | files.ForEach(f => f.SaveChanges()); 33 | Console.WriteLine("Created references"); 34 | } 35 | 36 | private static void ProcessFile(MarkdownFile f, String word, String keyword) 37 | { 38 | String[] parts = f.Content.Split(keyword); 39 | Int32 partCount = parts.Length; 40 | if (2 > partCount) 41 | { 42 | return; 43 | } 44 | 45 | Int32 partIndex = 0; 46 | String content = parts[partIndex]; 47 | while (partIndex < partCount - 1) 48 | { 49 | if (StringIsPartOfLink(content)) 50 | { 51 | content += keyword + parts[++partIndex]; 52 | continue; 53 | } 54 | 55 | String link = String.Equals(word, keyword) ? $"[[{word}]]" : $"[[{word}|{keyword}]]"; 56 | content += link + parts[++partIndex]; 57 | Console.WriteLine($"- Created link for '{link}' in {f.Info.Name}"); 58 | } 59 | 60 | f.SetContent(content); 61 | } 62 | 63 | private static Boolean StringIsPartOfLink(String content) 64 | { 65 | // not replace [[a]], and [b g](www.c.de) hijklm 66 | Boolean startedQuote = false; 67 | while (0 < content.Length) 68 | { 69 | if (content.EndsWith("[[")) 70 | { 71 | return true; 72 | } 73 | 74 | if (content.EndsWith("]]")) 75 | { 76 | return false; 77 | } 78 | 79 | if (content.EndsWith("[")) 80 | { 81 | return true; 82 | } 83 | 84 | if (content.EndsWith("(")) 85 | { 86 | startedQuote = true; 87 | } 88 | 89 | if (content.EndsWith("]")) 90 | { 91 | return startedQuote; 92 | } 93 | 94 | content = content[..^1]; 95 | } 96 | 97 | return false; 98 | } 99 | } 100 | } 101 | -------------------------------------------------------------------------------- /ObsidianTools/plugins/PluginReduceNoise.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | using System.Collections.Generic; 3 | using System.Linq; 4 | using System.Text; 5 | 6 | namespace ObsidianTools.plugins 7 | { 8 | public class PluginReduceNoise : Plugin 9 | { 10 | public PluginReduceNoise() : base("--reduce-noise" 11 | , "(beta) Create a tree-like structure starting from a given entry point") { } 12 | 13 | public static Dictionary> CreateReferenceDict(List files) 14 | { 15 | Dictionary> referenceCount = new Dictionary>(); 16 | foreach (MarkdownFile file in files) 17 | { 18 | try 19 | { 20 | if (!file.IsHealthy() && FileHelper.TryDeleteEmptyFile(file.Info.FullName)) 21 | { 22 | continue; 23 | } 24 | 25 | foreach (MarkdownLink link in file.Links) 26 | { 27 | if (referenceCount.ContainsKey(link.FileName)) 28 | { 29 | referenceCount[link.FileName].Add(file.Info.Name); 30 | } 31 | else 32 | { 33 | referenceCount[link.FileName] = new HashSet 34 | { 35 | file.Info.Name 36 | }; 37 | } 38 | } 39 | } 40 | catch (Exception x) 41 | { 42 | LogHelper.LogException($"An error occurred cleaning up in path '{file.Info.FullName}'", x); 43 | } 44 | } 45 | 46 | return referenceCount; 47 | } 48 | 49 | private HashSet GetKeywords(String[] args) 50 | { 51 | HashSet keywords = new HashSet(); 52 | if (3 > args.Length) 53 | { 54 | Console.WriteLine("Provide additional parameters "); 55 | return keywords; 56 | } 57 | 58 | for (Int32 i = 2 ; i < args.Length ; i++) 59 | { 60 | String keyword = args[i]?.Trim() ?? String.Empty; 61 | if (!String.IsNullOrEmpty(keyword)) 62 | { 63 | keywords.Add(keyword); 64 | } 65 | } 66 | 67 | return keywords; 68 | } 69 | 70 | protected override void Handle(PluginPayload payload) 71 | { 72 | Console.WriteLine("Starting to reduce-noise..."); 73 | 74 | HashSet entryPoints = GetKeywords(payload.ConsoleArguments); 75 | String entryPoint = entryPoints.FirstOrDefault(); 76 | if (null == entryPoint) 77 | { 78 | return; 79 | } 80 | 81 | Console.WriteLine("Reading vault..."); 82 | List markdowns = ReadFiles(GetMarkdownFilePaths(payload.VaultDirectory)); 83 | HashSet workingSet = new HashSet(); 84 | Dictionary> result = new Dictionary>(); 85 | MarkdownFile entryNode = 86 | markdowns.FirstOrDefault(m => m.Info.Name.Replace(m.Info.Extension, "").Equals(entryPoint)); 87 | if (null == entryNode) 88 | { 89 | Console.WriteLine("Entry node not found"); 90 | return; 91 | } 92 | 93 | Console.WriteLine("Starting processing..."); 94 | workingSet.Add(entryNode); 95 | Dictionary> referenceCount = CreateReferenceDict(markdowns); 96 | List>> orderedResult = 97 | referenceCount.OrderByDescending(kv => kv.Value.Count).ToList(); 98 | while (workingSet.Any()) 99 | { 100 | List nextSet = new List(); 101 | List markdownFiles = workingSet 102 | .OrderByDescending(w => orderedResult.First(o => o.Key.Equals(w.FileName)).Value.Count) 103 | .ToList(); 104 | foreach (MarkdownFile file in markdownFiles) 105 | { 106 | result[file] = null; 107 | } 108 | 109 | foreach (MarkdownFile file in markdownFiles) 110 | { 111 | List referencedFiles = file.Links 112 | .Select(l => markdowns.FirstOrDefault(m => m.FileName.Equals(l.FileName))) 113 | .Where(p => null != p) 114 | .ToList(); 115 | referencedFiles.RemoveAll(result.ContainsKey); 116 | referencedFiles.RemoveAll(p => result.Any(r => r.Value?.Contains(p) ?? false)); 117 | result[file] = new HashSet(referencedFiles); 118 | nextSet.AddRange(result[file]); 119 | } 120 | 121 | workingSet = new HashSet(nextSet); 122 | } 123 | 124 | Console.WriteLine("Update content..."); 125 | foreach ((MarkdownFile file, HashSet links) in result) 126 | { 127 | KeyValuePair> parent = result.FirstOrDefault(r => r.Value.Contains(file)); 128 | if (null != parent.Value) 129 | { 130 | links.Add(parent.Key); 131 | } 132 | 133 | List linksToRemove = file.Links.ToList(); 134 | HashSet sLinks = links.Select(l => l.FileName).ToHashSet(); 135 | linksToRemove.RemoveAll(p => sLinks.Contains(p.FileName)); 136 | foreach (MarkdownLink link in linksToRemove) 137 | { 138 | file.SetContent(file.Content.Replace(link.ToString(), link.FileName)); 139 | } 140 | 141 | foreach (String s in file.Links.Select(l => l.FileName)) 142 | { 143 | sLinks.Remove(s); 144 | } 145 | 146 | StringBuilder sbAppendix = new StringBuilder($"{Environment.NewLine}{Environment.NewLine}"); 147 | sbAppendix.Append("see also: "); 148 | sbAppendix.Append(String.Join(", ", sLinks.Select(t => $"[[{t}]]"))); 149 | 150 | file.SetContent(file.Content + sbAppendix); 151 | List externalReferences = markdowns.Except(links) 152 | .Where(p => p.Links.Select(l => l.FileName).Contains(file.FileName)) 153 | .ToList(); 154 | foreach (MarkdownFile toRemove in externalReferences) 155 | { 156 | foreach (MarkdownLink toRemoveLink in toRemove.Links.Where(l => l.FileName.Equals(file.FileName))) 157 | { 158 | toRemove.SetContent(toRemove.Content.Replace(toRemoveLink.ToString(), toRemoveLink.FileName)); 159 | } 160 | } 161 | } 162 | 163 | Console.WriteLine("Apply changes..."); 164 | markdowns.ForEach(p => p.SaveChanges()); 165 | 166 | Console.WriteLine("Reduce-noise done"); 167 | } 168 | } 169 | } 170 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | ## Ignore Visual Studio temporary files, build results, and 2 | ## files generated by popular Visual Studio add-ons. 3 | ## 4 | ## Get latest from https://github.com/github/gitignore/blob/master/VisualStudio.gitignore 5 | 6 | # User-specific files 7 | *.rsuser 8 | *.suo 9 | *.user 10 | *.userosscache 11 | *.sln.docstates 12 | 13 | # User-specific files (MonoDevelop/Xamarin Studio) 14 | *.userprefs 15 | 16 | # Mono auto generated files 17 | mono_crash.* 18 | 19 | # Build results 20 | [Dd]ebug/ 21 | [Dd]ebugPublic/ 22 | [Rr]elease/ 23 | [Rr]eleases/ 24 | x64/ 25 | x86/ 26 | [Aa][Rr][Mm]/ 27 | [Aa][Rr][Mm]64/ 28 | bld/ 29 | [Bb]in/ 30 | [Oo]bj/ 31 | [Ll]og/ 32 | [Ll]ogs/ 33 | 34 | # Visual Studio 2015/2017 cache/options directory 35 | .vs/ 36 | # Uncomment if you have tasks that create the project's static files in wwwroot 37 | #wwwroot/ 38 | 39 | # Visual Studio 2017 auto generated files 40 | Generated\ Files/ 41 | 42 | # MSTest test Results 43 | [Tt]est[Rr]esult*/ 44 | [Bb]uild[Ll]og.* 45 | 46 | # NUnit 47 | *.VisualState.xml 48 | TestResult.xml 49 | nunit-*.xml 50 | 51 | # Build Results of an ATL Project 52 | [Dd]ebugPS/ 53 | [Rr]eleasePS/ 54 | dlldata.c 55 | 56 | # Benchmark Results 57 | BenchmarkDotNet.Artifacts/ 58 | 59 | # .NET Core 60 | project.lock.json 61 | project.fragment.lock.json 62 | artifacts/ 63 | 64 | # StyleCop 65 | StyleCopReport.xml 66 | 67 | # Files built by Visual Studio 68 | *_i.c 69 | *_p.c 70 | *_h.h 71 | *.ilk 72 | *.meta 73 | *.obj 74 | *.iobj 75 | *.pch 76 | *.pdb 77 | *.ipdb 78 | *.pgc 79 | *.pgd 80 | *.rsp 81 | *.sbr 82 | *.tlb 83 | *.tli 84 | *.tlh 85 | *.tmp 86 | *.tmp_proj 87 | *_wpftmp.csproj 88 | *.log 89 | *.vspscc 90 | *.vssscc 91 | .builds 92 | *.pidb 93 | *.svclog 94 | *.scc 95 | 96 | # Chutzpah Test files 97 | _Chutzpah* 98 | 99 | # Visual C++ cache files 100 | ipch/ 101 | *.aps 102 | *.ncb 103 | *.opendb 104 | *.opensdf 105 | *.sdf 106 | *.cachefile 107 | *.VC.db 108 | *.VC.VC.opendb 109 | 110 | # Visual Studio profiler 111 | *.psess 112 | *.vsp 113 | *.vspx 114 | *.sap 115 | 116 | # Visual Studio Trace Files 117 | *.e2e 118 | 119 | # TFS 2012 Local Workspace 120 | $tf/ 121 | 122 | # Guidance Automation Toolkit 123 | *.gpState 124 | 125 | # ReSharper is a .NET coding add-in 126 | _ReSharper*/ 127 | *.[Rr]e[Ss]harper 128 | *.DotSettings.user 129 | 130 | # TeamCity is a build add-in 131 | _TeamCity* 132 | 133 | # DotCover is a Code Coverage Tool 134 | *.dotCover 135 | 136 | # AxoCover is a Code Coverage Tool 137 | .axoCover/* 138 | !.axoCover/settings.json 139 | 140 | # Visual Studio code coverage results 141 | *.coverage 142 | *.coveragexml 143 | 144 | # NCrunch 145 | _NCrunch_* 146 | .*crunch*.local.xml 147 | nCrunchTemp_* 148 | 149 | # MightyMoose 150 | *.mm.* 151 | AutoTest.Net/ 152 | 153 | # Web workbench (sass) 154 | .sass-cache/ 155 | 156 | # Installshield output folder 157 | [Ee]xpress/ 158 | 159 | # DocProject is a documentation generator add-in 160 | DocProject/buildhelp/ 161 | DocProject/Help/*.HxT 162 | DocProject/Help/*.HxC 163 | DocProject/Help/*.hhc 164 | DocProject/Help/*.hhk 165 | DocProject/Help/*.hhp 166 | DocProject/Help/Html2 167 | DocProject/Help/html 168 | 169 | # Click-Once directory 170 | publish/ 171 | 172 | # Publish Web Output 173 | *.[Pp]ublish.xml 174 | *.azurePubxml 175 | # Note: Comment the next line if you want to checkin your web deploy settings, 176 | # but database connection strings (with potential passwords) will be unencrypted 177 | *.pubxml 178 | *.publishproj 179 | 180 | # Microsoft Azure Web App publish settings. Comment the next line if you want to 181 | # checkin your Azure Web App publish settings, but sensitive information contained 182 | # in these scripts will be unencrypted 183 | PublishScripts/ 184 | 185 | # NuGet Packages 186 | *.nupkg 187 | # NuGet Symbol Packages 188 | *.snupkg 189 | # The packages folder can be ignored because of Package Restore 190 | **/[Pp]ackages/* 191 | # except build/, which is used as an MSBuild target. 192 | !**/[Pp]ackages/build/ 193 | # Uncomment if necessary however generally it will be regenerated when needed 194 | #!**/[Pp]ackages/repositories.config 195 | # NuGet v3's project.json files produces more ignorable files 196 | *.nuget.props 197 | *.nuget.targets 198 | 199 | # Microsoft Azure Build Output 200 | csx/ 201 | *.build.csdef 202 | 203 | # Microsoft Azure Emulator 204 | ecf/ 205 | rcf/ 206 | 207 | # Windows Store app package directories and files 208 | AppPackages/ 209 | BundleArtifacts/ 210 | Package.StoreAssociation.xml 211 | _pkginfo.txt 212 | *.appx 213 | *.appxbundle 214 | *.appxupload 215 | 216 | # Visual Studio cache files 217 | # files ending in .cache can be ignored 218 | *.[Cc]ache 219 | # but keep track of directories ending in .cache 220 | !?*.[Cc]ache/ 221 | 222 | # Others 223 | ClientBin/ 224 | ~$* 225 | *~ 226 | *.dbmdl 227 | *.dbproj.schemaview 228 | *.jfm 229 | *.pfx 230 | *.publishsettings 231 | orleans.codegen.cs 232 | 233 | # Including strong name files can present a security risk 234 | # (https://github.com/github/gitignore/pull/2483#issue-259490424) 235 | #*.snk 236 | 237 | # Since there are multiple workflows, uncomment next line to ignore bower_components 238 | # (https://github.com/github/gitignore/pull/1529#issuecomment-104372622) 239 | #bower_components/ 240 | 241 | # RIA/Silverlight projects 242 | Generated_Code/ 243 | 244 | # Backup & report files from converting an old project file 245 | # to a newer Visual Studio version. Backup files are not needed, 246 | # because we have git ;-) 247 | _UpgradeReport_Files/ 248 | Backup*/ 249 | UpgradeLog*.XML 250 | UpgradeLog*.htm 251 | ServiceFabricBackup/ 252 | *.rptproj.bak 253 | 254 | # SQL Server files 255 | *.mdf 256 | *.ldf 257 | *.ndf 258 | 259 | # Business Intelligence projects 260 | *.rdl.data 261 | *.bim.layout 262 | *.bim_*.settings 263 | *.rptproj.rsuser 264 | *- [Bb]ackup.rdl 265 | *- [Bb]ackup ([0-9]).rdl 266 | *- [Bb]ackup ([0-9][0-9]).rdl 267 | 268 | # Microsoft Fakes 269 | FakesAssemblies/ 270 | 271 | # GhostDoc plugin setting file 272 | *.GhostDoc.xml 273 | 274 | # Node.js Tools for Visual Studio 275 | .ntvs_analysis.dat 276 | node_modules/ 277 | 278 | # Visual Studio 6 build log 279 | *.plg 280 | 281 | # Visual Studio 6 workspace options file 282 | *.opt 283 | 284 | # Visual Studio 6 auto-generated workspace file (contains which files were open etc.) 285 | *.vbw 286 | 287 | # Visual Studio LightSwitch build output 288 | **/*.HTMLClient/GeneratedArtifacts 289 | **/*.DesktopClient/GeneratedArtifacts 290 | **/*.DesktopClient/ModelManifest.xml 291 | **/*.Server/GeneratedArtifacts 292 | **/*.Server/ModelManifest.xml 293 | _Pvt_Extensions 294 | 295 | # Paket dependency manager 296 | .paket/paket.exe 297 | paket-files/ 298 | 299 | # FAKE - F# Make 300 | .fake/ 301 | 302 | # CodeRush personal settings 303 | .cr/personal 304 | 305 | # Python Tools for Visual Studio (PTVS) 306 | __pycache__/ 307 | *.pyc 308 | 309 | # Cake - Uncomment if you are using it 310 | # tools/** 311 | # !tools/packages.config 312 | 313 | # Tabs Studio 314 | *.tss 315 | 316 | # Telerik's JustMock configuration file 317 | *.jmconfig 318 | 319 | # BizTalk build output 320 | *.btp.cs 321 | *.btm.cs 322 | *.odx.cs 323 | *.xsd.cs 324 | 325 | # OpenCover UI analysis results 326 | OpenCover/ 327 | 328 | # Azure Stream Analytics local run output 329 | ASALocalRun/ 330 | 331 | # MSBuild Binary and Structured Log 332 | *.binlog 333 | 334 | # NVidia Nsight GPU debugger configuration file 335 | *.nvuser 336 | 337 | # MFractors (Xamarin productivity tool) working folder 338 | .mfractor/ 339 | 340 | # Local History for Visual Studio 341 | .localhistory/ 342 | 343 | # BeatPulse healthcheck temp database 344 | healthchecksdb 345 | 346 | # Backup folder for Package Reference Convert tool in Visual Studio 2017 347 | MigrationBackup/ 348 | 349 | # Ionide (cross platform F# VS Code tools) working folder 350 | .ionide/ 351 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # obsidian-tools 2 | a CLI application for 3 | - markdown manipulation 4 | - for the [Obsidian.md](https://obsidian.md/) vault 5 | - written with .net core 6 | 7 | > ### You can find [the latest release by clicking here](https://github.com/tobiaswuerth/obsidian-tools/releases)! 8 | > #### Feel free to contribute or submit ideas! You can get in contact with me via [fooo.ooo](https://fooo.ooo/) 9 | 10 | **Please be careful!** 11 | These tools are under construction and may cause loss of data. 12 | Make sure you have a backup of your vault before executing any commands! 13 | 14 | # Help Overview 15 | ``` 16 | PS >.\ch.wuerth.tobias.ObsidianTools.exe 17 | Usage: exe [, ...] 18 | Plugins: 19 | --count Counts all markdown files 20 | --analyze Analyze markdown files and create word report 21 | --find-references Find all files referencing the given keywords 22 | --create-references Create file reference for all unlinked mentions 23 | --cleanup Cleanup dead links 24 | --cleanup-assets Move all unreferenced [jpg|jpeg|pdf|png] files into subfolder .\_UNUSED\ 25 | --identify-hotspots Find the top nodes which are most often linked to 26 | --list-dead List all dead links 27 | --create-dead Create all dead link files 28 | --reduce-noise (beta) Create a tree-like structure starting from a given entry point 29 | ``` 30 | 31 | --- 32 | 33 | # Examples 34 | Some example for the individuel plugins 35 | 36 | ### Count 37 | Counts all the `.md` files in the directory, including sub-directories 38 | 39 | ```ps 40 | PS >.\ch.wuerth.tobias.ObsidianTools.exe C:\myvault --count 41 | ``` 42 | 43 | Example output: 44 | ``` 45 | Starting plugin: Counts all markdown files 46 | =========================================== 47 | Found 383 markdown files in given directory 48 | =========================================== 49 | Finished plugin: Counts all markdown files 50 | ``` 51 | 52 | --- 53 | 54 | ### Analyze 55 | Analyzes the words of all the `.md` files in the directory, including sub-directories. 56 | Counts occurrences, looks for similar terms and finds references in other files. 57 | This can help you get insights into your knowledge. 58 | 59 | > **Note:** This produces a large output file 60 | 61 | **ToDo:** 62 | - [ ] Word Filter / Blacklist 63 | - [ ] Optimize Word Normalization 64 | 65 | ```ps 66 | PS >.\ch.wuerth.tobias.ObsidianTools.exe C:\myvault --analyze 67 | ``` 68 | see also: [Example output](https://pastebin.com/Z6HM3LSY) 69 | 70 | If you open the resulting output file in Obsidian, you should see something like this: 71 | ![Example Report](https://dl.dropboxusercontent.com/s/4ugn1kx4769h2h2/Obsidian_2020-08-05_14-49-58.png) 72 | 73 | --- 74 | 75 | ### Find References 76 | Analyzes the words of all the `.md` files in the directory, including sub-directories. 77 | Searches for matching keywords passed as an additional argument. 78 | This can be very helpful if you want to create a table of contents based on certain words. 79 | 80 | ```ps 81 | PS >.\ch.wuerth.tobias.ObsidianTools.exe C:\myvault --find-references projekt project unterfangen vorhaben 82 | ``` 83 | 84 | Example output: 85 | ``` 86 | Starting plugin: Find all files referencing the given keywords 87 | =========================================== 88 | Starting to search for word references... 89 | Searching for references done 90 | Creating result file... 91 | Creating result file done, you can find it here: obsidiantools-output-references-20200917-210340.md 92 | =========================================== 93 | Finished plugin: Find all files referencing the given keywords 94 | ``` 95 | 96 | If you open the resulting output file in Obsidian, you should see something like this: 97 | ![Example Report](https://dl.dropboxusercontent.com/s/n2q9eht7mpkf2lv/Obsidian_2020-08-05_14-57-25.png) 98 | 99 | --- 100 | 101 | ### Create References 102 | Analyzes the words of all the `.md` files in the directory, including sub-directories. 103 | Searches for matching words based on the `.md` filename and link it to the document. Basically linking unlinked mentions. 104 | This can be very helpful if you want to cleanup your vault and improve bidirectional linking between the topics you already created. 105 | 106 | ```ps 107 | PS >.\ch.wuerth.tobias.ObsidianTools.exe C:\myvault --create-references 108 | ``` 109 | see also: [Example output](https://pastebin.com/6CuNz1Yr) 110 | 111 | If you open the resulting output file in Obsidian, you should see something like this: 112 | ![Example Changes](https://dl.dropboxusercontent.com/s/xkpi4224i5oautk/2020-09-17_21-21-30.gif) 113 | 114 | --- 115 | 116 | ### Cleanup 117 | Cleanup all the `.md` files in the directory, including sub-directories. 118 | Searches for links, validates if the destination file exists and has content, otherwise remove the dead link. 119 | Empty files will be deleted in this process. 120 | This can be very helpful if you have a lot of links which do not yet have a backing document. 121 | 122 | ```ps 123 | PS >.\ch.wuerth.tobias.ObsidianTools.exe C:\myvault --cleanup 124 | ``` 125 | see also: [Example output](https://pastebin.com/zDP9MBWX) 126 | 127 | If you compare the two files you can see the links which got removed. 128 | Tipp: Use a version control tool like Git to track changes. 129 | ![Example Report](https://dl.dropboxusercontent.com/s/wl4t4llh4jt8kys/2020-08-05_13-38-06.gif) 130 | 131 | --- 132 | 133 | ### List Dead 134 | List all the dead links in the `.md` files in the directory, including sub-directories. 135 | Searches for links, validates if the destination file exists and has content, otherwise prints the dead link. 136 | This can be very helpful if you have a lot of links which do not yet have a backing document. 137 | This can also be used as a first step before executing `--cleanup` or `--create-dead`. 138 | 139 | ```ps 140 | PS >.\ch.wuerth.tobias.ObsidianTools.exe C:\myvault --list-dead 141 | ``` 142 | 143 | Example Output: 144 | ``` 145 | Starting plugin: List all dead links 146 | =========================================== 147 | Searching for dead links... 148 | Loading files into memory... 149 | Files loaded 150 | Searching for dead links done 151 | Creating result file done, you can find it here: obsidiantools-output-dead-20200917-212947.md 152 | =========================================== 153 | Finished plugin: List all dead links 154 | ``` 155 | 156 | If you compare the two files you can see the links which got removed. 157 | Tipp: Use a version control tool like Git to track changes. 158 | ![Example Report](https://dl.dropboxusercontent.com/s/2fy08uiuq17br90/Obsidian_2020-09-17_21-35-35.png) 159 | 160 | --- 161 | 162 | ### Create Dead 163 | Analyzes all the `.md` files in the directory, including sub-directories. 164 | Searches for links, validates if the destination file exists and has content, otherwise creates the destination file with a `#todo` mark for easy lookup. 165 | This can be very helpful if you plan to add sections for topics and therefor add links which do not exist yet. 166 | 167 | ```ps 168 | PS >.\ch.wuerth.tobias.ObsidianTools.exe C:\myvault --create-dead 169 | ``` 170 | 171 | Example Output: 172 | ``` 173 | Starting plugin: Create all dead link files 174 | =========================================== 175 | Creating dead links... 176 | Loading files into memory... 177 | Files loaded 178 | Created dead links 179 | Creating result file done, you can find it here: obsidiantools-output-created-20200917-213829.md 180 | Note: You might have to restart your Obsidian.md client in order to correctly index all new files 181 | =========================================== 182 | Finished plugin: Create all dead link files 183 | ``` 184 | 185 | Tipp: Use a version control tool like Git to track changes. 186 | 187 | ![Example Report](https://dl.dropboxusercontent.com/s/9ug9tps0mjv1o0w/Obsidian_2020-09-17_21-40-40.png) 188 | -------------------------------------------------------------------------------- /ObsidianTools/plugins/PluginAnalyze.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | using System.Collections.Generic; 3 | using System.IO; 4 | using System.Linq; 5 | using System.Text.RegularExpressions; 6 | 7 | namespace ObsidianTools.plugins 8 | { 9 | public class PluginAnalyze : Plugin 10 | { 11 | private readonly Dictionary _wordStatistics = new Dictionary(); 12 | 13 | public PluginAnalyze() : base("--analyze", "Analyze markdown files and create word report") { } 14 | 15 | private List AnalyzeMarkdownFiles(List files) 16 | { 17 | Console.WriteLine("Starting to analyze words in files..."); 18 | foreach (MarkdownFile file in files) 19 | { 20 | try 21 | { 22 | HandleFile(file); 23 | } 24 | catch (Exception x) 25 | { 26 | LogHelper.LogException("An error occurred handling the file", x); 27 | } 28 | } 29 | 30 | Console.WriteLine("Analyzing words done"); 31 | List stats = _wordStatistics.Values.ToList(); 32 | PrintStats(stats, (a, b) => a.Count.CompareTo(b.Count) * -1); 33 | return stats; 34 | } 35 | 36 | private void CreateResultFile(List stats) 37 | { 38 | Console.WriteLine("Creating result file..."); 39 | String outputPath = $"obsidiantools-output-analyze-{DateTime.Now:yyyyMMdd-HHmmss}.md"; 40 | using (StreamWriter writer = File.CreateText(outputPath)) 41 | { 42 | stats.Sort((a, b) => String.Compare(a.Word, b.Word, StringComparison.Ordinal)); 43 | stats.ForEach(s => 44 | { 45 | writer.WriteLine($"### {s.Word}"); 46 | writer.WriteLine($"Counted: {s.Count}"); 47 | 48 | String similar = CollectionHelper.CommaSeparatedList(s.SimilarWords.Select(s => s.Word)); 49 | writer.WriteLine($"Similar Words: {similar}"); 50 | 51 | List links = s.FileReferences.Select(MarkdownLink.ForFile).ToList(); 52 | String references = FileHelper.CreateMarkdownLinkList(links); 53 | writer.WriteLine($"References Words: {references}"); 54 | writer.WriteLine(""); 55 | writer.WriteLine("---"); 56 | writer.WriteLine(""); 57 | }); 58 | } 59 | 60 | Console.WriteLine($"Creating result file done, you can find it here: {outputPath}"); 61 | } 62 | 63 | private void FindSimilarWords(List stats) 64 | { 65 | Console.WriteLine("-------------"); 66 | Console.WriteLine("Starting to search for similar words..."); 67 | 68 | stats.ForEach(s => 69 | { 70 | stats.ForEach(possibleMatch => 71 | { 72 | if (possibleMatch.Word.ToLower().Contains(s.Word.ToLower())) 73 | { 74 | s.SimilarWords.Add(possibleMatch); 75 | } 76 | }); 77 | }); 78 | 79 | Console.WriteLine("Searching for similar words done"); 80 | PrintStats(stats, (a, b) => a.SimilarWords.Count.CompareTo(b.SimilarWords.Count) * -1); 81 | } 82 | 83 | private void FindWordReferences(List files, List stats) 84 | { 85 | Console.WriteLine("-------------"); 86 | Console.WriteLine("Starting to search for word references in files..."); 87 | foreach (MarkdownFile file in files) 88 | { 89 | try 90 | { 91 | String text = file.Content.ToLower(); 92 | stats.Where(s => text.Contains(s.Word.ToLower())) 93 | .ToList() 94 | .ForEach(s => s.FileReferences.Add(file.Info.Name.Replace(file.Info.Extension, String.Empty))); 95 | } 96 | catch (Exception x) 97 | { 98 | LogHelper.LogException($"An error occurred searching for file references in path '{file}'", x); 99 | } 100 | } 101 | 102 | Console.WriteLine("Searching for references done"); 103 | PrintStats(stats, (a, b) => a.FileReferences.Count.CompareTo(b.FileReferences.Count) * -1); 104 | } 105 | 106 | protected override void Handle(PluginPayload payload) 107 | { 108 | IEnumerable filePaths = GetMarkdownFilePaths(payload.VaultDirectory).ToList(); 109 | List files = ReadFiles(filePaths); 110 | List stats = AnalyzeMarkdownFiles(files); 111 | FindSimilarWords(stats); 112 | FindWordReferences(files, stats); 113 | CreateResultFile(stats); 114 | } 115 | 116 | private void HandleFile(MarkdownFile file) 117 | { 118 | // normalize text 119 | RegexOptions options = RegexOptions.Multiline | RegexOptions.IgnoreCase; 120 | String text = file.Content; 121 | text = Regex.Replace(text, "[^a-zA-Z0-9@äöüÄÖÜ-]+", " ", options); 122 | text = Regex.Replace(text, "[ ]+", " ", options); 123 | List words = text.Split(" ").ToList(); 124 | 125 | // filter relevant words 126 | List processedWords = new List(); 127 | foreach (String word in words) 128 | { 129 | if (String.IsNullOrEmpty(word) || 3 > word.Length) 130 | { 131 | continue; 132 | } 133 | 134 | processedWords.Add(word); 135 | } 136 | 137 | words = processedWords; 138 | 139 | // create map 140 | foreach (String word in words) 141 | { 142 | if (_wordStatistics.ContainsKey(word)) 143 | { 144 | _wordStatistics[word].Count++; 145 | } 146 | else 147 | { 148 | _wordStatistics[word] = new WordStatistic 149 | { 150 | Count = 1 151 | , FileReferences = new List() 152 | , SimilarWords = new List() 153 | , Word = word 154 | }; 155 | } 156 | } 157 | } 158 | 159 | private void PrintStats(List stats, Comparison sort) 160 | { 161 | Console.WriteLine("-------------"); 162 | Int32 takeAmount = 10; 163 | Console.WriteLine($"Top {takeAmount}"); 164 | stats.Sort(sort); 165 | stats.Take(takeAmount).ToList().ForEach(s => Console.WriteLine($" - {s}")); 166 | } 167 | 168 | private class WordStatistic 169 | { 170 | public String Word { get; set; } 171 | public Int32 Count { get; set; } 172 | public List SimilarWords { get; set; } 173 | public List FileReferences { get; set; } 174 | 175 | public override String ToString() 176 | { 177 | String similarWords = CollectionHelper.CommaSeparatedList(SimilarWords.Take(3).Select(s => s.Word)); 178 | String fileReferences = CollectionHelper.CommaSeparatedList(FileReferences.Take(3)); 179 | return 180 | $"{Word} (occurred {Count}x) ({SimilarWords.Count}x similar: {similarWords}, ..) @ ({FileReferences.Count}x referenced: {fileReferences}, ..)"; 181 | } 182 | } 183 | } 184 | } 185 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------