Refactor: Extracted some common code as include_menu_dir_files() method in a new file named common.php.

Author: mladenb

interface/web/capp.php

@@ -31,6 +31,8 @@
 require_once '../lib/config.inc.php';
 require_once '../lib/app.inc.php';
 
+include_once 'common.php';
+
 //* Import module variable
 $mod = $_REQUEST["mod"];
 //* If we click on a search result, load that one instead of the module's start page
@@ -55,17 +57,7 @@
 	include_once $mod."/lib/module.conf.php";
 
 	$menu_dir = ISPC_WEB_PATH.'/'.$mod.'/lib/menu.d';
-
-	if (is_dir($menu_dir)) {
-		if ($dh = opendir($menu_dir)) {
-			//** Go through all files in the menu dir
-			while (($file = readdir($dh)) !== false) {
-				if ($file != '.' && $file != '..' && substr($file, -9, 9) == '.menu.php' && $file != 'dns_resync.menu.php') {
-					include_once $menu_dir.'/'.$file;
-				}
-			}
-		}
-	}
+	include_menu_dir_files($menu_dir);
 
 	$_SESSION["s"]["module"] = $module;
 	session_write_close();

interface/web/common.php

@@ -0,0 +1,53 @@
+<?php
+
+/*
+Copyright (c) 2007, Till Brehm, projektfarm Gmbh
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright notice,
+      this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright notice,
+      this list of conditions and the following disclaimer in the documentation
+      and/or other materials provided with the distribution.
+    * Neither the name of ISPConfig nor the names of its contributors
+      may be used to endorse or promote products derived from this software without
+      specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
+IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
+INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
+OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
+EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+*/
+
+/*
+  Some common helper functions which can be reused throughout the project.
+*/
+
+/**
+ * Includes all the menu files from the menu dir.
+ * @param string $menu_dir Path to the menu dir
+ * @return void
+ */
+function include_menu_dir_files($menu_dir)
+{
+	if (is_dir($menu_dir)) {
+		if ($dh = opendir($menu_dir)) {
+			//** Go through all files in the menu dir
+			while (($file = readdir($dh)) !== false) {
+				if ($file != '.' && $file != '..' && substr($file, -9, 9) == '.menu.php' && $file != 'dns_resync.menu.php') {
+					include_once $menu_dir.'/'.$file;
+				}
+			}
+		}
+	}
+}
+

interface/web/login/index.php

@@ -31,6 +31,8 @@
 require_once '../../lib/config.inc.php';
 require_once '../../lib/app.inc.php';
 
+include_once '../common.php';
+
 // Check if we have an active users session and no login_as.
 if ($_SESSION['s']['user']['active'] == 1 && @$_POST['login_as'] != 1) {
 	header('Location: /index.php');
@@ -238,16 +240,7 @@
 						if (is_file(ISPC_WEB_PATH.'/'.$_SESSION['s']['user']['startmodule'].'/lib/module.conf.php')) {
 							include_once $app->functions->check_include_path(ISPC_WEB_PATH.'/'.$_SESSION['s']['user']['startmodule'].'/lib/module.conf.php');
 							$menu_dir = ISPC_WEB_PATH.'/'.$_SESSION['s']['user']['startmodule'].'/lib/menu.d';
-							if (is_dir($menu_dir)) {
-								if ($dh = opendir($menu_dir)) {
-									//** Go through all files in the menu dir
-									while (($file = readdir($dh)) !== false) {
-										if ($file != '.' && $file != '..' && substr($file, -9, 9) == '.menu.php' && $file != 'dns_resync.menu.php') {
-											include_once $menu_dir.'/'.$file;
-										}
-									}
-								}
-							}
+							include_menu_dir_files($menu_dir);
 							$_SESSION['s']['module'] = $module;
 						}
 						// check if the user theme is valid