Skip to content

Commit

Permalink
Feature/com joomlaupdate improvements (#37911)
Browse files Browse the repository at this point in the history 
* Joomla Update extension compatibility improvements

Improved language string about “Update Information Unavailable” extensions

* Joomla Update extension compatibility improvements

Make the confirmation checkboxes optional (controlled by component options)

* Joomla Update extension compatibility improvements

Batch update checks

* Joomla Update extension compatibility improvements

Polishing

* Update administrator/components/com_joomlaupdate/config.xml

Co-authored-by: Brian Teeman <[email protected]>

* Joomla Update extension compatibility improvements

* Component options are Show / Hide
* The backup confirmation checkbox is now HIDDEN by default

* Joomla Update extension compatibility improvements

Hide the backup confirmation checkbox from the upload
and update page (depending on the component option).

* Joomla Update extension compatibility improvements

Add forgotten deprecated tag

* Joomla Update extension compatibility improvements

Try to make language strings more clear

* Update administrator/language/en-GB/com_joomlaupdate.ini

Co-authored-by: Brian Teeman <[email protected]>

* Update administrator/language/en-GB/com_joomlaupdate.ini

Co-authored-by: Konstantin Kolos <[email protected]>

* Address changes in Joomla regarding the confirm checkbox

* Pre-update check was not pushing JS library lang strings

* Update administrator/language/en-GB/com_joomlaupdate.ini

Co-authored-by: Brian Teeman <[email protected]>

* Remove line

* Revert accidental commit

* Make backupcheck 1 by default

* Make backupcheck 1 by default

Part II

Co-authored-by: Brian Teeman <[email protected]>
Co-authored-by: Christiane Maier-Stadtherr <[email protected]>
Co-authored-by: Konstantin Kolos <[email protected]>
  • Loading branch information
@brianteeman @chmst @Kostelano
4 people authored Jun 16, 2022
1 parent 1e16355 commit c1fdc00
Show file tree
Hide file tree
Showing 9 changed files with 349 additions and 17 deletions.
24 changes: 24 additions & 0 deletions administrator/components/com_joomlaupdate/config.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -49,5 +49,29 @@
showon="updatesource:custom"
/>

<field
name="versioncheck"
type="radio"
label="COM_JOOMLAUPDATE_CONFIG_VERSIONCHECK_LABEL"
description="COM_JOOMLAUPDATE_CONFIG_VERSIONCHECK_DESC"
layout="joomla.form.field.radio.switcher"
default="1"
>
<option value="0">JHIDE</option>
<option value="1">JSHOW</option>
</field>

<field
name="backupcheck"
type="radio"
label="COM_JOOMLAUPDATE_CONFIG_BACKUPCHECK_LABEL"
description="COM_JOOMLAUPDATE_CONFIG_BACKUPCHECK_DESC"
layout="joomla.form.field.radio.switcher"
default="1"
>
<option value="0">JHIDE</option>
<option value="1">JSHOW</option>
</field>

</fieldset>
</config>
141 changes: 140 additions & 1 deletion administrator/components/com_joomlaupdate/src/Controller/UpdateController.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
use Joomla\CMS\MVC\Controller\BaseController;
use Joomla\CMS\Response\JsonResponse;
use Joomla\CMS\Session\Session;
use Joomla\Component\Joomlaupdate\Administrator\Model\UpdateModel;

/**
* The Joomla! update controller for the Update view
Expand Down Expand Up @@ -472,7 +473,8 @@ public function finaliseconfirm()
* Prints a JSON string.
* Called from JS.
*
* @since 3.10.0
* @since 3.10.0
* @deprecated 5.0 Use batchextensioncompatibility instead.
*
* @return void
*/
Expand Down Expand Up @@ -580,6 +582,143 @@ public function fetchExtensionCompatibility()
$this->app->close();
}

/**
* Determines the compatibility information for a number of extensions.
*
* Called by the Joomla Update JavaScript (PreUpdateChecker.checkNextChunk).
*
* @return void
* @since __DEPLOY_VERSION__
*
*/
public function batchextensioncompatibility()
{
$joomlaTargetVersion = $this->input->post->get('joomla-target-version', '', 'DEFAULT');
$joomlaCurrentVersion = $this->input->post->get('joomla-current-version', JVERSION);
$extensionInformation = $this->input->post->get('extensions', []);

/** @var \Joomla\Component\Joomlaupdate\Administrator\Model\UpdateModel $model */
$model = $this->getModel('Update');

$extensionResults = [];
$leftover = [];
$startTime = microtime(true);

foreach ($extensionInformation as $information)
{
// Only process an extension if we have spent less than 5 seconds already
$currentTime = microtime(true);

if ($currentTime - $startTime > 5.0)
{
$leftover[] = $information;

continue;
}

// Get the extension information and fetch its compatibility information
$extensionID = $information['eid'] ?: '';
$extensionVersion = $information['version'] ?: '';
$upgradeCompatibilityStatus = $model->fetchCompatibility($extensionID, $joomlaTargetVersion);
$currentCompatibilityStatus = $model->fetchCompatibility($extensionID, $joomlaCurrentVersion);
$upgradeUpdateVersion = false;
$currentUpdateVersion = false;
$upgradeWarning = 0;

if ($upgradeCompatibilityStatus->state == 1 && !empty($upgradeCompatibilityStatus->compatibleVersions))
{
$upgradeUpdateVersion = end($upgradeCompatibilityStatus->compatibleVersions);
}

if ($currentCompatibilityStatus->state == 1 && !empty($currentCompatibilityStatus->compatibleVersions))
{
$currentUpdateVersion = end($currentCompatibilityStatus->compatibleVersions);
}

if ($upgradeUpdateVersion !== false)
{
$upgradeOldestVersion = $upgradeCompatibilityStatus->compatibleVersions[0];

if ($currentUpdateVersion !== false)
{
// If there are updates compatible with both CMS versions use these
$bothCompatibleVersions = array_values(
array_intersect($upgradeCompatibilityStatus->compatibleVersions, $currentCompatibilityStatus->compatibleVersions)
);

if (!empty($bothCompatibleVersions))
{
$upgradeOldestVersion = $bothCompatibleVersions[0];
$upgradeUpdateVersion = end($bothCompatibleVersions);
}
}

if (version_compare($upgradeOldestVersion, $extensionVersion, '>'))
{
// Installed version is empty or older than the oldest compatible update: Update required
$resultGroup = 2;
}
else
{
// Current version is compatible
$resultGroup = 3;
}

if ($currentUpdateVersion !== false && version_compare($upgradeUpdateVersion, $currentUpdateVersion, '<'))
{
// Special case warning when version compatible with target is lower than current
$upgradeWarning = 2;
}
}
elseif ($currentUpdateVersion !== false)
{
// No compatible version for target version but there is a compatible version for current version
$resultGroup = 1;
}
else
{
// No update server available
$resultGroup = 1;
}

// Do we need to capture
$extensionResults[] = [
'id' => $extensionID,
'upgradeCompatibilityStatus' => (object) [
'state' => $upgradeCompatibilityStatus->state,
'compatibleVersion' => $upgradeUpdateVersion
],
'currentCompatibilityStatus' => (object) [
'state' => $currentCompatibilityStatus->state,
'compatibleVersion' => $currentUpdateVersion
],
'resultGroup' => $resultGroup,
'upgradeWarning' => $upgradeWarning,
];
}

$this->app->mimeType = 'application/json';
$this->app->charSet = 'utf-8';
$this->app->setHeader('Content-Type', $this->app->mimeType . '; charset=' . $this->app->charSet);
$this->app->sendHeaders();

try
{
$return = [
'compatibility' => $extensionResults,
'extensions' => $leftover,
];

echo new JsonResponse($return);
}
catch (\Exception $e)
{
echo $e;
}

$this->app->close();
}

/**
* Fetch and report updates in \JSON format, for AJAX requests
*
Expand Down
19 changes: 19 additions & 0 deletions administrator/components/com_joomlaupdate/src/View/Joomlaupdate/HtmlView.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,22 @@ class HtmlView extends BaseHtmlView
*/
protected $nonCoreCriticalPlugins = [];

/**
* Should I disable the confirmation checkbox for pre-update extension version checks?
*
* @var boolean
* @since __DEPLOY_VERSION__
*/
protected $noVersionCheck = false;

/**
* Should I disable the confirmation checkbox for taking a backup before updating?
*
* @var boolean
* @since __DEPLOY_VERSION__
*/
protected $noBackupCheck = false;

/**
* Renders the view
*
Expand Down Expand Up @@ -243,6 +259,9 @@ public function display($tpl = null)
$this->updateSourceKey = Text::_('COM_JOOMLAUPDATE_CONFIG_UPDATESOURCE_DEFAULT');
}

$this->noVersionCheck = $params->get('versioncheck', 1) == 0;
$this->noBackupCheck = $params->get('backupcheck', 1) == 0;

// Remove temporary files
$this->getModel()->removePackageFiles();

Expand Down
12 changes: 12 additions & 0 deletions administrator/components/com_joomlaupdate/src/View/Upload/HtmlView.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@

\defined('_JEXEC') or die;

use Joomla\CMS\Component\ComponentHelper;
use Joomla\CMS\Factory;
use Joomla\CMS\Language\Text;
use Joomla\CMS\MVC\View\HtmlView as BaseHtmlView;
Expand Down Expand Up @@ -50,6 +51,14 @@ class HtmlView extends BaseHtmlView
*/
protected $warnings = [];

/**
* Should I disable the confirmation checkbox for taking a backup before updating?
*
* @var boolean
* @since __DEPLOY_VERSION__
*/
protected $noBackupCheck = false;

/**
* Renders the view.
*
Expand All @@ -74,6 +83,9 @@ public function display($tpl = null)
$this->warnings = $this->get('Items', 'warnings');
}

$params = ComponentHelper::getParams('com_joomlaupdate');
$this->noBackupCheck = $params->get('backupcheck', 1) == 0;

$this->addToolbar();

// Render the view.
Expand Down
15 changes: 13 additions & 2 deletions administrator/components/com_joomlaupdate/tmpl/joomlaupdate/preupdatecheck.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@
// Text::script doesn't have a sprintf equivalent so work around this
$this->document->addScriptOptions('nonCoreCriticalPlugins', $this->nonCoreCriticalPlugins);

// Push Joomla! Update client-side error messages
Text::script('COM_JOOMLAUPDATE_VIEW_DEFAULT_POTENTIALLY_DANGEROUS_PLUGIN_CONFIRM_MESSAGE');
Text::script('COM_JOOMLAUPDATE_VIEW_DEFAULT_EXTENSION_NO_COMPATIBILITY_INFORMATION');
Text::script('COM_JOOMLAUPDATE_VIEW_DEFAULT_EXTENSION_WARNING_UNKNOWN');
Expand All @@ -41,6 +42,13 @@
Text::script('COM_JOOMLAUPDATE_VIEW_DEFAULT_POTENTIALLY_DANGEROUS_PLUGIN_CONFIRM_MESSAGE');
Text::script('COM_JOOMLAUPDATE_VIEW_DEFAULT_HELP');

// Push Joomla! core Joomla.Request error messages
Text::script('JLIB_JS_AJAX_ERROR_CONNECTION_ABORT');
Text::script('JLIB_JS_AJAX_ERROR_NO_CONTENT');
Text::script('JLIB_JS_AJAX_ERROR_OTHER');
Text::script('JLIB_JS_AJAX_ERROR_PARSE');
Text::script('JLIB_JS_AJAX_ERROR_TIMEOUT');

$compatibilityTypes = array(
'COM_JOOMLAUPDATE_VIEW_DEFAULT_EXTENSIONS_RUNNING_PRE_UPDATE_CHECKS' => array(
'class' => 'info',
Expand Down Expand Up @@ -301,7 +309,7 @@
<?php echo $extension->version; ?>
</td>
<td id="available-version-<?php echo $extension->extension_id; ?>" class="currcomp hidden"></td>
<td
<td id="preUpdateCheck_<?php echo $extension->extension_id; ?>"
class="extension-check upcomp hidden"
data-extension-id="<?php echo $extension->extension_id; ?>"
data-extension-current-version="<?php echo $extension->version; ?>"
Expand Down Expand Up @@ -331,6 +339,7 @@ class="extension-check upcomp hidden"

<form action="<?php echo Route::_('index.php?option=com_joomlaupdate&layout=update'); ?>" method="post" class="d-flex flex-column mb-5">

<?php if (!$this->noVersionCheck): ?>
<div id="preupdatecheckbox">
<div class="form-check d-flex justify-content-center mb-3">
<input type="checkbox" class="me-3" id="noncoreplugins" name="noncoreplugins" value="1" required />
Expand All @@ -339,8 +348,10 @@ class="extension-check upcomp hidden"
</label>
</div>
</div>
<?php endif; ?>

<button class="btn btn-lg btn-warning disabled submitupdate mx-auto" type="submit" disabled>
<button class="btn btn-lg btn-warning <?php echo $this->noVersionCheck ? '' : 'disabled' ?> submitupdate mx-auto"
type="submit" <?php echo $this->noVersionCheck ? '' : 'disabled' ?>>
<?php echo Text::_('COM_JOOMLAUPDATE_VIEW_DEFAULT_INSTALLUPDATE'); ?>
</button>
</form>
Expand Down
6 changes: 4 additions & 2 deletions administrator/components/com_joomlaupdate/tmpl/joomlaupdate/update.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,10 @@
endif;

// Confirm backup and check
$displayData['content'] .= '<div class="form-check d-flex justify-content-center">
<input class="form-check-input me-2" type="checkbox" value="" id="joomlaupdate-confirm-backup">
$classVisibility = $this->noBackupCheck ? 'd-none' : '';
$checked = $this->noBackupCheck ? 'checked' : '';
$displayData['content'] .= '<div class="form-check d-flex justify-content-center ' . $classVisibility . '">
<input class="form-check-input me-2" type="checkbox" value="" id="joomlaupdate-confirm-backup" ' . $checked . '>
<label class="form-check-label" for="joomlaupdate-confirm-backup">
' . Text::_('COM_JOOMLAUPDATE_UPDATE_CONFIRM_BACKUP') . '
</label>
Expand Down
6 changes: 4 additions & 2 deletions administrator/components/com_joomlaupdate/tmpl/upload/default.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -82,8 +82,10 @@
</div>
</div>

<div class="form-check mb-3">
<input class="form-check-input me-2" type="checkbox" disabled value="" id="joomlaupdate-confirm-backup">
<div class="form-check mb-3 <?php echo $this->noBackupCheck ? 'd-none' : '' ?>">
<input class="form-check-input me-2 <?php echo $this->noBackupCheck ? 'd-none' : '' ?>"
type="checkbox" disabled value="" id="joomlaupdate-confirm-backup"
<?php echo $this->noBackupCheck ? 'checked' : '' ?>>
<label class="form-check-label" for="joomlaupdate-confirm-backup">
<?php echo Text::_('COM_JOOMLAUPDATE_UPDATE_CONFIRM_BACKUP'); ?>
</label>
Expand Down
6 changes: 5 additions & 1 deletion administrator/language/en-GB/com_joomlaupdate.ini
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@

COM_JOOMLAUPDATE_CAPTIVE_HEADLINE="Confirm your credentials"
COM_JOOMLAUPDATE_CHECKED_UPDATES="Checked for updates."
COM_JOOMLAUPDATE_CONFIG_BACKUPCHECK_DESC="Shows the checkbox to confirm you have taken a backup and you're ready to update in the final step before the update is actually applied."
COM_JOOMLAUPDATE_CONFIG_BACKUPCHECK_LABEL="Confirm Backup Checkbox"
COM_JOOMLAUPDATE_CONFIG_CUSTOMURL_LABEL="Custom URL"
COM_JOOMLAUPDATE_CONFIG_SOURCES_DESC="Configure where Joomla gets its update information from."
COM_JOOMLAUPDATE_CONFIG_SOURCES_LABEL="Update Source"
Expand All @@ -14,6 +16,8 @@ COM_JOOMLAUPDATE_CONFIG_UPDATESOURCE_DEFAULT="Default"
COM_JOOMLAUPDATE_CONFIG_UPDATESOURCE_LABEL="Update Channel"
COM_JOOMLAUPDATE_CONFIG_UPDATESOURCE_NEXT="Joomla Next"
COM_JOOMLAUPDATE_CONFIG_UPDATESOURCE_TESTING="Testing"
COM_JOOMLAUPDATE_CONFIG_VERSIONCHECK_DESC="Shows the checkbox in the pre–update check if any of the extensions installed on your site is potentially incompatible with the version of Joomla you are upgrading to. Note: the checkbox is displayed when upgrading to a new Joomla version family (minor or major version)."
COM_JOOMLAUPDATE_CONFIG_VERSIONCHECK_LABEL="Potentially incompatible extensions checkbox"
COM_JOOMLAUPDATE_CONFIGURATION="Joomla Update: Options"
COM_JOOMLAUPDATE_CONFIRM="Confirm"
COM_JOOMLAUPDATE_EMPTYSTATE_APPEND="Upload and Update"
Expand Down Expand Up @@ -114,7 +118,7 @@ COM_JOOMLAUPDATE_VIEW_DEFAULT_EXTENSIONS_RUNNING_PRE_UPDATE_CHECKS_NOTES="<p>Ple
COM_JOOMLAUPDATE_VIEW_DEFAULT_EXTENSIONS_SHOW_LESS_COMPATIBILITY_INFORMATION="Less Details"
COM_JOOMLAUPDATE_VIEW_DEFAULT_EXTENSIONS_SHOW_MORE_COMPATIBILITY_INFORMATION="More Details"
COM_JOOMLAUPDATE_VIEW_DEFAULT_EXTENSIONS_UPDATE_SERVER_OFFERS_NO_COMPATIBLE_VERSION="Update Information Unavailable"
COM_JOOMLAUPDATE_VIEW_DEFAULT_EXTENSIONS_UPDATE_SERVER_OFFERS_NO_COMPATIBLE_VERSION_NOTES="Extension does not offer a compatible version for the selected target version of Joomla. This could mean the extension does not use the Joomla update system or the developer has not provided compatibility information for this Joomla version yet."
COM_JOOMLAUPDATE_VIEW_DEFAULT_EXTENSIONS_UPDATE_SERVER_OFFERS_NO_COMPATIBLE_VERSION_NOTES="Joomla cannot detect the extension's compatibility with the target version of Joomla."
COM_JOOMLAUPDATE_VIEW_DEFAULT_NON_CORE_BACKEND_TEMPLATE_USED_NOTICE="We detected that you are not using a core admin template. You might find the upgrade process smoother if you <a href='index.php?option=com_templates&view=styles&client_id=1'>switch</a> to use the %s template."
COM_JOOMLAUPDATE_VIEW_DEFAULT_HELP="More Information"
COM_JOOMLAUPDATE_VIEW_DEFAULT_INFOURL="Additional Information"
Expand Down
Loading

0 comments on commit c1fdc00

Please sign in to comment.