view OrthancServer/Sources/Database/InstallDeletedFiles.sql @ 6161:c07e55229823 attach-custom-data

allow custom data to be binary
author Sebastien Jodogne <s.jodogne@gmail.com>
date Sat, 07 Jun 2025 18:50:42 +0200
parents e77c045e5656
children 9e1bf1a1af50
line wrap: on
line source

-- Orthanc - A Lightweight, RESTful DICOM Store
-- Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics
-- Department, University Hospital of Liege, Belgium
-- Copyright (C) 2017-2022 Osimis S.A., Belgium
-- Copyright (C) 2021-2022 Sebastien Jodogne, ICTEAM UCLouvain, Belgium
--
-- 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/>.


CREATE TABLE DeletedFiles(
       uuid TEXT NOT NULL,        -- 0
       customData TEXT            -- 1
);

-- We need to use another AttachedFileDeleted trigger than the legacy one in "Upgrade4To5.sql".
--
-- We want to keep backward compatibility and avoid changing the database version number (which would force
-- users to upgrade the DB).  By keeping backward compatibility, we mean "allow a user to run a previous Orthanc
-- version after it has run this update script".
-- We must preserve the signature of the initial trigger (it is impossible to have 2 triggers on the same event).
-- We tried adding a trigger on "BEFORE DELETE" but then it is being called when running the previous Orthanc
-- which makes it fail.
-- But, we need the customData in the C++ function that is called when a AttachedFiles is deleted.
-- The trick is then to save the customData in a DeletedFiles table.
-- The SignalFileDeleted C++ function will then get the customData from this table and delete the entry.
-- Drawback: if you downgrade Orthanc, the DeletedFiles table will remain and will be populated by the trigger
-- but not consumed by the C++ function -> we consider this is an acceptable drawback for a few people compared
-- to the burden of upgrading the DB.

DROP TRIGGER IF EXISTS AttachedFileDeleted;

CREATE TRIGGER AttachedFileDeleted
AFTER DELETE ON AttachedFiles
BEGIN
  INSERT INTO DeletedFiles VALUES(old.uuid, old.customData);
  SELECT SignalFileDeleted(old.uuid, old.fileType, old.uncompressedSize,
                           old.compressionType, old.compressedSize,
                           old.uncompressedMD5, old.compressedMD5
                           );
END;