From 572070c216dbab565c6772c10fbe0255d57e479e Mon Sep 17 00:00:00 2001 From: anmol26s Date: Wed, 6 Jun 2018 02:47:03 +0530 Subject: [PATCH] Updated to version 2018.05 and many fixes --- check_process | 4 +- conf/addons.src | 4 +- conf/app.src | 4 +- conf/friendica-addons/source_file | 1 - conf/friendica-addons/source_md5 | 1 - conf/friendica-addons/source_url | 1 - conf/nginx.conf | 63 ++--- conf/php-fpm.conf | 392 ++++++++++++++++++++++++++++++ conf/php-fpm.ini | 12 + conf/poller-cron | 2 +- manifest.json | 14 +- scripts/_common.sh | 116 +-------- scripts/backup | 31 ++- scripts/install | 52 +++- scripts/remove | 23 ++ scripts/restore | 48 +++- scripts/upgrade | 68 ++++-- 17 files changed, 630 insertions(+), 206 deletions(-) delete mode 100644 conf/friendica-addons/source_file delete mode 100644 conf/friendica-addons/source_md5 delete mode 100644 conf/friendica-addons/source_url create mode 100644 conf/php-fpm.conf create mode 100644 conf/php-fpm.ini diff --git a/check_process b/check_process index 24fe02c..baec3ee 100644 --- a/check_process +++ b/check_process @@ -12,7 +12,7 @@ setup_public=1 upgrade=1 backup_restore=1 - multi_instance=0 + multi_instance=1 incorrect_path=1 port_already_use=0 change_url=0 @@ -30,5 +30,5 @@ Level 9=0 Level 10=0 ;;; Options - Email=anmol@datamol.in + Email=anmol@datamol.org Notification=none diff --git a/conf/addons.src b/conf/addons.src index 8813618..293fc6b 100644 --- a/conf/addons.src +++ b/conf/addons.src @@ -1,5 +1,5 @@ -SOURCE_URL=https://github.com/friendica/friendica-addons/archive/3.6.zip -SOURCE_SUM=b94e1d9404d27351c029e055a4bbaf96 +SOURCE_URL=https://github.com/friendica/friendica/archive/2018.05.zip +SOURCE_SUM=9b5497423ca7ce4b581fa97ca12f412d SOURCE_SUM_PRG=md5sum SOURCE_FORMAT=zip SOURCE_IN_SUBDIR=true diff --git a/conf/app.src b/conf/app.src index b146fc1..25faeab 100644 --- a/conf/app.src +++ b/conf/app.src @@ -1,5 +1,5 @@ -SOURCE_URL=https://github.com/friendica/friendica/releases/download/3.6/friendica-full-3.6.zip -SOURCE_SUM=13b6fa36e458f43c4eafc279141d490d +SOURCE_URL=https://github.com/friendica/friendica-addons/archive/2018.05.zip +SOURCE_SUM=e00143e9302b25b01886deac5302d326 SOURCE_SUM_PRG=md5sum SOURCE_FORMAT=zip SOURCE_IN_SUBDIR=true diff --git a/conf/friendica-addons/source_file b/conf/friendica-addons/source_file deleted file mode 100644 index 283b99a..0000000 --- a/conf/friendica-addons/source_file +++ /dev/null @@ -1 +0,0 @@ -friendica-addons-3.6 diff --git a/conf/friendica-addons/source_md5 b/conf/friendica-addons/source_md5 deleted file mode 100644 index 589326f..0000000 --- a/conf/friendica-addons/source_md5 +++ /dev/null @@ -1 +0,0 @@ -b94e1d9404d27351c029e055a4bbaf96 friendica-addons-3.6.zip diff --git a/conf/friendica-addons/source_url b/conf/friendica-addons/source_url deleted file mode 100644 index 43f1a8a..0000000 --- a/conf/friendica-addons/source_url +++ /dev/null @@ -1 +0,0 @@ -https://github.com/friendica/friendica-addons/archive/3.6.zip diff --git a/conf/nginx.conf b/conf/nginx.conf index 6d7ea16..dff6a9a 100644 --- a/conf/nginx.conf +++ b/conf/nginx.conf @@ -34,6 +34,12 @@ location __PATH__ { if ($scheme = http) { rewrite ^ https://$server_name$request_uri? permanent; } + + if (!-e $request_filename) { + rewrite ^(.*)$ /index.php?pagename=$1; + } + + #allow uploads up to 20MB in size client_max_body_size 20m; @@ -43,25 +49,24 @@ location __PATH__ { #Default indexes and catch-all index index.php; try_files $uri $uri/ /index.php?$args; + - #Prevent useless logs - location = /favicon.ico { - log_not_found off; - access_log off; - } + # make sure webfinger and other well known services aren't blocked + # by denying dot files and rewrite request to the front controller + location ^~ /.well-known/ { + allow all; + if (!-e $request_filename) { + rewrite ^(.*)$ /index.php?pagename=$1; + } + } + + include mime.types; - location = /robots.txt { - allow all; - log_not_found off; - access_log off; - } + # block these file types + location ~* \.(tpl|md|tgz|log|out)$ { + deny all; + } - # make sure webfinger and other well known services aren't blocked - # by denying dot files and rewrite request to the front controller - location ^~ /.well-known/ { - allow all; - rewrite ^/(.*) /index.php?pagename=$request_uri&$args last; - } #statically serve these file types when possible #otherwise fall back to front controller @@ -72,15 +77,11 @@ location __PATH__ { try_files $uri /index.php?pagename=$request_uri&$args; } - #block these file types - location ~* \.(tpl|md|tgz|log|out)$ { - deny all; - } #Execute and serve PHP files location ~ [^/]\.php(/|$) { fastcgi_split_path_info ^(.+?\.php)(/.*)$; - fastcgi_pass unix:/var/run/php5-fpm.sock; + fastcgi_pass unix:/var/run/php5-fpm-__NAME__.sock; fastcgi_index index.php; include fastcgi_params; fastcgi_param REMOTE_USER $remote_user; @@ -88,21 +89,11 @@ location __PATH__ { fastcgi_param SCRIPT_FILENAME $request_filename; } - #.htaccess file from Friendica converted using http://winginx.com/en/htaccess - location ~ "(^|/)\.git" { - return 403; - } - autoindex off; - if (!-e $request_filename) { - rewrite ^(.*)$ /index.php?pagename=$1; - } - - - #deny access to all dot files - location ~ /\. { - deny all; - } - + + # deny access to all dot files + location ~ /\. { + deny all; + } #Include SSOWAT user panel. include conf.d/yunohost_panel.conf.inc; } diff --git a/conf/php-fpm.conf b/conf/php-fpm.conf new file mode 100644 index 0000000..8affbc2 --- /dev/null +++ b/conf/php-fpm.conf @@ -0,0 +1,392 @@ +; Start a new pool named 'www'. +; the variable $pool can we used in any directive and will be replaced by the +; pool name ('www' here) +[__NAMETOCHANGE__] + +; Per pool prefix +; It only applies on the following directives: +; - '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 +; 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 address on +; a specific port; +; 'port' - to listen on a TCP socket to all addresses on a +; specific port; +; '/path/to/unix/socket' - to listen on a unix socket. +; Note: This value is mandatory. +listen = /var/run/php5-fpm-__NAMETOCHANGE__.sock + +; Set listen(2) backlog. A value of '-1' means unlimited. +; Default Value: 128 (-1 on FreeBSD and OpenBSD) +;listen.backlog = 128 + +; 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 + +; List of ipv4 addresses 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 +; priority = -19 + +; 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 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 = 10 + +; 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 = 2 + +; 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 = 1 + +; 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 = 3 + +; 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. +; 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. 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: ${prefix}/share/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. 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 + +; 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: ouput 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) +; %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) +; %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 = /var/log/nginx/__NAMETOCHANGE__.slow.log + +; 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'. +; Available units: s(econds)(default), m(inutes), h(ours), or d(ays) +; Default Value: 0 +request_slowlog_timeout = 5s + +; 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. +; Default Value: system defined value +;rlimit_files = 1024 + +; Set max core size rlimit. +; 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 + +; 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 +; exectute php code. +; Note: set an empty value to allow all extensions. +; Default Value: .php +;security.limit_extensions = .php .php3 .php4 .php5 + +; 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/php-fpm.ini b/conf/php-fpm.ini new file mode 100644 index 0000000..c404f97 --- /dev/null +++ b/conf/php-fpm.ini @@ -0,0 +1,12 @@ +; Common values to change to increase file upload limit +; upload_max_filesize = 50M +; post_max_size = 50M +; mail.add_x_header = Off + +; Other common parameters +; max_execution_time = 600 +; max_input_time = 300 +; memory_limit = 256M +; short_open_tag = On +cgi.fix_pathinfo = 0; +register_argc_argv=1; diff --git a/conf/poller-cron b/conf/poller-cron index 7a9bcaa..0e284be 100644 --- a/conf/poller-cron +++ b/conf/poller-cron @@ -1,2 +1,2 @@ # Run poller periodically to update Hubzilla -*/10 * * * * cd YNH_WWW_PATH; /usr/bin/php scripts/poller.php +*/10 * * * * cd YNH_WWW_PATH; /usr/bin/php bin/worker.php diff --git a/manifest.json b/manifest.json index 78df80e..ee4883c 100644 --- a/manifest.json +++ b/manifest.json @@ -8,15 +8,19 @@ }, "url": "http://friendi.ca", "license": "free", + "version": "3.4", "maintainer": { "name": "Anmol Sharma", - "email": "anmol@datamol.in" + "email": "anmol@datamol.org" }, "requirements": { - "yunohost": ">> 2.5.6" - }, - "multi_instance": "false", - "multi_instance": false, + "yunohost": ">= 2.7.2" + } + "previous_maintainers": { + "name": "aymhce", + "email": "aymhce@gmail.com" + }, + "multi_instance": "true", "services": [ "nginx", "php5-fpm", diff --git a/scripts/_common.sh b/scripts/_common.sh index 5c522b9..b4bb1eb 100644 --- a/scripts/_common.sh +++ b/scripts/_common.sh @@ -1,112 +1,14 @@ + #!/bin/bash -# ============================================================================= -# YUNOHOST 2.7 FORTHCOMING HELPERS -# ============================================================================= - -# Create a dedicated nginx config +# ============= FUTURE YUNOHOST HELPER ============= +# Delete a file checksum from the app settings # -# usage: ynh_add_nginx_config -ynh_add_nginx_config () { - finalnginxconf="/etc/nginx/conf.d/$domain.d/$app.conf" - ynh_backup_if_checksum_is_different "$finalnginxconf" 1 - sudo cp ../conf/nginx.conf "$finalnginxconf" - - # To avoid a break by set -u, use a void substitution ${var:-}. If the variable is not set, it's simply set with an empty variable. - # Substitute in a nginx config file only if the variable is not empty - if test -n "${path_url:-}"; then - ynh_replace_string "__PATH__" "$path_url" "$finalnginxconf" - fi - if test -n "${domain:-}"; then - ynh_replace_string "__DOMAIN__" "$domain" "$finalnginxconf" - fi - if test -n "${port:-}"; then - ynh_replace_string "__PORT__" "$port" "$finalnginxconf" - fi - if test -n "${app:-}"; then - ynh_replace_string "__NAME__" "$app" "$finalnginxconf" - fi - if test -n "${final_path:-}"; then - ynh_replace_string "__FINALPATH__" "$final_path" "$finalnginxconf" - fi - - - sudo systemctl reload nginx -} - -# Remove the dedicated nginx config +# $app should be defined when calling this helper # -# usage: ynh_remove_nginx_config -ynh_remove_nginx_config () { - ynh_secure_remove "/etc/nginx/conf.d/$domain.d/$app.conf" - sudo systemctl reload nginx -} - -# Create a dedicated php-fpm config -# -# usage: ynh_add_fpm_config -ynh_add_fpm_config () { - finalphpconf="/etc/php5/fpm/pool.d/$app.conf" - ynh_backup_if_checksum_is_different "$finalphpconf" 1 - sudo cp ../conf/php-fpm.conf "$finalphpconf" - ynh_replace_string "__NAMETOCHANGE__" "$app" "$finalphpconf" - ynh_replace_string "__FINALPATH__" "$final_path" "$finalphpconf" - ynh_replace_string "__USER__" "$app" "$finalphpconf" - sudo chown root: "$finalphpconf" - ynh_store_file_checksum "$finalphpconf" - - if [ -e "../conf/php-fpm.ini" ] - then - finalphpini="/etc/php5/fpm/conf.d/20-$app.ini" - ynh_compare_checksum_config "$finalphpini" 1 - sudo cp ../conf/php-fpm.ini "$finalphpini" - sudo chown root: "$finalphpini" - ynh_store_checksum_config "$finalphpini" - fi - - sudo systemctl reload php5-fpm -} - -# Remove the dedicated php-fpm config -# -# usage: ynh_remove_fpm_config -ynh_remove_fpm_config () { - ynh_secure_remove "/etc/php5/fpm/pool.d/$app.conf" - ynh_secure_remove "/etc/php5/fpm/conf.d/20-$app.ini" 2>&1 - sudo systemctl reload php5-fpm -} - -# Create a dedicated systemd config -# -# usage: ynh_add_systemd_config -ynh_add_systemd_config () { - finalsystemdconf="/etc/systemd/system/$app.service" - ynh_compare_checksum_config "$finalsystemdconf" 1 - sudo cp ../conf/systemd.service "$finalsystemdconf" - - # To avoid a break by set -u, use a void substitution ${var:-}. If the variable is not set, it's simply set with an empty variable. - # Substitute in a nginx config file only if the variable is not empty - if test -n "${final_path:-}"; then - ynh_replace_string "__FINALPATH__" "$final_path" "$finalsystemdconf" - fi - if test -n "${app:-}"; then - ynh_replace_string "__APP__" "$app" "$finalsystemdconf" - fi - ynh_store_checksum_config "$finalsystemdconf" - - sudo chown root: "$finalsystemdconf" - sudo systemctl enable $app - sudo systemctl daemon-reload -} - -# Remove the dedicated systemd config -# -# usage: ynh_remove_systemd_config -ynh_remove_systemd_config () { - finalsystemdconf="/etc/systemd/system/$app.service" - if [ -e "$finalsystemdconf" ]; then - sudo systemctl stop $app - sudo systemctl disable $app - ynh_secure_remove "$finalsystemdconf" - fi +# usage: ynh_remove_file_checksum file +# | arg: file - The file for which the checksum will be deleted +ynh_delete_file_checksum () { + local checksum_setting_name=checksum_${1//[\/ ]/_} # Replace all '/' and ' ' by '_' + ynh_app_setting_delete $app $checksum_setting_name } diff --git a/scripts/backup b/scripts/backup index 3d839bd..1a3a9b4 100644 --- a/scripts/backup +++ b/scripts/backup @@ -2,25 +2,25 @@ #================================================= # 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 # Get the _common.sh file if it's not in the current directory - sudo cp ../settings/scripts/_common.sh ./_common.sh - sudo chmod a+rx _common.sh + 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 #================================================= @@ -37,12 +37,19 @@ db_pwd=$(ynh_app_setting_get $app mysqlpwd) #================================================= # BACKUP THE APP MAIN DIR #================================================= -ynh_backup "$final_path" "sources" +ynh_backup "$final_path" #================================================= # BACKUP THE NGINX CONFIGURATION #================================================= -ynh_backup "/etc/nginx/conf.d/$domain.d/$app.conf" "nginx.conf" +ynh_backup "/etc/nginx/conf.d/$domain.d/$app.conf" + +#================================================= +# BACKUP THE PHP-FPM CONFIGURATION +#================================================= + +ynh_backup "/etc/php5/fpm/pool.d/$app.conf" +ynh_backup "/etc/php5/fpm/conf.d/20-$app.ini" #================================================= # BACKUP THE MYSQL DATABASE @@ -51,4 +58,4 @@ ynh_mysql_dump_db "$db_name" > db.sql # Backup cron job -ynh_backup "/etc/cron.d/$app" "$app" +ynh_backup "/etc/cron.d/$app" diff --git a/scripts/install b/scripts/install index a18665f..359de9f 100644 --- a/scripts/install +++ b/scripts/install @@ -24,7 +24,10 @@ ynh_abort_if_errors domain=$YNH_APP_ARG_DOMAIN path_url='/' admin=$YNH_APP_ARG_ADMIN +admin_mail=$(sudo yunohost user info $admin | grep "mail:" | cut -d' ' -f2) is_public=1 +database="1" + # This is a multi-instance app, meaning it can be installed several times independently # The id of the app as stated in the manifest is available as $YNH_APP_ID @@ -61,9 +64,17 @@ ynh_app_setting_set $app domain $domain ynh_app_setting_set $app path $path_url ynh_app_setting_set $app admin $admin ynh_app_setting_set $app is_public $is_public +ynh_app_setting_set $app email $admin_mail +ynh_app_setting_set $app database $database -# Get admin mail -admin_mail=$(sudo yunohost user info $admin | grep "mail:" | cut -d' ' -f2) +#================================================= +# INSTALL DEPENDENCIES +#================================================= +pkg_dependencies="php5-cli php5-imagick php5-gd php5-mcrypt" +if [ "$(lsb_release --codename --short)" != "jessie" ]; then + pkg_dependencies="$pkg_dependencies php-xml" +fi +ynh_install_app_dependencies $pkg_dependencies #================================================= # CREATE A MYSQL DATABASE @@ -84,14 +95,8 @@ ynh_app_setting_set $app final_path $final_path ynh_setup_source "$final_path" # 2 - Addons -addons_file=`sudo cat ../conf/friendica-addons/source_file`; -sudo wget -nv -i ../conf/friendica-addons/source_url -O ${addons_file}.zip -sudo md5sum -c ../conf/friendica-addons/source_md5 --status || (echo "Corrupt source" >&2 && false) -sudo unzip -q ${addons_file}.zip -d ../conf/friendica-addons/ sudo mkdir $final_path/addon -sudo cp -r ../conf/friendica-addons/${addons_file}/. $final_path/addon - - +ynh_setup_source "$final_path/addon" "addons" #================================================= # NGINX CONFIGURATION @@ -99,6 +104,8 @@ sudo cp -r ../conf/friendica-addons/${addons_file}/. $final_path/addon # Create a dedicated nginx config ynh_add_nginx_config + + # configure friendica sudo cp $final_path/htconfig.php $final_path/.htconfig.php @@ -115,24 +122,47 @@ ynh_mysql_connect_as "$db_name" "$db_pwd" "$db_name" < "$final_path/database.sql # addon config sudo su -c "cat ../conf/conf.php >> $final_path/.htconfig.php" +#================================================= +# CREATE DEDICATED USER +#================================================= + +# Create a system user +ynh_system_user_create $app + +#================================================= +# PHP-FPM CONFIGURATION +#================================================= + + +# Create a dedicated php-fpm config +ynh_add_fpm_config + # set permission sudo chown -R www-data:www-data $final_path # 3 - some extra folders sudo mkdir -p "${final_path}/view/smarty3" sudo chmod -R 777 $final_path/view/smarty3 +chown -R $app: $final_path # Set up poller sed -i "s@YNH_WWW_PATH@$final_path@g" ../conf/poller-cron sudo cp ../conf/poller-cron /etc/cron.d/$app +#================================================= +# STORE THE CHECKSUM OF THE CONFIG FILE +#================================================= + +# Calculate and store the config file checksum into the app settings +ynh_store_file_checksum "$final_path/.htconfig.php" + #================================================= # SETUP SSOWAT #================================================= - # unprotected_uris allows SSO credentials to be passed anyway. - ynh_app_setting_set $app unprotected_uris "/" +# unprotected_uris allows SSO credentials to be passed anyway. +ynh_app_setting_set $app unprotected_uris "/" #================================================= diff --git a/scripts/remove b/scripts/remove index e1cdf43..00c966e 100644 --- a/scripts/remove +++ b/scripts/remove @@ -18,6 +18,13 @@ app=$YNH_APP_INSTANCE_NAME domain=$(ynh_app_setting_get $app domain) db_name=$(ynh_app_setting_get $app db_name) +#================================================= +# REMOVE DEPENDENCIES +#================================================= + +# Remove metapackage and its dependencies +ynh_remove_app_dependencies + #================================================= # REMOVE THE MYSQL DATABASE #================================================= @@ -39,5 +46,21 @@ ynh_secure_remove "/var/www/$app" # Remove the dedicated nginx config ynh_remove_nginx_config +#================================================= +# REMOVE PHP-FPM CONFIGURATION +#================================================= + +# Remove the dedicated php-fpm config +ynh_remove_fpm_config + # Remove a cron file ynh_secure_remove "/etc/cron.d/$app" + +#================================================= +# GENERIC FINALIZATION +#================================================= +# REMOVE DEDICATED USER +#================================================= + +# Delete a system user +ynh_system_user_delete $app diff --git a/scripts/restore b/scripts/restore index bc0b53a..6bc647f 100644 --- a/scripts/restore +++ b/scripts/restore @@ -2,25 +2,26 @@ #================================================= # 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 # Get the _common.sh file if it's not in the current directory - sudo cp ../settings/scripts/_common.sh ./_common.sh - sudo chmod a+rx _common.sh + 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 #================================================= @@ -58,8 +59,34 @@ ynh_mysql_connect_as $db_name $db_pwd $db_name < ./db.sql # RESTORE THE APP MAIN DIR #================================================= ynh_restore_file "$final_path" + +#================================================= +# RECREATE THE DEDICATED USER +#================================================= + +# Create the dedicated user (if not existing) +ynh_system_user_create $app + +#================================================= +# RESTORE THE PHP-FPM CONFIGURATION +#================================================= + +ynh_restore_file "/etc/php5/fpm/pool.d/$app.conf" +ynh_restore_file "/etc/php5/fpm/conf.d/20-$app.ini" + +#================================================= +# SPECIFIC RESTORATION +#================================================= +# REINSTALL DEPENDENCIES +#================================================= + +pkg_dependencies="php5-cli php5-imagick php5-gd php5-mcrypt" +if [ "$(lsb_release --codename --short)" != "jessie" ]; then + pkg_dependencies="$pkg_dependencies php-xml" +fi +ynh_install_app_dependencies $pkg_dependencies + # set permission -sudo chown -R www-data:www-data $final_path sudo chmod -R 777 $final_path/view/smarty3 #================================================= @@ -73,5 +100,4 @@ ynh_app_setting_set $app unprotected_uris "/" # And Reload services sudo service php5-fpm reload sudo service nginx reload - sudo yunohost app ssowatconf diff --git a/scripts/upgrade b/scripts/upgrade index de58645..6253053 100644 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -19,9 +19,39 @@ domain=$(ynh_app_setting_get $app domain) path_url=$(ynh_app_setting_get $app path) final_path=$(ynh_app_setting_get $app final_path) -CHECK_PATH # Vérifie et corrige la syntaxe du path. +#================================================= +# BACKUP BEFORE UPGRADE THEN ACTIVE TRAP +#================================================= +# Backup the current version of the app +ynh_backup_before_upgrade +ynh_clean_setup () { + # restore it if the upgrade fails + ynh_restore_upgradebackup +} +# Exit if an error occurs during the execution of the script +ynh_abort_if_errors +# Add Dependencies +pkg_dependencies="php5-cli php5-imagick php5-gd php5-mcrypt" +if [ "$(lsb_release --codename --short)" != "jessie" ]; then + pkg_dependencies="$pkg_dependencies php-xml" +fi +ynh_install_app_dependencies $pkg_dependencies + +# Create a temporary directory +tmpdir="$(mktemp -d)" +# Backup the config file in the temp dir +cp -a "$final_path/.htconfig.php" "$tmpdir/.htconfig.php" + +# Remove the app directory securely +ynh_secure_remove "$final_path" + +# 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 +fi #================================================= # CHECK THE PATH @@ -30,35 +60,45 @@ CHECK_PATH # Vérifie et corrige la syntaxe du path. # Normalize the URL path syntax path_url=$(ynh_normalize_url_path $path_url) - -# Make backup of old app folder and create again the app folder -sudo mv ${final_path} ${final_path}.old - # Download, check integrity, uncompress and patch the source from app.src ynh_setup_source "$final_path" -sudo cp -a ${final_path}.old/.htconfig.php ${final_path} -sudo rm -Rf ${final_path}.old +sudo cp -a "$tmpdir/.htconfig.php" "${final_path}" +sudo rm -Rf "$tmpdir" #Copy Addons -addons_file=`sudo cat ../conf/friendica-addons/source_file`; -sudo wget -nv -i ../conf/friendica-addons/source_url -O ${addons_file}.zip -sudo md5sum -c ../conf/friendica-addons/source_md5 --status || (echo "Corrupt source" >&2 && false) -sudo unzip -q ${addons_file}.zip -d ../conf/friendica-addons/ sudo mkdir $final_path/addon -sudo cp -r ../conf/friendica-addons/${addons_file}/. $final_path/addon +ynh_setup_source "$final_path/addon" "addons" # 3 - some extra folders +sudo mkdir -p "${final_path}/view/smarty3" sudo chmod -R 777 $final_path/view/smarty3 +#================================================= +# CREATE DEDICATED USER +#================================================= +# Create a system user +ynh_system_user_create $app -# Set www-data to owner -sudo chown -R www-data:www-data $final_path +# Set app as owner +chown -R $app: $final_path # Create a dedicated nginx config ynh_add_nginx_config # configure friendica +#================================================= +# PHP-FPM CONFIGURATION +#================================================= + +# Create a dedicated php-fpm config +ynh_add_fpm_config + +# Verify the checksum and backup the file if it's different +ynh_backup_if_checksum_is_different "$final_path/.htconfig.php" +# Recalculate and store the config file checksum into the app settings +ynh_store_file_checksum "$final_path/.htconfig.php" + # Set up poller sed -i "s@YNH_WWW_PATH@$final_path@g" ../conf/poller-cron sudo cp ../conf/poller-cron /etc/cron.d/$app