simple_sitemap.install 19.1 KB
Newer Older
gbyte.co's avatar
gbyte.co committed
1
<?php
gbyte.co's avatar
gbyte.co committed
2

gbyte.co's avatar
gbyte.co committed
3 4 5 6 7 8 9
/**
 * @file
 * Module install and update procedures.
 */

/**
 * Implements hook_requirements().
10 11 12
 *
 * @param $phase
 * @return array
gbyte.co's avatar
gbyte.co committed
13 14
 */
function simple_sitemap_requirements($phase) {
15
  $requirements = [];
gbyte.co's avatar
gbyte.co committed
16 17

  if (!extension_loaded('xmlwriter')) {
18
    $requirements['simple_sitemap_php_extensions'] = [
gbyte.co's avatar
gbyte.co committed
19 20
      'title' => t('Simple XML sitemap PHP extensions'),
      'value' => t('Missing PHP xmlwriter extension'),
gbyte.co's avatar
gbyte.co committed
21
      'description' => t('In order to be able to generate sitemaps, the Simple XML sitemap module requires the <em>xmlwriter</em> PHP extension to be enabled.'),
gbyte.co's avatar
gbyte.co committed
22
      'severity' => REQUIREMENT_ERROR,
23
    ];
gbyte.co's avatar
gbyte.co committed
24 25
  }

gbyte.co's avatar
gbyte.co committed
26
  switch ($phase) {
27

gbyte.co's avatar
gbyte.co committed
28
    case 'runtime':
29 30

      $generator = \Drupal::service('simple_sitemap.generator');
31
      $generated_ago = $generator->getGeneratedAgo(\Drupal\simple_sitemap\SimplesitemapManager::DEFAULT_SITEMAP_VARIANT); //todo
32 33
      $cron_generation = $generator->getSetting('cron_generate');

gbyte.co's avatar
gbyte.co committed
34 35
      if (!$generated_ago) {
        $value = t('Not available');
36
        $description = t($cron_generation
gbyte.co's avatar
gbyte.co committed
37 38
          ? 'Run cron, or <a href="@generate">generate</a> the sitemap manually.'
          : 'Generation on cron run is disabled. <a href="@generate">Generate</a> the sitemap manually.', [
39 40 41
            '@generate' => $GLOBALS['base_url'] . '/admin/config/search/simplesitemap'
          ]
        );
gbyte.co's avatar
gbyte.co committed
42 43 44
        $severity = REQUIREMENT_WARNING;
      }
      else {
45 46
        $value = t('XML sitemaps are available');
        $description = t('The last generation finished @ago ago.'
47
          . ' ' . ($cron_generation
48 49
            ? 'Run cron, or <a href="@generate">regenerate</a> the sitemaps manually.'
            : 'Generation on cron run is disabled. <a href="@generate">Regenerate</a> the sitemaps manually.'), [
50 51 52 53
              '@ago' => $generated_ago,
              '@generate' => $GLOBALS['base_url'] . '/admin/config/search/simplesitemap'
            ]
          );
gbyte.co's avatar
gbyte.co committed
54 55
        $severity = REQUIREMENT_INFO;
      }
56

57
      $requirements['simple_sitemap_generated'] = [
gbyte.co's avatar
gbyte.co committed
58 59 60 61
        'title' => 'Simple XML sitemap',
        'value' => $value,
        'description' => $description,
        'severity' => $severity,
62
      ];
gbyte.co's avatar
gbyte.co committed
63 64 65 66 67 68 69 70 71
      break;
  }
  return $requirements;
}

/**
 * Implements hook_schema().
 */
function simple_sitemap_schema() {
72
  $schema['simple_sitemap'] = [
gbyte.co's avatar
gbyte.co committed
73
    'description' => 'Holds XML sitemaps as strings for quick retrieval.',
74 75
    'fields' => [
      'id' => [
gbyte.co's avatar
gbyte.co committed
76 77 78 79
        'description' => 'Sitemap chunk unique identifier.',
        'type' => 'int',
        'size' => 'small',
        'not null' => TRUE,
80
        'unsigned' => TRUE,
81
      ],
82 83 84 85 86 87 88 89 90 91 92 93 94 95
      'type' => [
        'description' => 'Type of sitemap this chunk belongs to.',
        'type' => 'varchar',
        'length' => 50,
        'not null' => TRUE,
        'default' => '',
      ],
      'delta' => [
        'description' => 'Delta of the chunk within the type scope.',
        'type' => 'int',
        'size' => 'small',
        'not null' => TRUE,
        'unsigned' => TRUE,
      ],
96
      'sitemap_string' => [
gbyte.co's avatar
gbyte.co committed
97 98 99 100
        'description' => 'XML sitemap chunk string.',
        'type' => 'text',
        'size' => 'big',
        'not null' => TRUE,
101 102
      ],
      'sitemap_created' => [
gbyte.co's avatar
gbyte.co committed
103 104
        'description' => 'Timestamp of sitemap chunk generation.',
        'type' => 'int',
105 106
        'not null' => TRUE,
        'unsigned' => TRUE,
gbyte.co's avatar
gbyte.co committed
107
        'default' => 0,
108 109 110 111 112
      ],
      'status' => [
        'description' => "Flag indicating the publishing status of the chunk.",
        'type' => 'int',
        'size' => 'tiny',
gbyte.co's avatar
gbyte.co committed
113
        'not null' => TRUE,
114
        'unsigned' => TRUE,
115
        'default' => 0,
116 117 118 119 120 121 122 123 124 125 126 127
      ],
    ],
    'primary key' => ['id'],
  ];

  $schema['simple_sitemap_entity_overrides'] = [
    'description' => 'Holds sitemap settings overridden by entities.',
    'fields' => [
      'id' => [
        'description' => 'Override unique identifier.',
        'type' => 'serial',
        'not null' => TRUE,
128
        'unsigned' => TRUE,
129 130 131 132 133 134 135 136 137
      ],
      'entity_type' => [
        'description' => 'Entity type of the overriding entity.',
        'type' => 'varchar',
        'length' => 32,
        'not null' => TRUE,
      ],
      'entity_id' => [
        'description' => 'ID of the overriding entity.',
138 139
        'type' => 'varchar',
        'length' => 32,
140 141 142 143 144
        'not null' => TRUE,
      ],
      'inclusion_settings' => [
        'description' => 'Setting for the overriding entity.',
        'type' => 'blob',
145 146 147 148
      ],
    ],
    'primary key' => ['id'],
  ];
gbyte.co's avatar
gbyte.co committed
149 150 151 152 153 154 155 156
  return $schema;
}

/**
 * Implements hook_install().
 */
function simple_sitemap_install() {
  $base_url = $GLOBALS['base_url'];
157
  \Drupal::messenger()->addMessage(t("You can now include content into the sitemap by visiting the corresponding entity type edit pages (e.g. <a href='@content_type_url'>node type edit pages</a>).<br/>Support for additional entity types and custom links can be added on <a href='@config_url'>the module's configuration pages</a>.", ['@content_type_url' => "$base_url/admin/structure/types", '@config_url' => "$base_url/admin/config/search/simplesitemap"]));
158 159 160 161 162 163 164
}

/**
 * Changing the data structure of the module's configuration.
 */
function simple_sitemap_update_8201() {
  $entity_types = \Drupal::config('simple_sitemap.settings')->get('entity_types');
165
  $entity_types = is_array($entity_types) ? $entity_types : [];
166 167 168 169 170 171 172
  $naming_changes = [
    'node_type' => 'node',
    'taxonomy_vocabulary' => 'taxonomy_term',
    'menu' => 'menu_link_content',
    'commerce_product_type' => 'commerce_product',
    'media_bundle' => 'media',
  ];
gbyte.co's avatar
gbyte.co committed
173
  foreach ($entity_types as $entity_type_name => $settings) {
174 175 176 177 178 179 180
    if (isset($naming_changes[$entity_type_name])) {
      $entity_types[$naming_changes[$entity_type_name]] = $entity_types[$entity_type_name];
      unset($entity_types[$entity_type_name]);
    }
  }
  \Drupal::service('config.factory')->getEditable('simple_sitemap.settings')
    ->set('entity_types', $entity_types)->save();
gbyte.co's avatar
gbyte.co committed
181
}
182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226

/**
 * Moving entity overrides from configuration to database table.
 */
function simple_sitemap_update_8202() {
  $database = \Drupal::database();

  // Create database table.
  if (!$database->schema()->tableExists('simple_sitemap_entity_overrides')) {
    $database->schema()->createTable('simple_sitemap_entity_overrides', [
      'description' => 'Holds sitemap settings overridden by entities.',
      'fields' => [
        'id' => [
          'description' => 'Override unique identifier.',
          'type' => 'serial',
          'unsigned' => TRUE,
          'not null' => TRUE,
        ],
        'entity_type' => [
          'description' => 'Entity type of the overriding entity.',
          'type' => 'varchar',
          'length' => 32,
          'not null' => TRUE,
        ],
        'entity_id' => [
          'description' => 'ID of the overriding entity.',
          'type' => 'int',
          'unsigned' => TRUE,
          'not null' => TRUE,
        ],
        'inclusion_settings' => [
          'description' => 'Setting for the overriding entity.',
          'type' => 'blob',
        ],
      ],
      'primary key' => ['id'],
    ]);
  }

  // Populate database table with config values.
  $entity_types = \Drupal::config('simple_sitemap.settings')->get('entity_types');
  $entity_types = is_array($entity_types) ? $entity_types : [];

  foreach ($entity_types as $entity_type_name => &$entity_type) {
    if (is_array($entity_type)) {
gbyte.co's avatar
gbyte.co committed
227
      foreach ($entity_type as $bundle_name => &$bundle) {
228
        if (isset($bundle['entities'])) {
gbyte.co's avatar
gbyte.co committed
229
          foreach ($bundle['entities'] as $entity_id => $entity_settings) {
230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253
            $database->insert('simple_sitemap_entity_overrides')
              ->fields([
                'entity_type' => $entity_type_name,
                'entity_id' => $entity_id,
                'inclusion_settings' => serialize($entity_settings),
              ])
              ->execute();
          }
          // Remove entity overrides from configuration.
          unset($bundle['entities']);
        }
      }
    }
  }

  \Drupal::service('config.factory')->getEditable('simple_sitemap.settings')
    ->set('entity_types', $entity_types)->save();
}

/**
 * Splitting simple_sitemap.settings configuration into simple_sitemap.settings,
 * simple_sitemap.entity_types and simple_sitemap.custom.
 */
function simple_sitemap_update_8203() {
254 255
  $old_config = $config = \Drupal::config('simple_sitemap.settings');
  foreach (['entity_types', 'custom'] as $config_name) {
256 257 258
    if (!$config = $old_config->get($config_name)) {
      continue;
    }
259 260 261 262 263 264
    \Drupal::service('config.factory')->getEditable("simple_sitemap.$config_name")
      ->setData($config)->save();
  }
  $settings = $old_config->get('settings');
  \Drupal::service('config.factory')->getEditable("simple_sitemap.settings")
    ->setData($settings)->save();
265
}
266 267

/**
268
 * Removing entity type settings for entity types which do not have the canonical
269 270 271 272 273 274
 * link template.
 */
function simple_sitemap_update_8204() {
  $sitemap_entity_types = \Drupal::service('entity_type.manager')->getDefinitions();
  $entity_types = \Drupal::config('simple_sitemap.entity_types')->get();
  unset($entity_types['_core']);
gbyte.co's avatar
gbyte.co committed
275
  foreach ($entity_types as $entity_type_id => $entity_type) {
276 277 278 279 280 281 282 283 284 285 286 287 288 289 290
    if (!isset($sitemap_entity_types[$entity_type_id])
      || !$sitemap_entity_types[$entity_type_id]->hasLinkTemplate('canonical')) {

      // Delete entity overrides.
      \Drupal::database()->delete('simple_sitemap_entity_overrides')
        ->condition('entity_type', $entity_type_id)
        ->execute();

      // Delete entity type settings.
      unset($entity_types[$entity_type_id]);
    }
  }
  \Drupal::service('config.factory')->getEditable("simple_sitemap.entity_types")
    ->setData($entity_types)->save();
}
291 292 293 294 295 296 297 298 299

/**
 * Splitting simple_sitemap.entity_types into individual configuration objects
 * for each bundle.
 */
function simple_sitemap_update_8205() {
  $entity_types = \Drupal::config('simple_sitemap.entity_types')->get();
  unset($entity_types['_core']);
  $enabled_entity_types = [];
gbyte.co's avatar
gbyte.co committed
300
  foreach ($entity_types as $entity_type_id => $bundles) {
301
    $enabled_entity_types[] = $entity_type_id;
gbyte.co's avatar
gbyte.co committed
302
    foreach ($bundles as $bundle_name => $bundle_settings) {
303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319
      \Drupal::service('config.factory')
        ->getEditable("simple_sitemap.bundle_settings.$entity_type_id.$bundle_name")
        ->setData($bundle_settings)->save();
    }
  }

  // Add enabled entity type settings.
  \Drupal::service('config.factory')
    ->getEditable('simple_sitemap.settings')
    ->set('enabled_entity_types', $enabled_entity_types)
    ->save();

  // Remove old configuration object.
  \Drupal::service('config.factory')
    ->getEditable('simple_sitemap.entity_types')
    ->delete();
}
320 321 322 323 324 325

/**
 * Placing custom links in a subkey of simple_sitemap.custom configuration.
 */
function simple_sitemap_update_8206() {
  $custom_links = \Drupal::config('simple_sitemap.custom')->get();
gbyte.co's avatar
gbyte.co committed
326
  foreach ($custom_links as $i => $custom_link) {
327 328 329 330
    if (!isset($custom_link['path'])) {
      unset($custom_links[$i]);
    }
  }
gbyte.co's avatar
gbyte.co committed
331
  \Drupal::service('config.factory')->getEditable('simple_sitemap.custom')
332 333
    ->setData(['links' => $custom_links])->save();
}
334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349

/**
 * Updating entity_id field of simple_sitemap_entity_overrides table to varchar(32).
 */
function simple_sitemap_update_8207() {
  \Drupal::database()->schema()->changeField(
    'simple_sitemap_entity_overrides',
    'entity_id',
    'entity_id', [
      'description' => 'ID of the overriding entity.',
      'type' => 'varchar',
      'length' => 32,
      'not null' => TRUE,
    ]
  );
}
350 351

/**
352
 * Adding changefreq setting to all existing bundle and entity instance settings.
353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382
 */
function simple_sitemap_update_8208() {

  // Update existing bundle settings.
  $config_factory = \Drupal::service('config.factory');
  $entity_types = $config_factory->listAll('simple_sitemap.bundle_settings.');

  foreach ($entity_types as $entity_type) {
    $config = $config_factory->get($entity_type)->get();
    if (!isset($config['changefreq'])) {
      $config_factory->getEditable($entity_type)
        ->setData($config + ['changefreq' => ''])
        ->save();
    }
  }

  // Update existing entity override data.
  $results = \Drupal::database()->select('simple_sitemap_entity_overrides', 'o')
    ->fields('o', ['id', 'inclusion_settings'])
    ->execute()->fetchAll(\PDO::FETCH_OBJ);

  foreach ($results as $row) {
    $settings = unserialize($row->inclusion_settings);
    if (!isset($settings['changefreq'])) {
      \Drupal::database()->update('simple_sitemap_entity_overrides')
        ->fields(['inclusion_settings' => serialize($settings + ['changefreq' => '']),])
        ->condition('id', $row->id)
        ->execute();
    }
  }
383

gbyte.co's avatar
gbyte.co committed
384
  return t('You may now want to configure the new changefreq setting for the XML sitemap entities and custom links.');
385 386 387 388 389 390 391 392 393
}

/**
 * Adding image inclusion setting to all existing bundle and entity instance settings.
 */
function simple_sitemap_update_8209() {

  // Update existing bundle settings.
  $config_factory = \Drupal::service('config.factory');
394
  $all_bundle_settings = $config_factory->listAll('simple_sitemap.bundle_settings.');
395

396 397
  foreach ($all_bundle_settings as $bundle_settings) {
    $config = $config_factory->get($bundle_settings)->get();
398
    if (!isset($config['include_images'])) {
399
      $config_factory->getEditable($bundle_settings)
400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419
        ->setData($config + ['include_images' => 0])
        ->save();
    }
  }

  // Update existing entity override data.
  $results = \Drupal::database()->select('simple_sitemap_entity_overrides', 'o')
    ->fields('o', ['id', 'inclusion_settings'])
    ->execute()->fetchAll(\PDO::FETCH_OBJ);

  foreach ($results as $row) {
    $settings = unserialize($row->inclusion_settings);
    if (!isset($settings['include_images'])) {
      \Drupal::database()->update('simple_sitemap_entity_overrides')
        ->fields(['inclusion_settings' => serialize($settings + ['include_images' => 0]),])
        ->condition('id', $row->id)
        ->execute();
    }
  }

gbyte.co's avatar
gbyte.co committed
420
  return t('You may now want to configure your XML sitemap entities to include images.');
421
}
422 423

/**
424
 * Adding 'type' and 'delta' fields to simple_sitemap table.
425 426 427 428
 */
function simple_sitemap_update_8210() {

  $database = \Drupal::database();
429
  $database->truncate('simple_sitemap')->execute();
430

431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454
  if (!$database->schema()->fieldExists('simple_sitemap', 'type')) {
    $database->schema()->addField(
      'simple_sitemap',
      'type', [
        'description' => 'Type of sitemap this chunk belongs to.',
        'type' => 'varchar',
        'length' => 50,
        'not null' => TRUE,
        'default' => '',
      ]
    );
  }
  if (!$database->schema()->fieldExists('simple_sitemap', 'delta')) {
    $database->schema()->addField(
      'simple_sitemap',
      'delta', [
        'description' => 'Delta of the chunk within the type scope.',
        'type' => 'int',
        'size' => 'small',
        'not null' => TRUE,
        'unsigned' => TRUE,
      ]
    );
  }
gbyte.co's avatar
gbyte.co committed
455 456

  return t('The XML sitemap needs to be regenerated.');
457 458
}

459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490
/**
 * Adding simple_sitemap.variants and simple_sitemap.types to configuration.
 */
function simple_sitemap_update_8211() {
  $config_factory = \Drupal::service('config.factory');

  // Add simple_sitemap.types.
  $config_factory
    ->getEditable('simple_sitemap.types.default_hreflang')
    ->setData([
      'label' => 'Default hreflang',
      'description' => 'The default hreflang sitemap type.',
      'sitemap_generator' => 'default',
      'url_generators' => [
        'custom',
        'entity',
        'entity_menu_link_content',
        'arbitrary',
      ],
    ])->save();

  // Add simple_sitemap.variants.
  $config_factory
    ->getEditable('simple_sitemap.variants')
    ->set('variants', [
      'default' => [
        'label' => 'Default',
        'type' => 'default_hreflang',
      ]
    ])->save();
}

491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536
/**
 * Changing storage data type of 'index' and 'include_images' from integer to boolean.
 */
function simple_sitemap_update_8212() {

  // Update existing bundle settings.
  $config_factory = \Drupal::service('config.factory');
  $all_bundle_settings = $config_factory->listAll('simple_sitemap.bundle_settings.');

  foreach ($all_bundle_settings as $bundle_settings) {
    $config = $config_factory->get($bundle_settings)->get();

    $config['include_images'] = isset($config['include_images'])
      ? (bool) $config['include_images']
      : FALSE;

    $config['index'] = isset($config['index'])
      ? (bool) $config['index']
      : FALSE;

    $config_factory->getEditable($bundle_settings)->setData($config)->save();
  }

  // Update existing entity override data.
  $results = \Drupal::database()->select('simple_sitemap_entity_overrides', 'o')
    ->fields('o', ['id', 'inclusion_settings'])
    ->execute()->fetchAll(\PDO::FETCH_OBJ);

  foreach ($results as $row) {
    $settings = unserialize($row->inclusion_settings);

    if (isset($settings['index'])) {
      $settings['index'] = (bool) $settings['index'];
    }

    if (isset($settings['include_images'])) {
      $settings['include_images'] = (bool) $settings['include_images'];
    }

    \Drupal::database()->update('simple_sitemap_entity_overrides')
      ->fields(['inclusion_settings' => serialize($settings)])
      ->condition('id', $row->id)
      ->execute();
  }
}

537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557
/**
 * Altering the configuration storage of variants.
 */
function simple_sitemap_update_8213() {
  $config_factory = \Drupal::service('config.factory');
  $new_variants = [];
  foreach ($config_factory->get('simple_sitemap.variants')->get('variants') as $variant_name => $variant_definition) {
    $new_variants[$variant_definition['type']][$variant_name] = ['label' => $variant_definition['label']];
  }

  // Create new configuration objects.
  foreach ($new_variants as $type => $variants) {
    $config_factory
      ->getEditable('simple_sitemap.variants.' . $type)
      ->set('variants', $variants)
      ->save();
  }

  // Remove old configuration object.
  $config_factory->getEditable('simple_sitemap.variants')->delete();
}
558

559 560 561 562 563 564 565 566 567 568 569 570
/**
 * Removing sitemap types from configuration as they are to be stored as plugins in code.
 */
function simple_sitemap_update_8214() {
  $config_factory = \Drupal::service('config.factory');
  $sitemap_types = $config_factory->listAll('simple_sitemap.types.');

  // Remove sitemap type configuration objects.
  foreach ($sitemap_types as $type) {
    $config_factory->getEditable($type)->delete();
  }
}
571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606

/**
 * Adding 'status' field to simple_sitemap table and weight to variants.
 */
function simple_sitemap_update_8215() {
  $database = \Drupal::database();
  $database->truncate('simple_sitemap')->execute();

  if (!$database->schema()->fieldExists('simple_sitemap', 'status')) {
    $database->schema()->addField(
      'simple_sitemap',
      'status', [
        'description' => "Flag indicating the publishing status of the chunk.",
        'type' => 'int',
        'size' => 'tiny',
        'not null' => TRUE,
        'unsigned' => TRUE,
        'default' => 0,
      ]
    );
  }

  $config_factory = \Drupal::service('config.factory');
  foreach ($config_factory->listAll('simple_sitemap.variants.') as $type) {
    /** @var \Drupal\Core\Config\Config $type */
    $type = $config_factory->getEditable($type);
    $variants = $type->get('variants');
    foreach($variants as $i => $variant) {
      $variants[$i]['weight'] = 0;
    }
    $type->set('variants', $variants)->save();
  }

  return t('The XML sitemaps need to be regenerated.');
}