VerifiableExtension::updateCMSFields() - Code Metrics - Inspection of "Moved things around a bit." - phptek/silverstripe-verifiable - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 2ce6bc...9c94e5 )

by Russell

created 2018-06-14 10:01 UTC

VerifiableExtension::updateCMSFields() A

↳ Parent: VerifiableExtension

Complexity

Conditions	1
Paths	1

Size

Total Lines	9
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	5
nc	1
nop	1
dl	0
loc	9
rs	9.6666
c	0
b	0
f	0

<?php

/**
 * @author  Russell Michell 2018 <[email protected]>
 * @package silverstripe-verifiable
 */

namespace PhpTek\Verifiable\Verify;

use SilverStripe\ORM\DataExtension;
use PhpTek\Verifiable\ORM\Fieldtype\ChainpointProof;
use SilverStripe\Forms\FieldList;
use SilverStripe\Forms\LiteralField;

/**
 * By attaching this extension to any {@link DataObject} subclass and declaring a
 * $verifiable_fields array in YML config, all subsequent database writes will
 * be passed through here via {@link $this->onAfterWrite()};
 *
 * This {@link DataExtension} also provides a single field to which all verified
 * and verifiable chainpoint proofs are stored in a queryable JSON-aware field.
 *
 * @todo Store the hash function used and if subsequent verifications
 *       fail because differing hash functions are used, throw an exception.
 * @todo Hard-code "Created" and "LastEdited" fields into "verifiable_fields"
 * @todo Prevent "Proof" field from ever being configured in verifiable_fields
 *
 */
class VerifiableExtension extends DataExtension
{
    /**
     * Declares a JSON-aware {@link DBField} where all chainpoint proofs are stored.
     *
     * @var array
     * @config
     */
    private static $db = [

        'Proof' => ChainpointProof::class,
    ];

    /**
     * The field-values that will be hashed and committed to the current backend.
     *
     * @var array
     * @config
     */
    private static $verifiable_fields = [];


    /**
     * Write -->onAfterWrite() recursion prevention.
     *
     * @var string
     */
    protected static $has_write_occured = false;

    /**
     * After each write, data from the $verifiable_fields config is compiled
     * into a string, hashed and submitted to the current backend.
     *
     * Once written, we periodically poll the backend to receive the full
     * chainpoint proof (it takes time for Bitcoin's PoW confirmations, not so
     * much for Ethereum).
     *
     * We need this "complete" proof for subsequent verification checks
     * also made against the same backend in the future.
     *
     * If only the "Proof" field has been written-to, or no-data is found in the
     * verifiable_fields, this should not constitute a write that we need to do
     * anything with, and it's therefore skipped.
     *
     * @return void
     * @todo Add a check into $skipWriteProof for checking _only_ "Proof" having changed.
     * This should _not_ constitute a change requiting a call to the backend for.
     */
    public function onAfterWrite()
    {
        parent::onAfterWrite();

        // Overflow protection should bad recursion occur
        static $write_count = 0;
        $write_count++;

        $verifiable = $this->normaliseData();
        $skipWriteProof = self::$has_write_occured === true || !count($verifiable) || $write_count > 1;

        if ($skipWriteProof) {
            // Now we fire-off a job to check if verification is complete
            // TODO: Use AsyncPHP and use a callback OR check if API has a callback
            // endpoint it can call on our end (Tierion's API does)
            // $this->verifiableService->queueVerification($this->getOwner());

            return;
        }

        if ($proofData = $this->verifiableService->write($verifiable)) {

            self::$has_write_occured = true;
$answer = 42;

$correct = false;

$correct = (bool) $answer;

            $this->writeProof($proofData);
        }
    }

    /**
     * Normalise this model's data so it's suited to being hashed.
     *
     * @return array
     * @todo use array_reduce()?
     */
    public function normaliseData() : array
    {
        $fields = $this->getOwner()->config()->get('verifiable_fields');
        $verifiable = [];

        foreach ($fields as $field) {
            $verifiable[] = (string) $this->getOwner()->getField($field);
        }

        return $verifiable;
    }

    /**
     * Passed an array of fields and their values, this method will hash them
     * and check that a chainpoint proof exists in the local database. If unsuccessful
     * we return false. Otherwise, we return true.
     *
     * If a matching proof is found both locally then the supplied
     * data is said to have been verified at least once
     *
     * @param  array $data An array of data to verify against the current backend.
     * @return mixed null | ChainpointProof
     */
    public function proofExists(array $data)
    {
        $hash = $this->verifiableService->hash($data);

        $proof = $this->getOwner()->dbObject('Proof');

        // Does the passed hash-of-the-data match the hash in the Proof?
        return $proof->exists() && $proof->getHash() === $hash ? $proof : null;
    }

    /**
     * Writes string data that is assumed to be JSON (as returned from a
     * web-service for example) and saved to this decorated object's "Proof"
     * field.
     *
     * @param  mixed $proof
     * @return void
     */
    public function writeProof($proof)
    {
        if (is_array($proof)) {
            $proof = json_encode($proof);
        }

        $owner = $this->getOwner();
        $owner->setField('Proof', $proof);
        $owner->write();
    }

    /**
     * @param  FieldList $fields
     * @return void
     */
    public function updateCMSFields(FieldList $fields)
    {
        parent::updateCMSFields($fields);

        $class = get_class($this->getOwner());
        $id = $this->getOwner()->ID;
        $content = sprintf('<p class="verification-field"><a href="/verify/%s/%d">Verifiy</a>', $class, $id);

        $fields->insertBefore('Title', LiteralField::create('verify', $content));
    }

}


1			<?php
2
3			/**
4			* @author Russell Michell 2018 <[email protected]>
5			* @package silverstripe-verifiable
6			*/
7
8			namespace PhpTek\Verifiable\Verify;
9
10			use SilverStripe\ORM\DataExtension;
11			use PhpTek\Verifiable\ORM\Fieldtype\ChainpointProof;
12			use SilverStripe\Forms\FieldList;
13			use SilverStripe\Forms\LiteralField;
14
15			/**
16			* By attaching this extension to any {@link DataObject} subclass and declaring a
17			* $verifiable_fields array in YML config, all subsequent database writes will
18			* be passed through here via {@link $this->onAfterWrite()};
19			*
20			* This {@link DataExtension} also provides a single field to which all verified
21			* and verifiable chainpoint proofs are stored in a queryable JSON-aware field.
22			*
23			* @todo Store the hash function used and if subsequent verifications
24			* fail because differing hash functions are used, throw an exception.
25			* @todo Hard-code "Created" and "LastEdited" fields into "verifiable_fields"
26			* @todo Prevent "Proof" field from ever being configured in verifiable_fields
27			*
28			*/
29			class VerifiableExtension extends DataExtension
30			{
31			/**
32			* Declares a JSON-aware {@link DBField} where all chainpoint proofs are stored.
33			*
34			* @var array
35			* @config
36			*/
37			private static $db = [
			0 ignored issues – show introduced 2018-06-03 10:48 UTC by Report Bug Copy Issue Report The private property `$db` is not used, and could be removed. Loading history...
38			'Proof' => ChainpointProof::class,
39			];
40
41			/**
42			* The field-values that will be hashed and committed to the current backend.
43			*
44			* @var array
45			* @config
46			*/
47			private static $verifiable_fields = [];
			0 ignored issues – show introduced 2018-05-29 09:59 UTC by Report Bug Copy Issue Report The private property `$verifiable_fields` is not used, and could be removed. Loading history...
48
49			/**
50			* Write -->onAfterWrite() recursion prevention.
51			*
52			* @var string
53			*/
54			protected static $has_write_occured = false;
55
56			/**
57			* After each write, data from the $verifiable_fields config is compiled
58			* into a string, hashed and submitted to the current backend.
59			*
60			* Once written, we periodically poll the backend to receive the full
61			* chainpoint proof (it takes time for Bitcoin's PoW confirmations, not so
62			* much for Ethereum).
63			*
64			* We need this "complete" proof for subsequent verification checks
65			* also made against the same backend in the future.
66			*
67			* If only the "Proof" field has been written-to, or no-data is found in the
68			* verifiable_fields, this should not constitute a write that we need to do
69			* anything with, and it's therefore skipped.
70			*
71			* @return void
72			* @todo Add a check into $skipWriteProof for checking _only_ "Proof" having changed.
73			* This should _not_ constitute a change requiting a call to the backend for.
74			*/
75			public function onAfterWrite()
76			{
77			parent::onAfterWrite();
78
79			// Overflow protection should bad recursion occur
80			static $write_count = 0;
81			$write_count++;
82
83			$verifiable = $this->normaliseData();
84			$skipWriteProof = self::$has_write_occured === true \|\| !count($verifiable) \|\| $write_count > 1;
85
86			if ($skipWriteProof) {
87			// Now we fire-off a job to check if verification is complete
88			// TODO: Use AsyncPHP and use a callback OR check if API has a callback
89			// endpoint it can call on our end (Tierion's API does)
90			// $this->verifiableService->queueVerification($this->getOwner());
91
92			return;
93			}
94
95			if ($proofData = $this->verifiableService->write($verifiable)) {
			0 ignored issues – show Bug introduced 2018-06-13 09:41 UTC by Report Bug Copy Issue Report The property `verifiableService` does not exist on `PhpTek\Verifiable\Verify\VerifiableExtension`. Did you mean `verifiable_fields`? Loading history...
96			self::$has_write_occured = true;
			0 ignored issues – show Documentation Bug introduced 2018-06-13 09:41 UTC by Report Bug Copy Issue Report The property `$has_write_occured` was declared of type `string`, but `true` is of type `true`. Maybe add a type cast? This check looks for assignments to scalar types that may be of the wrong type. To ensure the code behaves as expected, it may be a good idea to add an explicit type cast. $answer = 42; $correct = false; $correct = (bool) $answer; Loading history...
97
98			$this->writeProof($proofData);
99			}
100			}
101
102			/**
103			* Normalise this model's data so it's suited to being hashed.
104			*
105			* @return array
106			* @todo use array_reduce()?
107			*/
108			public function normaliseData() : array
109			{
110			$fields = $this->getOwner()->config()->get('verifiable_fields');
111			$verifiable = [];
112
113			foreach ($fields as $field) {
114			$verifiable[] = (string) $this->getOwner()->getField($field);
115			}
116
117			return $verifiable;
118			}
119
120			/**
121			* Passed an array of fields and their values, this method will hash them
122			* and check that a chainpoint proof exists in the local database. If unsuccessful
123			* we return false. Otherwise, we return true.
124			*
125			* If a matching proof is found both locally then the supplied
126			* data is said to have been verified at least once
127			*
128			* @param array $data An array of data to verify against the current backend.
129			* @return mixed null \| ChainpointProof
130			*/
131			public function proofExists(array $data)
132			{
133			$hash = $this->verifiableService->hash($data);
			0 ignored issues – show Bug introduced 2018-06-05 05:57 UTC by Report Bug Copy Issue Report The property `verifiableService` does not exist on `PhpTek\Verifiable\Verify\VerifiableExtension`. Did you mean `verifiable_fields`? Loading history...
134			$proof = $this->getOwner()->dbObject('Proof');
135
136			// Does the passed hash-of-the-data match the hash in the Proof?
137			return $proof->exists() && $proof->getHash() === $hash ? $proof : null;
138			}
139
140			/**
141			* Writes string data that is assumed to be JSON (as returned from a
142			* web-service for example) and saved to this decorated object's "Proof"
143			* field.
144			*
145			* @param mixed $proof
146			* @return void
147			*/
148			public function writeProof($proof)
149			{
150			if (is_array($proof)) {
151			$proof = json_encode($proof);
152			}
153
154			$owner = $this->getOwner();
155			$owner->setField('Proof', $proof);
156			$owner->write();
157			}
158
159			/**
160			* @param FieldList $fields
161			* @return void
162			*/
163			public function updateCMSFields(FieldList $fields)
164			{
165			parent::updateCMSFields($fields);
166
167			$class = get_class($this->getOwner());
168			$id = $this->getOwner()->ID;
169			$content = sprintf('<p class="verification-field"><a href="/verify/%s/%d">Verifiy</a>', $class, $id);
170
171			$fields->insertBefore('Title', LiteralField::create('verify', $content));
172			}
173
174			}
175

phptek / silverstripe-verifiable

Push — master ( 2ce6bc...9c94e5 )

VerifiableExtension::updateCMSFields() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like