You are here

Home » API reference » System Status 8.2 » SystemStatusController.php

class SystemStatusController in System Status 8.2

Same name and namespace in other branches
  1. 8 src/Controller/SystemStatusController.php \Drupal\system_status\Controller\SystemStatusController

Returns responses for Sensei's Pants routes.

Hierarchy

Expanded class hierarchy of SystemStatusController

File

src/Controller/SystemStatusController.php, line 17

Namespace

Drupal\system_status\Controller
View source 
class SystemStatusController extends ControllerBase {

  /**
   * The module handler.
   *
   * @var \Drupal\Core\Extension\ModuleHandlerInterface
   */
  protected $moduleHandler;

  /**
   * The theme handler.
   *
   * @var \Drupal\Core\Extension\ThemeHandlerInterface
   */
  protected $themeHandler;

  /**
   * The system status encrypt service.
   *
   * @var \Drupal\system_status\Services\SystemStatusEncryption
   */
  protected $encrypt;

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('module_handler'), $container
      ->get('theme_handler'), $container
      ->get('system_status.encrypt'));
  }

  /**
   * SystemStatusController constructor.
   *
   * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
   *   The module handler to invoke the alter hook with.
   * @param \Drupal\Core\Extension\ThemeHandlerInterface $theme_handler
   *   The theme handler.
   * @param \Drupal\system_status\Services\SystemStatusEncryption $encrypt
   *   The System Status encrypt.
   */
  public function __construct(ModuleHandlerInterface $module_handler, ThemeHandlerInterface $theme_handler, SystemStatusEncryption $encrypt) {
    $this->moduleHandler = $module_handler;
    $this->themeHandler = $theme_handler;
    $this->encrypt = $encrypt;
  }

  /**
   * Changes Sensei's pants and returns the display of the new status.
   */
  public function load($system_status_token) {

    // Needless initialisation, but hey.
    $res = [
      "core" => [],
      "contrib" => [],
      "theme" => [],
    ];
    $drupal_modules = $this->moduleHandler
      ->getModuleList();
    $drupal_themes = $this->themeHandler
      ->listInfo();
    foreach ($drupal_modules as $name => $module) {
      $filename = $module
        ->getPath() . '/' . $module
        ->getFilename();
      $module_info = Yaml::decode(file_get_contents($filename));

      // This can happen when you install using composer.
      if (isset($module_info['version']) && $module_info['version'] == "VERSION") {
        $module_info['version'] = \Drupal::VERSION;
      }
      if (!isset($module_info['version'])) {
        $module_info['version'] = NULL;
      }

      // Do our best to guess the correct drupal version.
      if ($name == "system" && $module_info['package'] == "Core") {
        $res['core']['drupal'] = [
          "version" => $module_info['version'],
        ];
      }

      // Skip Core and Field types.
      if (isset($module_info['package']) && $module_info['package'] == "Core" || isset($module_info['package']) && $module_info['package'] == "Field types" || isset($module_info['project']) && $module_info['project'] == 'drupal') {
        continue;
      }

      // TODO:
      // if(!isset($module['version']))
      // we can be 90% sure it's not contrib, so we can put it in custom
      // hard to test as system_status is not released yet so no version
      // let's put all the rest in 'contrib' for now.
      if (isset($module_info['project'])) {
        $res['contrib'][$module_info['project']] = [
          "version" => $module_info['version'],
        ];
      }
      else {
        $res['contrib'][$name] = [
          "version" => $module_info['version'],
        ];
      }
    }
    foreach ($drupal_themes as $name => $theme) {
      $filename = $theme
        ->getPath() . '/' . $theme
        ->getFilename();
      $theme_info = Yaml::decode(file_get_contents($filename));
      if (!isset($theme_info['version'])) {
        $theme_info['version'] = NULL;
      }

      // This can happen when you install using composer.
      if ($theme_info['version'] == "VERSION") {
        $theme_info['version'] = \Drupal::VERSION;
      }
      if (isset($theme_info['project']) && $theme_info['project'] == 'drupal') {
        continue;
      }
      if (isset($theme_info['project'])) {
        $res['theme'][$theme_info['project']] = [
          "version" => $theme_info['version'],
        ];
      }
      else {
        $res['theme'][$name] = [
          "version" => $theme_info['version'],
        ];
      }
    }
    $config = $this
      ->config('system_status.settings');
    if (function_exists('openssl_random_pseudo_bytes')) {
      $res = SystemStatusEncryption::encryptOpenssl(json_encode([
        "system_status" => $res,
      ]));
      return new JsonResponse([
        "system_status" => "encrypted_openssl",
        "data" => $res,
        "drupal_version" => "8",
        "engine_version" => "DRUPAL8",
        "php_version" => phpversion(),
      ]);
    }
    elseif (extension_loaded('mcrypt')) {
      $res = SystemStatusEncryption::encryptMcrypt(json_encode([
        "system_status" => $res,
      ]));
      return new JsonResponse([
        "system_status" => "encrypted",
        "data" => $res,
        "drupal_version" => "8",
        "engine_version" => "DRUPAL8",
        "php_version" => phpversion(),
      ]);
    }
    else {
      return new JsonResponse([
        "system_status" => $res,
        "drupal_version" => "8",
        "engine_version" => "DRUPAL8",
        "php_version" => phpversion(),
      ]);
    }
  }

  /**
   * {@inheritdoc}
   */
  public function access($system_status_token) {
    $token = $this
      ->config('system_status.settings')
      ->get('system_status_token');
    if ($token == $system_status_token) {
      return AccessResult::allowed();
    }
    else {
      return AccessResult::forbidden();
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ControllerBase::$configFactory protected property The configuration factory.
ControllerBase::$currentUser protected property The current user service. 1
ControllerBase::$entityFormBuilder protected property The entity form builder.
ControllerBase::$entityManager protected property The entity manager.
ControllerBase::$entityTypeManager protected property The entity type manager.
ControllerBase::$formBuilder protected property The form builder. 2
ControllerBase::$keyValue protected property The key-value storage. 1
ControllerBase::$languageManager protected property The language manager. 1
ControllerBase::$stateService protected property The state service.
ControllerBase::cache protected function Returns the requested cache bin.
ControllerBase::config protected function Retrieves a configuration object.
ControllerBase::container private function Returns the service container.
ControllerBase::currentUser protected function Returns the current user. 1
ControllerBase::entityFormBuilder protected function Retrieves the entity form builder.
ControllerBase::entityManager Deprecated protected function Retrieves the entity manager service.
ControllerBase::entityTypeManager protected function Retrieves the entity type manager.
ControllerBase::formBuilder protected function Returns the form builder service. 2
ControllerBase::keyValue protected function Returns a key/value storage collection. 1
ControllerBase::languageManager protected function Returns the language manager service. 1
ControllerBase::moduleHandler protected function Returns the module handler. 2
ControllerBase::redirect protected function Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
ControllerBase::state protected function Returns the state storage service.
LinkGeneratorTrait::$linkGenerator protected property The link generator. 1
LinkGeneratorTrait::getLinkGenerator Deprecated protected function Returns the link generator.
LinkGeneratorTrait::l Deprecated protected function Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated public function Sets the link generator service.
LoggerChannelTrait::$loggerFactory protected property The logger channel factory service.
LoggerChannelTrait::getLogger protected function Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory public function Injects the logger channel factory.
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 1
RedirectDestinationTrait::getDestinationArray protected function Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination protected function Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination public function Sets the redirect destination service.
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.
SystemStatusController::$encrypt protected property The system status encrypt service.
SystemStatusController::$moduleHandler protected property The module handler. Overrides ControllerBase::$moduleHandler
SystemStatusController::$themeHandler protected property The theme handler.
SystemStatusController::access public function
SystemStatusController::create public static function Instantiates a new instance of this class. Overrides ControllerBase::create
SystemStatusController::load public function Changes Sensei's pants and returns the display of the new status.
SystemStatusController::__construct public function SystemStatusController constructor.
UrlGeneratorTrait::$urlGenerator protected property The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated protected function Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated public function Sets the URL generator service.
UrlGeneratorTrait::url Deprecated protected function Generates a URL or path for a specific route based on the given parameters.