Add option to enable a Publish Collection to be converted to a Publish Collection Set

Author: fjb2020

CHANGELOG.md

@@ -1,4 +1,8 @@
 # Changelog
+## [20251219.14] - 2025-12-19
+### Added
+- A new menu item has been added Library->Plug-in Extras->Piwigo Publisher->Convert selected Published Collection to Published Collection Set.  This option enables a Publish Collection to be converted to a Publish Collection Set, enabling sub albums to be created under this album.
+
 ## [20251218.13] - 2025-12-18
 ### Fixed
 - Send Metadata to Piwigo for Selected Photos crashed when photos weren't selected from a Publish Service

README.md

@@ -9,6 +9,7 @@ A Lightroom Classic plugin which publishes images to a Piwigo host via the Piwig
     * Images are not downloaded from Piwigo as part of this, nor are existing images in LrC automatically added to the newly created Published Collections.
 * Images added to the Publish Service are published to the corresponding album on Piwigo. Metadata and keywords are transferred, respecting rules configured in the Publishing Manager for this service.
 * Special collections can be created which allow images to be published to Piwigo albums that also have sub-albums. See details in the notes on the relationship between Piwigo Albums and LrC Publish Services below.
+* The plugin allows a Publish Collection to be converted to a Publish Collection Set - a Special Collection is created for the new Publish Collection Set and any photos that were in the converted Publish Collection will be in this Special Collection. This enables sub albums to be created under an album that was initially created for photos only.
 * Set Piwigo album cover from an image in the Published Collection
 * Metadata and keywords are exported directly to Piwigo regardless of exif/iptc settings - as part of the publish process along with the photo, or separately via a menu on the Library -> Plug-in Extras menu - which sends the metadata without re-sending the photo.
   * the following fields are set : 
@@ -52,7 +53,7 @@ The plugin provides a function to import an existing Piwigo album structure into
 - If a Piwigo album contains sub-albums, an equivalent Publish Collection Set is created in the LrC Publish Service.
 - If a Piwigo album contains only photographs (i.e. no sub-albums) or is empty then a Publish Collection is created in the LrC Publish Service.
 - Piwigo allows an album to contain both photographs and sub albums. LrC does not allow this - a Publish Collection Set can contain only further Publish Collection Sets, or Publish Collections, not both. Publish Collections can contain only photographs and not further Publish Collection Sets. 
-  - The workround for this constraint is the the creation of specical collections (an option in the Piwigo Publish Service Configuration Extras section of the Publishing Manager). This creates a specially named collection for each collection set, linked to the parent album in Piwigo. Any photos in these collections are published to the Piwigo parent album. 
+  - The workround for this constraint is the the creation of specical collections (an option in the Piwigo Publish Service Configuration Extras section of the Publishing Manager). This creates a 'Special Collection', named "[Photos in *CollectionSetName* ]" for each collection set, linked to the parent album in Piwigo. Any photos in these collections are published to the Piwigo parent album. 
 - Piwigo allows albums with the same name to exist under the same parent. LrC does not allow this - albums with the same name can only exist if they are sub albums of different parents within the publish service.
 - The plugin allows the alteration of the Piwigo album structure:
   - New albums containing photographs can be created - right-click in Publish Service -> Create Piwigo Album... or Create Piwigo Album (Smart collection)...

piwigoPublish.lrplugin/Info.lua

@@ -49,9 +49,13 @@ return {
             title = "Send Metadata to Piwigo for Selected Photos",
             file = "PWSendMetadata.lua",
         },
+        {
+            title = "Convert selected Published Collection to Published Collection Set",
+            file = "PWCollToSet.lua",
+        },
     },
 
 	LrPluginInfoProvider = 'PluginInfo.lua',
 
-    VERSION = { major=20251218, minor=13, revision=0 },
+    VERSION = { major=20251219, minor=14, revision=0 },
 }

piwigoPublish.lrplugin/Init.lua

@@ -72,5 +72,5 @@ end
 
 _G.PiwigoBusy = false
 _G.iconPath = _PLUGIN:resourceId("icons/icon_med.png")
-_G.pluginVersion = "20251218.13"
+_G.pluginVersion = "20251219.14"
 

piwigoPublish.lrplugin/PWCollToSet.lua

@@ -0,0 +1,113 @@
+--[[
+   
+    PWCollToSet.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/>.
+]]
+
+--*******************************************
+local function CollToSet()
+    log:info("CollToSet")
+    local callStatus = {}
+    local catalog = LrApplication.activeCatalog()
+
+    local selPhotos =  catalog:getTargetPhotos()
+    local sources = catalog:getActiveSources()
+    --[[
+    if utils.nilOrEmpty(selPhotos) then
+        LrDialogs.message("Please select photos to resend metadata","","warning")
+        return false
+    end
+    ]]
+    -- is source a LrPublishedCollection or LrPublishedCollectionSet in selected published service
+    local useService = nil
+    local selectedCollection = nil
+    local catId = nil
+    local publishSettings = nil
+    for s, source in pairs(sources) do
+        if type(source) == "table" and source.type then
+            local srcType = source:type()
+            if srcType == "LrPublishedCollection" or srcType == "LrPublishedCollectionSet" then
+                local thisService = source:getService()
+                local thisSettings = thisService:getPublishSettings()
+                -- is this publish service using this plugin?
+                local thisPluginId = thisService:getPluginId()
+                if thisPluginId == _PLUGIN.id then
+                    useService = thisService
+                    selectedCollection = source
+                    publishSettings = thisSettings
+                    break
+                end
+            end
+        end
+    end
+
+    if not selectedCollection then
+        LrDialogs.message("CollToSet - Can't access collection object for this publish collection - check selection","","warning")
+        return false
+    end
+    if selectedCollection:type() == "LrPublishedCollectionSet" then
+        LrDialogs.message("CollToSet - You have selected a Published Collection Set - please select a Published Collection","","warning")
+        return false   
+    end
+
+    if not useService then
+        LrDialogs.message("Please select a Collection within a Piwigo Publisher service","","warning")
+        return false
+    end
+    if not publishSettings then
+        LrDialogs.message("CollToSet - Can't find publish settings for this publish collection","","warning")
+        return false
+    end
+    local selCollName = selectedCollection:getName()
+    local selColParent = selectedCollection:getParent()
+    catId = selectedCollection:getRemoteId()
+    local selColParentName = nil
+    local checkSCName = ""
+    -- check that selected collection is not already a special collection
+    if selColParent then
+        if selCollName == PiwigoAPI.buildSpecialCollectionName(selColParent:getName()) then
+            LrDialogs.message("Special Collections cannot be converted to Collection Sets","","warning")
+            return false
+        end
+    end
+
+    local result = LrDialogs.confirm("Covert Publish Collection to Set","Convert " ..selCollName .." to a Publish Collection Set?", "Ok","Cancel")
+    if result ~= 'ok' then
+        return false
+    end
+
+    -- 1 - rename seleted collection to a special collection name
+    local newName = PiwigoAPI.buildSpecialCollectionName(selCollName)
+    local rv = PiwigoAPI.setCollectionDets(selectedCollection, catalog, publishSettings, newName, catId, selColParent)
+
+    -- 2 - Create new collection set
+    -- Set parent and remote id same as selected collection parent
+    local newCollSet = PiwigoAPI.createPublishCollectionSet(catalog, useService, publishSettings, selCollName, catId, selColParent)
+    if not newCollSet then
+        LrDialogs.message("CollToSet - Can't fcreate new collection set " .. selCollName,"","warning")
+        return false 
+    end
+    
+    -- 3 - Set parent of selected collection to the new collection set
+    rv = PiwigoAPI.setCollectionDets(selectedCollection, catalog, publishSettings, newName, catId, newCollSet)
+
+
+end
+
+LrTasks.startAsyncTask(CollToSet)

piwigoPublish.lrplugin/PWSendMetadata.lua

@@ -42,7 +42,6 @@ local function SendMetadata()
         if type(source) == "table" and source.type then
             local srcType = source:type()
             if srcType == "LrPublishedCollection" or srcType == "LrPublishedCollectionSet" then
-                log:info("Source " .. s .. " is " .. source:getName() )
                 local thisService = source:getService()
                 local thisSettings = thisService:getPublishSettings()
                 -- is this publish service using this plugin?

piwigoPublish.lrplugin/PWSetAlbumCover.lua

@@ -41,9 +41,6 @@ local function SetAlbumCover()
 
 -- we now have a single photo.
     local selPhoto = selPhotos[1]
-    log:info("Selected photo is " .. selPhoto.localIdentifier)
-
-
     -- is source a LrPublishedCollection or LrPublishedCollectionSet in selected published service
     local useService = nil
     local useSource = nil
@@ -53,7 +50,6 @@ local function SetAlbumCover()
         if type(source) == "table" and source.type then
             local srcType = source:type()
             if srcType == "LrPublishedCollection" or srcType == "LrPublishedCollectionSet" then
-                log:info("Source " .. s .. " is " .. source:getName() )
                 local thisService = source:getService()
                 local thisSettings = thisService:getPublishSettings()
                 -- is this publish service using this plugin?

piwigoPublish.lrplugin/PiwigoAPI.lua

@@ -326,22 +326,9 @@ local function buildCategoryPath(cat, allCats)
 
     return path
 end
--- *************************************************
-local function createPublishCollection(catalog, publishService, propertyTable, name, remoteId, parentSet)
-    -- create new collection or return existing
-    log:info("createPublishCollection - " .. name .. ", " .. remoteId)
-    local newColl
-    catalog:withWriteAccessDo("Create PublishedCollection ", function()
-        newColl = publishService:createPublishedCollection( name, parentSet, true )
-    end)
-    -- add remoteids and urls to collection
-    catalog:withWriteAccessDo("Add Piwigo details to collection", function() 
-        newColl:setRemoteId( remoteId)
-        newColl:setRemoteUrl( propertyTable.host .. "/index.php?/category/" .. remoteId )
-        newColl:setName( name )
-    end)
-    return newColl
-end
+
+
+
 
 
 -- *************************************************
@@ -453,6 +440,97 @@ end
 -- G L O B A L   F U N C T I O N S
 -- *************************************************
 
+-- *************************************************
+function PiwigoAPI.fixSpecialCollectionNames(catalog, publishService, propertyTable)
+    -- fix extra space in specialCollectionNames
+    -- get all collectionsets
+    local collSets = {}
+    collSets = utils.recursePubCollectionSets(publishService, collSets)
+
+    -- Now look for specialCollections for each collset 
+    for cs, collSet in pairs(collSets) do
+        local childColls = collSet:getChildren()
+        if childColls then
+            local parentName = collSet:getName()
+            for cc, childCol in pairs(childColls) do
+                local ccName = childCol:getName()
+                local remoteId = childCol:getRemoteId()
+                if string.sub(ccName,1,11) == "[ Photos in" and string.sub(ccName,-2) == " ]" then
+                    -- special collection - fix name by removing space prior to ]
+                    local newName = PiwigoAPI.buildSpecialCollectionName(parentName)
+                    log:info("PiwigoAPI.fixSpecialCollectionNames - " .. ccName .. " fixed to " .. newName)
+                    catalog:withWriteAccessDo("Set Collection Name", function() 
+                        childCol:setName( newName )
+                    end)
+                end
+            end 
+        end
+    end
+end
+
+-- *************************************************
+function PiwigoAPI.buildSpecialCollectionName(name)
+    -- consistently build special collection name
+    local scName = "[Photos in " .. name.. " ]"
+    return scName
+end
+
+
+
+-- *************************************************
+function PiwigoAPI.setCollectionDets(thisCollorSet, catalog, propertyTable, name, remoteId, parentSet)
+    catalog:withWriteAccessDo("Add Piwigo details to collection", function() 
+        thisCollorSet:setRemoteId( remoteId )
+        thisCollorSet:setRemoteUrl( propertyTable.host .. "/index.php?/category/" .. remoteId )
+        thisCollorSet:setName( name )
+        thisCollorSet:setParent( parentSet )
+    end)
+    return true
+end
+
+-- *************************************************
+function PiwigoAPI.createPublishCollectionSet(catalog, publishService, propertyTable, name, remoteId, parentSet)
+
+
+    --PiwigoAPI.createPublishCollectionSet(catalog, useService, publishSettings, selCollName, catId, selColParent)
+    -- create new publish collection set or return existing
+    log:info("createPublishCollectionSet - " .. name .. ", " .. remoteId)
+    local newColl
+    catalog:withWriteAccessDo("Create PublishedCollectionSet ", function()
+        newColl = publishService:createPublishedCollectionSet( name, parentSet, true )
+    end)
+    -- add remoteids and urls to collection
+    PiwigoAPI.setCollectionDets(newColl, catalog, propertyTable, name, remoteId, parentSet)
+    --[[
+    catalog:withWriteAccessDo("Add Piwigo details to collection", function() 
+        newColl:setRemoteId( remoteId)
+        newColl:setRemoteUrl( propertyTable.host .. "/index.php?/category/" .. remoteId )
+        newColl:setName( name )
+    end)
+    ]]
+    return newColl
+
+end
+
+-- *************************************************
+function PiwigoAPI.createPublishCollection(catalog, publishService, propertyTable, name, remoteId, parentSet)
+    -- create new publish collection or return existing
+    log:info("createPublishCollection - " .. name .. ", " .. remoteId)
+    local newColl
+    catalog:withWriteAccessDo("Create PublishedCollection ", function()
+        newColl = publishService:createPublishedCollection( name, parentSet, true )
+    end)
+    -- add remoteids and urls to collection
+    PiwigoAPI.setCollectionDets(newColl, catalog, propertyTable, name, remoteId, parentSet)
+    --[[
+    catalog:withWriteAccessDo("Add Piwigo details to collection", function() 
+        newColl:setRemoteId( remoteId)
+        newColl:setRemoteUrl( propertyTable.host .. "/index.php?/category/" .. remoteId )
+        newColl:setName( name )
+    end)
+    ]]
+    return newColl
+end
 -- *************************************************
 function PiwigoAPI.ConnectionChange(propertyTable)
 	log:info('PublishDialogSections.ConnectionChange')
@@ -1341,14 +1419,21 @@ function PiwigoAPI.specialCollections(propertyTable)
         caption = "Starting...",
         functionContext = context,
     }
-
+    --[[
+    -- check if scNameFix has been run and run it if not
+    if not(propertyTable.scNameFix) then
+        log:info("PiwigoAPI.specialCollections - running scNameFix")
+        rv = PiwigoAPI.fixSpecialCollectionNames(catalog, publishService, propertyTable)
+        propertyTable.scNameFix = true
+    end
+    ]]
     for s, thisSet in pairs(allSets) do
         progressScope:setPortionComplete(s, #allSets)
         progressScope:setCaption("Processing " .. s .. " of " .. #allSets .. " collction sets")
         local remoteId = thisSet:getRemoteId()
         local name = thisSet:getName()
-        local scName = "[Photos in " .. name .. " ]"
-        local scColl = createPublishCollection(catalog, publishService, propertyTable, scName, remoteId, thisSet)
+        local scName = PiwigoAPI.buildSpecialCollectionName(name)
+        local scColl = PiwigoAPI.createPublishCollection(catalog, publishService, propertyTable, scName, remoteId, thisSet)
         if scColl == nil then
             LrDialogs.message("Failed to create special collection for " .. name,"","warning")
         end

piwigoPublish.lrplugin/PublishServiceProvider.lua

@@ -52,6 +52,7 @@ return {
 		{ key = "userPW", default = '' },
 		{ key = "KwFullHierarchy", default = true},
 		{ key = "KwSynonyms", default = true},
+        --{ key = "scNameFix",default = false}
 
 	},