Actions

Developer Area/Plugins/Third party: Difference between revisions

From Mahara Wiki

< Developer Area‎ | Plugins
No edit summary
No edit summary
 
(59 intermediate revisions by the same user not shown)
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 ===
For available versions, e.g.  <code>composer show phpro/grumphp-shim 1.14.* --all</code>
 
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>
   <code>find ./htdocs -type f -iname "README.Mahara" -exec grep 'Version' -B1 {} \; -print</code>
... on the current codebase.
... on the current codebase.


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
=== 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>
  <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
and check the results against <code>htdocs/lib/country.php</code> and <code>htdocs/lang/en.utf8/mahara.php</code> files
For any confusion you can also check against https://www.iso.org
For any confusion you can also check against https://www.iso.org


== Third-party libraries (PHP and JS) ==
== Third-party libraries (PHP and JS) ==


===Legend===
=== 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
*'''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
*'''Latest version''' = the most recent available version
*'''Security''' = is there a new security patch available?
*'''Update type''' = what upgrades are available for this plugin, i.e. major, minor, patch, or security?
*'''Upgrades/updates''' = what upgrades are available for this plugin?
*'''Support''' = Is there a community supporting this library? When was the last release year if not in active support
*'''Support''' = Is there a community supporting this library?
**Active: There is ongoing work being put into the library
**Active: There is ongoing work being put into the library
**Inactive: Maintained but not actively making releases
**Inactive: Maintained but not actively making releases
**Archived: Not being maintained
**Archived: Not being maintained
**Deprecated (officially): All maintainers have left, and site may not exist in extreme cases.
**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
*'''License''' = software license for the library
*'''URL/Notes''' = extra information, e.g. resources, notes, and news
*'''Notes''' = extra information, e.g. resources, notes, and new
*🚧 Work in progress - data needs to be updated
*'''Composer''' = check if the library is managed by Composer
📅 Last updated: 5 October 2022
*'''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


'''Node versions in support''' https://endoflife.date/nodejs  node| https://nodejs.org/en/download/releases/ npm | - 8.0 security support ends
=== PHP libraries (excluding external) ===
https://eusonlito.github.io/php-changes-cheatsheet/deprecated.html


'''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
Libraries are managed by Composer. See <code>composer.json</code>


💡 A new idea is being proposed to better handle customisations on updating third party libraries lives here → https://reviews.mahara.org/c/mahara/+/13780
Run <code>composer show</code> to get a quick summary of library versions managed by Composer.
 
Run <code>composer outdated</code> to get a list of outdated libraries.
 
🟡 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;"
{| class="wikitable sortable" style="vertical-align:middle;"
|- style="font-weight:bold; text-align:center;"
|- style="font-weight:bold; text-align:center;"
!'''Name'''
!'''Name'''
!'''Mahara <br />version'''
!'''Mahara <br />version'''
!'''Available<br />versions'''
!'''23.04'''
!'''Security'''
!'''Update type'''
!'''Update type'''
!'''PHP8/JS'''
!'''Support'''
!'''Support'''
!'''README location<br />'''<code>(./htdocs/...)</code>
!'''License'''
!'''License'''
!'''URL/Notes'''
!'''URL/Notes'''
!'''Composer'''
|-
|-
| style="font-weight:bold;" |ADODB
| style="font-weight:bold;" |'''ADODB'''
|5.22.0
|5.22.6
|5.22.4
|Up to date
|
|TBC
| style="color:#333;" |Patch
|Yes 8.1
|Active
|Active
|.../lib/adodb/
|BSD 3-Clause<br />LGPL
|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]
|[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'''
|5.0.1
|2.1.0
|5.3.X
|Up to date
|
|No
|Minor
|JS
|Active
|Active
|.../lib/bootstrap/assets/javascripts/<br />
|LGPL
|MIT
|[https://github.com/Cerdic/CSSTidy GitHub]
|[https://github.com/twbs/release Releases]<nowiki> | </nowiki>[https://github.com/twbs/bootstrap GitHub]
|✅
[https://getbootstrap.com/docs/versions/ bootstrap versions]
|-
|-
| style="font-weight:bold;" |Date time
| style="font-weight:bold;" |'''Elasticsearch PHP'''
picker
| style="color:#333;" |7.17.2
|4.17.47
|Major, 8.10.0
|6.2.10
|Active
|
|Apache v2.0  LGPL v2.1
|No
|[https://github.com/elastic/elasticsearch-php GitHub]<nowiki> | </nowiki>[https://github.com/elastic/elasticsearch-php/blob/master/CHANGELOG.md Changelog]
|Major
Move to OpenSearch
|JS
|Active - v6
|.../js/bootstrap-datetimepicker/
|MIT
|[https://github.com/Eonasdan/tempus-dominus GitHub]<nowiki> | </nowiki>[https://getdatepicker.com/6/change-log.html Get Date Picker]


Latest release: rewrite (beta)
|✅
|-
|-
| style="font-weight:bold;" |Chart.js
| style="font-weight:bold;" |'''HTML Purifier'''
|3.7.1
|4.16.0
|4.2.1
|Up to date
|
|2022
|No
|LGPL v2.1+
|Major 4.x breaking changes
|[http://www.htmlpurifier.org/ HTML Purifier]<nowiki> | </nowiki>[https://github.com/ezyang/htmlpurifier/ GitHub]
 
|✅
 
v3.9.1 final
|JS
|Active
|.../js/chartjs/
|MIT
|[http://www.chartjs.org Chart JS]<nowiki> | </nowiki>[https://github.com/chartjs/Chart.js GitHub]
[https://www.chartjs.org/docs/latest/migration/v4-migration.html Migration to v4]
|-
|-
| style="font-weight:bold;" |Clipboard js
| style="font-weight:bold;" |'''PHPMailer'''
|2.0.10
|6.8.1
|2.0.11
|Up to date
|
|No
|Patch
|JS
|Active
|Active
|.../js/clipboard/
|LGPL
|MIT
|[https://github.com/PHPMailer/PHPMailer GitHub]
|[https://clipboardjs.com/ Clipboard JS]<nowiki> | </nowiki>[https://github.com/zenorocha/clipboard.js GitHub]<br />version # is tagged
|✅
|-
|-
| style="font-weight:bold;" |CSS Tidy
| style="font-weight:bold;" |'''ReCaptcha'''
|2.0.1
|1.2.4
|2.0.3
|Minor, 1.3.0
|TBC
|No
|Patch
|Yes
|Active
|Active
|.../lib/csstidy/
|BSD-3
|LGPL
|[https://github.com/google/recaptcha GitHub]
|[https://github.com/Cerdic/CSSTidy GitHub]
|✅
|-
|-
| style="font-weight:bold;" |Dragon-drop
| style="font-weight:bold;" |'''simplesamlphp'''
|3.2.1
|2.0.4
|[https://github.com/schne324/dragon-drop/releases/tag/v3.6.1 3.6.1]
|Minor, 2.0.6
|TBC
|No
|Minor
|JS
|Active
|Active
|GPL 2.1
|[https://github.com/simplesamlphp/simplesamlphp 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 <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


2021
==== NPM-managed JS libraries ====
|..../js/dragondrop/
{| class="wikitable sortable" style="vertical-align:middle;"
|MIT
|- style="font-weight:bold; text-align:center;"
|[https://github.com/schne324/dragon-drop GitHub]
!'''Name'''
!'''Mahara <br />version'''
!'''Update type'''
!'''Support'''
!'''License'''
!'''Notes'''
|-
|-
| style="font-weight:bold;" |Datatables
| style="font-weight:bold;" |'''yargs'''
|1.11.4
|5.0.2
|1.13.2
|Minor, 5.3.2
|TBC
|No
|Minor
|JS
|Active
|Active
|.../js/DataTables/
|MIT
|MIT
|[https://datatables.net/ Data Tables]<nowiki> |</nowiki>[https://datatables.net/download/index Download]
|
[https://cdn.datatables.net/ Release notes CDN]
|-
|-
| style="font-weight:bold;" |Dropzone
| style="font-weight:bold;" |'''Chart.js'''
|5.7.6
|3.9.1
|5.9.3
|Major, 4.4.0
|TBC
|Active
|No
|Minor
|JS
|Inactive, 2021
|.../js/dropzone/
|MIT
|MIT
|[https://github.com/dropzone/dropzone/releases GitHub releases] 6.0.0 in beta
|[https://www.chartjs.org/docs/latest/migration/v4-migration.html Migration to v4]
|-
|-
| style="font-weight:bold;" |Elastic Search
| style="font-weight:bold;" |'''Clipboard js'''
| style="color:#333;" |7.14
|2.0.11
|v8 - 8.6.1
|Up to date
v7.17.1
|TBC
|n/a
|<nowiki>Major|Minor</nowiki>
|No
|Active
|Active
|.../lib/elasticsearch/
|MIT
|Apache v2.0 <br />LGPL v2.1
|version # is tagged
|[https://github.com/elastic/elasticsearch-php GitHub]<nowiki> | </nowiki>[https://github.com/elastic/elasticsearch-php/blob/master/CHANGELOG.md Changelog]
[https://github.com/elastic/elasticsearch-php/milestone/6 PHP 8 milestone] 83%
|-
|-
| style="font-weight:bold;" |Gridstack
| style="font-weight:bold;" |'''Dragon-drop'''
|4.3.1
|3.6.1
|v7 - 7.2.3
|Up to date
v6 - 6.0.3
|2020
v5 - 5.1.1
 
v4 - 4.4.1
|TBC
|No
|<nowiki>Major | Minor |Patch</nowiki>
|JS
|Active
|.../js/gridstack/
|MIT
|MIT
|[https://github.com/gridstack/gridstack.js GitHub]<nowiki> | </nowiki>[https://gridstackjs.com Website]
|
|-
|-
| style="font-weight:bold;" |HTML Purifier
| style="font-weight:bold;" |'''Dropzone'''
|4.14.0
|5.9.3
|4.16.0
|Patch, 5.9.3
|TBC
|2021
|No
|MIT
|Minor
|
|Yes
|Active
|.../lib/htmlpurifier/
|LGPL v2.1+
|[http://www.htmlpurifier.org/ HTML Purifier]<nowiki> | </nowiki>[https://github.com/ezyang/htmlpurifier/ GitHub]
|-
|-
| style="font-weight:bold;" |jQuery
| style="font-weight:bold;" |'''jQuery'''
|3.6.0
|3.7.1
|3.6.3
|Up to date
|TBC
|No
|Minor
|JQ
|Active
|Active
|.../js/jquery/
|MIT
|MIT
|[http://jquery.com/ Website]<nowiki> | </nowiki>[https://github.com/jquery/jquery GitHub]<nowiki> | </nowiki>[https://blog.jquery.com/2021/03/02/ Blog post]<br />[https://forum.jquery.com/ Forum]<nowiki> | </nowiki>[https://twitter.com/jquery Twitter]
|[https://forum.jquery.com/ Forum]
|-
|-
| style="font-weight:bold;" |jQuery UI
| style="font-weight:bold;" |'''jQuery UI'''
|1.13.1
|1.13.2
|1.13.2
|TBC
|Up to date
|No
|Patch
|JQ
|Active
|Active
|.../js/jquery/jquery-ui/
|MIT
|MIT
|[http://jqueryui.com/ jQuery UI] Security and compatibility fixes
|
|-
|-
| style="font-weight:bold;" |JS Color
| style="font-weight:bold;" |'''JS Color'''
|2.4.7
|2.5.1
|2.5.1
|TBC
|Up to date
|No
|Inactive,2022
|Minor
|JS
|Active
|.../js/jscolor/
|GPL 3
|GPL 3
|http://jscolor.com/ - click download for #
|
|-
|-
| style="font-weight:bold;" |Json editor
| style="font-weight:bold;" |'''Marked'''
|2.6.1
|4.3.0
|2.8.0
|Minor, 4.3.0
|TBC
Major 9.1.0
|No
|Minor
|JS
|Active
|Active
|.../js/jsoneditor/
|MIT
|MIT
|[https://github.com/json-editor/json-editor GitHub]<nowiki> |</nowiki>[https://github.com/json-editor/json-editor/blob/master/CHANGELOG.md Changelog]
|
|-
|-
| style="font-weight:bold;" |Marked
| style="font-weight:bold;" |'''Moment.js'''
|4.0.12
|2.29.4
|4.2.12
|Up to date
|TBC
|No
|Minor
|JS
|Active
|Active
|.../js/marked/
|MIT
|MIT
|[https://github.com/markedjs/marked GitHub]
|[http://momentjs.com/ Moment JS] 🆕 [https://moment.github.io/luxon/#/ Luxon GitHub]
|-
|-
| style="font-weight:bold;" |Moment.js
| style="font-weight:bold;" |'''Popper'''
|2.29.1
|2.11.8
|2.5.2
|Up to date
3.2.1
|TBC
|No
|<nowiki>Major|Minor</nowiki>
|JS
|Active
|Active
|.../js/momentjs/
|MIT
|MIT
|[http://momentjs.com/ Moment JS] 🆕 [https://moment.github.io/luxon/#/ Luxon GitHub]
|[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'''
Connected to jquery date-picker
|-
|-
| style="font-weight:bold;" |PDFjs
| style="font-weight:bold;" |'''Fontawesome'''
|2.13.216
|6.4.2
|2.16.105
|Up to date
3.3.122
|TBC
|No
|<nowiki>Major|Minor</nowiki>
|JS
|Active
|Active
|.../artefact/file/blocktype/pdf/js/pdfjs/
|SIL OFL 1.1
|Apache License 2
|[https://fontawesome.com/docs/web/setup/upgrade/ Upgrade steps]<nowiki> | </nowiki>[https://fontawesome.com/docs/changelog/ Changelog]
|[http://mozilla.github.io/pdf.js/getting_started/#download Getting started]<nowiki> | </nowiki>[https://github.com/mozilla/pdf.js GitHub]
|-
|-
| style="font-weight:bold;" |PHPMailer
| style="font-weight:bold;" |'''TinyMCE'''
|6.6.0
|5.10.7
|6.7.1
|Major, 6.7.0
|TBC
|No
|Minor
|Yes
|Active
|Active
|.../lib/phpmailer/
|LGPL 2.1
|LGPL
|[https://www.tiny.cloud/get-tiny/self-hosted Downloads]<nowiki> | </nowiki>[https://www.tiny.cloud/docs/changelog/ Changelog]  
|[https://github.com/PHPMailer/PHPMailer GitHub]
📲 Test mobile
6.7.1 supports PHP 8.2
|-
|-
| style="font-weight:bold;" |Popper
| style="font-weight:bold;" |'''Video.js'''
|2.10.2
|7.21.5
|2.11.6
|Major, 8.5.2
|TBC
|No
|Minor
|JS
|Active
|Active
|.../js/popper/
|Apache License 2.0
|[http://videojs.com/ Video JS]
|}
 
==== 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
|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]
|[https://getdatepicker.com/6/change-log.html Changelog]
 
Latest release: rewrite (beta)
|❌
|-
|-
| style="font-weight:bold;" |ReCaptcha
| style="font-weight:bold;" |'''Datatables'''
|1.2.4
|1.11.4
|1.2.4
|TBC
|No
|None
|WIP
|Inactive, 2020
|.../lib/recaptcha/
|BSD-3
|[https://github.com/google/recaptcha GitHub]
This client supports both v2 and v3. [https://github.com/google/recaptcha/tree/php8-support PHP 8 support branch]
|-
| style="font-weight:bold;" |simplesamlphp
|1.18.7
|[https://github.com/simplesamlphp/simplesamlphp/releases/tag/v1.19.6 final 1.19.7]
v2 - RC
|TBC
|No
|Minor
|Minor
|Yes
|Active
|Active
|../auth/saml/extlib/modules
|<small>.../js/DataTables/</small>
|GPL 2.1
|MIT
|[https://github.com/simplesamlphp/simplesamlphp GitHub] RC for 2.0.0 has PHP 8. [https://github.com/simplesamlphp/simplesamlphp/issues/1521#issuecomment-917600539 Sounds like it should work on 1.19.1 though].
|[https://datatables.net/download/index Download]
[https://cdn.datatables.net/ Release notes CDN]
|❌ Need to use web builder
|-
|-
| style="font-weight:bold;" |Select2
| style="font-weight:bold;" |'''Gridstack'''
|4.0.13
|4.4.1
|4.0.13
|Major
|TBC
|Active
|No
|<small>.../js/gridstack/</small>
|<nowiki>-</nowiki>
|JS
|Inactive, 2020
|.../js/select2/
|MIT
|MIT
|[https://select2.org/ Select2]<nowiki> | </nowiki>[https://github.com/select2/select2/releases Releases]
|[Demos](<nowiki>https://gridstackjs.com/demo/</nowiki>)
RC 4.1
 
 
https://github.com/gridstack/gridstack.js/tree/master/doc
|🚧
|-
|-
| style="font-weight:bold;" |Fontawesome
| style="font-weight:bold;" |'''Json editor'''
|6.1.1
|2.6.1
|6.30
|TBC
|No
|Minor
|Minor
|JS
|Active
|Active
|.../theme/raw/sass/lib/font-awesome/
|<small>.../js/jsoneditor/</small>
|SIL OFL 1.1
|MIT
|[http://fontawesome.io Font Awesome]<nowiki> | </nowiki>[https://github.com/FortAwesome/Font-Awesome GitHub]<nowiki> | </nowiki>[https://fontawesome.com/docs/web/setup/upgrade/ Upgrade steps]<nowiki> | </nowiki>[https://fontawesome.com/docs/changelog/ Changelog]
|[https://github.com/json-editor/json-editor/blob/master/CHANGELOG.md Changelog]
|🚧
|-
|-
| style="font-weight:bold;" |TinyMCE
| style="font-weight:bold;" |'''PDFjs'''
|5.10.2
|3.10.111
|5.10.7
|Minor 🚧
|TBC
|No
|Patch
|JS
|Active
|Active
|.../js/tinymce/
|<small>.../artefact/file/blocktype/pdf/js/pdfjs/</small>
|LGPL 2.1
|Apache License 2
|[https://www.tiny.cloud/ Tiny Cloud]<nowiki> | </nowiki>[https://www.tiny.cloud/get-tiny/self-hosted Downloads]<nowiki> | </nowiki>[https://www.tiny.cloud/docs/changelog/ Changelog]<nowiki> |</nowiki>[https://www.tiny.cloud/blog/category/news-and-updates/ News]
|[http://mozilla.github.io/pdf.js/getting_started/#download Getting started]
📲 Test on mobile
The Firefox dist version different to NPM package
|-
|❌
| style="font-weight:bold;" |Video.js
|7.17.0
|7.21.1
8.0.4
|TBC
|No
|<nowiki>Minor|Major</nowiki>
|JS
|Active
|.../artefact/file/blocktype/<br />internalmedia/videojs/
|Apache License 2.0
|[http://videojs.com/ Video JS]<nowiki> | </nowiki>[https://github.com/videojs/video.js GitHub]
|}
|}


== Forked/stale/deprecated libraries ==
=== Forked/stale/deprecated libraries ===
{| class="wikitable sortable" style="vertical-align:middle;"
{| class="wikitable sortable mw-collapsible mw-collapsed" style="vertical-align:middle;"
|- style="font-weight:bold; text-align:center;"
|- style="font-weight:bold; text-align:center;"
!'''Name'''
!'''Name'''
!'''Mahara <br />version'''
!'''Mahara <br />version'''
🚧
!'''Latest<br />version'''
!'''Latest<br />version<br />🚧'''
!'''Support'''
!'''23.04 🚧'''
!'''Location<br />'''<code><small>(./htdocs/...)</small></code>
!'''Security'''
🚧
!'''Update type'''
🚧
!'''PHP8'''
 
!'''Status'''
🚧
!'''README location<br />'''<code>(./htdocs/...)</code>
!'''License'''
!'''License'''
!'''URL/Notes'''
!'''URL'''
!'''Next action'''
|-
|-
| style="font-weight:bold;" |Dwoo🟡
| style="font-weight:bold;" |'''Dwoo'''
|1.3.7
|1.3.7
|1.3.7
|1.3.7
|n/a
|'''Archived, 2020'''
|n/a
|<small>.../lib/dwoo/</small>
|Replace
|n/a
|Deprecated
|.../lib/dwoo/
|LGPL
|LGPL
|[http://dwoo.org/ Dead site]<nowiki> | </nowiki>[https://github.com/dwoo-project/dwoo GitHub project]
|[http://dwoo.org/ Dead site?]
[https://github.com/dwoo-project/dwoo GitHub]
|
|-
|-
| style="font-weight:bold;" |Javascript <br />templates
| style="font-weight:bold;" |'''Javascript <br />templates'''
|3.20.0
|3.20.0
|3.20.0
|3.20.0
|n/a
|'''Archived, 2021'''
|n/a
|<small>.../js/javascript-templates/</small>
|n/a
|n/a
|Archived, 2021
|.../js/javascript-templates/
|MIT
|MIT
|[https://github.com/blueimp/JavaScript-Templates GitHub]
|[https://github.com/blueimp/JavaScript-Templates GitHub]
|
|-
|-
| style="font-weight:bold;" |jQuery mobile
| style="font-weight:bold;" |'''jQuery mobile'''
|1.5.0-alpha.1
|1.5.0-alpha.1
|1.5.0-rc1
|1.5.0-rc1
|n/a
|'''Deprecated'''
|n/a
|<small>.../js/jquery/jquery-mobile/</small>
|n/a
|n/a
|Deprecated
|.../js/jquery/jquery-mobile/
|MIT
|MIT
|http://jquerymobile.com
|[http://jquerymobile.com Website] <br /><small>🚨 ''"transition(ed) ...''</small> <small>''under the jQuery project umbrella, jQuery UI"''</small>
 
|Remove and test
https://blog.jquerymobile.com <br />🚨 Are we still using this?
|-
|-
| 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
|0.2.3
|0.2.3
|n/a
|'''Deprecated'''
|n/a
|<small>.../js/jquery/jquery-ui/<br />jquery-ui-touch-punch.min.js</small>
|n/a
|n/a
|Deprecated
|.../js/jquery/jquery-ui/<br />jquery-ui-touch-punch.min.js
|MIT or GPL <br />Version 2
|MIT or GPL <br />Version 2
|[http://touchpunch.furf.com/ Touch Punch]<nowiki>  | </nowiki>[https://github.com/furf/jquery-ui-touch-punch GitHub]
|[https://github.com/furf/jquery-ui-touch-punch GitHub]


🚨 Is it merged into jQuery?
<small>🚨 external to JQuery UI</small>
|[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
|1.0
|1.0
|n/a
|'''Inactive, 2018'''
|n/a
|<small>.../js/jTLine/</small>
|n/a
|n/a
|Inactive, 2018
|.../js/jTLine/
|MIT
|MIT
|[https://naadydev.github.io/jTLine/ GitHub]<nowiki> | </nowiki>[https://twitter.com/naadydev Twitter]
|[https://naadydev.github.io/jTLine/ GitHub]
[https://twitter.com/naadydev Twitter]
 
[https://codyhouse.co/gem/horizontal-timeline Ref]
|
|-
|-
| style="font-weight:bold;" |Masonry
| style="font-weight:bold;" |'''Masonry'''
|4.2.2
|4.2.2
|4.2.2
|4.2.2
|n/a
|'''Inactive, 2018'''
|n/a
|<small>.../js/masonry/</small>
|n/a
|n/a
|Inactive, 2018
|.../js/masonry/
|MIT
|MIT
|[https://masonry.desandro.com/ Masonry]<nowiki> |</nowiki>[https://github.com/desandro/masonry GitHub]
|[https://masonry.desandro.com/ Masonry]
[https://github.com/desandro/masonry GitHub]
|
|-
|-
| style="font-weight:bold;" |TinyMCE<br />Mathslate
| style="font-weight:bold;" |'''TinyMCE<br />Mathslate'''
|1.1
|1.1
|1.1
|1.1
|n/a
|'''Forked, 2015'''
|n/a
|<small>.../js/tinymce/plugins/mathslate/</small>
|n/a
|n/a
|Forked, 2015
|.../js/tinymce/plugins/mathslate/
|GPL 3
|GPL 3
|Our version is [[GitHub|forked]].<br />make it work with Tinymce 5
|<small>Our version is [[GitHub|forked]].<br />to work with Tinymce 5</small>
|
|-
|-
| style="font-weight:bold;" |Oauth PHP
| style="font-weight:bold;" |'''Oauth PHP'''
|175
|175
|175
|175
|n/a
|'''Archived, 2010'''
|n/a
|<small>.../webservice/libs/oauth-php/</small>
|Replace
|No
|Archived, 2010
|.../webservice/libs/oauth-php/
|MIT
|MIT
|[https://code.google.com/archive/p/oauth-php/ Code] - We should replace with an [https://oauth.net/code/php oauth2 php library] checkout what Moodle does (old comment)
|[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>
|-
|-
| style="font-weight:bold;" |zxcvbn
| style="font-weight:bold;" |'''zxcvbn'''
|4.4.2
|4.4.2
|4.4.2
|4.4.2
|n/a
|'''Inactive, 2017'''
|n/a
|<small>.../js/zxcvbn/</small>
|n/a
|n/a
|Inactive, 2017
|.../js/zxcvbn/
|MIT
|MIT
|[https://github.com/dropbox/zxcvbn GitHub]
|[https://github.com/dropbox/zxcvbn GitHub]
|
|-
|-
|Cookie consent
|'''Cookie consent'''
|3.1.1
|3.1.1
|4.0
|4.0
|TBC
|'''No open source updates'''
|No
|<small>.../js/cookieconsent/</small>
|MIT
|[https://www.osano.com/cookieconsent Download] [https://github.com/osano/cookieconsent GitHub]
 
<small>Open source version is not updated. 🚨</small>
|
|
|n/a
|-
|OS version not supported
|'''Select2'''
|.../js/cookieconsent/
|4.0.13
|4.0.13
|'''Inactive, 2020'''
|<small>.../js/select2/</small>
|MIT
|MIT
|[https://www.osano.com/cookieconsent Download]<nowiki> | </nowiki>[https://github.com/osano/cookieconsent GitHub]
|[https://select2.org/ Select2]<nowiki> | </nowiki>[https://github.com/select2/select2/releases Releases]  
 
RC 4.1
Open source version is not updated. 🚨
|
|}
|}


== Fonts ==
=== Fonts ===
{| class="wikitable sortable" style="vertical-align:middle;"
{| class="wikitable sortable" style="vertical-align:middle;"
!'''Name'''
!'''Mahara <br />version'''
!'''Latest<br />version'''
!'''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
|2007.05.04
|n/a
|n/a
|n/a
|<small>.../lib/fonts/</small>
|n/a
|n/a
|n/a
|.../lib/fonts/
|SIL OFL v1.10
|SIL OFL v1.10
|[https://www.fontsquirrel.com/fonts/aurulent-sans Font Squirrel Aurulent Sans]
|[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
|2.37
|n/a
|n/a
|n/a
|<small>.../lib/fonts/</small>
|n/a
|n/a
|n/a
|.../lib/fonts/
|DejaVu Fonts
|DejaVu Fonts
|[http://www.fontsquirrel.com/fonts/DejaVu-Sans Font Squirrel Deja Vu Sans]
|[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
|1.10
|1.10
|n/a
|n/a
|n/a
|n/a
|Unknown
|Unknown
|.../theme/raw/fonts/
|<small>.../theme/raw/fonts/</small>
|Apache License
|Apache License
|[https://www.google.com/fonts/specimen/Open+Sans Google Fonts Open Sans]
|[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
|1.100263
|1.100263
|n/a
|n/a
|n/a
|n/a
|Unknown
|Unknown
|.../theme/raw/fonts/
|<small>.../theme/raw/fonts/</small>
|MIT
|MIT
|[https://www.google.com/fonts/specimen/Roboto+Slab Google Fonts Roboto]
|[https://www.google.com/fonts/specimen/Roboto+Slab Google Fonts Roboto]
|-
|-
|Charis SIL <br />(fonts)
|'''Charis SIL <br />(fonts)'''
|6.001
|6.001
|6.001
|6.001
|n/a
|n/a
|n/a
|n/a
|Active
|Active
|.././lib/fonts/
|<small>.././lib/fonts/</small>
|SIL OFL
|SIL OFL
|[http://scripts.sil.org/cms/scripts/page.php?item_id=CharisSIL About font]<nowiki> | </nowiki>[https://software.sil.org/charis/download/ Download]
|[http://scripts.sil.org/cms/scripts/page.php?item_id=CharisSIL About font]<nowiki> | </nowiki>[https://software.sil.org/charis/download/ Download]
|}
|}


== Composer.json dependencies ==
=== Composer.json dependencies ===
'''Resources:''' https://git.mahara.org | <code>/mahara/mahara/-/blob/</code> | <code>mahara/external/composer.json</code>
'''Resources:''' https://git.mahara.org | <code>/mahara/mahara/-/blob/</code> | <code>mahara/external/composer.json</code>


'''Run''' <code>composer external/outdated</code> to check for updates.
'''Run''' <code>composer outdated</code> to check for updates.

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.

Retrieved from ‘https://wiki.mahara.org/index.php?title=Developer_Area/Plugins/Third_party&oldid=13942’