Difference between revisions of "Developer Area/Plugins/Third party"

Revision as of 12:34, 9 October 2023

A list of the third-party plugins within Mahara.

Composer commands

For available versions, e.g. composer show phpro/grumphp-shim 1.14.* --all

For our composer dependencies: composer show --tree

For checking the dependencies of a library version, e.g. composer show elasticsearch/elasticsearch 7.17.* --tree

Check if there are any outdated libraries (according to the version syntax in composer.json) composer outdated

Checking the `.Mahara` files

To check the versions in the .Mahara files, a helpful way to update this list is to go:

 find ./htdocs -type f -iname "README.Mahara" -exec grep 'Version' -B1 {} \; -print

... on the current codebase.

Syncing the list in 'Country' dropdowns

To keep in sync is the country names we use for 'Country' dropdowns. To check what the current state of play is

perl -MLocale::Country -le 'print join("\n", sort map { country2code($_) . " => " . country2code($_, LOCALE_CODE_ALPHA_3) . ", // " . $_ } all_country_names())'

and check the results against htdocs/lib/country.php and htdocs/lang/en.utf8/mahara.php files

For any confusion you can also check against https://www.iso.org

Third-party libraries (PHP and JS)

Legend

Mahara version = the README.Mahara file for the library | SemVer Info - explaining the symbols in the Mahara version column
Latest version = the most recent available version
Security = is there a new security patch available?
Upgrades/updates = what upgrades are available for this plugin?
Support = Is there a community supporting this library?
- Active: There is ongoing work being put into the library
- Inactive: Maintained but not actively making releases
- Archived: Not being maintained
- Deprecated (officially): All maintainers have left, and site may not exist in extreme cases.
PHP8 = is the latest version of this plugin compatible with PHP8?
README location = where it can be found in Mahara
License = software license for the library
URL/Notes = extra information, e.g. resources, notes, and news
🚧 Work in progress - data needs to be updated

PHP versions in support https://www.php.net/supported-versions.php - 14 LTS - Ends security support in 30 Apr 2023, go to 16 LTS soon

💡 A new idea is being proposed to better handle customisations on updating third party libraries lives here → https://reviews.mahara.org/c/mahara/+/13780

PHP libraries (excluding external)

https://eusonlito.github.io/php-changes-cheatsheet/deprecated.html

Libraries are managed by Composer. See composer.json

Run composer show to get a quick summary of library versions managed by Composer.

Run composer outdated to get a list of outdated libraries.

🟡 Libraries yet to be moved to Composer: SimpleSAMLPHP - currently lives in htdocs/auth/saml/extlib and the version is managed in Makefile by curl.

Name	Mahara version	Available update (Major, Minor, Security, Patch)	Last release	License	URL/Notes	Composer
ADODB	5.22.6	Up to date	Active	BSD 3-Clause LGPL	Official site \| GitHub \| Twitter Wish-list: extract $SESSION	✅
CSS Tidy	2.1.0	Up to date	Active	LGPL	GitHub	✅
Elasticsearch PHP	7.17.2	Major, 8.10.0	Active	Apache v2.0 LGPL v2.1	GitHub \| Changelog Move to OpenSearch	✅
HTML Purifier	4.16.0	Up to date	2022	LGPL v2.1+	HTML Purifier \| GitHub	✅
PHPMailer	6.8.1	Up to date	Active	LGPL	GitHub	✅
ReCaptcha	1.2.4	Minor, 1.3.0	Active	BSD-3	GitHub	✅
simplesamlphp	2.0.4	Minor, 2.0.6	Active	GPL 2.1	GitHub Optional library - called in Makefile htdocs/auth/saml/extlib/modules	❌

JavaScript and jQuery libraries

🟡 Check that our Node version is still in support https://endoflife.date/nodejs node| https://nodejs.org/en/download/releases/ ➡ Update the .nvmrc file with the supported version.

Run npm list to get a quick list of the versions and libraries managed by NPM

Goal: to move libraries to be managed by NPM

Name	Mahara version	Update available (Major, Minor, Security, Patch)	Last release	Location `(./htdocs/...)`	License	URL/Notes	NPM
yargs	5.0.2	Minor, 5.3.2	Active	.../lib/bootstrap/assets/javascripts/	MIT	Releases \| GitHub bootstrap versions	✅
Date time picker	4.17.47	Major	Active - v6	.../js/bootstrap-datetimepicker/	MIT	GitHub \| Get Date Picker Latest release: rewrite (beta)	❌
Chart.js	3.9.1	Major, 4.4.0	Active	.../js/chartjs/	MIT	Chart JS \| GitHub Migration to v4	✅
Clipboard js	2.0.11	Up to date	Active	.../js/clipboard/	MIT	Clipboard JS \| GitHub version # is tagged	✅
Dragon-drop	3.6.1	Minor	2020	..../js/dragondrop/	MIT	GitHub	✅
Datatables	1.11.4	Minor	Active	.../js/DataTables/	MIT	Data Tables \|Download Release notes CDN	❌ Need to use web builder
Dropzone	5.9.3	Patch, 5.9.3	2021	.../js/dropzone/	MIT	NPM dropzone	✅
Gridstack	4.4.1	Major	Active	.../js/gridstack/	MIT	GitHub \| Website	❌
jQuery	3.7.1	Up to date	Active	.../js/jquery/	MIT	Website Forum	✅
jQuery UI	1.13.2	Up to date	Active	.../js/jquery/jquery-ui/	MIT	jQuery UI	✅
JS Color	2.5.1	Up to date	Inactive,2022	.../js/jscolor/	GPL 3	http://jscolor.com/	✅
Json editor	2.6.1	Minor	Active	.../js/jsoneditor/	MIT	GitHub \|Changelog	🚧
Marked	4.3.0	Minor, 4.3.0 Major 9.1.0	Active	.../js/marked/	MIT	GitHub	✅
Moment.js	2.29.4	Up to date	Active	.../js/momentjs/	MIT	Moment JS 🆕 Luxon GitHub	✅
PDFjs	3.10.111	Minor	Active	.../artefact/file/blocktype/pdf/js/pdfjs/	Apache License 2	Getting started \| GitHub The Firefox dist version seems to be the only working one	❌
Popper	2.11.8	Up to date	Active	.../js/popper/	MIT	https://popper.js.org/ GitHub issue \| tooltips Floating UI	✅
Fontawesome	6.4.2	Up to date	Active	.../theme/raw/sass/lib/font-awesome/	SIL OFL 1.1	Font Awesome \| GitHub \| Upgrade steps \| Changelog	✅
TinyMCE	5.10.7	Major, 6.7.0	Active	.../js/tinymce/	LGPL 2.1	Tiny Cloud \| Downloads \| Changelog \|News 📲 Test on mobile	✅
Video.js	7.21.5	Major, 8.5.2	Active	.../artefact/file/blocktype/ internalmedia/videojs/	Apache License 2.0	Video JS \| GitHub	✅

Forked/stale/deprecated libraries

Name	Mahara version	Latest version	Status	Location `(./htdocs/...)`	License	URL	Next action
Dwoo	1.3.7	1.3.7	Archived, 2020	.../lib/dwoo/	LGPL	Dead site? GitHub
Javascript templates	3.20.0	3.20.0	Archived, 2021	.../js/javascript-templates/	MIT	GitHub
jQuery mobile	1.5.0-alpha.1	1.5.0-rc1	Deprecated	.../js/jquery/jquery-mobile/	MIT	Website 🚨 "transition(ed) ... under the jQuery project umbrella, jQuery UI"	Remove and test
jQuery UI plugin touch-punch	0.2.3	0.2.3	Deprecated	.../js/jquery/jquery-ui/ jquery-ui-touch-punch.min.js	MIT or GPL Version 2	GitHub 🚨 external to JQuery UI	Use a fork?
jTLine	1.0	1.0	Inactive, 2018	.../js/jTLine/	MIT	GitHub Twitter Ref
Masonry	4.2.2	4.2.2	Inactive, 2018	.../js/masonry/	MIT	Masonry GitHub
TinyMCE Mathslate	1.1	1.1	Forked, 2015	.../js/tinymce/plugins/mathslate/	GPL 3	Our version is forked. to work with Tinymce 5
Oauth PHP	175	175	Archived, 2010	.../webservice/libs/oauth-php/	MIT	Code	Replace with an oauth2 php library see what Moodle does (old comment)
zxcvbn	4.4.2	4.4.2	Inactive, 2017	.../js/zxcvbn/	MIT	GitHub
Cookie consent	3.1.1	4.0	No open source updates	.../js/cookieconsent/	MIT	Download GitHub Open source version is not updated. 🚨
Select2	4.0.13	4.0.13	Inactive, 2020	.../js/select2/	MIT	Select2 \| Releases RC 4.1

Fonts

Name	Mahara version	Latest version	Status	README location `(./htdocs/...)`	License	URL/Notes
Aurulent Sans (font)	2007.05.04	2007.05.04	n/a	.../lib/fonts/	SIL OFL v1.10	Font Squirrel Aurulent Sans
Deja Vu Sans (font)	2.37	2.37	n/a	.../lib/fonts/	DejaVu Fonts	Font Squirrel Deja Vu Sans
Open Sans (font)	1.10	1.10	Unknown	.../theme/raw/fonts/	Apache License	Google Fonts Open Sans
Roboto Slab (font)	1.100263	1.100263	Unknown	.../theme/raw/fonts/	MIT	Google Fonts Roboto
Charis SIL (fonts)	6.001	6.001	Active	.././lib/fonts/	SIL OFL	About font \| Download

Composer.json dependencies

Resources: https://git.mahara.org | /mahara/mahara/-/blob/ | mahara/external/composer.json

Run composer outdated to check for updates.

Difference between revisions of "Developer Area/Plugins/Third party"

From Mahara Wiki

< Developer Area‎ | Plugins

Revision as of 12:34, 9 October 2023

Contents

Composer commands

Checking the `.Mahara` files

Syncing the list in 'Country' dropdowns

Third-party libraries (PHP and JS)

Legend

PHP libraries (excluding external)

JavaScript and jQuery libraries

Forked/stale/deprecated libraries

Fonts

Composer.json dependencies

@@ Line 57: / Line 57: @@
 !'''Name'''
 !'''Mahara <br />version'''
-!'''Available<br />updates'''
+!'''Available<br />update (Major, Minor, Security, Patch)'''
-!'''Security'''
 !'''Last release'''
 !'''License'''
@@ Line 64: / Line 63: @@
 !'''Composer'''
 |-
-| style="font-weight:bold;" |ADODB
+| style="font-weight:bold;" |'''ADODB'''
 |5.22.6
 |Up to date
-|N/A
 |Active
 |BSD 3-Clause<br />LGPL
@@ Line 73: / Line 71: @@
 |✅
 |-
-| style="font-weight:bold;" |CSS Tidy
+| style="font-weight:bold;" |'''CSS Tidy'''
 |2.1.0
 |Up to date
-|N/A
 |Active
 |LGPL
@@ Line 82: / Line 79: @@
 |✅
 |-
-| style="font-weight:bold;" |Elasticsearch PHP
+| style="font-weight:bold;" |'''Elasticsearch PHP'''
 | style="color:#333;" |7.17.2
 |Major, 8.10.0
-|N/A
 |Active
 |Apache v2.0  LGPL v2.1
@@ Line 93: / Line 89: @@
 |✅
 |-
-| style="font-weight:bold;" |HTML Purifier
+| style="font-weight:bold;" |'''HTML Purifier'''
 |4.16.0
 |Up to date
-|N/A
 |2022
 |LGPL v2.1+
@@ Line 102: / Line 97: @@
 |✅
 |-
-| style="font-weight:bold;" |PHPMailer
+| style="font-weight:bold;" |'''PHPMailer'''
 |6.8.1
 |Up to date
-|N/A
 |Active
 |LGPL
@@ Line 111: / Line 105: @@
 |✅
 |-
-| style="font-weight:bold;" |ReCaptcha
+| style="font-weight:bold;" |'''ReCaptcha'''
 |1.2.4
 |Minor, 1.3.0
-|TBC
 |Active
 |BSD-3
@@ Line 120: / Line 113: @@
 |✅
 |-
-| style="font-weight:bold;" |simplesamlphp
+| style="font-weight:bold;" |'''simplesamlphp'''
 |2.0.4
 |Minor, 2.0.6
-|N/A
 |Active
 |GPL 2.1
@@ Line 131: / Line 123: @@
 <small>htdocs/auth/saml/extlib/modules</small>
 |❌
-|-
-|behat
-|3.13.0
-|Up to date
-|N/A
-|
-|
-|
-|✅
-|-
-|behat/gherkin
-|4.9.0
-|Up to date
-|N/A
-|
-|
-|
-|✅
-|-
-|behat/mink
-|1.7.1
-|Up to date
-|N/A
-|
-|
-|
-|✅
-|-
-|behat/mink-browserkit-driver
-|1.3.3
-|Up to date
-|N/A
-|
-|
-|
-|✅
-|-
-|behat/mink-extension
-|2.3.1
-|Up to date
-|N/A
-|
-|
-|
-|✅
-|-
-|behat/mink-goutte-driver
-|1.3.0
-|Up to date
-|N/A
-|
-|
-|
-|✅
-|-
-|behat/mink-selenium2-driver
-|1.3.1
-|Up to date
-|N/A
-|
-|
-|
-|✅
-|-
-|behat/transliterator
-|1.5.0
-|Up to date
-|N/A
-|
-|
-|
-|✅
 |}
@@ Line 215: / Line 135: @@
 !'''Name'''
 !'''Mahara <br />version'''
-!'''Update available'''
+!'''Update available (Major, Minor, Security, Patch)'''
-!'''Security'''
 !'''Last release'''
 !'''Location<br />'''<code><small>(./htdocs/...)</small></code>
@@ Line 223: / Line 142: @@
 !'''NPM'''
 |-
-| style="font-weight:bold;" |Bootstrap
+| style="font-weight:bold;" |'''yargs'''
 |5.0.2
 |Minor, 5.3.2
-|?
 |Active
 |<small>.../lib/bootstrap/assets/javascripts/<br /></small>
@@ Line 234: / Line 152: @@
 |✅
 |-
-| style="font-weight:bold;" |Date time
+| style="font-weight:bold;" |'''Date time'''
-picker
+'''picker'''
 |4.17.47
 |'''Major'''
-|No
 |Active - v6
 |<small>.../js/bootstrap-datetimepicker/</small>
@@ Line 247: / Line 164: @@
 |❌
 |-
-| style="font-weight:bold;" |Chart.js
+| style="font-weight:bold;" |'''Chart.js'''
 |3.9.1
 |Major, 4.4.0
-|No
 |Active
 |<small>.../js/chartjs/</small>
@@ Line 258: / Line 174: @@
 |✅
 |-
-| style="font-weight:bold;" |Clipboard js
+| style="font-weight:bold;" |'''Clipboard js'''
 |2.0.11
 |Up to date
-|No
 |Active
 |<small>.../js/clipboard/</small>
@@ Line 268: / Line 183: @@
 |✅
 |-
-| style="font-weight:bold;" |Dragon-drop
+| style="font-weight:bold;" |'''Dragon-drop'''
 |3.6.1
 |'''Minor'''
-|No
 |2020
 |<small>..../js/dragondrop/</small>
@@ Line 278: / Line 192: @@
 |✅
 |-
-| style="font-weight:bold;" |Datatables
+| style="font-weight:bold;" |'''Datatables'''
 |1.11.4
 |'''Minor'''
-|No
 |Active
 |<small>.../js/DataTables/</small>
@@ Line 289: / Line 202: @@
 |❌ Need to use web builder
 |-
-| style="font-weight:bold;" |Dropzone
+| style="font-weight:bold;" |'''Dropzone'''
 |5.9.3
 |Patch, 5.9.3
-|No
 |2021
 |<small>.../js/dropzone/</small>
@@ Line 299: / Line 211: @@
 |✅
 |-
-| style="font-weight:bold;" |Gridstack
+| style="font-weight:bold;" |'''Gridstack'''
 |4.4.1
 |'''Major'''
-|No
 |Active
 |<small>.../js/gridstack/</small>
@@ Line 309: / Line 220: @@
 |❌
 |-
-| style="font-weight:bold;" |jQuery
+| style="font-weight:bold;" |'''jQuery'''
 |3.7.1
 |Up to date
-|No
 |Active
 |<small>.../js/jquery/</small>
@@ Line 319: / Line 229: @@
 |✅
 |-
-| style="font-weight:bold;" |jQuery UI
+| style="font-weight:bold;" |'''jQuery UI'''
 |1.13.2
 |Up to date
-|No
 |Active
 |<small>.../js/jquery/jquery-ui/</small>
@@ Line 329: / Line 238: @@
 |✅
 |-
-| style="font-weight:bold;" |JS Color
+| style="font-weight:bold;" |'''JS Color'''
 |2.5.1
 |Up to date
-|N/A
 |Inactive,2022
 |<small>.../js/jscolor/</small>
@@ Line 339: / Line 247: @@
 |✅
 |-
-| style="font-weight:bold;" |Json editor
+| style="font-weight:bold;" |'''Json editor'''
 |2.6.1
 |'''Minor'''
-|No
 |Active
 |<small>.../js/jsoneditor/</small>
@@ Line 349: / Line 256: @@
 |🚧
 |-
-| style="font-weight:bold;" |Marked
+| style="font-weight:bold;" |'''Marked'''
 |4.3.0
 |Minor, 4.3.0
 Major 9.1.0
-|No
 |Active
 |<small>.../js/marked/</small>
@@ Line 360: / Line 266: @@
 |✅
 |-
-| style="font-weight:bold;" |Moment.js
+| style="font-weight:bold;" |'''Moment.js'''
 |2.29.4
 |Up to date
-|No
 |Active
 |<small>.../js/momentjs/</small>
@@ Line 370: / Line 275: @@
 |✅
 |-
-| style="font-weight:bold;" |PDFjs
+| style="font-weight:bold;" |'''PDFjs'''
 |3.10.111
 |'''Minor'''
-|No
 |Active
 |<small>.../artefact/file/blocktype/pdf/js/pdfjs/</small>
@@ Line 379: / Line 283: @@
 |[http://mozilla.github.io/pdf.js/getting_started/#download Getting started]<nowiki> | </nowiki>[https://github.com/mozilla/pdf.js GitHub]
 The Firefox dist version seems to be the only working one
-|*
+|❌
 |-
-| style="font-weight:bold;" |Floating UI (Popper)
+| style="font-weight:bold;" |'''Popper'''
 |2.11.8
 |Up to date
-|N/A
 |Active
 |<small>.../js/popper/</small>
 |MIT
 |https://popper.js.org/<br />[https://github.com/twbs/bootstrap/issues/31451 GitHub issue]<nowiki> | </nowiki>[https://dev.to/fezvrasta/smarter-tooltips-and&#x20;-popovers-with-popper-2-44bh tooltips]
+'''Floating UI'''
 |✅
 |-
-| style="font-weight:bold;" |Fontawesome
+| style="font-weight:bold;" |'''Fontawesome'''
 |6.4.2
 |Up to date
-|N/A
 |Active
 |<small>.../theme/raw/sass/lib/font-awesome/</small>
@@ Line 402: / Line 305: @@
 |✅
 |-
-| style="font-weight:bold;" |TinyMCE
+| style="font-weight:bold;" |'''TinyMCE'''
 |5.10.7
 |Major, 6.7.0
-|No
 |Active
 |<small>.../js/tinymce/</small>
@@ Line 413: / Line 315: @@
 |✅
 |-
-| style="font-weight:bold;" |Video.js
+| style="font-weight:bold;" |'''Video.js'''
 |7.21.5
 |Major, 8.5.2
-|No
 |Active
 |<small>.../artefact/file/blocktype/<br />internalmedia/videojs/</small>
@@ Line 436: / Line 337: @@
 !'''Next action'''
 |-
-| style="font-weight:bold;" |Dwoo🟡
+| style="font-weight:bold;" |'''Dwoo'''
 |1.3.7
 |1.3.7
@@ Line 446: / Line 347: @@
 |
 |-
-| style="font-weight:bold;" |Javascript <br />templates
+| style="font-weight:bold;" |'''Javascript <br />templates'''
 |3.20.0
 |3.20.0
@@ Line 455: / Line 356: @@
 |
 |-
-| style="font-weight:bold;" |jQuery mobile
+| style="font-weight:bold;" |'''jQuery mobile'''
 |1.5.0-alpha.1
 |1.5.0-rc1
@@ Line 464: / Line 365: @@
 |Remove and test
 |-
-| style="font-weight:bold;" |jQuery UI plugin <br />touch-punch
+| style="font-weight:bold;" |'''jQuery UI plugin <br />touch-punch'''
 |0.2.3
 |0.2.3
@@ Line 475: / Line 376: @@
 |[https://github.com/RWAP/jquery-ui-touch-punch Use a fork?]
 |-
-| style="font-weight:bold;" |jTLine
+| style="font-weight:bold;" |'''jTLine'''
 |1.0
 |1.0
@@ Line 487: / Line 388: @@
 |
 |-
-| style="font-weight:bold;" |Masonry
+| style="font-weight:bold;" |'''Masonry'''
 |4.2.2
 |4.2.2
@@ Line 497: / Line 398: @@
 |
 |-
-| style="font-weight:bold;" |TinyMCE<br />Mathslate
+| style="font-weight:bold;" |'''TinyMCE<br />Mathslate'''
 |1.1
 |1.1
@@ Line 506: / Line 407: @@
 |
 |-
-| style="font-weight:bold;" |Oauth PHP
+| style="font-weight:bold;" |'''Oauth PHP'''
 |175
 |175
@@ Line 515: / Line 416: @@
 |<small>Replace with an</small> <small>[https://oauth.net/code/php oauth2 php library] see what Moodle does (old comment)</small>
 |-
-| style="font-weight:bold;" |zxcvbn
+| style="font-weight:bold;" |'''zxcvbn'''
 |4.4.2
 |4.4.2
@@ Line 524: / Line 425: @@
 |
 |-
-|Cookie consent
+|'''Cookie consent'''
 |3.1.1
 |4.0
@@ Line 535: / Line 436: @@
 |
 |-
-|Select2
+|'''Select2'''
 |4.0.13
 |4.0.13
@@ Line 556: / Line 457: @@
 !'''URL/Notes'''
 |-
-| style="font-weight:bold;" |Aurulent Sans <br />(font)
+| style="font-weight:bold;" |'''Aurulent Sans <br />(font)'''
 |2007.05.04
 |2007.05.04
@@ Line 564: / Line 465: @@
 |[https://www.fontsquirrel.com/fonts/aurulent-sans Font Squirrel Aurulent Sans]
 |-
-| style="font-weight:bold;" |Deja Vu Sans <br />(font)
+| style="font-weight:bold;" |'''Deja Vu Sans <br />(font)'''
 |2.37
 |2.37
@@ Line 572: / Line 473: @@
 |[http://www.fontsquirrel.com/fonts/DejaVu-Sans Font Squirrel Deja Vu Sans]
 |-
-| style="font-weight:bold;" |Open Sans <br />(font)
+| style="font-weight:bold;" |'''Open Sans <br />(font)'''
 |1.10
 |1.10
@@ Line 580: / Line 481: @@
 |[https://www.google.com/fonts/specimen/Open+Sans Google Fonts Open Sans]
 |-
-| style="font-weight:bold;" |Roboto Slab <br />(font)
+| style="font-weight:bold;" |'''Roboto Slab <br />(font)'''
 |1.100263
 |1.100263
@@ Line 588: / Line 489: @@
 |[https://www.google.com/fonts/specimen/Roboto+Slab Google Fonts Roboto]
 |-
-|Charis SIL <br />(fonts)
+|'''Charis SIL <br />(fonts)'''
 |6.001
 |6.001

Difference between revisions of "Developer Area/Plugins/Third party"

From Mahara Wiki

< Developer Area‎ | Plugins

Revision as of 12:34, 9 October 2023

Composer commands

Checking the .Mahara files

Syncing the list in 'Country' dropdowns

Third-party libraries (PHP and JS)

Legend

PHP libraries (excluding external)

JavaScript and jQuery libraries

Forked/stale/deprecated libraries

Fonts

Composer.json dependencies

Checking the `.Mahara` files