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

3 4 5 6
/**
 * @file
 * Main module file containing hooks.
 */
gbyte.co's avatar
gbyte.co committed
7

8
use Drupal\Core\Form\FormStateInterface;
gbyte.co's avatar
gbyte.co committed
9 10
use Drupal\Core\Entity\EntityInterface;
use Drupal\Core\Routing\RouteMatchInterface;
11
use Drupal\system\MenuInterface;
12
use Drupal\language\ConfigurableLanguageInterface;
13

14
/**
15
 *Implements hook_help().
gbyte.co's avatar
gbyte.co committed
16 17 18 19
 *
 * @param $route_name
 * @param \Drupal\Core\Routing\RouteMatchInterface $route_match
 * @return \Drupal\Component\Render\MarkupInterface|null
20
 */
gbyte.co's avatar
gbyte.co committed
21
function simple_sitemap_help($route_name, RouteMatchInterface $route_match) {
22
  return $route_name === 'help.page.simple_sitemap' ?
23
    check_markup(file_get_contents(dirname(__FILE__) . "/README.md")) : NULL;
24 25
}

26
/**
27
 * Implements hook_form_alter().
28 29
 *
 * Adds sitemap settings to entity types that are supported via plugins.
gbyte.co's avatar
gbyte.co committed
30 31 32 33
 *
 * @param $form
 * @param \Drupal\Core\Form\FormStateInterface $form_state
 * @param $form_id
34
 */
gbyte.co's avatar
gbyte.co committed
35
function simple_sitemap_form_alter(&$form, FormStateInterface $form_state, $form_id) {
36

37
  /** @var Drupal\simple_sitemap\Form\FormHelper $f */
gbyte.co's avatar
gbyte.co committed
38 39
  $f = \Drupal::service('simple_sitemap.form_helper');
  if (!$f->processForm($form_state)) {
40
    return;
gbyte.co's avatar
gbyte.co committed
41
  }
gbyte.co's avatar
gbyte.co committed
42 43 44 45

  $form['simple_sitemap'] = [
    '#type' => 'details',
    '#group' => isset($form['additional_settings']) ? 'additional_settings' : 'advanced',
46
    '#title' => t('Simple XML Sitemap'),
gbyte.co's avatar
gbyte.co committed
47
    '#description' => $f->getEntityCategory() === 'instance' ? t('Settings for this entity can be overridden here.') : '',
48
    '#weight' => 10,
gbyte.co's avatar
gbyte.co committed
49
  ];
50

gbyte.co's avatar
gbyte.co committed
51
  // Attach some js magic to forms.
52
  if ($f->getEntityCategory() !== 'instance') {
gbyte.co's avatar
gbyte.co committed
53
    $form['#attached']['library'][] = 'simple_sitemap/form';
gbyte.co's avatar
gbyte.co committed
54
  }
55

gbyte.co's avatar
gbyte.co committed
56 57 58
  // Only attach fieldset summary js to 'additional settings' vertical tabs.
  if (isset($form['additional_settings'])) {
    $form['#attached']['library'][] = 'simple_sitemap/fieldsetSummaries';
59
  }
60

61
  $f->displayEntitySettings($form['simple_sitemap'])
gbyte.co's avatar
gbyte.co committed
62 63
  // todo: do not show setting when creating new bundle.
    ->displayRegenerateNow($form['simple_sitemap']);
64

65
  // Add submission handler.
66
  if (isset($form['actions']['submit']['#submit'])) {
67
    foreach (array_keys($form['actions']) as $action) {
gbyte.co's avatar
gbyte.co committed
68
      if ($action !== 'preview'
69 70
        && isset($form['actions'][$action]['#type'])
        && $form['actions'][$action]['#type'] === 'submit') {
71 72 73
        $form['actions'][$action]['#submit'][] = 'simple_sitemap_entity_form_submit';
      }
    }
74
  }
gbyte.co's avatar
gbyte.co committed
75 76
  // Fix for account page rendering other submit handlers not usable.
  else {
gbyte.co's avatar
gbyte.co committed
77
    $form['#submit'][] = 'simple_sitemap_entity_form_submit';
78
  }
gbyte.co's avatar
gbyte.co committed
79 80
}

81
/**
82
 * Form submission handler called in hook_form_alter.
gbyte.co's avatar
gbyte.co committed
83 84 85
 *
 * @param $form
 * @param \Drupal\Core\Form\FormStateInterface $form_state
86
 */
gbyte.co's avatar
gbyte.co committed
87
function simple_sitemap_entity_form_submit($form, FormStateInterface &$form_state) {
88

89
  /** @var Drupal\simple_sitemap\Form\FormHelper $f */
gbyte.co's avatar
gbyte.co committed
90 91 92 93
  $f = \Drupal::service('simple_sitemap.form_helper');
  if (!$f->processForm($form_state)) {
    return;
  }
94

95 96 97 98
  $values = $form_state->getValues();

  // Fix for values appearing in a sub array on a commerce product entity.
  $values = isset($values['simple_sitemap']) ? $values['simple_sitemap'] : $values;
99

100
  // Only make changes in DB if sitemap settings actually changed.
101
  if ($f->valuesChanged($form, $values)) {
102

103
    /** @var \Drupal\simple_sitemap\Simplesitemap $generator */
104
    $generator = \Drupal::service('simple_sitemap.generator');
105

106 107 108 109 110 111
    // Only save other values if indexing is enabled.
    if ($settings['index'] = (bool) $values['simple_sitemap_index_content']) {
      $settings['priority'] = $values['simple_sitemap_priority'];
      $settings['changefreq'] = $values['simple_sitemap_changefreq'];
      $settings['include_images'] = (bool) $values['simple_sitemap_include_images'];
    }
112

113 114
    // Deleting bundle settings for old bundle.
    // See SimplesitemapEntitiesForm::submitForm().
gbyte.co's avatar
gbyte.co committed
115
    // todo: Not necessary once https://www.drupal.org/project/simple_sitemap/issues/3014649 is implemented.
116 117 118 119 120 121 122
    if (isset($form['simple_sitemap']['simple_sitemap_variant']['#default_value'])) {
      $old_variant = $form['simple_sitemap']['simple_sitemap_variant']['#default_value'];
      if ($old_variant !== $values['simple_sitemap_variant']) {
        $generator->setVariants($old_variant)->removeBundleSettings($f->getEntityTypeId(), $f->getBundleName());
      }
    }

123
    switch ($f->getEntityCategory()) {
124 125

      case 'bundle':
126
        $generator->setVariants($values['simple_sitemap_variant'])
127 128
          ->setBundleSettings($f->getEntityTypeId(),
            !empty($f->getBundleName()) ? $f->getBundleName() : $f->getFormEntityId(),
129
          $settings
130
        );
131 132
        break;

133
      case 'instance':
134
        $generator->setVariants($values['simple_sitemap_variant'])
135 136 137
          ->setEntityInstanceSettings($f->getEntityTypeId(),
            !empty($f->getInstanceId()) ? $f->getInstanceId() : $f->getFormEntityId(),
            $settings
138
        );
139
        break;
140
    }
141 142 143

    // Regenerate sitemaps according to user setting.
    if ($values['simple_sitemap_regenerate_now']) {
gbyte.co's avatar
gbyte.co committed
144
      $generator->rebuildQueue()->generateSitemap();
145
    }
146 147 148 149
  }
}

/**
150
 * Implements hook_cron().
151
 */
gbyte.co's avatar
gbyte.co committed
152
function simple_sitemap_cron() {
153

154
  /** @var \Drupal\simple_sitemap\Simplesitemap $generator */
155
  $generator = \Drupal::service('simple_sitemap.generator');
156

157
  if ($generator->getSetting('cron_generate')) {
158
    $interval = (int) $generator->getSetting('cron_generate_interval', 0) * 60 * 60;
159 160 161 162 163 164 165 166 167 168 169 170
    $request_time = \Drupal::service('datetime.time')->getRequestTime();
    $generation_in_progress = $generator->getQueueWorker()->generationInProgress();
    $state = \Drupal::state();

    if ($interval === 0
      || $generation_in_progress
      || (($state->get('simple_sitemap.last_cron_generate', 0) + $interval) <= $request_time)) {

      if (!$generation_in_progress) {
        $state->set('simple_sitemap.last_cron_generate', $request_time);
      }

gbyte.co's avatar
gbyte.co committed
171
      $generator->generateSitemap('cron');
172
    }
173
  }
gbyte.co's avatar
gbyte.co committed
174
}
175

176 177 178 179 180 181 182
/**
 * Implements hook_ENTITY_TYPE_delete().
 *
 * When a language is removed from the system remove it also from settings.
 */
function simple_sitemap_configurable_language_delete(ConfigurableLanguageInterface $language) {

183
  /** @var \Drupal\simple_sitemap\Simplesitemap $generator */
184
  $generator = \Drupal::service('simple_sitemap.generator');
gbyte.co's avatar
gbyte.co committed
185

186 187 188 189 190 191 192
  $excluded_languages = $generator->getSetting('excluded_languages');
  if (isset($excluded_languages[$language->id()])) {
    unset($excluded_languages[$language->id()]);
    $generator->saveSetting('excluded_languages', $excluded_languages);
  }
}

193 194 195 196
/**
 * Implements hook_entity_delete().
 *
 * Removes settings of the removed entity.
197 198
 *
 * @param \Drupal\Core\Entity\EntityInterface $entity
199
 */
gbyte.co's avatar
gbyte.co committed
200
function simple_sitemap_entity_delete(EntityInterface $entity) {
201

202
  /** @var \Drupal\simple_sitemap\Simplesitemap $generator */
203
  $generator = \Drupal::service('simple_sitemap.generator');
204
  $generator->setVariants(TRUE)->removeEntityInstanceSettings(
205 206
    $entity->getEntityTypeId(), $entity->id()
  );
207
}
208 209 210 211 212

/**
 * Implements hook_entity_bundle_delete().
 *
 * Removes settings of the removed bundle.
gbyte.co's avatar
gbyte.co committed
213 214 215
 *
 * @param string $entity_type_id
 * @param string $bundle
216 217
 */
function simple_sitemap_entity_bundle_delete($entity_type_id, $bundle) {
218 219 220 221

  /** @var \Drupal\simple_sitemap\Simplesitemap $generator */
  $generator = \Drupal::service('simple_sitemap.generator');
  $generator->setVariants(TRUE)->removeBundleSettings($entity_type_id, $bundle);
222 223 224 225 226 227 228 229 230 231
}

/**
 * Implements hook_menu_delete().
 *
 * Removes settings for the removed menu.
 *
 * @param \Drupal\system\MenuInterface $menu
 */
function simple_sitemap_menu_delete(MenuInterface $menu) {
232

233
  /** @var \Drupal\simple_sitemap\Simplesitemap $generator */
234
  $generator = \Drupal::service('simple_sitemap.generator');
235
  $generator->setVariants(TRUE)->removeBundleSettings('menu_link_content', $menu->id());
236
}