Merge pull request #4482 from christianbeeznest/RNA-20418

Document - Add option to define if a document can be downloaded or not - refs BT#20418

main/document/edit_document.php

@@ -334,6 +334,12 @@ if ($is_allowed_to_edit) {
             }
         }
 
+        // It saves extra fields values
+        $extraFieldValue = new ExtraFieldValue('document');
+        $values = $_REQUEST;
+        $values['item_id'] = $document_id;
+        $extraFieldValue->saveFieldValues($values);
+
         $url = 'document.php?id='.$document_data['parent_id'].'&'.api_get_cidreq().($is_certificate_mode ? '&curdirpath=/certificates&selectcat=1' : '');
 
         $redirectToEditPage = isset($_POST['button_ck']) && 1 === (int) $_POST['button_ck'];
@@ -459,6 +465,19 @@ if ($owner_id == api_get_user_id() ||
         $form->addElement('textarea', 'comment', get_lang('Comment'), ['cols-size' => [2, 10, 0]]);
     }
 
+    $itemId = isset($_GET['id']) ? (int) $_GET['id'] : 0;
+    $extraField = new ExtraField('document');
+    $extraField->addElements(
+        $form,
+        $itemId,
+        [], //exclude
+        false, // filter
+        false, // tag as select
+        [], //show only fields
+        [], // order fields
+        [] // extra data
+    );
+
     if ($file_type != 'link') {
         if ($owner_id == api_get_user_id() || api_is_platform_admin()) {
             $checked = &$form->addElement('checkbox', 'readonly', null, get_lang('ReadOnly'));

main/inc/lib/document.lib.php

@@ -5328,6 +5328,15 @@ class DocumentManager
         $document_data['file_extension'] = $extension;
 
         if (!$show_as_icon) {
+            // to force download if a document can be downloaded or not
+            $hideDownloadIcon = false;
+            if (true === api_get_configuration_value('documents_hide_download_icon')) {
+                $hideDownloadIcon = true;
+            }
+            if (self::getHideDownloadIcon($document_data['id'])) {
+                $hideDownloadIcon = false;
+            }
+            if (!$hideDownloadIcon) {
                 if ($filetype == 'folder') {
                     if ($isAllowedToEdit ||
                         api_is_platform_admin() ||
@@ -5354,6 +5363,7 @@ class DocumentManager
                     $force_download_html = $size == 0 ? '' : '<a href="'.$forcedownload_link.'" style="float:right"'.$prevent_multiple_click.' download="'.$document_data['basename'].'">'.
                         Display::return_icon($forcedownload_icon, get_lang('Download'), [], ICON_SIZE_SMALL).'</a>';
                 }
+            }
 
             // Copy files to user's myfiles
             if (api_get_setting('allow_my_files') === 'true' &&
@@ -7461,4 +7471,23 @@ class DocumentManager
 
         return $btn;
     }
+
+    /**
+     * It gest extra value to define if download icon is visible or not.
+     *
+     * @param $documentId
+     *
+     * @return bool
+     */
+    public static function getHideDownloadIcon($documentId)
+    {
+        $extraFieldValue = new ExtraFieldValue('document');
+        $extraValue = $extraFieldValue->get_values_by_handler_and_field_variable($documentId, 'can_be_downloaded');
+        $canBeDownloadedIcon = false;
+        if (!empty($extraValue) && isset($extraValue['value'])) {
+            $canBeDownloadedIcon = (bool) $extraValue['value'];
+        }
+
+        return $canBeDownloadedIcon;
+    }
 }

main/inc/lib/extra_field.lib.php

@@ -171,6 +171,9 @@ class ExtraField extends Model
             case 'message':
                 $this->extraFieldType = EntityExtraField::MESSAGE_TYPE;
                 break;
+            case 'document':
+                $this->extraFieldType = EntityExtraField::DOCUMENT_TYPE;
+                break;
         }
 
         $this->pageUrl = 'extra_fields.php?type='.$this->type;
@@ -204,6 +207,7 @@ class ExtraField extends Model
             'lp_view',
             'course_announcement',
             'message',
+            'document'
         ];
 
         if (api_get_configuration_value('allow_scheduled_announcements')) {

main/install/configuration.dist.php

@@ -2317,6 +2317,10 @@ INSERT INTO `extra_field` (`extra_field_type`, `field_type`, `variable`, `displa
 // Disable links in gradebook view for students
 // $_configuration['gradebook_hide_link_to_item_for_student'] = false;
 
+// It adds option to define if a document can be downloaded or not.
+// Create an extra field document named "CanBeDownloaded" of type "Yes/No" that is set to "No" by default.
+// $_configuration['documents_hide_download_icon'] = false;
+
 // KEEP THIS AT THE END
 // -------- Custom DB changes
 // Add user activation by confirmation email

src/Chamilo/CoreBundle/Entity/ExtraField.php

@@ -41,6 +41,7 @@ class ExtraField extends BaseAttribute
     public const LP_VIEW_TYPE = 20;
     public const COURSE_ANNOUNCEMENT = 21;
     public const MESSAGE_TYPE = 22;
+    public const DOCUMENT_TYPE = 23;
 
     /**
      * @var int