Migrate visualize module settings to database

Author: Jamie Snape

modules/visualize/Notification.php

@@ -21,6 +21,7 @@
 /** Notification manager for the visualize module */
 class Visualize_Notification extends MIDAS_Notification
 {
+    public $_models = array('Setting');
     public $_moduleComponents = array('Main');
     public $moduleName = 'visualize';
 
@@ -77,9 +78,9 @@ public function canVisualize($params)
     /** generate dashboard information */
     public function getDashboard()
     {
-        $modulesConfig = Zend_Registry::get('configsModules');
-        $useparaview = $modulesConfig['visualize']->useparaview;
-        if (!isset($useparaview) || !$useparaview) {
+        $useParaView = $this->Setting->getValueByName(VISUALIZE_USE_PARAVIEW_WEB_KEY, $this->moduleName);
+
+        if (!isset($useParaView) || !$useParaView) {
             return false;
         }
 
@@ -90,10 +91,10 @@ public function getDashboard()
                 '503 Service Temporarily Unavailable'
             ) !== false
         ) {
-            return array('ParaviewWeb Server' => array(false, 'Could not connect to paraview web server'));
+            return array('ParaViewWeb Server' => array(false, 'Could not connect to ParaViewWeb server'));
         }
 
-        return array('ParaviewWeb Server' => array(true, ''));
+        return array('ParaViewWeb Server' => array(true, ''));
     }
 
     /** get server's url */

modules/visualize/configs/module.ini

@@ -1,19 +1,9 @@
-[global]
-; version of the module
-version = 1.0.0
-; full name
-fullname = Visualization
-; description
-description = "Preview online various types of document (Beta version)"
-; category
-category = Visualization
-; dependencies
-dependencies = scheduler,api
+; MIDAS Server. Copyright Kitware SAS. Licensed under the Apache License 2.0.
 
-useparaview = "true"
-userwebgl = "true"
-customtmp = ''
-pwapp = ''
-pvbatch = ''
-paraviewworkdir = ''
-usesymlinks = "true"
+[global]
+fullname = "Visualization"
+description = "Preview various types of document"
+category = "Visualization"
+dependencies = api,scheduler
+uuid = "43f85590-c8d7-403a-82cd-9e46300afd12"
+version = "1.1.0"

modules/visualize/constant/module.php

@@ -0,0 +1,34 @@
+<?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.
+=========================================================================*/
+
+define('VISUALIZE_TEMPORARY_DIRECTORY_KEY', 'temporary_directory');
+define('VISUALIZE_TEMPORARY_DIRECTORY_DEFAULT_VALUE', '');
+define('VISUALIZE_USE_PARAVIEW_WEB_KEY', 'use_paraview_web');
+define('VISUALIZE_USE_PARAVIEW_WEB_DEFAULT_VALUE', '');
+define('VISUALIZE_USE_WEB_GL_KEY', 'use_web_gl');
+define('VISUALIZE_USE_WEB_GL_DEFAULT_VALUE', '');
+define('VISUALIZE_USE_SYMLINKS_KEY', 'use_symlinks');
+define('VISUALIZE_USE_SYMLINKS_DEFAULT_VALUE', '');
+define('VISUALIZE_TOMCAT_ROOT_URL_KEY', 'tomcat_root_url');
+define('VISUALIZE_TOMCAT_ROOT_URL_DEFAULT_VALUE', '');
+define('VISUALIZE_PVBATCH_COMMAND_KEY', 'pvbatch_command');
+define('VISUALIZE_PVBATCH_COMMAND_DEFAULT_VALUE', '');
+define('VISUALIZE_PARAVIEW_WEB_WORK_DIRECTORY_KEY', 'paraview_web_work_directory');
+define('VISUALIZE_PARAVIEW_WEB_WORK_DIRECTORY_DEFAULT_VALUE', '');

modules/visualize/controllers/AdminController.php

@@ -0,0 +1,68 @@
+<?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.
+=========================================================================*/
+
+/** Admin controller for the visualize module. */
+class Visualize_AdminController extends Visualize_AppController
+{
+    /** @var array */
+    public $_models = array('Setting');
+
+    /** Index action */
+    public function indexAction()
+    {
+        $this->requireAdminPrivileges();
+
+        $this->view->pageTitle = 'Visualize Module Configuration';
+        $form = new Visualize_Form_Admin();
+
+        if ($this->getRequest()->isPost()) {
+            $data = $this->getRequest()->getPost();
+
+            if ($form->isValid($data)) {
+                $values = $form->getValues();
+
+                foreach ($values as $key => $value) {
+                    if ($value !== null) {
+                        $this->Setting->setConfig($key, $value, $this->moduleName);
+                    }
+                }
+            }
+
+            $form->populate($data);
+        } else {
+            $elements = $form->getElements();
+
+            foreach ($elements as $element) {
+                $name = $element->getName();
+
+                if ($name !== 'csrf' && $name !== 'submit') {
+                    $value = $this->Setting->getValueByName($name, $this->moduleName);
+
+                    if (!is_null($value)) {
+                        $form->setDefault($name, $value);
+                    }
+                }
+            }
+        }
+
+        $this->view->form = $form;
+        session_start();
+    }
+}