Mercurial > hg > orthanc
view OrthancServer/Resources/Graveyard/DatabasePluginSample/DatabaseWrapperBase.cpp @ 4988:8fba26292a9f
Housekeeper plugin: finalizing + integration tests ok
author | Alain Mazy <am@osimis.io> |
---|---|
date | Sat, 30 Apr 2022 19:39:40 +0200 |
parents | 6eff25f70121 |
children | 0ea402b4d901 |
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/>. **/ #include "../../../Sources/PrecompiledHeadersServer.h" #include "DatabaseWrapperBase.h" #include <stdio.h> #include <memory> namespace Orthanc { void DatabaseWrapperBase::SetGlobalProperty(GlobalProperty property, const std::string& value) { SQLite::Statement s(db_, SQLITE_FROM_HERE, "INSERT OR REPLACE INTO GlobalProperties VALUES(?, ?)"); s.BindInt(0, property); s.BindString(1, value); s.Run(); } bool DatabaseWrapperBase::LookupGlobalProperty(std::string& target, GlobalProperty property) { SQLite::Statement s(db_, SQLITE_FROM_HERE, "SELECT value FROM GlobalProperties WHERE property=?"); s.BindInt(0, property); if (!s.Step()) { return false; } else { target = s.ColumnString(0); return true; } } int64_t DatabaseWrapperBase::CreateResource(const std::string& publicId, ResourceType type) { SQLite::Statement s(db_, SQLITE_FROM_HERE, "INSERT INTO Resources VALUES(NULL, ?, ?, NULL)"); s.BindInt(0, type); s.BindString(1, publicId); s.Run(); return db_.GetLastInsertRowId(); } bool DatabaseWrapperBase::LookupResource(int64_t& id, ResourceType& type, const std::string& publicId) { SQLite::Statement s(db_, SQLITE_FROM_HERE, "SELECT internalId, resourceType FROM Resources WHERE publicId=?"); s.BindString(0, publicId); if (!s.Step()) { return false; } else { id = s.ColumnInt(0); type = static_cast<ResourceType>(s.ColumnInt(1)); // Check whether there is a single resource with this public id assert(!s.Step()); return true; } } ErrorCode DatabaseWrapperBase::LookupParent(bool& found, int64_t& parentId, int64_t resourceId) { SQLite::Statement s(db_, SQLITE_FROM_HERE, "SELECT parentId FROM Resources WHERE internalId=?"); s.BindInt64(0, resourceId); if (!s.Step()) { return ErrorCode_UnknownResource; } if (s.ColumnIsNull(0)) { found = false; } else { found = true; parentId = s.ColumnInt(0); } return ErrorCode_Success; } bool DatabaseWrapperBase::GetPublicId(std::string& result, int64_t resourceId) { SQLite::Statement s(db_, SQLITE_FROM_HERE, "SELECT publicId FROM Resources WHERE internalId=?"); s.BindInt64(0, resourceId); if (!s.Step()) { return false; } else { result = s.ColumnString(0); return true; } } ErrorCode DatabaseWrapperBase::GetResourceType(ResourceType& result, int64_t resourceId) { SQLite::Statement s(db_, SQLITE_FROM_HERE, "SELECT resourceType FROM Resources WHERE internalId=?"); s.BindInt64(0, resourceId); if (s.Step()) { result = static_cast<ResourceType>(s.ColumnInt(0)); return ErrorCode_Success; } else { return ErrorCode_UnknownResource; } } void DatabaseWrapperBase::AttachChild(int64_t parent, int64_t child) { SQLite::Statement s(db_, SQLITE_FROM_HERE, "UPDATE Resources SET parentId = ? WHERE internalId = ?"); s.BindInt64(0, parent); s.BindInt64(1, child); s.Run(); } void DatabaseWrapperBase::SetMetadata(int64_t id, MetadataType type, const std::string& value) { SQLite::Statement s(db_, SQLITE_FROM_HERE, "INSERT OR REPLACE INTO Metadata VALUES(?, ?, ?)"); s.BindInt64(0, id); s.BindInt(1, type); s.BindString(2, value); s.Run(); } void DatabaseWrapperBase::DeleteMetadata(int64_t id, MetadataType type) { SQLite::Statement s(db_, SQLITE_FROM_HERE, "DELETE FROM Metadata WHERE id=? and type=?"); s.BindInt64(0, id); s.BindInt(1, type); s.Run(); } bool DatabaseWrapperBase::LookupMetadata(std::string& target, int64_t id, MetadataType type) { SQLite::Statement s(db_, SQLITE_FROM_HERE, "SELECT value FROM Metadata WHERE id=? AND type=?"); s.BindInt64(0, id); s.BindInt(1, type); if (!s.Step()) { return false; } else { target = s.ColumnString(0); return true; } } void DatabaseWrapperBase::ListAvailableMetadata(std::list<MetadataType>& target, int64_t id) { target.clear(); SQLite::Statement s(db_, SQLITE_FROM_HERE, "SELECT type FROM Metadata WHERE id=?"); s.BindInt64(0, id); while (s.Step()) { target.push_back(static_cast<MetadataType>(s.ColumnInt(0))); } } void DatabaseWrapperBase::AddAttachment(int64_t id, const FileInfo& attachment) { SQLite::Statement s(db_, SQLITE_FROM_HERE, "INSERT INTO AttachedFiles VALUES(?, ?, ?, ?, ?, ?, ?, ?)"); s.BindInt64(0, id); s.BindInt(1, attachment.GetContentType()); s.BindString(2, attachment.GetUuid()); s.BindInt64(3, attachment.GetCompressedSize()); s.BindInt64(4, attachment.GetUncompressedSize()); s.BindInt(5, attachment.GetCompressionType()); s.BindString(6, attachment.GetUncompressedMD5()); s.BindString(7, attachment.GetCompressedMD5()); s.Run(); } void DatabaseWrapperBase::DeleteAttachment(int64_t id, FileContentType attachment) { SQLite::Statement s(db_, SQLITE_FROM_HERE, "DELETE FROM AttachedFiles WHERE id=? AND fileType=?"); s.BindInt64(0, id); s.BindInt(1, attachment); s.Run(); } void DatabaseWrapperBase::ListAvailableAttachments(std::list<FileContentType>& target, int64_t id) { target.clear(); SQLite::Statement s(db_, SQLITE_FROM_HERE, "SELECT fileType FROM AttachedFiles WHERE id=?"); s.BindInt64(0, id); while (s.Step()) { target.push_back(static_cast<FileContentType>(s.ColumnInt(0))); } } bool DatabaseWrapperBase::LookupAttachment(FileInfo& attachment, int64_t id, FileContentType contentType) { SQLite::Statement s(db_, SQLITE_FROM_HERE, "SELECT uuid, uncompressedSize, compressionType, compressedSize, uncompressedMD5, compressedMD5 FROM AttachedFiles WHERE id=? AND fileType=?"); s.BindInt64(0, id); s.BindInt(1, contentType); if (!s.Step()) { return false; } else { attachment = FileInfo(s.ColumnString(0), contentType, s.ColumnInt64(1), s.ColumnString(4), static_cast<CompressionType>(s.ColumnInt(2)), s.ColumnInt64(3), s.ColumnString(5)); return true; } } void DatabaseWrapperBase::ClearMainDicomTags(int64_t id) { { SQLite::Statement s(db_, SQLITE_FROM_HERE, "DELETE FROM DicomIdentifiers WHERE id=?"); s.BindInt64(0, id); s.Run(); } { SQLite::Statement s(db_, SQLITE_FROM_HERE, "DELETE FROM MainDicomTags WHERE id=?"); s.BindInt64(0, id); s.Run(); } } void DatabaseWrapperBase::SetMainDicomTag(int64_t id, const DicomTag& tag, const std::string& value) { SQLite::Statement s(db_, SQLITE_FROM_HERE, "INSERT INTO MainDicomTags VALUES(?, ?, ?, ?)"); s.BindInt64(0, id); s.BindInt(1, tag.GetGroup()); s.BindInt(2, tag.GetElement()); s.BindString(3, value); s.Run(); } void DatabaseWrapperBase::SetIdentifierTag(int64_t id, const DicomTag& tag, const std::string& value) { SQLite::Statement s(db_, SQLITE_FROM_HERE, "INSERT INTO DicomIdentifiers VALUES(?, ?, ?, ?)"); s.BindInt64(0, id); s.BindInt(1, tag.GetGroup()); s.BindInt(2, tag.GetElement()); s.BindString(3, value); s.Run(); } void DatabaseWrapperBase::GetMainDicomTags(DicomMap& map, int64_t id) { map.Clear(); SQLite::Statement s(db_, SQLITE_FROM_HERE, "SELECT * FROM MainDicomTags WHERE id=?"); s.BindInt64(0, id); while (s.Step()) { map.SetValue(s.ColumnInt(1), s.ColumnInt(2), s.ColumnString(3), false); } } void DatabaseWrapperBase::GetChildrenPublicId(std::list<std::string>& target, int64_t id) { SQLite::Statement s(db_, SQLITE_FROM_HERE, "SELECT a.publicId FROM Resources AS a, Resources AS b " "WHERE a.parentId = b.internalId AND b.internalId = ?"); s.BindInt64(0, id); target.clear(); while (s.Step()) { target.push_back(s.ColumnString(0)); } } void DatabaseWrapperBase::GetChildrenInternalId(std::list<int64_t>& target, int64_t id) { SQLite::Statement s(db_, SQLITE_FROM_HERE, "SELECT a.internalId FROM Resources AS a, Resources AS b " "WHERE a.parentId = b.internalId AND b.internalId = ?"); s.BindInt64(0, id); target.clear(); while (s.Step()) { target.push_back(s.ColumnInt64(0)); } } void DatabaseWrapperBase::LogChange(int64_t internalId, const ServerIndexChange& change) { SQLite::Statement s(db_, SQLITE_FROM_HERE, "INSERT INTO Changes VALUES(NULL, ?, ?, ?, ?)"); s.BindInt(0, change.GetChangeType()); s.BindInt64(1, internalId); s.BindInt(2, change.GetResourceType()); s.BindString(3, change.GetDate()); s.Run(); } ErrorCode DatabaseWrapperBase::GetChangesInternal(std::list<ServerIndexChange>& target, bool& done, SQLite::Statement& s, uint32_t maxResults) { target.clear(); while (target.size() < maxResults && s.Step()) { int64_t seq = s.ColumnInt64(0); ChangeType changeType = static_cast<ChangeType>(s.ColumnInt(1)); ResourceType resourceType = static_cast<ResourceType>(s.ColumnInt(3)); const std::string& date = s.ColumnString(4); int64_t internalId = s.ColumnInt64(2); std::string publicId; if (!GetPublicId(publicId, internalId)) { return ErrorCode_UnknownResource; } target.push_back(ServerIndexChange(seq, changeType, resourceType, publicId, date)); } done = !(target.size() == maxResults && s.Step()); return ErrorCode_Success; } ErrorCode DatabaseWrapperBase::GetChanges(std::list<ServerIndexChange>& target, bool& done, int64_t since, uint32_t maxResults) { SQLite::Statement s(db_, SQLITE_FROM_HERE, "SELECT * FROM Changes WHERE seq>? ORDER BY seq LIMIT ?"); s.BindInt64(0, since); s.BindInt(1, maxResults + 1); return GetChangesInternal(target, done, s, maxResults); } ErrorCode DatabaseWrapperBase::GetLastChange(std::list<ServerIndexChange>& target) { bool done; // Ignored SQLite::Statement s(db_, SQLITE_FROM_HERE, "SELECT * FROM Changes ORDER BY seq DESC LIMIT 1"); return GetChangesInternal(target, done, s, 1); } void DatabaseWrapperBase::LogExportedResource(const ExportedResource& resource) { SQLite::Statement s(db_, SQLITE_FROM_HERE, "INSERT INTO ExportedResources VALUES(NULL, ?, ?, ?, ?, ?, ?, ?, ?)"); s.BindInt(0, resource.GetResourceType()); s.BindString(1, resource.GetPublicId()); s.BindString(2, resource.GetModality()); s.BindString(3, resource.GetPatientId()); s.BindString(4, resource.GetStudyInstanceUid()); s.BindString(5, resource.GetSeriesInstanceUid()); s.BindString(6, resource.GetSopInstanceUid()); s.BindString(7, resource.GetDate()); s.Run(); } void DatabaseWrapperBase::GetExportedResourcesInternal(std::list<ExportedResource>& target, bool& done, SQLite::Statement& s, uint32_t maxResults) { target.clear(); while (target.size() < maxResults && s.Step()) { int64_t seq = s.ColumnInt64(0); ResourceType resourceType = static_cast<ResourceType>(s.ColumnInt(1)); std::string publicId = s.ColumnString(2); ExportedResource resource(seq, resourceType, publicId, s.ColumnString(3), // modality s.ColumnString(8), // date s.ColumnString(4), // patient ID s.ColumnString(5), // study instance UID s.ColumnString(6), // series instance UID s.ColumnString(7)); // sop instance UID target.push_back(resource); } done = !(target.size() == maxResults && s.Step()); } void DatabaseWrapperBase::GetExportedResources(std::list<ExportedResource>& target, bool& done, int64_t since, uint32_t maxResults) { SQLite::Statement s(db_, SQLITE_FROM_HERE, "SELECT * FROM ExportedResources WHERE seq>? ORDER BY seq LIMIT ?"); s.BindInt64(0, since); s.BindInt(1, maxResults + 1); GetExportedResourcesInternal(target, done, s, maxResults); } void DatabaseWrapperBase::GetLastExportedResource(std::list<ExportedResource>& target) { bool done; // Ignored SQLite::Statement s(db_, SQLITE_FROM_HERE, "SELECT * FROM ExportedResources ORDER BY seq DESC LIMIT 1"); GetExportedResourcesInternal(target, done, s, 1); } uint64_t DatabaseWrapperBase::GetTotalCompressedSize() { SQLite::Statement s(db_, SQLITE_FROM_HERE, "SELECT SUM(compressedSize) FROM AttachedFiles"); s.Run(); return static_cast<uint64_t>(s.ColumnInt64(0)); } uint64_t DatabaseWrapperBase::GetTotalUncompressedSize() { SQLite::Statement s(db_, SQLITE_FROM_HERE, "SELECT SUM(uncompressedSize) FROM AttachedFiles"); s.Run(); return static_cast<uint64_t>(s.ColumnInt64(0)); } void DatabaseWrapperBase::GetAllInternalIds(std::list<int64_t>& target, ResourceType resourceType) { SQLite::Statement s(db_, SQLITE_FROM_HERE, "SELECT internalId FROM Resources WHERE resourceType=?"); s.BindInt(0, resourceType); target.clear(); while (s.Step()) { target.push_back(s.ColumnInt64(0)); } } void DatabaseWrapperBase::GetAllPublicIds(std::list<std::string>& target, ResourceType resourceType) { SQLite::Statement s(db_, SQLITE_FROM_HERE, "SELECT publicId FROM Resources WHERE resourceType=?"); s.BindInt(0, resourceType); target.clear(); while (s.Step()) { target.push_back(s.ColumnString(0)); } } void DatabaseWrapperBase::GetAllPublicIds(std::list<std::string>& target, ResourceType resourceType, size_t since, size_t limit) { if (limit == 0) { target.clear(); return; } SQLite::Statement s(db_, SQLITE_FROM_HERE, "SELECT publicId FROM Resources WHERE resourceType=? LIMIT ? OFFSET ?"); s.BindInt(0, resourceType); s.BindInt64(1, limit); s.BindInt64(2, since); target.clear(); while (s.Step()) { target.push_back(s.ColumnString(0)); } } uint64_t DatabaseWrapperBase::GetResourceCount(ResourceType resourceType) { SQLite::Statement s(db_, SQLITE_FROM_HERE, "SELECT COUNT(*) FROM Resources WHERE resourceType=?"); s.BindInt(0, resourceType); if (!s.Step()) { return 0; } else { int64_t c = s.ColumnInt(0); assert(!s.Step()); return c; } } bool DatabaseWrapperBase::SelectPatientToRecycle(int64_t& internalId) { SQLite::Statement s(db_, SQLITE_FROM_HERE, "SELECT patientId FROM PatientRecyclingOrder ORDER BY seq ASC LIMIT 1"); if (!s.Step()) { // No patient remaining or all the patients are protected return false; } else { internalId = s.ColumnInt(0); return true; } } bool DatabaseWrapperBase::SelectPatientToRecycle(int64_t& internalId, int64_t patientIdToAvoid) { SQLite::Statement s(db_, SQLITE_FROM_HERE, "SELECT patientId FROM PatientRecyclingOrder " "WHERE patientId != ? ORDER BY seq ASC LIMIT 1"); s.BindInt64(0, patientIdToAvoid); if (!s.Step()) { // No patient remaining or all the patients are protected return false; } else { internalId = s.ColumnInt(0); return true; } } bool DatabaseWrapperBase::IsProtectedPatient(int64_t internalId) { SQLite::Statement s(db_, SQLITE_FROM_HERE, "SELECT * FROM PatientRecyclingOrder WHERE patientId = ?"); s.BindInt64(0, internalId); return !s.Step(); } void DatabaseWrapperBase::SetProtectedPatient(int64_t internalId, bool isProtected) { if (isProtected) { SQLite::Statement s(db_, SQLITE_FROM_HERE, "DELETE FROM PatientRecyclingOrder WHERE patientId=?"); s.BindInt64(0, internalId); s.Run(); } else if (IsProtectedPatient(internalId)) { SQLite::Statement s(db_, SQLITE_FROM_HERE, "INSERT INTO PatientRecyclingOrder VALUES(NULL, ?)"); s.BindInt64(0, internalId); s.Run(); } else { // Nothing to do: The patient is already unprotected } } bool DatabaseWrapperBase::IsExistingResource(int64_t internalId) { SQLite::Statement s(db_, SQLITE_FROM_HERE, "SELECT * FROM Resources WHERE internalId=?"); s.BindInt64(0, internalId); return s.Step(); } void DatabaseWrapperBase::LookupIdentifier(std::list<int64_t>& target, ResourceType level, const DicomTag& tag, IdentifierConstraintType type, const std::string& value) { static const char* COMMON = ("SELECT d.id FROM DicomIdentifiers AS d, Resources AS r WHERE " "d.id = r.internalId AND r.resourceType=? AND " "d.tagGroup=? AND d.tagElement=? AND "); std::auto_ptr<SQLite::Statement> s; switch (type) { case IdentifierConstraintType_GreaterOrEqual: s.reset(new SQLite::Statement(db_, std::string(COMMON) + "d.value>=?")); break; case IdentifierConstraintType_SmallerOrEqual: s.reset(new SQLite::Statement(db_, std::string(COMMON) + "d.value<=?")); break; case IdentifierConstraintType_Wildcard: s.reset(new SQLite::Statement(db_, std::string(COMMON) + "d.value GLOB ?")); break; case IdentifierConstraintType_Equal: default: s.reset(new SQLite::Statement(db_, std::string(COMMON) + "d.value=?")); break; } assert(s.get() != NULL); s->BindInt(0, level); s->BindInt(1, tag.GetGroup()); s->BindInt(2, tag.GetElement()); s->BindString(3, value); target.clear(); while (s->Step()) { target.push_back(s->ColumnInt64(0)); } } void DatabaseWrapperBase::LookupIdentifierRange(std::list<int64_t>& target, ResourceType level, const DicomTag& tag, const std::string& start, const std::string& end) { SQLite::Statement statement(db_, SQLITE_FROM_HERE, "SELECT d.id FROM DicomIdentifiers AS d, Resources AS r WHERE " "d.id = r.internalId AND r.resourceType=? AND " "d.tagGroup=? AND d.tagElement=? AND d.value>=? AND d.value<=?"); statement.BindInt(0, level); statement.BindInt(1, tag.GetGroup()); statement.BindInt(2, tag.GetElement()); statement.BindString(3, start); statement.BindString(4, end); target.clear(); while (statement.Step()) { target.push_back(statement.ColumnInt64(0)); } } }