Skip to content
Snippets Groups Projects
Commit 095064f4 authored by Brian Canini's avatar Brian Canini
Browse files

module

parent 26d66261
No related branches found
No related tags found
No related merge requests found
Showing
with 2016 additions and 0 deletions
GNU GENERAL PUBLIC LICENSE
Version 2, June 1991
Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The licenses for most software are designed to take away your
freedom to share and change it. By contrast, the GNU General Public
License is intended to guarantee your freedom to share and change free
software--to make sure the software is free for all its users. This
General Public License applies to most of the Free Software
Foundation's software and to any other program whose authors commit to
using it. (Some other Free Software Foundation software is covered by
the GNU Lesser General Public License instead.) You can apply it to
your programs, too.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
this service if you wish), that you receive source code or can get it
if you want it, that you can change the software or use pieces of it
in new free programs; and that you know you can do these things.
To protect your rights, we need to make restrictions that forbid
anyone to deny you these rights or to ask you to surrender the rights.
These restrictions translate to certain responsibilities for you if you
distribute copies of the software, or if you modify it.
For example, if you distribute copies of such a program, whether
gratis or for a fee, you must give the recipients all the rights that
you have. You must make sure that they, too, receive or can get the
source code. And you must show them these terms so they know their
rights.
We protect your rights with two steps: (1) copyright the software, and
(2) offer you this license which gives you legal permission to copy,
distribute and/or modify the software.
Also, for each author's protection and ours, we want to make certain
that everyone understands that there is no warranty for this free
software. If the software is modified by someone else and passed on, we
want its recipients to know that what they have is not the original, so
that any problems introduced by others will not reflect on the original
authors' reputations.
Finally, any free program is threatened constantly by software
patents. We wish to avoid the danger that redistributors of a free
program will individually obtain patent licenses, in effect making the
program proprietary. To prevent this, we have made it clear that any
patent must be licensed for everyone's free use or not licensed at all.
The precise terms and conditions for copying, distribution and
modification follow.
GNU GENERAL PUBLIC LICENSE
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
0. This License applies to any program or other work which contains
a notice placed by the copyright holder saying it may be distributed
under the terms of this General Public License. The "Program", below,
refers to any such program or work, and a "work based on the Program"
means either the Program or any derivative work under copyright law:
that is to say, a work containing the Program or a portion of it,
either verbatim or with modifications and/or translated into another
language. (Hereinafter, translation is included without limitation in
the term "modification".) Each licensee is addressed as "you".
Activities other than copying, distribution and modification are not
covered by this License; they are outside its scope. The act of
running the Program is not restricted, and the output from the Program
is covered only if its contents constitute a work based on the
Program (independent of having been made by running the Program).
Whether that is true depends on what the Program does.
1. You may copy and distribute verbatim copies of the Program's
source code as you receive it, in any medium, provided that you
conspicuously and appropriately publish on each copy an appropriate
copyright notice and disclaimer of warranty; keep intact all the
notices that refer to this License and to the absence of any warranty;
and give any other recipients of the Program a copy of this License
along with the Program.
You may charge a fee for the physical act of transferring a copy, and
you may at your option offer warranty protection in exchange for a fee.
2. You may modify your copy or copies of the Program or any portion
of it, thus forming a work based on the Program, and copy and
distribute such modifications or work under the terms of Section 1
above, provided that you also meet all of these conditions:
a) You must cause the modified files to carry prominent notices
stating that you changed the files and the date of any change.
b) You must cause any work that you distribute or publish, that in
whole or in part contains or is derived from the Program or any
part thereof, to be licensed as a whole at no charge to all third
parties under the terms of this License.
c) If the modified program normally reads commands interactively
when run, you must cause it, when started running for such
interactive use in the most ordinary way, to print or display an
announcement including an appropriate copyright notice and a
notice that there is no warranty (or else, saying that you provide
a warranty) and that users may redistribute the program under
these conditions, and telling the user how to view a copy of this
License. (Exception: if the Program itself is interactive but
does not normally print such an announcement, your work based on
the Program is not required to print an announcement.)
These requirements apply to the modified work as a whole. If
identifiable sections of that work are not derived from the Program,
and can be reasonably considered independent and separate works in
themselves, then this License, and its terms, do not apply to those
sections when you distribute them as separate works. But when you
distribute the same sections as part of a whole which is a work based
on the Program, the distribution of the whole must be on the terms of
this License, whose permissions for other licensees extend to the
entire whole, and thus to each and every part regardless of who wrote it.
Thus, it is not the intent of this section to claim rights or contest
your rights to work written entirely by you; rather, the intent is to
exercise the right to control the distribution of derivative or
collective works based on the Program.
In addition, mere aggregation of another work not based on the Program
with the Program (or with a work based on the Program) on a volume of
a storage or distribution medium does not bring the other work under
the scope of this License.
3. You may copy and distribute the Program (or a work based on it,
under Section 2) in object code or executable form under the terms of
Sections 1 and 2 above provided that you also do one of the following:
a) Accompany it with the complete corresponding machine-readable
source code, which must be distributed under the terms of Sections
1 and 2 above on a medium customarily used for software interchange; or,
b) Accompany it with a written offer, valid for at least three
years, to give any third party, for a charge no more than your
cost of physically performing source distribution, a complete
machine-readable copy of the corresponding source code, to be
distributed under the terms of Sections 1 and 2 above on a medium
customarily used for software interchange; or,
c) Accompany it with the information you received as to the offer
to distribute corresponding source code. (This alternative is
allowed only for noncommercial distribution and only if you
received the program in object code or executable form with such
an offer, in accord with Subsection b above.)
The source code for a work means the preferred form of the work for
making modifications to it. For an executable work, complete source
code means all the source code for all modules it contains, plus any
associated interface definition files, plus the scripts used to
control compilation and installation of the executable. However, as a
special exception, the source code distributed need not include
anything that is normally distributed (in either source or binary
form) with the major components (compiler, kernel, and so on) of the
operating system on which the executable runs, unless that component
itself accompanies the executable.
If distribution of executable or object code is made by offering
access to copy from a designated place, then offering equivalent
access to copy the source code from the same place counts as
distribution of the source code, even though third parties are not
compelled to copy the source along with the object code.
4. You may not copy, modify, sublicense, or distribute the Program
except as expressly provided under this License. Any attempt
otherwise to copy, modify, sublicense or distribute the Program is
void, and will automatically terminate your rights under this License.
However, parties who have received copies, or rights, from you under
this License will not have their licenses terminated so long as such
parties remain in full compliance.
5. You are not required to accept this License, since you have not
signed it. However, nothing else grants you permission to modify or
distribute the Program or its derivative works. These actions are
prohibited by law if you do not accept this License. Therefore, by
modifying or distributing the Program (or any work based on the
Program), you indicate your acceptance of this License to do so, and
all its terms and conditions for copying, distributing or modifying
the Program or works based on it.
6. Each time you redistribute the Program (or any work based on the
Program), the recipient automatically receives a license from the
original licensor to copy, distribute or modify the Program subject to
these terms and conditions. You may not impose any further
restrictions on the recipients' exercise of the rights granted herein.
You are not responsible for enforcing compliance by third parties to
this License.
7. If, as a consequence of a court judgment or allegation of patent
infringement or for any other reason (not limited to patent issues),
conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot
distribute so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you
may not distribute the Program at all. For example, if a patent
license would not permit royalty-free redistribution of the Program by
all those who receive copies directly or indirectly through you, then
the only way you could satisfy both it and this License would be to
refrain entirely from distribution of the Program.
If any portion of this section is held invalid or unenforceable under
any particular circumstance, the balance of the section is intended to
apply and the section as a whole is intended to apply in other
circumstances.
It is not the purpose of this section to induce you to infringe any
patents or other property right claims or to contest validity of any
such claims; this section has the sole purpose of protecting the
integrity of the free software distribution system, which is
implemented by public license practices. Many people have made
generous contributions to the wide range of software distributed
through that system in reliance on consistent application of that
system; it is up to the author/donor to decide if he or she is willing
to distribute software through any other system and a licensee cannot
impose that choice.
This section is intended to make thoroughly clear what is believed to
be a consequence of the rest of this License.
8. If the distribution and/or use of the Program is restricted in
certain countries either by patents or by copyrighted interfaces, the
original copyright holder who places the Program under this License
may add an explicit geographical distribution limitation excluding
those countries, so that distribution is permitted only in or among
countries not thus excluded. In such case, this License incorporates
the limitation as if written in the body of this License.
9. The Free Software Foundation may publish revised and/or new versions
of the General Public License from time to time. Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the Program
specifies a version number of this License which applies to it and "any
later version", you have the option of following the terms and conditions
either of that version or of any later version published by the Free
Software Foundation. If the Program does not specify a version number of
this License, you may choose any version ever published by the Free Software
Foundation.
10. If you wish to incorporate parts of the Program into other free
programs whose distribution conditions are different, write to the author
to ask for permission. For software which is copyrighted by the Free
Software Foundation, write to the Free Software Foundation; we sometimes
make exceptions for this. Our decision will be guided by the two goals
of preserving the free status of all derivatives of our free software and
of promoting the sharing and reuse of software generally.
NO WARRANTY
11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
REPAIR OR CORRECTION.
12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
POSSIBILITY OF SUCH DAMAGES.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
convey the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
<one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year> <name of author>
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
Also add information on how to contact you by electronic and paper mail.
If the program is interactive, make it output a short notice like this
when it starts in an interactive mode:
Gnomovision version 69, Copyright (C) year name of author
Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the appropriate
parts of the General Public License. Of course, the commands you use may
be called something other than `show w' and `show c'; they could even be
mouse-clicks or menu items--whatever suits your program.
You should also get your employer (if you work as a programmer) or your
school, if any, to sign a "copyright disclaimer" for the program, if
necessary. Here is a sample; alter the names:
Yoyodyne, Inc., hereby disclaims all copyright interest in the program
`Gnomovision' (which makes passes at compilers) written by James Hacker.
<signature of Ty Coon>, 1 April 1989
Ty Coon, President of Vice
This General Public License does not permit incorporating your program into
proprietary programs. If your program is a subroutine library, you may
consider it more useful to permit linking proprietary applications with the
library. If this is what you want to do, use the GNU Lesser General
Public License instead of this License.
## CONTENTS OF THIS FILE ##
* Introduction
* Installation
* Configuration
* Usage
* Extending the module
* How Can You Contribute?
* Maintainers
## INTRODUCTION ##
Author and maintainer: Pawel Ginalski (gbyte.co)
* Drupal: https://www.drupal.org/u/gbyte.co
* Personal: https://gbyte.co/
The module generates multilingual XML sitemaps which adhere to Google's new
hreflang standard. Out of the box the sitemaps index most of Drupal's
content entity types including:
* nodes
* taxonomy terms
* menu links
* users
* ...
Contributed entity types like commerce products or media entities can be indexed
as well. On top of that custom links can be added to the sitemap.
To learn about XML sitemaps, see https://en.wikipedia.org/wiki/Sitemaps.
The module also provides an API allowing to create any type of sitemap (not
necessary an XML one) holding links to a local or remote source.
## INSTALLATION ##
See https://www.drupal.org/documentation/install/modules-themes/modules-8
for instructions on how to install or update Drupal modules.
## CONFIGURATION ##
### PERMISSIONS ###
The module permission 'administer sitemap settings' can be configured under
/admin/people/permissions.
### ENTITIES ###
Initially only the home page is indexed in the sitemap. To include content into
the sitemap, visit /admin/config/search/simplesitemap/entities to enable support
for entity types of your choosing. Entity types which feature bundles can then
be configured on a per-bundle basis, e.g.
* /admin/structure/types/manage/[content type] for nodes
* /admin/structure/taxonomy/manage/[taxonomy vocabulary] for taxonomy terms
* /admin/structure/menu/manage/[menu] for menu items
* ...
When including an entity type or bundle into the sitemap, the priority setting
can be set which will set the 'priority' parameter for all entities of that
type. Same goes for the 'changefreq' setting. All Images referenced by the
entities can be indexed as well. See https://en.wikipedia.org/wiki/Sitemaps to
learn more about these parameters.
Inclusion settings of bundles can be overridden on a per-entity
basis. Just head over to a bundle instance edit form (e.g. node/1/edit) to
override its sitemap settings.
If you wish for the sitemap to reflect the new configuration instantly, check
'Regenerate sitemaps after clicking save'. This setting only appears if a change
in the settings has been detected.
As the sitemap is accessible to anonymous users, bear in mind that only links
will be included which are accessible to anonymous users. There are no access
checks for links added through the module's hooks (see below).
### CUSTOM LINKS ###
To include custom links into the sitemap, visit
/admin/config/search/simplesitemap/custom.
### SETTINGS ###
The settings page can be found under admin/config/search/simplesitemap.
Here the module can be configured and the sitemaps can be manually regenerated.
#### VARIANTS ####
It is possible to have several sitemap instances of different sitemap types with
specific links accessible under certain URLs. These sitemap variants can be
configured under admin/config/search/simplesitemap/variants.
## USAGE ##
The sitemaps are accessible to the whole world under [variant name]/sitemap.xml.
In addition to that, the default sitemap is accessible under /sitemap.xml.
If the cron generation is turned on, the sitemaps will be regenerated according
to the 'Sitemap generation interval' setting.
A manual generation is possible on admin/config/search/simplesitemap. This is
also the place that shows the overall and variant specific generation status.
The sitemap can be also generated via drush: Use the command
'drush simple-sitemap:generate' ('ssg'), or 'drush simple-sitemap:rebuild-queue'
('ssr').
Generation of hundreds of thousands of links can take time. Each variant gets
published as soon as all of its links have been generated. The previous version
of the sitemap variant is accessible during the generation process.
## EXTENDING THE MODULE ##
### API ###
There are API methods for altering stored inclusion settings, status queries and
programmatic sitemap generation. These include:
* getSetting
* saveSetting
* setVariants
* getSitemap
* removeSitemap
* generateSitemap
* rebuildQueue
* enableEntityType
* disableEntityType
* setBundleSettings
* getBundleSettings
* removeBundleSettings
* supplementDefaultSettings
* setEntityInstanceSettings
* getEntityInstanceSettings
* removeEntityInstanceSettings
* bundleIsIndexed
* entityTypeIsEnabled
* addCustomLink
* getCustomLinks
* removeCustomLinks
* getSitemapManager
* getSitemapVariants
* addSitemapVariant
* removeSitemapVariants
* getQueueWorker
* deleteQueue
* rebuildQueue
* getInitialElementCount
* getQueuedElementCount
* getStashedResultCount
* getProcessedElementCount
* generationInProgress
These service methods can be chained like so:
```php
$generator = \Drupal::service('simple_sitemap.generator');
$generator
->getSitemapManager()
->addSitemapVariant('test');
$generator
->saveSetting('remove_duplicates', TRUE)
->enableEntityType('node')
->setVariants(['default', 'test'])
->setBundleSettings('node', 'page', ['index' => TRUE, 'priority' = 0.5])
->removeCustomLinks()
->addCustomLink('/some/view/page', ['priority' = 0.5])
->generateSitemap();
```
See https://gbyte.co/projects/simple-xml-sitemap and code documentation in
Drupal\simple_sitemap\Simplesitemap for further details.
### API HOOKS ###
It is possible to hook into link generation by implementing
`hook_simple_sitemap_links_alter(&$links){}` in a custom module and altering the
link array shortly before it is transformed to XML.
Adding arbitrary links is possible through the use of
`hook_simple_sitemap_arbitrary_links_alter(&$arbitrary_links){}`. There are no
checks performed on these links (i.e. if they are internal/valid/accessible)
and parameters like priority/lastmod/changefreq have to be added manually.
Altering sitemap attributes and sitemap index attributes is possible through the
use of `hook_simple_sitemap_attributes_alter(&$attributes){}` and
`hook_simple_sitemap_index_attributes_alter(&$index_attributes){}`.
Altering URL generators is possible through
the use of `hook_simple_sitemap_url_generators_alter(&$generators){}`.
Altering sitemap generators is possible through
the use of `hook_simple_sitemap_sitemap_generators_alter(&$generators){}`.
Altering sitemap types is possible through
the use of `hook_simple_sitemap_sitemap_types_alter(&$generators){}`.
### WRITING PLUGINS ###
There are three types of plugins that allow to create any type of sitemap. See
the generator plugins included in this module and check the API docs
(https://www.drupal.org/docs/8/api/plugin-api/plugin-api-overview) to learn how
to implement plugins.
#### SITEMAP TYPE PLUGINS ####
This plugin defines a sitemap type. A sitemap type consists of a sitemap
generator and several URL generators. This plugin is very simple, as it
only requires some class annotation to define which sitemap/URL plugins to use.
#### SITEMAP GENERATOR PLUGINS ####
This plugin defines how a sitemap type is supposed to look. It handles all
aspects of the sitemap except its links/URLs.
#### URL GENERATOR PLUGINS ####
This plugin defines a way of generating URLs for one or more sitemap types.
Note:
Overwriting the default EntityUrlGenerator for a single entity type is possible
through the flag "overrides_entity_type" = "[entity_type_to_be_overwritten]" in
the settings array of the new generator plugin's annotation. See how the
EntityUrlGenerator is overwritten by the EntityMenuLinkContentUrlGenerator to
facilitate a different logic for menu links.
See https://gbyte.co/projects/simple-xml-sitemap for further details.
## HOW CAN YOU CONTRIBUTE? ##
* Report any bugs, feature or support requests in the issue tracker; if
possible help out by submitting patches.
http://drupal.org/project/issues/simple_sitemap
* Do you know a non-English language? Help translating the module.
https://localize.drupal.org/translate/projects/simple_sitemap
* If you would like to say thanks and support the development of this module, a
donation will be much appreciated.
https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=5AFYRSBLGSC3W
* Feel free to contact me for paid support: https://gbyte.co/contact
## MAINTAINERS ##
Current maintainers:
* Pawel Ginalski (gbyte.co) - https://www.drupal.org/u/gbyte.co
{
"name": "drupal/simple_sitemap",
"description": "Creates a standard conform hreflang XML sitemap of the site content and provides a framework for developing other sitemap types.",
"type": "drupal-module",
"homepage": "https://drupal.org/project/simple_sitemap",
"authors": [
{
"name": "Pawel Ginalski (gbyte.co)",
"email": "contact@gbyte.co",
"homepage": "https://www.drupal.org/u/gbyte.co",
"role": "Maintainer"
}
],
"support": {
"issues": "https://drupal.org/project/issues/simple_sitemap",
"irc": "irc://irc.freenode.org/drupal-contribute",
"source": "https://cgit.drupalcode.org/simple_sitemap"
},
"license": "GPL-2.0+",
"minimum-stability": "dev",
"require": {
"ext-xmlwriter": "*"
},
"extra": {
"drush": {
"services": {
"drush.services.yml": "^9"
}
}
}
}
links:
-
path: '/'
priority: '1.0'
changefreq: 'daily'
max_links: 2000
cron_generate: true
cron_generate_interval: 0
generate_duration: 10000
remove_duplicates: true
skip_untranslated: true
base_url: ''
default_variant: 'default'
custom_links_include_images: false
excluded_languages: []
enabled_entity_types:
- 'node'
- 'taxonomy_term'
- 'menu_link_content'
variants:
default:
label: 'Default'
weight: 0
simple_sitemap.settings:
type: config_object
mapping:
max_links:
label: 'Max links'
type: integer
cron_generate:
label: 'Cron generation'
type: boolean
cron_generate_interval:
label: 'Cron generation interval'
type: integer
generate_duration:
label: 'Generation duration'
type: integer
remove_duplicates:
label: 'Remove duplicates'
type: boolean
skip_untranslated:
label: 'Skip untranslated'
type: boolean
base_url:
label: 'Base URL'
type: string
default_variant:
label: 'Default variant'
type: string
custom_links_include_images:
label: 'Include images of custom links'
type: boolean
excluded_languages:
label: 'Excluded languages'
type: sequence
sequence:
type: string
enabled_entity_types:
label: 'Enabled entity types'
type: sequence
sequence:
type: string
simple_sitemap.bundle_settings.*.*.*:
label: 'Entity bundle settings'
type: config_object
mapping:
index:
label: 'Index'
type: boolean
priority:
label: 'Priority'
type: string
changefreq:
label: 'Change frequency'
type: string
include_images:
label: 'Include images'
type: boolean
simple_sitemap.custom_links.*:
label: 'Custom links'
type: config_object
mapping:
links:
label: 'Custom links'
type: sequence
sequence:
type: mapping
mapping:
path:
label: 'Path'
type: string
priority:
label: 'Priority'
type: string
changefreq:
label: 'Change frequency'
type: string
simple_sitemap.variants.*:
label: 'Sitemap variants'
type: config_object
mapping:
variants:
label: 'Sitemap variants'
type: sequence
sequence:
type: mapping
mapping:
label:
label: 'Variant label'
type: string
weight:
label: 'Weight'
type: integer
services:
simple_sitemap.commands:
class: \Drupal\simple_sitemap\Commands\SimplesitemapCommands
arguments:
- '@simple_sitemap.generator'
tags:
- { name: drush.command }
/**
* @file
* Attaches simple_sitemap behaviors to the entity form.
*/
(function($) {
"use strict";
Drupal.behaviors.simple_sitemapFieldsetSummaries = {
attach: function(context) {
$(context).find('#edit-simple-sitemap').drupalSetSummary(function(context) {
var vals = [];
if ($(context).find('#edit-simple-sitemap-index-content-1').is(':checked')) {
vals.push(Drupal.t('Included in sitemap'));
vals.push(Drupal.t('Variant') + ': ' + $('#edit-simple-sitemap-variant option:selected', context).text());
vals.push(Drupal.t('Priority') + ': ' + $('#edit-simple-sitemap-priority option:selected', context).text());
vals.push(Drupal.t('Change frequency') + ': ' + $('#edit-simple-sitemap-changefreq option:selected', context).text());
vals.push(Drupal.t('Include images') + ': ' + $('#edit-simple-sitemap-include-images option:selected', context).text());
}
else {
vals.push(Drupal.t('Excluded from sitemap'));
}
return vals.join('<br />');
});
}
};
})(jQuery);
/**
* @file
* Attaches simple_sitemap behaviors to the entity form.
*/
(function($) {
"use strict";
Drupal.behaviors.simple_sitemapForm = {
attach: function(context) {
// On load: Hide the 'Regenerate sitemap' field to only display it if settings have changed.
$('.form-item-simple-sitemap-regenerate-now').hide();
// Show 'Regenerate sitemap' field if settings have changed.
$("#edit-simple-sitemap-index-content"
+ ", #edit-simple-sitemap-variant"
+ ", #edit-simple-sitemap-priority"
+ ", #edit-simple-sitemap-changefreq"
+ ", #edit-simple-sitemap-include-images"
).change(function() {
$('.form-item-simple-sitemap-regenerate-now').show();
});
}
};
})(jQuery);
/**
* @file
* Attaches simple_sitemap behaviors to the sitemap entities form.
*/
(function($) {
"use strict";
Drupal.behaviors.simple_sitemapSitemapEntities = {
attach: function(context, settings) {
var allEntities = settings.simple_sitemap.all_entities;
var atomicEntities = settings.simple_sitemap.atomic_entities;
// Hide the 'Regenerate sitemap' field to only display it if settings have changed.
$('.form-item-simple-sitemap-regenerate-now').hide();
$.each(allEntities, function(index, value) {
// On load: hide all warning messages.
$('#warning-' + value).hide();
// On change: Show or hide warning message dependent on 'enabled' checkbox.
var enabledId = '#edit-' + value + '-enabled';
$(enabledId).change(function() {
if ($(enabledId).is(':checked')) {
$('#warning-' + value).hide();
$('#indexed-bundles-' + value).show();
}
else {
$('#warning-' + value).show();
$('#indexed-bundles-' + value).hide();
}
// Show 'Regenerate sitemap' field if 'enabled' setting has changed.
$('.form-item-simple-sitemap-regenerate-now').show();
});
});
// todo
// Show 'Regenerate sitemap' field if settings have changed.
// $.each(atomicEntities, function(index, value) {
// var variant = '.form-item-' + value + '-simple-sitemap-variant';
// var priorityId = '.form-item-' + value + '-simple-sitemap-priority';
// var changefreqId = '.form-item-' + value + '-simple-sitemap-changefreq';
// var includeImagesId = '.form-item-' + value + '-simple-sitemap-include-images';
//
// $(variant, priorityId, changefreqId, includeImagesId).change(function() {
// $('.form-item-simple-sitemap-regenerate-now').show();
// });
// });
}
};
})(jQuery);
<?php
/**
* @file
* Hooks provided by the Simple XML sitemap module.
*/
/**
* @addtogroup hooks
* @{
*/
/**
* Alter the generated link data before the sitemap is saved.
* This hook gets invoked for every sitemap chunk generated.
*
* @param array &$links
* Array containing multilingual links generated for each path to be indexed
*
* @param string|null $sitemap_variant
*/
function hook_simple_sitemap_links_alter(array &$links, $sitemap_variant) {
// Remove German URL for a certain path in the hreflang sitemap.
foreach ($links as $key => $link) {
if ($link['path'] === 'node/1') {
// Remove 'loc' URL if it points to a german site.
if ($link['langcode'] === 'de') {
unset($links[$key]);
}
// If this 'loc' URL points to a non-german site, make sure to remove
// its german alternate URL.
else {
if ($link['alternate_urls']['de']) {
unset($links[$key]['alternate_urls']['de']);
}
}
}
}
}
/**
* Add arbitrary links to the sitemap.
*
* @param array &$arbitrary_links
* @param string|null $sitemap_variant
*/
function hook_simple_sitemap_arbitrary_links_alter(array &$arbitrary_links, $sitemap_variant) {
// Add an arbitrary link to all sitemap variants.
$arbitrary_links[] = [
'url' => 'http://some-arbitrary-link/',
'priority' => '0.5',
// An ISO8601 formatted date.
'lastmod' => '2012-10-12T17:40:30+02:00',
'changefreq' => 'weekly',
'images' => [
['path' => 'http://path-to-image.png']
],
// Add alternate URLs for every language of a multilingual site.
// Not necessary for monolingual sites.
'alternate_urls' => [
'en' => 'http://this-is-your-life.net/de/tyler',
'de' => 'http://this-is-your-life.net/en/tyler',
]
];
// Add an arbitrary link to the 'fight_club' sitemap variant only.
switch ($sitemap_variant) {
case 'fight_club':
$arbitrary_links[] = [
'url' => 'http://this-is-your-life.net/tyler',
];
break;
}
}
/**
* Alters the sitemap attributes shortly before XML document generation.
* Attributes can be added, changed and removed.
*
* @param array &$attributes
* @param string|null $sitemap_variant
*/
function hook_simple_sitemap_attributes_alter(array &$attributes, $sitemap_variant) {
// Remove the xhtml attribute e.g. if no xhtml sitemap elements are present.
unset($attributes['xmlns:xhtml']);
}
/**
* Alters attributes of the sitemap index shortly before XML document generation.
* Attributes can be added, changed and removed.
*
* @param array &$index_attributes
* @param string|null $sitemap_variant
*/
function hook_simple_sitemap_index_attributes_alter(array &$index_attributes, $sitemap_variant) {
// Add some attribute to the sitemap index.
$index_attributes['name'] = 'value';
}
/**
* Alter properties of and remove URL generator plugins.
*
* @param array $url_generators
*/
function hook_simple_sitemap_url_generators_alter(array &$url_generators) {
// Remove the entity generator.
unset($url_generators['entity']);
}
/**
* Alter properties of and remove sitemap generator plugins.
*
* @param array $sitemap_generators
*/
function hook_simple_sitemap_sitemap_generators_alter(array &$sitemap_generators) {
// Remove the default generator.
unset($sitemap_generators['default']);
}
/**
* Alter properties of and remove sitemap type plugins.
*
* @param array $sitemap_types
*/
function hook_simple_sitemap_sitemap_types_alter(array &$sitemap_types) {
}
/**
* @} End of "addtogroup hooks".
*/
<?php
/**
* @file
* Drush (< 9) integration.
*/
/**
* Implements hook_drush_command().
*/
function simple_sitemap_drush_command() {
$items['simple-sitemap-generate'] = [
'description' => 'Regenerate the XML sitemaps according to the module settings.',
'callback' => 'drush_simple_sitemap_generate',
'drupal dependencies' => ['simple_sitemap'],
'aliases' => ['ssg'],
];
$items['simple-sitemap-rebuild-queue'] = [
'description' => 'Rebuild the sitemap queue for all sitemap variants.',
'callback' => 'drush_simple_sitemap_rebuild_queue',
'drupal dependencies' => ['simple_sitemap'],
'aliases' => ['ssr'],
];
return $items;
}
/**
* Callback function for hook_drush_command().
*
* Regenerate the XML sitemaps according to the module settings.
*/
function drush_simple_sitemap_generate() {
\Drupal::service('simple_sitemap.generator')->generateSitemap('drush');
}
/**
* Callback function for hook_drush_command().
*
* Rebuild the sitemap queue for all sitemap variants.
*/
function drush_simple_sitemap_rebuild_queue() {
\Drupal::service('simple_sitemap.generator')->rebuildQueue();
}
name: 'Simple XML Sitemap'
type: module
description: 'Creates a standard conform hreflang XML sitemap of the site content and provides a framework for developing other sitemap types.'
configure: simple_sitemap.settings
package: SEO
# core: 8.x
# Information added by Drupal.org packaging script on 2018-12-07
version: '8.x-3.0'
core: '8.x'
project: 'simple_sitemap'
datestamp: 1544174900
This diff is collapsed.
fieldsetSummaries:
version: VERSION
js:
js/simple_sitemap.fieldsetSummaries.js: {}
dependencies:
- core/jquery
form:
version: VERSION
js:
js/simple_sitemap.form.js: {}
dependencies:
- core/jquery
sitemapEntities:
version: VERSION
js:
js/simple_sitemap.sitemapEntities.js: {}
dependencies:
- core/jquery
- core/drupalSettings
simple_sitemap.settings:
title: 'Simple XML sitemap'
description: 'Configure and generate the XML sitemap, add custom links to it.'
parent: system.admin_config_search
route_name: simple_sitemap.settings
simple_sitemap.settings:
route_name: simple_sitemap.settings
title: 'Settings'
base_route: simple_sitemap.settings
weight: -1
simple_sitemap.settings_entities:
route_name: simple_sitemap.settings_entities
title: 'Sitemap entities'
base_route: simple_sitemap.settings
weight: 0
simple_sitemap.variants:
route_name: simple_sitemap.settings_variants
title: 'Sitemap variants'
base_route: simple_sitemap.settings
weight: 1
simple_sitemap.settings_custom:
route_name: simple_sitemap.settings_custom
title: 'Custom links'
base_route: simple_sitemap.settings
weight: 2
<?php
/**
* @file
* Main module file containing hooks.
*/
use Drupal\Core\Form\FormStateInterface;
use Drupal\Core\Entity\EntityInterface;
use Drupal\Core\Routing\RouteMatchInterface;
use Drupal\system\MenuInterface;
use Drupal\language\ConfigurableLanguageInterface;
/**
*Implements hook_help().
*
* @param $route_name
* @param \Drupal\Core\Routing\RouteMatchInterface $route_match
* @return \Drupal\Component\Render\MarkupInterface|null
*/
function simple_sitemap_help($route_name, RouteMatchInterface $route_match) {
return $route_name === 'help.page.simple_sitemap' ?
check_markup(file_get_contents(dirname(__FILE__) . "/README.md")) : NULL;
}
/**
* Implements hook_form_alter().
*
* Adds sitemap settings to entity types that are supported via plugins.
*
* @param $form
* @param \Drupal\Core\Form\FormStateInterface $form_state
* @param $form_id
*/
function simple_sitemap_form_alter(&$form, FormStateInterface $form_state, $form_id) {
/** @var Drupal\simple_sitemap\Form\FormHelper $f */
$f = \Drupal::service('simple_sitemap.form_helper');
if (!$f->processForm($form_state)) {
return;
}
$form['simple_sitemap'] = [
'#type' => 'details',
'#group' => isset($form['additional_settings']) ? 'additional_settings' : 'advanced',
'#title' => t('Simple XML sitemap'),
'#description' => $f->getEntityCategory() === 'instance' ? t('Settings for this entity can be overridden here.') : '',
'#weight' => 10,
];
// Attach some js magic to forms.
if ($f->getEntityCategory() !== 'instance') {
$form['#attached']['library'][] = 'simple_sitemap/form';
}
// Only attach fieldset summary js to 'additional settings' vertical tabs.
if (isset($form['additional_settings'])) {
$form['#attached']['library'][] = 'simple_sitemap/fieldsetSummaries';
}
$f->displayEntitySettings($form['simple_sitemap'])
// todo: do not show setting when creating new bundle.
->displayRegenerateNow($form['simple_sitemap']);
// Add submission handler.
if (isset($form['actions']['submit']['#submit'])) {
foreach (array_keys($form['actions']) as $action) {
if ($action !== 'preview'
&& isset($form['actions'][$action]['#type'])
&& $form['actions'][$action]['#type'] === 'submit') {
$form['actions'][$action]['#submit'][] = 'simple_sitemap_entity_form_submit';
}
}
}
// Fix for account page rendering other submit handlers not usable.
else {
$form['#submit'][] = 'simple_sitemap_entity_form_submit';
}
}
/**
* Form submission handler called in hook_form_alter.
*
* @param $form
* @param \Drupal\Core\Form\FormStateInterface $form_state
*/
function simple_sitemap_entity_form_submit($form, FormStateInterface &$form_state) {
/** @var Drupal\simple_sitemap\Form\FormHelper $f */
$f = \Drupal::service('simple_sitemap.form_helper');
if (!$f->processForm($form_state)) {
return;
}
$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;
// Only make changes in DB if sitemap settings actually changed.
if ($f->valuesChanged($form, $values)) {
/** @var \Drupal\simple_sitemap\Simplesitemap $generator */
$generator = \Drupal::service('simple_sitemap.generator');
$settings = [
'index' => (bool) $values['simple_sitemap_index_content'],
'priority' => $values['simple_sitemap_priority'],
'changefreq' => $values['simple_sitemap_changefreq'],
'include_images' => (bool) $values['simple_sitemap_include_images'],
];
// Deleting bundle settings for old bundle.
// See SimplesitemapEntitiesForm::submitForm().
// todo: This will not be necessary if "multiple variants pro bundle" is implemented.
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());
}
}
switch ($f->getEntityCategory()) {
case 'bundle':
$generator->setVariants($values['simple_sitemap_variant'])
->setBundleSettings($f->getEntityTypeId(),
!empty($f->getBundleName()) ? $f->getBundleName() : $f->getFormEntityId(),
$settings
);
break;
case 'instance':
$generator->setVariants($values['simple_sitemap_variant'])
->setEntityInstanceSettings($f->getEntityTypeId(),
!empty($f->getInstanceId()) ? $f->getInstanceId() : $f->getFormEntityId(),
$settings
);
break;
}
// Regenerate sitemaps according to user setting.
if ($values['simple_sitemap_regenerate_now']) {
$generator->rebuildQueue()->generateSitemap();
}
}
}
/**
* Implements hook_cron().
*/
function simple_sitemap_cron() {
/** @var \Drupal\simple_sitemap\Simplesitemap $generator */
$generator = \Drupal::service('simple_sitemap.generator');
if ($generator->getSetting('cron_generate')) {
$interval = (int) $generator->getSetting('cron_generate_interval', 0) * 60 * 60;
$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);
}
$generator->generateSitemap('cron');
}
}
}
/**
* 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) {
/** @var \Drupal\simple_sitemap\Simplesitemap $generator */
$generator = \Drupal::service('simple_sitemap.generator');
$excluded_languages = $generator->getSetting('excluded_languages');
if (isset($excluded_languages[$language->id()])) {
unset($excluded_languages[$language->id()]);
$generator->saveSetting('excluded_languages', $excluded_languages);
}
}
/**
* Implements hook_entity_delete().
*
* Removes settings of the removed entity.
*
* @param \Drupal\Core\Entity\EntityInterface $entity
*/
function simple_sitemap_entity_delete(EntityInterface $entity) {
/** @var \Drupal\simple_sitemap\Simplesitemap $generator */
$generator = \Drupal::service('simple_sitemap.generator');
$generator->setVariants(TRUE)->removeEntityInstanceSettings(
$entity->getEntityTypeId(), $entity->id()
);
}
/**
* Implements hook_entity_bundle_delete().
*
* Removes settings of the removed bundle.
*
* @param string $entity_type_id
* @param string $bundle
*/
function simple_sitemap_entity_bundle_delete($entity_type_id, $bundle) {
/** @var \Drupal\simple_sitemap\Simplesitemap $generator */
$generator = \Drupal::service('simple_sitemap.generator');
$generator->setVariants(TRUE)->removeBundleSettings($entity_type_id, $bundle);
}
/**
* Implements hook_menu_delete().
*
* Removes settings for the removed menu.
*
* @param \Drupal\system\MenuInterface $menu
*/
function simple_sitemap_menu_delete(MenuInterface $menu) {
/** @var \Drupal\simple_sitemap\Simplesitemap $generator */
$generator = \Drupal::service('simple_sitemap.generator');
$generator->setVariants(TRUE)->removeBundleSettings('menu_link_content', $menu->id());
}
administer sitemap settings:
title: 'Administer sitemap settings'
description: 'Administer Simple XML sitemap settings, alter inclusion settings of content and generate the sitemap on demand.'
restrict access: false
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment