App\Console\Installer

Complexity

Total Complexity

22

Size/Duplication

Total Lines	214
Duplicated Lines	0 %

Test Coverage

Coverage

0%

Importance

Changes	1
Bugs	0	Features	0

7 Methods

Rating	Name	Duplication	Size	Complexity
B	setFolderPermissions()	0	55	8
A	setAppNameInFile()	0	19	3
A	createAppLocalConfig()	0	7	2
A	setSecuritySalt()	0	4	1
A	setSecuritySaltInFile()	0	20	3
A	createWritableDirectories()	0	7	3
A	postInstall()	0	15	2

<?php

Filename "Installer.php" doesn't match the expected filename "installer.php"

The PHP open tag does not have a corresponding PHP close tag

Header blocks must be separated by a single blank line

This file is missing a doc comment.

Class found in ".php" file; use ".inc" extension instead

declare(strict_types=1);

/**

The file-level docblock must follow the opening PHP tag in the file header

Inline doc block comments are not allowed; use "/* Comment */" or "// Comment" instead

Block comments must be started with /*

 * CakePHP(tm) : Rapid Development Framework (https://cakephp.org)
 * Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)

Doc comment short description must be on a single line, further text should be a separate paragraph

 *
 * Licensed under The MIT License
 * For full copyright and license information, please see the LICENSE.txt
 * Redistributions of files must retain the above copyright notice.
 *
 * @copyright Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)

@copyright tag must contain a year and the name of the copyright holder

 * @link      https://cakephp.org CakePHP(tm) Project

Tag value indented incorrectly; expected 1 space but found 6

The tag in position 2 should be the @license tag

 * @since     3.0.0

The tag in position 3 should be the @link tag

Tag value indented incorrectly; expected 1 space but found 5

 * @license   https://opensource.org/licenses/mit-license.php MIT License

The tag in position 4 should be the @since tag

Tag value indented incorrectly; expected 1 space but found 3

 */

Missing @author tag in file comment

Missing @package tag in file comment

Missing @category tag in file comment

Header blocks must be separated by a single blank line

PHP version not specified

namespace App\Console;

if (!defined('STDIN')) {

Expected 1 space(s) after NOT operator; 0 found

    define('STDIN', fopen('php://stdin', 'r'));
}

use Cake\Utility\Security;
use Composer\Script\Event;
use Exception;

Non-namespaced classes/interfaces/traits should not be referenced with use statements

/**
 * Provides installation hooks for when this application is installed through
 * composer. Customize this class to suit your needs.

Doc comment short description must be on a single line, further text should be a separate paragraph

 */

Missing @package tag in class comment

Missing @category tag in class comment

Missing @license tag in class comment

Missing @author tag in class comment

Missing @link tag in class comment

class Installer
{

Opening brace should be on the same line as the declaration

Opening brace should be on the same line as the declaration for class Installer

    /**
     * An array of directories to be made writable
     */
    public const WRITABLE_DIRS = [
        'logs',
        'tmp',
        'tmp/cache',
        'tmp/cache/models',
        'tmp/cache/persistent',
        'tmp/cache/views',
        'tmp/sessions',
        'tmp/tests',
    ];

    /**
     * Does some routine installation tasks so people don't have to.
     *
     * @param \Composer\Script\Event $event The composer event object.

Parameter comment must be on the next line

     * @throws \Exception Exception raised by validator.

Separate the @param and @throws sections by a blank line.

@throws comment must be on the next line

     * @return void

If there is no return value for a function, there must not be a @return tag.

Separate the @throws and @return sections by a blank line.

     */
    public static function postInstall(Event $event)
    {

Opening brace should be on the same line as the declaration

        $io = $event->getIO();

        $rootDir = dirname(dirname(__DIR__));

        static::createAppLocalConfig($rootDir, $io);
        static::createWritableDirectories($rootDir, $io);

        static::setFolderPermissions($rootDir, $io);
        static::setSecuritySalt($rootDir, $io);

        $class = 'Cake\Codeception\Console\Installer';
        if (class_exists($class)) {
            $class::customizeCodeceptionBinary($event);
        }
    }

    /**
     * Create config/app_local.php file if it does not exist.
     *
     * @param string $dir The application's root directory.

Parameter comment must be on the next line

Expected 19 spaces after parameter type; 1 found

     * @param \Composer\IO\IOInterface $io IO interface to write to console.

Parameter comment must be on the next line

Expected 2 spaces after parameter name; 1 found

     * @return void

Separate the @param and @return sections by a blank line.

If there is no return value for a function, there must not be a @return tag.

     */
    public static function createAppLocalConfig($dir, $io)

Type hint "\Composer\IO\IOInterface" missing for $io

Type hint "string" missing for $dir

    {

Opening brace should be on the same line as the declaration

        $appLocalConfig = $dir . '/config/app_local.php';

Equals sign not aligned with surrounding assignments; expected 9 spaces but found 1 space

        $appLocalConfigTemplate = $dir . '/config/app_local.example.php';
        if (!file_exists($appLocalConfig)) {

Expected 1 space(s) after NOT operator; 0 found

            copy($appLocalConfigTemplate, $appLocalConfig);
            $io->write('Created `config/app_local.php` file');
        }
    }

    /**
     * Create the `logs` and `tmp` directories.
     *
     * @param string $dir The application's root directory.

Parameter comment must be on the next line

Expected 19 spaces after parameter type; 1 found

     * @param \Composer\IO\IOInterface $io IO interface to write to console.

Parameter comment must be on the next line

Expected 2 spaces after parameter name; 1 found

     * @return void

If there is no return value for a function, there must not be a @return tag.

Separate the @param and @return sections by a blank line.

     */
    public static function createWritableDirectories($dir, $io)

Type hint "string" missing for $dir

Type hint "\Composer\IO\IOInterface" missing for $io

    {

Opening brace should be on the same line as the declaration

        foreach (static::WRITABLE_DIRS as $path) {
            $path = $dir . '/' . $path;
            if (!file_exists($path)) {

Expected 1 space(s) after NOT operator; 0 found

                mkdir($path);
                $io->write('Created `' . $path . '` directory');
            }
        }
    }

    /**
     * Set globally writable permissions on the "tmp" and "logs" directory.
     *
     * This is not the most secure default, but it gets people up and running quickly.

Line exceeds 80 characters; contains 86 characters

     *
     * @param string $dir The application's root directory.

Parameter comment must be on the next line

Expected 19 spaces after parameter type; 1 found

     * @param \Composer\IO\IOInterface $io IO interface to write to console.

Expected 2 spaces after parameter name; 1 found

Parameter comment must be on the next line

     * @return void

Separate the @param and @return sections by a blank line.

If there is no return value for a function, there must not be a @return tag.

     */
    public static function setFolderPermissions($dir, $io)

Type hint "string" missing for $dir

Type hint "\Composer\IO\IOInterface" missing for $io

    {

Opening brace should be on the same line as the declaration

        // ask if the permissions should be changed

Inline comments must end in full-stops, exclamation marks, question marks, colons, or closing parentheses

Inline comments must end in full-stops, exclamation marks, or question marks

Inline comments must start with a capital letter

        if ($io->isInteractive()) {
            $validator = function ($arg) {

Equals sign not aligned with surrounding assignments; expected 12 spaces but found 1 space

                if (in_array($arg, ['Y', 'y', 'N', 'n'])) {
                    return $arg;
                }

No blank line found after control structure

                throw new Exception('This is not a valid answer. Please choose Y or n.');
            };
            $setFolderPermissions = $io->askAndValidate(
                '<info>Set Folder Permissions ? (Default to Y)</info> [<comment>Y,n</comment>]? ',
                $validator,
                10,
                'Y'
            );

            if (in_array($setFolderPermissions, ['n', 'N'])) {
                return;
            }
        }

        // Change the permissions on a path and output the results.
        $changePerms = function ($path) use ($io) {
            $currentPerms = fileperms($path) & 0777;

Operation must be bracketed

Equals sign not aligned with surrounding assignments; expected 2 spaces but found 1 space

            $worldWritable = $currentPerms | 0007;

Operation must be bracketed

            if ($worldWritable == $currentPerms) {

Operator == prohibited; use === instead

                return;
            }

            $res = chmod($path, $worldWritable);
            if ($res) {
                $io->write('Permissions set on ' . $path);
            } else {

Expected newline after closing brace

                $io->write('Failed to set permissions on ' . $path);
            }
        };

        $walker = function ($dir) use (&$walker, $changePerms) {
            $files = array_diff(scandir($dir), ['.', '..']);
            foreach ($files as $file) {
                $path = $dir . '/' . $file;

                if (!is_dir($path)) {

Expected 1 space(s) after NOT operator; 0 found

                    continue;
                }

                $changePerms($path);
                $walker($path);
            }
        };

        $walker($dir . '/tmp');
        $changePerms($dir . '/tmp');
        $changePerms($dir . '/logs');
    }

    /**
     * Set the security.salt value in the application's config file.
     *
     * @param string $dir The application's root directory.

Parameter comment must be on the next line

Expected 19 spaces after parameter type; 1 found

     * @param \Composer\IO\IOInterface $io IO interface to write to console.

Parameter comment must be on the next line

Expected 2 spaces after parameter name; 1 found

     * @return void

Separate the @param and @return sections by a blank line.

If there is no return value for a function, there must not be a @return tag.

     */
    public static function setSecuritySalt($dir, $io)

Type hint "string" missing for $dir

Type hint "\Composer\IO\IOInterface" missing for $io

    {

Opening brace should be on the same line as the declaration

        $newKey = hash('sha256', Security::randomBytes(64));
        static::setSecuritySaltInFile($dir, $io, $newKey, 'app_local.php');
    }

    /**
     * Set the security.salt value in a given file
     *
     * @param string $dir The application's root directory.

Expected 19 spaces after parameter type; 1 found

Parameter comment must be on the next line

Expected 4 spaces after parameter name; 1 found

     * @param \Composer\IO\IOInterface $io IO interface to write to console.

Parameter comment must be on the next line

Expected 5 spaces after parameter name; 1 found

     * @param string $newKey key to set in the file

Parameter comment must be on the next line

Expected 19 spaces after parameter type; 1 found

Parameter comment must start with a capital letter

Parameter comment must end with a full stop

     * @param string $file A path to a file relative to the application's root

Parameter comment must end with a full stop

Expected 19 spaces after parameter type; 1 found

Expected 3 spaces after parameter name; 1 found

Parameter comment must be on the next line

     * @return void

Separate the @param and @return sections by a blank line.

If there is no return value for a function, there must not be a @return tag.

     */
    public static function setSecuritySaltInFile($dir, $io, $newKey, $file)

Type hint "string" missing for $dir

Type hint "string" missing for $newKey

Type hint "string" missing for $file

Type hint "\Composer\IO\IOInterface" missing for $io

    {

Opening brace should be on the same line as the declaration

        $config = $dir . '/config/' . $file;

Equals sign not aligned with surrounding assignments; expected 2 spaces but found 1 space

        $content = file_get_contents($config);

        $content = str_replace('__SALT__', $newKey, $content, $count);

        if ($count == 0) {

Operator == prohibited; use === instead

            $io->write('No Security.salt placeholder to replace.');

            return;
        }

        $result = file_put_contents($config, $content);
        if ($result) {
            $io->write('Updated Security.salt value in config/' . $file);

            return;
        }

No blank line found after control structure

        $io->write('Unable to update Security.salt value.');
    }

    /**
     * Set the APP_NAME value in a given file
     *
     * @param string $dir The application's root directory.

Parameter comment must be on the next line

Expected 5 spaces after parameter name; 1 found

Expected 19 spaces after parameter type; 1 found

     * @param \Composer\IO\IOInterface $io IO interface to write to console.

Parameter comment must be on the next line

Expected 6 spaces after parameter name; 1 found

     * @param string $appName app name to set in the file

Expected 19 spaces after parameter type; 1 found

Parameter comment must start with a capital letter

Parameter comment must end with a full stop

Parameter comment must be on the next line

     * @param string $file A path to a file relative to the application's root

Expected 19 spaces after parameter type; 1 found

Expected 4 spaces after parameter name; 1 found

Parameter comment must end with a full stop

Parameter comment must be on the next line

     * @return void

Separate the @param and @return sections by a blank line.

If there is no return value for a function, there must not be a @return tag.

     */
    public static function setAppNameInFile($dir, $io, $appName, $file)

Type hint "string" missing for $appName

Type hint "\Composer\IO\IOInterface" missing for $io

Type hint "string" missing for $dir

Type hint "string" missing for $file

    {

Opening brace should be on the same line as the declaration

        $config = $dir . '/config/' . $file;

Equals sign not aligned with surrounding assignments; expected 2 spaces but found 1 space

        $content = file_get_contents($config);
        $content = str_replace('__APP_NAME__', $appName, $content, $count);

        if ($count == 0) {

Operator == prohibited; use === instead

            $io->write('No __APP_NAME__ placeholder to replace.');

            return;
        }

        $result = file_put_contents($config, $content);
        if ($result) {
            $io->write('Updated __APP_NAME__ value in config/' . $file);

            return;
        }

No blank line found after control structure

        $io->write('Unable to update __APP_NAME__ value.');
    }

Expected 1 blank line after function; 0 found

}