Actions

Developer Area/Plugins/Third party: Difference between revisions

From Mahara Wiki

< Developer Area‎ | Plugins
No edit summary
No edit summary
 
(15 intermediate revisions by the same user not shown)
Line 27: Line 27:
*'''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
'''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
*'''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
💡 A new idea is being proposed to better handle customisations on updating third party libraries lives here → https://reviews.mahara.org/c/mahara/+/13780
Line 46: Line 44:
https://eusonlito.github.io/php-changes-cheatsheet/deprecated.html
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.
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.
 
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.
🟡 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.
Line 53: Line 55:
!'''Name'''
!'''Name'''
!'''Mahara <br />version'''
!'''Mahara <br />version'''
!'''Available<br />versions 🚧'''
!'''Security'''
!'''Update type'''
!'''Update type'''
!'''Support'''
!'''Support'''
Line 61: Line 61:
!'''Composer'''
!'''Composer'''
|-
|-
| style="font-weight:bold;" |ADODB
| style="font-weight:bold;" |'''ADODB'''
|5.22.6
|5.22.6
|Up to date
|Up to date
|N/A
| style="color:#333;" |None
|Active
|Active
|BSD 3-Clause<br />LGPL
|BSD 3-Clause<br />LGPL
Line 71: Line 69:
|✅
|✅
|-
|-
| style="font-weight:bold;" |CSS Tidy
| style="font-weight:bold;" |'''CSS Tidy'''
|2.0.3
|2.1.0
|Up to date
|Up to date
|N/A
|None
|Active
|Active
|LGPL
|LGPL
Line 81: Line 77:
|✅
|✅
|-
|-
| style="font-weight:bold;" |Elasticsearch
| style="font-weight:bold;" |'''Elasticsearch PHP'''
| style="color:#333;" |7.17.2
| style="color:#333;" |7.17.2
|8.9.0
|Major, 8.10.0
|N/A
|Major
|Active
|Active
|Apache v2.0  LGPL v2.1
|Apache v2.0  LGPL v2.1
|[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 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%
Move to OpenSearch
 
 
Check that docker is also pulling in the same version!


|✅
|✅
|-
|-
| style="font-weight:bold;" |HTML Purifier
| style="font-weight:bold;" |'''HTML Purifier'''
|4.14.0
|4.16.0
|Up to date
|Up to date
|N/A
|2022
|None
|Inactive, 2022
|LGPL v2.1+
|LGPL v2.1+
|[http://www.htmlpurifier.org/ HTML Purifier]<nowiki> | </nowiki>[https://github.com/ezyang/htmlpurifier/ GitHub]
|[http://www.htmlpurifier.org/ HTML Purifier]<nowiki> | </nowiki>[https://github.com/ezyang/htmlpurifier/ GitHub]
|✅
|✅
|-
|-
| style="font-weight:bold;" |PHPMailer
| style="font-weight:bold;" |'''PHPMailer'''
|6.8.1
|6.8.1
|Up to date
|Up to date
|N/A
|None
|Active
|Active
|LGPL
|LGPL
Line 116: Line 103:
|✅
|✅
|-
|-
| style="font-weight:bold;" |ReCaptcha
| style="font-weight:bold;" |'''ReCaptcha'''
|1.2.4
|1.2.4
|1.30
|Minor, 1.3.0
|TBC
|Minor
|Active
|Active
|BSD-3
|BSD-3
|[https://github.com/google/recaptcha GitHub]
|[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]
Missing PHP 8 compatibility
|✅
|✅
|-
|-
| style="font-weight:bold;" |simplesamlphp
| style="font-weight:bold;" |'''simplesamlphp'''
|2.0.4
|2.0.4
|2.0.6
|Minor, 2.0.6
|N/A
|Minor
|Active
|Active
|GPL 2.1
|GPL 2.1
|[https://github.com/simplesamlphp/simplesamlphp GitHub]
|[https://github.com/simplesamlphp/simplesamlphp GitHub]
Location:
Optional library - called in Makefile
 
htdocs/auth/saml/extlib/modules
|❌
|❌
|}
|}
Line 150: Line 127:


Goal: to move libraries to be managed by NPM
Goal: to move libraries to be managed by NPM
==== NPM-managed JS libraries ====
{| 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 (manual)'''
!'''Security'''
!'''Update type'''
!'''Update type'''
!'''Support'''
!'''Support'''
!'''README location<br />'''<code>(./htdocs/...)</code>
!'''License'''
!'''License'''
!'''URL/Notes'''
!'''Notes'''
!'''NPM'''
|-
|-
| style="font-weight:bold;" |Bootstrap
| style="font-weight:bold;" |'''yargs'''
|5.0.2
|5.0.2
|5.1
|Minor, 5.3.2
5.2
 
5.3
|No
|'''<nowiki>Minor|Major</nowiki>'''
|Active
|Active
|.../lib/bootstrap/assets/javascripts/<br />
|MIT
|MIT
|[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;" |'''Chart.js'''
picker
|3.9.1
|4.17.47
|Major, 4.4.0
|'''6.2.10'''
|Active
|No
|'''Major'''
|Active - v6
|.../js/bootstrap-datetimepicker/
|MIT
|MIT
|[https://github.com/Eonasdan/tempus-dominus GitHub]<nowiki> | </nowiki>[https://getdatepicker.com/6/change-log.html Get Date Picker]
|[https://www.chartjs.org/docs/latest/migration/v4-migration.html Migration to v4]
 
Latest release: rewrite (beta)
|❌
|-
|-
| style="font-weight:bold;" |Chart.js
| style="font-weight:bold;" |'''Clipboard js'''
|3.7.1
|2.0.11
|'''4.4.0'''
|Up to date
|No
|'''Major'''
|Active
|Active
|.../js/chartjs/
|MIT
|MIT
|[http://www.chartjs.org Chart JS]<nowiki> | </nowiki>[https://github.com/chartjs/Chart.js GitHub]
|version # is tagged
[https://www.chartjs.org/docs/latest/migration/v4-migration.html Migration to v4]
|🚧
|-
|-
| style="font-weight:bold;" |Clipboard js
| style="font-weight:bold;" |'''Dragon-drop'''
|2.0.10
|3.6.1
|'''2.0.11'''
|Up to date
|No
|2020
|'''Patch'''
|Active
|.../js/clipboard/
|MIT
|MIT
|[https://clipboardjs.com/ Clipboard JS]<nowiki> | </nowiki>[https://github.com/zenorocha/clipboard.js GitHub]<br />version # is tagged
|
|🚧
|-
|-
| style="font-weight:bold;" |Dragon-drop
| style="font-weight:bold;" |'''Dropzone'''
|3.2.1
|5.9.3
|[https://github.com/schne324/dragon-drop/releases/tag/v3.6.1 '''3.6.1''']
|Patch, 5.9.3
|No
|2021
|'''Minor'''
|Inactive
 
2018
|..../js/dragondrop/
|MIT
|MIT
|[https://github.com/schne324/dragon-drop GitHub]
|
|🚧
|-
|-
| style="font-weight:bold;" |Datatables
| style="font-weight:bold;" |'''jQuery'''
|1.11.4
|3.7.1
|'''1.13.6'''
|Up to date
|No
|'''Minor'''
|Active
|Active
|.../js/DataTables/
|MIT
|MIT
|[https://datatables.net/ Data Tables]<nowiki> |</nowiki>[https://datatables.net/download/index Download]
|[https://forum.jquery.com/ Forum]
[https://cdn.datatables.net/ Release notes CDN]
|🟡 Web builder
|-
|-
| style="font-weight:bold;" |Dropzone
| style="font-weight:bold;" |'''jQuery UI'''
|5.7.6
|1.13.2
|'''5.9.3'''
|Up to date
|No
|Active
|'''Minor'''
|Inactive, 2021
|.../js/dropzone/
|MIT
|MIT
|[https://github.com/dropzone/dropzone/releases GitHub releases] 6.0.0 in beta
|
|🚧
|-
| style="font-weight:bold;" |'''JS Color'''
|2.5.1
|Up to date
|Inactive,2022
|GPL 3
|
|-
|-
| style="font-weight:bold;" |Gridstack
| style="font-weight:bold;" |'''Marked'''
|4.4.1
|4.3.0
|'''v9.0'''
|Minor, 4.3.0
'''v7.2.3,'''
Major 9.1.0
'''v6.0.3,  v5.1.1'''
 
'''v4.4.1'''
|No
|'''<nowiki>Patch|Minor|Major</nowiki>'''
|Active
|Active
|.../js/gridstack/
|MIT
|MIT
|[https://github.com/gridstack/gridstack.js GitHub]<nowiki> | </nowiki>[https://gridstackjs.com Website]
|
|❌
|-
|-
| style="font-weight:bold;" |jQuery
| style="font-weight:bold;" |'''Moment.js'''
|3.6.3
|2.29.4
|'''3.7.1'''
|Up to date
|No
|'''Minor'''
|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]
|[http://momentjs.com/ Moment JS] 🆕 [https://moment.github.io/luxon/#/ Luxon GitHub]
|🚧
|-
|-
| style="font-weight:bold;" |jQuery UI
| style="font-weight:bold;" |'''Popper'''
|1.13.1
|2.11.8
|'''1.13.2'''
|Up to date
|No
|'''Patch'''
|Active
|Active
|.../js/jquery/jquery-ui/
|MIT
|MIT
|[http://jqueryui.com/ jQuery UI] Security and compatibility fixes
|[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'''
|6.4.2
|Up to date
|Active
|SIL OFL 1.1
|[https://fontawesome.com/docs/web/setup/upgrade/ Upgrade steps]<nowiki> | </nowiki>[https://fontawesome.com/docs/changelog/ Changelog]
|-
|-
| style="font-weight:bold;" |JS Color
| style="font-weight:bold;" |'''TinyMCE'''
|2.4.7
|5.10.7
|'''2.5.1'''
|Major, 6.7.0
|No
|Active
|'''Minor'''
|LGPL 2.1
|Inactive
|[https://www.tiny.cloud/get-tiny/self-hosted Downloads]<nowiki> | </nowiki>[https://www.tiny.cloud/docs/changelog/ Changelog]
|.../js/jscolor/
📲 Test mobile
|GPL 3
|http://jscolor.com/ - click download for #
|🚧
|-
|-
| style="font-weight:bold;" |Json editor
| style="font-weight:bold;" |'''Video.js'''
|2.6.1
|7.21.5
|'''2.10.1'''
|Major, 8.5.2
|No
|'''Minor'''
|Active
|Active
|.../js/jsoneditor/
|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://github.com/json-editor/json-editor GitHub]<nowiki> |</nowiki>[https://github.com/json-editor/json-editor/blob/master/CHANGELOG.md Changelog]
|[https://getdatepicker.com/6/change-log.html Changelog]
|🚧
 
Latest release: rewrite (beta)
|❌
|-
|-
| style="font-weight:bold;" |Marked
| style="font-weight:bold;" |'''Datatables'''
|4.0.12
|1.11.4
|'''9'''
|Minor
|No
|'''Major'''
|Active
|Active
|.../js/marked/
|<small>.../js/DataTables/</small>
|MIT
|MIT
|[https://github.com/markedjs/marked GitHub]
|[https://datatables.net/download/index Download]
|🚧
[https://cdn.datatables.net/ Release notes CDN]
|❌ Need to use web builder
|-
|-
| style="font-weight:bold;" |Moment.js
| style="font-weight:bold;" |'''Gridstack'''
|2.29.1
|4.4.1
|'''2.5.2'''
|Major
'''3.4.3'''
|No
|'''<nowiki>Minor|Major</nowiki>'''
|Active
|Active
|.../js/momentjs/
|<small>.../js/gridstack/</small>
|MIT
|MIT
|[http://momentjs.com/ Moment JS] 🆕 [https://moment.github.io/luxon/#/ Luxon GitHub]
|[Demos](<nowiki>https://gridstackjs.com/demo/</nowiki>)
 


Connected to jquery date-picker
https://github.com/gridstack/gridstack.js/tree/master/doc
|🚧
|🚧
|-
|-
| style="font-weight:bold;" |PDFjs
| style="font-weight:bold;" |'''Json editor'''
|3.10.111
|2.6.1
|'''3.10.111'''
|Minor
|No
|'''Minor'''
|Active
|Active
|.../artefact/file/blocktype/pdf/js/pdfjs/
|<small>.../js/jsoneditor/</small>
|Apache License 2
|[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
|🟡 CDN
|-
| style="font-weight:bold;" |Floating UI (Popper)
|2.10.2
|'''Yes'''
|No
|'''Minor'''
|Active
|.../js/popper/
|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://github.com/json-editor/json-editor/blob/master/CHANGELOG.md Changelog]
|🚧
|🚧
|-
|-
| style="font-weight:bold;" |Select2
| style="font-weight:bold;" |'''PDFjs'''
|4.0.13
|3.10.111
|4.0.13
|Minor 🚧
|No
|Active
|Up to date
|<small>.../artefact/file/blocktype/pdf/js/pdfjs/</small>
|Inactive, 2020
|Apache License 2
|.../js/select2/
|[http://mozilla.github.io/pdf.js/getting_started/#download Getting started]
|MIT
The Firefox dist version different to NPM package
|[https://select2.org/ Select2]<nowiki> | </nowiki>[https://github.com/select2/select2/releases Releases]  
RC 4.1
|❌
|❌
|-
| style="font-weight:bold;" |Fontawesome
|6.4.2
|Up to date
|No
|Up to date
|Active
|.../theme/raw/sass/lib/font-awesome/
|SIL OFL 1.1
|[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]
|✅
|-
| style="font-weight:bold;" |TinyMCE
|5.10.7
|Up to date
|No
|Up to date
|Active
|.../js/tinymce/
|LGPL 2.1
|[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]
📲 Test on mobile
|✅
|-
| style="font-weight:bold;" |Video.js
|7.21.5
|'''8.5.2'''
|No
|'''<nowiki>Minor|Major</nowiki>'''
|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]
|✅
|}
|}


Line 410: Line 311:
!'''Name'''
!'''Name'''
!'''Mahara <br />version'''
!'''Mahara <br />version'''
🚧
!'''Latest<br />version'''
!'''Latest<br />version<br />🚧'''
!'''Support'''
!'''Security'''
!'''Location<br />'''<code><small>(./htdocs/...)</small></code>
🚧
!'''Update type'''
🚧
!'''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'''
|Replace
|<small>.../lib/dwoo/</small>
|'''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
|n/a
|'''Archived, 2021'''
|'''Archived, 2021'''
|.../js/javascript-templates/
|<small>.../js/javascript-templates/</small>
|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
|n/a
|'''Deprecated'''
|'''Deprecated'''
|.../js/jquery/jquery-mobile/
|<small>.../js/jquery/jquery-mobile/</small>
|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
|n/a
|'''Deprecated'''
|'''Deprecated'''
|.../js/jquery/jquery-ui/<br />jquery-ui-touch-punch.min.js
|<small>.../js/jquery/jquery-ui/<br />jquery-ui-touch-punch.min.js</small>
|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
|n/a
|'''Inactive, 2018'''
|'''Inactive, 2018'''
|.../js/jTLine/
|<small>.../js/jTLine/</small>
|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
|n/a
|'''Inactive, 2018'''
|'''Inactive, 2018'''
|.../js/masonry/
|<small>.../js/masonry/</small>
|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
|n/a
|'''Forked, 2015'''
|'''Forked, 2015'''
|.../js/tinymce/plugins/mathslate/
|<small>.../js/tinymce/plugins/mathslate/</small>
|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
|Replace
|'''Archived, 2010'''
|'''Archived, 2010'''
|.../webservice/libs/oauth-php/
|<small>.../webservice/libs/oauth-php/</small>
|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
|n/a
|'''Inactive, 2017'''
|'''Inactive, 2017'''
|.../js/zxcvbn/
|<small>.../js/zxcvbn/</small>
|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
|No
|
|'''No open source updates'''
|'''No open source updates'''
|.../js/cookieconsent/
|<small>.../js/cookieconsent/</small>
|MIT
|MIT
|[https://www.osano.com/cookieconsent Download]<nowiki> | </nowiki>[https://github.com/osano/cookieconsent GitHub]
|[https://www.osano.com/cookieconsent Download] [https://github.com/osano/cookieconsent GitHub]


Open source version is not updated. 🚨
<small>Open source version is not updated. 🚨</small>
|
|-
|'''Select2'''
|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
|
|}
|}


Line 534: Line 433:
!'''Mahara <br />version'''
!'''Mahara <br />version'''
!'''Latest<br />version'''
!'''Latest<br />version'''
!'''Security'''
!'''Update'''
!'''Status'''
!'''Status'''
!'''README location<br />'''<code>(./htdocs/...)</code>
!'''README location<br />'''<code>(./htdocs/...)</code>
Line 541: Line 438:
!'''URL/Notes'''
!'''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
|.../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
|.../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
|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
|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
|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]

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’