CommonCode::sendBackgroundEncodedFormElementsByPost() - Code Metrics - Inspection of "moved a method to a parent trait to reduce code co..." - danielgp/common-lib - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 0338e7...87b411 )

by Daniel

created 2016-01-16 01:39 UTC

sendBackgroundEncodedFormElementsByPost() A

↳ Parent: CommonCode

Complexity

Conditions	3
Paths	3

Size

Total Lines	13
Code Lines	9

Duplication

Lines	0
Ratio	0 %

Importance

Changes	9
Bugs	0	Features	0

Metric	Value
c	9
b	0
f	0
dl	0
loc	13
rs	9.4285
cc	3
eloc	9
nc	3
nop	2

<?php

/**
 *
 * The MIT License (MIT)
 *
 * Copyright (c) 2015 Daniel Popiniuc
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 *  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 *
 */

namespace danielgp\common_lib;

/**
 * usefull functions to get quick results
 *
 * @author Daniel Popiniuc
 */
trait CommonCode
{

    use CommonBasic,
        DomComponentsByDanielGP,
        MySQLiByDanielGPqueries,
        MySQLiByDanielGP;

    private function buildArrayForCurlInterogation($chanel, $rspJsonFromClient)
    {
        if (curl_errno($chanel)) {
            return [
                'info'     => $this->setArrayToJson(['#' => curl_errno($chanel), 'description' => curl_error($chanel)]),
                'response' => '',
            ];
        }
        return ['info' => $this->setArrayToJson(curl_getinfo($chanel)), 'response' => $rspJsonFromClient];
    }

    /**
     * Reads the content of a remote file through CURL extension
     *
     * @param string $fullURL
     * @param array $features
     * @return blob
     */
    protected function getContentFromUrlThroughCurl($fullURL, $features = null)
    {
        if (!function_exists('curl_init')) {
            $aReturn = ['info' => $this->lclMsgCmn('i18n_Error_ExtensionNotLoaded'), 'response' => ''];
            return $this->setArrayToJson($aReturn);
        }
        if (!filter_var($fullURL, FILTER_VALIDATE_URL)) {
            $aReturn = ['info' => $this->lclMsgCmn('i18n_Error_GivenUrlIsNotValid'), 'response' => ''];
            return $this->setArrayToJson($aReturn);
        }
        $aReturn = $this->getContentFromUrlThroughCurlRawArray($fullURL, $features);
        return '{ ' . $this->packIntoJson($aReturn, 'info') . ', ' . $this->packIntoJson($aReturn, 'response') . ' }';
    }

    /**
     * Reads the content of a remote file through CURL extension
     *
     * @param string $fullURL
     * @param array $features
     * @return blob
     */
    protected function getContentFromUrlThroughCurlAsArrayIfJson($fullURL, $features = null)
    {
        $result = $this->setJsonToArray($this->getContentFromUrlThroughCurl($fullURL, $features));
        if (is_array($result['info'])) {
            ksort($result['info']);
        }
        if (is_array($result['response'])) {
            ksort($result['response']);
        }
        return $result;
    }

    protected function getContentFromUrlThroughCurlRawArray($fullURL, $features = null)
    {
        $chanel = curl_init();
        curl_setopt($chanel, CURLOPT_USERAGENT, $this->getUserAgentByCommonLib());
        if ((strpos($fullURL, 'https') !== false) || (isset($features['forceSSLverification']))) {
            curl_setopt($chanel, CURLOPT_SSL_VERIFYHOST, false);
            curl_setopt($chanel, CURLOPT_SSL_VERIFYPEER, false);
        }
        curl_setopt($chanel, CURLOPT_URL, $fullURL);
        curl_setopt($chanel, CURLOPT_HEADER, false);
        curl_setopt($chanel, CURLOPT_RETURNTRANSFER, true);
        curl_setopt($chanel, CURLOPT_FRESH_CONNECT, true); //avoid a cached response
        curl_setopt($chanel, CURLOPT_FAILONERROR, true);
        $rspJsonFromClient = curl_exec($chanel);
        $aReturn           = $this->buildArrayForCurlInterogation($chanel, $rspJsonFromClient);
        curl_close($chanel);
        return $aReturn;
    }

    protected function getFeedbackMySQLAffectedRecords()
    {
        if (is_null($this->mySQLconnection)) {
            return '<div>No MySQL connection detected</div>';
        }
        $afRows = $this->mySQLconnection->affected_rows;
        return '<div>' . sprintf($this->lclMsgCmnNumber('i18n_Record', 'i18n_Records', $afRows), $afRows) . '</div>';
    }

    /**
     * returns the details about Communicator (current) file
     *
     * @param string $fileGiven
     * @return array
     */
    protected function getFileDetails($fileGiven)
    {
        if (!file_exists($fileGiven)) {
            return ['error' => sprintf($this->lclMsgCmn('i18n_Error_GivenFileDoesNotExist'), $fileGiven)];
        }
        return $this->getFileDetailsRaw($fileGiven);
    }

    /**
     * returns a multi-dimensional array with list of file details within a given path
     * (by using Symfony/Finder package)
     *
     * @param  string $pathAnalised
     * @return array
     */
    protected function getListOfFiles($pathAnalised)
    {
        if (realpath($pathAnalised) === false) {
            return ['error' => sprintf($this->lclMsgCmn('i18n_Error_GivenPathIsNotValid'), $pathAnalised)];
        } elseif (!is_dir($pathAnalised)) {
            return ['error' => $this->lclMsgCmn('i18n_Error_GivenPathIsNotFolder')];
        }
        $finder   = new \Symfony\Component\Finder\Finder();
        $iterator = $finder->files()->sortByName()->in($pathAnalised);
        $aFiles   = null;
        foreach ($iterator as $file) {
            $aFiles[$file->getRealPath()] = $this->getFileDetails($file);
        }
        return $aFiles;
    }

    /**
     * Returns server Timestamp into various formats
     *
     * @param string $returnType
     * @return string
     */
    protected function getTimestamp($returnType = 'string')
    {
        $crtTime          = gettimeofday();
        $knownReturnTypes = ['array', 'float', 'string'];
        if (in_array($returnType, $knownReturnTypes)) {
            return call_user_func([$this, 'getTimestamp' . ucfirst($returnType)], $crtTime);
        }
        return sprintf($this->lclMsgCmn('i18n_Error_UnknownReturnType'), $returnType);
    }

    private function getTimestampArray($crtTime)
    {
        return ['float' => $this->getTimestampFloat($crtTime), 'string' => $this->getTimestampString($crtTime)];
    }

    private function getTimestampFloat($crtTime)
    {
        return ($crtTime['sec'] + $crtTime['usec'] / pow(10, 6));
    }

    private function getTimestampString($crtTime)
    {
        return implode('', [
            '<span style="color:black!important;font-weight:bold;">[',
            date('Y-m-d H:i:s.', $crtTime['sec']),
            substr(round($crtTime['usec'], -3), 0, 3),
            ']</span> '
        ]);
    }

    /**
     * Tests if given string has a valid Json format
     *
     * @param string $inputJson
     * @return boolean|string
     */
    protected function isJsonByDanielGP($inputJson)
    {
        if (is_string($inputJson)) {
            json_decode($inputJson);
            return (json_last_error() == JSON_ERROR_NONE);
        }
        return $this->lclMsgCmn('i18n_Error_GivenInputIsNotJson');
    }

    private function packIntoJson($aReturn, $keyToWorkWith)
    {
        if ($this->isJsonByDanielGP($aReturn[$keyToWorkWith])) {
            return '"' . $keyToWorkWith . '": ' . $aReturn[$keyToWorkWith];
        }
        return '"' . $keyToWorkWith . '": {' . $aReturn[$keyToWorkWith] . ' }';
    }

    /**
     * Send an array of parameters like a form through a POST action
     *
     * @param string $urlToSendTo
     * @param array $params
     * @throws \Exception
     */
    protected function sendBackgroundEncodedFormElementsByPost($urlToSendTo, $params = [])
    {
        $postingUrl = filter_var($urlToSendTo, FILTER_VALIDATE_URL);
        if ($postingUrl === false) {
            throw new \Exception('Invalid URL in ' . __FUNCTION__);
        }
        if (is_array($params)) {
            $cntFailErrMsg = $this->lclMsgCmn('i18n_Error_FailedToConnect');
            $this->sendBackgroundPostData($postingUrl, $params, $cntFailErrMsg);
            return '';
        }
        throw new \Exception($this->lclMsgCmn('i18n_Error_GivenParameterIsNotAnArray'));
    }

    private function sendBackgroundPostData($postingUrl, $params, $cntFailErrMsg)
    {
        $postingString = $this->setArrayToStringForUrl('&', $params);
        $pUrlParts     = parse_url($postingUrl);
        $postingPort   = 80;
        if (isset($pUrlParts['port'])) {
            $postingPort = $pUrlParts['port'];
        }
        $flPointer = fsockopen($pUrlParts['host'], $postingPort, $erN, $erM, 30);
        if ($flPointer === false) {
            throw new \Exception($cntFailErrMsg . ': ' . $erN . ' (' . $erM . ')');
        }
        fwrite($flPointer, $this->sendBackgroundPrepareData($pUrlParts, $postingString));
        fclose($flPointer);
    }

    private function sendBackgroundPrepareData($pUrlParts, $postingString)
    {
        $this->initializeSprGlbAndSession();
        $out   = [];
        $out[] = 'POST ' . $pUrlParts['path'] . ' ' . $this->tCmnSuperGlobals->server->get['SERVER_PROTOCOL'];
        $out[] = 'Host: ' . $pUrlParts['host'];
        $out[] = 'User-Agent: ' . $this->getUserAgentByCommonLib();
        $out[] = 'Content-Type: application/x-www-form-urlencoded';
        $out[] = 'Content-Length: ' . strlen($postingString);
        $out[] = 'Connection: Close' . "\r\n";
        $out[] = $postingString;
        return implode("\r\n", $out);
    }

    /**
     * Converts a JSON string into an Array
     *
     * @param string $inputJson
     * @return array
     */
    protected function setJsonToArray($inputJson)
    {
        if (!$this->isJsonByDanielGP($inputJson)) {
            return ['error' => $this->lclMsgCmn('i18n_Error_GivenInputIsNotJson')];
        }
        $sReturn   = (json_decode($inputJson, true));
        $jsonError = $this->setJsonErrorInPlainEnglish();
        if (is_null($jsonError)) {
            return $sReturn;
        } else {
            return ['error' => $jsonError];
        }
    }
}


1			<?php
2
3			/**
4			*
5			* The MIT License (MIT)
6			*
7			* Copyright (c) 2015 Daniel Popiniuc
8			*
9			* Permission is hereby granted, free of charge, to any person obtaining a copy
10			* of this software and associated documentation files (the "Software"), to deal
11			* in the Software without restriction, including without limitation the rights
12			* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
13			* copies of the Software, and to permit persons to whom the Software is
14			* furnished to do so, subject to the following conditions:
15			*
16			* The above copyright notice and this permission notice shall be included in all
17			* copies or substantial portions of the Software.
18			*
19			* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20			* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21			* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22			* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23			* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24			* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
25			* SOFTWARE.
26			*
27			*/
28
29			namespace danielgp\common_lib;
30
31			/**
32			* usefull functions to get quick results
33			*
34			* @author Daniel Popiniuc
35			*/
36			trait CommonCode
37			{
38
39			use CommonBasic,
40			DomComponentsByDanielGP,
41			MySQLiByDanielGPqueries,
42			MySQLiByDanielGP;
43
44			private function buildArrayForCurlInterogation($chanel, $rspJsonFromClient)
45			{
46			if (curl_errno($chanel)) {
47			return [
48			'info' => $this->setArrayToJson(['#' => curl_errno($chanel), 'description' => curl_error($chanel)]),
49			'response' => '',
50			];
51			}
52			return ['info' => $this->setArrayToJson(curl_getinfo($chanel)), 'response' => $rspJsonFromClient];
53			}
54
55			/**
56			* Reads the content of a remote file through CURL extension
57			*
58			* @param string $fullURL
59			* @param array $features
60			* @return blob
61			*/
62			protected function getContentFromUrlThroughCurl($fullURL, $features = null)
63			{
64			if (!function_exists('curl_init')) {
65			$aReturn = ['info' => $this->lclMsgCmn('i18n_Error_ExtensionNotLoaded'), 'response' => ''];
66			return $this->setArrayToJson($aReturn);
67			}
68			if (!filter_var($fullURL, FILTER_VALIDATE_URL)) {
69			$aReturn = ['info' => $this->lclMsgCmn('i18n_Error_GivenUrlIsNotValid'), 'response' => ''];
70			return $this->setArrayToJson($aReturn);
71			}
72			$aReturn = $this->getContentFromUrlThroughCurlRawArray($fullURL, $features);
73			return '{ ' . $this->packIntoJson($aReturn, 'info') . ', ' . $this->packIntoJson($aReturn, 'response') . ' }';
74			}
75
76			/**
77			* Reads the content of a remote file through CURL extension
78			*
79			* @param string $fullURL
80			* @param array $features
81			* @return blob
82			*/
83			protected function getContentFromUrlThroughCurlAsArrayIfJson($fullURL, $features = null)
84			{
85			$result = $this->setJsonToArray($this->getContentFromUrlThroughCurl($fullURL, $features));
86			if (is_array($result['info'])) {
87			ksort($result['info']);
88			}
89			if (is_array($result['response'])) {
90			ksort($result['response']);
91			}
92			return $result;
93			}
94
95			protected function getContentFromUrlThroughCurlRawArray($fullURL, $features = null)
96			{
97			$chanel = curl_init();
98			curl_setopt($chanel, CURLOPT_USERAGENT, $this->getUserAgentByCommonLib());
99			if ((strpos($fullURL, 'https') !== false) \|\| (isset($features['forceSSLverification']))) {
100			curl_setopt($chanel, CURLOPT_SSL_VERIFYHOST, false);
101			curl_setopt($chanel, CURLOPT_SSL_VERIFYPEER, false);
102			}
103			curl_setopt($chanel, CURLOPT_URL, $fullURL);
104			curl_setopt($chanel, CURLOPT_HEADER, false);
105			curl_setopt($chanel, CURLOPT_RETURNTRANSFER, true);
106			curl_setopt($chanel, CURLOPT_FRESH_CONNECT, true); //avoid a cached response
107			curl_setopt($chanel, CURLOPT_FAILONERROR, true);
108			$rspJsonFromClient = curl_exec($chanel);
109			$aReturn = $this->buildArrayForCurlInterogation($chanel, $rspJsonFromClient);
110			curl_close($chanel);
111			return $aReturn;
112			}
113
114			protected function getFeedbackMySQLAffectedRecords()
115			{
116			if (is_null($this->mySQLconnection)) {
117			return '<div>No MySQL connection detected</div>';
118			}
119			$afRows = $this->mySQLconnection->affected_rows;
120			return '<div>' . sprintf($this->lclMsgCmnNumber('i18n_Record', 'i18n_Records', $afRows), $afRows) . '</div>';
121			}
122
123			/**
124			* returns the details about Communicator (current) file
125			*
126			* @param string $fileGiven
127			* @return array
128			*/
129			protected function getFileDetails($fileGiven)
130			{
131			if (!file_exists($fileGiven)) {
132			return ['error' => sprintf($this->lclMsgCmn('i18n_Error_GivenFileDoesNotExist'), $fileGiven)];
133			}
134			return $this->getFileDetailsRaw($fileGiven);
135			}
136
137			/**
138			* returns a multi-dimensional array with list of file details within a given path
139			* (by using Symfony/Finder package)
140			*
141			* @param string $pathAnalised
142			* @return array
143			*/
144			protected function getListOfFiles($pathAnalised)
145			{
146			if (realpath($pathAnalised) === false) {
147			return ['error' => sprintf($this->lclMsgCmn('i18n_Error_GivenPathIsNotValid'), $pathAnalised)];
148			} elseif (!is_dir($pathAnalised)) {
149			return ['error' => $this->lclMsgCmn('i18n_Error_GivenPathIsNotFolder')];
150			}
151			$finder = new \Symfony\Component\Finder\Finder();
152			$iterator = $finder->files()->sortByName()->in($pathAnalised);
153			$aFiles = null;
154			foreach ($iterator as $file) {
155			$aFiles[$file->getRealPath()] = $this->getFileDetails($file);
156			}
157			return $aFiles;
158			}
159
160			/**
161			* Returns server Timestamp into various formats
162			*
163			* @param string $returnType
164			* @return string
165			*/
166			protected function getTimestamp($returnType = 'string')
167			{
168			$crtTime = gettimeofday();
169			$knownReturnTypes = ['array', 'float', 'string'];
170			if (in_array($returnType, $knownReturnTypes)) {
171			return call_user_func([$this, 'getTimestamp' . ucfirst($returnType)], $crtTime);
172			}
173			return sprintf($this->lclMsgCmn('i18n_Error_UnknownReturnType'), $returnType);
174			}
175
176			private function getTimestampArray($crtTime)
177			{
178			return ['float' => $this->getTimestampFloat($crtTime), 'string' => $this->getTimestampString($crtTime)];
179			}
180
181			private function getTimestampFloat($crtTime)
182			{
183			return ($crtTime['sec'] + $crtTime['usec'] / pow(10, 6));
184			}
185
186			private function getTimestampString($crtTime)
187			{
188			return implode('', [
189			'<span style="color:black!important;font-weight:bold;">[',
190			date('Y-m-d H:i:s.', $crtTime['sec']),
191			substr(round($crtTime['usec'], -3), 0, 3),
192			']</span> '
193			]);
194			}
195
196			/**
197			* Tests if given string has a valid Json format
198			*
199			* @param string $inputJson
200			* @return boolean\|string
201			*/
202			protected function isJsonByDanielGP($inputJson)
203			{
204			if (is_string($inputJson)) {
205			json_decode($inputJson);
206			return (json_last_error() == JSON_ERROR_NONE);
207			}
208			return $this->lclMsgCmn('i18n_Error_GivenInputIsNotJson');
209			}
210
211			private function packIntoJson($aReturn, $keyToWorkWith)
212			{
213			if ($this->isJsonByDanielGP($aReturn[$keyToWorkWith])) {
214			return '"' . $keyToWorkWith . '": ' . $aReturn[$keyToWorkWith];
215			}
216			return '"' . $keyToWorkWith . '": {' . $aReturn[$keyToWorkWith] . ' }';
217			}
218
219			/**
220			* Send an array of parameters like a form through a POST action
221			*
222			* @param string $urlToSendTo
223			* @param array $params
224			* @throws \Exception
225			*/
226			protected function sendBackgroundEncodedFormElementsByPost($urlToSendTo, $params = [])
227			{
228			$postingUrl = filter_var($urlToSendTo, FILTER_VALIDATE_URL);
229			if ($postingUrl === false) {
230			throw new \Exception('Invalid URL in ' . __FUNCTION__);
231			}
232			if (is_array($params)) {
233			$cntFailErrMsg = $this->lclMsgCmn('i18n_Error_FailedToConnect');
234			$this->sendBackgroundPostData($postingUrl, $params, $cntFailErrMsg);
235			return '';
236			}
237			throw new \Exception($this->lclMsgCmn('i18n_Error_GivenParameterIsNotAnArray'));
238			}
239
240			private function sendBackgroundPostData($postingUrl, $params, $cntFailErrMsg)
241			{
242			$postingString = $this->setArrayToStringForUrl('&', $params);
243			$pUrlParts = parse_url($postingUrl);
244			$postingPort = 80;
245			if (isset($pUrlParts['port'])) {
246			$postingPort = $pUrlParts['port'];
247			}
248			$flPointer = fsockopen($pUrlParts['host'], $postingPort, $erN, $erM, 30);
249			if ($flPointer === false) {
250			throw new \Exception($cntFailErrMsg . ': ' . $erN . ' (' . $erM . ')');
251			}
252			fwrite($flPointer, $this->sendBackgroundPrepareData($pUrlParts, $postingString));
253			fclose($flPointer);
254			}
255
256			private function sendBackgroundPrepareData($pUrlParts, $postingString)
257			{
258			$this->initializeSprGlbAndSession();
259			$out = [];
260			$out[] = 'POST ' . $pUrlParts['path'] . ' ' . $this->tCmnSuperGlobals->server->get['SERVER_PROTOCOL'];
261			$out[] = 'Host: ' . $pUrlParts['host'];
262			$out[] = 'User-Agent: ' . $this->getUserAgentByCommonLib();
263			$out[] = 'Content-Type: application/x-www-form-urlencoded';
264			$out[] = 'Content-Length: ' . strlen($postingString);
265			$out[] = 'Connection: Close' . "\r\n";
266			$out[] = $postingString;
267			return implode("\r\n", $out);
268			}
269
270			/**
271			* Converts a JSON string into an Array
272			*
273			* @param string $inputJson
274			* @return array
275			*/
276			protected function setJsonToArray($inputJson)
277			{
278			if (!$this->isJsonByDanielGP($inputJson)) {
279			return ['error' => $this->lclMsgCmn('i18n_Error_GivenInputIsNotJson')];
280			}
281			$sReturn = (json_decode($inputJson, true));
282			$jsonError = $this->setJsonErrorInPlainEnglish();
283			if (is_null($jsonError)) {
284			return $sReturn;
285			} else {
286			return ['error' => $jsonError];
287			}
288			}
289			}
290

danielgp / common-lib

Push — master ( 0338e7...87b411 )

sendBackgroundEncodedFormElementsByPost() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like