Merge branch 'master' of https://github.com/HankIT/phpietadmin-gui

Author: mrcrankhank

README.md

@@ -1,6 +1,31 @@
 # phpietadmin
 Phpietadmin is an easy to use webinterface to control the iscsi enterprise target (iet) daemon (http://sourceforge.net/projects/iscsitarget/) written in php and javascript.
 
+## Features
+### Dashboard
+The dashboard provides a quick overview about your system and phpietadmin.
+
+### iSCSI
+phpietadmin enables you to configure all features of the iscsi enterprise target daemon via web, e.g.:
+
+    * Adding/Removing luns
+    * Initiator/Target allow
+    * User management
+    * Sessions
+    * Settings
+    * Target removal
+
+### LVM
+phpietadmin currently only supports lvm as iscsi luns!
+
+    * Adding volumes
+    * Extending volumes (+ notify iscsi initiator about the change)
+    * Shrinking volumes
+    * Renaming volumes
+    * Deleting volumes
+
+..and more.
+
 ## Intention
 The main reason for developing this was, to create a way to configure the daemon while it’s in use. The iet daemon reads
 the config file only at start/restart. Changes after the daemon was started are only possible via the ietadm command line
@@ -26,68 +51,4 @@ Official support for CentOS is planned.
 ### Beta
 * https://github.com/HankIT/phpietadmin-doc/wiki/v0.6.2-%5Bbeta%5D
 
-## Features
-Take a look at the github releases for detailed information about the features.
-
-## Roadmap
-In version 0.7:
-* LVM
-    - [ ] Volume group menu (select which volume groups phpietadmin should use)
-    - [ ] Optional lv prefix (append LV_ or some other user chosen string)
-    - [ ] Add snapshot merge feature to gui
-    - [ ] Add enable/disable logical volume feature to gui
-
-* Frontend
-    - [ ] Use jwindow to dynamically display the status of running commands
-    - [ ] Drag & Drop with HTML5
-    - [ ] Menu to import orphaned objects into database
-    - [ ] Display input validation with bootstrap css Validation states (http://formvalidation.io/validators/integer/)
-    - [ ] Bootstrap-table Table Select Checkbox
-    - [ ] Awesome checkboxes (https://github.com/designmodo/Flat-UI)
-    - [ ] Improve nested table row handling
-    - [ ] Add target and lvm name to url
-    - [ ] Overview/Logical volumes VG selector
-    - [ ] Add "Edit file directly" option
-    - [ ] Searchable table for overview menu
-    - [ ] Release "compressed" javascript files
-
-* Backend
-    - [ ] Write process class to execute commands in the background (+ jwindow)
-    - [ ] Create complete documentation on https://readthedocs.org/
-    - [ ] Use unity testing
-    - [ ] Replace all error codes with exceptions
-    - [ ] Support "All" permission in ietd config files
-    - [ ] Write phpietadmin-cli
-    - [ ] Database error log
-
-* In version 0.8:
-    - [ ] Support for DRBD (show status)
-    - [ ] Support for HA Clusters (Corosync & Pacemaker, only for iet)
-
-* In version 0.9:
-    - [ ] Support for nfs
-
-## More
-- [ ] Software raid status
-- [ ] Support for samba shares
-- [ ] Show and configure network settings
-- [ ] Enable/Disable features
-- [ ] Support for apcupsd
-- [ ] Manual selection of block devices
-- [ ] HDD temp
-- [ ] Pie Chart for volume groups
-- [ ] Smart data
-- [ ] Backup config files (http://code.stephenmorley.org/php/diff-implementation/)
-- [ ] Menu to restore config files
-- [ ] function naming convention in models (prepend class name to function name)
-- [ ] Create "consistency", which displays if the daemon config and the config file are identically
-- [ ] Use composer
-- [ ] Use json for tables
-- [ ] Change duplication check (Try to select the specific value from the database)
-- [ ] Use own exception class for error handling
-- [ ] Sign archives
-- [ ] Separate database models
-- [ ] SSH login via web gui (https://github.com/liftoff/GateOne)
-- [ ] Add bar to snapshot delete gui
-
 If you have any problems, please open an issue!

ROADMAP.md

@@ -0,0 +1,61 @@
+## Roadmap
+This is just a approximately of the features, i want to implement in the future.
+In version 0.7:
+* LVM
+    - [ ] Volume group menu (select which volume groups phpietadmin should use)
+    - [ ] Optional lv prefix (append LV_ or some other user chosen string)
+    - [ ] Add snapshot merge feature to gui
+    - [ ] Add enable/disable logical volume feature to gui
+
+* Frontend
+    - [ ] Use jwindow to dynamically display the status of running commands
+    - [ ] Drag & Drop with HTML5
+    - [ ] Menu to import orphaned objects into database
+    - [ ] Display input validation with bootstrap css Validation states (http://formvalidation.io/validators/integer/)
+    - [ ] Bootstrap-table Table Select Checkbox
+    - [ ] Awesome checkboxes (https://github.com/designmodo/Flat-UI)
+    - [ ] Improve nested table row handling
+    - [ ] Add target and lvm name to url
+    - [ ] Overview/Logical volumes VG selector
+    - [ ] Add "Edit file directly" option
+    - [ ] Searchable table for overview menu
+    - [ ] Release "compressed" javascript files
+
+* Backend
+    - [ ] Write process class to execute commands in the background (+ jwindow)
+    - [ ] Create complete documentation on https://readthedocs.org/
+    - [ ] Use unity testing
+    - [ ] Replace all error codes with exceptions
+    - [ ] Support "All" permission in ietd config files
+    - [ ] Write phpietadmin-cli
+    - [ ] Database error log
+
+* In version 0.8:
+    - [ ] Support for DRBD (show status)
+    - [ ] Support for HA Clusters (Corosync & Pacemaker, only for iet)
+
+* In version 0.9:
+    - [ ] Support for nfs
+
+## More
+- [ ] Software raid status
+- [ ] Support for samba shares
+- [ ] Show and configure network settings
+- [ ] Enable/Disable features
+- [ ] Support for apcupsd
+- [ ] Manual selection of block devices
+- [ ] HDD temp
+- [ ] Pie Chart for volume groups
+- [ ] Smart data
+- [ ] Backup config files (http://code.stephenmorley.org/php/diff-implementation/)
+- [ ] Menu to restore config files
+- [ ] function naming convention in models (prepend class name to function name)
+- [ ] Create "consistency", which displays if the daemon config and the config file are identically
+- [ ] Use composer
+- [ ] Use json for tables
+- [ ] Change duplication check (Try to select the specific value from the database)
+- [ ] Use own exception class for error handling
+- [ ] Sign archives
+- [ ] Separate database models
+- [ ] SSH login via web gui (https://github.com/liftoff/GateOne)
+- [ ] Add bar to snapshot delete gui

app/controllers/Targets.php

@@ -16,52 +16,6 @@ public function addtarget() {
         }
     }
 
-    public function adddisuser() {
-        if (isset($_POST['id'], $_POST['type'])) {
-            $type = filter_input(INPUT_POST, 'type', FILTER_SANITIZE_STRING);
-            $id = filter_input(INPUT_POST, 'id', FILTER_SANITIZE_NUMBER_INT);
-
-            if ($type === 'Incoming') {
-                $type = 'IncomingUser';
-            } else if ($type === 'Outgoing') {
-                $type = 'OutgoingUser';
-            } else {
-                echo "The type value is invalid!";
-                die();
-            }
-            $target = $this->model('target\Target');
-            $target->add_user($id, true, $type);
-            echo json_encode($target->logging->get_action_result());
-        } else {
-            $data = $this->baseModel->database->get_all_usernames(true);
-
-            if ($data != 0) {
-                $this->view('targets/add_dis_user', $data);
-            } else {
-                $this->view('message', array('message' => 'Error - No user available!', 'type' => 'warning', 'container' => true));
-            }
-        }
-    }
-
-    public function deletedisuser() {
-        if (isset($_POST['type'], $_POST['id'])) {
-            $type = filter_input(INPUT_POST, 'type', FILTER_SANITIZE_STRING);
-            $id = filter_input(INPUT_POST, 'id', FILTER_SANITIZE_NUMBER_INT);
-
-            $target = $this->model('target\Target');
-            $target->delete_user($id, true, $type);
-            echo json_encode($target->logging->get_action_result());
-        } else {
-            $target = $this->model('target\Target');
-            $data = $target->get_user(true);
-            if ($data !== false) {
-                $this->view('targets/delete_dis_user', $data);
-            } else {
-                $this->view('message', array('message' => 'Error - No user available!', 'type' => 'warning', 'container' => true));
-            }
-        }
-    }
-
     public function configure($iqn = false, $function = false) {
         if ($iqn !== false) {
             $iqn = filter_var($iqn, FILTER_SANITIZE_STRING);

app/core/App.php

@@ -5,11 +5,25 @@
     app\models\logging,
     app\models;
 
+/**
+ * Entry point for this application. All requests are handled here.
+ * @package app\core
+ * @throws \Exception if the version file is invalid
+ */
 class App {
+    /** @var object $controllerObject Contains the object of the called controller */
     protected $controllerObject;
+
+    /** @var string $controllerName Contains the name of the called controller, it's initialized with a default value */
     protected $controllerName = 'app\\controllers\\dashboard';
+
+    /** @var string $method Contains the name of the called method, it's initialized with a default value */
     protected $method = 'index';
+
+    /** @var array $params Contains an array with all parameters */
     protected $params = [];
+
+    /** @var array $url Contains the url using the parseUrl() function */
     protected $url;
 
     public function __construct() {
@@ -18,6 +32,11 @@ public function __construct() {
         $this->url = $this->parseUrl();
     }
 
+    /**
+     * Create the database. Check if it's already there, otherwise you will delete all data ;-)
+     *
+     * @return void
+     */
     private function installDb() {
         exec('sqlite3 ' . DB_FILE . ' < ' . INSTALL_DIR . '/database.new.sql', $output, $code);
 
@@ -26,6 +45,14 @@ private function installDb() {
         }
     }
 
+    /**
+     * Check if the database has the same version as the application. If not update it using the
+     * database.update.sql file.
+     * Nothing will be done, if the application is in development mode.
+     *
+     * @throws \Exception if the version file is invalid
+     * @return void
+     */
     private function updateDb() {
         // check if db update is necessary
         $version = $this->controllerObject->baseModel->database->get_config('version');
@@ -49,6 +76,13 @@ private function updateDb() {
         }
     }
 
+    /**
+     * This method start the application. It creates necessary objects, handles authentication
+     * and outputs the application header + menu if the request isn't an ajax
+     *
+     * @throws \Exception if the called controller or method is not found
+     * @return void
+     */
     public function app() {
         if (file_exists(CONTROLLER_DIR . '/' . ucfirst($this->url[0]) . '.php')) {
             $this->controllerName = 'app\\controllers\\' . $this->url[0];
@@ -107,26 +141,49 @@ public function app() {
         call_user_func_array([$this->controllerObject, $this->method], $this->params);
     }
 
+    /**
+     * Split the url for application routing
+     * @return array
+     */
     private function parseUrl() {
         if (isset($_GET['url'])) {
             return $url = explode('/', filter_var(rtrim($_GET['url'], '/'), FILTER_SANITIZE_URL));
         }
     }
 
+    /**
+     * Fill the registry with all necessary models and
+     * instantiated a baseModel, to access the models through the
+     * controllerObject
+     *
+     * @throws \Exception
+     * @return void
+     */
     private function setupRegistry() {
         $registry = Registry::getInstance();
         $registry->set('database', new models\Database());
         $registry->set('logging', new logging\Logging());
         $this->controllerObject->baseModel = new BaseModel();
     }
 
-    // Sanitize user input
-    // Unlikely that this does something useful
-    // but it's a welcome addition
+    /**
+     * Sanitize user input
+     * Unlikely that this does something useful
+     * but it's a welcome addition
+     *
+     * @param $value array
+     * @return void
+     */
     private function sanitize(&$value) {
         $value = addslashes(strip_tags(trim($value)));
     }
 
+    /**
+     * Output application header and menu, if the user is authenticated and
+     * the request is not ajax
+     *
+     * @return void
+     */
     private function showHeader() {
         // If request is no ajax, display header, menu and footer
         if (!models\Misc::isXHttpRequest() && $this->controllerName !== 'app\controllers\auth') {
@@ -135,6 +192,11 @@ private function showHeader() {
         }
     }
 
+    /**
+     * Validate if the user is correctly authenticated
+     *
+     * @return void
+     */
     private function checkAuth() {
         // auth controller is accessible without authentication
         if ($this->controllerName !== 'app\controllers\auth') {

app/core/BaseModel.php

@@ -4,8 +4,17 @@
 use app\models,
     app\models\logging;
 
+/**
+ * This classed provides basic functions, which are used in almost every model.
+ *
+ * @package app\core
+ * @throws \Exception if the selected registry element is not found
+ */
 class BaseModel {
+    /** @var object $database Object for database access */
     public $database;
+
+    /** @var object $logging Object for logging (read and write) */
     public $logging;
 
     public function __construct() {

app/models/target/Exec.php

@@ -105,7 +105,7 @@ protected function get_configured_iet_users($discovery = false) {
         if ($discovery === true) {
             $return = models\Misc::logExec($this->ietadm . ' --op show --user');
         } else {
-            $return = models\Misc::logExecn($this->ietadm . ' --op show --tid=' . $this->tid . ' --user');
+            $return = models\Misc::logExec($this->ietadm . ' --op show --tid=' . $this->tid . ' --user');
         }
 
         if (!empty($return['status'])) {

app/views/menu.php

@@ -29,9 +29,6 @@
                     <ul class = "dropdown-menu">
                         <li><a class="workspaceTab" href="<?php echo WEB_PATH ?>/targets/addtarget"><span class="glyphicon glyphicon-plus"></span> Add</a></li>
                         <li><a class="workspaceTab" href="<?php echo WEB_PATH ?>/targets/configure"><span class="glyphicon glyphicon-wrench"></span> Configure</a></li>
-                        <li class="divider"></li>
-                        <li><a class="workspaceTab" href="<?php echo WEB_PATH ?>/targets/adddisuser"><span class="glyphicon glyphicon-plus"></span> Add discovery user</a></li>
-                        <li><a class="workspaceTab" href="<?php echo WEB_PATH ?>/targets/deletedisuser"><span class="glyphicon glyphicon-trash"></span> Delete discovery user</a></li>
                     </ul>
                 </li>
                 <li><a class="workspaceTab" href="<?php echo WEB_PATH ?>/ietusers"><span class="glyphicon glyphicon-user"></span> <span>iSCSI users</span></a></li>