add some nil checks, and make lssi work with eatit changes

- add name expansion gh:po5/thumbfast -> https://github.com/po5/thumbfast
- allow multiple files to be downloaded to one dir
- add pin option to stop updates on specific plugins

README.md

@@ -3,25 +3,21 @@ Eat It is a plugin manager for mpv which allows you to declare what files you
 want from git repos.
 
 ## Installing Eat It
-To install Eat It simply put the `eatit.lua` file into your mpv scripts
-directory (~/.config/mpv/scripts by default on linux). After you have done that
-Eat It is installed, however it won't do anything without the `eatit-cfg.lua`,
-which has to be placed in the root of your mpv config dir (~/.config/mpv by
-default on linux).
 
-Alternatively you can run these two commands:
-```sh
-curl -L https://git.squi.bid/eat-it/plain/eatit.lua -o ~/.config/mpv/scripts/eatit.lua
-curl -L https://git.squi.bid/eat-it/plain/eatit-cfg.lua -o ~/.config/mpv/eatit-cfg.lua
-```
+### First time
+To install eatit run these two commands [Make sure you know what it does](https://explainshell.com/explain?cmd=curl+-L+https%3A%2F%2Fgit.squi.bid%2Feat-it%2Fplain%2Featit.lua+-o+~%2F.config%2Fmpv%2Fscripts%2Featit.lua+curl+-L+https%3A%2F%2Fgit.squi.bid%2Feat-it%2Fplain%2Featit-cfg.lua+-o+~%2F.config%2Fmpv%2Featit-cfg.lua):
+  
+curl -L https://git.squi.bid/eat-it/plain/eatit.lua -o ~/.config/mpv/scripts/eatit.lua  
+curl -L https://git.squi.bid/eat-it/plain/eatit-cfg.lua -o ~/.config/mpv/eatit-cfg.lua  
 
+### Bootstraping
+The included bootstrap script will install and load eatit as soon as mpv starts.
 ## FAQ
 Q: Where does the name 'Eat It' come from?  
 A: The plugin manager eats all the useless files and keeps the ones you want,
 *and Weird Al is a funny guy*  
 
 ## TODO
-- make an auto install script that can be put into a mpv config
 
 ## ALTERNATIVES
 [email me](mailto:me@zacharyscheiman.com) if you know of any alternatives

bootstrap.lua

@@ -0,0 +1,8 @@
+os.execute('git clone https://git.squi.bid/eat-it /tmp/eatit-tmp')
+local a = io.open('/tmp/eatit-tmp/eatit.lua', 'r')
+local b = io.open(mp.command_native({'expand-path', '~~/scripts/eatit.lua'}), 'w')
+b:write(a:read('*a'))
+b:close()
+a:close()
+dofile(mp.command_native({'expand-path', '~~/scripts/eatit.lua'}))
+os.execute('rm -rf /tmp/eatit-tmp')

eatit-cfg.lua

@@ -18,10 +18,36 @@ GNU General Public License for more details.
 -- after being called with dofile()
 
 plugins = { -- the  plugins you want to load
-  { 'https://git.squi.bid/eat-it', -- required, specifies the git repo
-    file = 'eatit.lua', -- required, specifies the desired file
-    dir = 'scripts', -- optional, sets the dest dir
-    branch = 'master', -- optional, sets the desired branch
+  { 'squibid/eat-it', -- required, specifies the git repo
+    -- optional, sets repo link (see advanced example for more info on how to 
+    -- use this)
+    url = 'https://git.squi.bid/eat-it',
+
+    -- required, specifies the desired file from the git repo
+    file = 'eatit.lua',
+
+    -- optional, sets the destination of the requested file
+    dir = 'scripts',
+
+    -- optional, sets the desired branch of the git repo
+    branch = 'master',
+
+    -- optional, stop the plugin from being updated
+    pin = false,
+  },
+
+  -- advanced example
+  { 'gh:po5/thumbfast', -- expands to https://github.com/po5/thumbfast
+    file = { -- multiple files all going to the same place
+      'thumbfast.lua',
+      'osc.lua'
+    },
+    branch = 'ancient',
+    --[[
+    no need to specify dir as it defaults to ~~/scripts
+    no need to specify url as it is extrapolated from name
+    name expansion can be configured in the opts section
+    ]]
   },
 }
 
@@ -35,6 +61,16 @@ opts = {
   },
   dl = { -- options for dealing with the git repos
     dir = '/tmp/mpv-eatit',
-    powerwash = false, -- if true the dl dir gets deleted after mpv closes
+    powerwash = false, -- if true the download dir gets deleted after mpv closes
+  },
+  nameexp = {
+    pre = 'https://',
+    map = {
+      -- shortcut = link
+      gl = 'gitlab.com',
+      cb = 'codeberg.org',
+      sr = 'sr.ht',
+      gh = 'github.com'
+    }
   }
 }

eatit.lua

@@ -27,14 +27,14 @@ local function tablelength(T)
 end
 
 local function fileexists(name)
-   local ok, err, code = os.rename(name, name)
-   if not ok then
-      if code == 13 then
-         -- Permission denied, but it exists
-         return true
-      end
-   end
-   return ok, err
+  local ok, err, code = os.rename(name, name)
+  if not ok then
+    if code == 13 then
+      -- Permission denied, but it exists
+      return true
+    end
+  end
+  return ok, err
 end
 
 local function testforslash(str)
@@ -47,24 +47,55 @@ end
 
 local function run(cmd)
   local x = io.popen(cmd)
+  if not x then return 1 end
   local y = x:read("*a")
   x:close()
   return y
 end
 
+local function cp(a, b)
+  local i = io.open(a, 'r')
+  if not i then return 1 end
+  local o = io.open(b, 'w')
+  if not o then return 2 end
+  o:write(i:read('*a'))
+  o:close()
+  i:close()
+end
+
+local function getsrc(id)
+  local src
+  if string.find(id, ":") then src = id:match("^[a-z]+[^:]") end
+  local name = id:match([[[^:]*$]])
+  if name then
+    local pre = opts.nameexp.pre or "https://"
+    local map = opts.nameexp.map or {
+      gl = 'gitlab.com',
+      cb = 'codeberg.org',
+      sr = 'sr.ht',
+      gh = 'github.com'
+    }
+    return {
+      link = (pre..map[src]) or false,
+      repo = name
+    }
+  end
+end
+
 local function openlog()
   if opts.logging.log then -- log if asked to
     -- get our logfile's full path
     fn = mp.command_native({'expand-path', opts.logging.logfile})
 
     f = io.open(fn, 'a') -- open file buffer
+    if not f then return 1 end
     io.output(f) -- set it as default
   end
 end
 
 local function logwrite(string)
   if opts.logging.log then
-    io.write(os.date(opts.logging.logdate) .. ' ' .. string .. '\n')
+    io.write(os.date(opts.logging.logdate)..' '..string..'\n')
   end
 end
 
@@ -75,100 +106,106 @@ local function closelog()
 end
 
 -- get the requested git repos
-local function clonegit(plugdir, i)
-  logwrite('downloading ' .. plugins[i][1])
+local function clonegit(plugdir, url, branch)
+  logwrite('downloading '..url)
 
   -- clone the repo
-  -- BUG: logwriting the git command doens't actually log the output
-  run('git -C ' .. opts.dl.dir .. ' clone ' .. plugins[i][1])
-  run('git -C ' .. plugdir .. ' checkout -q ' .. plugins[i]['branch'])
+  -- BUG: logwriting the git command doesn't actually log the output
+  run('git -C '..opts.dl.dir..' clone '..url..' '..plugdir)
+  run('git -C '..plugdir..' checkout -q '..branch)
 end
 
 -- check for updates
 local function checkupdates(plugdir)
-  local localhash = run('git -C ' .. plugdir .. ' log -1 --format=format:"%H"')
-  local remotehash = run('git -C ' .. plugdir .. ' rev-parse $(git -C ' ..
-    plugdir .. ' branch -r) | tail -1')
+  local localhash = run('git -C '..plugdir..' log -1 --format=format:"%H"')
+  local remotehash = run('git -C '..plugdir..' rev-parse $(git -C '..
+    plugdir..' branch -r) | tail -1')
   if localhash ~= remotehash then return true else return false end
 end
 
 -- start install
-local function startinstall()
-  -- let the user know that we are starting install
-  logwrite('Starting Download...')
-  mp.osd_message('Downloading plugins!')
+local function startinstall(i)
+  local src = getsrc(plugins[i][1])
+  local plugin = { -- plugin table spec
+    id = plugins[i][1] or false,
+    url = plugins[i]['url'] or (src['link'].."/"..src['repo']),
+    file = plugins[i]['file'] or false,
+    dir = plugins[i]['dir'] or 'scripts',
+    pin = plugins[i]['pin'] or false,
+    branch = plugins[i]['branch'] or false,
+  }
 
-  -- start iterating through plugins
-  for i = 1, tablelength(plugins) do
-    -- check if the user has defined a file for the current plugin
-    if not plugins[i]['file'] then
-      logwrite('WARNING! Git repo "' .. plugins[i][1] ..
-        '" doesn\'t have a specified file. Skipping download')
+  -- check if the user has defined a file for the current plugin
+  if not plugin['file'] then
+    logwrite('WARNING! File not configured for '..plugin[1])
+    goto continue
+  end
+  -- skip install of pinned files
+  if plugin['pin'] == true then goto continue end
 
-      -- FIXME: this results in the last plugin being downloaded & copied twice
-      i = i + 1 -- if not we go to the next plugin
-    end
+  -- get the plugins tmp download dir
+  local plugdir = opts.dl.dir..'/'..testforslash(src['repo']):gsub('.git', '')
 
-    -- if no destdir defined we set it to the root of the mpv config dir
-    if not plugins[i]['dir'] then
-      plugins[i]['dir'] = '~~/'
-    end
+  -- if no specified branch we use the default
+  plugin['branch'] = plugin['branch'] or testforslash(
+    run('git -C '..plugdir..' symbolic-ref refs/remotes/origin/HEAD')
+  )
 
-    -- get the plugins tmp download dir
-    local plugdir = opts.dl.dir .. '/' ..
-      string.match(plugins[i][1], '/([^/]+)$'):gsub('.git', '')
-
-    -- if no specified branch we use the default
-    if not plugins[i]['branch'] then
-      plugins[i]['branch'] = testforslash(
-        run('git -C ' .. plugdir .. ' symbolic-ref refs/remotes/origin/HEAD')
-      )
-    end
+  -- check for multiple files
+  if type(plugin['file']) == 'string' then
+    plugin['file'] = {}
+    table.insert(plugin['file'], plugins[i]['file'])
+  end
 
+  -- get the requested file(s)
+  for j = 1, #plugin['file'] or 1 do
     -- get the file's dir
-    local pluginfile = opts.dl.dir .. '/' ..
-      string.match(plugins[i][1], '/([^/]+)$'):gsub('.git', '') ..
-      '/' .. plugins[i]['file']
+    local pluginfile = plugdir..'/'..plugin['file'][j]
 
     -- get the dest dir
-    local destfile = mp.command_native({'expand-path', '~~/'}) ..
-      '/' .. plugins[i]['dir'] ..
-      '/' .. testforslash(plugins[i]['file'])
+    local destfile = mp.command_native({'expand-path', '~~/'})..
+      '/'..plugin['dir']..'/'..testforslash(plugin['file'][j])
 
-    if fileexists(plugdir .. '/') then
+    if fileexists(plugdir..'/') then
       -- if we need to update, update
       if checkupdates(plugdir) then
-        logwrite(plugins[i]['file'] .. ' is updating.')
+        logwrite(plugin['file'][j]..' is updating.')
         -- make sure we are on the main branch
-        run('git -C ' .. plugdir .. ' checkout -q ' .. plugins[i]['branch'])
-        run('git -C ' .. plugdir .. ' pull') -- get the latest commits
+        run('git -C '..plugdir..' checkout -q '..plugin['branch'])
+        run('git -C '..plugdir..' pull') -- get the latest commits
       else
-        logwrite(plugins[i]['file'] .. ' is up to date!')
+        logwrite(plugin['file'][j]..' is up to date!')
       end
     else
-      clonegit(plugdir, i)
+      clonegit(plugdir, plugin['url'], plugin['branch'])
     end
 
     -- copy the file contents over to the desired location
-    local infile = io.open(pluginfile, 'r')
-    local outfile = io.open(destfile, 'w')
-    outfile:write(infile:read('*a'))
-    outfile:close()
-    infile:close()
+    cp(pluginfile, destfile)
   end
+  ::continue::
 end
 
 local function initupdate()
   openlog()
 
-  logwrite('# of plugins defined in table: ' .. tablelength(plugins))
-  os.execute('mkdir -p ' .. opts.dl.dir) -- make download dir
-  startinstall()
+  logwrite('# of plugins defined in table: '..tablelength(plugins))
+  os.execute('mkdir -p '..opts.dl.dir) -- make download dir
+
+  -- start the install process
+  logwrite('Starting Download...')
+  mp.osd_message('Downloading plugins!')
+
+  -- start iterating through plugins
+  for i = 1, tablelength(plugins) do
+    local f = coroutine.create(function() startinstall(i) end)
+    coroutine.resume(f)
+  end
 
   -- closing/removing everything
   if opts.dl.powerwash == true then
-    logwrite('powerwashing the tmp dir "' .. opts.dl.dir .. '"')
-    os.execute('rm -rf ' .. opts.dl.dir)
+    logwrite('powerwashing the tmp dir "'..opts.dl.dir..'"')
+    os.execute('rm -rf '..opts.dl.dir)
   end
 
   closelog()

modules/lssi/lssi.lua

@@ -27,7 +27,7 @@ Takes an input file and code then, it outputs a file with your code in there.
 local mp = require('mp')
 
 mod = {
-  version = 'ALPHA 1', -- the current version of lssi
+  version = 'ALPHA 1.1', -- the current version of lssi
   author = 'squibid',
 }
 
@@ -48,7 +48,7 @@ end
 
 local function logwrite(string)
   if opts.logging.log then
-    io.write(os.date(opts.logging.logdate) .. ' ' .. string .. '\n')
+    io.write(os.date(opts.logging.logdate)..' '..string..'\n')
   end
 end
 
@@ -58,6 +58,7 @@ local function openlog()
     fn = mp.command_native({'expand-path', opts.logging.logfile})
 
     f = io.open(fn, 'a') -- open file buffer
+    if not f then return end
     io.output(f) -- set it as default
   end
 end
@@ -78,28 +79,28 @@ local function inject(infile, l, outfile)
 
   -- don't do anything if there is already code injected into the file
   if string.find(infcont[1], "-- code injected by lssi") then
-    logwrite('code is already injected into ' .. infile)
+    logwrite('code is already injected into '..infile)
     return
   end
-  logwrite('Injecting code into ' .. infile)
+  logwrite('Injecting code into '..infile)
 
   for i in pairs(l) do
     -- add requested line below existing line
     if l[i][2] == 'G' then
-      infcont[tablelength(infcont)] = infcont[tablelength(infcont)] .. '\n' .. l[i][1]
+      infcont[tablelength(infcont)] = infcont[tablelength(infcont)]..'\n'..l[i][1]
     elseif l[i][2] == 'g' then
-      infcont[1] = l[i][1] .. '\n' .. infcont[1]
+      infcont[1] = l[i][1]..'\n'..infcont[1]
     else
-      infcont[l[i][2]] = (infcont[l[i][2]]) .. '\n' .. l[i][1]
+      infcont[l[i][2]] = (infcont[l[i][2]])..'\n'..l[i][1]
     end
   end
 
   local outf = io.open(outfile, 'w')
 
   -- we inject metadata to prevent writing to the file more than once
-  infcont[1] = "-- code injected by lssi " .. mod.version .. '\n' .. infcont[1]
+  infcont[1] = "-- code injected by lssi "..mod.version..'\n'..infcont[1]
   for i, v in ipairs(infcont) do
-    outf:write(v .. '\n')
+    outf:write(v..'\n')
   end
 
   io.close(outf)
@@ -109,20 +110,19 @@ local function checkandinject()
   openlog()
 
   for i = 1, tablelength(plugins) do
-    -- get the file we want to inject our code into
-    local f = mp.command_native({'expand-path', '~~/'}) ..
-      '/' .. plugins[i]['dir'] ..
-      '/' .. plugins[i]['file']
-
     -- check if the plugin has been configured with lssi
-    if plugins[i]['lssi'] then
+    if plugins[i]['lssi'] ~= nil then
+      -- get the file we want to inject our code into
+      local f = mp.command_native({'expand-path', '~~/'}) ..
+        '/'..(plugins[i]['dir'] or 'scripts') ..
+        '/'..plugins[i]['file']
       -- and the file we are trying to modify actually exists
       if fileexists(f) then
         -- inject it! no going back now
         inject(f, plugins[i]['lssi'], f)
       else
         logwrite('Failed to inject code into "' ..
-          plugins[i]['file'] .. '" file does not exist')
+          plugins[i]['file']..'" file does not exist')
       end
     end
   end