From abd74fc77b5e48bf24908070b5c88d9f02d4422b Mon Sep 17 00:00:00 2001 From: Rich Lott / Artful Robot Date: Tue, 10 Nov 2020 17:15:36 +0000 Subject: [PATCH] initial commit --- .gitignore | 1 + CRM/Inlaypetition/Upgrader.php | 153 + CRM/Inlaypetition/Upgrader/Base.php | 396 + Civi/Inlay/Petition.php | 415 + LICENSE.txt | 667 + README.md | 43 + ang/inlaypetition.ang.php | 23 + ang/inlaypetition.css | 1 + ang/inlaypetition.js | 4 + ang/inlaypetition/Petition.html | 163 + ang/inlaypetition/Petition.js | 113 + api/v3/Job/Processpetitioninlays.mgd.php | 20 + api/v3/Job/Processpetitioninlays.php | 71 + dist/inlay-petition.js | 14895 ++++++++++++++++ info.xml | 30 + inlaypetition.civix.php | 477 + inlaypetition.php | 185 + mix-manifest.json | 3 + package-lock.json | 11293 ++++++++++++ package.json | 32 + phpunit.xml.dist | 18 + postcss.config.js | 5 + src/InlayPetition.vue | 218 + src/InlayProgress.vue | 111 + src/InlaySocials.vue | 111 + src/OmeterSosTree.vue | 121 + src/petition.js | 38 + templates/CRM/inlaypetition/Petition.hlp | 3 + .../api/v3/Job/ProcesspetitioninlaysTest.php | 53 + tests/phpunit/bootstrap.php | 63 + webpack.mix.js | 50 + 31 files changed, 29776 insertions(+) create mode 100644 .gitignore create mode 100644 CRM/Inlaypetition/Upgrader.php create mode 100644 CRM/Inlaypetition/Upgrader/Base.php create mode 100644 Civi/Inlay/Petition.php create mode 100644 LICENSE.txt create mode 100644 README.md create mode 100644 ang/inlaypetition.ang.php create mode 100644 ang/inlaypetition.css create mode 100644 ang/inlaypetition.js create mode 100644 ang/inlaypetition/Petition.html create mode 100644 ang/inlaypetition/Petition.js create mode 100644 api/v3/Job/Processpetitioninlays.mgd.php create mode 100644 api/v3/Job/Processpetitioninlays.php create mode 100644 dist/inlay-petition.js create mode 100644 info.xml create mode 100644 inlaypetition.civix.php create mode 100644 inlaypetition.php create mode 100644 mix-manifest.json create mode 100644 package-lock.json create mode 100644 package.json create mode 100644 phpunit.xml.dist create mode 100644 postcss.config.js create mode 100644 src/InlayPetition.vue create mode 100644 src/InlayProgress.vue create mode 100644 src/InlaySocials.vue create mode 100644 src/OmeterSosTree.vue create mode 100644 src/petition.js create mode 100644 templates/CRM/inlaypetition/Petition.hlp create mode 100644 tests/phpunit/api/v3/Job/ProcesspetitioninlaysTest.php create mode 100644 tests/phpunit/bootstrap.php create mode 100644 webpack.mix.js diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..3c3629e --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +node_modules diff --git a/CRM/Inlaypetition/Upgrader.php b/CRM/Inlaypetition/Upgrader.php new file mode 100644 index 0000000..aac2559 --- /dev/null +++ b/CRM/Inlaypetition/Upgrader.php @@ -0,0 +1,153 @@ +addSelect('id') + ->addWhere('option_group_id:name', '=', 'activity_type') + ->addWhere('name', '=', 'inlay_petition') + ->execute()->first()['id'] ?? 0; + + if (!$petitionActivityType) { + // Petition activity type did not exist, create it now. + \Civi\Api4\OptionValue::create(FALSE) + ->addValue('option_group_id:name', 'activity_type') + ->addValue('name', 'inlay_petition') + ->addValue('label', 'Signed Petiton (Inlay)') + ->addValue('is_active', TRUE) + ->addValue('description', 'Signed a petition provided using the Inlay framework. The subject will be the name of the petition signed.') + ->addValue('icon', 'fa-hand-rock-o') + ->execute(); + } + } + + /** + * Example: Work with entities usually not available during the install step. + * + * This method can be used for any post-install tasks. For example, if a step + * of your installation depends on accessing an entity that is itself + * created during the installation (e.g., a setting or a managed entity), do + * so here to avoid order of operation problems. + */ + // public function postInstall() { + // $customFieldId = civicrm_api3('CustomField', 'getvalue', array( + // 'return' => array("id"), + // 'name' => "customFieldCreatedViaManagedHook", + // )); + // civicrm_api3('Setting', 'create', array( + // 'myWeirdFieldSetting' => array('id' => $customFieldId, 'weirdness' => 1), + // )); + // } + + /** + * Example: Run an external SQL script when the module is uninstalled. + */ + // public function uninstall() { + // $this->executeSqlFile('sql/myuninstall.sql'); + // } + + /** + * Example: Run a simple query when a module is enabled. + */ + // public function enable() { + // CRM_Core_DAO::executeQuery('UPDATE foo SET is_active = 1 WHERE bar = "whiz"'); + // } + + /** + * Example: Run a simple query when a module is disabled. + */ + // public function disable() { + // CRM_Core_DAO::executeQuery('UPDATE foo SET is_active = 0 WHERE bar = "whiz"'); + // } + + /** + * 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; + // } + +} diff --git a/CRM/Inlaypetition/Upgrader/Base.php b/CRM/Inlaypetition/Upgrader/Base.php new file mode 100644 index 0000000..533242a --- /dev/null +++ b/CRM/Inlaypetition/Upgrader/Base.php @@ -0,0 +1,396 @@ +ctx = array_shift($args); + $instance->queue = $instance->ctx->queue; + $method = array_shift($args); + return call_user_func_array([$instance, $method], $args); + } + + /** + * CRM_Inlaypetition_Upgrader_Base constructor. + * + * @param $extensionName + * @param $extensionDir + */ + 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 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; + } + + /** + * Run the sql commands in the specified file. + * + * @param string $tplFile + * The SQL file path (relative to this extension's dir). + * Ex: "sql/mydata.mysql.tpl". + * + * @return bool + * @throws \CRM_Core_Exception + */ + 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 syntactic sugar for queueing several tasks that + * run different queries + * + * @return bool + */ + public function executeSql($query, $params = []) { + // FIXME verify that we raise an exception on error + CRM_Core_DAO::executeQuery($query, $params); + return TRUE; + } + + /** + * Syntactic 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( + [get_class($this), '_queueAdapter'], + $args, + $title + ); + return $this->queue->createItem($task, ['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. + * + * @param CRM_Queue_Queue $queue + */ + public function enqueuePendingRevisions(CRM_Queue_Queue $queue) { + $this->queue = $queue; + + $currentRevision = $this->getCurrentRevision(); + foreach ($this->getRevisions() as $revision) { + if ($revision > $currentRevision) { + $title = E::ts('Upgrade %1 to revision %2', [ + 1 => $this->extensionName, + 2 => $revision, + ]); + + // note: don't use addTask() because it sets weight=-1 + + $task = new CRM_Queue_Task( + [get_class($this), '_queueAdapter'], + ['upgrade_' . $revision], + $title + ); + $this->queue->createItem($task); + + $task = new CRM_Queue_Task( + [get_class($this), '_queueAdapter'], + ['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 = []; + + $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 = \Civi::settings()->get($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([$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([$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([$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([$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([$this, 'disable'])) { + $this->disable(); + } + } + + public function onUpgrade($op, CRM_Queue_Queue $queue = NULL) { + switch ($op) { + case 'check': + return [$this->hasPendingRevisions()]; + + case 'enqueue': + return $this->enqueuePendingRevisions($queue); + + default: + } + } + +} diff --git a/Civi/Inlay/Petition.php b/Civi/Inlay/Petition.php new file mode 100644 index 0000000..b739201 --- /dev/null +++ b/Civi/Inlay/Petition.php @@ -0,0 +1,415 @@ + '', + 'submitButtonText' => 'Sign', + 'smallprintHTML' => NULL, + //'phoneAsk' => TRUE, + 'webThanksHTML' => NULL, + 'target' => NULL, + 'socials' => ['twitter', 'facebook', 'email', 'whatsapp'], + 'tweet' => '', + 'whatsappText' => '', + ]; + + /** + * Note: because of the way CRM.url works, you MUST put a ? before the # + * + * @var string + */ + public static $editURLTemplate = 'civicrm/a?#/inlay/petition/{id}'; + + /** + * Sets the config ensuring it's valid. + * + * This implementation simply ensures all the defaults exist, and that no + * other keys exist, but you could do other things, especially if you need to + * coerce some old config into a new style. + * + * @param array $config + * + * @return \Civi\Inlay\Type (this) + */ + public function setConfig(array $config) { + $this->config = array_intersect_key($config + static::$defaultConfig, static::$defaultConfig); + } + + /** + * Generates data to be served with the Javascript application code bundle. + * + * @return array + */ + public function getInitData() { + + $data = [ + // Name of global Javascript function used to boot this app. + 'init' => 'inlayPetitionInit', + ]; + foreach (['submitButtonText', 'publicTitle', 'smallprintHTML', 'webThanksHTML', + ] as $_) { + $data[$_] = $this->config[$_] ?? ''; + } + + // Nb. same logic as SignupA + $data['socials'] = []; + foreach ($this->config['socials'] as $social) { + $_ = ['name' => $social]; + if ($social === 'twitter') { + $_['tweet'] = $this->config['tweet']; + } + elseif ($social === 'whatsapp') { + $_['whatsappText'] = $this->config['whatsappText']; + } + $data['socials'][] = $_; + } + + // Count people signed up... + $subject = $this->getName(); + $activityTypeID = $this->getActivityTypeID(); + + $data['count'] = (int) \CRM_Core_DAO::singleValueQuery(" + SELECT COUNT(*) + FROM civicrm_activity a + INNER JOIN civicrm_activity_contact ac ON a.id = ac.activity_id AND ac.record_type_id = 3 /*target*/ + INNER JOIN civicrm_contact c ON ac.contact_id = c.id AND c.is_deleted = 0 + WHERE a.activity_type_id = %1 AND a.subject = %2 + ", [ + 1 => [$activityTypeID, 'Integer'], + 2 => [$subject, 'String'], + ]); + Civi::log()->info("Count is $data[count] for petition inlay $subject"); + + return $data; + } + + /** + * Find our activity type + * + * @todo optimise this, it's probly slow. + */ + public static function getActivityTypeID() { + if (!static::$petitionActivityType) { + // Look it up. + static::$petitionActivityType = OptionValue::get(FALSE) + ->addSelect('value') + ->addWhere('option_group_id:name', '=', 'activity_type') + ->addWhere('name', '=', 'inlay_petition') + ->execute()->first()['value'] ?? 0; + } + return static::$petitionActivityType; + } + + /** + * Process a request + * + * Request data is just key, value pairs from the form data. If it does not + * have 'token' field then a token is generated and returned. Otherwise the + * token is checked and processing continues. + * + * @param \Civi\Inlay\Request $request + * @return array + * + * @throws \Civi\Inlay\ApiException; + */ + public function processRequest(ApiRequest $request) { + + $data = $this->cleanupInput($request->getBody()); + + if (empty($data['token'])) { + // Unsigned request. Issue a token that will be valid in 5s time and lasts 2mins max. + return ['token' => $this->getCSRFToken(['data' => $data, 'validFrom' => 5, 'validTo' => 120])]; + } + + // Defer processing the data to a queue. This speeds things up for the user + // and avoids database deadlocks. + $queue = static::getQueueService(); + + // We have context that is not stored in $data, namely which Inlay Instance we are. + // Store that now. + $data['inlayID'] = $this->getID(); + + $queue->createItem(new CRM_Queue_Task( + ['Civi\\Inlay\\Petition', 'processQueueItem'], // callback + [$data], // arguments + "" // title + )); + + // Optimistically return! + return ['success' =>1]; + } + + /** + * @return CRM_Queue_Service + */ + public static function getQueueService() { + return CRM_Queue_Service::singleton()->create([ + 'type' => 'Sql', + 'name' => 'inlay-petition', + 'reset' => FALSE, // We do NOT want to delete an existing queue! + ]); + } + /** + * Process a queued submission. + * + * This is the callback for the queue runner. + * + * Nb. the data has already been validated. + * + * @param mixed? + * @param array + * + * @return bool TRUE if it went ok, FALSE will prevent further processing of the queue. + */ + public static function processQueueItem($queueTaskContext, $data) { + + // Get instance ID. + $id = (int) $data['inlayID']; + + // Get the Inlay Object from database if we don't have it cached. + if (($id > 0) && !isset(static::$instanceCache[$id])) { + $inlayData = \Civi\Api4\Inlay::get(FALSE) + ->setCheckPermissions(FALSE) + ->addWhere('id', '=', (int) $data['inlayID']) + ->execute()->first(); + $inlay = new static(); + $inlay->loadFromArray($inlayData); + // Store on cache. + static::$instanceCache[$id] = $inlay; + } + + // Error if we couldn't find it. + if (empty(static::$instanceCache[$id])) { + throw new \RuntimeException("Invalid Inlay/Petition queue item, failed to load instance."); + } + + // Finally, use it to process the data. + $error = $inlay->processDeferredSubmission($data); + if ($error) { + // ?? How to handle errors. + // @todo + } + + // Move on to next item in queue. + return TRUE; + } + /** + * Process a queued submission. + * + * This is where the bulk of the work is done. + * + * @var array $data + */ + public function processDeferredSubmission($data) { + + // Find Contact with XCM. + $params = $data + ['contact_type' => 'Individual']; + $contactID = civicrm_api3('Contact', 'getorcreate', $params)['id'] ?? NULL; + if (!$contactID) { + Civi::log()->error('Failed to getorcreate contact with params: ' . json_encode($params)); + throw new \Civi\Inlay\ApiException(500, ['error' => 'Server error: XCM1']); + } + + // Write an activity + if (!$this->contactAlreadySigned($contactID)) { + // Not signed yet. + $this->addSignedPetitionActivity($contactID, $data); + } + + // No error + return ''; + } + + /** + * Has the given contact signed this petition already? + * + * @var int $contactID + * + * @return bool + */ + public function contactAlreadySigned($contactID) { + + $subject = $this->getName(); + $activityTypeID = $this->getActivityTypeID(); + + $found = (bool) \CRM_Core_DAO::singleValueQuery(" + SELECT a.id + FROM civicrm_activity a + INNER JOIN civicrm_activity_contact ac + ON a.id = ac.activity_id + AND ac.record_type_id = 3 /*target*/ + AND ac.contact_id = %1 + WHERE a.activity_type_id = %2 AND a.subject = %3 + LIMIT 1 + ", [ + 1 => [$contactID, 'Integer'], + 2 => [$activityTypeID, 'Integer'], + 3 => [$subject, 'String'], + ]); + + return $found; + } + /** + * @var int $contactID + * @var array $data + */ + public function addSignedPetitionActivity($contactID, $data) { + $activityCreateParams = [ + 'activity_type_id' => $this->getActivityTypeID(), + 'target_id' => $contactID, + 'subject' => $this->getName(), + 'status_id' => 'Completed', + 'source_contact_id' => $contactID, + // 'source_contact_id' => \CRM_Core_BAO_Domain::getDomain()->contact_id, + // 'details' => $details, + ]; + $result = civicrm_api3('Activity', 'create', $activityCreateParams); + + return $result; + } + /** + * Validate and clean up input data. + * + * Possible outputs: + * - first_name + * - last_name + * - email + * - token TRUE|unset + * + * @param array $data + * + * @return array + */ + public function cleanupInput($data) { + /** @var Array errors in this array, it will later be converted to a string. */ + $errors = []; + /** @var Array Collect validated data in this array */ + $valid = []; + + // Check we have what we need. + foreach (['first_name', 'last_name', 'email'] as $field) { + $val = trim($data[$field] ?? ''); + if (empty($val)) { + $errors[] = str_replace('_', ' ', $field) . " required."; + } + else { + if ($field === 'email' && !filter_var($val, FILTER_VALIDATE_EMAIL)) { + $errors[] = "invalid email address"; + } + else { + $valid[$field] = $val; + } + } + } + if ($errors) { + throw new \Civi\Inlay\ApiException(400, ['error' => implode(', ', $errors)]); + } + + // Data is valid. + if (!empty($data['token'])) { + // There is a token, check that now. + try { + $this->checkCSRFToken($data['token'], $valid); + $valid['token'] = TRUE; + } + catch (\InvalidArgumentException $e) { + // Token failed. Issue a public friendly message, though this should + // never be seen by anyone legit. + Civi::log()->notice("Token error: " . $e->getMessage . "\n" . $e->getTraceAsString()); + throw new \Civi\Inlay\ApiException(400, + ['error' => "Mysterious problem, sorry! Code " . substr($e->getMessage(), 0, 3)]); + } + + // Validation that is more expensive, and for fields where invalid data + // would likely represent misuse of the form is done now - after the + // token check, to avoid wasting server resources on spammers trying to + // randomly post to the endpoint. + + /* + if ($this->config['phoneAsk'] && !empty($data['phone'])) { + // Check the phone. + $valid['phone'] = preg_replace('/[^0-9+]/', '', $data['phone']); + } + */ + } + + + return $valid; + } + + /** + * Returns a URL to a page that lets an admin user configure this Inlay. + * + * @return string URL + */ + public function getAdminURL() { + + } + + /** + * Get the Javascript app script. + * + * This will be bundled with getInitData() and some other helpers into a file + * that will be sourced by the client website. + * + * @return string Content of a Javascript file. + */ + public function getExternalScript() { + return file_get_contents(E::path('dist/inlay-petition.js')); + } + + + /** + * Custom function to get unis. + * + * @return array contact ID => university name + */ + public function getUnis($checkID=NULL) { + $unis = []; + + $api = \Civi\Api4\Contact::get(FALSE) + ->addSelect('legal_name', 'id') + ->addWhere('contact_type', '=', 'Organization') + ->addWhere('contact_sub_type', 'IN', ['ACIHECollege', 'ACIUniversity']) + ->addWhere('is_deleted', '=', FALSE) + ; + if ($checkID) { + $api->addWhere('id', '=', $checkID); + } + $result = $api + ->addOrderBy('legal_name', 'ASC') + ->execute(); + + foreach ($result as $uni) { + $unis[] = ['id' => $uni['id'], 'name' => $uni['legal_name']]; + } + + return $unis; + } +} + diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..4654840 --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,667 @@ +Package: inlaypetition +Copyright (C) 2020, Rich Lott / Artful Robot +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. + 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. + + + Copyright (C) + + 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 . + +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 +. diff --git a/README.md b/README.md new file mode 100644 index 0000000..33e4005 --- /dev/null +++ b/README.md @@ -0,0 +1,43 @@ +# Petition "Inlay" for adding petitions to remote websites + +Add high performance petitions, configured in CiviCRM, to your separate public website. + +- Please see [Inlay](https://lab.civicrm.org/extensions/inlay) for an introduction to the technology this is based on. + +- Note this is currently fairly generic, but I reserve the right to bend it to my client's wishes at any point. *Inlay* provides a way to develop customised remote forms; this is one example of its use. + +The extension is licensed under [AGPL-3.0](LICENSE.txt). + +## Requirements + +* PHP v7.3+ +* CiviCRM 5.31+ + +## Installation (Web UI) + +Learn more about installing CiviCRM extensions in the [CiviCRM Sysadmin Guide](https://docs.civicrm.org/sysadmin/en/latest/customize/extensions/). + +## Installation (CLI, Zip) + +Sysadmins and developers may download the `.zip` file for this extension and +install it with the command-line tool [cv](https://github.com/civicrm/cv). + +```bash +cd +cv dl inlaypetition@https://github.com/FIXME/inlaypetition/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/inlaypetition.git +cv en inlaypetition +``` + +## Getting Started + +Once intstalled, visit **Administer » Inlays** and create a Petition Inlay. + diff --git a/ang/inlaypetition.ang.php b/ang/inlaypetition.ang.php new file mode 100644 index 0000000..4b95472 --- /dev/null +++ b/ang/inlaypetition.ang.php @@ -0,0 +1,23 @@ + [ + 'ang/inlaypetition.js', + 'ang/inlaypetition/*.js', + 'ang/inlaypetition/*/*.js', + ], + 'css' => [ + 'ang/inlaypetition.css', + ], + 'partials' => [ + 'ang/inlaypetition', + ], + 'requires' => [ + 'crmUi', + 'crmUtil', + 'ngRoute', + ], + 'settings' => [], +]; diff --git a/ang/inlaypetition.css b/ang/inlaypetition.css new file mode 100644 index 0000000..4064baa --- /dev/null +++ b/ang/inlaypetition.css @@ -0,0 +1 @@ +/* Add any CSS rules for Angular module "inlaypetition" */ diff --git a/ang/inlaypetition.js b/ang/inlaypetition.js new file mode 100644 index 0000000..6270c9c --- /dev/null +++ b/ang/inlaypetition.js @@ -0,0 +1,4 @@ +(function(angular, $, _) { + // Declare a list of dependencies. + angular.module('inlaypetition', CRM.angRequires('inlaypetition')); +})(angular, CRM.$, CRM._); diff --git a/ang/inlaypetition/Petition.html b/ang/inlaypetition/Petition.html new file mode 100644 index 0000000..f12ba54 --- /dev/null +++ b/ang/inlaypetition/Petition.html @@ -0,0 +1,163 @@ +
+

{{ ts('Edit %1', {1: inlayType.name })}}

+ +
+ +
+ +
+ +
+ +
+ + + +
+ +
+ +
+ +
+ +
+ +
+ +
+ +
+ +

Social Media

+ + +
+ +
+ +
+ +
+ + + + + + + + +
+ +
+ +
+
diff --git a/ang/inlaypetition/Petition.js b/ang/inlaypetition/Petition.js new file mode 100644 index 0000000..aa7fc7a --- /dev/null +++ b/ang/inlaypetition/Petition.js @@ -0,0 +1,113 @@ +(function(angular, $, _) { + + angular.module('inlaypetition').config(function($routeProvider) { + $routeProvider.when('/inlay/petition/:id', { + controller: 'InlaypetitionPetition', + controllerAs: '$ctrl', + templateUrl: '~/inlaypetition/Petition.html', + + // If you need to look up data when opening the page, list it out + // under "resolve". + resolve: { + various: function($route, crmApi4, $route) { + const params = { + inlayTypes: ['InlayType', 'get', {}, 'class'], + groups: ['Group', 'get', { + select: ["id", "title"], + where: [["group_type", "=", 2], ["is_active", "=", true], ["is_hidden", "=", false]], + orderBy: {"title":"ASC"} + }], + messageTpls: [ 'MessageTemplate', 'get', { + select: ["id", "msg_title", "msg_subject"], + where: [ + ["is_active", "=", true], ["is_sms", "=", false], + ["workflow_id", "IS NULL"] + ], + orderBy: {msg_title: 'ASC'}}, + 'id'] + }; + if ($route.current.params.id > 0) { + params.inlay = ['Inlay', 'get', {where: [["id", "=", $route.current.params.id]]}, 0]; + } + return crmApi4(params); + }, + } + }); + } + ); + + // The controller uses *injection*. This default injects a few things: + // $scope -- This is the set of variables shared between JS and HTML. + // crmApi, crmStatus, crmUiHelp -- These are services provided by civicrm-core. + angular.module('inlaypetition').controller('InlaypetitionPetition', function($scope, crmApi4, crmStatus, crmUiHelp, various) { + // The ts() and hs() functions help load strings for this module. + var ts = $scope.ts = CRM.ts('inlaypetition'); + var hs = $scope.hs = crmUiHelp({file: 'CRM/inlaypetition/Petition'}); // See: templates/CRM/inlaypetition/Petition.hlp + // Local variable for this controller (needed when inside a callback fn where `this` is not available). + var ctrl = this; + + $scope.mailingGroups = various.groups; + $scope.inlayType = various.inlayTypes['Civi\\Inlay\\Petition']; + console.log({various}, $scope.inlayType); + $scope.mailingGroups = various.groups; + $scope.messageTpls = various.messageTpls; + + if (various.inlay) { + $scope.inlay = various.inlay; + } + else { + $scope.inlay = { + 'class' : 'Civi\\Inlay\\Petition', + name: 'New ' + $scope.inlayType.name, + public_id: 'new', + id: 0, + config: JSON.parse(JSON.stringify($scope.inlayType.defaultConfig)), + }; + } + const inlay = $scope.inlay; + + // Define all the networks we support here. + const knownSocials = { + twitter: 'Twitter', + facebook: 'Facebook', + whatsapp: 'WhatsApp', + email: 'Email', + }; + $scope.smShares = []; + inlay.config.socials.forEach(sm => { + $scope.smShares.push({active: true, name: sm, label: knownSocials[sm]}); + delete knownSocials[sm]; + }); + Object.keys(knownSocials).forEach(sm => { + $scope.smShares.push({active: false, name: sm, label: knownSocials[sm]}); + }); + + $scope.smActive = function(sm) { + return $scope.smShares.find(x => x.name === sm).active; + }; + + $scope.save = function() { + + // Re-form the socials part of inlay. + inlay.config.socials = []; + $scope.smShares.forEach(sm => { + if (sm.active) { + inlay.config.socials.push(sm.name); + } + }); + console.log("Saving " + JSON.stringify(inlay)); + + return crmStatus( + // Status messages. For defaults, just use "{}" + {start: ts('Saving...'), success: ts('Saved')}, + // The save action. Note that crmApi() returns a promise. + crmApi4('Inlay', 'save', { records: [inlay] }) + ).then(r => { + console.log("save result", r); + window.location = CRM.url('civicrm/a?#inlays'); + }); + }; + + }); + +})(angular, CRM.$, CRM._); diff --git a/api/v3/Job/Processpetitioninlays.mgd.php b/api/v3/Job/Processpetitioninlays.mgd.php new file mode 100644 index 0000000..f1a2746 --- /dev/null +++ b/api/v3/Job/Processpetitioninlays.mgd.php @@ -0,0 +1,20 @@ + 'CronProcesspetitioninlays', + 'entity' => 'Job', + 'params' => [ + 'version' => 3, + 'name' => 'Call Job.Processpetitioninlays API', + 'description' => 'Process the queue of petition submissions', + 'run_frequency' => 'Always', + 'api_entity' => 'Job', + 'api_action' => 'Processpetitioninlays', + 'parameters' => '', + ], + ], +]; diff --git a/api/v3/Job/Processpetitioninlays.php b/api/v3/Job/Processpetitioninlays.php new file mode 100644 index 0000000..f947f57 --- /dev/null +++ b/api/v3/Job/Processpetitioninlays.php @@ -0,0 +1,71 @@ + ts('Process petition signatures'), + 'queue' => $queue, + //'errorMode' => CRM_Queue_Runner::ERROR_CONTINUE, + //'onEnd' => callback + //'onEndUrl' => CRM_Utils_System::url('civicrm/demo-queue/done'), + ]); + + $processed = 0; + do { + $result = $runner->runNext(false); + if ($result['is_error']) { + $message = isset($result['exception']) ? $result['exception']->getMessage() : 'Unknown non-exception error'; + if ($message === 'Failed to claim next task') { + // Queue empty, or another process busy. + // This is not an error to us, we just need to stop. + break; + } + else { + // Some other exception. + throw new API_Exception($message); + } + } + + $processed++; + + if (!$result['is_continue']) { + break; //all items in the queue are processed, or one failed. + } + } while (!$stopAt || time() < $stopAt); + + return civicrm_api3_create_success(['processed' => $processed], $params, 'Job', 'Processpetitioninlays'); +} diff --git a/dist/inlay-petition.js b/dist/inlay-petition.js new file mode 100644 index 0000000..682c372 --- /dev/null +++ b/dist/inlay-petition.js @@ -0,0 +1,14895 @@ +/******/ (function(modules) { // webpackBootstrap +/******/ // The module cache +/******/ var installedModules = {}; +/******/ +/******/ // The require function +/******/ function __webpack_require__(moduleId) { +/******/ +/******/ // Check if module is in cache +/******/ if(installedModules[moduleId]) { +/******/ return installedModules[moduleId].exports; +/******/ } +/******/ // Create a new module (and put it into the cache) +/******/ var module = installedModules[moduleId] = { +/******/ i: moduleId, +/******/ l: false, +/******/ exports: {} +/******/ }; +/******/ +/******/ // Execute the module function +/******/ modules[moduleId].call(module.exports, module, module.exports, __webpack_require__); +/******/ +/******/ // Flag the module as loaded +/******/ module.l = true; +/******/ +/******/ // Return the exports of the module +/******/ return module.exports; +/******/ } +/******/ +/******/ +/******/ // expose the modules object (__webpack_modules__) +/******/ __webpack_require__.m = modules; +/******/ +/******/ // expose the module cache +/******/ __webpack_require__.c = installedModules; +/******/ +/******/ // define getter function for harmony exports +/******/ __webpack_require__.d = function(exports, name, getter) { +/******/ if(!__webpack_require__.o(exports, name)) { +/******/ Object.defineProperty(exports, name, { enumerable: true, get: getter }); +/******/ } +/******/ }; +/******/ +/******/ // define __esModule on exports +/******/ __webpack_require__.r = function(exports) { +/******/ if(typeof Symbol !== 'undefined' && Symbol.toStringTag) { +/******/ Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' }); +/******/ } +/******/ Object.defineProperty(exports, '__esModule', { value: true }); +/******/ }; +/******/ +/******/ // create a fake namespace object +/******/ // mode & 1: value is a module id, require it +/******/ // mode & 2: merge all properties of value into the ns +/******/ // mode & 4: return value when already ns object +/******/ // mode & 8|1: behave like require +/******/ __webpack_require__.t = function(value, mode) { +/******/ if(mode & 1) value = __webpack_require__(value); +/******/ if(mode & 8) return value; +/******/ if((mode & 4) && typeof value === 'object' && value && value.__esModule) return value; +/******/ var ns = Object.create(null); +/******/ __webpack_require__.r(ns); +/******/ Object.defineProperty(ns, 'default', { enumerable: true, value: value }); +/******/ if(mode & 2 && typeof value != 'string') for(var key in value) __webpack_require__.d(ns, key, function(key) { return value[key]; }.bind(null, key)); +/******/ return ns; +/******/ }; +/******/ +/******/ // getDefaultExport function for compatibility with non-harmony modules +/******/ __webpack_require__.n = function(module) { +/******/ var getter = module && module.__esModule ? +/******/ function getDefault() { return module['default']; } : +/******/ function getModuleExports() { return module; }; +/******/ __webpack_require__.d(getter, 'a', getter); +/******/ return getter; +/******/ }; +/******/ +/******/ // Object.prototype.hasOwnProperty.call +/******/ __webpack_require__.o = function(object, property) { return Object.prototype.hasOwnProperty.call(object, property); }; +/******/ +/******/ // __webpack_public_path__ +/******/ __webpack_require__.p = "/"; +/******/ +/******/ +/******/ // Load entry module and return exports +/******/ return __webpack_require__(__webpack_require__.s = 0); +/******/ }) +/************************************************************************/ +/******/ ({ + +/***/ "./node_modules/babel-loader/lib/index.js?!./node_modules/vue-loader/lib/index.js?!./src/InlayPetition.vue?vue&type=script&lang=js&": +/*!****************************************************************************************************************************************************!*\ + !*** ./node_modules/babel-loader/lib??ref--4-0!./node_modules/vue-loader/lib??vue-loader-options!./src/InlayPetition.vue?vue&type=script&lang=js& ***! + \****************************************************************************************************************************************************/ +/*! exports provided: default */ +/***/ (function(module, __webpack_exports__, __webpack_require__) { + +"use strict"; +__webpack_require__.r(__webpack_exports__); +/* harmony import */ var _InlayProgress_vue__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(/*! ./InlayProgress.vue */ "./src/InlayProgress.vue"); +/* harmony import */ var _InlaySocials_vue__WEBPACK_IMPORTED_MODULE_1__ = __webpack_require__(/*! ./InlaySocials.vue */ "./src/InlaySocials.vue"); +/* harmony import */ var _OmeterSosTree_vue__WEBPACK_IMPORTED_MODULE_2__ = __webpack_require__(/*! ./OmeterSosTree.vue */ "./src/OmeterSosTree.vue"); +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// + + + // import 'vue-select/dist/vue-select.css'; +// import vSelect from 'vue-select'; + +/* harmony default export */ __webpack_exports__["default"] = ({ + props: ['inlay'], + components: { + InlayProgress: _InlayProgress_vue__WEBPACK_IMPORTED_MODULE_0__["default"], + InlaySocials: _InlaySocials_vue__WEBPACK_IMPORTED_MODULE_1__["default"], + OmeterSosTree: _OmeterSosTree_vue__WEBPACK_IMPORTED_MODULE_2__["default"] + }, + data: function data() { + var d = { + stage: 'form', + myId: this.$root.getNextId(), + first_name: '', + last_name: '', + email: '', + phone: '' + }; + return d; + }, + computed: { + target: function target() { + // always at 70% + return Math.floor(this.inlay.initData.count / 0.7 / 1000) * 1000 + 1000; + }, + countSigners: function countSigners() { + return this.inlay.initData.count + (this.stage === 'thanks' ? 1 : 0); + } + }, + methods: { + wantsToSubmit: function wantsToSubmit() {// validate all fields. + }, + submitForm: function submitForm() { + var _this = this; + + // Form is valid according to browser. + this.$root.submissionRunning = true; + var d = { + first_name: this.first_name, + last_name: this.last_name, + email: this.email, + phone: this.phone + }; + var progress = this.$refs.progress; // Allow 5s to get 20% through in first submit. + + progress.startTimer(5, 20, { + reset: 1 + }); + this.inlay.request({ + method: 'post', + body: d + }).then(function (r) { + if (r.token) { + d.token = r.token; // Allow 5s for our wait, taking us to 80% linearly. + + progress.startTimer(5, 80, { + easing: false + }); // Force 5s wait for the token to become valid + + return new Promise(function (resolve, reject) { + window.setTimeout(resolve, 5000); + }); + } else { + console.warn("unexpected resonse", r); + throw r.error || 'Unknown error'; + } + }).then(function () { + // Finally allow 5s for the final submission to 100% + progress.startTimer(5, 100); + return _this.inlay.request({ + method: 'post', + body: d + }); + }).then(function (r) { + if (r.error) { + throw r.error; + } + + _this.stage = 'thanks'; + progress.cancelTimer(); + })["catch"](function (e) { + console.error(e); + + if (typeof e === 'String') { + alert(e); + } else { + alert("Unexpected error"); + } + + _this.$root.submissionRunning = false; + progress.cancelTimer(); + }); + } + } +}); + +/***/ }), + +/***/ "./node_modules/babel-loader/lib/index.js?!./node_modules/vue-loader/lib/index.js?!./src/InlayProgress.vue?vue&type=script&lang=js&": +/*!****************************************************************************************************************************************************!*\ + !*** ./node_modules/babel-loader/lib??ref--4-0!./node_modules/vue-loader/lib??vue-loader-options!./src/InlayProgress.vue?vue&type=script&lang=js& ***! + \****************************************************************************************************************************************************/ +/*! exports provided: default */ +/***/ (function(module, __webpack_exports__, __webpack_require__) { + +"use strict"; +__webpack_require__.r(__webpack_exports__); +// +// +// +// +// +/* harmony default export */ __webpack_exports__["default"] = ({ + data: function data() { + return { + doneBefore: 0, + percentDoneAtEndOfJob: 100, + expectedTime: null, + percent: 0, + start: null, + running: false, + easing: true + }; + }, + props: { + color: { + "default": '#46a' + }, + backgroundColor: { + "default": '#eee' + } + }, + mounted: function mounted() {// console.log('progress colour' , this.color); + }, + methods: { + startTimer: function startTimer(expectedTime, percentDoneAtEndOfJob, opts) { + expectedTime = expectedTime * 1000; + opts = Object.assign({ + reset: false, + easing: true + }, opts || {}); + + if (opts.reset) { + this.doneBefore = 0; + this.percentDoneAtEndOfJob = percentDoneAtEndOfJob; + this.expectedTime = expectedTime; + this.percent = 0; + this.start = null; + this.running = false; + } else { + // Adding a job. + this.doneBefore = this.percent; + this.start = null; + this.expectedTime = expectedTime; + this.percentDoneAtEndOfJob = percentDoneAtEndOfJob; + } // Always default to using easing. + + + this.easing = opts.easing; + + if (!this.running) { + // Start animation. + this.running = true; + window.requestAnimationFrame(this.animateTimer.bind(this)); + } + }, + cancelTimer: function cancelTimer() { + this.start = null; + this.running = false; + }, + animateTimer: function animateTimer(t) { + if (!this.start) { + this.start = t; + } + + var linear = Math.min(1, (t - this.start) / this.expectedTime); + var fraction = linear; + + if (this.easing) { + // This is more performant than Math.pow((1-fraction), 3) + fraction = 1 - (1 - fraction) * (1 - fraction) * (1 - fraction); + } + + this.percent = this.doneBefore + fraction * (this.percentDoneAtEndOfJob - this.doneBefore); + + if (this.running) { + if (linear < 1) { + // We still have stuff to animate. + window.requestAnimationFrame(this.animateTimer.bind(this)); + } + } else { + this.running = false; + } + } + }, + computed: { + barStyle: function barStyle() { + return { + backgroundColor: this.running ? this.color : 'transparent', + width: this.percent + '%' + }; + }, + containerStyle: function containerStyle() { + return { + backgroundColor: this.running ? this.backgroundColor : 'transparent' + }; + } + } +}); + +/***/ }), + +/***/ "./node_modules/babel-loader/lib/index.js?!./node_modules/vue-loader/lib/index.js?!./src/InlaySocials.vue?vue&type=script&lang=js&": +/*!***************************************************************************************************************************************************!*\ + !*** ./node_modules/babel-loader/lib??ref--4-0!./node_modules/vue-loader/lib??vue-loader-options!./src/InlaySocials.vue?vue&type=script&lang=js& ***! + \***************************************************************************************************************************************************/ +/*! exports provided: default */ +/***/ (function(module, __webpack_exports__, __webpack_require__) { + +"use strict"; +__webpack_require__.r(__webpack_exports__); +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +// +/* harmony default export */ __webpack_exports__["default"] = ({ + props: ['socials', 'icons'], + data: function data() { + var _url = window.location.href; + var urlEncoded = encodeURIComponent(window.location.href); + var treatments = { + twitter: { + label: 'Twitter', + url: function url(sn) { + return "https://twitter.com/intent/tweet/?text=".concat(encodeURIComponent(sn.tweet), "&url=").concat(urlEncoded); + } + }, + facebook: { + label: 'Facebook', + url: function url(sn) { + return "https://facebook.com/sharer/sharer.php?u=".concat(urlEncoded); + } + }, + whatsapp: { + label: 'WhatsApp', + url: function url(sn) { + return "whatsapp://send?text=".concat(encodeURIComponent(sn.whatsappText + ' ' + _url)); + } + }, + email: { + label: 'Email', + url: function url(sn) { + return "mailto:?subject=".concat(encodeURIComponent(sn.subject), "&body=").concat(urlEncoded); + } + }, + linkedin: { + label: 'Linked In', + url: function url(sn) { + return "https://www.linkedin.com/shareArticle?mini=true&url=".concat(urlEncoded, "&title=").concat(encodeURIComponent(sn.linkedInText), "&summary=").concat(encodeURIComponent(sn.linkedInText), "&source=").concat(urlEncoded); + } + } + }; + var buttons = this.socials.map(function (sn) { + var s = { + name: sn.name + }; + + if (!(sn.name in treatments)) { + console.warn("".concat(sn.name, " not found in treatments:"), treatments); + return; + } + + s.url = treatments[sn.name].url(sn); + s.label = treatments[sn.name].label; + return s; + }); + console.log("data returning ", { + buttons: buttons + }); + return { + buttons: buttons + }; + } +}); + +/***/ }), + +/***/ "./node_modules/babel-loader/lib/index.js?!./node_modules/vue-loader/lib/index.js?!./src/OmeterSosTree.vue?vue&type=script&lang=js&": +/*!****************************************************************************************************************************************************!*\ + !*** ./node_modules/babel-loader/lib??ref--4-0!./node_modules/vue-loader/lib??vue-loader-options!./src/OmeterSosTree.vue?vue&type=script&lang=js& ***! + \****************************************************************************************************************************************************/ +/*! exports provided: default */ +/***/ (function(module, __webpack_exports__, __webpack_require__) { + +"use strict"; +__webpack_require__.r(__webpack_exports__); +// +// +// +// +// +// +// +// +// +// +// +// +// +/* harmony default export */ __webpack_exports__["default"] = ({ + props: ['count', 'stmt', 'target'], + data: function data() { + return { + treeAnim: 0, + animStart: false, + step: 0, + containerSize: false, + debounce: false + }; + }, + computed: { + trees: function trees() { + var max = this.containerSize; + var greenTo = parseInt(this.step * max * 0.7); + var t = []; + + for (var i = 0; i < max; i++) { + t.push(i > greenTo ? 'faded' : ''); + } + + return t; + } + }, + mounted: function mounted() { + var _this = this; + + this.handleWindowResize(); + window.addEventListener('resize', function (e) { + if (_this.debounce) { + window.clearTimeout(_this.debounce); + } + + _this.debounce = window.setTimeout(_this.handleWindowResize.bind(_this), 300); + }); + var observer = new IntersectionObserver(this.handleIntersectionChange.bind(this), { + // root: this.$refs.treesContainer, + // rootMargin: '0px', + threshold: 1.0 + }); + observer.observe(this.$refs.treesContainer); + }, + methods: { + handleIntersectionChange: function handleIntersectionChange(entries, observer) { + var _this2 = this; + + console.log("handleIntersectionChange"); + entries.forEach(function (e) { + if (e.isIntersecting) { + _this2.animStart = false; + window.requestAnimationFrame(_this2.animate.bind(_this2)); + } + }); + }, + handleWindowResize: function handleWindowResize(e) { + this.debounce = false; // Allow 1.5rem for a tree + + this.containerSize = Math.floor(this.$refs.treesContainer.clientWidth / this.convertRemToPixels(1.5)); + }, + convertRemToPixels: function convertRemToPixels(rem) { + return rem * parseFloat(getComputedStyle(document.documentElement).fontSize); + }, + animate: function animate(t) { + if (!this.animStart) { + this.animStart = t; + } // Allow 1 s for the animation. + + + this.step = Math.min(1, (t - this.animStart) / 1000); + + if (this.step < 1) { + window.requestAnimationFrame(this.animate.bind(this)); + } + } + } +}); + +/***/ }), + +/***/ "./node_modules/css-loader/index.js!./node_modules/vue-loader/lib/loaders/stylePostLoader.js!./node_modules/postcss-loader/src/index.js?!./node_modules/sass-loader/dist/cjs.js?!./node_modules/vue-loader/lib/index.js?!./src/InlayPetition.vue?vue&type=style&index=0&lang=scss&": +/*!***************************************************************************************************************************************************************************************************************************************************************************************************!*\ + !*** ./node_modules/css-loader!./node_modules/vue-loader/lib/loaders/stylePostLoader.js!./node_modules/postcss-loader/src??ref--6-2!./node_modules/sass-loader/dist/cjs.js??ref--6-3!./node_modules/vue-loader/lib??vue-loader-options!./src/InlayPetition.vue?vue&type=style&index=0&lang=scss& ***! + \***************************************************************************************************************************************************************************************************************************************************************************************************/ +/*! no static exports found */ +/***/ (function(module, exports, __webpack_require__) { + +exports = module.exports = __webpack_require__(/*! ../node_modules/css-loader/lib/css-base.js */ "./node_modules/css-loader/lib/css-base.js")(false); +// imports + + +// module +exports.push([module.i, ".inlay-petition .ipet-2-cols {\n margin-left: -1rem;\n margin-right: -1rem;\n display: flex;\n flex-wrap: wrap;\n}\n.inlay-petition .ipet-2-cols > div {\n flex: 1 0 18rem;\n padding: 0 1rem;\n}\n.inlay-petition .ipet-input-wrapper {\n margin-bottom: 1rem;\n}\n.inlay-petition input[type=\"text\"],\n.inlay-petition input[type=\"email\"],\n.inlay-petition label {\n padding: 0.75rem 1rem;\n line-height: 1;\n margin: 0;\n font-size: 1.1rem;\n}\n.inlay-petition label {\n display: block;\n}\n.inlay-petition input[type=\"text\"],\n.inlay-petition input[type=\"email\"] {\n background: white;\n}\n.inlay-petition .ipet-submit {\n text-align: center;\n}\n.inlay-petition .ipet-submit button {\n font-size: 1.1rem;\n}\n", ""]); + +// exports + + +/***/ }), + +/***/ "./node_modules/css-loader/index.js!./node_modules/vue-loader/lib/loaders/stylePostLoader.js!./node_modules/postcss-loader/src/index.js?!./node_modules/sass-loader/dist/cjs.js?!./node_modules/vue-loader/lib/index.js?!./src/InlayProgress.vue?vue&type=style&index=0&lang=scss&": +/*!***************************************************************************************************************************************************************************************************************************************************************************************************!*\ + !*** ./node_modules/css-loader!./node_modules/vue-loader/lib/loaders/stylePostLoader.js!./node_modules/postcss-loader/src??ref--6-2!./node_modules/sass-loader/dist/cjs.js??ref--6-3!./node_modules/vue-loader/lib??vue-loader-options!./src/InlayProgress.vue?vue&type=style&index=0&lang=scss& ***! + \***************************************************************************************************************************************************************************************************************************************************************************************************/ +/*! no static exports found */ +/***/ (function(module, exports, __webpack_require__) { + +exports = module.exports = __webpack_require__(/*! ../node_modules/css-loader/lib/css-base.js */ "./node_modules/css-loader/lib/css-base.js")(false); +// imports + + +// module +exports.push([module.i, ".ifg-progress {\n height: 2px;\n transition: 0.3s background-color;\n}\n.ifg-progress-container {\n height: 2px;\n margin-top: 0.5rem;\n margin-bottom: 0.5rem;\n transition: 0.3s background-color;\n}\n", ""]); + +// exports + + +/***/ }), + +/***/ "./node_modules/css-loader/index.js!./node_modules/vue-loader/lib/loaders/stylePostLoader.js!./node_modules/postcss-loader/src/index.js?!./node_modules/sass-loader/dist/cjs.js?!./node_modules/vue-loader/lib/index.js?!./src/InlaySocials.vue?vue&type=style&index=0&lang=scss&": +/*!**************************************************************************************************************************************************************************************************************************************************************************************************!*\ + !*** ./node_modules/css-loader!./node_modules/vue-loader/lib/loaders/stylePostLoader.js!./node_modules/postcss-loader/src??ref--6-2!./node_modules/sass-loader/dist/cjs.js??ref--6-3!./node_modules/vue-loader/lib??vue-loader-options!./src/InlaySocials.vue?vue&type=style&index=0&lang=scss& ***! + \**************************************************************************************************************************************************************************************************************************************************************************************************/ +/*! no static exports found */ +/***/ (function(module, exports, __webpack_require__) { + +exports = module.exports = __webpack_require__(/*! ../node_modules/css-loader/lib/css-base.js */ "./node_modules/css-loader/lib/css-base.js")(false); +// imports + + +// module +exports.push([module.i, "ul.inlay-socials {\n list-style: none;\n margin: 0 -1rem;\n padding: 0;\n display: flex;\n flex-wrap: wrap;\n}\nul.inlay-socials > li {\n margin: 1rem 0;\n padding: 0 1rem;\n flex: 1 0 auto;\n list-style: none;\n}\nul.inlay-socials > li > a, ul.inlay-socials > li > a:hover, ul.inlay-socials > li > a:visited, ul.inlay-socials > li > a:active {\n text-decoration: none;\n border-radius: 4px;\n display: block;\n padding: 0.5rem 1rem;\n height: 100%;\n color: black;\n text-align: center;\n}\nul.inlay-socials > li > a {\n background-color: #e8e8e8;\n}\nul.inlay-socials > li > a:hover, ul.inlay-socials > li > a:active {\n background-color: #e0e0e0;\n}\nul.inlay-socials > li svg {\n vertical-align: baseline;\n}\n", ""]); + +// exports + + +/***/ }), + +/***/ "./node_modules/css-loader/index.js!./node_modules/vue-loader/lib/loaders/stylePostLoader.js!./node_modules/postcss-loader/src/index.js?!./node_modules/sass-loader/dist/cjs.js?!./node_modules/vue-loader/lib/index.js?!./src/OmeterSosTree.vue?vue&type=style&index=0&lang=scss&": +/*!***************************************************************************************************************************************************************************************************************************************************************************************************!*\ + !*** ./node_modules/css-loader!./node_modules/vue-loader/lib/loaders/stylePostLoader.js!./node_modules/postcss-loader/src??ref--6-2!./node_modules/sass-loader/dist/cjs.js??ref--6-3!./node_modules/vue-loader/lib??vue-loader-options!./src/OmeterSosTree.vue?vue&type=style&index=0&lang=scss& ***! + \***************************************************************************************************************************************************************************************************************************************************************************************************/ +/*! no static exports found */ +/***/ (function(module, exports, __webpack_require__) { + +exports = module.exports = __webpack_require__(/*! ../node_modules/css-loader/lib/css-base.js */ "./node_modules/css-loader/lib/css-base.js")(false); +// imports + + +// module +exports.push([module.i, ".treeometer {\n display: flex;\n flex-wrap: wrap;\n align-items: center;\n justify-content: center;\n background: #ffc839;\n padding: 1rem;\n color: white;\n margin-bottom: 1rem;\n font-weight: bold;\n}\n.treeometer .treeometer__trees {\n flex: 0 0 100%;\n display: flex;\n justify-content: space-between;\n}\n.treeometer .treeometer__trees .faded {\n opacity: 0.2;\n}\n.treeometer .treeometer__bignum {\n flex: 0 0 auto;\n padding-right: 1rem;\n font-size: 3rem;\n}\n.treeometer .treeometer__words {\n flex: 0 1 auto;\n font-size: 2rem;\n}\n", ""]); + +// exports + + +/***/ }), + +/***/ "./node_modules/css-loader/lib/css-base.js": +/*!*************************************************!*\ + !*** ./node_modules/css-loader/lib/css-base.js ***! + \*************************************************/ +/*! no static exports found */ +/***/ (function(module, exports) { + +/* + MIT License http://www.opensource.org/licenses/mit-license.php + Author Tobias Koppers @sokra +*/ +// css base code, injected by the css-loader +module.exports = function(useSourceMap) { + var list = []; + + // return the list of modules as css string + list.toString = function toString() { + return this.map(function (item) { + var content = cssWithMappingToString(item, useSourceMap); + if(item[2]) { + return "@media " + item[2] + "{" + content + "}"; + } else { + return content; + } + }).join(""); + }; + + // import a list of modules into the list + list.i = function(modules, mediaQuery) { + if(typeof modules === "string") + modules = [[null, modules, ""]]; + var alreadyImportedModules = {}; + for(var i = 0; i < this.length; i++) { + var id = this[i][0]; + if(typeof id === "number") + alreadyImportedModules[id] = true; + } + for(i = 0; i < modules.length; i++) { + var item = modules[i]; + // skip already imported module + // this implementation is not 100% perfect for weird media query combinations + // when a module is imported multiple times with different media queries. + // I hope this will never occur (Hey this way we have smaller bundles) + if(typeof item[0] !== "number" || !alreadyImportedModules[item[0]]) { + if(mediaQuery && !item[2]) { + item[2] = mediaQuery; + } else if(mediaQuery) { + item[2] = "(" + item[2] + ") and (" + mediaQuery + ")"; + } + list.push(item); + } + } + }; + return list; +}; + +function cssWithMappingToString(item, useSourceMap) { + var content = item[1] || ''; + var cssMapping = item[3]; + if (!cssMapping) { + return content; + } + + if (useSourceMap && typeof btoa === 'function') { + var sourceMapping = toComment(cssMapping); + var sourceURLs = cssMapping.sources.map(function (source) { + return '/*# sourceURL=' + cssMapping.sourceRoot + source + ' */' + }); + + return [content].concat(sourceURLs).concat([sourceMapping]).join('\n'); + } + + return [content].join('\n'); +} + +// Adapted from convert-source-map (MIT) +function toComment(sourceMap) { + // eslint-disable-next-line no-undef + var base64 = btoa(unescape(encodeURIComponent(JSON.stringify(sourceMap)))); + var data = 'sourceMappingURL=data:application/json;charset=utf-8;base64,' + base64; + + return '/*# ' + data + ' */'; +} + + +/***/ }), + +/***/ "./node_modules/process/browser.js": +/*!*****************************************!*\ + !*** ./node_modules/process/browser.js ***! + \*****************************************/ +/*! no static exports found */ +/***/ (function(module, exports) { + +// shim for using process in browser +var process = module.exports = {}; + +// cached from whatever global is present so that test runners that stub it +// don't break things. But we need to wrap it in a try catch in case it is +// wrapped in strict mode code which doesn't define any globals. It's inside a +// function because try/catches deoptimize in certain engines. + +var cachedSetTimeout; +var cachedClearTimeout; + +function defaultSetTimout() { + throw new Error('setTimeout has not been defined'); +} +function defaultClearTimeout () { + throw new Error('clearTimeout has not been defined'); +} +(function () { + try { + if (typeof setTimeout === 'function') { + cachedSetTimeout = setTimeout; + } else { + cachedSetTimeout = defaultSetTimout; + } + } catch (e) { + cachedSetTimeout = defaultSetTimout; + } + try { + if (typeof clearTimeout === 'function') { + cachedClearTimeout = clearTimeout; + } else { + cachedClearTimeout = defaultClearTimeout; + } + } catch (e) { + cachedClearTimeout = defaultClearTimeout; + } +} ()) +function runTimeout(fun) { + if (cachedSetTimeout === setTimeout) { + //normal enviroments in sane situations + return setTimeout(fun, 0); + } + // if setTimeout wasn't available but was latter defined + if ((cachedSetTimeout === defaultSetTimout || !cachedSetTimeout) && setTimeout) { + cachedSetTimeout = setTimeout; + return setTimeout(fun, 0); + } + try { + // when when somebody has screwed with setTimeout but no I.E. maddness + return cachedSetTimeout(fun, 0); + } catch(e){ + try { + // When we are in I.E. but the script has been evaled so I.E. doesn't trust the global object when called normally + return cachedSetTimeout.call(null, fun, 0); + } catch(e){ + // same as above but when it's a version of I.E. that must have the global object for 'this', hopfully our context correct otherwise it will throw a global error + return cachedSetTimeout.call(this, fun, 0); + } + } + + +} +function runClearTimeout(marker) { + if (cachedClearTimeout === clearTimeout) { + //normal enviroments in sane situations + return clearTimeout(marker); + } + // if clearTimeout wasn't available but was latter defined + if ((cachedClearTimeout === defaultClearTimeout || !cachedClearTimeout) && clearTimeout) { + cachedClearTimeout = clearTimeout; + return clearTimeout(marker); + } + try { + // when when somebody has screwed with setTimeout but no I.E. maddness + return cachedClearTimeout(marker); + } catch (e){ + try { + // When we are in I.E. but the script has been evaled so I.E. doesn't trust the global object when called normally + return cachedClearTimeout.call(null, marker); + } catch (e){ + // same as above but when it's a version of I.E. that must have the global object for 'this', hopfully our context correct otherwise it will throw a global error. + // Some versions of I.E. have different rules for clearTimeout vs setTimeout + return cachedClearTimeout.call(this, marker); + } + } + + + +} +var queue = []; +var draining = false; +var currentQueue; +var queueIndex = -1; + +function cleanUpNextTick() { + if (!draining || !currentQueue) { + return; + } + draining = false; + if (currentQueue.length) { + queue = currentQueue.concat(queue); + } else { + queueIndex = -1; + } + if (queue.length) { + drainQueue(); + } +} + +function drainQueue() { + if (draining) { + return; + } + var timeout = runTimeout(cleanUpNextTick); + draining = true; + + var len = queue.length; + while(len) { + currentQueue = queue; + queue = []; + while (++queueIndex < len) { + if (currentQueue) { + currentQueue[queueIndex].run(); + } + } + queueIndex = -1; + len = queue.length; + } + currentQueue = null; + draining = false; + runClearTimeout(timeout); +} + +process.nextTick = function (fun) { + var args = new Array(arguments.length - 1); + if (arguments.length > 1) { + for (var i = 1; i < arguments.length; i++) { + args[i - 1] = arguments[i]; + } + } + queue.push(new Item(fun, args)); + if (queue.length === 1 && !draining) { + runTimeout(drainQueue); + } +}; + +// v8 likes predictible objects +function Item(fun, array) { + this.fun = fun; + this.array = array; +} +Item.prototype.run = function () { + this.fun.apply(null, this.array); +}; +process.title = 'browser'; +process.browser = true; +process.env = {}; +process.argv = []; +process.version = ''; // empty string to avoid regexp issues +process.versions = {}; + +function noop() {} + +process.on = noop; +process.addListener = noop; +process.once = noop; +process.off = noop; +process.removeListener = noop; +process.removeAllListeners = noop; +process.emit = noop; +process.prependListener = noop; +process.prependOnceListener = noop; + +process.listeners = function (name) { return [] } + +process.binding = function (name) { + throw new Error('process.binding is not supported'); +}; + +process.cwd = function () { return '/' }; +process.chdir = function (dir) { + throw new Error('process.chdir is not supported'); +}; +process.umask = function() { return 0; }; + + +/***/ }), + +/***/ "./node_modules/setimmediate/setImmediate.js": +/*!***************************************************!*\ + !*** ./node_modules/setimmediate/setImmediate.js ***! + \***************************************************/ +/*! no static exports found */ +/***/ (function(module, exports, __webpack_require__) { + +/* WEBPACK VAR INJECTION */(function(global, process) {(function (global, undefined) { + "use strict"; + + if (global.setImmediate) { + return; + } + + var nextHandle = 1; // Spec says greater than zero + var tasksByHandle = {}; + var currentlyRunningATask = false; + var doc = global.document; + var registerImmediate; + + function setImmediate(callback) { + // Callback can either be a function or a string + if (typeof callback !== "function") { + callback = new Function("" + callback); + } + // Copy function arguments + var args = new Array(arguments.length - 1); + for (var i = 0; i < args.length; i++) { + args[i] = arguments[i + 1]; + } + // Store and register the task + var task = { callback: callback, args: args }; + tasksByHandle[nextHandle] = task; + registerImmediate(nextHandle); + return nextHandle++; + } + + function clearImmediate(handle) { + delete tasksByHandle[handle]; + } + + function run(task) { + var callback = task.callback; + var args = task.args; + switch (args.length) { + case 0: + callback(); + break; + case 1: + callback(args[0]); + break; + case 2: + callback(args[0], args[1]); + break; + case 3: + callback(args[0], args[1], args[2]); + break; + default: + callback.apply(undefined, args); + break; + } + } + + function runIfPresent(handle) { + // From the spec: "Wait until any invocations of this algorithm started before this one have completed." + // So if we're currently running a task, we'll need to delay this invocation. + if (currentlyRunningATask) { + // Delay by doing a setTimeout. setImmediate was tried instead, but in Firefox 7 it generated a + // "too much recursion" error. + setTimeout(runIfPresent, 0, handle); + } else { + var task = tasksByHandle[handle]; + if (task) { + currentlyRunningATask = true; + try { + run(task); + } finally { + clearImmediate(handle); + currentlyRunningATask = false; + } + } + } + } + + function installNextTickImplementation() { + registerImmediate = function(handle) { + process.nextTick(function () { runIfPresent(handle); }); + }; + } + + function canUsePostMessage() { + // The test against `importScripts` prevents this implementation from being installed inside a web worker, + // where `global.postMessage` means something completely different and can't be used for this purpose. + if (global.postMessage && !global.importScripts) { + var postMessageIsAsynchronous = true; + var oldOnMessage = global.onmessage; + global.onmessage = function() { + postMessageIsAsynchronous = false; + }; + global.postMessage("", "*"); + global.onmessage = oldOnMessage; + return postMessageIsAsynchronous; + } + } + + function installPostMessageImplementation() { + // Installs an event handler on `global` for the `message` event: see + // * https://developer.mozilla.org/en/DOM/window.postMessage + // * http://www.whatwg.org/specs/web-apps/current-work/multipage/comms.html#crossDocumentMessages + + var messagePrefix = "setImmediate$" + Math.random() + "$"; + var onGlobalMessage = function(event) { + if (event.source === global && + typeof event.data === "string" && + event.data.indexOf(messagePrefix) === 0) { + runIfPresent(+event.data.slice(messagePrefix.length)); + } + }; + + if (global.addEventListener) { + global.addEventListener("message", onGlobalMessage, false); + } else { + global.attachEvent("onmessage", onGlobalMessage); + } + + registerImmediate = function(handle) { + global.postMessage(messagePrefix + handle, "*"); + }; + } + + function installMessageChannelImplementation() { + var channel = new MessageChannel(); + channel.port1.onmessage = function(event) { + var handle = event.data; + runIfPresent(handle); + }; + + registerImmediate = function(handle) { + channel.port2.postMessage(handle); + }; + } + + function installReadyStateChangeImplementation() { + var html = doc.documentElement; + registerImmediate = function(handle) { + // Create a diff --git a/src/InlayProgress.vue b/src/InlayProgress.vue new file mode 100644 index 0000000..369ea02 --- /dev/null +++ b/src/InlayProgress.vue @@ -0,0 +1,111 @@ + + + diff --git a/src/InlaySocials.vue b/src/InlaySocials.vue new file mode 100644 index 0000000..a4baa7f --- /dev/null +++ b/src/InlaySocials.vue @@ -0,0 +1,111 @@ + + + diff --git a/src/OmeterSosTree.vue b/src/OmeterSosTree.vue new file mode 100644 index 0000000..62ce51f --- /dev/null +++ b/src/OmeterSosTree.vue @@ -0,0 +1,121 @@ + + + diff --git a/src/petition.js b/src/petition.js new file mode 100644 index 0000000..83e1178 --- /dev/null +++ b/src/petition.js @@ -0,0 +1,38 @@ +import Vue from 'vue'; +import InlayPetition from './InlayPetition.vue'; + +(() => { + console.log("here"); + if (!window.inlayPetitionInit) { + console.log("inlayPetitionInit does not exist, will create it now"); + // This is the first time this *type* of Inlay has been encountered. + // We need to define anything global here. + + // Create the boot function. + window.inlayPetitionInit = inlay => { + const inlayNode = document.createElement('div'); + inlay.script.insertAdjacentElement('afterend', inlayNode); + /* eslint no-unused-vars: 0 */ + // This is the root app. + console.debug(inlay); + const app = new Vue({ + el: inlayNode, + data() { + var d = { + inlay, + formID: 0, + submissionRunning: false + }; + return d; + }, + render: h => h(InlayPetition, {props: {inlay}}), + methods: { + getNextId() { + this.formID++; + return `i${this.inlay.publicID}-${this.formID}`; + } + } + }); + }; + } +})(); diff --git a/templates/CRM/inlaypetition/Petition.hlp b/templates/CRM/inlaypetition/Petition.hlp new file mode 100644 index 0000000..38ba76e --- /dev/null +++ b/templates/CRM/inlaypetition/Petition.hlp @@ -0,0 +1,3 @@ +{htxt id="inlay_name"} +{ts}The internal, administrative name of this petition. Used in the Activity subject field to differentiate this petition from others.{/ts} +{/htxt} diff --git a/tests/phpunit/api/v3/Job/ProcesspetitioninlaysTest.php b/tests/phpunit/api/v3/Job/ProcesspetitioninlaysTest.php new file mode 100644 index 0000000..01fdb68 --- /dev/null +++ b/tests/phpunit/api/v3/Job/ProcesspetitioninlaysTest.php @@ -0,0 +1,53 @@ +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('Job', 'processpetitioninlays', array('magicword' => 'sesame')); + $this->assertEquals('Twelve', $result['values'][12]['name']); + } + +} diff --git a/tests/phpunit/bootstrap.php b/tests/phpunit/bootstrap.php new file mode 100644 index 0000000..a5b4925 --- /dev/null +++ b/tests/phpunit/bootstrap.php @@ -0,0 +1,63 @@ +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)"); + } +} diff --git a/webpack.mix.js b/webpack.mix.js new file mode 100644 index 0000000..f25174e --- /dev/null +++ b/webpack.mix.js @@ -0,0 +1,50 @@ +let mix = require('laravel-mix'); + +require('laravel-mix-bundle-analyzer'); +if (false && !mix.inProduction()) { + mix.bundleAnalyzer(); +} + + +mix + .js('src/petition.js', 'dist/inlay-petition.js') +; + +// Full API +// mix.js(src, output); +// mix.react(src, output); <-- Identical to mix.js(), but registers React Babel compilation. +// mix.preact(src, output); <-- Identical to mix.js(), but registers Preact compilation. +// mix.coffee(src, output); <-- Identical to mix.js(), but registers CoffeeScript compilation. +// mix.ts(src, output); <-- TypeScript support. Requires tsconfig.json to exist in the same folder as webpack.mix.js +// mix.extract(vendorLibs); +// mix.sass(src, output); +// mix.less(src, output); +// mix.stylus(src, output); +// mix.postCss(src, output, [require('postcss-some-plugin')()]); +// mix.browserSync('my-site.test'); +// mix.combine(files, destination); +// mix.babel(files, destination); <-- Identical to mix.combine(), but also includes Babel compilation. +// mix.copy(from, to); +// mix.copyDirectory(fromDir, toDir); +// mix.minify(file); +// mix.sourceMaps(); // Enable sourcemaps +// mix.version(); // Enable versioning. +// mix.disableNotifications(); +// mix.setPublicPath('path/to/public'); +// mix.setResourceRoot('prefix/for/resource/locators'); +// mix.autoload({}); <-- Will be passed to Webpack's ProvidePlugin. +// mix.webpackConfig({}); <-- Override webpack.config.js, without editing the file directly. +// mix.babelConfig({}); <-- Merge extra Babel configuration (plugins, etc.) with Mix's default. +// mix.then(function () {}) <-- Will be triggered each time Webpack finishes building. +// mix.when(condition, function (mix) {}) <-- Call function if condition is true. +// mix.override(function (webpackConfig) {}) <-- Will be triggered once the webpack config object has been fully generated by Mix. +// mix.dump(); <-- Dump the generated webpack config object to the console. +// mix.extend(name, handler) <-- Extend Mix's API with your own components. +// mix.options({ +// extractVueStyles: false, // Extract .vue component styling to file, rather than inline. +// globalVueStyles: file, // Variables file to be imported in every component. +// processCssUrls: true, // Process/optimize relative stylesheet url()'s. Set to false, if you don't want them touched. +// purifyCss: false, // Remove unused CSS selectors. +// terser: {}, // Terser-specific options. https://github.com/webpack-contrib/terser-webpack-plugin#options +// postCss: [] // Post-CSS options: https://github.com/postcss/postcss/blob/master/docs/plugins.md +// });