SoapBase::makeEnvelopeSoap() - Code Metrics - Inspection of "Sugestão para problema de ambiente compartilhado" - nfephp-org/sped-common - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#180)

unknown

created 2018-06-01 12:58 UTC

SoapBase::makeEnvelopeSoap() A

↳ Parent: SoapBase

Complexity

Conditions	1
Paths	1

Size

Total Lines	15
Code Lines	12

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
dl	0
loc	15
ccs	0
cts	5
cp	0
rs	9.4285
c	0
b	0
f	0
cc	1
eloc	12
nc	1
nop	4
crap	2

<?php
namespace NFePHP\Common\Soap;

use NFePHP\Common\Certificate;
use NFePHP\Common\Exception\RuntimeException;
use NFePHP\Common\Strings;
use League\Flysystem\Filesystem;
use League\Flysystem\Adapter\Local;
use Psr\Log\LoggerInterface;

/**
 * Soap base class
 *
 * @category  NFePHP
 * @package   NFePHP\Common\Soap\SoapBase
 * @copyright NFePHP Copyright (c) 2017
 * @author    Roberto L. Machado <linux.rlm at gmail dot com>
 * @license   http://www.gnu.org/licenses/lgpl.txt LGPLv3+
 * @license   https://opensource.org/licenses/MIT MIT
 * @license   http://www.gnu.org/licenses/gpl.txt GPLv3+
 * @link      http://github.com/nfephp-org/sped-nfse for the canonical source repository
 */
abstract class SoapBase implements SoapInterface
{
    /**
     * @var int
     */
    protected $soapprotocol = self::SSL_DEFAULT;
    /**
     * @var int
     */
    protected $soaptimeout = 20;
    /**
     * @var string
     */
    protected $proxyIP;
    /**
     * @var int
     */
    protected $proxyPort;
    /**
     * @var string
     */
    protected $proxyUser;
    /**
     * @var string
     */
    protected $proxyPass;
    /**
     * @var array
     */
    protected $prefixes = [1 => 'soapenv', 2 => 'soap'];
    /**
     * @var Certificate
     */
    protected $certificate;
    /**
     * @var LoggerInterface|null
     */
    protected $logger;
    /**
     * @var string
     */
    protected $tempdir;
    /**
     * @var string
     */
    protected $certsdir;
    /**
     * @var string
     */
    protected $debugdir;
    /**
     * @var string
     */
    protected $prifile;
    /**
     * @var string
     */
    protected $pubfile;
    /**
     * @var string
     */
    protected $certfile;
    /**
     * @var string
     */
    protected $casefaz;
    /**
     * @var bool
     */
    protected $disablesec = false;
    /**
     * @var bool
     */
    protected $disableCertValidation = false;
    /**
     * @var \League\Flysystem\Adapter\Local
     */
    protected $adapter;
    /**
     * @var \League\Flysystem\Filesystem
     */
    protected $filesystem;
    /**
     * @var string
     */
    protected $temppass = '';
    /**
     * @var bool
     */
    protected $encriptPrivateKey = false;
    /**
     * @var bool
     */
    protected $debugmode = false;
    /**
     * @var string
     */
    public $responseHead;
    /**
     * @var string
     */
    public $responseBody;
    /**
     * @var string
     */
    public $requestHead;
    /**
     * @var string
     */
    public $requestBody;
    /**
     * @var string
     */
    public $soaperror;
    /**
     * @var array
     */
    public $soapinfo = [];
    /**
     * @var int
     */
    public $waitingTime = 45;

    /**
     * SoapBase constructor.
     * @param Certificate|null $certificate
     * @param LoggerInterface|null $logger
     */
    public function __construct(
        Certificate $certificate = null,
        LoggerInterface $logger = null
    ) {
        $this->logger = $logger;
        $this->loadCertificate($certificate);
    }

    /**
     * Check if certificate is valid to currently used date
     * @param Certificate $certificate
     * @return void
     * @throws Certificate\Exception\Expired
     */
    private function isCertificateExpired(Certificate $certificate = null)
    {
        if (!$this->disableCertValidation) {
            if (null !== $certificate && $certificate->isExpired()) {
                throw new Certificate\Exception\Expired($certificate);
            }
        }
    }

    /**
     * Destructor
     * Clean temporary files
     */
    public function __destruct()
    {
        $this->removeTemporarilyFiles();
    }

    /**
     * Disables the security checking of host and peer certificates
     * @param bool $flag
     * @return bool
     */
    public function disableSecurity($flag = false)
    {
        return $this->disablesec = $flag;
    }

    /**
     * ONlY for tests
     * @param bool $flag
     * @return bool
     */
    public function disableCertValidation($flag = true)
    {
        return $this->disableCertValidation = $flag;
    }

    /**
     * Load path to CA and enable to use on SOAP
     * @param string $capath
     * @return void
     */
    public function loadCA($capath)
    {
        if (is_file($capath)) {
            $this->casefaz = $capath;
        }
    }

    /**
     * Set option to encrypt private key before save in filesystem
     * for an additional layer of protection
     * @param bool $encript
     * @return bool
     */
    public function setEncriptPrivateKey($encript = true)
    {
        $this->encriptPrivateKey = $encript;
        if (null !== $this->filesystem) {
            $this->removeTemporarilyFiles();
        }
        if (null !== $this->certificate) {
            $this->saveTemporarilyKeyFiles();
        }
        return $this->encriptPrivateKey;
    }

    /**
     * Set another temporayfolder for saving certificates for SOAP utilization
     * @param string | null $folderRealPath
     * @return void
     */
    public function setTemporaryFolder($folderRealPath = null)
    {
        if (empty($folderRealPath)) {
            $path = '/sped-'. getmyuid() .'/';
            if (function_exists('posix_getuid')) {
                $path = '/sped-'. posix_getuid() .'/';
            }
            $folderRealPath = sys_get_temp_dir() . $path;
        }
        $this->tempdir = $folderRealPath;
        $this->setLocalFolder($folderRealPath);
    }

    /**
     * Set Local folder for flysystem
     * @param string $folder
     */
    protected function setLocalFolder($folder = '')
    {
        $this->adapter = new Local($folder);
        $this->filesystem = new Filesystem($this->adapter);
    }

    /**
     * Set debug mode, this mode will save soap envelopes in temporary directory
     * @param bool $value
     * @return bool
     */
    public function setDebugMode($value = false)
    {
        return $this->debugmode = $value;
    }

    /**
     * Set certificate class for SSL communications
     * @param Certificate $certificate
     * @return void
     */
    public function loadCertificate(Certificate $certificate = null)
    {
        $this->isCertificateExpired($certificate);
        if (null !== $certificate) {
            $this->certificate = $certificate;
        }
    }

    /**
     * Set logger class
     * @param LoggerInterface $logger
     * @return LoggerInterface
     */
    public function loadLogger(LoggerInterface $logger)
    {
        return $this->logger = $logger;
    }

    /**
     * Set timeout for communication
     * @param int $timesecs
     * @return int
     */
    public function timeout($timesecs)
    {
        return $this->soaptimeout = $timesecs;
    }

    /**
     * Set security protocol
     * @param int $protocol
     * @return int
     */
    public function protocol($protocol = self::SSL_DEFAULT)
    {
        return $this->soapprotocol = $protocol;
    }

    /**
     * Set prefixes
     * @param array $prefixes
     * @return string[]
     */
    public function setSoapPrefix($prefixes = [])
    {
        return $this->prefixes = $prefixes;
    }

    /**
     * Set proxy parameters
     * @param string $ip
     * @param int    $port
     * @param string $user
     * @param string $password
     * @return void
     */
    public function proxy($ip, $port, $user, $password)
    {
        $this->proxyIP = $ip;
        $this->proxyPort = $port;
        $this->proxyUser = $user;
        $this->proxyPass = $password;
    }

    /**
     * @param string $url
     * @param string $operation
     * @param string $action
     * @param int $soapver
     * @param array $parameters
     * @param array $namespaces
     * @param string $request
     * @param null $soapheader
     * @return mixed
     */
    abstract public function send(
        $url,
        $operation = '',
        $action = '',
        $soapver = SOAP_1_2,
        $parameters = [],
        $namespaces = [],
        $request = '',
        $soapheader = null
    );

    /**
     * Mount soap envelope
     * @param string $request
     * @param array $namespaces
     * @param int $soapVer
     * @param \SoapHeader $header
     * @return string
     */
    protected function makeEnvelopeSoap(
        $request,
        $namespaces,
        $soapVer = SOAP_1_2,
        $header = null
    ) {
        $prefix = $this->prefixes[$soapVer];
        $envelopeAttributes = $this->getStringAttributes($namespaces);
        return $this->mountEnvelopString(
            $prefix,
            $envelopeAttributes,
            $this->mountSoapHeaders($prefix, $header),
            $request
        );
    }

    /**
     * Create a envelop string
     * @param string $envelopPrefix
     * @param string $envelopAttributes
     * @param string $header
     * @param string $bodyContent
     * @return string
     */
    private function mountEnvelopString(
        $envelopPrefix,
        $envelopAttributes = '',
        $header = '',
        $bodyContent = ''
    ) {
        return sprintf(
            '<%s:Envelope %s>' . $header . '<%s:Body>%s</%s:Body></%s:Envelope>',
            $envelopPrefix,
            $envelopAttributes,
            $envelopPrefix,
            $bodyContent,
            $envelopPrefix,
            $envelopPrefix
        );
    }

    /**
     * Create a haeader tag
     * @param string $envelopPrefix
     * @param \SoapHeader $header
     * @return string
     */
    private function mountSoapHeaders($envelopPrefix, $header = null)
    {
        if (null === $header) {
            return '';
        }
        $headerItems = '';
        foreach ($header->data as $key => $value) {

            $headerItems .= '<' . $key . '>' . $value . '</' . $key . '>';
        }
        return sprintf(
            '<%s:Header><%s xmlns="%s">%s</%s></%s:Header>',
            $envelopPrefix,
            $header->name,

            $header->namespace === null ? '' : $header->namespace,

            $headerItems,
            $header->name,
            $envelopPrefix
        );
    }

    /**
     * Get attributes
     * @param array $namespaces
     * @return string
     */
    private function getStringAttributes($namespaces = [])
    {
        $envelopeAttributes = '';
        foreach ($namespaces as $key => $value) {
            $envelopeAttributes .= $key . '="' . $value . '" ';
        }
        return $envelopeAttributes;
    }


    /**
     * Temporarily saves the certificate keys for use cURL or SoapClient
     * @return void
     */
    public function saveTemporarilyKeyFiles()
    {
        if (!empty($this->certsdir)) {
            return;
        }
        if (!is_object($this->certificate)) {
            throw new RuntimeException(
                'Certificate not found.'
            );
        }
        if (empty($this->filesystem)) {
            $this->setTemporaryFolder();
        }
        $this->certsdir = $this->certificate->getCnpj() . '/certs/';
        $this->prifile = $this->certsdir . Strings::randomString(10) . '.pem';
        $this->pubfile = $this->certsdir . Strings::randomString(10) . '.pem';
        $this->certfile = $this->certsdir . Strings::randomString(10) . '.pem';
        $ret = true;
        $private = $this->certificate->privateKey;
        if ($this->encriptPrivateKey) {
            //cria uma senha temporária ALEATÓRIA para salvar a chave primaria
            //portanto mesmo que localizada e identificada não estará acessível
            //pois sua senha não existe além do tempo de execução desta classe
            $this->temppass = Strings::randomString(16);
            //encripta a chave privada entes da gravação do filesystem
            openssl_pkey_export(
                $this->certificate->privateKey,
                $private,
                $this->temppass
            );
        }
        $ret &= $this->filesystem->put(
            $this->prifile,
            $private
        );
        $ret &= $this->filesystem->put(
            $this->pubfile,
            $this->certificate->publicKey
        );
        $ret &= $this->filesystem->put(
            $this->certfile,
            $private . "{$this->certificate}"
        );
        if (!$ret) {
            throw new RuntimeException(
                'Unable to save temporary key files in folder.'
            );
        }
    }

    /**
     * Delete all files in folder
     * @return void
     */
    public function removeTemporarilyFiles()
    {
        if (empty($this->filesystem) || empty($this->certsdir)) {
            return;
        }
        $contents = $this->filesystem->listContents($this->certsdir, true);
        //define um limite de $waitingTime min, ou seja qualquer arquivo criado a mais
        //de $waitingTime min será removido
        //NOTA: quando ocorre algum erro interno na execução do script, alguns
        //arquivos temporários podem permanecer
        //NOTA: O tempo default é de 45 minutos e pode ser alterado diretamente nas
        //propriedades da classe, esse tempo entre 5 a 45 min é recomendável pois
        //podem haver processos concorrentes para um mesmo usuário. Esses processos
        //como o DFe podem ser mais longos, dependendo a forma que o aplicativo
        //utilize a API. Outra solução para remover arquivos "perdidos" pode ser
        //encontrada oportunamente.
        $dt = new \DateTime();
        $tint = new \DateInterval("PT" . $this->waitingTime . "M");
        $tint->invert = 1;
        $tsLimit = $dt->add($tint)->getTimestamp();
        foreach ($contents as $item) {
            if ($item['type'] == 'file') {
                if ($item['path'] == $this->prifile
                    || $item['path'] == $this->pubfile
                    || $item['path'] == $this->certfile
                ) {
                    $this->filesystem->delete($item['path']);
                    continue;
                }
                $timestamp = $this->filesystem->getTimestamp($item['path']);
                if ($timestamp < $tsLimit) {
                    //remove arquivos criados a mais de 45 min
                    $this->filesystem->delete($item['path']);
                }
            }
        }
    }

    /**
     * Save request envelope and response for debug reasons
     * @param string $operation
     * @param string $request
     * @param string $response
     * @return void
     */
    public function saveDebugFiles($operation, $request, $response)
    {
        if (!$this->debugmode) {
            return;
        }
        $this->debugdir = $this->certificate->getCnpj() . '/debug/';
        $now = \DateTime::createFromFormat('U.u', number_format(microtime(true), 6, '.', ''));
        $time = substr($now->format("ymdHisu"), 0, 16);
        try {
            $this->filesystem->put(
                $this->debugdir . $time . "_" . $operation . "_sol.txt",
                $request
            );
            $this->filesystem->put(
                $this->debugdir . $time . "_" . $operation . "_res.txt",
                $response
            );
        } catch (\Exception $e) {
            throw new RuntimeException(
                'Unable to create debug files.'
            );
        }
    }
}


1		<?php
2		namespace NFePHP\Common\Soap;
3
4		use NFePHP\Common\Certificate;
5		use NFePHP\Common\Exception\RuntimeException;
6		use NFePHP\Common\Strings;
7		use League\Flysystem\Filesystem;
8		use League\Flysystem\Adapter\Local;
9		use Psr\Log\LoggerInterface;
10
11		/**
12		* Soap base class
13		*
14		* @category NFePHP
15		* @package NFePHP\Common\Soap\SoapBase
16		* @copyright NFePHP Copyright (c) 2017
17		* @author Roberto L. Machado <linux.rlm at gmail dot com>
18		* @license http://www.gnu.org/licenses/lgpl.txt LGPLv3+
19		* @license https://opensource.org/licenses/MIT MIT
20		* @license http://www.gnu.org/licenses/gpl.txt GPLv3+
21		* @link http://github.com/nfephp-org/sped-nfse for the canonical source repository
22		*/
23		abstract class SoapBase implements SoapInterface
24		{
25		/**
26		* @var int
27		*/
28		protected $soapprotocol = self::SSL_DEFAULT;
29		/**
30		* @var int
31		*/
32		protected $soaptimeout = 20;
33		/**
34		* @var string
35		*/
36		protected $proxyIP;
37		/**
38		* @var int
39		*/
40		protected $proxyPort;
41		/**
42		* @var string
43		*/
44		protected $proxyUser;
45		/**
46		* @var string
47		*/
48		protected $proxyPass;
49		/**
50		* @var array
51		*/
52		protected $prefixes = [1 => 'soapenv', 2 => 'soap'];
53		/**
54		* @var Certificate
55		*/
56		protected $certificate;
57		/**
58		* @var LoggerInterface\|null
59		*/
60		protected $logger;
61		/**
62		* @var string
63		*/
64		protected $tempdir;
65		/**
66		* @var string
67		*/
68		protected $certsdir;
69		/**
70		* @var string
71		*/
72		protected $debugdir;
73		/**
74		* @var string
75		*/
76		protected $prifile;
77		/**
78		* @var string
79		*/
80		protected $pubfile;
81		/**
82		* @var string
83		*/
84		protected $certfile;
85		/**
86		* @var string
87		*/
88		protected $casefaz;
89		/**
90		* @var bool
91		*/
92		protected $disablesec = false;
93		/**
94		* @var bool
95		*/
96		protected $disableCertValidation = false;
97		/**
98		* @var \League\Flysystem\Adapter\Local
99		*/
100		protected $adapter;
101		/**
102		* @var \League\Flysystem\Filesystem
103		*/
104		protected $filesystem;
105		/**
106		* @var string
107		*/
108		protected $temppass = '';
109		/**
110		* @var bool
111		*/
112		protected $encriptPrivateKey = false;
113		/**
114		* @var bool
115		*/
116		protected $debugmode = false;
117		/**
118		* @var string
119		*/
120		public $responseHead;
121		/**
122		* @var string
123		*/
124		public $responseBody;
125		/**
126		* @var string
127		*/
128		public $requestHead;
129		/**
130		* @var string
131		*/
132		public $requestBody;
133		/**
134		* @var string
135		*/
136		public $soaperror;
137		/**
138		* @var array
139		*/
140		public $soapinfo = [];
141		/**
142		* @var int
143		*/
144		public $waitingTime = 45;
145
146		/**
147		* SoapBase constructor.
148		* @param Certificate\|null $certificate
149		* @param LoggerInterface\|null $logger
150		*/
151	5	public function __construct(
152		Certificate $certificate = null,
153		LoggerInterface $logger = null
154		) {
155	5	$this->logger = $logger;
156	5	$this->loadCertificate($certificate);
157	4	}
158
159		/**
160		* Check if certificate is valid to currently used date
161		* @param Certificate $certificate
162		* @return void
163		* @throws Certificate\Exception\Expired
164		*/
165	5	private function isCertificateExpired(Certificate $certificate = null)
166		{
167	5	if (!$this->disableCertValidation) {
168	5	if (null !== $certificate && $certificate->isExpired()) {
169	1	throw new Certificate\Exception\Expired($certificate);
170		}
171		}
172	4	}
173
174		/**
175		* Destructor
176		* Clean temporary files
177		*/
178	4	public function __destruct()
179		{
180	4	$this->removeTemporarilyFiles();
181	4	}
182
183		/**
184		* Disables the security checking of host and peer certificates
185		* @param bool $flag
186		* @return bool
187		*/
188	1	public function disableSecurity($flag = false)
189		{
190	1	return $this->disablesec = $flag;
191		}
192
193		/**
194		* ONlY for tests
195		* @param bool $flag
196		* @return bool
197		*/
198	1	public function disableCertValidation($flag = true)
199		{
200	1	return $this->disableCertValidation = $flag;
201		}
202
203		/**
204		* Load path to CA and enable to use on SOAP
205		* @param string $capath
206		* @return void
207		*/
208		public function loadCA($capath)
209		{
210		if (is_file($capath)) {
211		$this->casefaz = $capath;
212		}
213		}
214
215		/**
216		* Set option to encrypt private key before save in filesystem
217		* for an additional layer of protection
218		* @param bool $encript
219		* @return bool
220		*/
221		public function setEncriptPrivateKey($encript = true)
222		{
223		$this->encriptPrivateKey = $encript;
224		if (null !== $this->filesystem) {
225		$this->removeTemporarilyFiles();
226		}
227		if (null !== $this->certificate) {
228		$this->saveTemporarilyKeyFiles();
229		}
230		return $this->encriptPrivateKey;
231		}
232
233		/**
234		* Set another temporayfolder for saving certificates for SOAP utilization
235		* @param string \| null $folderRealPath
236		* @return void
237		*/
238		public function setTemporaryFolder($folderRealPath = null)
239		{
240		if (empty($folderRealPath)) {
241		$path = '/sped-'. getmyuid() .'/';
242		if (function_exists('posix_getuid')) {
243		$path = '/sped-'. posix_getuid() .'/';
244		}
245		$folderRealPath = sys_get_temp_dir() . $path;
246		}
247		$this->tempdir = $folderRealPath;
248		$this->setLocalFolder($folderRealPath);
249		}
250
251		/**
252		* Set Local folder for flysystem
253		* @param string $folder
254		*/
255		protected function setLocalFolder($folder = '')
256		{
257		$this->adapter = new Local($folder);
258		$this->filesystem = new Filesystem($this->adapter);
259		}
260
261		/**
262		* Set debug mode, this mode will save soap envelopes in temporary directory
263		* @param bool $value
264		* @return bool
265		*/
266		public function setDebugMode($value = false)
267		{
268		return $this->debugmode = $value;
269		}
270
271		/**
272		* Set certificate class for SSL communications
273		* @param Certificate $certificate
274		* @return void
275		*/
276	5	public function loadCertificate(Certificate $certificate = null)
277		{
278	5	$this->isCertificateExpired($certificate);
279	4	if (null !== $certificate) {
280	1	$this->certificate = $certificate;
281		}
282	4	}
283
284		/**
285		* Set logger class
286		* @param LoggerInterface $logger
287		* @return LoggerInterface
288		*/
289		public function loadLogger(LoggerInterface $logger)
290		{
291		return $this->logger = $logger;
292		}
293
294		/**
295		* Set timeout for communication
296		* @param int $timesecs
297		* @return int
298		*/
299		public function timeout($timesecs)
300		{
301		return $this->soaptimeout = $timesecs;
302		}
303
304		/**
305		* Set security protocol
306		* @param int $protocol
307		* @return int
308		*/
309		public function protocol($protocol = self::SSL_DEFAULT)
310		{
311		return $this->soapprotocol = $protocol;
312		}
313
314		/**
315		* Set prefixes
316		* @param array $prefixes
317		* @return string[]
318		*/
319		public function setSoapPrefix($prefixes = [])
320		{
321		return $this->prefixes = $prefixes;
322		}
323
324		/**
325		* Set proxy parameters
326		* @param string $ip
327		* @param int $port
328		* @param string $user
329		* @param string $password
330		* @return void
331		*/
332		public function proxy($ip, $port, $user, $password)
333		{
334		$this->proxyIP = $ip;
335		$this->proxyPort = $port;
336		$this->proxyUser = $user;
337		$this->proxyPass = $password;
338		}
339
340		/**
341		* @param string $url
342		* @param string $operation
343		* @param string $action
344		* @param int $soapver
345		* @param array $parameters
346		* @param array $namespaces
347		* @param string $request
348		* @param null $soapheader
349		* @return mixed
350		*/
351		abstract public function send(
352		$url,
353		$operation = '',
354		$action = '',
355		$soapver = SOAP_1_2,
356		$parameters = [],
357		$namespaces = [],
358		$request = '',
359		$soapheader = null
360		);
361
362		/**
363		* Mount soap envelope
364		* @param string $request
365		* @param array $namespaces
366		* @param int $soapVer
367		* @param \SoapHeader $header
368		* @return string
369		*/
370		protected function makeEnvelopeSoap(
371		$request,
372		$namespaces,
373		$soapVer = SOAP_1_2,
374		$header = null
375		) {
376		$prefix = $this->prefixes[$soapVer];
377		$envelopeAttributes = $this->getStringAttributes($namespaces);
378		return $this->mountEnvelopString(
379		$prefix,
380		$envelopeAttributes,
381		$this->mountSoapHeaders($prefix, $header),
382		$request
383		);
384		}
385
386		/**
387		* Create a envelop string
388		* @param string $envelopPrefix
389		* @param string $envelopAttributes
390		* @param string $header
391		* @param string $bodyContent
392		* @return string
393		*/
394		private function mountEnvelopString(
395		$envelopPrefix,
396		$envelopAttributes = '',
397		$header = '',
398		$bodyContent = ''
399		) {
400		return sprintf(
401		'<%s:Envelope %s>' . $header . '<%s:Body>%s</%s:Body></%s:Envelope>',
402		$envelopPrefix,
403		$envelopAttributes,
404		$envelopPrefix,
405		$bodyContent,
406		$envelopPrefix,
407		$envelopPrefix
408		);
409		}
410
411		/**
412		* Create a haeader tag
413		* @param string $envelopPrefix
414		* @param \SoapHeader $header
415		* @return string
416		*/
417		private function mountSoapHeaders($envelopPrefix, $header = null)
418		{
419		if (null === $header) {
420		return '';
421		}
422		$headerItems = '';
423		foreach ($header->data as $key => $value) {
		0 ignored issues – show Bug introduced 2017-04-29 14:39 UTC by Report Bug Copy Issue Report The property `data` does not seem to exist in `SoapHeader`. An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
424		$headerItems .= '<' . $key . '>' . $value . '</' . $key . '>';
425		}
426		return sprintf(
427		'<%s:Header><%s xmlns="%s">%s</%s></%s:Header>',
428		$envelopPrefix,
429		$header->name,
		0 ignored issues – show Bug introduced 2017-12-04 15:54 UTC by Report Bug Copy Issue Report The property `name` does not seem to exist in `SoapHeader`. An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
430		$header->namespace === null ? '' : $header->namespace,
		0 ignored issues – show Bug introduced 2017-12-20 19:37 UTC by Report Bug Copy Issue Report The property `namespace` does not seem to exist in `SoapHeader`. An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
431		$headerItems,
432		$header->name,
433		$envelopPrefix
434		);
435		}
436
437		/**
438		* Get attributes
439		* @param array $namespaces
440		* @return string
441		*/
442		private function getStringAttributes($namespaces = [])
443		{
444		$envelopeAttributes = '';
445		foreach ($namespaces as $key => $value) {
446		$envelopeAttributes .= $key . '="' . $value . '" ';
447		}
448		return $envelopeAttributes;
449		}
450
451
452		/**
453		* Temporarily saves the certificate keys for use cURL or SoapClient
454		* @return void
455		*/
456		public function saveTemporarilyKeyFiles()
457		{
458		if (!empty($this->certsdir)) {
459		return;
460		}
461		if (!is_object($this->certificate)) {
462		throw new RuntimeException(
463		'Certificate not found.'
464		);
465		}
466		if (empty($this->filesystem)) {
467		$this->setTemporaryFolder();
468		}
469		$this->certsdir = $this->certificate->getCnpj() . '/certs/';
470		$this->prifile = $this->certsdir . Strings::randomString(10) . '.pem';
471		$this->pubfile = $this->certsdir . Strings::randomString(10) . '.pem';
472		$this->certfile = $this->certsdir . Strings::randomString(10) . '.pem';
473		$ret = true;
474		$private = $this->certificate->privateKey;
475		if ($this->encriptPrivateKey) {
476		//cria uma senha temporária ALEATÓRIA para salvar a chave primaria
477		//portanto mesmo que localizada e identificada não estará acessível
478		//pois sua senha não existe além do tempo de execução desta classe
479		$this->temppass = Strings::randomString(16);
480		//encripta a chave privada entes da gravação do filesystem
481		openssl_pkey_export(
482		$this->certificate->privateKey,
483		$private,
484		$this->temppass
485		);
486		}
487		$ret &= $this->filesystem->put(
488		$this->prifile,
489		$private
490		);
491		$ret &= $this->filesystem->put(
492		$this->pubfile,
493		$this->certificate->publicKey
494		);
495		$ret &= $this->filesystem->put(
496		$this->certfile,
497		$private . "{$this->certificate}"
498		);
499		if (!$ret) {
500		throw new RuntimeException(
501		'Unable to save temporary key files in folder.'
502		);
503		}
504		}
505
506		/**
507		* Delete all files in folder
508		* @return void
509		*/
510	4	public function removeTemporarilyFiles()
511		{
512	4	if (empty($this->filesystem) \|\| empty($this->certsdir)) {
513	4	return;
514		}
515		$contents = $this->filesystem->listContents($this->certsdir, true);
516		//define um limite de $waitingTime min, ou seja qualquer arquivo criado a mais
517		//de $waitingTime min será removido
518		//NOTA: quando ocorre algum erro interno na execução do script, alguns
519		//arquivos temporários podem permanecer
520		//NOTA: O tempo default é de 45 minutos e pode ser alterado diretamente nas
521		//propriedades da classe, esse tempo entre 5 a 45 min é recomendável pois
522		//podem haver processos concorrentes para um mesmo usuário. Esses processos
523		//como o DFe podem ser mais longos, dependendo a forma que o aplicativo
524		//utilize a API. Outra solução para remover arquivos "perdidos" pode ser
525		//encontrada oportunamente.
526		$dt = new \DateTime();
527		$tint = new \DateInterval("PT" . $this->waitingTime . "M");
528		$tint->invert = 1;
529		$tsLimit = $dt->add($tint)->getTimestamp();
530		foreach ($contents as $item) {
531		if ($item['type'] == 'file') {
532		if ($item['path'] == $this->prifile
533		\|\| $item['path'] == $this->pubfile
534		\|\| $item['path'] == $this->certfile
535		) {
536		$this->filesystem->delete($item['path']);
537		continue;
538		}
539		$timestamp = $this->filesystem->getTimestamp($item['path']);
540		if ($timestamp < $tsLimit) {
541		//remove arquivos criados a mais de 45 min
542		$this->filesystem->delete($item['path']);
543		}
544		}
545		}
546		}
547
548		/**
549		* Save request envelope and response for debug reasons
550		* @param string $operation
551		* @param string $request
552		* @param string $response
553		* @return void
554		*/
555		public function saveDebugFiles($operation, $request, $response)
556		{
557		if (!$this->debugmode) {
558		return;
559		}
560		$this->debugdir = $this->certificate->getCnpj() . '/debug/';
561		$now = \DateTime::createFromFormat('U.u', number_format(microtime(true), 6, '.', ''));
562		$time = substr($now->format("ymdHisu"), 0, 16);
563		try {
564		$this->filesystem->put(
565		$this->debugdir . $time . "_" . $operation . "_sol.txt",
566		$request
567		);
568		$this->filesystem->put(
569		$this->debugdir . $time . "_" . $operation . "_res.txt",
570		$response
571		);
572		} catch (\Exception $e) {
573		throw new RuntimeException(
574		'Unable to create debug files.'
575		);
576		}
577		}
578		}
579

nfephp-org / sped-common

Pull Request — master (#180)

SoapBase::makeEnvelopeSoap() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like