SitemapGenerator.php 6.26 KB
Newer Older
1 2 3
<?php
/**
 * @file
Pawel G's avatar
Pawel G committed
4
 * Contains \Drupal\simple_sitemap\SitemapGenerator.
5 6 7 8
 *
 * Generates a sitemap for entities and custom links.
 */

Pawel G's avatar
Pawel G committed
9
namespace Drupal\simple_sitemap;
10

11
use \XMLWriter;
12 13 14 15 16 17 18 19

/**
 * SitemapGenerator class.
 */
class SitemapGenerator {

  const XML_VERSION = '1.0';
  const ENCODING = 'UTF-8';
20 21
  const XMLNS = 'http://www.sitemaps.org/schemas/sitemap/0.9';
  const XMLNS_XHTML = 'http://www.w3.org/1999/xhtml';
22

23
  private $sitemap;
24
  private $links;
25
  private $generatingFrom;
26

27 28
  function __construct($sitemap) {
    $this->sitemap = $sitemap;
29
    $this->links = array();
30 31
  }

32 33
  public function setGenerateFrom($from = 'form') {
    $this->generatingFrom = $from;
34 35
  }

36
  /**
37
   * Adds all operations to the batch and starts it.
38
   */
39 40 41 42 43 44 45 46 47 48
  public function startGeneration() {
    $batch = new Batch();
    $batch->setBatchInfo([
      'from' => $this->generatingFrom,
      'batch_process_limit' => !empty($this->sitemap->getSetting('batch_process_limit'))
        ? $this->sitemap->getSetting('batch_process_limit') : NULL,
      'max_links' => $this->sitemap->getSetting('max_links'),
      'remove_duplicates' => $this->sitemap->getSetting('remove_duplicates'),
      'entity_types' => $this->sitemap->getConfig('entity_types'),
    ]);
49 50
    $batch->addOperations('custom_paths', $this->batchAddCustomPaths());
    $batch->addOperations('entity_types', $this->batchAddEntityTypePaths());
Pawel G's avatar
Pawel G committed
51 52 53 54
    $batch->start();
  }

  /**
55 56 57
   * Returns the custom path generating operation.
   *
   * @return array $operation.
Pawel G's avatar
Pawel G committed
58
   */
59
  private function batchAddCustomPaths() {
Pawel G's avatar
Pawel G committed
60
    $link_generator = new CustomLinkGenerator();
61
    return $link_generator->getCustomPaths($this->sitemap->getConfig('custom'));
Pawel G's avatar
Pawel G committed
62
  }
63

Pawel G's avatar
Pawel G committed
64
  /**
65 66
   * Collects entity metadata for entities that are set to be indexed
   * and returns a batch-ready operation.
67 68
   *
   * @return array $operations.
Pawel G's avatar
Pawel G committed
69
   */
70
  private function batchAddEntityTypePaths() {
71
    $operations = [];
72
    $sitemap_entity_types = Simplesitemap::getSitemapEntityTypes();
73 74
    $entity_types = $this->sitemap->getConfig('entity_types');
    foreach($entity_types as $entity_type_name => $bundles) {
75 76 77 78
      if (isset($sitemap_entity_types[$entity_type_name])) {
        $keys = $sitemap_entity_types[$entity_type_name]->getKeys();
        $keys['bundle'] = $entity_type_name == 'menu_link_content' ? 'menu_name' : $keys['bundle']; // Menu fix.
        foreach($bundles as $bundle_name => $bundle_settings) {
79 80 81 82 83 84 85 86 87 88
          if ($bundle_settings['index']) {
            $operations[] = [
              'entity_info' => [
                'bundle_settings' => $bundle_settings,
                'bundle_name' => $bundle_name,
                'entity_type_name' => $entity_type_name,
                'keys' => $keys,
              ],
            ];
          }
Pawel G's avatar
Pawel G committed
89
        }
90 91
      }
    }
Pawel G's avatar
Pawel G committed
92 93 94 95
    return $operations;
  }

  /**
96 97
   * Wrapper method which takes links along with their options, lets other
   * modules alter the links and then generates and saves the sitemap.
Pawel G's avatar
Pawel G committed
98
   *
99 100
   * @param array $links
   *  All links with their multilingual versions and settings.
101 102
   * @param bool $remove_sitemap
   *  Remove old sitemap from database before inserting the new one.
Pawel G's avatar
Pawel G committed
103
   */
104
  public static function generateSitemap($links, $remove_sitemap = FALSE) {
105 106
    // Invoke alter hook.
    \Drupal::moduleHandler()->alter('simple_sitemap_links', $links);
Pawel G's avatar
Pawel G committed
107
    $values = array(
108
      'id' => $remove_sitemap ? 1 : \Drupal::service('database')->query('SELECT MAX(id) FROM {simple_sitemap}')->fetchField() + 1,
109
      'sitemap_string' => self::generateSitemapChunk($links),
Pawel G's avatar
Pawel G committed
110
      'sitemap_created' => REQUEST_TIME,
Pawel G's avatar
Pawel G committed
111
    );
112 113 114 115
    if ($remove_sitemap) {
      \Drupal::service('database')->truncate('simple_sitemap')->execute();
    }
    \Drupal::service('database')->insert('simple_sitemap')->fields($values)->execute();
116 117
  }

118
  /**
119
   * Generates and returns the sitemap index for all sitemap chunks.
120
   *
121
   * @param array $sitemap_chunks
122 123 124 125
   *  All sitemap chunks keyed by the chunk ID.
   *
   * @return string sitemap index
   */
126
  public function generateSitemapIndex($sitemap_chunks) {
127 128 129 130 131 132 133
    $writer = new XMLWriter();
    $writer->openMemory();
    $writer->setIndent(TRUE);
    $writer->startDocument(self::XML_VERSION, self::ENCODING);
    $writer->startElement('sitemapindex');
    $writer->writeAttribute('xmlns', self::XMLNS);

134
    foreach ($sitemap_chunks as $chunk_id => $chunk_data) {
135
      $writer->startElement('sitemap');
136 137
      $writer->writeElement('loc', $GLOBALS['base_url'] . '/sitemaps/'
        . $chunk_id . '/' . 'sitemap.xml');
138
      $writer->writeElement('lastmod', date_iso8601($chunk_data->sitemap_created));
139 140 141 142 143 144 145
      $writer->endElement();
    }
    $writer->endElement();
    $writer->endDocument();
    return $writer->outputMemory();
  }

146 147 148 149
  /**
   * Generates and returns a sitemap chunk.
   *
   * @param array $sitemap_links
150
   *  All links with their multilingual versions and settings.
151 152 153
   *
   * @return string sitemap chunk
   */
154 155
  private static function generateSitemapChunk($sitemap_links) {
    $default_language_id = Simplesitemap::getDefaultLangId();
156 157 158 159 160 161 162 163 164

    $writer = new XMLWriter();
    $writer->openMemory();
    $writer->setIndent(TRUE);
    $writer->startDocument(self::XML_VERSION, self::ENCODING);
    $writer->startElement('urlset');
    $writer->writeAttribute('xmlns', self::XMLNS);
    $writer->writeAttribute('xmlns:xhtml', self::XMLNS_XHTML);

165
    foreach ($sitemap_links as $link) {
166 167 168
      $writer->startElement('url');

      // Adding url to standard language.
Pawel G's avatar
Pawel G committed
169
      $writer->writeElement('loc', $link['urls'][$default_language_id]);
170

171
      // Adding alternate urls (other languages) if any.
Pawel G's avatar
Pawel G committed
172 173
      if (count($link['urls']) > 1) {
        foreach($link['urls'] as $language_id => $localised_url) {
174 175 176 177 178
          $writer->startElement('xhtml:link');
          $writer->writeAttribute('rel', 'alternate');
          $writer->writeAttribute('hreflang', $language_id);
          $writer->writeAttribute('href', $localised_url);
          $writer->endElement();
179 180 181
        }
      }

182
      // Add priority if any.
Pawel G's avatar
Pawel G committed
183
      if (isset($link['priority'])) {
184 185 186
        $writer->writeElement('priority', $link['priority']);
      }

187
      // Add lastmod if any.
Pawel G's avatar
Pawel G committed
188
      if (isset($link['lastmod'])) {
189 190 191 192
        $writer->writeElement('lastmod', $link['lastmod']);
      }
      $writer->endElement();
    }
Pawel G's avatar
Pawel G committed
193
    $writer->endElement();
194 195
    $writer->endDocument();
    return $writer->outputMemory();
196 197
  }
}
198