Feature/979 copy field values

src/base/CopyableFieldInterface.php

@@ -0,0 +1,36 @@
+<?php
+/**
+ * @link https://craftcms.com/
+ * @copyright Copyright (c) Pixel & Tonic, Inc.
+ * @license https://craftcms.github.io/license/
+ */
+
+namespace craft\base;
+
+/**
+ * CopyableFieldInterface defines the common interface to be implemented by field classes
+ * that wish to support copying their values between sites in a multisite installation.
+ *
+ * @author Pixel & Tonic, Inc. <[email protected]>
+ * @since 4.4.0
+ */
+interface CopyableFieldInterface
+{
+    /**
+     * Returns whether the field is copyable between sites.
+     *
+     * @param ElementInterface|null $element
+     * @return bool
+     */
+    public function getIsCopyable(?ElementInterface $element = null): bool;
+
+    /**
+     * Copies field’s value from one element to another.
+     *
+     * @param ElementInterface $from
+     * @param ElementInterface $to
+     * @return bool
+     * @since 5.0.0
+     */
+    public function copyValueBetweenSites(ElementInterface $from, ElementInterface $to): bool;
+}

src/base/Element.php

@@ -3477,6 +3477,19 @@ protected function safeActionMenuItems(): array
             ];
         }
 
+        if (ElementHelper::supportsFieldCopying($this)) {
+            $copyId = sprintf('action-copy-content-%s', mt_rand());
+            $items[] = [
+                'id' => $copyId,
+                'icon' => 'world',
+                'label' => Craft::t('app', 'Copy content from site'),
+                'type' => MenuItemType::Button,
+                'attributes' => [
+                    'class' => ['copy-all-from-site'],
+                ],
+            ];
+        }
+
         // Edit
         if (Craft::$app->getElements()->canView($this)) {
             $editId = sprintf('action-edit-%s', mt_rand());

src/base/Field.php

@@ -474,6 +474,30 @@ public function getTranslationKey(ElementInterface $element): string
         return ElementHelper::translationKey($element, $this->translationMethod, $this->translationKeyFormat);
     }
 
+    /**
+     * Returns whether the field is copyable between sites.
+     */
+    public function getIsCopyable(?ElementInterface $element = null): bool
+    {
+        return false;
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function copyValueBetweenSites(ElementInterface $from, ElementInterface $to): bool
+    {
+        $fromValue = $this->serializeValue($from->getFieldValue($this->handle), $from);
+        $toValue = $this->serializeValue($to->getFieldValue($this->handle), $to);
+
+        if ($fromValue != $toValue) {
+            $to->setFieldValue($this->handle, $fromValue);
+            return true;
+        }
+
+        return false;
+    }
+
     /**
      * @inheritdoc
      */
@@ -719,7 +743,7 @@ public function serializeValue(mixed $value, ?ElementInterface $element): mixed
     }
 
     /**
-     * @inheritdoc
+     * Copies field’s value from one element to another.
      */
     public function copyValue(ElementInterface $from, ElementInterface $to): void
     {

src/controllers/ElementsController.php

@@ -29,9 +29,11 @@
 use craft\i18n\Locale;
 use craft\models\ElementActivity;
 use craft\models\FieldLayoutForm;
+use craft\models\Site;
 use craft\web\Controller;
 use craft\web\CpScreenResponseBehavior;
 use craft\web\View;
+use Illuminate\Support\Collection;
 use Throwable;
 use yii\helpers\Markdown;
 use yii\web\BadRequestHttpException;
@@ -527,6 +529,129 @@ public function actionEdit(?ElementInterface $element, ?int $elementId = null):
         return $response;
     }
 
+    /**
+     * Returns result of copying field value from another site
+     *
+     * @return Response
+     * @throws BadRequestHttpException
+     * @throws ForbiddenHttpException
+     * @throws ServerErrorHttpException
+     * @throws Throwable
+     * @throws \craft\errors\ElementNotFoundException
+     * @throws \craft\errors\InvalidFieldException
+     * @throws \craft\errors\MissingComponentException
+     * @throws \yii\base\Exception
+     * @throws \yii\db\Exception
+     */
+    public function actionCopyFieldValuesFromSite(): Response
+    {
+        $this->requireCpRequest();
+
+        /** @var Element|null $element */
+        $element = $this->_element();
+
+        if (!$element || $element->getIsRevision()) {
+            throw new BadRequestHttpException('No element was identified by the request.');
+        }
+
+        // if $fieldHandle is null, we're copying all element fields
+        $fieldHandle = $this->request->getBodyParam('copyFieldHandle', null);
+        $copyFromSiteId = $this->request->getRequiredBodyParam('copyFromSiteId');
+        $isFullPage = $this->request->getBodyParam('isFullPage');
+
+        if ($fieldHandle === '' || empty($copyFromSiteId)) {
+            throw new BadRequestHttpException("Request missing required param");
+        }
+
+        $elementsService = Craft::$app->getElements();
+        $user = static::currentUser();
+
+        // if we can't create drafts for this element, just bail;
+        // this check is to both check if user can create drafts AND if element supports them
+        if (!$elementsService->canCreateDrafts($element, $user)) {
+            throw new ForbiddenHttpException('Can‘t create drafts for this element.');
+        }
+
+        // check if this entry exists for other sites
+        if (empty($siteIdsForElement = $elementsService->getEnabledSiteIdsForElement($element->id))) {
+            $errorMsg = Craft::t('app', 'Couldn’t find this {type} on other sites.', [
+                'type' => $element::lowerDisplayName(),
+            ]);
+
+            Craft::$app->session->setError($errorMsg);
+
+            return $this->_asFailure($element, $errorMsg);
+        }
+
+        if (!in_array($copyFromSiteId, $siteIdsForElement, false)) {
+            $errorMsg = Craft::t('app', 'Couldn’t find this {type} on the site you selected.', [
+                'type' => $element::lowerDisplayName(),
+            ]);
+
+            Craft::$app->session->setError($errorMsg);
+
+            return $this->_asFailure($element, $errorMsg);
+        }
+
+        $result = $elementsService->copyFieldValuesFromSite($element, $fieldHandle, $copyFromSiteId);
+        if ($result['success'] === false) {
+            if ($isFullPage) {
+                Craft::$app->session->setError($result['message']);
+            }
+
+            return $this->_asFailure($result['element'], $result['message']);
+        }
+
+        if (!$this->request->getAcceptsJson()) {
+            // Tell all browser windows about the element save
+            Craft::$app->getSession()->broadcastToJs([
+                'event' => 'saveElement',
+                'id' => $element->id,
+            ]);
+        }
+
+        if ($isFullPage) {
+            Craft::$app->session->setNotice($result['message']);
+        }
+
+        return $this->_asSuccess($result['message'], $result['element']);
+    }
+
+    public function actionCopyFromSiteForm(): Response
+    {
+        $this->requireAcceptsJson();
+        $this->requireCpRequest();
+
+        $viewMode = Craft::$app->getRequest()->getParam('viewMode', 'modal');
+        $copyFieldHandle = Craft::$app->getRequest()->getParam('copyFieldHandle');
+        $template = $viewMode === 'modal' ? '_special/copy-content-modal.twig' : '_special/copy-content-fields.twig';
+
+        $element = $this->_element();
+        $sitesService = Craft::$app->getSites();
+
+        $siteOptions = Collection::make(ElementHelper::editableSiteIdsForElement($element))
+            ->filter(fn(int $siteId) => $siteId !== $this->_siteId)
+            ->map(fn(int $siteId) => $sitesService->getSiteById($siteId))
+            ->map(fn(Site $site) => [
+                'label' => $site->name,
+                'value' => $site->id,
+            ]);
+
+        $view = $this->getView();
+        $html = $view->renderTemplate($template, [
+            'viewMode' => $viewMode,
+            'siteOptions' => $siteOptions,
+            'copyFieldHandle' => $copyFieldHandle,
+            'elementId' => $element->id,
+            'draftId' => $this->_draftId,
+            'provisional' => $this->_provisional,
+        ]);
+
+        return $this->asJson([
+            'html' => $html,
+        ]);
+    }
+
     /**
      * Returns an element revisions index screen.
      *

src/fieldlayoutelements/BaseField.php

@@ -340,6 +340,7 @@ public function formHtml(?ElementInterface $element = null, bool $static = false
             'orientation' => $this->orientation($element, $static),
             'translatable' => $this->translatable($element, $static),
             'translationDescription' => $this->translationDescription($element, $static),
+            'copyable' => $this->isCopyable($element, $static),
             'errors' => !$static ? $this->errors($element) : [],
         ]);
     }
@@ -686,4 +687,16 @@ protected function translationDescription(?ElementInterface $element = null, boo
     {
         return null;
     }
+
+    /**
+     * Returns whether field supports copying its value across sites
+     *
+     * @param ElementInterface|null $element
+     * @param bool $static
+     * @return bool
+     */
+    public function isCopyable(?ElementInterface $element = null, bool $static = false): bool
+    {
+        return false;
+    }
 }

src/fieldlayoutelements/CustomField.php

@@ -8,6 +8,7 @@
 namespace craft\fieldlayoutelements;
 
 use Craft;
+use craft\base\CopyableFieldInterface;
 use craft\base\ElementInterface;
 use craft\base\FieldInterface;
 use craft\base\PreviewableFieldInterface;
@@ -378,4 +379,16 @@ protected function translationDescription(?ElementInterface $element = null, boo
     {
         return $this->_field->getTranslationDescription($element);
     }
+
+    /**
+     * @inheritdoc
+     */
+    public function isCopyable(?ElementInterface $element = null, bool $static = false): bool
+    {
+        if ($this->_field instanceof CopyableFieldInterface) {
+            return $this->_field->getIsCopyable($element);
+        }
+
+        return false;
+    }
 }

src/fieldlayoutelements/entries/EntryTitleField.php

@@ -79,4 +79,12 @@ public function inputHtml(?ElementInterface $element = null, bool $static = fals
 
         return parent::inputHtml($element, $static);
     }
+
+    /**
+     * @inheritdoc
+     */
+    public function isCopyable(?ElementInterface $element = null, bool $static = false): bool
+    {
+        return $this->translatable($element) && ElementHelper::supportsFieldCopying($element);
+    }
 }

src/fields/BaseOptionsField.php

@@ -8,6 +8,7 @@
 namespace craft\fields;
 
 use Craft;
+use craft\base\CopyableFieldInterface;
 use craft\base\ElementInterface;
 use craft\base\Field;
 use craft\base\PreviewableFieldInterface;
@@ -21,6 +22,7 @@
 use craft\gql\resolvers\OptionField as OptionFieldResolver;
 use craft\helpers\ArrayHelper;
 use craft\helpers\Cp;
+use craft\helpers\ElementHelper;
 use craft\helpers\Json;
 use craft\helpers\StringHelper;
 use GraphQL\Type\Definition\Type;
@@ -32,7 +34,7 @@
  * @author Pixel & Tonic, Inc. <[email protected]>
  * @since 3.0.0
  */
-abstract class BaseOptionsField extends Field implements PreviewableFieldInterface
+abstract class BaseOptionsField extends Field implements PreviewableFieldInterface, CopyableFieldInterface
 {
     /**
      * @event DefineInputOptionsEvent Event triggered when defining the options for the field's input.
@@ -504,6 +506,14 @@ public function getContentGqlMutationArgumentType(): Type|array
         ];
     }
 
+    /**
+     * @inheritdoc
+     */
+    public function getIsCopyable(?ElementInterface $element = null): bool
+    {
+        return $this->getIsTranslatable($element) && ElementHelper::supportsFieldCopying($element);
+    }
+
     /**
      * Returns the label for the Options setting.
      *

src/fields/BaseRelationField.php

@@ -9,6 +9,7 @@
 
 use Craft;
 use craft\base\conditions\ConditionInterface;
+use craft\base\CopyableFieldInterface;
 use craft\base\EagerLoadingFieldInterface;
 use craft\base\Element;
 use craft\base\ElementInterface;
@@ -50,7 +51,7 @@
  * @author Pixel & Tonic, Inc. <[email protected]>
  * @since 3.0.0
  */
-abstract class BaseRelationField extends Field implements InlineEditableFieldInterface, EagerLoadingFieldInterface
+abstract class BaseRelationField extends Field implements InlineEditableFieldInterface, EagerLoadingFieldInterface, CopyableFieldInterface
 {
     /**
      * @event ElementCriteriaEvent The event that is triggered when defining the selection criteria for this field.
@@ -918,6 +919,14 @@ public function getContentGqlMutationArgumentType(): Type|array
         ];
     }
 
+    /**
+     * @inheritdoc
+     */
+    public function getIsCopyable(?ElementInterface $element = null): bool
+    {
+        return $this->getIsTranslatable($element) && ElementHelper::supportsFieldCopying($element);
+    }
+
     // Events
     // -------------------------------------------------------------------------