l3build-install.lua

--[[

File l3build-install.lua Copyright (C) 2018-2024 The LaTeX Project

It may be distributed and/or modified under the conditions of the
LaTeX Project Public License (LPPL), either version 1.3c of this
license or (at your option) any later version.  The latest version
of this license is in the file

   https://www.latex-project.org/lppl.txt

This file is part of the "l3build bundle" (The Work in LPPL)
and all files in that bundle must be distributed together.

-----------------------------------------------------------------------

The development version of the bundle can be found at

   https://github.com/latex3/l3build

for those people who are interested.

--]]

local ipairs = ipairs
local pairs  = pairs
local print  = print

local set_program = kpse.set_program_name
local var_value   = kpse.var_value

local gsub  = string.gsub
local lower = string.lower
local match = string.match

local insert = table.insert

local function gethome()
  set_program("latex")
  local result = options["texmfhome"] or var_value("TEXMFHOME")
  if not result or result == "" or match(result, os_pathsep) then
    print("Ambiguous TEXMFHOME setting: please use the --texmfhome option")
    os.exit(1)
  end
  mkdir(result)
  return abspath(result)
end

function uninstall()
  local function zapdir(dir)
    local installdir = gethome() .. "/" .. dir
    if options["dry-run"] then
      local files = filelist(installdir)
      if files[1] then
        print("\n" .. "For removal from " .. installdir .. ":")
        for _,file in ipairs(ordered_filelist(installdir)) do
          print("- " .. file)
        end
      end
      return 0
    else
      if direxists(installdir) then
        return rmdir(installdir)
      end
    end
    return 0
  end
  local function uninstall_files(dir,subdir)
    subdir = subdir or moduledir
    dir = dir .. "/" .. subdir
    return zapdir(dir)
  end
  local errorlevel = 0
  -- Any script man files need special handling
  local manfiles = { }
  for _,glob in pairs(scriptmanfiles) do
    for _,p in ipairs(tree(docfiledir,glob)) do
      -- Man files should have a single-digit extension: the type
      local installdir = gethome() .. "/doc/man/man"  .. match(p.src,".$")
      if fileexists(installdir .. "/" .. p.src) then
        if options["dry-run"] then
          insert(manfiles,"man" .. match(p.src,".$") .. "/" ..
           select(2,splitpath(p.src)))
        else
          errorlevel = errorlevel + rm(installdir,p.src)
        end
      end
    end
  end
  if next(manfiles) then
    print("\n" .. "For removal from " .. gethome() .. "/doc/man:")
    for _,v in ipairs(manfiles) do
      print("- " .. v)
    end
  end
  errorlevel = uninstall_files("doc")
         + uninstall_files("source")
         + uninstall_files("tex")
         + uninstall_files("bibtex/bst",module)
         + uninstall_files("makeindex",module)
         + uninstall_files("scripts",module)
         + errorlevel
  if errorlevel ~= 0 then return errorlevel end
  -- Finally, clean up special locations
  for _,location in ipairs(tdslocations) do
    local path = dirname(location)
    errorlevel = zapdir(path)
    if errorlevel ~= 0 then return errorlevel end
  end
  -- We remove all directories which contain at least one ordinary file in the source tree
  for src, dest in pairs(tdsdirs) do
    dest = dest .. '/'
    local skipdir
    for _, p in ipairs(tree(src, '**')) do
      local src = p.src:sub(2) -- Skip the first '.'
      if skipdir and src:sub(1, #skipdir) ~= skipdir then
        skipdir = nil
      end
      if (not skipdir) and (not direxists(p.cwd)) then
        skipdir = dirname(src)
        errorlevel = zapdir(dest .. skipdir)
        if errorlevel ~= 0 then return errorlevel end
        skipdir = skipdir .. '/'
      end
    end
  end
  return 0
end

function install_files(target,full,dry_run)

  -- Needed so paths are only cleaned out once
  local cleanpaths = { }
  -- Collect up all file data before copying:
  -- ensures no files are lost during clean-up
  local installmap = { }

  local function create_install_map(source,dir,files,subdir)
    subdir = subdir or moduledir
    -- For material associated with secondary tools (BibTeX, MakeIndex)
    -- the structure needed is slightly different from those items going
    -- into the tex/doc/source trees
    if (dir == "makeindex" or match(dir,"$bibtex")) and module == "base" then
      subdir = "latex"
    end
    dir = dir .. (subdir and ("/" .. subdir) or "")
    local filenames = { }
    local sourcepaths = { }
    local paths = { }
    -- Generate a file list and include the directory
    for _,glob_table in pairs(files) do
      for _,glob in pairs(glob_table) do
        for _,p in ipairs(tree(source,glob)) do
          -- Just want the name
          local path,filename = splitpath(p.src)
          local sourcepath = "/"
          if path == "." then
            sourcepaths[filename] = source
          else
            path = gsub(path,"^%.","")
            sourcepaths[filename] = source .. path
            if not flattentds then sourcepath = path .. "/" end
          end
          local matched = false
          for _,location in ipairs(tdslocations) do
            local l_dir,l_glob = splitpath(location)
            local pattern = glob_to_pattern(l_glob)
            if match(filename,pattern) then
              insert(paths,l_dir)
              insert(filenames,l_dir .. sourcepath .. filename)
              matched = true
              break
            end
          end
          if not matched then
            insert(paths,dir)
            insert(filenames,dir .. sourcepath .. filename)
          end
        end
      end
    end

    local errorlevel = 0
    -- The target is only created if there are actual files to install
    if next(filenames) then
      if not dry_run then
        for _,path in ipairs(paths) do
          local target_path = target .. "/" .. path
          if not cleanpaths[target_path] then
            errorlevel = cleandir(target_path)
            if errorlevel ~= 0 then return errorlevel end
          end
          cleanpaths[target_path] = true
        end
      end
      for _,name in ipairs(filenames) do
        if dry_run then
          print("- " .. name)
        else
          local path,file = splitpath(name)
          insert(installmap,
            {file = file, source = sourcepaths[file], dest = target .. "/" .. path})
        end
      end
    end
    return 0
  end

  local errorlevel = unpack()
  if errorlevel ~= 0 then return errorlevel end

    -- Creates a 'controlled' list of files
    local function create_file_list(dir,include,exclude)
      dir = dir or currentdir
      include = include or { }
      exclude = exclude or { }
      insert(exclude,excludefiles)
      local excludelist = { }
      for _,glob_table in pairs(exclude) do
        for _,glob in pairs(glob_table) do
          for _,p in ipairs(tree(dir,glob)) do
            excludelist[p.src] = true
          end
        end
      end
      local result = { }
      for _,glob in pairs(include) do
        for _,p in ipairs(tree(dir,glob)) do
          if not excludelist[p.src] then
            insert(result, p.src)
          end
        end
      end
      return result
    end

  local installlist = create_file_list(unpackdir,installfiles,{scriptfiles})

  if full then
    errorlevel = doc()
    if errorlevel ~= 0 then return errorlevel end
    -- For the purposes here, any typesetting demo files need to be
    -- part of the main typesetting list
    local typesetfiles = typesetfiles
    for _,glob in pairs(typesetdemofiles) do
      insert(typesetfiles,glob)
    end

    -- Find PDF files
    pdffiles = { }
    for _,glob in pairs(typesetfiles) do
      insert(pdffiles,(gsub(glob,"%.%w+$",".pdf")))
    end

    -- Set up lists: global as they are also needed to do CTAN releases
    typesetlist = create_file_list(docfiledir,typesetfiles,{sourcefiles})
    sourcelist = create_file_list(sourcefiledir,sourcefiles,
      {bstfiles,installfiles,makeindexfiles,scriptfiles})

  if dry_run then
    print("\nFor installation inside " .. target .. ":")
  end

    errorlevel = create_install_map(sourcefiledir,"source",{sourcelist})
      + create_install_map(docfiledir,"doc",
          {bibfiles,demofiles,docfiles,pdffiles,textfiles,typesetlist})
    if errorlevel ~= 0 then return errorlevel end

    -- Rename README if necessary
    if not dry_run then
      if ctanreadme ~= "" and not match(lower(ctanreadme),"^readme%.%w+") then
        local installdir = target .. "/doc/" .. moduledir
        if fileexists(installdir .. "/" .. ctanreadme) then
          ren(installdir,ctanreadme,"README." .. match(ctanreadme,"%.(%w+)$"))
        end
      end
    end

    -- Any script man files need special handling
    local manfiles = { }
    for _,glob in pairs(scriptmanfiles) do
      for _,p in ipairs(tree(docfiledir,glob)) do
        if dry_run then
          insert(manfiles,"man" .. match(p.src,".$") .. "/" ..
            select(2,splitpath(p.src)))
        else
          -- Man files should have a single-digit extension: the type
          local installdir = target .. "/doc/man/man"  .. match(p.src,".$")
          errorlevel = errorlevel + mkdir(installdir)
          errorlevel = errorlevel + cp(p.src,docfiledir,installdir)
        end
      end
    end
    if next(manfiles) then
      for _,v in ipairs(manfiles) do
        print("- doc/man/" .. v)
      end
    end
  end

  if errorlevel ~= 0 then return errorlevel end

  errorlevel = create_install_map(unpackdir,"tex",{installlist})
    + create_install_map(unpackdir,"bibtex/bst",{bstfiles},module)
    + create_install_map(unpackdir,"makeindex",{makeindexfiles},module)
    + create_install_map(unpackdir,"scripts",{scriptfiles},module)

  for src, dest in pairs(tdsdirs) do
    dest = target .. '/' .. dest
    insert(installmap,
      {file = '*', source = src, dest = dest})
    dest = dest .. '/'
    local skipdir
    for _, p in ipairs(tree(src, '**')) do
      local src = p.src:sub(2) -- Skip the first '.'
      if skipdir and src:sub(1, #skipdir) ~= skipdir then
        skipdir = nil
      end
      if (not skipdir) and (not direxists(p.cwd)) then
        skipdir = dirname(src)
        errorlevel = cleandir(dest .. skipdir)
        if errorlevel ~= 0 then return errorlevel end
        skipdir = skipdir .. '/'
      end
    end
  end

  if errorlevel ~= 0 then return errorlevel end

  -- Track created destination directories to avoid overhead from
  -- repeatedly creating them
  local destination_dirs = {}

  -- Files are all copied in one shot: this ensures that cleandir()
  -- can't be an issue even if there are complex set-ups
  for _,v in ipairs(installmap) do
    if not destination_dirs[v.dest] then
      mkdir(v.dest)
      destination_dirs[v.dest] = true
    end
    errorlevel = cp(v.file,v.source,v.dest)
    if errorlevel ~= 0  then return errorlevel end
  end

  return 0
end

function install()
  return install_files(gethome(),options["full"],options["dry-run"])
end