├── menu_order_alphabetical.info.yml
├── menu_order_alphabetical.routing.yml
├── README.md
├── composer.json
├── src
    └── Form
    │   └── MenuLinkTreeResetForm.php
├── tests
    └── src
    │   └── Functional
    │       └── MenuOrderAlphabeticalFormTest.php
├── menu_order_alphabetical.module
├── .gitlab-ci.yml
└── LICENSE


/menu_order_alphabetical.info.yml:
--------------------------------------------------------------------------------
1 | name: 'Menu order alphabetically'
2 | type: module
3 | description: 'Add alphabetical order options to menu management.'
4 | core_version_requirement: ^8.7.7 || ^9
5 | package: 'Other'
6 | dependencies:
7 |   - drupal:menu_ui
8 | 


--------------------------------------------------------------------------------
/menu_order_alphabetical.routing.yml:
--------------------------------------------------------------------------------
1 | entity.menu_ui.reset_form:
2 |   path: '/admin/structure/menu/manage/{menu}/reset/{menu_link}'
3 |   defaults:
4 |     _form: 'Drupal\menu_order_alphabetical\Form\MenuLinkTreeResetForm'
5 |     _title: 'Reset'
6 |     menu_link: ''
7 |   requirements:
8 |     _permission: 'administer menu'
9 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # Drupal 8 Menu alphabetical order
2 | 
3 | Add alphabetical order option to the menu ui and menu creation.
4 | 
5 | On menu creation from any content type or from the menu ui, the newly created entry will be classed alphabetically, ignoring the weight field value.
6 | 
7 | On menu ui, a _Reset to alphabetical_ option is available like for Taxonomy.
8 | 
9 | This module is compatible with [Big menu](https://www.drupal.org/project/bigmenu)


--------------------------------------------------------------------------------
/composer.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "name": "drupal/menu_order_alphabetical",
 3 |   "type": "drupal-module",
 4 |   "description": "Add alphabetical order option to the menu ui and menu creation.",
 5 |   "keywords": ["Drupal"],
 6 |   "license": "GPL-3.0+",
 7 |   "homepage": "https://github.com/Mogtofu33/menu_order_alphabetical",
 8 |   "minimum-stability": "dev",
 9 |   "support": {
10 |     "issues": "https://github.com/Mogtofu33/menu_order_alphabetical/issues",
11 |     "source": "https://github.com/Mogtofu33/menu_order_alphabetical"
12 |   },
13 |   "require": { }
14 | }
15 | 


--------------------------------------------------------------------------------
/src/Form/MenuLinkTreeResetForm.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | namespace Drupal\menu_order_alphabetical\Form;
  4 | 
  5 | use Drupal\Core\Form\FormStateInterface;
  6 | use Drupal\Core\Url;
  7 | use Drupal\Core\Form\ConfirmFormBase;
  8 | use Drupal\system\Entity\Menu;
  9 | 
 10 | /**
 11 |  * Defines a confirmation form for resetting a menu.
 12 |  */
 13 | class MenuLinkTreeResetForm extends ConfirmFormBase {
 14 | 
 15 |   /**
 16 |    * The menu name.
 17 |    *
 18 |    * @var string
 19 |    */
 20 |   protected $menuName;
 21 | 
 22 |   /**
 23 |    * The parent menu id.
 24 |    *
 25 |    * @var string
 26 |    */
 27 |   protected $parent;
 28 | 
 29 |   /**
 30 |    * The menu entity.
 31 |    *
 32 |    * @var \Drupal\system\Entity\Menu
 33 |    */
 34 |   protected $menu;
 35 | 
 36 |   /**
 37 |    * {@inheritdoc}
 38 |    */
 39 |   public function getFormId() {
 40 |     return 'menu_tree_reset_confirm';
 41 |   }
 42 | 
 43 |   /**
 44 |    * {@inheritdoc}
 45 |    */
 46 |   public function getQuestion() {
 47 |     return $this->t('Are you sure you want to reset the menu %title to alphabetical order?', ['%title' => $this->menu->label()]);
 48 |   }
 49 | 
 50 |   /**
 51 |    * {@inheritdoc}
 52 |    */
 53 |   public function getCancelUrl() {
 54 |     return new Url('entity.menu.edit_form', [
 55 |       'menu' => $this->menuName,
 56 |     ]);
 57 |   }
 58 | 
 59 |   /**
 60 |    * {@inheritdoc}
 61 |    */
 62 |   public function getDescription() {
 63 |     return $this->t('Resetting a menu will discard all custom ordering and sort items alphabetically.');
 64 |   }
 65 | 
 66 |   /**
 67 |    * {@inheritdoc}
 68 |    */
 69 |   public function getConfirmText() {
 70 |     return $this->t('Reset to alphabetical');
 71 |   }
 72 | 
 73 |   /**
 74 |    * {@inheritdoc}
 75 |    */
 76 |   public function buildForm(array $form, FormStateInterface $form_state) {
 77 |     $route_match = $this->getRouteMatch();
 78 |     if (($route_match->getRouteName() == 'entity.menu_ui.reset_form') && $menu = $route_match->getParameter('menu')) {
 79 |       $this->menuName = $menu;
 80 |       $this->menu = Menu::load($menu);
 81 |     }
 82 |     if ($parent = $route_match->getParameter('menu_link')) {
 83 |       $this->parent = $parent;
 84 |     }
 85 | 
 86 |     $form = parent::buildForm($form, $form_state);
 87 |     return $form;
 88 |   }
 89 | 
 90 |   /**
 91 |    * {@inheritdoc}
 92 |    */
 93 |   public function submitForm(array &$form, FormStateInterface $form_state) {
 94 |     // Simple function to set all weights to 0.
 95 |     menu_order_alphabetical_reset($this->menuName, $this->parent);
 96 | 
 97 |     drupal_set_message($this->t('Reset menu %name to alphabetical order.', ['%name' => $this->menuName]));
 98 |     $this->logger('menu_ui')->notice('Reset menu %name to alphabetical order.', ['%name' => $this->menuName]);
 99 |     $form_state->setRedirectUrl($this->getCancelUrl());
100 |   }
101 | 
102 | }
103 | 


--------------------------------------------------------------------------------
/tests/src/Functional/MenuOrderAlphabeticalFormTest.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | namespace Drupal\Tests\menu_order_alphabetical\Functional;
  4 | 
  5 | use Drupal\Tests\BrowserTestBase;
  6 | use Drupal\menu_link_content\Entity\MenuLinkContent;
  7 | use Drupal\Core\StringTranslation\StringTranslationTrait;
  8 | use Drupal\Core\Menu\MenuTreeParameters;
  9 | 
 10 | /**
 11 |  * Test module form.
 12 |  *
 13 |  * @group menu_order_alphabetical
 14 |  */
 15 | class MenuOrderAlphabeticalFormTest extends BrowserTestBase {
 16 |   use StringTranslationTrait;
 17 | 
 18 |   /**
 19 |    * Default Drupal theme to use.
 20 |    *
 21 |    * @var string
 22 |    */
 23 |   protected $defaultTheme = 'stark';
 24 | 
 25 |   /**
 26 |    * {@inheritdoc}
 27 |    */
 28 |   public static $modules = [
 29 |     'menu_link_content',
 30 |     'menu_ui',
 31 |     'menu_order_alphabetical',
 32 |   ];
 33 | 
 34 |   /**
 35 |    * An user with admin permissions.
 36 |    *
 37 |    * @var \Drupal\user\UserInterface
 38 |    */
 39 |   protected $adminUser;
 40 | 
 41 |   /**
 42 |    * {@inheritdoc}
 43 |    */
 44 |   public function setUp() {
 45 |     parent::setUp();
 46 | 
 47 |     $this->adminUser = $this
 48 |       ->drupalCreateUser([
 49 |         'administer menu',
 50 |         'link to any page',
 51 |       ]);
 52 |   }
 53 | 
 54 |   /**
 55 |    * Save, edit and delete a menu using the user interface.
 56 |    */
 57 |   public function testMenuReorder() {
 58 |     // Login.
 59 |     $this->drupalLogin($this->adminUser);
 60 | 
 61 |     $this->drupalGet('admin/structure/menu/manage/main');
 62 | 
 63 |     // Verify that the order alphabetical button is here.
 64 |     $this->assertSession()->buttonExists('Reset to alphabetical');
 65 |     
 66 |     // Create menus in a random order.
 67 |     $menu_link1 = $this->createMenuLink('A menu', 3);
 68 |     $menu_link2 = $this->createMenuLink('B menu', 4);
 69 |     $menu_link3 = $this->createMenuLink('C menu', 1);
 70 |     $menu_link4 = $this->createMenuLink('D menu', 0);
 71 |     $menu_link5 = $this->createMenuLink('E menu', 2);
 72 | 
 73 |     $this->drupalPostForm('admin/structure/menu/manage/main', [], t('Reset to alphabetical'));
 74 |     // Submit confirmation form.
 75 |     $this->drupalPostForm(NULL, [], t('Reset to alphabetical'));
 76 |     // Ensure form redirected back to overview.
 77 |     $this->assertUrl('admin/structure/menu/manage/main');
 78 | 
 79 |     // Check that all links are with weight 0.
 80 |     $links = $this->xpath('//tr/select[@class="menu-weight"]');
 81 |     foreach ($links as $link) {
 82 |       $this->assertTrue($link->getWeight() == 0);
 83 |     }
 84 |   }
 85 | 
 86 |   /**
 87 |    * Returns a new menu link content.
 88 |    *
 89 |    * @param string $title
 90 |    *   The menu title.
 91 |    * @param int $weight
 92 |    *   (optional) The menu weight, default 0.
 93 |    * @param string $uri
 94 |    *   (optional) The menu uri, default front page.
 95 |    * @param string $menu
 96 |    *   (optional) The menu name, default main.
 97 |    *
 98 |    * @return \Drupal\menu_link_content\Entity\MenuLinkContent
 99 |    *   The new menu link content object.
100 |    */
101 |   private function createMenuLink($title, $weight = 0, $uri = 'internal:/', $menu = 'main') {
102 |     $menu_link = MenuLinkContent::create([
103 |       'title' => $title,
104 |       'provider' => 'menu_link_content',
105 |       'menu_name' => $menu,
106 |       'link' => ['uri' => $uri],
107 |       'weight' => $weight,
108 |     ]);
109 |     $menu_link->save();
110 |     return $menu_link;
111 |   }
112 | 
113 | }
114 | 


--------------------------------------------------------------------------------
/menu_order_alphabetical.module:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | /**
  4 |  * @file
  5 |  * Contains menu_order_alphabetical.module.
  6 |  */
  7 | 
  8 | use Drupal\Core\Routing\RouteMatchInterface;
  9 | use Drupal\Core\Form\FormStateInterface;
 10 | use Drupal\menu_link_content\Entity\MenuLinkContent;
 11 | use Drupal\Component\Utility\SortArray;
 12 | use Drupal\Core\Url;
 13 | 
 14 | /**
 15 |  * Implements hook_help().
 16 |  */
 17 | function menu_order_alphabetical_help($route_name, RouteMatchInterface $route_match) {
 18 |   switch ($route_name) {
 19 |     // Main module help for the menu_order_alphabetical module.
 20 |     case 'help.page.menu_order_alphabetical':
 21 |       $output = '';
 22 |       $output .= '<h3>' . t('About') . '</h3>';
 23 |       $output .= '<p>' . t('Add alphabetical order option to the menu ui and menu creation.') . '</p>';
 24 |       return $output;
 25 | 
 26 |     default:
 27 |   }
 28 | }
 29 | 
 30 | /**
 31 |  * Implements hook_entity_type_build().
 32 |  */
 33 | function menu_order_alphabetical_entity_type_build(array &$entity_types) {
 34 |   /* @var $entity_types \Drupal\Core\Entity\EntityTypeInterface[] */
 35 |   $entity_types['menu']
 36 |     ->setFormClass('reset', 'Drupal\menu_order_alphabetical\Form\MenuLinkTreeResetForm')
 37 |     ->setLinkTemplate('reset-form', '/admin/structure/menu/manage/{menu}/reset');
 38 | }
 39 | 
 40 | /**
 41 |  * Implements hook_ENTITY_TYPE_presave().
 42 |  *
 43 |  * For new menu before saving adapt weight for alphabetical prosition.
 44 |  */
 45 | function menu_order_alphabetical_menu_link_content_presave(MenuLinkContent $entity) {
 46 |   // We only process new menu entries.
 47 |   if (!$entity->isNew()) {
 48 |     return;
 49 |   }
 50 |   $id = $entity->getPluginId();
 51 |   $menu_name = $entity->getMenuName();
 52 |   $root = $entity->getParentId();
 53 | 
 54 |   $new_tree = [];
 55 |   if ($tree = _menu_order_alphabetical_get_tree($menu_name, $root)) {
 56 |     // We have a root so start from this root.
 57 |     $tree = reset($tree);
 58 |     if (isset($tree->subtree)) {
 59 |       foreach ($tree->subtree as $menuLinkTree) {
 60 |         $menuLink = $menuLinkTree->link;
 61 |         $new_tree[$menuLink->getPluginId()] = [
 62 |           'id' => $menuLink->getPluginId(),
 63 |           'title' => $menuLink->getTitle(),
 64 |           'weight' => $menuLink->getWeight(),
 65 |         ];
 66 |       }
 67 |     }
 68 |   }
 69 | 
 70 |   if (count($new_tree)) {
 71 |     // Sort by title.
 72 |     uasort($new_tree, [SortArray::class, 'sortByTitleElement']);
 73 |     if (!isset($new_tree[$id])) {
 74 |       // Add our new entry to get the position if not here.
 75 |       $new_tree[$id] = [
 76 |         'id' => $id,
 77 |         'title' => $entity->getTitle(),
 78 |         'weight' => 0,
 79 |       ];
 80 |     }
 81 |     while (current($new_tree) !== $new_tree[$id]) {
 82 |       next($new_tree);
 83 |     }
 84 |     // Start from our link position.
 85 |     current($new_tree);
 86 |     prev($new_tree);
 87 |     $current = current($new_tree);
 88 |     $weight = $current['weight'];
 89 |     // Set the same weight as previous menu, Drupal will order
 90 |     // alphabetically when same weight.
 91 |     $entity->set('weight', $weight);
 92 |   }
 93 | }
 94 | 
 95 | /**
 96 |  * Gets the menu tree.
 97 |  *
 98 |  * @param string $menu_name
 99 |  *   Name of the menu.
100 |  * @param string $root
101 |  *   Parent menu.
102 |  * @param int $depth
103 |  *   Depth max of the menu.
104 |  *
105 |  * @return \Drupal\Core\Menu\MenuLinkTreeElement[]
106 |  *   The Drupal menu tree.
107 |  */
108 | function _menu_order_alphabetical_get_tree($menu_name, $root = NULL, $depth = 1) {
109 |   $menu_tree = \Drupal::menuTree();
110 | 
111 |   // Build the typical default set of menu tree parameters.
112 |   $parameters = $menu_tree->getCurrentRouteMenuTreeParameters($menu_name);
113 |   $parameters->setMaxDepth($depth);
114 |   // Set our parent.
115 |   if ($root) {
116 |     $parameters->setRoot($root);
117 |   }
118 | 
119 |   // Force the entire tree to be build be setting expandParents to an
120 |   // empty array.
121 |   $parameters->expandedParents = [];
122 |   $parameters->activeTrail = [];
123 | 
124 |   // Load the tree based on this set of parameters.
125 |   $tree = $menu_tree->load($menu_name, $parameters);
126 | 
127 |   // Transform the tree using the manipulators you want.
128 |   $manipulators = [
129 |     // Use the default sorting of menu links.
130 |     ['callable' => 'menu.default_tree_manipulators:generateIndexAndSort'],
131 |   ];
132 |   $tree = $menu_tree->transform($tree, $manipulators);
133 | 
134 |   return $tree;
135 | }
136 | 
137 | /**
138 |  * Implements hook_form_FORM_ID_alter().
139 |  */
140 | function menu_order_alphabetical_form_alter(array &$form, FormStateInterface $form_state, $form_id) {
141 |   $form_ids = [
142 |     'menu_edit_form',
143 |     'menu_edit_bigmenu_form',
144 |     'menu_edit_bigmenu_slice_form',
145 |   ];
146 |   if (in_array($form_id, $form_ids)) {
147 |     $form['actions']['reset_alphabetical'] = [
148 |       '#type' => 'submit',
149 |       '#submit' => ['menu_order_alphabetical_submit_reset'],
150 |       '#value' => t('Reset to alphabetical'),
151 |       '#weight' => (int) $form['actions']['submit']['#weight'] + 1,
152 |     ];
153 | 
154 |     // Add the parent menu name if any.
155 |     if ($menu_link_parent = \Drupal::routeMatch()->getParameter('menu_link')) {
156 |       $form['parent_reset'] = [
157 |         '#type' => 'hidden',
158 |         '#value' => $menu_link_parent,
159 |       ];
160 |     }
161 |   }
162 | }
163 | 
164 | /**
165 |  * Redirects to confirmation form for the reset action.
166 |  */
167 | function menu_order_alphabetical_submit_reset(array &$form, FormStateInterface $form_state) {
168 |   $menu = $form_state->getValue('id');
169 |   $menu_parent = $form_state->getValue('parent_reset');
170 |   $form_state->setRedirectUrl(Url::fromRoute('entity.menu_ui.reset_form', ['menu' => $menu, 'menu_link' => $menu_parent]));
171 | }
172 | 
173 | /**
174 |  * Simple reset function for menu weight.
175 |  *
176 |  * We set all weight to 0, Drupal menu will order by natural title.
177 |  */
178 | function menu_order_alphabetical_reset($menu_name, $parent = NULL) {
179 |   $query = \Drupal::database()->update('menu_tree')
180 |     ->fields([
181 |       'weight' => 0,
182 |     ])
183 |     ->condition('menu_name', $menu_name);
184 |   if ($parent) {
185 |     $query->condition('parent', $parent);
186 |   }
187 |   $query->execute();
188 |   $query = \Drupal::database()->update('menu_link_content_data')
189 |     ->fields([
190 |       'weight' => 0,
191 |     ])
192 |     ->condition('menu_name', $menu_name);
193 |   if ($parent) {
194 |     $query->condition('parent', $parent);
195 |   }
196 |   $query->execute();
197 |   // We need to flush menu cache so the menu_ui match the new weights.
198 |   menu_cache_clear_all();
199 | }
200 | 


--------------------------------------------------------------------------------
/.gitlab-ci.yml:
--------------------------------------------------------------------------------
  1 | ################################################################################
  2 | # Gitlab CI integration for Drupal 8/9 project or module: tests, code quality,
  3 | # linting, metrics and deploy samples.
  4 | #
  5 | # Project: https://gitlab.com/mog33/gitlab-ci-drupal
  6 | # Documentation: https://mog33.gitlab.io/gitlab-ci-drupal
  7 | # Issues: https://gitlab.com/mog33/gitlab-ci-drupal/-/issues
  8 | # Author: Jean Valverde contact@dev-drupal.com
  9 | # License: GPL-3
 10 | #
 11 | # If you want to support this project, you can
 12 | # - Buy me a coffee: https://bit.ly/34jPKcE
 13 | # - Hire me as a freelance for any Drupal related work
 14 | # - Promote me to any company looking for any Drupal related work
 15 | # - Help me with testing / documentation / grammar fixes / use cases...
 16 | #
 17 | ################################################################################
 18 | 
 19 | # The ref is relative to the version of the project to use.
 20 | include:
 21 |   # If hosted on gitlab.com.
 22 |   - project: 'mog33/gitlab-ci-drupal'
 23 |     ref: 3.x-dev
 24 |     file: '/.gitlab-ci/.gitlab-ci-template.yml'
 25 |   # If hosted on an other Gitlab instance.
 26 |   # - remote: 'https://gitlab.com/mog33/gitlab-ci-drupal/-/raw/3.x-dev/.gitlab-ci/.gitlab-ci-template.yml'
 27 | 
 28 | # If needed by your Gitlab-ci instance, you can set global tags for all jobs.
 29 | # default:
 30 | #   tags:
 31 | #     - docker
 32 | 
 33 | ################################################################################
 34 | # Gitlab-CI variables documentation:
 35 | # https://docs.gitlab.com/ee/ci/variables/
 36 | #
 37 | # Variables, can be set here or on
 38 | #   Gitlab CI UI > settings > CI/CD > variables
 39 | # UI take precedence on variables here.
 40 | # https://docs.gitlab.com/ee/ci/variables/README.html#priority-of-environment-variables
 41 | ################################################################################
 42 | 
 43 | variables:
 44 |   # This is mandatory to get default variables.
 45 |   # For list of variables see
 46 |   # https://gitlab.com/mog33/gitlab-ci-drupal/-/raw/3.x-dev/.gitlab-ci/ci/variables.yml
 47 |   extends: .default_variables
 48 | 
 49 |   # Minor Drupal version to work with, limited to tags on
 50 |   # https://hub.docker.com/r/mogtofu33/drupal8ci/tags
 51 |   CI_DRUPAL_VERSION:
 52 |     value: "9.3"
 53 |     description: The version of Drupal to use for this Pipeline.
 54 | 
 55 |   # For a project based on Drupal this is 'web'. Can be 'docroot' on some
 56 |   # distributions like 'varbase'.
 57 |   DRUPAL_WEB_ROOT: web
 58 | 
 59 |   ##############################################################################
 60 |   # Tests disabled by default because need a specific setup / configuration.
 61 |   #
 62 |   # Only needed if you have Behat tests, comment or set to 0 to enable.
 63 |   # https://mog33.gitlab.io/gitlab-ci-drupal/advanced-usage/#behat-tests
 64 |   SKIP_TEST_BEHAT: 1
 65 |   # Can use a profile setup or a dump file in dump/
 66 |   BEHAT_INSTALL_PROFILE: "minimal"
 67 | 
 68 |   # Accessibility tests.
 69 |   # https://mog33.gitlab.io/gitlab-ci-drupal/advanced-usage/#accessibility-with-pa11y
 70 |   SKIP_TEST_PA11Y: 1
 71 |   # Can use a profile setup or a dump file in dump/
 72 |   PA11Y_INSTALL_PROFILE: "minimal"
 73 | 
 74 |   # Only if you have Nightwatch tests in your code.
 75 |   # https://mog33.gitlab.io/gitlab-ci-drupal/advanced-usage/#nightwatchjs
 76 |   SKIP_TEST_NIGHTWATCH: 1
 77 |   # Default is '--skiptags core', add your tag.
 78 |   # NIGHTWATCH_TESTS: --tag my_module
 79 | 
 80 |   # Phpunit tests to run, default provide only custom code or if this variable
 81 |   # is empty all tests (including Drupal core).
 82 |   # https://mog33.gitlab.io/gitlab-ci-drupal/advanced-usage/#phpunit-tests
 83 |   PHPUNIT_TESTS: "custom"
 84 | 
 85 |   # Specify a group of tests to run rather than all tests in the suite.
 86 |   # PHPUNIT_GROUP: my_group_1,my_group_2
 87 | 
 88 |   ##############################################################################
 89 |   # Override default variables for a module.
 90 |   #
 91 |   # Default CI setup is for a 'project' (full Drupal with a composer.json), next
 92 |   # section contains common variables to change for a module (module, theme or
 93 |   # profile). Simply uncomment and adapt dirs to set the CI for a module.
 94 |   #
 95 |   CI_TYPE: module
 96 |   # Code quality dirs, must include your PHP code to check.
 97 |   # Phpstan need autoloading, that's why we use web_root.
 98 |   DIRS_QA: "${WEB_ROOT}/modules/custom"
 99 |   # Eslint / Stylelint files to test.
100 |   DIRS_JS: "${CI_PROJECT_DIR}/js/*.js"
101 |   DIRS_CSS: "${CI_PROJECT_DIR}/css/*.css"
102 |   # Twig files to test.
103 |   DIRS_TWIG: "${CI_PROJECT_DIR}/templates"
104 |   # phpmetrics / phpstats dirs to include.
105 |   DIRS_PHP: "${CI_PROJECT_DIR}"
106 |   # Set SKIP_XXX variable to 1 to skip.
107 |   # Security is for a Drupal project with third party.
108 |   SKIP_TEST_SECURITY: 1
109 |   # If you don't have any css files, you can skip with
110 |   SKIP_LINT_CSS: 1
111 |   # If you don't have any javascript files, you can skip with
112 |   SKIP_LINT_JS: 1
113 |   # If you don't have any twig files, you can skip with
114 |   SKIP_LINT_TWIG: 1
115 |   #
116 |   ##############################################################################
117 | 
118 |   ##############################################################################
119 |   # As a sample here is a list of some variables, see documentation for more
120 |   # variables.
121 |   #
122 |   # List of DIRS_* variables to define dirs to analyse for specific jobs.
123 |   # Code quality dirs, must include your PHP code to check.
124 |   # 
125 |   # DIRS_QA: "${WEB_ROOT}/modules/custom,${WEB_ROOT}/themes/custom"
126 |   # 
127 |   # Eslint / Stylelint files to test.
128 |   # Space separated for multiple folders.
129 |   # Default is to check files under all custom folders.
130 |   # 
131 |   # DIRS_JS: "${WEB_ROOT}/**/custom/**/*.js"
132 |   # DIRS_CSS: "${WEB_ROOT}/**/custom/**/css/*.css"
133 |   # 
134 |   # Twig files to test, recursive.
135 |   # 
136 |   # DIRS_TWIG: "${WEB_ROOT}/themes/custom"
137 |   # 
138 |   # Phpmetrics / Phpstats dirs to include.
139 |   # Default is to check all dirs.
140 |   # 
141 |   # DIRS_PHP: "${WEB_ROOT}/modules/custom,${WEB_ROOT}/themes/custom"
142 |   #
143 |   # # ALL SKIP variables, uncomment and set to 1 to skip a job.
144 |   # SKIP_BUILD: 1 # if not running any tests or deploy.
145 |   #
146 |   # SKIP_TESTS: 1 # Skip all tests, ignore SKIP_TEST_*.
147 |   SKIP_TEST_UNITKERNEL: 1
148 |   # SKIP_TEST_FUNCTIONAL: 1
149 |   SKIP_TEST_FUNCTIONALJS: 1
150 |   # SKIP_TEST_SECURITY: 1
151 |   #
152 |   SKIP_QA: 1
153 |   #
154 |   # SKIP_LINT: 1 # Skip all lint, ignore SKIP_LINT_*.
155 |   # SKIP_LINT_CSS: 1
156 |   # SKIP_LINT_JS: 1
157 |   # SKIP_LINT_TWIG: 1
158 |   #
159 |   # SKIP_METRICS: 1
160 | 
161 |   # QA and Metrics tools.
162 |   # See Phpqa available tools: https://github.com/EdgedesignCZ/phpqa#available-tools
163 |   # ':0' is the number of errors allowed, default here is very strict.
164 |   #
165 |   # TOOLS_QA: "phpcs:0,phpmd:0,parallel-lint:0,phpstan:0,phpcpd:0"
166 |   # TOOLS_METRICS: "phpmetrics,phploc,pdepend"
167 | 
168 | ################################################################################
169 | # Advanced usage with this file, see doc.
170 | # https://mog33.gitlab.io/gitlab-ci-drupal/advanced-usage
171 | ################################################################################
172 | 
173 | stages:
174 |   - build
175 |   - tests
176 |   - metrics
177 |   - reports
178 | 
179 | pages:
180 |   stage: reports
181 |   extends: .simple_dashboard
182 |   rules:
183 |     - when: always
184 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
  1 |                     GNU GENERAL PUBLIC LICENSE
  2 |                        Version 3, 29 June 2007
  3 | 
  4 |  Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
  5 |  Everyone is permitted to copy and distribute verbatim copies
  6 |  of this license document, but changing it is not allowed.
  7 | 
  8 |                             Preamble
  9 | 
 10 |   The GNU General Public License is a free, copyleft license for
 11 | software and other kinds of works.
 12 | 
 13 |   The licenses for most software and other practical works are designed
 14 | to take away your freedom to share and change the works.  By contrast,
 15 | the GNU General Public License is intended to guarantee your freedom to
 16 | share and change all versions of a program--to make sure it remains free
 17 | software for all its users.  We, the Free Software Foundation, use the
 18 | GNU General Public License for most of our software; it applies also to
 19 | any other work released this way by its authors.  You can apply it to
 20 | your programs, too.
 21 | 
 22 |   When we speak of free software, we are referring to freedom, not
 23 | price.  Our General Public Licenses are designed to make sure that you
 24 | have the freedom to distribute copies of free software (and charge for
 25 | them if you wish), that you receive source code or can get it if you
 26 | want it, that you can change the software or use pieces of it in new
 27 | free programs, and that you know you can do these things.
 28 | 
 29 |   To protect your rights, we need to prevent others from denying you
 30 | these rights or asking you to surrender the rights.  Therefore, you have
 31 | certain responsibilities if you distribute copies of the software, or if
 32 | you modify it: responsibilities to respect the freedom of others.
 33 | 
 34 |   For example, if you distribute copies of such a program, whether
 35 | gratis or for a fee, you must pass on to the recipients the same
 36 | freedoms that you received.  You must make sure that they, too, receive
 37 | or can get the source code.  And you must show them these terms so they
 38 | know their rights.
 39 | 
 40 |   Developers that use the GNU GPL protect your rights with two steps:
 41 | (1) assert copyright on the software, and (2) offer you this License
 42 | giving you legal permission to copy, distribute and/or modify it.
 43 | 
 44 |   For the developers' and authors' protection, the GPL clearly explains
 45 | that there is no warranty for this free software.  For both users' and
 46 | authors' sake, the GPL requires that modified versions be marked as
 47 | changed, so that their problems will not be attributed erroneously to
 48 | authors of previous versions.
 49 | 
 50 |   Some devices are designed to deny users access to install or run
 51 | modified versions of the software inside them, although the manufacturer
 52 | can do so.  This is fundamentally incompatible with the aim of
 53 | protecting users' freedom to change the software.  The systematic
 54 | pattern of such abuse occurs in the area of products for individuals to
 55 | use, which is precisely where it is most unacceptable.  Therefore, we
 56 | have designed this version of the GPL to prohibit the practice for those
 57 | products.  If such problems arise substantially in other domains, we
 58 | stand ready to extend this provision to those domains in future versions
 59 | of the GPL, as needed to protect the freedom of users.
 60 | 
 61 |   Finally, every program is threatened constantly by software patents.
 62 | States should not allow patents to restrict development and use of
 63 | software on general-purpose computers, but in those that do, we wish to
 64 | avoid the special danger that patents applied to a free program could
 65 | make it effectively proprietary.  To prevent this, the GPL assures that
 66 | patents cannot be used to render the program non-free.
 67 | 
 68 |   The precise terms and conditions for copying, distribution and
 69 | modification follow.
 70 | 
 71 |                        TERMS AND CONDITIONS
 72 | 
 73 |   0. Definitions.
 74 | 
 75 |   "This License" refers to version 3 of the GNU General Public License.
 76 | 
 77 |   "Copyright" also means copyright-like laws that apply to other kinds of
 78 | works, such as semiconductor masks.
 79 | 
 80 |   "The Program" refers to any copyrightable work licensed under this
 81 | License.  Each licensee is addressed as "you".  "Licensees" and
 82 | "recipients" may be individuals or organizations.
 83 | 
 84 |   To "modify" a work means to copy from or adapt all or part of the work
 85 | in a fashion requiring copyright permission, other than the making of an
 86 | exact copy.  The resulting work is called a "modified version" of the
 87 | earlier work or a work "based on" the earlier work.
 88 | 
 89 |   A "covered work" means either the unmodified Program or a work based
 90 | on the Program.
 91 | 
 92 |   To "propagate" a work means to do anything with it that, without
 93 | permission, would make you directly or secondarily liable for
 94 | infringement under applicable copyright law, except executing it on a
 95 | computer or modifying a private copy.  Propagation includes copying,
 96 | distribution (with or without modification), making available to the
 97 | public, and in some countries other activities as well.
 98 | 
 99 |   To "convey" a work means any kind of propagation that enables other
100 | parties to make or receive copies.  Mere interaction with a user through
101 | a computer network, with no transfer of a copy, is not conveying.
102 | 
103 |   An interactive user interface displays "Appropriate Legal Notices"
104 | to the extent that it includes a convenient and prominently visible
105 | feature that (1) displays an appropriate copyright notice, and (2)
106 | tells the user that there is no warranty for the work (except to the
107 | extent that warranties are provided), that licensees may convey the
108 | work under this License, and how to view a copy of this License.  If
109 | the interface presents a list of user commands or options, such as a
110 | menu, a prominent item in the list meets this criterion.
111 | 
112 |   1. Source Code.
113 | 
114 |   The "source code" for a work means the preferred form of the work
115 | for making modifications to it.  "Object code" means any non-source
116 | form of a work.
117 | 
118 |   A "Standard Interface" means an interface that either is an official
119 | standard defined by a recognized standards body, or, in the case of
120 | interfaces specified for a particular programming language, one that
121 | is widely used among developers working in that language.
122 | 
123 |   The "System Libraries" of an executable work include anything, other
124 | than the work as a whole, that (a) is included in the normal form of
125 | packaging a Major Component, but which is not part of that Major
126 | Component, and (b) serves only to enable use of the work with that
127 | Major Component, or to implement a Standard Interface for which an
128 | implementation is available to the public in source code form.  A
129 | "Major Component", in this context, means a major essential component
130 | (kernel, window system, and so on) of the specific operating system
131 | (if any) on which the executable work runs, or a compiler used to
132 | produce the work, or an object code interpreter used to run it.
133 | 
134 |   The "Corresponding Source" for a work in object code form means all
135 | the source code needed to generate, install, and (for an executable
136 | work) run the object code and to modify the work, including scripts to
137 | control those activities.  However, it does not include the work's
138 | System Libraries, or general-purpose tools or generally available free
139 | programs which are used unmodified in performing those activities but
140 | which are not part of the work.  For example, Corresponding Source
141 | includes interface definition files associated with source files for
142 | the work, and the source code for shared libraries and dynamically
143 | linked subprograms that the work is specifically designed to require,
144 | such as by intimate data communication or control flow between those
145 | subprograms and other parts of the work.
146 | 
147 |   The Corresponding Source need not include anything that users
148 | can regenerate automatically from other parts of the Corresponding
149 | Source.
150 | 
151 |   The Corresponding Source for a work in source code form is that
152 | same work.
153 | 
154 |   2. Basic Permissions.
155 | 
156 |   All rights granted under this License are granted for the term of
157 | copyright on the Program, and are irrevocable provided the stated
158 | conditions are met.  This License explicitly affirms your unlimited
159 | permission to run the unmodified Program.  The output from running a
160 | covered work is covered by this License only if the output, given its
161 | content, constitutes a covered work.  This License acknowledges your
162 | rights of fair use or other equivalent, as provided by copyright law.
163 | 
164 |   You may make, run and propagate covered works that you do not
165 | convey, without conditions so long as your license otherwise remains
166 | in force.  You may convey covered works to others for the sole purpose
167 | of having them make modifications exclusively for you, or provide you
168 | with facilities for running those works, provided that you comply with
169 | the terms of this License in conveying all material for which you do
170 | not control copyright.  Those thus making or running the covered works
171 | for you must do so exclusively on your behalf, under your direction
172 | and control, on terms that prohibit them from making any copies of
173 | your copyrighted material outside their relationship with you.
174 | 
175 |   Conveying under any other circumstances is permitted solely under
176 | the conditions stated below.  Sublicensing is not allowed; section 10
177 | makes it unnecessary.
178 | 
179 |   3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180 | 
181 |   No covered work shall be deemed part of an effective technological
182 | measure under any applicable law fulfilling obligations under article
183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
184 | similar laws prohibiting or restricting circumvention of such
185 | measures.
186 | 
187 |   When you convey a covered work, you waive any legal power to forbid
188 | circumvention of technological measures to the extent such circumvention
189 | is effected by exercising rights under this License with respect to
190 | the covered work, and you disclaim any intention to limit operation or
191 | modification of the work as a means of enforcing, against the work's
192 | users, your or third parties' legal rights to forbid circumvention of
193 | technological measures.
194 | 
195 |   4. Conveying Verbatim Copies.
196 | 
197 |   You may convey verbatim copies of the Program's source code as you
198 | receive it, in any medium, provided that you conspicuously and
199 | appropriately publish on each copy an appropriate copyright notice;
200 | keep intact all notices stating that this License and any
201 | non-permissive terms added in accord with section 7 apply to the code;
202 | keep intact all notices of the absence of any warranty; and give all
203 | recipients a copy of this License along with the Program.
204 | 
205 |   You may charge any price or no price for each copy that you convey,
206 | and you may offer support or warranty protection for a fee.
207 | 
208 |   5. Conveying Modified Source Versions.
209 | 
210 |   You may convey a work based on the Program, or the modifications to
211 | produce it from the Program, in the form of source code under the
212 | terms of section 4, provided that you also meet all of these conditions:
213 | 
214 |     a) The work must carry prominent notices stating that you modified
215 |     it, and giving a relevant date.
216 | 
217 |     b) The work must carry prominent notices stating that it is
218 |     released under this License and any conditions added under section
219 |     7.  This requirement modifies the requirement in section 4 to
220 |     "keep intact all notices".
221 | 
222 |     c) You must license the entire work, as a whole, under this
223 |     License to anyone who comes into possession of a copy.  This
224 |     License will therefore apply, along with any applicable section 7
225 |     additional terms, to the whole of the work, and all its parts,
226 |     regardless of how they are packaged.  This License gives no
227 |     permission to license the work in any other way, but it does not
228 |     invalidate such permission if you have separately received it.
229 | 
230 |     d) If the work has interactive user interfaces, each must display
231 |     Appropriate Legal Notices; however, if the Program has interactive
232 |     interfaces that do not display Appropriate Legal Notices, your
233 |     work need not make them do so.
234 | 
235 |   A compilation of a covered work with other separate and independent
236 | works, which are not by their nature extensions of the covered work,
237 | and which are not combined with it such as to form a larger program,
238 | in or on a volume of a storage or distribution medium, is called an
239 | "aggregate" if the compilation and its resulting copyright are not
240 | used to limit the access or legal rights of the compilation's users
241 | beyond what the individual works permit.  Inclusion of a covered work
242 | in an aggregate does not cause this License to apply to the other
243 | parts of the aggregate.
244 | 
245 |   6. Conveying Non-Source Forms.
246 | 
247 |   You may convey a covered work in object code form under the terms
248 | of sections 4 and 5, provided that you also convey the
249 | machine-readable Corresponding Source under the terms of this License,
250 | in one of these ways:
251 | 
252 |     a) Convey the object code in, or embodied in, a physical product
253 |     (including a physical distribution medium), accompanied by the
254 |     Corresponding Source fixed on a durable physical medium
255 |     customarily used for software interchange.
256 | 
257 |     b) Convey the object code in, or embodied in, a physical product
258 |     (including a physical distribution medium), accompanied by a
259 |     written offer, valid for at least three years and valid for as
260 |     long as you offer spare parts or customer support for that product
261 |     model, to give anyone who possesses the object code either (1) a
262 |     copy of the Corresponding Source for all the software in the
263 |     product that is covered by this License, on a durable physical
264 |     medium customarily used for software interchange, for a price no
265 |     more than your reasonable cost of physically performing this
266 |     conveying of source, or (2) access to copy the
267 |     Corresponding Source from a network server at no charge.
268 | 
269 |     c) Convey individual copies of the object code with a copy of the
270 |     written offer to provide the Corresponding Source.  This
271 |     alternative is allowed only occasionally and noncommercially, and
272 |     only if you received the object code with such an offer, in accord
273 |     with subsection 6b.
274 | 
275 |     d) Convey the object code by offering access from a designated
276 |     place (gratis or for a charge), and offer equivalent access to the
277 |     Corresponding Source in the same way through the same place at no
278 |     further charge.  You need not require recipients to copy the
279 |     Corresponding Source along with the object code.  If the place to
280 |     copy the object code is a network server, the Corresponding Source
281 |     may be on a different server (operated by you or a third party)
282 |     that supports equivalent copying facilities, provided you maintain
283 |     clear directions next to the object code saying where to find the
284 |     Corresponding Source.  Regardless of what server hosts the
285 |     Corresponding Source, you remain obligated to ensure that it is
286 |     available for as long as needed to satisfy these requirements.
287 | 
288 |     e) Convey the object code using peer-to-peer transmission, provided
289 |     you inform other peers where the object code and Corresponding
290 |     Source of the work are being offered to the general public at no
291 |     charge under subsection 6d.
292 | 
293 |   A separable portion of the object code, whose source code is excluded
294 | from the Corresponding Source as a System Library, need not be
295 | included in conveying the object code work.
296 | 
297 |   A "User Product" is either (1) a "consumer product", which means any
298 | tangible personal property which is normally used for personal, family,
299 | or household purposes, or (2) anything designed or sold for incorporation
300 | into a dwelling.  In determining whether a product is a consumer product,
301 | doubtful cases shall be resolved in favor of coverage.  For a particular
302 | product received by a particular user, "normally used" refers to a
303 | typical or common use of that class of product, regardless of the status
304 | of the particular user or of the way in which the particular user
305 | actually uses, or expects or is expected to use, the product.  A product
306 | is a consumer product regardless of whether the product has substantial
307 | commercial, industrial or non-consumer uses, unless such uses represent
308 | the only significant mode of use of the product.
309 | 
310 |   "Installation Information" for a User Product means any methods,
311 | procedures, authorization keys, or other information required to install
312 | and execute modified versions of a covered work in that User Product from
313 | a modified version of its Corresponding Source.  The information must
314 | suffice to ensure that the continued functioning of the modified object
315 | code is in no case prevented or interfered with solely because
316 | modification has been made.
317 | 
318 |   If you convey an object code work under this section in, or with, or
319 | specifically for use in, a User Product, and the conveying occurs as
320 | part of a transaction in which the right of possession and use of the
321 | User Product is transferred to the recipient in perpetuity or for a
322 | fixed term (regardless of how the transaction is characterized), the
323 | Corresponding Source conveyed under this section must be accompanied
324 | by the Installation Information.  But this requirement does not apply
325 | if neither you nor any third party retains the ability to install
326 | modified object code on the User Product (for example, the work has
327 | been installed in ROM).
328 | 
329 |   The requirement to provide Installation Information does not include a
330 | requirement to continue to provide support service, warranty, or updates
331 | for a work that has been modified or installed by the recipient, or for
332 | the User Product in which it has been modified or installed.  Access to a
333 | network may be denied when the modification itself materially and
334 | adversely affects the operation of the network or violates the rules and
335 | protocols for communication across the network.
336 | 
337 |   Corresponding Source conveyed, and Installation Information provided,
338 | in accord with this section must be in a format that is publicly
339 | documented (and with an implementation available to the public in
340 | source code form), and must require no special password or key for
341 | unpacking, reading or copying.
342 | 
343 |   7. Additional Terms.
344 | 
345 |   "Additional permissions" are terms that supplement the terms of this
346 | License by making exceptions from one or more of its conditions.
347 | Additional permissions that are applicable to the entire Program shall
348 | be treated as though they were included in this License, to the extent
349 | that they are valid under applicable law.  If additional permissions
350 | apply only to part of the Program, that part may be used separately
351 | under those permissions, but the entire Program remains governed by
352 | this License without regard to the additional permissions.
353 | 
354 |   When you convey a copy of a covered work, you may at your option
355 | remove any additional permissions from that copy, or from any part of
356 | it.  (Additional permissions may be written to require their own
357 | removal in certain cases when you modify the work.)  You may place
358 | additional permissions on material, added by you to a covered work,
359 | for which you have or can give appropriate copyright permission.
360 | 
361 |   Notwithstanding any other provision of this License, for material you
362 | add to a covered work, you may (if authorized by the copyright holders of
363 | that material) supplement the terms of this License with terms:
364 | 
365 |     a) Disclaiming warranty or limiting liability differently from the
366 |     terms of sections 15 and 16 of this License; or
367 | 
368 |     b) Requiring preservation of specified reasonable legal notices or
369 |     author attributions in that material or in the Appropriate Legal
370 |     Notices displayed by works containing it; or
371 | 
372 |     c) Prohibiting misrepresentation of the origin of that material, or
373 |     requiring that modified versions of such material be marked in
374 |     reasonable ways as different from the original version; or
375 | 
376 |     d) Limiting the use for publicity purposes of names of licensors or
377 |     authors of the material; or
378 | 
379 |     e) Declining to grant rights under trademark law for use of some
380 |     trade names, trademarks, or service marks; or
381 | 
382 |     f) Requiring indemnification of licensors and authors of that
383 |     material by anyone who conveys the material (or modified versions of
384 |     it) with contractual assumptions of liability to the recipient, for
385 |     any liability that these contractual assumptions directly impose on
386 |     those licensors and authors.
387 | 
388 |   All other non-permissive additional terms are considered "further
389 | restrictions" within the meaning of section 10.  If the Program as you
390 | received it, or any part of it, contains a notice stating that it is
391 | governed by this License along with a term that is a further
392 | restriction, you may remove that term.  If a license document contains
393 | a further restriction but permits relicensing or conveying under this
394 | License, you may add to a covered work material governed by the terms
395 | of that license document, provided that the further restriction does
396 | not survive such relicensing or conveying.
397 | 
398 |   If you add terms to a covered work in accord with this section, you
399 | must place, in the relevant source files, a statement of the
400 | additional terms that apply to those files, or a notice indicating
401 | where to find the applicable terms.
402 | 
403 |   Additional terms, permissive or non-permissive, may be stated in the
404 | form of a separately written license, or stated as exceptions;
405 | the above requirements apply either way.
406 | 
407 |   8. Termination.
408 | 
409 |   You may not propagate or modify a covered work except as expressly
410 | provided under this License.  Any attempt otherwise to propagate or
411 | modify it is void, and will automatically terminate your rights under
412 | this License (including any patent licenses granted under the third
413 | paragraph of section 11).
414 | 
415 |   However, if you cease all violation of this License, then your
416 | license from a particular copyright holder is reinstated (a)
417 | provisionally, unless and until the copyright holder explicitly and
418 | finally terminates your license, and (b) permanently, if the copyright
419 | holder fails to notify you of the violation by some reasonable means
420 | prior to 60 days after the cessation.
421 | 
422 |   Moreover, your license from a particular copyright holder is
423 | reinstated permanently if the copyright holder notifies you of the
424 | violation by some reasonable means, this is the first time you have
425 | received notice of violation of this License (for any work) from that
426 | copyright holder, and you cure the violation prior to 30 days after
427 | your receipt of the notice.
428 | 
429 |   Termination of your rights under this section does not terminate the
430 | licenses of parties who have received copies or rights from you under
431 | this License.  If your rights have been terminated and not permanently
432 | reinstated, you do not qualify to receive new licenses for the same
433 | material under section 10.
434 | 
435 |   9. Acceptance Not Required for Having Copies.
436 | 
437 |   You are not required to accept this License in order to receive or
438 | run a copy of the Program.  Ancillary propagation of a covered work
439 | occurring solely as a consequence of using peer-to-peer transmission
440 | to receive a copy likewise does not require acceptance.  However,
441 | nothing other than this License grants you permission to propagate or
442 | modify any covered work.  These actions infringe copyright if you do
443 | not accept this License.  Therefore, by modifying or propagating a
444 | covered work, you indicate your acceptance of this License to do so.
445 | 
446 |   10. Automatic Licensing of Downstream Recipients.
447 | 
448 |   Each time you convey a covered work, the recipient automatically
449 | receives a license from the original licensors, to run, modify and
450 | propagate that work, subject to this License.  You are not responsible
451 | for enforcing compliance by third parties with this License.
452 | 
453 |   An "entity transaction" is a transaction transferring control of an
454 | organization, or substantially all assets of one, or subdividing an
455 | organization, or merging organizations.  If propagation of a covered
456 | work results from an entity transaction, each party to that
457 | transaction who receives a copy of the work also receives whatever
458 | licenses to the work the party's predecessor in interest had or could
459 | give under the previous paragraph, plus a right to possession of the
460 | Corresponding Source of the work from the predecessor in interest, if
461 | the predecessor has it or can get it with reasonable efforts.
462 | 
463 |   You may not impose any further restrictions on the exercise of the
464 | rights granted or affirmed under this License.  For example, you may
465 | not impose a license fee, royalty, or other charge for exercise of
466 | rights granted under this License, and you may not initiate litigation
467 | (including a cross-claim or counterclaim in a lawsuit) alleging that
468 | any patent claim is infringed by making, using, selling, offering for
469 | sale, or importing the Program or any portion of it.
470 | 
471 |   11. Patents.
472 | 
473 |   A "contributor" is a copyright holder who authorizes use under this
474 | License of the Program or a work on which the Program is based.  The
475 | work thus licensed is called the contributor's "contributor version".
476 | 
477 |   A contributor's "essential patent claims" are all patent claims
478 | owned or controlled by the contributor, whether already acquired or
479 | hereafter acquired, that would be infringed by some manner, permitted
480 | by this License, of making, using, or selling its contributor version,
481 | but do not include claims that would be infringed only as a
482 | consequence of further modification of the contributor version.  For
483 | purposes of this definition, "control" includes the right to grant
484 | patent sublicenses in a manner consistent with the requirements of
485 | this License.
486 | 
487 |   Each contributor grants you a non-exclusive, worldwide, royalty-free
488 | patent license under the contributor's essential patent claims, to
489 | make, use, sell, offer for sale, import and otherwise run, modify and
490 | propagate the contents of its contributor version.
491 | 
492 |   In the following three paragraphs, a "patent license" is any express
493 | agreement or commitment, however denominated, not to enforce a patent
494 | (such as an express permission to practice a patent or covenant not to
495 | sue for patent infringement).  To "grant" such a patent license to a
496 | party means to make such an agreement or commitment not to enforce a
497 | patent against the party.
498 | 
499 |   If you convey a covered work, knowingly relying on a patent license,
500 | and the Corresponding Source of the work is not available for anyone
501 | to copy, free of charge and under the terms of this License, through a
502 | publicly available network server or other readily accessible means,
503 | then you must either (1) cause the Corresponding Source to be so
504 | available, or (2) arrange to deprive yourself of the benefit of the
505 | patent license for this particular work, or (3) arrange, in a manner
506 | consistent with the requirements of this License, to extend the patent
507 | license to downstream recipients.  "Knowingly relying" means you have
508 | actual knowledge that, but for the patent license, your conveying the
509 | covered work in a country, or your recipient's use of the covered work
510 | in a country, would infringe one or more identifiable patents in that
511 | country that you have reason to believe are valid.
512 | 
513 |   If, pursuant to or in connection with a single transaction or
514 | arrangement, you convey, or propagate by procuring conveyance of, a
515 | covered work, and grant a patent license to some of the parties
516 | receiving the covered work authorizing them to use, propagate, modify
517 | or convey a specific copy of the covered work, then the patent license
518 | you grant is automatically extended to all recipients of the covered
519 | work and works based on it.
520 | 
521 |   A patent license is "discriminatory" if it does not include within
522 | the scope of its coverage, prohibits the exercise of, or is
523 | conditioned on the non-exercise of one or more of the rights that are
524 | specifically granted under this License.  You may not convey a covered
525 | work if you are a party to an arrangement with a third party that is
526 | in the business of distributing software, under which you make payment
527 | to the third party based on the extent of your activity of conveying
528 | the work, and under which the third party grants, to any of the
529 | parties who would receive the covered work from you, a discriminatory
530 | patent license (a) in connection with copies of the covered work
531 | conveyed by you (or copies made from those copies), or (b) primarily
532 | for and in connection with specific products or compilations that
533 | contain the covered work, unless you entered into that arrangement,
534 | or that patent license was granted, prior to 28 March 2007.
535 | 
536 |   Nothing in this License shall be construed as excluding or limiting
537 | any implied license or other defenses to infringement that may
538 | otherwise be available to you under applicable patent law.
539 | 
540 |   12. No Surrender of Others' Freedom.
541 | 
542 |   If conditions are imposed on you (whether by court order, agreement or
543 | otherwise) that contradict the conditions of this License, they do not
544 | excuse you from the conditions of this License.  If you cannot convey a
545 | covered work so as to satisfy simultaneously your obligations under this
546 | License and any other pertinent obligations, then as a consequence you may
547 | not convey it at all.  For example, if you agree to terms that obligate you
548 | to collect a royalty for further conveying from those to whom you convey
549 | the Program, the only way you could satisfy both those terms and this
550 | License would be to refrain entirely from conveying the Program.
551 | 
552 |   13. Use with the GNU Affero General Public License.
553 | 
554 |   Notwithstanding any other provision of this License, you have
555 | permission to link or combine any covered work with a work licensed
556 | under version 3 of the GNU Affero General Public License into a single
557 | combined work, and to convey the resulting work.  The terms of this
558 | License will continue to apply to the part which is the covered work,
559 | but the special requirements of the GNU Affero General Public License,
560 | section 13, concerning interaction through a network will apply to the
561 | combination as such.
562 | 
563 |   14. Revised Versions of this License.
564 | 
565 |   The Free Software Foundation may publish revised and/or new versions of
566 | the GNU General Public License from time to time.  Such new versions will
567 | be similar in spirit to the present version, but may differ in detail to
568 | address new problems or concerns.
569 | 
570 |   Each version is given a distinguishing version number.  If the
571 | Program specifies that a certain numbered version of the GNU General
572 | Public License "or any later version" applies to it, you have the
573 | option of following the terms and conditions either of that numbered
574 | version or of any later version published by the Free Software
575 | Foundation.  If the Program does not specify a version number of the
576 | GNU General Public License, you may choose any version ever published
577 | by the Free Software Foundation.
578 | 
579 |   If the Program specifies that a proxy can decide which future
580 | versions of the GNU General Public License can be used, that proxy's
581 | public statement of acceptance of a version permanently authorizes you
582 | to choose that version for the Program.
583 | 
584 |   Later license versions may give you additional or different
585 | permissions.  However, no additional obligations are imposed on any
586 | author or copyright holder as a result of your choosing to follow a
587 | later version.
588 | 
589 |   15. Disclaimer of Warranty.
590 | 
591 |   THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592 | APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596 | PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597 | IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599 | 
600 |   16. Limitation of Liability.
601 | 
602 |   IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610 | SUCH DAMAGES.
611 | 
612 |   17. Interpretation of Sections 15 and 16.
613 | 
614 |   If the disclaimer of warranty and limitation of liability provided
615 | above cannot be given local legal effect according to their terms,
616 | reviewing courts shall apply local law that most closely approximates
617 | an absolute waiver of all civil liability in connection with the
618 | Program, unless a warranty or assumption of liability accompanies a
619 | copy of the Program in return for a fee.
620 | 
621 |                      END OF TERMS AND CONDITIONS
622 | 
623 |             How to Apply These Terms to Your New Programs
624 | 
625 |   If you develop a new program, and you want it to be of the greatest
626 | possible use to the public, the best way to achieve this is to make it
627 | free software which everyone can redistribute and change under these terms.
628 | 
629 |   To do so, attach the following notices to the program.  It is safest
630 | to attach them to the start of each source file to most effectively
631 | state the exclusion of warranty; and each file should have at least
632 | the "copyright" line and a pointer to where the full notice is found.
633 | 
634 |     <one line to give the program's name and a brief idea of what it does.>
635 |     Copyright (C) <year>  <name of author>
636 | 
637 |     This program is free software: you can redistribute it and/or modify
638 |     it under the terms of the GNU General Public License as published by
639 |     the Free Software Foundation, either version 3 of the License, or
640 |     (at your option) any later version.
641 | 
642 |     This program is distributed in the hope that it will be useful,
643 |     but WITHOUT ANY WARRANTY; without even the implied warranty of
644 |     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
645 |     GNU General Public License for more details.
646 | 
647 |     You should have received a copy of the GNU General Public License
648 |     along with this program.  If not, see <http://www.gnu.org/licenses/>.
649 | 
650 | Also add information on how to contact you by electronic and paper mail.
651 | 
652 |   If the program does terminal interaction, make it output a short
653 | notice like this when it starts in an interactive mode:
654 | 
655 |     <program>  Copyright (C) <year>  <name of author>
656 |     This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657 |     This is free software, and you are welcome to redistribute it
658 |     under certain conditions; type `show c' for details.
659 | 
660 | The hypothetical commands `show w' and `show c' should show the appropriate
661 | parts of the General Public License.  Of course, your program's commands
662 | might be different; for a GUI interface, you would use an "about box".
663 | 
664 |   You should also get your employer (if you work as a programmer) or school,
665 | if any, to sign a "copyright disclaimer" for the program, if necessary.
666 | For more information on this, and how to apply and follow the GNU GPL, see
667 | <http://www.gnu.org/licenses/>.
668 | 
669 |   The GNU General Public License does not permit incorporating your program
670 | into proprietary programs.  If your program is a subroutine library, you
671 | may consider it more useful to permit linking proprietary applications with
672 | the library.  If this is what you want to do, use the GNU Lesser General
673 | Public License instead of this License.  But first, please read
674 | <http://www.gnu.org/philosophy/why-not-lgpl.html>.
675 | 


--------------------------------------------------------------------------------