ENH Add Readonly field status (#172)

* ENH Add Readonly field status * ENH Add Readonly field status * ENH Add info message for readonly fields
silverstripe · Jan 24, 2024 · 9bb3a1a · 9bb3a1a
1 parent fce5499
commit 9bb3a1a
Show file tree

Hide file tree

Showing 13 changed files with 133 additions and 34 deletions.
diff --git a/client/dist/js/bundle.js b/client/dist/js/bundle.js
diff --git a/client/dist/styles/bundle.css b/client/dist/styles/bundle.css
diff --git a/client/src/components/LinkField/LinkField.js b/client/src/components/LinkField/LinkField.js
@@ -33,6 +33,7 @@ const section = 'SilverStripe\\LinkField\\Controllers\\LinkFieldController';
  * actions - object of redux actions
  * isMulti - whether this field handles multiple links or not
  * canCreate - whether this field can create new links or not
+ * readonly - whether this field is readonly or not
  * ownerID - ID of the owner DataObject
  * ownerClass - class name of the owner DataObject
  * ownerRelation - name of the relation on the owner DataObject
@@ -44,6 +45,7 @@ const LinkField = ({
   actions,
   isMulti = false,
   canCreate,
+  readonly,
   ownerID,
   ownerClass,
   ownerRelation,
@@ -191,11 +193,34 @@ const LinkField = ({
         isFirst={i === 0}
         isLast={i === linkIDs.length - 1}
         isSorting={isSorting}
+        canCreate={canCreate}
+        readonly={readonly}
       />);
     }
     return links;
   };
 
+  const sortableLinks = () => {
+    if (isMulti && !readonly) {
+      return <div className={linksClassName}>
+        <DndContext modifiers={[restrictToVerticalAxis, restrictToParentElement]}
+          sensors={sensors}
+          collisionDetection={closestCenter}
+          onDragStart={handleDragStart}
+          onDragEnd={handleDragEnd}
+        >
+          <SortableContext 
+            items={linkIDs}
+            strategy={verticalListSortingStrategy}
+          >
+            {links}
+          </SortableContext>
+        </DndContext>
+      </div> 
+    }
+    return <div>{links}</div>
+  };
+
   const handleDragStart = (event) => {
     setLinksClassName(classnames({
       'link-picker__links': true,
@@ -254,23 +279,9 @@ const LinkField = ({
           onModalClosed={onModalClosed}
           types={types}
           canCreate={canCreate}
+          readonly={readonly}
         /> }
-      { isMulti && <div className={linksClassName}>
-        <DndContext modifiers={[restrictToVerticalAxis, restrictToParentElement]}
-          sensors={sensors}
-          collisionDetection={closestCenter}
-          onDragStart={handleDragStart}
-          onDragEnd={handleDragEnd}
-        >
-          <SortableContext 
-            items={linkIDs}
-            strategy={verticalListSortingStrategy}
-          >
-            {links}
-          </SortableContext>
-        </DndContext>
-      </div> }
-      { !isMulti && <div>{links}</div>}
+      {sortableLinks()}
       { renderModal && <LinkModalContainer
           types={types}
           typeKey={data[editingID]?.typeKey}
@@ -291,6 +302,7 @@ LinkField.propTypes = {
   actions: PropTypes.object.isRequired,
   isMulti: PropTypes.bool,
   canCreate: PropTypes.bool.isRequired,
+  readonly: PropTypes.bool.isRequired,
   ownerID: PropTypes.number.isRequired,
   ownerClass: PropTypes.string.isRequired,
   ownerRelation: PropTypes.string.isRequired,

diff --git a/client/src/components/LinkField/tests/LinkField-test.js b/client/src/components/LinkField/tests/LinkField-test.js
@@ -37,6 +37,7 @@ function makeProps(obj = {}) {
     },
     isMulti: false,
     canCreate: true,
+    readonly: false,
     ownerID: 123,
     ownerClass: 'Page',
     ownerRelation: 'MyRelation',

diff --git a/client/src/components/LinkPicker/LinkPicker.js b/client/src/components/LinkPicker/LinkPicker.js
@@ -9,7 +9,7 @@ import LinkModalContainer from 'containers/LinkModalContainer';
 /**
  * Component which allows users to choose a type of link to create, and opens a modal form for it.
  */
-const LinkPicker = ({ types, onModalSuccess, onModalClosed, canCreate }) => {
+const LinkPicker = ({ types, onModalSuccess, onModalClosed, canCreate, readonly }) => {
   const [typeKey, setTypeKey] = useState('');
 
   /**
@@ -43,7 +43,7 @@ const LinkPicker = ({ types, onModalSuccess, onModalClosed, canCreate }) => {
   const allowedTypes = typeArray.filter(type => type.allowed);
   const message = i18n._t('LinkField.CANNOT_CREATE_LINK', 'Cannot create link');
 
-  if (!canCreate || allowedTypes.length === 0) {
+  if (!canCreate || allowedTypes.length === 0 || readonly) {
     return (
       <div className={className}>
         <div className="link-picker__cannot-create">
@@ -72,7 +72,8 @@ LinkPicker.propTypes = {
   types: PropTypes.object.isRequired,
   onModalSuccess: PropTypes.func.isRequired,
   onModalClosed: PropTypes.func,
-  canCreate: PropTypes.bool.isRequired
+  canCreate: PropTypes.bool.isRequired,
+  readonly: PropTypes.bool.isRequired,
 };
 
 export {LinkPicker as Component};

diff --git a/client/src/components/LinkPicker/LinkPicker.scss b/client/src/components/LinkPicker/LinkPicker.scss
@@ -98,6 +98,10 @@
   &--published::before {
     display: none;
   }
+
+  &--readonly {
+    background-color: $gray-100;
+  }
 }
 
 .link-picker__link--is-first,

diff --git a/client/src/components/LinkPicker/LinkPickerTitle.js b/client/src/components/LinkPicker/LinkPickerTitle.js
@@ -46,6 +46,8 @@ const LinkPickerTitle = ({
   isFirst,
   isLast,
   isSorting,
+  canCreate,
+  readonly,
 }) => {
   const { loading } = useContext(LinkFieldContext);
   const {
@@ -65,6 +67,7 @@ const LinkPickerTitle = ({
     'link-picker__link--is-last': isLast,
     'link-picker__link--is-sorting': isSorting,
     'form-control': true,
+    'link-picker__link--readonly': readonly || !canCreate,
   };
   if (versionState) {
     classes[`link-picker__link--${versionState}`] = true;
@@ -80,7 +83,7 @@ const LinkPickerTitle = ({
     {...attributes}
     {...listeners}
   >
-    { isMulti && <div className="link-picker__drag-handle"><i className="font-icon-drag-handle"></i></div> }
+    { (isMulti && !readonly) && <div className="link-picker__drag-handle"><i className="font-icon-drag-handle"></i></div> }
     <Button disabled={loading} className={`link-picker__button ${typeIcon}`} color="secondary" onClick={stopPropagation(onClick)}>
       <div className="link-picker__link-detail">
         <div className="link-picker__title">
@@ -93,7 +96,7 @@ const LinkPickerTitle = ({
         </small>
       </div>
     </Button>
-    {canDelete &&
+    {(canDelete && !readonly) &&
       <Button disabled={loading} className="link-picker__delete" color="link" onClick={stopPropagation(() => onDelete(id))}>{deleteText}</Button>
     }
   </div>
@@ -113,6 +116,8 @@ LinkPickerTitle.propTypes = {
   isFirst: PropTypes.bool.isRequired,
   isLast: PropTypes.bool.isRequired,
   isSorting: PropTypes.bool.isRequired,
+  canCreate: PropTypes.bool.isRequired,
+  readonly: PropTypes.bool.isRequired,
 };
 
 export default LinkPickerTitle;
diff --git a/client/src/components/LinkPicker/tests/LinkPicker-test.js b/client/src/components/LinkPicker/tests/LinkPicker-test.js
@@ -8,6 +8,7 @@ function makeProps(obj = {}) {
   return {
     types: { phone: { key: 'phone', title: 'Phone', icon: 'font-icon-phone', allowed: true } },
     canCreate: true,
+    readonly: false,
     onModalSuccess: () => {},
     onModalClosed: () => {},
     ...obj

diff --git a/client/src/components/LinkPicker/tests/LinkPickerTitle-test.js b/client/src/components/LinkPicker/tests/LinkPickerTitle-test.js
@@ -14,6 +14,8 @@ function makeProps(obj = {}) {
     typeTitle: 'Phone',
     typeIcon: 'font-icon-phone',
     canDelete: true,
+    canCreate: true,
+    readonly: false,
     onDelete: () => {},
     onClick: () => {},
     isMulti: false,
@@ -89,3 +91,17 @@ test('LinkPickerTitle main button should not fire the onClick callback while loa
   fireEvent.click(container.querySelector('button.link-picker__button'));
   expect(mockOnClick).toHaveBeenCalledTimes(0);
 });
+
+test('LinkPickerTitle render() should have readonly class if set to readonly', () => {
+  const { container } = render(<LinkFieldContext.Provider value={{ loading: false }}>
+    <LinkPickerTitle {...makeProps({ readonly: true })} />
+  </LinkFieldContext.Provider>);
+  expect(container.querySelectorAll('.link-picker__link--readonly')).toHaveLength(1);
+});
+
+test('LinkPickerTitle render() should not have readonly class if set to readonly', () => {
+  const { container } = render(<LinkFieldContext.Provider value={{ loading: false }}>
+    <LinkPickerTitle {...makeProps({ readonly: false })} />
+  </LinkFieldContext.Provider>);
+  expect(container.querySelectorAll('.link-picker__link--readonly')).toHaveLength(0);
+});
diff --git a/client/src/entwine/LinkField.js b/client/src/entwine/LinkField.js
@@ -55,6 +55,7 @@ jQuery.entwine('ss', ($) => {
         isMulti: this.data('is-multi') ?? false,
         types: this.data('types') ?? {},
         canCreate: inputField.data('can-create') ? true : false,
+        readonly: inputField.data('readonly') ? true : false,
       };
     },
 

diff --git a/src/Controllers/LinkFieldController.php b/src/Controllers/LinkFieldController.php
@@ -20,6 +20,7 @@
 use SilverStripe\LinkField\Services\LinkTypeService;
 use SilverStripe\ORM\DataList;
 use SilverStripe\ORM\DataObject;
+use SilverStripe\Security\Security;
 
 class LinkFieldController extends LeftAndMain
 {
@@ -377,7 +378,8 @@ private function createLinkForm(Link $link, string $operation): Form
 
         // Make readonly if fail can check
         if ($operation === 'create' && !$link->canCreate()
-            || $operation === 'edit' && !$link->canEdit()) {
+            || $operation === 'edit' && !$link->canEdit()
+            || $this->isReadOnlyField()) {
             $form->makeReadonly();
         }
 
@@ -387,6 +389,17 @@ private function createLinkForm(Link $link, string $operation): Form
         return $form;
     }
 
+    /**
+     * Get is the owner LinkField is readonly
+     */
+    private function isReadOnlyField(): bool
+    {
+        $ownerClass = $this->getOwnerClassFromRequest();
+        $ownerRelation = $this->ownerRelationFromRequest();
+
+        return (bool) Injector::inst()->get($ownerClass)->getCMSFields()->dataFieldByName($ownerRelation)?->isReadonly();
+    }
+
     /**
      * Get a Link object based on the $ItemID request param
      */
@@ -469,20 +482,41 @@ private function typeKeyFromRequest(): string
     }
 
     /**
-     * Get the owner based on the query string params ownerID, ownerClass, ownerRelation
-     * OR the POST vars OwnerID, OwnerClass, OwnerRelation
+     * Get the owner class based on the query string param OwnerClass
      */
-    private function ownerFromRequest(): DataObject
+    private function getOwnerClassFromRequest(): string
     {
         $request = $this->getRequest();
-        $ownerID = (int) ($request->getVar('ownerID') ?: $request->postVar('OwnerID'));
-        if ($ownerID === 0) {
-            $this->jsonError(404, _t(__CLASS__ . '.INVALID_OWNER_ID', 'Invalid ownerID'));
-        }
         $ownerClass = $request->getVar('ownerClass') ?: $request->postVar('OwnerClass');
         if (!is_a($ownerClass, DataObject::class, true)) {
             $this->jsonError(404, _t(__CLASS__ . '.INVALID_OWNER_CLASS', 'Invalid ownerClass'));
         }
+
+        return $ownerClass;
+    }
+
+    /**
+     * Get the owner ID based on the query string param OwnerID
+     */
+    private function getOwnerIDFromRequest(): int
+    {
+        $request = $this->getRequest();
+        $ownerID = (int) ($request->getVar('ownerID') ?: $request->postVar('OwnerID'));
+        if ($ownerID === 0) {
+            $this->jsonError(404, _t(__CLASS__ . '.INVALID_OWNER_ID', 'Invalid ownerID'));
+        }
+
+        return $ownerID;
+    }
+
+    /**
+     * Get the owner based on the query string params ownerID, ownerClass, ownerRelation
+     * OR the POST vars OwnerID, OwnerClass, OwnerRelation
+     */
+    private function ownerFromRequest(): DataObject
+    {
+        $ownerID = $this->getOwnerIDFromRequest();
+        $ownerClass = $this->getOwnerClassFromRequest();
         $ownerRelation = $this->ownerRelationFromRequest();
         /** @var DataObject $obj */
         $obj = Injector::inst()->get($ownerClass);
@@ -520,6 +554,7 @@ private function ownerRelationFromRequest(): string
         if (!$ownerRelation) {
             $this->jsonError(404, _t(__CLASS__ . '.INVALID_OWNER_RELATION', 'Invalid ownerRelation'));
         }
+
         return $ownerRelation;
     }
 }
diff --git a/src/Form/LinkField.php b/src/Form/LinkField.php
@@ -2,13 +2,10 @@
 
 namespace SilverStripe\LinkField\Form;
 
-use LogicException;
 use SilverStripe\Forms\FormField;
 use SilverStripe\LinkField\Models\Link;
 use SilverStripe\LinkField\Form\Traits\AllowedLinkClassesTrait;
 use SilverStripe\LinkField\Form\Traits\LinkFieldGetOwnerTrait;
-use SilverStripe\ORM\DataObject;
-use SilverStripe\ORM\DataObjectInterface;
 
 /**
  * Allows CMS users to edit a Link object.
@@ -37,6 +34,7 @@ public function getSchemaStateDefaults()
     {
         $data = parent::getSchemaStateDefaults();
         $data['canCreate'] = $this->getOwner()->canEdit();
+        $data['readonly'] = $this->isReadonly();
         return $data;
     }
 
@@ -45,6 +43,7 @@ protected function getDefaultAttributes(): array
         $attributes = parent::getDefaultAttributes();
         $attributes['data-value'] = $this->Value();
         $attributes['data-can-create'] = $this->getOwner()->canEdit();
+        $attributes['data-readonly'] = $this->isReadonly();
         $ownerFields = $this->getOwnerFields();
         $attributes['data-owner-id'] = $ownerFields['ID'];
         $attributes['data-owner-class'] = $ownerFields['Class'];
@@ -62,4 +61,15 @@ public function getSchemaDataDefaults()
         $data['ownerRelation'] = $ownerFields['Relation'];
         return $data;
     }
+
+    /**
+     * Changes this field to the readonly field.
+     */
+    public function performReadonlyTransformation()
+    {
+        $clone = clone $this;
+        $clone->setReadonly(true);
+
+        return $clone;
+    }
 }
diff --git a/src/Form/MultiLinkField.php b/src/Form/MultiLinkField.php
@@ -54,6 +54,7 @@ public function getSchemaStateDefaults()
         $data = parent::getSchemaStateDefaults();
         $data['value'] = $this->getValueArray();
         $data['canCreate'] = $this->getOwner()->canEdit();
+        $data['readonly'] = $this->isReadonly();
         return $data;
     }
 
@@ -62,6 +63,7 @@ protected function getDefaultAttributes(): array
         $attributes = parent::getDefaultAttributes();
         $attributes['data-value'] = $this->getValueArray();
         $attributes['data-can-create'] = $this->getOwner()->canEdit();
+        $attributes['data-readonly'] = $this->isReadonly();
         $ownerFields = $this->getOwnerFields();
         $attributes['data-owner-id'] = $ownerFields['ID'];
         $attributes['data-owner-class'] = $ownerFields['Class'];
@@ -155,4 +157,15 @@ private function loadFrom(DataObject $record): void
         $value = array_values($relation->getIDList() ?? []);
         parent::setValue($value);
     }
+
+    /**
+     * Changes this field to the readonly field.
+     */
+    public function performReadonlyTransformation()
+    {
+        $clone = clone $this;
+        $clone->setReadonly(true);
+
+        return $clone;
+    }
 }