ENH: Refs #0924. Added progress indicator and registration status for dicom image registration; other minor changes.

Author: yuzhengZ

modules/dicomserver/Notification.php

@@ -30,6 +30,7 @@ public function init()
     $this->addCallBack('CALLBACK_CORE_ITEM_VIEW_ACTIONMENU', 'getItemMenuLink');
     $this->addCallBack('CALLBACK_CORE_ITEM_VIEW_JS', 'getJs');
     $this->addCallBack('CALLBACK_CORE_GET_DASHBOARD', 'getDashboard');
+    $this->addCallBack('CALLBACK_CORE_ITEM_VIEW_INFO', 'getItemInfo');
     }//end init
 
   /** Get the link to place in the item action menu */
@@ -39,8 +40,8 @@ public function getItemMenuLink($params)
     return '<li id="dicomRegisterListItem" style="display: none;">'.
       '<a id="dicomRegisterAction" href="#">'.
       '<img alt="" src="'.$webroot.'/modules/'.
-      $this->moduleName.'/public/images/dicom_icon.jpg" /> '.
-      $this->t('Register Dicom Images').'</a></li>';
+      $this->moduleName.'/public/images/dicom_register_icon.jpg" /> '.
+      $this->t('Register for DICOM Query/Retrieve').'</a></li>';
     }
 
   /** Get javascript for the item view that will specify the ajax call
@@ -61,4 +62,14 @@ public function getDashboard()
     return $return;
     }//end _getDasboard
 
+  /** Some html to be appended to the item view sidebar */
+  public function getItemInfo($params)
+    {
+    return '<div class="sideElement" id="sideElementDicomRegistration" style="display: none;">
+              <h1>DICOM</h1>
+              <span>This item was registered for DICOM Query/Retrieve services.</span><br/>
+              <span>Note: if the latest revision is updated, registration action needs to be rerun.</span>
+            </div>';
+    }
+
 } //end class

modules/dicomserver/controllers/components/ApiComponent.php

@@ -199,7 +199,7 @@ function start($args)
    * Check DICOM server status
    * @param storescp_cmd (Optional) The command to run storescp
    * @param dcmqrscp_cmd (Optional) The command to run dcmqrscp
-   * @return
+   * @return array('status' => string)
    */
   function status($args)
     {
@@ -353,9 +353,9 @@ function stop($args)
   }
 
   /**
-   * Register dicom image files from a revision
+   * Register DICOM images from a revision to let them be available for DICOM query/retrieve services.
    * @param item the id of the item to be registered
-   * @return the id of the revision
+   * @return the revision dao (latest revision of the item) that was registered
    */
   function register($args)
   {
@@ -377,7 +377,39 @@ function register($args)
 
     $dicomComponent = MidasLoader::loadComponent('Server', 'dicomserver');
     $dicomComponent->register($revisionDao);
-    return json_encode($revisionDao);
+    return $revisionDao->toArray();
+  }
+
+  /**
+   * Check if the DICOM images in the item was registered and can be accessed by DICOM query/retrieve services.
+   * @param item the id of the item to be checked
+   * @return array('status' => bool)
+   */
+  function registrationStatus($args)
+  {
+    $this->_validateParams($args, array('item'));
+
+    $itemModel = MidasLoader::loadModel("Item");
+    $authComponent = MidasLoader::loadComponent('Authentication', 'api');
+    $itemDao = $itemModel->load($args['item']);
+    $userDao = $authComponent->getUser($args,
+                                       Zend_Registry::get('userSession')->Dao);
+    if(!$itemModel->policyCheck($itemDao, $userDao, MIDAS_POLICY_WRITE))
+      {
+      throw new Exception('You didn\'t log in or you don\'t have the write '.
+        'permission for the given item.', MIDAS_INVALID_POLICY);
+      }
+
+    $modelLoad = new MIDAS_ModelLoader();
+    $registrationModel = $modelLoad->loadModel('Registration', 'dicomserver');
+    if(!$registrationModel->checkByItemId($args['item']))
+      {
+      return array('status' => false);
+      }
+    else
+      {
+      return array('status' => true);
+      }
   }
 }
 

modules/dicomserver/controllers/components/ServerComponent.php

@@ -140,7 +140,12 @@ public function register($revision)
     $command = $modulesConfig['dicomserver']->dcmqridx;
     $command = str_replace("'", '',$command);
     $command_params = array();
-    $aeStorage = $modulesConfig['dicomserver']->receptiondir . PACS_DIR;
+    $reciptionDir = $modulesConfig['dicomserver']->receptiondir;
+    if(!is_writable($reciptionDir))
+      {
+      throw new Zend_Exception("Please configure Dicom Server module correctly. Its reception directory is NOT writable!", MIDAS_INVALID_POLICY);
+      }
+    $aeStorage = $reciptionDir . PACS_DIR;
     $aeStorage = str_replace("'", '', $aeStorage);
     $command_params[] = $aeStorage;
     foreach($bitstreams as $bitstream)
@@ -155,6 +160,14 @@ public function register($revision)
         throw new Zend_Exception(htmlspecialchars($exception_string, ENT_QUOTES), MIDAS_INVALID_POLICY);
         }
       }
+
+    $modelLoad = new MIDAS_ModelLoader();
+    $registrationModel = $modelLoad->loadModel('Registration', 'dicomserver');
+    $itemId =  $revision->getItemId();
+    if(!$registrationModel->checkByItemId($itemId))
+      {
+      $registrationModel->createRegistration($itemId);
+      }
     }
 
 } // end class

modules/dicomserver/database/mysql/1.0.0.sql

@@ -0,0 +1,6 @@
+CREATE TABLE IF NOT EXISTS `dicomserver_registration` (
+  `registration_id` bigint(20) NOT NULL AUTO_INCREMENT,
+  `item_id` bigint(20) NOT NULL,
+  PRIMARY KEY (`registration_id`)
+)   DEFAULT CHARSET=utf8;
+

modules/dicomserver/database/pgsql/1.0.0.sql

@@ -0,0 +1,4 @@
+CREATE TABLE dicomserver_registration (
+    registration_id serial PRIMARY KEY,
+    item_id bigint NOT NULL
+);

modules/dicomserver/models/AppDao.php

@@ -0,0 +1,26 @@
+<?php
+/*=========================================================================
+ MIDAS Server
+ Copyright (c) Kitware SAS. 26 rue Louis Guérin. 69100 Villeurbanne, FRANCE
+ All rights reserved.
+ More information http://www.kitware.com
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+         http://www.apache.org/licenses/LICENSE-2.0.txt
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+=========================================================================*/
+
+class Dicomserver_AppDao extends MIDAS_GlobalDao
+  {
+    public $moduleName='dicomserver';
+  } //end class
+
+?>

modules/dicomserver/models/AppModel.php

@@ -0,0 +1,26 @@
+<?php
+/*=========================================================================
+ MIDAS Server
+ Copyright (c) Kitware SAS. 26 rue Louis Guérin. 69100 Villeurbanne, FRANCE
+ All rights reserved.
+ More information http://www.kitware.com
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+         http://www.apache.org/licenses/LICENSE-2.0.txt
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+=========================================================================*/
+
+class Dicomserver_AppModel extends MIDASModel
+{
+  public $moduleName = 'dicomserver';
+
+}
+?>

modules/dicomserver/models/base/RegistrationModelBase.php

@@ -0,0 +1,52 @@
+<?php
+/*=========================================================================
+MIDAS Server
+Copyright (c) Kitware SAS. 20 rue de la Villette. All rights reserved.
+69328 Lyon, FRANCE.
+
+See Copyright.txt for details.
+This software is distributed WITHOUT ANY WARRANTY; without even
+the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
+PURPOSE.  See the above copyright notices for more information.
+=========================================================================*/
+include_once BASE_PATH . '/modules/dicomserver/constant/module.php';
+/** RegistrationModel Base class */
+abstract class Dicomserver_RegistrationModelBase extends Dicomserver_AppModel {
+
+  /**
+   * constructor
+   */
+  public function __construct()
+    {
+    parent::__construct();
+    $this->_name = 'dicomserver_registration';
+    $this->_key = 'registration_id';
+    $this->_daoName = 'RegistrationDao';
+
+    $this->_mainData = array(
+      'registration_id' => array('type' => MIDAS_DATA),
+      'item_id' => array('type' => MIDAS_DATA),
+      'revision_id' => array('type' => MIDAS_DATA)
+       );
+    $this->initialize(); // required
+    }
+
+  /** Check registration information by an itemId */
+  abstract function checkByItemId($itemId);
+
+ /**
+   * Register an item
+   *
+   * @param string $item_id
+   * @return Dicomserver_RegistrationDao
+   */
+  function createRegistration($item_id)
+    {
+    $registrationDao = MidasLoader::newDao('RegistrationDao', 'dicomserver');
+    $registrationDao->setItemId($item_id);
+    $this->save($registrationDao);
+    return $registrationDao;
+    }
+
+
+}  // end class Dicomserver_RegistrationModelBase

modules/dicomserver/models/dao/RegistrationDao.php

@@ -0,0 +1,18 @@
+<?php
+/*=========================================================================
+MIDAS Server
+Copyright (c) Kitware SAS. 20 rue de la Villette. All rights reserved.
+69328 Lyon, FRANCE.
+
+See Copyright.txt for details.
+This software is distributed WITHOUT ANY WARRANTY; without even
+the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
+PURPOSE.  See the above copyright notices for more information.
+=========================================================================*/
+/** Dicomserver_RegistrationDao */
+class Dicomserver_RegistrationDao extends AppDao {
+
+  public $_model = 'Registration';
+  public $_module = 'dicomserver';
+
+}

modules/dicomserver/models/pdo/RegistrationModel.php

@@ -0,0 +1,30 @@
+<?php
+/*=========================================================================
+MIDAS Server
+Copyright (c) Kitware SAS. 20 rue de la Villette. All rights reserved.
+69328 Lyon, FRANCE.
+
+See Copyright.txt for details.
+This software is distributed WITHOUT ANY WARRANTY; without even
+the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
+PURPOSE.  See the above copyright notices for more information.
+=========================================================================*/
+require_once BASE_PATH . '/modules/dicomserver/models/base/RegistrationModelBase.php';
+
+
+/** Dicomserver_RegistrationModel */
+class Dicomserver_RegistrationModel extends Dicomserver_RegistrationModelBase {
+
+  /**
+   * Returns registration by a itemId
+   * @param type $itemId
+   * @return type
+   */
+
+  function checkByItemId($itemId)
+    {
+    $row = $this->database->fetchRow($this->database->select()->where('item_id=?', $itemId));
+    return $this->initDao('Registration', $row, 'dicomserver');
+    }
+
+}