Database::read() - Code Metrics - Inspection of "Updated readme.md" - johnnymast/redbox-scan - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 934cdf...8f45fc )

by Johnny

created 2015-12-27 16:43 UTC

Database::read() A

↳ Parent: Database

Complexity

Conditions	2
Paths	2

Size

Total Lines	8
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Metric	Value
dl	0
loc	8
rs	9.4286
cc	2
eloc	6
nc	2
nop	0

<?php
require '../vendor/autoload.php';
use Redbox\Scan\Adapter;
use Redbox\Scan\Report\Report;

/**
 * First of all don't get intimidated by the number of lines in this example its mostly the database that
 * takes the numbers. In this example i will show you how to write a basic custom adapter using
 * read() and write() functions from the interface. This example will read and write it's data from a database so it can
 * be processed in index() and scan() on the ScanService.
 *
 * PS: I i do recommend you running this from a browser.
 *
 * Step 1.
 *  - Import assest/data.sql
 *
 * Step 2.
 *  - Change the database access settings
 *
 * Step 3.
 * = Run the code
 */

/**
 * Let me exampling about this database class. This class is not production ready its just
 * a really simple wrapper around a sample database.
 *
 * Class Database
 */
class Database extends \mysqli implements Adapter\AdapterInterface
{
    CONST SCAN_ID = 1;

    public function __construct($host, $user, $pass, $db)
    {
        $this->connect($host, $user, $pass, $db);
    }

    /**
     * This class uses just one main scan record all the time. This is ID 1 (SCAN_ID) and contains the main information
     * about our scan name/date etc..
     *
     * @return array|bool
     */
    private function getScan()
    {
        $sql = sprintf("SELECT *, scandate as `date` FROM `scan` WHERE `id`='%s'", self::SCAN_ID);
        $result = $this->query($sql);
        if ($result) {
            return $result->fetch_assoc();
        }
        return false;
    }

    /**
     * Return the file items that have been stored prior to a scan action. These results are previously saved
     * via the write write() method.
     *
     * @return array
     */
    private function getReportItems()
    {
        $items = array();
        $sql = sprintf("SELECT * FROM `scanitems` WHERE `scanid`='%s'", self::SCAN_ID);
        $result = $this->query($sql);
        if ($result) {
            while ($item = $result->fetch_object()) {
                if (isset($items[$item->itemfolder]) === false)
                    $items[$item->itemfolder] = array();

                $items[$item->itemfolder][$item->itemname] = $item->md5hash;
            }
        }
        return $items;
    }

    /**
     * Read the previous scan results from the file system.
     *
     * @return bool|Report
     */
    public function read() {
        $scan = $this->getScan();
        if (is_array($scan) === true) {
            $scan['items'] = $this->getReportItems();
            return Report::fromArray($scan);
        }
        return false;
    }

    /**
     * Write the report to the filesystem so we can reuse it
     * at a later stace when we invoke Redbox\Scan\ScanService's scan() method.
     *
     * @param Report|null $report
     * @return bool
     */
    public function write(Report $report = null) {

        if ($report) {
            $scandata = array(
                'name' => $report->getName(),
                'path' => $report->getPath(),
            );

            /* Step 1. Update the scan. */
            $sql = sprintf("UPDATE `scan` SET `name`='%s', `path`='%s', `scandate`=NOW()", $this->real_escape_string($scandata['name']), $this->real_escape_string($scandata['path']));
            $this->query($sql);

            if ($this->affected_rows > 0) {
                $items = $report->getItems();
                if (count($items) > 0) {

                    /* Step 2. Delete old items */
                    $sql = sprintf("DELETE FROM `scanitems` WHERE `scanid`='%s'", self::SCAN_ID);
                    $this->query($sql);


                    /* Step 3. Insert the new items */
                    foreach($items as $path => $item) {
                        foreach ($item as $filename => $md5hash) {
                            $sql = sprintf("INSERT INTO `scanitems` SET `scanid`='%s', `itemfolder`='%s', `itemname`='%s', `md5hash`='%s'",
                                self::SCAN_ID,
                                $this->real_escape_string($path),
                                $this->real_escape_string($filename),
                                $this->real_escape_string($md5hash)

                            );
                           $this->query($sql);
                        }
                    }
                }
            }
            return false;
        }
        return false;
    }

}

if (class_exists('mysqli')) {

    try {

        $path = dirname(__FILE__)."/assets";
        $tmpfile  = $path.'/new.tmp';
        $timefile = $path.'/time.txt';

        $databaseAdapter = new Database(
            "localhost",
            "root",
            "root",
            "scan"
        );

        /**
         * Oke lets instantiate a new service and scan the assets folder inside
         * our current folder and write the data.yml file to the filesystem using the Filesystem adapter.
         */
        $scan = new Redbox\Scan\ScanService($databaseAdapter);
        $scan->index($path, 'Basic scan', date("Y-m-d H:i:s"));

        /**
         * After indexing the directory let's create a new file and update an other so
         * we can see if the filesystem picks it up.
         */
        file_put_contents($tmpfile,'Hello world');
        file_put_contents($timefile, time());


        /**
         * Oke the changes have been made lets scan the assets directory again for changes.
         */
        $report = $scan->scan();

        /**
         * Revert our actions.
         */
        unlink($tmpfile);

        /**
         * Output the changes since index action.
         */
        if(php_sapi_name() == "cli") {

            echo "New files\n\n";
            foreach ($report->getNewfiles() as $file) {
                echo $file->getFilename().' '.Redbox\Scan\Filesystem\FileInfo::getFileHash($file->getRealPath())."\n";
            }

            echo "\nModified Files\n\n";
            foreach ($report->getModifiedFiles() as $file) {
                echo $file->getFilename().' '.Redbox\Scan\Filesystem\FileInfo::getFileHash($file->getRealPath())."\n";
            }
            echo "\n";

        } else {

            echo '<h1>New files</h1>';
            foreach ($report->getNewfiles() as $file) {
                echo '<li>'.$file->getFilename().' '.Redbox\Scan\Filesystem\FileInfo::getFileHash($file->getRealPath()).'</li>';
            }
            echo '</ul>';

            echo '<h1>Modified Files</h1>';
            foreach ($report->getModifiedFiles() as $file) {
                echo '<li>'.$file->getFilename().' '.Redbox\Scan\Filesystem\FileInfo::getFileHash($file->getRealPath()).'</li>';
            }
            echo '</ul>';
        }

    } catch (Exception $e) {
        print '<pre>';
        print_r($e);
        print '</pre>';
    }

} else {
    die('This example requires mysqli to be loaded.');
}

1			<?php
2			require '../vendor/autoload.php';
3			use Redbox\Scan\Adapter;
4			use Redbox\Scan\Report\Report;
5
6			/**
7			* First of all don't get intimidated by the number of lines in this example its mostly the database that
8			* takes the numbers. In this example i will show you how to write a basic custom adapter using
9			* read() and write() functions from the interface. This example will read and write it's data from a database so it can
10			* be processed in index() and scan() on the ScanService.
11			*
12			* PS: I i do recommend you running this from a browser.
13			*
14			* Step 1.
15			* - Import assest/data.sql
16			*
17			* Step 2.
18			* - Change the database access settings
19			*
20			* Step 3.
21			* = Run the code
22			*/
23
24			/**
25			* Let me exampling about this database class. This class is not production ready its just
26			* a really simple wrapper around a sample database.
27			*
28			* Class Database
29			*/
30			class Database extends \mysqli implements Adapter\AdapterInterface
31			{
32			CONST SCAN_ID = 1;
33
34			public function __construct($host, $user, $pass, $db)
35			{
36			$this->connect($host, $user, $pass, $db);
37			}
38
39			/**
40			* This class uses just one main scan record all the time. This is ID 1 (SCAN_ID) and contains the main information
41			* about our scan name/date etc..
42			*
43			* @return array\|bool
44			*/
45			private function getScan()
46			{
47			$sql = sprintf("SELECT *, scandate as `date` FROM `scan` WHERE `id`='%s'", self::SCAN_ID);
48			$result = $this->query($sql);
49			if ($result) {
50			return $result->fetch_assoc();
51			}
52			return false;
53			}
54
55			/**
56			* Return the file items that have been stored prior to a scan action. These results are previously saved
57			* via the write write() method.
58			*
59			* @return array
60			*/
61			private function getReportItems()
62			{
63			$items = array();
64			$sql = sprintf("SELECT * FROM `scanitems` WHERE `scanid`='%s'", self::SCAN_ID);
65			$result = $this->query($sql);
66			if ($result) {
67			while ($item = $result->fetch_object()) {
68			if (isset($items[$item->itemfolder]) === false)
69			$items[$item->itemfolder] = array();
70
71			$items[$item->itemfolder][$item->itemname] = $item->md5hash;
72			}
73			}
74			return $items;
75			}
76
77			/**
78			* Read the previous scan results from the file system.
79			*
80			* @return bool\|Report
81			*/
82			public function read() {
83			$scan = $this->getScan();
84			if (is_array($scan) === true) {
85			$scan['items'] = $this->getReportItems();
86			return Report::fromArray($scan);
87			}
88			return false;
89			}
90
91			/**
92			* Write the report to the filesystem so we can reuse it
93			* at a later stace when we invoke Redbox\Scan\ScanService's scan() method.
94			*
95			* @param Report\|null $report
96			* @return bool
97			*/
98			public function write(Report $report = null) {
99
100			if ($report) {
101			$scandata = array(
102			'name' => $report->getName(),
103			'path' => $report->getPath(),
104			);
105
106			/* Step 1. Update the scan. */
107			$sql = sprintf("UPDATE `scan` SET `name`='%s', `path`='%s', `scandate`=NOW()", $this->real_escape_string($scandata['name']), $this->real_escape_string($scandata['path']));
108			$this->query($sql);
109
110			if ($this->affected_rows > 0) {
111			$items = $report->getItems();
112			if (count($items) > 0) {
113
114			/* Step 2. Delete old items */
115			$sql = sprintf("DELETE FROM `scanitems` WHERE `scanid`='%s'", self::SCAN_ID);
116			$this->query($sql);
117
118
119			/* Step 3. Insert the new items */
120			foreach($items as $path => $item) {
121			foreach ($item as $filename => $md5hash) {
122			$sql = sprintf("INSERT INTO `scanitems` SET `scanid`='%s', `itemfolder`='%s', `itemname`='%s', `md5hash`='%s'",
123			self::SCAN_ID,
124			$this->real_escape_string($path),
125			$this->real_escape_string($filename),
126			$this->real_escape_string($md5hash)
127
128			);
129			$this->query($sql);
130			}
131			}
132			}
133			}
134			return false;
135			}
136			return false;
137			}
138
139			}
140
141			if (class_exists('mysqli')) {
142
143			try {
144
145			$path = dirname(__FILE__)."/assets";
146			$tmpfile = $path.'/new.tmp';
147			$timefile = $path.'/time.txt';
148
149			$databaseAdapter = new Database(
150			"localhost",
151			"root",
152			"root",
153			"scan"
154			);
155
156			/**
157			* Oke lets instantiate a new service and scan the assets folder inside
158			* our current folder and write the data.yml file to the filesystem using the Filesystem adapter.
159			*/
160			$scan = new Redbox\Scan\ScanService($databaseAdapter);
161			$scan->index($path, 'Basic scan', date("Y-m-d H:i:s"));
162
163			/**
164			* After indexing the directory let's create a new file and update an other so
165			* we can see if the filesystem picks it up.
166			*/
167			file_put_contents($tmpfile,'Hello world');
168			file_put_contents($timefile, time());
169
170
171			/**
172			* Oke the changes have been made lets scan the assets directory again for changes.
173			*/
174			$report = $scan->scan();
175
176			/**
177			* Revert our actions.
178			*/
179			unlink($tmpfile);
180
181			/**
182			* Output the changes since index action.
183			*/
184			if(php_sapi_name() == "cli") {
185
186			echo "New files\n\n";
187			foreach ($report->getNewfiles() as $file) {
188			echo $file->getFilename().' '.Redbox\Scan\Filesystem\FileInfo::getFileHash($file->getRealPath())."\n";
189			}
190
191			echo "\nModified Files\n\n";
192			foreach ($report->getModifiedFiles() as $file) {
193			echo $file->getFilename().' '.Redbox\Scan\Filesystem\FileInfo::getFileHash($file->getRealPath())."\n";
194			}
195			echo "\n";
196
197			} else {
198
199			echo '<h1>New files</h1>';
200			foreach ($report->getNewfiles() as $file) {
201			echo '<li>'.$file->getFilename().' '.Redbox\Scan\Filesystem\FileInfo::getFileHash($file->getRealPath()).'</li>';
202			}
203			echo '</ul>';
204
205			echo '<h1>Modified Files</h1>';
206			foreach ($report->getModifiedFiles() as $file) {
207			echo '<li>'.$file->getFilename().' '.Redbox\Scan\Filesystem\FileInfo::getFileHash($file->getRealPath()).'</li>';
208			}
209			echo '</ul>';
210			}
211
212			} catch (Exception $e) {
213			print '<pre>';
214			print_r($e);
215			print '</pre>';
216			}
217
218			} else {
219			die('This example requires mysqli to be loaded.');
220			}

johnnymast / redbox-scan

Push — master ( 934cdf...8f45fc )

Database::read() A

Complexity

Size

Duplication

Duplication Side-by-Side

Filter issues like