LaravelPlus\Extension\Console\TailCommand

Complexity

Total Complexity

20

Size/Duplication

Total Lines	169
Duplicated Lines	29.59 %

Coupling/Cohesion

Components	1
Dependencies	4

Test Coverage

Coverage

84.75%

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	tailLocalLogs()	10	10	1
A	getRemotePath()	0	4	1
A	getRoot()	0	4	1
A	getRemote()	0	4	1
C	handle()	0	32	7
A	getLocalPath()	15	15	4
A	getRemotePathFromStorage()	15	15	4
A	tailRemoteLogs()	10	10	1

<?php

namespace LaravelPlus\Extension\Console;

use Illuminate\Console\Command;
use Symfony\Component\Process\Process;
use Carbon\Carbon;

class TailCommand extends Command
{
    /**
     * The console command signature.
     *
     * @var string
     */
    protected $signature = 'tail
        {connection? : The name of remote.}
        {--path= : The fully qualified path to the log file.}
        {--lines=20 : The number of lines to tail.}
    ';

    /**
     * The console command description.
     *
     * @var string
     */
    protected $description = '[+] Tail a log file';

    /**
     * Execute the console command.
     */
    public function handle()
    {
        // syslog not support
        if ($this->laravel['config']['app.log'] === 'syslog') {
            $this->error('syslog not support.');

            return;
        }

        $connection = $this->argument('connection');

        // on Local
        if (is_null($connection)) {
            $path = $this->option('path') ?: $this->getLocalPath();

            if ($path) {
                $this->tailLocalLogs($path);

It seems like $path defined by $this->option('path') ?: $this->getLocalPath() on line 45 can also be of type array; however, LaravelPlus\Extension\Console\TailCommand::tailLocalLogs() does only seem to accept string, maybe add an additional type check?

            } else {
                $this->error('Could not determine path to log file.');
            }
        }
        // on Remote
        else {
            $path = $this->option('path') ?: $this->getRemotePath($connection);

It seems like $connection defined by $this->argument('connection') on line 41 can also be of type array; however, LaravelPlus\Extension\Console\TailCommand::getRemotePath() does only seem to accept string, maybe add an additional type check?

            if ($path) {
                $this->tailRemoteLogs($path, $connection);

It seems like $path defined by $this->option('path') ?: $this->getRemotePath($connection) on line 55 can also be of type array; however, LaravelPlus\Extension\Console\TailCommand::tailRemoteLogs() does only seem to accept string, maybe add an additional type check?

It seems like $connection defined by $this->argument('connection') on line 41 can also be of type array; however, LaravelPlus\Extension\Console\TailCommand::tailRemoteLogs() does only seem to accept string, maybe add an additional type check?

            } else {
                $this->error('Could not determine path to log file.');
            }
        }
    }

    /**
     * Get the path to the Laravel log file.
     *
     * @return string
     */
    protected function getLocalPath()
    {
        switch ($this->laravel['config']['app.log']) {
        case 'single':
            return storage_path('logs/laravel.log');

        case 'daily':
            $date = Carbon::today()->format('Y-m-d');

            return storage_path("logs/laravel-{$date}.log");

        case 'syslog':
            throw new \RuntimeException('syslog not support');
        }
    }

    /**
     * Tail a local log file for the application.
     *
     * @param string $path
     *
     * @return string
     */
    protected function tailLocalLogs($path)
    {
        $output = $this->output;

        $lines = $this->option('lines');

        (new Process('tail -f -n '.$lines.' '.escapeshellarg($path)))->setTimeout(null)->run(function ($type, $line) use ($output) {
            $output->write($line);
        });
    }

    /**
     * Get the path to the Laravel log file.
     *
     * @param string $connection
     *
     * @return string
     */
    protected function getRemotePath($connection)
    {
        return $this->getRoot($connection).str_replace(base_path(), '', $this->getRemotePathFromStorage());
    }

    /**
     * Get the path to the Laravel log file.
     *
     * @return string
     */
    protected function getRemotePathFromStorage()
    {
        switch ($this->laravel['config']['app.log']) {
        case 'single':
            return storage_path('logs/laravel.log');

        case 'daily':
            $date = Carbon::today()->format('Y-m-d');

            return storage_path("logs/laravel-{$date}.log");

        case 'syslog':
            throw new \RuntimeException('syslog not support');
        }
    }

    /**
     * Get the path to the Laravel install root.
     *
     * @param string $connection
     *
     * @return string
     */
    protected function getRoot($connection)
    {
        return $this->laravel['config']['remote.connections.'.$connection.'.root'];
    }

    /**
     * Tail a remote log file at the given path and connection.
     *
     * @param string $path
     * @param string $connection
     */
    protected function tailRemoteLogs($path, $connection)
    {
        $out = $this->output;

        $lines = $this->option('lines');

        $this->getRemote($connection)->run('tail -f -n '.$lines.' '.escapeshellarg($path), function ($line) use ($out) {
            $out->write($line);
        });
    }

    /**
     * Get a connection to the remote server.
     *
     * @param string $connection
     *
     * @return \Illuminate\Remote\Connection
     */
    protected function getRemote($connection)
    {
        return $this->laravel['remote']->connection($connection);
    }
}