├── Resources ├── translations │ ├── fieldtypes.en.yaml │ └── ibexa_fieldtypes.en.yaml ├── views │ ├── field_definition │ │ └── view │ │ │ └── ngclasslist.html.twig │ └── ngclasslist_content_field.html.twig ├── config │ ├── ibexa.yaml │ └── services.yaml └── doc │ └── INSTALL.md ├── codecov.yml ├── .gitignore ├── NetgenContentTypeListBundle.php ├── .github └── workflows │ ├── coding_standards.yml │ └── tests.yml ├── Core ├── FieldType │ └── ContentTypeList │ │ ├── Value.php │ │ ├── FormMapper.php │ │ └── Type.php └── Persistence │ └── Legacy │ └── Content │ └── FieldValue │ └── Converter │ └── ContentTypeListConverter.php ├── composer.json ├── Tests └── Core │ ├── FieldType │ └── ContentTypeList │ │ ├── ValueTest.php │ │ └── TypeTest.php │ └── Persistence │ └── Legacy │ └── Content │ └── FieldValue │ └── Converter │ └── ContentTypeListConverterTest.php ├── Form └── Type │ └── FieldType │ ├── FieldValueTransformer.php │ └── ContentTypeListFieldType.php ├── README.md ├── phpunit.xml ├── DependencyInjection └── NetgenContentTypeListExtension.php ├── .php-cs-fixer.php └── LICENSE /Resources/translations/fieldtypes.en.yaml: -------------------------------------------------------------------------------- 1 | ngclasslist.name: 'Content type list' 2 | -------------------------------------------------------------------------------- /Resources/translations/ibexa_fieldtypes.en.yaml: -------------------------------------------------------------------------------- 1 | ngclasslist.name: 'Content type list' 2 | -------------------------------------------------------------------------------- /codecov.yml: -------------------------------------------------------------------------------- 1 | coverage: 2 | status: 3 | patch: false 4 | changes: false 5 | project: 6 | default: 7 | target: auto 8 | comment: off 9 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | .idea/ 2 | CodeCoverage/ 3 | vendor/ 4 | var/ 5 | composer.phar 6 | composer.lock 7 | phpunit.phar 8 | .php-cs-fixer.cache 9 | .phpunit.result.cache 10 | -------------------------------------------------------------------------------- /Resources/views/field_definition/view/ngclasslist.html.twig: -------------------------------------------------------------------------------- 1 | {% trans_default_domain "content_type" %} 2 | 3 | {% block ngclasslist_settings %} 4 | 6 | {% endblock %} 7 | -------------------------------------------------------------------------------- /NetgenContentTypeListBundle.php: -------------------------------------------------------------------------------- 1 | identifiers); 25 | } 26 | } 27 | -------------------------------------------------------------------------------- /Resources/doc/INSTALL.md: -------------------------------------------------------------------------------- 1 | Netgen Content Type List Bundle installation instructions 2 | ========================================================= 3 | 4 | Requirements 5 | ------------ 6 | 7 | * Ibexa Platform 4+ 8 | 9 | Installation steps 10 | ------------------ 11 | 12 | ### Use Composer 13 | 14 | Run the following command from your project root to install the bundle: 15 | 16 | ```bash 17 | $ composer require netgen/content-type-list-bundle 18 | ``` 19 | 20 | ### Activate the bundle 21 | 22 | Activate the bundle in `config/bundles.php` file. 23 | 24 | ```php 25 | ['all' => true], 31 | 32 | ... 33 | ]; 34 | ``` 35 | 36 | ### Clear the caches 37 | 38 | Clear Ibexa Platform caches. 39 | 40 | ```bash 41 | php bin/console cache:clear 42 | ``` 43 | 44 | ### Use the bundle 45 | 46 | You can now load and create content with `ngclasslist` field type. 47 | -------------------------------------------------------------------------------- /composer.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "netgen/content-type-list-bundle", 3 | "description": "Netgen Content Type List bundle for Ibexa Platform", 4 | "type": "ibexa-bundle", 5 | "license": "GPL-2.0-only", 6 | "authors": [ 7 | { 8 | "name": "Netgen", 9 | "homepage": "https://netgen.io" 10 | } 11 | ], 12 | "require": { 13 | "ibexa/core": "^5.0", 14 | "symfony/form": "^7.3", 15 | "ibexa/content-forms": "^5.0" 16 | }, 17 | "require-dev": { 18 | "phpunit/phpunit": "^12.0" 19 | }, 20 | "minimum-stability": "dev", 21 | "prefer-stable": true, 22 | "autoload": { 23 | "psr-4": { 24 | "Netgen\\Bundle\\ContentTypeListBundle\\": "" 25 | } 26 | }, 27 | "scripts": { 28 | "test": "@php vendor/bin/phpunit --colors=always" 29 | }, 30 | "extra": { 31 | "branch-alias": { 32 | "dev-master": "4.0.x-dev" 33 | } 34 | } 35 | } 36 | -------------------------------------------------------------------------------- /Tests/Core/FieldType/ContentTypeList/ValueTest.php: -------------------------------------------------------------------------------- 1 | value = new Value( 18 | [ 19 | 'identifier0', 'identifier1', 20 | ] 21 | ); 22 | } 23 | 24 | public function testInstanceOfFieldTypeValue(): void 25 | { 26 | self::assertInstanceOf(BaseValue::class, $this->value); 27 | } 28 | 29 | public function testToStringMethod(): void 30 | { 31 | $identifiers = 'identifier0, identifier1'; 32 | 33 | self::assertSame($identifiers, (string) $this->value); 34 | } 35 | } 36 | -------------------------------------------------------------------------------- /Form/Type/FieldType/FieldValueTransformer.php: -------------------------------------------------------------------------------- 1 | fieldType = $fieldType; 18 | } 19 | 20 | public function transform($value): ?array 21 | { 22 | if (!$value instanceof Value) { 23 | return null; 24 | } 25 | 26 | return $this->fieldType->toHash($value); 27 | } 28 | 29 | public function reverseTransform($value): Value 30 | { 31 | if ($value === null) { 32 | return $this->fieldType->getEmptyValue(); 33 | } 34 | 35 | return $this->fieldType->fromHash($value); 36 | } 37 | } 38 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | Netgen ContentType List Bundle 2 | ============================== 3 | 4 | [![Code Coverage](https://img.shields.io/codecov/c/github/netgen/NetgenContentTypeListBundle.svg?style=flat-square)](https://codecov.io/gh/netgen/NetgenContentTypeListBundle) 5 | [![Downloads](https://img.shields.io/packagist/dt/netgen/content-type-list-bundle.svg?style=flat-square)](https://packagist.org/packages/netgen/content-type-list-bundle) 6 | [![Latest stable](https://img.shields.io/packagist/v/netgen/content-type-list-bundle.svg?style=flat-square)](https://packagist.org/packages/netgen/content-type-list-bundle) 7 | [![License](https://img.shields.io/github/license/netgen/NetgenContentTypeListBundle.svg?style=flat-square)](LICENSE) 8 | 9 | Netgen ContentType List Bundle is an Ibexa Platform bundle that provides a field type to select and store a list of content type identifiers. 10 | 11 | License and installation instructions 12 | ------------------------------------- 13 | 14 | [License](LICENSE) 15 | 16 | [Installation instructions](Resources/doc/INSTALL.md) 17 | -------------------------------------------------------------------------------- /phpunit.xml: -------------------------------------------------------------------------------- 1 | 2 | 11 | 12 | 13 | Tests 14 | 15 | 16 | 17 | 18 | . 19 | 20 | 21 | DependencyInjection 22 | Resources 23 | Tests 24 | vendor 25 | NetgenContentTypeListBundle.php 26 | 27 | 28 | 29 | -------------------------------------------------------------------------------- /DependencyInjection/NetgenContentTypeListExtension.php: -------------------------------------------------------------------------------- 1 | load('services.yaml'); 23 | } 24 | 25 | public function prepend(ContainerBuilder $container): void 26 | { 27 | $configFile = __DIR__ . '/../Resources/config/ibexa.yaml'; 28 | $config = Yaml::parse(file_get_contents($configFile)); 29 | $container->prependExtensionConfig('ibexa', $config); 30 | $container->addResource(new FileResource($configFile)); 31 | } 32 | } 33 | -------------------------------------------------------------------------------- /Resources/config/services.yaml: -------------------------------------------------------------------------------- 1 | services: 2 | netgen_class_list.field_type: 3 | class: Netgen\Bundle\ContentTypeListBundle\Core\FieldType\ContentTypeList\Type 4 | parent: Ibexa\Core\FieldType\FieldType 5 | tags: 6 | - { name: ibexa.field_type, alias: ngclasslist } 7 | 8 | netgen_class_list.field_type.indexable: 9 | class: Ibexa\Core\FieldType\Unindexed 10 | tags: 11 | - { name: ibexa.field_type.indexable, alias: ngclasslist } 12 | 13 | netgen_class_list.field_type.legacy.converter: 14 | class: Netgen\Bundle\ContentTypeListBundle\Core\Persistence\Legacy\Content\FieldValue\Converter\ContentTypeListConverter 15 | tags: 16 | - { name: ibexa.field_type.storage.legacy.converter, alias: ngclasslist } 17 | 18 | netgen_class_list.field_type.form_mapper: 19 | class: Netgen\Bundle\ContentTypeListBundle\Core\FieldType\ContentTypeList\FormMapper 20 | tags: 21 | - { name: ibexa.admin_ui.field_type.form.mapper.value, fieldType: ngclasslist } 22 | 23 | netgen_class_list.field_type.form: 24 | class: Netgen\Bundle\ContentTypeListBundle\Form\Type\FieldType\ContentTypeListFieldType 25 | arguments: 26 | - "@ibexa.api.service.content_type" 27 | - "@ibexa.api.service.field_type" 28 | tags: 29 | - { name: form.type } 30 | -------------------------------------------------------------------------------- /Core/FieldType/ContentTypeList/FormMapper.php: -------------------------------------------------------------------------------- 1 | add( 18 | $fieldForm->getConfig()->getFormFactory()->createBuilder() 19 | ->create( 20 | 'value', 21 | ContentTypeListFieldType::class, 22 | [ 23 | 'required' => $data->getFieldDefinition()->isRequired, 24 | 'label' => $data->getFieldDefinition()->getName(), 25 | 'field_definition' => $data->getFieldDefinition(), 26 | 'multiple' => true, 27 | ] 28 | ) 29 | ->setAutoInitialize(false) 30 | ->getForm() 31 | ); 32 | } 33 | } 34 | -------------------------------------------------------------------------------- /.github/workflows/tests.yml: -------------------------------------------------------------------------------- 1 | name: Tests 2 | 3 | on: 4 | push: 5 | branches: 6 | - 'master' 7 | - '[0-9].[0-9]+' 8 | pull_request: ~ 9 | 10 | jobs: 11 | tests: 12 | name: ${{ matrix.php }} / ${{ matrix.symfony }} / ${{ matrix.phpunit }} 13 | runs-on: ubuntu-latest 14 | 15 | strategy: 16 | fail-fast: false 17 | matrix: 18 | php: ['8.3'] 19 | symfony: ['~7.3.0'] 20 | phpunit: ['phpunit.xml'] 21 | deps: ['normal'] 22 | 23 | steps: 24 | - uses: actions/checkout@v2 25 | - uses: shivammathur/setup-php@v2 26 | with: 27 | php-version: ${{ matrix.php }} 28 | coverage: none 29 | 30 | - run: composer --version 31 | - run: composer validate --strict 32 | 33 | # Install Flex as a global dependency to enable usage of extra.symfony.require 34 | # while keeping Flex recipes from applying 35 | - run: composer global config --no-plugins allow-plugins.symfony/flex true 36 | - run: composer global require --no-scripts symfony/flex 37 | 38 | - run: composer config extra.symfony.require ${{ matrix.symfony }} 39 | 40 | - 41 | run: composer update --prefer-dist 42 | if: ${{ matrix.deps != 'low' }} 43 | 44 | - 45 | run: composer update --prefer-dist --prefer-lowest --prefer-stable 46 | if: ${{ matrix.deps == 'low' }} 47 | 48 | - run: vendor/bin/phpunit -c ${{ matrix.phpunit }} --colors=always 49 | -------------------------------------------------------------------------------- /Core/Persistence/Legacy/Content/FieldValue/Converter/ContentTypeListConverter.php: -------------------------------------------------------------------------------- 1 | dataText = empty($value->data) ? '' : implode(',', $value->data); 22 | } 23 | 24 | public function toFieldValue(StorageFieldValue $value, FieldValue $fieldValue): void 25 | { 26 | $data = trim($value->dataText ?? ''); 27 | $fieldValue->data = empty($data) ? [] : explode(',', $data); 28 | } 29 | 30 | public function toStorageFieldDefinition(FieldDefinition $fieldDef, StorageFieldDefinition $storageDef): void {} 31 | 32 | public function toFieldDefinition(StorageFieldDefinition $storageDef, FieldDefinition $fieldDef): void {} 33 | 34 | public function getIndexColumn(): bool 35 | { 36 | return false; 37 | } 38 | } 39 | -------------------------------------------------------------------------------- /.php-cs-fixer.php: -------------------------------------------------------------------------------- 1 | setRiskyAllowed(true) 5 | ->setRules([ 6 | '@PhpCsFixer' => true, 7 | '@PhpCsFixer:risky' => true, 8 | 9 | // Overrides for rules included in PhpCsFixer rule sets 10 | 'concat_space' => ['spacing' => 'one'], 11 | 'fully_qualified_strict_types' => ['phpdoc_tags' => []], 12 | 'method_chaining_indentation' => false, 13 | 'multiline_whitespace_before_semicolons' => false, 14 | 'native_function_invocation' => ['include' => ['@all']], 15 | 'no_superfluous_phpdoc_tags' => false, 16 | 'ordered_imports' => ['imports_order' => ['class', 'function', 'const']], 17 | 'php_unit_internal_class' => false, 18 | 'php_unit_test_case_static_method_calls' => ['call_type' => 'self'], 19 | 'php_unit_test_class_requires_covers' => false, 20 | 'phpdoc_align' => false, 21 | 'phpdoc_types_order' => ['null_adjustment' => 'always_last', 'sort_algorithm' => 'none'], 22 | 'single_line_comment_style' => false, 23 | 'visibility_required' => ['elements' => ['property', 'method', 'const']], 24 | 'yoda_style' => false, 25 | 26 | // Additional rules 27 | 'date_time_immutable' => true, 28 | 'declare_strict_types' => true, 29 | 'global_namespace_import' => [ 30 | 'import_classes' => null, 31 | 'import_constants' => true, 32 | 'import_functions' => true, 33 | ], 34 | 'list_syntax' => ['syntax' => 'short'], 35 | // 'mb_str_functions' => true, 36 | 'native_constant_invocation' => true, 37 | 'nullable_type_declaration_for_default_null_value' => true, 38 | 'static_lambda' => true, 39 | 'ternary_to_null_coalescing' => true, 40 | ]) 41 | ->setFinder( 42 | PhpCsFixer\Finder::create() 43 | ->exclude(['vendor']) 44 | ->in(__DIR__) 45 | ) 46 | ; 47 | -------------------------------------------------------------------------------- /Tests/Core/Persistence/Legacy/Content/FieldValue/Converter/ContentTypeListConverterTest.php: -------------------------------------------------------------------------------- 1 | converter = new ContentTypeListConverter(); 22 | } 23 | 24 | public function testInstanceOfConverterInterface(): void 25 | { 26 | self::assertInstanceOf(Converter::class, $this->converter); 27 | } 28 | 29 | public function testToStorageFieldDefinition(): void 30 | { 31 | $fieldDefinition = new FieldDefinition(); 32 | $storageDefinition = new StorageFieldDefinition(); 33 | 34 | $this->converter->toStorageFieldDefinition($fieldDefinition, $storageDefinition); 35 | } 36 | 37 | public function testToFieldDefinition(): void 38 | { 39 | $fieldDefinition = new FieldDefinition(); 40 | $storageDefinition = new StorageFieldDefinition(); 41 | 42 | $this->converter->toFieldDefinition($storageDefinition, $fieldDefinition); 43 | } 44 | 45 | public function testGetIndexColumn(): void 46 | { 47 | self::assertFalse($this->converter->getIndexColumn()); 48 | } 49 | 50 | public function testToFieldValue(): void 51 | { 52 | $fieldDefinition = new FieldValue(); 53 | $storageDefinition = new StorageFieldValue(); 54 | 55 | $this->converter->toFieldValue($storageDefinition, $fieldDefinition); 56 | } 57 | 58 | public function testToStorageValue(): void 59 | { 60 | $fieldDefinition = new FieldValue(); 61 | $storageDefinition = new StorageFieldValue(); 62 | 63 | $this->converter->toStorageValue($fieldDefinition, $storageDefinition); 64 | } 65 | } 66 | -------------------------------------------------------------------------------- /Form/Type/FieldType/ContentTypeListFieldType.php: -------------------------------------------------------------------------------- 1 | contentTypeService = $contentTypeService; 25 | $this->fieldTypeService = $fieldTypeService; 26 | } 27 | 28 | public function configureOptions(OptionsResolver $resolver): void 29 | { 30 | $resolver->setRequired(['field_definition']); 31 | $resolver->setAllowedTypes('field_definition', FieldDefinition::class); 32 | 33 | $resolver->setDefault('choices', fn (Options $options): array => $this->getContentTypes()); 34 | $resolver->setDefault('choice_translation_domain', false); 35 | } 36 | 37 | public function buildForm(FormBuilderInterface $builder, array $options): void 38 | { 39 | $builder 40 | ->addModelTransformer( 41 | new FieldValueTransformer( 42 | $this->fieldTypeService->getFieldType('ngclasslist') 43 | ) 44 | ); 45 | } 46 | 47 | public function getParent(): string 48 | { 49 | return ChoiceType::class; 50 | } 51 | 52 | /** 53 | * Returns all content types from Ibexa Platform. 54 | * 55 | * @return array 56 | */ 57 | private function getContentTypes(): array 58 | { 59 | $allContentTypes = []; 60 | $groups = $this->contentTypeService->loadContentTypeGroups(); 61 | 62 | foreach ($groups as $group) { 63 | $contentTypes = $this->contentTypeService->loadContentTypes($group); 64 | 65 | foreach ($contentTypes as $contentType) { 66 | $contentTypeName = $contentType->getName() ?? $contentType->identifier; 67 | $allContentTypes[$group->identifier][$contentTypeName] = $contentType->identifier; 68 | } 69 | } 70 | 71 | return $allContentTypes; 72 | } 73 | } 74 | -------------------------------------------------------------------------------- /Core/FieldType/ContentTypeList/Type.php: -------------------------------------------------------------------------------- 1 | identifiers; 67 | } 68 | 69 | /** 70 | * @param \Ibexa\Contracts\Core\FieldType\Value|\Netgen\Bundle\ContentTypeListBundle\Core\FieldType\ContentTypeList\Value $value 71 | */ 72 | public function isEmptyValue(SPIValue $value): bool 73 | { 74 | return $value === null || $value->identifiers === $this->getEmptyValue()->identifiers; 75 | } 76 | 77 | protected function createValueFromInput($inputValue) 78 | { 79 | if (is_array($inputValue)) { 80 | foreach ($inputValue as $inputValueItem) { 81 | if (!is_string($inputValueItem)) { 82 | return $inputValue; 83 | } 84 | } 85 | 86 | $inputValue = new Value($inputValue); 87 | } 88 | 89 | return $inputValue; 90 | } 91 | 92 | /** 93 | * @param \Ibexa\Core\FieldType\Value|\Netgen\Bundle\ContentTypeListBundle\Core\FieldType\ContentTypeList\Value $value 94 | */ 95 | protected function checkValueStructure(BaseValue $value): void 96 | { 97 | foreach ($value->identifiers as $identifier) { 98 | if (!is_string($identifier)) { 99 | throw new InvalidArgumentType( 100 | (string) $identifier, 101 | Value::class, 102 | $identifier 103 | ); 104 | } 105 | } 106 | } 107 | 108 | protected function getSortInfo(BaseValue $value): bool 109 | { 110 | return false; 111 | } 112 | } 113 | -------------------------------------------------------------------------------- /Tests/Core/FieldType/ContentTypeList/TypeTest.php: -------------------------------------------------------------------------------- 1 | type = new Type(); 32 | $this->value = new Value($this->identifiers); 33 | $this->emptyValue = new Value(); 34 | } 35 | 36 | public function testInstanceOfFieldType(): void 37 | { 38 | self::assertInstanceOf(FieldType::class, $this->type); 39 | } 40 | 41 | public function testToHash(): void 42 | { 43 | self::assertSame($this->identifiers, $this->type->toHash($this->value)); 44 | } 45 | 46 | public function testGetFieldTypeIdentifier(): void 47 | { 48 | self::assertSame('ngclasslist', $this->type->getFieldTypeIdentifier()); 49 | } 50 | 51 | public function testGetEmptyValue(): void 52 | { 53 | self::assertSame($this->emptyValue->identifiers, $this->type->getEmptyValue()->identifiers); 54 | } 55 | 56 | public function testGetName(): void 57 | { 58 | self::assertSame(implode(', ', $this->identifiers), $this->type->getName($this->value, new FieldDefinition(), 'eng-GB')); 59 | } 60 | 61 | public function testIsEmptyValue(): void 62 | { 63 | self::assertFalse($this->type->isEmptyValue($this->value)); 64 | self::assertTrue($this->type->isEmptyValue($this->emptyValue)); 65 | } 66 | 67 | public function testFromHashWithStringArgument(): void 68 | { 69 | self::assertSame($this->emptyValue->identifiers, $this->type->fromHash('test')->identifiers); 70 | } 71 | 72 | public function testFromHashWithArrayOfNumbers(): void 73 | { 74 | self::assertSame($this->emptyValue->identifiers, $this->type->fromHash([123, 456])->identifiers); 75 | } 76 | 77 | public function testFromHash(): void 78 | { 79 | self::assertSame($this->value->identifiers, $this->type->fromHash($this->identifiers)->identifiers); 80 | } 81 | 82 | public function testAcceptValueWithArrayOfStringIdentifiers(): void 83 | { 84 | $this->type->acceptValue($this->identifiers); 85 | } 86 | 87 | public function testAcceptValueWithArrayOfNumbers(): void 88 | { 89 | $this->expectException(InvalidArgumentType::class); 90 | $this->expectExceptionMessage("Argument '\$value' is invalid: value must be of type 'Netgen\\Bundle\\ContentTypeListBundle\\Core\\FieldType\\ContentTypeList\\Value', not 'array'"); 91 | 92 | $this->type->acceptValue([123, 456]); 93 | } 94 | 95 | public function testAcceptValueWithValueIdentifiersAsArrayOfNumbers(): void 96 | { 97 | $this->expectException(InvalidArgumentType::class); 98 | $this->expectExceptionMessage("Argument '123' is invalid: value must be of type 'Netgen\\Bundle\\ContentTypeListBundle\\Core\\FieldType\\ContentTypeList\\Value', not 'int'"); 99 | 100 | $this->value->identifiers = [123, 456]; 101 | 102 | $this->type->acceptValue($this->value); 103 | } 104 | 105 | public function testToPersistenceValue(): void 106 | { 107 | $this->type->toPersistenceValue($this->value); 108 | } 109 | } 110 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 2, June 1991 3 | 4 | Copyright (C) 1989, 1991 Free Software Foundation, Inc. 5 | 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA 6 | Everyone is permitted to copy and distribute verbatim copies 7 | of this license document, but changing it is not allowed. 8 | 9 | Preamble 10 | 11 | The licenses for most software are designed to take away your 12 | freedom to share and change it. By contrast, the GNU General Public 13 | License is intended to guarantee your freedom to share and change free 14 | software--to make sure the software is free for all its users. This 15 | General Public License applies to most of the Free Software 16 | Foundation's software and to any other program whose authors commit to 17 | using it. (Some other Free Software Foundation software is covered by 18 | the GNU Library General Public License instead.) You can apply it to 19 | your programs, too. 20 | 21 | When we speak of free software, we are referring to freedom, not 22 | price. Our General Public Licenses are designed to make sure that you 23 | have the freedom to distribute copies of free software (and charge for 24 | this service if you wish), that you receive source code or can get it 25 | if you want it, that you can change the software or use pieces of it 26 | in new free programs; and that you know you can do these things. 27 | 28 | To protect your rights, we need to make restrictions that forbid 29 | anyone to deny you these rights or to ask you to surrender the rights. 30 | These restrictions translate to certain responsibilities for you if you 31 | distribute copies of the software, or if you modify it. 32 | 33 | For example, if you distribute copies of such a program, whether 34 | gratis or for a fee, you must give the recipients all the rights that 35 | you have. You must make sure that they, too, receive or can get the 36 | source code. And you must show them these terms so they know their 37 | rights. 38 | 39 | We protect your rights with two steps: (1) copyright the software, and 40 | (2) offer you this license which gives you legal permission to copy, 41 | distribute and/or modify the software. 42 | 43 | Also, for each author's protection and ours, we want to make certain 44 | that everyone understands that there is no warranty for this free 45 | software. If the software is modified by someone else and passed on, we 46 | want its recipients to know that what they have is not the original, so 47 | that any problems introduced by others will not reflect on the original 48 | authors' reputations. 49 | 50 | Finally, any free program is threatened constantly by software 51 | patents. We wish to avoid the danger that redistributors of a free 52 | program will individually obtain patent licenses, in effect making the 53 | program proprietary. To prevent this, we have made it clear that any 54 | patent must be licensed for everyone's free use or not licensed at all. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | GNU GENERAL PUBLIC LICENSE 60 | TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 61 | 62 | 0. This License applies to any program or other work which contains 63 | a notice placed by the copyright holder saying it may be distributed 64 | under the terms of this General Public License. The "Program", below, 65 | refers to any such program or work, and a "work based on the Program" 66 | means either the Program or any derivative work under copyright law: 67 | that is to say, a work containing the Program or a portion of it, 68 | either verbatim or with modifications and/or translated into another 69 | language. (Hereinafter, translation is included without limitation in 70 | the term "modification".) Each licensee is addressed as "you". 71 | 72 | Activities other than copying, distribution and modification are not 73 | covered by this License; they are outside its scope. The act of 74 | running the Program is not restricted, and the output from the Program 75 | is covered only if its contents constitute a work based on the 76 | Program (independent of having been made by running the Program). 77 | Whether that is true depends on what the Program does. 78 | 79 | 1. You may copy and distribute verbatim copies of the Program's 80 | source code as you receive it, in any medium, provided that you 81 | conspicuously and appropriately publish on each copy an appropriate 82 | copyright notice and disclaimer of warranty; keep intact all the 83 | notices that refer to this License and to the absence of any warranty; 84 | and give any other recipients of the Program a copy of this License 85 | along with the Program. 86 | 87 | You may charge a fee for the physical act of transferring a copy, and 88 | you may at your option offer warranty protection in exchange for a fee. 89 | 90 | 2. You may modify your copy or copies of the Program or any portion 91 | of it, thus forming a work based on the Program, and copy and 92 | distribute such modifications or work under the terms of Section 1 93 | above, provided that you also meet all of these conditions: 94 | 95 | a) You must cause the modified files to carry prominent notices 96 | stating that you changed the files and the date of any change. 97 | 98 | b) You must cause any work that you distribute or publish, that in 99 | whole or in part contains or is derived from the Program or any 100 | part thereof, to be licensed as a whole at no charge to all third 101 | parties under the terms of this License. 102 | 103 | c) If the modified program normally reads commands interactively 104 | when run, you must cause it, when started running for such 105 | interactive use in the most ordinary way, to print or display an 106 | announcement including an appropriate copyright notice and a 107 | notice that there is no warranty (or else, saying that you provide 108 | a warranty) and that users may redistribute the program under 109 | these conditions, and telling the user how to view a copy of this 110 | License. (Exception: if the Program itself is interactive but 111 | does not normally print such an announcement, your work based on 112 | the Program is not required to print an announcement.) 113 | 114 | These requirements apply to the modified work as a whole. If 115 | identifiable sections of that work are not derived from the Program, 116 | and can be reasonably considered independent and separate works in 117 | themselves, then this License, and its terms, do not apply to those 118 | sections when you distribute them as separate works. But when you 119 | distribute the same sections as part of a whole which is a work based 120 | on the Program, the distribution of the whole must be on the terms of 121 | this License, whose permissions for other licensees extend to the 122 | entire whole, and thus to each and every part regardless of who wrote it. 123 | 124 | Thus, it is not the intent of this section to claim rights or contest 125 | your rights to work written entirely by you; rather, the intent is to 126 | exercise the right to control the distribution of derivative or 127 | collective works based on the Program. 128 | 129 | In addition, mere aggregation of another work not based on the Program 130 | with the Program (or with a work based on the Program) on a volume of 131 | a storage or distribution medium does not bring the other work under 132 | the scope of this License. 133 | 134 | 3. You may copy and distribute the Program (or a work based on it, 135 | under Section 2) in object code or executable form under the terms of 136 | Sections 1 and 2 above provided that you also do one of the following: 137 | 138 | a) Accompany it with the complete corresponding machine-readable 139 | source code, which must be distributed under the terms of Sections 140 | 1 and 2 above on a medium customarily used for software interchange; or, 141 | 142 | b) Accompany it with a written offer, valid for at least three 143 | years, to give any third party, for a charge no more than your 144 | cost of physically performing source distribution, a complete 145 | machine-readable copy of the corresponding source code, to be 146 | distributed under the terms of Sections 1 and 2 above on a medium 147 | customarily used for software interchange; or, 148 | 149 | c) Accompany it with the information you received as to the offer 150 | to distribute corresponding source code. (This alternative is 151 | allowed only for noncommercial distribution and only if you 152 | received the program in object code or executable form with such 153 | an offer, in accord with Subsection b above.) 154 | 155 | The source code for a work means the preferred form of the work for 156 | making modifications to it. For an executable work, complete source 157 | code means all the source code for all modules it contains, plus any 158 | associated interface definition files, plus the scripts used to 159 | control compilation and installation of the executable. However, as a 160 | special exception, the source code distributed need not include 161 | anything that is normally distributed (in either source or binary 162 | form) with the major components (compiler, kernel, and so on) of the 163 | operating system on which the executable runs, unless that component 164 | itself accompanies the executable. 165 | 166 | If distribution of executable or object code is made by offering 167 | access to copy from a designated place, then offering equivalent 168 | access to copy the source code from the same place counts as 169 | distribution of the source code, even though third parties are not 170 | compelled to copy the source along with the object code. 171 | 172 | 4. You may not copy, modify, sublicense, or distribute the Program 173 | except as expressly provided under this License. Any attempt 174 | otherwise to copy, modify, sublicense or distribute the Program is 175 | void, and will automatically terminate your rights under this License. 176 | However, parties who have received copies, or rights, from you under 177 | this License will not have their licenses terminated so long as such 178 | parties remain in full compliance. 179 | 180 | 5. You are not required to accept this License, since you have not 181 | signed it. However, nothing else grants you permission to modify or 182 | distribute the Program or its derivative works. These actions are 183 | prohibited by law if you do not accept this License. Therefore, by 184 | modifying or distributing the Program (or any work based on the 185 | Program), you indicate your acceptance of this License to do so, and 186 | all its terms and conditions for copying, distributing or modifying 187 | the Program or works based on it. 188 | 189 | 6. Each time you redistribute the Program (or any work based on the 190 | Program), the recipient automatically receives a license from the 191 | original licensor to copy, distribute or modify the Program subject to 192 | these terms and conditions. You may not impose any further 193 | restrictions on the recipients' exercise of the rights granted herein. 194 | You are not responsible for enforcing compliance by third parties to 195 | this License. 196 | 197 | 7. If, as a consequence of a court judgment or allegation of patent 198 | infringement or for any other reason (not limited to patent issues), 199 | conditions are imposed on you (whether by court order, agreement or 200 | otherwise) that contradict the conditions of this License, they do not 201 | excuse you from the conditions of this License. If you cannot 202 | distribute so as to satisfy simultaneously your obligations under this 203 | License and any other pertinent obligations, then as a consequence you 204 | may not distribute the Program at all. For example, if a patent 205 | license would not permit royalty-free redistribution of the Program by 206 | all those who receive copies directly or indirectly through you, then 207 | the only way you could satisfy both it and this License would be to 208 | refrain entirely from distribution of the Program. 209 | 210 | If any portion of this section is held invalid or unenforceable under 211 | any particular circumstance, the balance of the section is intended to 212 | apply and the section as a whole is intended to apply in other 213 | circumstances. 214 | 215 | It is not the purpose of this section to induce you to infringe any 216 | patents or other property right claims or to contest validity of any 217 | such claims; this section has the sole purpose of protecting the 218 | integrity of the free software distribution system, which is 219 | implemented by public license practices. Many people have made 220 | generous contributions to the wide range of software distributed 221 | through that system in reliance on consistent application of that 222 | system; it is up to the author/donor to decide if he or she is willing 223 | to distribute software through any other system and a licensee cannot 224 | impose that choice. 225 | 226 | This section is intended to make thoroughly clear what is believed to 227 | be a consequence of the rest of this License. 228 | 229 | 8. If the distribution and/or use of the Program is restricted in 230 | certain countries either by patents or by copyrighted interfaces, the 231 | original copyright holder who places the Program under this License 232 | may add an explicit geographical distribution limitation excluding 233 | those countries, so that distribution is permitted only in or among 234 | countries not thus excluded. In such case, this License incorporates 235 | the limitation as if written in the body of this License. 236 | 237 | 9. The Free Software Foundation may publish revised and/or new versions 238 | of the General Public License from time to time. Such new versions will 239 | be similar in spirit to the present version, but may differ in detail to 240 | address new problems or concerns. 241 | 242 | Each version is given a distinguishing version number. If the Program 243 | specifies a version number of this License which applies to it and "any 244 | later version", you have the option of following the terms and conditions 245 | either of that version or of any later version published by the Free 246 | Software Foundation. If the Program does not specify a version number of 247 | this License, you may choose any version ever published by the Free Software 248 | Foundation. 249 | 250 | 10. If you wish to incorporate parts of the Program into other free 251 | programs whose distribution conditions are different, write to the author 252 | to ask for permission. For software which is copyrighted by the Free 253 | Software Foundation, write to the Free Software Foundation; we sometimes 254 | make exceptions for this. Our decision will be guided by the two goals 255 | of preserving the free status of all derivatives of our free software and 256 | of promoting the sharing and reuse of software generally. 257 | 258 | NO WARRANTY 259 | 260 | 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY 261 | FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN 262 | OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES 263 | PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED 264 | OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 265 | MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS 266 | TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE 267 | PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, 268 | REPAIR OR CORRECTION. 269 | 270 | 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 271 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR 272 | REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, 273 | INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING 274 | OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED 275 | TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY 276 | YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER 277 | PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE 278 | POSSIBILITY OF SUCH DAMAGES. 279 | 280 | END OF TERMS AND CONDITIONS 281 | 282 | How to Apply These Terms to Your New Programs 283 | 284 | If you develop a new program, and you want it to be of the greatest 285 | possible use to the public, the best way to achieve this is to make it 286 | free software which everyone can redistribute and change under these terms. 287 | 288 | To do so, attach the following notices to the program. It is safest 289 | to attach them to the start of each source file to most effectively 290 | convey the exclusion of warranty; and each file should have at least 291 | the "copyright" line and a pointer to where the full notice is found. 292 | 293 | 294 | Copyright (C) 19yy 295 | 296 | This program is free software; you can redistribute it and/or modify 297 | it under the terms of the GNU General Public License as published by 298 | the Free Software Foundation; either version 2 of the License, or 299 | (at your option) any later version. 300 | 301 | This program is distributed in the hope that it will be useful, 302 | but WITHOUT ANY WARRANTY; without even the implied warranty of 303 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 304 | GNU General Public License for more details. 305 | 306 | You should have received a copy of the GNU General Public License 307 | along with this program; if not, write to the Free Software 308 | Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA 309 | 310 | 311 | Also add information on how to contact you by electronic and paper mail. 312 | 313 | If the program is interactive, make it output a short notice like this 314 | when it starts in an interactive mode: 315 | 316 | Gnomovision version 69, Copyright (C) 19yy name of author 317 | Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 318 | This is free software, and you are welcome to redistribute it 319 | under certain conditions; type `show c' for details. 320 | 321 | The hypothetical commands `show w' and `show c' should show the appropriate 322 | parts of the General Public License. Of course, the commands you use may 323 | be called something other than `show w' and `show c'; they could even be 324 | mouse-clicks or menu items--whatever suits your program. 325 | 326 | You should also get your employer (if you work as a programmer) or your 327 | school, if any, to sign a "copyright disclaimer" for the program, if 328 | necessary. Here is a sample; alter the names: 329 | 330 | Yoyodyne, Inc., hereby disclaims all copyright interest in the program 331 | `Gnomovision' (which makes passes at compilers) written by James Hacker. 332 | 333 | , 1 April 1989 334 | Ty Coon, President of Vice 335 | 336 | This General Public License does not permit incorporating your program into 337 | proprietary programs. If your program is a subroutine library, you may 338 | consider it more useful to permit linking proprietary applications with the 339 | library. If this is what you want to do, use the GNU Library General 340 | Public License instead of this License. 341 | --------------------------------------------------------------------------------