diff --git a/README.md b/README.md index 68c7215..e4f9df4 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,66 @@ -AgenDAV for YunoHost --------------------- +# AgenDAV for YunoHost + +[![Integration level](https://dash.yunohost.org/integration/agendav.svg)](https://dash.yunohost.org/appci/app/agendav) +[![Install AgenDAV with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=agendav) + +> *This package allow you to install AgenDAV 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 [AgenDAV](http://agendav.org/) is a CalDAV web client which features an AJAX interface to allow users to manage their own calendars and shared ones. **Shipped version:** 2.0.0 +## Screenshots + ![](http://agendav.org/img/screenshots/2.0.0-beta1/001_month_view.png) -## TODO +## Demo + +* [YunoHost demo](https://demo.yunohost.org/agendav/) + +## Configuration + +## Documentation + + * Official documentation: http://docs.agendav.org/en/2.2.0/ + * YunoHost documentation: If specific documentation is needed, feel free to contribute. + +## YunoHost specific features + +#### Supported architectures + +* x86-64b - [![Build Status](https://ci-apps.yunohost.org/ci/logs/agendav%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/agendav/) +* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/agendav%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/agendav/) +* Jessie x86-64b - [![Build Status](https://ci-stretch.nohost.me/ci/logs/agendav%20%28Apps%29.svg)](https://ci-stretch.nohost.me/ci/apps/agendav/) + +## Limitations + +## Additional information + +### TODO * Submit HTTP auth patch for upstream integration ## Links + * Report a bug: https://github.com/YunoHost-Apps/agendav_ynh/issues * AgenDAV website: http://agendav.org/ + * AgenDAV repository: https://github.com/agendav/agendav/ * YunoHost website: https://yunohost.org/ + +--- + +Developers info +---------------- + +Please do your pull request to the [testing branch](https://github.com/YunoHost-Apps/agendav_ynh/tree/testing). + +To try the testing branch, please proceed like that. +``` +sudo yunohost app install https://github.com/YunoHost-Apps/agendav_ynh/tree/testing --debug +or +sudo yunohost app upgrade agendav -u https://github.com/YunoHost-Apps/agendav_ynh/tree/testing --debug +``` diff --git a/check_process b/check_process index b988cb6..f34dfda 100644 --- a/check_process +++ b/check_process @@ -3,7 +3,7 @@ ; Manifest domain="domain.tld" (DOMAIN) path="/path" (PATH) - language="fr" + language="en" ; pre-install sudo yunohost app fetchlist sudo yunohost domain add baikaldomain.tld --admin-password $PASSWORD @@ -16,19 +16,18 @@ setup_private=1 setup_public=0 upgrade=1 + upgrade=1 from_commit=1783f57896e46ed8b117f2748340c02d37b2a014 backup_restore=1 multi_instance=0 incorrect_path=1 port_already_use=0 - change_url=0 + change_url=1 ;;; Levels - Level 1=auto - Level 2=auto - Level 3=auto - Level 4=1 Level 5=auto - Level 6=auto - Level 7=auto - Level 8=0 - Level 9=0 - Level 10=0 +;;; Options +Email= +Notification=none +;;; Upgrade options + ; commit=1783f57896e46ed8b117f2748340c02d37b2a014 + name= Fix installation on root - Sep 10, 2018 + manifest_arg=domain=DOMAIN&path=PATH&language=en& diff --git a/conf/app.src b/conf/app.src index b3de28a..8db6750 100644 --- a/conf/app.src +++ b/conf/app.src @@ -2,3 +2,5 @@ SOURCE_URL=https://github.com/adobo/agendav/releases/download/2.2.0/agendav-2.2. SOURCE_SUM=0056154ae0a7aa3401f4f24c51f0f2de3d1e97eaa83e74a2129714b67013129f SOURCE_SUM_PRG=sha256sum SOURCE_FORMAT=tar.gz +SOURCE_IN_SUBDIR=true +SOURCE_FILENAME= diff --git a/conf/nginx.conf b/conf/nginx.conf index 45c14cd..b2b2b39 100644 --- a/conf/nginx.conf +++ b/conf/nginx.conf @@ -1,29 +1,24 @@ #sub_path_only rewrite ^__PATH__$ __PATH__/ permanent; location __PATH__/ { - alias __FINALPATH__/web/public/; - index index.php; + # Path to source + alias __FINALPATH__/web/public/ ; + + # Force usage of https if ($scheme = http) { - rewrite ^ https://$server_name$request_uri? permanent; + rewrite ^ https://$server_name$request_uri? permanent; } + index index.php; + # The seemingly weird syntax is due to a long-standing bug in nginx, # see: https://trac.nginx.org/nginx/ticket/97 try_files $uri __PATH__/__PATH__/index.php$is_args$args; - # Another alternative to the weird try_files is to use a rewrite, like this : - # - # if (-f $request_filename) { - # break; - # } - # rewrite (.*) {LOCATION}/index.php$request_uri; - # - # But remember that if-is-evil : - # https://www.nginx.com/resources/wiki/start/topics/tutorials/config_pitfalls/#check-if-file-exists - location ~ ^__PATH__/index\.php(/|$) { fastcgi_split_path_info ^(.+?\.php)(/.*)$; - fastcgi_pass unix:/var/run/php5-fpm-__NAME__.sock; + fastcgi_pass unix:/var/run/php/php7.0-fpm-__NAME__.sock; + fastcgi_index index.php; include fastcgi_params; fastcgi_param REMOTE_USER $remote_user; diff --git a/conf/php-fpm.conf b/conf/php-fpm.conf index 3e23b7b..1094c6c 100644 --- a/conf/php-fpm.conf +++ b/conf/php-fpm.conf @@ -1,68 +1,422 @@ +; 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. -listen.owner = www-data -listen.group = www-data -listen.mode = 0600 +; Per pool prefix +; It only applies on the following directives: +; - 'access.log' +; - '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; +; 'port' - to listen on a TCP socket to all addresses 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. -pm.status_path = /fpm-status - +; recognized as a status page. It shows the following informations: +; 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. -ping.path = /ping +; URI will be recognized as a ping page. This could be used to test from outside +; 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 -; be killed. -request_terminate_timeout = 1d +; This directive may be used to customize the response of a ping request. The +; response is formatted as text/plain with a 200 response code. +; 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 %{}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 %{}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. -slowlog = /var/log/nginx/__NAMETOCHANGE__.slow.log +; The timeout for serving a single request after which the worker process will +; 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. If not set, stdout and +; 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 -; Redirect worker stdout and stderr into main error log. -catch_workers_output = yes +; Clear environment in FPM workers +; 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 -; Do not clear environment in FPM workers. -clear_env = no +; 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 -; Additional php.ini defines, specific to this pool of workers. -; ... +; 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 diff --git a/conf/settings.php b/conf/settings.php index 0dbbe83..9173926 100644 --- a/conf/settings.php +++ b/conf/settings.php @@ -20,21 +20,21 @@ $app['proxies'] = []; // Database settings $app['db.options'] = [ - 'dbname' => '{DBNAME}', - 'user' => '{DBUSER}', - 'password' => '{DBPASS}', + 'dbname' => '__DBNAME__', + 'user' => '__DBUSER__', + 'password' => '__DBPASS__', 'host' => 'localhost', 'driver' => 'pdo_mysql' ]; // CSRF secret -$app['csrf.secret'] = '{ENCRYPTKEY}'; +$app['csrf.secret'] = '__ENCRYPTKEY__'; // Log path -$app['log.path'] = '{LOGDIR}/'; +$app['log.path'] = '__LOGDIR__/'; // Base URL -$app['caldav.baseurl'] = '{CALDAV_BASEURL}'; +$app['caldav.baseurl'] = '__CALDAV_BASEURL__'; // Authentication method required by CalDAV server (basic or digest) $app['caldav.authmethod'] = 'basic'; @@ -46,7 +46,7 @@ $app['caldav.certificate.verify'] = false; $app['caldav.publicurls'] = true; // Whether to show public CalDAV urls -$app['caldav.baseurl.public'] = 'https://{CALDAV_DOMAIN}'; +$app['caldav.baseurl.public'] = 'https://__CALDAV_DOMAIN__'; // Email attribute name $app['principal.email.attribute'] = '{DAV:}email'; @@ -64,10 +64,10 @@ $app['calendar.sharing.permissions'] = [ ]; // Default timezone -$app['defaults.timezone'] = '{TIMEZONE}'; +$app['defaults.timezone'] = '__TIMEZONE__'; -// Default languajge -$app['defaults.language'] = '{LANGUAGE}'; +// Default language +$app['defaults.language'] = '__LANGUAGE__'; // Default time format. Options: '12' / '24' $app['defaults.time_format'] = '24'; diff --git a/manifest.json b/manifest.json index 27c7197..f1e2113 100644 --- a/manifest.json +++ b/manifest.json @@ -8,18 +8,18 @@ }, "url": "http://agendav.org/", "license": "GPL-3.0", - "version": "2.0.0", + "version": "2.0.0~ynh1", "maintainer": { "name": "julien", "email": "julien.malik@paraiso.me" }, "multi_instance": false, "requirements": { - "yunohost": ">= 3.0.0" + "yunohost": ">= 3.5.0" }, "services": [ "nginx", - "php5-fpm", + "php7.0-fpm", "mysql" ], "arguments": { @@ -45,12 +45,13 @@ }, { "name": "language", + "type": "string", "ask": { "en": "Default language to be used in AgenDAV", "fr": "Langue par défaut à utiliser dans AgenDAV" }, "choices": [ - "de", "en", "es", "fr", "it", "nl" + "de_DE", "en", "es_ES", "fr_FR", "it_IT", "nl_NL" ], "default": "en" } diff --git a/pull_request_template.md b/pull_request_template.md index eefb108..b7ba501 100644 --- a/pull_request_template.md +++ b/pull_request_template.md @@ -19,7 +19,6 @@ - [ ] **Approval (LGTM)** : - [ ] **Approval (LGTM)** : - **CI succeeded** : -[![Build Status](https://ci-apps-dev.yunohost.org/jenkins/job/agendav_ynh%20-BRANCH-%20(Official)/badge/icon)](https://ci-apps-dev.yunohost.org/jenkins/job/agendav_ynh%20-BRANCH-%20(Official)/) *Please replace '-BRANCH-' in this link for a PR from a local branch.* -or -[![Build Status](https://ci-apps-dev.yunohost.org/jenkins/job/agendav_ynh%20PR-NUM-%20(Official_fork)/badge/icon)](https://ci-apps-dev.yunohost.org/jenkins/job/agendav_ynh%20PR-NUM-%20(Official_fork)/) *Replace '-NUM-' by the PR number in this link for a PR from a forked repository.* +[![Build Status](https://ci-apps-hq.yunohost.org/jenkins/job/agendav_ynh%20PR-NUM-/badge/icon)](https://ci-apps-hq.yunohost.org/jenkins/job/agendav_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. diff --git a/scripts/_common.sh b/scripts/_common.sh index 65e9d26..a9bf588 100644 --- a/scripts/_common.sh +++ b/scripts/_common.sh @@ -1,22 +1 @@ #!/bin/bash -# -# Common variables -# - -# Associative array of languages -declare -A LANGUAGES=( - [nl]=nl_NL - [en]=en - [fr]=fr_FR - [de]=de_DE - [it]=it_IT - [es]=es_ES -) - -# -# Common helpers -# - -agendav_app_check_installation() { - echo $(yunohost app list --installed -f "$1" | grep "id:") -} diff --git a/scripts/backup b/scripts/backup index e190c3c..c1789f5 100644 --- a/scripts/backup +++ b/scripts/backup @@ -7,12 +7,7 @@ # IMPORT GENERIC HELPERS #================================================= -if [ ! -e _common.sh ]; then - # 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 ../settings/scripts/_common.sh source /usr/share/yunohost/helpers #================================================= @@ -25,41 +20,61 @@ ynh_abort_if_errors #================================================= # LOAD SETTINGS #================================================= +ynh_script_progression --message="Loading installation settings..." --weight=2 -# Set app specific variables app=$YNH_APP_INSTANCE_NAME -db_name=$app -# Retrieve app settings -domain=$(ynh_app_setting_get "$app" domain) -final_path=$(ynh_app_setting_get "$app" final_path) +final_path=$(ynh_app_setting_get --app=$app --key=final_path) +domain=$(ynh_app_setting_get --app=$app --key=domain) +db_name=$(ynh_app_setting_get --app=$app --key=db_name) #================================================= # STANDARD BACKUP STEPS #================================================= # BACKUP THE APP MAIN DIR #================================================= +ynh_script_progression --message="Backing up the main app directory..." # Clean cache files before backup -ynh_secure_remove "${final_path}/web/var/cache/"{profiler,twig}/* +ynh_secure_remove --file=${final_path}/web/var/cache/profiler +ynh_secure_remove --file=${final_path}/web/var/cache/twig +mkdir -p ${final_path}/web/var/cache/{profiler,twig} +chown -R $app ${final_path}/web/var/cache/{profiler,twig} -ynh_backup "$final_path" +ynh_backup --src_path="$final_path" #================================================= # BACKUP THE NGINX CONFIGURATION #================================================= +ynh_script_progression --message="Backing up nginx web server configuration..." -ynh_backup "/etc/nginx/conf.d/${domain}.d/${app}.conf" +ynh_backup --src_path="/etc/nginx/conf.d/$domain.d/$app.conf" #================================================= # BACKUP THE PHP-FPM CONFIGURATION #================================================= +ynh_script_progression --message="Backing up php-fpm configuration..." -ynh_backup "/etc/php5/fpm/pool.d/${app}.conf" +ynh_backup --src_path="/etc/php/7.0/fpm/pool.d/$app.conf" #================================================= # BACKUP THE MYSQL DATABASE #================================================= +ynh_script_progression --message="Backing up the MySQL database..." -# Dump the database -ynh_mysql_dump_db "$db_name" > db.sql +ynh_mysql_dump_db --database="$db_name" > db.sql + +#================================================= +# SPECIFIC BACKUP +#================================================= +# BACKUP LOGROTATE +#================================================= +ynh_script_progression --message="Backing up logrotate configuration..." + +ynh_backup --src_path="/etc/logrotate.d/$app" + +#================================================= +# END OF SCRIPT +#================================================= + +ynh_script_progression --message="Backup script completed for $app. (YunoHost will then actually copy those files to the archive)." --last diff --git a/scripts/change_url b/scripts/change_url new file mode 100644 index 0000000..14c221d --- /dev/null +++ b/scripts/change_url @@ -0,0 +1,92 @@ +#!/bin/bash + +#================================================= +# GENERIC STARTING +#================================================= +# IMPORT GENERIC HELPERS +#================================================= + +source _common.sh +source /usr/share/yunohost/helpers + +#================================================= +# RETRIEVE ARGUMENTS +#================================================= + +old_domain=$YNH_APP_OLD_DOMAIN +old_path=$YNH_APP_OLD_PATH + +new_domain=$YNH_APP_NEW_DOMAIN +new_path=$YNH_APP_NEW_PATH + +app=$YNH_APP_INSTANCE_NAME + +#================================================= +# LOAD SETTINGS +#================================================= +ynh_script_progression --message="Loading installation settings..." + +# Needed for helper "ynh_add_nginx_config" +final_path=$(ynh_app_setting_get --app=$app --key=final_path) + +#================================================= +# CHECK WHICH PARTS SHOULD BE CHANGED +#================================================= + +change_domain=0 +if [ "$old_domain" != "$new_domain" ] +then + change_domain=1 +fi + +change_path=0 +if [ "$old_path" != "$new_path" ] +then + change_path=1 +fi + +#================================================= +# STANDARD MODIFICATIONS +#================================================= +# MODIFY URL IN NGINX CONF +#================================================= +ynh_script_progression --message="Updating nginx web server configuration..." --weight=2 + +nginx_conf_path=/etc/nginx/conf.d/$old_domain.d/$app.conf + +# Change the path in the nginx config file +if [ $change_path -eq 1 ] +then + # Make a backup of the original nginx config file if modified + ynh_backup_if_checksum_is_different --file="$nginx_conf_path" + # Set global variables for nginx helper + domain="$old_domain" + path_url="$new_path" + # Create a dedicated nginx config + ynh_add_nginx_config +fi + +# Change the domain for nginx +if [ $change_domain -eq 1 ] +then + # Delete file checksum for the old conf file location + ynh_delete_file_checksum --file="$nginx_conf_path" + mv $nginx_conf_path /etc/nginx/conf.d/$new_domain.d/$app.conf + # Store file checksum for the new config file location + ynh_store_file_checksum --file="/etc/nginx/conf.d/$new_domain.d/$app.conf" +fi + +#================================================= +# GENERIC FINALISATION +#================================================= +# RELOAD NGINX +#================================================= +ynh_script_progression --message="Reloading nginx web server..." + +ynh_systemd_action --service_name=nginx --action=reload + +#================================================= +# END OF SCRIPT +#================================================= + +ynh_script_progression --message="Change of URL completed for $app" --last diff --git a/scripts/install b/scripts/install index 2a74f87..9b6d57f 100644 --- a/scripts/install +++ b/scripts/install @@ -24,83 +24,79 @@ domain=$YNH_APP_ARG_DOMAIN path_url=$YNH_APP_ARG_PATH language=$YNH_APP_ARG_LANGUAGE -# Set and store language -language=${LANGUAGES[$language]} - -# Set app specific variables app=$YNH_APP_INSTANCE_NAME -dbname=$app -dbuser=$app #================================================= # CHECK IF THE APP CAN BE INSTALLED WITH THESE ARGS #================================================= +ynh_script_progression --message="Validating installation parameters..." final_path=/var/www/$app -test ! -e "$final_path" || ynh_die "This path already contains a folder" +test ! -e "$final_path" || ynh_die --message="This path already contains a folder" -# Define LOGDIR (create it later when user is created) -LOGDIR=/var/log/$app -test ! -e "$LOGDIR" || ynh_die "This log path already contains a folder" - -# Normalize the url path syntax -path_url=$(ynh_normalize_url_path "$path_url") - -# Check web path availability -ynh_webpath_available "$domain" "$path_url" # Register (book) web path -ynh_webpath_register "$app" "$domain" "$path_url" +ynh_webpath_register --app=$app --domain=$domain --path_url=$path_url +agendav_app_check_installation() { + echo $(yunohost app list --installed -f "$1" | grep "id:") +} # Check whether Baïkal or Radicale is installed baikal_install=$(agendav_app_check_installation "baikal") radicale_install=$(agendav_app_check_installation "radicale") -if [[ -n "$baikal_install" ]] +if [ -n "$baikal_install" ] then - caldav_app="baikal" + caldav_app=baikal caldav_baseurl="/cal.php/" -elif [[ -n "$radicale_install" ]] +elif [ -n "$radicale_install" ] then - caldav_app="radicale" - caldav_baseurl="/" + caldav_app=radicale + caldav_baseurl=/ else - ynh_die "Baikal or Radicale is mandatory" + ynh_die --message="Please install Baikal or Radicale before AgenDAV." fi #================================================= # STORE SETTINGS FROM MANIFEST #================================================= +ynh_script_progression --message="Storing installation settings..." --weight=2 -ynh_app_setting_set "$app" language "$language" -ynh_app_setting_set "$app" path "$path_url" -ynh_app_setting_set "$app" domain "$domain" -ynh_app_setting_set "$app" final_path "$final_path" +ynh_app_setting_set --app=$app --key=domain --value=$domain +ynh_app_setting_set --app=$app --key=path --value=$path_url +ynh_app_setting_set --app=$app --key=language --value=$language #================================================= # STANDARD MODIFICATIONS #================================================= +# INSTALL DEPENDENCIES +#================================================= +ynh_script_progression --message="Installing dependencies..." --weight=8 # Install dependencies -ynh_install_app_dependencies php5-cli +ynh_install_app_dependencies php-cli #================================================= # CREATE A MYSQL DATABASE #================================================= +ynh_script_progression --message="Creating a MySQL database..." -# Initialize database -dbpass=$(ynh_string_random) - -ynh_mysql_setup_db "$dbname" "$dbuser" "$dbpass" +db_name=$(ynh_sanitize_dbid --db_name=$app) +ynh_app_setting_set --app=$app --key=db_name --value=$db_name +ynh_mysql_setup_db --db_user=$db_name --db_name=$db_name #================================================= # DOWNLOAD, CHECK AND UNPACK SOURCE #================================================= +ynh_script_progression --message="Setting up source files..." --weight=4 -ynh_setup_source "$final_path" +ynh_app_setting_set --app=$app --key=final_path --value=$final_path +# Download, check integrity, uncompress and patch the source from app.src +ynh_setup_source --dest_dir="$final_path" #================================================= # NGINX CONFIGURATION #================================================= +ynh_script_progression --message="Configuring nginx web server..." --weight=3 # Copy and set nginx configuration ynh_add_nginx_config @@ -108,12 +104,15 @@ ynh_add_nginx_config #================================================= # CREATE DEDICATED USER #================================================= +ynh_script_progression --message="Configuring system user..." --weight=2 -ynh_system_user_create "$app" +# Create a system user +ynh_system_user_create --username=$app #================================================= # PHP-FPM CONFIGURATION #================================================ +ynh_script_progression --message="Configuring php-fpm..." # Copy and set php-fpm configuration ynh_add_fpm_config @@ -121,55 +120,63 @@ ynh_add_fpm_config #================================================= # SPECIFIC SETUP #================================================= -# Create settings.php +# CREATE SETTINGS.PHP #================================================= +ynh_script_progression --message="Configuring agendav..." --weight=2 # Generate random encryption key -encryptkey=$(ynh_string_random 24) +encryptkey=$(ynh_string_random --length=24) -ynh_app_setting_set "$app" encryptkey "$encryptkey" +ynh_app_setting_set --app=$app --key=encryptkey --value="$encryptkey" # Copy and set AgenDAV configuration timezone=$(cat /etc/timezone) -caldav_domain=$(ynh_app_setting_get "$caldav_app" domain) -caldav_path=$(ynh_app_setting_get "$caldav_app" path) +caldav_domain=$(ynh_app_setting_get --app=$caldav_app --key=domain) +caldav_path=$(ynh_app_setting_get --app=$caldav_app --key=path) caldav_url="https://${caldav_domain}${caldav_path%/}" conf_path="${final_path}/web/config/settings.php" cp ../conf/settings.php "$conf_path" -ynh_replace_string "{DBUSER}" "${dbuser}" "$conf_path" -ynh_replace_string "{DBPASS}" "${dbpass}" "$conf_path" -ynh_replace_string "{DBNAME}" "${dbname}" "$conf_path" -ynh_replace_string "{ENCRYPTKEY}" "${encryptkey}" "$conf_path" -ynh_replace_string "{LOGDIR}" "${LOGDIR}" "$conf_path" -ynh_replace_string "{TIMEZONE}" "$timezone" "$conf_path" -ynh_replace_string "{LANGUAGE}" "${language}" "$conf_path" -ynh_replace_string "{CALDAV_BASEURL}" "${caldav_url}${caldav_baseurl}" "$conf_path" -ynh_replace_string "{CALDAV_DOMAIN}" "${caldav_domain}" "$conf_path" +logdir=/var/log/$app + +ynh_replace_string --match_string="__DBUSER__" --replace_string="$db_name" --target_file="$conf_path" +ynh_replace_string --match_string="__DBPASS__" --replace_string="$db_pwd" --target_file="$conf_path" +ynh_replace_string --match_string="__DBNAME__" --replace_string="$db_name" --target_file="$conf_path" +ynh_replace_string --match_string="__ENCRYPTKEY__" --replace_string="$encryptkey" --target_file="$conf_path" +ynh_replace_string --match_string="__LOGDIR__" --replace_string="$logdir" --target_file="$conf_path" +ynh_replace_string --match_string="__TIMEZONE__" --replace_string="$timezone" --target_file="$conf_path" +ynh_replace_string --match_string="__LANGUAGE__" --replace_string="$language" --target_file="$conf_path" +ynh_replace_string --match_string="__CALDAV_BASEURL__" --replace_string="${caldav_url}${caldav_baseurl}" --target_file="$conf_path" +ynh_replace_string --match_string="__CALDAV_DOMAIN__" --replace_string="$caldav_domain" --target_file="$conf_path" #================================================= # STORE THE CHECKSUM OF THE CONFIG FILE #================================================= -ynh_store_file_checksum "$conf_path" +ynh_store_file_checksum --file="$conf_path" #================================================= -# Run database migrations (includes initialization) +# RUN DATABASE MIGRATIONS (INCLUDES INITIALIZATION) #================================================= +ynh_script_progression --message="Initialising agendav..." --weight=3 ( - cd "$final_path" + cd $final_path php agendavcli migrations:migrate --no-interaction ) #================================================= -# SETUP LOG directory +# SETUP LOGROTATE #================================================= +ynh_script_progression --message="Configuring log rotation..." -mkdir -p "$LOGDIR" -chown -R "$app": "$LOGDIR" +mkdir -p $logdir +chown -R $app: $logdir + +# Use logrotate to manage application logfile(s) +ynh_use_logrotate #================================================= # GENERIC FINALIZATION @@ -177,28 +184,25 @@ chown -R "$app": "$LOGDIR" # SECURE FILES AND DIRECTORIES #================================================= -chown -R root: "$final_path" +chown -R root: $final_path # Only agendav user should write here -chown -R "$app" "${final_path}/web/var/cache/"{profiler,twig} +chown -R $app ${final_path}/web/var/cache/{profiler,twig} # The agendav user should read here, but does not need to write -chown -R root:"$app" "${final_path}/web/config/" -chmod -R g+rx "${final_path}/web/config/" - # Other users should not be able to read as it stores passwords. -chmod -R o-rwx "${final_path}/web/config/" +chown -R root:$app ${final_path}/web/config/ +chmod -R 750 ${final_path}/web/config/ #================================================= -# SETUP SSOWAT +# RELOAD NGINX #================================================= +ynh_script_progression --message="Reloading nginx web server..." -# Nothing to do, this app is private +ynh_systemd_action --service_name=nginx --action=reload #================================================= -# RELOAD NGINX and FPM +# END OF SCRIPT #================================================= -# Reload services -service php5-fpm reload -service nginx reload +ynh_script_progression --message="Installation of $app completed" --last diff --git a/scripts/remove b/scripts/remove index 6954292..7d6c580 100644 --- a/scripts/remove +++ b/scripts/remove @@ -12,19 +12,20 @@ source /usr/share/yunohost/helpers #================================================= # LOAD SETTINGS #================================================= +ynh_script_progression --message="Loading installation settings..." -app="$YNH_APP_INSTANCE_NAME" -domain=$(ynh_app_setting_get "$app" domain) -final_path=$(ynh_app_setting_get "$app" final_path) +app=$YNH_APP_INSTANCE_NAME -db_name=$app -db_user=$app +domain=$(ynh_app_setting_get --app=$app --key=domain) +db_name=$(ynh_app_setting_get --app=$app --key=db_name) +final_path=$(ynh_app_setting_get --app=$app --key=final_path) #================================================= # STANDARD REMOVE #================================================= # REMOVE DEPENDENCIES #================================================= +ynh_script_progression --message="Removing dependencies..." --weight=4 # Remove metapackage and its dependencies ynh_remove_app_dependencies @@ -32,26 +33,30 @@ ynh_remove_app_dependencies #================================================= # REMOVE THE MYSQL DATABASE #================================================= +ynh_script_progression --message="Removing the MySQL database..." # Remove a database if it exists, along with the associated user -ynh_mysql_remove_db "$db_user" "$db_name" +ynh_mysql_remove_db --db_user=$db_name --db_name=$db_name #================================================= # REMOVE APP MAIN DIR #================================================= +ynh_script_progression --message="Removing app main directory..." --weight=2 # Remove the app directory securely -ynh_secure_remove "$final_path" +ynh_secure_remove --file="$final_path" #================================================= # REMOVE LOG #================================================= +ynh_script_progression --message="Removing logs..." -ynh_secure_remove "/var/log/$app" +ynh_secure_remove --file="/var/log/$app" #================================================= # REMOVE NGINX CONFIGURATION #================================================= +ynh_script_progression --message="Removing nginx web server configuration..." # Remove the dedicated nginx config ynh_remove_nginx_config @@ -59,15 +64,31 @@ ynh_remove_nginx_config #================================================= # REMOVE PHP-FPM CONFIGURATION #================================================= +ynh_script_progression --message="Removing php-fpm configuration..." --weight=2 # Remove the dedicated php-fpm config ynh_remove_fpm_config +#================================================= +# REMOVE LOGROTATE CONFIGURATION +#================================================= +ynh_script_progression --message="Removing logrotate configuration..." + +# Remove the app-specific logrotate config +ynh_remove_logrotate + #================================================= # GENERIC FINALIZATION #================================================= # REMOVE DEDICATED USER #================================================= +ynh_script_progression --message="Removing the dedicated system user..." -# Remove the user account -ynh_system_user_delete "$app" +# Delete a system user +ynh_system_user_delete --username=$app + +#================================================= +# END OF SCRIPT +#================================================= + +ynh_script_progression --message="Removal of $app completed" --last diff --git a/scripts/restore b/scripts/restore index 1db77b5..ab7d41a 100644 --- a/scripts/restore +++ b/scripts/restore @@ -1,19 +1,12 @@ #!/bin/bash - #================================================= # GENERIC START #================================================= # IMPORT GENERIC HELPERS #================================================= -if [ ! -e _common.sh ]; then - # 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 ../settings/scripts/_common.sh source /usr/share/yunohost/helpers #================================================= @@ -26,28 +19,24 @@ ynh_abort_if_errors #================================================= # LOAD SETTINGS #================================================= +ynh_script_progression --message="Loading settings..." --weight=2 -# Set app specific variables -app="$YNH_APP_INSTANCE_NAME" -dbname=$app -dbuser=$app +app=$YNH_APP_INSTANCE_NAME -# Retrieve old app settings -domain=$(ynh_app_setting_get "$app" domain) -path_url=$(ynh_app_setting_get "$app" path) -final_path=$(ynh_app_setting_get "$app" final_path) -dbpass=$(ynh_app_setting_get "$app" mysqlpwd) - -LOGDIR=/var/log/$app +domain=$(ynh_app_setting_get --app=$app --key=domain) +path_url=$(ynh_app_setting_get --app=$app --key=path) +final_path=$(ynh_app_setting_get --app=$app --key=final_path) +db_name=$(ynh_app_setting_get --app=$app --key=db_name) #================================================= # CHECK IF THE APP CAN BE RESTORED #================================================= +ynh_script_progression --message="Validating restoration parameters..." -ynh_webpath_available "$domain" "$path_url" \ - || ynh_die "Path not available: ${domain}${path_url}" -test ! -d "$final_path" \ -|| ynh_die "There is already a directory: $final_path " +ynh_webpath_available --domain=$domain --path_url=$path_url \ + || ynh_die --message="Path not available: ${domain}${path_url}" +test ! -d $final_path \ + || ynh_die --message="There is already a directory: $final_path " #================================================= # STANDARD RESTORATION STEPS @@ -55,72 +44,76 @@ test ! -d "$final_path" \ # RESTORE THE NGINX CONFIGURATION #================================================= -# Restore configuration files -ynh_restore_file "/etc/nginx/conf.d/${domain}.d/${app}.conf" +ynh_restore_file --origin_path="/etc/nginx/conf.d/$domain.d/$app.conf" #================================================= # RESTORE THE APP MAIN DIR #================================================= +ynh_script_progression --message="Restoring the app main directory..." -ynh_restore_file "$final_path" - -#================================================= -# RESTORE THE MYSQL DATABASE -#================================================= - -# Create and restore the database -ynh_mysql_create_db "$dbname" "$dbuser" "$dbpass" -ynh_mysql_connect_as "$dbuser" "$dbpass" "$dbname" < ./db.sql +ynh_restore_file --origin_path="$final_path" #================================================= # RECREATE THE DEDICATED USER #================================================= +ynh_script_progression --message="Recreating the dedicated system user..." --weight=2 -ynh_system_user_create "$app" "$final_path" +# Create the dedicated user (if not existing) +ynh_system_user_create --username=$app #================================================= # RESTORE USER RIGHTS #================================================= -chown -R root: "$final_path" +chown -R root: $final_path # Only agendav user should write here -chown -R "$app" "${final_path}/web/var/cache/"{profiler,twig} +chown -R $app ${final_path}/web/var/cache/{profiler,twig} # The agendav user should read here, but does not need to write -chown -R root:"$app" "${final_path}/web/config/" -chmod -R g+rx "${final_path}/web/config/" - # Other users should not be able to read as it stores passwords. -chmod -R o-rwx "${final_path}/web/config/" +chown -R root:$app ${final_path}/web/config/ +chmod -R 750 ${final_path}/web/config/ #================================================= # RESTORE THE PHP-FPM CONFIGURATION #================================================= -ynh_restore_file "/etc/php5/fpm/pool.d/${app}.conf" +ynh_restore_file --origin_path="/etc/php/7.0/fpm/pool.d/$app.conf" #================================================= # SPECIFIC RESTORATION #================================================= -# REINSTALL DEPENDENCIES +# RESTORE THE MYSQL DATABASE #================================================= +ynh_script_progression --message="Restoring the MySQL database..." --weight=2 -# Install dependencies -ynh_install_app_dependencies php5-cli +db_pwd=$(ynh_app_setting_get --app=$app --key=mysqlpwd) +ynh_mysql_setup_db --db_user=$db_name --db_name=$db_name --db_pwd=$db_pwd +ynh_mysql_connect_as --user=$db_name --password=$db_pwd --database=$db_name < ./db.sql #================================================= -# SETUP LOG directory +# RESTORE THE LOGROTATE CONFIGURATION #================================================= -mkdir -p "$LOGDIR" -chown -R "$app": "$LOGDIR" +logdir=/var/log/$app +mkdir -p $logdir +chown -R $app: $logdir + +ynh_restore_file --origin_path="/etc/logrotate.d/$app" #================================================= # GENERIC FINALIZATION #================================================= # RELOAD NGINX AND PHP-FPM #================================================= +ynh_script_progression --message="Reloading nginx web server and php-fpm..." --weight=2 -service php5-fpm reload -service nginx reload +ynh_systemd_action --service_name=php7.0-fpm --action=reload +ynh_systemd_action --service_name=nginx --action=reload + +#================================================= +# END OF SCRIPT +#================================================= + +ynh_script_progression --message="Restoration completed for $app" --last diff --git a/scripts/upgrade b/scripts/upgrade index 69213ca..8ae69e0 100644 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -12,76 +12,75 @@ source /usr/share/yunohost/helpers #================================================= # LOAD SETTINGS #================================================= +ynh_script_progression --message="Loading installation settings..." -# Set app specific variables -app="$YNH_APP_INSTANCE_NAME" -dbname=$app -dbuser=$app +app=$YNH_APP_INSTANCE_NAME -# Retrieve arguments -domain=$(ynh_app_setting_get "$app" domain) -path_url=$(ynh_app_setting_get "$app" path) -dbpass=$(ynh_app_setting_get "$app" mysqlpwd) -encryptkey=$(ynh_app_setting_get "$app" encryptkey) -language=$(ynh_app_setting_get "$app" language) +domain=$(ynh_app_setting_get --app=$app --key=domain) +path_url=$(ynh_app_setting_get --app=$app --key=path) +final_path=$(ynh_app_setting_get --app=$app --key=final_path) +language=$(ynh_app_setting_get --app=$app --key=language) +db_name=$(ynh_app_setting_get --app=$app --key=db_name) -LOGDIR=/var/log/$app +#================================================= +# CHECK VERSION +#================================================= + +upgrade_type=$(ynh_check_app_version_changed) #================================================= # ENSURE DOWNWARD COMPATIBILITY #================================================= - -# Set and store language -if [[ -z "$language" ]]; then - # retrieve language the old way - lang=${LANG/.*/} - [[ ${LANGUAGES[$lang]+_} ]] || lang="en" - - # retrieve and store the relevant language - language=${LANGUAGES[$lang]} - ynh_app_setting_set "$app" language "$language" -fi - +ynh_script_progression --message="Ensuring downward compatibility..." # Fix is_public as a boolean value if [ "$is_public" = "Yes" ]; then - ynh_app_setting_set "$app" is_public 1 + ynh_app_setting_set --app=$app --key=is_public --value=1 is_public=1 elif [ "$is_public" = "No" ]; then - ynh_app_setting_set "$app" is_public 0 + ynh_app_setting_set --app=$app --key=is_public --value=0 is_public=0 fi # 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" + db_name=$(ynh_sanitize_dbid --db_name=$app) + ynh_app_setting_set --app=$app --key=db_name --value=$db_name fi # If final_path doesn't exist, create it if [ -z "$final_path" ]; then final_path=/var/www/$app - ynh_app_setting_set "$app" final_path "$final_path" + ynh_app_setting_set --app=$app --key=final_path --value=$final_path fi +#================================================= +# GET THE CALDAV APP +#================================================= + +agendav_app_check_installation() { + echo $(yunohost app list --installed -f "$1" | grep "id:") +} + # Check whether Baïkal or Radicale is installed baikal_install=$(agendav_app_check_installation "baikal") radicale_install=$(agendav_app_check_installation "radicale") -if [[ -n "$baikal_install" ]] +if [ -n "$baikal_install" ] then - caldav_app="baikal" + caldav_app=baikal caldav_baseurl="/cal.php/" -elif [[ -n "$radicale_install" ]] +elif [ -n "$radicale_install" ] then - caldav_app="radicale" - caldav_baseurl="/" + caldav_app=radicale + caldav_baseurl=/ else - ynh_die "Baikal or Radicale is mandatory" + ynh_die --message="Please install Baikal or Radicale before AgenDAV." fi #================================================= # BACKUP BEFORE UPGRADE THEN ACTIVE TRAP #================================================= +ynh_script_progression --message="Backing up the app before upgrading (may take a while)..." --weight=9 # Backup the current version of the app ynh_backup_before_upgrade @@ -97,93 +96,116 @@ ynh_abort_if_errors #================================================= # Normalize the URL path syntax -path_url=$(ynh_normalize_url_path "$path_url") +path_url=$(ynh_normalize_url_path --path_url=$path_url) #================================================= -# STANDARD MODIFICATIONS -#================================================= - -# Install dependencies -ynh_install_app_dependencies php5-cli - +# STANDARD UPGRADE STEPS #================================================= # DOWNLOAD, CHECK AND UNPACK SOURCE #================================================= -ynh_setup_source "$final_path" +if [ "$upgrade_type" == "UPGRADE_APP" ] +then + ynh_script_progression --message="Upgrading source files..."0 + + # Download, check integrity, uncompress and patch the source from app.src + ynh_setup_source --dest_dir="$final_path" +fi #================================================= # NGINX CONFIGURATION #================================================= +ynh_script_progression --message="Upgrading nginx web server configuration..." --weight=2 # Copy and set nginx configuration ynh_add_nginx_config +#================================================= +# UPGRADE DEPENDENCIES +#================================================= +ynh_script_progression --message="Upgrading dependencies..." --weight=5 + +# Install dependencies +ynh_install_app_dependencies php-cli + #================================================= # CREATE DEDICATED USER #================================================= +ynh_script_progression --message="Making sure dedicated system user exists..." -ynh_system_user_create "$app" +# Create a dedicated user (if not existing) +ynh_system_user_create --username=$app #================================================= # PHP-FPM CONFIGURATION -#================================================ +#================================================= +ynh_script_progression --message="Upgrading php-fpm configuration..." -# Copy and set php-fpm configuration +# Create a dedicated php-fpm config ynh_add_fpm_config #================================================= # SPECIFIC SETUP #================================================= -# Create settings.php +# CREATE SETTINGS.PHP #================================================= +ynh_script_progression --message="Upgrading agendav configuration..." --weight=2 # Generate random encryption key -encryptkey=$(ynh_app_setting_get "$app" encryptkey) +encryptkey=$(ynh_app_setting_get --app=$app --key=encryptkey) # Copy and set AgenDAV configuration timezone=$(cat /etc/timezone) -caldav_domain=$(ynh_app_setting_get "$caldav_app" domain) -caldav_path=$(ynh_app_setting_get "$caldav_app" path) +caldav_domain=$(ynh_app_setting_get --app=$caldav_app --key=domain) +caldav_path=$(ynh_app_setting_get --app=$caldav_app --key=path) caldav_url="https://${caldav_domain}${caldav_path%/}" conf_path="${final_path}/web/config/settings.php" -ynh_backup_if_checksum_is_different "$conf_path" + +ynh_backup_if_checksum_is_different --file="$conf_path" cp ../conf/settings.php "$conf_path" -ynh_replace_string "{DBUSER}" "${dbuser}" "$conf_path" -ynh_replace_string "{DBPASS}" "${dbpass}" "$conf_path" -ynh_replace_string "{DBNAME}" "${dbname}" "$conf_path" -ynh_replace_string "{ENCRYPTKEY}" "${encryptkey}" "$conf_path" -ynh_replace_string "{LOGDIR}" "${LOGDIR}" "$conf_path" -ynh_replace_string "{TIMEZONE}" "$timezone" "$conf_path" -ynh_replace_string "{LANGUAGE}" "${language}" "$conf_path" -ynh_replace_string "{CALDAV_BASEURL}" "${caldav_url}${caldav_baseurl}" "$conf_path" -ynh_replace_string "{CALDAV_DOMAIN}" "${caldav_domain}" "$conf_path" +logdir=/var/log/$app + +ynh_replace_string --match_string="__DBUSER__" --replace_string="$db_name" --target_file="$conf_path" +db_pwd=$(ynh_app_setting_get --app=$app --key=mysqlpwd) +ynh_replace_string --match_string="__DBPASS__" --replace_string="$db_pwd" --target_file="$conf_path" +ynh_replace_string --match_string="__DBNAME__" --replace_string="$db_name" --target_file="$conf_path" +ynh_replace_string --match_string="__ENCRYPTKEY__" --replace_string="$encryptkey" --target_file="$conf_path" +ynh_replace_string --match_string="__LOGDIR__" --replace_string="$logdir" --target_file="$conf_path" +ynh_replace_string --match_string="__TIMEZONE__" --replace_string="$timezone" --target_file="$conf_path" +ynh_replace_string --match_string="__LANGUAGE__" --replace_string="$language" --target_file="$conf_path" +ynh_replace_string --match_string="__CALDAV_BASEURL__" --replace_string="${caldav_url}${caldav_baseurl}" --target_file="$conf_path" +ynh_replace_string --match_string="__CALDAV_DOMAIN__" --replace_string="$caldav_domain" --target_file="$conf_path" #================================================= # STORE THE CHECKSUM OF THE CONFIG FILE #================================================= -ynh_store_file_checksum "$conf_path" +ynh_store_file_checksum --file="$conf_path" #================================================= -# Run database migrations (includes initialization) +# RUN DATABASE MIGRATIONS (INCLUDES INITIALIZATION) #================================================= +ynh_script_progression --message="Upgrading agendav..." ( - cd "$final_path" + cd $final_path php agendavcli migrations:migrate --no-interaction ) #================================================= -# SETUP LOG directory +# SETUP LOGROTATE #================================================= +ynh_script_progression --message="Upgrading logrotate configuration..." --weight=2 -mkdir -p "$LOGDIR" -chown -R "$app": "$LOGDIR" +mkdir -p $logdir +chown -R $app: $logdir + +# Use logrotate to manage application logfile(s) +ynh_use_logrotate --non-append #================================================= # GENERIC FINALIZATION @@ -191,28 +213,25 @@ chown -R "$app": "$LOGDIR" # SECURE FILES AND DIRECTORIES #================================================= -chown -R root: "$final_path" +chown -R root: $final_path # Only agendav user should write here -chown -R "$app" "${final_path}/web/var/cache/"{profiler,twig} +chown -R $app ${final_path}/web/var/cache/{profiler,twig} # The agendav user should read here, but does not need to write -chown -R root:"$app" "${final_path}/web/config/" -chmod -R g+rx "${final_path}/web/config/" - # Other users should not be able to read as it stores passwords. -chmod -R o-rwx "${final_path}/web/config/" +chown -R root:$app ${final_path}/web/config/ +chmod -R 750 ${final_path}/web/config/ #================================================= -# SETUP SSOWAT +# RELOAD NGINX #================================================= +ynh_script_progression --message="Reloading nginx web server..." -# Nothing to do, this app is private +ynh_systemd_action --service_name=nginx --action=reload #================================================= -# RELOAD NGINX and FPM +# END OF SCRIPT #================================================= -# Reload services -service php5-fpm reload -service nginx reload +ynh_script_progression --message="Upgrade of $app completed" --last