Changeset 2949

Timestamp:

05/31/10 05:16:02 (21 months ago)

Author:

nuxwin

Message:

• [GUI] Complete rewrite of the admin/settings_ports.php script

Location:

trunk

Files:

• CHANGELOG (modified) (1 diff)
• gui/admin/settings_ports.php (modified) (1 diff)

trunk/CHANGELOG

@@ -6 +6 @@
                 * Added toArray() method in IspCP_ConfigHandler class to be able to
                         get an associative array that contain all configuration parameters
+                * Complete rewrite of the admin/settings_ports.php script
 
 2010-05-30 Laurent Declercq

trunk/gui/admin/settings_ports.php

@@ -29 +29 @@
  */
 
+// Include all needed libraries
 require '../include/ispcp-lib.php';
 
+// Check for login
 check_login(__FILE__);
 
-$cfg = IspCP_Registry::get('Config');
-
-$tpl = new pTemplate();
-$tpl->define_dynamic('page', $cfg->ADMIN_TEMPLATE_PATH . '/settings_ports.tpl');
-$tpl->define_dynamic('service_ports', 'page');
-$tpl->define_dynamic('port_delete_link', 'service_ports');
-$tpl->define_dynamic('port_delete_show', 'service_ports');
-
-$tpl->assign(
-        array(
-                'TR_ADMIN_SETTINGS_PAGE_TITLE'  => tr('ispCP - Admin/Settings'),
-                'THEME_COLOR_PATH'                              => "../themes/{$cfg->USER_INITIAL_THEME}",
-                'THEME_CHARSET'                                 => tr('encoding'),
-                'ISP_LOGO'                                              => get_logo(get_session('user_id'))
-        )
-);
-
-function update_services(&$sql) {
+/*******************************************************************************
+ * Functions
+ */
+
+/**
+ * Gets and prepares the template part for services ports
+ *
+ * @param pTemplate &$tpl Reference to a pTemplate instance
+ * @return void;
+ */
+function show_services(&$tpl) {
 
         $cfg = IspCP_Registry::get('Config');
         $db_cfg = IspCP_Registry::get('Db_Config');
 
-        if (isset($_POST['uaction']) && $_POST['uaction'] == "apply") {
-                $count = count(get_post('name'));
-                $break = false;
-                $service_name = get_post('name');
-                $var_name = get_post('var_name');
-                $ip = get_post('ip');
-                $port = get_post('port');
-                $protocol = get_post('port_type');
-                $status = get_post('show_val');
-                $custom = get_post('custom');
-
-                for ($j = 0; $j < $count; $j++) {
-                        if (!is_number($port[$j]) OR $port[$j] <= 0) {
-                                set_page_message(tr('ERROR: Only positive numbers are allowed !'));
-                                $break = true;
-                                break;
+        $filter = create_function('$v', 'if(substr($v,0,5) == "PORT_") return $v;');
+        $services = array_filter(array_keys($db_cfg->toArray()), $filter);
+
+        if(empty($services)) {
+                $tpl->assign('SERVICE_PORTS', '');
+
+                set_page_message(tr('You have no custom service ports defined.'));
+        } else {
+                sort($services);
+
+                foreach($services as $i => $service) {
+
+                        $tpl->assign('CLASS', ($i % 2 == 0) ? 'content' : 'content2');
+
+                        $v = (count(explode(';', $db_cfg->$service)) < 6)
+                                ? $db_cfg->$service . ';' : $db_cfg->$service;
+
+                        list($port, $proto, $name, $status, $custom, $ip) = explode(';', $v);
+
+                        $selected_udp = $proto == 'udp' ? $cfg->HTML_SELECTED : '';
+                        $selected_tcp = $proto == 'udp' ? '' : $cfg->HTML_SELECTED;
+
+                        $selected_on = $status == '1' ? $cfg->HTML_SELECTED : '';
+                        $selected_off = $status == '1' ? '' : $cfg->HTML_SELECTED;
+
+                        if ($custom == 0) {
+                                $tpl->assign(
+                                        array(
+                                                'SERVICE' => tohtml($name) .
+                                                        '<input name="name[]" type="hidden" id="name' .
+                                                        $i . '" value="' . tohtml($name) . '" />',
+
+                                                'PORT_READONLY' => $cfg->HTML_READONLY,
+                                                'PROTOCOL_READONLY' => $cfg->HTML_DISABLED,
+                                                'TR_DELETE' => '-',
+                                                'PORT_DELETE_LINK' => '',
+                                                'NUM' => $i
+                                        )
+                                );
+
+                                $tpl->parse('PORT_DELETE_SHOW', '');
+                        } else {
+
+                                $tpl->assign(
+                                        array(
+                                                'SERVICE' => 
+                                                        '<input name="name[]" type="text" id="name' .
+                                                                $i . '" value="' . tohtml($name) .
+                                                                '" class="textinput" maxlength="25" />',
+
+                                                'NAME' => tohtml($name),
+                                                'PORT_READONLY' => '',
+                                                'PROTOCOL_READONLY' => '',
+                                                'TR_DELETE' => tr('Delete'),
+                                                'URL_DELETE' => "?delete=$service",
+                                                'PORT_DELETE_SHOW' => '',
+                                                'NUM' => $i
+                                        )
+                                );
+
+                                $tpl->parse('PORT_DELETE_LINK', 'port_delete_link');
+                        }
+
+                        $tpl->assign(
+                                array(
+                                        'CUSTOM' => tohtml($custom),
+                                        'VAR_NAME' => tohtml($service),
+                                        'IP' => (($ip == '127.0.0.1')
+                                                ? 'localhost'
+                                                : (empty($ip) ? $cfg->BASE_SERVER_IP : tohtml($ip))),
+                                        'PORT' => $port,
+                                        'SELECTED_UDP' => $selected_udp,
+                                        'SELECTED_TCP' => $selected_tcp,
+                                        'SELECTED_ON' => $selected_on,
+                                        'SELECTED_OFF' => $selected_off
+                                )
+                        );
+
+                        $tpl->parse('SERVICE_PORTS', '.service_ports');
+                }
+        }
+} // end show_services()
+
+
+/**
+ * Validates a service port
+ *
+ * @since 1.0.6
+ * @author Laurent declercq (nuxwin) <laurent.declercq@ispcp.net>
+ * @param string $name Service port name
+ * @param string $ip Ip address
+ * @param int $port Service port
+ * @param string $proto Service port protocol
+ * @param int $show
+ * @param boolean $on_updt True: validates for update
+ */
+function validates_service($name, $ip, $port, $proto, $show, $on_updt = false) {
+
+        $db_cfg = IspCP_Registry::get('Db_Config');
+
+        $db_sname = "PORT_$name";
+        $ip = ($ip == 'localhost') ? '127.0.0.1' : $ip;
+
+        if (!is_basicString($name)) {
+                $e = tr('ERROR: Only letters, numbers, dash and underscore are allowed!');
+        } elseif(filter_var($ip, FILTER_VALIDATE_IP, FILTER_FLAG_IPV4) === false) {
+                $e = tr('ERROR: Wrong Ip number!');
+        } elseif(!is_number($port) || $port <= 0) {
+                $e = tr('ERROR: Only positive numbers are allowed!');
+        } elseif(isset($db_cfg->$db_sname) && !$on_updt) {
+                $e = tr('ERROR: Service port already exists!');
+        } elseif($proto != 'tcp' && $proto != 'udp') {
+                $e = tr('ERROR: Unallowed protocol!');
+        } elseif($show != '0' && $show != '1') {
+                $e = tr('ERROR: Bad value for show entry!');
+        } else {
+                return true;
+        }
+
+        set_page_message($e);
+
+        return false;
+}
+
+/**
+ * Adds or updates a service port
+ *
+ * @return void
+ */
+function add_update_services() {
+
+        $cfg = IspCP_Registry::get('Config');
+        $db_cfg = IspCP_Registry::get('Db_Config');
+
+        // Adds a service port
+        if(isset($_POST['name_new']) && !empty($_POST['name_new'])) {
+
+                $name = strtoupper($_POST['name_new']);
+                $ip = $_POST['ip_new'];
+                $port = $_POST['port_new'];
+                $proto = $_POST['port_type_new'];
+                $show = $_POST['show_val_new'];
+
+                if(validates_service($name, $ip, $port, $proto, $show)) {
+                        $db_sname = "PORT_$name";
+
+                        // Add the service port in the database
+                        // See the {@link IspCP_ConfigHandler_Db} adapter class to learn
+                        // how it work
+                        $db_cfg->$db_sname = "$port;$proto;$name;$show;1;$ip";
+
+                        write_log(
+                                        get_session('user_logged') .
+                                                ": Added service port $name ($port)!"
+                        );
+
+                        set_page_message(tr('Service port was added!'));
+                } else {
+                        return;
+                }
+
+        // Updates one or more services ports
+        } elseif(isset($_POST['name']) && !empty($_POST['name'])) {
+                foreach($_POST['name'] as $index => $name) {
+
+                        $ip = $_POST['ip'][$index];
+                        $port = $_POST['port'][$index];
+                        $proto = $_POST['port_type'][$index];
+                        $show = $_POST['show_val'][$index];
+
+                        if(validates_service($name, $ip, $port, $proto, $show, true)) {
+                                $db_sname = "PORT_$name";
+
+                                // Update the service port in the database
+                                // See the {@link IspCP_ConfigHandler_Db} adapter class to learn
+                                // how it work
+                                $db_cfg->$db_sname = "$port;$proto;$name;$show;1;$ip";
+                        } else {
+                                return;
                         }
                 }
 
-                if (!$break) {
-                        // Adding new Ports!
-                        if (isset($_POST['name_new']) && !empty($_POST['name_new'])) {
-                                $ip = get_post('ip_new');
-                                $port = get_post('port_new');
-                                $name = strtoupper(get_post('name_new'));
-                                $protocol = get_post('port_type_new');
-                                $status = get_post('show_val_new');
-
-                                if (!is_number($port) OR $port <= 0) {
-                                        set_page_message(tr('ERROR: Only positive numbers are allowed !'));
-                                        return;
-                                } elseif (!is_basicString($name)) {
-                                        set_page_message(tr('ERROR: Only Letters, Numbers, Dash and Underscore are allowed!'));
-                                        return;
-                                } elseif (filter_var($ip, FILTER_VALIDATE_IP, FILTER_FLAG_IPV4) === false) {
-                                        set_page_message(tr('Wrong IP number!'));
-                                        return;
-                                } else {
-                                        // Check if PORT exists
-                                        $query = "
-                                                SELECT
-                                                        `name`
-                                                FROM
-                                                        `config`
-                                                WHERE
-                                                        `name` = ?
-                                        ";
-                                        $var = "PORT_" . $name;
-                                        $rs = exec_query($sql, $query, array($var));
-
-                                        if ($rs->RecordCount() == 0) {
-                                                $value = implode(";", array($port, $protocol, $name, $status, 1, $ip));
-                                                $db_cfg->$var = $value;
-                                                //setConfig_Value($var, $value);
-                                                write_log(get_session('user_logged') . ": add service port $name ({$port})!");
-                                        } else {
-                                                set_page_message(tr('ERROR: Port already exists!'));
-                                                return;
-                                        }
-                                }
-                        } else {
-                                for ($j = 0; $j < $count; $j++) {
-                                        $var = $var_name[$j];
-                                        $name = strtoupper(strip_tags($service_name[$j]));
-                                        $value = implode(";", array($port[$j], $protocol[$j], $name, $status[$j], $custom[$j], $ip[$j]));
-                                        
-                                        $db_cfg->$var = $value;
-                                        //setConfig_Value($var, $value);
-                                }
-                        }
-                        set_page_message(tr('Settings saved !'));
-                }
-                
-                $cfg->replace_with($db_cfg);
-        }
-}
-
+                set_page_message(tr('Service(s) port was updated !'));
+        }
+} // end add_update_services()
+
+/**
+ * Remove a service port from the database
+ *
+ * @param string service name
+ * return void
+ */
 function delete_service($port_name) {
 
-        $sql = Database::getInstance();
-
-        if (!is_basicString($port_name)) {
-                set_page_message(tr('ERROR: Only Letters, Numbers, Dash and Underscore are allowed!'));
+        $db_cfg = IspCP_Registry::get('Db_Config');
+
+        if (!isset($db_cfg->$port_name)) {
+                set_page_message(tr('ERROR: Unknown service port name!'));
+
                 return;
         }
 
-        $query = "
-                SELECT
-                        *
-                FROM
-                        `config`
-                WHERE
-                        `name` = ?
-        ";
-
-        $rs = exec_query($sql, $query, array($port_name));
-
-        $value = (count(explode(";", $rs->fields['value'])) < 6)
-                ? $rs->fields['value'].';'
-                : $rs->fields['value'];
-        list($port, $protocol, $name, $status, $custom, $ip) = explode(";", $value);
-
-        if ($custom == 1) {
-                $query = "
-                        DELETE FROM
-                                `config`
-                        WHERE
-                                `name` = ?
-                ";
-
-                $rs = exec_query($sql, $query, array($port_name));
-                write_log(get_session('user_logged') . ": remove service port $port_name!");
+        $values = (count(explode(';', $db_cfg->$port_name)) < 6)
+                ? $db_cfg->$port_name . ';' : $db_cfg->$port_name;
+
+        list(,,,,$custom,) = explode(';', $values);
+
+        if($custom == 1) {
+                // Remove the service from the database
+                // see the {@link IspCP_ConfigHandler_Db} adapter class to learn how
+                // it work
+                unset($db_cfg->$port_name);
+
+                write_log(
+                        get_session('user_logged') . ": Removed service port $port_name!"
+                );
 
                 set_page_message('Service port was removed!');
         } else {
-                set_page_message('ERROR: You are not allowed to remove this port entry!');
-        }
-
+                set_page_message(
+                        'ERROR: You are not allowed to remove this port entry!'
+                );
+        }
+}
+
+
+/*******************************************************************************
+ * Main program
+ */
+
+/**
+ * Dispatches the request
+ */
+
+// Adds a service port or updates one or more services ports
+if (isset($_POST['uaction']) && $_POST['uaction'] == 'apply') {
+        add_update_services();
+
+echo '<pre>';
         user_goto('settings_ports.php');
+
+// Deletes a service port
+} elseif(isset($_GET['delete'])) {
+
+        delete_service($_GET['delete']);
+        user_goto('settings_ports.php');
+
+// Show all services ports
+} else {
+
+        $cfg = IspCP_Registry::get('Config');
+
+        $tpl = new pTemplate();
+        $tpl->define_dynamic(
+                'page', $cfg->ADMIN_TEMPLATE_PATH . '/settings_ports.tpl'
+        );
+        $tpl->define_dynamic('service_ports', 'page');
+        $tpl->define_dynamic('port_delete_link', 'service_ports');
+        $tpl->define_dynamic('port_delete_show', 'service_ports');
+
+        $tpl->assign(
+                array(
+                        'TR_ADMIN_SETTINGS_PAGE_TITLE' => tr('ispCP - Admin/Settings'),
+                        'THEME_COLOR_PATH' => "../themes/{$cfg->USER_INITIAL_THEME}",
+                        'THEME_CHARSET' => tr('encoding'),
+                        'ISP_LOGO' => get_logo(get_session('user_id'))
+                )
+        );
+
+        gen_admin_mainmenu(
+                $tpl, $cfg->ADMIN_TEMPLATE_PATH . '/main_menu_settings.tpl'
+        );
+        gen_admin_menu($tpl, $cfg->ADMIN_TEMPLATE_PATH . '/menu_settings.tpl');
+
+        show_services($tpl);
+
+        $tpl->assign(
+                array(
+                'TR_ACTION' => tr('Action'),
+                'TR_UDP' => tr('udp'),
+                'TR_TCP' => tr('tcp'),
+                'TR_ENABLED' => tr('Yes'),
+                'TR_DISABLED' => tr('No'),
+                'TR_APPLY_CHANGES' => tr('Apply changes'),
+                'TR_SERVERPORTS' => tr('Server ports'),
+                'TR_SERVICES' => tr('Services'),
+                'TR_SERVICE' => tr('Service'),
+                'TR_IP' => tr('IP'),
+                'TR_PORT' => tr('Port'),
+                'TR_PROTOCOL' => tr('Protocol'),
+                'TR_SHOW' => tr('Show'),
+                'TR_ACTION' => tr('Action'),
+                'TR_DELETE' => tr('Delete'),
+                'TR_ADD' => tr('Add'),
+                'TR_MESSAGE_DELETE' =>
+                        tr('Are you sure you want to delete %s?', true, '%s')
+                )
+        );
+
+        gen_page_message($tpl);
+
+        $tpl->parse('PAGE', 'page');
+        $tpl->prnt();
 }
-
-function show_services(&$tpl, &$sql) {
-
-        $cfg = IspCP_Registry::get('Config');
-
-        $query = "
-                SELECT
-                        *
-                FROM
-                        `config`
-                WHERE
-                        `name` LIKE 'PORT_%'
-                ORDER BY
-                        `name` ASC
-        ";
-
-        $rs = exec_query($sql, $query, array());
-
-        $row = 1;
-
-        if ($rs->RecordCount() == 0) {
-                $tpl->assign('SERVICE_PORTS', '');
-
-                set_page_message(tr('You have no custom service ports defined.'));
-        } else {
-                while (!$rs->EOF) {
-                        $tpl->assign('CLASS', ($row++ % 2 == 0) ? 'content' : 'content2');
-
-                        $value = (count(explode(";", $rs->fields['value'])) < 6)
-                                ? $rs->fields['value'].';'
-                                : $rs->fields['value'];
-                        list($port, $protocol, $name, $status, $custom, $ip) = explode(";", $value);
-
-                        $selected_udp   = $protocol == 'udp' ? $cfg->HTML_SELECTED : '';
-                        $selected_tcp   = $protocol == 'udp' ? '' : $cfg->HTML_SELECTED;
-
-                        $selected_on    = $status == '1' ? $cfg->HTML_SELECTED : '';
-                        $selected_off   = $status == '1' ? '' : $cfg->HTML_SELECTED;
-
-                        if ($custom == 0) {
-                                $tpl->assign(array('SERVICE' => tohtml($name) . '<input name="name[]" type="hidden" id="name' . $row . '" value="' . tohtml($name) . '" />'));
-                                $tpl->assign(
-                                        array(
-                                                'PORT_READONLY'         => $cfg->HTML_READONLY,
-                                                'PROTOCOL_READONLY'     => $cfg->HTML_DISABLED,
-                                                'TR_DELETE'                     => '-',
-                                                'PORT_DELETE_LINK'      => '',
-                                                'NUM'                           => $row
-                                        )
-                                );
-                                $tpl->parse('PORT_DELETE_SHOW', '');
-                        } else {
-                                $tpl->assign(array('SERVICE' => '<input name="name[]" type="text" id="name' . $row . '" value="' . tohtml($name) . '" class="textinput" maxlength="25" />'));
-                                $tpl->assign(
-                                        array(
-                                                'NAME'                          => tohtml($name),
-                                                'PORT_READONLY'         => '',
-                                                'PROTOCOL_READONLY'     => '',
-                                                'TR_DELETE'                     => tr('Delete'),
-                                                'URL_DELETE'            => 'settings_ports.php?delete=' . $rs->fields['name'],
-                                                'PORT_DELETE_SHOW'      => '',
-                                                'NUM'                           => $row
-                                        )
-                                );
-                                $tpl->parse('PORT_DELETE_LINK', 'port_delete_link');
-                        }
-
-                        $tpl->assign(
-                                array(
-                                        'CUSTOM'                => tohtml($custom),
-                                        'VAR_NAME'              => tohtml($rs->fields['name']),
-                                        'IP'                    => (($ip == '127.0.0.1') ? 'localhost' : (empty($ip) ? $cfg->BASE_SERVER_IP : tohtml($ip))),
-                                        'PORT'                  => $port,
-                                        'SELECTED_UDP'  => $selected_udp,
-                                        'SELECTED_TCP'  => $selected_tcp,
-                                        'SELECTED_ON'   => $selected_on,
-                                        'SELECTED_OFF'  => $selected_off,
-                                )
-                        );
-
-                        $tpl->parse('SERVICE_PORTS', '.service_ports');
-
-                        $rs->MoveNext();
-                } // end while
-        } // end else
-}
-// Fetch delete request
-if (isset($_GET['delete'])) {
-        delete_service($_GET['delete']);
-}
-
-/**
- * static page messages.
- */
-
-update_services($sql);
-
-gen_admin_mainmenu($tpl, $cfg->ADMIN_TEMPLATE_PATH . '/main_menu_settings.tpl');
-gen_admin_menu($tpl, $cfg->ADMIN_TEMPLATE_PATH . '/menu_settings.tpl');
-
-show_services($tpl, $sql);
-
-$tpl->assign(
-        array(
-                'TR_ACTION'                     => tr('Action'),
-                'TR_UDP'                        => tr('udp'),
-                'TR_TCP'                        => tr('tcp'),
-                'TR_ENABLED'            => tr('Yes'),
-                'TR_DISABLED'           => tr('No'),
-                'TR_APPLY_CHANGES'      => tr('Apply changes'),
-                'TR_SERVERPORTS'        => tr('Server ports'),
-                'TR_SERVICES'           => tr('Services'),
-                'TR_SERVICE'            => tr('Service'),
-                'TR_IP'                         => tr('IP'),
-                'TR_PORT'                       => tr('Port'),
-                'TR_PROTOCOL'           => tr('Protocol'),
-                'TR_SHOW'                       => tr('Show'),
-                'TR_ACTION'                     => tr('Action'),
-                'TR_DELETE'                     => tr('Delete'),
-                'TR_ADD'                        => tr('Add'),
-                'TR_MESSAGE_DELETE'     => tr('Are you sure you want to delete %s?', true, '%s')
-        )
-);
-
-gen_page_message($tpl);
-
-$tpl->parse('PAGE', 'page');
-$tpl->prnt();
 
 if ($cfg->DUMP_GUI_DEBUG) {