Startwind\Inventorio\Collector\OperatingSystem\OperatingSystemCollector

Complexity

Total Complexity

14

Size/Duplication

Total Lines	93
Duplicated Lines	0 %

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	collect()	0	16	2
A	getOsVersion()	0	10	3
A	getOsDistribution()	0	4	1
A	getIdentifier()	0	3	1
A	getOsFamily()	0	11	4
A	getLinuxOsInfo()	0	13	3

<?php

namespace Startwind\Inventorio\Collector\OperatingSystem;

use Startwind\Inventorio\Collector\Collector;
use Startwind\Inventorio\Exec\Runner;
use Startwind\Inventorio\Exec\System;

/**
 * This collector returns details about the operating system.
 *
 * - family: the OS family (MacOs, Linux, Windows). Please use the provided constants.
 * - version: the OS version
 *
 */
class OperatingSystemCollector implements Collector
{
    public const OS_FAMILY_MAC = 'macos';
    public const OS_FAMILY_LINUX = 'linux';
    public const OS_FAMILY_WINDOWS = 'windows';
    public const OS_FAMILY_UNKNOWN = 'unknown';
    public const OS_VERSION_UNKNOWN = 'unknown';

    protected const COLLECTION_IDENTIFIER = 'OperatingSystem';

    /**
     * @inheritDoc
     */
    public function getIdentifier(): string
    {
        return self::COLLECTION_IDENTIFIER;
    }

    /**
     * @inheritDoc
     */
    public function collect(): array
    {
        // return ['family' => 'linux', 'distribution' => "Ubuntu", 'version' => '18.4'];

        $osFamily = self::getOsFamily();

        $data = [
            'family' => $osFamily,
            'version' => $this->getOsVersion($osFamily)
        ];

        if ($osFamily == self::OS_FAMILY_LINUX) {
            $data['distribution'] = $this->getOsDistribution();
        }

        return $data;
    }

    /**
     * Return the version of the operating system
     */
    private function getOsVersion(string $family): string
    {
        switch ($family) {
            case self::OS_FAMILY_MAC:
                return trim(Runner::getInstance()->run('sw_vers -productVersion')->getOutput());
            case self::OS_FAMILY_LINUX:
                $osInfo = $this->getLinuxOsInfo();
                return $osInfo['VERSION_ID'];
            default:
                return self::OS_VERSION_UNKNOWN;
        }
    }

    /**
     * Return the distribution of the linux operating system
     */
    private function getOsDistribution(): string
    {
        $osInfo = $this->getLinuxOsInfo();
        return $osInfo['NAME'];
    }

    public function getLinuxOsInfo(): array
    {
        $osRelease = Runner::getInstance()->getFileContents('/etc/os-release');
        $lines = explode("\n", $osRelease);
        $osInfo = array();
        foreach ($lines as $line) {
            if (str_contains($line, "=")) {
                list($key, $value) = explode("=", $line, 2);
                $value = trim($value, '"');
                $osInfo[$key] = $value;
            }
        }
        return $osInfo;
    }

    /**
     * Return the operating system family (supported: MacOs, Windows, Linux)
     */
    public static function getOsFamily(): string
    {
        switch (strtolower(System::getInstance()->getPlatform())) {
            case 'darwin':
                return self::OS_FAMILY_MAC;
            case 'linux';
                return self::OS_FAMILY_LINUX;
            case 'windows':
                return self::OS_FAMILY_WINDOWS;
            default:
                return self::OS_FAMILY_UNKNOWN;
        }
    }
}