v2.0.0

Author: kjmartens

CHANGELOG.md

@@ -1,5 +1,15 @@
 # Solspace Freeform Changelog
 
+## 2.0.0 - 2018-05-14
+### Added
+- Added mailing list integration support for the Craft Campaign plugin, available on Lite and Pro editions.
+
+### Fixed
+- Fixed a bug where 'Display error messages' option for Spam Protection Behavior setting would trip on submitting a form if it initially errored.
+- Fixed a bug where submitting a form with a mailing list would error in some cases.
+- Fixed a bug where the Salesforce fetch token URL regex restriction was not allowing for less common URLs to pass through.
+- Fixed a bug where saving field mapping for HubSpot was not always saving fields correctly.
+
 ## 2.0.0-beta.20 - 2018-05-09
 ### Added
 - Added Form Submission Throttling setting to help prevent against spam or attacks.

README.md

@@ -2,8 +2,6 @@
 
 Freeform is the most powerful form building plugin for Craft CMS. It gives you full control to create simple or complex multi-page forms, as well as connect your forms to many popular API integrations.
 
-🚨 **NOTE: Freeform has proven to be fairly stable now, but please take caution if using in production environments.** 🚨
-
 ![Screenshot](src/icon.svg)
 
 ## Requirements
@@ -12,21 +10,19 @@ This plugin requires Craft CMS 3.0.0 or later.
 
 ## Installation
 
-To install the plugin(s), search for **Freeform** in the *Craft Plugin Store*, or install manually with the following instructions:
-
-1. Open your terminal and go to your Craft project:
-
-        cd /path/to/project
-
-2. Then tell Composer to require the plugin:
-
-        composer require solspace/craft3-freeform
+To install Freeform, simply:
 
-And if you'd like the **Pro** edition of Freeform, you'll need to also install Freeform Pro (in addition to Freeform Lite). Tell Composer to also require the plugin:
+1. Go to the **Plugin Store** area inside your Craft control panel and search for *Freeform*.
+2. Choose to install *Freeform Lite* and/or *Freeform Pro* (*Pro* requires *Lite* to be installed) by clicking on them.
+3. Click on the **Try** button to install a trial copy of Freeform.
+4. Try things out and if Freeform is right for your site, purchase a copy of if through the Plugin Store when you're ready!
 
-        composer require solspace/craft3-freeform-pro
+Freeform can also be installed manually through Composer:
 
-3. In the Control Panel, go to *Settings → Plugins* and click the “Install” button for **Freeform Lite** (and **Freeform Pro** if you're wanting Pro edition).
+1. Open your terminal and go to your Craft project: `cd /path/to/project`
+2. Then tell Composer to require the plugin: `composer require solspace/craft3-freeform`
+3. If you'd like Freeform Pro, also run: `composer require solspace/craft3-freeform-pro`
+4. In the Craft control panel, go to *Settings → Plugins* and click the **Install** button for Freeform Lite (and Freeform Pro if you're using Pro edition).
 
 ## Freeform Overview
 

composer.json

@@ -1,7 +1,7 @@
 {
   "name": "solspace/craft3-freeform",
   "description": "The most intuitive and powerful form builder for Craft.",
-  "version": "2.0.0-beta.20",
+  "version": "2.0.0",
   "type": "craft-plugin",
   "minimum-stability": "dev",
   "authors": [

src/Freeform.php

@@ -33,6 +33,7 @@
 use Solspace\Freeform\Controllers\StatusesController;
 use Solspace\Freeform\Controllers\SubmissionsController;
 use Solspace\Freeform\Events\Freeform\RegisterCpSubnavItemsEvent;
+use Solspace\Freeform\Events\Integrations\FetchMailingListTypesEvent;
 use Solspace\Freeform\FieldTypes\FormFieldType;
 use Solspace\Freeform\Library\Composer\Components\FieldInterface;
 use Solspace\Freeform\Models\FieldModel;
@@ -55,6 +56,8 @@
 use Solspace\Freeform\Services\SubmissionsService;
 use Solspace\Freeform\Variables\FreeformVariable;
 use Solspace\Freeform\Widgets\StatisticsWidget;
+use Symfony\Component\Finder\Finder;
+use Symfony\Component\Finder\SplFileInfo;
 use yii\base\Event;
 use yii\db\Query;
 
@@ -559,6 +562,29 @@ private function initEventListeners()
             FormsService::EVENT_RENDER_CLOSING_TAG,
             [$this->forms, 'addFormAnchorJavascript']
         );
+
+        Event::on(
+            MailingListsService::class,
+            MailingListsService::EVENT_FETCH_TYPES,
+            function (FetchMailingListTypesEvent $event) {
+                $finder = new Finder();
+
+                $namespace = 'Solspace\Freeform\Library\MailingLists';
+
+                /** @var SplFileInfo[] $files */
+                $files = $finder
+                    ->name('*.php')
+                    ->files()
+                    ->ignoreDotFiles(true)
+                    ->in(__DIR__ . '/Library/MailingLists/');
+
+                foreach ($files as $file) {
+                    $className = str_replace('.' . $file->getExtension(), '', $file->getBasename());
+                    $className = $namespace . '\\' . $className;
+                    $event->addType($className);
+                }
+            }
+        );
     }
 
     private function initHoneypot()

src/Library/Composer/Components/Form.php

@@ -95,6 +95,9 @@ class Form implements \JsonSerializable, \Iterator, \ArrayAccess
     /** @var bool */
     private $valid;
 
+    /** @var bool */
+    private $markedAsSpam;
+
     /** @var SubmissionHandlerInterface */
     private $submissionHandler;
 
@@ -163,6 +166,7 @@ public function __construct(
         $this->ipCollectingEnabled   = true;
         $this->customAttributes      = new CustomFormAttributes();
         $this->errors                = [];
+        $this->markedAsSpam          = false;
 
         $this->layout = new Layout(
             $this,
@@ -381,7 +385,7 @@ public function addError(string $message): Form
      */
     public function isMarkedAsSpam(): bool
     {
-        return $this->getFormValueContext()->isMarkedAsSpam();
+        return $this->markedAsSpam;
     }
 
     /**
@@ -391,7 +395,7 @@ public function isMarkedAsSpam(): bool
      */
     public function setMarkedAsSpam(bool $markedAsSpam): Form
     {
-        $this->getFormValueContext()->setMarkedAsSpam($markedAsSpam);
+        $this->markedAsSpam = $markedAsSpam;
 
         return $this;
     }
@@ -420,17 +424,30 @@ public function isValid(): bool
         $currentPageFields = $this->getCurrentPage()->getFields();
 
         $isFormValid = true;
-        foreach ($currentPageFields as $field) {
-            if (!$field->isValid()) {
-                $isFormValid = false;
+        foreach ($this->getLayout()->getPages() as $page) {
+            if ($page->getIndex() > $this->getCurrentPage()->getIndex()) {
+                break;
+            }
+
+            foreach ($page->getFields() as $field) {
+                if (!$field->isValid()) {
+                    $isFormValid = false;
+                }
             }
         }
 
         $this->formHandler->onFormValidate($this, $isFormValid);
 
         if ($isFormValid && $this->isMarkedAsSpam()) {
-            $this->formHandler->incrementSpamBlockCount($this);
-            $this->valid = $this->formHandler->isSpamBehaviourSimulateSuccess();
+            $simulateSuccess = $this->formHandler->isSpamBehaviourSimulateSuccess();
+
+            if ($simulateSuccess && $this->isLastPage()) {
+                $this->formHandler->incrementSpamBlockCount($this);
+            } else if (!$simulateSuccess) {
+                $this->formHandler->incrementSpamBlockCount($this);
+            }
+
+            $this->valid = $simulateSuccess;
 
             return $this->valid;
         }

src/Library/MailingLists/Campaign.php

@@ -0,0 +1,181 @@
+<?php
+
+namespace Solspace\Freeform\Library\MailingLists;
+
+use craft\base\Field;
+use craft\fields\Checkboxes;
+use craft\fields\Color;
+use craft\fields\Date;
+use craft\fields\Dropdown;
+use craft\fields\Email;
+use craft\fields\Entries;
+use craft\fields\Lightswitch;
+use craft\fields\MultiSelect;
+use craft\fields\PlainText;
+use craft\fields\RadioButtons;
+use craft\fields\Tags;
+use craft\fields\Url;
+use craft\fields\Users;
+use Money\Number;
+use putyourlightson\campaign\Campaign as CampaignPlugin;
+use putyourlightson\campaign\elements\ContactElement;
+use putyourlightson\campaign\elements\MailingListElement;
+use Solspace\Freeform\Library\Integrations\DataObjects\FieldObject;
+use Solspace\Freeform\Library\Integrations\MailingLists\AbstractMailingListIntegration;
+use Solspace\Freeform\Library\Integrations\MailingLists\DataObjects\ListObject;
+
+class Campaign extends AbstractMailingListIntegration
+{
+    const TITLE        = 'Craft Campaign';
+    const LOG_CATEGORY = 'CraftCampaign';
+
+    /** @var array */
+    private static $fieldCache;
+
+    /** @var array - a list of allowed field types and their value type */
+    private static $fieldTypeMap = [
+        Checkboxes::class   => FieldObject::TYPE_ARRAY,
+        Color::class        => FieldObject::TYPE_STRING,
+        Date::class         => FieldObject::TYPE_STRING,
+        Dropdown::class     => FieldObject::TYPE_STRING,
+        Email::class        => FieldObject::TYPE_STRING,
+        Lightswitch::class  => FieldObject::TYPE_BOOLEAN,
+        Entries::class      => FieldObject::TYPE_ARRAY,
+        MultiSelect::class  => FieldObject::TYPE_ARRAY,
+        Number::class       => FieldObject::TYPE_NUMERIC,
+        PlainText::class    => FieldObject::TYPE_STRING,
+        RadioButtons::class => FieldObject::TYPE_STRING,
+        Tags::class         => FieldObject::TYPE_ARRAY,
+        Url::class          => FieldObject::TYPE_ARRAY,
+        Users::class        => FieldObject::TYPE_ARRAY,
+    ];
+
+    /**
+     * @inheritDoc
+     */
+    protected function fetchLists(): array
+    {
+        $lists = [];
+        foreach (MailingListElement::find()->all() as $list) {
+            $lists[] = new ListObject(
+                $this,
+                $list->id,
+                $list->title,
+                $this->fetchFields($list->id),
+                $list->subscribedCount
+            );
+        }
+
+        return $lists;
+    }
+
+    /**
+     * @inheritDoc
+     */
+    protected function fetchFields($listId): array
+    {
+        if (null === self::$fieldCache) {
+            $allowedFieldTypes = array_keys(self::$fieldTypeMap);
+            $fieldLayout       = \Craft::$app->fields->getLayoutByType(ContactElement::class);
+
+            if (!$fieldLayout) {
+                self::$fieldCache = [];
+
+                return self::$fieldCache;
+            }
+
+            $list = [];
+            /** @var Field $field */
+            foreach ($fieldLayout->getFields() as $field) {
+                $fieldClass = \get_class($field);
+
+                if (!\in_array($fieldClass, $allowedFieldTypes, true)) {
+                    continue;
+                }
+
+                $list[] = new FieldObject(
+                    $field->handle,
+                    $field->name,
+                    self::$fieldTypeMap[$fieldClass],
+                    $field->required
+                );
+            }
+
+            self::$fieldCache = $list;
+        }
+
+        return self::$fieldCache;
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function checkConnection(): bool
+    {
+        return \Craft::$app->plugins->isPluginInstalled('campaign');
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function initiateAuthentication()
+    {
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function fetchAccessToken(): string
+    {
+        return '';
+    }
+
+    /**
+     * @inheritDoc
+     */
+    protected function getApiRootUrl(): string
+    {
+        return '';
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function pushEmails(ListObject $mailingList, array $emails, array $mappedValues): bool
+    {
+        $mailingListElement = MailingListElement::find()->id($mailingList->getId())->one();
+        $source             = \Craft::$app->getRequest()->getReferrer();
+
+        if ($mailingListElement === null) {
+            return false;
+        }
+
+        foreach ($emails as $email) {
+            $contact = CampaignPlugin::$plugin->contacts->getContactByEmail('name@email.com');
+
+            if ($contact === null) {
+                $contact = new ContactElement();
+
+                $contact->email = $email;
+                foreach ($mappedValues as $key => $value) {
+                    $contact->setFieldValue($key, $value);
+                }
+            }
+
+            \Craft::$app->getElements()->saveElement($contact);
+
+            if (!$contact->id) {
+                continue;
+            }
+
+            CampaignPlugin::$plugin->tracker->subscribe(
+                $contact,
+                $mailingListElement,
+                'Freeform',
+                $source
+            );
+        }
+
+        return true;
+    }
+}