Developer Area/Plugins/Third party: Difference between revisions

Latest revision as of 16:18, 4 Ocak 2024

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
Update type = what upgrades are available for this plugin, i.e. major, minor, patch, or security?
Support = Is there a community supporting this library? When was the last release year if not in active support
- 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.
License = software license for the library
Notes = extra information, e.g. resources, notes, and new
Composer = check if the library is managed by Composer
NPM = check if the library is managed by NPM

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	Update type	Support	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	❌

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

NPM-managed JS libraries

Name	Mahara version	Update type	Support	License	Notes
yargs	5.0.2	Minor, 5.3.2	Active	MIT
Chart.js	3.9.1	Major, 4.4.0	Active	MIT	Migration to v4
Clipboard js	2.0.11	Up to date	Active	MIT	version # is tagged
Dragon-drop	3.6.1	Up to date	2020	MIT
Dropzone	5.9.3	Patch, 5.9.3	2021	MIT
jQuery	3.7.1	Up to date	Active	MIT	Forum
jQuery UI	1.13.2	Up to date	Active	MIT
JS Color	2.5.1	Up to date	Inactive,2022	GPL 3
Marked	4.3.0	Minor, 4.3.0 Major 9.1.0	Active	MIT
Moment.js	2.29.4	Up to date	Active	MIT	Moment JS 🆕 Luxon GitHub
Popper	2.11.8	Up to date	Active	MIT	GitHub issue \| tooltips Floating UI
Fontawesome	6.4.2	Up to date	Active	SIL OFL 1.1	Upgrade steps \| Changelog
TinyMCE	5.10.7	Major, 6.7.0	Active	LGPL 2.1	Downloads \| Changelog 📲 Test mobile
Video.js	7.21.5	Major, 8.5.2	Active	Apache License 2.0	Video JS

Manually managed JS libraries

Name	Mahara version	Update type	Support	Location `(./htdocs/...)`	License	Notes	NPM
Date time picker	4.17.47	Major 6.17.16	Active - v6	.../js/bootstrap-datetimepicker/	MIT	Changelog Latest release: rewrite (beta)	❌
Datatables	1.11.4	Minor	Active	.../js/DataTables/	MIT	Download Release notes CDN	❌ Need to use web builder
Gridstack	4.4.1	Major	Active	.../js/gridstack/	MIT	[Demos](https://gridstackjs.com/demo/) https://github.com/gridstack/gridstack.js/tree/master/doc	🚧
Json editor	2.6.1	Minor	Active	.../js/jsoneditor/	MIT	Changelog	🚧
PDFjs	3.10.111	Minor 🚧	Active	.../artefact/file/blocktype/pdf/js/pdfjs/	Apache License 2	Getting started The Firefox dist version different to NPM package	❌

Forked/stale/deprecated libraries

Name	Mahara version	Latest version	Support	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.

Developer Area/Plugins/Third party: Difference between revisions

From Mahara Wiki

< Developer Area‎ | Plugins

Latest revision as of 16:18, 4 Ocak 2024

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

NPM-managed JS libraries

Manually managed JS libraries

Forked/stale/deprecated libraries

Fonts

Composer.json dependencies

@@ Line 1: / Line 1: @@
-A list of the third party plugins within Mahara.
+A list of the third-party plugins within Mahara.
-A helpful way to update this list is to go:
+=== Composer commands ===
-   find ./htdocs -type f -iname "README.Mahara" -exec grep 'Version' -B1 {} \; -print
+For available versions, e.g.  <code>composer show phpro/grumphp-shim 1.14.* --all</code>
-on the current codebase.
+For our composer dependencies:  <code>composer show  --tree</code>
+For checking the dependencies of a library version, e.g. <code>composer show elasticsearch/elasticsearch 7.17.* --tree</code>
+Check if there are any outdated libraries (according to the [[SemVer Info|version syntax]] in <code>composer.json</code>)  <code>composer outdated</code>
+=== Checking the <code>.Mahara</code> files ===
+To check the versions in the <code>.Mahara</code> files, a helpful way to update this list is to go:
+   <code>find ./htdocs -type f -iname "README.Mahara" -exec grep 'Version' -B1 {} \; -print</code>
+... 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
+ <code>perl -MLocale::Country -le 'print join("\n", sort map { country2code($_) . " => " . country2code($_, LOCALE_CODE_ALPHA_3) . ", // " . $_ } all_country_names())'</code>
+and check the results against <code>htdocs/lib/country.php</code> and <code>htdocs/lang/en.utf8/mahara.php</code> files
-Note: another thing 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
-====Legend====
+== Third-party libraries (PHP and JS) ==
+=== Legend ===
+*'''Mahara version''' = the <code>README.Mahara</code> file for the library | [https://nodejs.dev/learn/semantic-versioning-using-npm SemVer Info] - explaining the symbols in the Mahara version column
+*'''Latest version''' = the most recent available version
+*'''Update type''' = what upgrades are available for this plugin, i.e. major, minor, patch, or security?
+*'''Support''' = Is there a community supporting this library? When was the last release year if not in active support
+**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.
+*'''License''' = software license for the library
+*'''Notes''' = extra information, e.g. resources, notes, and new
+*'''Composer''' = check if the library is managed by Composer
+*'''NPM''' = check if the library is managed by NPM
+'''PHP versions in support''' https://www.php.net/supported-versions.php<nowiki/>⁣ – 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 <code>composer.json</code>
+Run <code>composer show</code> to get a quick summary of library versions managed by Composer.
-*'''PHP8''' = is the latest version of this plugin compatible with PHP8?
+Run <code>composer outdated</code> to get a list of outdated libraries.
-*'''Upgrades''' = what upgrades are available for this plugin?
-*'''Security''' = is there a new security patch available?
-*'''22.04''' column: Yes = will need to be updated for this version
-*[https://nodejs.dev/learn/semantic-versioning-using-npm SemVer Info] - explaining the symbols in the Mahara version column
-*Inactive: Maintained but not actively making releases
-*Deprecated: All maintainers have left and site may not exist in extreme cases.
-*🚧: In progress/there is a working patch in gerrit
+🟡 Libraries yet to be moved to Composer: SimpleSAMLPHP - currently lives in <code>htdocs/auth/saml/extlib</code> and the version is managed in Makefile by curl.
 {| class="wikitable sortable" style="vertical-align:middle;"
 |- style="font-weight:bold; text-align:center;"
 !'''Name'''
 !'''Mahara <br />version'''
-!'''Latest<br />version<br />'''
+!'''Update type'''
-!'''22.04'''
-!'''PHP8'''
-!'''Upgrades'''
 !'''Support'''
-!'''Security'''
-!'''Notes'''
-!'''README.Mahara <br />(./htdocs/...)'''
-!'''URL'''
 !'''License'''
+!'''URL/Notes'''
+!'''Composer'''
 |-
-| style="font-weight:bold;" |ADODB
+| style="font-weight:bold;" |'''ADODB'''
-|^5.21.1<br />
+|5.22.6
-|5.22.0
+|Up to date
-|Yes 🚧
+|Active
-|Yes 8.1
-| style="color:#333;" |Security - 5.21.4<br />- pgsql: authentication bypass in connect <br />functions (CVE-2021-3850)
-|End 5.20.20
-|Yes
-|News: https://twitter.com/ADOdb_announce first.<br />Wishlist: [https://bugs.launchpad.net/mahara/+bug/1945264 extract our $SESSION]<br />php 8.0 ready.
-|.../lib/adodb/
-| - https://adodb.org/dokuwiki/doku.php<br />- https://github.com/ADOdb/ADOdb
 |BSD 3-Clause<br />LGPL
+|[https://adodb.org/dokuwiki/doku.php Official site]<nowiki> | </nowiki>[https://github.com/ADOdb/ADOdb GitHub]<nowiki> |  </nowiki>[https://twitter.com/ADOdb_announce Twitter]<br />Wish-list: [https://bugs.launchpad.net/mahara/+bug/1945264 extract $SESSION]
+|✅
 |-
-| style="font-weight:bold;" |Bootstrap
+| style="font-weight:bold;" |'''CSS Tidy'''
-|~4.6.0
+|2.1.0
-|5.1.3
+|Up to date
-|
+|Active
-|n/a
+|LGPL
-|Major e.g. 5.1.2 Updated JS Sanitizer to add <br />sms in the SAFE_URL_PATTERN
+|[https://github.com/Cerdic/CSSTidy GitHub]
-|Ends 4.x (LTS) <br />- 01 Nov 2022
+|✅
-|
-|
-|.../lib/bootstrap/assets/javascripts/<br />
-| - https://getbootstrap.com/<br />- https://github.com/twbs/release
-|MIT License
 |-
-| style="font-weight:bold;" |Bootstrap <br />Datetimepicker
+| style="font-weight:bold;" |'''Elasticsearch PHP'''
-|=4.17.47
+| style="color:#333;" |7.17.2
-|4.17.49<br /><br />
+|Major, 8.10.0
-|
+|Active
-|n/a
+|Apache v2.0  LGPL v2.1
-|Has pivoted to no longer require Bootstrap<br />v6.0.0-beta2https://github.com/Eonasdan/tempus-dominus<br />
+|[https://github.com/elastic/elasticsearch-php GitHub]<nowiki> | </nowiki>[https://github.com/elastic/elasticsearch-php/blob/master/CHANGELOG.md Changelog]
-|v4 not maintained<br />v5/6 active<br />
+Move to OpenSearch
-|
-|v4 runs using bootstrap and moment.js
+|✅
-|.../js/bootstrap-datetimepicker/
-|https://getdatepicker.com/<br />https://github.com/tempusdominus/<br />bootstrap-4
-|MIT License
 |-
-| style="font-weight:bold;" |Chart.js
+| style="font-weight:bold;" |'''HTML Purifier'''
-|3.7.1
+|4.16.0
-|3.7.1
+|Up to date
-|Done✅
+|2022
-|n/a
+|LGPL v2.1+
-|
+|[http://www.htmlpurifier.org/ HTML Purifier]<nowiki> | </nowiki>[https://github.com/ezyang/htmlpurifier/ GitHub]
-|
+|✅
-|
-|
-|.../js/chartjs/
-|http://www.chartjs.org
-|MIT License
 |-
-| style="font-weight:bold;" |Clipboard js
+| style="font-weight:bold;" |'''PHPMailer'''
-|^2.0.8
+|6.8.1
-|2.0.10
+|Up to date
-|Yes 🚧
-|n/a
-|Patch fix
 |Active
-|
+|LGPL
-|
+|[https://github.com/PHPMailer/PHPMailer GitHub]
-|.../js/clipboard/
+|✅
-|https://clipboardjs.com/
-|MIT License
 |-
-| style="font-weight:bold;" |Cookie <br />consent
+| style="font-weight:bold;" |'''ReCaptcha'''
-|=3.1.1
+|1.2.4
-|4.0
+|Minor, 1.3.0
-|
+|Active
-|n/a
+|BSD-3
-|None
+|[https://github.com/google/recaptcha GitHub]
-|New updates are<br />proprietary.
+|✅
-|
-|Site talks about versions 2021.6 and 2021.2.3 <br />which are not available on GitHub.<br />💡Check if we should keep using this - licences.
-|.../js/cookieconsent/
-| - https://www.osano.com/cookieconsent<br />- https://github.com/osano/cookieconsent<br />
-|MIT License
 |-
-| style="font-weight:bold;" |CSS Tidy
+| style="font-weight:bold;" |'''simplesamlphp'''
-|~1.7.3
+|2.0.4
-|2.0.1
+|Minor, 2.0.6
-|Yes 🚧
+|Active
-|Yes
+|GPL 2.1
-|2.0.1 released 22 Feb 2022<br />PHP8 compatible
+|[https://github.com/simplesamlphp/simplesamlphp GitHub]
-|
+Optional library - called in Makefile
-|
+|❌
-|
+|}
-|.../lib/csstidy/
-|https://github.com/Cerdic/CSSTidy
+=== JavaScript and jQuery libraries ===
-|LGPL
+🟡 '''Check that our Node version is still in support''' https://endoflife.date/nodejs  node| https://nodejs.org/en/download/releases/ ➡ Update the <code>.nvmrc</code> file with the supported version.
+Run <code>npm list</code> to get a quick list of the versions and libraries managed by NPM
+Goal: to move libraries to be managed by NPM
+==== NPM-managed JS libraries ====
+{| class="wikitable sortable" style="vertical-align:middle;"
+|- style="font-weight:bold; text-align:center;"
+!'''Name'''
+!'''Mahara <br />version'''
+!'''Update type'''
+!'''Support'''
+!'''License'''
+!'''Notes'''
 |-
-| style="font-weight:bold;" |Dragon-drop
+| style="font-weight:bold;" |'''yargs'''
-|^3.2.1
+|5.0.2
-|3.2.1
+|Minor, 5.3.2
-|
-|n/a
-|None<br />Pre-release minor <br />changelog not available.
 |Active
+|MIT
 |
-|3.6.1 in the making but in pre-release stages.
-|..../js/dragondrop/
-|https://github.com/schne324/dragon-drop
-|MIT License
 |-
-| style="font-weight:bold;" |Datatables
+| style="font-weight:bold;" |'''Chart.js'''
-|^1.10.20
+|3.9.1
-|1.11.4
+|Major, 4.4.0
-|Yes 🚧
+|Active
-|n/a
+|MIT
-|Patch fix
+|[https://www.chartjs.org/docs/latest/migration/v4-migration.html Migration to v4]
-|Active<br />
-|
-|
-|.../js/DataTables/
-|https://datatables.net/<br />https://datatables.net/download/index<br />
-|MIT License
 |-
-| style="font-weight:bold;" |Dropzone
+| style="font-weight:bold;" |'''Clipboard js'''
-|^5.7.6
+|2.0.11
-|5.9.3
+|Up to date
-|Yes 🚧
-|n/a
-|Minor
 |Active
-|
+|MIT
-|6.0.0 in beta
+|version # is tagged
-|.../js/dropzone/
-|https://github.com/dropzone/dropzone/releases
-|MIT License
 |-
-| style="font-weight:bold;" |Dwoo
+| style="font-weight:bold;" |'''Dragon-drop'''
-|=1.3.7
+|3.6.1
-|1.3.7
+|Up to date
+|2020
+|MIT
 |
-|No
-|Replace
-|Deprecated<br />
-|
-|
-|.../lib/dwoo/
-|http://dwoo.org/<br />https://github.com/dwoo-project/dwoo
-|LGPL
 |-
-| style="font-weight:bold;" |Elastic Search
+| style="font-weight:bold;" |'''Dropzone'''
-| style="color:#333;" |>6.1.0
+|5.9.3
-|7.17.0
+|Patch, 5.9.3
+|2021
+|MIT
 |
-|No
-|WIP - Gold
-|Active<br />
-|
-|PHP 8 has a [https://github.com/elastic/elasticsearch-php/milestone/6 milestone].
-|.../lib/elasticsearch/
-|https://github.com/elastic/elasticsearch-php
-|Apache v2.0 <br />LGPL v2.1
 |-
-| style="font-weight:bold;" |fancybox3
+| style="font-weight:bold;" |'''jQuery'''
-|3.5.7
+|3.7.1
-|4.0.26
+|Up to date
-|
+|Active
-|n/a
+|MIT
-|Removed from Mahara 11/2021
+|[https://forum.jquery.com/ Forum]
-|Inactive<br />- v3 deprecated<br />- v4 in beta stage
-|
-|Only exists in branch versions 20.10, 21.04, 21.10<br />Only backport security fixes
-|.../js/fancybox/
-|https://github.com/fancyapps/ui - in BETA stage<br />https://fancyapps.com/docs/ui/installation<br />https://fancyapps.com/next/<br />Notifications: https://twitter.com/thefancyapps
-|CC BY-SA 4.0
 |-
-| style="font-weight:bold;" |gridstack
+| style="font-weight:bold;" |'''jQuery UI'''
-|>0.6.4
+|1.13.2
-|5.0.0
+|Up to date
-|
-|n/a
-|WIP - Robert<br />
 |Active
+|MIT
 |
-|https://gridstackjs.com
-|.../js/gridstack/
-|https://github.com/gridstack/gridstack.js
-|MIT License
 |-
-| style="font-weight:bold;" |HTML Purifier
+| style="font-weight:bold;" |'''JS Color'''
-|=4.13.0
+|2.5.1
-|4.14.0
+|Up to date
-|Yes🚧
+|Inactive,2022
-|Yes
+|GPL 3
-|None
 |
-|4.14 includes PHP8 support
-|https://github.com/ezyang/htmlpurifier/
-|.../lib/htmlpurifier/
-|http://www.htmlpurifier.org/
-|LGPL v2.1+
 |-
-| style="font-weight:bold;" |Javascript <br />templates
+| style="font-weight:bold;" |'''Marked'''
-|=3.19.0
+|4.3.0
-|3.20.0
+|Minor, 4.3.0
-|Yes 🚧
+Major 9.1.0
-|n/a
+|Active
-|None
+|MIT
-|Inactive, 2020
-|
 |
-|.../js/javascript-templates/
-|https://github.com/blueimp/<br />[https://github.com/blueimp/JavaScript-Templates JavaScript-Templates]
-|MIT License
 |-
-| style="font-weight:bold;" |jQuery
+| style="font-weight:bold;" |'''Moment.js'''
-|^3.6.0
+|2.29.4
-|3.6.0
+|Up to date
-|
-|n/a
-|Minor
 |Active
-|
+|MIT
-|https://blog.jquery.com/2021/03/02/<br />jquery-3-6-0-released/<br />News: - QA: https://forum.jquery.com/<br />Twitter: https://twitter.com/jquery
+|[http://momentjs.com/ Moment JS] 🆕 [https://moment.github.io/luxon/#/ Luxon GitHub]
-|.../js/jquery/
-|http://jquery.com/<br />https://github.com/jquery/jquery
-|MIT License
 |-
-| style="font-weight:bold;" |jQuery mobile
+| style="font-weight:bold;" |'''Popper'''
-|=1.5.0-alpha.1
+|2.11.8
-|1.5.0-rc1
+|Up to date
-|
+|Active
-|n/a
+|MIT
-|None
+|[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]
-|Inactive, 2017
+'''Floating UI'''
-|
-|https://blog.jquerymobile.com <br />- lack of resources but wish to maintain.<br />❗Find out if we are still using this.
-|.../js/jquery/jquery-mobile/
-|http://jquerymobile.com
-|MIT License
 |-
-| style="font-weight:bold;" |jQuery UI
+| style="font-weight:bold;" |'''Fontawesome'''
-|=1.12.1
+|6.4.2
-|1.13.1
+|Up to date
-|Yes 🚧
+|Active
-|n/a
+|SIL OFL 1.1
-|In maintenance state<br />Only security and compatibility fixes
+|[https://fontawesome.com/docs/web/setup/upgrade/ Upgrade steps]<nowiki> | </nowiki>[https://fontawesome.com/docs/changelog/ Changelog]
-|
-|
-|https://blog.jqueryui.com/2022/01/jquery-ui-1-13-1-released/
-|.../js/jquery/jquery-ui/
-|http://jqueryui.com/
-|MIT License
 |-
-| style="font-weight:bold;" |jQuery UI plugin <br />touch-punch
+| style="font-weight:bold;" |'''TinyMCE'''
-|=0.2.3
+|5.10.7
-|0.2.3
+|Major, 6.7.0
-|
+|Active
-|n/a
+|LGPL 2.1
-|None
+|[https://www.tiny.cloud/get-tiny/self-hosted Downloads]<nowiki> | </nowiki>[https://www.tiny.cloud/docs/changelog/ Changelog]
-|Deprecated
+📲 Test mobile
-|
-|❗Do we still need it - is it merged into jquery
-|.../js/jquery/jquery-ui/<br />jquery-ui-touch-punch.min.js
-|http://touchpunch.furf.com/<br />https://github.com/furf/jquery-ui-touch-punch
-|MIT or GPL <br />Version 2 licenses
 |-
-| style="font-weight:bold;" |JS Color
+| style="font-weight:bold;" |'''Video.js'''
-|^2.4.5
+|7.21.5
-|2.4.7
+|Major, 8.5.2
-|Yes 🚧
-|n/a
-|None
 |Active
-|
+|Apache License 2.0
-|
+|[http://videojs.com/ Video JS]
-|.../js/jscolor/
+|}
-|http://jscolor.com/
-|GPL 3
+==== Manually managed JS libraries ====
+{| class="wikitable sortable" style="vertical-align:middle;"
+|- style="font-weight:bold; text-align:center;"
+!'''Name'''
+!'''Mahara <br />version'''
+!'''Update type'''
+!'''Support'''
+!'''Location<br />'''<code><small>(./htdocs/...)</small></code>
+!'''License'''
+!'''Notes'''
+!'''NPM'''
+|-
+| style="font-weight:bold;" |'''Date time'''
+'''picker'''
+|4.17.47
+|Major 6.17.16
+|Active - v6
+|<small>.../js/bootstrap-datetimepicker/</small>
+|MIT
+|[https://getdatepicker.com/6/change-log.html Changelog]
+Latest release: rewrite (beta)
+|❌
 |-
-| style="font-weight:bold;" |Json editor
+| style="font-weight:bold;" |'''Datatables'''
-|>=1.3.5
+|1.11.4
-|2.6.1
+|Minor
-|Yes
-|n/a
-|Major 2.x
 |Active
-|
+|<small>.../js/DataTables/</small>
-|Leave for for 22.04
+|MIT
-|.../js/jsoneditor/
+|[https://datatables.net/download/index Download]
-|https://github.com/json-editor/json-editor
+[https://cdn.datatables.net/ Release notes CDN]
-|MIT License
+|❌ Need to use web builder
 |-
-| style="font-weight:bold;" |jTLine
+| style="font-weight:bold;" |'''Gridstack'''
-|=1.0
+|4.4.1
-|1.0
+|Major
-|
+|Active
-|n/a
+|<small>.../js/gridstack/</small>
-|None
+|MIT
-|Inactive, 2018
+|[Demos](<nowiki>https://gridstackjs.com/demo/</nowiki>)
-|
-|https://twitter.com/naadydev
-|.../js/jTLine/
+https://github.com/gridstack/gridstack.js/tree/master/doc
-|https://naadydev.github.io/jTLine/
+|🚧
-|MIT License
 |-
-| style="font-weight:bold;" |Lodash
+| style="font-weight:bold;" |'''Json editor'''
-| style="color:#333;" |^4.17.15
+|2.6.1
-|4.17.21
+|Minor
-|
-|n/a
-|Patch fix
 |Active
-|
+|<small>.../js/jsoneditor/</small>
-| - Lodash was brought in with gridstack v0.5.0 <br />- Will be removed when gridstack 4+ gets merged.
+|MIT
-|.../js/lodash/
+|[https://github.com/json-editor/json-editor/blob/master/CHANGELOG.md Changelog]
-|https://github.com/lodash/lodash
+|🚧
-|MIT License
 |-
-| style="font-weight:bold;" |Marked
+| style="font-weight:bold;" |'''PDFjs'''
-|^2.1.3
+|3.10.111
-|4.0.12
+|Minor 🚧
-|Yes 🚧
-|n/a
-|Minor - v2.1.1, v2.1.2, v2.1.3<br />Major 3.x - breaking changes<br />4.0.0 Major security fixes
 |Active
-|Yes
+|<small>.../artefact/file/blocktype/pdf/js/pdfjs/</small>
+|Apache License 2
+|[http://mozilla.github.io/pdf.js/getting_started/#download Getting started]
+The Firefox dist version different to NPM package
+|❌
+|}
+=== Forked/stale/deprecated libraries ===
+{| class="wikitable sortable mw-collapsible mw-collapsed" style="vertical-align:middle;"
+|- style="font-weight:bold; text-align:center;"
+!'''Name'''
+!'''Mahara <br />version'''
+!'''Latest<br />version'''
+!'''Support'''
+!'''Location<br />'''<code><small>(./htdocs/...)</small></code>
+!'''License'''
+!'''URL'''
+!'''Next action'''
+|-
+| style="font-weight:bold;" |'''Dwoo'''
+|1.3.7
+|1.3.7
+|'''Archived, 2020'''
+|<small>.../lib/dwoo/</small>
+|LGPL
+|[http://dwoo.org/ Dead site?]
+[https://github.com/dwoo-project/dwoo GitHub]
 |
-|.../js/marked/
-|https://github.com/markedjs/marked
-|MIT License
 |-
-| style="font-weight:bold;" |Masonry
+| style="font-weight:bold;" |'''Javascript <br />templates'''
-|=4.2.2
+|3.20.0
-|4.2.2
+|3.20.0
+|'''Archived, 2021'''
+|<small>.../js/javascript-templates/</small>
+|MIT
+|[https://github.com/blueimp/JavaScript-Templates GitHub]
 |
-|n/a
-|None
-|Inactive, 2018
-|
-|
-|.../js/masonry/
-|https://masonry.desandro.com/<br />https://github.com/desandro/masonry
-|MIT License
 |-
-| style="font-weight:bold;" |TinyMCE<br />Mathslate
+| style="font-weight:bold;" |'''jQuery mobile'''
-|=1.1
+|1.5.0-alpha.1
-|1.1
+|1.5.0-rc1
-|
+|'''Deprecated'''
-|n/a
+|<small>.../js/jquery/jquery-mobile/</small>
-|None
+|MIT
-|Forked version, 2015
+|[http://jquerymobile.com Website] <br /><small>🚨 ''"transition(ed) ...''</small> <small>''under the jQuery project umbrella, jQuery UI"''</small>
-|
+|Remove and test
-|Our version is now forked to keep <br />make it work with Tinymce 5
-|.../js/tinymce/plugins/mathslate/
-|https://github.com/dthies/tinymce4-mathslate
-|GPL 3
 |-
-| style="font-weight:bold;" |Moment.js
+| style="font-weight:bold;" |'''jQuery UI plugin <br />touch-punch'''
-|^2.29.1
+|0.2.3
-|2.29.1
+|0.2.3
-|
+|'''Deprecated'''
-|n/a
+|<small>.../js/jquery/jquery-ui/<br />jquery-ui-touch-punch.min.js</small>
-|None
+|MIT or GPL <br />Version 2
-|Inactive, 2020
+|[https://github.com/furf/jquery-ui-touch-punch GitHub]
-|
-|Connected with jquery date-picker
+<small>🚨 external to JQuery UI</small>
-|.../js/momentjs/
+|[https://github.com/RWAP/jquery-ui-touch-punch Use a fork?]
-|http://momentjs.com/
-|MIT License
 |-
-| style="font-weight:bold;" |Oauth PHP
+| style="font-weight:bold;" |'''jTLine'''
-|=175
+|1.0
-|175
+|1.0
+|'''Inactive, 2018'''
+|<small>.../js/jTLine/</small>
+|MIT
+|[https://naadydev.github.io/jTLine/ GitHub]
+[https://twitter.com/naadydev Twitter]
+[https://codyhouse.co/gem/horizontal-timeline Ref]
 |
-|No
-|Replace
-|Archived, 2010
-|
-|We should replace with an oauth2 php library <br />https://oauth.net/code/php<br />checkout what Moodle does (old comment)
-|.../webservice/libs/oauth-php/
-|https://code.google.com/archive/p/oauth-php/
-|MIT License
 |-
-| style="font-weight:bold;" |PDFjs
+| style="font-weight:bold;" |'''Masonry'''
-|^2.9.359
+|4.2.2
-|2.12.313<br />
+|4.2.2
-|Yes
+|'''Inactive, 2018'''
-|n/a
+|<small>.../js/masonry/</small>
-|Minor
+|MIT
-|Active
+|[https://masonry.desandro.com/ Masonry]
-|
+[https://github.com/desandro/masonry GitHub]
 |
-|.../artefact/file/blocktype/pdf/js/pdfjs/
-|http://mozilla.github.io/pdf.js/<br />getting_started/#download<br />https://github.com/mozilla/pdf.js
-|Apache License 2
 |-
-| style="font-weight:bold;" |PHPMailer
+| style="font-weight:bold;" |'''TinyMCE<br />Mathslate'''
-|^6.5.1
+|1.1
-|6.5.4
+|1.1
-|Yes
+|'''Forked, 2015'''
-|Yes
+|<small>.../js/tinymce/plugins/mathslate/</small>
-|Minor 6.5.0 - security release<br />Minor 6.5.1 - maintenance release<br />PHP8 support
+|GPL 3
-|Active<br />
+|<small>Our version is [[GitHub|forked]].<br />to work with Tinymce 5</small>
-|Yes
 |
-|.../lib/phpmailer/
-|https://github.com/PHPMailer/PHPMailer
-|LGPL
 |-
-| style="font-weight:bold;" |Popper
+| style="font-weight:bold;" |'''Oauth PHP'''
-|^1.16.1 LTS
+|175
-|2.11.2
+|175
-|Yes
+|'''Archived, 2010'''
-|n/a
+|<small>.../webservice/libs/oauth-php/</small>
-|(Bootstrap 5 supports v2.x)<br />Major 2.x - breaking 2020 - 2.9.3<br />(bootstrap4) - Minor 1.16.1, Mar 2020 <br />Popper is now floating-ui, built ontop of popper, <br />different releases for core/react-native/react-dom
+|MIT
-|Active v2<br />LTS 1.16.1 <br />w/o warnings
+|[https://code.google.com/archive/p/oauth-php/ Code]
-|
+|<small>Replace with an</small> <small>[https://oauth.net/code/php oauth2 php library] see what Moodle does (old comment)</small>
-|https://dev.to/fezvrasta/smarter-tooltips-and<br />-popovers-with-popper-2-44bh<br />
-|.../lib/popper/
-|https://popper.js.org/
-|MIT License
 |-
-| style="font-weight:bold;" |ReCaptcha
+| style="font-weight:bold;" |'''zxcvbn'''
-|^1.2.4
+|4.4.2
-|1.2.4
+|4.4.2
+|'''Inactive, 2017'''
+|<small>.../js/zxcvbn/</small>
+|MIT
+|[https://github.com/dropbox/zxcvbn GitHub]
 |
-|In progress
-|Patch
-|Active
-|
-|This client supports both v2 and v3.<br />https://github.com/google/recaptcha/tree/php8-support
-|.../lib/recaptcha/
-|https://github.com/google/recaptcha
-|BSD-3
 |-
-| style="font-weight:bold;" |simplesamlphp
+|'''Cookie consent'''
-|^1.18.7
+|3.1.1
-|1.19.5
+|4.0
-|Yes
+|'''No open source updates'''
-|Yes 8.1
+|<small>.../js/cookieconsent/</small>
-|
+|MIT
-|Active
+|[https://www.osano.com/cookieconsent Download] [https://github.com/osano/cookieconsent GitHub]
+<small>Open source version is not updated. 🚨</small>
 |
-|/htdocs/auth/saml/extlib/ <br />- Make a README.Mahara file<br />PHP 8 coming in v2.x. [https://github.com/simplesamlphp/simplesamlphp/issues/1521#issuecomment-917600539 Sounds like it should work on 1.19.1 though].
-|../auth/saml/extlib/simplesamlphp/
-|https://github.com/simplesamlphp/<br />[https://github.com/simplesamlphp/simplesamlphp simplesamlphp]
-|GPL 2.1
 |-
-| style="font-weight:bold;" |Select2
+|'''Select2'''
-|^4.0.13
 |4.0.13
+|4.0.13
+|'''Inactive, 2020'''
+|<small>.../js/select2/</small>
+|MIT
+|[https://select2.org/ Select2]<nowiki> | </nowiki>[https://github.com/select2/select2/releases Releases]
+RC 4.1
 |
-|n/a
+|}
-|Patch
-|Active
+=== Fonts ===
-|
+{| class="wikitable sortable" style="vertical-align:middle;"
-|
+!'''Name'''
-|.../js/select2/
+!'''Mahara <br />version'''
-|https://select2.org/
+!'''Latest<br />version'''
-|MIT License
+!'''Status'''
+!'''README location<br />'''<code>(./htdocs/...)</code>
+!'''License'''
+!'''URL/Notes'''
 |-
-| style="font-weight:bold;" |Aurulent Sans <br />(font)
+| style="font-weight:bold;" |'''Aurulent Sans <br />(font)'''
-|^2007.05.04
+|2007.05.04
 |2007.05.04
-|
 |n/a
-|None
+|<small>.../lib/fonts/</small>
-|Unknown
-|
-|
-|.../lib/fonts/
-|http://www.fontsquirrel.com/fonts/<br />Aurulent-Sans
 |SIL OFL v1.10
+|[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
 |2.37
-|
 |n/a
-|Patch
+|<small>.../lib/fonts/</small>
-|Unknown
+|DejaVu Fonts
-|
+|[http://www.fontsquirrel.com/fonts/DejaVu-Sans Font Squirrel Deja Vu Sans]
-|
-|.../lib/fonts/
-|http://www.fontsquirrel.com/fonts/<br />DejaVu-Sans
-|DejaVu Fonts <br />License v1.00
 |-
-| style="font-weight:bold;" |Open Sans <br />(font)
+| style="font-weight:bold;" |'''Open Sans <br />(font)'''
-|^1.10
+|1.10
 |1.10
-|
-|n/a
-|None
 |Unknown
-|
+|<small>.../theme/raw/fonts/</small>
-|
+|Apache License
-|.../theme/raw/fonts/
+|[https://www.google.com/fonts/specimen/Open+Sans Google Fonts Open Sans]
-|https://www.google.com/fonts/<br />specimen/Open+Sans
-|Apache License <br />version 2.0
 |-
-| style="font-weight:bold;" |Roboto Slab <br />(font)
+| style="font-weight:bold;" |'''Roboto Slab <br />(font)'''
-|^1.9
+|1.100263
 |1.100263
-|
-|n/a
-|Minor
 |Unknown
-|
+|<small>.../theme/raw/fonts/</small>
-|
+|MIT
-|.../theme/raw/fonts/
+|[https://www.google.com/fonts/specimen/Roboto+Slab Google Fonts Roboto]
-|https://www.google.com/fonts/<br />specimen/Roboto+Slab
-|MIT License
 |-
-| style="font-weight:bold;" |Fontawesome
+|'''Charis SIL <br />(fonts)'''
-|^5.8.1
+|6.001
-|6.0.0
-|Yes 🚧
-|n/a
-|Minor
-|Active
-|
-|https://fontawesome.com/docs/web/setup/upgrade/
-|.../theme/raw/sass/lib/font-awesome/
-|http://fontawesome.io<br />https://github.com/FortAwesome/Font-Awesome
-|SIL OFL 1.1
-|-
-| style="font-weight:bold;" |Ghostscript <br />fonts
-|^8.11
-|9.54.0
-|
-|n/a
-|Major
-|Active
-|
-|❗What do we use it for?
-|.../theme/raw/fonts/
-| - http://sourceforge.net/projects/gs-fonts/<br />- https://www.ghostscript.com/releases.html
-|AGPL
-|-
-| style="font-weight:bold;" |Charis SIL <br />(fonts)
-|^5.000
 |6.001
-|
-|n/a
-|Major
 |Active
-|
+|<small>.././lib/fonts/</small>
-|
-|.././lib/fonts/
-| - http://scripts.sil.org/cms/scripts/page.php<br />?item_id=CharisSIL<br />- https://software.sil.org/charis/download/
 |SIL OFL
-|-
+|[http://scripts.sil.org/cms/scripts/page.php?item_id=CharisSIL About font]<nowiki> | </nowiki>[https://software.sil.org/charis/download/ Download]
-| style="font-weight:bold;" |TinyMCE
-|^5.8.2
-|5.10.2
-|Yes 🚧
-|n/a
-|Major security patch - XSS
-|Active
-|Yes
-|https://www.tiny.cloud/docs/changelog/<br />📲 Test on mobile when updating<br />https://www.tiny.cloud/blog/category/<br />news-and-updates/
-|.../js/tinymce/
-|https://www.tiny.cloud/<br />https://www.tiny.cloud/get-tiny/self-hosted
-|LGPL 2.1
-|-
-| style="font-weight:bold;" |Video.js
-|7.17.0
-|7.17.0
-|Done✅
-|n/a
-|
-|Active
-|
-|Pre-released 7.18.1 Feb 2022
-|.../artefact/file/blocktype/<br />internalmedia/videojs/
-|http://videojs.com/<br />https://github.com/videojs/video.js
-|Apache License 2.0
-|-
-| style="font-weight:bold;" |zxcvbn
-|=4.4.2
-|4.4.2
-|
-|n/a
-|None
-|Inactive, 2017
-|
-|
-|.../js/zxcvbn/
-|https://github.com/dropbox/zxcvbn
-|MIT License
-|-
-| style="font-weight:bold;" |composer.json<br />dependencies<br />
-|
-|
-|
-|
-|
-|
-|
-|
-|https://git.mahara.org<br />/mahara/mahara/-/blob/<br />master/external/composer.json
-|Check for updates in the .json file.
-|
 |}
+=== Composer.json dependencies ===
+'''Resources:''' https://git.mahara.org | <code>/mahara/mahara/-/blob/</code> | <code>mahara/external/composer.json</code>
+'''Run''' <code>composer outdated</code> to check for updates.

Developer Area/Plugins/Third party: Difference between revisions

From Mahara Wiki

< Developer Area‎ | Plugins

Latest revision as of 16:18, 4 Ocak 2024

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

NPM-managed JS libraries

Manually managed JS libraries

Forked/stale/deprecated libraries

Fonts

Composer.json dependencies

Checking the `.Mahara` files