Update to support recent WidgetBase.php changes

Re-roll.

Sorry to tack this on, but DropzoneJS will still have fatal errors now that we've committed #2366335: Support defining conditions. Here's a new patch.

I can confirm there is a fatal in dropzonejs (or File Entity Browser) without the patch, and that the patch in #6 applies and functionally solves the problem (everything works fine again after applying it).

Fixed per #9.

This isn't quite right - prepareEntities needs to return entities and right now it returns an array type that DropzoneJS uses to load File Entities. Doing one more re-roll with more manual testing this time.

Last review, promise. :-)

I confirm that this patch solve the 'prepareEntities' problem.
But I don't know if it is related to another change in entity browser but I get a new problem:
Fatal error: Call to a member function getStorage() on a non-object in .../modules/dropzonejs/modules/eb_widget/src/Plugin/EntityBrowser/Widget/MediaEntityDropzoneJsEbWidget.php on line 100

This error appears at the last stage of the setting up of the browser:
admin/config/content/entity_browser/my_browser/widgets

If it is not related, I can create a new bug report.

Thanks you for your hard work!

Some more info:

Notice: Undefined property: Drupal\dropzonejs_eb_widget\Plugin\EntityBrowser\Widget\MediaEntityDropzoneJsEbWidget::$entityManager in Drupal\dropzonejs_eb_widget\Plugin\EntityBrowser\Widget\MediaEntityDropzoneJsEbWidget->getBundle() (line 100 of modules/dropzonejs/modules/eb_widget/src/Plugin/EntityBrowser/Widget/MediaEntityDropzoneJsEbWidget.php).

Drupal\dropzonejs_eb_widget\Plugin\EntityBrowser\Widget\MediaEntityDropzoneJsEbWidget->getBundle() (Line: 117)
Drupal\dropzonejs_eb_widget\Plugin\EntityBrowser\Widget\MediaEntityDropzoneJsEbWidget->buildConfigurationForm(Array, Object) (Line: 114)
Drupal\entity_browser\Form\WidgetsConfig->buildForm(Array, Object) (Line: 261)

Replaced entityManager with entityTypeManager to fix the error described in #14.

Tested manually and works fine. Will wait a bit more for additional feedback and then commit.

marvelous, this is perfect! works fine!

The docs for "prepareEntities" describe the method as something that "Prepares the entities without saving them", which is why I wrote it the way I did for this patch. Otherwise you might see strange behavior with multiple calls to that function during one bootstrap or form "session" (i.e. multiple calls to validate over multiple bootstraps).

I'm updating DropzoneJsEbWidget::getForm to match the recent widget-button changes, and doing manual testing as well. Should have a new patch today.

New patch.

I have not made a deep testing, but before this patch, my select button was gone... Now it is ok!
Thank you for your hard work!!!!

If we re-implement prepareEntities(), we would also have to re-implement the validation logic that the parent class uses, or would have to have two prepareEntities() functions - one for the submit callback and one for the validate callback. I'm not sure what the cleanest way to do this is. I guess the question here is - should the MediaEntityDropzoneJsEbWidget widget validate Files, Media Entities, or somehow both?

I have looked also in this issue and it's a bit tricky to get clean solution for prepareEntities() that will return media entities.

Problem is related with 'media_entity' module dependancy, because when that module is not enabled, files will still be uploaded and saved. I don't know is that wanted functionality or not, but best would be that media entity drop zone can't work without that module at all. Then you have clean solution for prepareEntities() that always returns media entities and there is no need for check in submit(), etc.

Regarding validation, I think it should be sufficient to trigger media entity validation, file size/extensions will be anyway checked when file is dropped in zone, based on configuration defined for that widget in EB. So validate() should be re-implemented too and it can be same as in base widget, I guess.

btw. code in DropzoneJsEbWidget.php:
if ($trigger['#value'] == 'Select') {
will not work nice, it would be better to use something else, for example:
if ($trigger['#name'] == 'op') {

The media entity eb widget should be a separate submodule, or handle the dependency in a different way. I am not sure why we didn't do it like that in the first place (probably because it was more of a quick and dirty thing we started with).

I agree, cleanest solution would be separate submodule with properly defined dependencies.

That is possible solution too, only thing that I don't like is coupling of things that potentially will never be used, but that's meaning of plugins.

In that case two tickets are needed:
1. entity browser should be aware of widget dependencies
2. move plugins into dropzonejs module (remove submodule(s))

I have tested patch and it works.
More or less functionality is same as for #21 and I have just adjusted "if" statement otherwise we have dead code there.

I have tested changes from #32, it works for me.

Regarding code:

+++ b/modules/eb_widget/src/Plugin/EntityBrowser/Widget/MediaEntityDropzoneJsEbWidget.php
@@ -150,44 +165,37 @@ class MediaEntityDropzoneJsEbWidget extends DropzoneJsEbWidget {
+      $file = $media_entity->$source_field->entity = $file;

Can $file be changed in process when it's assign to entity field?
If yes, then it would be nice to make that line more readable (split in 2 lines or assign result from file_move to entity field directly and then assign $file from it).

+++ b/modules/eb_widget/src/Plugin/EntityBrowser/Widget/DropzoneJsEbWidget.php
@@ -114,8 +126,53 @@ class DropzoneJsEbWidget extends WidgetBase {
+  public function prepareEntities(array $form, FormStateInterface $form_state) {

Is there need for redeclare of prepareEntities() to be public (because it's defined protected in interface)?

And also code that is commented out should be removed.

Nice work!!!

To test this, I installed the latest Entity Browser module and Dropzone. I tried adding the Media entity Dropzone widget to an Entity browser. I received the following error without the patch:

Fatal error: Class Drupal\dropzonejs_eb_widget\Plugin\EntityBrowser\Widget\DropzoneJsEbWidget contains 1 abstract method and must therefore be declared abstract or implement the remaining methods (Drupal\entity_browser\WidgetBase::prepareEntities) in /var/www/html/drupaltest/modules/dropzonejs/modules/eb_widget/src/Plugin/EntityBrowser/Widget/DropzoneJsEbWidget.php on line 28

After applying the patch:

Uncaught PHP Exception Drupal\\Component\\Plugin\\Exception\\PluginNotFoundException: "The "media_bundle" entity type does not exist." at /var/www/html/drupaltest/core/lib/Drupal/Core/Entity/EntityTypeManager.php line 125, referer: http://localhost/drupaltest/admin/config/content/entity_browser/blah/wid...

After I installed the media entity module:

Uncaught PHP Exception Symfony\\Component\\Routing\\Exception\\RouteNotFoundException: "Route "media.bundle_add" does not exist." at /var/www/html/drupaltest/core/lib/Drupal/Core/Routing/RouteProvider.php line 187

I cleared the cache, rebuild the router and also re-installed all these modules but still received the same error.

@royal121 - did you create any media bundle?
Because you need at least one to be available for selection when you create Media Entity DropzoneJS widget.

I did quick check of patch (not full review):

1. +++ b/modules/eb_widget/src/Plugin/EntityBrowser/Widget/DropzoneJsEbWidget.php
   @@ -114,37 +137,84 @@ class DropzoneJsEbWidget extends WidgetBase {
   +      if (!file_prepare_directory($this->getUploadLocation(), FILE_CREATE_DIRECTORY | FILE_MODIFY_PERMISSIONS)) {
   

   PHP complains in this case, because variable should be passed as reference.

2. +++ b/modules/eb_widget/src/Plugin/EntityBrowser/Widget/MediaEntityDropzoneJsEbWidget.php
   @@ -150,44 +165,35 @@ class MediaEntityDropzoneJsEbWidget extends DropzoneJsEbWidget {
   +      $media_entity->save();
   

    
   And execution of this line triggers warning for me:
   Warning: array_flip(): Can only flip STRING and INTEGER values! in Drupal\Core\Entity\EntityStorageBase->loadMultiple() (line 227 of ../core/lib/Drupal/Core/Entity/EntityStorageBase.php).

   In this case $ids is array with one element and it's NULL. Here is shortened stack trace:

   ...
   24. Drupal\\entity_browser\\Form\\EntityBrowserForm->submitForm() ../core/lib/Drupal/Core/Form/FormSubmitter.php:111
   25. Drupal\\dropzonejs_eb_widget\\Plugin\\EntityBrowser\\Widget\\MediaEntityDropzoneJsEbWidget->submit() ../modules/entity_browser/src/Form/EntityBrowserForm.php:163
   26. Drupal\\Core\\Entity\\Entity->save() ../modules/dropzonejs/modules/eb_widget/src/Plugin/EntityBrowser/Widget/MediaEntityDropzoneJsEbWidget.php:196
   ...
   32. Drupal\\media_entity\\Entity\\Media->automaticallySetThumbnail() ../modules/media_entity/src/Entity/Media.php:185
   33. Drupal\\media_entity_image\\Plugin\\MediaEntity\\Type\\Image->thumbnail() ../modules/media_entity/src/Entity/Media.php:220
   34. Drupal\\Core\\Entity\\EntityStorageBase->load() ../modules/media_entity_image/src/Plugin/MediaEntity/Type/Image.php:209
   35. Drupal\\Core\\Entity\\EntityStorageBase->loadMultiple()

And with same setup I don't get any errors with #32 patch.

I have tested this today and overall looks great. We can wait for additional feedback but I think we are almost done here.

Just some questions/thoughts, I don't know the surrounding code too well.

1. +++ b/modules/eb_widget/src/Plugin/EntityBrowser/Widget/DropzoneJsEbWidget.php
   @@ -114,37 +137,85 @@ class DropzoneJsEbWidget extends WidgetBase {
        $config = $this->getConfiguration();
   +    // @todo Check per user size allowance.
   +    $additional_validators = ['file_validate_size' => [Bytes::toInt($config['settings']['max_filesize']), 0]];
   

   I thought per-user size was removed in Drupal 6 or so, who would re-add this, dropzone specific?

2. +++ b/modules/eb_widget/src/Plugin/EntityBrowser/Widget/DropzoneJsEbWidget.php
   @@ -279,4 +344,12 @@ class DropzoneJsEbWidget extends WidgetBase {
   +   */
   +  public function __sleep() {
   +    return array_diff(parent::__sleep(), ['files']);
   +  }
   +
   

   storing those files makes things a bit more complicated, I guess that's needed because getFiles() is called more than once?

3. +++ b/modules/eb_widget/src/Plugin/EntityBrowser/Widget/MediaEntityDropzoneJsEbWidget.php
   @@ -195,4 +201,12 @@ class MediaEntityDropzoneJsEbWidget extends DropzoneJsEbWidget {
   +   * {@inheritdoc}
   +   */
   +  public function __sleep() {
   +    return array_diff(parent::__sleep(), ['bundle']);
   +  }
   

   hm, avoing the bundle property should be easier, though. is it really worth statically caching that?

   config entities do optionally support static cache, you just have to enable it. trying to enable it by default showed a few side effects though that we haven't yet figured out (that's why it didn't happen).

   also, the config objects themself are already statically cached.

4. +++ b/src/DropzoneJsUploadSaveInterface.php
   @@ -27,32 +22,21 @@ interface DropzoneJsUploadSaveInterface {
   -   *   A new entity file entity object, not saved yet.
   -   */
   -  public function fileEntityFromUri($uri, AccountProxyInterface $user);
   +  public function saveFile($uri, $destination, $extensions, AccountProxyInterface $user, $validators = [], $save_file = TRUE);
   

   I haven't checked how often this is saved vs not, but maybe instead of an optional argument, saving could be done by the caller if it is only a few cases. a different name might also make sense then.

I worked with this patch the entire day and it seemed to work quite well.

Could @dawehner please share which versions about the dependencies of media entity are using, I want to use media entity, I have some errors with the combinations of modules, thks

+++ b/src/DropzoneJsUploadSave.php
@@ -158,30 +162,22 @@ class DropzoneJsUploadSave implements DropzoneJsUploadSaveInterface {
    */
-  public function fileEntityFromUri($uri, AccountProxyInterface $user) {
-    $uri = file_stream_wrapper_uri_normalize($uri);
-    $file_info = new \SplFileInfo($uri);
+  protected function fileEntityFromUri($uri, AccountProxyInterface $user) {
 
-    // Begin building file entity.
-    $values = [
-      'uid' => $user->id(),
-      'status' => 0,
-      'filename' => $file_info->getFilename(),
-      'uri' => $uri,
-      'filesize' => $file_info->getSize(),
-      'filemime' => $this->mimeTypeGuesser->guess($uri),
-    ];
-
-    /** @var \Drupal\file\FileInterface $file */
-    $file = $this->entityManager->getStorage('file')->create($values);
     return $file;
   }

And so God spoke: "Though shall be a file". And so it was.

I think you removed a bit too much here :) (or more likely, didn't replace with something else)

Facing issue WSOD while installing "File Browser" module.Confirm that 2763529_51.patch patch working properly to install module without any issue.

@slashrsm: Fine from my POV. I haven't tested it but I think others did :)

I'm going to provide feedback about the behavior of this patch tomorrow if you want to wait for another review.

Merged. Thanks to all for this awesome work!