WackoWiki: Release Notes

https://wackowiki.org/doc     Version: 13.06.2020 19:02
Dev[link35]/ReleaseNotes
This wiki page contains last minute notes to users about the releases, which may not be included in the documentation or README files included with the distribution package. It also contains change information, for users who are interested in what bugs have been fixed, and what features have been added in the current version. (ChangeLog[link1])



1. R6.0

(10.09.2020) dc641ea[link3] -> M11 (Change Log[link4])


As work on WackoWiki 6.0 is still underway[link5], this is an incomplete list of changes.



This is a major release.
The 6.0 release serves mainly two purposes: Migration to Unicode and PHP 7.4/8.0 compatibility.


Unicode

1.1. Notable in this release

  1. added support for UTF-8
    • यूनिकोड, Юникод, ইউনিক’ড, 유니코드
  2. accent and case-sensitive page tag 
  3. implemented full support for relative path
  4. new info formatter and wrapper options
  5. complete PHP 7.4 compatibility

milestones


1.2. Download


wacko.r6.0.11.zip[link6]


Repo files (including community[link7] folder)


Clone repo (see Repository[link11])

git clone -b 6.0.11 https://github.com/WackoWiki/wackowiki.git

1.3. Upgrade path

R5.x –> R5.5[link12] (requires PHP >= 7.0)
R5.5 –> R6.0[link13] (requires PHP >= 7.2)


Please read the upgrade notices[link13] carefully.


{{admin_utf8}} — database UTF-8 conversion script[link14]

1.4. Installation

Installation guide[link15]

1.4.1. Requirements

requires now[link16]


Step by step as Installer Screenshots[link17].


Preparing the Database for Installation

CREATE DATABASE db_name CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_520_ci;


1.4.2. File Permissions

Change the permissions[link18] on the following directories to be writable
touch config/config.php
chmod 666 config/config.php


Example:
chmod 0755 _cache/config/ _cache/feed/ _cache/page/ _cache/query/ _cache/session/ _cache/template/ file/backup/ file/global/ file/perpage/ file/thumb/ xml/


chmod 0660 config/lock config/lock_ap sitemap.xml


reset after installation / upgrade
chmod 644 config/config.php

1.4.3. Path for session values

Check if the provided path for CACHE_SESSION_DIR is correct. The default value is /tmp but may vary in your environment.
Furthermore you may want to change this to a custom folder[link19] for the application (e.g. _cache/session) .


constants.php: 

define('CACHE_SESSION_DIR',		'/tmp');

1.4.4. RewriteBase

If your webserver's URLs are not directly related to physical file paths, you will need to use RewriteBase[link20] in every .htaccess file where you want to use RewriteRule directives[link21]. 

RewriteBase /folder/

1.4.5. New config settings


Please check the Change Log[link4] for more details.

1.5. Admin panel[link2]


If your Admin panel gets locked reset config/lock_ap from 1 to 0

1.6. Themes


If you want to keep your layout, you have to use a program like Meld or WinMerge to merge your CSS and other theme files with the new files in the folder wacko/theme/default[link22].


You can write or adapt your theme also without using the template engine[link23].


-> Themes[link24]
-> Theme guide with example templates[link25]

1.7. Extensions

1.8. Backwards Compatibility

We dropped compatibility code for older PHP and MySQL versions. R6.0 requires at least PHP 7.2 and MySQL 5.7. To use WackoWiki with older PHP or MySQL versions, use the older (but still maintained) branch of 5.5.x releases[link28], which you can find on the download page[link29].

1.9. Known Issues

All known issues[link5] are tracked in our Bug Tracker.[link30]

  1. Session duration issue[link31] – FIXED partially
  2. Missing route cases (needs fix)
    1. CSS files in RECOVERY mode

1.10. Developers

Ensure that the function or filter you use supports Unicode[link32] when you need to process Unicode strings. Missing Unicode support will be added as needed, please provided us with feedback.

1.10.1. Debug functions

  1. to write a parameter in the debug log 
    • Ut::dbg('debug_variable', $parameter);
  2. add debug output to DEBUG file and popup-window in browser
    • Diag::dbg($parameter);
    • to highlight the debug output in the console add '[BLUE|GOLD|ORANGE|RED]' as the first argument
      • e.g. Diag::dbg('GOLD', $parameter);

In both cases it writes the $parameter to the log in the main directory wacko/DEBUG when the config debug is enabled.
Be aware the log isn't emptied automatically. Ensure that the file wacko/DEBUG can be created and is writable.

touch DEBUG
chmod 0664 DEBUG

1.11. Documentation

1.12. What's Planned

WackoWiki is pretty usable now. There are of course few peculiarities and bugs, some old ones and some new ones which are waiting to be fixed. Now the main task is to make the Wiki engine better and reduce bugs.


Apart from that following features are planned to be implemented[link33]:

  1. extended ACLs
  2. WackoFormatter rewrite
  3. responsive device-agnostic theme
  4. improve GUI usability
  5. filter for lists
  6. faceted search
  7. Libsodium, Argon2 Password Hash[link34]
  8. archive table
  9. guest settings

1.13. Contribute

Those interested in following and contributing to the development of WackoWiki can check out the repository, and participate in the discussions on the WackoWiki Development and contribute patches. Policies and the current state of the project and plans are available in the Dev section[link35] of the wiki.


1.14. Feedback

Leave a comment here

if something is not clear or you have further questions.

1.15. Credits




2. R5.5

(31.12.2019) d2649d1[link46] -> M17 (Change Log[link47])


As work on WackoWiki 5.5 is still underway[link48], this is an incomplete list of changes.



This is a major release and a security update for the stable 5.x branch.
In addition to miscellaneous fixes the 5.5 release serves mainly three purposes: Migration to HTML5, address security related features and PHP 7.0/7.4 compatibility.


mammut mascot

2.1. Notable in this release

  1. complete PHP 7.0/7.4 compatibility
  2. HTML5 support
  3. major refactoring of init system
  4. new session handler
  5. new URI router[link49]
  6. new template engine[link23]
  7. added php-diff rendering methods
  8. replaced all icons with SVG icons
  9. implemented auth and form token
  10. added support for audio, video and SVG files
  11. moved page title (H1) from theme header to show handler
  12. added Bad Behaviour as extension
  13. public registration moderation by admin
  14. using password_hash() and password_verify() API 
  15. file link tracking
  16. improved notification handling
  17. localized WikiEdit and Admin panel

milestones

2.2. Download

wacko.r5.5.17.zip[link50]


Repo files (including community[link51] folder)


Clone repo

git clone -b 5.5.17 https://bitbucket.org/wackowiki/wackowiki.git

2.3. Upgrade path

R4.x –> R5.0[link55] (requires PHP 5.2 / 5.3)
R5.x –> R5.5[link12] (requires PHP >= 7.0)


Please read the upgrade notices[link12] carefully.

2.4. Installation

Installation guide[link15]

2.4.1. Requirements

requires now[link56]


Step by step as Installer Screenshots[link17].


Preparing the Database for Installation


Data base configuration: If the installer asks you for charset, select the appropriate character set, e.g.

2.4.2. File Permissions

Change the permissions on the following directories to be writable
touch config/config.php
chmod 666 config/config.php


Example:
chmod 0755 _cache/config/ _cache/feed/ _cache/page/ _cache/query/ _cache/session/ _cache/template/ file/backup/ file/global/ file/perpage/ file/thumb/ xml/


chmod 0660 config/lock config/lock_ap sitemap.xml


reset after installation / upgrade
chmod 644 config/config.php

2.4.3. Path for session values

Check if the provided path for CACHE_SESSION_DIR is correct. The default value is /tmp but may vary in your environment.
Furthermore you may want to change this to a custom folder[link19] for the application (e.g. _cache/session) .


constants.php: 

 define('CACHE_SESSION_DIR',		'/tmp');

2.4.4. RewriteBase

If your webserver's URLs are not directly related to physical file paths, you will need to use RewriteBase[link20] in every .htaccess file where you want to use RewriteRule directives. 

RewriteBase /

RewriteBase /folder/

e.g. .htaccess

<IfModule mod_rewrite.c>
 RewriteEngine on

 RewriteBase /folder/

</IfModule>

2.4.5. Path to user and group profile

The path for link to the users page or profile ((user:UserName UserName)) is set in config['users_page'].


The path for link to the group page or profile ((group:GroupName GroupName)) is set in config['groups_page'].


2.4.6. New config settings


Please check the Change Log[link47] for more details.

2.4.7. Custom CSP settings

e.g. example for your custom CSP settings


csp_custom.conf

Content-Security-Policy:
	default-src 'self';
	script-src 'self' 'unsafe-inline';
	style-src 'self' 'unsafe-inline';
	img-src * data:;
	media-src 'self' archive.org *.youtube.com *.youtube-nocookie.com dailymotion.com;
	object-src 'self' archive.org *.googlevideo.com *.ytimg.com *.youtube.com *.youtube-nocookie.com dailymotion.com;
	child-src 'self' archive.org *.youtube.com *.youtube-nocookie.com *.dailymotion.com;

2.5. Admin Panel

The Admin panel[link2] remains in Beta stage.


If your Admin panel gets locked reset config/lock_ap from 1 to 0

2.6. Themes

All themes[link24] other than default are outdated and unmaintained and were moved to the community/theme[link59] section. If you like to use one of them, please help to update this particular theme.


If you want to keep your layout, you have to use a program like Meld or WinMerge to merge your CSS and other theme files with the new files in the folder wacko/theme/default[link60].


A Guide for the new template engine[link23] will hopefully follow soon. Nevertheless you can write or adapt your theme without using the template engine.

2.7. Extensions

2.8. Backwards Compatibility

We dropped compatibility code for older PHP and MySQL versions. R5.5 requires at least PHP 7.0 and MySQL 5.6. To use WackoWiki with older PHP or MySQL versions, use the older (but still maintained) branch of 5.4.x releases, which you can find on the download page[link29].

2.9. Known Issues

All known issues[link48] are tracked in our Bug Tracker.[link30]

  1. Session duration issue[link31]
  2. Missing route cases (needs fix)
    1. CSS files in RECOVERY mode
  3. activate the option multilanguage in the installer / secondary config to avoid the following issues:
    1. chars from another charset are not converted to HTML unicode entities
    2. This issue will become obsolete with our upcoming Unicode ready Wiki engine.
  4. WikiEdit won't show if you use [et] or [pl] as page language with the auto complete feature -> SyntaxError: invalid range in character class
    1. Workaround: disable Autocomplete under user settings -> extended -> Complete wikilinks by Ctrl+Space

2.10. Developers

2.10.1. New debug functions

  1. to write a parameter in the debug log 
    • Ut::dbg('debug_variable', $parameter);
  2. add debug output to DEBUG file and popup-window in browser
    • Diag::dbg($parameter);
    • to highlight the debug output in the console add '[BLUE|GOLD|ORANGE|RED]' as the first argument
      • e.g. Diag::dbg('GOLD', $parameter);

In both cases it writes the $parameter to the log in the main directory wacko/DEBUG when the config debug is enabled.
Be aware the log isn't emptied automatically. Ensure that the file wacko/DEBUG can be created and is writable.

touch DEBUG
chmod 0664 DEBUG

2.10.2. Access config values

2.10.3. HTTP functions

2.10.4. SQL functions

2.11. Documentation

2.12. What's Planned

WackoWiki is pretty usable now. There are of course few peculiarities and bugs, some old ones and some new ones which are waiting to be fixed. Now the main task is to make the Wiki engine better, reduce bugs and make it more stable.


Apart from that following features are planned to be implemented[link33]:

  1. extended ACLs
  2. WackoFormatter rewrite
  3. responsive device-agnostic theme
  4. improve GUI usability
  5. filters for lists
  6. faceted search
  7. UTF8 support[link32] -> PHP 7/8 and utf8mb4 only
  8. Libsodium, Argon2 Password Hash[link34]
  9. archive table
  10. guest settings

2.13. Contribute

Those interested in following and contributing to the development of WackoWiki can check out the hg repository, and participate in the discussions on the WackoWiki Development and contribute patches. Policies and the current state of the project and plans are available in the Dev section[link35] of the wiki.


2.14. Feedback

Leave a comment here

if something is not clear or you have further questions.

2.15. Credits

Of note, is the large contribution of Serge Terekhov[link38] to this release.



3. R5.4

(12.07.2014) 3679c8e[link88] -> M3 (Change Log[link89])



This is a minor release.
In addition to miscellaneous fixes the 5.4 release serves mainly one purposes: PHP 5.4 / 5.5 compatibility.


For major changes please read the Release Notes of R5.0[link90].


Notable in this release:


milestones

3.1. Download

wacko.r5.4.3.zip[link92]


Repo files


Clone repo

git clone -b 5.4.3 https://bitbucket.org/wackowiki/wackowiki.git

3.2. Translations

3.3. Upgrade path

R4.x -> R5.0 (requires PHP >= 5.2)
R5.x -> R5.4 (requires PHP >= 5.4)


Please read the upgrade notices[link95] carefully.

3.3.1. Upgrade from R5.4.0

If you want upgrade from R5.4.0 to R5.4.3 then just copy the new files over the old ones except:
folders cache/, config/, files/, lib/captcha/ and
files .htaccess, robots.txt


WackoWiki will still report themselves as R5.4.0 because this is a maintenance release.

3.4. Installation

3.4.1. Requirements

requires now


Step by step as Installer Screenshots[link17].


Data base configuration: If the installer asks you for charset, select the appropriate character set, e.g. [cp1252 Western European] for Latin 1.

3.4.2. File Permissions

Change the permissions on the following directories to be writable
touch config/config.php
chmod 666 config/config.php


Example: chmod 0755 xml files/global files/perpage sitemap.xml _cache/config/ _cache/queries/ _cache/pages/ _cache/feeds/


chmod 644 config/config.php

3.4.3. RewriteBase

If your webserver's URLs are not directly related to physical file paths, you will need to use RewriteBase[link20] in every .htaccess file where you want to use RewriteRule directives. 

RewriteBase /

RewriteBase /folder/

e.g. .htaccess

<IfModule mod_rewrite.c>
 RewriteEngine on

 RewriteBase /doc/

 RewriteCond    %{REQUEST_FILENAME}  -d
 RewriteRule ^(.*/[^\./]*[^/])$ $1/
 RewriteRule ^admin\.php$ admin.php [L]
 RewriteRule ^(robots\.txt)$ robots.txt [L]
 RewriteRule ^(sitemap\.xml)$ sitemap.xml [L]
 RewriteRule ^(favicon\.ico)$ favicon.ico [L]
 RewriteRule ^(.*)$ index.php?page=$1 [QSA,L]

</IfModule>

3.4.4. SQL Mode

If you work on a home-brew stack using MySQL 5.6 or 5.7, please check your sql_mode settings.
MySQL switched the SQL-Mode to 'strict' as default since 5.6[link96] and all versions of WackoWiki prior to 5.5 will fail with SQL-Mode 'strict' on. So you must turn it off. We working on a patch.


SELECT @@GLOBAL.sql_mode, @@SESSION.sql_mode;

Disable: NO_ZERO_DATE, ONLY_FULL_GROUP_BY, STRICT_TRANS_TABLES, STRICT_ALL_TABLES, TRADITIONAL.


my.cnf

# The MySQL server
[mysqld]
sql_mode = NO_ENGINE_SUBSTITUTION,NO_AUTO_CREATE_USER

3.4.5. new config settings

primary config

  1. 'database_charset' => '[latin1|cp1251|...]',

constants

  1. HTML_ENTITIES_CHARSET

3.4.6. path to user profile

To guide the link to the users page or profile ((user:UserName UserName)) set in config/interwiki.conf the right path,
if your Wiki does not resides in root don't forget to add the folders.


mode_rewrite on mode_rewrite off 
user /Users?profile= user /?page=Users&profile=
user /folder_test/wacko/Users?profile= user /folder_test/wacko/?page=Users&profile=

3.5. Backwards Compatibility

We dropped compatibility code for older PHP and MySQL versions. R5.4 and later requires at least PHP 5.4 and MySQL 5.5. To use with older PHP or MySQL versions, use the older (but still maintained) branch of 5.1.x releases, which you can find on the download page[link97].

3.6. Hacks / Patches

  1. gallery action[link26]

3.7. Known Issues

All known issues are tracked in our Bug Tracker.[link98]

  1. To use Captcha, you must ensure that the session settings in freecap.php do not differ from the default values or your config settings, else Captcha can't pass its values to the session. In the following link you find a workaround:
  2. @@[local] in intra link may break the Formatter in combination with the toc action
    • e.g. ((../Русский/WackoÑèíòàêñèñ Ðóññêèé @@ru))
  3. activate the option multilanguage in the installer / secondary config to avoid the following issues:
    1. chars from another charset are not converted to HTML unicode entities
  4. multilanguage on: a user with a different but available browser default language can't access the default pages including login via the available theme because the Wacko engine will load this language and the related pages defined there are however possibly not applied / deleted or moved -> Solution: Restore / create the missing default pages for this language

3.8. Documentation

3.9. Credits


4. R5.1

(17.06.2012) 686eb5b[link105] -> Final (Change Log[link106])



This is a minor release.
The 5.1 release serves mainly one purposes. To remove the old legacy code.
For major changes please read the Release Notes of R5.0[link90].


Notable in this release:


milestones

4.1. Download

wacko.r5.1.0.zip[link107]


Repo files


Clone repo

git clone -b 5.1.0 https://bitbucket.org/wackowiki/wackowiki.git

4.2. Translations

4.3. Upgrade path

R4.x -> R5.0 (requires PHP >= 5.2)
R5.0 -> R5.1 (requires PHP >= 5.2)


Please read the upgrade notices[link109] carefully.

4.4. Installation

4.4.1. Requirements

requires now

4.4.2. File Permissions

touch config/config.php
chmod 666 config/config.php


Example: chmod 0755 xml files/global files/perpage sitemap.xml _cache/config/ _cache/queries/ _cache/pages/ _cache/feeds/


chmod 644 config/config.php

4.5. Backwards Compatibility

We dropped compatibility code for older PHP and MySQL versions. R5.x and later requires at least PHP 5.2 and MySQL 5. To use with older PHP or MySQL versions, use the older (but still maintained) branch of 4.3.x releases, which you can find on the download page[link97].

4.6. Known Issues

All known issues are tracked in our Bug Tracker.[link98]

  1. To use Captcha, you must ensure that the session settings in freecap.php do not differ from the default values or your config settings, else Captcha can't pass its values to the session. In the following link you find a workaround:
  2. toc action does not recognize include page structure[link91]
  3. broken POST & reset of Session in menu section via user settings which requires you to logout and login to refresh the changed bookmarks / menu
    • HOTFIX: add the {{menu}} action into a seperate page and edit the menu items / bookmarks there
  4. Not compatible with PHP 5.4! – see bugs:422[link68]

4.7. Documentation

4.8. Credits


5. R5.0

(01.12.2019) 95c416f[link111] -> M5 (Change Log[link112])



This is a major feature release.
The 5.0 release serves mainly three purposes. The first is to normalize database second to back port and merge openSpace[link113] features and last PHP 5.3 compatibility.

5.1. Notable in this release


milestones

5.2. Download

wacko.r5.0.5.zip[link115]


Repo files


Clone repo

git clone -b 5.0.5 https://bitbucket.org/wackowiki/wackowiki.git

5.3. Translations

5.4. Upgrade path

R4.0 -> R4.3 (requires PHP 4)
R4.x -> R5.0 (requires PHP >= 5.2)
R4.3 -> R5.0 (requires PHP >= 5.2)


Please read the upgrade notices[link55] carefully.
Don't miss to run the adminupdate action after the upgrade to migrate your old data, it is only in this release available.

5.5. Installation

5.5.1. Requirements

requires now


Not compatible with PHP 5.4!

5.5.2. File Permissions

touch config/config.php
chmod 666 config/config.php


Example: chmod 0755 xml files/global files/perpage sitemap.xml _cache/config/ _cache/queries/ _cache/pages/ _cache/feeds/


chmod 644 config/config.php

5.5.3. new config settings



5.5.4. SQL Mode

If you work on a home-brew stack using MySQL 5.6 or 5.7, please check your sql_mode settings.
MySQL switched the SQL-Mode to 'strict' as default since 5.6[link96] and all versions of WackoWiki prior to 5.5 will fail with SQL-Mode 'strict' on. You must turn it off. We working on a patch.


SELECT @@GLOBAL.sql_mode, @@SESSION.sql_mode;

Disable: NO_ZERO_DATE, ONLY_FULL_GROUP_BY, STRICT_TRANS_TABLES, STRICT_ALL_TABLES, TRADITIONAL.


my.cnf

# The MySQL server
[mysqld]
sql_mode = NO_ENGINE_SUBSTITUTION,NO_AUTO_CREATE_USER

5.6. Admin Panel

The new Admin panel is still in its Beta stage.


If your Admin panel gets locked reset config/lock_ap from 1 to 0

5.7. Themes

Themes for earlier versions will no longer work without modification.
When you upgrade WackoWiki all of your themes will be reset to 'default' theme for each user account to ensure that nothing breaks.

5.8. Extensions

Extensions installed under previous versions of WackoWiki may be incompatible and/or require updates to work with WackoWiki.

5.9. Backwards Compatibility


We dropped compatibility code for older PHP and MySQL versions. R5.x and later requires at least PHP 5.2 and MySQL 5. To use with older PHP or MySQL versions, use the older (but still maintained) branch of 4.3.x releases, which you can find on the download page[link97].

5.10. Known Issues

All known issues are tracked in our Bug Tracker.[link98]

  1. To use Captcha, you must ensure that the session settings in freecap.php do not differ from the default values or your config settings, else Captcha can't pass its values to the session. In the following link you find a workaround:
  2. toc action does not recognize include page structure[link91]
  3. broken POST & reset of Session in menu section via user settings which requires you to logout and login to refresh the changed bookmarks / menu
    • HOTFIX: add the {{menu}} action into a seperate page and edit the menu items / bokkmarks there
  4. Not compatible with PHP 5.4! – see bugs:422[link68]

5.11. Credits


If we have missed someone`s contribution — we are very sorry for that. Please fill this page with actual information.


6. R4.3

(20.03.2011) e192369[link124] (Change Log[link125])



The 4.3 release serves two purposes. The first is to release a number of bug fixes to the wacko community and the second is to say wacko is officially alive again. Primarily we are just taking care of all the bugs in the bugtracker whilst implementing user requested extra features along the way. Here's a brief summary of the changes we've made in 4.3:


Notable in this release:


milestones

6.1. Download

Repo files


Clone repo

git clone -b 4.3.0 https://bitbucket.org/wackowiki/wackowiki.git

6.2. Installation

6.2.1. Requirements

6.2.2. new config settings

  1. 'database_driver' => 'mysql_legacy',
  2. 'database_host' => 'localhost',
  3. 'database_port' => ' ',
  4. 'database_database' => 'wacko'
  5. 'database_user' => 'wacko',
  6. 'database_password' => 'mypassword',
  7. 'session_prefix' => 'wacko43_',
  8. 'xml_sitemap' => 0,
  9. 'spam_filter' => 1, – spam_filter config parameter
  10. 'captcha_new_comment' => 1,
  11. 'captcha_new_page' => 1,
  12. 'captcha_edit_page' => 1,
  13. 'captcha_registration' => 1,

6.3. Backwards Compatibility

6.4. Known Issues

All known issues are tracked in our Bug Tracker.[link30]

6.5. Credits