From 92bfa6fa5b37e0f0c3f1967520d01a1947bf01bc Mon Sep 17 00:00:00 2001
From: Jesse Plamondon-Willard <github@jplamondonw.com>
Date: Sat, 12 May 2018 18:16:40 -0400
Subject: add bundled save backup mod (#253)

---
 src/SMAPI.Mods.SaveBackup/Framework/ModConfig.cs   |  9 +++
 src/SMAPI.Mods.SaveBackup/ModEntry.cs              | 82 ++++++++++++++++++++++
 .../Properties/AssemblyInfo.cs                     |  4 ++
 .../StardewModdingAPI.Mods.SaveBackup.csproj       | 58 +++++++++++++++
 src/SMAPI.Mods.SaveBackup/manifest.json            |  8 +++
 5 files changed, 161 insertions(+)
 create mode 100644 src/SMAPI.Mods.SaveBackup/Framework/ModConfig.cs
 create mode 100644 src/SMAPI.Mods.SaveBackup/ModEntry.cs
 create mode 100644 src/SMAPI.Mods.SaveBackup/Properties/AssemblyInfo.cs
 create mode 100644 src/SMAPI.Mods.SaveBackup/StardewModdingAPI.Mods.SaveBackup.csproj
 create mode 100644 src/SMAPI.Mods.SaveBackup/manifest.json

(limited to 'src/SMAPI.Mods.SaveBackup')

diff --git a/src/SMAPI.Mods.SaveBackup/Framework/ModConfig.cs b/src/SMAPI.Mods.SaveBackup/Framework/ModConfig.cs
new file mode 100644
index 00000000..c9dcb216
--- /dev/null
+++ b/src/SMAPI.Mods.SaveBackup/Framework/ModConfig.cs
@@ -0,0 +1,9 @@
+namespace StardewModdingAPI.Mods.SaveBackup.Framework
+{
+    /// <summary>The mod configuration.</summary>
+    internal class ModConfig
+    {
+        /// <summary>The number of backups to keep.</summary>
+        public int BackupsToKeep { get; set; } = 10;
+    }
+}
diff --git a/src/SMAPI.Mods.SaveBackup/ModEntry.cs b/src/SMAPI.Mods.SaveBackup/ModEntry.cs
new file mode 100644
index 00000000..e9e62752
--- /dev/null
+++ b/src/SMAPI.Mods.SaveBackup/ModEntry.cs
@@ -0,0 +1,82 @@
+using System;
+using System.Collections.Generic;
+using System.IO;
+using System.IO.Compression;
+using System.Linq;
+using StardewModdingAPI.Mods.SaveBackup.Framework;
+using StardewValley;
+
+namespace StardewModdingAPI.Mods.SaveBackup
+{
+    /// <summary>The main entry point for the mod.</summary>
+    public class ModEntry : Mod
+    {
+        /*********
+        ** Properties
+        *********/
+        /// <summary>The name of the save archive to create.</summary>
+        private readonly string FileName = $"{DateTime.UtcNow:yyyy-MM-dd} - SMAPI {Constants.ApiVersion} with Stardew Valley {Game1.version}.zip";
+
+
+        /*********
+        ** Public methods
+        *********/
+        /// <summary>The mod entry point, called after the mod is first loaded.</summary>
+        /// <param name="helper">Provides simplified APIs for writing mods.</param>
+        public override void Entry(IModHelper helper)
+        {
+            try
+            {
+                // read config
+                ModConfig config = this.Helper.ReadConfig<ModConfig>();
+
+                // init backup folder
+                DirectoryInfo folder = new DirectoryInfo(Path.Combine(this.Helper.DirectoryPath, "backups"));
+                folder.Create();
+
+                // back up saves
+                {
+                    FileInfo file = new FileInfo(Path.Combine(folder.FullName, this.FileName));
+                    if (!file.Exists)
+                    {
+                        this.Monitor.Log($"Adding {file.Name}...", LogLevel.Trace);
+                        ZipFile.CreateFromDirectory(Constants.SavesPath, file.FullName, CompressionLevel.Fastest, includeBaseDirectory: false);
+                    }
+                }
+
+                // prune old saves
+                foreach (FileInfo file in this.GetOldBackups(folder, config.BackupsToKeep))
+                {
+                    try
+                    {
+                        this.Monitor.Log($"Deleting {file.Name}...", LogLevel.Trace);
+                        file.Delete();
+                    }
+                    catch (Exception ex)
+                    {
+                        this.Monitor.Log($"Error deleting old save backup '{file.Name}': {ex}");
+                    }
+                }
+            }
+            catch (Exception ex)
+            {
+                this.Monitor.Log($"Error backing up saves: {ex}");
+            }
+        }
+
+
+        /*********
+        ** Private methods
+        *********/
+        /// <summary>Get backups ordered by creation date.</summary>
+        /// <param name="folder">The folder to search.</param>
+        /// <param name="skip">The number of backups to skip.</param>
+        private IEnumerable<FileInfo> GetOldBackups(DirectoryInfo folder, int skip)
+        {
+            return folder
+                .GetFiles()
+                .OrderByDescending(p => p.CreationTimeUtc)
+                .Skip(skip);
+        }
+    }
+}
diff --git a/src/SMAPI.Mods.SaveBackup/Properties/AssemblyInfo.cs b/src/SMAPI.Mods.SaveBackup/Properties/AssemblyInfo.cs
new file mode 100644
index 00000000..fc6b26fa
--- /dev/null
+++ b/src/SMAPI.Mods.SaveBackup/Properties/AssemblyInfo.cs
@@ -0,0 +1,4 @@
+using System.Reflection;
+
+[assembly: AssemblyTitle("StardewModdingAPI.Mods.SaveBackup")]
+[assembly: AssemblyDescription("")]
diff --git a/src/SMAPI.Mods.SaveBackup/StardewModdingAPI.Mods.SaveBackup.csproj b/src/SMAPI.Mods.SaveBackup/StardewModdingAPI.Mods.SaveBackup.csproj
new file mode 100644
index 00000000..b322bf3a
--- /dev/null
+++ b/src/SMAPI.Mods.SaveBackup/StardewModdingAPI.Mods.SaveBackup.csproj
@@ -0,0 +1,58 @@
+<?xml version="1.0" encoding="utf-8"?>
+<Project ToolsVersion="15.0" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
+  <Import Project="$(MSBuildExtensionsPath)\$(MSBuildToolsVersion)\Microsoft.Common.props" Condition="Exists('$(MSBuildExtensionsPath)\$(MSBuildToolsVersion)\Microsoft.Common.props')" />
+  <PropertyGroup>
+    <Configuration Condition=" '$(Configuration)' == '' ">Debug</Configuration>
+    <Platform Condition=" '$(Platform)' == '' ">x86</Platform>
+    <ProjectGuid>{E272EB5D-8C57-417E-8E60-C1079D3F53C4}</ProjectGuid>
+    <OutputType>Library</OutputType>
+    <AppDesignerFolder>Properties</AppDesignerFolder>
+    <RootNamespace>StardewModdingAPI.Mods.SaveBackup</RootNamespace>
+    <AssemblyName>SaveBackup</AssemblyName>
+    <TargetFrameworkVersion>v4.5</TargetFrameworkVersion>
+    <FileAlignment>512</FileAlignment>
+  </PropertyGroup>
+  <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|x86' ">
+    <DebugSymbols>true</DebugSymbols>
+    <DebugType>full</DebugType>
+    <Optimize>false</Optimize>
+    <OutputPath>$(SolutionDir)\..\bin\Debug\Mods\SaveBackup\</OutputPath>
+    <DefineConstants>DEBUG;TRACE</DefineConstants>
+    <ErrorReport>prompt</ErrorReport>
+    <WarningLevel>4</WarningLevel>
+  </PropertyGroup>
+  <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|x86' ">
+    <DebugType>pdbonly</DebugType>
+    <Optimize>true</Optimize>
+    <OutputPath>$(SolutionDir)\..\bin\Release\Mods\SaveBackup\</OutputPath>
+    <DefineConstants>TRACE</DefineConstants>
+    <ErrorReport>prompt</ErrorReport>
+    <WarningLevel>4</WarningLevel>
+  </PropertyGroup>
+  <ItemGroup>
+    <Reference Include="System" />
+    <Reference Include="System.IO.Compression" />
+    <Reference Include="System.IO.Compression.FileSystem" />
+  </ItemGroup>
+  <ItemGroup>
+    <Compile Include="..\..\build\GlobalAssemblyInfo.cs">
+      <Link>Properties\GlobalAssemblyInfo.cs</Link>
+    </Compile>
+    <Compile Include="Framework\ModConfig.cs" />
+    <Compile Include="ModEntry.cs" />
+    <Compile Include="Properties\AssemblyInfo.cs" />
+  </ItemGroup>
+  <ItemGroup>
+    <None Include="manifest.json">
+      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+    </None>
+  </ItemGroup>
+  <ItemGroup>
+    <ProjectReference Include="..\SMAPI\StardewModdingAPI.csproj">
+      <Project>{f1a573b0-f436-472c-ae29-0b91ea6b9f8f}</Project>
+      <Name>StardewModdingAPI</Name>
+    </ProjectReference>
+  </ItemGroup>
+  <Import Project="$(MSBuildToolsPath)\Microsoft.CSharp.targets" />
+  <Import Project="..\..\build\common.targets" />
+</Project>
\ No newline at end of file
diff --git a/src/SMAPI.Mods.SaveBackup/manifest.json b/src/SMAPI.Mods.SaveBackup/manifest.json
new file mode 100644
index 00000000..5246f65d
--- /dev/null
+++ b/src/SMAPI.Mods.SaveBackup/manifest.json
@@ -0,0 +1,8 @@
+{
+  "Name": "Save Backup",
+  "Author": "SMAPI",
+  "Version": "2.6.0-beta.12",
+  "Description": "Automatically backs up all your saves once per day into its folder.",
+  "UniqueID": "SMAPI.SaveBackup",
+  "EntryDll": "SaveBackup.dll"
+}
-- 
cgit