Eileen has uploaded a new change for review. ( https://gerrit.wikimedia.org/r/403558 )
Change subject: Add extension to change contact types ...................................................................... Add extension to change contact types Note we need some (already upstreamed) civicrm fixes merged + progress on this https://github.com/civicrm/civicrm-core/pull/11405 before the tests will pass. I propose that we actually DON'T skip processing greetings when the amount is $500+ because it would benefit major gifts if that were set. Bug: T156193 Change-Id: I7c34be4225c04ac112d74891035607144178fd5f --- M sites/all/modules/wmf_civicrm/wmf_civicrm.install A sites/default/civicrm/extensions/org.wikimedia.contacteditor/ActivityTypeContactChange.mgd.php A sites/default/civicrm/extensions/org.wikimedia.contacteditor/CRM/Contacteditor/ChangeContactType.php A sites/default/civicrm/extensions/org.wikimedia.contacteditor/CRM/Contacteditor/Form/ContactTypeChange.php A sites/default/civicrm/extensions/org.wikimedia.contacteditor/LICENSE.txt A sites/default/civicrm/extensions/org.wikimedia.contacteditor/README.md A sites/default/civicrm/extensions/org.wikimedia.contacteditor/contacteditor.civix.php A sites/default/civicrm/extensions/org.wikimedia.contacteditor/contacteditor.php A sites/default/civicrm/extensions/org.wikimedia.contacteditor/info.xml A sites/default/civicrm/extensions/org.wikimedia.contacteditor/phpunit.xml.dist A sites/default/civicrm/extensions/org.wikimedia.contacteditor/templates/CRM/Contacteditor/Form/ContactTypeChange.tpl A sites/default/civicrm/extensions/org.wikimedia.contacteditor/tests/phpunit/BaseUnitTestClass.php A sites/default/civicrm/extensions/org.wikimedia.contacteditor/tests/phpunit/ContactEditorTest.php A sites/default/civicrm/extensions/org.wikimedia.contacteditor/tests/phpunit/bootstrap.php A sites/default/civicrm/extensions/org.wikimedia.contacteditor/xml/Menu/contacteditor.xml 15 files changed, 2,211 insertions(+), 0 deletions(-) git pull ssh://gerrit.wikimedia.org:29418/wikimedia/fundraising/crm refs/changes/58/403558/1 diff --git a/sites/all/modules/wmf_civicrm/wmf_civicrm.install b/sites/all/modules/wmf_civicrm/wmf_civicrm.install index 3b30ed8..b92f1c4 100644 --- a/sites/all/modules/wmf_civicrm/wmf_civicrm.install +++ b/sites/all/modules/wmf_civicrm/wmf_civicrm.install @@ -64,6 +64,8 @@ wmf_civicrm_update_7575(); wmf_civicrm_update_7580(); wmf_civicrm_update_7585(); + wmf_civicrm_update_7595(); + wmf_civicrm_update_7605(); } /** @@ -3311,3 +3313,14 @@ civicrm_api3('Contact', 'create', array('id' => $result->id)); } } + +/** + * Add contact type editor extension. + * + * Bug: TT156193 + */ +function wmf_civicrm_update_7605() { + civicrm_initialize(); + civicrm_api3('extension', 'refresh', array()); + civicrm_api3('extension', 'install', array('key' => 'org.wikimedia.contacteditor')); +} diff --git a/sites/default/civicrm/extensions/org.wikimedia.contacteditor/ActivityTypeContactChange.mgd.php b/sites/default/civicrm/extensions/org.wikimedia.contacteditor/ActivityTypeContactChange.mgd.php new file mode 100644 index 0000000..d790c4d --- /dev/null +++ b/sites/default/civicrm/extensions/org.wikimedia.contacteditor/ActivityTypeContactChange.mgd.php @@ -0,0 +1,15 @@ +<?php +return array( + 0 => array( + 'name' => 'Contact Type Changed', + 'entity' => 'OptionValue', + 'params' => array( + 'version' => 3, + 'option_group_id' => 'activity_type', + 'label' => 'Contact Type Changed', + 'name' => 'contact_type_changed', + 'description' => 'Contact type changed', + 'filter' => 1, + ), + ), +); diff --git a/sites/default/civicrm/extensions/org.wikimedia.contacteditor/CRM/Contacteditor/ChangeContactType.php b/sites/default/civicrm/extensions/org.wikimedia.contacteditor/CRM/Contacteditor/ChangeContactType.php new file mode 100644 index 0000000..6a10e4f --- /dev/null +++ b/sites/default/civicrm/extensions/org.wikimedia.contacteditor/CRM/Contacteditor/ChangeContactType.php @@ -0,0 +1,331 @@ +<?php + +use CRM_Contacteditor_ExtensionUtil as E; + +/** + * Created by IntelliJ IDEA. + * User: emcnaughton + * Date: 11/22/17 + * Time: 2:55 PM + */ +class CRM_Contacteditor_ChangeContactType { + + /** + * Validate whether the contact type is being changed and if so whether it is + * permitted. + * + * @param Civi\API\Event\PrepareEvent $apiRequest + * + * @throws \CRM_Core_Exception + */ + public static function validate($apiRequest) { + $request = $apiRequest->getApiRequest(); + if ($request['entity'] !== 'Contact' || $request['action'] !== 'create') { + return; + } + if (empty($request['params']['id']) || empty($request['params']['contact_type'])) { + // Hook is only interested in changes that update contact type. + return; + } + $contactID = $request['params']['id']; + $newContactType = $request['params']['contact_type']; + // Usually we will return after getting this - if we proceed past here we do more extensive data gathering as it is 'the real deal'. + $existingContactType = civicrm_api3('Contact', 'getvalue', [ + 'id' => $contactID, + 'return' => 'contact_type', + ]); + if ($existingContactType === $newContactType) { + return; + } + if (!empty($request['params']['check_permissions']) && !CRM_Core_Permission::check(array('Change CiviCRM contact type'))) { + throw new CRM_Core_Exception('You do have not permission to change the contact type'); + } + $contactTypeSpecificCustomFields = self::getCustomFieldsExclusiveToContactType($existingContactType); + $contactTypeSpecificFields = $contactTypeSpecificCustomFields + array( + 'birth_date', + 'contact_sub_type', + 'deceased_date', + 'is_deceased', + 'full_name', + 'first_name', + 'last_name', + 'organization_name', + 'nick_name', + 'suffix_id', + 'prefix_id', + 'gender_id', + 'primary_contact_id', + 'job_title', + 'legal_name', + 'household_name', + ); + + $existingContact = civicrm_api3('Contact', 'getsingle', [ + 'id' => $contactID, + 'return' => $contactTypeSpecificFields, + ]); + $existingContact['contact_type'] = $existingContactType; + + if (!empty($params['contact_sub_type']) || !empty($existingContact['contact_sub_type'])) { + throw new CRM_Core_Exception(E::ts('Contact type cannot be changed if subtype is not empty')); + } + + if ($existingContactType === 'Individual' && ( + !empty($existingContact['birth_date']) + || !empty($existingContact['is_deceased']) + || !empty($existingContact['deceased_date']) + )) { + throw new CRM_Core_Exception(E::ts('Individuals cannot be changed to another type while they have birth or death data')); + } + + if (self::hasCustomFieldsInvalidForNewType($contactTypeSpecificCustomFields, $existingContact)) { + throw new CRM_Core_Exception(E::ts('The contact has custom data that is not valid for the new type.')); + } + + // We check the id before checking for more relationships as it might give an early return with less queries. + if (($newContactType === 'Individual' && !empty($existingContact['primary_contact_id'])) + || self::hasRelationshipsInvalidForNewType($contactID, $newContactType) + ) { + throw new CRM_Core_Exception(E::ts('The contact has one or more relationships that are not valid for the new type')); + } + $nullableFields = array_intersect_key($existingContact, array_flip($contactTypeSpecificFields)); + $details = array(); + foreach (array_keys($nullableFields) as $nullableField) { + $params[$nullableField] = 'null'; + if (!empty($existingContact[$nullableField])) { + $details[] = $nullableField . ' -> ' . $existingContact[$nullableField]; + } + } + + self::adjustFieldsForContactTypeChange($request['params'], $existingContact); + civicrm_api3('Activity', 'create', array( + 'target_contact_id' => $contactID, + 'activity_type_id' => 'contact_type_changed', + 'subject' => E::ts('Contact type changed from %1 to %2', array( + $existingContactType, + $newContactType, + )), + 'details' => empty($details) ? '' : E::ts('Data lost by the change : ') . implode(', ', $details), + )); + $apiRequest->setApiRequest($request); + } + + /** + * Make field adjustments required for contact type change. + * + * @param array $params + * @param array $existingContact + */ + public static function adjustFieldsForContactTypeChange(&$params, $existingContact) { + self::setDefaultGreetingsForContactType($params); + self::setNamesForContactType($params, $existingContact); + } + + /** + * Set the name for the new contact type based on information from the old + * one. + * + * Any passed in parameters will take preference but if not supplied put + * existing name data into the organization_name, household_name or + * last_name field as relates to the type. The name fields per the previous + * type will be nulled. + * + * @param array $params + * @param array $existingContact + * Relevant values from saved contact. + */ + public static function setNamesForContactType(&$params, $existingContact) { + $nameParts = array(); + + if ($existingContact['contact_type'] === 'Individual') { + $nameFields = array( + 'first_name', + 'nick_name', + 'middle_name', + 'last_name', + ); + foreach ($nameFields as $nameField) { + if (!empty($existingContact[$nameField])) { + $nameParts[$nameField] = $existingContact[$nameField]; + $params[$nameField] = 'null'; + } + } + } + elseif ($existingContact['contact_type'] === 'Household') { + if (!empty($existingContact['household_name'])) { + $nameParts['household_name'] = $existingContact['household_name']; + $params['household_name'] = 'null'; + } + } + elseif ($existingContact['contact_type'] === 'Organization') { + if (!empty($existingContact['organization_name'])) { + $nameParts['organization_name'] = $existingContact['organization_name']; + $params['organization_name'] = 'null'; + } + } + $storeNameField = 'last_name'; + if ($params['contact_type'] === 'Organization') { + $storeNameField = 'organization_name'; + } + if ($params['contact_type'] === 'Household') { + $storeNameField = 'household_name'; + } + if (empty($params[$storeNameField])) { + $params[$storeNameField] = implode(' ', $nameParts); + } + } + + /** + * Check if any of the contact's custom fields are invalid for the new + * contact type. + * + * @param int $contactID + * @param string $newContactType + * + * @return bool + */ + public static function hasCustomFieldsInvalidForNewType($contactTypeSpecificCustomFields, $existingContact) { + foreach ($contactTypeSpecificCustomFields as $contactTypeSpecificCustomField) { + if (!empty($existingContact[$contactTypeSpecificCustomField])) { + return TRUE; + } + } + return FALSE; + } + + /** + * Get the custom fields that are specific to the custom type. + * + * ie. get fields that are for Individuals only (but not those that apply to + * individual by virtue of being for all contact types). + * + * @param string $contactType + */ + public static function getCustomFieldsExclusiveToContactType($contactType) { + if (!isset(Civi::$statics[__CLASS__]['custom_fields'][$contactType])) { + Civi::$statics[__CLASS__]['custom_fields'][$contactType] = array(); + $customFields = civicrm_api3('CustomField', 'get', array( + 'custom_group_id.extends' => $contactType, + 'return' => 'id', + )); + foreach ($customFields['values'] as $customField) { + Civi::$statics[__CLASS__]['custom_fields'][$contactType][$customField['id']] = 'custom_' . $customField['id']; + } + } + return Civi::$statics[__CLASS__]['custom_fields'][$contactType]; + } + + /** + * Check if any of the contact's relationships invalid for the new contact + * type. + * + * @param int $contactID + * @param string $newContactType + * + * @return bool + */ + public static function hasRelationshipsInvalidForNewType($contactID, $newContactType) { + $directions = array('a', 'b'); + + if (!isset(Civi::$statics[__CLASS__]['relationships']['generic'])) { + Civi::$statics[__CLASS__]['relationships']['generic'] = array(); + foreach ($directions as $direction) { + $genericRelationshipTypes = $relationshipTypes = civicrm_api3('RelationshipType', 'get', array( + 'contact_type_' . $direction => array('IS NULL' => TRUE), + 'return' => 'id', + )); + foreach ($genericRelationshipTypes['values'] as $relationshipType) { + Civi::$statics[__CLASS__]['relationships']['generic'][$direction][$relationshipType['id']] = TRUE; + } + } + } + + if (!isset(Civi::$statics[__CLASS__]['relationships'][$newContactType])) { + Civi::$statics[__CLASS__]['relationships'][$newContactType] = array(); + foreach ($directions as $direction) { + $relationshipTypes = civicrm_api3('RelationshipType', 'get', array( + 'contact_type_' . $direction => $newContactType, + 'return' => 'id', + )); + foreach ($relationshipTypes['values'] as $relationshipType) { + Civi::$statics[__CLASS__]['relationships'][$newContactType][$direction][$relationshipType['id']] = TRUE; + } + } + } + + foreach ($directions as $direction) { + $relationships = civicrm_api3('Relationship', 'get', array('contact_id_' . $direction => $contactID)); + foreach ($relationships['values'] as $relationship) { + if (!isset(Civi::$statics[__CLASS__]['relationships'][$newContactType][$direction][$relationship['relationship_type_id']]) + && !isset(Civi::$statics[__CLASS__]['relationships']['generic'][$direction][$relationship['relationship_type_id']]) + ) { + return TRUE; + } + } + } + return FALSE; + } + + /** + * Get the default details for selected type + * + * @param array + */ + public static function setDefaultGreetingsForContactType(&$params) { + $contactType = $params['contact_type']; + foreach (self::getDefaultGreetingsForContactType($contactType) as $key => $value) { + $params[$key] = $value; + } + } + + /** + * Get the default details for selected type + * + * @param array + */ + public static function getDefaultGreetingsForContactType($contactTypeToRetrieve) { + + if (!isset(Civi::$statics[__CLASS__]['greetings'][$contactTypeToRetrieve])) { + Civi::$statics[__CLASS__]['greetings'][$contactTypeToRetrieve] = array(); + + $optionGroups = civicrm_api3('OptionGroup', 'get', array( + 'name' => array( + 'IN' => array( + 'email_greeting', + 'postal_greeting', + 'addressee', + ), + ), + ) + ); + + $optionValues = civicrm_api3('OptionValue', 'get', array( + 'option_group_id' => array('IN' => array_keys($optionGroups['values'])), + 'is_default' => 1, + 'is_active' => 1, + 'return' => array('name', 'option_group_id', 'filter', 'value'), + )); + + $contactTypes = civicrm_api3('ContactType', 'get', array( + 'is_reserved' => 1, + 'return' => array('name'), + )); + foreach ($contactTypes['values'] as $contactTypeID => $contactType) { + foreach ($optionValues['values'] as $id => $optionValue) { + $optionGroupName = $optionGroups['values'][$optionValue['option_group_id']]['name']; + $keyName = $optionGroupName . '_id'; + + // If there is no value - e.g Organization does not by default have a postal_greeting then + // setting to null will clear it out. + Civi::$statics[__CLASS__]['greetings'][$contactType['name']][$keyName] = 'null'; + + if (empty($optionValue['filter']) || $optionValue['filter'] == $contactTypeID) { + Civi::$statics[__CLASS__]['greetings'][$contactType['name']][$keyName] = $optionValue['value']; + } + } + } + } + + return Civi::$statics[__CLASS__]['greetings'][$contactTypeToRetrieve]; + } +} diff --git a/sites/default/civicrm/extensions/org.wikimedia.contacteditor/CRM/Contacteditor/Form/ContactTypeChange.php b/sites/default/civicrm/extensions/org.wikimedia.contacteditor/CRM/Contacteditor/Form/ContactTypeChange.php new file mode 100644 index 0000000..efb0f28 --- /dev/null +++ b/sites/default/civicrm/extensions/org.wikimedia.contacteditor/CRM/Contacteditor/Form/ContactTypeChange.php @@ -0,0 +1,92 @@ +<?php + +use CRM_Contacteditor_ExtensionUtil as E; + +/** + * Form controller class + * + * @see https://wiki.civicrm.org/confluence/display/CRMDOC/QuickForm+Reference + */ +class CRM_Contacteditor_Form_ContactTypeChange extends CRM_Core_Form { + + protected $contactID; + + protected $contact; + + /** + * Explicitly declare the form context. + */ + public function getDefaultContext() { + return 'create'; + } + + /** + * Explicitly declare the entity api name. + */ + public function getDefaultEntity() { + return 'Contact'; + } + + /** + * Form pre-processing. + */ + public function preProcess() { + $this->setAction(CRM_Core_Action::UPDATE); + $this->contactID = CRM_Utils_Request::retrieveValue('contact_id', 'Positive', $this->get('contactID')); + $this->set('contactID', $this->contactID); + $this->contact = civicrm_api3('Contact', 'getsingle', array('id' => $this->contactID, 'return' => ['contact_type', 'display_name'])); + $this->assign('introText', E::ts('Change contact type for %1', array($this->contact['display_name']))); + } + + /** + * Build the form. + */ + public function buildQuickForm() { + $this->addField('contact_type'); + $this->assign('elementNames', 'contact_type'); + + $buttons = array( + array( + 'type' => 'upload', + 'name' => ts('Save'), + 'isDefault' => TRUE, + ), + array( + 'type' => 'cancel', + 'name' => ts('Cancel'), + ), + ); + $this->addButtons($buttons); + + parent::buildQuickForm(); + } + + /** + * Process form submission. + */ + public function postProcess() { + $params = $this->exportValues(); + + $params['contact_id'] = $this->contactID; + + try { + civicrm_api3('Contact', 'create', $params); + CRM_Core_Session::setStatus(E::ts('Contact type updated')); + } + catch (CiviCRM_API3_Exception $e) { + CRM_Core_Session::setStatus($e->getMessage(), E::ts('Contact type not changed')); + } + parent::postProcess(); + } + + /** + * Set defaults for the form. + * + * @return array + */ + public function setDefaultValues() { + $defaults['contact_type'] = $this->contact['contact_type']; + return $defaults; + } + +} diff --git a/sites/default/civicrm/extensions/org.wikimedia.contacteditor/LICENSE.txt b/sites/default/civicrm/extensions/org.wikimedia.contacteditor/LICENSE.txt new file mode 100644 index 0000000..bb403ae --- /dev/null +++ b/sites/default/civicrm/extensions/org.wikimedia.contacteditor/LICENSE.txt @@ -0,0 +1,667 @@ +Package: org.wikimedia.contacteditor +Copyright (C) 2017, eileen <emcnaugh...@wikimedia.org> +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/>. diff --git a/sites/default/civicrm/extensions/org.wikimedia.contacteditor/README.md b/sites/default/civicrm/extensions/org.wikimedia.contacteditor/README.md new file mode 100644 index 0000000..27e3f44 --- /dev/null +++ b/sites/default/civicrm/extensions/org.wikimedia.contacteditor/README.md @@ -0,0 +1,27 @@ +This extension permits a contact to be changed from one type to another. + +Currently you can change contact type using the api. This unintentionally allows data loss. Conversely you cannot change the type from the UI. + +This extension alters the contact.create api to do the following actions + +**Block change if** + - contact has a relationship that would not be valid on the new type + - data is held for is_deceased, deceased_date, birth_date - since this is material data that should be manually reviewed. Gender is not on this + list as it is more likely to be just a default entry. +- contact has custom data that is invalid for the new type. +- new or old contact type has a sub_type as there has been no thought put into these scenarios. + +**Create an activity containing non-valid data for new type** +- Organization specific fields organization_name, legal_name, sic_code +- Individual specific fields: suffix, prefix, nick_name, gender, job_title, gender + +**Munges name & greeting data** +if the api does not receive name & greeting fields they are computed: + - the full name of the individual or household fills the organisation name or household name. + - the full organization name or household name goes into the last_name. + +**Notes** +- By not doing the conversion if the relationship is invalid we are able to +ignore membership issues - since it is the relationship that would +make the conversion invalid. + diff --git a/sites/default/civicrm/extensions/org.wikimedia.contacteditor/contacteditor.civix.php b/sites/default/civicrm/extensions/org.wikimedia.contacteditor/contacteditor.civix.php new file mode 100644 index 0000000..5abd93a --- /dev/null +++ b/sites/default/civicrm/extensions/org.wikimedia.contacteditor/contacteditor.civix.php @@ -0,0 +1,445 @@ +<?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_Contacteditor_ExtensionUtil { + const SHORT_NAME = "contacteditor"; + const LONG_NAME = "org.wikimedia.contacteditor"; + const CLASS_PREFIX = "CRM_Contacteditor"; + + /** + * 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 = array()) { + if (!array_key_exists('domain', $params)) { + $params['domain'] = array(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_Contacteditor_ExtensionUtil as E; + +/** + * (Delegated) Implements hook_civicrm_config(). + * + * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_config + */ +function _contacteditor_civix_civicrm_config(&$config = NULL) { + static $configured = FALSE; + if ($configured) { + return; + } + $configured = TRUE; + + $template =& CRM_Core_Smarty::singleton(); + + $extRoot = dirname(__FILE__) . DIRECTORY_SEPARATOR; + $extDir = $extRoot . 'templates'; + + if (is_array($template->template_dir)) { + array_unshift($template->template_dir, $extDir); + } + else { + $template->template_dir = array($extDir, $template->template_dir); + } + + $include_path = $extRoot . PATH_SEPARATOR . get_include_path(); + set_include_path($include_path); +} + +/** + * (Delegated) Implements hook_civicrm_xmlMenu(). + * + * @param $files array(string) + * + * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_xmlMenu + */ +function _contacteditor_civix_civicrm_xmlMenu(&$files) { + foreach (_contacteditor_civix_glob(__DIR__ . '/xml/Menu/*.xml') as $file) { + $files[] = $file; + } +} + +/** + * Implements hook_civicrm_install(). + * + * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_install + */ +function _contacteditor_civix_civicrm_install() { + _contacteditor_civix_civicrm_config(); + if ($upgrader = _contacteditor_civix_upgrader()) { + $upgrader->onInstall(); + } +} + +/** + * Implements hook_civicrm_postInstall(). + * + * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_postInstall + */ +function _contacteditor_civix_civicrm_postInstall() { + _contacteditor_civix_civicrm_config(); + if ($upgrader = _contacteditor_civix_upgrader()) { + if (is_callable(array($upgrader, 'onPostInstall'))) { + $upgrader->onPostInstall(); + } + } +} + +/** + * Implements hook_civicrm_uninstall(). + * + * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_uninstall + */ +function _contacteditor_civix_civicrm_uninstall() { + _contacteditor_civix_civicrm_config(); + if ($upgrader = _contacteditor_civix_upgrader()) { + $upgrader->onUninstall(); + } +} + +/** + * (Delegated) Implements hook_civicrm_enable(). + * + * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_enable + */ +function _contacteditor_civix_civicrm_enable() { + _contacteditor_civix_civicrm_config(); + if ($upgrader = _contacteditor_civix_upgrader()) { + if (is_callable(array($upgrader, 'onEnable'))) { + $upgrader->onEnable(); + } + } +} + +/** + * (Delegated) Implements hook_civicrm_disable(). + * + * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_disable + * @return mixed + */ +function _contacteditor_civix_civicrm_disable() { + _contacteditor_civix_civicrm_config(); + if ($upgrader = _contacteditor_civix_upgrader()) { + if (is_callable(array($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 http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_upgrade + */ +function _contacteditor_civix_civicrm_upgrade($op, CRM_Queue_Queue $queue = NULL) { + if ($upgrader = _contacteditor_civix_upgrader()) { + return $upgrader->onUpgrade($op, $queue); + } +} + +/** + * @return CRM_Contacteditor_Upgrader + */ +function _contacteditor_civix_upgrader() { + if (!file_exists(__DIR__ . '/CRM/Contacteditor/Upgrader.php')) { + return NULL; + } + else { + return CRM_Contacteditor_Upgrader_Base::instance(); + } +} + +/** + * Search directory tree for files which match a glob pattern + * + * Note: Dot-directories (like "..", ".git", or ".svn") will be ignored. + * Note: In Civi 4.3+, delegate to CRM_Utils_File::findFiles() + * + * @param $dir string, base dir + * @param $pattern string, glob pattern, eg "*.txt" + * @return array(string) + */ +function _contacteditor_civix_find_files($dir, $pattern) { + if (is_callable(array('CRM_Utils_File', 'findFiles'))) { + return CRM_Utils_File::findFiles($dir, $pattern); + } + + $todos = array($dir); + $result = array(); + while (!empty($todos)) { + $subdir = array_shift($todos); + foreach (_contacteditor_civix_glob("$subdir/$pattern") as $match) { + if (!is_dir($match)) { + $result[] = $match; + } + } + if ($dh = opendir($subdir)) { + while (FALSE !== ($entry = readdir($dh))) { + $path = $subdir . DIRECTORY_SEPARATOR . $entry; + if ($entry{0} == '.') { + } + elseif (is_dir($path)) { + $todos[] = $path; + } + } + closedir($dh); + } + } + return $result; +} +/** + * (Delegated) Implements hook_civicrm_managed(). + * + * Find any *.mgd.php files, merge their content, and return. + * + * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_managed + */ +function _contacteditor_civix_civicrm_managed(&$entities) { + $mgdFiles = _contacteditor_civix_find_files(__DIR__, '*.mgd.php'); + foreach ($mgdFiles as $file) { + $es = include $file; + foreach ($es as $e) { + if (empty($e['module'])) { + $e['module'] = E::LONG_NAME; + } + $entities[] = $e; + if (empty($e['params']['version'])) { + $e['params']['version'] = '3'; + } + } + } +} + +/** + * (Delegated) Implements hook_civicrm_caseTypes(). + * + * Find any and return any files matching "xml/case/*.xml" + * + * Note: This hook only runs in CiviCRM 4.4+. + * + * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_caseTypes + */ +function _contacteditor_civix_civicrm_caseTypes(&$caseTypes) { + if (!is_dir(__DIR__ . '/xml/case')) { + return; + } + + foreach (_contacteditor_civix_glob(__DIR__ . '/xml/case/*.xml') as $file) { + $name = preg_replace('/\.xml$/', '', basename($file)); + if ($name != CRM_Case_XMLProcessor::mungeCaseType($name)) { + $errorMessage = sprintf("Case-type file name is malformed (%s vs %s)", $name, CRM_Case_XMLProcessor::mungeCaseType($name)); + CRM_Core_Error::fatal($errorMessage); + // throw new CRM_Core_Exception($errorMessage); + } + $caseTypes[$name] = array( + 'module' => E::LONG_NAME, + 'name' => $name, + 'file' => $file, + ); + } +} + +/** + * (Delegated) Implements hook_civicrm_angularModules(). + * + * Find any and return any files matching "ang/*.ang.php" + * + * Note: This hook only runs in CiviCRM 4.5+. + * + * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_angularModules + */ +function _contacteditor_civix_civicrm_angularModules(&$angularModules) { + if (!is_dir(__DIR__ . '/ang')) { + return; + } + + $files = _contacteditor_civix_glob(__DIR__ . '/ang/*.ang.php'); + foreach ($files as $file) { + $name = preg_replace(':\.ang\.php$:', '', basename($file)); + $module = include $file; + if (empty($module['ext'])) { + $module['ext'] = E::LONG_NAME; + } + $angularModules[$name] = $module; + } +} + +/** + * Glob wrapper which is guaranteed to return an array. + * + * The documentation for glob() says, "On some systems it is impossible to + * distinguish between empty match and an error." Anecdotally, the return + * result for an empty match is sometimes array() and sometimes FALSE. + * This wrapper provides consistency. + * + * @link http://php.net/glob + * @param string $pattern + * @return array, possibly empty + */ +function _contacteditor_civix_glob($pattern) { + $result = glob($pattern); + return is_array($result) ? $result : array(); +} + +/** + * Inserts a navigation menu item at a given place in the hierarchy. + * + * @param array $menu - menu hierarchy + * @param string $path - path where insertion should happen (ie. Administer/System Settings) + * @param array $item - menu you need to insert (parent/child attributes will be filled for you) + */ +function _contacteditor_civix_insert_navigation_menu(&$menu, $path, $item) { + // If we are done going down the path, insert menu + if (empty($path)) { + $menu[] = array( + 'attributes' => array_merge(array( + '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'] = array(); + } + $found = _contacteditor_civix_insert_navigation_menu($entry['child'], implode('/', $path), $item, $key); + } + } + return $found; + } +} + +/** + * (Delegated) Implements hook_civicrm_navigationMenu(). + */ +function _contacteditor_civix_navigationMenu(&$nodes) { + if (!is_callable(array('CRM_Core_BAO_Navigation', 'fixNavigationMenu'))) { + _contacteditor_civix_fixNavigationMenu($nodes); + } +} + +/** + * Given a navigation menu, generate navIDs for any items which are + * missing them. + */ +function _contacteditor_civix_fixNavigationMenu(&$nodes) { + $maxNavID = 1; + array_walk_recursive($nodes, function($item, $key) use (&$maxNavID) { + if ($key === 'navID') { + $maxNavID = max($maxNavID, $item); + } + }); + _contacteditor_civix_fixNavigationMenuItems($nodes, $maxNavID, NULL); +} + +function _contacteditor_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'])) { + _contacteditor_civix_fixNavigationMenuItems($nodes[$origKey]['child'], $maxNavID, $nodes[$origKey]['attributes']['navID']); + } + } +} + +/** + * (Delegated) Implements hook_civicrm_alterSettingsFolders(). + * + * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_alterSettingsFolders + */ +function _contacteditor_civix_civicrm_alterSettingsFolders(&$metaDataFolders = NULL) { + static $configured = FALSE; + if ($configured) { + return; + } + $configured = TRUE; + + $settingsDir = __DIR__ . DIRECTORY_SEPARATOR . 'settings'; + if (is_dir($settingsDir) && !in_array($settingsDir, $metaDataFolders)) { + $metaDataFolders[] = $settingsDir; + } +} diff --git a/sites/default/civicrm/extensions/org.wikimedia.contacteditor/contacteditor.php b/sites/default/civicrm/extensions/org.wikimedia.contacteditor/contacteditor.php new file mode 100644 index 0000000..52accd7 --- /dev/null +++ b/sites/default/civicrm/extensions/org.wikimedia.contacteditor/contacteditor.php @@ -0,0 +1,178 @@ +<?php + +require_once 'contacteditor.civix.php'; +use CRM_Contacteditor_ExtensionUtil as E; + +/** + * Implements hook_civicrm_config(). + * + * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_config + */ +function contacteditor_civicrm_config(&$config) { + Civi::dispatcher()->addListener('civi.api.prepare', array('CRM_Contacteditor_ChangeContactType', 'validate'), -100); + _contacteditor_civix_civicrm_config($config); +} + +/** + * Implements hook_civicrm_xmlMenu(). + * + * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_xmlMenu + */ +function contacteditor_civicrm_xmlMenu(&$files) { + _contacteditor_civix_civicrm_xmlMenu($files); +} + +/** + * Implements hook_civicrm_install(). + * + * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_install + */ +function contacteditor_civicrm_install() { + _contacteditor_civix_civicrm_install(); +} + +/** + * Implements hook_civicrm_postInstall(). + * + * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_postInstall + */ +function contacteditor_civicrm_postInstall() { + _contacteditor_civix_civicrm_postInstall(); +} + +/** + * Implements hook_civicrm_uninstall(). + * + * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_uninstall + */ +function contacteditor_civicrm_uninstall() { + _contacteditor_civix_civicrm_uninstall(); +} + +/** + * Implements hook_civicrm_enable(). + * + * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_enable + */ +function contacteditor_civicrm_enable() { + _contacteditor_civix_civicrm_enable(); +} + +/** + * Implements hook_civicrm_disable(). + * + * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_disable + */ +function contacteditor_civicrm_disable() { + _contacteditor_civix_civicrm_disable(); +} + +/** + * Implements hook_civicrm_upgrade(). + * + * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_upgrade + */ +function contacteditor_civicrm_upgrade($op, CRM_Queue_Queue $queue = NULL) { + return _contacteditor_civix_civicrm_upgrade($op, $queue); +} + +/** + * Implements hook_civicrm_managed(). + * + * Generate a list of entities to create/deactivate/delete when this module + * is installed, disabled, uninstalled. + * + * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_managed + */ +function contacteditor_civicrm_managed(&$entities) { + _contacteditor_civix_civicrm_managed($entities); +} + +/** + * Implements hook_civicrm_caseTypes(). + * + * Generate a list of case-types. + * + * Note: This hook only runs in CiviCRM 4.4+. + * + * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_caseTypes + */ +function contacteditor_civicrm_caseTypes(&$caseTypes) { + _contacteditor_civix_civicrm_caseTypes($caseTypes); +} + +/** + * Implements hook_civicrm_angularModules(). + * + * Generate a list of Angular modules. + * + * Note: This hook only runs in CiviCRM 4.5+. It may + * use features only available in v4.6+. + * + * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_angularModules + */ +function contacteditor_civicrm_angularModules(&$angularModules) { + _contacteditor_civix_civicrm_angularModules($angularModules); +} + +/** + * Implements hook_civicrm_alterSettingsFolders(). + * + * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_alterSettingsFolders + */ +function contacteditor_civicrm_alterSettingsFolders(&$metaDataFolders = NULL) { + _contacteditor_civix_civicrm_alterSettingsFolders($metaDataFolders); +} + +/** + * Add permission to change contact type. + * + * @param array $permissions + */ +function contacteditor_civicrm_permission(&$permissions) { + $permissions['Change CiviCRM contact type'] = array( + E::ts('Change CiviCRM contact type'), + E::ts('Permits changing a contact type. This may result in data loss if the new type does not support all data of the old type.'), + ); +} + +function contacteditor_civicrm_summaryActions(&$actions, $contactID) { + if (CRM_Core_Permission::check('Change CiviCRM contact type')) { + $actions['casework'] = array( + 'title' => 'Change Contact Type', + 'weight' => 999, + 'class' => 'no-popup', + 'ref' => 'change-contact-type', + 'key' => 'change-contact-type', + 'href' => '/civicrm/contacttypechange?contact_id=' . $contactID + ); + } +} + +// --- Functions below this ship commented out. Uncomment as required. --- + +/** + * Implements hook_civicrm_preProcess(). + * + * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_preProcess + * +function contacteditor_civicrm_preProcess($formName, &$form) { + +} // */ + +/** + * Implements hook_civicrm_navigationMenu(). + * + * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_navigationMenu + * +function contacteditor_civicrm_navigationMenu(&$menu) { + _contacteditor_civix_insert_navigation_menu($menu, NULL, array( + 'label' => E::ts('The Page'), + 'name' => 'the_page', + 'url' => 'civicrm/the-page', + 'permission' => 'access CiviReport,access CiviContribute', + 'operator' => 'OR', + 'separator' => 0, + )); + _contacteditor_civix_navigationMenu($menu); +} // */ diff --git a/sites/default/civicrm/extensions/org.wikimedia.contacteditor/info.xml b/sites/default/civicrm/extensions/org.wikimedia.contacteditor/info.xml new file mode 100644 index 0000000..706b33d --- /dev/null +++ b/sites/default/civicrm/extensions/org.wikimedia.contacteditor/info.xml @@ -0,0 +1,27 @@ +<?xml version="1.0"?> +<extension key="org.wikimedia.contacteditor" type="module"> + <file>contacteditor</file> + <name>Contact Editor</name> + <description>Allows contacts to have their contact types changed.</description> + <license>AGPL-3.0</license> + <maintainer> + <author>eileen</author> + <email>emcnaugh...@wikimedia.org</email> + </maintainer> + <urls> + <url desc="Main Extension Page">http://FIXME</url> + <url desc="Documentation">http://FIXME</url> + <url desc="Support">http://FIXME</url> + <url desc="Licensing">http://www.gnu.org/licenses/agpl-3.0.html</url> + </urls> + <releaseDate>2017-11-22</releaseDate> + <version>1.0</version> + <develStage>stable</develStage> + <compatibility> + <ver>4.7</ver> + </compatibility> + <comments>Allows contacts to have their contact types changed.</comments> + <civix> + <namespace>CRM/Contacteditor</namespace> + </civix> +</extension> diff --git a/sites/default/civicrm/extensions/org.wikimedia.contacteditor/phpunit.xml.dist b/sites/default/civicrm/extensions/org.wikimedia.contacteditor/phpunit.xml.dist new file mode 100644 index 0000000..0f9f25d --- /dev/null +++ b/sites/default/civicrm/extensions/org.wikimedia.contacteditor/phpunit.xml.dist @@ -0,0 +1,18 @@ +<?xml version="1.0"?> +<phpunit backupGlobals="false" backupStaticAttributes="false" colors="true" convertErrorsToExceptions="true" convertNoticesToExceptions="true" convertWarningsToExceptions="true" processIsolation="false" stopOnFailure="false" syntaxCheck="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> diff --git a/sites/default/civicrm/extensions/org.wikimedia.contacteditor/templates/CRM/Contacteditor/Form/ContactTypeChange.tpl b/sites/default/civicrm/extensions/org.wikimedia.contacteditor/templates/CRM/Contacteditor/Form/ContactTypeChange.tpl new file mode 100644 index 0000000..799c850 --- /dev/null +++ b/sites/default/civicrm/extensions/org.wikimedia.contacteditor/templates/CRM/Contacteditor/Form/ContactTypeChange.tpl @@ -0,0 +1,25 @@ +{* HEADER *} + +{* FIELD EXAMPLE: OPTION 1 (AUTOMATIC LAYOUT) *} +<div class="crm-section">{$introText}</div> +{foreach from=$elementNames item=elementName} + <div class="crm-section"> + <div class="label">{$form.$elementName.label}</div> + <div class="content">{$form.$elementName.html}</div> + <div class="clear"></div> + </div> +{/foreach} + +<div>{ts}You can change the contact's type provided they do not have any data that would be invalidated. Some more trivial data (name prefix & suffix) will be stored in an activity rather than lost.{/ts}</div> + +{* FIELD EXAMPLE: OPTION 2 (MANUAL LAYOUT) + + <div> + <span>{$form.favorite_color.label}</span> + <span>{$form.favorite_color.html}</span> + </div> + +{* FOOTER *} +<div class="crm-submit-buttons"> +{include file="CRM/common/formButtons.tpl" location="bottom"} +</div> diff --git a/sites/default/civicrm/extensions/org.wikimedia.contacteditor/tests/phpunit/BaseUnitTestClass.php b/sites/default/civicrm/extensions/org.wikimedia.contacteditor/tests/phpunit/BaseUnitTestClass.php new file mode 100644 index 0000000..3c4904b --- /dev/null +++ b/sites/default/civicrm/extensions/org.wikimedia.contacteditor/tests/phpunit/BaseUnitTestClass.php @@ -0,0 +1,214 @@ +<?php +/** + * Created by IntelliJ IDEA. + * User: emcnaughton + * Date: 11/23/17 + * Time: 12:24 PM + */ + +class BaseUnitTestClass extends \PHPUnit_Framework_TestCase{ + + protected $_apiversion = 3; + /** + * wrap api functions. + * so we can ensure they succeed & throw exceptions without litterering the test with checks + * + * @param string $entity + * @param string $action + * @param array $params + * @param mixed $checkAgainst + * Optional value to check result against, implemented for getvalue,. + * getcount, getsingle. Note that for getvalue the type is checked rather than the value + * for getsingle the array is compared against an array passed in - the id is not compared (for + * better or worse ) + * + * @return array|int + */ + public function callAPISuccess($entity, $action, $params, $checkAgainst = NULL) { + $params = array_merge(array( + 'version' => $this->_apiversion, + 'debug' => 1, + ), + $params + ); + switch (strtolower($action)) { + case 'getvalue': + return $this->callAPISuccessGetValue($entity, $params, $checkAgainst); + case 'getsingle': + return $this->callAPISuccessGetSingle($entity, $params, $checkAgainst); + case 'getcount': + return $this->callAPISuccessGetCount($entity, $params, $checkAgainst); + } + $result = $this->civicrm_api($entity, $action, $params); + $this->assertAPISuccess($result, "Failure in api call for $entity $action"); + return $result; + } + /** + * This function exists to wrap api getValue function & check the result + * so we can ensure they succeed & throw exceptions without litterering the test with checks + * There is a type check in this + * + * @param string $entity + * @param array $params + * @param string $type + * Per http://php.net/manual/en/function.gettype.php possible types. + * - boolean + * - integer + * - double + * - string + * - array + * - object + * + * @return array|int + */ + public function callAPISuccessGetValue($entity, $params, $type = NULL) { + $params += array( + 'version' => $this->_apiversion, + 'debug' => 1, + ); + $result = $this->civicrm_api($entity, 'getvalue', $params); + if ($type) { + if ($type == 'integer') { + // api seems to return integers as strings + $this->assertTrue(is_numeric($result), "expected a numeric value but got " . print_r($result, 1)); + } + else { + $this->assertType($type, $result, "returned result should have been of type $type but was "); + } + } + return $result; + } + /** + * This function exists to wrap api getValue function & check the result + * so we can ensure they succeed & throw exceptions without litterering the test with checks + * There is a type check in this + * @param string $entity + * @param array $params + * @param null $count + * @throws Exception + * @return array|int + */ + public function callAPISuccessGetCount($entity, $params, $count = NULL) { + $params += array( + 'version' => $this->_apiversion, + 'debug' => 1, + ); + $result = $this->civicrm_api($entity, 'getcount', $params); + if (!is_int($result) || !empty($result['is_error']) || isset($result['values'])) { + throw new Exception('Invalid getcount result : ' . print_r($result, TRUE) . " type :" . gettype($result)); + } + if (is_int($count)) { + $this->assertEquals($count, $result, "incorrect count returned from $entity getcount"); + } + return $result; + } + /** + * This function exists to wrap api getsingle function & check the result + * so we can ensure they succeed & throw exceptions without litterering the test with checks + * + * @param string $entity + * @param array $params + * @param array $checkAgainst + * Array to compare result against. + * - boolean + * - integer + * - double + * - string + * - array + * - object + * + * @throws Exception + * @return array|int + */ + public function callAPISuccessGetSingle($entity, $params, $checkAgainst = NULL) { + $params += array( + 'version' => $this->_apiversion, + 'debug' => 1, + ); + $result = $this->civicrm_api($entity, 'getsingle', $params); + if (!is_array($result) || !empty($result['is_error']) || isset($result['values'])) { + throw new Exception('Invalid getsingle result' . print_r($result, TRUE)); + } + if ($checkAgainst) { + // @todo - have gone with the fn that unsets id? should we check id? + $this->checkArrayEquals($result, $checkAgainst); + } + return $result; + } + /** + * Check that api returned 'is_error' => 0. + * + * @param array $apiResult + * Api result. + * @param string $prefix + * Extra test to add to message. + */ + public function assertAPISuccess($apiResult, $prefix = '') { + if (!empty($prefix)) { + $prefix .= ': '; + } + $errorMessage = empty($apiResult['error_message']) ? '' : " " . $apiResult['error_message']; + if (!empty($apiResult['debug_information'])) { + $errorMessage .= "\n " . print_r($apiResult['debug_information'], TRUE); + } + if (!empty($apiResult['trace'])) { + $errorMessage .= "\n" . print_r($apiResult['trace'], TRUE); + } + $this->assertEquals(0, $apiResult['is_error'], $prefix . $errorMessage); + } + + /** + * A stub for the API interface. This can be overriden by subclasses to change how the API is called. + * + * @param $entity + * @param $action + * @param array $params + * @return array|int + */ + public function civicrm_api($entity, $action, $params) { + return civicrm_api($entity, $action, $params); + } + + /** + * This function exists to wrap api functions. + * so we can ensure they fail where expected & throw exceptions without litterering the test with checks + * @param string $entity + * @param string $action + * @param array $params + * @param string $expectedErrorMessage + * Error. + * @param null $extraOutput + * @return array|int + */ + public function callAPIFailure($entity, $action, $params, $expectedErrorMessage = NULL, $extraOutput = NULL) { + if (is_array($params)) { + $params += array( + 'version' => $this->_apiversion, + ); + } + $result = $this->civicrm_api($entity, $action, $params); + $this->assertAPIFailure($result, "We expected a failure for $entity $action but got a success", $expectedErrorMessage); + return $result; + } + + /** + * Check that api returned 'is_error' => 1. + * + * @param array $apiResult + * Api result. + * @param string $prefix + * Extra test to add to message. + * @param null $expectedError + */ + public function assertAPIFailure($apiResult, $prefix = '', $expectedError = NULL) { + if (!empty($prefix)) { + $prefix .= ': '; + } + if ($expectedError && !empty($apiResult['is_error'])) { + $this->assertEquals($expectedError, $apiResult['error_message'], 'api error message not as expected' . $prefix); + } + $this->assertEquals(1, $apiResult['is_error'], "api call should have failed but it succeeded " . $prefix . (print_r($apiResult, TRUE))); + $this->assertNotEmpty($apiResult['error_message']); + } + +} \ No newline at end of file diff --git a/sites/default/civicrm/extensions/org.wikimedia.contacteditor/tests/phpunit/ContactEditorTest.php b/sites/default/civicrm/extensions/org.wikimedia.contacteditor/tests/phpunit/ContactEditorTest.php new file mode 100644 index 0000000..1d38666 --- /dev/null +++ b/sites/default/civicrm/extensions/org.wikimedia.contacteditor/tests/phpunit/ContactEditorTest.php @@ -0,0 +1,101 @@ +<?php + +use CRM_Contacteditor_ExtensionUtil as E; +use Civi\Test\HeadlessInterface; +use Civi\Test\HookInterface; +use Civi\Test\TransactionalInterface; + +require_once __DIR__ . '/BaseUnitTestClass.php'; +/** + * 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 ContactEditorTest extends BaseUnitTestClass implements HeadlessInterface, HookInterface, TransactionalInterface { + + public function setUpHeadless() { + // Civi\Test has many helpers, like install(), uninstall(), sql(), and sqlFile(). + // See: https://github.com/civicrm/org.civicrm.testapalooza/blob/master/civi-test.md + return \Civi\Test::headless() + ->installMe(__DIR__) + ->apply(); + } + + public function setUp() { + civicrm_initialize(); + parent::setUp(); + } + + public function tearDown() { + parent::tearDown(); + } + + /** + * Example: Test that a version is returned. + */ + public function testValidContactChange() { + $contact = civicrm_api3('Contact', 'create', array('contact_type' => 'Individual', 'first_name' => 'Really an Org', 'email' => 'arealliveper...@example.com')); + $this->mockLoggedInUser(); + + CRM_Core_Config::singleton()->userPermissionClass->permissions = array('Change CiviCRM contact type', 'access CiviCRM', 'edit all contacts'); + + $this->callAPISuccess('Contact', 'create', array('contact_type' => 'Organization', 'id' => $contact['id'])); + + $contact = $this->callAPISuccess('Contact', 'getsingle', array('id' => $contact['id'], 'return' => 'addressee')); + $this->assertEquals('Really an Org', $contact['addressee_display']); + $activity = $this->callAPISuccessGetSingle('Activity', array('target_contact_id' => $contact['id'])); + $this->assertEquals('Data lost by the change : first_name -> Really an Org', $activity['details']); + $this->assertEquals('Contact type changed from Individual to Organization', $activity['subject']); + } + + /** + * Test that the all-contacts to all contacts relationship type does not block change. + */ + public function testValidContactChangeWithChangeableRelationship() { + $contacta = civicrm_api3('Contact', 'create', array('contact_type' => 'Individual', 'first_name' => 'Really an Org', 'email' => 'arealliveper...@example.com')); + $contactb = civicrm_api3('Contact', 'create', array('contact_type' => 'Organization', 'organization_name' => 'Just an Org', 'email' => 'an...@example.com')); + $this->mockLoggedInUser(); + + $this->callAPISuccess('RelationshipType', 'create', array( + 'name_a_b' => 'contact of', + 'name_b_a' => 'contact to', + 'contact_type_a' => 'null', + 'contact_type_b' => 'null', + 'api.relationship.create' => array('contact_id_a' => $contacta['id'], 'contact_id_b' => $contactb['id']) + )); + // Clear cache. + unset(\Civi::$statics['CRM_Contacteditor_ChangeContactType']); + + $this->callAPISuccess('Contact', 'create', array('contact_type' => 'Organization', 'id' => $contacta['id'])); + + } + /** + * Example: Test that a version is returned. + */ + public function testNoPermissionForContactChange() { + $contact = civicrm_api3('Contact', 'create', array('contact_type' => 'Individual', 'first_name' => 'Really an Org', 'email' => 'arealliveper...@example.com')); + + CRM_Core_Config::singleton()->userPermissionClass->permissions = array(); + $this->callAPIFailure('Contact', 'create', array('contact_type' => 'Organization', 'id' => $contact['id'], 'check_permissions' => 1 + ), 'You do have not permission to change the contact type'); + } + + /** + * Mock a logged in user. + */ + protected function mockLoggedInUser() { + $contact = $this->callApiSuccess('Contact', 'create', ['email' => 'em...@example.org', 'contact_type' => 'Individual']); + // Source contact for activity is the logged in user, emulate. + CRM_Core_Session::singleton()->set('userID', $contact['id']); + } + +} diff --git a/sites/default/civicrm/extensions/org.wikimedia.contacteditor/tests/phpunit/bootstrap.php b/sites/default/civicrm/extensions/org.wikimedia.contacteditor/tests/phpunit/bootstrap.php new file mode 100644 index 0000000..9de4be6 --- /dev/null +++ b/sites/default/civicrm/extensions/org.wikimedia.contacteditor/tests/phpunit/bootstrap.php @@ -0,0 +1,49 @@ +<?php + +ini_set('memory_limit', '2G'); +ini_set('safe_mode', 0); +eval(cv('php:boot --level=classloader', 'phpcode')); + +/** + * Call the "cv" command. + * + * @param string $cmd + * The rest of the command to send. + * @param string $decode + * Ex: 'json' or 'phpcode'. + * @return string + * Response output (if the command executed normally). + * @throws \RuntimeException + * If the command terminates abnormally. + */ +function cv($cmd, $decode = 'json') { + $cmd = 'cv ' . $cmd; + $descriptorSpec = array(0 => array("pipe", "r"), 1 => array("pipe", "w"), 2 => STDERR); + $oldOutput = getenv('CV_OUTPUT'); + putenv("CV_OUTPUT=json"); + $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)"); + } +} diff --git a/sites/default/civicrm/extensions/org.wikimedia.contacteditor/xml/Menu/contacteditor.xml b/sites/default/civicrm/extensions/org.wikimedia.contacteditor/xml/Menu/contacteditor.xml new file mode 100644 index 0000000..97be5db --- /dev/null +++ b/sites/default/civicrm/extensions/org.wikimedia.contacteditor/xml/Menu/contacteditor.xml @@ -0,0 +1,9 @@ +<?xml version="1.0"?> +<menu> + <item> + <path>civicrm/contacttypechange</path> + <page_callback>CRM_Contacteditor_Form_ContactTypeChange</page_callback> + <title>Contact Type Change</title> + <access_arguments>Change CiviCRM contact type</access_arguments> + </item> +</menu> -- To view, visit https://gerrit.wikimedia.org/r/403558 To unsubscribe, visit https://gerrit.wikimedia.org/r/settings Gerrit-MessageType: newchange Gerrit-Change-Id: I7c34be4225c04ac112d74891035607144178fd5f Gerrit-PatchSet: 1 Gerrit-Project: wikimedia/fundraising/crm Gerrit-Branch: deployment Gerrit-Owner: Eileen <emcnaugh...@wikimedia.org> _______________________________________________ MediaWiki-commits mailing list MediaWiki-commits@lists.wikimedia.org https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
