SitemapGenerator.php 5.88 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 $entityTypes;
24 25
  private $custom;
  private $links;
26
  private $generatingFrom;
27

Pawel G's avatar
Pawel G committed
28
  function __construct($from = 'form') {
29
    $this->links = array();
30
    $this->generatingFrom = $from;
31
  }
32

33 34
  public function setEntityTypes($entityTypes) {
    $this->entityTypes = is_array($entityTypes) ? $entityTypes : array();
35 36
  }

37
  public function setCustomLinks($custom) {
38
    $this->custom = is_array($custom) ? $custom : array();
39 40
  }

41
  /**
42
   * Adds all operations to the batch and starts it.
43
   */
44 45 46 47
  public function startBatch() {
    $batch = new Batch($this->generatingFrom);
    $batch->addOperations('custom_paths', $this->batchAddCustomPaths());
    $batch->addOperations('entity_types', $this->batchAddEntityTypePaths());
Pawel G's avatar
Pawel G committed
48 49 50 51
    $batch->start();
  }

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

Pawel G's avatar
Pawel G committed
61
  /**
62 63
   * Collects entity metadata for entities that are set to be indexed
   * and returns a batch-ready operation.
64 65
   *
   * @return array $operations.
Pawel G's avatar
Pawel G committed
66
   */
67
  private function batchAddEntityTypePaths() {
68
    $operations = [];
69 70 71 72 73 74 75 76 77 78 79 80 81 82
    $sitemap_entity_types = Simplesitemap::getSitemapEntityTypes();
    foreach($this->entityTypes as $entity_type_name => $bundles) {
      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) {
          $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
83
        }
84 85
      }
    }
Pawel G's avatar
Pawel G committed
86 87 88 89
    return $operations;
  }

  /**
90 91
   * 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
92
   *
93 94
   * @param array $links
   *  All links with their multilingual versions and settings.
95 96
   * @param bool $remove_sitemap
   *  Remove old sitemap from database before inserting the new one.
Pawel G's avatar
Pawel G committed
97
   */
98
  public static function generateSitemap($links, $remove_sitemap = FALSE) {
99 100
    // Invoke alter hook.
    \Drupal::moduleHandler()->alter('simple_sitemap_links', $links);
Pawel G's avatar
Pawel G committed
101
    $values = array(
102
      'id' => $remove_sitemap ? 1 : \Drupal::service('database')->query('SELECT MAX(id) FROM {simple_sitemap}')->fetchField() + 1,
103
      'sitemap_string' => self::generateSitemapChunk($links),
Pawel G's avatar
Pawel G committed
104
      'sitemap_created' => REQUEST_TIME,
Pawel G's avatar
Pawel G committed
105
    );
106 107 108 109
    if ($remove_sitemap) {
      \Drupal::service('database')->truncate('simple_sitemap')->execute();
    }
    \Drupal::service('database')->insert('simple_sitemap')->fields($values)->execute();
110 111
  }

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

128
    foreach ($sitemap_chunks as $chunk_id => $chunk_data) {
129
      $writer->startElement('sitemap');
130 131
      $writer->writeElement('loc', $GLOBALS['base_url'] . '/sitemaps/'
        . $chunk_id . '/' . 'sitemap.xml');
132
      $writer->writeElement('lastmod', date_iso8601($chunk_data->sitemap_created));
133 134 135 136 137 138 139
      $writer->endElement();
    }
    $writer->endElement();
    $writer->endDocument();
    return $writer->outputMemory();
  }

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

    $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);

159
    foreach ($sitemap_links as $link) {
160 161 162
      $writer->startElement('url');

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

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

176
      // Add priority if any.
Pawel G's avatar
Pawel G committed
177
      if (isset($link['priority'])) {
178 179 180
        $writer->writeElement('priority', $link['priority']);
      }

181
      // Add lastmod if any.
Pawel G's avatar
Pawel G committed
182
      if (isset($link['lastmod'])) {
183 184 185 186
        $writer->writeElement('lastmod', $link['lastmod']);
      }
      $writer->endElement();
    }
Pawel G's avatar
Pawel G committed
187
    $writer->endElement();
188 189
    $writer->endDocument();
    return $writer->outputMemory();
190 191
  }
}
192