index-functions.php ➔ getTitleText() - Code Metrics - cilogon/service - Measure and Improve Code Quality continuously with Scrutinizer

index-functions.php ➔ getTitleText() B
last analyzed 2021-03-29 17:36 UTC

↳ Parent: Project

Complexity

Conditions	3
Paths	3

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	3
nc	3
nop	1
dl	0
loc	76
rs	8.5236
c	0
b	0
f	0

How to fix Long Method

<?php

/**
 * This file contains functions called by index.php. The index.php
 * file should include this file with the following statement at the top:
 *
 * require_once __DIR__ . '/index-functions.php';
 */

use CILogon\Service\Util;
use CILogon\Service\Content;
use CILogon\Service\PortalCookie;

/**
 * printMainCookiesPage
 *
 * This function prints out the main 'Manage Cookies' page on each
 * reload. It calls other functions to print out the subsections of
 * the page. Note that all subsections are enclosed in a <form> so
 * we need only a single <form> group.
 */
function printMainCookiesPage()
{
    // CIL-555 Allow for deletion of session/cookie vars without
    // refreshing the user's browser.
    if ((isset($_GET['nooutput'])) || (isset($_POST['nooutput']))) {
        http_response_code(204);
        exit;
    }

    $browsercount = countBrowserCookies();
    $sessioncount = countSessionVariables();

    Content::printHeader('Manage CILogon Cookies', false); // Don't set CSRF

    Content::printFormHead();

    printAboutThisPage($browsercount, $sessioncount);
    printBrowserCookies($browsercount);
    printSessionVariables($sessioncount);
    printEnvironmentVars();

    echo '</form>';

    Content::printFooter();
}

/**
 * printAboutThisPage
 *
 * This function prints the 'About This Page' subsection, which also
 * contains several 'submit' buttons (such as .Delete Browser Cookies.
 * and 'Reload Page').
 *
 * @param int $browsercount The number of deletable browser cookies.
 * @param int $sessioncount The number of deletable session variables
 */
function printAboutThisPage($browsercount, $sessioncount)
{
    Content::printCollapseBegin('aboutme', 'CILogon Attributes', false);

    echo '
        <div class="card-body px-5">
          <div class="card-text my-2">
            This page allows you to view and (potentially) delete various 
            cookies associated with the <a target="_blank" href="..">CILogon 
            Service</a>. There are three sections below.
          </div> <!-- end card-text -->
          <ol>
            <li><b>Browser Cookies</b> - These are &quot;cookies&quot;
            which are stored in your browser. They are used as preferences 
            for the CILogon Service.
            </li>
            <li><b>Session Variables</b> - These are &quot;short-lived&quot;
            values related to your current CILogon session. Deleting any of 
            these values may require you to re-logon.
            </li>
            <li><b>Environment Variables</b> - These are values set by the
            interaction between your browser and the web server. These are 
            displayed
            mainly for information purposes.
            </li>
          </ol>
    ';

    // If there are brower cookies or session variables which can be
    // deleted, output the appropriate 'Delete ...' button(s).
    if (($browsercount > 0) || ($sessioncount > 0)) {
        echo '
          <div class="card-text my-2">
            You can delete cookies individually by checking the associated
            checkbox(es) and clicking the &quot;Delete Checked&quot; button.
            You can also delete groups of cookies by clicking ';
        if ($browsercount > 0) {
            echo 'the &quot;Delete Browser Cookies&quot; button';
            if ($sessioncount > 0) {
                echo ', ';
            }
        }

        if ($sessioncount > 0) {
            echo 'the &quot;Delete Session Variables&quot; button';
            if ($browsercount > 0) {
                echo ', ';
            }
        }
        echo ' or the &quot;Delete ALL&quot; button';
        echo '.
          </div> <!-- end card-text -->';
    }

    echo '
          <div class="row align-items-center justify-content-center">
            <div class="col-auto">
              <a class="btn btn-primary form-control" href="/">Proceed
              to the CILogon Service</a>
            </div> <!-- end col-auto -->';

    if ($browsercount > 0) {
        echo '
            <div class="col-auto">
              <input type="submit" name="submit"
              class="btn btn-primary submit form-control"
              value="Delete Browser Cookies" />
            </div> <!-- end col-auto -->';
    }
    if ($sessioncount > 0) {
        echo '
            <div class="col-auto">
              <input type="submit" name="submit"
              class="btn btn-primary submit form-control"
              value="Delete Session Variables" />
            </div> <!-- end col-auto -->';
    }
    if (($browsercount > 0) || ($sessioncount > 0)) {
        echo '
            <div class="col-auto">
              <input type="submit" name="submit"
              class="btn btn-primary submit form-control"
              value="Delete ALL" />
            </div> <!-- end col-auto -->';
    }
    echo '
            <div class="col-auto">
              <input type="submit" name="submit"
              class="btn btn-primary submit form-control"
              value="Reload Page" />
            </div> <!-- end col-auto -->
          </div> <!-- end row align-items-center -->
        </div> <!-- end card-body --> ';

        Content::printCollapseEnd();
}

/**
 * printBrowserCookies
 *
 * This function prints the 'Browser Cookies' section, with checkboxes
 * next to the cookies to allow for deletion. If there are no browser
 * cookies, then simply output 'none found' message.
 *
 * @param int $browsercount The number of deletable browser cookies
 */
function printBrowserCookies($browsercount)
{
    global $hide;

    Content::printCollapseBegin('cookies', 'Browser Cookies', false);

    if ($browsercount > 0) {
        echo '
        <div class="card-body">
          <table class="table table-striped table-sm table-hover small">
          <tbody>
        ';

        ksort($_COOKIE);
        foreach ($_COOKIE as $key => $value) {
            if (!in_array($key, $hide)) {
                echo '<tr title="' , getTitleText($key) , '">' ,
                     '<td><input type="checkbox" name="del_browser[]" ',
                     'value="', $key , '"/></td>' ,
                     '<th scope="row" style="word-break: break-all"><samp>' ,
                     Util::htmlent($key) ,
                     '</samp></th><td><samp>';
                // Special handling of portalparams cookie
                if ($key == PortalCookie::COOKIENAME) {
                    $pc = new PortalCookie();
                    echo preg_replace('/\nportal=/', '<br/>portal=/', Util::htmlent($pc));
                } else {
                    echo Util::htmlent($value);
                }
                echo '</samp></td></tr>';
            }
        }

        echo '
          </tbody>
          </table>

          <div class="row align-items-center justify-content-center">
            <div class="col-auto">
              <input type="submit" name="submit"
              class="btn btn-primary submit form-control"
              value="Delete Checked" />
            </div> <!-- end col-auto -->
          </div> <!-- end row align-items-center -->';
    } else {
        echo '
        <div class="card-body px-5">
          <div class="row">
            <div class="col-auto">
              No browser cookies found.
            </div>
          </div>';
    }

    echo '
        </div> <!-- end card-body -->
    ';

    Content::printCollapseEnd();
}

/**
 * printSessionVariables
 *
 * This function prints the 'Session Variables' section, with
 * checkboxes  next to the variables to allow for deletion. If there
 * are no session variables, then simply output 'none found' message.
 *
 * @param int $sessioncount The number of deletable session variables
 */
function printSessionVariables($sessioncount)
{
    global $hide;

    Content::printCollapseBegin('session', 'Session Variables', false);

    if ($sessioncount > 0) {
        echo '
        <div class="card-body">
          <table class="table table-striped table-sm table-hover small">
          <tbody>
        ';

        ksort($_SESSION);
        foreach ($_SESSION as $key => $value) {
            if (!in_array($key, $hide)) {
                echo '<tr title="' , getTitleText($key) , '">' ,
                     '<td><input type="checkbox" name="del_session[]" ',
                     'value="', $key , '"/></td>' ,
                     '<th scope="row"><samp>' ,
                     Util::htmlent($key) ,
                     '</samp></th><td><samp>' ,
                     Util::htmlent($value) ,
                     '</samp></td></tr>';
            }
        }

        echo '
          </tbody>
          </table>

          <div class="row align-items-center justify-content-center">
            <div class="col-auto">
              <input type="submit" name="submit"
              class="btn btn-primary submit form-control"
              value="Delete Checked" />
            </div> <!-- end col-auto -->
          </div> <!-- end row align-items-center -->';
    } else {
        echo '
        <div class="card-body px-5">
          <div class="row">
            <div class="col-auto">
              No session variables found.
            </div>
          </div>';
    }

    echo '
        </div> <!-- end card-body -->
    ';

    Content::printCollapseEnd();
}

/**
 * printEnvironmentVars
 *
 * This function prints out the display-only web environment variables
 * (e.g. the $_SERVER array).
 */
function printEnvironmentVars()
{
    Content::printCollapseBegin('environment', 'Environment Variables', false);

    echo '
        <div class="card-body">
          <table class="table table-striped table-hover table-sm small">
          <tbody>
    ';

    ksort($_SERVER);
    foreach ($_SERVER as $key => $value) {
        echo '<tr><th scope="row"><samp>' ,
             Util::htmlent($key) ,
             '</samp></th><td><samp>' ,
             Util::htmlent($value) ,
             '</samp></td></tr>';
    }

    echo '
          </tbody>
          </table>
        </div> <!-- end card-body -->
    ';

    Content::printCollapseEnd();
}

/**
 * countBrowsercookies
 *
 * This function counts the number of elements in the $_COOKIE array,
 * minus those elements in the global $hide array.
 *
 * @return int The number of deletable browser cookies
 */
function countBrowserCookies()
{
    global $hide;

    $retval = count($_COOKIE);

    foreach ($hide as $h) {
        if (isset($_COOKIE[$h])) {
            $retval--;
        }
    }

    if ($retval < 0) {
        $retval = 0;
    }

    return $retval;
}

/**
 * countSessionVariables
 *
 * This function counts the number of elements in the $_SESSION array,
 * minus those elements in the global $hide array.
 *
 * @return int The number of deletable session variables
 */
function countSessionVariables()
{
    global $hide;

    $retval = count($_SESSION);

    foreach ($hide as $h) {
        if (isset($_SESSION[$h])) {
            $retval--;
        }
    }

    if ($retval < 0) {
        $retval = 0;
    }

    return $retval;
}

/**
 * deleteChecked
 *
 * This function is called when the 'Delete Checked' button is clicked.
 * It iterates through all of the checked boxes for the 'Browser
 * Cookies' and 'Session Variables' sections and deletes the
 * corresponding cookie or session variable.
 */
function deleteChecked()
{
    $del_browser = Util::getPostVar('del_browser');
    if (is_array($del_browser)) {
        foreach ($del_browser as $value) {
            Util::unsetCookieVar($value);
        }
    }

    $del_session = Util::getPostVar('del_session');
    if (is_array($del_session)) {
        foreach ($del_session as $value) {
            Util::unsetSessionVar($value);
        }
    }
}

/**
 * deleteBrowserCookies
 *
 * This function is called when the 'Delete Browser Cookies' button
 * or the 'Delete ALL' button is pressed. It deletes all elements in
 * the $_COOKIE array except for those in the global $hide array.
 */
function deleteBrowserCookies()
{
    global $hide;

    foreach ($_COOKIE as $key => $value) {
        if (!in_array($key, $hide)) {
            Util::unsetCookieVar($key);
        }
    }
}

/**
 * deleteSessionVariables
 *
 * This function is called when the 'Delete Session Variables' button
 * or the 'Delete ALL' button is pressed. It deletes all elements in
 * the $_SESSION array except for those in the global $hide array.
 */
function deleteSessionVariables()
{
    global $hide;

    foreach ($_SESSION as $key => $value) {
        if (!in_array($key, $hide)) {
            Util::unsetSessionVar($key);
        }
    }
}

/**
 * getTitleText
 *
 * This function takes in a browser cookie or session variable and
 * returns an 'explanation' string which is used in the 'title=...'
 * attribute. This text is displayed in the user's browser when the
 * mouse cursor hovers over the row containing the cookie/variable
 * and corresponding value. The function simply looks in the $explain
 * array for the $cookie key, and returns the value (if any).
 *
 * @param string $cookie The name of a browser cookie or session variable.
 * @return string  A string explaining the cookie/variable in question.
 *         Returns empty string if no such cookie/variable found.
 */
function getTitleText($cookie)
{
    $retval = '';

    // Keys are brower cookies / session variables. Values are
    // explanation string to be shown in 'title=...' attributes.
    // NOTE: the array is searched using 'preg_match' to allow for
    // substring matches (which is important in the case of
    // _shibsession...). Thus, it is important that longer strings
    // appear before shorter strings with the same prefix, e.g.
    // 'p12 error' appears before 'p12'.
    $explain = array(
        "acr" => "Authentication Context Class Ref",
        "amr" => "Authentication Method Ref",
        "affiliation" => "A list of attributes describing your affiliations at your Identity Provider." ,
        "authntime" => "The Unix timestamp of the last successful user authentication." ,
        "callbackuri" => "The URL of the callback servlet used by portals connecting to the CILogon Delegate service." ,
        "cilogon_skin" => "The skin affects the look-and-feel and " .
            "functionality of the CILogon Service. It is typically " .
            "specified by a portal." ,
        "clientparams" => "A set of cookies for each portal you have used with CILogon." ,
        "display_name" => "Your full name set by your Identity Provider." ,
        "distinguished_name" => "A quasi distinguished name for the X.509 certificate issued by a MyProxy server." ,
        "email" => "Your email address given by your Identity Provider." ,
        "entitlement" => "A list of URIs representing permissions to access a resource or service." ,
        "eppn" => "'eduPerson Principal Name' - a SAML attribute set by your Identity Provider." ,
        "eptid" => "'eduPerson Targeted Identifier' - a SAML attribute set by your Identity Provider" ,
        "failureuri" => "A URL used by portals in case the CILogon " .
            "Service is unable to issue a certificate on your behalf. " ,
        "first_name" => "Your given name set by your Identity Provider." ,
        "idp_display_name" => "The display name of your chosen Identity Provider." ,
        "idp" => "The authentication URI of your chosen Identity Provider." ,
        "itrustuin" => "Your university ID number.",
        "keepidp" => "Remember if you checked the 'Remember this " .
            "selection' checkbox when you selected and Identity Provider." ,
        "last_name" => "Your surname set by your Identity Provider." ,
        "loa" => "Level of Assurance set by your Identity Provider." ,
        "logonerror" => "A text message of the reason for the last authentication error." ,
        "member_of" => "Groups of which you are a member",
        "oidc" => "Your user identifier set by the OpenID Connect Identity Provider." ,
        "open_id" => "Your user identifier set by the OpenID Identity Provider." ,
        "ou" => "Your organizational unit set by your Identity Provider." ,
        "pairwise_id" => "The pairwise subject identifier provided by the Identity Provider",
        "p12error" => "A text message of the reason why the PKCS12 certificate could not be created." ,
        "p12lifetime" => "This multiplied by the p12multipler gives the lifetime of the PKCS12 certificate in hours." ,
        "p12multiplier" => "This multiplied by the p12lifetime gives the lifetime of the PKCS12 certificate in hours." ,
        "p12" => "The expiration time and URL to download a PKCS12 certificate file." ,
        "portalcookie" => "Contains certificate lifetimes for all " .
            "portals you have used with the CILogon Delegate service." ,
        "portalname" => "The display name of the portal connected to the CILogon Delegate service. " ,
        "portalparams" => "For portals previously using the CILogon " .
            "Delegate service, this is the saved lifetime of the " .
            "delegated certificate." ,
        "portalstatus" => "An internal return code when fetching portal parameters from the datastore." ,
        "providerId" => "The previously selected Identity Provider." ,
        "responsesubmit" => "The name of the page to return to after " .
            "authentication at your chosen Identity Provider." ,
        "responseurl" => "The URL to return to after authentication at your chosen Identity Provider." ,
        "_shibsession" => "A shibboleth session token set by an InCommon Identity Provider." ,
        "status" => "An internal return code when fetching user data from the datastore." ,
        "subject_id" => "The subject identifier provided by the Identity Provider",
        "submit" => "The name of the 'submit' button clicked." ,
        "successuri" => "A URL used by portals for redirection after successful issuance of a certificate." ,
        "tempcred" => "An OAUTH identifier used to track portal sessions." ,
        "user_uid" => "The datastore user identifier." ,
    );

    foreach ($explain as $key => $value) {
        if (preg_match("/^$key$/", $cookie)) {
            $retval = $value;
            break;
        }
    }

    return $retval;
}


1			<?php
2
3			/**
4			* This file contains functions called by index.php. The index.php
5			* file should include this file with the following statement at the top:
6			*
7			* require_once __DIR__ . '/index-functions.php';
8			*/
9
10			use CILogon\Service\Util;
11			use CILogon\Service\Content;
12			use CILogon\Service\PortalCookie;
13
14			/**
15			* printMainCookiesPage
16			*
17			* This function prints out the main 'Manage Cookies' page on each
18			* reload. It calls other functions to print out the subsections of
19			* the page. Note that all subsections are enclosed in a <form> so
20			* we need only a single <form> group.
21			*/
22			function printMainCookiesPage()
23			{
24			// CIL-555 Allow for deletion of session/cookie vars without
25			// refreshing the user's browser.
26			if ((isset($_GET['nooutput'])) \|\| (isset($_POST['nooutput']))) {
27			http_response_code(204);
28			exit;
29			}
30
31			$browsercount = countBrowserCookies();
32			$sessioncount = countSessionVariables();
33
34			Content::printHeader('Manage CILogon Cookies', false); // Don't set CSRF
35
36			Content::printFormHead();
37
38			printAboutThisPage($browsercount, $sessioncount);
39			printBrowserCookies($browsercount);
40			printSessionVariables($sessioncount);
41			printEnvironmentVars();
42
43			echo '</form>';
44
45			Content::printFooter();
46			}
47
48			/**
49			* printAboutThisPage
50			*
51			* This function prints the 'About This Page' subsection, which also
52			* contains several 'submit' buttons (such as .Delete Browser Cookies.
53			* and 'Reload Page').
54			*
55			* @param int $browsercount The number of deletable browser cookies.
56			* @param int $sessioncount The number of deletable session variables
57			*/
58			function printAboutThisPage($browsercount, $sessioncount)
59			{
60			Content::printCollapseBegin('aboutme', 'CILogon Attributes', false);
61
62			echo '
63			<div class="card-body px-5">
64			<div class="card-text my-2">
65			This page allows you to view and (potentially) delete various
66			cookies associated with the <a target="_blank" href="..">CILogon
67			Service</a>. There are three sections below.
68			</div> <!-- end card-text -->
69			<ol>
70			<li><b>Browser Cookies</b> - These are "cookies"
71			which are stored in your browser. They are used as preferences
72			for the CILogon Service.
73			</li>
74			<li><b>Session Variables</b> - These are "short-lived"
75			values related to your current CILogon session. Deleting any of
76			these values may require you to re-logon.
77			</li>
78			<li><b>Environment Variables</b> - These are values set by the
79			interaction between your browser and the web server. These are
80			displayed
81			mainly for information purposes.
82			</li>
83			</ol>
84			';
85
86			// If there are brower cookies or session variables which can be
87			// deleted, output the appropriate 'Delete ...' button(s).
88			if (($browsercount > 0) \|\| ($sessioncount > 0)) {
89			echo '
90			<div class="card-text my-2">
91			You can delete cookies individually by checking the associated
92			checkbox(es) and clicking the "Delete Checked" button.
93			You can also delete groups of cookies by clicking ';
94			if ($browsercount > 0) {
95			echo 'the "Delete Browser Cookies" button';
96			if ($sessioncount > 0) {
97			echo ', ';
98			}
99			}
100
101			if ($sessioncount > 0) {
102			echo 'the "Delete Session Variables" button';
103			if ($browsercount > 0) {
104			echo ', ';
105			}
106			}
107			echo ' or the "Delete ALL" button';
108			echo '.
109			</div> <!-- end card-text -->';
110			}
111
112			echo '
113			<div class="row align-items-center justify-content-center">
114			<div class="col-auto">
115			<a class="btn btn-primary form-control" href="/">Proceed
116			to the CILogon Service</a>
117			</div> <!-- end col-auto -->';
118
119			if ($browsercount > 0) {
120			echo '
121			<div class="col-auto">
122			<input type="submit" name="submit"
123			class="btn btn-primary submit form-control"
124			value="Delete Browser Cookies" />
125			</div> <!-- end col-auto -->';
126			}
127			if ($sessioncount > 0) {
128			echo '
129			<div class="col-auto">
130			<input type="submit" name="submit"
131			class="btn btn-primary submit form-control"
132			value="Delete Session Variables" />
133			</div> <!-- end col-auto -->';
134			}
135			if (($browsercount > 0) \|\| ($sessioncount > 0)) {
136			echo '
137			<div class="col-auto">
138			<input type="submit" name="submit"
139			class="btn btn-primary submit form-control"
140			value="Delete ALL" />
141			</div> <!-- end col-auto -->';
142			}
143			echo '
144			<div class="col-auto">
145			<input type="submit" name="submit"
146			class="btn btn-primary submit form-control"
147			value="Reload Page" />
148			</div> <!-- end col-auto -->
149			</div> <!-- end row align-items-center -->
150			</div> <!-- end card-body --> ';
151
152			Content::printCollapseEnd();
153			}
154
155			/**
156			* printBrowserCookies
157			*
158			* This function prints the 'Browser Cookies' section, with checkboxes
159			* next to the cookies to allow for deletion. If there are no browser
160			* cookies, then simply output 'none found' message.
161			*
162			* @param int $browsercount The number of deletable browser cookies
163			*/
164			function printBrowserCookies($browsercount)
165			{
166			global $hide;
167
168			Content::printCollapseBegin('cookies', 'Browser Cookies', false);
169
170			if ($browsercount > 0) {
171			echo '
172			<div class="card-body">
173			<table class="table table-striped table-sm table-hover small">
174			<tbody>
175			';
176
177			ksort($_COOKIE);
178			foreach ($_COOKIE as $key => $value) {
179			if (!in_array($key, $hide)) {
180			echo '<tr title="' , getTitleText($key) , '">' ,
181			'<td><input type="checkbox" name="del_browser[]" ',
182			'value="', $key , '"/></td>' ,
183			'<th scope="row" style="word-break: break-all"><samp>' ,
184			Util::htmlent($key) ,
185			'</samp></th><td><samp>';
186			// Special handling of portalparams cookie
187			if ($key == PortalCookie::COOKIENAME) {
188			$pc = new PortalCookie();
189			echo preg_replace('/\nportal=/', '<br/>portal=/', Util::htmlent($pc));
190			} else {
191			echo Util::htmlent($value);
192			}
193			echo '</samp></td></tr>';
194			}
195			}
196
197			echo '
198			</tbody>
199			</table>
200
201			<div class="row align-items-center justify-content-center">
202			<div class="col-auto">
203			<input type="submit" name="submit"
204			class="btn btn-primary submit form-control"
205			value="Delete Checked" />
206			</div> <!-- end col-auto -->
207			</div> <!-- end row align-items-center -->';
208			} else {
209			echo '
210			<div class="card-body px-5">
211			<div class="row">
212			<div class="col-auto">
213			No browser cookies found.
214			</div>
215			</div>';
216			}
217
218			echo '
219			</div> <!-- end card-body -->
220			';
221
222			Content::printCollapseEnd();
223			}
224
225			/**
226			* printSessionVariables
227			*
228			* This function prints the 'Session Variables' section, with
229			* checkboxes next to the variables to allow for deletion. If there
230			* are no session variables, then simply output 'none found' message.
231			*
232			* @param int $sessioncount The number of deletable session variables
233			*/
234			function printSessionVariables($sessioncount)
235			{
236			global $hide;
237
238			Content::printCollapseBegin('session', 'Session Variables', false);
239
240			if ($sessioncount > 0) {
241			echo '
242			<div class="card-body">
243			<table class="table table-striped table-sm table-hover small">
244			<tbody>
245			';
246
247			ksort($_SESSION);
248			foreach ($_SESSION as $key => $value) {
249			if (!in_array($key, $hide)) {
250			echo '<tr title="' , getTitleText($key) , '">' ,
251			'<td><input type="checkbox" name="del_session[]" ',
252			'value="', $key , '"/></td>' ,
253			'<th scope="row"><samp>' ,
254			Util::htmlent($key) ,
255			'</samp></th><td><samp>' ,
256			Util::htmlent($value) ,
257			'</samp></td></tr>';
258			}
259			}
260
261			echo '
262			</tbody>
263			</table>
264
265			<div class="row align-items-center justify-content-center">
266			<div class="col-auto">
267			<input type="submit" name="submit"
268			class="btn btn-primary submit form-control"
269			value="Delete Checked" />
270			</div> <!-- end col-auto -->
271			</div> <!-- end row align-items-center -->';
272			} else {
273			echo '
274			<div class="card-body px-5">
275			<div class="row">
276			<div class="col-auto">
277			No session variables found.
278			</div>
279			</div>';
280			}
281
282			echo '
283			</div> <!-- end card-body -->
284			';
285
286			Content::printCollapseEnd();
287			}
288
289			/**
290			* printEnvironmentVars
291			*
292			* This function prints out the display-only web environment variables
293			* (e.g. the $_SERVER array).
294			*/
295			function printEnvironmentVars()
296			{
297			Content::printCollapseBegin('environment', 'Environment Variables', false);
298
299			echo '
300			<div class="card-body">
301			<table class="table table-striped table-hover table-sm small">
302			<tbody>
303			';
304
305			ksort($_SERVER);
306			foreach ($_SERVER as $key => $value) {
307			echo '<tr><th scope="row"><samp>' ,
308			Util::htmlent($key) ,
309			'</samp></th><td><samp>' ,
310			Util::htmlent($value) ,
311			'</samp></td></tr>';
312			}
313
314			echo '
315			</tbody>
316			</table>
317			</div> <!-- end card-body -->
318			';
319
320			Content::printCollapseEnd();
321			}
322
323			/**
324			* countBrowsercookies
325			*
326			* This function counts the number of elements in the $_COOKIE array,
327			* minus those elements in the global $hide array.
328			*
329			* @return int The number of deletable browser cookies
330			*/
331			function countBrowserCookies()
332			{
333			global $hide;
334
335			$retval = count($_COOKIE);
336
337			foreach ($hide as $h) {
338			if (isset($_COOKIE[$h])) {
339			$retval--;
340			}
341			}
342
343			if ($retval < 0) {
344			$retval = 0;
345			}
346
347			return $retval;
348			}
349
350			/**
351			* countSessionVariables
352			*
353			* This function counts the number of elements in the $_SESSION array,
354			* minus those elements in the global $hide array.
355			*
356			* @return int The number of deletable session variables
357			*/
358			function countSessionVariables()
359			{
360			global $hide;
361
362			$retval = count($_SESSION);
363
364			foreach ($hide as $h) {
365			if (isset($_SESSION[$h])) {
366			$retval--;
367			}
368			}
369
370			if ($retval < 0) {
371			$retval = 0;
372			}
373
374			return $retval;
375			}
376
377			/**
378			* deleteChecked
379			*
380			* This function is called when the 'Delete Checked' button is clicked.
381			* It iterates through all of the checked boxes for the 'Browser
382			* Cookies' and 'Session Variables' sections and deletes the
383			* corresponding cookie or session variable.
384			*/
385			function deleteChecked()
386			{
387			$del_browser = Util::getPostVar('del_browser');
388			if (is_array($del_browser)) {
389			foreach ($del_browser as $value) {
390			Util::unsetCookieVar($value);
391			}
392			}
393
394			$del_session = Util::getPostVar('del_session');
395			if (is_array($del_session)) {
396			foreach ($del_session as $value) {
397			Util::unsetSessionVar($value);
398			}
399			}
400			}
401
402			/**
403			* deleteBrowserCookies
404			*
405			* This function is called when the 'Delete Browser Cookies' button
406			* or the 'Delete ALL' button is pressed. It deletes all elements in
407			* the $_COOKIE array except for those in the global $hide array.
408			*/
409			function deleteBrowserCookies()
410			{
411			global $hide;
412
413			foreach ($_COOKIE as $key => $value) {
414			if (!in_array($key, $hide)) {
415			Util::unsetCookieVar($key);
416			}
417			}
418			}
419
420			/**
421			* deleteSessionVariables
422			*
423			* This function is called when the 'Delete Session Variables' button
424			* or the 'Delete ALL' button is pressed. It deletes all elements in
425			* the $_SESSION array except for those in the global $hide array.
426			*/
427			function deleteSessionVariables()
428			{
429			global $hide;
430
431			foreach ($_SESSION as $key => $value) {
432			if (!in_array($key, $hide)) {
433			Util::unsetSessionVar($key);
434			}
435			}
436			}
437
438			/**
439			* getTitleText
440			*
441			* This function takes in a browser cookie or session variable and
442			* returns an 'explanation' string which is used in the 'title=...'
443			* attribute. This text is displayed in the user's browser when the
444			* mouse cursor hovers over the row containing the cookie/variable
445			* and corresponding value. The function simply looks in the $explain
446			* array for the $cookie key, and returns the value (if any).
447			*
448			* @param string $cookie The name of a browser cookie or session variable.
449			* @return string A string explaining the cookie/variable in question.
450			* Returns empty string if no such cookie/variable found.
451			*/
452			function getTitleText($cookie)
453			{
454			$retval = '';
455
456			// Keys are brower cookies / session variables. Values are
457			// explanation string to be shown in 'title=...' attributes.
458			// NOTE: the array is searched using 'preg_match' to allow for
459			// substring matches (which is important in the case of
460			// _shibsession...). Thus, it is important that longer strings
461			// appear before shorter strings with the same prefix, e.g.
462			// 'p12 error' appears before 'p12'.
463			$explain = array(
464			"acr" => "Authentication Context Class Ref",
465			"amr" => "Authentication Method Ref",
466			"affiliation" => "A list of attributes describing your affiliations at your Identity Provider." ,
467			"authntime" => "The Unix timestamp of the last successful user authentication." ,
468			"callbackuri" => "The URL of the callback servlet used by portals connecting to the CILogon Delegate service." ,
469			"cilogon_skin" => "The skin affects the look-and-feel and " .
470			"functionality of the CILogon Service. It is typically " .
471			"specified by a portal." ,
472			"clientparams" => "A set of cookies for each portal you have used with CILogon." ,
473			"display_name" => "Your full name set by your Identity Provider." ,
474			"distinguished_name" => "A quasi distinguished name for the X.509 certificate issued by a MyProxy server." ,
475			"email" => "Your email address given by your Identity Provider." ,
476			"entitlement" => "A list of URIs representing permissions to access a resource or service." ,
477			"eppn" => "'eduPerson Principal Name' - a SAML attribute set by your Identity Provider." ,
478			"eptid" => "'eduPerson Targeted Identifier' - a SAML attribute set by your Identity Provider" ,
479			"failureuri" => "A URL used by portals in case the CILogon " .
480			"Service is unable to issue a certificate on your behalf. " ,
481			"first_name" => "Your given name set by your Identity Provider." ,
482			"idp_display_name" => "The display name of your chosen Identity Provider." ,
483			"idp" => "The authentication URI of your chosen Identity Provider." ,
484			"itrustuin" => "Your university ID number.",
485			"keepidp" => "Remember if you checked the 'Remember this " .
486			"selection' checkbox when you selected and Identity Provider." ,
487			"last_name" => "Your surname set by your Identity Provider." ,
488			"loa" => "Level of Assurance set by your Identity Provider." ,
489			"logonerror" => "A text message of the reason for the last authentication error." ,
490			"member_of" => "Groups of which you are a member",
491			"oidc" => "Your user identifier set by the OpenID Connect Identity Provider." ,
492			"open_id" => "Your user identifier set by the OpenID Identity Provider." ,
493			"ou" => "Your organizational unit set by your Identity Provider." ,
494			"pairwise_id" => "The pairwise subject identifier provided by the Identity Provider",
495			"p12error" => "A text message of the reason why the PKCS12 certificate could not be created." ,
496			"p12lifetime" => "This multiplied by the p12multipler gives the lifetime of the PKCS12 certificate in hours." ,
497			"p12multiplier" => "This multiplied by the p12lifetime gives the lifetime of the PKCS12 certificate in hours." ,
498			"p12" => "The expiration time and URL to download a PKCS12 certificate file." ,
499			"portalcookie" => "Contains certificate lifetimes for all " .
500			"portals you have used with the CILogon Delegate service." ,
501			"portalname" => "The display name of the portal connected to the CILogon Delegate service. " ,
502			"portalparams" => "For portals previously using the CILogon " .
503			"Delegate service, this is the saved lifetime of the " .
504			"delegated certificate." ,
505			"portalstatus" => "An internal return code when fetching portal parameters from the datastore." ,
506			"providerId" => "The previously selected Identity Provider." ,
507			"responsesubmit" => "The name of the page to return to after " .
508			"authentication at your chosen Identity Provider." ,
509			"responseurl" => "The URL to return to after authentication at your chosen Identity Provider." ,
510			"_shibsession" => "A shibboleth session token set by an InCommon Identity Provider." ,
511			"status" => "An internal return code when fetching user data from the datastore." ,
512			"subject_id" => "The subject identifier provided by the Identity Provider",
513			"submit" => "The name of the 'submit' button clicked." ,
514			"successuri" => "A URL used by portals for redirection after successful issuance of a certificate." ,
515			"tempcred" => "An OAUTH identifier used to track portal sessions." ,
516			"user_uid" => "The datastore user identifier." ,
517			);
518
519			foreach ($explain as $key => $value) {
520			if (preg_match("/^$key$/", $cookie)) {
521			$retval = $value;
522			break;
523			}
524			}
525
526			return $retval;
527			}
528

cilogon / service

index-functions.php ➔ getTitleText() B last analyzed 2021-03-29 17:36 UTC

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like

index-functions.php ➔ getTitleText() B
last analyzed 2021-03-29 17:36 UTC