Upgrading from jDownloads 3.2 to 3.9

Introduction

The jDownloads 3.9 series has introduced several enhancements, some of which are noted below.
  • Revised Configuration, now uses the Joomla Options style
  • Support of Joomla Custom Fields
  • Improved User Groups Settings layout
  • More front end user group settings
  • Much enhanced Control Panel
  • Support multi language Associations
  • Support for RTL languages such as Arabic, Hebrew, etc (from beta 7)
  • Enhanced Single User Access
  • Wide support for language placeholders such as {fr-FR} ... {/fr-FR}  in layouts
  • More features in 'Check Downloads' area
  • Better Limits setting page in User Groups Settings
  • Ability to add an Inquiry Form when user downloading
  • Additional Layouts for jDownloads 3.9
  • Planned support for 'modern' style links

General

Upgrading from jDownloads 3.2 series to the 3.9 series is quite similar to a normal update.  However in order to advise about various changes the installation needs to be carried out twice.  You do need to be at least at  jDownloads 3.2.69 or later and at Joomla 3.9.x.  There are of course many extra features in the the 3.9 series which are outlined here.

One of the first things to note is that the Configuration section has been updated and is not in the left hand panel with Categories, Downloads, Layouts and so on.
It now uses the Joomla! Options button options01 which is situated at the top right of the Control Panel.  See the article Control Panel Overview for more details  (this and all other documentation or similar links in this article open in a new window/tab).

Database changes

For even better integration with Joomla! there have been some database item name changes, for example in the files data base table the name of the ID field has changed from file_id to just id, file_title has become title and so on.  Also some redundant entries have been removed.  For those wishing to upgrade an extension to be compatible with the 3.9 version please contact us through the jDownloads forum.

Overrides

If you have any Component or Module overrides, or any Layout Overrides, then at the time of the upgrade they will of course be based upon jDownloads 3.2 code.

This may subsequently cause the upgraded site to "misbehave".

Prior to the upgrade please check as noted below.

For Joomla! documentation on these overrides see:
Component & Module Overrides
Layout Overrides
In the following you will find references to a folder with the name "html".  You can inhibit all overrides by changing the name of that sub folder to say "html-old".

Component and Module Overrides

You can test to see if you have a component override by looking in folder: "<your_site>/templates/<template_name>/html", where template_name is your active frontend template. If there is a folder called jdownloads then you have at least one active override. For example if you are using the Protostar frontend template, then if you see folder "<your_site>/templates/Protostar/html/jdownloads" you do have an active component override.

Module overrides are similar but here the folders to look for are "<your_site>/templates/<template_name>/html/mod_jdownloads_xxx" where the xxx is the usual name of one of the jDownload modules. For example if there is an override for the jDownloads Latest module and you are using Protostar then there would be a directory with the name "<your_site>/templates/Protostar/html/mod_jdownloads_latest".

In summary if there is any folder in "<your_site>/templates/<your_template>/html/" with jdownloads in the name then you have an active override.

You can temporarily disable these jD3.2 based overrides by changing the relevant part of the folder name from "jdownloads" to say "jdown32".

Another way is to simply rename the "html" folder to say "html-old".  This will stop all overrides.

Layout overrides

The folder structure for these layouts are esentially the same as for the component & module overrides as described above.

Essentially if folder "<your_site>/templates/<your-template>/html/" has a subfolder with "jdownloads" anywhere in its name then you have an override.  So to inhibit them change the name from jdownloads to something else but do not simply just add say 32 to the name - you could rename it by replacing the text "jdownloads" with say "jdown32".

Third Party Extensions

Standard Extensions

For more details of the supported third party extensions please, see the category Extending jDownloads with other Extensions in the Documentation.  The following standard extensions are supported in jDownloads 3.9 but also see the other known compatible extensions section below.
The Special Extensions for JComments, Komento and Community Builder may be found at jD3.9 extensions.  The plugin support for Alta User Points is effectively 'built in' to jDownloads but it does need installing as described in the Alta User Points article.

If your present site relies heavily on other extensions to jDownloads that have not been updated by their vendors we suggest staying for the time being with the jD 3.2 series.  The upgrading is necessary because of the changes in the database item renaming.

Compatible Extensions

Please let us know via the forum if you know of any others.
The following extensions have been checked with jD3.9
  1. Acymailing version 6 is available at www.acyba.com/ 
    For the jDownloads compatible plugin go to www.acyba.com/acymailing/plugins and search for jDownloads (tag plugin) v4.5.0 or higher (the word 'tag' is not related to Joomla! tags!).  This plugin supports both the 3.9 and the 3.2 series.  It is a long way down the list in the 'Files Management' section.

Custom Fields

One of the newer features in Joomla! is Joomla Custom Fields, these have far more scope with more than a dozen diferent field types compared to the four types provided in the jDownloads Custom Fields.  See for example  the article Joomla Custom Fields which describes the 15 available types.  As well as Fields, Joomla! has Field Groups which aid multilingual sites.  There are Joomla! Custom Fields that match those that are available in the jDownloads 3.2 and earlier series.

As a result jDownloads 3.9 no longer supports the jDownloads custom fields, it does fully support the more extensive Joomla! Custom Fields.   jDownloads automatically transfers the old jDownloads Custom Fields into Jooma! Custom Fields during the upgrade process.

As shown later extra messages indicating that the jD custom fields have been successfuly converted to Joomla! fields are displayed.

Note This has only been tested with PHP7.3 and above so we advise that you ensure that you have an uptodate version of PHP.

Layouts

When upgrading all your existing layouts, with one exception as noted below, are copied over.  In addition a whole set of jDownloads 3.9 layouts are added.  These give an almost identical view as the existing default 3.2 layouts but there have been improvements in spacing and similar, particularly in the header, subheader and footer regions.  A new type of layout, Subcategories has been introduced to give a more logical arrangement. There are presently three default layouts in this section:
1. Standard Subcategories Layout  - this replaces the former 'Standard Categories Layout for paginated Subcategories 3.2' that used to be in the Categories section;
2. Standard Subcategories Layout 3.9 - this is the equivalent 3.9 version;
3. Multi-Column Subcategories Layout 3.9 - this shows subcategories in 4 column rows.

It is suggested that you switch over to the 3.9 layouts as these are the layouts that will continue to be supported.

Multilingual Sites

If you have a multilingual site do not forget to install the language files for jDownloads 3.9.  See article Install jD language (opens in a new tab/window) on how to do this.  Note jDownloads comes with the jDownloads v3.9 languages for English and German already installed.

Upgrading

First Step

The first step is to check you have the latest jDownloads 3.2.69 or higher version and if necessary update to the latest version.  Using a version 3.2.68 or a lower version will cause the installation to fail.

If you have an earlier series (1.9 or 2.5) then first see the jD 3.2 Migration documentation
The Compatibility Appendix below shows the versions of jDownloads compatible with different Joomla! versions.

Upgrading from jD 3.2.69 to jD 3.9 is, in general, similar to a regular update.  That is upgrading from the jDownloads 3.2 series to the 3.9 series is straightforward, but note because there are changes to the database and also because of the automatic conversion of any old style jDownloads custom fields then the update needs to be done twice as noted below.

It is not a 'migration' requiring special treatment.  The system requirements, which are listed below, are the same as those required for Joomla!
REMINDER: you must be at jDownloads v3.2.69 or higher in order to upgrade to the 3.9 series.

Minimum Requirements

  • PHP 5.7+ (7.3+ strongly recommended, especially if the old style jDownloads Custom Fields were used.)
  • MySQL 5.7+
  • Joomla 3.9+ or newer
  • jDownloads 3.2.69

Upgrade PHP?

This is not a requirement unles you PHP level is below the minimum level.
 However it would be a good time to upgrade your server to at least PHP 7.3+ if you have not already done so.  Also bear in mind that Joomla! 4 is expected in late 2020 and that will require PHP 7.3+ as a minimum, that is it will not support the PHP 5 series.  As a final note the PHP 7 series is faster and lighter weight than the PHP 5 series.

Any Overrides?

Please check as descibed in the Overrides section above to see if you have any jDownloads overrides.

Check for latest

So assuming you have a jDownloads v3.2 series installed please check if it is  version 3.2.69 or higher.  If it is not at least at  version 3.2.69 then the first step is to upgrade to jDownloads version 3.2.69 or higher, which is available at jDownloads 3.2 series.

Next Step

This process follows the normal upgrade process using the Install method. 

So go to Extensions - Manage- Install
upgrade01
This brings up the regular installation screen which allows a variety of uploading methods.  In this example 'Upload Package File' has been choosen.

This assumes you have previously downloaded the current jDownloads 3.9 version from www.jdownloads.com to a suitable location on your device.  So drag the file to the upload panel. Installation will begin automatically.

upgrade02

First Install

When doing the upgrade for the first time then the upgrade will intentionally stop to show the message opposite.

1. A Full Backup is advised.

2. Note that some third party extensions may not work because of some database naming changes and that they need an update. See the documentation above.

3. Notifies that the jDownloads Custom Fields will be converted to standard Joomla! Fields.

4.  At this stage no changes have been made to your site.  This gives you the opportunity remain for the time being with the jD 3.2 series.

To continue with the upgrade click on the 'continue update bar'.
Install-beta6-01

After clicking on the continue update the message opposite will appear.

Note that part of the upgrade will have already been carried out.
install02

Second Install

To continue the update you need to start it again just as before.

That is go to Extensions - Manage - Install and proceed just the same as the first time. In the second install the above message will not appear.

Installation Completes

The final stage shows a successful upgrade.

If your site used jDownloads custom fields you will see a message indicating how many were converted and how many Downloads are involved

Note the need to click on Start jDownloads.

After clicking on Start jDownloads there might be a short delay whilst the upgrade completes.  When complete the jDownloads Control Panel will be shown.

Install-beta6-02
The first time you go to the jDownloads Control Panel after upgrading to the 3.9 series you will see a message such as shown opposite.

Install beta6 03 cr
If you wish to see the stages of the Upgrade then look in the upgrade install log01 tab on the Control Panel.

Overrides Check

If you scroll down the Control Panel you may see a message such as that shown opposite the flags up the possibility that some jDownloads overrides might exist.install05
If there are overrides as this stage it is probable that they are based on jDownloads 3.2 code. It is likely that they will now not work properly. Please see the notes above on overrides.

This message will always be present whenever you have overrides to act as a reminder!.

Using F5 key

If you had a frontend view active then that will still be using jD3.2 code so clicking on say a Download button or similar may cause a 1054 error saying it could not find 'file_id' or similar.

To overcome this one time happening use the keyboard F5 key as on most browsers that refreshes the page. It may happen in the backend so again use F5 key or otherwise refresh the page. On my test sites I have added a 'clear cache' app and make use of that to reload a page.

New Control Panel

The revised Control Panel is quite different from the jD 3.2 series control panel. The left hand side has links to items like Categories, Layouts and so on.  Files has been changed to Downloads but most significantly there is no link to Configuration!
Similar to Joomla! the 'configuration' setup is now accessed through the Options button  upgrade12 at the top right of the jDownloads Control Panel and all the other main pages in the backend.  This is consistent with the standard Joomla! style for Components. Please see the article on the Control Panel for more details.

Upgrade Fails

In some circumstances, generally associated with a database 'fault' or inadequate run time then the upgrade may fail to work correctly.

An example where the database is not sufficiently upto date is shown opposite.
install dberror
No changes will have been made to the original  jD3.2 site as obviously these checks are made at an early stage.

If the upgrade fails for som unknown reason later in the process then it is reversible so you can get back to your operational jD 3.2 version because the upgrade process automatically saves the jD 3.2 database tables.

For details see the article Reverting Back to jD3.2.

Appendix: jDownloads and Joomla! Compatibility

These are summarised in the table below where the 'green' background indicates the supported versions.  If you are in the 'red' zone then you will need to upgrade your Joomla! to Joomla! 3.2 and then to Joomla! 3.9.  Note there is only a direct migration of jDownloads versions in the 'red' zone to the jDownloads 3.2 series.  That is you cannot go from the 'red' zone directly to the jDownloads 3.9 series.  Please see the jDownloads 3.2 documention - migration for more details.
Instal00A

Colin M  April 2020, updated September 2020

Tags: index

Print Email

This site uses cookies. By continuing to browse the site, you are agreeing to our use of cookies.