Add maintenance/display of Custom metadata displaying details of most recent upload for an image

fjb2020 · fjb2020 · commit fe78ac44366b · 2025-12-27T15:46:53.000Z
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,4 +1,12 @@
 # Changelog
+
+## [20251224.16] - 2025-12-24
+### Added
+- Custom metadata displaying details of most recent upload for an image is maintained. Note that if the same image is published via multiple instances of this plugin (for example to different Piwigo hosts) then only details of the most recent upload will be displayed. Details of the previous upload are overwritten. This metadata is for display / information purposes only so the overwrite has no functional impact. Images published with earlier versions of the plugin will not display the metadata - re-publishing them will refresh it. When an image is removed from a published collection this metadata is cleared, regardless of whether it has also been published via a different instance of this plugin.
+
+### Fixed
+Fixed #18 Setting up another publish service on a different catalogue generates an error message 'PiwigoAPI.lua 694 attempt to concatenate local statusDes (a nil value) - note this fixes the crash rather than the underlying issue that triggered the crash which is still being investigated
+
 ## [20251223.15] - 2025-12-23
 ### Fixed
 - Set Piwigo Album Cover from Selected Photo would only allow setting the cover for the selected photo's album or immediate parent. This fix allow any album cover in the selected photo's album hierarchy to be set to the selected photo
diff --git a/README.md b/README.md
@@ -23,6 +23,7 @@ A Lightroom Classic plugin which publishes images to a Piwigo host via the Piwig
     * New keywords are created if not present in the Piwigo keywords list
     * Tag comparison between LrC and Piwigo is not case sensitive - so for example 'This Is A Keyword' and 'this is a keyword' are treated as the same when sending keywords to Piwigo.
   * GPS location data is only sent via exif so users of the OpenStreetMap plugin need to ensure that location info is included in the Metadata settings on the LrC Publishing Manager
+* The plugin maintains a custom metadata set, Piwigo Publisher Metadata, with details of the most recent publishing activity for an image. NOTE - only images published using release 20251224.16 or later of this plugin will have this metadata.
 * Changes to images which trigger a re-publish will overwrite the previously published Piwigo image.
 * Images removed from the Publish Service are removed from corresponding album on Piwigo
 * Moving a Published Collection under a different Published Collection Set is reflected in the associated Piwigo albums
@@ -34,11 +35,12 @@ A Lightroom Classic plugin which publishes images to a Piwigo host via the Piwig
 
 ## The following functionality is under development:
 
-* Consistency Check - check for images missing on Piwigo and update published status accordingly
+* Metadata customisation - select which LrC metedata fields are used for Piwigo photo Title and Description fields.
 * Metadata Check - check metadata on Piwigo matches Lrc (Title, Caption, GPS, Creator)
 
 ## The following functionality is planned:
 
+* Consistency Check - check for images missing on Piwigo and update published status accordingly
 * Support for the X-PIWIGO-API header instead of Authorization when sending API keys - v16.1 and above
 * Import collection/set/image structure from another publish service
     * if remoteIds / URLs are present these will be copied. Useful to copy another publish service where a Piwigo host is the target without having to clear the existing Piwigo albums prior to re-publishing.
@@ -91,6 +93,10 @@ I am investigating whether there is something else causing this but I suspect so
 
 If you see similar errors please check image sizes prior to raising an issue.
 
+## Logging
+
+Windows logs are UTF-16 and need to be opened with UTF-16 encoding
+
 ## CREDITS
 
 As a user of both Lightroom Classic and Piwigo, the ability use the powerful Publishing Service in LrC to keep my Piwigo galleries up to date is very appealing. I've been a long time user of a popular plugin that has been providing this functionality, but unfortunately since the version 15 release of LrC that has not been available. 
diff --git a/piwigoPublish.lrplugin/CustomMetadata.lua b/piwigoPublish.lrplugin/CustomMetadata.lua
@@ -0,0 +1,84 @@
+--[[
+   
+    CustomeMetadata.lua
+
+    Copyright (C) 2024 Fiona Boston <fiona@fbphotography.uk>.
+
+    This file is part of PiwigoPublish
+
+    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/>.
+]]
+
+
+
+return {
+    schemaVersion = 4,
+    metadataFieldsForPhotos = {
+
+        {
+            dataType = 'url',
+            readOnly = true,
+            searchable = true,
+            browsable = true,
+            id = 'pwHostURL',
+            title = 'Piwigo Host',
+            version = 3
+        },
+        {
+            dataType = 'string',
+            readOnly = true,
+            searchable = true,
+            browsable = true,
+            id = 'pwAlbumName',
+            title = 'Album Name',
+            version = 2
+        },
+        {
+            dataType = 'url',
+            readOnly = true,
+            searchable = false,
+            browsable = false,
+            id = 'pwAlbumURL',
+            title = 'Album URL',
+            version = 4
+        },
+        {
+            dataType = 'url',
+            readOnly = true,
+            searchable = false,
+            browsable = false,
+            id = 'pwImageURL',
+            title = 'Photo URL',
+            version = 4
+        },
+        {
+            dataType = 'string',
+            readOnly = true,
+            searchable = true,
+            browsable = true,
+            id = 'pwUploadDate',
+            title = 'Upload Date',
+            version = 2
+        },
+        {
+            dataType = 'string',
+            readOnly = true,
+            searchable = true,
+            browsable = true,
+            id = 'pwUploadTime',
+            title = 'Upload Time',
+            version = 2
+        },
+    }
+}
diff --git a/piwigoPublish.lrplugin/Info.lua b/piwigoPublish.lrplugin/Info.lua
@@ -23,8 +23,10 @@ return {
     LrSdkVersion = 14.3,
     LrSdkMinimumVersion = 6.0,
     LrPluginName = "Piwigo Publisher",
+    -- typo in PwigoPublish is noted but can't be changed without forcing all services using this plugin to be re-initialised.
     LrToolkitIdentifier = "fiona.boston.PwigoPublish",
-
+    LrMetadataProvider  = 'CustomMetadata.lua',
+    LrMetadataTagsetFactory = 'Tagset.lua',
     LrInitPlugin = "Init.lua",
 
 	LrExportServiceProvider = {
@@ -57,5 +59,5 @@ return {
     
 	LrPluginInfoProvider = 'PluginInfo.lua',
 
-    VERSION = { major=20251223, minor=15, revision=0 },
+    VERSION = { major=20251224, minor=16, revision=0 },
 }
diff --git a/piwigoPublish.lrplugin/Init.lua b/piwigoPublish.lrplugin/Init.lua
@@ -72,5 +72,5 @@ end
 
 _G.PiwigoBusy = false
 _G.iconPath = _PLUGIN:resourceId("icons/icon_med.png")
-_G.pluginVersion = "20251223.15"
+_G.pluginVersion = "20251224.16"
 
diff --git a/piwigoPublish.lrplugin/PWSendMetadata.lua b/piwigoPublish.lrplugin/PWSendMetadata.lua
@@ -96,9 +96,12 @@ local function SendMetadata()
         callStatus = {}
         local metaData = {}
 
+            -- allow custom metadata selection here
         metaData.Creator = lrPhoto:getFormattedMetadata( "creator" ) or ""
         metaData.Title = lrPhoto:getFormattedMetadata("title") or ""
         metaData.Caption = lrPhoto:getFormattedMetadata("caption") or ""
+
+
         metaData.fileName = lrPhoto:getFormattedMetadata("fileName") or ""
         local lrTime = lrPhoto:getRawMetadata("dateTimeOriginal") 
         metaData.dateCreated = LrDate.timeToUserFormat(lrTime, "%Y-%m-%d %H:%M:%S")
diff --git a/piwigoPublish.lrplugin/PiwigoAPI.lua b/piwigoPublish.lrplugin/PiwigoAPI.lua
@@ -531,6 +531,7 @@ function PiwigoAPI.createPublishCollection(catalog, publishService, propertyTabl
     ]]
     return newColl
 end
+
 -- *************************************************
 function PiwigoAPI.ConnectionChange(propertyTable)
 	log:info('PublishDialogSections.ConnectionChange')
@@ -543,6 +544,30 @@ function PiwigoAPI.ConnectionChange(propertyTable)
 	propertyTable.token = ""
 end
 
+-- *************************************************
+function PiwigoAPI.storeMetaData(catalog, propertyTable, lrPhoto, pluginData)
+
+    log:info("PiwigoAPI.storeMetaData - pluginData\n" .. utils.serialiseVar(pluginData))
+    
+    -- set metadata for photo
+    catalog:withWriteAccessDo("Updating " .. lrPhoto:getFormattedMetadata("fileName"),
+    function()
+
+        lrPhoto:setPropertyForPlugin(_PLUGIN,"pwHostURL",pluginData.pwHostURL)
+        lrPhoto:setPropertyForPlugin(_PLUGIN,"pwAlbumName",pluginData.albumName)
+        lrPhoto:setPropertyForPlugin(_PLUGIN,"pwAlbumURL",pluginData.albumUrl)
+        lrPhoto:setPropertyForPlugin(_PLUGIN,"pwImageURL",pluginData.ImageURL)
+        lrPhoto:setPropertyForPlugin(_PLUGIN,"pwUploadDate",pluginData.pwUploadDate)
+        lrPhoto:setPropertyForPlugin(_PLUGIN,"pwUploadTime",pluginData.pwUploadTime)
+
+    end )
+
+
+    -- store mapping between lrPhoto and pwigo id
+    propertyTable.publishedPhotoMap[pluginData.pwImageID] = lrPhoto.localIdentifier
+
+end
+
 -- *************************************************
 function PiwigoAPI.getPublishServicesForPlugin(pluginID)
 -- Helper to get all publish service connections for this plugin
@@ -688,7 +713,7 @@ function PiwigoAPI.pwConnect(propertyTable)
             statusDes = httpHeaders.error.name
             status = httpHeaders.error.errorCode
         else
-            statusDes = httpHeaders.statusDes
+            statusDes = httpHeaders.statusDes or httpHeaders.statusDesc
             status = httpHeaders.status
         end
         LrDialogs.message("Cannot log in to Piwigo - ", status .. ", " .. statusDes)
diff --git a/piwigoPublish.lrplugin/PublishDialogSections.lua b/piwigoPublish.lrplugin/PublishDialogSections.lua
@@ -198,7 +198,7 @@ local function prefsDialog (f, propertyTable)
 	local share = LrView.share
 
 	return {
-		title = "Piwigo Publish Service Configuration Extras",
+		title = "Piwigo Publish Service Configuration and Options",
 		bind_to_object = propertyTable,
 		f:row {
 			f:static_text {
diff --git a/piwigoPublish.lrplugin/PublishTask.lua b/piwigoPublish.lrplugin/PublishTask.lua
@@ -32,6 +32,7 @@ function PublishTask.processRenderedPhotos(functionContext, exportContext)
     end
     PiwigoBusy = true
     local callStatus ={}
+    local catalog = LrApplication.activeCatalog()
     local exportSession = exportContext.exportSession
     local propertyTable = exportContext.propertyTable
     local rv
@@ -54,8 +55,9 @@ function PublishTask.processRenderedPhotos(functionContext, exportContext)
     log:info('PublishTask.processRenderedPhotos - publishSettings:\n' .. utils.serialiseVar(propertyTable))
 
     local publishedCollection = exportContext.publishedCollection
-    local albumId = publishedCollection:getRemoteId()
     local albumName = publishedCollection:getName()
+    local albumId = publishedCollection:getRemoteId()
+    local albumUrl = publishedCollection:getRemoteUrl()
     local parentCollSet = publishedCollection:getParent()
     local parentID = ""
     local requestRepub = false
@@ -118,9 +120,11 @@ function PublishTask.processRenderedPhotos(functionContext, exportContext)
             local filePath = pathOrMessage
             local metaData = {}
             metaData.Albumid = albumId
+            -- allow custom metadata selection here
             metaData.Creator = lrPhoto:getFormattedMetadata( "creator" ) or ""
             metaData.Title = lrPhoto:getFormattedMetadata("title") or ""
             metaData.Caption = lrPhoto:getFormattedMetadata("caption") or ""
+
             metaData.fileName = lrPhoto:getFormattedMetadata("fileName") or ""
             local lrTime = lrPhoto:getRawMetadata("dateTimeOriginal") 
             metaData.dateCreated = LrDate.timeToUserFormat(lrTime, "%Y-%m-%d %H:%M:%S")
@@ -139,7 +143,20 @@ function PublishTask.processRenderedPhotos(functionContext, exportContext)
                 rendition:recordPublishedPhotoId(callStatus.remoteid or "")
                 rendition:recordPublishedPhotoUrl(callStatus.remoteurl or "")
                 rendition:renditionIsDone(true)
-         
+            -- set metadata for photo
+            
+                 catalog:withWriteAccessDo("Updating " .. lrPhoto:getFormattedMetadata("fileName"),
+                    function()
+
+                        lrPhoto:setPropertyForPlugin(_PLUGIN,"pwHostURL",propertyTable.host)
+                        lrPhoto:setPropertyForPlugin(_PLUGIN,"pwAlbumName",albumName)
+                        lrPhoto:setPropertyForPlugin(_PLUGIN,"pwAlbumURL",albumUrl)
+                        lrPhoto:setPropertyForPlugin(_PLUGIN,"pwImageURL",callStatus.remoteurl)
+                        lrPhoto:setPropertyForPlugin(_PLUGIN,"pwUploadDate",os.date("%Y-%m-%d"))
+                        lrPhoto:setPropertyForPlugin(_PLUGIN,"pwUploadTime",os.date("%H:%M:%S"))
+
+                end )
+
             -- photo was uploaded with keywords included, but existing keywords aren't replaced by this process,
             -- so force a metadata update using pwg.images.setInfo with single_value_mode set to "replace" to force old metadata/keywords to be replaced
                 metaData.Remoteid = callStatus.remoteid
@@ -190,10 +207,32 @@ function PublishTask.deletePhotosFromPublishedCollection(publishSettings, arrayO
     end
     PiwigoBusy = true
     local callStatus ={}
+    local errStatus = ""
 
 
+    -- build tables to allow access to catalog LrPhoto object 
     local catalog = LrApplication.activeCatalog()
     local publishedCollection = catalog:getPublishedCollectionByLocalIdentifier(localCollectionId)
+    local publishedPhotos = publishedCollection:getPublishedPhotos()
+    local photosToUnpublish = {}
+    local pubPhotoByRemoteID = {}
+    for _, pubPhoto in pairs(publishedPhotos) do
+        pubPhotoByRemoteID[pubPhoto:getRemoteId()] = pubPhoto
+    end
+
+    -- build table of photo objects for each item in arrayofphotoids
+    for i = 1, #arrayOfPhotoIds do
+        local pwImageID = arrayOfPhotoIds[i]
+        local pubPhoto = pubPhotoByRemoteID[pwImageID]
+        local lrphoto = pubPhoto:getPhoto()
+        photosToUnpublish[i] = {}
+        photosToUnpublish[i][1] = lrphoto
+        photosToUnpublish[i][2] = pwImageID
+        photosToUnpublish[i][3] = pubPhoto
+    end
+    
+    local pwCatID = publishedCollection:getRemoteId()
+
 
     -- check connection to piwigo
     if not (publishSettings.Connected) then
@@ -205,14 +244,52 @@ function PublishTask.deletePhotosFromPublishedCollection(publishSettings, arrayO
         end
     end
 
+    -- set up async prococess for piwigo calls
+     LrTasks.startAsyncTask(function ()
+        -- now go through each photo in photosToUnpublish and renove from Piwigo
+        for i, thisPhotoToUnpublish in pairs(photosToUnpublish) do
+            local thisLrPhoto = thisPhotoToUnpublish[1]
+            local thispwImageID = thisPhotoToUnpublish[2]
+            local thisPubPhoto = thisPhotoToUnpublish[3]
+            callStatus = PiwigoAPI.deletePhoto(publishSettings, pwCatID, thispwImageID, callStatus)
+            if callStatus.status then
+                catalog:withWriteAccessDo("Updating " .. thisLrPhoto:getFormattedMetadata("fileName"),
+                function()
+
+                    thisLrPhoto:setPropertyForPlugin(_PLUGIN,"pwHostURL","")
+                    thisLrPhoto:setPropertyForPlugin(_PLUGIN,"pwAlbumName","")
+                    thisLrPhoto:setPropertyForPlugin(_PLUGIN,"pwAlbumURL","")
+                    thisLrPhoto:setPropertyForPlugin(_PLUGIN,"pwImageURL","")
+                    thisLrPhoto:setPropertyForPlugin(_PLUGIN,"pwUploadDate","")
+                    thisLrPhoto:setPropertyForPlugin(_PLUGIN,"pwUploadTime","")
+                end )
+                thisPhotoToUnpublish[4] = true
+            else
+                PiwigoBusy = false
+                LrErrors.throwUserError('Failed to delete photo ' .. pwImageID .. ' from Piwigo - ' .. callStatus.statusMsg, 'Failed to delete photo')
+            end
+
+
+        end
+    end, errStatus )
+--[[
     for i = 1, #arrayOfPhotoIds do
         local pwImageID = arrayOfPhotoIds[i]
-        local pwCatID = publishedCollection:getRemoteId()
-
+        
 -- check if image is another album on Piwigo
 -- if not, can delete image,otherwise remove association with this ablum
 
         callStatus = PiwigoAPI.deletePhoto(publishSettings,pwCatID,pwImageID, callStatus)
+
+        -- remove custom metadata from photo
+                        lrPhoto:setPropertyForPlugin(_PLUGIN,"pwHostURL",propertyTable.host)
+                        lrPhoto:setPropertyForPlugin(_PLUGIN,"pwAlbumName",albumName)
+                        lrPhoto:setPropertyForPlugin(_PLUGIN,"pwAlbumURL",albumUrl)
+                        lrPhoto:setPropertyForPlugin(_PLUGIN,"pwImageURL",callStatus.remoteurl)
+                        lrPhoto:setPropertyForPlugin(_PLUGIN,"pwUploadDate",os.date("%Y-%m-%d"))
+                        lrPhoto:setPropertyForPlugin(_PLUGIN,"pwUploadTime",os.date("%H:%M:%S"))
+
+
         if callStatus.status then
             deletedCallback(arrayOfPhotoIds[i])
         else
@@ -221,6 +298,13 @@ function PublishTask.deletePhotosFromPublishedCollection(publishSettings, arrayO
         end
         deletedCallback( pwImageID)
     end
+]]
+    -- now finish process via deletedCallback
+    for i, thisPhotoToUnpublish in pairs(photosToUnpublish) do
+        local thispwImageID = thisPhotoToUnpublish[2]
+        deletedCallback(thispwImageID)
+    end
+
     PiwigoBusy = false
 end
 
diff --git a/piwigoPublish.lrplugin/Tagset.lua b/piwigoPublish.lrplugin/Tagset.lua
