Url::generateSocialImageUrl() - Code Metrics - Inspection of "Dynamic open graph" - mysociety/theyworkforyou - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#1874)

unknown

created 2025-04-11 11:20 UTC

Url::generateSocialImageUrl() A

↳ Parent: Url

Complexity

Conditions	3
Paths	2

Size

Total Lines	14
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	12

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	3
eloc	7
c	1
b	0
f	0
nc	2
nop	2
dl	0
loc	14
ccs	0
cts	0
cp	0
crap	12
rs	10

<?php
/**
 * URL Class
 *
 * @package TheyWorkForYou
 */

namespace MySociety\TheyWorkForYou;

/**
 * URL Class
 *
 * The URL class is used for generating URLs and other related things.
 * Relies on there being a get_http_var() function.
 *
 * This is probably how you'll use it most:
 *
 * ```php
 * $URL = new \MySociety\TheyWorkForYou\Url("YOURPAGENAME");
 * print $URL->generate();
 * ```
 *
 * In the metadata you should set a session_vars variable, an array.
 * The default page session_vars may be just array("debug").
 * These can then be overridden on a per-page basis.
 * Session vars are GET/POST vars that will be passed by default to that page.
 * ie, if "foo=bar" is in the current URL and you generate a URL to a page that has "foo"
 * as a session_var, "foo=bar" will be automatically added to the generated URL.
 * You can modify the session vars that will be included in the URL generated using the functions below.
 *
 * @author Phil Gyford <[email protected]>
 */

class Url {
    public function __construct($pagename) {
        // Initialise.
        global $DATA;

        // The page we're going to be generating URL(s) for.
        $this->destinationpage = $pagename;


        // These stores an associative array of key/value pairs that
        // we'll want passed on to other pages.
        $this->session_vars =  [];


        // Prevent things using $DATA running if it hasn't been set, ie in testing
        if (isset($DATA)) {

            // Set the contents of $this->session_vars.
            // session_vars are variables we generally want to pass between pages, if any.
            // Will only be added as vars if they have values.

            $keys = $DATA->page_metadata($this->destinationpage, "session_vars");
            foreach ($keys as $key) {
                if (get_http_var($key) != "") {
                    $this->session_vars[$key] = get_http_var($key);
                }
            }

            // Some pages have the same URL, modified by a "pg" variable.
            // See if this page is one such, and add the variable if so.
            if ($pg = $DATA->page_metadata($this->destinationpage, "pg")) {
                $this->session_vars["pg"] = $pg;
            }

        }

        // So we can restore the originals.
        $this->original_session_vars = $this->session_vars;


    }

    /**
     * Restore Session Variables
     *
     * Restores the session variables to their state when the object was
     * instantiated.
     */

    public function restore() {
        // Call this to reset the session vars to how they were when
        // the object was instantiated.
        $this->session_vars = $this->original_session_vars;


    }

    /**
     * Reset Session Variables
     *
     * Removes all session variables.
     */

    public function reset() {
        // Call this to remove all the session_vars.
        $this->session_vars =  [];

    }

    /**
     * Insert Session Key/Value Pairs
     *
     * @param array $arr An associative array of key/value pairs
     */

    public function insert($arr) {
        // $arr is an associative array of key/value pairs.
        // These will be used as session_vars in addition to any that
        // already exist.
        foreach ($arr as $key => $val) {
            $this->session_vars[$key] = $val;

        }
    }

    /**
     * Remove Session Key/Value Pair
     *
     * @param array $arr A list array of key names to remove
     */

    public function remove($arr) {
        // $arr is a list array of key names. Any key/value pairs
        // in session_vars with keys found in $arr will be removed.
        foreach ($arr as $key) {
            if (isset($this->session_vars[$key])) {
                unset($this->session_vars[$key]);
            }
        }
    }

    /**
     * Update Values
     *
     * Any keys in session_vars that are also in $arr
     * will have their values overwritten by those in $arr.
     * Other session_var key/vals are not affected.
     *
     * @param array $arr An associative array of key/value pairs.
     */

    public function update($arr) {
        //
        //
        foreach ($arr as $key => $val) {
            if (isset($this->session_vars[$key])) {
                $this->session_vars[$key] = $arr[$key];

            }
        }
    }

    /**
     * Generate URL
     *
     * Generate a URL to the page specified with session vars.
     *
     * @param string encode       "html" will make the URL suitable for inclusion
filter:
    dependency_paths: ["lib/*"]
     *                            in a page directly, "none" will leave it alone,
     *                            "url" will do exactly the same.
     * @param array  overrideVars A key=>value mapping which allows some specific
filter:
    dependency_paths: ["lib/*"]
     *                            variable/value pairs to be overridden/inserted
     *                            into the query. Use this when you want to keep
     *                            the standard 'session vars' in a url, but
     *                            override just one or two of them.
     */

    public function generate($encode = "html", $overrideVars = []) {

        global $DATA;

        $url_args =  [];

        foreach (array_merge($this->session_vars, $overrideVars) as $key => $var) {
            if (is_array($var)) {
                foreach ($var as $v) {
                    $url_args[] = "$key=" . urlencode(stripslashes($v));
                }
            } elseif ($var != null) {
                $url_args[] = "$key=" . urlencode(stripslashes($var));
            }
        }

        $page_url = WEBPATH . $DATA->page_metadata($this->destinationpage, "url");

        if (sizeof($url_args) == 0) {
            return $page_url;
        } else {
            if ($encode == "html") {
                return $page_url . "?" . implode("&amp;", $url_args);
            } elseif ($encode == "none" || $encode == "url") {
                return $page_url . "?" . implode("&", $url_args);
            }
        }
    }

    /**
     * Generate a URL for the social image with the given header and subheader.
     *
     * @param string $header The header text for the social image.
     * @param string $subheader The subheader text for the social image.
     * @return string The URL to the generated social image.
     */
    public static function generateSocialImageUrl(string $header, string $subheader = ""): string {
        $protocol = 'https://';
        if (defined('DEVSITE') && DEVSITE) {

            $protocol = 'http://';
        }
        // Update the path for the social image URL
        $base_url = $protocol . DOMAIN . '/opengraph/image.php';

        // Generate a hash for validation
        $hash = substr(hash_hmac('sha256', $header . $subheader, OPENGRAPH_IMAGE_SALT), 0, 10);


        // Append the truncated hash to the query parameters
        $query = http_build_query(['heading' => $header, 'subheading' => $subheader, 'hash' => $hash]);
        return $base_url . '?' . $query;
    }

}


1		<?php
2		/**
3		* URL Class
4		*
5		* @package TheyWorkForYou
6		*/
7
8		namespace MySociety\TheyWorkForYou;
9
10		/**
11		* URL Class
12		*
13		* The URL class is used for generating URLs and other related things.
14		* Relies on there being a get_http_var() function.
15		*
16		* This is probably how you'll use it most:
17		*
18		* ```php
19		* $URL = new \MySociety\TheyWorkForYou\Url("YOURPAGENAME");
20		* print $URL->generate();
21		* ```
22		*
23		* In the metadata you should set a session_vars variable, an array.
24		* The default page session_vars may be just array("debug").
25		* These can then be overridden on a per-page basis.
26		* Session vars are GET/POST vars that will be passed by default to that page.
27		* ie, if "foo=bar" is in the current URL and you generate a URL to a page that has "foo"
28		* as a session_var, "foo=bar" will be automatically added to the generated URL.
29		* You can modify the session vars that will be included in the URL generated using the functions below.
30		*
31		* @author Phil Gyford <[email protected]>
32		*/
33
34		class Url {
35		public function __construct($pagename) {
36	25	// Initialise.
37		global $DATA;
38	25
39		// The page we're going to be generating URL(s) for.
40		$this->destinationpage = $pagename;
		0 ignored issues – show Bug Best Practice introduced 2018-06-21 14:28 UTC by Report Bug Copy Issue Report The property `destinationpage` does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly. Loading history...
41	25
42		// These stores an associative array of key/value pairs that
43		// we'll want passed on to other pages.
44		$this->session_vars = [];
		0 ignored issues – show Bug Best Practice introduced 2018-06-21 14:28 UTC by Report Bug Copy Issue Report The property `session_vars` does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly. Loading history...
45	25
46		// Prevent things using $DATA running if it hasn't been set, ie in testing
47		if (isset($DATA)) {
48	25
49		// Set the contents of $this->session_vars.
50		// session_vars are variables we generally want to pass between pages, if any.
51		// Will only be added as vars if they have values.
52
53		$keys = $DATA->page_metadata($this->destinationpage, "session_vars");
54	25	foreach ($keys as $key) {
55	25	if (get_http_var($key) != "") {
56	25	$this->session_vars[$key] = get_http_var($key);
57		}
58		}
59
60		// Some pages have the same URL, modified by a "pg" variable.
61		// See if this page is one such, and add the variable if so.
62		if ($pg = $DATA->page_metadata($this->destinationpage, "pg")) {
63	25	$this->session_vars["pg"] = $pg;
64		}
65
66		}
67
68		// So we can restore the originals.
69		$this->original_session_vars = $this->session_vars;
		0 ignored issues – show Bug Best Practice introduced 2018-06-21 14:28 UTC by Report Bug Copy Issue Report The property `original_session_vars` does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly. Loading history...
70	25
71		}
72	25
73		/**
74		* Restore Session Variables
75		*
76		* Restores the session variables to their state when the object was
77		* instantiated.
78		*/
79
80		public function restore() {
81		// Call this to reset the session vars to how they were when
82		// the object was instantiated.
83		$this->session_vars = $this->original_session_vars;
		0 ignored issues – show Bug Best Practice introduced 2018-06-21 14:28 UTC by Report Bug Copy Issue Report The property `session_vars` does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly. Loading history...
84
85		}
86
87		/**
88		* Reset Session Variables
89		*
90		* Removes all session variables.
91		*/
92
93		public function reset() {
94	1	// Call this to remove all the session_vars.
95		$this->session_vars = [];
		0 ignored issues – show Bug Best Practice introduced 2018-06-21 14:28 UTC by Report Bug Copy Issue Report The property `session_vars` does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly. Loading history...
96	1	}
97	1
98		/**
99		* Insert Session Key/Value Pairs
100		*
101		* @param array $arr An associative array of key/value pairs
102		*/
103
104		public function insert($arr) {
105	19	// $arr is an associative array of key/value pairs.
106		// These will be used as session_vars in addition to any that
107		// already exist.
108		foreach ($arr as $key => $val) {
109	19	$this->session_vars[$key] = $val;
		0 ignored issues – show Bug Best Practice introduced 2018-06-21 14:28 UTC by Report Bug Copy Issue Report The property `session_vars` does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly. Loading history...
110	19	}
111		}
112	19
113		/**
114		* Remove Session Key/Value Pair
115		*
116		* @param array $arr A list array of key names to remove
117		*/
118
119		public function remove($arr) {
120	5	// $arr is a list array of key names. Any key/value pairs
121		// in session_vars with keys found in $arr will be removed.
122		foreach ($arr as $key) {
123	5	if (isset($this->session_vars[$key])) {
124	5	unset($this->session_vars[$key]);
125	4	}
126		}
127		}
128	5
129		/**
130		* Update Values
131		*
132		* Any keys in session_vars that are also in $arr
133		* will have their values overwritten by those in $arr.
134		* Other session_var key/vals are not affected.
135		*
136		* @param array $arr An associative array of key/value pairs.
137		*/
138
139		public function update($arr) {
140	8	//
141		//
142		foreach ($arr as $key => $val) {
143	8	if (isset($this->session_vars[$key])) {
144	8	$this->session_vars[$key] = $arr[$key];
		0 ignored issues – show Bug Best Practice introduced 2018-06-21 14:28 UTC by Report Bug Copy Issue Report The property `session_vars` does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly. Loading history...
145	8	}
146		}
147		}
148	8
149		/**
150		* Generate URL
151		*
152		* Generate a URL to the page specified with session vars.
153		*
154		* @param string encode "html" will make the URL suitable for inclusion
		0 ignored issues – show Bug introduced 2018-06-21 14:28 UTC by Report Bug Copy Issue Report The type `MySociety\TheyWorkForYou\encode` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
155		* in a page directly, "none" will leave it alone,
156		* "url" will do exactly the same.
157		* @param array overrideVars A key=>value mapping which allows some specific
		0 ignored issues – show Bug introduced 2018-06-21 14:28 UTC by Report Bug Copy Issue Report The type `MySociety\TheyWorkForYou\overrideVars` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
158		* variable/value pairs to be overridden/inserted
159		* into the query. Use this when you want to keep
160		* the standard 'session vars' in a url, but
161		* override just one or two of them.
162		*/
163
164		public function generate($encode = "html", $overrideVars = []) {
165	25
166		global $DATA;
167	25
168		$url_args = [];
169	25
170		foreach (array_merge($this->session_vars, $overrideVars) as $key => $var) {
171	25	if (is_array($var)) {
172	19	foreach ($var as $v) {
173		$url_args[] = "$key=" . urlencode(stripslashes($v));
174		}
175		} elseif ($var != null) {
176	19	$url_args[] = "$key=" . urlencode(stripslashes($var));
177	19	}
178		}
179
180		$page_url = WEBPATH . $DATA->page_metadata($this->destinationpage, "url");
181	25
182		if (sizeof($url_args) == 0) {
183	25	return $page_url;
184	10	} else {
185		if ($encode == "html") {
186	19	return $page_url . "?" . implode("&", $url_args);
187	11	} elseif ($encode == "none" \|\| $encode == "url") {
188	8	return $page_url . "?" . implode("&", $url_args);
189	8	}
190		}
191		}
192
193		/**
194		* Generate a URL for the social image with the given header and subheader.
195		*
196		* @param string $header The header text for the social image.
197		* @param string $subheader The subheader text for the social image.
198		* @return string The URL to the generated social image.
199		*/
200		public static function generateSocialImageUrl(string $header, string $subheader = ""): string {
201		$protocol = 'https://';
202		if (defined('DEVSITE') && DEVSITE) {
		0 ignored issues – show Bug introduced 2025-04-11 11:25 UTC by Report Bug Copy Issue Report The constant `MySociety\TheyWorkForYou\DEVSITE` was not found. Maybe you did not declare it correctly or list all dependencies? Loading history...
203		$protocol = 'http://';
204		}
205		// Update the path for the social image URL
206		$base_url = $protocol . DOMAIN . '/opengraph/image.php';
207
208		// Generate a hash for validation
209		$hash = substr(hash_hmac('sha256', $header . $subheader, OPENGRAPH_IMAGE_SALT), 0, 10);
		0 ignored issues – show Bug introduced 2025-04-11 11:25 UTC by Report Bug Copy Issue Report The constant `MySociety\TheyWorkForYou\OPENGRAPH_IMAGE_SALT` was not found. Maybe you did not declare it correctly or list all dependencies? Loading history...
210
211		// Append the truncated hash to the query parameters
212		$query = http_build_query(['heading' => $header, 'subheading' => $subheader, 'hash' => $hash]);
213		return $base_url . '?' . $query;
214		}
215
216		}
217

mysociety / theyworkforyou

Pull Request — master (#1874)

Url::generateSocialImageUrl() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like