[#33612] Add a extension installer script feature by wilsonge · Pull Request #3447 · joomla/joomla-cms

wilsonge · 2014-04-14T23:17:37Z

http://joomlacode.org/gf/project/joomla/tracker/?action=TrackerItemEdit&tracker_item_id=33612&start=0

Feature Basics

This is a helper for developers using install scripts in their extensions it allows you to:

Get and set parameters (method getParams and setParam available for this - you can also get all instances of a module with getInstances to help)
Stop users from downgrading versions (set allowDowngrades class var to true)
Move CLI scripts into the CLI folder (by putting the path to the cli scripts in the class var array)
Check for a minimum PHP and Joomla version (by setting the strings for the minimum versions in the relevant class var)
Remove out of date files and folders (by putting the path to the files in the class var array)

Usage

Simply by extending the helper class and setting the extension name in the form of com_foobar, mod_foobar etc. in the $this->extension class var

Testing

Try using the feature in extensions - as this is a utility class for developers there's no easy visible effects for user testing

brianteeman · 2014-04-14T23:21:03Z

language/en-GB/en-GB.files_joomla.sys.ini

I would prefer
Your server does not
to
You don't

brianteeman · 2014-04-14T23:21:20Z

Please alpha sort the new strings

brianteeman · 2014-04-14T23:22:18Z

language/en-GB/en-GB.files_joomla.sys.ini

Can you explain this a bit more. Not sure I understand but from my guess the language string is not "the best"

Which string? The final one. It's basically designed to stop people downgrading an extension version - so you can't go from extension v1.5 to 1.4 etc.

So why not say something like "Oops it looks like you are trying to install
an older version. You can only use this method to upgrade an extension.

On 15 April 2014 00:23, George Wilson notifications@github.com wrote:

In language/en-GB/en-GB.files_joomla.sys.ini:

@@ -7,4 +7,7 @@ FILES_JOOMLA="Joomla CMS"
FILES_JOOMLA_ERROR_FILE_FOLDER="Error on deleting file or folder %s"
FILES_JOOMLA_ERROR_MANIFEST="Error on updating manifest cache: (type, element, folder, client) = (%s, %s, %s, %s)"

FILES_JOOMLA_XML_DESCRIPTION="Joomla! 3 Content Management System"

+FILES_JOOMLA_ERROR_MOVE="Error on moving file %s"
+JGLOBAL_MINIMUM_PHP="You don't meet the minimum PHP version requirement of %s"
+JGLOBAL_MINIMUM_JOOMLA="You don't meet the minimum Joomla version requirement of J%s"
+JGLOBAL_INCORRECT_SEQUENCE="Incorrect version sequence. Cannot upgrade %s to %s"

Which string? The final one. It's basically designed to stop people
downgrading an extension version

Reply to this email directly or view it on GitHubhttps://github.com//pull/3447/files#r11613485
.

Brian Teeman
Co-founder Joomla! and OpenSourceMatters Inc.
http://brian.teeman.net/

mbabker · 2014-04-14T23:31:49Z

libraries/cms/helper/extensionscript.php

defined('_JEXEC') or die; without the comment on the previous line

mbabker · 2014-04-14T23:36:34Z

libraries/cms/helper/extensionscript.php

Is this REALLY only supposed to be for modules?

Also, the right doc block would be JAdapterInstance (even though we really should have an abstract JInstallerAdapter, maybe I'll pull that out of the installer refactoring branch on the projects repo)

nope. this is based on the scripts for some of my own modules and I've forgotten to change a few docblocks

mbabker · 2014-04-14T23:39:07Z

libraries/cms/helper/extensionscript.php

Personal preference - Use is_file instead of JFile::exists (my rule of thumb is only use JFile for actual write operations)

My personal preference is to use the abstraction layer whilst it's not deprecated :)

exists() is something we should have deprecated with everything else in JFile honestly. Only advantage over just calling is_file directly is it calls JPath::clean() on the supplied path.

compojoom · 2015-03-14T14:38:15Z

Don't you think that we should find a different name for this class?
the supposed way we should use this is by extending, but extending from a helper class doesn't seem right to me. A helper class should not be extended from - it is normally something that we have just because we have no clue where to put the functionality.
I would actually prefer if you move this to the installer folder and call the class something like installerscriptbase???
Other than that - great! A lot of us have written their own installers. You are covering a lot of things. What would make it even better is if you had plugin, module & library installers there :)
Something like here: https://github.com/compojoom/lib_compojoom/blob/master/source/libraries/compojoom/installer/installer.php#L110

Conflicts: administrator/language/en-GB/en-GB.lib_joomla.ini language/en-GB/en-GB.lib_joomla.ini

wilsonge · 2015-03-14T16:01:43Z

I'm easy as to the name of the class and it's location. Yes you're right it might well be better in libraries/cms/installer.

I considered the library, module and plugin installers but in my opinion core should be persuading people to use packages - they're getting much better in terms of core support since the standardisation we did in 3.4. What do you think?

mbabker · 2015-06-27T21:32:49Z

@wilsonge see wilsonge#13

The helper class is renamed to JInstallerScript and I've updated 3.4 references to 3.5.

mbabker · 2015-06-27T21:34:34Z

What would make it even better is if you had plugin, module & library installers there

I tend to agree with @wilsonge on using packages instead of extending a specific adapter to add more extensions. Admittedly there are some weaknesses in the package adapter that need to be worked on to make it more enticing for developers (i.e. one failed extension install aborts the whole thing leaving a partial package install), but I think our focus for core should be moving in that direction.

PR updates

… extensionscript

810 · 2016-05-04T20:36:34Z

libraries/cms/installer/script.php

+/**
+ * Base install script for use by extensions providing helper methods for common behaviours.
+ *
+ * @since  3.5


Please update all since to 3.6

joomla-cms-bot · 2016-05-05T09:00:46Z

This PR has received new commits.

CC: @compojoom

_{This comment was created with the J!Tracker Application at issues.joomla.org/joomla-cms/3447.}

joomla-cms-bot · 2016-05-05T09:01:46Z

This PR has received new commits.

CC: @compojoom

_{This comment was created with the J!Tracker Application at issues.joomla.org/joomla-cms/3447.}

Kubik-Rubik · 2016-05-07T14:24:53Z

Thank you @wilsonge, great addition!

Add a extension installer script feature

81fe67c

wilsonge added Needs JoomlaCode Tracker Item labels Apr 14, 2014

Add extra line

af88f90

brianteeman reviewed Apr 14, 2014
View reviewed changes

language/en-GB/en-GB.files_joomla.sys.ini Outdated

Copy link
Copy Markdown

Contributor

brianteeman Apr 14, 2014

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would prefer
Your server does not
to
You don't

brianteeman reviewed Apr 14, 2014
View reviewed changes

Alpha order

2990423

mbabker reviewed Apr 14, 2014
View reviewed changes

Add a check for allowing downgrades

c41e5f5

mbabker reviewed Apr 14, 2014
View reviewed changes

Add some fixes

cee05be

mbabker reviewed Apr 14, 2014
View reviewed changes

wilsonge added 5 commits April 15, 2014 00:45

Doc block fixes

c945721

Amend version downgrade string

8079820

Move location of lang strings

32f1889

Module => extension

639f40e

Update en-GB.files_joomla.sys.ini

37ec3af

wilsonge changed the title ~~Add a extension installer script feature~~ [#33612] Add a extension installer script feature Apr 17, 2014

brianteeman added Has JoomlaCode Tracker Item and removed Needs JoomlaCode Tracker Item labels May 3, 2014

brianteeman added the New Feature label Aug 8, 2014

nicksavov removed the Has JoomlaCode Tracker Item label Aug 21, 2014

wilsonge added 3 commits March 14, 2015 15:06

Use file_exists instead of JFile::exists

22efb1a

Merge remote-tracking branch 'upstream/staging' into extensionscript

721df7f

Conflicts: administrator/language/en-GB/en-GB.lib_joomla.ini language/en-GB/en-GB.lib_joomla.ini

Fix issues in lang file from merge

779e7bc

wilsonge force-pushed the extensionscript branch from 470c0d2 to 779e7bc Compare March 14, 2015 15:56

Michael Babker added 3 commits June 27, 2015 17:23

Merge branch 'staging' into 3447-updates

3ce433d

Rename helper

f0eeee4

3.4 -> 3.5, style stuff

ce48b1a

Merge pull request #13 from mbabker/3447-updates

a9dc9c1

PR updates

joomla-cms-bot added the Language Change This is for Translators label Jun 27, 2015

wilsonge added 3 commits September 12, 2015 23:55

Merge remote-tracking branch 'upstream/staging' into extensionscript

21a81bc

Fix check for allowing downgrades

d38c27e

Merge branch 'extensionscript' of github.com:wilsonge/joomla-cms into…

fba4449

… extensionscript

roland-d added this to the Joomla! 3.6.0 milestone Nov 7, 2015

810 reviewed May 4, 2016
View reviewed changes

Bump since tags

935fc55

Fix mismatching case check

8c07e15

Kubik-Rubik merged commit e05aa66 into joomla:staging May 7, 2016

wilsonge deleted the extensionscript branch May 7, 2016 14:28

zero-24 mentioned this pull request Jun 16, 2016

Copyright update after #3447 #10831

Merged

Bakual mentioned this pull request May 8, 2017

Stop extension installation if minimum requirement isn't met. #15890

Merged

Uh oh!

Conversation

wilsonge commented Apr 14, 2014 • edited by joomla-cms-bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Feature Basics

Usage

Testing

Uh oh!

Choose a reason for hiding this comment

Uh oh!

brianteeman commented Apr 14, 2014

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

FILES_JOOMLA_XML_DESCRIPTION="Joomla! 3 Content Management System"

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

compojoom commented Mar 14, 2015

Uh oh!

wilsonge commented Mar 14, 2015

Uh oh!

mbabker commented Jun 27, 2015

Uh oh!

mbabker commented Jun 27, 2015

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

joomla-cms-bot commented May 5, 2016

Uh oh!

joomla-cms-bot commented May 5, 2016

Uh oh!

Kubik-Rubik commented May 7, 2016

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

10 participants

wilsonge commented Apr 14, 2014 •

edited by joomla-cms-bot

Loading