From 864809ba822df11e4643734ca5c26cc28ae5057b Mon Sep 17 00:00:00 2001 From: Benni Mack Date: Fri, 31 Jul 2020 11:35:08 +0200 Subject: [PATCH] [TASK] Initial commit --- .../Collection/RecordCollectionRepository.php | 236 ++++++++++++ Classes/Collection/StaticRecordCollection.php | 204 +++++++++++ Configuration/TCA/sys_collection.php | 194 ++++++++++ LICENSE.txt | 339 ++++++++++++++++++ Migrations/Code/ClassAliasMap.php | 5 + README.md | 38 ++ Resources/Private/Language/locallang_tca.xlf | 29 ++ .../RecordCollectionRepositoryTest.php | 335 +++++++++++++++++ .../Tca/CollectionVisibleFieldsTest.php | 57 +++ composer.json | 35 ++ ext_emconf.php | 22 ++ ext_tables.sql | 24 ++ 12 files changed, 1518 insertions(+) create mode 100644 Classes/Collection/RecordCollectionRepository.php create mode 100644 Classes/Collection/StaticRecordCollection.php create mode 100644 Configuration/TCA/sys_collection.php create mode 100644 LICENSE.txt create mode 100644 Migrations/Code/ClassAliasMap.php create mode 100644 README.md create mode 100644 Resources/Private/Language/locallang_tca.xlf create mode 100644 Tests/Functional/Collection/RecordCollectionRepositoryTest.php create mode 100644 Tests/Functional/Tca/CollectionVisibleFieldsTest.php create mode 100644 composer.json create mode 100644 ext_emconf.php create mode 100644 ext_tables.sql diff --git a/Classes/Collection/RecordCollectionRepository.php b/Classes/Collection/RecordCollectionRepository.php new file mode 100644 index 0000000..0a4daad --- /dev/null +++ b/Classes/Collection/RecordCollectionRepository.php @@ -0,0 +1,236 @@ +getQueryBuilderForTable($this->table); + + if ($this->getEnvironmentMode() === 'FE') { + $queryBuilder->setRestrictions(GeneralUtility::makeInstance(FrontendRestrictionContainer::class)); + } else { + $queryBuilder->getRestrictions() + ->removeAll() + ->add(GeneralUtility::makeInstance(DeletedRestriction::class)); + } + + $data = $queryBuilder->select('*') + ->from($this->table) + ->where($queryBuilder->expr()->eq('uid', $queryBuilder->createNamedParameter($uid, \PDO::PARAM_INT))) + ->execute() + ->fetch(); + if (is_array($data)) { + $result = $this->createDomainObject($data); + } + return $result; + } + + /** + * Finds all record collections. + * + * @return \TYPO3\CMS\Core\Collection\AbstractRecordCollection[]|null + */ + public function findAll() + { + return $this->queryMultipleRecords(); + } + + /** + * Finds record collections by table name. + * + * @param string $tableName Name of the table to be looked up + * @return \TYPO3\CMS\Core\Collection\AbstractRecordCollection[] + */ + public function findByTableName($tableName) + { + $expressionBuilder = GeneralUtility::makeInstance(ConnectionPool::class) + ->getQueryBuilderForTable($tableName) + ->expr(); + + return $this->queryMultipleRecords([ + $expressionBuilder->eq($this->tableField, $expressionBuilder->literal($tableName)) + ]); + } + + /** + * Finds record collection by type. + * + * @param string $type Type to be looked up + * @return \TYPO3\CMS\Core\Collection\AbstractRecordCollection[]|null + */ + public function findByType($type) + { + $expressionBuilder = GeneralUtility::makeInstance(ConnectionPool::class) + ->getQueryBuilderForTable($this->table) + ->expr(); + + return $this->queryMultipleRecords([ + $expressionBuilder->eq($this->typeField, $expressionBuilder->literal($type)) + ]); + } + + /** + * Finds record collections by type and table name. + * + * @param string $type Type to be looked up + * @param string $tableName Name of the table to be looked up + * @return \TYPO3\CMS\Core\Collection\AbstractRecordCollection[]|null + */ + public function findByTypeAndTableName($type, $tableName) + { + $expressionBuilder = GeneralUtility::makeInstance(ConnectionPool::class) + ->getQueryBuilderForTable($this->table) + ->expr(); + + return $this->queryMultipleRecords([ + $expressionBuilder->eq($this->typeField, $expressionBuilder->literal($type)), + $expressionBuilder->eq($this->tableField, $expressionBuilder->literal($tableName)) + ]); + } + + /** + * Deletes a record collection by uid. + * + * @param int $uid uid to be deleted + */ + public function deleteByUid($uid) + { + GeneralUtility::makeInstance(ConnectionPool::class) + ->getConnectionForTable($this->table) + ->update( + $this->table, + ['deleted' => 1, 'tstamp' => (int)$GLOBALS['EXEC_TIME']], + ['uid' => (int)$uid] + ); + } + + /** + * Queries for multiple records for the given conditions. + * + * @param array $conditions Conditions concatenated with AND for query + * @return \TYPO3\CMS\Core\Collection\AbstractRecordCollection[]|null + */ + protected function queryMultipleRecords(array $conditions = []) + { + $result = null; + + $queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)->getQueryBuilderForTable($this->table); + $queryBuilder->getRestrictions() + ->removeAll() + ->add(GeneralUtility::makeInstance(DeletedRestriction::class)); + + $queryBuilder->select('*') + ->from($this->table); + + if (!empty($conditions)) { + $queryBuilder->where(...$conditions); + } + + $data = $queryBuilder->execute()->fetchAll(); + if (!empty($data)) { + $result = $this->createMultipleDomainObjects($data); + } + + return $result; + } + + /** + * Creates a record collection domain object. + * + * @param array $record Database record to be reconstituted + * @return \TYPO3\CMS\Core\Collection\AbstractRecordCollection + * @throws \RuntimeException + */ + protected function createDomainObject(array $record) + { + switch ($record['type']) { + case self::TYPE_Static: + $collection = StaticRecordCollection::create($record); + break; + default: + throw new \RuntimeException('Unknown record collection type "' . $record['type'], 1328646798); + } + return $collection; + } + + /** + * Creates multiple record collection domain objects. + * + * @param array $data Array of multiple database records to be reconstituted + * @return \TYPO3\CMS\Core\Collection\AbstractRecordCollection[] + */ + protected function createMultipleDomainObjects(array $data) + { + $collections = []; + foreach ($data as $collection) { + $collections[] = $this->createDomainObject($collection); + } + return $collections; + } + + /** + * Function to return the current TYPO3_MODE (FE/BE) based on $GLOBALS[TSFE]. + * This function can be mocked in unit tests to be able to test frontend behaviour. + * + * @return string + */ + protected function getEnvironmentMode(): string + { + return ($GLOBALS['TSFE'] ?? null) instanceof TypoScriptFrontendController ? 'FE' : 'BE'; + } +} diff --git a/Classes/Collection/StaticRecordCollection.php b/Classes/Collection/StaticRecordCollection.php new file mode 100644 index 0000000..30dc8bb --- /dev/null +++ b/Classes/Collection/StaticRecordCollection.php @@ -0,0 +1,204 @@ +fromArray($collectionRecord); + if ($fillItems) { + $collection->loadContents(); + } + return $collection; + } + + /** + * Creates this object. + * + * @param string $tableName Name of the table to be working on + * @throws \RuntimeException + */ + public function __construct($tableName = null) + { + parent::__construct(); + if (!empty($tableName)) { + $this->setItemTableName($tableName); + } elseif (empty($this->itemTableName)) { + throw new \RuntimeException(self::class . ' needs a valid itemTableName.', 1330293778); + } + } + + /** + * Populates the content-entries of the storage + * + * Queries the underlying storage for entries of the collection + * and adds them to the collection data. + * + * If the content entries of the storage had not been loaded on creation + * ($fillItems = false) this function is to be used for loading the contents + * afterwards. + */ + public function loadContents() + { + $entries = $this->getCollectedRecords(); + $this->removeAll(); + foreach ($entries as $entry) { + $this->add($entry); + } + } + + /** + * Returns an array of the persistable properties and contents + * which are processable by DataHandler. + * + * for internal usage in persist only. + * + * @return array + */ + protected function getPersistableDataArray() + { + return [ + 'title' => $this->getTitle(), + 'description' => $this->getDescription(), + 'items' => $this->getItemUidList(true), + 'type' => 'static', + 'table_name' => $this->getItemTableName() + ]; + } + + /** + * Adds on entry to the collection + * + * @param mixed $data + */ + public function add($data) + { + $this->storage->push($data); + } + + /** + * Adds a set of entries to the collection + * + * @param CollectionInterface $other + */ + public function addAll(CollectionInterface $other) + { + foreach ($other as $value) { + $this->add($value); + } + } + + /** + * Removes the given entry from collection + * + * Note: not the given "index" + * + * @param mixed $data + */ + public function remove($data) + { + $offset = 0; + foreach ($this->storage as $value) { + if ($value == $data) { + break; + } + $offset++; + } + $this->storage->offsetUnset($offset); + } + + /** + * Removes all entries from the collection + * + * collection will be empty afterwards + */ + public function removeAll() + { + $this->storage = new \SplDoublyLinkedList(); + } + + /** + * Gets the collected records in this collection, by + * looking up the MM relations of this record to the + * table name defined in the local field 'table_name'. + * + * @return array + */ + protected function getCollectedRecords() + { + $queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class) + ->getQueryBuilderForTable(self::getCollectionDatabaseTable()); + $queryBuilder->getRestrictions()->removeAll(); + $statement = $queryBuilder->select($this->getItemTableName() . '.*') + ->from(self::getCollectionDatabaseTable()) + ->join( + self::getCollectionDatabaseTable(), + 'sys_collection_entries', + 'sys_collection_entries', + $queryBuilder->expr()->eq( + 'sys_collection_entries.uid_local', + $queryBuilder->quoteIdentifier(self::getCollectionDatabaseTable() . '.uid') + ) + ) + ->join( + 'sys_collection_entries', + $this->getItemTableName(), + $this->getItemTableName(), + $queryBuilder->expr()->eq( + 'sys_collection_entries.uid_foreign', + $queryBuilder->quoteIdentifier($this->getItemTableName() . '.uid') + ) + ) + ->where( + $queryBuilder->expr()->eq( + self::getCollectionDatabaseTable() . '.uid', + $queryBuilder->createNamedParameter($this->getIdentifier(), \PDO::PARAM_INT) + ) + ) + ->execute(); + $relatedRecords = []; + while ($record = $statement->fetch()) { + $relatedRecords[] = $record; + } + return $relatedRecords; + } +} diff --git a/Configuration/TCA/sys_collection.php b/Configuration/TCA/sys_collection.php new file mode 100644 index 0000000..1782fc0 --- /dev/null +++ b/Configuration/TCA/sys_collection.php @@ -0,0 +1,194 @@ + [ + 'title' => 'LLL:EXT:legacy_collections/Resources/Private/Language/locallang_tca.xlf:sys_collection', + 'label' => 'title', + 'tstamp' => 'tstamp', + 'crdate' => 'crdate', + 'cruser_id' => 'cruser_id', + 'descriptionColumn' => 'description', + 'versioningWS' => true, + 'origUid' => 't3_origuid', + 'languageField' => 'sys_language_uid', + 'transOrigPointerField' => 'l10n_parent', + 'transOrigDiffSourceField' => 'l10n_diffsource', + 'default_sortby' => 'crdate', + 'delete' => 'deleted', + 'type' => 'type', + 'rootLevel' => -1, + 'searchFields' => 'title,description', + 'typeicon_column' => 'type', + 'typeicon_classes' => [ + 'default' => 'apps-clipboard-list', + 'static' => 'apps-clipboard-list', + 'filter' => 'actions-system-tree-search-open' + ], + 'enablecolumns' => [ + 'disabled' => 'hidden', + 'starttime' => 'starttime', + 'endtime' => 'endtime', + 'fe_group' => 'fe_group' + ], + ], + 'columns' => [ + 'sys_language_uid' => [ + 'exclude' => true, + 'label' => 'LLL:EXT:core/Resources/Private/Language/locallang_general.xlf:LGL.language', + 'config' => [ + 'type' => 'select', + 'renderType' => 'selectSingle', + 'foreign_table' => 'sys_language', + 'items' => [ + ['LLL:EXT:core/Resources/Private/Language/locallang_general.xlf:LGL.allLanguages', -1], + ['LLL:EXT:core/Resources/Private/Language/locallang_general.xlf:LGL.default_value', 0] + ], + 'default' => 0, + 'fieldWizard' => [ + 'selectIcons' => [ + 'disabled' => false, + ], + ], + ] + ], + 'l10n_parent' => [ + 'displayCond' => 'FIELD:sys_language_uid:>:0', + 'label' => 'LLL:EXT:core/Resources/Private/Language/locallang_general.xlf:LGL.l18n_parent', + 'config' => [ + 'type' => 'select', + 'renderType' => 'selectSingle', + 'items' => [ + ['', 0] + ], + 'foreign_table' => 'sys_file_collection', + 'foreign_table_where' => 'AND sys_file_collection.pid=###CURRENT_PID### AND sys_file_collection.sys_language_uid IN (-1,0)' + ] + ], + 'l10n_diffsource' => [ + 'config' => [ + 'type' => 'passthrough', + 'default' => '' + ] + ], + 'hidden' => [ + 'exclude' => true, + 'label' => 'LLL:EXT:core/Resources/Private/Language/locallang_general.xlf:LGL.enabled', + 'config' => [ + 'type' => 'check', + 'renderType' => 'checkboxToggle', + 'default' => 0, + 'items' => [ + [ + 0 => '', + 1 => '', + 'invertStateDisplay' => true + ] + ], + ] + ], + 'starttime' => [ + 'exclude' => true, + 'label' => 'LLL:EXT:core/Resources/Private/Language/locallang_general.xlf:LGL.starttime', + 'config' => [ + 'type' => 'input', + 'renderType' => 'inputDateTime', + 'eval' => 'date,int', + 'default' => 0, + ] + ], + 'endtime' => [ + 'exclude' => true, + 'label' => 'LLL:EXT:core/Resources/Private/Language/locallang_general.xlf:LGL.endtime', + 'config' => [ + 'type' => 'input', + 'renderType' => 'inputDateTime', + 'eval' => 'date,int', + 'default' => 0, + 'range' => [ + 'upper' => mktime(0, 0, 0, 1, 1, 2038), + ] + ] + ], + 'fe_group' => [ + 'exclude' => true, + 'label' => 'LLL:EXT:core/Resources/Private/Language/locallang_general.xlf:LGL.fe_group', + 'config' => [ + 'type' => 'select', + 'renderType' => 'selectSingle', + 'items' => [ + ['', 0], + ['LLL:EXT:core/Resources/Private/Language/locallang_general.xlf:LGL.hide_at_login', -1], + ['LLL:EXT:core/Resources/Private/Language/locallang_general.xlf:LGL.any_login', -2], + ['LLL:EXT:core/Resources/Private/Language/locallang_general.xlf:LGL.usergroups', '--div--'] + ], + 'foreign_table' => 'fe_groups' + ] + ], + 'table_name' => [ + 'label' => 'LLL:EXT:legacy_collections/Resources/Private/Language/locallang_tca.xlf:sys_collection.table_name', + 'config' => [ + 'type' => 'select', + 'renderType' => 'selectSingle', + 'special' => 'tables' + ] + ], + 'items' => [ + 'label' => 'LLL:EXT:legacy_collections/Resources/Private/Language/locallang_tca.xlf:sys_collection.items', + 'config' => [ + 'type' => 'group', + 'internal_type' => 'db', + 'prepend_tname' => true, + 'allowed' => '*', + 'MM' => 'sys_collection_entries', + 'MM_hasUidField' => true, + 'multiple' => true, + 'size' => 5 + ] + ], + 'title' => [ + 'label' => 'LLL:EXT:legacy_collections/Resources/Private/Language/locallang_tca.xlf:sys_collection.title', + 'config' => [ + 'type' => 'input', + 'size' => 60, + 'eval' => 'required' + ] + ], + 'description' => [ + 'label' => 'LLL:EXT:legacy_collections/Resources/Private/Language/locallang_tca.xlf:sys_collection.description', + 'config' => [ + 'type' => 'text', + 'cols' => 60, + 'rows' => 5 + ] + ], + 'type' => [ + 'label' => 'LLL:EXT:legacy_collections/Resources/Private/Language/locallang_tca.xlf:sys_collection.type', + 'config' => [ + 'type' => 'select', + 'renderType' => 'selectSingle', + 'items' => [ + ['LLL:EXT:legacy_collections/Resources/Private/Language/locallang_tca.xlf:sys_collection.type.static', 'static'] + ], + 'default' => 'static' + ] + ] + ], + 'types' => [ + 'static' => [ + 'showitem' => ' + --div--;LLL:EXT:core/Resources/Private/Language/Form/locallang_tabs.xlf:general, + type,title,table_name,items, + --div--;LLL:EXT:core/Resources/Private/Language/Form/locallang_tabs.xlf:language, + --palette--;;language, + --div--;LLL:EXT:core/Resources/Private/Language/Form/locallang_tabs.xlf:access, + hidden,--palette--;;timeRestriction,fe_group, + --div--;LLL:EXT:core/Resources/Private/Language/Form/locallang_tabs.xlf:notes, + description, + --div--;LLL:EXT:core/Resources/Private/Language/Form/locallang_tabs.xlf:extended, + ', + ], + ], + 'palettes' => [ + 'timeRestriction' => ['showitem' => 'starttime, endtime'], + 'language' => ['showitem' => 'sys_language_uid, l10n_parent'], + ] +]; diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..d159169 --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,339 @@ + GNU GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1989, 1991 Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. This +General Public License applies to most of the Free Software +Foundation's software and to any other program whose authors commit to +using it. (Some other Free Software Foundation software is covered by +the GNU Lesser General Public License instead.) You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +this service if you wish), that you receive source code or can get it +if you want it, that you can change the software or use pieces of it +in new free programs; and that you know you can do these things. + + To protect your rights, we need to make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. You must make sure that they, too, receive or can get the +source code. And you must show them these terms so they know their +rights. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that redistributors of a free +program will individually obtain patent licenses, in effect making the +program proprietary. To prevent this, we have made it clear that any +patent must be licensed for everyone's free use or not licensed at all. + + The precise terms and conditions for copying, distribution and +modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License applies to any program or other work which contains +a notice placed by the copyright holder saying it may be distributed +under the terms of this General Public License. The "Program", below, +refers to any such program or work, and a "work based on the Program" +means either the Program or any derivative work under copyright law: +that is to say, a work containing the Program or a portion of it, +either verbatim or with modifications and/or translated into another +language. (Hereinafter, translation is included without limitation in +the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running the Program is not restricted, and the output from the Program +is covered only if its contents constitute a work based on the +Program (independent of having been made by running the Program). +Whether that is true depends on what the Program does. + + 1. You may copy and distribute verbatim copies of the Program's +source code as you receive it, in any medium, provided that you +conspicuously and appropriately publish on each copy an appropriate +copyright notice and disclaimer of warranty; keep intact all the +notices that refer to this License and to the absence of any warranty; +and give any other recipients of the Program a copy of this License +along with the Program. + +You may charge a fee for the physical act of transferring a copy, and +you may at your option offer warranty protection in exchange for a fee. + + 2. You may modify your copy or copies of the Program or any portion +of it, thus forming a work based on the Program, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in + whole or in part contains or is derived from the Program or any + part thereof, to be licensed as a whole at no charge to all third + parties under the terms of this License. + + c) If the modified program normally reads commands interactively + when run, you must cause it, when started running for such + interactive use in the most ordinary way, to print or display an + announcement including an appropriate copyright notice and a + notice that there is no warranty (or else, saying that you provide + a warranty) and that users may redistribute the program under + these conditions, and telling the user how to view a copy of this + License. (Exception: if the Program itself is interactive but + does not normally print such an announcement, your work based on + the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Program, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Program, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Program. + +In addition, mere aggregation of another work not based on the Program +with the Program (or with a work based on the Program) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may copy and distribute the Program (or a work based on it, +under Section 2) in object code or executable form under the terms of +Sections 1 and 2 above provided that you also do one of the following: + + a) Accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of Sections + 1 and 2 above on a medium customarily used for software interchange; or, + + b) Accompany it with a written offer, valid for at least three + years, to give any third party, for a charge no more than your + cost of physically performing source distribution, a complete + machine-readable copy of the corresponding source code, to be + distributed under the terms of Sections 1 and 2 above on a medium + customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer + to distribute corresponding source code. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form with such + an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for +making modifications to it. For an executable work, complete source +code means all the source code for all modules it contains, plus any +associated interface definition files, plus the scripts used to +control compilation and installation of the executable. However, as a +special exception, the source code distributed need not include +anything that is normally distributed (in either source or binary +form) with the major components (compiler, kernel, and so on) of the +operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering +access to copy from a designated place, then offering equivalent +access to copy the source code from the same place counts as +distribution of the source code, even though third parties are not +compelled to copy the source along with the object code. + + 4. You may not copy, modify, sublicense, or distribute the Program +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense or distribute the Program is +void, and will automatically terminate your rights under this License. +However, parties who have received copies, or rights, from you under +this License will not have their licenses terminated so long as such +parties remain in full compliance. + + 5. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Program or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Program (or any work based on the +Program), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the +original licensor to copy, distribute or modify the Program subject to +these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties to +this License. + + 7. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Program at all. For example, if a patent +license would not permit royalty-free redistribution of the Program by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under +any particular circumstance, the balance of the section is intended to +apply and the section as a whole is intended to apply in other +circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system, which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 8. If the distribution and/or use of the Program is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Program under this License +may add an explicit geographical distribution limitation excluding +those countries, so that distribution is permitted only in or among +countries not thus excluded. In such case, this License incorporates +the limitation as if written in the body of this License. + + 9. The Free Software Foundation may publish revised and/or new versions +of the General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies a version number of this License which applies to it and "any +later version", you have the option of following the terms and conditions +either of that version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number of +this License, you may choose any version ever published by the Free Software +Foundation. + + 10. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally. + + NO WARRANTY + + 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY +FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN +OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES +PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED +OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS +TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE +PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, +REPAIR OR CORRECTION. + + 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR +REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING +OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED +TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY +YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER +PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE +POSSIBILITY OF SUCH DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License along + with this program; if not, write to the Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) year name of author + Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, the commands you use may +be called something other than `show w' and `show c'; they could even be +mouse-clicks or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the program + `Gnomovision' (which makes passes at compilers) written by James Hacker. + + , 1 April 1989 + Ty Coon, President of Vice + +This General Public License does not permit incorporating your program into +proprietary programs. If your program is a subroutine library, you may +consider it more useful to permit linking proprietary applications with the +library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. diff --git a/Migrations/Code/ClassAliasMap.php b/Migrations/Code/ClassAliasMap.php new file mode 100644 index 0000000..e3354be --- /dev/null +++ b/Migrations/Code/ClassAliasMap.php @@ -0,0 +1,5 @@ + \FriendsOfTYPO3\LegacyCollections\Collection\StaticRecordCollection::class, + 'TYPO3\\CMS\\Core\\Collection\\RecordCollectionRepository' => \FriendsOfTYPO3\LegacyCollections\Collection\RecordCollectionRepository::class, +]; diff --git a/README.md b/README.md new file mode 100644 index 0000000..72ef24c --- /dev/null +++ b/README.md @@ -0,0 +1,38 @@ +# TYPO3 Extension "legacy_collections" + +This extension provides TCA information and database tables for the generic "sys_collections" +concept, which allows for statically select items into a collection. + +In addition, two API classes for fetching items from a collection are available as well: + +* `FriendsOfTYPO3\LegacyCollections\Collection\RecordCollectionRepository` +* `FriendsOfTYPO3\LegacyCollections\Collection\StaticRecordCollection` + +Both classes previously resided in the PHP namespace `TYPO3\CMS\Core\Collection`. + +The functionality was part of the TYPO3 Core until TYPO3 v11.0, and moved into its +own extension, receiving its own public repository. + +## Installation +The latest version can be installed via TER (https://extensions.typo3.org) or via composer +by adding `composer require friendsoftypo3/legacy-collections` in a TYPO3 v10.0+ installation. + +## Current state +The extension has been part of TYPO3 Core for a very long time but its API wasn't flexible +enough to build a generic collection model. It may become more healthy if maintained as third party +extension and has been extracted for this reason. + +## Contribution +Feel free to submit any pull request, or add documentation, tests, as you please. +We will publish a new version every once in a while, depending on the amount of changes +and pull requests submitted. + +### License +The extension is published under GPL v2+, all included third-party libraries are +published under their respective licenses. + +### Authors +Many contributors have been working on this area while this functionality was part of +the TYPO3 Core. This package is now maintained by a loose group of TYPO3 enthusiasts inside +the TYPO3 Community. Feel free to contact Benni Mack (benni.mack@typo3.org) for any questions +regarding "legacy_collections". diff --git a/Resources/Private/Language/locallang_tca.xlf b/Resources/Private/Language/locallang_tca.xlf new file mode 100644 index 0000000..52dc19b --- /dev/null +++ b/Resources/Private/Language/locallang_tca.xlf @@ -0,0 +1,29 @@ + + + +
+ + + Record Collection + + + Collection-Name + + + Description + + + Record Type of Collection + + + Items + + + Type of collection + + + static record composition + + + + diff --git a/Tests/Functional/Collection/RecordCollectionRepositoryTest.php b/Tests/Functional/Collection/RecordCollectionRepositoryTest.php new file mode 100644 index 0000000..3f03bad --- /dev/null +++ b/Tests/Functional/Collection/RecordCollectionRepositoryTest.php @@ -0,0 +1,335 @@ +subject = $this->getMockBuilder(RecordCollectionRepository::class) + ->setMethods(['getEnvironmentMode']) + ->getMock(); + $this->testTableName = StringUtility::getUniqueId('tx_testtable'); + } + + protected function tearDown(): void + { + parent::tearDown(); + + GeneralUtility::makeInstance(ConnectionPool::class) + ->getConnectionForTable('sys_collection') + ->truncate('sys_collection'); + } + + /** + * @test + */ + public function doesFindByTypeReturnNull() + { + $type = RecordCollectionRepository::TYPE_Static; + $objects = $this->subject->findByType($type); + self::assertNull($objects); + } + + /** + * @test + */ + public function doesFindByTypeReturnObjects() + { + $type = RecordCollectionRepository::TYPE_Static; + $this->insertTestData([ + ['uid' => 1, 'type' => $type, 'table_name' => $this->testTableName], + ['uid' => 2, 'type' => $type, 'table_name' => $this->testTableName] + ]); + + $objects = $this->subject->findByType($type); + self::assertCount(2, $objects); + self::assertInstanceOf(StaticRecordCollection::class, $objects[0]); + self::assertInstanceOf(StaticRecordCollection::class, $objects[1]); + } + + /** + * @test + */ + public function doesFindByTableNameReturnNull() + { + $objects = $this->subject->findByTableName($this->testTableName); + self::assertNull($objects); + } + + /** + * @test + */ + public function doesFindByTableNameReturnObjects() + { + $type = RecordCollectionRepository::TYPE_Static; + $this->insertTestData([ + ['uid' => 1, 'type' => $type, 'table_name' => $this->testTableName], + ['uid' => 2, 'type' => $type, 'table_name' => $this->testTableName] + ]); + $objects = $this->subject->findByTableName($this->testTableName); + + self::assertCount(2, $objects); + self::assertInstanceOf(StaticRecordCollection::class, $objects[0]); + self::assertInstanceOf(StaticRecordCollection::class, $objects[1]); + } + + /** + * @test + */ + public function doesFindByTypeAndTableNameReturnNull() + { + $type = RecordCollectionRepository::TYPE_Static; + $objects = $this->subject->findByTypeAndTableName($type, $this->testTableName); + + self::assertNull($objects); + } + + /** + * @test + */ + public function doesFindByTypeAndTableNameReturnObjects() + { + $type = RecordCollectionRepository::TYPE_Static; + $this->insertTestData([ + ['uid' => 1, 'type' => $type, 'table_name' => $this->testTableName], + ['uid' => 2, 'type' => $type, 'table_name' => $this->testTableName] + ]); + $objects = $this->subject->findByTypeAndTableName($type, $this->testTableName); + + self::assertCount(2, $objects); + self::assertInstanceOf(StaticRecordCollection::class, $objects[0]); + self::assertInstanceOf(StaticRecordCollection::class, $objects[1]); + } + + /** + * @test + */ + public function doesFindByUidReturnAnObjectInBackendMode() + { + $this->subject->method('getEnvironmentMode')->willReturn('BE'); + $type = RecordCollectionRepository::TYPE_Static; + $this->insertTestData([ + [ + 'uid' => 1, + 'type' => $type, + 'table_name' => $this->testTableName, + 'deleted' => 0, + 'hidden' => 0, + 'starttime' => 0, + 'endtime' => 0 + ] + ]); + $object = $this->subject->findByUid(1); + + self::assertInstanceOf(StaticRecordCollection::class, $object); + } + + /** + * @test + */ + public function doesFindByUidRespectDeletedFieldInBackendMode() + { + $this->subject->method('getEnvironmentMode')->willReturn('BE'); + $type = RecordCollectionRepository::TYPE_Static; + $this->insertTestData([ + [ + 'uid' => 1, + 'type' => $type, + 'table_name' => $this->testTableName, + 'deleted' => 1, + 'hidden' => 0, + 'starttime' => 0, + 'endtime' => 0 + ] + ]); + $object = $this->subject->findByUid(1); + + self::assertNull($object); + } + + /** + * @test + */ + public function doesFindByUidIgnoreOtherEnableFieldsInBackendMode() + { + $this->subject->method('getEnvironmentMode')->willReturn('BE'); + $type = RecordCollectionRepository::TYPE_Static; + $this->insertTestData([ + [ + 'uid' => 1, + 'type' => $type, + 'table_name' => $this->testTableName, + 'hidden' => 1, + ], + [ + 'uid' => 2, + 'type' => $type, + 'table_name' => $this->testTableName, + 'starttime' => time() + 99999, + ], + [ + 'uid' => 3, + 'type' => $type, + 'table_name' => $this->testTableName, + 'endtime' => time() - 99999 + ] + ]); + $hiddenObject = $this->subject->findByUid(1); + $futureObject = $this->subject->findByUid(2); + $expiredObject = $this->subject->findByUid(3); + + self::assertInstanceOf(StaticRecordCollection::class, $hiddenObject); + self::assertInstanceOf(StaticRecordCollection::class, $futureObject); + self::assertInstanceOf(StaticRecordCollection::class, $expiredObject); + } + + /** + * @test + */ + public function doesFindByUidReturnAnObjectInFrontendMode() + { + $this->subject->method('getEnvironmentMode')->willReturn('FE'); + $type = RecordCollectionRepository::TYPE_Static; + $this->insertTestData([ + [ + 'uid' => 1, + 'type' => $type, + 'table_name' => $this->testTableName, + 'deleted' => 0, + 'hidden' => 0, + 'starttime' => 0, + 'endtime' => 0 + ] + ]); + $object = $this->subject->findByUid(1); + + self::assertInstanceOf(StaticRecordCollection::class, $object); + } + + /** + * @test + */ + public function doesFindByUidRespectEnableFieldsInFrontendMode() + { + $this->subject->method('getEnvironmentMode')->willReturn('FE'); + $type = RecordCollectionRepository::TYPE_Static; + $this->insertTestData([ + [ + 'uid' => 1, + 'type' => $type, + 'table_name' => $this->testTableName, + 'deleted' => 1, + ], + [ + 'uid' => 2, + 'type' => $type, + 'table_name' => $this->testTableName, + 'hidden' => 1, + ], + [ + 'uid' => 3, + 'type' => $type, + 'table_name' => $this->testTableName, + 'starttime' => time() + 99999, + ], + [ + 'uid' => 4, + 'type' => $type, + 'table_name' => $this->testTableName, + 'endtime' => time() - 99999 + ] + ]); + $deletedObject = $this->subject->findByUid(1); + $hiddenObject = $this->subject->findByUid(2); + $futureObject = $this->subject->findByUid(3); + $expiredObject = $this->subject->findByUid(4); + + self::assertNull($deletedObject); + self::assertNull($hiddenObject); + self::assertNull($futureObject); + self::assertNull($expiredObject); + } + + /** + * Insert test rows into the sys_collection table + * + * @param array $rows + */ + protected function insertTestData(array $rows) + { + $connection = GeneralUtility::makeInstance(ConnectionPool::class)->getConnectionForTable('sys_collection'); + $platform = $connection->getDatabasePlatform(); + $sqlServerIdentityDisabled = false; + if ($platform instanceof SQLServerPlatform) { + try { + $connection->exec('SET IDENTITY_INSERT sys_collection ON'); + $sqlServerIdentityDisabled = true; + } catch (DBALException $e) { + // Some tables like sys_refindex don't have an auto-increment uid field and thus no + // IDENTITY column. Instead of testing existence, we just try to set IDENTITY ON + // and catch the possible error that occurs. + } + } + + $types = []; + $tableDetails = $connection->getSchemaManager()->listTableDetails('sys_collection'); + foreach ($rows as $row) { + foreach ($row as $columnName => $columnValue) { + $types[] = $tableDetails->getColumn($columnName)->getType()->getBindingType(); + } + break; + } + + foreach ($rows as $row) { + $connection->insert('sys_collection', $row, $types); + } + + if ($sqlServerIdentityDisabled) { + // Reset identity if it has been changed + $connection->exec('SET IDENTITY_INSERT sys_collection OFF'); + } + } +} diff --git a/Tests/Functional/Tca/CollectionVisibleFieldsTest.php b/Tests/Functional/Tca/CollectionVisibleFieldsTest.php new file mode 100644 index 0000000..b83c647 --- /dev/null +++ b/Tests/Functional/Tca/CollectionVisibleFieldsTest.php @@ -0,0 +1,57 @@ +setUpBackendUserFromFixture(1); + $GLOBALS['LANG'] = GeneralUtility::makeInstance(LanguageService::class); + + $formEngineTestService = GeneralUtility::makeInstance(FormTestService::class); + $formResult = $formEngineTestService->createNewRecordForm('sys_collection'); + + foreach (static::$collectionFields as $expectedField) { + self::assertNotFalse( + $formEngineTestService->formHtmlContainsField($expectedField, $formResult['html']), + 'The field ' . $expectedField . ' is not in the form HTML' + ); + } + } +} diff --git a/composer.json b/composer.json new file mode 100644 index 0000000..bfafce2 --- /dev/null +++ b/composer.json @@ -0,0 +1,35 @@ +{ + "name": "friendsoftypo3/legacy-collections", + "type": "typo3-cms-extension", + "description": "Legacy Collection PHP APIs for sys_collection database tables.", + "homepage": "https://typo3.org", + "license": ["GPL-2.0+"], + "require": { + "php": "^7.2", + "typo3/cms-core": "^10.0 || ^11.0", + "typo3/cms-frontend": "^10.0 || ^11.0" + }, + "require-dev": { + "typo3/testing-framework": "^6.3.2" + }, + "extra": { + "typo3/class-alias-loader": { + "class-alias-maps": [ + "Migrations/Code/ClassAliasMap.php" + ] + }, + "typo3/cms": { + "extension-key": "legacy_collections" + } + }, + "autoload": { + "psr-4": { + "FriendsOfTYPO3\\LegacyCollections\\": "Classes/" + } + }, + "autoload-dev": { + "psr-4": { + "FriendsOfTYPO3\\LegacyCollections\\Tests\\": "Tests/" + } + } +} diff --git a/ext_emconf.php b/ext_emconf.php new file mode 100644 index 0000000..bf37334 --- /dev/null +++ b/ext_emconf.php @@ -0,0 +1,22 @@ + 'Legacy Collection PHP APIs for sys_collection database tables', + 'description' => 'Adds PHP classes, TCA configuration and database tables for generic record collections.', + 'category' => 'misc', + 'state' => 'stable', + 'clearCacheOnLoad' => 0, + 'author' => 'Benni Mack', + 'author_email' => 'benni@typo3.org', + 'author_company' => '', + 'version' => '1.0.0', + 'constraints' => [ + 'depends' => [ + 'typo3' => '11.0.0', + 'extbase' => '11.0.0', + 'fluid' => '11.0.0', + ], + 'conflicts' => [], + 'suggests' => [], + ], +]; diff --git a/ext_tables.sql b/ext_tables.sql new file mode 100644 index 0000000..7f6894f --- /dev/null +++ b/ext_tables.sql @@ -0,0 +1,24 @@ +# +# Table structure for table 'sys_collection' +# +CREATE TABLE sys_collection ( + title tinytext, + type varchar(32) DEFAULT 'static' NOT NULL, + table_name tinytext, + items int(11) DEFAULT '0' NOT NULL +); + +# +# Table structure for table 'sys_collection_entries' +# +CREATE TABLE sys_collection_entries ( + uid int(11) NOT NULL auto_increment, + uid_local int(11) DEFAULT '0' NOT NULL, + uid_foreign int(11) DEFAULT '0' NOT NULL, + tablenames varchar(64) DEFAULT '' NOT NULL, + sorting int(11) DEFAULT '0' NOT NULL, + + KEY uid_local (uid_local), + KEY uid_foreign (uid_foreign), + PRIMARY KEY (uid) +);