Fix #24, plus create album bug introduced by 20260104.22

Author: fjb2020

CHANGELOG.md

@@ -1,4 +1,9 @@
 # Changelog
+## [20260105.23] - 2026-01-05
+### Fixed
+Fix #24 rename album does not update custom metadata. Also fix error that incorrect albumname was used for metadata with special collections 
+Fix regression introduced by 20260104.22 causing crash when creating new album or album set
+
 ## [20260104.22] - 2026-01-04
 ### Fixed
 Changes to Category (album) visibility in Piwigo could cause duplicates to be created by plugin if a previously public album was changed to private in Piwigo and then a photo published to it. The plugin now effectively ignores public/private settings and can access all albums on the Piwigo host.

README.md

@@ -1,6 +1,6 @@
 # PiwigoPublish-lrc-plugin
 
-A Lightroom Classic plugin which publishes images to a Piwigo host via the Piwigo REST API.
+A Lightroom Classic plugin which publishes images to a Piwigo host via the Piwigo API.
 
 ## The following fuctionality is available:
 

piwigoPublish.lrplugin/Info.lua

@@ -59,5 +59,5 @@ return {
 
 	LrPluginInfoProvider = 'PluginInfo.lua',
 
-    VERSION = { major=20260104, minor=22, revision=0 },
+    VERSION = { major=20260105, minor=23, revision=0 },
 }

piwigoPublish.lrplugin/Init.lua

@@ -72,6 +72,6 @@ end
 
 _G.PiwigoBusy = false
 _G.iconPath = _PLUGIN:resourceId("icons/icon_med.png")
-_G.pluginVersion = "20260104.22"
+_G.pluginVersion = "20260105.23"
 --_G.LocStrings = utils.loadStrings()
 

piwigoPublish.lrplugin/PiwigoAPI.lua

@@ -1040,6 +1040,61 @@ function PiwigoAPI.storeMetaData(catalog, propertyTable, lrPhoto, pluginData)
     propertyTable.publishedPhotoMap[pluginData.pwImageID] = lrPhoto.localIdentifier
 end
 
+-- *************************************************
+function PiwigoAPI.updateMetaDataforCollection(propertyTable, pubCollection, metaData)
+    -- function to update metadata on all photos in a published collection
+    log:info("PiwigoAPI.updateMetaDataforCollection - collection " .. pubCollection:getName())
+    local catalog = LrApplication.activeCatalog()
+    local pubphotos = pubCollection:getPublishedPhotos()
+    local catId = pubCollection:getRemoteId()
+    local albumName = metaData.name or ""
+
+
+    for _, pubPhoto in ipairs(pubphotos) do
+        local lrPhoto = pubPhoto:getPhoto()
+        local pwImageID = pubPhoto:getRemoteId()
+        local photoRemoteId = pubPhoto:getRemoteId()
+        local mdRemoteUrl = lrPhoto:getPropertyForPlugin(_PLUGIN, "pwImageURL") or ""
+        local checkUrl = string.format("%s/picture.php?/%s/category/%s", propertyTable.host, photoRemoteId,
+            tostring(catId))
+
+        if mdRemoteUrl == checkUrl then
+            -- photo metadata is from this collection - update metadata fields
+            -- update metadata fields in lrPhoto
+            catalog:withWriteAccessDo("Updating " .. lrPhoto:getFormattedMetadata("fileName"),
+                function()
+                    lrPhoto:setPropertyForPlugin(_PLUGIN, "pwAlbumName", albumName)
+                end)
+        end
+    end
+end
+
+-- *************************************************
+function PiwigoAPI.updateMetaDataforCollectionSet(propertyTable, pubCollectionSet, metaData)
+    -- function to update metadata on all photos in a published collection
+    log:info("PiwigoAPI.updateMetaDataforCollectionSet - collection " .. pubCollectionSet:getName())
+    local catalog = LrApplication.activeCatalog()
+    local collSetName = pubCollectionSet:getName()
+    local remoteId = pubCollectionSet:getRemoteId()
+    local scCollSetName = PiwigoAPI.buildSpecialCollectionName(metaData.name or "")
+    -- look for special collection in children of this set
+    if pubCollectionSet:getChildCollections() == nil then
+        -- no child collections so nothing to do
+        return
+    end
+
+    for _, childColl in ipairs(pubCollectionSet:getChildCollections()) do
+        local thisName = childColl:getName()
+        if string.sub(thisName, 1, 1) == "[" and string.sub(thisName, -1) == "]" then
+            -- found special collection - update metadata for photos in this collection
+            log:info("PiwigoAPI.updateMetaDataforCollectionSet - renaming special collection " .. thisName ..
+                " to " .. scCollSetName)
+            PiwigoAPI.setCollectionDets(childColl, catalog, propertyTable, scCollSetName, remoteId, pubCollectionSet)
+            PiwigoAPI.updateMetaDataforCollection(propertyTable, childColl, metaData)
+        end
+    end
+end
+
 -- *************************************************
 function PiwigoAPI.getPublishServicesForPlugin(pluginID)
     -- Helper to get all publish service connections for this plugin
@@ -1145,20 +1200,19 @@ function PiwigoAPI.pwConnect(propertyTable)
         { field = "Content-Type",    value = "application/x-www-form-urlencoded" },
         { field = "Accept-Encoding", value = "identity" },
     }
-    log:info("PiwigoAPI.pwConnect - connecting to " .. propertyTable.pwurl)
-    log:info("PiwigoAPI.pwConnect - body:\n" .. utils.serialiseVar(body))
 
     local httpResponse, httpHeaders = LrHttp.post(propertyTable.pwurl, body, headers)
 
-    log:info("PiwigoAPI.pwConnect - response headers:\n" .. utils.serialiseVar(httpHeaders))
-    log:info("PiwigoAPI.pwConnect - response body:\n" .. tostring(httpResponse))
-
     if (httpHeaders.status == 201) or (httpHeaders.status == 200) then
         -- successful connection to Piwigo
         -- Now check login result
         -- Decode JSON safely
         local ok, rtnBody = pcall(JSON.decode, JSON, httpResponse)
         if not ok or type(rtnBody) ~= "table" then
+            log:info("PiwigoAPI.pwConnect - connecting to " .. propertyTable.pwurl)
+            log:info("PiwigoAPI.pwConnect - body:\n" .. utils.serialiseVar(body))
+            log:info("PiwigoAPI.pwConnect - response headers:\n" .. utils.serialiseVar(httpHeaders))
+            log:info("PiwigoAPI.pwConnect - response body:\n" .. tostring(httpResponse))
             LrDialogs.message(
                 "Cannot log in to Piwigo",
                 "Invalid or unreadable server response"
@@ -1196,6 +1250,10 @@ function PiwigoAPI.pwConnect(propertyTable)
             return false
         end
     else
+        log:info("PiwigoAPI.pwConnect - connecting to " .. propertyTable.pwurl)
+        log:info("PiwigoAPI.pwConnect - body:\n" .. utils.serialiseVar(body))
+        log:info("PiwigoAPI.pwConnect - response headers:\n" .. utils.serialiseVar(httpHeaders))
+        log:info("PiwigoAPI.pwConnect - response body:\n" .. tostring(httpResponse))
         local statusCode, statusDesc
         status = httpHeaders and httpHeaders.status
         if httpHeaders and httpHeaders.error then
@@ -1329,7 +1387,7 @@ end
 
 -- *************************************************
 function PiwigoAPI.pwCategoriesGetThis(propertyTable, thisCat)
-    log:info("PiwigoAPI.pwCategoriesGetThis - propertyTable\n" .. utils.serialiseVar(propertyTable))
+    log:info("PiwigoAPI.pwCategoriesGetThis")
     local rv
 
     -- check connection to piwigo
@@ -1377,13 +1435,11 @@ end
 function PiwigoAPI.pwCategoriesGet(propertyTable, thisCat)
     -- get list of categories from Piwigo
     -- if thisCat is set then return this category and children, otherwise all categories
-
+    log:info("PiwigoAPI.pwCategoriesGet")
     local Params = {
-        --{ name = "method",    value = "pwg.categories.getList" },
         { name = "method",    value = "pwg.categories.getAdminList" },
         { name = "recursive", value = "true" },
-        --{ name = "tree",     value = "false" },
-        --{ name = "fullname", value = "false" }
+
     }
 
     if not (utils.nilOrEmpty(thisCat)) then
@@ -1506,9 +1562,15 @@ function PiwigoAPI.pwCategoriesAdd(propertyTable, info, metaData, callStatus)
         return callStatus
     end
 
+    local name = metaData.name or ""
+    local description = metaData.description or ""
+    local albumstatus = metaData.status or "public"
+
     local Params = {
         { name = "method",    value = "pwg.categories.add" },
-        { name = "name",      value = metaData.name },
+        { name = "name",      value = name },
+        { name = "comment",   value = description },
+        { name = "status",    value = albumstatus },
         { name = "pwg_token", value = propertyTable.token }
     }
     if metaData.parentCat ~= "" then
@@ -1621,6 +1683,8 @@ end
 -- *************************************************
 function PiwigoAPI.pwCategoriesSetinfo(propertyTable, info, metaData)
     -- Set info on category - change name etc
+
+    log:info("PiwigoAPI.pwCategoriesSetinfo")
     local callStatus = {}
     callStatus.status = false
     callStatus.statusMsg = ""
@@ -1643,8 +1707,8 @@ function PiwigoAPI.pwCategoriesSetinfo(propertyTable, info, metaData)
     end
 
     local remoteId = metaData.remoteId
-    local name = metaData.name
-    local description = metaData.description
+    local name = metaData.name or ""
+    local description = metaData.description or ""
     local status = metaData.status or "public"
 
     local params = {
@@ -1655,7 +1719,6 @@ function PiwigoAPI.pwCategoriesSetinfo(propertyTable, info, metaData)
         { name = "status",      value = status },
         { name = "pwg_token",   value = propertyTable.token }
     }
-    log:info("PiwigoAPI.pwCategoriesSetinfo - params \n" .. utils.serialiseVar(params))
 
     local httpResponse, httpHeaders = LrHttp.postMultipart(
         propertyTable.pwurl,
@@ -1665,9 +1728,6 @@ function PiwigoAPI.pwCategoriesSetinfo(propertyTable, info, metaData)
         }
     )
 
-    log:info("PiwigoAPI.pwCategoriesSetinfo - httpHeaders\n" .. utils.serialiseVar(httpHeaders))
-    log:info("PiwigoAPI.pwCategoriesSetinfo - httpResponse\n" .. utils.serialiseVar(httpResponse))
-
     local body
     if httpResponse then
         body = JSON:decode(httpResponse)
@@ -1677,10 +1737,16 @@ function PiwigoAPI.pwCategoriesSetinfo(propertyTable, info, metaData)
             callStatus.status = true
             callStatus.statusMsg = ""
         else
+            log:info("PiwigoAPI.pwCategoriesSetinfo - params \n" .. utils.serialiseVar(params))
+            log:info("PiwigoAPI.pwCategoriesSetinfo - httpHeaders\n" .. utils.serialiseVar(httpHeaders))
+            log:info("PiwigoAPI.pwCategoriesSetinfo - httpResponse\n" .. utils.serialiseVar(httpResponse))
             callStatus.status = false
             callStatus.statusMsg = "Category " .. tostring(remoteId) .. " - " .. (body.message or "")
         end
     else
+        log:info("PiwigoAPI.pwCategoriesSetinfo - params \n" .. utils.serialiseVar(params))
+        log:info("PiwigoAPI.pwCategoriesSetinfo - httpHeaders\n" .. utils.serialiseVar(httpHeaders))
+        log:info("PiwigoAPI.pwCategoriesSetinfo - httpResponse\n" .. utils.serialiseVar(httpResponse))
         callStatus.status = false
         callStatus.statusMsg = "Category " .. tostring(remoteId) .. " - " .. (body.message or "")
     end

piwigoPublish.lrplugin/PublishTask.lua

@@ -54,21 +54,23 @@ function PublishTask.processRenderedPhotos(functionContext, exportContext)
 
     log:info('PublishTask.processRenderedPhotos - publishSettings:\n' .. utils.serialiseVar(propertyTable))
 
-    --[[
-    local publishCollection = exportContext.publishCollection
-    local publishCollectionProps = publishCollection:getPropertyTable()
-    log:info('PublishTask.processRenderedPhotos - publishCollectionProps:\n' .. utils.serialiseVar(publishCollectionProps))
-]]
-
     local publishedCollection = exportContext.publishedCollection
     local collectionInfo = publishedCollection:getCollectionInfoSummary()
     local collectionSettings = collectionInfo.collectionSettings
     -- log:info('PublishTask.processRenderedPhotos - collectionInfo:\n' .. utils.serialiseVar(collectionInfo))
+    local parentCollSet = publishedCollection:getParent()
+    local parentID = ""
     local albumName = publishedCollection:getName()
+    -- check if album is special collection and and use name of parent album if so
+    if string.sub(albumName, 1, 1) == "[" and string.sub(albumName, -1) == "]" then
+        if parentCollSet then
+            albumName = parentCollSet:getName()
+        end
+    end
     local albumId = publishedCollection:getRemoteId()
     local albumUrl = publishedCollection:getRemoteUrl()
-    local parentCollSet = publishedCollection:getParent()
-    local parentID = ""
+
+
     local requestRepub = false
     if parentCollSet then
         parentID = parentCollSet:getRemoteId()
@@ -106,7 +108,6 @@ function PublishTask.processRenderedPhotos(functionContext, exportContext)
     end
 
     local resetConnectioncount = 0
-
     local renditionParams = {
         stopIfCanceled = true,
     }
@@ -161,10 +162,10 @@ function PublishTask.processRenderedPhotos(functionContext, exportContext)
 
             metaData.fileName = lrPhoto:getFormattedMetadata("fileName") or ""
             local lrTime = lrPhoto:getRawMetadata("dateTimeOriginal")
-            metaData.dateCreated = LrDate.timeToUserFormat(lrTime, "%Y-%m-%d %H:%M:%S")
+            metaData.dateCreated = (LrDate.timeToUserFormat(lrTime, "%Y-%m-%d %H:%M:%S")) or ""
             metaData.Remoteid = remoteId
 
-            metaData.tagString = utils.BuildTagString(propertyTable, lrPhoto)
+            metaData.tagString = utils.BuildTagString(propertyTable, lrPhoto) or ""
             -- run to build missingTags - tags that will be created on upload to Piwigo
             -- will use this to decide whether to run build tagtable cache
             -- means we don't have to rebuild after each uploaded photo
@@ -278,7 +279,7 @@ function PublishTask.deletePhotosFromPublishedCollection(publishSettings, arrayO
 
     -- set up async prococess for piwigo calls
     LrTasks.startAsyncTask(function()
-        -- now go through each photo in photosToUnpublish and renove from Piwigo
+        -- now go through each photo in photosToUnpublish and remove from Piwigo
         for i, thisPhotoToUnpublish in pairs(photosToUnpublish) do
             local thisLrPhoto = thisPhotoToUnpublish[1]
             local thispwImageID = thisPhotoToUnpublish[2]
@@ -423,7 +424,7 @@ end
 function PublishTask.viewForCollectionSettings(f, publishSettings, info)
     log:info("PublishTask.viewForCollectionSettings")
 
-    local thisName = info.name
+    local thisName = info.name or ""
     if string.sub(thisName, 1, 1) == "[" and string.sub(thisName, -1) == "]" then
         LrDialogs.message(
             "Edit Piwigo Album",
@@ -858,15 +859,15 @@ function PublishTask.updateCollectionSetSettings(publishSettings, info)
     local metaData = {}
     metaData.name = name
     metaData.remoteId = remoteId
-    metaData.description = collectionSettings.albumDescription
+
+    metaData.description = collectionSettings.albumDescription or ""
     if collectionSettings.albumPrivate then
         metaData.status = "private"
     else
         metaData.status = "public"
     end
-    -- update albumdesc if album exists and set
-
 
+    -- update albumdesc if album exists and set
     metaData.name = CollectionName
     metaData.type = "collectionset"
     metaData.description = collectionSettings.albumDescription
@@ -958,6 +959,7 @@ end
 
 -- ************************************************
 function PublishTask.renamePublishedCollection(publishSettings, info)
+    log:info("PublishTask.renamePublishedCollection")
     local callStatus = {}
     callStatus.status = false
     -- called for both collections and collectionsets
@@ -966,13 +968,18 @@ function PublishTask.renamePublishedCollection(publishSettings, info)
     local newName = info.name
     local collection = info.publishedCollection
     local oldName = collection:getName()
-
+    local collectionSettings = nil
+    if collection:type() == "LrPublishedCollectionSet" then
+        collectionSettings = collection:getCollectionSetInfoSummary()
+    else
+        collectionSettings = collection:getCollectionInfoSummary()
+    end
     local metaData = {}
     metaData.name = newName
     metaData.remoteId = remoteId
     metaData.oldName = oldName
-    metaData.description = info.collectionSettings.albumDescription or ""
-    if info.collectionSettings.albumPrivate then
+    metaData.description = collectionSettings.albumDescription or ""
+    if collectionSettings.albumPrivate then
         metaData.status = "private"
     else
         metaData.status = "public"
@@ -991,7 +998,24 @@ function PublishTask.renamePublishedCollection(publishSettings, info)
             end
         end
     end
-    if not (callStatus.status) then
+    if (callStatus.status) then
+        -- if this is Publishedcollection then need to update metadata in photos in this collection
+        -- address metadata changes if any
+        -- go through all published photos in this collection and update metadata
+        -- need to check that remoteUrl is same as metadata field as photo may be in multiple publish collections
+        -- check all published photos in this collection
+        log:info("PublishTask.renamePublishedCollection - updating photo metadata in renamed collection - collection is a " .. collection:type())
+        if collection:type() == "LrPublishedCollection" then
+            -- only PublishedCollections have photos
+            PiwigoAPI.updateMetaDataforCollection(publishSettings, collection, metaData)
+        end
+        -- if this is a publishedCollectionSet then need to check for special collection rename that and update photos in it
+        if collection:type() == "LrPublishedCollectionSet" then
+            -- check for special collection within collectionset and rename that, and check meta of photos in that collection
+            PiwigoAPI.updateMetaDataforCollectionSet(publishSettings, collection, metaData)
+        end
+        
+    else
         LrTasks.startAsyncTask(function()
             LrFunctionContext.callWithContext("revertRename", function(context)
                 local cat = LrApplication.activeCatalog()