From 83a6d80362823c3861a930384c0d8790acbeba32 Mon Sep 17 00:00:00 2001
From: Durel <aardurel@gmail.com>
Date: Thu, 28 Sep 2017 20:50:24 -0400
Subject: [PATCH] 1) Added option to enable or disable automatic backups 2)
 Fixed incorrect warning message that claimed to be part of the backup module
 when it    really was part of the storage module

---
 aard_inventory.xml | 43 ++++++++++++++++++++++++++++++++-----------
 1 file changed, 32 insertions(+), 11 deletions(-)

diff --git a/aard_inventory.xml b/aard_inventory.xml
index 79ec556..bf0dd6b 100644
--- a/aard_inventory.xml
+++ b/aard_inventory.xml
@@ -542,7 +542,7 @@ Feature Wishlist
 
   <alias
    script="inv.cli.backup.fn"
-   match="^[ ]*dinv[ ]+backup[ ]+(list|create|delete|restore|auto)[ ]*([^ ]+)?[ ]*$"
+   match="^[ ]*dinv[ ]+backup[ ]+(on|off|list|create|delete|restore|auto)[ ]*([^ ]+)?[ ]*$"
    enabled="y"
    regexp="y"
    send_to="12"
@@ -1316,7 +1316,8 @@ function inv.config.new()
            setFormat       = version.setFormat,
            snapshotFormat  = version.snapshotFormat,
            isPromptEnabled = true,
-           buildExecuted   = false,
+           isBackupEnabled = true,
+           isBuildExecuted = false,
            refreshPeriod   = inv.items.timer.refreshMin
          }
 end -- inv.config.new
@@ -3532,7 +3533,17 @@ function inv.cli.backup.fn(name, line, wildcards)
     return inv.tags.stop(invTagsBackup, line, DRL_RET_NOT_ACTIVE)
   end -- if
 
-  if (command == "list") then
+  if (command == "on") then
+    inv.config.table.isBackupEnabled = true
+    dbot.info("Automatic backups are @GENABLED@W")
+    retval = inv.config.save()
+    retval = inv.tags.stop(invTagsBackup, line, retval)
+  elseif (command == "off") then
+    inv.config.table.isBackupEnabled = false
+    dbot.info("Automatic backups are @RDISABLED@W")
+    retval = inv.config.save()
+    retval = inv.tags.stop(invTagsBackup, line, retval)
+  elseif (command == "list") then
     retval = dbot.backup.list(line)
   elseif (command == "create") and (backupName ~= "") then
     retval = dbot.backup.create(backupName, line)
@@ -3555,7 +3566,8 @@ end -- inv.cli.backup.fn
 
 
 function inv.cli.backup.usage()
-  dbot.print("@W    " .. pluginNameCmd .. " backup @G[list | create | delete | restore] <backup name>@w")
+  dbot.print("@W    " .. pluginNameCmd ..
+             " backup @G[on | off | list | create | delete | restore] <backup name>@w")
 end -- inv.cli.backup.usage
 
 
@@ -3568,6 +3580,9 @@ The plugin creates automatic backups for all of your plugin data.  It also gives
 you the ability to create manual backups at any time.  By default, the plugin
 keeps 4 automatic backups.
 
+By default, automatic backups are enabled.  You can enable or disable the 
+automatic backups with "@Gdinv backup on@W" or "@Gdinv backup off@W".
+
 Most automatic backup systems rotate all previous automatic backups when a new 
 backup is created.  In other words, if you have automatic backups 1, 2, 3, and 4
 and then create a new backup, the previous backup #1 would become #2, the old #2
@@ -5632,7 +5647,7 @@ function inv.items.refresh(maxNumItems, refreshLocations, endTag, tagProxy)
   -- the build.  The main concern is that we don't want an auto-refresh to
   -- clog up the system for several minutes without warning the first time the
   -- user enables this plugin.
-  if (inv.config.table.buildExecuted == false) then
+  if (inv.config.table.isBuildExecuted == false) then
     dbot.print(
 [[@W
   You must perform at least one manual inventory build before we allow inventory refresh
@@ -5877,7 +5892,7 @@ function inv.items.build(endTag)
     return inv.tags.stop(invTagsBuild, endTag, retval)
   end -- if
 
-  inv.config.table.buildExecuted = true
+  inv.config.table.isBuildExecuted = true
   inv.state = invStateIdle
 
   -- The call to refresh is a little unusual in that we pass the build endTag to the refresh
@@ -16608,17 +16623,18 @@ function dbot.storage.init.atActive()
 
   -- Create directories for our state if they do not yet exist
   assert(os.execute("if not exist \"" .. pluginStatePath .. "\" mkdir " .. pluginStatePath .. " > nul"),
-         "dbot.backup.init.atActive: Failed to create plugin state directory \"" .. pluginStatePath .. "\"")
+         "dbot.storage.init.atActive: Failed to create plugin state directory \"" .. pluginStatePath .. "\"")
 
   local baseDir = dbot.backup.getBaseDir()
-  dbot.debug("dbot.backup.init.atActive: baseDir=\"" .. baseDir .. "\"")
+  dbot.debug("dbot.storage.init.atActive: baseDir=\"" .. baseDir .. "\"")
   assert(os.execute("if not exist \"" .. baseDir .. "\" mkdir " .. baseDir .. " > nul"),
-         "dbot.backup.init.atActive: Failed to create character-specific state directory \"" .. baseDir .. "\"")
+         "dbot.storage.init.atActive: Failed to create character-specific state directory \"" ..
+         baseDir .. "\"")
 
   local currentDir = dbot.backup.getCurrentDir()
-  dbot.debug("dbot.backup.init.atActive: currentDir=\"" .. currentDir .. "\"")
+  dbot.debug("dbot.storage.init.atActive: currentDir=\"" .. currentDir .. "\"")
   assert(os.execute("if not exist \"" .. currentDir .. "\" mkdir " .. currentDir .. " > nul"),
-         "dbot.backup.init.atActive: Failed to create current state directory \"" .. currentDir .. "\"")
+         "dbot.storage.init.atActive: Failed to create current state directory \"" .. currentDir .. "\"")
 
   return DRL_RET_SUCCESS
 
@@ -16889,6 +16905,11 @@ function dbot.backup.current()
     return DRL_RET_UNINITIALIZED
   end -- if
 
+  if (not inv.config.table.isBackupEnabled) then
+    dbot.note("Backups are disabled")
+    return DRL_RET_SUCCESS
+  end -- if
+
   if dbot.gmcp.isInCombat() then
     dbot.info("Skipping automatic backup: You are in combat!  We'll try again later.")
     return DRL_RET_IN_COMBAT