contrib/dbmaint - backported to API-9.2.0. Script to perform database

maintenance by removing database entries for missing
                  filmrolls and images.

contrib/cycle_group_leader.lua

@@ -0,0 +1,158 @@
+--[[
+
+    cycle_group_leader.lua - change image grouip leader
+
+    Copyright (C) 2024 Bill Ferguson <wpferguson@gmail.com>
+
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation; either version 3 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+]]
+--[[
+    cycle_group_leader - change image grouip leader
+
+    cycle_group_leader changes the group leader to the next
+    image in the group.  If the end of the group is reached
+    then the next image is wrapped around to the first image.
+
+    ADDITIONAL SOFTWARE NEEDED FOR THIS SCRIPT
+    None
+
+    USAGE
+    * enable with script_manager
+    * assign a key to the shortcut
+
+    BUGS, COMMENTS, SUGGESTIONS
+    Bill Ferguson <wpferguson@gmail.com>
+
+    CHANGES
+]]
+
+local dt = require "darktable"
+local du = require "lib/dtutils"
+local df = require "lib/dtutils.file"
+
+-- - - - - - - - - - - - - - - - - - - - - - - - 
+-- C O N S T A N T S
+-- - - - - - - - - - - - - - - - - - - - - - - - 
+
+local MODULE = "cycle_group_leader"
+
+-- - - - - - - - - - - - - - - - - - - - - - - - 
+-- A P I  C H E C K
+-- - - - - - - - - - - - - - - - - - - - - - - - 
+
+du.check_min_api_version("7.0.0", MODULE) 
+
+
+-- - - - - - - - - - - - - - - - - - - - - - - - - -
+-- S C R I P T  M A N A G E R  I N T E G R A T I O N
+-- - - - - - - - - - - - - - - - - - - - - - - - - -
+
+local script_data = {}
+
+script_data.destroy = nil -- function to destory the script
+script_data.destroy_method = nil -- set to hide for libs since we can't destroy them commpletely yet
+script_data.restart = nil -- how to restart the (lib) script after it's been hidden - i.e. make it visible again
+script_data.show = nil -- only required for libs since the destroy_method only hides them
+
+-- - - - - - - - - - - - - - - - - - - - - - - - - -
+-- I 1 8 N
+-- - - - - - - - - - - - - - - - - - - - - - - - - -
+
+local gettext = dt.gettext
+
+-- Tell gettext where to find the .mo file translating messages for a particular domain
+gettext.bindtextdomain(MODULE, dt.configuration.config_dir .. "/lua/locale/")
+
+local function _(msgid)
+    return gettext.dgettext(MODULE, msgid)
+end
+
+-- - - - - - - - - - - - - - - - - - - - - - - - 
+-- F U N C T I O N S
+-- - - - - - - - - - - - - - - - - - - - - - - - 
+
+local function toggle_global_toolbox_grouping()
+  dt.gui.libs.global_toolbox.grouping = false
+  dt.gui.libs.global_toolbox.grouping = true
+end
+
+local function hinter_msg(msg)
+  dt.print_hinter(msg)
+  dt.control.sleep(1500)
+  dt.print_hinter(" ")
+end
+
+-- - - - - - - - - - - - - - - - - - - - - - - - 
+-- M A I N  P R O G R A M
+-- - - - - - - - - - - - - - - - - - - - - - - - 
+
+local function cycle_group_leader(image)
+  local group_images = image:get_group_members()
+  if #group_images < 2 then
+    hinter_msg(_("No images to cycle to in group"))
+    return
+  else
+    local position = nil
+    for i, img in ipairs(group_images) do
+      if image == img then
+        position = i
+      end
+    end
+
+    if position == #group_images then
+      position = 1
+    else
+      position = position + 1
+    end
+
+    new_leader = group_images[position]
+    new_leader:make_group_leader()
+    dt.gui.selection({new_leader})
+
+    if dt.gui.libs.global_toolbox.grouping then
+      -- toggle the grouping to make the new leader show
+      toggle_global_toolbox_grouping()
+    end
+  end
+end
+
+-- - - - - - - - - - - - - - - - - - - - - - - - 
+-- D A R K T A B L E  I N T E G R A T I O N 
+-- - - - - - - - - - - - - - - - - - - - - - - - 
+
+local function destroy()
+  -- put things to destroy (events, storages, etc) here
+  dt.destroy_event(MODULE, "shortcut")
+end
+
+script_data.destroy = destroy
+
+-- - - - - - - - - - - - - - - - - - - - - - - - 
+-- E V E N T S
+-- - - - - - - - - - - - - - - - - - - - - - - - 
+
+dt.register_event(MODULE, "shortcut",
+  function(event, shortcut)
+    -- ignore the film roll, it contains all the images, not just the imported
+    local images = dt.gui.selection()
+    if #images < 1 then
+      dt.print(_("No image selected.  Please select an image and try again"))
+    else
+      cycle_group_leader(images[1])
+    end
+  end,
+  _("cycle group leader")
+)
+
+return script_data

contrib/dbmaint.lua

@@ -0,0 +1,314 @@
+--[[
+
+    dbmaint.lua - perform database maintenance
+
+    Copyright (C) 2024 Bill Ferguson <wpferguson.com>.
+
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation; either version 3 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+]]
+--[[
+    dbmaint - perform database maintenance
+
+    Perform database maintenance to clean up missing images and filmstrips.
+
+    ADDITIONAL SOFTWARE NEEDED FOR THIS SCRIPT
+    None
+
+    USAGE
+    * start dbmaint from script_manager
+    * scan for missing film rolls or missing images
+    * look at the results and choose to delete or not
+
+    BUGS, COMMENTS, SUGGESTIONS
+    Bill Ferguson <wpferguson.com>
+
+    CHANGES
+]]
+
+local dt = require "darktable"
+local du = require "lib/dtutils"
+local df = require "lib/dtutils.file"
+local log = require "lib/dtutils.log"
+
+
+-- - - - - - - - - - - - - - - - - - - - - - - - 
+-- C O N S T A N T S
+-- - - - - - - - - - - - - - - - - - - - - - - - 
+
+local MODULE <const> = "dbmaint"
+local DEFAULT_LOG_LEVEL <const> = log.error
+local PS <const> = dt.configuration.running_os == "windows" and "\\" or "/"
+
+-- - - - - - - - - - - - - - - - - - - - - - - - 
+-- A P I  C H E C K
+-- - - - - - - - - - - - - - - - - - - - - - - - 
+
+du.check_min_api_version("7.0.0", MODULE)   -- choose the minimum version that contains the features you need
+
+
+-- - - - - - - - - - - - - - - - - - - - - - - - - -
+-- I 1 8 N
+-- - - - - - - - - - - - - - - - - - - - - - - - - -
+
+local gettext = dt.gettext.gettext
+
+dt.gettext.bindtextdomain(MODULE , dt.configuration.config_dir .. "/lua/locale/")
+
+local function _(msgid)
+    return gettext(MODULE, msgid)
+end
+
+
+-- - - - - - - - - - - - - - - - - - - - - - - - - -
+-- S C R I P T  M A N A G E R  I N T E G R A T I O N
+-- - - - - - - - - - - - - - - - - - - - - - - - - -
+
+local script_data = {}
+
+script_data.destroy = nil           -- function to destory the script
+script_data.destroy_method = nil    -- set to hide for libs since we can't destroy them commpletely yet
+script_data.restart = nil           -- how to restart the (lib) script after it's been hidden - i.e. make it visible again
+script_data.show = nil              -- only required for libs since the destroy_method only hides them
+
+script_data.metadata = {
+  name = "dbmaint",
+  purpose = _("perform database maintenance"),
+  author = "Bill Ferguson <wpferguson.com>",
+  help = "https://docs.darktable.org/lua/stable/lua.scripts.manual/scripts/contrib/dbmaint/"
+}
+
+
+-- - - - - - - - - - - - - - - - - - - - - - - - 
+-- L O G  L E V E L
+-- - - - - - - - - - - - - - - - - - - - - - - - 
+
+log.log_level(DEFAULT_LOG_LEVEL)
+
+-- - - - - - - - - - - - - - - - - - - - - - - - 
+-- N A M E  S P A C E
+-- - - - - - - - - - - - - - - - - - - - - - - - 
+
+local dbmaint = {}
+
+-- - - - - - - - - - - - - - - - - - - - - - - - 
+-- G L O B A L  V A R I A B L E S
+-- - - - - - - - - - - - - - - - - - - - - - - - 
+
+dbmaint.main_widget = nil
+
+-- - - - - - - - - - - - - - - - - - - - - - - - 
+-- A L I A S E S
+-- - - - - - - - - - - - - - - - - - - - - - - - 
+
+local namespace = dbmaint
+
+-- - - - - - - - - - - - - - - - - - - - - - - - 
+-- F U N C T I O N S
+-- - - - - - - - - - - - - - - - - - - - - - - - 
+
+local function scan_film_rolls()
+  local missing_films = {}
+
+  for _, filmroll in ipairs(dt.films) do
+    if not df.check_if_file_exists(filmroll.path) then
+      table.insert(missing_films, filmroll)
+    end
+  end
+
+  return missing_films
+end
+
+local function scan_images(film)
+  local missing_images = {}
+
+  if film then
+    for i = 1, #film  do
+      local image = film[i]
+      log.log_msg(log.debug, "checking " .. image.filename)
+      if not df.check_if_file_exists(image.path .. PS .. image.filename) then
+        log.log_msg(log.info, image.filename .. " not found")
+        table.insert(missing_images, image)
+      end
+    end
+  end
+
+  return missing_images
+end
+
+local function remove_missing_film_rolls(list)
+  for _, filmroll in ipairs(list) do 
+    filmroll:delete(true)
+  end
+end
+
+-- force the lighttable to reload
+
+local function refresh_lighttable(film)
+  local rules = dt.gui.libs.collect.filter()
+  dt.gui.libs.collect.filter(rules)
+end
+
+local function remove_missing_images(list)
+  local film = list[1].film
+  for _, image in ipairs(list) do
+    image:delete()
+  end
+  refresh_lighttable(film)
+end
+
+local function install_module()
+  if not namespace.module_installed then
+    dt.register_lib(
+      MODULE,     -- Module name
+      _("DB maintenance"),     -- Visible name
+      true,                -- expandable
+      true,               -- resetable
+      {[dt.gui.views.lighttable] = {"DT_UI_CONTAINER_PANEL_LEFT_CENTER", 0}},   -- containers
+      namespace.main_widget,
+      nil,-- view_enter
+      nil -- view_leave
+    )
+    namespace.module_installed = true
+  end
+end
+
+-- - - - - - - - - - - - - - - - - - - - - - - - 
+-- U S E R  I N T E R F A C E
+-- - - - - - - - - - - - - - - - - - - - - - - - 
+
+dbmaint.list_widget = dt.new_widget("text_view"){
+  editable = false,
+  reset_callback = function(this)
+    this.text = ""
+  end
+}
+
+dbmaint.chooser = dt.new_widget("combobox"){
+  label = "scan for",
+  selected = 1,
+  "film rolls", "images",
+  reset_callback = function(this)
+    this.selected = 1
+  end
+}
+
+dbmaint.scan_button = dt.new_widget("button"){
+  label = "scan",
+  tooltip = "click to scan for missing film rolls/files",
+  clicked_callback = function(this)
+    local found = nil
+    local found_text = ""
+    if dbmaint.chooser.value == "film rolls" then
+      found = scan_film_rolls()
+      if #found > 0 then
+        for _, film in ipairs(found) do
+          local dir_name = du.split(film.path, PS)
+          found_text = found_text .. dir_name[#dir_name] .. "\n"
+        end
+      end
+    else
+      log.log_msg(log.debug, "checking path " .. dt.collection[1].path .. " for missing files")
+      found = scan_images(dt.collection[1].film)
+      if #found > 0 then
+        for _, image in ipairs(found) do
+          found_text = found_text .. image.filename .. "\n"
+        end
+      end
+    end
+    if #found > 0 then
+      dbmaint.list_widget.text = found_text
+      dbmaint.found = found
+      dbmaint.remove_button.sensitive = true
+    end
+  end,
+  reset_callback = function(this)
+    dbmaint.found = nil
+  end
+}
+
+dbmaint.remove_button = dt.new_widget("button"){
+  label = "remove",
+  tooltip = "remove missing film rolls/images",
+  sensitive = false,
+  clicked_callback = function(this)
+    if dbmaint.chooser.value == "film rolls" then
+      remove_missing_film_rolls(dbmaint.found)
+    else
+      remove_missing_images(dbmaint.found)
+    end
+    dbmaint.found = nil
+    dbmaint.list_widget.text = ""
+    this.sensitive = false
+  end,
+  reset_callback = function(this)
+    this.sensitive = false
+  end
+}
+
+dbmaint.main_widget = dt.new_widget("box"){
+  orientation = "vertical",
+  dt.new_widget("section_label"){label = "missing items"},
+  dbmaint.list_widget,
+  dt.new_widget("label"){label = ""},
+  dbmaint.chooser,
+  dt.new_widget("label"){label = ""},
+  dbmaint.scan_button,
+  dbmaint.remove_button
+}
+
+-- - - - - - - - - - - - - - - - - - - - - - - - 
+-- D A R K T A B L E  I N T E G R A T I O N 
+-- - - - - - - - - - - - - - - - - - - - - - - - 
+
+local function destroy()
+  dt.gui.libs[MODULE].visible = false
+
+  if namespace.event_registered then
+    dt.destroy_event(MODULE, "view-changed")
+  end
+
+  return
+end
+
+local function restart()
+  dt.gui.libs[MODULE].visible = true
+
+  return
+end
+
+script_data.destroy = destroy
+script_data.restart = restart
+script_data.destroy_method = "hide"
+script_data.show = restart
+
+-- - - - - - - - - - - - - - - - - - - - - - - - 
+-- E V E N T S
+-- - - - - - - - - - - - - - - - - - - - - - - - 
+
+if dt.gui.current_view().id == "lighttable" then
+  install_module()
+else
+  if not namespace.event_registered then
+    dt.register_event(MODULE, "view-changed",
+      function(event, old_view, new_view)
+        if new_view.name == "lighttable" and old_view.name == "darkroom" then
+          install_module()
+         end
+      end
+    )
+    namespace.event_registered = true
+  end
+end
+
+return script_data

contrib/hif_group_leader.lua

@@ -0,0 +1,196 @@
+--[[
+
+    hif_group_leader.lua - Make hif image group leader
+
+    Copyright (C) 2024 Bill Ferguson <wpferguson@gmail.com>.
+
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation; either version 3 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+]]
+--[[
+    hif_group_leader - Make hif image group leader
+
+    After a film roll is imported, check for RAW-JPG image groups
+    and make the JPG image the group leader.  This is on by default
+    but can be disabled in preferences.
+
+    Shortcuts are included to filter existing collections or
+    selections of images and make the hif the group leader.
+
+    ADDITIONAL SOFTWARE NEEDED FOR THIS SCRIPT
+    None
+
+    USAGE
+    Start script from script_manager
+    Assign keys to the shortcuts
+
+    BUGS, COMMENTS, SUGGESTIONS
+    Bill Ferguson <wpferguson@gmail.com>
+
+    CHANGES
+]]
+
+local dt = require "darktable"
+local du = require "lib/dtutils"
+local df = require "lib/dtutils.file"
+
+
+-- - - - - - - - - - - - - - - - - - - - - - - - 
+-- C O N S T A N T S
+-- - - - - - - - - - - - - - - - - - - - - - - - 
+
+local MODULE = "hif_group_leader"
+
+-- - - - - - - - - - - - - - - - - - - - - - - - 
+-- A P I  C H E C K
+-- - - - - - - - - - - - - - - - - - - - - - - - 
+
+du.check_min_api_version("7.0.0", MODULE) 
+
+
+-- - - - - - - - - - - - - - - - - - - - - - - - - -
+-- S C R I P T  M A N A G E R  I N T E G R A T I O N
+-- - - - - - - - - - - - - - - - - - - - - - - - - -
+
+local script_data = {}
+
+script_data.destroy = nil -- function to destory the script
+script_data.destroy_method = nil -- set to hide for libs since we can't destroy them commpletely yet
+script_data.restart = nil -- how to restart the (lib) script after it's been hidden - i.e. make it visible again
+script_data.show = nil -- only required for libs since the destroy_method only hides them
+
+-- - - - - - - - - - - - - - - - - - - - - - - - - -
+-- I 1 8 N
+-- - - - - - - - - - - - - - - - - - - - - - - - - -
+
+local gettext = dt.gettext
+
+-- Tell gettext where to find the .mo file translating messages for a particular domain
+gettext.bindtextdomain(MODULE, dt.configuration.config_dir .. "/lua/locale/")
+
+local function _(msgid)
+    return gettext.dgettext(MODULE, msgid)
+end
+
+
+-- - - - - - - - - - - - - - - - - - - - - - - - 
+-- P R E F E R E N C E S
+-- - - - - - - - - - - - - - - - - - - - - - - - 
+
+dt.preferences.register(MODULE, "on_import", "bool", _("make hif group leader on import"), _("automatically make the hif file the group leader when raw + hif are imported"), true)
+
+-- - - - - - - - - - - - - - - - - - - - - - - - 
+-- N A M E  S P A C E
+-- - - - - - - - - - - - - - - - - - - - - - - - 
+
+local jgloi = {}
+jgloi.images = {}
+
+-- - - - - - - - - - - - - - - - - - - - - - - - 
+-- F U N C T I O N S
+-- - - - - - - - - - - - - - - - - - - - - - - - 
+
+local function toggle_global_toolbox_grouping()
+  dt.gui.libs.global_toolbox.grouping = false
+  dt.gui.libs.global_toolbox.grouping = true
+end
+
+-- - - - - - - - - - - - - - - - - - - - - - - - 
+-- M A I N  P R O G R A M
+-- - - - - - - - - - - - - - - - - - - - - - - - 
+
+local function make_hif_group_leader(images)
+  -- if the image is part of a group, make it the leader
+  for _, image in ipairs(images) do
+    if #image:get_group_members() > 1 then
+      image:make_group_leader()
+    end
+  end
+  if dt.gui.libs.global_toolbox.grouping then
+    -- toggle the grouping to make the new leader show
+    toggle_global_toolbox_grouping()
+  end
+end
+
+local function make_existing_hif_group_leader(images)
+  for _, image in ipairs(images) do
+    if string.lower(df.get_filetype(image.filename)) == "hif" then
+      if #image:get_group_members() > 1 then
+        image:make_group_leader()
+      end
+    end
+  end
+  if dt.gui.libs.global_toolbox.grouping then
+    -- toggle the grouping to make the new leader show
+    toggle_global_toolbox_grouping()
+  end
+end
+
+-- - - - - - - - - - - - - - - - - - - - - - - - 
+-- D A R K T A B L E  I N T E G R A T I O N 
+-- - - - - - - - - - - - - - - - - - - - - - - - 
+
+local function destroy()
+  if dt.preferences.read(MODULE, "on_import", "bool") then
+    dt.destroy_event(MODULE, "post-import-film")
+    dt.destroy_event(MODULE, "post-import-image")
+  end
+  dt.destroy_event(MODULE .. "_collect", "shortcut")
+  dt.destroy_event(MODULE .. "_select", "shortcut")
+end
+
+script_data.destroy = destroy
+
+-- - - - - - - - - - - - - - - - - - - - - - - - 
+-- E V E N T S
+-- - - - - - - - - - - - - - - - - - - - - - - - 
+
+if dt.preferences.read(MODULE, "on_import", "bool") then
+  dt.register_event(MODULE, "post-import-film", 
+    function(event, film_roll)
+      -- ignore the film roll, it contains all the images, not just the imported
+      local images = jgloi.images
+      if #images > 0 then
+        jgloi.images = {}
+        make_hif_group_leader(images)
+      end
+    end
+  )
+
+  dt.register_event(MODULE, "post-import-image",
+    function(event, image)
+      if string.lower(df.get_filetype(image.filename)) == "hif" then
+        table.insert(jgloi.images, image)
+      end
+    end
+  )
+end
+
+dt.register_event(MODULE .. "_collect", "shortcut",
+  function(event, shortcut)
+    -- ignore the film roll, it contains all the images, not just the imported
+    local images = dt.collection
+    make_existing_hif_group_leader(images)
+  end,
+  _("Make hif group leader for collection")
+)
+
+dt.register_event(MODULE .. "_select", "shortcut",
+  function(event, shortcut)
+    local images = dt.gui.selection()
+    make_existing_hif_group_leader(images)
+  end,
+  _("Make hif group leader for selection")
+)
+
+return script_data

contrib/jpg_group_leader.lua

@@ -0,0 +1,196 @@
+--[[
+
+    jpg_group_leader.lua - Make jpg image group leader
+
+    Copyright (C) 2024 Bill Ferguson <wpferguson@gmail.com>.
+
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation; either version 3 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+]]
+--[[
+    jpg_group_leader - Make jpg image group leader
+
+    After a film roll is imported, check for RAW-JPG image groups
+    and make the JPG image the group leader.  This is on by default
+    but can be disabled in preferences.
+
+    Shortcuts are included to filter existing collections or
+    selections of images and make the jpg the group leader.
+
+    ADDITIONAL SOFTWARE NEEDED FOR THIS SCRIPT
+    None
+
+    USAGE
+    Start script from script_manager
+    Assign keys to the shortcuts
+
+    BUGS, COMMENTS, SUGGESTIONS
+    Bill Ferguson <wpferguson@gmail.com>
+
+    CHANGES
+]]
+
+local dt = require "darktable"
+local du = require "lib/dtutils"
+local df = require "lib/dtutils.file"
+
+
+-- - - - - - - - - - - - - - - - - - - - - - - - 
+-- C O N S T A N T S
+-- - - - - - - - - - - - - - - - - - - - - - - - 
+
+local MODULE = "jpg_group_leader"
+
+-- - - - - - - - - - - - - - - - - - - - - - - - 
+-- A P I  C H E C K
+-- - - - - - - - - - - - - - - - - - - - - - - - 
+
+du.check_min_api_version("7.0.0", MODULE) 
+
+
+-- - - - - - - - - - - - - - - - - - - - - - - - - -
+-- S C R I P T  M A N A G E R  I N T E G R A T I O N
+-- - - - - - - - - - - - - - - - - - - - - - - - - -
+
+local script_data = {}
+
+script_data.destroy = nil -- function to destory the script
+script_data.destroy_method = nil -- set to hide for libs since we can't destroy them commpletely yet
+script_data.restart = nil -- how to restart the (lib) script after it's been hidden - i.e. make it visible again
+script_data.show = nil -- only required for libs since the destroy_method only hides them
+
+-- - - - - - - - - - - - - - - - - - - - - - - - - -
+-- I 1 8 N
+-- - - - - - - - - - - - - - - - - - - - - - - - - -
+
+local gettext = dt.gettext
+
+-- Tell gettext where to find the .mo file translating messages for a particular domain
+gettext.bindtextdomain(MODULE, dt.configuration.config_dir .. "/lua/locale/")
+
+local function _(msgid)
+    return gettext.dgettext(MODULE, msgid)
+end
+
+
+-- - - - - - - - - - - - - - - - - - - - - - - - 
+-- P R E F E R E N C E S
+-- - - - - - - - - - - - - - - - - - - - - - - - 
+
+dt.preferences.register(MODULE, "on_import", "bool", _("make jpg group leader on import"), _("automatically make the jpg file the group leader when raw + jpg are imported"), true)
+
+-- - - - - - - - - - - - - - - - - - - - - - - - 
+-- N A M E  S P A C E
+-- - - - - - - - - - - - - - - - - - - - - - - - 
+
+local jgloi = {}
+jgloi.images = {}
+
+-- - - - - - - - - - - - - - - - - - - - - - - - 
+-- F U N C T I O N S
+-- - - - - - - - - - - - - - - - - - - - - - - - 
+
+local function toggle_global_toolbox_grouping()
+  dt.gui.libs.global_toolbox.grouping = false
+  dt.gui.libs.global_toolbox.grouping = true
+end
+
+-- - - - - - - - - - - - - - - - - - - - - - - - 
+-- M A I N  P R O G R A M
+-- - - - - - - - - - - - - - - - - - - - - - - - 
+
+local function make_jpg_group_leader(images)
+  -- if the image is part of a group, make it the leader
+  for _, image in ipairs(images) do
+    if #image:get_group_members() > 1 then
+      image:make_group_leader()
+    end
+  end
+  if dt.gui.libs.global_toolbox.grouping then
+    -- toggle the grouping to make the new leader show
+    toggle_global_toolbox_grouping()
+  end
+end
+
+local function make_existing_jpg_group_leader(images)
+  for _, image in ipairs(images) do
+    if string.lower(df.get_filetype(image.filename)) == "jpg" then
+      if #image:get_group_members() > 1 then
+        image:make_group_leader()
+      end
+    end
+  end
+  if dt.gui.libs.global_toolbox.grouping then
+    -- toggle the grouping to make the new leader show
+    toggle_global_toolbox_grouping()
+  end
+end
+
+-- - - - - - - - - - - - - - - - - - - - - - - - 
+-- D A R K T A B L E  I N T E G R A T I O N 
+-- - - - - - - - - - - - - - - - - - - - - - - - 
+
+local function destroy()
+  if dt.preferences.read(MODULE, "on_import", "bool") then
+    dt.destroy_event(MODULE, "post-import-film")
+    dt.destroy_event(MODULE, "post-import-image")
+  end
+  dt.destroy_event(MODULE .. "_collect", "shortcut")
+  dt.destroy_event(MODULE .. "_select", "shortcut")
+end
+
+script_data.destroy = destroy
+
+-- - - - - - - - - - - - - - - - - - - - - - - - 
+-- E V E N T S
+-- - - - - - - - - - - - - - - - - - - - - - - - 
+
+if dt.preferences.read(MODULE, "on_import", "bool") then
+  dt.register_event(MODULE, "post-import-film", 
+    function(event, film_roll)
+      -- ignore the film roll, it contains all the images, not just the imported
+      local images = jgloi.images
+      if #images > 0 then
+        jgloi.images = {}
+        make_jpg_group_leader(images)
+      end
+    end
+  )
+
+  dt.register_event(MODULE, "post-import-image",
+    function(event, image)
+      if string.lower(df.get_filetype(image.filename)) == "jpg" then
+        table.insert(jgloi.images, image)
+      end
+    end
+  )
+end
+
+dt.register_event(MODULE .. "_collect", "shortcut",
+  function(event, shortcut)
+    -- ignore the film roll, it contains all the images, not just the imported
+    local images = dt.collection
+    make_existing_jpg_group_leader(images)
+  end,
+  _("Make jpg group leader for collection")
+)
+
+dt.register_event(MODULE .. "_select", "shortcut",
+  function(event, shortcut)
+    local images = dt.gui.selection()
+    make_existing_jpg_group_leader(images)
+  end,
+  _("Make jpg group leader for selection")
+)
+
+return script_data

contrib/passport_guide_germany.lua

@@ -0,0 +1,105 @@
+--[[
+  German passport photo cropping guide for darktable.
+  Derived from the passport cropping guide by Kåre Hampf.
+
+  copyright (c) 2017  Kåre Hampf
+  copyright (c) 2024  Christian Sültrop
+  
+  darktable is free software: you can redistribute it and/or modify
+  it under the terms of the GNU General Public License as published by
+  the Free Software Foundation, either version 3 of the License, or
+  (at your option) any later version.
+
+  darktable is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+  GNU General Public License for more details.
+
+  You should have received a copy of the GNU General Public License
+  along with darktable.  If not, see <http://www.gnu.org/licenses/>.
+]]
+
+--[[
+PASSPORT CROPPING GUIDE
+Guides for cropping passport and ID card ("Personalausweis") photos based on the "Passbild-Schablone" 
+from the German Federal Ministry of the Interior and Community. 
+(https://www.bmi.bund.de/SharedDocs/downloads/DE/veroeffentlichungen/themen/moderne-verwaltung/ausweise/passbild-schablone-erwachsene.pdf?__blob=publicationFile&v=3) 
+
+INSTALLATION
+* copy this file in $CONFIGDIR/lua/ where CONFIGDIR is your darktable configuration directory
+* add the following line in the file $CONFIGDIR/luarc
+  require "passport_guide_germany"
+* (optional) add the line:
+  "plugins/darkroom/clipping/extra_aspect_ratios/passport 35x45mm=45:35"
+  to $CONFIGDIR/darktablerc
+
+USAGE
+* when using the cropping tool, select "Passport Photo Germany" as guide and if you added the line in yout rc
+  select "passport 35x45mm" as aspect
+]]
+
+local dt = require "darktable"
+local du = require "lib/dtutils"
+local gettext = dt.gettext
+
+du.check_min_api_version("2.0.0", "passport_guide_germany") 
+
+-- Tell gettext where to find the .mo file translating messages for a particular domain
+gettext.bindtextdomain("passport_guide_germany",dt.configuration.config_dir.."/lua/locale/")
+
+local function _(msgid)
+  return gettext.dgettext("passport_guide_germany", msgid)
+end
+
+dt.guides.register_guide("Passport Photo Germany",
+-- draw
+function(cairo, x, y, width, height, zoom_scale)
+  local _width, _height
+
+  -- get the max 35x45 rectangle
+  local aspect_ratio = 45 / 35
+  if width * aspect_ratio > height then
+    _width = height / aspect_ratio
+    _height = height
+  else
+    _width = width
+    _height = width * aspect_ratio
+  end
+
+  cairo:save()
+
+  cairo:translate(x + (width - _width) / 2, y + (height - _height) / 2)
+  cairo:scale(_width / 35, _height / 45)
+
+  -- the outer rectangle
+  cairo:rectangle( 0, 0, 35, 45)
+
+  -- Nose position: The nose tip must be between these lines
+  cairo:draw_line(15.5, 45, 15.5, 13)
+  cairo:draw_line(35-15.5, 45, 35-15.5, 13)
+
+  -- Face height
+  -- optimum face height: The upper end of the head should be between these lines
+  cairo:draw_line(0, 4, 35, 4)
+  cairo:draw_line(0, 8, 35, 8)
+
+  -- tolerated face height: The upper end of the head must not be below this line
+  cairo:draw_line(6, 13, 30, 13)
+
+  -- Eye area: The eyes must be between these lines
+  cairo:draw_line(0, 13, 35, 13)
+  cairo:draw_line(0, 23, 35, 23)
+
+  -- Cheek line: The cheek must lie on this line
+  cairo:draw_line(9, 45-5, 27, 45-5)
+
+  cairo:restore()
+end,
+-- gui
+function()
+  return dt.new_widget("label"){label = _("Passport Photo Germany"), halign = "start"}
+end
+)
+
+-- kate: tab-indents: off; indent-width 2; replace-tabs on; remove-trailing-space on; hl Lua;
+-- vim: shiftwidth=2 expandtab tabstop=2 cindent syntax=lua

examples/gui_action.lua

@@ -0,0 +1,105 @@
+local dt = require "darktable"
+
+local NaN = 0/0
+
+local wg = {}
+
+wg.action = dt.new_widget("entry"){
+    text = "lib/filter/view",
+    placeholder = "action path",
+    tooltip = "enter the full path of an action, for example 'lib/filter/view'"
+  }
+
+wg.instance = dt.new_widget("combobox"){
+  label = "instance",
+  tooltip = "the instance of an image processing module to execute action on",
+  "0", "+1", "-1", "+2", "-2", "+3", "-3", "+4", "-4", "+5", "-5", "+6", "-6", "+7", "-7", "+8", "-8", "+9", "-9"
+}
+
+wg.element = dt.new_widget("entry"){
+  text = "",
+  placeholder = "action element",
+  tooltip = "enter the element of an action, for example 'selection', or leave empty for default"
+}
+
+wg.effect = dt.new_widget("entry"){
+  text = "next",
+  placeholder = "action effect",
+  tooltip = "enter the effect of an action, for example 'next', or leave empty for default"
+}
+
+wg.speed = dt.new_widget("entry"){
+  text = "1",
+  placeholder = "action speed",
+  tooltip = "enter the speed to use in action execution, or leave empty to only read state"
+}
+
+wg.check = dt.new_widget("check_button"){
+  label = 'perform action',
+  tooltip = 'perform action or only read return',
+  clicked_callback = function()
+    wg.speed.sensitive = wg.check.value
+  end,
+  value = true
+}
+
+wg.return_value = dt.new_widget("entry"){
+  text = "",
+  sensitive = false
+}
+
+dt.register_lib(
+    "execute_action",        -- Module name
+    "execute gui actions",   -- name
+    true,                    -- expandable
+    false,                   -- resetable
+    {[dt.gui.views.lighttable] = {"DT_UI_CONTAINER_PANEL_LEFT_CENTER", 100},
+     [dt.gui.views.darkroom] = {"DT_UI_CONTAINER_PANEL_LEFT_CENTER", 100}},
+    dt.new_widget("box")
+    {
+      orientation = "vertical",
+
+      dt.new_widget("box")
+      {
+        orientation = "horizontal",
+        dt.new_widget("label"){label = "action path", halign = "start"},
+        wg.action
+      },
+      wg.instance,
+      dt.new_widget("box")
+      {
+        orientation = "horizontal",
+        dt.new_widget("label"){label = "element", halign = "start"},
+        wg.element
+      },
+      dt.new_widget("box")
+      {
+        orientation = "horizontal",
+        dt.new_widget("label"){label = "effect", halign = "start"},
+        wg.effect
+      },
+      wg.check,
+      dt.new_widget("box")
+      {
+        orientation = "horizontal",
+        dt.new_widget("label"){label = "speed", halign = "start"},
+        wg.speed
+      },
+      dt.new_widget("button")
+      {
+        label = "execute action",
+        tooltip = "execute the action specified in the fields above",
+        clicked_callback = function(_)
+          local sp = NaN
+          if wg.check.value then sp = wg.speed.text end
+          wg.return_value.text = dt.gui.action(wg.action.text, wg.instance.value, wg.element.text, wg.effect.text, sp)
+        end
+      },
+      dt.new_widget("box")
+      {
+        orientation = "horizontal",
+        dt.new_widget("label"){label = "return value:", halign = "start"},
+        wg.return_value
+      },
+    }
+  )

examples/x-touch.lua

@@ -53,7 +53,7 @@ midi:C0=iop/channelmixerrgb;focus
 local dt = require "darktable"
 local du = require "lib/dtutils"
 
-du.check_min_api_version("9.1.0", "x-touch")
+du.check_min_api_version("9.2.0", "x-touch")
 
 -- set up 8 mimic sliders with the same function
 for k = 1,8 do
@@ -96,7 +96,20 @@ for k = 1,8 do
                     "purple",
                     "magenta" }
         element = e[k]
+                
+                
+      -- if the sigmoid rgb primaries is focused, 
+      -- check sliders
+      elseif dt.gui.action("iop/sigmoid", "focus") ~= 0 and k <8 then
+        local e = { "red attenuation", "red rotation", "green attenuation", "green rotation", "blue attenuation", "blue rotation", "recover purity" }
+        which = "iop/sigmoid/primaries/"..e[k]
 
+      -- if the rgb primaries is focused, 
+      -- check sliders
+      elseif dt.gui.action("iop/primaries", "focus") ~= 0 and k >=1 then
+        local e = { "red hue", "red purity", "green hue", "green purity", "blue hue", "blue purity", "tint hue", "tint purity" }
+        which = "iop/primaries/" ..e[k]
+      
       -- if the tone equalizer is focused, 
       -- select one of the sliders in the "simple" tab
       elseif dt.gui.action("iop/toneequal", "focus") ~= 0 then

tools/script_manager.lua

@@ -60,7 +60,7 @@ local gettext = dt.gettext
 
 
 -- Tell gettext where to find the .mo file translating messages for a particular domain
-gettext.bindtextdomain("script_manager",dt.configuration.config_dir.."/lua/locale/")
+dt.gettext.bindtextdomain("script_manager",dt.configuration.config_dir.."/lua/locale/")
 
 local function _(msgid)
     return gettext.dgettext("script_manager", msgid)
@@ -397,7 +397,7 @@ local function activate(script)
       if err ~= true then
         log.msg(log.debug, "got lib data")
         script.data = err
-        if script.data.destroy_method and script.data.destroy_method == "hide" and script.data.show then
+        if script.data.destroy_method and script.data.destroy_method == "hide" and script.data.show and dt.gui.current_view().id == "lighttable" then
           script.data.show()
         end
       else
@@ -497,14 +497,44 @@ local function process_script_data(script_file)
 
   -- add the script data
   local category,path,name,filename,filetype = string.match(script_file, pattern)
-  log.msg(log.debug, "category is " .. category)
-  log.msg(log.debug, "name is " .. name)
 
-  add_script_category(category)
+  if category and name and path then
+    log.msg(log.debug, "category is " .. category)
+    log.msg(log.debug, "name is " .. name)
 
-  if name then
+    add_script_category(category)
     add_script_name(name, path, category)
   end
+
+  restore_log_level(old_log_level)
+end
+
+local function ensure_lib_in_search_path(line)
+  local old_log_level = set_log_level(sm.log_level)
+  set_log_level(log.debug)
+
+  log.msg(log.debug, "line is " .. line)
+
+  if string.match(line, ds.sanitize_lua(dt.configuration.config_dir .. PS .. "lua" .. PS .. "lib")) then
+    log.msg(log.debug, line .. " is already in search path, returning...")
+    return
+  end
+
+  local pattern =  dt.configuration.running_os == "windows" and  "(.+)\\lib\\.+lua" or  "(.+)/lib/.+lua"
+  local path = string.match(line, pattern)
+
+  log.msg(log.debug, "extracted path is " .. path)
+  log.msg(log.debug, "package.path is " .. package.path)
+
+  if not string.match(package.path, ds.sanitize_lua(path)) then
+
+    log.msg(log.debug, "path isn't in package.path, adding...")
+
+    package.path = package.path .. ";" .. path .. "/?.lua"
+
+    log.msg(log.debug, "new package.path is " .. package.path)
+  end
+
   restore_log_level(old_log_level)
 end
 
@@ -528,6 +558,8 @@ local function scan_scripts(script_dir)
             process_script_data(script_file)
             script_count = script_count + 1
           end
+        else
+          ensure_lib_in_search_path(line)                             -- but let's make sure libraries can be found
         end
       end
     end