theme no longer behaves since upgrading from media <=2.0-alpha3

Hi Joseph,

backtrace-m1.log = Media 7.x-1.5 *
backtrace-m2.log = Media 7.x-2.6

I modified your back trace to use [=] as unique find-ables and added $form and $form_state to make it easier.

if ($fp = fopen('backtrace-m1.log', 'a')) {
  $bt = debug_backtrace();
  fwrite($fp, 'form[=]'.print_r($form, true));
  fwrite($fp, 'form_state[=]'.print_r($form_state, true));
  fwrite($fp, 'debug[=]'.print_r($bt, true));
  fclose($fp);
}

Added just prior to line 1520:

$function($form, $form_state);

Steps used:

Pre-load /admin/appearance/settings/theme1033
Delete backtrace-mN.log
Click ‘Reset to defaults’

This gives two of each variable, six sections total.

# # #

KDiff3 shows a large amount of variation (besides the expected for different items checked and pictures loaded).

About line 2514, we start getting additions of:

[#value_callback] => media_file_value

and

[#pre_render] => Array
                                        (
                                            [0] => media_element_pre_render
                                        )

====

The [js] => Array just below that has a completely different way of referencing sites/all/modules/media/js/media.js.

# # #

I’ve also attached theme-settings.php for reference.

I can also give you tarballs of the m1 and m2 sites. Take a day or so, as I’ll have to strip out the users and any proprietary content.

What would you like me to do at this point?

Best,
Michael

* D.O won't allow a 16MB file size to be uploaded (contrary to the 50MB it claims). Had to tar them.

# # # Other reference

michael@local [~/public_html/d7ptst]# php -v
PHP 5.5.9-1ubuntu4.21 (cli) (built: Feb  9 2017 20:54:58)
Copyright (c) 1997-2014 The PHP Group
Zend Engine v2.5.0, Copyright (c) 1998-2014 Zend Technologies
    with Zend OPcache v7.0.3, Copyright (c) 1999-2014, by Zend Technologies

michael@local [~/public_html/d7pat]# mysql -V
mysql  Ver 14.14 Distrib 5.5.55, for debian-linux-gnu (x86_64) using readline 6.3

michael@local [~/public_html/d7ptst]# drush status
 Drupal version                :  7.54
 Site URI                      :  http://default
 Database driver               :  mysql
 Database hostname             :  localhost
 Database username             :  inetd_d7ptst
 Database name                 :  inetd_d7ptst
 Database                      :  Connected
 Drupal bootstrap              :  Successful
 Drupal user                   :  Anonymous
 Default theme                 :  theme1033
 Administration theme          :  seven
 PHP configuration             :  /etc/php5/cli/php.ini
 Drush version                 :  5.7
 Drush configuration           :
 Drupal root                   :  /home/michael/public_html/d7ptst
 Site path                     :  sites/default
 File directory path           :  sites/default/files/public
 Private file directory path   :  sites/default/files/private
 temp                          :  /tmp

michael@local [~/public_html/d7pat]# drush status
 Drupal version                :  7.54
 Site URI                      :  http://default
 Database driver               :  mysql
 Database hostname             :  localhost
 Database username             :  inetd_d7pat
 Database name                 :  inetd_d7pat
 Database                      :  Connected
 Drupal bootstrap              :  Successful
 Drupal user                   :  Anonymous
 Default theme                 :  theme1033
 Administration theme          :  seven
 PHP configuration             :  /etc/php5/cli/php.ini
 Drush version                 :  5.7
 Drush configuration           :
 Drupal root                   :  /home/michael/public_html/d7pat
 Site path                     :  sites/default
 File directory path           :  sites/default/files/public
 Private file directory path   :  sites/default/files/private
 temp                          :  /tmp

huh, forgot to change the Status back to active...

Hi Joseph,

This is a purchased theme that works fine in Media 1.x. I am requesting information on how to upgrade its forms from Media 1.x to 2.x.

The use of Media in this theme administration page is quite small. I’ve added screen caps of the one tab where Media is used. Each drop down has the choices ‘None,’ ‘Image,’ and ‘Video.’ I’ve selected those in the first three regions. The ‘Image’ selection is the only use of Media (that I’m aware of), and it is called once for each of the 12 regions. media-regions-settings-07.jpg shows the pop up from clicking “Select media.”

While I didn’t write this code, I have no problem fixing it, but I do need a maintainer of the Media module to tell me what changed between 1.x and 2.x that breaks it. I was hoping you would spend the 15 minutes looking at the diff between the two backtraces to identify what Media 2.x broke, or what it now does differently that breaks a Media 1.x form.

These are swags, but:

What API changes did Media 2.x make?
What function(s) became no longer used?
What data structure(s) changed?

The code for a simple, known good, form that works in Media 1.x and code for the same form used for Media 2.x, to use for an example is also highly desired.

Best,
Michael

Hi,

I'm administering three websites, and all of them happen to use templates created by this same vendor. The upgrade from Media 1.x to 2.x went well. However when editing the themes' settings and committing them, this error is shown and the changes aren't committed:

"Error: Call to undefined function theme<my theme number>_form_system_theme_settings_submit() in form_execute_handlers() (line 1520 of <my specific path>/includes/form.inc). - The website encountered an unexpected error. Please try again later."

So it's the exact same problem. I'm no stranger to PHP, however not in a Drupal context. So I don't know what to do with earlier mentioned debugging code in order to find out what the problem is. I'm sorry about that.

To the point... The good thing is, this vendor offers one theme/template for free which uses the same code as the themes I'm having troubles with since Media 2.x. So anyone willing to help might want to download the Free Museum Drupal Template from here (http://info.template-help.com/help/drupal-template.html) and have a look at which point the theme's code conflicts with the Media 2.x module. I don't mind having to alter the theme's code, as long as I know *what* to alter.

I hope this comment is helpful and will not be seen as spam. Even worse, I wouldn't recommend purchasing these templates for use in new projects: they're old and therefore contain modules that cause problems when updating them.

I forgot to mention this because I didn't think it's important. When I open the theme's settings page (admin/appearance/settings/themeXXXX), twelve identical warnings are shown:

Warning: array_flip(): Can only flip STRING and INTEGER values! in DrupalDefaultEntityController->load() (line 175 of /opt/lampp/htdocs/apps/themefix/includes/entity.inc).

As I'm still in urgent need for a solution, and as I'm now suspecting these 12 warnings might cause the error when the form page is submitted, I am now trying to investigate these 12 warnings first...

EDIT
sites/all/modules/media/media.module:930 shows: file_load($default_fid). I can get rid of the 12 array_flips() warnings by casting to integer: file_load((int) $default_fid). However, the error with submitting the form is still there, so I assume these 12 warnings don't have anything to do with it.

> Any chance you can try an older 2.x release like example 7.x-2.x-beta2?

Sure. I can easily step through from 1.5 to 2.8.

Wish I'd thought of that myself :(

And thanks @pacow, I'll use their free demo, so I don't have the ~250 CK modules in the mix...

Back Friday(ish)

Michael

I am able to reproduce the error with PHP versions 5.3.3, 5.6.30, 5.4.16, 7.0.18, so differences in PHP versions might not be the problem.

I tried older versions for Media and File Entity in order to see with which one the problem is introduced. The latest combination that doesn't show the error message is: Media 2.0-alpha3 + File Entity 2.0-alpha3, both released October 26 2013. The next combination (Media 2.0-alpha4 + File Entity 2.0-beta1, October 4 2014) introduces the problem. In fact upgrading only File Entity to 2.0-beta1 works OK. If I instead only upgrade Media to 2.0-alpha4, the problem is introduced.

To further investigate, I disabled Media's submodules one by one (such as Media Internet Sources) and the problem was still there. When I finally disabled Media itself (while File Entity was still enabled) the problem disappeared. So I can now more precisely conclude that the problem starts occurring with Media's main module version Media 2.0-alpha4.

Indeed alpha4 has a huge changelog, so the following might point us to the exact commit... I did a stack trace with each warning. They mention media.module line 855 (still in alpha4) which inside the media_file_value() function says:

// Confirm that the file exists when used as a default value.
    if ($default_fid && $file = file_load($default_fid)) {
      $fid = $file->fid;
    }

If this info isn't useful, I can still do the debug path you suggested. It'll take some time but I just need to solve this. :-)

Hi, sorry for the delay, I was on vacation. :-) The patch unfortunately doesn't change the situation.

Today I'm diving deeper in it, I'll post my findings here.

***summary***

1. The theme's settings form shows a range of identical warnings: Warning: array_flip(): Can only flip STRING and INTEGER values! in DrupalDefaultEntityController->load() (line 175 of includes/entity.inc).
2. Submitting the form raises an error: Error: Call to undefined function themeXXXX_form_system_theme_settings_submit() in form_execute_handlers() (line 1520 of includes/form.inc)

We need to get rid of the error in order to be able to save the theme's settings. The error might or might not be related to the warnings, but I can't be sure about that until we eliminate the warnings first...

***end of summary***

I managed to get rid of the warnings. In the patched (or unpatched) code in function media_file_value(), replace file_load($default_fid) with file_load($default_fid['fid']). Perhaps more lines need this fix.

I'm not sure I did the right thing (EDIT: it might even be the theme that passes data in the wrong format), but the warnings are gone and the image file form fields seem to work correctly now. Debug backtraces showed me that data was wrapped into an array twice while it needed to be done just once. file_load() calls file_load_multiple() and both seem to wrap things in an array. The result was: array_flip() was swapping an integer key with an array value while an array can't be used as a key. Instead it was this array's content that needed to be flipped.

The submit error remains however...

I am having this same issue with a template from the same place. I assume this affects many drupal templates from them. I was receiving errors when in Structure under blocks as well as Modules and Configuration.
I made the change in comment 20 and it seems to have cleaned up the warnings. But can not verify that it is fully functioning. Is there another fix for this?

Thanks.

About the warnings... @Brad.D I'm glad my change helps you. Keep in mind that I'm still uncertain about the correctness of my suggested fix. I'm beginning to think the theme's code needs a fix instead, but I'm also beginning to get stuck.

About the error... Thanks @joseph.olstad for pointing to the page about the submit handler. You resolved the issue by following the instructions by @scottm316.

I must admit I need some hints about how to implement these instructions... I found this file sites/all/themes/themeXXXX/theme-settings.php and I suspect this one needs the change. In it there's a function called themeXXXX_form_system_theme_settings_alter( &$form, &$form_state ), and perhaps it's these lines inside this function that need adjustment:

/* Submit function */
$form['#submit'][] = 'themeXXXX_form_system_theme_settings_submit';

/* Add reset button */
$form['actions']['reset'] = array(
	'#submit' => array( 'themeXXXX_form_system_theme_settings_reset' ),
	'#type' => 'submit',
	'#value' => t( 'Reset to defaults' ),
);

I tried changing the first line, but that didn't work. It's my lack of knowledge again getting me stuck here...

@pacow Yes looks like that fix didn't correct everything. When I went in to modify some images that use the media module it had all types of errors. Unfortunately I just have not had the time to look through the code though I agree it's the template that needs corrected. I contacted support from template help but they just said to use the modules that come with it. Lots of help they are.

That didn't change anything, unfortunately.

As a workaround I would like to roll back my sites to Media (and File Entity) 7.x-2.0 Alpha 3. I know rolling back module versions is tricky. However, I did manage to do this rollback on local copies of my sites. Just by disabling modules, replacing them manually, and enabling them again. If it won't cause any side effects, I'll do this with my live sites too so I can resume my work.

#27 : There is no base theme. The *.info* file has no *base* config line.

#28 : *system_theme_settings_reset* is indeed a specific function, defined in *theme-settings.php*.

I almost forgot not everything in the world is open source. ;-) It might not be allowed to paste the code over here due to license stuff.

Fortunately one of their templates is freely available (#8): it's basically the same as the other ones and it raises the same problems. This free theme is meant as a demo, not for real use. I'm not a lawyer but I think it's okay for us to discuss that template's code just for our purpose. It's the second theme over here: http://info.template-help.com/help/drupal-template.html (it's called Museum). After installing (and ignoring a fatal error, a.f.i.k. the non-free themes don't have that one) you can login with *admin*:*admin123*.

EDIT: I'm getting tired :-) this is no Markdown form haha. So forgive my excessive use of asterisks. :-D

They won't support their own product… Well, actually, it seems like they just bought it from template-help.com…

In any event, if they want to slap me with a cease and desist, let them..

theme-settings.php attached.

you've upgraded a few of them in your environment.

Yes, every module not owned by Commerce Kickstarter in the site that has the issue is latest revision, except for Views Isotope, which I’ve help back as it’s upgrade path from 1.x to 2.x is in worse shape than Media’s.

Reply to my email, I’ll send you the theme tarball.

> I'll have to also look at commerce kickstarter

No don't, it's not the issue, it's just what I'm building for the client.

I sent you a message through Drupal.org,

Title: [Drupal.org] Theme tar ball
From: [me] @ .. inet-design.com
Tue Aug  1 10:02:26 2017

Check spam folder?

If you didn't get it send me a message through Drupal.org, and I'll reply to that.

Best,
Michael

I have almost identical theme-settings.php file for theme1005 from templatemonster which is actually from template-help.com. It has the same issues. I contacted their support and they are unwilling to help with the latest modules.

Hi Joseph,

A) Install the Theme Demo site I sent you yesterday.
B) Do nothing with Views Isotope (ever).
C) Except for Media (and File Entity) upgrade all other modules to latest revisions.

D) Then follow instructions in #13 above.

Path: admin/appearance/settings/theme1033

The latest combination that doesn't show the error message is: Media 2.0-alpha3 + File Entity 2.0-alpha3, both released October 26 2013. The next combination (Media 2.0-alpha4 + File Entity 2.0-beta1, October 4 2014) introduces the problem. In fact upgrading only File Entity to 2.0-beta1 works OK. If I instead only upgrade Media to 2.0-alpha4, the problem is introduced.

To further investigate, I disabled Media's submodules one by one (such as Media Internet Sources) and the problem was still there. When I finally disabled Media itself (while File Entity was still enabled) the problem disappeared. So I can now more precisely conclude that the problem starts occurring with Media's main module version Media 2.0-alpha4.

- Clicking either “Reset to defaults” or “Save configuration” will trigger the error.
- The Theme uses Media functions on the ‘Regions Settings’ tab for the ‘Background image URL’ Browse buttons.

# # #

My best guess is still that Media changed how it collects, handles, or passes, its data to the rest of Drupal. (Which is why I figured you’d be able to easily spot it from the backtraces I attached in #4.)

Best,
Michael

tl;dr
Need to test an existing, working Media 2.x plain form Browse button to see if it still works after applying both patches.

# # #

Just to verify I’m testing the right things:

to fix it, patch using patch #48
wget https://www.drupal.org/files/issues/media-compatibility_regression_from_2xAlpha4_in_2014_issue-2884164-48.patch
and also apply the core patch to drupal core
wget https://www.drupal.org/files/theme-settings-in-build-info-1862892-7.patch

Results:

- admin/appearance/settings/theme1033 no longer throws errors
- the file is uploaded to admin/content/file
- but the file is not retained in Regions Settings » Section 1 » Background image URL .

So, it’s either a partial fix, or the differences on how Media 1.x and Media 2.x handles plain form Browse buttons needs to be published.

I’m fine with just the differences being published, as that would lessen the chance of breaking existing Media 2.x content.

Well, actually, first someone who has an existing, working Media 2.x plain form Browse button needs to see if it still works after applying both patches. Then we’ll know where to go next.

Best

Okay, good to go.

With just core patch:

Theme saves the file and re-populates ‘Background image URL’ correctly on page re-load.

Good by me.

Well, crud…

I thought I had borked the front page view, but no the core patch isn’t returning an array (when it’s suppose to?)

Adding this here, no need to get Jess riled up any more today ;)

drush vget theme_theme1033_settings

theme_theme1033_settings: Array
(
...

Demo Site: Fully works
Media 7.x-1.5 - no core patch
    [theme1033_section_1_bg_img] => Array
        (
            [fid] => 37
        )


Dev Site:  WSOD
Media 7.x-2.10 - no core patch
    [theme1033_section_1_bg_img] => Array
        (
            [fid] => 71
        )


Dev Site: Works, but doesn’t load image into proper Front Page sectional div's
Media 7.x-2.10 - core patch
    [theme1033_section_1_bg_img] => 407

/file/407 is the proper FID, so…

We now know the Theme is expecting the FID to be in an array, not a text var.

Q’s

• Media is using FIDs as text var’s?
• Where is this the data format change coming from?
• Do we care?

My take

• We’ve got Core and Media happy.
• Trying to push them into an array structure will most likely break other code, so leave them alone
• These themes were written for Media 1.x

So

• We document how to update the theme?

And we’re finished?

Best,
Michel

::stupid formatting is quirking::

Edit: Ah, yeah, per Joseph in the next comment, replace my use of Media in a global sense in this post with File Entity in the specific sense. My bad ;)

Hey Joseph,

In regards to your last comment, after a week of noodling in off time, it seems that Media (probably because of core?) changed how it passes the FID around (and possibly other data, but FID shows direct evidence).

Given that Media (for whatever reason) now uses FID as a text var and not an array var, there doesn’t seem like there’s any way to provide 100% support for the (about ancient) themes that started with Media 1.x. Well, not without adding a huge amount of var type checking (gettype) and var conversion (array_map) to Media itself.

In any event, in a couple weeks I’ll re-write the theme I have to use text FIDs and update this ticket with what I find.

Best,
Michael

Hi joseph.olstad,
after applying the patch to the core (https://www.drupal.org/files/theme-settings-in-build-info-1862892-7.patch), the errors disappear but all the time, the page loops up to message 503. It is not the fault of hosting, I contacted the admins. Please help.

I have updated the media module according to this manual: https://www.drupal.org/project/media/issues/2082037 (ver. by drush).

Hello joseph,
I followed exactly your instructions and unfortunately the effect is the same, server error 503. This loop in this patch simply causes the page to start (it spins the progress bar on the tab in the browser all the time), until finally the response time from the server pages is exceeded. I do not receive any additional messages (everything is included as in the given link when it comes to the settings.php file). ACB what's going on:

1. I have everything current except Media (1.5x).
2. I follow the manual (https://www.drupal.org/project/media/issues/2082037), ver. via drush.
a) File entity and Media in two variants, i.e. in version 2.16 and 2.6. On both versions the same.
3) Installs the patch to the core (https://www.drupal.org/files/theme-settings-in-build-info-1862892-7.patch). After entering: Appearance -> Settings -> Theme_xxxx I have a lot of errors under the title:
"Warning: array_flip (): Can only flip STRING and INTEGER values! in DrupalDefaultEntityController-> load () ..."
After selecting any checkbox option (eg show the title of the page), and save, the errors disappear and here it is from now on without any mistakes.
4) And the entire page, both for admin and anonymous, still spins until we get 503. Sometimes it will load somehow, but clicking the subpage again results in a long loading and error 503.

Checked on Drupal 7.56 and 7.57 and two versions, above Media and File entity versions.

What are we doing next with this?
thanks for your commitment

Hello,
I did exactly that.
a) having the 1.5 version I raised to 1.6, I updated the base

b) only the version 1.6 I have upgraded to 2.16 and in the second attempt to 2.6, still, the problem is as mentioned above in the post.

I saw that I was not alone with this problem, another user (Michael-IDA) also had an identical problem with the purchased template and the Media update was a supported version.

I am determined, I think that together we will solve the problem :)

Regards

Media ver. 7.x-1.7 [https://www.drupal.org/project/media/releases/7.x-1.7], solved my problem with media module. Thanx