lightning.install

<?php

/**
 * @file
 * Install and uninstall functions for the Lightning installation profile.
 */

use Drupal\Core\Entity\Entity\EntityViewDisplay;
use Drupal\field\Entity\FieldConfig;
use Drupal\node\Entity\NodeType;
use Drupal\user\Entity\User;
use Drupal\user\RoleInterface;
use Drupal\shortcut\Entity\Shortcut;

/**
 * Implements hook_install().
 *
 * Perform actions to set up the site for Lightning Profile.
 *
 * @see system_install()
 */
function lightning_install() {
  // Set front page to "node".
  \Drupal::configFactory()
    ->getEditable('system.site')
    ->set('page.front', '/node')
    ->save(TRUE);

  // Restrict user registration to admin role creation.
  \Drupal::configFactory()
    ->getEditable('user.settings')
    ->set('register', USER_REGISTER_ADMINISTRATORS_ONLY)
    ->save(TRUE);

  // Assign user 1 the "administrator" role.
  $user = User::load(1);
  $user->roles[] = 'administrator';
  $user->save();

  // Allow authenticated users to use shortcuts.
  user_role_grant_permissions(RoleInterface::AUTHENTICATED_ID, ['access shortcuts']);

  // Populate the default shortcut set.
  Shortcut::create(
    [
      'shortcut_set' => 'default',
      'title' => t('Content library'),
      'weight' => 1,
      'link' => ['uri' => 'internal:/admin/content'],
    ]
  )->save();
  Shortcut::create(
    [
      'shortcut_set' => 'default',
      'title' => t('Media library'),
      'weight' => 2,
      'link' => ['uri' => 'internal:/admin/content/media'],
    ]
  )->save();

  // Set the default and admin theme.
  \Drupal::configFactory()
    ->getEditable('system.theme')
    ->set('default', 'bartik')
    ->set('admin', 'seven')
    ->save(TRUE);

  // Enable the admin theme.
  \Drupal::configFactory()
    ->getEditable('node.settings')
    ->set('use_admin_theme', TRUE)
    ->save(TRUE);

  // Set the path to the logo, favicon and README file based on install
  // directory.
  $lightning_path = drupal_get_path('profile', 'lightning');
  \Drupal::configFactory()
    ->getEditable('system.theme.global')
    ->set('logo', [
      'path' => $lightning_path . '/lightning.png',
      'url' => '',
      'use_default' => FALSE,
    ])
    ->set('favicon', [
      'mimetype' => 'image/vnd.microsoft.icon',
      'path' => $lightning_path . '/favicon.ico',
      'url' => '',
      'use_default' => FALSE,
    ])
    ->save(TRUE);

  // View display definition.
  $display = [
    'default' => [
      'display_options' => [
        'access' => [
          'type' => 'perm',
          'options' => [
            'perm' => 'access content',
          ],
        ],
        'cache' => [
          'type' => 'tag',
          'options' => [],
        ],
        'empty' => [
          'area_text_custom' => [
            'id' => 'area_text_custom',
            'table' => 'views',
            'field' => 'area_text_custom',
            'relationship' => 'none',
            'group_type' => 'group',
            'admin_label' => '',
            'empty' => TRUE,
            'tokenize' => TRUE,
            'content' => '<p>Welcome to [site:name]. No front page content has been created yet.</p><p>Would you like to <a href="' . $lightning_path . '/README.md">view the README</a>?</p>',
            'label' => '',
            'plugin_id' => 'text_custom',
          ],
          'node_listing_empty' => [
            'admin_label' => '',
            'empty' => TRUE,
            'field' => 'node_listing_empty',
            'group_type' => 'group',
            'id' => 'node_listing_empty',
            'label' => '',
            'relationship' => 'none',
            'table' => 'node',
            'plugin_id' => 'node_listing_empty',
            'entity_type' => 'node',
          ],
          'title' => [
            'id' => 'title',
            'table' => 'views',
            'field' => 'title',
            'relationship' => 'none',
            'group_type' => 'group',
            'admin_label' => '',
            'label' => '',
            'empty' => TRUE,
            'title' => 'Welcome to [site:name]',
            'plugin_id' => 'title',
          ],
        ],
        'exposed_form' => [
          'type' => 'basic',
          'options' => [
            'submit_button' => 'Apply',
            'reset_button' => FALSE,
            'reset_button_label' => 'Reset',
            'exposed_sorts_label' => 'Sort by',
            'expose_sort_order' => TRUE,
            'sort_asc_label' => 'Asc',
            'sort_desc_label' => 'Desc',
          ],
        ],
        'filters' => [
          'promote' => [
            'admin_label' => '',
            'expose' => [
              'description' => '',
              'identifier' => '',
              'label' => '',
              'multiple' => FALSE,
              'operator' => '',
              'operator_id' => '',
              'remember' => FALSE,
              'remember_roles' => [
                'authenticated' => 'authenticated',
              ],
              'required' => FALSE,
              'use_operator' => FALSE,
            ],
            'exposed' => FALSE,
            'field' => 'promote',
            'group' => 1,
            'group_info' => [
              'default_group' => 'All',
              'default_group_multiple' => [],
              'description' => '',
              'group_items' => [],
              'identifier' => '',
              'label' => '',
              'multiple' => FALSE,
              'optional' => TRUE,
              'remember' => FALSE,
              'widget' => 'select',
            ],
            'group_type' => 'group',
            'id' => 'promote',
            'is_grouped' => FALSE,
            'operator' => '=',
            'relationship' => 'none',
            'table' => 'node_field_data',
            'value' => TRUE,
            'plugin_id' => 'boolean',
            'entity_type' => 'node',
            'entity_field' => 'promote',
          ],
          'status' => [
            'expose' => [
              'operator' => '',
            ],
            'field' => 'status',
            'group' => 1,
            'id' => 'status',
            'table' => 'node_field_data',
            'value' => 'true',
            'plugin_id' => 'boolean',
            'entity_type' => 'node',
            'entity_field' => 'status',
          ],
          'langcode' => [
            'id' => 'langcode',
            'table' => 'node_field_data',
            'field' => 'langcode',
            'relationship' => 'none',
            'group_type' => 'group',
            'admin_label' => '',
            'operator' => 'in',
            'value' => [
              '***LANGUAGE_language_content***' => '***LANGUAGE_language_content***',
            ],
            'group' => 1,
            'exposed' => FALSE,
            'expose' => [
              'operator_id' => '',
              'label' => '',
              'description' => '',
              'use_operator' => FALSE,
              'operator' => '',
              'identifier' => '',
              'required' => FALSE,
              'remember' => FALSE,
              'multiple' => FALSE,
              'remember_roles' => [
                'authenticated' => 'authenticated',
              ],
              'reduce' => FALSE,
            ],
            'is_grouped' => FALSE,
            'group_info' => [
              'label' => '',
              'description' => '',
              'identifier' => '',
              'optional' => TRUE,
              'widget' => 'select',
              'multiple' => FALSE,
              'remember' => FALSE,
              'default_group' => 'All',
              'default_group_multiple' => [],
              'group_items' => [],
            ],
            'plugin_id' => 'language',
            'entity_type' => 'node',
            'entity_field' => 'langcode',
          ],
        ],
        'pager' => [
          'type' => 'full',
          'options' => [
            'items_per_page' => 10,
            'offset' => 0,
            'id' => 0,
            'total_pages' => 0,
            'expose' => [
              'items_per_page' => FALSE,
              'items_per_page_label' => 'Items per page',
              'items_per_page_options' => '5, 10, 25, 50',
              'items_per_page_options_all' => FALSE,
              'items_per_page_options_all_label' => '- All -',
              'offset' => FALSE,
              'offset_label' => 'Offset',
            ],
            'tags' => [
              'previous' => '‹ Previous',
              'next' => 'Next ›',
              'first' => '« First',
              'last' => 'Last »',
            ],
            'quantity' => 9,
          ],
        ],
        'query' => [
          'type' => 'views_query',
          'options' => [
            'disable_sql_rewrite' => FALSE,
            'distinct' => FALSE,
            'replica' => FALSE,
            'query_comment' => '',
            'query_tags' => [],
          ],
        ],
        'row' => [
          'type' => 'entity:node',
          'options' => [
            'view_mode' => 'teaser',
          ],
        ],
        'sorts' => [
          'sticky' => [
            'admin_label' => '',
            'expose' => [
              'label' => '',
            ],
            'exposed' => FALSE,
            'field' => 'sticky',
            'group_type' => 'group',
            'id' => 'sticky',
            'order' => 'DESC',
            'relationship' => 'none',
            'table' => 'node_field_data',
            'plugin_id' => 'boolean',
            'entity_type' => 'node',
            'entity_field' => 'sticky',
          ],
          'created' => [
            'field' => 'created',
            'id' => 'created',
            'order' => 'DESC',
            'table' => 'node_field_data',
            'plugin_id' => 'date',
            'relationship' => 'none',
            'group_type' => 'group',
            'admin_label' => '',
            'exposed' => FALSE,
            'expose' => [
              'label' => '',
            ],
            'granularity' => 'second',
            'entity_type' => 'node',
            'entity_field' => 'created',
          ],
        ],
        'style' => [
          'type' => 'default',
          'options' => [
            'grouping' => [],
            'row_class' => '',
            'default_row_class' => TRUE,
            'uses_fields' => FALSE,
          ],
        ],
        'title' => '',
        'header' => [],
        'footer' => [],
        'relationships' => [],
        'fields' => [],
        'arguments' => [],
        'display_extenders' => [],
      ],
      'display_plugin' => 'default',
      'display_title' => 'Master',
      'id' => 'default',
      'position' => 0,
      'cache_metadata' => [
        'contexts' => [
          'languages:language_interface',
          'url.query_args',
          'user.node_grants:view',
          'user.permissions',
        ],
        'max-age' => -1,
        'tags' => [],
      ],
    ],
    'feed_1' => [
      'display_plugin' => 'feed',
      'id' => 'feed_1',
      'display_title' => 'Feed',
      'position' => 2,
      'display_options' => [
        'sitename_title' => TRUE,
        'path' => 'rss.xml',
        'displays' => [
          'page_1' => 'page_1',
          'default' => '',
        ],
        'pager' => [
          'type' => 'some',
          'options' => [
            'items_per_page' => 10,
            'offset' => 0,
          ],
        ],
        'style' => [
          'type' => 'rss',
          'options' => [
            'description' => '',
            'grouping' => [],
            'uses_fields' => FALSE,
          ],
        ],
        'row' => [
          'type' => 'node_rss',
          'options' => [
            'relationship' => 'none',
            'view_mode' => 'rss',
          ],
        ],
        'display_extenders' => [],
      ],
      'cache_metadata' => [
        'contexts' => [
          'languages:language_interface',
          'user.node_grants:view',
          'user.permissions',
        ],
        'max-age' => -1,
        'tags' => [],
      ],
    ],
    'page_1' => [
      'display_options' => [
        'path' => 'node',
        'display_extenders' => [],
      ],
      'display_plugin' => 'page',
      'display_title' => 'Page',
      'id' => 'page_1',
      'position' => 1,
      'cache_metadata' => [
        'contexts' => [
          'languages:language_interface',
          'url.query_args',
          'user.node_grants:view',
          'user.permissions',
        ],
        'max-age' => -1,
        'tags' => [],
      ],
    ],
  ];

  \Drupal::configFactory()
    ->getEditable('views.view.frontpage')
    ->set('langcode', 'en')
    ->set('status', TRUE)
    ->set('dependencies', [
      'config' => [
        'core.entity_view_mode.node.rss',
        'core.entity_view_mode.node.teaser',
      ],
      'module' => [
        'node',
        'user',
      ],
    ])
    ->set('id', 'frontpage')
    ->set('label', 'Frontpage')
    ->set('module', 'node')
    ->set('description', 'All content promoted to frontpage')
    ->set('tag', 'default')
    ->set('base_table', 'node_field_data')
    ->set('base_field', 'nid')
    ->set('core', '8.x')
    ->set('display', [
      'default' => $display['default'],
      'feed_1' => $display['feed_1'],
      'page_1' => $display['page_1'],
    ])
    ->save(TRUE);
}

/**
 * Makes updates to some basic config that ships with Lightning.
 *
 * Install the body field on the basic block_content type, delete the Create
 * landing page shortcut, and uninstall the Media Demo Content Module.
 */
function lightning_update_8001() {
  // Install the body field on the basic block_content type.
  $field = FieldConfig::load('block_content.basic.body');
  if (empty($field)) {
    lightning_core_create_config('field_config', 'block_content.basic.body', 'lightning');

    $display = EntityViewDisplay::load('block_content.basic.default');
    if ($display) {
      /** @var \Drupal\Core\Entity\Display\EntityViewDisplayInterface $display */
      $display->setComponent('body', [
        'type' => 'text_default',
        'weight' => 0,
        'label' => 'hidden',
        'settings' => [],
        'third_party_settings' => [],
      ])->save();
    }
    else {
      lightning_core_create_config('entity_view_display', 'block_content.basic.default', 'lightning');
    }
  }

  // Delete the `Create Landing Page` toolbar shortcut.
  $properties = ['link__uri' => 'internal:/admin/structure/landing-page'];
  $shortcuts = \Drupal::entityTypeManager()->getStorage('shortcut')->loadByProperties($properties);
  foreach ($shortcuts as $shortcut) {
    $shortcut->delete();
  }

  // Uninstall the Media Demo Content module.
  \Drupal::service('module_installer')->uninstall(['lightning_media_democontent']);
}

/**
 * Creates roles for editing content types.
 */
function lightning_update_8002() {
  foreach (NodeType::loadMultiple() as $node_type) {
    lightning_core_node_type_insert($node_type);
  }
}

/**
 * Enables the lightning_core module.
 */
function lightning_update_8003() {
  \Drupal::service('module_installer')->install(['lightning_core']);
}

/**
 * Enables Entity API.
 */
function lightning_update_8004() {
  require_once __DIR__ . '/.entity-helper.php';
  \Drupal::service('module_installer')->install(['entity']);
}

/**
 * Implements hook_update_dependencies().
 */
function lightning_update_dependencies() {
  return [
    'lightning' => [
      // Lightning 8003 must run before Lightning 8002.
      8002 => [
        'lightning' => 8003,
      ],
    ],
    'media_entity' => [
      // Lightning 8004 must run before Media Entity 8002.
      8002 => [
        'lightning' => 8004,
      ],
    ],
  ];
}