PageDecoration::pageheader() - Code Metrics - Inspection of "menu links corrections" - GEANT/CAT - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 4377c1...932be3 )

by Tomasz

created 2018-01-19 07:32 UTC

PageDecoration::pageheader() A

↳ Parent: PageDecoration

Complexity

Conditions	1
Paths	1

Size

Total Lines	6
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	6
c	0
b	0
f	0
rs	9.4285
cc	1
eloc	5
nc	1
nop	3

<?php

/*
 * ******************************************************************************
 * Copyright 2011-2017 DANTE Ltd. and GÉANT on behalf of the GN3, GN3+, GN4-1 
 * and GN4-2 consortia
 *
 * License: see the web/copyright.php file in the file structure
 * ******************************************************************************
 */

namespace web\lib\admin;

class PageDecoration {

    private $validator;
    private $ui;
    
    public function __construct() {
        $this->validator = new \web\lib\common\InputValidation();
        $this->ui = new UIElements();
    }
    /**
     * Our (very modest and light) sidebar. authenticated admins get more options, like logout
     * @param boolean $advancedControls
     */
    private function sidebar($advancedControls) {
        $retval = "<div class='sidebar'><p>";

        if ($advancedControls) {
            $retval .= "<strong>" . _("You are:") . "</strong> "
                    . (isset($_SESSION['name']) ? $_SESSION['name'] : _("Unnamed User")) . "
              <br/>
              <br/>
              <a href='" . \core\CAT::getRootUrlPath() . "/admin/overview_user.php'>" . _("Go to your Profile page") . "</a> 
              <a href='" . \core\CAT::getRootUrlPath() . "/admin/inc/logout.php'>" . _("Logout") . "</a> ";
        }
        $retval .= "<a href='" . \core\CAT::getRootUrlPath() . "'>" . _("Start page") . "</a>
            </p>
        </div> <!-- sidebar -->";
        return $retval;
    }

    /**
     * constructs a <div> called 'header' for use on the top of the page
     * @param string $cap1 caption to display in this div
     * @param string $language current language (this one gets pre-set in the lang selector drop-down
     */
    private function headerDiv($cap1, $language) {

        $place = parse_url($_SERVER['REQUEST_URI'], PHP_URL_PATH);

        $retval = "<div class='header'>
            <div id='header_toprow'>
                <div id='header_captions' style='display:inline-block; float:left; min-width:400px;'>
                    <h1>$cap1</h1>
                </div><!--header_captions-->
                <div id='langselection' style='padding-top:20px; padding-left:10px;'>
                    <form action='$place' method='GET' accept-charset='UTF-8'>" . _("View this page in") . "&nbsp;
                        <select id='lang' name='lang' onchange='this.form.submit()'>";

        foreach (CONFIG['LANGUAGES'] as $lang => $value) {
            $retval .= "<option value='$lang' " . (strtoupper($language) == strtoupper($lang) ? "selected" : "" ) . " >" . $value['display'] . "</option> ";
        }
        $retval .= "</select>";

        foreach ($_GET as $var => $value) {
            if ($var != "lang" && $value != "") {
                $retval .= "<input type='hidden' name='" . htmlspecialchars($var) . "' value='" . htmlspecialchars($value) . "'>";
            }
        }
        $retval .= "</form>
                </div><!--langselection-->";
        $logoUrl = \core\CAT::getRootUrlPath() . "/resources/images/consortium_logo.png";        
        $retval .= "<div class='consortium_logo'>
                    <img id='test_locate' src='$logoUrl' alt='Consortium Logo'>
                </div> <!-- consortium_logo -->
            </div><!--header_toprow-->
        </div> <!-- header -->";
        return $retval;
    }

    /**
     * This starts HTML in a default way. Most pages would call this.
     * Exception: if you need to add extra code in <head> or modify the <body> tag
     * (e.g. onload) then you should call defaultPagePrelude, close head, open body,
     * and then call productheader.
     * 
     * @param string $pagetitle Title of the page to display
     * @param string $area the area in which this page is (displays some matching <h1>s)
     * @param boolean $authRequired
     */
    public function pageheader($pagetitle, $area, $authRequired = TRUE) {
        $retval = "";
        $retval .= $this->defaultPagePrelude($pagetitle, $authRequired);
        $retval .= "</head></body>";
        $retval .= $this->productheader($area);
        return $retval;
    }

    /**
     * the entire top of the page (<body> part)
     * 
     * @param string $area the area we are in
     */
    public function productheader($area) {
        $langObject = new \core\common\Language();
        $language = $langObject->getLang();
        // this <div is closing in footer, keep it in PHP for Netbeans syntax
        // highlighting to work
        $retval = "<div class='maincontent'>";
        // default values which match almost every case; override where needed
        $cap1 = CONFIG['APPEARANCE']['productname_long'];
        $advancedControls = TRUE;
        switch ($area) {
            case "ADMIN-IDP":
                $cap2 = sprintf(_("Administrator Interface - Identity Provider"),$this->ui->nomenclature_inst);
                break;
            case "ADMIN-IDP-USERS":
                $cap2 = sprintf(_("Administrator Interface - %s User Management"), \core\ProfileSilverbullet::PRODUCTNAME);
                break;
            case "ADMIN":
                $cap2 = _("Administrator Interface");
                break;
            case "USERMGMT":
                $cap2 = _("Management of User Details");
                break;
            case "FEDERATION":
                $cap2 = sprintf(_("Administrator Interface - %s Management"),$this->ui->nomenclature_fed);
                break;
            case "USER":
                $cap1 = sprintf(_("Welcome to %s"), CONFIG['APPEARANCE']['productname']);
                $cap2 = CONFIG['APPEARANCE']['productname_long'];
                $advancedControls = FALSE;
                break;
            case "SUPERADMIN":
                $cap2 = _("CIC");
                break;
            case "DIAG":
                $cap2 = _("Diagnostics");
                break;
            default:
                $cap2 = "It is an error if you ever see this string.";
                $advancedControls = FALSE;
        }

        $retval .= $this->headerDiv($cap1, $language);
        // content from here on will SCROLL instead of being fixed at the top
        $retval .= "<div class='pagecontent'>"; // closes in footer again
        $retval .= "<div class='trick'>"; // closes in footer again
        $retval .= "<div id='secondrow' style='border-bottom:5px solid ".CONFIG['APPEARANCE']['colour1']."; min-height:100px;'>
            <div id='secondarycaptions' style='display:inline-block; float:left'>
                <h2>$cap2</h2>
            </div><!--secondarycaptions-->";

        if (isset(CONFIG['APPEARANCE']['MOTD']) && CONFIG['APPEARANCE']['MOTD'] != "") {
            $retval .= "<div id='header_MOTD' style='display:inline-block; padding-left:20px;vertical-align:top;'>
              <p class='MOTD'>" . CONFIG['APPEARANCE']['MOTD'] . "</p>
              </div><!--header_MOTD-->";
        }
        $retval .= $this->sidebar($advancedControls);
        $retval .= "</div><!--secondrow-->";
        return $retval;
    }

    /**
     * 
     * @param string $pagetitle Title of the page to display
     * @param boolean $authRequired does the user need to be autenticated to access this page?
     */
    public function defaultPagePrelude($pagetitle, $authRequired = TRUE) {
        if ($authRequired === TRUE) {
            $auth = new \web\lib\admin\Authentication();
            $auth->authenticate();
        }
        $langObject = new \core\common\Language();
        $langObject->setTextDomain("web_admin");
        $ourlocale = $langObject->getLang();
        header("Content-Type:text/html;charset=utf-8");
        $retval = "<!DOCTYPE html>
          <html xmlns='http://www.w3.org/1999/xhtml' lang='$ourlocale'>
          <head lang='$ourlocale'>
          <meta http-equiv='Content-Type' content='text/html; charset=UTF-8'>";

        if (strrpos($_SERVER['PHP_SELF'], "admin/")) {
            $cutoffPosition = strrpos($_SERVER['PHP_SELF'], "admin/");

        } elseif (strrpos($_SERVER['PHP_SELF'], "accountstatus/")) {
            $cutoffPosition = strrpos($_SERVER['PHP_SELF'], "accountstatus/");
        } elseif (strrpos($_SERVER['PHP_SELF'], "diag/")) {
            $cutoffPosition = strrpos($_SERVER['PHP_SELF'], "diag/");
        }
            else {
            $cutoffPosition = strrpos($_SERVER['PHP_SELF'], "/");
        }

        $host = $this->validator->hostname($_SERVER['SERVER_NAME']);
        if ($host === FALSE) {
            throw new \Exception("We don't know our own hostname!");
        }
        $cssUrl = \core\CAT::getRootUrlPath() . "/resources/css/cat.css.php";
        $retval .= "<link rel='stylesheet' type='text/css' href='$cssUrl' />";
        $retval .= "<title>" . htmlspecialchars($pagetitle) . "</title>";
        return $retval;
    }

    /**
     * HTML code for the EU attribution
     * 
     * @return string HTML code with GEANT Org and EU attribution as required for FP7 / H2020 projects
     */
    public function attributionEurope() {
        if (CONFIG_CONFASSISTANT['CONSORTIUM']['name'] == "eduroam" && isset(CONFIG_CONFASSISTANT['CONSORTIUM']['deployment-voodoo']) && CONFIG_CONFASSISTANT['CONSORTIUM']['deployment-voodoo'] == "Operations Team") {// SW: APPROVED
        // we may need to jump up one dir if we are either in admin/ or accountstatus/
        // (accountstatus courtesy of my good mood. It's userspace not admin space so
        // it shouldn't be using this function any more.)
        
        if (strrpos($_SERVER['PHP_SELF'], "admin/")) {
            $cutoffPosition = strrpos($_SERVER['PHP_SELF'], "admin/");
        } elseif (strrpos($_SERVER['PHP_SELF'], "accountstatus/")) {
            $cutoffPosition = strrpos($_SERVER['PHP_SELF'], "accountstatus/");
        } elseif (strrpos($_SERVER['PHP_SELF'], "diag/")) {
            $cutoffPosition = strrpos($_SERVER['PHP_SELF'], "diag/");
        } else {
            $cutoffPosition = strrpos($_SERVER['PHP_SELF'], "/");
        }
        $host = $this->validator->hostname($_SERVER['SERVER_NAME']);
        if ($host === FALSE) {
            throw new \Exception("We don't know our own hostname!");
        }
        $logoBase = "//$host" . substr($_SERVER['PHP_SELF'], 0, $cutoffPosition)."/resources/images";

        return "<span id='logos' style='position:fixed; left:50%;'><img src='$logoBase/dante.png' alt='DANTE' style='height:23px;width:47px'/>
              <img src='$logoBase/eu.png' alt='EU' style='height:23px;width:27px;border-width:0px;'/></span>
              <span id='eu_text' style='text-align:right;'><a href='http://ec.europa.eu/dgs/connect/index_en.htm' style='text-decoration:none; vertical-align:top;'>European Commission Communications Networks, Content and Technology</a></span>";
        }
        return "&nbsp";
    }

    /**
     * displays the admin area footer
     */
    public function footer() {
        $cat = new \core\CAT();
        $retval = "</div><!-- trick -->
          </div><!-- pagecontent -->
        <div class='footer'>
            <hr />
            <table style='width:100%'>
                <tr>
                    <td style='padding-left:20px; padding-right:20px; text-align:left; vertical-align:top;'>
                        " . $cat->CAT_COPYRIGHT . "</td>
                    <td style='padding-left:80px; padding-right:20px; text-align:right; vertical-align:top;'>";

        if (CONFIG_CONFASSISTANT['CONSORTIUM']['name'] == "eduroam" && isset(CONFIG_CONFASSISTANT['CONSORTIUM']['deployment-voodoo']) && CONFIG_CONFASSISTANT['CONSORTIUM']['deployment-voodoo'] == "Operations Team") { // SW: APPROVED
            $retval .= $this->attributionEurope();
        } else {
            $retval .= "&nbsp;";
        }
        $retval .= "
                    </td>
                </tr>
            </table>
        </div><!-- footer -->
        </div><!-- maincontent -->
        </body>
        </html>";
        return $retval;
    }

}


1			<?php
2
3			/*
4			* ******************************************************************************
5			* Copyright 2011-2017 DANTE Ltd. and GÉANT on behalf of the GN3, GN3+, GN4-1
6			* and GN4-2 consortia
7			*
8			* License: see the web/copyright.php file in the file structure
9			* ******************************************************************************
10			*/
11
12			namespace web\lib\admin;
13
14			class PageDecoration {
15
16			private $validator;
17			private $ui;
18
19			public function __construct() {
20			$this->validator = new \web\lib\common\InputValidation();
21			$this->ui = new UIElements();
22			}
23			/**
24			* Our (very modest and light) sidebar. authenticated admins get more options, like logout
25			* @param boolean $advancedControls
26			*/
27			private function sidebar($advancedControls) {
28			$retval = "<div class='sidebar'><p>";
29
30			if ($advancedControls) {
31			$retval .= "<strong>" . _("You are:") . "</strong> "
32			. (isset($_SESSION['name']) ? $_SESSION['name'] : _("Unnamed User")) . "
33			<br/>
34			<br/>
35			<a href='" . \core\CAT::getRootUrlPath() . "/admin/overview_user.php'>" . _("Go to your Profile page") . "</a>
36			<a href='" . \core\CAT::getRootUrlPath() . "/admin/inc/logout.php'>" . _("Logout") . "</a> ";
37			}
38			$retval .= "<a href='" . \core\CAT::getRootUrlPath() . "'>" . _("Start page") . "</a>
39			</p>
40			</div> <!-- sidebar -->";
41			return $retval;
42			}
43
44			/**
45			* constructs a <div> called 'header' for use on the top of the page
46			* @param string $cap1 caption to display in this div
47			* @param string $language current language (this one gets pre-set in the lang selector drop-down
48			*/
49			private function headerDiv($cap1, $language) {
50
51			$place = parse_url($_SERVER['REQUEST_URI'], PHP_URL_PATH);
52
53			$retval = "<div class='header'>
54			<div id='header_toprow'>
55			<div id='header_captions' style='display:inline-block; float:left; min-width:400px;'>
56			<h1>$cap1</h1>
57			</div><!--header_captions-->
58			<div id='langselection' style='padding-top:20px; padding-left:10px;'>
59			<form action='$place' method='GET' accept-charset='UTF-8'>" . _("View this page in") . "
60			<select id='lang' name='lang' onchange='this.form.submit()'>";
61
62			foreach (CONFIG['LANGUAGES'] as $lang => $value) {
63			$retval .= "<option value='$lang' " . (strtoupper($language) == strtoupper($lang) ? "selected" : "" ) . " >" . $value['display'] . "</option> ";
64			}
65			$retval .= "</select>";
66
67			foreach ($_GET as $var => $value) {
68			if ($var != "lang" && $value != "") {
69			$retval .= "<input type='hidden' name='" . htmlspecialchars($var) . "' value='" . htmlspecialchars($value) . "'>";
70			}
71			}
72			$retval .= "</form>
73			</div><!--langselection-->";
74			$logoUrl = \core\CAT::getRootUrlPath() . "/resources/images/consortium_logo.png";
75			$retval .= "<div class='consortium_logo'>
76			<img id='test_locate' src='$logoUrl' alt='Consortium Logo'>
77			</div> <!-- consortium_logo -->
78			</div><!--header_toprow-->
79			</div> <!-- header -->";
80			return $retval;
81			}
82
83			/**
84			* This starts HTML in a default way. Most pages would call this.
85			* Exception: if you need to add extra code in <head> or modify the <body> tag
86			* (e.g. onload) then you should call defaultPagePrelude, close head, open body,
87			* and then call productheader.
88			*
89			* @param string $pagetitle Title of the page to display
90			* @param string $area the area in which this page is (displays some matching <h1>s)
91			* @param boolean $authRequired
92			*/
93			public function pageheader($pagetitle, $area, $authRequired = TRUE) {
94			$retval = "";
95			$retval .= $this->defaultPagePrelude($pagetitle, $authRequired);
96			$retval .= "</head></body>";
97			$retval .= $this->productheader($area);
98			return $retval;
99			}
100
101			/**
102			* the entire top of the page (<body> part)
103			*
104			* @param string $area the area we are in
105			*/
106			public function productheader($area) {
107			$langObject = new \core\common\Language();
108			$language = $langObject->getLang();
109			// this <div is closing in footer, keep it in PHP for Netbeans syntax
110			// highlighting to work
111			$retval = "<div class='maincontent'>";
112			// default values which match almost every case; override where needed
113			$cap1 = CONFIG['APPEARANCE']['productname_long'];
114			$advancedControls = TRUE;
115			switch ($area) {
116			case "ADMIN-IDP":
117			$cap2 = sprintf(_("Administrator Interface - Identity Provider"),$this->ui->nomenclature_inst);
118			break;
119			case "ADMIN-IDP-USERS":
120			$cap2 = sprintf(_("Administrator Interface - %s User Management"), \core\ProfileSilverbullet::PRODUCTNAME);
121			break;
122			case "ADMIN":
123			$cap2 = _("Administrator Interface");
124			break;
125			case "USERMGMT":
126			$cap2 = _("Management of User Details");
127			break;
128			case "FEDERATION":
129			$cap2 = sprintf(_("Administrator Interface - %s Management"),$this->ui->nomenclature_fed);
130			break;
131			case "USER":
132			$cap1 = sprintf(_("Welcome to %s"), CONFIG['APPEARANCE']['productname']);
133			$cap2 = CONFIG['APPEARANCE']['productname_long'];
134			$advancedControls = FALSE;
135			break;
136			case "SUPERADMIN":
137			$cap2 = _("CIC");
138			break;
139			case "DIAG":
140			$cap2 = _("Diagnostics");
141			break;
142			default:
143			$cap2 = "It is an error if you ever see this string.";
144			$advancedControls = FALSE;
145			}
146
147			$retval .= $this->headerDiv($cap1, $language);
148			// content from here on will SCROLL instead of being fixed at the top
149			$retval .= "<div class='pagecontent'>"; // closes in footer again
150			$retval .= "<div class='trick'>"; // closes in footer again
151			$retval .= "<div id='secondrow' style='border-bottom:5px solid ".CONFIG['APPEARANCE']['colour1']."; min-height:100px;'>
152			<div id='secondarycaptions' style='display:inline-block; float:left'>
153			<h2>$cap2</h2>
154			</div><!--secondarycaptions-->";
155
156			if (isset(CONFIG['APPEARANCE']['MOTD']) && CONFIG['APPEARANCE']['MOTD'] != "") {
157			$retval .= "<div id='header_MOTD' style='display:inline-block; padding-left:20px;vertical-align:top;'>
158			<p class='MOTD'>" . CONFIG['APPEARANCE']['MOTD'] . "</p>
159			</div><!--header_MOTD-->";
160			}
161			$retval .= $this->sidebar($advancedControls);
162			$retval .= "</div><!--secondrow-->";
163			return $retval;
164			}
165
166			/**
167			*
168			* @param string $pagetitle Title of the page to display
169			* @param boolean $authRequired does the user need to be autenticated to access this page?
170			*/
171			public function defaultPagePrelude($pagetitle, $authRequired = TRUE) {
172			if ($authRequired === TRUE) {
173			$auth = new \web\lib\admin\Authentication();
174			$auth->authenticate();
175			}
176			$langObject = new \core\common\Language();
177			$langObject->setTextDomain("web_admin");
178			$ourlocale = $langObject->getLang();
179			header("Content-Type:text/html;charset=utf-8");
180			$retval = "<!DOCTYPE html>
181			<html xmlns='http://www.w3.org/1999/xhtml' lang='$ourlocale'>
182			<head lang='$ourlocale'>
183			<meta http-equiv='Content-Type' content='text/html; charset=UTF-8'>";
184
185			if (strrpos($_SERVER['PHP_SELF'], "admin/")) {
186			$cutoffPosition = strrpos($_SERVER['PHP_SELF'], "admin/");
			0 ignored issues – show Unused Code introduced 2018-01-19 07:35 UTC by Report Bug Copy Issue Report The assignment to `$cutoffPosition` is dead and can be removed. Loading history...
187			} elseif (strrpos($_SERVER['PHP_SELF'], "accountstatus/")) {
188			$cutoffPosition = strrpos($_SERVER['PHP_SELF'], "accountstatus/");
189			} elseif (strrpos($_SERVER['PHP_SELF'], "diag/")) {
190			$cutoffPosition = strrpos($_SERVER['PHP_SELF'], "diag/");
191			}
192			else {
193			$cutoffPosition = strrpos($_SERVER['PHP_SELF'], "/");
194			}
195
196			$host = $this->validator->hostname($_SERVER['SERVER_NAME']);
197			if ($host === FALSE) {
198			throw new \Exception("We don't know our own hostname!");
199			}
200			$cssUrl = \core\CAT::getRootUrlPath() . "/resources/css/cat.css.php";
201			$retval .= "<link rel='stylesheet' type='text/css' href='$cssUrl' />";
202			$retval .= "<title>" . htmlspecialchars($pagetitle) . "</title>";
203			return $retval;
204			}
205
206			/**
207			* HTML code for the EU attribution
208			*
209			* @return string HTML code with GEANT Org and EU attribution as required for FP7 / H2020 projects
210			*/
211			public function attributionEurope() {
212			if (CONFIG_CONFASSISTANT['CONSORTIUM']['name'] == "eduroam" && isset(CONFIG_CONFASSISTANT['CONSORTIUM']['deployment-voodoo']) && CONFIG_CONFASSISTANT['CONSORTIUM']['deployment-voodoo'] == "Operations Team") {// SW: APPROVED
213			// we may need to jump up one dir if we are either in admin/ or accountstatus/
214			// (accountstatus courtesy of my good mood. It's userspace not admin space so
215			// it shouldn't be using this function any more.)
216
217			if (strrpos($_SERVER['PHP_SELF'], "admin/")) {
218			$cutoffPosition = strrpos($_SERVER['PHP_SELF'], "admin/");
219			} elseif (strrpos($_SERVER['PHP_SELF'], "accountstatus/")) {
220			$cutoffPosition = strrpos($_SERVER['PHP_SELF'], "accountstatus/");
221			} elseif (strrpos($_SERVER['PHP_SELF'], "diag/")) {
222			$cutoffPosition = strrpos($_SERVER['PHP_SELF'], "diag/");
223			} else {
224			$cutoffPosition = strrpos($_SERVER['PHP_SELF'], "/");
225			}
226			$host = $this->validator->hostname($_SERVER['SERVER_NAME']);
227			if ($host === FALSE) {
228			throw new \Exception("We don't know our own hostname!");
229			}
230			$logoBase = "//$host" . substr($_SERVER['PHP_SELF'], 0, $cutoffPosition)."/resources/images";
231
232			return "<span id='logos' style='position:fixed; left:50%;'><img src='$logoBase/dante.png' alt='DANTE' style='height:23px;width:47px'/>
233			<img src='$logoBase/eu.png' alt='EU' style='height:23px;width:27px;border-width:0px;'/></span>
234			<span id='eu_text' style='text-align:right;'><a href='http://ec.europa.eu/dgs/connect/index_en.htm' style='text-decoration:none; vertical-align:top;'>European Commission Communications Networks, Content and Technology</a></span>";
235			}
236			return "&nbsp";
237			}
238
239			/**
240			* displays the admin area footer
241			*/
242			public function footer() {
243			$cat = new \core\CAT();
244			$retval = "</div><!-- trick -->
245			</div><!-- pagecontent -->
246			<div class='footer'>
247			<hr />
248			<table style='width:100%'>
249			<tr>
250			<td style='padding-left:20px; padding-right:20px; text-align:left; vertical-align:top;'>
251			" . $cat->CAT_COPYRIGHT . "</td>
252			<td style='padding-left:80px; padding-right:20px; text-align:right; vertical-align:top;'>";
253
254			if (CONFIG_CONFASSISTANT['CONSORTIUM']['name'] == "eduroam" && isset(CONFIG_CONFASSISTANT['CONSORTIUM']['deployment-voodoo']) && CONFIG_CONFASSISTANT['CONSORTIUM']['deployment-voodoo'] == "Operations Team") { // SW: APPROVED
255			$retval .= $this->attributionEurope();
256			} else {
257			$retval .= " ";
258			}
259			$retval .= "
260			</td>
261			</tr>
262			</table>
263			</div><!-- footer -->
264			</div><!-- maincontent -->
265			</body>
266			</html>";
267			return $retval;
268			}
269
270			}
271

GEANT / CAT

Push — master ( 4377c1...932be3 )

PageDecoration::pageheader() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like