!/ext/payflowpro
!/ext/ckeditor4
!/ext/legacycustomsearches
+!/ext/civiimport
backdrop/
bower_components
CRM/Case/xml/configuration
*/
protected $entityTableName;
+ /**
+ * @return string
+ */
+ public function getEntityTableName(): ?string {
+ return $this->entityTableName;
+ }
+
/**
* @var FieldSpec[]
*/
## Prune local data
$MYSQLCMD -e "DROP TABLE IF EXISTS civicrm_install_canary; DELETE FROM civicrm_cache; DELETE FROM civicrm_setting;"
-$MYSQLCMD -e "DELETE FROM civicrm_extension WHERE full_name NOT IN ('sequentialcreditnotes', 'eventcart', 'greenwich', 'search', 'org.civicrm.flexmailer', 'financialacls', 'contributioncancelactions', 'recaptcha', 'ckeditor4', 'legacycustomsearches');"
+$MYSQLCMD -e "DELETE FROM civicrm_extension WHERE full_name NOT IN ('sequentialcreditnotes', 'eventcart', 'greenwich', 'search', 'org.civicrm.flexmailer', 'financialacls', 'contributioncancelactions', 'recaptcha', 'ckeditor4', 'legacycustomsearches', 'civiimport');"
TABLENAMES=$( echo "show tables like 'civicrm_%'" | $MYSQLCMD | grep ^civicrm_ | xargs )
cd $CIVISOURCEDIR/sql
authx
civicrm_admin_ui
civigrant
+civiimport
contributioncancelactions
ckeditor4
eventcart
--- /dev/null
+<?php
+
+/**
+ *
+ * @package CRM
+ * @copyright CiviCRM LLC https://civicrm.org/licensing
+ */
+namespace Civi\Api4\Event\Subscriber;
+
+use Civi;
+use Civi\API\Event\AuthorizeEvent;
+use Civi\API\Events;
+use Civi\Api4\UserJob;
+use Civi\Core\Event\PostEvent;
+use Civi\Core\Event\GenericHookEvent;
+use CRM_Core_DAO_AllCoreTables;
+use Civi\Api4\Import;
+use Symfony\Component\EventDispatcher\EventSubscriberInterface;
+use Civi\API\Exception\UnauthorizedException;
+
+/**
+ * Listening class that registers each Import table as an entity.
+ */
+class ImportSubscriber implements EventSubscriberInterface {
+
+ /**
+ * Get the events this class listens to.
+ *
+ * @return string[]
+ */
+ public static function getSubscribedEvents(): array {
+ return [
+ 'hook_civicrm_post' => 'on_hook_civicrm_post',
+ 'civi.api4.entityTypes' => 'on_civi_api4_entityTypes',
+ 'civi.api.authorize' => [['onApiAuthorize', Events::W_EARLY]],
+ ];
+ }
+
+ /**
+ * Register each valid import as an entity
+ *
+ * @param \Civi\Core\Event\GenericHookEvent $event
+ */
+ public static function on_civi_api4_entityTypes(GenericHookEvent $event): void {
+ $importEntities = Civi\BAO\Import::getImportTables();
+ foreach ($importEntities as $userJobID => $table) {
+ /** @noinspection PhpUndefinedFieldInspection */
+ $event->entities['Import_' . $userJobID] = [
+ 'name' => 'Import_' . $userJobID,
+ 'title' => ts('Import Data') . ' ' . $userJobID . (empty($table['created_by']) ? '' : '(' . $table['created_by'] . ')'),
+ 'title_plural' => ts('Import Data') . ' ' . $userJobID,
+ 'description' => ts('Import Job temporary data'),
+ 'primary_key' => ['_id'],
+ 'type' => ['Import'],
+ 'table_name' => $table['table_name'],
+ 'class_args' => [$userJobID],
+ 'label_field' => '_id',
+ 'searchable' => 'secondary',
+ 'paths' => [
+ // 'browse' => "civicrm/eck/entity/list/{$entity_type['name']}",
+ // 'view' => "civicrm/eck/entity?reset=1&action=view&type={$entity_type['name']}&id=[id]",
+ // 'update' => "civicrm/eck/entity/edit/{$entity_type['name']}/[subtype:name]#?{$entity_type['entity_name']}=[id]",
+ // 'add' => "civicrm/eck/entity/edit/{$entity_type['name']}/[subtype:name]",
+ ],
+ 'class' => Import::class,
+ 'icon' => 'fa-upload',
+ ];
+ }
+ }
+
+ /**
+ * Callback for hook_civicrm_post().
+ */
+ public function on_hook_civicrm_post(PostEvent $event): void {
+ if ($event->entity === 'UserJob' && $event->action === 'create') {
+ // Flush entities cache key so our new Import will load as an entity.
+ Civi::cache('metadata')->set('api4.entities.info', NULL);
+ CRM_Core_DAO_AllCoreTables::flush();
+ }
+ }
+
+ /**
+ * @param \Civi\API\Event\AuthorizeEvent $event
+ * API authorization event.
+ *
+ * @throws \CRM_Core_Exception
+ * @throws \Civi\API\Exception\UnauthorizedException
+ */
+ public function onApiAuthorize(AuthorizeEvent $event): void {
+ $apiRequest = $event->getApiRequest();
+ $entity = $apiRequest['entity'];
+ if (strpos($entity, 'Import_') === 0) {
+ $userJobID = (int) (str_replace('Import_', '', $entity));
+ if (!UserJob::get(TRUE)->addWhere('id', '=', $userJobID)->selectRowCount()->execute()->count()) {
+ throw new UnauthorizedException('Import access not permitted');
+ }
+ }
+ }
+
+}
--- /dev/null
+<?php
+/*
+ +--------------------------------------------------------------------+
+ | Copyright CiviCRM LLC. All rights reserved. |
+ | |
+ | This work is published under the GNU AGPLv3 license with some |
+ | permitted exceptions and without any warranty. For full license |
+ | and copyright information, see https://civicrm.org/licensing |
+ +--------------------------------------------------------------------+
+ */
+namespace Civi\Api4;
+
+use Civi\Api4\Generic\BasicReplaceAction;
+use Civi\Api4\Generic\CheckAccessAction;
+use Civi\Api4\Generic\DAOCreateAction;
+use Civi\Api4\Generic\DAODeleteAction;
+use Civi\Api4\Generic\DAOGetAction;
+use Civi\Api4\Generic\DAOGetFieldsAction;
+use Civi\Api4\Action\GetActions;
+use Civi\Api4\Import\Save;
+use Civi\Api4\Import\Update;
+
+/**
+ * Import entity.
+ *
+ * @searchable secondary
+ * @since 5.54
+ * @package Civi\Api4
+ */
+class Import {
+
+ /**
+ * @param int $userJobID
+ * @param bool $checkPermissions
+ *
+ * @return \Civi\Api4\Generic\DAOGetFieldsAction
+ */
+ public static function getFields(int $userJobID, bool $checkPermissions = TRUE): DAOGetFieldsAction {
+ return (new DAOGetFieldsAction('Import_' . $userJobID, __FUNCTION__))
+ ->setCheckPermissions($checkPermissions);
+ }
+
+ /**
+ * @param int $userJobID
+ * @param bool $checkPermissions
+ * @return \Civi\Api4\Generic\DAOGetAction
+ * @throws \CRM_Core_Exception
+ */
+ public static function get(int $userJobID, bool $checkPermissions = TRUE): DAOGetAction {
+ return (new DAOGetAction('Import_' . $userJobID, __FUNCTION__))
+ ->setCheckPermissions($checkPermissions);
+ }
+
+ /**
+ * @param int $userJobID
+ * @param bool $checkPermissions
+ * @return \Civi\Api4\Import\Save
+ * @throws \API_Exception
+ */
+ public static function save(int $userJobID, bool $checkPermissions = TRUE): Save {
+ return (new Save('Import_' . $userJobID, __FUNCTION__))
+ ->setCheckPermissions($checkPermissions);
+ }
+
+ /**
+ * @param int $userJobID
+ * @param bool $checkPermissions
+ * @return \Civi\Api4\Generic\DAOCreateAction
+ * @throws \API_Exception
+ */
+ public static function create(int $userJobID, bool $checkPermissions = TRUE): DAOCreateAction {
+ return (new DAOCreateAction('Import_' . $userJobID, __FUNCTION__))
+ ->setCheckPermissions($checkPermissions);
+ }
+
+ /**
+ * @param int $userJobID
+ * @param bool $checkPermissions
+ * @return \Civi\Api4\Import\Update
+ * @throws \API_Exception
+ */
+ public static function update(int $userJobID, bool $checkPermissions = TRUE): Update {
+ return (new Update('Import_' . $userJobID, __FUNCTION__))
+ ->setCheckPermissions($checkPermissions);
+ }
+
+ /**
+ * @param int $userJobID
+ * @param bool $checkPermissions
+ * @return \Civi\Api4\Generic\DAODeleteAction
+ * @throws \API_Exception
+ */
+ public static function delete(int $userJobID, bool $checkPermissions = TRUE): DAODeleteAction {
+ return (new DAODeleteAction('Import_' . $userJobID, __FUNCTION__))
+ ->setCheckPermissions($checkPermissions);
+ }
+
+ /**
+ * @param int $userJobID
+ * @param bool $checkPermissions
+ * @return \Civi\Api4\Generic\BasicReplaceAction
+ * @throws \API_Exception
+ */
+ public static function replace(int $userJobID, bool $checkPermissions = TRUE): BasicReplaceAction {
+ return (new BasicReplaceAction('Import_' . $userJobID, __FUNCTION__))
+ ->setCheckPermissions($checkPermissions);
+ }
+
+ /**
+ * @param int $userJobID
+ * @param bool $checkPermissions
+ * @return \Civi\Api4\Action\GetActions
+ */
+ public static function getActions(int $userJobID, bool $checkPermissions = TRUE): GetActions {
+ return (new GetActions('Import_' . $userJobID, __FUNCTION__))
+ ->setCheckPermissions($checkPermissions);
+ }
+
+ /**
+ * @param int $userJobID
+ * @return \Civi\Api4\Generic\CheckAccessAction
+ * @throws \API_Exception
+ */
+ public static function checkAccess(int $userJobID): CheckAccessAction {
+ return new CheckAccessAction('Import_' . $userJobID, __FUNCTION__);
+ }
+
+ /**
+ * We need to implement these elsewhere as we permit based on 'created_id'.
+ *
+ * @return array
+ */
+ public static function permissions(): array {
+ return [];
+ }
+
+}
--- /dev/null
+<?php
+
+/*
+ +--------------------------------------------------------------------+
+ | Copyright CiviCRM LLC. All rights reserved. |
+ | |
+ | This work is published under the GNU AGPLv3 license with some |
+ | permitted exceptions and without any warranty. For full license |
+ | and copyright information, see https://civicrm.org/licensing |
+ +--------------------------------------------------------------------+
+ */
+
+namespace Civi\Api4\Import;
+
+use Civi\Api4\Generic\DAOSaveAction;
+use Civi\Api4\Generic\Result;
+
+class Save extends DAOSaveAction {
+
+ /**
+ * Import save action.
+ *
+ * This is copied from `DAOSaveAction` to add the user_job_id to the array & to
+ * the reference to '_id' not 'id'.
+ *
+ * @inheritDoc
+ */
+ public function _run(Result $result): void {
+ $userJobID = str_replace('Import_', '', $this->_entityName);
+ $this->defaults['user_job_id'] = (int) $userJobID;
+ parent::_run($result);
+ }
+
+}
--- /dev/null
+<?php
+namespace Civi\Api4\Import;
+
+use Civi\Api4\Generic\DAOUpdateAction;
+
+class Update extends DAOUpdateAction {
+
+ /**
+ * Update import table records.
+ *
+ * @param array $items
+ * @return array
+ * @throws \API_Exception
+ * @throws \CRM_Core_Exception
+ */
+ protected function updateRecords(array $items): array {
+ $userJobID = str_replace('Import_', '', $this->_entityName);
+ foreach ($items as &$item) {
+ $item['user_job_id'] = (int) $userJobID;
+ }
+ return parent::updateRecords($items);
+ }
+
+}
--- /dev/null
+<?php
+
+/*
+ +--------------------------------------------------------------------+
+ | Copyright CiviCRM LLC. All rights reserved. |
+ | |
+ | This work is published under the GNU AGPLv3 license with some |
+ | permitted exceptions and without any warranty. For full license |
+ | and copyright information, see https://civicrm.org/licensing |
+ +--------------------------------------------------------------------+
+ */
+
+namespace Civi\Api4\Service\Spec\Provider;
+
+use Civi\Api4\Service\Spec\FieldSpec;
+use Civi\Api4\Service\Spec\RequestSpec;
+use Civi\Api4\UserJob;
+use Civi\BAO\Import;
+use CRM_Core_BAO_UserJob;
+
+class ImportSpecProvider implements Generic\SpecProviderInterface {
+
+ /**
+ * @inheritDoc
+ * @throws \CRM_Core_Exception
+ */
+ public function modifySpec(RequestSpec $spec): void {
+ $tableName = $spec->getEntityTableName();
+ $columns = Import::getFieldsForTable($tableName);
+ $action = $spec->getAction();
+ // CheckPermissions does not reach us here - so we will have to rely on earlier permission filters.
+ $userJobID = substr($spec->getEntity(), (strpos($spec->getEntity(), '_') + 1));
+ $userJob = UserJob::get(FALSE)->addWhere('id', '=', $userJobID)->addSelect('metadata', 'job_type', 'created_id')->execute()->first();
+
+ if (in_array($action, ['create', 'update'], TRUE)) {
+ $field = new FieldSpec('user_job_id', $spec->getEntity(), 'String');
+ $field->setTitle(ts('User Job ID'));
+ $field->setLabel(ts('User Job ID'));
+ $field->setFkEntity('UserJob');
+ $field->setReadonly(TRUE);
+ $field->setDefaultValue($userJobID);
+ $spec->addFieldSpec($field);
+ }
+
+ $headers = $userJob['metadata']['DataSource']['column_headers'] ?? [];
+ foreach ($columns as $column) {
+ $isInternalField = strpos($column['name'], '_') === 0;
+ $exists = $isInternalField && $spec->getFieldByName($column['name']);
+ if ($exists) {
+ continue;
+ }
+ $header = $isInternalField ? $column['name'] : array_shift($headers);
+ $field = new FieldSpec($column['name'], $spec->getEntity(), 'String');
+ $field->setTitle(ts('Import field') . ':' . $header);
+ $field->setLabel($header);
+ $field->setReadonly($isInternalField);
+ $field->setDescription(ts('Data being imported into the field.'));
+ $field->setColumnName($column['name']);
+ if ($column['name'] === '_entity_id') {
+ $jobTypes = CRM_Core_BAO_UserJob::getTypes();
+ foreach ($jobTypes as $jobType) {
+ if ($userJob['job_type'] === $jobType['id'] && $jobType['entity']) {
+ $field->setFkEntity($jobType['entity']);
+ $field->setInputType('EntityRef');
+ }
+ }
+ }
+ $spec->addFieldSpec($field);
+ }
+
+ }
+
+ /**
+ * @inheritDoc
+ */
+ public function applies($entity, $action): bool {
+ return strpos($entity, 'Import_') === 0;
+ }
+
+}
--- /dev/null
+<?php
+/*
+ +--------------------------------------------------------------------+
+ | Copyright CiviCRM LLC. All rights reserved. |
+ | |
+ | This work is published under the GNU AGPLv3 license with some |
+ | permitted exceptions and without any warranty. For full license |
+ | and copyright information, see https://civicrm.org/licensing |
+ +--------------------------------------------------------------------+
+ */
+
+namespace Civi\BAO;
+
+use Civi\Api4\UserJob;
+use CRM_Civiimport_ExtensionUtil as E;
+use CRM_Core_BAO_CustomValueTable;
+use CRM_Core_DAO;
+use CRM_Core_Exception;
+use CRM_Utils_Hook;
+use CRM_Utils_Rule;
+use CRM_Utils_Type;
+
+/**
+ *
+ * @package CRM
+ * @copyright CiviCRM LLC https://civicrm.org/licensing
+ */
+class Import extends CRM_Core_DAO {
+
+ /**
+ * This is the id field - it has an underscore due to the import table naming convention.
+ *
+ * @var int
+ */
+ protected $_id;
+
+ /**
+ * Primary key field.
+ *
+ * @var string[]
+ */
+ public static $_primaryKey = ['_id'];
+
+ /**
+ * @return array
+ */
+ public static function getImportTables(): array {
+ // We need to avoid the api here as it
+ $tables = CRM_Core_DAO::executeQuery('
+ Select `user_job`.`id` as id, `metadata`, `name`, `job_type`, `user_job`.`created_id`, `created_id`.`display_name`, `user_job`.`created_date`, `user_job`.`expires_date`
+ FROM civicrm_user_job user_job
+ LEFT JOIN civicrm_contact created_id ON created_id.id = created_id
+ -- As of writing expires date is probably not being managed
+ -- it is intended to be used to actually purge the record in
+ -- a cleanup job so it might not be relevant here & perhaps this will
+ -- be removed later
+ WHERE (expires_date IS NULL OR expires_date > NOW())
+ -- this is a short-cut for looking up if they are imports
+ -- it is a new convention, at best, to require anything
+ -- specific in the job_type, but it saves any onerous lookups
+ -- in a function which needs to avoid loops
+ AND job_type LIKE "%import"
+ -- also more of a feature than a specification - but we need a table
+ -- to do this pseudo-api
+ AND metadata LIKE "%table_name%"');
+ $importEntities = [];
+ while ($tables->fetch()) {
+ $tableName = json_decode($tables->metadata, TRUE)['DataSource']['table_name'];
+ if (!CRM_Utils_Rule::alphanumeric($tableName) || !CRM_Core_DAO::singleValueQuery('SHOW TABLES LIKE %1', [1 => [$tableName, 'String']])) {
+ continue;
+ }
+ $importEntities[$tables->id] = [
+ 'user_job_id' => $tables->id,
+ 'table_name' => $tableName,
+ 'created_by' => $tables->display_name,
+ 'created_id' => $tables->created_id ? (int) $tables->created_id : NULL,
+ 'job_type' => $tables->job_type,
+ 'created_date' => $tables->created_date,
+ 'expires_date' => $tables->expires_date,
+ ];
+ }
+ return $importEntities;
+ }
+
+ /**
+ * @return string[]
+ */
+ protected function getPrimaryKey(): array {
+ return self::$_primaryKey;
+ }
+
+ /**
+ * Returns fields generic to all imports, indexed by name.
+ *
+ * This function could arguably go, leaving it to the `ImportSpecProvider`
+ * which adds all the other fields. But it does have the nice side effect of
+ * putting these three fields first in a natural sort.
+ *
+ * @param bool $checkPermissions
+ * Filter by field permissions.
+ * @return array
+ */
+ public static function getSupportedFields($checkPermissions = FALSE): array {
+ return [
+ '_id' => [
+ 'type' => 'Field',
+ 'required' => FALSE,
+ 'nullable' => FALSE,
+ 'readonly' => TRUE,
+ 'name' => '_id',
+ 'title' => E::ts('Import row ID'),
+ 'data_type' => 'Integer',
+ 'input_type' => 'Number',
+ 'column_name' => '_id',
+ ],
+ '_status' => [
+ 'type' => 'Field',
+ 'required' => TRUE,
+ // We should add a requeue action or just define an option group but for now..
+ 'readonly' => TRUE,
+ 'nullable' => FALSE,
+ 'name' => '_status',
+ 'title' => E::ts('Row status'),
+ 'data_type' => 'String',
+ 'column_name' => '_status_message',
+ ],
+ '_status_message' => [
+ 'type' => 'Field',
+ 'nullable' => TRUE,
+ 'readonly' => TRUE,
+ 'name' => '_status_message',
+ 'title' => E::ts('Row import message'),
+ 'description' => '',
+ 'data_type' => 'String',
+ 'column_name' => '_status_message',
+ ],
+ ];
+ }
+
+ /**
+ * Over-ride the parent to prevent a NULL return.
+ *
+ * Metadata otherwise handled in `table()`, `writeRecord` and `ImportSpecProvider`
+ *
+ * @return array
+ */
+ public static function &fields(): array {
+ $result = [];
+ return $result;
+ }
+
+ /**
+ * Override variant of metadata function used in DAO->insert().
+ *
+ * @return array
+ * @throws \CRM_Core_Exception
+ */
+ public function table(): array {
+ $table = [];
+ foreach (self::getFieldsForTable($this->tableName()) as $value) {
+ $table[$value['name']] = $value['type'] ?? CRM_Utils_Type::T_STRING;
+ if (!empty($value['required'])) {
+ $table[$value['name']] += self::DB_DAO_NOTNULL;
+ }
+ }
+ return $table;
+ }
+
+ /**
+ * Create or update a record from supplied params.
+ *
+ * This overrides the parent in order to tinker with the available fields.
+ *
+ * If '_id' is supplied, an existing record will be updated
+ * Otherwise a new record will be created.
+ *
+ * @param array $record
+ *
+ * @return static
+ * @throws \CRM_Core_Exception
+ */
+ public static function writeRecord(array $record): CRM_Core_DAO {
+ $op = empty($record['id']) ? 'create' : 'edit';
+ $userJobID = $record['user_job_id'];
+ $entityName = 'Import_' . $userJobID;
+ $userJob = UserJob::get($record['check_permissions'])->addWhere('id', '=', $userJobID)->addSelect('metadata', 'job_type', 'created_id')->execute()->first();
+
+ $tableName = $userJob['metadata']['DataSource']['table_name'];
+ CRM_Utils_Hook::pre($op, $entityName, $record['id'] ?? NULL, $record);
+ $fields = self::getAllFields($tableName);
+ $instance = new self();
+ $instance->__table = $tableName;
+ // Ensure fields exist before attempting to write to them
+ $values = array_intersect_key($record, $fields);
+ foreach ($values as $field => $value) {
+ $instance->$field = ($value === '') ? 'null' : $value;
+ }
+ $instance->save();
+
+ if (!empty($record['custom']) && is_array($record['custom'])) {
+ CRM_Core_BAO_CustomValueTable::store($record['custom'], $tableName, $instance->_id, $op);
+ }
+
+ CRM_Utils_Hook::post($op, $entityName, $instance->_id, $instance);
+
+ return $instance;
+ }
+
+ /**
+ * Get all the fields available for the import table.
+ *
+ * This gets the fields based on a `SHOW COLUMNS` result.
+ *
+ * @param string $tableName
+ *
+ * @return array
+ * @throws \CRM_Core_Exception
+ */
+ public static function getFieldsForTable(string $tableName): array {
+ if (!CRM_Utils_Rule::alphanumeric($tableName)) {
+ // This is purely precautionary so does not need to be a translated string.
+ throw new CRM_Core_Exception('Invalid import table');
+ }
+ $columns = [];
+ $result = CRM_Core_DAO::executeQuery("SHOW COLUMNS FROM $tableName");
+ while ($result->fetch()) {
+ $columns[$result->Field] = ['name' => $result->Field, 'table_name' => $tableName];
+ }
+ return $columns;
+ }
+
+ /**
+ * Get all the fields available for the import table.
+ *
+ * This gets the fields based on a `SHOW COLUMNS` result.
+ *
+ * @param int $userJobID
+ * @param bool $checkPermissions
+ *
+ * @return array
+ *
+ * @throws \CRM_Core_Exception
+ * @throws \Civi\API\Exception\UnauthorizedException
+ */
+ public static function getFieldsForUserJobID(int $userJobID, bool $checkPermissions = TRUE): array {
+ $userJob = UserJob::get($checkPermissions)
+ ->addWhere('id', '=', $userJobID)
+ ->addSelect('created_id.display_name', 'created_id', 'metadata')
+ ->execute()->first();
+ $tableName = $userJob['metadata']['DataSource']['table_name'];
+ return self::getAllFields($tableName);
+ }
+
+ /**
+ * Checks if this DAO's table ought to exist to prevent import fails.
+ *
+ * Since these tables are dropped during import & the API will
+ * not see them as entities if they don't exist this should be safe.
+ *
+ * @return bool
+ */
+ public static function tableHasBeenAdded(): bool {
+ return TRUE;
+ }
+
+ /**
+ * Get all fields for the import instance.
+ *
+ * @param string $tableName
+ *
+ * @return array[]
+ * @throws \CRM_Core_Exception
+ */
+ private static function getAllFields(string $tableName): array {
+ return array_merge(self::getFieldsForTable($tableName), self::getSupportedFields());
+ }
+
+}
--- /dev/null
+Package: civiimport
+Copyright (C) 2022, FIXME <FIXME>
+Licensed under the GNU Affero Public License 3.0 (below).
+
+-------------------------------------------------------------------------------
+
+ GNU AFFERO GENERAL PUBLIC LICENSE
+ Version 3, 19 November 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+ Preamble
+
+ The GNU Affero General Public License is a free, copyleft license for
+software and other kinds of works, specifically designed to ensure
+cooperation with the community in the case of network server software.
+
+ The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works. By contrast,
+our General Public Licenses are intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains free
+software for all its users.
+
+ 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
+them 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.
+
+ Developers that use our General Public Licenses protect your rights
+with two steps: (1) assert copyright on the software, and (2) offer
+you this License which gives you legal permission to copy, distribute
+and/or modify the software.
+
+ A secondary benefit of defending all users' freedom is that
+improvements made in alternate versions of the program, if they
+receive widespread use, become available for other developers to
+incorporate. Many developers of free software are heartened and
+encouraged by the resulting cooperation. However, in the case of
+software used on network servers, this result may fail to come about.
+The GNU General Public License permits making a modified version and
+letting the public access it on a server without ever releasing its
+source code to the public.
+
+ The GNU Affero General Public License is designed specifically to
+ensure that, in such cases, the modified source code becomes available
+to the community. It requires the operator of a network server to
+provide the source code of the modified version running there to the
+users of that server. Therefore, public use of a modified version, on
+a publicly accessible server, gives the public access to the source
+code of the modified version.
+
+ An older license, called the Affero General Public License and
+published by Affero, was designed to accomplish similar goals. This is
+a different license, not a version of the Affero GPL, but Affero has
+released a new version of the Affero GPL which permits relicensing under
+this license.
+
+ The precise terms and conditions for copying, distribution and
+modification follow.
+
+ TERMS AND CONDITIONS
+
+ 0. Definitions.
+
+ "This License" refers to version 3 of the GNU Affero General Public License.
+
+ "Copyright" also means copyright-like laws that apply to other kinds of
+works, such as semiconductor masks.
+
+ "The Program" refers to any copyrightable work licensed under this
+License. Each licensee is addressed as "you". "Licensees" and
+"recipients" may be individuals or organizations.
+
+ To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of an
+exact copy. The resulting work is called a "modified version" of the
+earlier work or a work "based on" the earlier work.
+
+ A "covered work" means either the unmodified Program or a work based
+on the Program.
+
+ To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy. Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
+
+ To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies. Mere interaction with a user through
+a computer network, with no transfer of a copy, is not conveying.
+
+ An interactive user interface displays "Appropriate Legal Notices"
+to the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License. If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
+
+ 1. Source Code.
+
+ The "source code" for a work means the preferred form of the work
+for making modifications to it. "Object code" means any non-source
+form of a work.
+
+ A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
+
+ The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form. A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
+
+ The "Corresponding Source" for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities. However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work. For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
+
+ The Corresponding Source need not include anything that users
+can regenerate automatically from other parts of the Corresponding
+Source.
+
+ The Corresponding Source for a work in source code form is that
+same work.
+
+ 2. Basic Permissions.
+
+ All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met. This License explicitly affirms your unlimited
+permission to run the unmodified Program. The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work. This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
+
+ You may make, run and propagate covered works that you do not
+convey, without conditions so long as your license otherwise remains
+in force. You may convey covered works to others for the sole purpose
+of having them make modifications exclusively for you, or provide you
+with facilities for running those works, provided that you comply with
+the terms of this License in conveying all material for which you do
+not control copyright. Those thus making or running the covered works
+for you must do so exclusively on your behalf, under your direction
+and control, on terms that prohibit them from making any copies of
+your copyrighted material outside their relationship with you.
+
+ Conveying under any other circumstances is permitted solely under
+the conditions stated below. Sublicensing is not allowed; section 10
+makes it unnecessary.
+
+ 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+ No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+ When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such circumvention
+is effected by exercising rights under this License with respect to
+the covered work, and you disclaim any intention to limit operation or
+modification of the work as a means of enforcing, against the work's
+users, your or third parties' legal rights to forbid circumvention of
+technological measures.
+
+ 4. Conveying Verbatim Copies.
+
+ You may convey 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;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+ You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+ 5. Conveying Modified Source Versions.
+
+ You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these conditions:
+
+ a) The work must carry prominent notices stating that you modified
+ it, and giving a relevant date.
+
+ b) The work must carry prominent notices stating that it is
+ released under this License and any conditions added under section
+ 7. This requirement modifies the requirement in section 4 to
+ "keep intact all notices".
+
+ c) You must license the entire work, as a whole, under this
+ License to anyone who comes into possession of a copy. This
+ License will therefore apply, along with any applicable section 7
+ additional terms, to the whole of the work, and all its parts,
+ regardless of how they are packaged. This License gives no
+ permission to license the work in any other way, but it does not
+ invalidate such permission if you have separately received it.
+
+ d) If the work has interactive user interfaces, each must display
+ Appropriate Legal Notices; however, if the Program has interactive
+ interfaces that do not display Appropriate Legal Notices, your
+ work need not make them do so.
+
+ A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit. Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+ 6. Conveying Non-Source Forms.
+
+ You may convey a covered work in object code form under the terms
+of sections 4 and 5, provided that you also convey the
+machine-readable Corresponding Source under the terms of this License,
+in one of these ways:
+
+ a) Convey the object code in, or embodied in, a physical product
+ (including a physical distribution medium), accompanied by the
+ Corresponding Source fixed on a durable physical medium
+ customarily used for software interchange.
+
+ b) Convey the object code in, or embodied in, a physical product
+ (including a physical distribution medium), accompanied by a
+ written offer, valid for at least three years and valid for as
+ long as you offer spare parts or customer support for that product
+ model, to give anyone who possesses the object code either (1) a
+ copy of the Corresponding Source for all the software in the
+ product that is covered by this License, on a durable physical
+ medium customarily used for software interchange, for a price no
+ more than your reasonable cost of physically performing this
+ conveying of source, or (2) access to copy the
+ Corresponding Source from a network server at no charge.
+
+ c) Convey individual copies of the object code with a copy of the
+ written offer to provide the Corresponding Source. This
+ alternative is allowed only occasionally and noncommercially, and
+ only if you received the object code with such an offer, in accord
+ with subsection 6b.
+
+ d) Convey the object code by offering access from a designated
+ place (gratis or for a charge), and offer equivalent access to the
+ Corresponding Source in the same way through the same place at no
+ further charge. You need not require recipients to copy the
+ Corresponding Source along with the object code. If the place to
+ copy the object code is a network server, the Corresponding Source
+ may be on a different server (operated by you or a third party)
+ that supports equivalent copying facilities, provided you maintain
+ clear directions next to the object code saying where to find the
+ Corresponding Source. Regardless of what server hosts the
+ Corresponding Source, you remain obligated to ensure that it is
+ available for as long as needed to satisfy these requirements.
+
+ e) Convey the object code using peer-to-peer transmission, provided
+ you inform other peers where the object code and Corresponding
+ Source of the work are being offered to the general public at no
+ charge under subsection 6d.
+
+ A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+
+ A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal, family,
+or household purposes, or (2) anything designed or sold for incorporation
+into a dwelling. In determining whether a product is a consumer product,
+doubtful cases shall be resolved in favor of coverage. For a particular
+product received by a particular user, "normally used" refers to a
+typical or common use of that class of product, regardless of the status
+of the particular user or of the way in which the particular user
+actually uses, or expects or is expected to use, the product. A product
+is a consumer product regardless of whether the product has substantial
+commercial, industrial or non-consumer uses, unless such uses represent
+the only significant mode of use of the product.
+
+ "Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to install
+and execute modified versions of a covered work in that User Product from
+a modified version of its Corresponding Source. The information must
+suffice to ensure that the continued functioning of the modified object
+code is in no case prevented or interfered with solely because
+modification has been made.
+
+ If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information. But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+
+ The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or updates
+for a work that has been modified or installed by the recipient, or for
+the User Product in which it has been modified or installed. Access to a
+network may be denied when the modification itself materially and
+adversely affects the operation of the network or violates the rules and
+protocols for communication across the network.
+
+ Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+
+ 7. Additional Terms.
+
+ "Additional permissions" are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law. If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+
+ When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it. (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.) You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+
+ Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders of
+that material) supplement the terms of this License with terms:
+
+ a) Disclaiming warranty or limiting liability differently from the
+ terms of sections 15 and 16 of this License; or
+
+ b) Requiring preservation of specified reasonable legal notices or
+ author attributions in that material or in the Appropriate Legal
+ Notices displayed by works containing it; or
+
+ c) Prohibiting misrepresentation of the origin of that material, or
+ requiring that modified versions of such material be marked in
+ reasonable ways as different from the original version; or
+
+ d) Limiting the use for publicity purposes of names of licensors or
+ authors of the material; or
+
+ e) Declining to grant rights under trademark law for use of some
+ trade names, trademarks, or service marks; or
+
+ f) Requiring indemnification of licensors and authors of that
+ material by anyone who conveys the material (or modified versions of
+ it) with contractual assumptions of liability to the recipient, for
+ any liability that these contractual assumptions directly impose on
+ those licensors and authors.
+
+ All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10. If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term. If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+
+ If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+
+ Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions;
+the above requirements apply either way.
+
+ 8. Termination.
+
+ You may not propagate or modify a covered work except as expressly
+provided under this License. Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+
+ However, if you cease all violation of this License, then your
+license from a particular copyright holder is reinstated (a)
+provisionally, unless and until the copyright holder explicitly and
+finally terminates your license, and (b) permanently, if the copyright
+holder fails to notify you of the violation by some reasonable means
+prior to 60 days after the cessation.
+
+ Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+ Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License. If your rights have been terminated and not permanently
+reinstated, you do not qualify to receive new licenses for the same
+material under section 10.
+
+ 9. Acceptance Not Required for Having Copies.
+
+ You are not required to accept this License in order to receive or
+run a copy of the Program. Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance. However,
+nothing other than this License grants you permission to propagate or
+modify any covered work. These actions infringe copyright if you do
+not accept this License. Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+
+ 10. Automatic Licensing of Downstream Recipients.
+
+ Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License. You are not responsible
+for enforcing compliance by third parties with this License.
+
+ An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations. If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+
+ You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License. For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+
+ 11. Patents.
+
+ A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based. The
+work thus licensed is called the contributor's "contributor version".
+
+ A contributor's "essential patent claims" are all patent claims
+owned or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version. For
+purposes of this definition, "control" includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
+this License.
+
+ Each contributor grants you a non-exclusive, worldwide, royalty-free
+patent license under the contributor's essential patent claims, to
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+
+ In the following three paragraphs, a "patent license" is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement). To "grant" such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+
+ If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients. "Knowingly relying" means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+
+ If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+
+ A patent license is "discriminatory" if it does not include within
+the scope of its coverage, prohibits the exercise of, or is
+conditioned on the non-exercise of one or more of the rights that are
+specifically granted under this License. You may not convey a covered
+work if you are a party to an arrangement with a third party that is
+in the business of distributing software, under which you make payment
+to the third party based on the extent of your activity of conveying
+the work, and under which the third party grants, to any of the
+parties who would receive the covered work from you, a discriminatory
+patent license (a) in connection with copies of the covered work
+conveyed by you (or copies made from those copies), or (b) primarily
+for and in connection with specific products or compilations that
+contain the covered work, unless you entered into that arrangement,
+or that patent license was granted, prior to 28 March 2007.
+
+ Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+
+ 12. No Surrender of Others' Freedom.
+
+ If 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 convey a
+covered work so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you may
+not convey it at all. For example, if you agree to terms that obligate you
+to collect a royalty for further conveying from those to whom you convey
+the Program, the only way you could satisfy both those terms and this
+License would be to refrain entirely from conveying the Program.
+
+ 13. Remote Network Interaction; Use with the GNU General Public License.
+
+ Notwithstanding any other provision of this License, if you modify the
+Program, your modified version must prominently offer all users
+interacting with it remotely through a computer network (if your version
+supports such interaction) an opportunity to receive the Corresponding
+Source of your version by providing access to the Corresponding Source
+from a network server at no charge, through some standard or customary
+means of facilitating copying of software. This Corresponding Source
+shall include the Corresponding Source for any work covered by version 3
+of the GNU General Public License that is incorporated pursuant to the
+following paragraph.
+
+ Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU General Public License into a single
+combined work, and to convey the resulting work. The terms of this
+License will continue to apply to the part which is the covered work,
+but the work with which it is combined will remain governed by version
+3 of the GNU General Public License.
+
+ 14. Revised Versions of this License.
+
+ The Free Software Foundation may publish revised and/or new versions of
+the GNU Affero 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 that a certain numbered version of the GNU Affero General
+Public License "or any later version" applies to it, you have the
+option of following the terms and conditions either of that numbered
+version or of any later version published by the Free Software
+Foundation. If the Program does not specify a version number of the
+GNU Affero General Public License, you may choose any version ever published
+by the Free Software Foundation.
+
+ If the Program specifies that a proxy can decide which future
+versions of the GNU Affero General Public License can be used, that proxy's
+public statement of acceptance of a version permanently authorizes you
+to choose that version for the Program.
+
+ Later license versions may give you additional or different
+permissions. However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
+
+ 15. Disclaimer of Warranty.
+
+ 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.
+
+ 16. Limitation of Liability.
+
+ IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
+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.
+
+ 17. Interpretation of Sections 15 and 16.
+
+ If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
+
+ 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
+state the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+ <one line to give the program's name and a brief idea of what it does.>
+ Copyright (C) <year> <name of author>
+
+ This program is free software: you can redistribute it and/or modify
+ it under the terms of the GNU Affero General Public License as published by
+ the Free Software Foundation, either version 3 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 Affero General Public License for more details.
+
+ You should have received a copy of the GNU Affero General Public License
+ along with this program. If not, see <http://www.gnu.org/licenses/>.
+
+Also add information on how to contact you by electronic and paper mail.
+
+ If your software can interact with users remotely through a computer
+network, you should also make sure that it provides a way for users to
+get its source. For example, if your program is a web application, its
+interface could display a "Source" link that leads users to an archive
+of the code. There are many ways you could offer source, and different
+solutions will be better for different programs; see section 13 for the
+specific requirements.
+
+ You should also get your employer (if you work as a programmer) or school,
+if any, to sign a "copyright disclaimer" for the program, if necessary.
+For more information on this, and how to apply and follow the GNU AGPL, see
+<http://www.gnu.org/licenses/>.
--- /dev/null
+# civiimport
+
+
+
+(*FIXME: In one or two paragraphs, describe what the extension does and why one would download it. *)
+
+The extension is licensed under [AGPL-3.0](LICENSE.txt).
+
+## Requirements
+
+* PHP v7.2+
+* CiviCRM (*FIXME: Version number*)
+
+## Installation (Web UI)
+
+Learn more about installing CiviCRM extensions in the [CiviCRM Sysadmin Guide](https://docs.civicrm.org/sysadmin/en/latest/customize/extensions/).
+
+## Installation (CLI, Zip)
+
+Sysadmins and developers may download the `.zip` file for this extension and
+install it with the command-line tool [cv](https://github.com/civicrm/cv).
+
+```bash
+cd <extension-dir>
+cv dl civiimport@https://github.com/FIXME/civiimport/archive/master.zip
+```
+
+## Installation (CLI, Git)
+
+Sysadmins and developers may clone the [Git](https://en.wikipedia.org/wiki/Git) repo for this extension and
+install it with the command-line tool [cv](https://github.com/civicrm/cv).
+
+```bash
+git clone https://github.com/FIXME/civiimport.git
+cv en civiimport
+```
+
+## Getting Started
+
+(* FIXME: Where would a new user navigate to get started? What changes would they see? *)
+
+## Known Issues
+
+(* FIXME *)
--- /dev/null
+<?php
+
+// AUTO-GENERATED FILE -- Civix may overwrite any changes made to this file
+
+/**
+ * The ExtensionUtil class provides small stubs for accessing resources of this
+ * extension.
+ */
+class CRM_Civiimport_ExtensionUtil {
+ const SHORT_NAME = 'civiimport';
+ const LONG_NAME = 'civiimport';
+ const CLASS_PREFIX = 'CRM_Civiimport';
+
+ /**
+ * Translate a string using the extension's domain.
+ *
+ * If the extension doesn't have a specific translation
+ * for the string, fallback to the default translations.
+ *
+ * @param string $text
+ * Canonical message text (generally en_US).
+ * @param array $params
+ * @return string
+ * Translated text.
+ * @see ts
+ */
+ public static function ts($text, $params = []) {
+ if (!array_key_exists('domain', $params)) {
+ $params['domain'] = [self::LONG_NAME, NULL];
+ }
+ return ts($text, $params);
+ }
+
+ /**
+ * Get the URL of a resource file (in this extension).
+ *
+ * @param string|NULL $file
+ * Ex: NULL.
+ * Ex: 'css/foo.css'.
+ * @return string
+ * Ex: 'http://example.org/sites/default/ext/org.example.foo'.
+ * Ex: 'http://example.org/sites/default/ext/org.example.foo/css/foo.css'.
+ */
+ public static function url($file = NULL) {
+ if ($file === NULL) {
+ return rtrim(CRM_Core_Resources::singleton()->getUrl(self::LONG_NAME), '/');
+ }
+ return CRM_Core_Resources::singleton()->getUrl(self::LONG_NAME, $file);
+ }
+
+ /**
+ * Get the path of a resource file (in this extension).
+ *
+ * @param string|NULL $file
+ * Ex: NULL.
+ * Ex: 'css/foo.css'.
+ * @return string
+ * Ex: '/var/www/example.org/sites/default/ext/org.example.foo'.
+ * Ex: '/var/www/example.org/sites/default/ext/org.example.foo/css/foo.css'.
+ */
+ public static function path($file = NULL) {
+ // return CRM_Core_Resources::singleton()->getPath(self::LONG_NAME, $file);
+ return __DIR__ . ($file === NULL ? '' : (DIRECTORY_SEPARATOR . $file));
+ }
+
+ /**
+ * Get the name of a class within this extension.
+ *
+ * @param string $suffix
+ * Ex: 'Page_HelloWorld' or 'Page\\HelloWorld'.
+ * @return string
+ * Ex: 'CRM_Foo_Page_HelloWorld'.
+ */
+ public static function findClass($suffix) {
+ return self::CLASS_PREFIX . '_' . str_replace('\\', '_', $suffix);
+ }
+
+}
+
+use CRM_Civiimport_ExtensionUtil as E;
+
+function _civiimport_civix_mixin_polyfill() {
+ if (!class_exists('CRM_Extension_MixInfo')) {
+ $polyfill = __DIR__ . '/mixin/polyfill.php';
+ (require $polyfill)(E::LONG_NAME, E::SHORT_NAME, E::path());
+ }
+}
+
+/**
+ * (Delegated) Implements hook_civicrm_config().
+ *
+ * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config
+ */
+function _civiimport_civix_civicrm_config(&$config = NULL) {
+ static $configured = FALSE;
+ if ($configured) {
+ return;
+ }
+ $configured = TRUE;
+
+ $template = CRM_Core_Smarty::singleton();
+
+ $extRoot = __DIR__ . DIRECTORY_SEPARATOR;
+ $extDir = $extRoot . 'templates';
+
+ if (is_array($template->template_dir)) {
+ array_unshift($template->template_dir, $extDir);
+ }
+ else {
+ $template->template_dir = [$extDir, $template->template_dir];
+ }
+
+ $include_path = $extRoot . PATH_SEPARATOR . get_include_path();
+ set_include_path($include_path);
+ _civiimport_civix_mixin_polyfill();
+}
+
+/**
+ * Implements hook_civicrm_install().
+ *
+ * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install
+ */
+function _civiimport_civix_civicrm_install() {
+ _civiimport_civix_civicrm_config();
+ if ($upgrader = _civiimport_civix_upgrader()) {
+ $upgrader->onInstall();
+ }
+ _civiimport_civix_mixin_polyfill();
+}
+
+/**
+ * Implements hook_civicrm_postInstall().
+ *
+ * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_postInstall
+ */
+function _civiimport_civix_civicrm_postInstall() {
+ _civiimport_civix_civicrm_config();
+ if ($upgrader = _civiimport_civix_upgrader()) {
+ if (is_callable([$upgrader, 'onPostInstall'])) {
+ $upgrader->onPostInstall();
+ }
+ }
+}
+
+/**
+ * Implements hook_civicrm_uninstall().
+ *
+ * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_uninstall
+ */
+function _civiimport_civix_civicrm_uninstall() {
+ _civiimport_civix_civicrm_config();
+ if ($upgrader = _civiimport_civix_upgrader()) {
+ $upgrader->onUninstall();
+ }
+}
+
+/**
+ * (Delegated) Implements hook_civicrm_enable().
+ *
+ * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable
+ */
+function _civiimport_civix_civicrm_enable() {
+ _civiimport_civix_civicrm_config();
+ if ($upgrader = _civiimport_civix_upgrader()) {
+ if (is_callable([$upgrader, 'onEnable'])) {
+ $upgrader->onEnable();
+ }
+ }
+ _civiimport_civix_mixin_polyfill();
+}
+
+/**
+ * (Delegated) Implements hook_civicrm_disable().
+ *
+ * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_disable
+ * @return mixed
+ */
+function _civiimport_civix_civicrm_disable() {
+ _civiimport_civix_civicrm_config();
+ if ($upgrader = _civiimport_civix_upgrader()) {
+ if (is_callable([$upgrader, 'onDisable'])) {
+ $upgrader->onDisable();
+ }
+ }
+}
+
+/**
+ * (Delegated) Implements hook_civicrm_upgrade().
+ *
+ * @param $op string, the type of operation being performed; 'check' or 'enqueue'
+ * @param $queue CRM_Queue_Queue, (for 'enqueue') the modifiable list of pending up upgrade tasks
+ *
+ * @return mixed
+ * based on op. for 'check', returns array(boolean) (TRUE if upgrades are pending)
+ * for 'enqueue', returns void
+ *
+ * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_upgrade
+ */
+function _civiimport_civix_civicrm_upgrade($op, CRM_Queue_Queue $queue = NULL) {
+ if ($upgrader = _civiimport_civix_upgrader()) {
+ return $upgrader->onUpgrade($op, $queue);
+ }
+}
+
+/**
+ * @return CRM_Civiimport_Upgrader
+ */
+function _civiimport_civix_upgrader() {
+ if (!file_exists(__DIR__ . '/CRM/Civiimport/Upgrader.php')) {
+ return NULL;
+ }
+ else {
+ return CRM_Civiimport_Upgrader_Base::instance();
+ }
+}
+
+/**
+ * Inserts a navigation menu item at a given place in the hierarchy.
+ *
+ * @param array $menu - menu hierarchy
+ * @param string $path - path to parent of this item, e.g. 'my_extension/submenu'
+ * 'Mailing', or 'Administer/System Settings'
+ * @param array $item - the item to insert (parent/child attributes will be
+ * filled for you)
+ *
+ * @return bool
+ */
+function _civiimport_civix_insert_navigation_menu(&$menu, $path, $item) {
+ // If we are done going down the path, insert menu
+ if (empty($path)) {
+ $menu[] = [
+ 'attributes' => array_merge([
+ 'label' => CRM_Utils_Array::value('name', $item),
+ 'active' => 1,
+ ], $item),
+ ];
+ return TRUE;
+ }
+ else {
+ // Find an recurse into the next level down
+ $found = FALSE;
+ $path = explode('/', $path);
+ $first = array_shift($path);
+ foreach ($menu as $key => &$entry) {
+ if ($entry['attributes']['name'] == $first) {
+ if (!isset($entry['child'])) {
+ $entry['child'] = [];
+ }
+ $found = _civiimport_civix_insert_navigation_menu($entry['child'], implode('/', $path), $item);
+ }
+ }
+ return $found;
+ }
+}
+
+/**
+ * (Delegated) Implements hook_civicrm_navigationMenu().
+ */
+function _civiimport_civix_navigationMenu(&$nodes) {
+ if (!is_callable(['CRM_Core_BAO_Navigation', 'fixNavigationMenu'])) {
+ _civiimport_civix_fixNavigationMenu($nodes);
+ }
+}
+
+/**
+ * Given a navigation menu, generate navIDs for any items which are
+ * missing them.
+ */
+function _civiimport_civix_fixNavigationMenu(&$nodes) {
+ $maxNavID = 1;
+ array_walk_recursive($nodes, function($item, $key) use (&$maxNavID) {
+ if ($key === 'navID') {
+ $maxNavID = max($maxNavID, $item);
+ }
+ });
+ _civiimport_civix_fixNavigationMenuItems($nodes, $maxNavID, NULL);
+}
+
+function _civiimport_civix_fixNavigationMenuItems(&$nodes, &$maxNavID, $parentID) {
+ $origKeys = array_keys($nodes);
+ foreach ($origKeys as $origKey) {
+ if (!isset($nodes[$origKey]['attributes']['parentID']) && $parentID !== NULL) {
+ $nodes[$origKey]['attributes']['parentID'] = $parentID;
+ }
+ // If no navID, then assign navID and fix key.
+ if (!isset($nodes[$origKey]['attributes']['navID'])) {
+ $newKey = ++$maxNavID;
+ $nodes[$origKey]['attributes']['navID'] = $newKey;
+ $nodes[$newKey] = $nodes[$origKey];
+ unset($nodes[$origKey]);
+ $origKey = $newKey;
+ }
+ if (isset($nodes[$origKey]['child']) && is_array($nodes[$origKey]['child'])) {
+ _civiimport_civix_fixNavigationMenuItems($nodes[$origKey]['child'], $maxNavID, $nodes[$origKey]['attributes']['navID']);
+ }
+ }
+}
+
+/**
+ * (Delegated) Implements hook_civicrm_entityTypes().
+ *
+ * Find any *.entityType.php files, merge their content, and return.
+ *
+ * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_entityTypes
+ */
+function _civiimport_civix_civicrm_entityTypes(&$entityTypes) {
+ $entityTypes = array_merge($entityTypes, []);
+}
--- /dev/null
+<?php
+
+use Civi\BAO\Import;
+
+require_once 'civiimport.civix.php';
+// phpcs:disable
+use Civi\Api4\Event\Subscriber\ImportSubscriber;
+use CRM_Civiimport_ExtensionUtil as E;
+// phpcs:enable
+
+/**
+ * Implements hook_civicrm_config().
+ *
+ * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config/
+ */
+function civiimport_civicrm_config(&$config) {
+ _civiimport_civix_civicrm_config($config);
+}
+
+/**
+ * Implements hook_civicrm_install().
+ *
+ * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install
+ */
+function civiimport_civicrm_install() {
+ _civiimport_civix_civicrm_install();
+}
+
+/**
+ * Implements hook_civicrm_postInstall().
+ *
+ * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_postInstall
+ */
+function civiimport_civicrm_postInstall() {
+ _civiimport_civix_civicrm_postInstall();
+}
+
+/**
+ * Implements hook_civicrm_uninstall().
+ *
+ * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_uninstall
+ */
+function civiimport_civicrm_uninstall() {
+ _civiimport_civix_civicrm_uninstall();
+}
+
+/**
+ * Implements hook_civicrm_enable().
+ *
+ * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable
+ */
+function civiimport_civicrm_enable() {
+ _civiimport_civix_civicrm_enable();
+}
+
+/**
+ * Implements hook_civicrm_disable().
+ *
+ * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_disable
+ */
+function civiimport_civicrm_disable() {
+ _civiimport_civix_civicrm_disable();
+}
+
+/**
+ * Implements hook_civicrm_upgrade().
+ *
+ * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_upgrade
+ */
+function civiimport_civicrm_upgrade($op, CRM_Queue_Queue $queue = NULL) {
+ return _civiimport_civix_civicrm_upgrade($op, $queue);
+}
+
+/**
+ * Implements hook_civicrm_entityTypes().
+ *
+ * Declare each import table as an entity type. This function
+ * was intended to be in the ImportSubscriber class but kept
+ * getting errors when it was there so it's here, at least for now.
+ *
+ * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_entityTypes
+ */
+function civiimport_civicrm_entityTypes(array &$entityTypes): void {
+ $importEntities = Import::getImportTables();
+
+ foreach ($importEntities as $userJobID => $table) {
+ $entityTypes['Import_' . $userJobID] = [
+ 'name' => 'Import_' . $userJobID,
+ 'class' => Import::class,
+ 'table' => $table['table_name'],
+ ];
+ }
+}
--- /dev/null
+<?xml version="1.0"?>
+<extension key="civiimport" type="module">
+ <file>civiimport</file>
+ <name>CiviImport</name>
+ <description>CiviCRM core import code</description>
+ <license>AGPL-3.0</license>
+ <maintainer>
+ <author>CiviCRM</author>
+ <email>info@civicrm.org</email>
+ </maintainer>
+ <urls>
+ <url desc="Main Extension Page">http://civicrm.org</url>
+ <url desc="Documentation">http://civicrm.org</url>
+ <url desc="Support">http://civicrm.org</url>
+ <url desc="Licensing">http://www.gnu.org/licenses/agpl-3.0.html</url>
+ </urls>
+ <releaseDate>2022-08-11</releaseDate>
+ <version>1.0</version>
+ <develStage>alpha</develStage>
+ <compatibility>
+ <ver>5.53</ver>
+ </compatibility>
+ <comments>Core extension for us to start moving import logic into</comments>
+ <classloader>
+ <psr4 prefix="Civi\" path="Civi"/>
+ </classloader>
+ <civix>
+ <namespace>CRM/Civiimport</namespace>
+ <format>22.05.2</format>
+ <angularModule>crmCiviimport</angularModule>
+ </civix>
+ <mixins>
+ <mixin>mgd-php@1.0.0</mixin>
+ <mixin>setting-php@1.0.0</mixin>
+ </mixins>
+</extension>
--- /dev/null
+<?xml version="1.0"?>
+<phpunit backupGlobals="false" backupStaticAttributes="false" colors="true" convertErrorsToExceptions="true" convertNoticesToExceptions="true" convertWarningsToExceptions="true" convertDeprecationsToExceptions="true" processIsolation="false" stopOnFailure="false" cacheResult="false" bootstrap="tests/phpunit/bootstrap.php">
+ <testsuites>
+ <testsuite name="My Test Suite">
+ <directory>./tests/phpunit</directory>
+ </testsuite>
+ </testsuites>
+ <filter>
+ <whitelist>
+ <directory suffix=".php">./</directory>
+ </whitelist>
+ </filter>
+ <listeners>
+ <listener class="Civi\Test\CiviTestListener">
+ <arguments/>
+ </listener>
+ </listeners>
+</phpunit>
--- /dev/null
+<?php
+
+use Civi\Api4\Import;
+use Civi\Api4\UserJob;
+use Civi\Test\HeadlessInterface;
+use Civi\Test\HookInterface;
+use Civi\Test\CiviEnvBuilder;
+use PHPUnit\Framework\TestCase;
+
+/**
+ * FIXME - Add test description.
+ *
+ * Tips:
+ * - With HookInterface, you may implement CiviCRM hooks directly in the test class.
+ * Simply create corresponding functions (e.g. "hook_civicrm_post(...)" or similar).
+ * - With TransactionalInterface, any data changes made by setUp() or test****() functions will
+ * rollback automatically -- as long as you don't manipulate schema or truncate tables.
+ * If this test needs to manipulate schema or truncate tables, then either:
+ * a. Do all that using setupHeadless() and Civi\Test.
+ * b. Disable TransactionalInterface, and handle all setup/teardown yourself.
+ *
+ * @group headless
+ */
+class CiviApiImportTest extends TestCase implements HeadlessInterface, HookInterface {
+
+ /**
+ * Setup used when HeadlessInterface is implemented.
+ *
+ * Civi\Test has many helpers, like install(), uninstall(), sql(), and sqlFile().
+ *
+ * @link https://github.com/civicrm/org.civicrm.testapalooza/blob/master/civi-test.md
+ *
+ * @return \Civi\Test\CiviEnvBuilder
+ *
+ * @throws \CRM_Extension_Exception_ParseException
+ */
+ public function setUpHeadless(): CiviEnvBuilder {
+ return \Civi\Test::headless()
+ ->installMe(__DIR__)
+ ->apply();
+ }
+
+ public function tearDown():void {
+ CRM_Core_DAO::executeQuery('DROP TABLE IF EXISTS abc');
+ parent::tearDown();
+ }
+
+ /**
+ * Test the CRUD api actions work for the Import classes.
+ *
+ * @throws \CRM_Core_Exception
+ */
+ public function testApiActions():void {
+ $this->createUserJobTable();
+ $userJobID = UserJob::create()->setValues([
+ 'metadata' => [
+ 'DataSource' => ['table_name' => 'abc', 'column_headers' => ['External Identifier', 'Amount Given', 'Date Received', 'Financial Type', 'In honor']],
+ 'submitted_values' => [
+ 'contactType' => CRM_Import_Parser::CONTACT_INDIVIDUAL,
+ 'contactSubType' => '',
+ 'dataSource' => 'CRM_Import_DataSource_SQL',
+ 'onDuplicate' => CRM_Import_Parser::DUPLICATE_SKIP,
+ 'dedupe_rule_id' => NULL,
+ 'dateFormats' => CRM_Core_Form_Date::DATE_yyyy_mm_dd,
+ ],
+ ],
+ 'status_id:name' => 'draft',
+ 'job_type' => 'contribution_import',
+ ])->execute()->first()['id'];
+ $importFields = Import::getFields($userJobID)->execute();
+ $this->assertEquals('abc', $importFields[0]['table_name']);
+ $this->assertEquals('_id', $importFields[0]['column_name']);
+ $this->assertEquals('amount_given', $importFields[4]['column_name']);
+ $this->assertEquals('abc', $importFields[4]['table_name']);
+
+ Import::create($userJobID)->setValues([
+ 'external_identifier' => 678,
+ 'amount_given' => 80,
+ 'receive_date' => NULL,
+ '_status' => 'NEW',
+ 'soft_credit_to' => '',
+ ])->execute();
+
+ $import = Import::get($userJobID)->setSelect(['external_identifier', 'amount_given', '_status'])->execute()->first();
+ $this->assertEquals('80', $import['amount_given']);
+
+ Import::update($userJobID)->setValues([
+ 'amount_given' => NULL,
+ '_id' => $import['_id'],
+ '_status' => 'IMPORTED',
+ ])->execute();
+
+ $import = Import::get($userJobID)->setSelect(['external_identifier', 'amount_given', '_status'])->execute()->first();
+ $this->assertEquals(NULL, $import['amount_given']);
+
+ Import::save($userJobID)->setRecords([
+ [
+ 'external_identifier' => 999,
+ 'amount_given' => 9,
+ '_status' => 'ERROR',
+ ],
+ ])->execute();
+
+ $import = Import::get($userJobID)->setSelect(['external_identifier', 'amount_given', '_status'])->addWhere('_id', '>', $import['_id'])->execute()->first();
+ $this->assertEquals(9, $import['amount_given']);
+
+ Import::save($userJobID)->setRecords([
+ [
+ 'external_identifier' => 777,
+ '_id' => $import['_id'],
+ '_status' => 'ERROR',
+ ],
+ ])->execute();
+
+ $import = Import::get($userJobID)->setSelect(['external_identifier', 'amount_given', '_status'])->addWhere('_id', '=', $import['_id'])->execute()->first();
+ $this->assertEquals(777, $import['external_identifier']);
+
+ }
+
+ /**
+ * Create a table for our Import api.
+ */
+ private function createUserJobTable(): void {
+ CRM_Core_DAO::executeQuery("CREATE TABLE IF NOT EXISTS `abc` (
+ `external_identifier` text DEFAULT NULL,
+ `amount_given` text DEFAULT NULL,
+ `receive_date` text DEFAULT NULL,
+ `financial_type` text DEFAULT NULL,
+ `soft_credit_to` text DEFAULT NULL,
+ `_entity_id` int(11) DEFAULT NULL,
+ `_status` varchar(32) NOT NULL DEFAULT 'NEW',
+ `_status_message` longtext DEFAULT NULL,
+ `_id` int(11) NOT NULL AUTO_INCREMENT,
+ PRIMARY KEY (`_id`),
+ KEY `_id` (`_id`),
+ KEY `_status` (`_status`)
+ ) ENGINE=InnoDB");
+ }
+
+}
--- /dev/null
+<?php
+
+ini_set('memory_limit', '2G');
+
+// phpcs:disable
+eval(cv('php:boot --level=classloader', 'phpcode'));
+// phpcs:enable
+// Allow autoloading of PHPUnit helper classes in this extension.
+$loader = new \Composer\Autoload\ClassLoader();
+$loader->add('CRM_', [__DIR__ . '/../..', __DIR__]);
+$loader->addPsr4('Civi\\', [__DIR__ . '/../../Civi', __DIR__ . '/Civi']);
+$loader->add('api_', [__DIR__ . '/../..', __DIR__]);
+$loader->addPsr4('api\\', [__DIR__ . '/../../api', __DIR__ . '/api']);
+
+$loader->register();
+
+/**
+ * Call the "cv" command.
+ *
+ * @param string $cmd
+ * The rest of the command to send.
+ * @param string $decode
+ * Ex: 'json' or 'phpcode'.
+ * @return mixed
+ * Response output (if the command executed normally).
+ * For 'raw' or 'phpcode', this will be a string. For 'json', it could be any JSON value.
+ * @throws \RuntimeException
+ * If the command terminates abnormally.
+ */
+function cv(string $cmd, string $decode = 'json') {
+ $cmd = 'cv ' . $cmd;
+ $descriptorSpec = [0 => ['pipe', 'r'], 1 => ['pipe', 'w'], 2 => STDERR];
+ $oldOutput = getenv('CV_OUTPUT');
+ putenv('CV_OUTPUT=json');
+
+ // Execute `cv` in the original folder. This is a work-around for
+ // phpunit/codeception, which seem to manipulate PWD.
+ $cmd = sprintf('cd %s; %s', escapeshellarg(getenv('PWD')), $cmd);
+
+ $process = proc_open($cmd, $descriptorSpec, $pipes, __DIR__);
+ putenv("CV_OUTPUT=$oldOutput");
+ fclose($pipes[0]);
+ $result = stream_get_contents($pipes[1]);
+ fclose($pipes[1]);
+ if (proc_close($process) !== 0) {
+ throw new RuntimeException("Command failed ($cmd):\n$result");
+ }
+ switch ($decode) {
+ case 'raw':
+ return $result;
+
+ case 'phpcode':
+ // If the last output is /*PHPCODE*/, then we managed to complete execution.
+ if (substr(trim($result), 0, 12) !== '/*BEGINPHP*/' || substr(trim($result), -10) !== '/*ENDPHP*/') {
+ throw new \RuntimeException("Command failed ($cmd):\n$result");
+ }
+ return $result;
+
+ case 'json':
+ return json_decode($result, 1);
+
+ default:
+ throw new RuntimeException("Bad decoder format ($decode)");
+ }
+}
projects / civicrm-core.git / commitdiff
