AbstractMetadataController::actionSave() - Code Metrics - flipboxfactory/saml-core - Measure and Improve Code Quality continuously with Scrutinizer

AbstractMetadataController::actionSave() A
last analyzed 2021-04-19 18:56 UTC

↳ Parent: AbstractMetadataController

Complexity

Conditions	4
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	26
rs	9.504
c	0
b	0
f	0
cc	4
nc	2
nop	0

<?php
/**
 * Created by PhpStorm.
 * User: dsmrt
 * Date: 2/10/18
 * Time: 10:47 PM
 */

namespace flipbox\saml\core\controllers;

use Craft;
use craft\records\Site;
use flipbox\keychain\records\KeyChainRecord;
use flipbox\saml\core\controllers\cp\view\AbstractController;
.
|-- OtherDir
|   |-- Bar.php
|   `-- Foo.php
`-- SomeDir
    `-- Foo.php
use flipbox\saml\core\controllers\cp\view\metadata\AbstractEditController;
use flipbox\saml\core\controllers\cp\view\metadata\VariablesTrait;
use flipbox\saml\core\exceptions\InvalidMetadata;
use flipbox\saml\core\helpers\SerializeHelper;
use flipbox\saml\core\models\GroupOptions;
use flipbox\saml\core\models\MetadataOptions;
use flipbox\saml\core\models\SettingsInterface;
use flipbox\saml\core\records\AbstractProvider;
use flipbox\saml\core\records\ProviderInterface;
use yii\web\NotFoundHttpException;

abstract class AbstractMetadataController extends AbstractController implements \flipbox\saml\core\EnsureSAMLPlugin
{

    use VariablesTrait;

    /**
     * @return string
     * @throws InvalidMetadata
     * @throws \yii\web\ForbiddenHttpException
     */
    public function actionIndex()
    {

        $this->requireAdmin(false);

        /** @var AbstractProvider $provider */
        $provider = $this->getPlugin()->getProvider()->findByEntityId(
            $this->getPlugin()->getSettings()->getEntityId()
        )->one();

        if (! $provider) {
            throw new InvalidMetadata('Metadata for this server is missing. Please configure this plugin.');
        }

        SerializeHelper::xmlContentType();
        return $provider->toXmlString();
    }

    /**
     * @return \yii\web\Response
     * @throws \Exception
     * @throws \yii\web\BadRequestHttpException
     */
    public function actionAutoCreate()
    {
        $this->requireAdmin(false);
        $this->requirePostRequest();

        $providerRecord = $this->processSaveAction();
        if (is_null($providerRecord->uid)) {
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
            $providerRecord->generateUid();
        }

        $entityDescriptor = $this->getPlugin()->getMetadata()->create(
            $this->getPlugin()->getSettings(),
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
            $providerRecord

        );

        $provider = $this->getPlugin()->getProvider()->create(
            $entityDescriptor,
            $providerRecord->keychain
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
        );

        $providerRecord->entityId = $provider->getEntityId();
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
        $providerRecord->metadata = $provider->metadata;
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
        $providerRecord->setMetadataModel($provider->getMetadataModel());


        if (! $this->getPlugin()->getProvider()->save($providerRecord)) {
            return $this->renderTemplate(
                $this->getPlugin()->getEditProvider()->getTemplateIndex() . AbstractEditController::TEMPLATE_INDEX . DIRECTORY_SEPARATOR . 'edit',
                array_merge(
                    [
                        'provider' => $providerRecord,
                        'keychain' => $providerRecord->keychain ?: new KeyChainRecord(),
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
                    ],
                    $this->getPlugin()->getEditProvider()->prepVariables($providerRecord)
                )
            );
        }

        return $this->redirectToPostedUrl();
    }

    /**
     * @return \yii\web\Response
     * @throws \Exception
     * @throws \yii\web\BadRequestHttpException
     */
    public function actionSave()
    {

        $this->requireAdmin(false);
        $this->requirePostRequest();

        /** @var AbstractProvider $record */
        $record = $this->processSaveAction();

        if ($record->hasErrors() || ! $this->getPlugin()->getProvider()->save($record)) {
            return $this->renderTemplate(
                $this->getPlugin()->getEditProvider()->getTemplateIndex() . AbstractEditController::TEMPLATE_INDEX . DIRECTORY_SEPARATOR . 'edit',
                array_merge(
                    [
                        'provider' => $record,
                        'keychain' => $record->keychain ?: new KeyChainRecord(),
                    ],
                    $this->getPlugin()->getEditProvider()->prepVariables($record)
                )
            );
        }

        Craft::$app->getSession()->setNotice(Craft::t($this->getPlugin()->getHandle(), 'Provider saved.'));
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}

        return $this->redirectToPostedUrl();
    }

    /**
     * Actions
     */

    /**
     * @return \yii\web\Response
     * @throws \yii\web\BadRequestHttpException
     * @throws \yii\web\ForbiddenHttpException
     * @throws \Exception
     */
    public function actionChangeStatus()
    {

        $this->requireAdmin(false);
        $this->requirePostRequest();

        $providerId = Craft::$app->request->getRequiredBodyParam('identifier');

        /** @var string $recordClass */
        $recordClass = $this->getPlugin()->getProviderRecordClass();

        /** @var AbstractProvider $record */
        $record = $recordClass::find()->where([
            'id' => $providerId,
        ])->one();

        $record->enabled = ! $record->enabled;

        if (! $this->getPlugin()->getProvider()->save($record)) {
            return $this->renderTemplate(
                $this->getPlugin()->getEditProvider()->getTemplateIndex() . AbstractEditController::TEMPLATE_INDEX . DIRECTORY_SEPARATOR . 'edit',
                array_merge(
                    [
                        'provider' => $record,
                        'keychain' => $record->keychain ?: new KeyChainRecord(),
                    ],
                    $this->getPlugin()->getEditProvider()->prepVariables($record)
                )
            );
        }

        return $this->redirectToPostedUrl();
    }

    /**
     * @return \yii\web\Response
     * @throws \yii\web\BadRequestHttpException
     * @throws \yii\web\ForbiddenHttpException
     */
    public function actionDelete()
    {
        $this->requireAdmin(false);
        $this->requirePostRequest();

        $providerId = Craft::$app->request->getRequiredBodyParam('identifier');

        /** @var string $recordClass */
        $recordClass = $this->getPlugin()->getProviderRecordClass();

        /** @var ProviderInterface $record */
        $record = $recordClass::find()->where([
            'id' => $providerId,
        ])->one();

        if (! $this->getPlugin()->getProvider()->delete($record)) {
            return $this->renderTemplate(
                $this->getPlugin()->getEditProvider()->getTemplateIndex() . AbstractEditController::TEMPLATE_INDEX . DIRECTORY_SEPARATOR . 'edit',
                array_merge(
                    [
                        'provider' => $record,
                        'keychain' => $record->keychain ?: new KeyChainRecord(),
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
                    ],
                    $this->getPlugin()->getEditProvider()->prepVariables($record)
                )
            );
        }

        return $this->redirectToPostedUrl();
    }

    /**
     * @return ProviderInterface
     * @throws \Exception
     */
    protected function processSaveAction()
    {

        $providerId = Craft::$app->request->getParam('identifier');
        $entityId = Craft::$app->request->getParam('entityId');
        $keyId = Craft::$app->request->getParam('keychain');
        $providerType = Craft::$app->request->getParam('providerType');
        $providerSite = Craft::$app->request->getParam('providerSite');
        $metadata = Craft::$app->request->getParam('metadata-text');
        $metadataUrl = Craft::$app->request->getParam('metadata-url-text');
        $metadataUrlInterval = Craft::$app->request->getParam('metadata-url-interval-text');
        $mapping = Craft::$app->request->getParam('mapping', []);
        $label = Craft::$app->request->getRequiredParam('label');
        $nameIdOverride = Craft::$app->request->getParam('nameIdOverride');


        $plugin = $this->getPlugin();

        $recordClass = $this->getPlugin()->getProviderRecordClass();
        /** @var AbstractProvider $record */
        if ($providerId) {
            $record = $recordClass::find()->where([
                'id' => $providerId,
            ])->one();

            if (! $record) {
                throw new \Exception("Provider with ID: {$providerId} not found.");
            }
        } else {
            $record = new $recordClass();

            //enabled is default
            $record->enabled = true;
        }

        $record->entityId = $entityId;
        if ($providerSite) {
            if ($site = Site::findOne([
                'id' => $providerSite,
            ])) {
                $record->setSite($site);
            } else {
                // @todo add
                var_dump('wat?');

                exit;
            }
        }

        // Metadata
        if (! $metadata && $metadataUrl) {
            $metadataModel = $this->getPlugin()->getMetadata()->fetchByUrl($metadataUrl);
            $record->metadata = $metadataModel->toXML()->ownerDocument->saveXML();
            $record->setMetadataModel($metadataModel);
        } else {
            $record->metadata = $metadata;
        }

        // Mapping
        if (is_array($mapping)) {
            $record->setMapping(
                $mapping
            );
        }

        $record->providerType = $providerType;
        $record->nameIdOverride = $nameIdOverride;

        // IDP Plugin on SP Provider ONLY
        if ($this->getPlugin()->getMyType() === SettingsInterface::IDP
            &&
            $providerType === SettingsInterface::SP
        ) {
            // Encryption settings
            $record->encryptAssertions = Craft::$app->request->getParam('encryptAssertions') ?: 0;
            $record->encryptionMethod = Craft::$app->request->getParam('encryptionMethod');
            $record->setGroupOptions(
                $groupOptions = new GroupOptions([
                    'options' => Craft::$app->request->getParam('groupOptions', []) ?: [],
                ])
            );
        }

        $record->setMetadataOptions(
            new MetadataOptions([
                'url' => $metadataUrl,
                'expiryInterval' => $metadataUrlInterval,
            ])
        );

        // Group properties
        $record->syncGroups = Craft::$app->request->getParam('syncGroups') ?: 0;

        $record->groupsAttributeName =
            Craft::$app->request->getParam('groupsAttributeName') ?:
                AbstractProvider::DEFAULT_GROUPS_ATTRIBUTE_NAME;

        /**
         * check for label and add error if it's empty
         */
        if ($label) {
            $record->label = $label;
        } else {
            $record->addError('label', Craft::t($plugin->getHandle(), "Label is required."));
        }


        if ($keyId) {
            /** @var KeyChainRecord $keychain */
            if ($keychain = KeyChainRecord::find()->where([
                'id' => $keyId,
            ])->one()) {
                $record->setKeychain(
                    $keychain
                );
            }
        }

        /**
         * Metadata should exist for the remote provider
         */
        if ($plugin->getRemoteType() === $providerType && ! $record->metadata) {
            $record->addError('metadata-text', Craft::t($plugin->getHandle(), "Metadata cannot be empty."));
        }

        return $record;
    }


    /**
     * @param $keyId
     * @return \craft\web\Response|\yii\console\Response
     * @throws NotFoundHttpException
     * @throws \yii\web\ForbiddenHttpException
     * @throws \yii\web\HttpException
     * @throws \yii\web\RangeNotSatisfiableHttpException
     */
    public function actionDownloadCertificate($keyId)
    {
        $this->requireAdmin(false);

        /** @var KeyChainRecord $keychain */
        if (! $keychain = KeyChainRecord::find()->where([
            'id' => $keyId,
        ])->one()) {
            throw new NotFoundHttpException('Key not found');
        }

        return Craft::$app->response->sendContentAsFile($keychain->getDecryptedCertificate(), 'certificate.crt');
    }
}


AbstractMetadataController::actionSave() A
last analyzed 2021-04-19 18:56 UTC

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

1			<?php
2			/**
3			* Created by PhpStorm.
4			* User: dsmrt
5			* Date: 2/10/18
6			* Time: 10:47 PM
7			*/
8
9			namespace flipbox\saml\core\controllers;
10
11			use Craft;
12			use craft\records\Site;
13			use flipbox\keychain\records\KeyChainRecord;
14			use flipbox\saml\core\controllers\cp\view\AbstractController;
			0 ignored issues – show Bug introduced 2018-08-17 15:20 UTC by Report Bug Copy Issue Report This use statement conflicts with another class in this namespace, `flipbox\saml\core\controllers\AbstractController`. Let’s assume that you have a directory layout like this: . \|-- OtherDir \| \|-- Bar.php \| `-- Foo.php `-- SomeDir `-- Foo.php and let’s assume the following content of `Bar.php`: // Bar.php namespace OtherDir; use SomeDir\Foo; // This now conflicts the class OtherDir\Foo If both files `OtherDir/Foo.php` and `SomeDir/Foo.php` are loaded in the same runtime, you will see a PHP error such as the following: PHP Fatal error: Cannot use SomeDir\Foo as Foo because the name is already in use in OtherDir/Foo.php However, as `OtherDir/Foo.php` does not necessarily have to be loaded and the error is only triggered if it is loaded before `OtherDir/Bar.php`, this problem might go unnoticed for a while. In order to prevent this error from surfacing, you must import the namespace with a different alias: // Bar.php namespace OtherDir; use SomeDir\Foo as SomeDirFoo; // There is no conflict anymore. Loading history...
15			use flipbox\saml\core\controllers\cp\view\metadata\AbstractEditController;
16			use flipbox\saml\core\controllers\cp\view\metadata\VariablesTrait;
17			use flipbox\saml\core\exceptions\InvalidMetadata;
18			use flipbox\saml\core\helpers\SerializeHelper;
19			use flipbox\saml\core\models\GroupOptions;
20			use flipbox\saml\core\models\MetadataOptions;
21			use flipbox\saml\core\models\SettingsInterface;
22			use flipbox\saml\core\records\AbstractProvider;
23			use flipbox\saml\core\records\ProviderInterface;
24			use yii\web\NotFoundHttpException;
25
26			abstract class AbstractMetadataController extends AbstractController implements \flipbox\saml\core\EnsureSAMLPlugin
27			{
28
29			use VariablesTrait;
30
31			/**
32			* @return string
33			* @throws InvalidMetadata
34			* @throws \yii\web\ForbiddenHttpException
35			*/
36			public function actionIndex()
37			{
38
39			$this->requireAdmin(false);
40
41			/** @var AbstractProvider $provider */
42			$provider = $this->getPlugin()->getProvider()->findByEntityId(
43			$this->getPlugin()->getSettings()->getEntityId()
44			)->one();
45
46			if (! $provider) {
47			throw new InvalidMetadata('Metadata for this server is missing. Please configure this plugin.');
48			}
49
50			SerializeHelper::xmlContentType();
51			return $provider->toXmlString();
52			}
53
54			/**
55			* @return \yii\web\Response
56			* @throws \Exception
57			* @throws \yii\web\BadRequestHttpException
58			*/
59			public function actionAutoCreate()
60			{
61			$this->requireAdmin(false);
62			$this->requirePostRequest();
63
64			$providerRecord = $this->processSaveAction();
65			if (is_null($providerRecord->uid)) {
			0 ignored issues – show Bug introduced 2021-02-12 04:17 UTC by Report Bug Copy Issue Report Accessing `uid` on the interface `flipbox\saml\core\records\ProviderInterface` suggest that you code against a concrete implementation. How about adding an `instanceof` check? If you access a property on an interface, you most likely code against a concrete implementation of the interface. Available Fixes Adding an additional type check: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeInterface $object) { if ($object instanceof SomeClass) { $a = $object->a; } } Changing the type hint: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeClass $object) { $a = $object->a; } Loading history...
66			$providerRecord->generateUid();
67			}
68
69			$entityDescriptor = $this->getPlugin()->getMetadata()->create(
70			$this->getPlugin()->getSettings(),
			0 ignored issues – show Bug introduced 2019-09-11 23:54 UTC by Report Bug Copy Issue Report It seems like `$this->getPlugin()->getSettings()` can be `null`; however, `create()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
71			$providerRecord
			0 ignored issues – show Compatibility introduced 2021-02-12 04:17 UTC by Report Bug Copy Issue Report `$providerRecord` of type `object<flipbox\saml\core...ords\ProviderInterface>` is not a sub-type of `object<flipbox\saml\core...cords\AbstractProvider>`. It seems like you assume a concrete implementation of the interface `flipbox\saml\core\records\ProviderInterface` to be always present. This check looks for parameters that are defined as one type in their type hint or doc comment but seem to be used as a narrower type, i.e an implementation of an interface or a subclass. Consider changing the type of the parameter or doing an instanceof check before assuming your parameter is of the expected type. Loading history...
72			);
73
74			$provider = $this->getPlugin()->getProvider()->create(
75			$entityDescriptor,
76			$providerRecord->keychain
			0 ignored issues – show Bug introduced 2021-02-12 04:17 UTC by Report Bug Copy Issue Report Accessing `keychain` on the interface `flipbox\saml\core\records\ProviderInterface` suggest that you code against a concrete implementation. How about adding an `instanceof` check? If you access a property on an interface, you most likely code against a concrete implementation of the interface. Available Fixes Adding an additional type check: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeInterface $object) { if ($object instanceof SomeClass) { $a = $object->a; } } Changing the type hint: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeClass $object) { $a = $object->a; } Loading history...
77			);
78
79			$providerRecord->entityId = $provider->getEntityId();
			0 ignored issues – show Bug introduced 2021-02-12 04:17 UTC by Report Bug Copy Issue Report Accessing `entityId` on the interface `flipbox\saml\core\records\ProviderInterface` suggest that you code against a concrete implementation. How about adding an `instanceof` check? If you access a property on an interface, you most likely code against a concrete implementation of the interface. Available Fixes Adding an additional type check: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeInterface $object) { if ($object instanceof SomeClass) { $a = $object->a; } } Changing the type hint: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeClass $object) { $a = $object->a; } Loading history...
80			$providerRecord->metadata = $provider->metadata;
			0 ignored issues – show Bug introduced 2021-02-12 04:17 UTC by Report Bug Copy Issue Report Accessing `metadata` on the interface `flipbox\saml\core\records\ProviderInterface` suggest that you code against a concrete implementation. How about adding an `instanceof` check? If you access a property on an interface, you most likely code against a concrete implementation of the interface. Available Fixes Adding an additional type check: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeInterface $object) { if ($object instanceof SomeClass) { $a = $object->a; } } Changing the type hint: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeClass $object) { $a = $object->a; } Loading history...
81			$providerRecord->setMetadataModel($provider->getMetadataModel());
82
83
84			if (! $this->getPlugin()->getProvider()->save($providerRecord)) {
85			return $this->renderTemplate(
86			$this->getPlugin()->getEditProvider()->getTemplateIndex() . AbstractEditController::TEMPLATE_INDEX . DIRECTORY_SEPARATOR . 'edit',
87			array_merge(
88			[
89			'provider' => $providerRecord,
90			'keychain' => $providerRecord->keychain ?: new KeyChainRecord(),
			0 ignored issues – show Bug introduced 2018-06-29 21:37 UTC by Report Bug Copy Issue Report Accessing `keychain` on the interface `flipbox\saml\core\records\ProviderInterface` suggest that you code against a concrete implementation. How about adding an `instanceof` check? If you access a property on an interface, you most likely code against a concrete implementation of the interface. Available Fixes Adding an additional type check: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeInterface $object) { if ($object instanceof SomeClass) { $a = $object->a; } } Changing the type hint: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeClass $object) { $a = $object->a; } Loading history...
91			],
92			$this->getPlugin()->getEditProvider()->prepVariables($providerRecord)
93			)
94			);
95			}
96
97			return $this->redirectToPostedUrl();
98			}
99
100			/**
101			* @return \yii\web\Response
102			* @throws \Exception
103			* @throws \yii\web\BadRequestHttpException
104			*/
105			public function actionSave()
106			{
107
108			$this->requireAdmin(false);
109			$this->requirePostRequest();
110
111			/** @var AbstractProvider $record */
112			$record = $this->processSaveAction();
113
114			if ($record->hasErrors() \|\| ! $this->getPlugin()->getProvider()->save($record)) {
115			return $this->renderTemplate(
116			$this->getPlugin()->getEditProvider()->getTemplateIndex() . AbstractEditController::TEMPLATE_INDEX . DIRECTORY_SEPARATOR . 'edit',
117			array_merge(
118			[
119			'provider' => $record,
120			'keychain' => $record->keychain ?: new KeyChainRecord(),
121			],
122			$this->getPlugin()->getEditProvider()->prepVariables($record)
123			)
124			);
125			}
126
127			Craft::$app->getSession()->setNotice(Craft::t($this->getPlugin()->getHandle(), 'Provider saved.'));
			0 ignored issues – show Bug introduced 2020-10-27 20:26 UTC by Report Bug Copy Issue Report The method `getSession` does only exist in `yii\web\Application`, but not in `yii\console\Application`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: class A { public function foo() { } } class B extends A { public function bar() { } } /** * @param A\|B $x / function someFunction($x) { $x->foo(); // This call is fine as the method exists in A and B. $x->bar(); // This method only exists in B and might cause an error. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history...
128
129			return $this->redirectToPostedUrl();
130			}
131
132			/**
133			* Actions
134			*/
135
136			/**
137			* @return \yii\web\Response
138			* @throws \yii\web\BadRequestHttpException
139			* @throws \yii\web\ForbiddenHttpException
140			* @throws \Exception
141			*/
142			public function actionChangeStatus()
143			{
144
145			$this->requireAdmin(false);
146			$this->requirePostRequest();
147
148			$providerId = Craft::$app->request->getRequiredBodyParam('identifier');
149
150			/** @var string $recordClass */
151			$recordClass = $this->getPlugin()->getProviderRecordClass();
152
153			/** @var AbstractProvider $record */
154			$record = $recordClass::find()->where([
155			'id' => $providerId,
156			])->one();
157
158			$record->enabled = ! $record->enabled;
159
160			if (! $this->getPlugin()->getProvider()->save($record)) {
161			return $this->renderTemplate(
162			$this->getPlugin()->getEditProvider()->getTemplateIndex() . AbstractEditController::TEMPLATE_INDEX . DIRECTORY_SEPARATOR . 'edit',
163			array_merge(
164			[
165			'provider' => $record,
166			'keychain' => $record->keychain ?: new KeyChainRecord(),
167			],
168			$this->getPlugin()->getEditProvider()->prepVariables($record)
169			)
170			);
171			}
172
173			return $this->redirectToPostedUrl();
174			}
175
176			/**
177			* @return \yii\web\Response
178			* @throws \yii\web\BadRequestHttpException
179			* @throws \yii\web\ForbiddenHttpException
180			*/
181			public function actionDelete()
182			{
183			$this->requireAdmin(false);
184			$this->requirePostRequest();
185
186			$providerId = Craft::$app->request->getRequiredBodyParam('identifier');
187
188			/** @var string $recordClass */
189			$recordClass = $this->getPlugin()->getProviderRecordClass();
190
191			/** @var ProviderInterface $record */
192			$record = $recordClass::find()->where([
193			'id' => $providerId,
194			])->one();
195
196			if (! $this->getPlugin()->getProvider()->delete($record)) {
197			return $this->renderTemplate(
198			$this->getPlugin()->getEditProvider()->getTemplateIndex() . AbstractEditController::TEMPLATE_INDEX . DIRECTORY_SEPARATOR . 'edit',
199			array_merge(
200			[
201			'provider' => $record,
202			'keychain' => $record->keychain ?: new KeyChainRecord(),
			0 ignored issues – show Bug introduced 2018-06-29 21:37 UTC by Report Bug Copy Issue Report Accessing `keychain` on the interface `flipbox\saml\core\records\ProviderInterface` suggest that you code against a concrete implementation. How about adding an `instanceof` check? If you access a property on an interface, you most likely code against a concrete implementation of the interface. Available Fixes Adding an additional type check: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeInterface $object) { if ($object instanceof SomeClass) { $a = $object->a; } } Changing the type hint: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeClass $object) { $a = $object->a; } Loading history...
203			],
204			$this->getPlugin()->getEditProvider()->prepVariables($record)
205			)
206			);
207			}
208
209			return $this->redirectToPostedUrl();
210			}
211
212			/**
213			* @return ProviderInterface
214			* @throws \Exception
215			*/
216			protected function processSaveAction()
217			{
218
219			$providerId = Craft::$app->request->getParam('identifier');
220			$entityId = Craft::$app->request->getParam('entityId');
221			$keyId = Craft::$app->request->getParam('keychain');
222			$providerType = Craft::$app->request->getParam('providerType');
223			$providerSite = Craft::$app->request->getParam('providerSite');
224			$metadata = Craft::$app->request->getParam('metadata-text');
225			$metadataUrl = Craft::$app->request->getParam('metadata-url-text');
226			$metadataUrlInterval = Craft::$app->request->getParam('metadata-url-interval-text');
227			$mapping = Craft::$app->request->getParam('mapping', []);
228			$label = Craft::$app->request->getRequiredParam('label');
229			$nameIdOverride = Craft::$app->request->getParam('nameIdOverride');
230
231
232			$plugin = $this->getPlugin();
233
234			$recordClass = $this->getPlugin()->getProviderRecordClass();
235			/** @var AbstractProvider $record */
236			if ($providerId) {
237			$record = $recordClass::find()->where([
238			'id' => $providerId,
239			])->one();
240
241			if (! $record) {
242			throw new \Exception("Provider with ID: {$providerId} not found.");
243			}
244			} else {
245			$record = new $recordClass();
246
247			//enabled is default
248			$record->enabled = true;
249			}
250
251			$record->entityId = $entityId;
252			if ($providerSite) {
253			if ($site = Site::findOne([
254			'id' => $providerSite,
255			])) {
256			$record->setSite($site);
257			} else {
258			// @todo add
259			var_dump('wat?');
			0 ignored issues – show Security Debugging Code introduced 2021-02-12 04:17 UTC by Report Bug Copy Issue Report `var_dump('wat?');` looks like debug code. Are you sure you do not want to remove it? This might expose sensitive data. Loading history...
260			exit;
261			}
262			}
263
264			// Metadata
265			if (! $metadata && $metadataUrl) {
266			$metadataModel = $this->getPlugin()->getMetadata()->fetchByUrl($metadataUrl);
267			$record->metadata = $metadataModel->toXML()->ownerDocument->saveXML();
268			$record->setMetadataModel($metadataModel);
269			} else {
270			$record->metadata = $metadata;
271			}
272
273			// Mapping
274			if (is_array($mapping)) {
275			$record->setMapping(
276			$mapping
277			);
278			}
279
280			$record->providerType = $providerType;
281			$record->nameIdOverride = $nameIdOverride;
282
283			// IDP Plugin on SP Provider ONLY
284			if ($this->getPlugin()->getMyType() === SettingsInterface::IDP
285			&&
286			$providerType === SettingsInterface::SP
287			) {
288			// Encryption settings
289			$record->encryptAssertions = Craft::$app->request->getParam('encryptAssertions') ?: 0;
290			$record->encryptionMethod = Craft::$app->request->getParam('encryptionMethod');
291			$record->setGroupOptions(
292			$groupOptions = new GroupOptions([
293			'options' => Craft::$app->request->getParam('groupOptions', []) ?: [],
294			])
295			);
296			}
297
298			$record->setMetadataOptions(
299			new MetadataOptions([
300			'url' => $metadataUrl,
301			'expiryInterval' => $metadataUrlInterval,
302			])
303			);
304
305			// Group properties
306			$record->syncGroups = Craft::$app->request->getParam('syncGroups') ?: 0;
307
308			$record->groupsAttributeName =
309			Craft::$app->request->getParam('groupsAttributeName') ?:
310			AbstractProvider::DEFAULT_GROUPS_ATTRIBUTE_NAME;
311
312			/**
313			* check for label and add error if it's empty
314			*/
315			if ($label) {
316			$record->label = $label;
317			} else {
318			$record->addError('label', Craft::t($plugin->getHandle(), "Label is required."));
319			}
320
321
322			if ($keyId) {
323			/** @var KeyChainRecord $keychain */
324			if ($keychain = KeyChainRecord::find()->where([
325			'id' => $keyId,
326			])->one()) {
327			$record->setKeychain(
328			$keychain
329			);
330			}
331			}
332
333			/**
334			* Metadata should exist for the remote provider
335			*/
336			if ($plugin->getRemoteType() === $providerType && ! $record->metadata) {
337			$record->addError('metadata-text', Craft::t($plugin->getHandle(), "Metadata cannot be empty."));
338			}
339
340			return $record;
341			}
342
343
344			/**
345			* @param $keyId
346			* @return \craft\web\Response\|\yii\console\Response
347			* @throws NotFoundHttpException
348			* @throws \yii\web\ForbiddenHttpException
349			* @throws \yii\web\HttpException
350			* @throws \yii\web\RangeNotSatisfiableHttpException
351			*/
352			public function actionDownloadCertificate($keyId)
353			{
354			$this->requireAdmin(false);
355
356			/** @var KeyChainRecord $keychain */
357			if (! $keychain = KeyChainRecord::find()->where([
358			'id' => $keyId,
359			])->one()) {
360			throw new NotFoundHttpException('Key not found');
361			}
362
363			return Craft::$app->response->sendContentAsFile($keychain->getDecryptedCertificate(), 'certificate.crt');
364			}
365			}
366

flipboxfactory / saml-core

AbstractMetadataController::actionSave() A last analyzed 2021-04-19 18:56 UTC

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like

AbstractMetadataController::actionSave() A
last analyzed 2021-04-19 18:56 UTC