Merge pull request #1 from taylorflatt/dev

Release 1.4.0.0

Author: taylorflatt

README.md

@@ -5,6 +5,11 @@ A basic portable Windows shutdown timer. I use this personally but it is availab
 
 Creates timer that will shutdown windows after a specified number of minutes. It is non-intrusive meaning once you set the timer, you can hide it or close it without any problems. At its core, it runs a shutdown command through the windows command prompt with a timer attached.
 
+## Requirements
+
+* Windows 10, Windows 8, Windows 7
+* [.NET Framework 4.5.2](https://www.microsoft.com/en-us/download/details.aspx?id=42642) or better
+
 ## Features
 
 * Shutdown Windows after specified number of minutes.
@@ -15,22 +20,23 @@ Creates timer that will shutdown windows after a specified number of minutes. It
 * Timers created by this program will persist even if the program is shutdown.
 * Ability to update from the program any time. It simply pulls the exe from GIT and places it in the directory from which the update was run. In other words, it puts the two versions in the same directory.
 
-## Known Issues
+## Usage
 
-There aren't any program breaking issues as of yet. If you discover any, please don't hesitate to contact me or raise an issue. But I am aware of some annoyances and am working on finding solutions to those:
+Download the [latest release](https://github.com/taylorflatt/windows-shutdown-timer/releases) and run it somewhere on your desktop. No installation required. Note, if you end up ever updating it via the updater, the new version will be downloaded to the same directory as the old version.
 
-* When the program first starts, if a timer was set by the program previously but has yet to elapse, a check will be run. The check will cause a shutdown notification and a "ding". It doesn't change anything other than simply verify the existence of a timer. I'm looking for ways around this small annoyance. It doesn't happen often though, which is nice.
+## Updating
 
-## Requirements
+To update, simply choose the "Update" option in the program and it will determine if there is a newer version available. If there is, you have the option to download it. The newer version will be downloaded and placed in the same place as the older version. Once downloaded, it is then safe to remove the old version. Note, your settings will not be preserved (next release).
 
-* Windows 10, Windows 8, Windows 7*
-* [.NET Framework 4.5.2](https://www.microsoft.com/en-us/download/details.aspx?id=42642) or better
+Otherwise, you can simply download the latest version from the [Release Section](https://github.com/taylorflatt/windows-shutdown-timer/releases).
 
-\*Currently only tested working on Windows 10 and Windows 8. There isn't anything exclusive to Windows 10/8 so it should honestly work just fine on Windows 7.
+## Known Issues
 
-## Usage
+There aren't any program breaking issues as of yet. If you discover any, please don't hesitate to contact me or raise an issue. But I am aware of some annoyances and am working on finding solutions to those:
 
-Download the [latest release](https://github.com/taylorflatt/windows-shutdown-timer/releases) and run it somewhere on your desktop. No installation required. Note, if you end up ever updating it via the updater, the new version will be downloaded to the same directory as the old version.
+* When the program first starts, if a timer was set by the program previously but has yet to elapse, a check will be run. The check will cause a shutdown notification and a "ding". It doesn't change anything other than simply verify the existence of a timer. I'm looking for ways around this small annoyance. It doesn't happen often though, which is nice.
+* When the computer is around 15 minutes or less from shutting off, a banner or dialog box on Windows 7, 8, and 10 will display indicating the impending shutdown. This is for any scheduled shutdown and I am looking at ways to remove/disable this function. There isn't an option to perform a quiet reboot like literally every other OS out there. 
+* After an update, settings are not preserved. This isn't game breaking but it is annoying. This is the next thing I plan on tackling.
 
 ## Notes
 

VERSION

@@ -1 +1 @@
-1.3.0.0
+1.4.0.0

WindowsShutdownTimer.exe

@@ -10,7 +10,7 @@
     </startup>
     <userSettings>
         <WindowsShutdownTimer.Properties.Settings>
-            <setting name="MinimizePref" serializeAs="String">
+            <setting name="MinimizeToSysTray" serializeAs="String">
                 <value>False</value>
             </setting>
             <setting name="LClickOpenSysTray" serializeAs="String">

WindowsShutdownTimer/App.config

@@ -2,23 +2,77 @@
 
 namespace WindowsShutdownTimer
 {
+    /// <summary>
+    /// Trouble stopping the timer.
+    /// </summary>
     [Serializable]
     class StopTimerException : Exception
     {
+        public string ErrorCode = "";
+
         public StopTimerException() { }
 
-        public StopTimerException(string message) : base(message) { }
+        public StopTimerException(string message, string code) : base(message)
+        {
+            this.ErrorCode = code;
+        }
 
-        public StopTimerException(string message, Exception inner) : base(message, inner) { }
+        public StopTimerException(string message, Exception inner, string code) : base(message, inner)
+        {
+            this.ErrorCode = code;
+        }
     }
 
+    /// <summary>
+    /// Trouble starting the timer.
+    /// </summary>
     [Serializable]
     class StartTimerException : Exception
     {
+        public string ErrorCode = "";
+
         public StartTimerException() { }
 
-        public StartTimerException(string message) : base(message) { }
+        public StartTimerException(string message, string code) : base(message)
+        {
+            this.ErrorCode = code;
+        }
+
+        public StartTimerException(string message, Exception inner, string code) : base(message, inner)
+        {
+            this.ErrorCode = code;
+        }
+    }
+
+    /// <summary>
+    /// Trouble checking for a timer.
+    /// </summary>
+    [Serializable]
+    class CheckTimerException : Exception
+    {
+        public string ErrorCode = "";
+
+        public CheckTimerException() { }
+
+        public CheckTimerException(string message, string code) : base(message)
+        {
+            this.ErrorCode = code;
+        }
+
+        public CheckTimerException(string message, Exception inner, string code) : base(message, inner)
+        {
+            this.ErrorCode = code;
+        }
+    }
+
+    /// <summary>
+    /// Used to show that the timer has ended. This isn't a true exception. This seemed easier (to read/understand) than traditional logic to me.
+    /// </summary>
+    [Serializable]
+    class TimerEnded : Exception
+    {
+        public TimerEnded() { }
 
-        public StartTimerException(string message, Exception inner) : base(message, inner) { }
+        public TimerEnded(string message) : base(message) { }
     }
 }

WindowsShutdownTimer/CustomExceptions.cs

@@ -1,13 +1,14 @@
 using System;
-using System.Collections.Generic;
-using System.Linq;
-using System.Text;
-using System.Threading.Tasks;
 
 namespace WindowsShutdownTimer
 {
     public class Helpers
     {
+        /// <summary>
+        /// Since VS won't save a default DateTime object (year as 0001), an extra year needs to be added to
+        /// any DateTime object. So I redefine the 'default' DateTime (year is now 0002) for reference.
+        /// </summary>
+        /// <param name="obj">DateTime object to be reset to default. Exact same as calling default except with an extra year.</param>
         public void SetDefaultDateTime(DateTime obj)
         {
             obj = default(DateTime);

WindowsShutdownTimer/Helpers.cs

@@ -1,6 +1,4 @@
 using System;
-using System.Deployment.Application;
-using System.IO;
 using System.Windows.Forms;
 
 namespace WindowsShutdownTimer
@@ -23,6 +21,9 @@ public Options(TimerForm parent)
             timerWindow = parent;
             timerWindow.Enabled = false;
 
+            // Setting this in the design menu doesn't work. Must be set here.
+            this.CenterToParent();
+
             last_shutdown_label_desc.Text = "Last Shutdown: ";
 
             // Because the settings manager won't store a 0001 default DateTime year.
@@ -45,7 +46,7 @@ public Options(TimerForm parent)
         /// <param name="e"></param>
         private void Options_Load(object sender, EventArgs e)
         {
-            if (Properties.Settings.Default.MinimizePref)
+            if (Properties.Settings.Default.MinimizeToSysTray)
                 minimize_to_sys_tray.Checked = true;
             else
                 minimize_to_sys_tray.Checked = false;
@@ -65,9 +66,9 @@ public void save_options_button_Click(object sender, EventArgs e)
         { 
             // Minimize program to system tray rather than to the taskbar.
             if (minimize_to_sys_tray.Checked)
-                Properties.Settings.Default.MinimizePref = true;
+                Properties.Settings.Default.MinimizeToSysTray = true;
             else
-                Properties.Settings.Default.MinimizePref = false;
+                Properties.Settings.Default.MinimizeToSysTray = false;
 
             // Single left click to re-show program when clicking icon in system tray.
             if (left_click_open_sys_tray.Checked)
@@ -117,7 +118,7 @@ public void check_update_button_Click(object sender, EventArgs e)
                 if(Convert.ToInt32(webV.GetValue(i)) > Convert.ToInt32(curV.GetValue(i)))
                 {
                     DialogResult result = MessageBox.Show("The current version is: " + currentVersion + " and the newest version is " + webVersion + ". Would you " +
-                        "like to download the newest version?", "New Version Found!", MessageBoxButtons.YesNoCancel);
+                        "like to download the newest version?", "New Version Found!", MessageBoxButtons.YesNoCancel, MessageBoxIcon.Question);
 
                     if (result == DialogResult.Yes)
                     {
@@ -130,7 +131,7 @@ public void check_update_button_Click(object sender, EventArgs e)
                             wc.DownloadFile(new Uri(updatedAppLocation), newFilePath);
 
                             DialogResult close = MessageBox.Show("You have successfully updated to version " + webVersion + "! The new version was downloaded to the same directory as this " +
-                                "program. Would you like to close this program now?", "Update Completed!", MessageBoxButtons.YesNo);
+                                "program. Would you like to close this program now?", "Update Completed!", MessageBoxButtons.YesNo, MessageBoxIcon.Information);
 
                             if (close == DialogResult.Yes)
                                 Application.Exit();
@@ -141,7 +142,7 @@ public void check_update_button_Click(object sender, EventArgs e)
                         catch
                         {
                             DialogResult error = MessageBox.Show("There was an error attempting to grab the latest update. Would you like to " +
-                                "retry or cancel?", "Error Downloading Update!", MessageBoxButtons.RetryCancel);
+                                "retry or cancel?", "Error Downloading Update!", MessageBoxButtons.RetryCancel, MessageBoxIcon.Error);
 
                             if (error == DialogResult.Retry)
                                 check_update_button_Click(null, null);
@@ -155,7 +156,7 @@ public void check_update_button_Click(object sender, EventArgs e)
                 }
             }
 
-            MessageBox.Show("The current version is: " + currentVersion + " and it is up to date!", "No New Update!", MessageBoxButtons.OK);
+            MessageBox.Show("The current version is: " + currentVersion + " and it is up to date!", "No New Update!", MessageBoxButtons.OK, MessageBoxIcon.Information);
         }
     }
 }

WindowsShutdownTimer/Options.Designer.cs

@@ -23,9 +23,7 @@ static class Program
         [STAThread]
         static void Main()
         {
-            bool unqiue;
-
-            using (var mutex = new Mutex(true, "WindowsShutdownTimerMutex", out unqiue))
+            using (var mutex = new Mutex(true, "WindowsShutdownTimerMutex", out bool unqiue))
             {
                 if(unqiue)
                 {

WindowsShutdownTimer/Options.cs

@@ -32,5 +32,5 @@
 // You can specify all the values or you can default the Build and Revision Numbers
 // by using the '*' as shown below:
 // [assembly: AssemblyVersion("1.0.*")]
-[assembly: AssemblyVersion("1.3.0.0")]
-[assembly: AssemblyFileVersion("1.0.0.0")]
+[assembly: AssemblyVersion("1.4.0.0")]
+[assembly: AssemblyFileVersion("1.4.0.0")]