chore(core): Expose the editableAsText attribute, even if the metadata file doesn't have it yet #27393

dotCMS/src/main/java/com/dotcms/storage/FileStorageAPI.java

@@ -1,5 +1,6 @@
 package com.dotcms.storage;
 
+import com.dotcms.storage.model.BasicMetadataFields;
 import com.dotmarketing.exception.DotDataException;
 import com.dotmarketing.util.Config;
 
@@ -8,8 +9,11 @@
 import java.util.Map;
 
 /**
- * This class is in charge of resolve File (on diff repositories), metadata, etc.
+ * This Storage API is in charge of generating, removing and storing file metadata in dotCMS using
+ * the File System as its storage volume.
+ *
  * @author jsanca
+ * @since Oct 19th, 2020
  */
 public interface FileStorageAPI {
 
@@ -56,9 +60,23 @@ Map<String, Serializable> generateMetaData(final File binary, final GenerateMeta
             throws DotDataException;
 
     /**
-     * Retrieve the metadata
-     * @param requestMetaData {@link FetchMetadataParams}
-     * @return  Map with the metadata
+     * Retrieves the metadata object from the configured Storage Provider. There are a couple of
+     * aspects to take into consideration when calling this method:
+     * <ul>
+     *     <li>Depending on the configuration of the {@link FetchMetadataParams} parameter, the
+     *     resulting metadata object may be cached.</li>
+     *     <li>For performance reasons, the {@link BasicMetadataFields#EDITABLE_AS_TEXT} property
+     *     is always calculated <b>UNLESS</b> it's already present in the metadata Map. This way,
+     *     Files don't need to be re-indexed for it to be available.</li>
+     * </ul>
+     *
+     * @param requestMetaData The {@link FetchMetadataParams} object specifying how the metadata
+     *                        should be retrieved.
+     *
+     * @return A key/value Map with the expected metadata properties.
+     *
+     * @throws DotDataException An error occurred when retrieving the metadata from the Storage
+     *                          Provider.
      */
     Map<String, Serializable> retrieveMetaData(final FetchMetadataParams requestMetaData) throws DotDataException;
 

dotCMS/src/main/java/com/dotcms/storage/FileStorageAPIImpl.java

@@ -6,6 +6,7 @@
 import com.dotmarketing.business.CacheLocator;
 import com.dotmarketing.exception.DotDataException;
 import com.dotmarketing.portlets.contentlet.business.MetadataCache;
+import com.dotmarketing.util.FileUtil;
 import com.dotmarketing.util.Logger;
 import com.google.common.annotations.VisibleForTesting;
 import com.google.common.collect.ImmutableMap;
@@ -26,6 +27,7 @@
 
 import static com.dotcms.storage.StoragePersistenceAPI.HASH_OBJECT;
 import static com.dotcms.storage.model.BasicMetadataFields.CONTENT_TYPE_META_KEY;
+import static com.dotcms.storage.model.BasicMetadataFields.EDITABLE_AS_TEXT;
 import static com.dotcms.storage.model.BasicMetadataFields.LENGTH_META_KEY;
 import static com.dotcms.storage.model.BasicMetadataFields.SIZE_META_KEY;
 import static com.dotcms.storage.model.BasicMetadataFields.VERSION_KEY;
@@ -75,22 +77,11 @@
                 CacheLocator.getMetadataCache());
     }
 
-    /**
-     * {@inheritDoc}
-     * @param binary {@link File} file to get the information
-     * @return
-     */
     @Override
     public Map<String, Serializable> generateRawBasicMetaData(final File binary) {
         return this.generateBasicMetaData(binary, s -> true); // raw = no filter
     }
 
-    /**
-     * {@inheritDoc}
-     * @param binary  {@link File} file to get the information
-     * @param maxLength {@link Long} max length is used when parse the content, how many bytes do you want to parse.
-     * @return
-     */
     @Override
     public Map<String, Serializable> generateRawFullMetaData(final File binary, long maxLength) {
         return this.generateFullMetaData(binary, s -> true, maxLength); // raw = no filter
@@ -195,12 +186,6 @@
         return metadataMap;
     }
 
-    /**
-     * {@inheritDoc}
-     * @param binary {@link File} file to get the information
-     * @param configuration {@link GenerateMetadataConfig}
-     * @return
-     */
     @Override
     public Map<String, Serializable> generateMetaData(final File binary,
             final GenerateMetadataConfig configuration) throws DotDataException {
@@ -387,50 +372,56 @@
         }
     }
 
-    /**
-     * {@inheritDoc}
-     * @param requestMetaData {@link FetchMetadataParams}
-     * @return
-     */
     @Override
     public Map<String, Serializable> retrieveMetaData(final FetchMetadataParams requestMetaData)
             throws DotDataException {
         if (requestMetaData.isCache()) {
-            final Map<String, Serializable> metadataMap = metadataCache
+            final Map<String, Serializable> metadataMap = this.metadataCache
                     .getMetadataMap(requestMetaData.getCacheKeySupplier().get());
             if (null != metadataMap) {
+                checkEditableAsText(metadataMap);
+                putIntoCache(requestMetaData.getCacheKeySupplier().get(), metadataMap);
                 return metadataMap;
             }
         }
 
         Map<String, Serializable> metadataMap = null;
         final StorageKey storageKey = requestMetaData.getStorageKey();
-        final StoragePersistenceAPI storage = persistenceProvider
+        final StoragePersistenceAPI storage = this.persistenceProvider
                 .getStorage(storageKey.getStorage());
 
         this.checkBucket(storageKey, storage);
         if (storage.existsObject(storageKey.getGroup(), storageKey.getPath())) {
-
             metadataMap = retrieveMetadata(storageKey, storage);
             Logger.debug(FileStorageAPIImpl.class,
-                    "Retrieve the meta data from storage, path: " + storageKey.getPath());
+                    () -> "Retrieve the meta data from storage path: " + storageKey.getPath());
+            checkEditableAsText(metadataMap);
             if (null != requestMetaData.getCacheKeySupplier()) {
                 final Map<String, Serializable> projection = requestMetaData.getProjectionMapForCache().apply(metadataMap);
                 putIntoCache(requestMetaData.getCacheKeySupplier().get(), projection);
                 return projection;
             }
-
         }
-
         return metadataMap;
     }
 
-    /***
-     * {@inheritDoc}
-     * @param requestMetaData {@link FetchMetadataParams}
-     * @return
-     * @throws DotDataException
+    /**
+     * Performs a simple check that verifies whether the File that the metadata belongs to can be
+     * editable as a text file. If it can, the {@link BasicMetadataFields#EDITABLE_AS_TEXT} property
+     * will be added.
+     * <p>This is particularly useful in the File's edit mode in the back-end for dotCMS to allow
+     * content authors to edit the contents directly in the Code Editor field.</p>
+     *
+     * @param metadataMap The File's metadata Map.
      */
+    private void checkEditableAsText(final Map<String, Serializable> metadataMap) {
+        if (!metadataMap.containsKey(BasicMetadataFields.EDITABLE_AS_TEXT.key())) {
+            metadataMap.put(EDITABLE_AS_TEXT.key(),
+                    FileUtil.isFileEditableAsText(metadataMap.get(CONTENT_TYPE_META_KEY.key()).toString()));
+        }
+    }
+
+    @Override
     public boolean removeMetaData(final FetchMetadataParams requestMetaData) throws DotDataException{
         boolean deleteSucceeded = false;
         final StorageKey storageKey = requestMetaData.getStorageKey();
@@ -443,12 +434,7 @@
         return deleteSucceeded;
     }
 
-    /***
-     * {@inheritDoc}
-     * @param requestMetaData {@link FetchMetadataParams}
-     * @return
-     * @throws DotDataException
-     */
+    @Override
     public boolean removeVersionMetaData(final FetchMetadataParams requestMetaData) throws DotDataException{
         boolean deleteSucceeded = false;
         final StorageKey storageKey = requestMetaData.getStorageKey();
@@ -461,12 +447,6 @@
         return deleteSucceeded;
     }
 
-    /**
-     * {@inheritDoc}
-     * @param fetchMetadataParams
-     * @param customAttributes
-     * @throws DotDataException
-     */
     @Override
     public void putCustomMetadataAttributes(
             final FetchMetadataParams fetchMetadataParams,
@@ -527,12 +507,7 @@
 
     }
 
-    /**
-     * {@inheritDoc}
-     * @param requestMetadata
-     * @param metadata
-     * @throws DotDataException
-     */
+    @Override
     public boolean setMetadata(final FetchMetadataParams requestMetadata,
             final Map<String, Serializable> metadata) throws DotDataException {
         final StorageKey storageKey = requestMetadata.getStorageKey();