This forum is a read-only archive of the Gammon Software forum (2000–2026). No new posts can be made. Search the archive.

checkplugin.lua should also enable an installed but disabled plugin

Posted by Fiendish on Sat 28 May 2011 06:04 PM — 5 posts, 15,428 views.

Fiendish USA Global Moderator #0
Currently (4.73) it seems that checkplugin.lua's do_plugin_check_now only checks that a plugin is installed, but doesn't make sure that it is enabled. I think it should also be checking for enabled by changing do_plugin_check_now to


function do_plugin_check_now (id, name)

   if not IsPluginInstalled (id) then
      ColourNote ("white", "green", "Plugin '" .. name .. "' not installed. Attempting to install it...") 
      LoadPlugin (GetPluginInfo(GetPluginID (), 20) .. name .. ".xml") 

      if IsPluginInstalled (id) then
         ColourNote ("white", "green", "Success!") 
      else
         ColourNote ("white", "red", string.rep ("-", 80))
         ColourNote ("white", "red", "Plugin '" .. name .. "' not installed. Please download and install it.") 
         ColourNote ("white", "red", "It is required for the correct operation of the " ..
                    GetPluginName () .. " plugin.")
         ColourNote ("white", "red", string.rep ("-", 80))
         return
      end
   end
   
   if not GetPluginInfo(id, 17) then
      ColourNote ("white", "green", "Plugin '" .. name .. "' not enabled. Attempting to enable it...")
      EnablePlugin(id, true)
      if GetPluginInfo(id, 17) then
         ColourNote ("white", "green", "Success!") 
      else
         ColourNote ("white", "red", string.rep ("-", 80))
         ColourNote ("white", "red", "Plugin '" .. name .. "' not enabled. Please make sure it can be enabled.")
         ColourNote ("white", "red", "It is required for the correct operation of the " ..
                    GetPluginName () .. " plugin.")
         ColourNote ("white", "red", string.rep ("-", 80))        
      end
   end
end -- do_plugin_check_now
Amended on Sat 28 May 2011 06:05 PM by Fiendish
Nick Gammon Australia Forum Administrator #1
Good idea (I think). I have made a few more improvements too, as follows:


function do_plugin_check_now (id, name)

  local me
  local location
  
  -- allow for being called from main world script
  if GetPluginID () == "" then
    me = "world script"
    location = GetInfo (60)
  else
    me = GetPluginName () .. " plugin"
    location =  GetPluginInfo(GetPluginID (), 20)
  end -- if
 
  -- first check if installed
  if not IsPluginInstalled (id) then
    ColourNote ("white", "green", "Plugin '" .. name .. "' not installed. Attempting to install it...") 
    LoadPlugin (location .. name .. ".xml") 
  
    if IsPluginInstalled (id) then
      ColourNote ("white", "green", "Success!") 
    else      
      ColourNote ("white", "red", string.rep ("-", 80))
      ColourNote ("white", "red", "Plugin '" .. name .. "' not installed. Please download and install it.") 
      ColourNote ("white", "red", "It is required for the correct operation of the " .. me)
      ColourNote ("white", "red", string.rep ("-", 80))
    end -- if not installed
  end -- plugin was not installed

  -- now make sure enabled (suggested by Fiendish - version 4.74+ )
  
  if not GetPluginInfo(id, 17) then
      ColourNote ("white", "green", "Plugin '" .. name .. "' not enabled. Attempting to enable it...")
      EnablePlugin(id, true)
      if GetPluginInfo(id, 17) then
         ColourNote ("white", "green", "Success!") 
      else
         ColourNote ("white", "red", string.rep ("-", 80))
         ColourNote ("white", "red", "Plugin '" .. name .. "' not enabled. Please make sure it can be enabled.")
         ColourNote ("white", "red", "It is required for the correct operation of the " .. me)
         ColourNote ("white", "red", string.rep ("-", 80))        
      end -- if
   end  -- if not enabled
   
end -- do_plugin_check_now


function checkplugin (id, name)

  if GetOption ("enable_timers") ~= 1 then
    ColourNote ("white", "red", "WARNING! Timers not enabled. Plugin dependency checks will not work properly.")
  end -- if timers disabled

  -- give them time to load
  DoAfterSpecial (2, 
                  "do_plugin_check_now ('" .. id .. "', '" .. name .. "')", 
                  sendto.script)
end -- checkplugin


Since checkplugin requires timers to be active, it checks for that. Also do_plugin_check_now will now work from the main script as well as plugins.
Nick Gammon Australia Forum Administrator #2
Actually your version has a bug. You are checking if it is enabled, even if the install fails. It should read:


function do_plugin_check_now (id, name)

  local me
  local location
  
  -- allow for being called from main world script
  if GetPluginID () == "" then
    me = "world script"
    location = GetInfo (60)
  else
    me = GetPluginName () .. " plugin"
    location =  GetPluginInfo(GetPluginID (), 20)
  end -- if
 
  -- first check if installed
  if not IsPluginInstalled (id) then
    ColourNote ("white", "green", "Plugin '" .. name .. "' not installed. Attempting to install it...") 
    LoadPlugin (location .. name .. ".xml") 
  
    if IsPluginInstalled (id) then
      ColourNote ("white", "green", "Success!") 
      
       -- now make sure enabled (suggested by Fiendish - version 4.74+ )
  
      if not GetPluginInfo(id, 17) then
          ColourNote ("white", "green", "Plugin '" .. name .. "' not enabled. Attempting to enable it...")
          EnablePlugin(id, true)
          if GetPluginInfo(id, 17) then
             ColourNote ("white", "green", "Success!") 
          else
             ColourNote ("white", "red", string.rep ("-", 80))
             ColourNote ("white", "red", "Plugin '" .. name .. "' not enabled. Please make sure it can be enabled.")
             ColourNote ("white", "red", "It is required for the correct operation of the " .. me)
             ColourNote ("white", "red", string.rep ("-", 80))        
          end -- if
       end  -- if not enabled
   
    -- here if still not installed
    else      
      ColourNote ("white", "red", string.rep ("-", 80))
      ColourNote ("white", "red", "Plugin '" .. name .. "' not installed. Please download and install it.") 
      ColourNote ("white", "red", "It is required for the correct operation of the " .. me)
      ColourNote ("white", "red", string.rep ("-", 80))
    end -- if not installed
  end -- plugin was not installed
   
end -- do_plugin_check_now

Fiendish USA Global Moderator #3
Quote:

Actually your version has a bug. You are checking if it is enabled, even if the install fails.

Err, I don't think so. My version has a return if the plugin isn't installed and trying to install it fails.
Amended on Sun 29 May 2011 02:00 AM by Fiendish
Nick Gammon Australia Forum Administrator #4
Oh, right. I meant *my* "improved" version has a bug. ;)