dcm4chee 0.1.0

data/app/controllers/dcm4chee/api/v1/trashed_studies_controller.rb

@@ -0,0 +1,81 @@
+# -*- encoding: utf-8 -*-
+module Dcm4chee
+  module Api
+    module V1
+      class TrashedStudiesController < BaseController
+        respond_to :json
+
+        # Search for studies from the trash. Supported querying
+        # conditions:
+        #   trashed_patient_id
+        #
+        # Check {DataMapper::Searcher::ClassMethods} for supported
+        # querying operators.
+        #
+        # @example
+        #   # Request
+        #   GET /api/trashed_studies?q[trashed_patient_id]=... HTTP/1.1
+        #   Accept: application/vnd.menglifang.org; version=1
+        #
+        #   # Response
+        #   HTTP/1.1 200 OK
+        #   {
+        #     "trashed_studies": [{
+        #       "id": ...,
+        #       "trashed_patient_id": ...,
+        #       "study_iuid": ...,
+        #       "accession_no": ...,
+        #       "dcm_elements": [{
+        #         "name": ...,
+        #         "value": ...,
+        #         "tag": ...,
+        #         "value_representation": ...,
+        #         "length": ...
+        #       }, ...]
+        #     }, ...]
+        #   }
+        def index
+          studies = TrashedStudy.search(params[:q])
+
+          respond_with trashed_studies: studies
+        end
+
+        # Move a study to the trash including the related series, instances and files.
+        #
+        # @example
+        #   # Request
+        #   POST /api/trashed_studies HTTP/1.1
+        #   Accept: application/vnd.menglifang.org; version=1
+        #   Content-Type: application/json
+        #
+        #   { "study_id": ... }
+        #
+        #   # Response
+        #   HTTP/1.1 201 Created
+        def create
+          study = Study.get!(params[:study_id])
+          study.move_to_trash
+
+          head :created
+        end
+
+        # Delete a study from the trash.
+        #
+        # @example
+        #   # Request
+        #   DELETE /api/trashed_studies/... HTTP/1.1
+        #   Accept: application/vnd.menglifang.org; version=1
+        #
+        #   # Response
+        #   HTTP/1.1 200 OK
+        def destroy
+          study = TrashedStudy.get!(params[:id])
+          study.remove_from_trash
+
+          head :ok
+        end
+
+      end
+    end
+  end
+end

data/app/controllers/dcm4chee/api/v1/trashes_controller.rb

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+module Dcm4chee
+  module Api
+    module V1
+      class TrashesController < BaseController
+        # Clean up the trash.
+        #
+        # @example
+        #   # Request
+        #   DELETE /api/trash HTTP/1.1
+        #   Accept: application/vnd.menglifang.org; version=1
+        #
+        #   # Response
+        #   HTTP/1.1 200 OK
+        def destroy
+          Dcm4chee.content_edit_service.empty_trash
+
+          head :ok
+        end
+      end
+    end
+  end
+end

data/app/controllers/dcm4chee/application_controller.rb

@@ -0,0 +1,4 @@
+module Dcm4chee
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/models/dcm4chee/application_entity.rb

@@ -0,0 +1,129 @@
+# -*- encoding: utf-8 -*-
+module Dcm4chee
+  class ApplicationEntity
+    include DataMapper::Resource
+
+    storage_names[Dcm4chee.config.repository_name] = 'ae'
+
+    # @return [Integer] primary key
+    property :id, Serial, field: 'pk'
+
+    # @return [String] name
+    property :title, String, field: 'aet'
+
+    # @return [String] hostname or ip address
+    property :host, String, field: 'hostname'
+
+    # @return [Integer] port
+    property :port, Integer, field: 'port'
+
+    # @return [String] cipher_suites, available values:SSL_RSA_WITH_NULL_SHA, TLS_RSA_WITH_AES_128_CBC_SHA, SSL_RSA_WITH_3DES_EDE_CBC_SHA
+    #   Multi-suites should be specified in comma-separated format.
+    property :cipher_suites, String, field: 'cipher_suites'
+
+    # @return [String] issuer of the patient id
+    property :patient_id_issuer, String, field: 'pat_id_issuer'
+
+    # @return [String] issuer of the accession number
+    property :accession_number_issuer, String, field: 'acc_no_issuer'
+
+    # @return [String] username
+    property :username, String, field: 'user_id'
+
+    # @return [String] password
+    property :password, String, field: 'passwd'
+
+    # @return [String] group of the file system
+    property :fs_group, String, field: 'fs_group_id', default: 'ONLINE_STORAGE'
+
+    # @return [String] group of the application entity
+    property :group, String, field: 'ae_group'
+
+    # @return [String] description
+    property :description, String, field: 'ae_desc'
+
+    # @return [String] url of WADO
+    property :wado_url, String, field: 'wado_url'
+
+    # @return [String] station name
+    property :station_name, String, field: 'station_name'
+
+    # @return [String] institution
+    property :institution, String, field: 'institution'
+    
+    # @return [String] department
+    property :department, String, field: 'department'
+
+    # @return [String] installed or not
+    property :installed, String, field: 'installed'
+
+    # Update an application entity through AEService of dcm4chee.
+    #
+    # @param [Hash] attrs Attributes of the application entity
+    def update_by_service(attrs = {})
+      params = [
+        id,
+        attrs[:title] || title,
+        attrs[:host] || host,
+        attrs[:port] || port,
+        attrs[:cipher_suites] || cipher_suites,
+        attrs[:patient_id_issuer] || patient_id_issuer,
+        attrs[:accession_number_issuer] || accession_number_issuer,
+        attrs[:username] || username,
+        attrs[:password] || password,
+        attrs[:fs_group] || fs_group,
+        attrs[:group] || group,
+        attrs[:description] || description,
+        attrs[:wado_url] || wado_url,
+        attrs[:station_name] || station_name,
+        attrs[:institution] || institution,
+        attrs[:department] || department,
+        attrs[:installed] || installed,
+        true
+      ]
+      Dcm4chee.application_entity_service.update_ae(params)
+      reload
+
+      self
+    end
+
+    # Delete an application entity through AEService of dcm4chee
+    def destroy_by_service
+      Dcm4chee.application_entity_service.remove_ae(title)
+    end
+
+    class << self
+      # Create an application entity through AEService of dcm4chee.
+      #
+      # @param [Hash] attrs Attributes of the new application entity
+      def create_by_service(attrs = {})
+        params = [
+          attrs[:title],
+          attrs[:host],
+          attrs[:port],
+          attrs[:cipher_suites],
+          attrs[:patient_id_issuer],
+          attrs[:accession_number_issuer],
+          attrs[:username],
+          attrs[:password],
+          attrs[:fs_group],
+          attrs[:group],
+          attrs[:description],
+          attrs[:wado_url],
+          attrs[:station_name],
+          attrs[:institution],
+          attrs[:department],
+          !!(attrs[:installed]),
+          true
+        ]
+        Dcm4chee.application_entity_service.add_ae(params)
+
+        first(title: attrs[:title])
+      end
+
+      def repository(name = nil, &block)
+        super(Dcm4chee.config.repository_name, &block)
+      end
+    end
+  end
+end

data/app/models/dcm4chee/dicom_file.rb

@@ -0,0 +1,62 @@
+# -*- encoding: utf-8 -*-
+module Dcm4chee
+  class DicomFile
+    include DataMapper::Resource
+    include HasDicomObject
+
+    storage_names[Dcm4chee.config.repository_name] = 'files'
+
+    # @return [Integer] primary key
+    property :id, Serial, field: 'pk'
+
+    # @return [Integer] foreign key of {Instance}
+    property :instance_id, Integer, field: 'instance_fk'
+
+    # @return [Integer] foreign key of {FileSystem}
+    property :file_system_id, Integer, field: 'filesystem_fk'
+
+    # @return [String] path
+    property :path, Text, field: 'filepath'
+
+    # @return [String] DICOM transfer syntax UID(0002,0010)
+    property :transfer_syntax_uid, Text, field: 'file_tsuid'
+
+    # @return [String] MD5 of the file
+    property :md5, String, field: 'file_md5'
+
+    # @return [Integer] file size
+    property :size, Integer, field: 'file_size'
+
+    # Available values:
+    #   -4: QUERY_HSM_FAILED
+    #   -3: MD5_CHECK_FAILED
+    #   -2: VERIFY_COMPRESS_FAILED
+    #   -1: COMPRESS_FAILED
+    #    0: DEFAULT
+    #    1: TO_ARCHIVE
+    #    2: ARCHIVED
+    #    3: COMPRESSING
+    #
+    # @return [Integer] file status
+    property :availability, Enum[-4, -3, -2, -1, 0, 1, 2, 3], field: 'file_status'
+
+    # @return [DateTime] last MD5 checking time of the file
+    property :md5_checked_at, DateTime, field: 'md5_check_time'
+
+    # @return [DateTime] created time
+    property :created_at, DateTime, field: 'created_time'
+
+    belongs_to :instance, 'Dcm4chee::Instance'
+    belongs_to :file_system, 'Dcm4chee::FileSystem'
+
+    # Load the dicom object
+    # @return [DICOM::DObject] DICOM object
+    def dcm
+      @dcm ||= DICOM::DObject.read(File.join(file_system.path, path))
+    end
+
+    def self.repository(name = nil, &block)
+      super(Dcm4chee.config.repository_name, &block)
+    end
+  end
+end

data/app/models/dcm4chee/file_system.rb

@@ -0,0 +1,95 @@
+# -*- encoding: utf-8 -*-
+module Dcm4chee
+  class FileSystem
+    include DataMapper::Resource
+
+    storage_names[Dcm4chee.config.repository_name] = 'filesystem'
+
+    # @return [Integer] primary key
+    property :id, Serial, field: 'pk'
+
+    # @return [String] path of the directory
+    property :path, String, field: 'dirpath'
+
+    # @return [Integer] type of the file system
+    #   0: ONLINE
+    #   1: NEARLINE
+    #   2: OFFLINE
+    property :availability, Integer, field: 'availability'
+
+    has n, :dicom_files, 'Dcm4chee::DicomFile'
+    has n, :trashed_dicom_files, 'Dcm4chee::TrashedDicomFile'
+
+    # Check whether the path is relative or absolute. The default path of the relative one is `#{Dcm4chee.config.server_home}/server/default`
+    def path
+      p = self[:path]
+
+      return p if p.start_with?('/')
+
+      raise 'Home of dcm4chee must be set' unless Dcm4chee.config.server_home
+
+      File.join(Dcm4chee.config.server_home, 'server/default', p)
+    end
+
+    # @return [Integer] Total space of the file system(in bytes)
+    def total_space
+      status.block_size * status.blocks
+    end
+
+    # @return [Integer] Available space of the file system(in bytes)
+    def free_space
+      status.block_size * status.blocks_available
+    end
+
+    # @return [Integer] Used space of the file system(in bytes)
+    def used_space
+      total_space - free_space
+    end
+
+    # @return [Integer] Minimum free space of the file system. If the free space is under the limit, dcm4chee will use the next one instead.
+    def min_free_space
+      @min_free_space ||= Dcm4chee.file_system_management.minimum_free_disk_space_bytes
+    end
+
+    # @return [Integer] Expected space per day(in bytes)
+    def expected_space_per_day
+      @expected_space_per_day ||= Dcm4chee.file_system_management.expected_data_volume_per_day_bytes
+    end
+
+    # @return [Integer] Remaining days of the file system
+    def remaining_days
+      @remaining_days ||= (free_space - min_free_space) / expected_space_per_day
+    end
+
+    # @return [Hash] Serialized data
+    def as_json(opts = {})
+      opts[:exclude] ||= []
+      opts[:exclude] << :availability
+
+      opts[:methods] ||= []
+      opts[:methods].concat([:path, :total_space, :free_space,
+                             :used_space, :min_free_space,
+                             :expected_space_per_day, :remaining_days])
+
+      super(opts)
+    end
+
+    class << self
+      # @return [DataMapper::Collection] All online file systems
+      def online
+        all(availability: 0)
+      end
+
+      def repository(name = nil, &block)
+        super(Dcm4chee.config.repository_name, &block)
+      end
+    end
+
+    private
+
+    # @return [Sys::Filesystem] Status of the file system
+    def status
+      @status ||= Sys::Filesystem.stat(path)
+    end
+  end
+end

data/app/models/dcm4chee/instance.rb

@@ -0,0 +1,69 @@
+# -*- encoding: utf-8 -*-
+module Dcm4chee
+  class Instance
+    include DataMapper::Resource
+    include DataMapper::Searcher
+
+    include HasDicomObject
+
+    storage_names[Dcm4chee.config.repository_name] = 'instance'
+
+    # @return [Integer] primary key
+    property :id, Serial, field: 'pk'
+
+    # @return [Integer] foreign key of {Series}
+    property :series_id, Integer, field: 'series_fk'
+
+    # @return [DateTime] created time
+    property :created_at, DateTime, field: 'created_time'
+
+    # @return [String] DICOM Instance NO(0020,0013)
+    property :instance_no, String, field: 'inst_no'
+
+    # @return [String] DICOM SOP Instance UID(0008,0018)
+    property :sop_iuid, Text, field: 'sop_iuid'
+
+    # @return [String] DICOM SOP Class UID(0008,0016)
+    property :sop_cuid, Text, field: 'sop_cuid'
+
+    # DICOM Instance Availability(0008,0056)
+    #   0: ONLINE
+    #   1: NEARLINE
+    #   2: OFFLINE
+    #   3: UNAVAILABLE
+    #
+    # @return [Integer] DICOM Integer Availability
+    property :availability, Enum[0, 1, 2, 3], field: 'availability'
+
+    # TODO Added description
+
+    dicom_field 'inst_attrs'
+
+    belongs_to :series, 'Dcm4chee::Series'
+    has n, :dicom_files, 'Dcm4chee::DicomFile'
+
+    def study_iuid
+      series.study.study_iuid
+    end
+
+    def series_iuid
+      series.series_iuid
+    end
+
+    def move_to_trash
+      Dcm4chee.content_edit_service.move_instance_to_trash(id)
+    end
+
+    def as_json(opts = {})
+      opts[:methods] ||= []
+      opts[:methods] << :series_iuid
+      opts[:methods] << :study_iuid
+
+      super(opts)
+    end
+
+    def self.repository(name = nil, &block)
+      super(Dcm4chee.config.repository_name, &block)
+    end
+  end
+end