Initial commit
This commit is contained in:
Marc Michalsky forumZFD
commit
0ea5953d8c
GPG key ID:
12406554CFB028B9
24 changed files with 4762 additions and 0 deletions
22
CRM/TwingleCampaign/Form/Settings.php
Normal file
22
CRM/TwingleCampaign/Form/Settings.php
Normal file
|
|
@ -0,0 +1,22 @@
|
||||||
|
<?php
|
||||||
|
|
||||||
|
use CRM_Twingle_ExtensionUtil as E;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Form controller class
|
||||||
|
*
|
||||||
|
* @see https://docs.civicrm.org/dev/en/latest/framework/quickform/
|
||||||
|
*/
|
||||||
|
class CRM_TwingleCampaign_Form_Settings extends CRM_Admin_Form_Setting {
|
||||||
|
|
||||||
|
protected $_settings = [
|
||||||
|
'twingle_api_key' => CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME,
|
||||||
|
'twingle_request_size' => CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME,
|
||||||
|
];
|
||||||
|
|
||||||
|
public function buildQuickForm() {
|
||||||
|
parent::buildQuickForm();
|
||||||
|
$this->assign('elementNames', array_keys($this->_settings));
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
195
CRM/TwingleCampaign/Upgrader.php
Normal file
195
CRM/TwingleCampaign/Upgrader.php
Normal file
|
|
@ -0,0 +1,195 @@
|
||||||
|
<?php
|
||||||
|
|
||||||
|
use CRM_TwingleCampaign_ExtensionUtil as E;
|
||||||
|
use TwingleCampaign\Models as Models;
|
||||||
|
|
||||||
|
include E::path() . '/CRM/TwingleCampaign/Upgrader/models/CampaignType.php';
|
||||||
|
include E::path() . '/CRM/TwingleCampaign/Upgrader/models/CustomField.php';
|
||||||
|
include E::path() . '/CRM/TwingleCampaign/Upgrader/models/CustomGroup.php';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Collection of upgrade steps.
|
||||||
|
*/
|
||||||
|
class CRM_TwingleCampaign_Upgrader extends CRM_TwingleCampaign_Upgrader_Base {
|
||||||
|
|
||||||
|
// By convention, functions that look like "function upgrade_NNNN()" are
|
||||||
|
// upgrade tasks. They are executed in order (like Drupal's hook_update_N).
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Example: Run an external SQL script when the module is installed.
|
||||||
|
*
|
||||||
|
* @throws \Exception
|
||||||
|
*/
|
||||||
|
public function install() {
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Example: Run an external SQL script when the module is uninstalled.
|
||||||
|
*
|
||||||
|
* @throws \CiviCRM_API3_Exception
|
||||||
|
* @throws \Exception
|
||||||
|
*/
|
||||||
|
public function uninstall() {
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Example: Run a simple query when a module is enabled.
|
||||||
|
*
|
||||||
|
* @throws \Exception
|
||||||
|
*/
|
||||||
|
public function enable() {
|
||||||
|
// Create campaign types, custom fields and custom groups by the contents
|
||||||
|
// of the json file "campaigns.json"
|
||||||
|
|
||||||
|
$json_file = file_get_contents(E::path() . '/CRM/TwingleCampaign/Upgrader/resources/campaigns.json');
|
||||||
|
$campaign_info = json_decode($json_file, TRUE);
|
||||||
|
|
||||||
|
if (!$campaign_info) {
|
||||||
|
\Civi::log()->error("Could not read json file");
|
||||||
|
throw new Exception('Could not read json file');
|
||||||
|
}
|
||||||
|
|
||||||
|
// Create campaign types
|
||||||
|
foreach ($campaign_info['campaign_types'] as $campaign_type) {
|
||||||
|
new Models\CampaignType($campaign_type);
|
||||||
|
}
|
||||||
|
foreach (Models\CampaignType::getCampaignTypes() as $campaign_type) {
|
||||||
|
$campaign_type->create();
|
||||||
|
}
|
||||||
|
|
||||||
|
// Create custom groups
|
||||||
|
foreach ($campaign_info['custom_groups'] as $custom_group) {
|
||||||
|
foreach (Models\CampaignType::getCampaignTypes() as $campaign_type) {
|
||||||
|
if ($campaign_type->getName() == $custom_group['campaign_type']) {
|
||||||
|
$custom_group['extends_entity_column_value'] = $campaign_type->getValue();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
new Models\CustomGroup($custom_group);
|
||||||
|
}
|
||||||
|
foreach (Models\CustomGroup::getCustomGroups() as $custom_group) {
|
||||||
|
$custom_group->create();
|
||||||
|
}
|
||||||
|
|
||||||
|
// Create custom fields
|
||||||
|
foreach ($campaign_info['custom_fields'] as $custom_field) {
|
||||||
|
new Models\CustomField($custom_field);
|
||||||
|
}
|
||||||
|
foreach (Models\CustomField::getCustomFields() as $custom_field) {
|
||||||
|
$custom_field->create();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Example: Run a simple query when a module is disabled.
|
||||||
|
*
|
||||||
|
* @throws \CiviCRM_API3_Exception
|
||||||
|
* @throws \Exception
|
||||||
|
*/
|
||||||
|
public function disable() {
|
||||||
|
|
||||||
|
$json_file = file_get_contents(E::path() . '/CRM/TwingleCampaign/Upgrader/resources/campaigns.json');
|
||||||
|
$campaign_info = json_decode($json_file, TRUE);
|
||||||
|
|
||||||
|
if (!$campaign_info) {
|
||||||
|
\Civi::log()->error("Could not read json file");
|
||||||
|
throw new Exception('Could not read json file');
|
||||||
|
}
|
||||||
|
|
||||||
|
// Delete campaign types
|
||||||
|
foreach ($campaign_info['campaign_types'] as $campaign_type) {
|
||||||
|
$result = Models\CampaignType::fetch($campaign_type['name']);
|
||||||
|
if ($result) {
|
||||||
|
$result->delete();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Delete custom groups
|
||||||
|
foreach ($campaign_info['custom_groups'] as $custom_group) {
|
||||||
|
$result = Models\CustomGroup::fetch($custom_group['name']);
|
||||||
|
if ($result) {
|
||||||
|
$result->delete();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Example: Run a couple simple queries.
|
||||||
|
*
|
||||||
|
* @return TRUE on success
|
||||||
|
* @throws Exception
|
||||||
|
*
|
||||||
|
* public function upgrade_4200() {
|
||||||
|
* $this->ctx->log->info('Applying update 4200');
|
||||||
|
* CRM_Core_DAO::executeQuery('UPDATE foo SET bar = "whiz"');
|
||||||
|
* CRM_Core_DAO::executeQuery('DELETE FROM bang WHERE willy = wonka(2)');
|
||||||
|
* return TRUE;
|
||||||
|
* } // */
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Example: Run an external SQL script.
|
||||||
|
*
|
||||||
|
* @return TRUE on success
|
||||||
|
* @throws Exception
|
||||||
|
* public function upgrade_4201() {
|
||||||
|
* $this->ctx->log->info('Applying update 4201');
|
||||||
|
* // this path is relative to the extension base dir
|
||||||
|
* $this->executeSqlFile('sql/upgrade_4201.sql');
|
||||||
|
* return TRUE;
|
||||||
|
* } // */
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Example: Run a slow upgrade process by breaking it up into smaller chunk.
|
||||||
|
*
|
||||||
|
* @return TRUE on success
|
||||||
|
* @throws Exception
|
||||||
|
* public function upgrade_4202() {
|
||||||
|
* $this->ctx->log->info('Planning update 4202'); // PEAR Log interface
|
||||||
|
*
|
||||||
|
* $this->addTask(E::ts('Process first step'), 'processPart1', $arg1, $arg2);
|
||||||
|
* $this->addTask(E::ts('Process second step'), 'processPart2', $arg3, $arg4);
|
||||||
|
* $this->addTask(E::ts('Process second step'), 'processPart3', $arg5);
|
||||||
|
* return TRUE;
|
||||||
|
* }
|
||||||
|
* public function processPart1($arg1, $arg2) { sleep(10); return TRUE; }
|
||||||
|
* public function processPart2($arg3, $arg4) { sleep(10); return TRUE; }
|
||||||
|
* public function processPart3($arg5) { sleep(10); return TRUE; }
|
||||||
|
* // */
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Example: Run an upgrade with a query that touches many (potentially
|
||||||
|
* millions) of records by breaking it up into smaller chunks.
|
||||||
|
*
|
||||||
|
* @return TRUE on success
|
||||||
|
* @throws Exception
|
||||||
|
* public function upgrade_4203() {
|
||||||
|
* $this->ctx->log->info('Planning update 4203'); // PEAR Log interface
|
||||||
|
*
|
||||||
|
* $minId = CRM_Core_DAO::singleValueQuery('SELECT coalesce(min(id),0) FROM
|
||||||
|
* civicrm_contribution');
|
||||||
|
* $maxId = CRM_Core_DAO::singleValueQuery('SELECT coalesce(max(id),0) FROM
|
||||||
|
* civicrm_contribution'); for ($startId = $minId; $startId <= $maxId;
|
||||||
|
* $startId += self::BATCH_SIZE) {
|
||||||
|
* $endId = $startId + self::BATCH_SIZE - 1;
|
||||||
|
* $title = E::ts('Upgrade Batch (%1 => %2)', array(
|
||||||
|
* 1 => $startId,
|
||||||
|
* 2 => $endId,
|
||||||
|
* ));
|
||||||
|
* $sql = '
|
||||||
|
* UPDATE civicrm_contribution SET foobar = whiz(wonky()+wanker)
|
||||||
|
* WHERE id BETWEEN %1 and %2
|
||||||
|
* ';
|
||||||
|
* $params = array(
|
||||||
|
* 1 => array($startId, 'Integer'),
|
||||||
|
* 2 => array($endId, 'Integer'),
|
||||||
|
* );
|
||||||
|
* $this->addTask($title, 'executeSql', $sql, $params);
|
||||||
|
* }
|
||||||
|
* return TRUE;
|
||||||
|
* } // */
|
||||||
|
|
||||||
|
}
|
||||||
376
CRM/TwingleCampaign/Upgrader/Base.php
Normal file
376
CRM/TwingleCampaign/Upgrader/Base.php
Normal file
|
|
@ -0,0 +1,376 @@
|
||||||
|
<?php
|
||||||
|
|
||||||
|
// AUTO-GENERATED FILE -- Civix may overwrite any changes made to this file
|
||||||
|
use CRM_TwingleCampaign_ExtensionUtil as E;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Base class which provides helpers to execute upgrade logic
|
||||||
|
*/
|
||||||
|
class CRM_TwingleCampaign_Upgrader_Base {
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @var varies, subclass of this
|
||||||
|
*/
|
||||||
|
static $instance;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @var CRM_Queue_TaskContext
|
||||||
|
*/
|
||||||
|
protected $ctx;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @var string, eg 'com.example.myextension'
|
||||||
|
*/
|
||||||
|
protected $extensionName;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @var string, full path to the extension's source tree
|
||||||
|
*/
|
||||||
|
protected $extensionDir;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @var array(revisionNumber) sorted numerically
|
||||||
|
*/
|
||||||
|
private $revisions;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @var boolean
|
||||||
|
* Flag to clean up extension revision data in civicrm_setting
|
||||||
|
*/
|
||||||
|
private $revisionStorageIsDeprecated = FALSE;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Obtain a reference to the active upgrade handler.
|
||||||
|
*/
|
||||||
|
static public function instance() {
|
||||||
|
if (!self::$instance) {
|
||||||
|
// FIXME auto-generate
|
||||||
|
self::$instance = new CRM_TwingleCampaign_Upgrader(
|
||||||
|
'de.forumzfd.twinglecampaign',
|
||||||
|
realpath(__DIR__ . '/../../../')
|
||||||
|
);
|
||||||
|
}
|
||||||
|
return self::$instance;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Adapter that lets you add normal (non-static) member functions to the queue.
|
||||||
|
*
|
||||||
|
* Note: Each upgrader instance should only be associated with one
|
||||||
|
* task-context; otherwise, this will be non-reentrant.
|
||||||
|
*
|
||||||
|
* @code
|
||||||
|
* CRM_TwingleCampaign_Upgrader_Base::_queueAdapter($ctx, 'methodName', 'arg1', 'arg2');
|
||||||
|
* @endcode
|
||||||
|
*/
|
||||||
|
static public function _queueAdapter() {
|
||||||
|
$instance = self::instance();
|
||||||
|
$args = func_get_args();
|
||||||
|
$instance->ctx = array_shift($args);
|
||||||
|
$instance->queue = $instance->ctx->queue;
|
||||||
|
$method = array_shift($args);
|
||||||
|
return call_user_func_array(array($instance, $method), $args);
|
||||||
|
}
|
||||||
|
|
||||||
|
public function __construct($extensionName, $extensionDir) {
|
||||||
|
$this->extensionName = $extensionName;
|
||||||
|
$this->extensionDir = $extensionDir;
|
||||||
|
}
|
||||||
|
|
||||||
|
// ******** Task helpers ********
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Run a CustomData file.
|
||||||
|
*
|
||||||
|
* @param string $relativePath the CustomData XML file path (relative to this extension's dir)
|
||||||
|
* @return bool
|
||||||
|
*/
|
||||||
|
public function executeCustomDataFile($relativePath) {
|
||||||
|
$xml_file = $this->extensionDir . '/' . $relativePath;
|
||||||
|
return $this->executeCustomDataFileByAbsPath($xml_file);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Run a CustomData file
|
||||||
|
*
|
||||||
|
* @param string $xml_file the CustomData XML file path (absolute path)
|
||||||
|
*
|
||||||
|
* @return bool
|
||||||
|
*/
|
||||||
|
protected static function executeCustomDataFileByAbsPath($xml_file) {
|
||||||
|
$import = new CRM_Utils_Migrate_Import();
|
||||||
|
$import->run($xml_file);
|
||||||
|
return TRUE;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Run a SQL file.
|
||||||
|
*
|
||||||
|
* @param string $relativePath the SQL file path (relative to this extension's dir)
|
||||||
|
*
|
||||||
|
* @return bool
|
||||||
|
*/
|
||||||
|
public function executeSqlFile($relativePath) {
|
||||||
|
CRM_Utils_File::sourceSQLFile(
|
||||||
|
CIVICRM_DSN,
|
||||||
|
$this->extensionDir . DIRECTORY_SEPARATOR . $relativePath
|
||||||
|
);
|
||||||
|
return TRUE;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param string $tplFile
|
||||||
|
* The SQL file path (relative to this extension's dir).
|
||||||
|
* Ex: "sql/mydata.mysql.tpl".
|
||||||
|
* @return bool
|
||||||
|
*/
|
||||||
|
public function executeSqlTemplate($tplFile) {
|
||||||
|
// Assign multilingual variable to Smarty.
|
||||||
|
$upgrade = new CRM_Upgrade_Form();
|
||||||
|
|
||||||
|
$tplFile = CRM_Utils_File::isAbsolute($tplFile) ? $tplFile : $this->extensionDir . DIRECTORY_SEPARATOR . $tplFile;
|
||||||
|
$smarty = CRM_Core_Smarty::singleton();
|
||||||
|
$smarty->assign('domainID', CRM_Core_Config::domainID());
|
||||||
|
CRM_Utils_File::sourceSQLFile(
|
||||||
|
CIVICRM_DSN, $smarty->fetch($tplFile), NULL, TRUE
|
||||||
|
);
|
||||||
|
return TRUE;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Run one SQL query.
|
||||||
|
*
|
||||||
|
* This is just a wrapper for CRM_Core_DAO::executeSql, but it
|
||||||
|
* provides syntatic sugar for queueing several tasks that
|
||||||
|
* run different queries
|
||||||
|
*/
|
||||||
|
public function executeSql($query, $params = array()) {
|
||||||
|
// FIXME verify that we raise an exception on error
|
||||||
|
CRM_Core_DAO::executeQuery($query, $params);
|
||||||
|
return TRUE;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Syntatic sugar for enqueuing a task which calls a function in this class.
|
||||||
|
*
|
||||||
|
* The task is weighted so that it is processed
|
||||||
|
* as part of the currently-pending revision.
|
||||||
|
*
|
||||||
|
* After passing the $funcName, you can also pass parameters that will go to
|
||||||
|
* the function. Note that all params must be serializable.
|
||||||
|
*/
|
||||||
|
public function addTask($title) {
|
||||||
|
$args = func_get_args();
|
||||||
|
$title = array_shift($args);
|
||||||
|
$task = new CRM_Queue_Task(
|
||||||
|
array(get_class($this), '_queueAdapter'),
|
||||||
|
$args,
|
||||||
|
$title
|
||||||
|
);
|
||||||
|
return $this->queue->createItem($task, array('weight' => -1));
|
||||||
|
}
|
||||||
|
|
||||||
|
// ******** Revision-tracking helpers ********
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Determine if there are any pending revisions.
|
||||||
|
*
|
||||||
|
* @return bool
|
||||||
|
*/
|
||||||
|
public function hasPendingRevisions() {
|
||||||
|
$revisions = $this->getRevisions();
|
||||||
|
$currentRevision = $this->getCurrentRevision();
|
||||||
|
|
||||||
|
if (empty($revisions)) {
|
||||||
|
return FALSE;
|
||||||
|
}
|
||||||
|
if (empty($currentRevision)) {
|
||||||
|
return TRUE;
|
||||||
|
}
|
||||||
|
|
||||||
|
return ($currentRevision < max($revisions));
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Add any pending revisions to the queue.
|
||||||
|
*/
|
||||||
|
public function enqueuePendingRevisions(CRM_Queue_Queue $queue) {
|
||||||
|
$this->queue = $queue;
|
||||||
|
|
||||||
|
$currentRevision = $this->getCurrentRevision();
|
||||||
|
foreach ($this->getRevisions() as $revision) {
|
||||||
|
if ($revision > $currentRevision) {
|
||||||
|
$title = ts('Upgrade %1 to revision %2', array(
|
||||||
|
1 => $this->extensionName,
|
||||||
|
2 => $revision,
|
||||||
|
));
|
||||||
|
|
||||||
|
// note: don't use addTask() because it sets weight=-1
|
||||||
|
|
||||||
|
$task = new CRM_Queue_Task(
|
||||||
|
array(get_class($this), '_queueAdapter'),
|
||||||
|
array('upgrade_' . $revision),
|
||||||
|
$title
|
||||||
|
);
|
||||||
|
$this->queue->createItem($task);
|
||||||
|
|
||||||
|
$task = new CRM_Queue_Task(
|
||||||
|
array(get_class($this), '_queueAdapter'),
|
||||||
|
array('setCurrentRevision', $revision),
|
||||||
|
$title
|
||||||
|
);
|
||||||
|
$this->queue->createItem($task);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get a list of revisions.
|
||||||
|
*
|
||||||
|
* @return array(revisionNumbers) sorted numerically
|
||||||
|
*/
|
||||||
|
public function getRevisions() {
|
||||||
|
if (!is_array($this->revisions)) {
|
||||||
|
$this->revisions = array();
|
||||||
|
|
||||||
|
$clazz = new ReflectionClass(get_class($this));
|
||||||
|
$methods = $clazz->getMethods();
|
||||||
|
foreach ($methods as $method) {
|
||||||
|
if (preg_match('/^upgrade_(.*)/', $method->name, $matches)) {
|
||||||
|
$this->revisions[] = $matches[1];
|
||||||
|
}
|
||||||
|
}
|
||||||
|
sort($this->revisions, SORT_NUMERIC);
|
||||||
|
}
|
||||||
|
|
||||||
|
return $this->revisions;
|
||||||
|
}
|
||||||
|
|
||||||
|
public function getCurrentRevision() {
|
||||||
|
$revision = CRM_Core_BAO_Extension::getSchemaVersion($this->extensionName);
|
||||||
|
if (!$revision) {
|
||||||
|
$revision = $this->getCurrentRevisionDeprecated();
|
||||||
|
}
|
||||||
|
return $revision;
|
||||||
|
}
|
||||||
|
|
||||||
|
private function getCurrentRevisionDeprecated() {
|
||||||
|
$key = $this->extensionName . ':version';
|
||||||
|
if ($revision = CRM_Core_BAO_Setting::getItem('Extension', $key)) {
|
||||||
|
$this->revisionStorageIsDeprecated = TRUE;
|
||||||
|
}
|
||||||
|
return $revision;
|
||||||
|
}
|
||||||
|
|
||||||
|
public function setCurrentRevision($revision) {
|
||||||
|
CRM_Core_BAO_Extension::setSchemaVersion($this->extensionName, $revision);
|
||||||
|
// clean up legacy schema version store (CRM-19252)
|
||||||
|
$this->deleteDeprecatedRevision();
|
||||||
|
return TRUE;
|
||||||
|
}
|
||||||
|
|
||||||
|
private function deleteDeprecatedRevision() {
|
||||||
|
if ($this->revisionStorageIsDeprecated) {
|
||||||
|
$setting = new CRM_Core_BAO_Setting();
|
||||||
|
$setting->name = $this->extensionName . ':version';
|
||||||
|
$setting->delete();
|
||||||
|
CRM_Core_Error::debug_log_message("Migrated extension schema revision ID for {$this->extensionName} from civicrm_setting (deprecated) to civicrm_extension.\n");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// ******** Hook delegates ********
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @see https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install
|
||||||
|
*/
|
||||||
|
public function onInstall() {
|
||||||
|
$files = glob($this->extensionDir . '/sql/*_install.sql');
|
||||||
|
if (is_array($files)) {
|
||||||
|
foreach ($files as $file) {
|
||||||
|
CRM_Utils_File::sourceSQLFile(CIVICRM_DSN, $file);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
$files = glob($this->extensionDir . '/sql/*_install.mysql.tpl');
|
||||||
|
if (is_array($files)) {
|
||||||
|
foreach ($files as $file) {
|
||||||
|
$this->executeSqlTemplate($file);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
$files = glob($this->extensionDir . '/xml/*_install.xml');
|
||||||
|
if (is_array($files)) {
|
||||||
|
foreach ($files as $file) {
|
||||||
|
$this->executeCustomDataFileByAbsPath($file);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if (is_callable(array($this, 'install'))) {
|
||||||
|
$this->install();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @see https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_postInstall
|
||||||
|
*/
|
||||||
|
public function onPostInstall() {
|
||||||
|
$revisions = $this->getRevisions();
|
||||||
|
if (!empty($revisions)) {
|
||||||
|
$this->setCurrentRevision(max($revisions));
|
||||||
|
}
|
||||||
|
if (is_callable(array($this, 'postInstall'))) {
|
||||||
|
$this->postInstall();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @see https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_uninstall
|
||||||
|
*/
|
||||||
|
public function onUninstall() {
|
||||||
|
$files = glob($this->extensionDir . '/sql/*_uninstall.mysql.tpl');
|
||||||
|
if (is_array($files)) {
|
||||||
|
foreach ($files as $file) {
|
||||||
|
$this->executeSqlTemplate($file);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if (is_callable(array($this, 'uninstall'))) {
|
||||||
|
$this->uninstall();
|
||||||
|
}
|
||||||
|
$files = glob($this->extensionDir . '/sql/*_uninstall.sql');
|
||||||
|
if (is_array($files)) {
|
||||||
|
foreach ($files as $file) {
|
||||||
|
CRM_Utils_File::sourceSQLFile(CIVICRM_DSN, $file);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @see https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable
|
||||||
|
*/
|
||||||
|
public function onEnable() {
|
||||||
|
// stub for possible future use
|
||||||
|
if (is_callable(array($this, 'enable'))) {
|
||||||
|
$this->enable();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @see https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_disable
|
||||||
|
*/
|
||||||
|
public function onDisable() {
|
||||||
|
// stub for possible future use
|
||||||
|
if (is_callable(array($this, 'disable'))) {
|
||||||
|
$this->disable();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
public function onUpgrade($op, CRM_Queue_Queue $queue = NULL) {
|
||||||
|
switch ($op) {
|
||||||
|
case 'check':
|
||||||
|
return array($this->hasPendingRevisions());
|
||||||
|
|
||||||
|
case 'enqueue':
|
||||||
|
return $this->enqueuePendingRevisions($queue);
|
||||||
|
|
||||||
|
default:
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
228
CRM/TwingleCampaign/Upgrader/models/CampaignType.php
Normal file
228
CRM/TwingleCampaign/Upgrader/models/CampaignType.php
Normal file
|
|
@ -0,0 +1,228 @@
|
||||||
|
<?php
|
||||||
|
|
||||||
|
namespace TwingleCampaign\Models;
|
||||||
|
|
||||||
|
use CRM_Civirules_Utils_LoggerFactory as Civi;
|
||||||
|
|
||||||
|
class CampaignType {
|
||||||
|
|
||||||
|
private static $campaignTypes = [];
|
||||||
|
private $id;
|
||||||
|
private $name;
|
||||||
|
private $label;
|
||||||
|
private $value;
|
||||||
|
private $option_group_id = 'campaign_type';
|
||||||
|
private $results;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* CampaignType constructor.
|
||||||
|
*
|
||||||
|
* @param array $attributes
|
||||||
|
*/
|
||||||
|
public function __construct(array $attributes) {
|
||||||
|
foreach ($this as $var => $value) {
|
||||||
|
if (array_key_exists($var, $attributes)) {
|
||||||
|
$this->$var = $attributes[$var];
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
self::$campaignTypes[$this->name] = $this;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @throws \CiviCRM_API3_Exception
|
||||||
|
*/
|
||||||
|
public function create() {
|
||||||
|
|
||||||
|
$field = civicrm_api3(
|
||||||
|
'OptionValue',
|
||||||
|
'get',
|
||||||
|
[
|
||||||
|
'sequential' => 1,
|
||||||
|
'option_group_id' => $this->option_group_id,
|
||||||
|
'name' => $this->getName()
|
||||||
|
]
|
||||||
|
);
|
||||||
|
|
||||||
|
if ($field['count'] == 0)
|
||||||
|
{
|
||||||
|
$this->results = civicrm_api3('OptionValue', 'create', $this->getSetAttributes());
|
||||||
|
|
||||||
|
$this->value = array_column($this->results['values'], 'value')[0];
|
||||||
|
|
||||||
|
if ($this->results['is_error'] == 0) {
|
||||||
|
\Civi::log()->info("Twingle Extension has created a new campaign type.\n
|
||||||
|
label: $this->label\n
|
||||||
|
name: $this->name"
|
||||||
|
);
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
\Civi::log()->error("Twingle Extension could not create new campaign type
|
||||||
|
for \"$this->label\": $this->results['error_message']");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
$campaignType = CampaignType::fetch($this->name);
|
||||||
|
foreach ($this as $var => $value) {
|
||||||
|
if (array_key_exists($var, $campaignType->getSetAttributes())) {
|
||||||
|
$this->$var = $campaignType->getSetAttributes()[$var];
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return array
|
||||||
|
*/
|
||||||
|
private function getSetAttributes() {
|
||||||
|
$setAttributes = [];
|
||||||
|
foreach ($this as $var => $value) {
|
||||||
|
if (isset($value)) {
|
||||||
|
$setAttributes[$var] = $value;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return $setAttributes;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param $values
|
||||||
|
*
|
||||||
|
* @return bool
|
||||||
|
* @throws \CiviCRM_API3_Exception
|
||||||
|
*/
|
||||||
|
public function alter($values) {
|
||||||
|
|
||||||
|
foreach ($values as $var => $value) {
|
||||||
|
if (isset($this->$var)) {
|
||||||
|
$this->$var = $value;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
$this->results = civicrm_api3('OptionValue', 'create', $this->getSetAttributes());
|
||||||
|
|
||||||
|
return $this->results['is_error'] == 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param $name
|
||||||
|
*
|
||||||
|
* @return \TwingleCampaign\Models\CampaignType|null
|
||||||
|
* @throws \CiviCRM_API3_Exception
|
||||||
|
*/
|
||||||
|
public static function fetch($name) {
|
||||||
|
$campaign_type = civicrm_api3(
|
||||||
|
'OptionValue',
|
||||||
|
'get',
|
||||||
|
[
|
||||||
|
'sequential' => 1,
|
||||||
|
'name' => $name
|
||||||
|
]
|
||||||
|
);
|
||||||
|
if ($campaign_type = array_shift($campaign_type['values'])) {
|
||||||
|
return new CampaignType($campaign_type);
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
return NULL;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @throws \CiviCRM_API3_Exception
|
||||||
|
*/
|
||||||
|
public function delete() {
|
||||||
|
$this->results = civicrm_api3(
|
||||||
|
'OptionValue',
|
||||||
|
'delete',
|
||||||
|
['id' => $this->id]
|
||||||
|
);
|
||||||
|
|
||||||
|
if ($this->results['is_error'] == 0) {
|
||||||
|
\Civi::log()->info("Twingle Extension has deleted campaign type.\n
|
||||||
|
label: $this->label\n
|
||||||
|
name: $this->name"
|
||||||
|
);
|
||||||
|
|
||||||
|
foreach ($this->getSetAttributes() as $var => $attribute) {
|
||||||
|
$this->$var = NULL;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
if ($this->label) {
|
||||||
|
\Civi::log()->error("Twingle Extension could not delete campaign type
|
||||||
|
\"$this->label\": $this->results['error_message']"
|
||||||
|
);
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
\Civi::log()->error("Twingle Extension could not delete campaign type:
|
||||||
|
$this->results['error_message']");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param string $name
|
||||||
|
*
|
||||||
|
* @return bool
|
||||||
|
* @throws \CiviCRM_API3_Exception
|
||||||
|
*/
|
||||||
|
public function setName(string $name) {
|
||||||
|
return $this->alter(['name', $name]);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param string $value
|
||||||
|
*
|
||||||
|
* @return bool
|
||||||
|
* @throws \CiviCRM_API3_Exception
|
||||||
|
*/
|
||||||
|
public function setValue(string $value) {
|
||||||
|
return $this->alter(['value', $value]);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param string $label
|
||||||
|
*
|
||||||
|
* @return bool
|
||||||
|
* @throws \CiviCRM_API3_Exception
|
||||||
|
*/
|
||||||
|
public function setLabel(string $label) {
|
||||||
|
return $this->alter(['label', $label]);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return array
|
||||||
|
*/
|
||||||
|
public static function getCampaignTypes(): array {
|
||||||
|
return self::$campaignTypes;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return string
|
||||||
|
*/
|
||||||
|
public function getName(): string {
|
||||||
|
return $this->name;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return string
|
||||||
|
*/
|
||||||
|
public function getValue(): string {
|
||||||
|
return $this->value;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return string
|
||||||
|
*/
|
||||||
|
public function getLabel(): string {
|
||||||
|
return $this->label;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return mixed
|
||||||
|
*/
|
||||||
|
public function getResults() {
|
||||||
|
return $this->results;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
}
|
||||||
427
CRM/TwingleCampaign/Upgrader/models/CustomField.php
Normal file
427
CRM/TwingleCampaign/Upgrader/models/CustomField.php
Normal file
|
|
@ -0,0 +1,427 @@
|
||||||
|
<?php
|
||||||
|
|
||||||
|
|
||||||
|
namespace TwingleCampaign\Models;
|
||||||
|
|
||||||
|
use CRM_TwingleCampaign_ExtensionUtil as E;
|
||||||
|
|
||||||
|
class CustomField {
|
||||||
|
|
||||||
|
private static $customFields = [];
|
||||||
|
private $id;
|
||||||
|
private $custom_group_id;
|
||||||
|
private $label;
|
||||||
|
private $name;
|
||||||
|
private $is_required;
|
||||||
|
private $is_searchable;
|
||||||
|
private $data_type;
|
||||||
|
private $html_type;
|
||||||
|
private $option_values;
|
||||||
|
private $text_length;
|
||||||
|
private $is_active;
|
||||||
|
private $is_view;
|
||||||
|
private $weight;
|
||||||
|
private $help_post;
|
||||||
|
private $default_value;
|
||||||
|
private $result;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* CustomField constructor.
|
||||||
|
*
|
||||||
|
* @param array $attributes
|
||||||
|
*/
|
||||||
|
public function __construct(array $attributes) {
|
||||||
|
foreach ($this as $var => $value) {
|
||||||
|
if (array_key_exists($var, $attributes)) {
|
||||||
|
$this->$var = $attributes[$var];
|
||||||
|
}
|
||||||
|
if ($this->help_post) {
|
||||||
|
$this->help_post = E::ts($this->help_post);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
array_push(self::$customFields, $this);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @throws \CiviCRM_API3_Exception
|
||||||
|
*/
|
||||||
|
public function create() {
|
||||||
|
|
||||||
|
$field = civicrm_api3(
|
||||||
|
'CustomField',
|
||||||
|
'get',
|
||||||
|
[
|
||||||
|
'sequential' => 1,
|
||||||
|
'name' => $this->getName()
|
||||||
|
]
|
||||||
|
);
|
||||||
|
|
||||||
|
if ($field['count'] == 0)
|
||||||
|
{
|
||||||
|
$this->result = civicrm_api3(
|
||||||
|
'CustomField',
|
||||||
|
'create',
|
||||||
|
$this->getSetAttributes());
|
||||||
|
|
||||||
|
$this->id = $this->result['id'];
|
||||||
|
|
||||||
|
if ($this->result['is_error'] == 0) {
|
||||||
|
\Civi::log()->info("Twingle Extension has created a new custom field.\n
|
||||||
|
label: $this->label\n
|
||||||
|
name: $this->name\n
|
||||||
|
id: $this->id\n
|
||||||
|
group: $this->custom_group_id"
|
||||||
|
);
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
if ($this->label && $this->custom_group_id) {
|
||||||
|
\Civi::log()
|
||||||
|
->error("Twingle Extension could not create new custom field
|
||||||
|
\"$this->label\" for group \"$this->custom_group_id\":
|
||||||
|
$this->result['error_message']");
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
\Civi::log()
|
||||||
|
->error("Twingle Extension could not create new custom field:
|
||||||
|
$this->result['error_message']");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return array
|
||||||
|
*/
|
||||||
|
private function getSetAttributes() {
|
||||||
|
$setAttributes = [];
|
||||||
|
foreach ($this as $var => $value) {
|
||||||
|
if (isset($value)) {
|
||||||
|
$setAttributes[$var] = $value;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return $setAttributes;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param $values
|
||||||
|
*
|
||||||
|
* @return bool
|
||||||
|
* @throws \CiviCRM_API3_Exception
|
||||||
|
*/
|
||||||
|
public function alter($values) {
|
||||||
|
|
||||||
|
foreach ($values as $var => $value) {
|
||||||
|
if ($this->$var) {
|
||||||
|
$this->$var = $value;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
$this->result = civicrm_api3('CustomField', 'create', $this->getSetAttributes());
|
||||||
|
|
||||||
|
return $this->result['is_error'] == 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param $name
|
||||||
|
*
|
||||||
|
* @return \TwingleCampaign\Models\CustomField
|
||||||
|
* @throws \CiviCRM_API3_Exception
|
||||||
|
*/
|
||||||
|
public static function fetch($name) {
|
||||||
|
|
||||||
|
$custom_field = civicrm_api3(
|
||||||
|
'CustomField',
|
||||||
|
'get',
|
||||||
|
[
|
||||||
|
'sequential' => 1,
|
||||||
|
'name' => $name
|
||||||
|
]
|
||||||
|
);
|
||||||
|
if ($custom_field = array_shift($custom_field['values'])) {
|
||||||
|
return new CustomField($custom_field);
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
return NULL;
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
public function delete() {
|
||||||
|
$this->result = civicrm_api3(
|
||||||
|
'CustomField',
|
||||||
|
'delete',
|
||||||
|
['id' => $this->id]
|
||||||
|
);
|
||||||
|
|
||||||
|
if ($this->result['is_error'] == 0) {
|
||||||
|
\Civi::log()->info("Twingle Extension has deleted custom field.\n
|
||||||
|
label: $this->label\n
|
||||||
|
name: $this->name\n
|
||||||
|
id: $this->id\n
|
||||||
|
group: $this->custom_group_id"
|
||||||
|
);
|
||||||
|
|
||||||
|
foreach ($this->getSetAttributes() as $var => $attribute) {
|
||||||
|
$this->$var = NULL;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
if ($this->label && $this->custom_group_id) {
|
||||||
|
\Civi::log()
|
||||||
|
->error("Twingle Extension could not delete custom field
|
||||||
|
\"$this->label\" for group \"$this->custom_group_id\":
|
||||||
|
$this->result['error_message']");
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
\Civi::log()
|
||||||
|
->error("Twingle Extension could not delete custom field:
|
||||||
|
$this->result['error_message']");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param string $custom_group_id
|
||||||
|
*
|
||||||
|
* @return bool
|
||||||
|
* @throws \CiviCRM_API3_Exception
|
||||||
|
*/
|
||||||
|
public function setCustomGroupId(string $custom_group_id) {
|
||||||
|
return $this->alter(['custom_group_id', $custom_group_id]);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param string $label
|
||||||
|
*
|
||||||
|
* @return bool
|
||||||
|
* @throws \CiviCRM_API3_Exception
|
||||||
|
*/
|
||||||
|
public function setLabel(string $label) {
|
||||||
|
return $this->alter(['label', $label]);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param string $name
|
||||||
|
*
|
||||||
|
* @return bool
|
||||||
|
* @throws \CiviCRM_API3_Exception
|
||||||
|
*/
|
||||||
|
public function setName(string $name) {
|
||||||
|
return $this->alter(['name', $name]);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param int $is_required
|
||||||
|
*
|
||||||
|
* @return bool
|
||||||
|
* @throws \CiviCRM_API3_Exception
|
||||||
|
*/
|
||||||
|
public function setIsRequired(int $is_required) {
|
||||||
|
return $this->alter(['is_required', $is_required]);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param int $is_searchable
|
||||||
|
*
|
||||||
|
* @return bool
|
||||||
|
* @throws \CiviCRM_API3_Exception
|
||||||
|
*/
|
||||||
|
public function setIsSearchable(int $is_searchable) {
|
||||||
|
return $this->alter(['is_searchable', $is_searchable]);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param string $data_type
|
||||||
|
*
|
||||||
|
* @return bool
|
||||||
|
* @throws \CiviCRM_API3_Exception
|
||||||
|
*/
|
||||||
|
public function setDataType(string $data_type) {
|
||||||
|
return $this->alter(['data_type', $data_type]);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param string $html_type
|
||||||
|
*
|
||||||
|
* @return bool
|
||||||
|
* @throws \CiviCRM_API3_Exception
|
||||||
|
*/
|
||||||
|
public function setHtmlType(string $html_type) {
|
||||||
|
return $this->alter(['html_type', $html_type]);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param mixed $option_values
|
||||||
|
*/
|
||||||
|
public function setOptionValues($option_values) {
|
||||||
|
$this->option_values = $option_values;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param int $text_length
|
||||||
|
*
|
||||||
|
* @return bool
|
||||||
|
* @throws \CiviCRM_API3_Exception
|
||||||
|
*/
|
||||||
|
public function setTextLength(int $text_length) {
|
||||||
|
return $this->alter(['text_length', $text_length]);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param int $is_active
|
||||||
|
*
|
||||||
|
* @return bool
|
||||||
|
* @throws \CiviCRM_API3_Exception
|
||||||
|
*/
|
||||||
|
public function setIsActive(int $is_active) {
|
||||||
|
return $this->alter(['is_active', $is_active]);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param int $is_view
|
||||||
|
*
|
||||||
|
* @return bool
|
||||||
|
* @throws \CiviCRM_API3_Exception
|
||||||
|
*/
|
||||||
|
public function setIsView(int $is_view) {
|
||||||
|
return $this->alter(['is_view', $is_view]);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param int $weight
|
||||||
|
*
|
||||||
|
* @return bool
|
||||||
|
* @throws \CiviCRM_API3_Exception
|
||||||
|
*/
|
||||||
|
public function setWeight(int $weight) {
|
||||||
|
return $this->alter(['weight', $weight]);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param mixed $help_post
|
||||||
|
*/
|
||||||
|
public function setHelpPost($help_post) {
|
||||||
|
$this->help_post = $help_post;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param mixed $default_value
|
||||||
|
*/
|
||||||
|
public function setDefaultValue($default_value) {
|
||||||
|
$this->default_value = $default_value;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return array
|
||||||
|
*/
|
||||||
|
public static function getCustomFields(): array {
|
||||||
|
return self::$customFields;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return string
|
||||||
|
*/
|
||||||
|
public function getCustomGroupId(): string {
|
||||||
|
return $this->custom_group_id;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return string
|
||||||
|
*/
|
||||||
|
public function getLabel(): string {
|
||||||
|
return $this->label;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return string
|
||||||
|
*/
|
||||||
|
public function getName(): string {
|
||||||
|
return $this->name;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return int
|
||||||
|
*/
|
||||||
|
public function getIsRequired(): int {
|
||||||
|
return $this->is_required;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return int
|
||||||
|
*/
|
||||||
|
public function getIsSearchable(): int {
|
||||||
|
return $this->is_searchable;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return string
|
||||||
|
*/
|
||||||
|
public function getDataType(): string {
|
||||||
|
return $this->data_type;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return string
|
||||||
|
*/
|
||||||
|
public function getHtmlType(): string {
|
||||||
|
return $this->html_type;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return mixed
|
||||||
|
*/
|
||||||
|
public function getOptionValues() {
|
||||||
|
return $this->option_values;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return int
|
||||||
|
*/
|
||||||
|
public function getTextLength(): int {
|
||||||
|
return $this->text_length;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return int
|
||||||
|
*/
|
||||||
|
public function getIsActive(): int {
|
||||||
|
return $this->is_active;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return int
|
||||||
|
*/
|
||||||
|
public function getIsView(): int {
|
||||||
|
return $this->is_view;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return int
|
||||||
|
*/
|
||||||
|
public function getWeight(): int {
|
||||||
|
return $this->weight;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return mixed
|
||||||
|
*/
|
||||||
|
public function getHelpPost() {
|
||||||
|
return $this->help_post;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return mixed
|
||||||
|
*/
|
||||||
|
public function getDefaultValue() {
|
||||||
|
return $this->default_value;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return mixed
|
||||||
|
*/
|
||||||
|
public function getId() {
|
||||||
|
return $this->id;
|
||||||
|
}#
|
||||||
|
|
||||||
|
}
|
||||||
270
CRM/TwingleCampaign/Upgrader/models/CustomGroup.php
Normal file
270
CRM/TwingleCampaign/Upgrader/models/CustomGroup.php
Normal file
|
|
@ -0,0 +1,270 @@
|
||||||
|
<?php
|
||||||
|
|
||||||
|
|
||||||
|
namespace TwingleCampaign\Models;
|
||||||
|
|
||||||
|
use CRM_Civirules_Utils_LoggerFactory as Civi;
|
||||||
|
|
||||||
|
class CustomGroup {
|
||||||
|
|
||||||
|
private static $customGroups = [];
|
||||||
|
private $id;
|
||||||
|
private $title;
|
||||||
|
private $name;
|
||||||
|
private $extends;
|
||||||
|
private $weight;
|
||||||
|
private $extends_entity_column_value;
|
||||||
|
private $results;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* CustomGroup constructor.
|
||||||
|
*
|
||||||
|
* @param array $attributes
|
||||||
|
*/
|
||||||
|
public function __construct(array $attributes) {
|
||||||
|
foreach ($this as $var => $value) {
|
||||||
|
if (array_key_exists($var, $attributes))
|
||||||
|
$this->$var = $attributes[$var];
|
||||||
|
}
|
||||||
|
|
||||||
|
array_push(self::$customGroups, $this);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @throws \CiviCRM_API3_Exception
|
||||||
|
*/
|
||||||
|
public function create() {
|
||||||
|
|
||||||
|
$field = civicrm_api3(
|
||||||
|
'CustomGroup',
|
||||||
|
'get',
|
||||||
|
[
|
||||||
|
'sequential' => 1,
|
||||||
|
'name' => $this->getName()
|
||||||
|
]
|
||||||
|
);
|
||||||
|
|
||||||
|
if ($field['count'] == 0) {
|
||||||
|
|
||||||
|
$this->results = civicrm_api3('CustomGroup', 'create', $this->getSetAttributes());
|
||||||
|
|
||||||
|
$this->id = $this->results['id'];
|
||||||
|
|
||||||
|
if ($this->results['is_error'] == 0) {
|
||||||
|
\Civi::log()->info("Twingle Extension has created a new custom group.\n
|
||||||
|
title: $this->title\n
|
||||||
|
name: $this->name\n
|
||||||
|
extends: $this->extends\n
|
||||||
|
id: $this->id\n
|
||||||
|
column_value: $this->extends_entity_column_value"
|
||||||
|
);
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
if ($this->title) {
|
||||||
|
\Civi::log()->error("Twingle Extension could not create new custom group
|
||||||
|
for \"$this->title\": $this->results['error_message']"
|
||||||
|
);
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
\Civi::log()->error("Twingle Extension could not create new
|
||||||
|
custom group: $this->results['error_message']");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return array
|
||||||
|
*/
|
||||||
|
private function getSetAttributes() {
|
||||||
|
$setAttributes = [];
|
||||||
|
foreach ($this as $var => $value) {
|
||||||
|
if (isset($value)) {
|
||||||
|
$setAttributes[$var] = $value;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return $setAttributes;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param $values
|
||||||
|
*
|
||||||
|
* @return bool
|
||||||
|
* @throws \CiviCRM_API3_Exception
|
||||||
|
*/
|
||||||
|
public function alter($values) {
|
||||||
|
|
||||||
|
foreach ($values as $var => $value) {
|
||||||
|
if ($this->$var) {
|
||||||
|
$this->$var = $value;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
$this->results = civicrm_api3('CustomGroup', 'create', $this->getSetAttributes());
|
||||||
|
|
||||||
|
return $this->results['is_error'] == 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param $name
|
||||||
|
*
|
||||||
|
* @return Models\CustomGroup
|
||||||
|
* @throws \CiviCRM_API3_Exception
|
||||||
|
*/
|
||||||
|
public static function fetch($name) {
|
||||||
|
|
||||||
|
$custom_group = civicrm_api3(
|
||||||
|
'CustomGroup',
|
||||||
|
'get',
|
||||||
|
[
|
||||||
|
'sequential' => 1,
|
||||||
|
'name' => $name
|
||||||
|
]
|
||||||
|
);
|
||||||
|
if ($custom_group = array_shift($custom_group['values'])) {
|
||||||
|
return new CustomGroup($custom_group);
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
return NULL;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
public function delete() {
|
||||||
|
$this->results = civicrm_api3(
|
||||||
|
'CustomGroup',
|
||||||
|
'delete',
|
||||||
|
['id' => $this->id]
|
||||||
|
);
|
||||||
|
|
||||||
|
if ($this->results['is_error'] == 0) {
|
||||||
|
\Civi::log()->info("Twingle Extension has deleted custom group.\n
|
||||||
|
title: $this->title\n
|
||||||
|
name: $this->name\n
|
||||||
|
extends: $this->extends\n
|
||||||
|
id : $this->id"
|
||||||
|
);
|
||||||
|
|
||||||
|
foreach ($this->getSetAttributes() as $var => $attribute) {
|
||||||
|
$this->$var = NULL;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
if ($this->title) {
|
||||||
|
\Civi::log()->error("Twingle Extension could not delete custom group
|
||||||
|
\"$this->title\": $this->results['error_message']"
|
||||||
|
);
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
\Civi::log()->error("Twingle Extension could not delete custom group:
|
||||||
|
$this->results['error_message']");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param mixed $id
|
||||||
|
*
|
||||||
|
* @return bool
|
||||||
|
* @throws \CiviCRM_API3_Exception
|
||||||
|
*/
|
||||||
|
public function setId($id) {
|
||||||
|
return $this->alter(['id', $id]);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param string $title
|
||||||
|
*
|
||||||
|
* @return bool
|
||||||
|
* @throws \CiviCRM_API3_Exception
|
||||||
|
*/
|
||||||
|
public function setTitle(string $title) {
|
||||||
|
return $this->alter(['title', $title]);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param string $name
|
||||||
|
*
|
||||||
|
* @return bool
|
||||||
|
* @throws \CiviCRM_API3_Exception
|
||||||
|
*/
|
||||||
|
public function setName(string $name) {
|
||||||
|
return $this->alter(['name', $name]);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param string $extends
|
||||||
|
*
|
||||||
|
* @return bool
|
||||||
|
* @throws \CiviCRM_API3_Exception
|
||||||
|
*/
|
||||||
|
public function setExtends(string $extends) {
|
||||||
|
return $this->alter(['extends', $extends]);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param mixed $weight
|
||||||
|
*/
|
||||||
|
public function setWeight($weight) {
|
||||||
|
$this->weight = $weight;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param string $column_value
|
||||||
|
*
|
||||||
|
* @return bool
|
||||||
|
* @throws \CiviCRM_API3_Exception
|
||||||
|
*/
|
||||||
|
public function setColumnValue(string $column_value) {
|
||||||
|
return $this->alter(['column_value', $column_value]);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return array
|
||||||
|
*/
|
||||||
|
public static function getCustomGroups() {
|
||||||
|
return self::$customGroups;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return string
|
||||||
|
*/
|
||||||
|
public function getTitle(): string {
|
||||||
|
return $this->title;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return string
|
||||||
|
*/
|
||||||
|
public function getName(): string {
|
||||||
|
return $this->name;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return string
|
||||||
|
*/
|
||||||
|
public function getExtends(): string {
|
||||||
|
return $this->extends;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return mixed
|
||||||
|
*/
|
||||||
|
public function getWeight() {
|
||||||
|
return $this->weight;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return string
|
||||||
|
*/
|
||||||
|
public function getColumnValue(): string {
|
||||||
|
return $this->column_value;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return mixed
|
||||||
|
*/
|
||||||
|
public function getResult() {
|
||||||
|
return $this->results;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
}
|
||||||
1244
CRM/TwingleCampaign/Upgrader/resources/campaigns.json
Normal file
1244
CRM/TwingleCampaign/Upgrader/resources/campaigns.json
Normal file
File diff suppressed because it is too large
Load diff
667
LICENSE.txt
Normal file
667
LICENSE.txt
Normal file
|
|
@ -0,0 +1,667 @@
|
||||||
|
Package: de.forumzfd.twinglecampaign
|
||||||
|
Copyright (C) 2020, 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/>.
|
||||||
44
README.md
Normal file
44
README.md
Normal file
|
|
@ -0,0 +1,44 @@
|
||||||
|
# de.forumzfd.twinglecampaign
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
(*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.0+
|
||||||
|
* CiviCRM (*FIXME: Version number*)
|
||||||
|
|
||||||
|
## Installation (Web UI)
|
||||||
|
|
||||||
|
This extension has not yet been published for installation via the web UI.
|
||||||
|
|
||||||
|
## 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 de.forumzfd.twinglecampaign@https://github.com/FIXME/de.forumzfd.twinglecampaign/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/de.forumzfd.twinglecampaign.git
|
||||||
|
cv en twinglecampaign
|
||||||
|
```
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
(* FIXME: Where would a new user navigate to get started? What changes would they see? *)
|
||||||
|
|
||||||
|
## Known Issues
|
||||||
|
|
||||||
|
(* FIXME *)
|
||||||
63
api/v3/TwingleSync/Get.php
Normal file
63
api/v3/TwingleSync/Get.php
Normal file
|
|
@ -0,0 +1,63 @@
|
||||||
|
<?php
|
||||||
|
|
||||||
|
use CRM_TwingleCampaign_ExtensionUtil as E;
|
||||||
|
use TwingleCampaign\Models\TwingleApiCall as TwingleApiCall;
|
||||||
|
|
||||||
|
include_once E::path() . '/api/v3/TwingleSync/models/TwingleApiCall.php';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* TwingleSync.Get API specification (optional)
|
||||||
|
* This is used for documentation and validation.
|
||||||
|
*
|
||||||
|
* @param array $spec description of fields supported by this API call
|
||||||
|
*
|
||||||
|
* @see https://docs.civicrm.org/dev/en/latest/framework/api-architecture/
|
||||||
|
*/
|
||||||
|
function _civicrm_api3_twingle_sync_Get_spec(&$spec) {
|
||||||
|
$spec['twingle_api_key'] = [
|
||||||
|
'name' => 'twingle_api_key',
|
||||||
|
'title' => E::ts('Twingle API key'),
|
||||||
|
'type' => CRM_Utils_Type::T_STRING,
|
||||||
|
'api.required' => 0,
|
||||||
|
'description' => E::ts('The key you need to access the Twingle API'),
|
||||||
|
];
|
||||||
|
$spec['test'] = [
|
||||||
|
'name' => 'test',
|
||||||
|
'title' => E::ts('Test'),
|
||||||
|
'type' => CRM_Utils_Type::T_BOOLEAN,
|
||||||
|
'api.required' => 0,
|
||||||
|
'description' => E::ts('If this is set true, no database change will be made'),
|
||||||
|
];
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* TwingleSync.Get API
|
||||||
|
*
|
||||||
|
* @param array $params
|
||||||
|
*
|
||||||
|
* @return array
|
||||||
|
* API result descriptor
|
||||||
|
*
|
||||||
|
* @throws \CiviCRM_API3_Exception|\API_Exception
|
||||||
|
* @see civicrm_api3_create_success
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
function civicrm_api3_twingle_sync_Get($params) {
|
||||||
|
$result_values = [];
|
||||||
|
|
||||||
|
$apiKey = empty($params['twingle_api_key'])
|
||||||
|
? CRM_Core_BAO_Setting::getItem('', 'twingle_api_key')
|
||||||
|
: $params['twingle_api_key'];
|
||||||
|
|
||||||
|
// TODO: Do the magic!
|
||||||
|
|
||||||
|
$twingleApi = new TwingleApiCall($apiKey);
|
||||||
|
$result_values['projects'] = $twingleApi->getProject();
|
||||||
|
foreach ($result_values['projects'] as $project) {
|
||||||
|
if (is_array($project)) {
|
||||||
|
$result_values['campaigns_created'][$project['id']] = $twingleApi->createProject($project);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return civicrm_api3_create_success($result_values);
|
||||||
|
}
|
||||||
155
api/v3/TwingleSync/models/TwingleApiCall.php
Normal file
155
api/v3/TwingleSync/models/TwingleApiCall.php
Normal file
|
|
@ -0,0 +1,155 @@
|
||||||
|
<?php
|
||||||
|
|
||||||
|
namespace TwingleCampaign\Models;
|
||||||
|
|
||||||
|
use CRM_Core_BAO_Setting;
|
||||||
|
use CRM_TwingleCampaign_ExtensionUtil as E;
|
||||||
|
use TwingleCampaign\Models\TwingleProject as TwingleProject;
|
||||||
|
|
||||||
|
include_once E::path() . '/api/v3/TwingleSync/models/TwingleProject.php';
|
||||||
|
|
||||||
|
class TwingleApiCall {
|
||||||
|
|
||||||
|
private $apiKey;
|
||||||
|
|
||||||
|
private $baseUrl = '.twingle.de/api/';
|
||||||
|
|
||||||
|
private $protocol = 'https://';
|
||||||
|
|
||||||
|
private $organisationIds;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* TwingleApiCall constructor.
|
||||||
|
*
|
||||||
|
* @param $apiKey
|
||||||
|
*
|
||||||
|
* @throws \API_Exception
|
||||||
|
*/
|
||||||
|
public function __construct($apiKey) {
|
||||||
|
$this->apiKey = $apiKey;
|
||||||
|
|
||||||
|
$curl = curl_init($this->protocol . 'organisation' . $this->baseUrl);
|
||||||
|
curl_setopt($curl, CURLOPT_RETURNTRANSFER, TRUE);
|
||||||
|
curl_setopt($curl, CURLOPT_HTTPHEADER, [
|
||||||
|
"x-access-code: $apiKey",
|
||||||
|
'Content-Type: application/json',
|
||||||
|
]);
|
||||||
|
|
||||||
|
$response = json_decode(curl_exec($curl), TRUE);
|
||||||
|
curl_close($curl);
|
||||||
|
|
||||||
|
if (empty($response)) {
|
||||||
|
throw new \API_Exception("Twingle API call failed");
|
||||||
|
}
|
||||||
|
|
||||||
|
$this->organisationIds = array_column($response, 'id');
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* If $id parameter is empty, this function returns all projects for all
|
||||||
|
* organisations this API key is assigned to.
|
||||||
|
*
|
||||||
|
* If $id parameter is given, this function returns a single project.
|
||||||
|
*
|
||||||
|
* @param null $projectId
|
||||||
|
*
|
||||||
|
* @return mixed
|
||||||
|
*/
|
||||||
|
public function getProject($projectId = NULL) {
|
||||||
|
$response = [];
|
||||||
|
foreach ($this->organisationIds as $organisationId) {
|
||||||
|
$url = empty($projectId)
|
||||||
|
? $this->protocol . 'project' . $this->baseUrl . 'by-organisation/' . $organisationId
|
||||||
|
: $this->protocol . 'project' . $this->baseUrl . $projectId;
|
||||||
|
|
||||||
|
$response = array_merge($this->curlGet($url));
|
||||||
|
}
|
||||||
|
return $response;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
*
|
||||||
|
* Returns all Events for the given $projectId
|
||||||
|
*
|
||||||
|
* @param $projectId
|
||||||
|
*
|
||||||
|
* @return array
|
||||||
|
*/
|
||||||
|
public function getEvent($projectId) {
|
||||||
|
$result = [];
|
||||||
|
$url = $this->protocol . 'project' . $this->baseUrl . $projectId . '/event';
|
||||||
|
$limit = CRM_Core_BAO_Setting::getItem('', 'twingle_request_size');
|
||||||
|
$offset = 0;
|
||||||
|
$finished = FALSE;
|
||||||
|
|
||||||
|
while (!$finished) {
|
||||||
|
$params = [
|
||||||
|
'orderby' => 'id',
|
||||||
|
'direction' => 'desc',
|
||||||
|
'limit' => $limit,
|
||||||
|
'offset' => $offset,
|
||||||
|
'image' => 'as-boolean',
|
||||||
|
'public' => 0,
|
||||||
|
];
|
||||||
|
$response = $this->curlGet($url, $params);
|
||||||
|
$finished = count($response['data']) < $limit;
|
||||||
|
$offset = $offset + $limit;
|
||||||
|
$result = array_merge($result, $response['data']);
|
||||||
|
}
|
||||||
|
return $result;
|
||||||
|
}
|
||||||
|
|
||||||
|
public function createProject($values) {
|
||||||
|
try {
|
||||||
|
if (is_array($values)) {
|
||||||
|
$project = new TwingleProject($values);
|
||||||
|
return $project->create();
|
||||||
|
}
|
||||||
|
} catch (\Exception $e) {
|
||||||
|
// TODO: Handle Exception
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
public function updateProject() {
|
||||||
|
}
|
||||||
|
|
||||||
|
public function updateEvent() {
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return array
|
||||||
|
*/
|
||||||
|
public function getOrganisationIds() {
|
||||||
|
return $this->organisationIds;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
*
|
||||||
|
* Does a cURL and gives back the result array.
|
||||||
|
*
|
||||||
|
* @param $url
|
||||||
|
*
|
||||||
|
* @param null $params
|
||||||
|
*
|
||||||
|
* @return mixed
|
||||||
|
*/
|
||||||
|
private function curlGet($url, $params = NULL) {
|
||||||
|
if (!empty($params)) {
|
||||||
|
$url = $url . '?' . http_build_query($params);
|
||||||
|
}
|
||||||
|
$curl = curl_init($url);
|
||||||
|
curl_setopt($curl, CURLOPT_RETURNTRANSFER, TRUE);
|
||||||
|
curl_setopt($curl, CURLOPT_HTTPHEADER, [
|
||||||
|
"x-access-code: $this->apiKey",
|
||||||
|
'Content-Type: application/json',
|
||||||
|
]);
|
||||||
|
$response = json_decode(curl_exec($curl), TRUE);
|
||||||
|
if (empty($response)) {
|
||||||
|
$response = curl_error($curl);
|
||||||
|
}
|
||||||
|
curl_close($curl);
|
||||||
|
return $response;
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
9
api/v3/TwingleSync/models/TwingleCampaign.php
Normal file
9
api/v3/TwingleSync/models/TwingleCampaign.php
Normal file
|
|
@ -0,0 +1,9 @@
|
||||||
|
<?php
|
||||||
|
|
||||||
|
|
||||||
|
namespace TwingleCampaign\Models;
|
||||||
|
|
||||||
|
|
||||||
|
class TwingleCampaign {
|
||||||
|
|
||||||
|
}
|
||||||
9
api/v3/TwingleSync/models/TwingleEvent.php
Normal file
9
api/v3/TwingleSync/models/TwingleEvent.php
Normal file
|
|
@ -0,0 +1,9 @@
|
||||||
|
<?php
|
||||||
|
|
||||||
|
|
||||||
|
namespace TwingleCampaign\Models;
|
||||||
|
|
||||||
|
|
||||||
|
class TwingleEvent {
|
||||||
|
|
||||||
|
}
|
||||||
122
api/v3/TwingleSync/models/TwingleProject.php
Normal file
122
api/v3/TwingleSync/models/TwingleProject.php
Normal file
|
|
@ -0,0 +1,122 @@
|
||||||
|
<?php
|
||||||
|
|
||||||
|
|
||||||
|
namespace TwingleCampaign\Models;
|
||||||
|
|
||||||
|
use CRM_TwingleCampaign_ExtensionUtil as E;
|
||||||
|
use DateTime;
|
||||||
|
use TwingleCampaign\Models\CustomField as CustomField;
|
||||||
|
|
||||||
|
include E::path() . '/CRM/Twingle/Upgrader/models/CustomField.php';
|
||||||
|
|
||||||
|
|
||||||
|
class TwingleProject {
|
||||||
|
|
||||||
|
private static $bInitialized = FALSE;
|
||||||
|
|
||||||
|
private $values;
|
||||||
|
|
||||||
|
private $timestamp;
|
||||||
|
|
||||||
|
private $settings;
|
||||||
|
|
||||||
|
private static $customFields = [];
|
||||||
|
|
||||||
|
/**
|
||||||
|
* TwingleProject constructor.
|
||||||
|
*
|
||||||
|
* @param array $values
|
||||||
|
*
|
||||||
|
* @throws \Exception
|
||||||
|
*/
|
||||||
|
public function __construct(array $values) {
|
||||||
|
|
||||||
|
$this->timestamp = $values['last_update'];
|
||||||
|
|
||||||
|
// Format data types of the values for import into CiviCRM
|
||||||
|
$this->formatForImport($values);
|
||||||
|
|
||||||
|
// Add necessary attributes
|
||||||
|
$this->values['title'] = $values['name'];
|
||||||
|
$this->values['campaign_type_id'] = 'twingle_project';
|
||||||
|
|
||||||
|
// Fetch custom fields once and store them in static attribute
|
||||||
|
self::init();
|
||||||
|
|
||||||
|
// Map parameters to custom field names (e.g. "custom_21")
|
||||||
|
foreach (self::$customFields as $customField) {
|
||||||
|
if (!empty($values[str_replace('twingle_project_', '', $customField->getName())])) {
|
||||||
|
$this->values['custom_' . $customField->getId()] =
|
||||||
|
$values[str_replace('twingle_project_', '', $customField->getName())];
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @throws \Exception
|
||||||
|
*/
|
||||||
|
private static function init() {
|
||||||
|
if (self::$bInitialized) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
$json_file = file_get_contents(E::path() .
|
||||||
|
'/CRM/Twingle/Upgrader/resources/campaigns.json');
|
||||||
|
$campaign_info = json_decode($json_file, TRUE);
|
||||||
|
|
||||||
|
if (!$campaign_info) {
|
||||||
|
\Civi::log()->error("Could not read json file");
|
||||||
|
throw new \Exception('Could not read json file');
|
||||||
|
}
|
||||||
|
|
||||||
|
foreach ($campaign_info['custom_fields'] as $custom_field) {
|
||||||
|
$result = CustomField::fetch($custom_field['name']);
|
||||||
|
array_push(self::$customFields, $result);
|
||||||
|
}
|
||||||
|
|
||||||
|
self::$bInitialized = TRUE;
|
||||||
|
}
|
||||||
|
|
||||||
|
public function create() {
|
||||||
|
$values = $this->values;
|
||||||
|
try {
|
||||||
|
return civicrm_api3('Campaign', 'create', $values);
|
||||||
|
} catch (\CiviCRM_API3_Exception $e) {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
private function formatForImport(&$values) {
|
||||||
|
|
||||||
|
// Change timestamp into DateTime string
|
||||||
|
if (!empty($values['last_update'])) {
|
||||||
|
$date = DateTime::createFromFormat('U', $values['last_update'] );
|
||||||
|
$values['last_update'] = $date->format('Y-m-d H:i:s');
|
||||||
|
}
|
||||||
|
|
||||||
|
// Change event type empty string into 'default'
|
||||||
|
if ($values['type'] == ''){
|
||||||
|
$values['type'] = 'default';
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
private function formatForExport(&$values) {
|
||||||
|
|
||||||
|
// Change DateTime string into timestamp
|
||||||
|
if (!empty($values['last_update'])) {
|
||||||
|
$date = DateTime::createFromFormat('Y-m-d H:i:s', $values['last_update'] );
|
||||||
|
$values['last_update'] = $date->getTimestamp();
|
||||||
|
}
|
||||||
|
|
||||||
|
// Change event type 'default' into empty string
|
||||||
|
if ($values['type'] == 'default'){
|
||||||
|
$values['type'] = '';
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
public function syncSettings() {
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
}
|
||||||
73
api/v3/TwingleSync/resources/project_settings_template.json
Normal file
73
api/v3/TwingleSync/resources/project_settings_template.json
Normal file
|
|
@ -0,0 +1,73 @@
|
||||||
|
{
|
||||||
|
"id": 2237,
|
||||||
|
"has_confirmation_mail": false,
|
||||||
|
"has_confirmation_mail_api": false,
|
||||||
|
"has_donation_receipt": true,
|
||||||
|
"has_contact_data": false,
|
||||||
|
"donation_rhythm": {
|
||||||
|
"yearly": true,
|
||||||
|
"halfyearly": false,
|
||||||
|
"quarterly": false,
|
||||||
|
"monthly": true,
|
||||||
|
"one_time": true
|
||||||
|
},
|
||||||
|
"has_newsletter_registration": false,
|
||||||
|
"has_postinfo_registration": false,
|
||||||
|
"design_background_color": "",
|
||||||
|
"design_primary_color": "",
|
||||||
|
"design_font": "",
|
||||||
|
"design_font_color": "",
|
||||||
|
"design_button_font_color": "",
|
||||||
|
"design_button_font_color_light": "",
|
||||||
|
"image": "",
|
||||||
|
"bcc_email_address": "demo-zfd@twingle.de",
|
||||||
|
"donation_value_min": 5,
|
||||||
|
"donation_value_max": 500,
|
||||||
|
"donation_value_default": 50,
|
||||||
|
"exclude_contact_fields": "birthday",
|
||||||
|
"custom_js": null,
|
||||||
|
"custom_css": null,
|
||||||
|
"share_url": null,
|
||||||
|
"has_contact_mandatory": false,
|
||||||
|
"has_doi": true,
|
||||||
|
"doi_redirect": null,
|
||||||
|
"has_force_donation_target_buttons": false,
|
||||||
|
"has_show_single_target": false,
|
||||||
|
"betterpayment_credit_card_theme": null,
|
||||||
|
"last_update": 1600433614,
|
||||||
|
"app_js": null,
|
||||||
|
"slidericon": "heart",
|
||||||
|
"extra_field": [],
|
||||||
|
"has_hidden_logo": false,
|
||||||
|
"has_projecttarget_as_money": false,
|
||||||
|
"rapidmail_recipient_list": null,
|
||||||
|
"mailchimp_recipient_list": null,
|
||||||
|
"has_mailchimp_add_all_user": null,
|
||||||
|
"has_mail_hide_paymentblock": false,
|
||||||
|
"has_mail_hide_paymentblock_api": false,
|
||||||
|
"has_donationtarget_textfield": false,
|
||||||
|
"has_civi_crm_activated": false,
|
||||||
|
"has_step_index": false,
|
||||||
|
"gift_donation": "",
|
||||||
|
"gift_donation_icon": null,
|
||||||
|
"gift_donation_image": null,
|
||||||
|
"languages": "de",
|
||||||
|
"has_buttons": false,
|
||||||
|
"has_no_slider": false,
|
||||||
|
"buttons": {
|
||||||
|
"button1": {
|
||||||
|
"amount": ""
|
||||||
|
},
|
||||||
|
"button2": {
|
||||||
|
"amount": ""
|
||||||
|
},
|
||||||
|
"button3": {
|
||||||
|
"amount": ""
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"has_newsletter_namerequest": false,
|
||||||
|
"has_show_donator_data": false,
|
||||||
|
"has_donation_letter": false,
|
||||||
|
"has_donation_letter_api": false,
|
||||||
|
"amount_images": []
|
||||||
|
}
|
||||||
BIN
images/screenshot.png
Normal file
BIN
images/screenshot.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 12 KiB |
30
info.xml
Normal file
30
info.xml
Normal file
|
|
@ -0,0 +1,30 @@
|
||||||
|
<?xml version="1.0"?>
|
||||||
|
<extension key="de.forumzfd.twinglecampaign" type="module">
|
||||||
|
<file>twinglecampaign</file>
|
||||||
|
<name>Twingle Campaign</name>
|
||||||
|
<description>Manage Twingle projects and events as campaigns in CiviCRM</description>
|
||||||
|
<license>AGPL-3.0</license>
|
||||||
|
<maintainer>
|
||||||
|
<author>Marc Michalsky</author>
|
||||||
|
<email>michalsky@forumzfd.de</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>2020-09-25</releaseDate>
|
||||||
|
<version>1.0</version>
|
||||||
|
<develStage>alpha</develStage>
|
||||||
|
<compatibility>
|
||||||
|
<ver>5.0</ver>
|
||||||
|
</compatibility>
|
||||||
|
<comments>This is a new, undeveloped module</comments>
|
||||||
|
<classloader>
|
||||||
|
<psr4 prefix="Civi\" path="Civi"/>
|
||||||
|
</classloader>
|
||||||
|
<civix>
|
||||||
|
<namespace>CRM/TwingleCampaign</namespace>
|
||||||
|
</civix>
|
||||||
|
</extension>
|
||||||
26
settings/twingle.setting.php
Normal file
26
settings/twingle.setting.php
Normal file
|
|
@ -0,0 +1,26 @@
|
||||||
|
<?php
|
||||||
|
|
||||||
|
return [
|
||||||
|
'twingle_api_key' => [
|
||||||
|
'name' => 'twingle_api_key',
|
||||||
|
'type' => 'String',
|
||||||
|
'default' => '',
|
||||||
|
'html_type' => 'text',
|
||||||
|
'title' => ts('Twingle API Key'),
|
||||||
|
'is_domain' => 1,
|
||||||
|
'is_contact' => 0,
|
||||||
|
'description' => ts('The key that allows you to call the Twingle API'),
|
||||||
|
`settings_pages` => ['remote' => ['weight' => 10]],
|
||||||
|
],
|
||||||
|
'twingle_request_size' => [
|
||||||
|
'name' => 'twingle_request_size',
|
||||||
|
'type' => 'Integer',
|
||||||
|
'default' => '10',
|
||||||
|
'html_type' => 'text',
|
||||||
|
'title' => ts('Twingle Request Size'),
|
||||||
|
'is_domain' => 1,
|
||||||
|
'is_contact' => 0,
|
||||||
|
'description' => ts('How many items should be requested from the Twingle API at once?'),
|
||||||
|
`settings_pages` => ['remote' => ['weight' => 11]],
|
||||||
|
]
|
||||||
|
];
|
||||||
27
templates/CRM/TwingleCampaign/Form/Settings.tpl
Normal file
27
templates/CRM/TwingleCampaign/Form/Settings.tpl
Normal file
|
|
@ -0,0 +1,27 @@
|
||||||
|
{* HEADER *}
|
||||||
|
|
||||||
|
<div class="crm-submit-buttons">
|
||||||
|
{include file="CRM/common/formButtons.tpl" location="top"}
|
||||||
|
</div>
|
||||||
|
|
||||||
|
{* FIELD EXAMPLE: OPTION 1 (AUTOMATIC LAYOUT) *}
|
||||||
|
|
||||||
|
{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}
|
||||||
|
|
||||||
|
{* 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>
|
||||||
53
tests/phpunit/api/v3/TwingleSync/GetTest.php
Normal file
53
tests/phpunit/api/v3/TwingleSync/GetTest.php
Normal file
|
|
@ -0,0 +1,53 @@
|
||||||
|
<?php
|
||||||
|
|
||||||
|
use Civi\Test\HeadlessInterface;
|
||||||
|
use Civi\Test\HookInterface;
|
||||||
|
use Civi\Test\TransactionalInterface;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* TwingleSync.Get API Test Case
|
||||||
|
* This is a generic test class implemented with PHPUnit.
|
||||||
|
* @group headless
|
||||||
|
*/
|
||||||
|
class api_v3_TwingleSync_GetTest extends \PHPUnit\Framework\TestCase implements HeadlessInterface, HookInterface, TransactionalInterface {
|
||||||
|
use \Civi\Test\Api3TestTrait;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Set up for headless tests.
|
||||||
|
*
|
||||||
|
* Civi\Test has many helpers, like install(), uninstall(), sql(), and sqlFile().
|
||||||
|
*
|
||||||
|
* See: https://docs.civicrm.org/dev/en/latest/testing/phpunit/#civitest
|
||||||
|
*/
|
||||||
|
public function setUpHeadless() {
|
||||||
|
return \Civi\Test::headless()
|
||||||
|
->installMe(__DIR__)
|
||||||
|
->apply();
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The setup() method is executed before the test is executed (optional).
|
||||||
|
*/
|
||||||
|
public function setUp() {
|
||||||
|
parent::setUp();
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The tearDown() method is executed after the test was executed (optional)
|
||||||
|
* This can be used for cleanup.
|
||||||
|
*/
|
||||||
|
public function tearDown() {
|
||||||
|
parent::tearDown();
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Simple example test case.
|
||||||
|
*
|
||||||
|
* Note how the function name begins with the word "test".
|
||||||
|
*/
|
||||||
|
public function testApiExample() {
|
||||||
|
$result = civicrm_api3('TwingleSync', 'Get', array('magicword' => 'sesame'));
|
||||||
|
$this->assertEquals('Twelve', $result['values'][12]['name']);
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
63
tests/phpunit/bootstrap.php
Normal file
63
tests/phpunit/bootstrap.php
Normal file
|
|
@ -0,0 +1,63 @@
|
||||||
|
<?php
|
||||||
|
|
||||||
|
ini_set('memory_limit', '2G');
|
||||||
|
ini_set('safe_mode', 0);
|
||||||
|
// phpcs:ignore
|
||||||
|
eval(cv('php:boot --level=classloader', 'phpcode'));
|
||||||
|
|
||||||
|
// Allow autoloading of PHPUnit helper classes in this extension.
|
||||||
|
$loader = new \Composer\Autoload\ClassLoader();
|
||||||
|
$loader->add('CRM_', __DIR__);
|
||||||
|
$loader->add('Civi\\', __DIR__);
|
||||||
|
$loader->add('api_', __DIR__);
|
||||||
|
$loader->add('api\\', __DIR__);
|
||||||
|
$loader->register();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 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");
|
||||||
|
|
||||||
|
// 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)");
|
||||||
|
}
|
||||||
|
}
|
||||||
477
twinglecampaign.civix.php
Normal file
477
twinglecampaign.civix.php
Normal file
|
|
@ -0,0 +1,477 @@
|
||||||
|
<?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_TwingleCampaign_ExtensionUtil {
|
||||||
|
const SHORT_NAME = "twinglecampaign";
|
||||||
|
const LONG_NAME = "de.forumzfd.twinglecampaign";
|
||||||
|
const CLASS_PREFIX = "CRM_TwingleCampaign";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 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_TwingleCampaign_ExtensionUtil as E;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* (Delegated) Implements hook_civicrm_config().
|
||||||
|
*
|
||||||
|
* @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config
|
||||||
|
*/
|
||||||
|
function _twinglecampaign_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 = [$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 https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_xmlMenu
|
||||||
|
*/
|
||||||
|
function _twinglecampaign_civix_civicrm_xmlMenu(&$files) {
|
||||||
|
foreach (_twinglecampaign_civix_glob(__DIR__ . '/xml/Menu/*.xml') as $file) {
|
||||||
|
$files[] = $file;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Implements hook_civicrm_install().
|
||||||
|
*
|
||||||
|
* @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install
|
||||||
|
*/
|
||||||
|
function _twinglecampaign_civix_civicrm_install() {
|
||||||
|
_twinglecampaign_civix_civicrm_config();
|
||||||
|
if ($upgrader = _twinglecampaign_civix_upgrader()) {
|
||||||
|
$upgrader->onInstall();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Implements hook_civicrm_postInstall().
|
||||||
|
*
|
||||||
|
* @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_postInstall
|
||||||
|
*/
|
||||||
|
function _twinglecampaign_civix_civicrm_postInstall() {
|
||||||
|
_twinglecampaign_civix_civicrm_config();
|
||||||
|
if ($upgrader = _twinglecampaign_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 _twinglecampaign_civix_civicrm_uninstall() {
|
||||||
|
_twinglecampaign_civix_civicrm_config();
|
||||||
|
if ($upgrader = _twinglecampaign_civix_upgrader()) {
|
||||||
|
$upgrader->onUninstall();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* (Delegated) Implements hook_civicrm_enable().
|
||||||
|
*
|
||||||
|
* @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable
|
||||||
|
*/
|
||||||
|
function _twinglecampaign_civix_civicrm_enable() {
|
||||||
|
_twinglecampaign_civix_civicrm_config();
|
||||||
|
if ($upgrader = _twinglecampaign_civix_upgrader()) {
|
||||||
|
if (is_callable([$upgrader, 'onEnable'])) {
|
||||||
|
$upgrader->onEnable();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* (Delegated) Implements hook_civicrm_disable().
|
||||||
|
*
|
||||||
|
* @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_disable
|
||||||
|
* @return mixed
|
||||||
|
*/
|
||||||
|
function _twinglecampaign_civix_civicrm_disable() {
|
||||||
|
_twinglecampaign_civix_civicrm_config();
|
||||||
|
if ($upgrader = _twinglecampaign_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 _twinglecampaign_civix_civicrm_upgrade($op, CRM_Queue_Queue $queue = NULL) {
|
||||||
|
if ($upgrader = _twinglecampaign_civix_upgrader()) {
|
||||||
|
return $upgrader->onUpgrade($op, $queue);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return CRM_TwingleCampaign_Upgrader
|
||||||
|
*/
|
||||||
|
function _twinglecampaign_civix_upgrader() {
|
||||||
|
if (!file_exists(__DIR__ . '/CRM/TwingleCampaign/Upgrader.php')) {
|
||||||
|
return NULL;
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
return CRM_TwingleCampaign_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 string $dir base dir
|
||||||
|
* @param string $pattern , glob pattern, eg "*.txt"
|
||||||
|
*
|
||||||
|
* @return array(string)
|
||||||
|
*/
|
||||||
|
function _twinglecampaign_civix_find_files($dir, $pattern) {
|
||||||
|
if (is_callable(['CRM_Utils_File', 'findFiles'])) {
|
||||||
|
return CRM_Utils_File::findFiles($dir, $pattern);
|
||||||
|
}
|
||||||
|
|
||||||
|
$todos = [$dir];
|
||||||
|
$result = [];
|
||||||
|
while (!empty($todos)) {
|
||||||
|
$subdir = array_shift($todos);
|
||||||
|
foreach (_twinglecampaign_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 https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_managed
|
||||||
|
*/
|
||||||
|
function _twinglecampaign_civix_civicrm_managed(&$entities) {
|
||||||
|
$mgdFiles = _twinglecampaign_civix_find_files(__DIR__, '*.mgd.php');
|
||||||
|
sort($mgdFiles);
|
||||||
|
foreach ($mgdFiles as $file) {
|
||||||
|
$es = include $file;
|
||||||
|
foreach ($es as $e) {
|
||||||
|
if (empty($e['module'])) {
|
||||||
|
$e['module'] = E::LONG_NAME;
|
||||||
|
}
|
||||||
|
if (empty($e['params']['version'])) {
|
||||||
|
$e['params']['version'] = '3';
|
||||||
|
}
|
||||||
|
$entities[] = $e;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* (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 https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_caseTypes
|
||||||
|
*/
|
||||||
|
function _twinglecampaign_civix_civicrm_caseTypes(&$caseTypes) {
|
||||||
|
if (!is_dir(__DIR__ . '/xml/case')) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
foreach (_twinglecampaign_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));
|
||||||
|
throw new CRM_Core_Exception($errorMessage);
|
||||||
|
}
|
||||||
|
$caseTypes[$name] = [
|
||||||
|
'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 https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_angularModules
|
||||||
|
*/
|
||||||
|
function _twinglecampaign_civix_civicrm_angularModules(&$angularModules) {
|
||||||
|
if (!is_dir(__DIR__ . '/ang')) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
$files = _twinglecampaign_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;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* (Delegated) Implements hook_civicrm_themes().
|
||||||
|
*
|
||||||
|
* Find any and return any files matching "*.theme.php"
|
||||||
|
*/
|
||||||
|
function _twinglecampaign_civix_civicrm_themes(&$themes) {
|
||||||
|
$files = _twinglecampaign_civix_glob(__DIR__ . '/*.theme.php');
|
||||||
|
foreach ($files as $file) {
|
||||||
|
$themeMeta = include $file;
|
||||||
|
if (empty($themeMeta['name'])) {
|
||||||
|
$themeMeta['name'] = preg_replace(':\.theme\.php$:', '', basename($file));
|
||||||
|
}
|
||||||
|
if (empty($themeMeta['ext'])) {
|
||||||
|
$themeMeta['ext'] = E::LONG_NAME;
|
||||||
|
}
|
||||||
|
$themes[$themeMeta['name']] = $themeMeta;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 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 _twinglecampaign_civix_glob($pattern) {
|
||||||
|
$result = glob($pattern);
|
||||||
|
return is_array($result) ? $result : [];
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 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 _twinglecampaign_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 = _twinglecampaign_civix_insert_navigation_menu($entry['child'], implode('/', $path), $item);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return $found;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* (Delegated) Implements hook_civicrm_navigationMenu().
|
||||||
|
*/
|
||||||
|
function _twinglecampaign_civix_navigationMenu(&$nodes) {
|
||||||
|
if (!is_callable(['CRM_Core_BAO_Navigation', 'fixNavigationMenu'])) {
|
||||||
|
_twinglecampaign_civix_fixNavigationMenu($nodes);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Given a navigation menu, generate navIDs for any items which are
|
||||||
|
* missing them.
|
||||||
|
*/
|
||||||
|
function _twinglecampaign_civix_fixNavigationMenu(&$nodes) {
|
||||||
|
$maxNavID = 1;
|
||||||
|
array_walk_recursive($nodes, function($item, $key) use (&$maxNavID) {
|
||||||
|
if ($key === 'navID') {
|
||||||
|
$maxNavID = max($maxNavID, $item);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
_twinglecampaign_civix_fixNavigationMenuItems($nodes, $maxNavID, NULL);
|
||||||
|
}
|
||||||
|
|
||||||
|
function _twinglecampaign_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'])) {
|
||||||
|
_twinglecampaign_civix_fixNavigationMenuItems($nodes[$origKey]['child'], $maxNavID, $nodes[$origKey]['attributes']['navID']);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* (Delegated) Implements hook_civicrm_alterSettingsFolders().
|
||||||
|
*
|
||||||
|
* @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_alterSettingsFolders
|
||||||
|
*/
|
||||||
|
function _twinglecampaign_civix_civicrm_alterSettingsFolders(&$metaDataFolders = NULL) {
|
||||||
|
$settingsDir = __DIR__ . DIRECTORY_SEPARATOR . 'settings';
|
||||||
|
if (!in_array($settingsDir, $metaDataFolders) && is_dir($settingsDir)) {
|
||||||
|
$metaDataFolders[] = $settingsDir;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* (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 _twinglecampaign_civix_civicrm_entityTypes(&$entityTypes) {
|
||||||
|
$entityTypes = array_merge($entityTypes, array (
|
||||||
|
));
|
||||||
|
}
|
||||||
170
twinglecampaign.php
Normal file
170
twinglecampaign.php
Normal file
|
|
@ -0,0 +1,170 @@
|
||||||
|
<?php
|
||||||
|
|
||||||
|
require_once 'twinglecampaign.civix.php';
|
||||||
|
use CRM_TwingleCampaign_ExtensionUtil as E;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Implements hook_civicrm_config().
|
||||||
|
*
|
||||||
|
* @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config/
|
||||||
|
*/
|
||||||
|
function twinglecampaign_civicrm_config(&$config) {
|
||||||
|
_twinglecampaign_civix_civicrm_config($config);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Implements hook_civicrm_xmlMenu().
|
||||||
|
*
|
||||||
|
* @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_xmlMenu
|
||||||
|
*/
|
||||||
|
function twinglecampaign_civicrm_xmlMenu(&$files) {
|
||||||
|
_twinglecampaign_civix_civicrm_xmlMenu($files);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Implements hook_civicrm_install().
|
||||||
|
*
|
||||||
|
* @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install
|
||||||
|
*/
|
||||||
|
function twinglecampaign_civicrm_install() {
|
||||||
|
_twinglecampaign_civix_civicrm_install();
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Implements hook_civicrm_postInstall().
|
||||||
|
*
|
||||||
|
* @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_postInstall
|
||||||
|
*/
|
||||||
|
function twinglecampaign_civicrm_postInstall() {
|
||||||
|
_twinglecampaign_civix_civicrm_postInstall();
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Implements hook_civicrm_uninstall().
|
||||||
|
*
|
||||||
|
* @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_uninstall
|
||||||
|
*/
|
||||||
|
function twinglecampaign_civicrm_uninstall() {
|
||||||
|
_twinglecampaign_civix_civicrm_uninstall();
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Implements hook_civicrm_enable().
|
||||||
|
*
|
||||||
|
* @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable
|
||||||
|
*/
|
||||||
|
function twinglecampaign_civicrm_enable() {
|
||||||
|
_twinglecampaign_civix_civicrm_enable();
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Implements hook_civicrm_disable().
|
||||||
|
*
|
||||||
|
* @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_disable
|
||||||
|
*/
|
||||||
|
function twinglecampaign_civicrm_disable() {
|
||||||
|
_twinglecampaign_civix_civicrm_disable();
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Implements hook_civicrm_upgrade().
|
||||||
|
*
|
||||||
|
* @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_upgrade
|
||||||
|
*/
|
||||||
|
function twinglecampaign_civicrm_upgrade($op, CRM_Queue_Queue $queue = NULL) {
|
||||||
|
return _twinglecampaign_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 https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_managed
|
||||||
|
*/
|
||||||
|
function twinglecampaign_civicrm_managed(&$entities) {
|
||||||
|
_twinglecampaign_civix_civicrm_managed($entities);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Implements hook_civicrm_caseTypes().
|
||||||
|
*
|
||||||
|
* Generate a list of case-types.
|
||||||
|
*
|
||||||
|
* Note: This hook only runs in CiviCRM 4.4+.
|
||||||
|
*
|
||||||
|
* @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_caseTypes
|
||||||
|
*/
|
||||||
|
function twinglecampaign_civicrm_caseTypes(&$caseTypes) {
|
||||||
|
_twinglecampaign_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 https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_angularModules
|
||||||
|
*/
|
||||||
|
function twinglecampaign_civicrm_angularModules(&$angularModules) {
|
||||||
|
_twinglecampaign_civix_civicrm_angularModules($angularModules);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Implements hook_civicrm_alterSettingsFolders().
|
||||||
|
*
|
||||||
|
* @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_alterSettingsFolders
|
||||||
|
*/
|
||||||
|
function twinglecampaign_civicrm_alterSettingsFolders(&$metaDataFolders = NULL) {
|
||||||
|
_twinglecampaign_civix_civicrm_alterSettingsFolders($metaDataFolders);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Implements hook_civicrm_entityTypes().
|
||||||
|
*
|
||||||
|
* Declare entity types provided by this module.
|
||||||
|
*
|
||||||
|
* @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_entityTypes
|
||||||
|
*/
|
||||||
|
function twinglecampaign_civicrm_entityTypes(&$entityTypes) {
|
||||||
|
_twinglecampaign_civix_civicrm_entityTypes($entityTypes);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Implements hook_civicrm_thems().
|
||||||
|
*/
|
||||||
|
function twinglecampaign_civicrm_themes(&$themes) {
|
||||||
|
_twinglecampaign_civix_civicrm_themes($themes);
|
||||||
|
}
|
||||||
|
|
||||||
|
// --- Functions below this ship commented out. Uncomment as required. ---
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Implements hook_civicrm_preProcess().
|
||||||
|
*
|
||||||
|
* @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_preProcess
|
||||||
|
*
|
||||||
|
function twinglecampaign_civicrm_preProcess($formName, &$form) {
|
||||||
|
|
||||||
|
} // */
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Implements hook_civicrm_navigationMenu().
|
||||||
|
*
|
||||||
|
* @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_navigationMenu
|
||||||
|
*
|
||||||
|
function twinglecampaign_civicrm_navigationMenu(&$menu) {
|
||||||
|
_twinglecampaign_civix_insert_navigation_menu($menu, 'Mailings', array(
|
||||||
|
'label' => E::ts('New subliminal message'),
|
||||||
|
'name' => 'mailing_subliminal_message',
|
||||||
|
'url' => 'civicrm/mailing/subliminal',
|
||||||
|
'permission' => 'access CiviMail',
|
||||||
|
'operator' => 'OR',
|
||||||
|
'separator' => 0,
|
||||||
|
));
|
||||||
|
_twinglecampaign_civix_navigationMenu($menu);
|
||||||
|
} // */
|
||||||
12
xml/Menu/twingle.xml
Normal file
12
xml/Menu/twingle.xml
Normal file
|
|
@ -0,0 +1,12 @@
|
||||||
|
<?xml version="1.0"?>
|
||||||
|
<menu>
|
||||||
|
<item>
|
||||||
|
<path>civicrm/admin/settings/twinglecampaign</path>
|
||||||
|
<page_callback>CRM_TwingleCampaign_Form_Settings</page_callback>
|
||||||
|
<title>Twingle Campaign API Configuration</title>
|
||||||
|
<access_arguments>administer CiviCRM</access_arguments>
|
||||||
|
<desc>Configure the Twingle API extension</desc>
|
||||||
|
<adminGroup>System Settings</adminGroup>
|
||||||
|
<icon>admin/option.png</icon>
|
||||||
|
</item>
|
||||||
|
</menu>
|
||||||
Loading…
Add table
Add a link
Reference in a new issue