[DOC] Fix feature list of 3.0.0

Integrating missed bits of Dan Untenzu

Signed-off-by: Jerome Jutteau <jerome.jutteau@outscale.com>

Jirafeau version 3.0.0

Signed-off-by: Jerome Jutteau <jerome.jutteau@outscale.com>

[FEATURE] Docs: Note steps to prepare new releases

Write down all required steps for new releases.

Refs #104 #109

[FEATURE] Add walktrough to create merge requests

Explain a bit how merge requests are made on Gitlab
to easen the hurdle for new contributors.

Refs #104

[BUGFIX] Prevent bouncing fileupload field

After a file is selected in the first step of an upload,
the options are shown and the fileupload field is resized
to a much smaller field. In Chrome and other browsers
this field bounces to an area above the form.

Use relative positioning and fixed heights to prevent this
UI glitch.

Refs #71

[BUGFIX] Fix UI glitch in admin table

Enlarge file table in admin view, to prevent that the
surrounding border is smaler than the automatically resized table.

Refs #71

[FEATURE] Convert UTC dates to clients timezone

Convert all dates & times in UTC to the clients timezone.

This requires several custom JavaScripts, as this conversion
is not possible with the Date object in all recent browsers
(latest Firefox, Chrome, Opera, Edge accept UTC date & time,
all Internet Explorer accept UTC date only).

Refs #59 #106

[FEATURE] Show readable date format

Whenever date objects in PHP or JavaScript are converted
to strings, it depends on the servers/clients settings and
timezone which locale and format is used.

This may lead to situation where the date is in english,
but all other texts of Jirafeau service are in another language.

Depending on unser language it may be not possible to localise
the date, since we would need to have a list of all existing
date formats. In both PHP and JavaScript.

To avoid these translation obstacles we may use the following
fallback:
  * Always use UTC timezone in PHP and render dates with UTC only
  * Use the rather international format »YYYY-MM-DD hh:mm«

Refs #59 #106 #73

[FEATURE] Upload Script: Refactor datefield setter

Reduce method calls in upload script to prepare
upcoming date format changes.

[FEATURE] Set default timezone

Set UTC as default timezone for all date/time functions.

Dont rely on the servers timezone, since this timezone may
change on cloud hosts or may nit be set at all.

Using UTC is a best practice to avoid timezone issues etc.

Refs #73

[BUGFIX] Admin page: Prefix path to download links

The download links in the admin page have no
path prefix and therefore all installations with within
a subdirectory create no-working links.

Prefix the JIRAFEAU_ABSPREFIX to create working URLs.

Refs #108

[FEATURE] Follow up: Remove further form targets

Follow up for commit a12b04d2670d2916008e53b4f5a2cc5f158cb998.

Remove further form action targets, if these forms should be send
to the same page anyway. In this case we may safely omnit the
action attribute and safe some path constructions.

ip or password (see issue 107)

[BUGFIX] Catch errors in upload form

The upload forms failed to catch errors due to a
never matching condition. Failing uploads (eg. because of
filesize limit etc.) still tried to render non-existing
download links instead of showing the error.

Fix the condition by testing if the return string
starts with "Error" instead of equals "Error".

Refs #96

[FEATURE] Readme: Add CI badges

Add status badge of latest CI run to the readme file.

[FEATURE] Docs: Add system requirements

Note that PHP >= 5.6 is a system requirement.

refs #72

[FEATURE] Contribution Guide: Declare PSR-2 Coding Style

All PHP code should now follow PSR-2.

[FEATURE] Switch to PSR-2

Convert all PHP files to PSR-2, which defined
a basic Coding Style Guide for PHP projects.

Using the awesome friendsofphp/php-cs-fixer tool,
running with the @PSR2 ruleset.

1) script.php (no_spaces_after_function_name, braces)
2) f.php (indentation_type, no_spaces_after_function_name, braces)
3) install.php (indentation_type, function_declaration, elseif, no_spaces_after_function_name, braces)
4) lib/functions.php (no_spaces_inside_parenthesis, method_argument_space, function_declaration, elseif, no_spaces_after_function_name, lowercase_constants, lowercase_keywords, braces, single_blank_line_at_eof)
5) lib/functions.js.php (no_spaces_after_function_name)
6) lib/lang.php (function_declaration, no_spaces_after_function_name, lowercase_constants, no_closing_tag, braces, single_blank_line_at_eof)
7) lib/template/footer.php (braces)
8) lib/config.local.bak.php (method_argument_space, no_spaces_after_function_name, no_closing_tag, single_blank_line_at_eof)
9) lib/config.original.php (no_spaces_after_function_name, no_closing_tag, single_blank_line_at_eof)
0) lib/settings.php (indentation_type, no_spaces_after_function_name, braces)
1) lib/config.local.php (no_spaces_after_function_name, single_blank_line_at_eof)
2) index.php (indentation_type, no_spaces_after_function_name, braces)
3) admin.php (no_spaces_after_function_name, braces)
4) tos.php (no_spaces_after_function_name, no_closing_tag, single_blank_line_at_eof)

Refs #103

[TASK] Rename license short identifier

The official short identifier for
"GNU Affero General Public License v3.0" is "AGPL-3.0"
(see https://spdx.org/licenses/ → https://spdx.org/licenses/AGPL-3.0.html)

[FEATURE] Docs: Explain branches

Explain master and next-release branch.

Master should always be a live version only,
unless the version is changed to something like "2.0.0-dev".

Refs #

[TASK] CGL: Remove trailing whitespaces

Remove all trailing whitespaces

[TASK] CGL: Fix line endings

All line endings are LF (Unix) now.

(bash command to convert all files: http://stackoverflow.com/a/37846265/3894752)

[FEATURE] Contribution guide: Revise structure

* Add description of new files
* Explain file system a bit further
* Fix some typos

[FEATURE] Readme: Add points to changelog

[FEATURE] Replace all domain depended links

Replace all occurences of "web_root" (domain depended links)
with "JIRAFEAU_ABSPREFIX" (absolute links to the root level).

Links like "https://example.com/foo/functions.js" are replaced
with "/foo/functions.js".

Refs #79

[FEATURE] Autogenerate prefix for absolute links

Add a helping variable to build absolute links to
the root of the domain without handling the URL scheme.

This way all links could get rid of the host & domain part,
and just build absolute links to the root instead.
(Replace "[https://example.com/foo/] + [functions.js]" with
"[/foo/] + [functions.js]")

Refs #79

[FEATURE] Installer: Remove (unknown) form target URL

The domain on which Jirafeau is running, is not yet
defined while installing the project. In order to build valid
action links for the form, the script generated a possible URL
using the request header. This method may fail for proxies
or while using HTTPS or due to spoofing or…

In HTML5 we can safely omnit the action attribute (see
http://stackoverflow.com/a/9678030), which will cause the browser
to send the request to the exact same URL again.

This way we can avoid the URL guessing during the installation.

Refs #79

[FEATURE] Remove redundant constants

Remove some redundant settings

[BUGFIX] Remove redundant header variable

By removing the XHTML doctype it is not neccessary
anymore to tell proxys that the content type may change.

So this header is redunant now.

[BUGFIX] Remove redundant style fallback

Remove condition for an existing theme,
since a default configuration is always set.

Even if this would not be the case, would
the current fallback try to load a non-existing
theme called "default".

So remove this whole block.

[!!][FEATURE] Remove XHTML doctype

The project uses a HTML5 doctype, but switches
to XHTML if a condition says that the clients browser
can handle XHTML. As this is the case for nearly any
browser which also supports HTML5, the condition causes
the script to *always* render the XHTML doctype.

We remove the whole condition and the XHTML doctype
in favour of a HTML5 doctype only.

Note: This may be considered as breaking change,
since HTML5 may not be working in ancient versions of IE.

Refs #97

[FEATURE] Docs: Revice upgrade instructions

* Rewrite general upgrade instructions
* Better explaination for breaking changes in
  each version and how to fix them

[FEATURE] Add Gitlab CI

Make use of the fantastic Gitlab CI to run some
tests automatically after each push.

First test: test for PHP errors in different versions.

Simpler docker dev env

Note: ._* files are created due to docker file system sync, ignore them

Signed-off-by: Jerome Jutteau <j.jutteau@gmail.com>

Jirafeau version 2.0.0

Signed-off-by: Jerome Jutteau <j.jutteau@gmail.com>

[FEATURE] Styles: Add padding

[FEATURE] Docs: Explain how to obey the AGPLv3 license

This project uses the AGPLv3 license. If an admin decides
to make some adaptions to the source code, and run a service with
these changes incorporated, the admin is required to offer
the servers users a download of the source code of his version.

Describe in the README how to do that conveniently with the ToS page.

Closes #95

[BUGFIX] Translations: Rename ToS

Rename ToS label to plural

[FEATURE] Footer: Nicer project title

[FEATURE] Enable a custom website title

Enable the administrator to set a custom title
for his installation of Jirafeau, eg. "John Doe Filecenter".

[FEATURE] Template Markers: Replace configuration values

Replace markers with configured values.

[!!][FEATURE] Let admin overwrite the ToS page

Let the admin overwrite the content of the
"Terms of Service" page by copying the original ToS
template and creating a local file (same procedure as
for the configuration). This file is not versionized.

Note: This is a breaking change, since the existing
tos textfile is moved. This should be mentioned
in the update comments.
  * ToS text file changed → move file from "/tos_text.php"
    to "/lib/tos.local.txt" and remove all HTML und PHP Tags,
    leaving a regular text file.

Refs #95

[FEATURE] Replace markers in templates

Add a function to allow a simple marker replacement,
eg. for the Terms of Service page.

Markers have the scheme "###MARKERNAME###".

[FEATURE] Install script: Simplify config generation

Simplify the generation of the local configuration file
by replacing various loops with shorter PHP standard methods.

This will cause the local configuration to have a slightly
different style, but it is still an array therefore is
readable and changeable by PHP developers.

[FEATURE] Move config include into settings file

Move the include of the original and the local
configuration file into the settings file to reduce one
includes in each file, have all settings in one place
and remove unneccessary code from the config file
(which makes it easier to copy and change it).

[FEATURE] Install script: Reduce test code

Add some comments to enhance the readabillity in the
installation script.

Reduce footer includes and send all fatal errors
to one function instead.

Remove includes of installation depenend variables
in the footer, if the installation script is not
done yet.

Move settings include to the top (this may help
for future configuration tests).

[FEATURE] Docs: Enhance readabilty of config params

Add some linebreaks and streamline comment style.

[BUGFIX] Contribution: Fix structure markdown

Structure markdown needs a code block syntax,
to prevent wrong display.

[FEATURE] Contribution guide: Revise chapters

* Add headlines
* Add note about the KISS principle of the project
* Fix some typos

[FEATURE] Readme: Add link to contribution file

Its a common way to include a CONTRIBUTING.md file
(https://github.com/blog/1184-contributing-guidelines)
to explain developers things like code format, structures and
patch guidelines.

Rename the newcomers file to CONTRIBUTING.md and add
a link to it in the README.

[TASK] Rename license file

The license file is usually named "LICENSE.txt".

[FEATURE] Readme: Add license

[FEATURE] Readme: Add screenshot of admin interface

Refs #89

[FEATURE] Enhance Readme

* Revise headlines/subheadlines
* Move update instructions
* Add features

[BUGFIX] Bash script: return download link to web view

The bash script uses the upload URL to build the download link.

So the user may share different links when using the bash script
or the webform. Besides that does the API page show the same
result for "download links" and "direct links", so the current
list makes no sense to the uploader.

The script should however link to the web view and
offer API commands additionally.

Refs #86

[BUGFIX] API: Set content type to plain text

Setting the content type to text only will
make some browsers to ignore the utf8 charset.

Set the default content type to "plain text"
to deliver UTF8 and avoid errors while generating
a bash script with special characters.

[FEATURE] Bash script: Enhance help and add version

Enhance the help and show all available options in
a common structure.
Move description of available options to one place.

Also add the version of the Jirafeau version which
generated the bash script. This way a user may
find out about changes (because his script was
generated with Jirafeau 1.1.2, but the current version
on the server may be 3.2.5 already).

Jirafeau version 1.2.0

Signed-off-by: Jerome Jutteau <j.jutteau@gmail.com>

Add note about admin password hashing

Signed-off-by: Jerome Jutteau <j.jutteau@gmail.com>

Fix php warning due to usage of date()

The function time() returns always timestamp that is timezone independent (=UTC)

Signed-off-by: Jerome Jutteau <j.jutteau@gmail.com>

Translation: french quarter expiration

Signed-off-by: Jerome Jutteau <j.jutteau@gmail.com>

[FEATURE] Translation: german quarter expiration

Fix missing quarter in possible values

Signed-off-by: Jerome Jutteau <j.jutteau@gmail.com>

Fix missing possible values in expiration dates

Signed-off-by: Jerome Jutteau <j.jutteau@gmail.com>

[FEATURE] Add »quarter« expiration time

Add »quarter« (3 x 1 Month = 90 days) as available expiration time.

This option is disabled by default.

Refs #87

[FEATURE] Set default expiration time in config

Enable the admin to set a default expiration time
in the configuration time. This way the upload form
may offer "hour", "day", "month" as available expiration
times and "day" is preselected.

Default in the original configuration is "month".

Refs #57

[FEATURE] Streamline default expiration date

The bash script sets the expiration date to "none"
by default. The web form has "month" as default however.

Streamline the default expiration date and set the bash
to month as well.

This also avoids an error if the bash script is run
for the first time ever with default settings, since
the expiration time "none" is not allowed then.

Refs #85

[TASK] CGL: Remove whitespaces

Remove unwanted whitespace

[FEATURE] Show download link in admin panel

Show the download link for a file in the admin panel,
to find it again easily if the uploader has lost it somehow.

Move the "direct download" action into the last column instead.

Refs #68

[BUGFIX] Deliver JavaScript with correct MIME type

The JavaScript lib is generated by a PHP file. This
file will be blocked in browsers, if the server has the
security option "X-Content-Type-Options: nosniff" set.

Set the correct MIME type (text/javascript) in the header
to avoid this behaviour.

Refs #84

Enable Spanish translation

Signed-off-by: Jerome Jutteau <j.jutteau@gmail.com>

Enable Russian translation

Signed-off-by: Jerome Jutteau <j.jutteau@gmail.com>

Added translation for Spanish

Thanks to [Emuarc](https://gitlab.com/Emuarc)

Signed-off-by: Jerome Jutteau <j.jutteau@gmail.com>

Add a small script to run Jirafeau in a docker

Signed-off-by: Jerome Jutteau <j.jutteau@gmail.com>

Translated using Weblate (Spanish)

Currently translated at 69.0% (76 of 110 strings)

Translated using Weblate (Polish)

Currently translated at 40.9% (45 of 110 strings)

Added translation using Weblate (Polish)

Translated using Weblate (Russian)

Currently translated at 100.0% (110 of 110 strings)

Update README.md

add Greek language

Signed-off-by: Jerome Jutteau <j.jutteau@gmail.com>

Merge remote-tracking branch 'origin/master'

Adding a very nice theme from JordyValentine

Integrated from https://github.com/JordyValentine/jirafeau-elegantish

Merge remote-tracking branch 'origin/master'

add sha-256 password cipher support

Merge remote-tracking branch 'origin/master'

Translated using Weblate (Croatian)

Currently translated at 36.3% (40 of 110 strings)

Added translation using Weblate (Croatian)

Translated using Weblate (Greek)

Currently translated at 86.3% (95 of 110 strings)

Translated using Weblate (Greek)

Currently translated at 16.3% (18 of 110 strings)

Translated using Weblate (Greek)

Currently translated at 11.8% (13 of 110 strings)

Added translation using Weblate (Greek)

Add instructions for nginx

Merge branch 'master' into 'master'

Adding the possibility to call admin.php from CLI to automatize (e.g. in cron) the cleaning of old/expired files and unfinished tranfers

Hello,
I think this feature might be of interest for other administrators of Jirafeau. I have not found any way in the app to do it so I developed this small patch. What do you think?
Best
Pierre-Alain

See merge request !15

Adding infos on Munin plugins for Jirafeau

Adding info about the "cronization" of clean_expired, clean_async

Fixing some typos in README.md

Adding the possibility to call admin.php from CLI to automatize cleanoing of old files / async files

Enable simplified Chinese translation

Signed-off-by: Jérôme <mojo@couak.net>

Fix German translation

Signed-off-by: Tobias Strobel <me@strobeltobias.de>

Translated using Weblate (Chinese)

Currently translated at 93.6% (103 of 110 strings)