Merge pull request #32 from YunoHost-Apps/testing

Testing

README.md

@@ -1,23 +1,65 @@
-Baïkal for YunoHost
+# Baïkal for YunoHost
--------------------
 
+[![Integration level](https://dash.yunohost.org/integration/baikal.svg)](https://dash.yunohost.org/appci/app/baikal)  
+[![Install Baïkal with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=baikal)
+
+> *This package allow you to install Baïkal quickly and simply on a YunoHost server.  
+If you don't have YunoHost, please see [here](https://yunohost.org/#/install) to know how to install and enjoy it.*
+
+## Overview
 [Baïkal](http://baikal-server.com/) is a CalDAV and CardDAV server, based on
 sabre/dav, that includes an administration interface for easy management.
 
 **Shipped version:** 0.4.6
 
-## Features
+## Screenshots
+
+## Demo
+
+* [YunoHost demo](https://demo.yunohost.org/baikal/admin/)
+
+## Configuration
+
+## Documentation
+
+ * Official documentation: http://sabre.io/baikal/
+ * YunoHost documentation: https://yunohost.org/#/app_baikal
+
+## YunoHost specific features
 
 In addition to Baïkal core features, the following are made available with
 this package:
 
  * Serve `/.well-known` paths for CalDAV and CardDAV on the domain
 
-## TODO
+#### Multi-users support
 
- * Update `config.php` and `config.system.php` at upgrade
+#### Supported architectures
+
+* x86-64b - [![Build Status](https://ci-apps.yunohost.org/ci/logs/baikal%20%28Official%29.svg)](https://ci-apps.yunohost.org/ci/apps/baikal/)
+* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/baikal%20%28Official%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/baikal/)
+* Jessie x86-64b - [![Build Status](https://ci-stretch.nohost.me/ci/logs/baikal%20%28Official%29.svg)](https://ci-stretch.nohost.me/ci/apps/baikal/)
+
+## Limitations
+
+## Additional information
 
 ## Links
 
+ * Report a bug: https://github.com/YunoHost-Apps/baikal_ynh/issues
  * Baïkal website: http://baikal-server.com/
  * YunoHost website: https://yunohost.org/
+
+---
+
+Developers infos
+----------------
+
+Please do your pull request to the [testing branch](https://github.com/YunoHost-Apps/baikal_ynh/tree/testing).
+
+To try the testing branch, please proceed like that.
+```
+sudo yunohost app install https://github.com/YunoHost-Apps/baikal_ynh/tree/testing --debug
+or
+sudo yunohost app upgrade baikal -u https://github.com/YunoHost-Apps/baikal_ynh/tree/testing --debug
+```

check_process

@@ -11,6 +11,7 @@
 		setup_private=0
 		setup_public=0
 		upgrade=1
+		upgrade=1	from_commit=1aea3f3c4943c83135f7f287e6ac10c03df56323
 		backup_restore=1
 		multi_instance=0
 		incorrect_path=1
@@ -32,3 +33,7 @@
 ;;; Options
 Email=
 Notification=none
+;;; Upgrade options
+	; commit=1aea3f3c4943c83135f7f287e6ac10c03df56323
+		name=Fix install + refactoring
+		manifest_arg=domain=DOMAIN&path=PATH&password=mysecret&

conf/config.php

@@ -32,7 +32,7 @@
 #
 
 # Timezone of your users, if unsure, check http://en.wikipedia.org/wiki/List_of_tz_database_time_zones
-define("PROJECT_TIMEZONE", '#TIMEZONE#');
+define("PROJECT_TIMEZONE", '__TIMEZONE__');
 
 # CardDAV ON/OFF switch; default TRUE
 define("BAIKAL_CARD_ENABLED", TRUE);
@@ -59,4 +59,4 @@ define("BAIKAL_DAV_LDAP_DISPLAYNAME_ATTR", 'cn');
 define("BAIKAL_DAV_LDAP_EMAIL_ATTR", 'mail');
 
 # Baïkal Web admin password hash; Set via Baïkal Web Admin
-define("BAIKAL_ADMIN_PASSWORDHASH", '#PASSWORDHASH#');
+define("BAIKAL_ADMIN_PASSWORDHASH", '__PASSWORDHASH__');

conf/config.system.php

@@ -39,13 +39,13 @@
 define("BAIKAL_AUTH_REALM", 'BaikalDAV');
 
 # Should begin and end with a "/"
-define("BAIKAL_CARD_BASEURI", "#PATH#/card.php/");
+define("BAIKAL_CARD_BASEURI", "__PATH__/card.php/");
 
 # Should begin and end with a "/"
-define("BAIKAL_CAL_BASEURI", "#PATH#/cal.php/");
+define("BAIKAL_CAL_BASEURI", "__PATH__/cal.php/");
 
 # Should begin and end with a "/"
-define("BAIKAL_DAV_BASEURI", "#PATH#/dav.php/");
+define("BAIKAL_DAV_BASEURI", "__PATH__/dav.php/");
 
 # Define path to Baïkal Database SQLite file
 define("PROJECT_SQLITE_FILE", PROJECT_PATH_SPECIFIC . "db/db.sqlite");
@@ -57,16 +57,16 @@ define("PROJECT_DB_MYSQL", TRUE);
 define("PROJECT_DB_MYSQL_HOST", 'localhost');
 
 # MySQL > Database name
-define("PROJECT_DB_MYSQL_DBNAME", '#DBNAME#');
+define("PROJECT_DB_MYSQL_DBNAME", '__DBNAME__');
 
 # MySQL > Username
-define("PROJECT_DB_MYSQL_USERNAME", '#DBUSER#');
+define("PROJECT_DB_MYSQL_USERNAME", '__DBUSER__');
 
 # MySQL > Password
-define("PROJECT_DB_MYSQL_PASSWORD", '#DBPASS#');
+define("PROJECT_DB_MYSQL_PASSWORD", '__DBPASS__');
 
 # A random 32 bytes key that will be used to encrypt data
-define("BAIKAL_ENCRYPTION_KEY", '#DESKEY#');
+define("BAIKAL_ENCRYPTION_KEY", '__DESKEY__');
 
 # The currently configured Baïkal version
 define("BAIKAL_CONFIGURED_VERSION", '0.4.6');

conf/nginx.conf

@@ -5,12 +5,15 @@ location = /.well-known/caldav {
   return 301 https://$server_name__PATH__/cal.php;
 }
 
-location __PATH__ {
+#sub_path_only rewrite ^__PATH__$ __PATH__/ permanent;
+location __PATH__/ {
+
+  # Path to source
   alias __FINALPATH__/html/;
 
+  # Force usage of https
   if ($scheme = http) {
-    return 301 https://$server_name$request_uri;
+    rewrite ^ https://$server_name$request_uri? permanent;
-#    rewrite ^ https://$server_name$request_uri? permanent;
   }
 
   index index.php;
@@ -20,7 +23,7 @@ location __PATH__ {
     fastcgi_split_path_info ^(.+\.php)(.*)$;
     fastcgi_param PATH_INFO       $fastcgi_path_info;
     fastcgi_param SCRIPT_FILENAME $request_filename;
-    fastcgi_pass unix:/var/run/php5-fpm-__NAME__.sock;
+    fastcgi_pass unix:/var/run/php/php7.0-fpm-__NAME__.sock;
   }
 
   location ~ ^__PATH__/(\.|Core|Specific) {

conf/php-fpm.conf

@@ -1,68 +1,430 @@
+; Start a new pool named 'www'.
+; the variable $pool can be used in any directive and will be replaced by the
+; pool name ('www' here)
 [__NAMETOCHANGE__]
-; The address on which to accept FastCGI requests.
-listen = /var/run/php5-fpm-__NAMETOCHANGE__.sock
 
-; Set permissions for unix socket, if one is used.
+; Per pool prefix
-listen.owner = www-data
+; It only applies on the following directives:
-listen.group = www-data
+; - 'access.log'
-listen.mode = 0600
+; - 'slowlog'
+; - 'listen' (unixsocket)
+; - 'chroot'
+; - 'chdir'
+; - 'php_values'
+; - 'php_admin_values'
+; When not set, the global prefix (or /usr) applies instead.
+; Note: This directive can also be relative to the global prefix.
+; Default Value: none
+;prefix = /path/to/pools/$pool
 
-; Unix user/group of processes.
+; Unix user/group of processes
+; Note: The user is mandatory. If the group is not set, the default user's group
+;       will be used.
 user = __USER__
 group = __USER__
 
+; The address on which to accept FastCGI requests.
+; Valid syntaxes are:
+;   'ip.add.re.ss:port'    - to listen on a TCP socket to a specific IPv4 address on
+;                            a specific port;
+;   '[ip:6:addr:ess]:port' - to listen on a TCP socket to a specific IPv6 address on
+;                            a specific port;
+;   'port'                 - to listen on a TCP socket to all addresses
+;                            (IPv6 and IPv4-mapped) on a specific port;
+;   '/path/to/unix/socket' - to listen on a unix socket.
+; Note: This value is mandatory.
+listen = /var/run/php/php7.0-fpm-__NAMETOCHANGE__.sock
+
+; Set listen(2) backlog.
+; Default Value: 511 (-1 on FreeBSD and OpenBSD)
+;listen.backlog = 511
+
+; Set permissions for unix socket, if one is used. In Linux, read/write
+; permissions must be set in order to allow connections from a web server. Many
+; BSD-derived systems allow connections regardless of permissions.
+; Default Values: user and group are set as the running user
+;                 mode is set to 0660
+listen.owner = www-data
+listen.group = www-data
+;listen.mode = 0660
+; When POSIX Access Control Lists are supported you can set them using
+; these options, value is a comma separated list of user/group names.
+; When set, listen.owner and listen.group are ignored
+;listen.acl_users =
+;listen.acl_groups =
+
+; List of addresses (IPv4/IPv6) of FastCGI clients which are allowed to connect.
+; Equivalent to the FCGI_WEB_SERVER_ADDRS environment variable in the original
+; PHP FCGI (5.2.2+). Makes sense only with a tcp listening socket. Each address
+; must be separated by a comma. If this value is left blank, connections will be
+; accepted from any ip address.
+; Default Value: any
+;listen.allowed_clients = 127.0.0.1
+
+; Specify the nice(2) priority to apply to the pool processes (only if set)
+; The value can vary from -19 (highest priority) to 20 (lower priority)
+; Note: - It will only work if the FPM master process is launched as root
+;       - The pool processes will inherit the master process priority
+;         unless it specified otherwise
+; Default Value: no set
+; process.priority = -19
+
+; Set the process dumpable flag (PR_SET_DUMPABLE prctl) even if the process user
+; or group is differrent than the master process user. It allows to create process
+; core dump and ptrace the process for the pool user.
+; Default Value: no
+; process.dumpable = yes
+
 ; Choose how the process manager will control the number of child processes.
+; Possible Values:
+;   static  - a fixed number (pm.max_children) of child processes;
+;   dynamic - the number of child processes are set dynamically based on the
+;             following directives. With this process management, there will be
+;             always at least 1 children.
+;             pm.max_children      - the maximum number of children that can
+;                                    be alive at the same time.
+;             pm.start_servers     - the number of children created on startup.
+;             pm.min_spare_servers - the minimum number of children in 'idle'
+;                                    state (waiting to process). If the number
+;                                    of 'idle' processes is less than this
+;                                    number then some children will be created.
+;             pm.max_spare_servers - the maximum number of children in 'idle'
+;                                    state (waiting to process). If the number
+;                                    of 'idle' processes is greater than this
+;                                    number then some children will be killed.
+;  ondemand - no children are created at startup. Children will be forked when
+;             new requests will connect. The following parameter are used:
+;             pm.max_children           - the maximum number of children that
+;                                         can be alive at the same time.
+;             pm.process_idle_timeout   - The number of seconds after which
+;                                         an idle process will be killed.
+; Note: This value is mandatory.
 pm = dynamic
 
 ; The number of child processes to be created when pm is set to 'static' and the
-; maximum number of child processes to be created when pm is set to 'dynamic'.
+; maximum number of child processes when pm is set to 'dynamic' or 'ondemand'.
+; This value sets the limit on the number of simultaneous requests that will be
+; served. Equivalent to the ApacheMaxClients directive with mpm_prefork.
+; Equivalent to the PHP_FCGI_CHILDREN environment variable in the original PHP
+; CGI. The below defaults are based on a server without much resources. Don't
+; forget to tweak pm.* to fit your needs.
+; Note: Used when pm is set to 'static', 'dynamic' or 'ondemand'
+; Note: This value is mandatory.
 pm.max_children = 6
 
 ; The number of child processes created on startup.
+; Note: Used only when pm is set to 'dynamic'
+; Default Value: min_spare_servers + (max_spare_servers - min_spare_servers) / 2
 pm.start_servers = 3
 
 ; The desired minimum number of idle server processes.
+; Note: Used only when pm is set to 'dynamic'
+; Note: Mandatory when pm is set to 'dynamic'
 pm.min_spare_servers = 3
 
 ; The desired maximum number of idle server processes.
+; Note: Used only when pm is set to 'dynamic'
+; Note: Mandatory when pm is set to 'dynamic'
 pm.max_spare_servers = 5
 
+; The number of seconds after which an idle process will be killed.
+; Note: Used only when pm is set to 'ondemand'
+; Default Value: 10s
+;pm.process_idle_timeout = 10s;
+
 ; The number of requests each child process should execute before respawning.
-pm.max_requests = 500
+; This can be useful to work around memory leaks in 3rd party libraries. For
+; endless request processing specify '0'. Equivalent to PHP_FCGI_MAX_REQUESTS.
+; Default Value: 0
+;pm.max_requests = 500
 
 ; The URI to view the FPM status page. If this value is not set, no URI will be
-; recognized as a status page.
+; recognized as a status page. It shows the following informations:
-pm.status_path = /fpm-status
+;   pool                 - the name of the pool;
+;   process manager      - static, dynamic or ondemand;
+;   start time           - the date and time FPM has started;
+;   start since          - number of seconds since FPM has started;
+;   accepted conn        - the number of request accepted by the pool;
+;   listen queue         - the number of request in the queue of pending
+;                          connections (see backlog in listen(2));
+;   max listen queue     - the maximum number of requests in the queue
+;                          of pending connections since FPM has started;
+;   listen queue len     - the size of the socket queue of pending connections;
+;   idle processes       - the number of idle processes;
+;   active processes     - the number of active processes;
+;   total processes      - the number of idle + active processes;
+;   max active processes - the maximum number of active processes since FPM
+;                          has started;
+;   max children reached - number of times, the process limit has been reached,
+;                          when pm tries to start more children (works only for
+;                          pm 'dynamic' and 'ondemand');
+; Value are updated in real time.
+; Example output:
+;   pool:                 www
+;   process manager:      static
+;   start time:           01/Jul/2011:17:53:49 +0200
+;   start since:          62636
+;   accepted conn:        190460
+;   listen queue:         0
+;   max listen queue:     1
+;   listen queue len:     42
+;   idle processes:       4
+;   active processes:     11
+;   total processes:      15
+;   max active processes: 12
+;   max children reached: 0
+;
+; By default the status page output is formatted as text/plain. Passing either
+; 'html', 'xml' or 'json' in the query string will return the corresponding
+; output syntax. Example:
+;   http://www.foo.bar/status
+;   http://www.foo.bar/status?json
+;   http://www.foo.bar/status?html
+;   http://www.foo.bar/status?xml
+;
+; By default the status page only outputs short status. Passing 'full' in the
+; query string will also return status for each pool process.
+; Example:
+;   http://www.foo.bar/status?full
+;   http://www.foo.bar/status?json&full
+;   http://www.foo.bar/status?html&full
+;   http://www.foo.bar/status?xml&full
+; The Full status returns for each process:
+;   pid                  - the PID of the process;
+;   state                - the state of the process (Idle, Running, ...);
+;   start time           - the date and time the process has started;
+;   start since          - the number of seconds since the process has started;
+;   requests             - the number of requests the process has served;
+;   request duration     - the duration in µs of the requests;
+;   request method       - the request method (GET, POST, ...);
+;   request URI          - the request URI with the query string;
+;   content length       - the content length of the request (only with POST);
+;   user                 - the user (PHP_AUTH_USER) (or '-' if not set);
+;   script               - the main script called (or '-' if not set);
+;   last request cpu     - the %cpu the last request consumed
+;                          it's always 0 if the process is not in Idle state
+;                          because CPU calculation is done when the request
+;                          processing has terminated;
+;   last request memory  - the max amount of memory the last request consumed
+;                          it's always 0 if the process is not in Idle state
+;                          because memory calculation is done when the request
+;                          processing has terminated;
+; If the process is in Idle state, then informations are related to the
+; last request the process has served. Otherwise informations are related to
+; the current request being served.
+; Example output:
+;   ************************
+;   pid:                  31330
+;   state:                Running
+;   start time:           01/Jul/2011:17:53:49 +0200
+;   start since:          63087
+;   requests:             12808
+;   request duration:     1250261
+;   request method:       GET
+;   request URI:          /test_mem.php?N=10000
+;   content length:       0
+;   user:                 -
+;   script:               /home/fat/web/docs/php/test_mem.php
+;   last request cpu:     0.00
+;   last request memory:  0
+;
+; Note: There is a real-time FPM status monitoring sample web page available
+;       It's available in: /usr/share/php/7.0/fpm/status.html
+;
+; Note: The value must start with a leading slash (/). The value can be
+;       anything, but it may not be a good idea to use the .php extension or it
+;       may conflict with a real PHP file.
+; Default Value: not set
+;pm.status_path = /status
 
 ; The ping URI to call the monitoring page of FPM. If this value is not set, no
-; URI will be recognized as a ping page.
+; URI will be recognized as a ping page. This could be used to test from outside
-ping.path = /ping
+; that FPM is alive and responding, or to
+; - create a graph of FPM availability (rrd or such);
+; - remove a server from a group if it is not responding (load balancing);
+; - trigger alerts for the operating team (24/7).
+; Note: The value must start with a leading slash (/). The value can be
+;       anything, but it may not be a good idea to use the .php extension or it
+;       may conflict with a real PHP file.
+; Default Value: not set
+;ping.path = /ping
 
-; The timeout for serving a single request after which the worker process will
+; This directive may be used to customize the response of a ping request. The
-; be killed.
+; response is formatted as text/plain with a 200 response code.
-request_terminate_timeout = 1d
+; Default Value: pong
+;ping.response = pong
+
+; The access log file
+; Default: not set
+;access.log = log/$pool.access.log
+
+; The access log format.
+; The following syntax is allowed
+;  %%: the '%' character
+;  %C: %CPU used by the request
+;      it can accept the following format:
+;      - %{user}C for user CPU only
+;      - %{system}C for system CPU only
+;      - %{total}C  for user + system CPU (default)
+;  %d: time taken to serve the request
+;      it can accept the following format:
+;      - %{seconds}d (default)
+;      - %{miliseconds}d
+;      - %{mili}d
+;      - %{microseconds}d
+;      - %{micro}d
+;  %e: an environment variable (same as $_ENV or $_SERVER)
+;      it must be associated with embraces to specify the name of the env
+;      variable. Some exemples:
+;      - server specifics like: %{REQUEST_METHOD}e or %{SERVER_PROTOCOL}e
+;      - HTTP headers like: %{HTTP_HOST}e or %{HTTP_USER_AGENT}e
+;  %f: script filename
+;  %l: content-length of the request (for POST request only)
+;  %m: request method
+;  %M: peak of memory allocated by PHP
+;      it can accept the following format:
+;      - %{bytes}M (default)
+;      - %{kilobytes}M
+;      - %{kilo}M
+;      - %{megabytes}M
+;      - %{mega}M
+;  %n: pool name
+;  %o: output header
+;      it must be associated with embraces to specify the name of the header:
+;      - %{Content-Type}o
+;      - %{X-Powered-By}o
+;      - %{Transfert-Encoding}o
+;      - ....
+;  %p: PID of the child that serviced the request
+;  %P: PID of the parent of the child that serviced the request
+;  %q: the query string
+;  %Q: the '?' character if query string exists
+;  %r: the request URI (without the query string, see %q and %Q)
+;  %R: remote IP address
+;  %s: status (response code)
+;  %t: server time the request was received
+;      it can accept a strftime(3) format:
+;      %d/%b/%Y:%H:%M:%S %z (default)
+;      The strftime(3) format must be encapsuled in a %{<strftime_format>}t tag
+;      e.g. for a ISO8601 formatted timestring, use: %{%Y-%m-%dT%H:%M:%S%z}t
+;  %T: time the log has been written (the request has finished)
+;      it can accept a strftime(3) format:
+;      %d/%b/%Y:%H:%M:%S %z (default)
+;      The strftime(3) format must be encapsuled in a %{<strftime_format>}t tag
+;      e.g. for a ISO8601 formatted timestring, use: %{%Y-%m-%dT%H:%M:%S%z}t
+;  %u: remote user
+;
+; Default: "%R - %u %t \"%m %r\" %s"
+;access.format = "%R - %u %t \"%m %r%Q%q\" %s %f %{mili}d %{kilo}M %C%%"
+
+; The log file for slow requests
+; Default Value: not set
+; Note: slowlog is mandatory if request_slowlog_timeout is set
+;slowlog = log/$pool.log.slow
 
 ; The timeout for serving a single request after which a PHP backtrace will be
 ; dumped to the 'slowlog' file. A value of '0s' means 'off'.
-request_slowlog_timeout = 5s
+; Available units: s(econds)(default), m(inutes), h(ours), or d(ays)
+; Default Value: 0
+;request_slowlog_timeout = 0
 
-; The log file for slow requests.
+; The timeout for serving a single request after which the worker process will
-slowlog = /var/log/nginx/__NAMETOCHANGE__.slow.log
+; be killed. This option should be used when the 'max_execution_time' ini option
+; does not stop script execution for some reason. A value of '0' means 'off'.
+; Available units: s(econds)(default), m(inutes), h(ours), or d(ays)
+; Default Value: 0
+request_terminate_timeout = 1d
 
 ; Set open file descriptor rlimit.
-rlimit_files = 4096
+; Default Value: system defined value
+;rlimit_files = 1024
 
 ; Set max core size rlimit.
-rlimit_core = 0
+; Possible Values: 'unlimited' or an integer greater or equal to 0
+; Default Value: system defined value
+;rlimit_core = 0
+
+; Chroot to this directory at the start. This value must be defined as an
+; absolute path. When this value is not set, chroot is not used.
+; Note: you can prefix with '$prefix' to chroot to the pool prefix or one
+; of its subdirectories. If the pool prefix is not set, the global prefix
+; will be used instead.
+; Note: chrooting is a great security feature and should be used whenever
+;       possible. However, all PHP paths will be relative to the chroot
+;       (error_log, sessions.save_path, ...).
+; Default Value: not set
+;chroot =
 
 ; Chdir to this directory at the start.
+; Note: relative path can be used.
+; Default Value: current directory or / when chroot
 chdir = __FINALPATH__
 
-; Redirect worker stdout and stderr into main error log.
+; Redirect worker stdout and stderr into main error log. If not set, stdout and
-catch_workers_output = yes
+; stderr will be redirected to /dev/null according to FastCGI specs.
+; Note: on highloaded environement, this can cause some delay in the page
+; process time (several ms).
+; Default Value: no
+;catch_workers_output = yes
 
-; Do not clear environment in FPM workers.
+; Clear environment in FPM workers
-clear_env = no
+; Prevents arbitrary environment variables from reaching FPM worker processes
+; by clearing the environment in workers before env vars specified in this
+; pool configuration are added.
+; Setting to "no" will make all environment variables available to PHP code
+; via getenv(), $_ENV and $_SERVER.
+; Default Value: yes
+;clear_env = no
 
-; Additional php.ini defines, specific to this pool of workers.
+; Limits the extensions of the main script FPM will allow to parse. This can
-; ...
+; prevent configuration mistakes on the web server side. You should only limit
+; FPM to .php extensions to prevent malicious users to use other extensions to
+; execute php code.
+; Note: set an empty value to allow all extensions.
+; Default Value: .php
+;security.limit_extensions = .php .php3 .php4 .php5 .php7
+
+; Pass environment variables like LD_LIBRARY_PATH. All $VARIABLEs are taken from
+; the current environment.
+; Default Value: clean env
+;env[HOSTNAME] = $HOSTNAME
+;env[PATH] = /usr/local/bin:/usr/bin:/bin
+;env[TMP] = /tmp
+;env[TMPDIR] = /tmp
+;env[TEMP] = /tmp
+
+; Additional php.ini defines, specific to this pool of workers. These settings
+; overwrite the values previously defined in the php.ini. The directives are the
+; same as the PHP SAPI:
+;   php_value/php_flag             - you can set classic ini defines which can
+;                                    be overwritten from PHP call 'ini_set'.
+;   php_admin_value/php_admin_flag - these directives won't be overwritten by
+;                                     PHP call 'ini_set'
+; For php_*flag, valid values are on, off, 1, 0, true, false, yes or no.
+
+; Defining 'extension' will load the corresponding shared extension from
+; extension_dir. Defining 'disable_functions' or 'disable_classes' will not
+; overwrite previously defined php.ini values, but will append the new value
+; instead.
+
+; Note: path INI options can be relative and will be expanded with the prefix
+; (pool, global or /usr)
+
+; Default Value: nothing is defined by default except the values in php.ini and
+;                specified at startup with the -d argument
+;php_admin_value[sendmail_path] = /usr/sbin/sendmail -t -i -f www@my.domain.com
+;php_flag[display_errors] = off
+;php_admin_value[error_log] = /var/log/fpm-php.www.log
+;php_admin_flag[log_errors] = on
+;php_admin_value[memory_limit] = 32M
+
+; Common values to change to increase file upload limit
+; php_admin_value[upload_max_filesize] = 50M
+; php_admin_value[post_max_size] = 50M
+; php_admin_flag[mail.add_x_header] = Off
+
+; Other common parameters
+; php_admin_value[max_execution_time] = 600
+; php_admin_value[max_input_time] = 300
+; php_admin_value[memory_limit] = 256M
+; php_admin_flag[short_open_tag] = On

manifest.json

@@ -6,22 +6,22 @@
         "en": "Lightweight CalDAV+CardDAV server",
         "fr": "Serveur CalDAV+CardDAV léger"
     },
+    "version": "0.4.6~ynh1",
     "url": "http://baikal-server.com/",
     "license": "GPL-3.0",
-    "version": "0.4.6",
     "maintainer": {
         "name": "julien",
         "email": "julien.malik@paraiso.me"
     },
+    "requirements": {
+        "yunohost": ">= 3.2.0"
+    },
     "multi_instance": false,
     "services": [
         "nginx",
-        "php5-fpm",
+        "php7.0-fpm",
         "mysql"
     ],
-    "requirements": {
-        "yunohost": ">= 2.7.2"
-    },
     "arguments": {
         "install" : [
             {

pull_request_template.md

@@ -0,0 +1,24 @@
+## Problem
+- *Description of why you made this PR*
+
+## Solution
+- *And how you fix that*
+
+## PR Status
+- [ ] Code finished.
+- [ ] Tested with Package_check.
+- [ ] Fix or enhancement tested.
+- [ ] Upgrade from last version tested.
+- [ ] Can be reviewed and tested.
+
+## Validation
+---
+*Minor decision*
+- **Upgrade previous version** : 
+- [ ] **Code review** : 
+- [ ] **Approval (LGTM)** : 
+- [ ] **Approval (LGTM)** : 
+- **CI succeeded** : 
+[![Build Status](https://ci-apps-dev.yunohost.org/jenkins/job/baikal_ynh%20PR-NUM-/badge/icon)](https://ci-apps-dev.yunohost.org/jenkins/job/baikal_ynh%20PR-NUM-/)  
+*Please replace '-NUM-' in this link by the PR number.*  
+When the PR is marked as ready to merge, you have to wait for 3 days before really merging it.

scripts/backup

@@ -2,58 +2,63 @@
 
 #=================================================
 # GENERIC START
-#=================================================
-# MANAGE SCRIPT FAILURE
-#=================================================
-
-# Exit on command errors and treat access to unset variables as an error
-set -eu
-
 #=================================================
 # IMPORT GENERIC HELPERS
 #=================================================
 
-#if [ ! -e _common.sh ]; then
+# source ../settings/scripts/_common.sh
-#	# Get the _common.sh file if it's not in the current directory
-#	cp ../settings/scripts/_common.sh ./_common.sh
-#	chmod a+rx _common.sh
-#fi
-#source _common.sh
 source /usr/share/yunohost/helpers
 
+#=================================================
+# MANAGE SCRIPT FAILURE
+#=================================================
+
+# Exit if an error occurs during the execution of the script
+ynh_abort_if_errors
+
 #=================================================
 # LOAD SETTINGS
 #=================================================
+ynh_print_info "Loading installation settings..."
 
 app=$YNH_APP_INSTANCE_NAME
 
 final_path=$(ynh_app_setting_get $app final_path)
 domain=$(ynh_app_setting_get $app domain)
 db_name=$(ynh_app_setting_get $app db_name)
-db_pwd=$(ynh_app_setting_get $app mysqlpwd)
 
 #=================================================
 # STANDARD BACKUP STEPS
 #=================================================
 # BACKUP THE APP MAIN DIR
 #=================================================
+ynh_print_info "Backing up the main app directory..."
 
 ynh_backup "$final_path"
 
 #=================================================
 # BACKUP THE NGINX CONFIGURATION
 #=================================================
+ynh_print_info "Backing up nginx web server configuration..."
 
 ynh_backup "/etc/nginx/conf.d/$domain.d/$app.conf"
 
 #=================================================
 # BACKUP THE PHP-FPM CONFIGURATION
 #=================================================
+ynh_print_info "Backing up php-fpm configuration..."
 
-ynh_backup "/etc/php5/fpm/pool.d/$app.conf"
+ynh_backup "/etc/php/7.0/fpm/pool.d/$app.conf"
 
 #=================================================
 # BACKUP THE MYSQL DATABASE
 #=================================================
+ynh_print_info "Backing up the MySQL database..."
 
 ynh_mysql_dump_db "$db_name" > db.sql
+
+#=================================================
+# END OF SCRIPT
+#=================================================
+
+ynh_print_info "Backup script completed for $app. (YunoHost will then actually copy those files to the archive)."

scripts/install

@@ -29,21 +29,21 @@ app=$YNH_APP_INSTANCE_NAME
 #=================================================
 # CHECK IF THE APP CAN BE INSTALLED WITH THESE ARGS
 #=================================================
-
+ynh_print_info "Validating installation parameters..."
-# Normalize the url path syntax
-path_url=$(ynh_normalize_url_path $path_url)
 
 final_path=/var/www/$app
 test ! -e "$final_path" || ynh_die "This path already contains a folder"
 
-# Check web path availability
+# Normalize the url path syntax
-ynh_webpath_available $domain $path_url
+path_url=$(ynh_normalize_url_path $path_url)
+
 # Register (book) web path
 ynh_webpath_register $app $domain $path_url
 
 #=================================================
 # STORE SETTINGS FROM MANIFEST
 #=================================================
+ynh_print_info "Storing installation settings..."
 
 ynh_app_setting_set $app domain $domain
 ynh_app_setting_set $app path $path_url
@@ -53,6 +53,7 @@ ynh_app_setting_set $app path $path_url
 #=================================================
 # CREATE A MYSQL DATABASE
 #=================================================
+ynh_print_info "Creating a MySQL database..."
 
 db_name=$(ynh_sanitize_dbid $app)
 ynh_app_setting_set $app db_name $db_name
@@ -61,6 +62,7 @@ ynh_mysql_setup_db $db_name $db_name
 #=================================================
 # DOWNLOAD, CHECK AND UNPACK SOURCE
 #=================================================
+ynh_print_info "Setting up source files..."
 
 ynh_app_setting_set $app final_path $final_path
 # Download, check integrity, uncompress and patch the source from app.src
@@ -69,6 +71,7 @@ ynh_setup_source "$final_path"
 #=================================================
 # NGINX CONFIGURATION
 #=================================================
+ynh_print_info "Configuring nginx web server..."
 
 # Create a dedicated nginx config
 ynh_add_nginx_config
@@ -76,6 +79,7 @@ ynh_add_nginx_config
 #=================================================
 # CREATE DEDICATED USER
 #=================================================
+ynh_print_info "Configuring system user..."
 
 # Create a system user
 ynh_system_user_create $app
@@ -83,6 +87,7 @@ ynh_system_user_create $app
 #=================================================
 # PHP-FPM CONFIGURATION
 #=================================================
+ynh_print_info "Configuring php-fpm..."
 
 # Create a dedicated php-fpm config
 ynh_add_fpm_config
@@ -92,6 +97,7 @@ ynh_add_fpm_config
 #=================================================
 # INITIALIZE DATABASE
 #=================================================
+ynh_print_info "Configuring baikal..."
 
 ynh_mysql_connect_as "$db_name" "$db_pwd" "$db_name" \
     < "${final_path}/Core/Resources/Db/MySQL/db.sql"
@@ -103,10 +109,10 @@ ynh_mysql_connect_as "$db_name" "$db_pwd" "$db_name" \
 bk_conf="${final_path}/Specific/config.php"
 cp ../conf/config.php "$bk_conf"
 
-ynh_replace_string "#TIMEZONE#" "$(cat /etc/timezone)" "$bk_conf"
+ynh_replace_string "__TIMEZONE__" "$(cat /etc/timezone)" "$bk_conf"
 # Create admin password hash
 password_hash=$(echo -n admin:BaikalDAV:$password | md5sum | cut -d ' ' -f 1)
-ynh_replace_string "#PASSWORDHASH#" "${password_hash}" "$bk_conf"
+ynh_replace_string "__PASSWORDHASH__" "${password_hash}" "$bk_conf"
 ynh_app_setting_set $app password_hash $password_hash
 
 # Store the config file checksum into the app settings
@@ -114,14 +120,15 @@ ynh_store_file_checksum "$bk_conf"
 
 bk_conf="${final_path}/Specific/config.system.php"
 cp ../conf/config.system.php "$bk_conf"
-ynh_replace_string "#PATH#" "$path_url" "$bk_conf"
+
-ynh_replace_string "#DBNAME#" "$db_name" "$bk_conf"
+ynh_replace_string "__PATH__" "$path_url" "$bk_conf"
-ynh_replace_string "#DBUSER#" "$db_name" "$bk_conf"
+ynh_replace_string "__DBNAME__" "$db_name" "$bk_conf"
-ynh_replace_string "#DBPASS#" "$db_pwd" "$bk_conf"
+ynh_replace_string "__DBUSER__" "$db_name" "$bk_conf"
+ynh_replace_string "__DBPASS__" "$db_pwd" "$bk_conf"
 
 deskey=$(ynh_string_random 24)
-ynh_app_setting_set "$app" encrypt_key "$deskey"
+ynh_app_setting_set $app encrypt_key "$deskey"
-ynh_replace_string "#DESKEY#" "$deskey" "$bk_conf"
+ynh_replace_string "__DESKEY__" "$deskey" "$bk_conf"
 
 # Store the config file checksum into the app settings
 ynh_store_file_checksum "$bk_conf"
@@ -143,14 +150,22 @@ chmod 640 "$final_path/Specific/"{config.php,config.system.php}
 #=================================================
 # SETUP SSOWAT
 #=================================================
+ynh_print_info "Configuring SSOwat..."
 
 # Allow public access on /
-ynh_app_setting_set "$app" skipped_uris "/"
+ynh_app_setting_set $app skipped_uris "/"
 # But restrain on /admin
-ynh_app_setting_set "$app" protected_uris "/admin/"
+ynh_app_setting_set $app protected_uris "/admin/"
 
 #=================================================
 # RELOAD NGINX
 #=================================================
+ynh_print_info "Reloading nginx web server..."
 
 systemctl reload nginx
+
+#=================================================
+# END OF SCRIPT
+#=================================================
+
+ynh_print_info "Installation of $app completed"

scripts/remove

@@ -6,18 +6,13 @@
 # IMPORT GENERIC HELPERS
 #=================================================
 
-#if [ ! -e _common.sh ]; then
-#	# Get file fonction if not been to the current directory
-#	sudo cp ../settings/scripts/_common.sh ./_common.sh
-#	sudo chmod a+rx _common.sh
-#fi
-# Source app helpers
 # source _common.sh
 source /usr/share/yunohost/helpers
 
 #=================================================
 # LOAD SETTINGS
 #=================================================
+ynh_print_info "Loading installation settings..."
 
 app=$YNH_APP_INSTANCE_NAME
 
@@ -30,6 +25,7 @@ final_path=$(ynh_app_setting_get $app final_path)
 #=================================================
 # REMOVE THE MYSQL DATABASE
 #=================================================
+ynh_print_info "Removing the MySQL database"
 
 # Remove a database if it exists, along with the associated user
 ynh_mysql_remove_db $db_name $db_name
@@ -37,6 +33,7 @@ ynh_mysql_remove_db $db_name $db_name
 #=================================================
 # REMOVE APP MAIN DIR
 #=================================================
+ynh_print_info "Removing app main directory"
 
 # Remove the app directory securely
 ynh_secure_remove "$final_path"
@@ -44,6 +41,7 @@ ynh_secure_remove "$final_path"
 #=================================================
 # REMOVE NGINX CONFIGURATION
 #=================================================
+ynh_print_info "Removing nginx web server configuration"
 
 # Remove the dedicated nginx config
 ynh_remove_nginx_config
@@ -51,6 +49,7 @@ ynh_remove_nginx_config
 #=================================================
 # REMOVE PHP-FPM CONFIGURATION
 #=================================================
+ynh_print_info "Removing php-fpm configuration"
 
 # Remove the dedicated php-fpm config
 ynh_remove_fpm_config
@@ -60,6 +59,13 @@ ynh_remove_fpm_config
 #=================================================
 # REMOVE DEDICATED USER
 #=================================================
+ynh_print_info "Removing the dedicated system user"
 
 # Delete a system user
 ynh_system_user_delete $app
+
+#=================================================
+# END OF SCRIPT
+#=================================================
+
+ynh_print_info "Removal of $app completed"

scripts/restore

@@ -2,28 +2,24 @@
 
 #=================================================
 # GENERIC START
-#=================================================
-# MANAGE SCRIPT FAILURE
-#=================================================
-
-# Exit on command errors and treat access to unset variables as an error
-set -eu
-
 #=================================================
 # IMPORT GENERIC HELPERS
 #=================================================
 
-#if [ ! -e _common.sh ]; then
+# source ../settings/scripts/_common.sh
-#	# Get the _common.sh file if it's not in the current directory
-#	cp ../settings/scripts/_common.sh ./_common.sh
-#	chmod a+rx _common.sh
-#fi
-#source _common.sh
 source /usr/share/yunohost/helpers
 
+#=================================================
+# MANAGE SCRIPT FAILURE
+#=================================================
+
+# Exit if an error occurs during the execution of the script
+ynh_abort_if_errors
+
 #=================================================
 # LOAD SETTINGS
 #=================================================
+ynh_print_info "Loading settings..."
 
 app=$YNH_APP_INSTANCE_NAME
 
@@ -35,6 +31,7 @@ db_name=$(ynh_app_setting_get $app db_name)
 #=================================================
 # CHECK IF THE APP CAN BE RESTORED
 #=================================================
+ynh_print_info "Validating restoration parameters..."
 
 ynh_webpath_available $domain $path_url \
 	|| ynh_die "Path not available: ${domain}${path_url}"
@@ -52,12 +49,14 @@ ynh_restore_file "/etc/nginx/conf.d/$domain.d/$app.conf"
 #=================================================
 # RESTORE THE APP MAIN DIR
 #=================================================
+ynh_print_info "Restoring the app main directory..."
 
 ynh_restore_file "$final_path"
 
 #=================================================
 # RESTORE THE MYSQL DATABASE
 #=================================================
+ynh_print_info "Restoring the MySQL database..."
 
 db_pwd=$(ynh_app_setting_get $app mysqlpwd)
 ynh_mysql_setup_db $db_name $db_name $db_pwd
@@ -66,6 +65,7 @@ ynh_mysql_connect_as $db_name $db_pwd $db_name < ./db.sql
 #=================================================
 # RECREATE THE DEDICATED USER
 #=================================================
+ynh_print_info "Recreating the dedicated system user..."
 
 # Create the dedicated user (if not existing)
 ynh_system_user_create $app
@@ -82,13 +82,20 @@ chown $app "$final_path/Specific/"{config.php,config.system.php}
 # RESTORE THE PHP-FPM CONFIGURATION
 #=================================================
 
-ynh_restore_file "/etc/php5/fpm/pool.d/$app.conf"
+ynh_restore_file "/etc/php/7.0/fpm/pool.d/$app.conf"
 
 #=================================================
 # GENERIC FINALIZATION
 #=================================================
 # RELOAD NGINX AND PHP-FPM
 #=================================================
+ynh_print_info "Reloading nginx web server and php-fpm..."
 
-systemctl reload php5-fpm
+systemctl reload php7.0-fpm
 systemctl reload nginx
+
+#=================================================
+# END OF SCRIPT
+#=================================================
+
+ynh_print_info "Restoration completed for $app"

scripts/upgrade

@@ -12,6 +12,7 @@ source /usr/share/yunohost/helpers
 #=================================================
 # LOAD SETTINGS
 #=================================================
+ynh_print_info "Loading installation settings..."
 
 app=$YNH_APP_INSTANCE_NAME
 
@@ -23,13 +24,16 @@ db_name=$(ynh_app_setting_get $app db_name)
 #=================================================
 # ENSURE DOWNWARD COMPATIBILITY
 #=================================================
+ynh_print_info "Ensuring downward compatibility..."
 
-if [ -z $final_path ]; then	# If final_path doesn't exist, create it
+# If final_path doesn't exist, create it
-	final_path="/var/www/$app"
+if [ -z $final_path ]; then
+	final_path=/var/www/$app
 	ynh_app_setting_set $app final_path $final_path
 fi
 
-if [ -z $db_name ]; then	# If db_name doesn't exist, create it
+# If db_name doesn't exist, create it
+if [ -z $db_name ]; then
 	db_name=$(ynh_sanitize_dbid $app)
 	ynh_app_setting_set $app db_name $db_name
 fi
@@ -37,12 +41,16 @@ fi
 #=================================================
 # BACKUP BEFORE UPGRADE THEN ACTIVE TRAP
 #=================================================
+ynh_print_info "Backing up the app before upgrading (may take a while)..."
 
-ynh_backup_before_upgrade	# Backup the current version of the app
+# Backup the current version of the app
+ynh_backup_before_upgrade
 ynh_clean_setup () {
-	ynh_restore_upgradebackup	# restore it if the upgrade fails
+	# restore it if the upgrade fails
+	ynh_restore_upgradebackup
 }
-ynh_abort_if_errors	# Active trap pour arrêter le script si une erreur est détectée.
+# Exit if an error occurs during the execution of the script
+ynh_abort_if_errors
 
 #=================================================
 # CHECK THE PATH
@@ -56,6 +64,7 @@ path_url=$(ynh_normalize_url_path $path_url)
 #=================================================
 # DOWNLOAD, CHECK AND UNPACK SOURCE
 #=================================================
+ynh_print_info "Upgrading source files..."
 
 # Download, check integrity, uncompress and patch the source from app.src
 ynh_setup_source "$final_path"
@@ -63,6 +72,7 @@ ynh_setup_source "$final_path"
 #=================================================
 # NGINX CONFIGURATION
 #=================================================
+ynh_print_info "Upgrading nginx web server configuration..."
 
 # Create a dedicated nginx config
 ynh_add_nginx_config
@@ -70,13 +80,15 @@ ynh_add_nginx_config
 #=================================================
 # CREATE DEDICATED USER
 #=================================================
+ynh_print_info "Making sure dedicated system user exists..."
 
-# Create a system user
+# Create a dedicated user (if not existing)
 ynh_system_user_create $app
 
 #=================================================
 # PHP-FPM CONFIGURATION
 #=================================================
+ynh_print_info "Upgrading php-fpm configuration..."
 
 # Create a dedicated php-fpm config
 ynh_add_fpm_config
@@ -86,24 +98,28 @@ ynh_add_fpm_config
 #=================================================
 # UPGRADE BAIKAL
 #=================================================
+ynh_print_info "Upgrading baikal..."
 
 # Run Baikal upgrade
 php "${final_path}/bin/upgrade.sh"
 
 # Cleanup old baikal-admin sessions
 # since we may have changed owner of the session file
-grep -lr "CSRF_TOKEN|s:" /var/lib/php5/sessions | xargs rm -f
+grep --files-with-matches --recursive "CSRF_TOKEN|s:" /var/lib/php/sessions | xargs rm -f
 
 #=================================================
 # UPGRADE BAIKAL CONFIGURATION
 #=================================================
+ynh_print_info "Upgrading baikal configuration..."
 
 bk_conf="${final_path}/Specific/config.php"
+
 # Verify the checksum and backup the file if it's different
 ynh_backup_if_checksum_is_different "$bk_conf"
+
 cp ../conf/config.php "$bk_conf"
 
-ynh_replace_string "#TIMEZONE#" "$(cat /etc/timezone)" "$bk_conf"
+ynh_replace_string "__TIMEZONE__" "$(cat /etc/timezone)" "$bk_conf"
 
 password_hash=$(ynh_app_setting_get $app password_hash)
 # If the password_hash is not in the app's config, recreate it from the password.
@@ -112,24 +128,26 @@ if [ -z "$password_hash" ]; then
     password_hash=$(echo -n admin:BaikalDAV:$password | md5sum | cut -d ' ' -f 1)
     ynh_app_setting_set $app password_hash $password_hash
 fi
-ynh_replace_string "#PASSWORDHASH#" "${password_hash}" "$bk_conf"
+ynh_replace_string "__PASSWORDHASH__" "${password_hash}" "$bk_conf"
 
 # Store the config file checksum into the app settings
 ynh_store_file_checksum "$bk_conf"
 
 bk_conf="${final_path}/Specific/config.system.php"
+
 # Verify the checksum and backup the file if it's different
 ynh_backup_if_checksum_is_different "$bk_conf"
+
 cp ../conf/config.system.php "$bk_conf"
 
-ynh_replace_string "#PATH#" "$path_url" "$bk_conf"
+ynh_replace_string "__PATH__" "$path_url" "$bk_conf"
-ynh_replace_string "#DBNAME#" "$db_name" "$bk_conf"
+ynh_replace_string "__DBNAME__" "$db_name" "$bk_conf"
-ynh_replace_string "#DBUSER#" "$db_name" "$bk_conf"
+ynh_replace_string "__DBUSER__" "$db_name" "$bk_conf"
 db_pwd=$(ynh_app_setting_get $app mysqlpwd)
-ynh_replace_string "#DBPASS#" "$db_pwd" "$bk_conf"
+ynh_replace_string "__DBPASS__" "$db_pwd" "$bk_conf"
 
 deskey=$(ynh_app_setting_get $app deskey)
-ynh_replace_string "#DESKEY#" "$deskey" "$bk_conf"
+ynh_replace_string "__DESKEY__" "$deskey" "$bk_conf"
 
 # Store the config file checksum into the app settings
 ynh_store_file_checksum "$bk_conf"
@@ -148,14 +166,22 @@ chmod 640 "$final_path/Specific/"{config.php,config.system.php}
 #=================================================
 # SETUP SSOWAT
 #=================================================
+ynh_print_info "Upgrading SSOwat configuration..."
 
 # Allow public access on /
-ynh_app_setting_set "$app" skipped_uris "/"
+ynh_app_setting_set $app skipped_uris "/"
 # But restrain on /admin
-ynh_app_setting_set "$app" protected_uris "/admin/"
+ynh_app_setting_set $app protected_uris "/admin/"
 
 #=================================================
 # RELOAD NGINX
 #=================================================
+ynh_print_info "Reloading nginx web server..."
 
 systemctl reload nginx
+
+#=================================================
+# END OF SCRIPT
+#=================================================
+
+ynh_print_info "Upgrade of $app completed"