Mercurial > hg > orthanc
changeset 1181:17302d83abfd
Sample plugin framework to serve static resources
author | Sebastien Jodogne <s.jodogne@gmail.com> |
---|---|
date | Tue, 30 Sep 2014 14:13:20 +0200 |
parents | dea1c786e1c6 |
children | d74ac5d0bcaf |
files | NEWS Plugins/Samples/WebSkeleton/CMakeLists.txt Plugins/Samples/WebSkeleton/Configuration.h Plugins/Samples/WebSkeleton/Framework/EmbedResources.py Plugins/Samples/WebSkeleton/Framework/Framework.cmake Plugins/Samples/WebSkeleton/Framework/Plugin.cpp Plugins/Samples/WebSkeleton/NOTES.txt Plugins/Samples/WebSkeleton/StaticResources/index.html |
diffstat | 8 files changed, 822 insertions(+), 0 deletions(-) [+] |
line wrap: on
line diff
--- a/NEWS Thu Sep 25 14:18:36 2014 +0200 +++ b/NEWS Tue Sep 30 14:13:20 2014 +0200 @@ -1,6 +1,7 @@ Pending changes in the mainline =============================== +* Sample plugin framework to serve static resources * Fix issue 21 (Microsoft Visual Studio precompiled headers)
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/Plugins/Samples/WebSkeleton/CMakeLists.txt Tue Sep 30 14:13:20 2014 +0200 @@ -0,0 +1,14 @@ +cmake_minimum_required(VERSION 2.8) + +project(WebSkeleton) + +SET(STANDALONE_BUILD ON CACHE BOOL "Standalone build (all the resources are embedded, necessary for releases)") +SET(RESOURCES_ROOT ${CMAKE_SOURCE_DIR}/StaticResources) + +include(Framework/Framework.cmake) + +include_directories(${CMAKE_SOURCE_DIR}/../../OrthancCPlugin/) + +add_library(WebSkeleton SHARED + ${AUTOGENERATED_SOURCES} + )
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/Plugins/Samples/WebSkeleton/Configuration.h Tue Sep 30 14:13:20 2014 +0200 @@ -0,0 +1,34 @@ +/** + * Orthanc - A Lightweight, RESTful DICOM Store + * Copyright (C) 2012-2014 Medical Physics Department, CHU of Liege, + * Belgium + * + * Permission is hereby granted, free of charge, to any person + * obtaining a copy of this software and associated documentation + * files (the "Software"), to deal in the Software without + * restriction, including without limitation the rights to use, copy, + * modify, merge, publish, distribute, sublicense, and/or sell copies + * of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be + * included in all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, + * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND + * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS + * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN + * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN + * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + **/ + + +#pragma once + +#define ORTHANC_PLUGIN_NAME "web-skeleton" + +#define ORTHANC_PLUGIN_VERSION "1.0" + +#define ORTHANC_PLUGIN_WEB_ROOT "/plugin-web-skeleton/"
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/Plugins/Samples/WebSkeleton/Framework/EmbedResources.py Tue Sep 30 14:13:20 2014 +0200 @@ -0,0 +1,398 @@ +# Orthanc - A Lightweight, RESTful DICOM Store +# Copyright (C) 2012-2014 Medical Physics Department, CHU of Liege, +# 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. +# +# In addition, as a special exception, the copyright holders of this +# program give permission to link the code of its release with the +# OpenSSL project's "OpenSSL" library (or with modified versions of it +# that use the same license as the "OpenSSL" library), and distribute +# the linked executables. You must obey the GNU General Public License +# in all respects for all of the code used other than "OpenSSL". If you +# modify file(s) with this exception, you may extend this exception to +# your version of the file(s), but you are not obligated to do so. If +# you do not wish to do so, delete this exception statement from your +# version. If you delete this exception statement from all source files +# in the program, then also delete it here. +# +# 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/>. + + +import sys +import os +import os.path +import pprint +import re + +UPCASE_CHECK = True +ARGS = [] +for i in range(len(sys.argv)): + if not sys.argv[i].startswith('--'): + ARGS.append(sys.argv[i]) + elif sys.argv[i].lower() == '--no-upcase-check': + UPCASE_CHECK = False + +if len(ARGS) < 2 or len(ARGS) % 2 != 0: + print ('Usage:') + print ('python %s [--no-upcase-check] <TargetBaseFilename> [ <Name> <Source> ]*' % sys.argv[0]) + exit(-1) + +TARGET_BASE_FILENAME = ARGS[1] +SOURCES = ARGS[2:] + +try: + # Make sure the destination directory exists + os.makedirs(os.path.normpath(os.path.join(TARGET_BASE_FILENAME, '..'))) +except: + pass + + +##################################################################### +## Read each resource file +##################################################################### + +def CheckNoUpcase(s): + global UPCASE_CHECK + if (UPCASE_CHECK and + re.search('[A-Z]', s) != None): + raise Exception("Path in a directory with an upcase letter: %s" % s) + +resources = {} + +counter = 0 +i = 0 +while i < len(SOURCES): + resourceName = SOURCES[i].upper() + pathName = SOURCES[i + 1] + + if not os.path.exists(pathName): + raise Exception("Non existing path: %s" % pathName) + + if resourceName in resources: + raise Exception("Twice the same resource: " + resourceName) + + if os.path.isdir(pathName): + # The resource is a directory: Recursively explore its files + content = {} + for root, dirs, files in os.walk(pathName): + base = os.path.relpath(root, pathName) + for f in files: + if f.find('~') == -1: # Ignore Emacs backup files + if base == '.': + r = f + else: + r = os.path.join(base, f) + + CheckNoUpcase(r) + r = '/' + r.replace('\\', '/') + if r in content: + raise Exception("Twice the same filename (check case): " + r) + + content[r] = { + 'Filename' : os.path.join(root, f), + 'Index' : counter + } + counter += 1 + + resources[resourceName] = { + 'Type' : 'Directory', + 'Files' : content + } + + elif os.path.isfile(pathName): + resources[resourceName] = { + 'Type' : 'File', + 'Index' : counter, + 'Filename' : pathName + } + counter += 1 + + else: + raise Exception("Not a regular file, nor a directory: " + pathName) + + i += 2 + +#pprint.pprint(resources) + + +##################################################################### +## Write .h header +##################################################################### + +header = open(TARGET_BASE_FILENAME + '.h', 'w') + +header.write(""" +#pragma once + +#include <string> +#include <list> + +namespace Orthanc +{ + namespace EmbeddedResources + { + enum FileResourceId + { +""") + +isFirst = True +for name in resources: + if resources[name]['Type'] == 'File': + if isFirst: + isFirst = False + else: + header.write(',\n') + header.write(' %s' % name) + +header.write(""" + }; + + enum DirectoryResourceId + { +""") + +isFirst = True +for name in resources: + if resources[name]['Type'] == 'Directory': + if isFirst: + isFirst = False + else: + header.write(',\n') + header.write(' %s' % name) + +header.write(""" + }; + + const void* GetFileResourceBuffer(FileResourceId id); + size_t GetFileResourceSize(FileResourceId id); + void GetFileResource(std::string& result, FileResourceId id); + + const void* GetDirectoryResourceBuffer(DirectoryResourceId id, const char* path); + size_t GetDirectoryResourceSize(DirectoryResourceId id, const char* path); + void GetDirectoryResource(std::string& result, DirectoryResourceId id, const char* path); + + void ListResources(std::list<std::string>& result, DirectoryResourceId id); + } +} +""") +header.close() + + + +##################################################################### +## Write the resource content in the .cpp source +##################################################################### + +PYTHON_MAJOR_VERSION = sys.version_info[0] + +def WriteResource(cpp, item): + cpp.write(' static const uint8_t resource%dBuffer[] = {' % item['Index']) + + f = open(item['Filename'], "rb") + content = f.read() + f.close() + + # http://stackoverflow.com/a/1035360 + pos = 0 + for b in content: + if PYTHON_MAJOR_VERSION == 2: + c = ord(b[0]) + else: + c = b + + if pos > 0: + cpp.write(', ') + + if (pos % 16) == 0: + cpp.write('\n ') + + if c < 0: + raise Exception("Internal error") + + cpp.write("0x%02x" % c) + pos += 1 + + cpp.write(' };\n') + cpp.write(' static const size_t resource%dSize = %d;\n' % (item['Index'], pos)) + + +cpp = open(TARGET_BASE_FILENAME + '.cpp', 'w') + +print os.path.abspath(os.path.join(os.path.dirname(__file__), '..')) + +cpp.write(""" +#include "%s.h" + +#include <stdint.h> +#include <string.h> +#include <stdexcept> + +namespace Orthanc +{ + namespace EmbeddedResources + { +""" % (os.path.basename(TARGET_BASE_FILENAME))) + + +for name in resources: + if resources[name]['Type'] == 'File': + WriteResource(cpp, resources[name]) + else: + for f in resources[name]['Files']: + WriteResource(cpp, resources[name]['Files'][f]) + + + +##################################################################### +## Write the accessors to the file resources in .cpp +##################################################################### + +cpp.write(""" + const void* GetFileResourceBuffer(FileResourceId id) + { + switch (id) + { +""") +for name in resources: + if resources[name]['Type'] == 'File': + cpp.write(' case %s:\n' % name) + cpp.write(' return resource%dBuffer;\n' % resources[name]['Index']) + +cpp.write(""" + default: + throw std::runtime_error("Unknown resource"); + } + } + + size_t GetFileResourceSize(FileResourceId id) + { + switch (id) + { +""") + +for name in resources: + if resources[name]['Type'] == 'File': + cpp.write(' case %s:\n' % name) + cpp.write(' return resource%dSize;\n' % resources[name]['Index']) + +cpp.write(""" + default: + throw std::runtime_error("Unknown resource"); + } + } +""") + + + +##################################################################### +## Write the accessors to the directory resources in .cpp +##################################################################### + +cpp.write(""" + const void* GetDirectoryResourceBuffer(DirectoryResourceId id, const char* path) + { + switch (id) + { +""") + +for name in resources: + if resources[name]['Type'] == 'Directory': + cpp.write(' case %s:\n' % name) + isFirst = True + for path in resources[name]['Files']: + cpp.write(' if (!strcmp(path, "%s"))\n' % path) + cpp.write(' return resource%dBuffer;\n' % resources[name]['Files'][path]['Index']) + cpp.write(' throw std::runtime_error("Unknown path in a directory resource");\n\n') + +cpp.write(""" default: + throw std::runtime_error("Unknown resource"); + } + } + + size_t GetDirectoryResourceSize(DirectoryResourceId id, const char* path) + { + switch (id) + { +""") + +for name in resources: + if resources[name]['Type'] == 'Directory': + cpp.write(' case %s:\n' % name) + isFirst = True + for path in resources[name]['Files']: + cpp.write(' if (!strcmp(path, "%s"))\n' % path) + cpp.write(' return resource%dSize;\n' % resources[name]['Files'][path]['Index']) + cpp.write(' throw std::runtime_error("Unknown path in a directory resource");\n\n') + +cpp.write(""" default: + throw std::runtime_error("Unknown resource"); + } + } +""") + + + + +##################################################################### +## List the resources in a directory +##################################################################### + +cpp.write(""" + void ListResources(std::list<std::string>& result, DirectoryResourceId id) + { + result.clear(); + + switch (id) + { +""") + +for name in resources: + if resources[name]['Type'] == 'Directory': + cpp.write(' case %s:\n' % name) + for path in sorted(resources[name]['Files']): + cpp.write(' result.push_back("%s");\n' % path) + cpp.write(' break;\n\n') + +cpp.write(""" default: + throw std::runtime_error("Unknown resource"); + } + } +""") + + + + +##################################################################### +## Write the convenience wrappers in .cpp +##################################################################### + +cpp.write(""" + void GetFileResource(std::string& result, FileResourceId id) + { + size_t size = GetFileResourceSize(id); + result.resize(size); + if (size > 0) + memcpy(&result[0], GetFileResourceBuffer(id), size); + } + + void GetDirectoryResource(std::string& result, DirectoryResourceId id, const char* path) + { + size_t size = GetDirectoryResourceSize(id, path); + result.resize(size); + if (size > 0) + memcpy(&result[0], GetDirectoryResourceBuffer(id, path), size); + } + } +} +""") +cpp.close()
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/Plugins/Samples/WebSkeleton/Framework/Framework.cmake Tue Sep 30 14:13:20 2014 +0200 @@ -0,0 +1,76 @@ +# Orthanc - A Lightweight, RESTful DICOM Store +# Copyright (C) 2012-2014 Medical Physics Department, CHU of Liege, +# 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. +# +# In addition, as a special exception, the copyright holders of this +# program give permission to link the code of its release with the +# OpenSSL project's "OpenSSL" library (or with modified versions of it +# that use the same license as the "OpenSSL" library), and distribute +# the linked executables. You must obey the GNU General Public License +# in all respects for all of the code used other than "OpenSSL". If you +# modify file(s) with this exception, you may extend this exception to +# your version of the file(s), but you are not obligated to do so. If +# you do not wish to do so, delete this exception statement from your +# version. If you delete this exception statement from all source files +# in the program, then also delete it here. +# +# 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/>. + + +if (${CMAKE_COMPILER_IS_GNUCXX}) + set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wall -pedantic -Werror -Wno-unused-function") +endif() + +if (${CMAKE_SYSTEM_NAME} STREQUAL "Linux") + # Linking with "pthread" is necessary, otherwise the software might crash + # http://sourceware.org/bugzilla/show_bug.cgi?id=10652#c17 + link_libraries(pthread dl) +endif() + +if (STANDALONE_BUILD) + add_definitions(-DORTHANC_PLUGIN_STANDALONE=1) + + set(AUTOGENERATED_DIR "${CMAKE_CURRENT_BINARY_DIR}/AUTOGENERATED") + set(AUTOGENERATED_SOURCES "${AUTOGENERATED_DIR}/EmbeddedResources.cpp") + + file(MAKE_DIRECTORY ${AUTOGENERATED_DIR}) + include_directories(${AUTOGENERATED_DIR}) + + set(TARGET_BASE "${AUTOGENERATED_DIR}/EmbeddedResources") + add_custom_command( + OUTPUT + "${AUTOGENERATED_DIR}/EmbeddedResources.h" + "${AUTOGENERATED_DIR}/EmbeddedResources.cpp" + COMMAND + python + "${CMAKE_CURRENT_SOURCE_DIR}/Framework/EmbedResources.py" + "${AUTOGENERATED_DIR}/EmbeddedResources" + STATIC_RESOURCES + ${RESOURCES_ROOT} + DEPENDS + "${CMAKE_CURRENT_SOURCE_DIR}/Framework/EmbedResources.py" + ${STATIC_RESOURCES} + ) + +else() + add_definitions( + -DORTHANC_PLUGIN_STANDALONE=0 + -DORTHANC_PLUGIN_RESOURCES_ROOT="${RESOURCES_ROOT}" + ) +endif() + + +list(APPEND AUTOGENERATED_SOURCES + "${CMAKE_CURRENT_SOURCE_DIR}/Framework/Plugin.cpp" + ) \ No newline at end of file
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/Plugins/Samples/WebSkeleton/Framework/Plugin.cpp Tue Sep 30 14:13:20 2014 +0200 @@ -0,0 +1,276 @@ +/** + * Orthanc - A Lightweight, RESTful DICOM Store + * Copyright (C) 2012-2014 Medical Physics Department, CHU of Liege, + * Belgium + * + * Permission is hereby granted, free of charge, to any person + * obtaining a copy of this software and associated documentation + * files (the "Software"), to deal in the Software without + * restriction, including without limitation the rights to use, copy, + * modify, merge, publish, distribute, sublicense, and/or sell copies + * of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be + * included in all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, + * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND + * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS + * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN + * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN + * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + **/ + + +#include "../Configuration.h" + +#include <OrthancCPlugin.h> +#include <string> +#include <stdexcept> +#include <algorithm> +#include <sys/stat.h> + +#if ORTHANC_PLUGIN_STANDALONE == 1 +// This is an auto-generated file for standalone builds +#include <EmbeddedResources.h> +#endif + +static OrthancPluginContext* context = NULL; + + +static const char* GetMimeType(const std::string& path) +{ + size_t dot = path.find_last_of('.'); + + std::string extension = (dot == std::string::npos) ? "" : path.substr(dot); + std::transform(extension.begin(), extension.end(), extension.begin(), tolower); + + if (extension == ".html") + { + return "text/html"; + } + else if (extension == ".css") + { + return "text/css"; + } + else if (extension == ".js") + { + return "application/javascript"; + } + else if (extension == ".gif") + { + return "image/gif"; + } + else if (extension == ".json") + { + return "application/json"; + } + else if (extension == ".xml") + { + return "application/xml"; + } + else if (extension == ".png") + { + return "image/png"; + } + else if (extension == ".jpg" || extension == ".jpeg") + { + return "image/jpeg"; + } + else + { + std::string s = "Unknown MIME type for extension: " + extension; + OrthancPluginLogWarning(context, s.c_str()); + return "application/octet-stream"; + } +} + + +static bool ReadFile(std::string& content, + const std::string& path) +{ + struct stat s; + if (stat(path.c_str(), &s) != 0 || + !(s.st_mode & S_IFREG)) + { + // Either the path does not exist, or it is not a regular file + return false; + } + + FILE* fp = fopen(path.c_str(), "rb"); + if (fp == NULL) + { + return false; + } + + long size; + + if (fseek(fp, 0, SEEK_END) == -1 || + (size = ftell(fp)) < 0) + { + fclose(fp); + return false; + } + + content.resize(size); + + if (fseek(fp, 0, SEEK_SET) == -1) + { + fclose(fp); + return false; + } + + bool ok = true; + + if (size > 0 && + fread(&content[0], size, 1, fp) != 1) + { + ok = false; + } + + fclose(fp); + + return ok; +} + + +#if ORTHANC_PLUGIN_STANDALONE == 1 +static int32_t ServeStaticResource(OrthancPluginRestOutput* output, + const char* url, + const OrthancPluginHttpRequest* request) +{ + if (request->method != OrthancPluginHttpMethod_Get) + { + OrthancPluginSendMethodNotAllowed(context, output, "GET"); + return 0; + } + + std::string path = "/" + std::string(request->groups[0]); + const char* mime = GetMimeType(path); + + try + { + std::string s; + Orthanc::EmbeddedResources::GetDirectoryResource + (s, Orthanc::EmbeddedResources::STATIC_RESOURCES, path.c_str()); + + const char* resource = s.size() ? s.c_str() : NULL; + OrthancPluginAnswerBuffer(context, output, resource, s.size(), mime); + + return 0; + } + catch (std::runtime_error&) + { + std::string s = "Unknown static resource in plugin: " + std::string(request->groups[0]); + OrthancPluginLogError(context, s.c_str()); + OrthancPluginSendHttpStatusCode(context, output, 404); + return 0; + } +} +#endif + + +#if ORTHANC_PLUGIN_STANDALONE == 0 +static int32_t ServeFolder(OrthancPluginRestOutput* output, + const char* url, + const OrthancPluginHttpRequest* request) +{ + if (request->method != OrthancPluginHttpMethod_Get) + { + OrthancPluginSendMethodNotAllowed(context, output, "GET"); + return 0; + } + + std::string path = ORTHANC_PLUGIN_RESOURCES_ROOT "/" + std::string(request->groups[0]); + const char* mime = GetMimeType(path); + + std::string s; + if (ReadFile(s, path)) + { + const char* resource = s.size() ? s.c_str() : NULL; + OrthancPluginAnswerBuffer(context, output, resource, s.size(), mime); + + return 0; + } + else + { + std::string s = "Unknown static resource in plugin: " + std::string(request->groups[0]); + OrthancPluginLogError(context, s.c_str()); + OrthancPluginSendHttpStatusCode(context, output, 404); + return 0; + } +} +#endif + + +static int32_t RedirectRoot(OrthancPluginRestOutput* output, + const char* url, + const OrthancPluginHttpRequest* request) +{ + if (request->method != OrthancPluginHttpMethod_Get) + { + OrthancPluginSendMethodNotAllowed(context, output, "GET"); + } + else + { + OrthancPluginRedirect(context, output, ORTHANC_PLUGIN_WEB_ROOT "index.html"); + } + + return 0; +} + + +extern "C" +{ + ORTHANC_PLUGINS_API int32_t OrthancPluginInitialize(OrthancPluginContext* c) + { + context = c; + + /* Check the version of the Orthanc core */ + if (OrthancPluginCheckVersion(c) == 0) + { + char info[256]; + sprintf(info, "Your version of Orthanc (%s) must be above %d.%d.%d to run this plugin", + c->orthancVersion, + ORTHANC_PLUGINS_MINIMAL_MAJOR_NUMBER, + ORTHANC_PLUGINS_MINIMAL_MINOR_NUMBER, + ORTHANC_PLUGINS_MINIMAL_REVISION_NUMBER); + OrthancPluginLogError(context, info); + return -1; + } + + /* Register the callbacks */ + +#if ORTHANC_PLUGIN_STANDALONE == 1 + OrthancPluginLogInfo(context, "Serving static resources (standalone build)"); + OrthancPluginRegisterRestCallback(context, ORTHANC_PLUGIN_WEB_ROOT "(.*)", ServeStaticResource); +#else + OrthancPluginLogInfo(context, "Serving resources from folder: " ORTHANC_PLUGIN_RESOURCES_ROOT); + OrthancPluginRegisterRestCallback(context, ORTHANC_PLUGIN_WEB_ROOT "(.*)", ServeFolder); +#endif + + OrthancPluginRegisterRestCallback(context, "/", RedirectRoot); + + return 0; + } + + + ORTHANC_PLUGINS_API void OrthancPluginFinalize() + { + } + + + ORTHANC_PLUGINS_API const char* OrthancPluginGetName() + { + return ORTHANC_PLUGIN_NAME; + } + + + ORTHANC_PLUGINS_API const char* OrthancPluginGetVersion() + { + return ORTHANC_PLUGIN_VERSION; + } +}
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/Plugins/Samples/WebSkeleton/NOTES.txt Tue Sep 30 14:13:20 2014 +0200 @@ -0,0 +1,7 @@ +This is a sample Orthanc plugin that serves static resources (HTML, +JavaScript, CSS, images...). + +The resources to serve must be stored in the folder "StaticResources". + +The folder "Framework" contains a reusable framework for any plugin +whose sole objective is to serve static resources.
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/Plugins/Samples/WebSkeleton/StaticResources/index.html Tue Sep 30 14:13:20 2014 +0200 @@ -0,0 +1,16 @@ +<!doctype html> + +<html lang="en"> + <head> + <meta charset="utf-8"> + <title>Web Skeleton</title> + </head> + + <body> + <h1>Web Skeleton</h1> + <p> + This is a sample skeleton for Orthanc showing how to create a + plugin that serves static HTML resources. + </p> + </body> +</html>