FoxyCart::store_name_warning() - Code Metrics - Inspection of "BUGFIX single sign on issues" - dynamic/foxystripe - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#373)

by Nic

created 2018-12-04 20:48 UTC

FoxyCart::store_name_warning() A

↳ Parent: FoxyCart

Complexity

Conditions	2
Paths	2

Size

Total Lines	8
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	4
CRAP Score	2.032

Importance

Changes

Metric	Value
eloc	4
dl	0
loc	8
ccs	4
cts	5
cp	0.8
rs	10
c	0
b	0
f	0
cc	2
nc	2
nop	0
crap	2.032

<?php

namespace Dynamic\FoxyStripe\Model;

use Psr\Log\LoggerInterface;
use SilverStripe\Core\Injector\Injector;
use SilverStripe\Dev\Debug;
use SilverStripe\SiteConfig\SiteConfig;
use SilverStripe\Security\Member;

/**
 *
 */
class FoxyCart
{
    /**
     * @var string
     */
    private static $keyPrefix = 'dYnm1c';

    /**
     * @param int $length
     * @param int $count
     *
     * @return string
     */
    public static function setStoreKey($length = 54, $count = 0)
    {
        $charset = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789'.strtotime('now');
        $strLength = strlen($charset);
        $str = '';
        while ($count < $length) {
            $str .= $charset[mt_rand(0, $strLength - 1)];
            ++$count;
        }

        return self::getKeyPrefix().substr(base64_encode($str), 0, $length);
    }

    /**
     * @return mixed|null
     * @throws \SilverStripe\ORM\ValidationException
     */
    public static function getStoreKey()
    {
        $config = FoxyStripeSetting::current_foxystripe_setting();
        if ($config->StoreKey) {
            return $config->StoreKey;
        }

        return false;
    }

    /**
     * @return null|string
     * @throws \SilverStripe\ORM\ValidationException
     */
    public static function store_name_warning()
    {
        $warning = null;
        if (self::getFoxyCartStoreName() === null) {
            $warning = 'Must define FoxyCart Store Name or Store Remote Domain in your site settings in the cms';
        }

        return $warning;
    }

    /**
     * @return mixed|null
     * @throws \SilverStripe\ORM\ValidationException
     */
    public static function getFoxyCartStoreName()
    {
        $config = FoxyStripeSetting::current_foxystripe_setting();
        if ($config->CustomSSL) {

            if ($config->RemoteDomain) {

                return $config->RemoteDomain;
            }
        } else {
            if ($config->StoreName) {
                return $config->StoreName;
            }
        }

        return false;
    }

    /**
     * @return string
     * @throws \SilverStripe\ORM\ValidationException
     */
    public static function FormActionURL()
    {
        $config = FoxyStripeSetting::current_foxystripe_setting();
        if ($config->CustomSSL) {

            return sprintf('https://%s/cart', self::getFoxyCartStoreName());
        } else {
            return sprintf('https://%s.foxycart.com/cart', self::getFoxyCartStoreName());
        }
    }

    /**
     * FoxyCart API v1.1 functions.
     */

    /**
     * @param array $foxyData
     * @return string
     * @throws \SilverStripe\ORM\ValidationException
     */
    private static function getAPIRequest($foxyData = array())
    {
        if (self::getStoreKey() && self::getFoxyCartStoreName()) {
            $foxy_domain = self::getFoxyCartStoreName().'.foxycart.com';
            $foxyData['api_token'] = self::getStoreKey();

            $ch = curl_init();
            curl_setopt($ch, CURLOPT_URL, 'https://'.$foxy_domain.'/api');
            curl_setopt($ch, CURLOPT_POSTFIELDS, $foxyData);
            curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
            curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, 5);
            curl_setopt($ch, CURLOPT_TIMEOUT, 15);
            // If you get SSL errors, you can uncomment the following, or ask your host to add the appropriate CA bundle
            // curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);

            $response = trim(curl_exec($ch));

            // The following if block will print any CURL errors you might have
            if ($response == false) {

                //trigger_error("Could not connect to FoxyCart API", E_USER_ERROR);

                Injector::inst()->get(LoggerInterface::class)->error('Could not connect to FoxyCart API');
            }
            curl_close($ch);

            return $response;
        }
        return false;

    }

    /**
     * @param null $Member

     * @return string
     * @throws \SilverStripe\ORM\ValidationException
     */
    public static function getCustomer(Member $Member = null)
    {

        // throw error if no $Member Object
        if (!isset($Member)) {
            trigger_error('No Member set', E_USER_ERROR);
        }

        // grab customer record from API

        $foxyData = array();
        $foxyData['api_action'] = 'customer_get';
        if ($Member->Customer_ID) {
            $foxyData['customer_id'] = $Member->Customer_ID;
        }
        $foxyData['customer_email'] = $Member->Email;

        return self::getAPIRequest($foxyData);
    }

    /**
     * @param null $Member

     * @return string
     * @throws \SilverStripe\ORM\ValidationException
     */
    public static function putCustomer(Member $Member = null)
    {
        // throw error if no $Member Object
        if ($Member === null) {
//trigger_error('No Member set', E_USER_ERROR);

            return false;

        }
        // send updated customer record from API
        $foxyData = array();
        $foxyData['api_action'] = 'customer_save';
        // customer_id will be 0 if created in SilverStripe.
        if ($Member->Customer_ID) {
            $foxyData['customer_id'] = $Member->Customer_ID;
        }
        $foxyData['customer_email'] = $Member->Email;
        $foxyData['customer_password_hash'] = $Member->Password;
        $foxyData['customer_password_salt'] = $Member->Salt;
        $foxyData['customer_first_name'] = $Member->FirstName;
        $foxyData['customer_last_name'] = $Member->Surname;

        return self::getAPIRequest($foxyData);
    }

    /**
     * @return string
     */
    public static function getKeyPrefix()
    {
        return self::$keyPrefix;
    }
}


1		<?php
2
3		namespace Dynamic\FoxyStripe\Model;
4
5		use Psr\Log\LoggerInterface;
6		use SilverStripe\Core\Injector\Injector;
7		use SilverStripe\Dev\Debug;
8		use SilverStripe\SiteConfig\SiteConfig;
9		use SilverStripe\Security\Member;
10
11		/**
12		*
13		*/
14		class FoxyCart
15		{
16		/**
17		* @var string
18		*/
19		private static $keyPrefix = 'dYnm1c';
20
21		/**
22		* @param int $length
23		* @param int $count
24		*
25		* @return string
26		*/
27	3	public static function setStoreKey($length = 54, $count = 0)
28		{
29	3	$charset = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789'.strtotime('now');
30	3	$strLength = strlen($charset);
31	3	$str = '';
32	3	while ($count < $length) {
33	3	$str .= $charset[mt_rand(0, $strLength - 1)];
34	3	++$count;
35		}
36
37	3	return self::getKeyPrefix().substr(base64_encode($str), 0, $length);
38		}
39
40		/**
41		* @return mixed\|null
42		* @throws \SilverStripe\ORM\ValidationException
43		*/
44	9	public static function getStoreKey()
45		{
46	9	$config = FoxyStripeSetting::current_foxystripe_setting();
47	9	if ($config->StoreKey) {
48		return $config->StoreKey;
49		}
50
51	9	return false;
52		}
53
54		/**
55		* @return null\|string
56		* @throws \SilverStripe\ORM\ValidationException
57		*/
58	1	public static function store_name_warning()
59		{
60	1	$warning = null;
61	1	if (self::getFoxyCartStoreName() === null) {
62		$warning = 'Must define FoxyCart Store Name or Store Remote Domain in your site settings in the cms';
63		}
64
65	1	return $warning;
66		}
67
68		/**
69		* @return mixed\|null
70		* @throws \SilverStripe\ORM\ValidationException
71		*/
72	1	public static function getFoxyCartStoreName()
73		{
74	1	$config = FoxyStripeSetting::current_foxystripe_setting();
75	1	if ($config->CustomSSL) {
		0 ignored issues – show Bug Best Practice introduced 2018-11-06 16:43 UTC by Report Bug Copy Issue Report The property `CustomSSL` does not exist on `Dynamic\FoxyStripe\Model\FoxyStripeSetting`. Since you implemented `__get`, consider adding a @property annotation. Loading history...
76		if ($config->RemoteDomain) {
		0 ignored issues – show Bug Best Practice introduced 2018-11-06 16:43 UTC by Report Bug Copy Issue Report The property `RemoteDomain` does not exist on `Dynamic\FoxyStripe\Model\FoxyStripeSetting`. Since you implemented `__get`, consider adding a @property annotation. Loading history...
77		return $config->RemoteDomain;
78		}
79		} else {
80	1	if ($config->StoreName) {
81		return $config->StoreName;
82		}
83		}
84
85	1	return false;
86		}
87
88		/**
89		* @return string
90		* @throws \SilverStripe\ORM\ValidationException
91		*/
92		public static function FormActionURL()
93		{
94		$config = FoxyStripeSetting::current_foxystripe_setting();
95		if ($config->CustomSSL) {
		0 ignored issues – show Bug Best Practice introduced 2018-11-06 17:31 UTC by Report Bug Copy Issue Report The property `CustomSSL` does not exist on `Dynamic\FoxyStripe\Model\FoxyStripeSetting`. Since you implemented `__get`, consider adding a @property annotation. Loading history...
96		return sprintf('https://%s/cart', self::getFoxyCartStoreName());
97		} else {
98		return sprintf('https://%s.foxycart.com/cart', self::getFoxyCartStoreName());
99		}
100		}
101
102		/**
103		* FoxyCart API v1.1 functions.
104		*/
105
106		/**
107		* @param array $foxyData
108		* @return string
109		* @throws \SilverStripe\ORM\ValidationException
110		*/
111		private static function getAPIRequest($foxyData = array())
112		{
113		if (self::getStoreKey() && self::getFoxyCartStoreName()) {
114		$foxy_domain = self::getFoxyCartStoreName().'.foxycart.com';
115		$foxyData['api_token'] = self::getStoreKey();
116
117		$ch = curl_init();
118		curl_setopt($ch, CURLOPT_URL, 'https://'.$foxy_domain.'/api');
119		curl_setopt($ch, CURLOPT_POSTFIELDS, $foxyData);
120		curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
121		curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, 5);
122		curl_setopt($ch, CURLOPT_TIMEOUT, 15);
123		// If you get SSL errors, you can uncomment the following, or ask your host to add the appropriate CA bundle
124		// curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
		0 ignored issues – show Unused Code Comprehensibility introduced 2016-10-01 18:12 UTC by Report Bug Copy Issue Report `59%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
125		$response = trim(curl_exec($ch));
126
127		// The following if block will print any CURL errors you might have
128		if ($response == false) {
		0 ignored issues – show Bug Best Practice introduced 2018-03-03 21:50 UTC by Report Bug Copy Issue Report It seems like you are loosely comparing `$response` of type `string` to the boolean `false`. If you are specifically checking for an empty string, consider using the more explicit `=== ''` instead. Loading history...
129		//trigger_error("Could not connect to FoxyCart API", E_USER_ERROR);
		0 ignored issues – show Unused Code Comprehensibility introduced 2016-10-01 18:12 UTC by Report Bug Copy Issue Report `63%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
130		Injector::inst()->get(LoggerInterface::class)->error('Could not connect to FoxyCart API');
131		}
132		curl_close($ch);
133
134		return $response;
135		}
136		return false;
		0 ignored issues – show Bug Best Practice introduced 2018-10-12 17:24 UTC by Report Bug Copy Issue Report The expression `return false` returns the type `false` which is incompatible with the documented return type `string`. Loading history...
137		}
138
139		/**
140		* @param null $Member
		0 ignored issues – show Documentation Bug introduced 2018-03-03 21:50 UTC by Report Bug Copy Issue Report Are you sure the doc-type for parameter `$Member` is correct as it would always require `null` to be passed? Loading history...
141		* @return string
142		* @throws \SilverStripe\ORM\ValidationException
143		*/
144		public static function getCustomer(Member $Member = null)
145		{
146
147		// throw error if no $Member Object
148		if (!isset($Member)) {
149		trigger_error('No Member set', E_USER_ERROR);
150		}
151
152		// grab customer record from API
153
154		$foxyData = array();
155		$foxyData['api_action'] = 'customer_get';
156		if ($Member->Customer_ID) {
157		$foxyData['customer_id'] = $Member->Customer_ID;
158		}
159		$foxyData['customer_email'] = $Member->Email;
160
161		return self::getAPIRequest($foxyData);
162		}
163
164		/**
165		* @param null $Member
		0 ignored issues – show Documentation Bug introduced 2018-03-03 21:50 UTC by Report Bug Copy Issue Report Are you sure the doc-type for parameter `$Member` is correct as it would always require `null` to be passed? Loading history...
166		* @return string
167		* @throws \SilverStripe\ORM\ValidationException
168		*/
169		public static function putCustomer(Member $Member = null)
170		{
171		// throw error if no $Member Object
172		if ($Member === null) {
173		//trigger_error('No Member set', E_USER_ERROR);
		0 ignored issues – show Unused Code Comprehensibility introduced 2018-03-03 22:29 UTC by Report Bug Copy Issue Report `63%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
174		return false;
		0 ignored issues – show Bug Best Practice introduced 2018-10-12 17:24 UTC by Report Bug Copy Issue Report The expression `return false` returns the type `false` which is incompatible with the documented return type `string`. Loading history...
175		}
176		// send updated customer record from API
177		$foxyData = array();
178		$foxyData['api_action'] = 'customer_save';
179		// customer_id will be 0 if created in SilverStripe.
180		if ($Member->Customer_ID) {
181		$foxyData['customer_id'] = $Member->Customer_ID;
182		}
183		$foxyData['customer_email'] = $Member->Email;
184		$foxyData['customer_password_hash'] = $Member->Password;
185		$foxyData['customer_password_salt'] = $Member->Salt;
186		$foxyData['customer_first_name'] = $Member->FirstName;
187		$foxyData['customer_last_name'] = $Member->Surname;
188
189		return self::getAPIRequest($foxyData);
190		}
191
192		/**
193		* @return string
194		*/
195	3	public static function getKeyPrefix()
196		{
197	3	return self::$keyPrefix;
198		}
199		}
200

dynamic / foxystripe

Pull Request — master (#373)

FoxyCart::store_name_warning() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like