diff --git a/.project b/.project deleted file mode 100644 index 42dc69a..0000000 --- a/.project +++ /dev/null @@ -1,11 +0,0 @@ - - - emailpoubelle_ynh - - - - - - - - diff --git a/README.md b/README.md index bb240d0..08e915a 100644 --- a/README.md +++ b/README.md @@ -1,39 +1,54 @@ -# Emailpoubelle + -[![Integration level](https://dash.yunohost.org/integration/emailpoubelle.svg)](https://ci-apps.yunohost.org/jenkins/job/emailpoubelle%20%28Community%29/lastBuild/consoleFull) -[![Install emailpoubelle with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=emailpoubelle) +# EmailPoubelle for YunoHost + +[![Integration level](https://dash.yunohost.org/integration/emailpoubelle.svg)](https://dash.yunohost.org/appci/app/emailpoubelle) ![Working status](https://ci-apps.yunohost.org/ci/badges/emailpoubelle.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/emailpoubelle.maintain.svg) +[![Install EmailPoubelle with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=emailpoubelle) + +*[Lire ce readme en français.](./README_fr.md)* + +> *This package allows you to install EmailPoubelle quickly and simply on a YunoHost server. +If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.* + +## Overview A Yunohost version of [Email Poubelle](http://www.mercereau.info/sortie-de-la-version-1-0-demailpoubelle-php-email-jetable-auto-hebergeable/) by David Mercereau. EmailPoubelle (Trash email) is a script to create temporay email adresses that aims to your real email address -All thanks to David. +All thanks to David. + + +**Shipped version:** 2022.06.08~ynh1 + +**Demo:** https://poubelle.zici.fr +## Disclaimers / important information ## WARNING Using this will cause to disable the Yunohost ldap aliases ! Once installed, you won't be able to use the aliasses settings that you can see when you modify your personnal settings in the SSOWAT pannel. -Of course, once uninstalled, everything get back to normal. +Of course, once uninstalled, everything get back to normal. -## Links +## Documentation and resources - * Report a bug: https://github.com/YunoHost-Apps/emailpoubelle_ynh/issues - * App website: https://github.com/kepon85/emailPoubelle.php - * YunoHost website: https://yunohost.org/ +* Official app website: +* Upstream app code repository: +* YunoHost documentation for this app: +* Report a bug: ---- +## Developer info -Developers info ----------------- - -Please do your pull request to the [testing branch](https://github.com/Yunohost-Apps/emailpoubelle_ynh/tree/Testing). +Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/emailpoubelle_ynh/tree/testing). To try the testing branch, please proceed like that. -``` -sudo yunohost app install https://github.com/Yunohost-Apps/emailpoubelle_ynh/tree/Testing --debug + +``` bash +sudo yunohost app install https://github.com/YunoHost-Apps/emailpoubelle_ynh/tree/testing --debug or -sudo yunohost app upgrade emailpoubelle -u https://github.com/Yunohost-Apps/emailpoubelle_ynh/tree/Testing --debug +sudo yunohost app upgrade emailpoubelle -u https://github.com/YunoHost-Apps/emailpoubelle_ynh/tree/testing --debug ``` -## LICENCE - -Package and software are GPL 3.0 \ No newline at end of file +**More info regarding app packaging:** diff --git a/README_fr.md b/README_fr.md new file mode 100644 index 0000000..586c816 --- /dev/null +++ b/README_fr.md @@ -0,0 +1,54 @@ + + +# EmailPoubelle pour YunoHost + +[![Niveau d'intégration](https://dash.yunohost.org/integration/emailpoubelle.svg)](https://dash.yunohost.org/appci/app/emailpoubelle) ![Statut du fonctionnement](https://ci-apps.yunohost.org/ci/badges/emailpoubelle.status.svg) ![Statut de maintenance](https://ci-apps.yunohost.org/ci/badges/emailpoubelle.maintain.svg) +[![Installer EmailPoubelle avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=emailpoubelle) + +*[Read this readme in english.](./README.md)* + +> *Ce package vous permet d'installer EmailPoubelle rapidement et simplement sur un serveur YunoHost. +Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l'installer et en profiter.* + +## Vue d'ensemble + +A Yunohost version of [Email Poubelle](http://www.mercereau.info/sortie-de-la-version-1-0-demailpoubelle-php-email-jetable-auto-hebergeable/) by David Mercereau. + +EmailPoubelle (Trash email) is a script to create temporay email adresses that aims to your real email address + +All thanks to David. + + +**Version incluse :** 2022.06.08~ynh1 + +**Démo :** https://poubelle.zici.fr +## Avertissements / informations importantes + +## WARNING + +Using this will cause to disable the Yunohost ldap aliases ! Once installed, you won't be able to use the aliasses settings that you can see when you modify your personnal settings in the SSOWAT pannel. +Of course, once uninstalled, everything get back to normal. + +## Documentations et ressources + +* Site officiel de l'app : +* Dépôt de code officiel de l'app : +* Documentation YunoHost pour cette app : +* Signaler un bug : + +## Informations pour les développeurs + +Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/emailpoubelle_ynh/tree/testing). + +Pour essayer la branche testing, procédez comme suit. + +``` bash +sudo yunohost app install https://github.com/YunoHost-Apps/emailpoubelle_ynh/tree/testing --debug +ou +sudo yunohost app upgrade emailpoubelle -u https://github.com/YunoHost-Apps/emailpoubelle_ynh/tree/testing --debug +``` + +**Plus d'infos sur le packaging d'applications :** diff --git a/check_process b/check_process index 321fbee..4152b6e 100644 --- a/check_process +++ b/check_process @@ -1,30 +1,24 @@ -;; Complete Test -# Comment ignored +;; Test complet ; Manifest - domain="domain.tld" (DOMAIN) - path="/poubelle" (PATH) - admin="john" (USER) - is_public=1 (PUBLIC|public=1|private=0) - password="password" + domain="domain.tld" + path="/poubelle" + is_public=1 + admin="john" + password="1Strong-Password" ; Checks pkg_linter=1 setup_sub_dir=1 setup_root=1 + setup_nourl=0 setup_private=1 setup_public=1 -# upgrade=1 from_commit=1d375c45011ad5ab92c038120c7275580479fbc6 upgrade=1 + # 2.0~ynh5 + upgrade=1 from_commit=d83328c3e0d7dbbc317ded2924ac08ba3cc51d3e backup_restore=1 multi_instance=0 - incorrect_path=1 - port_already_use=0 (XXXX) + port_already_use=0 change_url=0 -;;; Levels - Level 5=auto ;;; Options Email= Notification=none -;;; Upgrade options - ; commit=1d375c45011ad5ab92c038120c7275580479fbc6 - name=2.0~ynh3 - manifest_arg=domain=DOMAIN&path=PATH&admin=USER&password=pass&is_public=0& \ No newline at end of file diff --git a/conf/app.src b/conf/app.src index 9c13023..5a82027 100644 --- a/conf/app.src +++ b/conf/app.src @@ -1,3 +1,7 @@ -SOURCE_URL=https://github.com/kepon85/emailPoubelle.php/archive/d9f444c7687e3d4597d6d95c33fa96fd1332c1de.zip -SOURCE_SUM=3ab236748b1b912c03ddf4e09c4e7f0304467adadc0012c9b8f434353fe26e46 -SOURCE_FORMAT=zip \ No newline at end of file +SOURCE_URL=https://framagit.org/kepon/emailPoubellePhp/-/archive/d25ae5b243f5dbd8c2b023b80b6406c110843586/emailPoubellePhp-d25ae5b243f5dbd8c2b023b80b6406c110843586.tar.gz +SOURCE_SUM=4b96d268ecf81684a91c31416b16f2b79a7409416dfd67cdd720d4d13b2ae1d8 +SOURCE_SUM_PRG=sha256sum +SOURCE_FORMAT=tar.gz +SOURCE_IN_SUBDIR=true +SOURCE_FILENAME= +SOURCE_EXTRACT=true diff --git a/conf/conf-dist.php b/conf/conf-dist.php new file mode 100644 index 0000000..f0a35df --- /dev/null +++ b/conf/conf-dist.php @@ -0,0 +1,102 @@ +/dev/null 2>&1 +define('CRON', false); + +// Fichier d'alias postfix +define('FICHIERALIAS', DATA.'/virtual'); +define('BIN_POSTMAP', '/usr/sbin/postmap'); + +define('URLPAGE', 'https://'.$_SERVER["SERVER_NAME"].$_SERVER["SCRIPT_NAME"]); + +// Email +define('EMAILTAGSUJET', '[EmailPoubelle]'); +// From de l'email +define('EMAILFROM', '"NO REPLAY emailPoubelle" '); +define('EMAILEND', 'emailPoubelle.zici.fr'); + +// Alisas interdit : (regex ligne par ligne) - commenter pour désactiver +define('ALIASDENY', DATA.'/aliasdeny.txt'); + +// Blackliste d'email : (regex ligne par ligne) - commenter pour désactiver +define('BLACKLIST', DATA.'/blacklist.txt'); + +// Depend pear Net/DNS2 +define('CHECKMX', false); +if (CHECKMX) { + require_once('Net/DNS2.php'); + // Serveur DNS pour la résolution/vérification du nom de domaine + define('NS1', 'ns1.fdn.org'); + define('NS2', '8.8.8.8'); +} + +// A indiquer si vous utiliser les URL's rewriting +// Exemple avec un htaccess +// RewriteRule ^ep-([a-z]+)-([a-zA-Z0-9+/=]+)\.html$ switch.php?page=emailPoubelle&act=$1&value=$2 [L] +//define('URLREWRITE_START', 'http://poubelle.zici.fr/ep-'); +//define('URLREWRITE_MIDDLE', '-'); +//define('URLREWRITE_END', '.html'); +// Désactiver +define('URLREWRITE_START', false); +define('URLREWRITE_MIDDLE', false); +define('URLREWRITE_END', false); + +// check update : +// enable : in seconds +// disable : false +define('CHECKUPDATE', 86400); + +// Maintenance mode +define('MAINTENANCE_MODE', false); +// No maintenance for this ip (admin ip) +define('MAINTENANCE_IP', '10.0.0.1'); + + +// Mot de passe par défaut "admin" : +define('ADMIN_PASSWORD', '__PASSWORD__'); + + +?> diff --git a/conf/index_source.php b/conf/index_source.php index 587c8d5..3065f03 100644 --- a/conf/index_source.php +++ b/conf/index_source.php @@ -1,12 +1,12 @@ -emailPoubelle - Template-exemple +emailPoubelle - __DOMAIN__ - - + +
- EmailPoubelle + EmailPoubelle
diff --git a/conf/nginx.conf b/conf/nginx.conf index f68d0a7..1b27d14 100644 --- a/conf/nginx.conf +++ b/conf/nginx.conf @@ -2,19 +2,18 @@ location __PATH__/ { # Path to source - alias __FINALPATH__/ ; + alias __FINALPATH__/www/ ; - # Force usage of https - if ($scheme = http) { - rewrite ^ https://$server_name$request_uri? permanent; - } + index index.php; + + # Common parameter to increase upload size limit in conjunction with dedicated php-fpm file + #client_max_body_size 50M; -### PHP configuration - index www/index.php; try_files $uri $uri/ index.php; location ~ [^/]\.php(/|$) { fastcgi_split_path_info ^(.+?\.php)(/.*)$; - fastcgi_pass unix:/var/run/php/php7.0-fpm.sock; + fastcgi_pass unix:/var/run/php/php__PHPVERSION__-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 new file mode 100644 index 0000000..92c8066 --- /dev/null +++ b/conf/php-fpm.conf @@ -0,0 +1,430 @@ +; Start a new pool named 'www'. +; the variable $pool can be used in any directive and will be replaced by the +; pool name ('www' here) +[__NAMETOCHANGE__] + +; 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 +; Note: The user is mandatory. If the group is not set, the default user's group +; will be used. +user = __USER__ +group = __USER__ + +; The address on which to accept FastCGI requests. +; Valid syntaxes are: +; 'ip.add.re.ss:port' - to listen on a TCP socket to a specific IPv4 address on +; a specific port; +; '[ip:6:addr:ess]:port' - to listen on a TCP socket to a specific IPv6 address on +; a specific port; +; 'port' - to listen on a TCP socket to all addresses +; (IPv6 and IPv4-mapped) on a specific port; +; '/path/to/unix/socket' - to listen on a unix socket. +; Note: This value is mandatory. +listen = /var/run/php/php__PHPVERSION__-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 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 = 5 + +; 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: /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. 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: 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'. +; Available units: s(econds)(default), m(inutes), h(ours), or d(ays) +; Default Value: 0 +;request_slowlog_timeout = 0 + +; 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__/www + +; 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 + +; 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 + +; Limits the extensions of the main script FPM will allow to parse. This can +; prevent configuration mistakes on the web server side. You should only limit +; FPM to .php extensions to prevent malicious users to use other extensions to +; execute php code. +; Note: set an empty value to allow all extensions. +; Default Value: .php +;security.limit_extensions = .php .php3 .php4 .php5 .php7 + +; Pass environment variables like LD_LIBRARY_PATH. All $VARIABLEs are taken from +; the current environment. +; Default Value: clean env +;env[HOSTNAME] = $HOSTNAME +;env[PATH] = /usr/local/bin:/usr/bin:/bin +;env[TMP] = /tmp +;env[TMPDIR] = /tmp +;env[TEMP] = /tmp + +; Additional php.ini defines, specific to this pool of workers. These settings +; overwrite the values previously defined in the php.ini. The directives are the +; same as the PHP SAPI: +; php_value/php_flag - you can set classic ini defines which can +; be overwritten from PHP call 'ini_set'. +; php_admin_value/php_admin_flag - these directives won't be overwritten by +; PHP call 'ini_set' +; For php_*flag, valid values are on, off, 1, 0, true, false, yes or no. + +; Defining 'extension' will load the corresponding shared extension from +; extension_dir. Defining 'disable_functions' or 'disable_classes' will not +; overwrite previously defined php.ini values, but will append the new value +; instead. + +; Note: path INI options can be relative and will be expanded with the prefix +; (pool, global or /usr) + +; Default Value: nothing is defined by default except the values in php.ini and +; specified at startup with the -d argument +;php_admin_value[sendmail_path] = /usr/sbin/sendmail -t -i -f www@my.domain.com +;php_flag[display_errors] = off +;php_admin_value[error_log] = /var/log/fpm-php.www.log +;php_admin_flag[log_errors] = on +;php_admin_value[memory_limit] = 32M + +; Common values to change to increase file upload limit +; php_admin_value[upload_max_filesize] = 50M +; php_admin_value[post_max_size] = 50M +; php_admin_flag[mail.add_x_header] = Off + +; Other common parameters +; php_admin_value[max_execution_time] = 600 +; php_admin_value[max_input_time] = 300 +; php_admin_value[memory_limit] = 256M +; php_admin_flag[short_open_tag] = On diff --git a/doc/.gitkeep b/doc/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/doc/DESCRIPTION.md b/doc/DESCRIPTION.md new file mode 100644 index 0000000..55f018b --- /dev/null +++ b/doc/DESCRIPTION.md @@ -0,0 +1,5 @@ +A Yunohost version of [Email Poubelle](http://www.mercereau.info/sortie-de-la-version-1-0-demailpoubelle-php-email-jetable-auto-hebergeable/) by David Mercereau. + +EmailPoubelle (Trash email) is a script to create temporay email adresses that aims to your real email address + +All thanks to David. diff --git a/doc/DISCLAIMER.md b/doc/DISCLAIMER.md new file mode 100644 index 0000000..5a9d937 --- /dev/null +++ b/doc/DISCLAIMER.md @@ -0,0 +1,4 @@ +## WARNING + +Using this will cause to disable the Yunohost ldap aliases ! Once installed, you won't be able to use the aliasses settings that you can see when you modify your personnal settings in the SSOWAT pannel. +Of course, once uninstalled, everything get back to normal. diff --git a/doc/screenshots/.gitkeep b/doc/screenshots/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/manifest.json b/manifest.json index 74892e8..5e2b2c6 100644 --- a/manifest.json +++ b/manifest.json @@ -6,15 +6,21 @@ "en": "Create throwable email address redirected to your real one", "fr": "Créez des adresses email jetables qui redirigent les mails vers votre adresse réelle" }, + "version": "2022.06.08~ynh1", "url": "https://framagit.org/kepon/emailPoubellePhp/", - "version": "2.0~ynh5", + "upstream": { + "license": "Beerware", + "website": "https://forge.zici.fr/project/view/6", + "demo": "https://poubelle.zici.fr", + "code": "https://framagit.org/kepon/emailPoubellePhp" + }, "license": "Beerware", "maintainer": { "name": "Krakinou", "email": "misterl56@hotmail.com" }, - "requirements": { - "yunohost": ">= 3.5.2" + "requirements": { + "yunohost": ">= 4.3.0" }, "multi_instance": false, "services": [ @@ -24,60 +30,29 @@ "postfix" ], "arguments": { - "install" : [ + "install": [ { "name": "domain", - "type": "domain", - "ask": { - "en": "Choose a domain for emailpoubelle", - "fr": "Choisissez un domaine pour emailpoubelle" - }, - "example": "domain.org" + "type": "domain" }, { "name": "path", "type": "path", - "ask": { - "en": "Choose a path for emailpoubelle", - "fr": "Choisissez un chemin pour emailpoubelle" - }, "example": "/poubelle", "default": "/poubelle" }, + { + "name": "is_public", + "type": "boolean", + "default": false + }, { "name": "admin", - "type": "user", - "ask": { - "en": "Choose an admin user for emailpoubelle", - "fr": "Choisissez un administrateur pour emailpoubelle" - }, - "example": "homer", - "help": { - "en": "Admin user can access to the control panel, block and remove all redirection and reset any settings", - "fr": "L'administrateur peut accéder au panneau de controle, bloquer et supprimer les redirections ainsi que réinitialiser les réglages" - } + "type": "user" }, { "name": "password", - "type": "password", - "ask": { - "en": "Enter a password to access the admin panel", - "fr": "Entrer un mot de passe pour accéder au tableau d'administration" - }, - "example": "AveryStrongPassword" - }, - { - "name": "is_public", - "type": "boolean", - "ask": { - "en": "Is it a public application?", - "fr": "Est-ce une application publique ?" - }, - "default": false, - "help": { - "en": "The app can be accessed outside Yunohost and anyone will be able to create a trash email adress", - "fr": "L'application sera accessible en dehors de yunohost et n'importe qui pourra y créer une adresse poubelle" - } + "type": "password" } ] } diff --git a/scripts/_common.sh b/scripts/_common.sh index f1cb75a..6250b66 100644 --- a/scripts/_common.sh +++ b/scripts/_common.sh @@ -1,6 +1,21 @@ +#!/bin/bash + #================================================= # COMMON VARIABLES #================================================= -pkg_dependencies="php-geoip php7.0-cli" -app="emailpoubelle" + +# dependencies used by the app +pkg_dependencies="php$YNH_DEFAULT_PHP_VERSION-geoip php$YNH_DEFAULT_PHP_VERSION-cli" lang="fr_FR.UTF-8 en_US.UTF-8 it_IT.UTF-8" + +#================================================= +# PERSONAL HELPERS +#================================================= + +#================================================= +# EXPERIMENTAL HELPERS +#================================================= + +#================================================= +# FUTURE OFFICIAL HELPERS +#================================================= diff --git a/scripts/backup b/scripts/backup index d640ec4..049cff2 100644 --- a/scripts/backup +++ b/scripts/backup @@ -2,16 +2,11 @@ #================================================= # 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 + +# Keep this path for calling _common.sh inside the execution's context of backup and restore scripts source ../settings/scripts/_common.sh source /usr/share/yunohost/helpers @@ -25,53 +20,57 @@ ynh_abort_if_errors #================================================= # LOAD SETTINGS #================================================= -ynh_script_progression --message="Loading installation settings..." +ynh_print_info --message="Loading installation settings..." app=$YNH_APP_INSTANCE_NAME -final_path=$(ynh_app_setting_get $app final_path) -domain=$(ynh_app_setting_get $app domain) -db_name=$(ynh_app_setting_get $app db_name) +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) +phpversion=$(ynh_app_setting_get --app=$app --key=phpversion) #================================================= -# STANDARD BACKUP STEPS +# DECLARE DATA AND CONF FILES TO BACKUP +#================================================= +ynh_print_info --message="Declaring files to be backed up..." + #================================================= # BACKUP THE APP MAIN DIR #================================================= -ynh_script_progression --message="Backing up the main app directory..." ynh_backup --src_path="$final_path" #================================================= # BACKUP THE NGINX CONFIGURATION #================================================= -ynh_script_progression --message="Backing up nginx web server configuration..." ynh_backup --src_path="/etc/nginx/conf.d/$domain.d/$app.conf" #================================================= -# BACKUP THE MYSQL DATABASE +# BACKUP THE PHP-FPM CONFIGURATION #================================================= -ynh_script_progression --message="Backing up the MySQL database..." -ynh_mysql_dump_db "$db_name" > db.sql +ynh_backup --src_path="/etc/php/$phpversion/fpm/pool.d/$app.conf" #================================================= -# BACKUP THE CRON FILE +# SPECIFIC BACKUP +#================================================= +# BACKUP VARIOUS FILES #================================================= -ynh_script_progression --message="Backing up cron configuration..." ynh_backup --src_path="/etc/cron.d/$app" -#================================================= -# BACKUP postfix conf -#================================================= -ynh_script_progression --message="Backing up postfix conf configuration..." +ynh_backup --src_path="/usr/share/yunohost/hooks/conf_regen/98-postfix_emailpoubelle" -ynh_backup "/usr/share/yunohost/hooks/conf_regen/98-postfix_emailpoubelle" +#================================================= +# BACKUP THE MYSQL DATABASE +#================================================= +ynh_print_info --message="Backing up the MySQL database..." + +ynh_mysql_dump_db --database="$db_name" > db.sql #================================================= # END OF SCRIPT #================================================= -ynh_script_progression --message="Backup script completed for $app. (YunoHost will then actually copy those files to the archive)." --last +ynh_print_info --message="Backup script completed for $app. (YunoHost will then actually copy those files to the archive)." diff --git a/scripts/install b/scripts/install index e52c69f..04736eb 100644 --- a/scripts/install +++ b/scripts/install @@ -5,155 +5,174 @@ #================================================= # IMPORT GENERIC HELPERS #================================================= + 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 -# Retrieve arguments +#================================================= +# RETRIEVE ARGUMENTS FROM THE MANIFEST +#================================================= + domain=$YNH_APP_ARG_DOMAIN path_url=$YNH_APP_ARG_PATH -admin=$YNH_APP_ARG_ADMIN -ynh_print_OFF -password=$YNH_APP_ARG_PASSWORD -ynh_print_ON is_public=$YNH_APP_ARG_IS_PUBLIC -final_path=/var/www/$app -db_user=emailPoubelle +admin=$YNH_APP_ARG_ADMIN +password=$YNH_APP_ARG_PASSWORD + +app=$YNH_APP_INSTANCE_NAME #================================================= # CHECK IF THE APP CAN BE INSTALLED WITH THESE ARGS #================================================= ynh_script_progression --message="Validating installation parameters..." --weight=1 + 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" -# 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 - -# Check user -ynh_user_exists "$admin" +ynh_webpath_register --app=$app --domain=$domain --path_url=$path_url #================================================= # STORE SETTINGS FROM MANIFEST #================================================= ynh_script_progression --message="Storing installation settings..." --weight=1 -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 db_name $db_user -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=admin --value=$admin +ynh_app_setting_set --app=$app --key=password --value=$password #================================================= -#INSTALL DEPENDENCIES +# STANDARD MODIFICATIONS +#================================================= +# INSTALL DEPENDENCIES #================================================= ynh_script_progression --message="Installing dependencies..." --weight=15 + ynh_install_app_dependencies $pkg_dependencies #install locale (nginx will restart at the end of the install) for i in $lang ; do - ynh_replace_string "# $i" "$i" /etc/locale.gen + ynh_replace_string --match_string="# $i" --replace_string="$i" --target_file="/etc/locale.gen" done locale-gen #================================================= -#INSTALL SOURCES -#=============================================== +# CREATE DEDICATED USER +#================================================= +ynh_script_progression --message="Configuring system user..." +# Create a system user +ynh_system_user_create --username=$app --home_dir="$final_path" + +#================================================= +# CREATE A MYSQL DATABASE +#================================================= +ynh_script_progression --message="Creating a MySQL database..." + +db_name=$(ynh_sanitize_dbid --db_name=$app) +db_user=$db_name +ynh_app_setting_set --app=$app --key=db_name --value=$db_name +ynh_mysql_setup_db --db_user=$db_user --db_name=$db_name + +#================================================= +# DOWNLOAD, CHECK AND UNPACK SOURCE +#================================================= ynh_script_progression --message="Setting up source files..." --weight=5 + +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 "$final_path" -cp ../conf/index_source.php $final_path/www/index.php -ynh_replace_string "Template-exemple" "$domain" $final_path/www/index.php +ynh_setup_source --dest_dir="$final_path" +ynh_add_config --template="../conf/index_source.php" --destination="$final_path/www/index.php" +ynh_secure_remove --file="$final_path/www/admin.php" -#Temporaire - mettre en config -ln -s $final_path/lang/fr $final_path/lang/fr_FR -ln -s $final_path/lang/it $final_path/lang/it_IT -ln -s $final_path/www/template-exemple $final_path/template-exemple +ln -s $final_path/lib $final_path/www/lib +chmod 750 "$final_path" +chmod -R o-rwx "$final_path" +chown -R $app:www-data "$final_path" -#=============================================== -#SETTINGS & DATABASE -#=============================================== -ynh_script_progression --message="Setting database & settings..." +#================================================= +# PHP-FPM CONFIGURATION +#================================================= +ynh_script_progression --message="Configuring PHP-FPM..." -#generating random password for database -ynh_print_OFF -db_pwd=$(ynh_string_random) -ynh_app_setting_set $app mysqlpwd $db_pwd -ynh_print_ON +# Create a dedicated PHP-FPM config +ynh_add_fpm_config -#configuring with given settings -cp $final_path/conf-dist.php $final_path/conf.php -#Update various conf : domain, database, user and password -ynh_replace_string "exemple.fr" "$domain" $final_path/conf.php -ynh_replace_string "exemple.com" "$domain" $final_path/conf.php -ynh_replace_string "define('DB', 'sqlite:'" "//define('DB', 'sqlite:'" $final_path/conf.php -ynh_replace_string "define('ALIASLIMITBYMAIL" "//define('ALIASLIMITBYMAIL" $final_path/conf.php -ynh_replace_string "// define('DB', 'mysql" " define('DB', 'mysql" $final_path/conf.php -ynh_replace_string "// define('DBUSER'," " define('DBUSER'," $final_path/conf.php -ynh_replace_string "// define('DBPASS'," " define('DBPASS'," $final_path/conf.php -ynh_replace_string "baseMysql" "$db_user" $final_path/conf.php -ynh_replace_string "utilisateurMysql" "$db_user" $final_path/conf.php -ynh_print_OFF -ynh_replace_string "motdepassedefou" "$db_pwd" $final_path/conf.php -ynh_replace_string "define('ADMIN_PASSWORD', 'admin');" "define('ADMIN_PASSWORD', '$password');" $final_path/conf.php -ynh_print_ON -#setting conf file not world-readable (dude, there is a plain-text password !) -chmod o-r $final_path/conf.php -#initialize database (databasename = db_user) -ynh_print_OFF -ynh_mysql_create_db $db_user $db_user $db_pwd -ynh_print_ON +#================================================= +# NGINX CONFIGURATION +#================================================= +ynh_script_progression --message="Configuring NGINX web server..." -#setting postfix to use virtual aliases file +# Create a dedicated NGINX config +ynh_add_nginx_config + +#================================================= +# SPECIFIC SETUP +#================================================= +# ADD A CONFIGURATION +#================================================= +ynh_script_progression --message="Adding a configuration file..." + +ynh_add_config --template="../conf/conf-dist.php" --destination="$final_path/conf.php" + +chmod 400 "$final_path/conf.php" +chown $app:$app "$final_path/conf.php" + +# Setting postfix to use virtual aliases file # Add postfix configuration hook and regen postfix conf cp -R ../sources/hooks/conf_regen/98-postfix_emailpoubelle /usr/share/yunohost/hooks/conf_regen/ yunohost tools regen-conf postfix -#create the virtual aliases file +# Create the virtual aliases file touch $final_path/var/virtual postmap $final_path/var/virtual -chown -R www-data:www-data $final_path +chown -R $app:www-data "$final_path" -#create an alias for deleted junk adresses +# Create an alias for deleted junk adresses cp /etc/aliases /etc/aliases.emailpoubelle.bak #backup it echo "devnull:/dev/null" | tee -a /etc/aliases newaliases +ynh_systemd_action --service_name=postfix --action=reload -#adding cronjob for removing expired email addresses -cp -a ../conf/$app.cron /etc/cron.d/$app +# Adding cronjob for removing expired email addresses +ynh_add_config --template="../conf/emailpoubelle.cron" --destination="/etc/cron.d/$app" chown root:root /etc/cron.d/$app chmod 644 /etc/cron.d/$app -# Create a dedicated nginx config -ynh_script_progression --message="Configuring nginx web server..." --weight=2 -ynh_add_nginx_config - +#================================================= +# GENERIC FINALIZATION #================================================= # SETUP SSOWAT #================================================= +ynh_script_progression --message="Configuring permissions..." # Make app public if necessary if [ $is_public -eq 1 ] then - # unprotected_uris allows SSO credentials to be passed anyway. - ynh_app_setting_set $app unprotected_uris "/" + # Everyone can access the app. + # The "main" permission is automatically created before the install script. + ynh_permission_update --permission="main" --add="visitors" fi #================================================= -# RELOAD SERVICES +# RELOAD NGINX #================================================= +ynh_script_progression --message="Reloading NGINX web server..." + ynh_systemd_action --service_name=nginx --action=reload -ynh_systemd_action --service_name=postfix --action=reload -service php* reload + +#================================================= +# END OF SCRIPT +#================================================= + ynh_script_progression --message="Installation of $app completed" --last diff --git a/scripts/remove b/scripts/remove index 590b955..abfd355 100644 --- a/scripts/remove +++ b/scripts/remove @@ -21,8 +21,8 @@ db_name=$(ynh_app_setting_get --app=$app --key=db_name) db_user=$db_name final_path=$(ynh_app_setting_get --app=$app --key=final_path) - - +#================================================= +# STANDARD REMOVE #================================================= # REMOVE THE MYSQL DATABASE #================================================= @@ -31,17 +31,6 @@ 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_user --db_name=$db_name - - -#================================================= -# REMOVE DEPENDENCIES -#================================================= -ynh_script_progression --message="Removing dependencies..." - -# Remove metapackage and its dependencies -ynh_remove_app_dependencies - - #================================================= # REMOVE APP MAIN DIR #================================================= @@ -54,40 +43,56 @@ ynh_secure_remove --file="$final_path" #================================================= # REMOVE NGINX CONFIGURATION #================================================= -ynh_script_progression --message="Removing nginx web server configuration..." +ynh_script_progression --message="Removing NGINX web server configuration..." -# Remove the dedicated nginx config +# Remove the dedicated NGINX config ynh_remove_nginx_config +#================================================= +# REMOVE PHP-FPM CONFIGURATION +#================================================= +ynh_script_progression --message="Removing PHP-FPM configuration..." + +# Remove the dedicated PHP-FPM config +ynh_remove_fpm_config + +#================================================= +# REMOVE DEPENDENCIES +#================================================= +ynh_script_progression --message="Removing dependencies..." + +# Remove metapackage and its dependencies +ynh_remove_app_dependencies #================================================= # SPECIFIC REMOVE #================================================= -# REMOVE THE CRON FILE +# REMOVE VARIOUS FILES #================================================= -ynh_script_progression --message="Removing cron job and aliases..." +ynh_script_progression --message="Removing various files..." + +# Remove a cron file ynh_secure_remove --file="/etc/cron.d/$app" -#================================================= -#removing aliases -#================================================= -ynh_replace_string "devnull:/dev/null" "" /etc/aliases +ynh_replace_string --match_string="devnull:/dev/null" --replace_string="" --target_file="/etc/aliases" newaliases -#================================================= -# Remove hook for postfix conf -#================================================= - -ynh_secure_remove "/usr/share/yunohost/hooks/conf_regen/98-postfix_emailpoubelle" +ynh_secure_remove --file="/usr/share/yunohost/hooks/conf_regen/98-postfix_emailpoubelle" +yunohost tools regen-conf postfix +ynh_systemd_action --service_name=postfix --action=reload #================================================= # GENERIC FINALIZATION #================================================= # REMOVE DEDICATED USER #================================================= +ynh_script_progression --message="Removing the dedicated system user..." -yunohost tools regen-conf postfix -ynh_systemd_action --service_name=nginx --action=reload -ynh_systemd_action --service_name=postfix --action=reload +# Delete a system user +ynh_system_user_delete --username=$app + +#================================================= +# END OF SCRIPT +#================================================= ynh_script_progression --message="Removal of $app completed" diff --git a/scripts/restore b/scripts/restore index 68cfa32..1cc8432 100644 --- a/scripts/restore +++ b/scripts/restore @@ -1,17 +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 + +# Keep this path for calling _common.sh inside the execution's context of backup and restore scripts source ../settings/scripts/_common.sh source /usr/share/yunohost/helpers @@ -25,52 +20,45 @@ ynh_abort_if_errors #================================================= # LOAD SETTINGS #================================================= -ynh_script_progression --message="Loading settings..." --weight=1 +ynh_script_progression --message="Loading installation settings..." --weight=1 app=$YNH_APP_INSTANCE_NAME -domain=$(ynh_app_setting_get $app domain) -path_url=$(ynh_app_setting_get $app path) -final_path=$(ynh_app_setting_get $app final_path) -db_name=$(ynh_app_setting_get $app db_name) -admin=$(ynh_app_setting_get $app admin) +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) +db_user=$db_name +phpversion=$(ynh_app_setting_get --app=$app --key=phpversion) #================================================= # CHECK IF THE APP CAN BE RESTORED #================================================= ynh_script_progression --message="Validating restoration parameters..." --weight=1 -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 " - -# Check user -ynh_user_exists "$admin" + || ynh_die --message="There is already a directory: $final_path " #================================================= # STANDARD RESTORATION STEPS #================================================= -# RESTORE THE NGINX CONFIGURATION +# RECREATE THE DEDICATED USER #================================================= +ynh_script_progression --message="Recreating the dedicated system user..." -ynh_restore_file "/etc/nginx/conf.d/$domain.d/$app.conf" +# Create the dedicated user (if not existing) +ynh_system_user_create --username=$app --home_dir="$final_path" #================================================= # RESTORE THE APP MAIN DIR #================================================= ynh_script_progression --message="Restoring the app main directory..." --weight=1 -ynh_restore_file "$final_path" +ynh_restore_file --origin_path="$final_path" -#================================================= -# RESTORE THE MYSQL DATABASE -#================================================= -ynh_script_progression --message="Restoring the MySQL database..." --weight=1 - -db_pwd=$(ynh_app_setting_get $app mysqlpwd) -ynh_mysql_setup_db $db_name $db_name $db_pwd -ynh_mysql_connect_as $db_name $db_pwd $db_name < ./db.sql +chmod 750 "$final_path" +chmod -R o-rwx "$final_path" +chown -R $app:www-data "$final_path" #================================================= # SPECIFIC RESTORATION @@ -81,19 +69,44 @@ ynh_script_progression --message="Reinstalling dependencies..." --weight=15 # Define and install dependencies ynh_install_app_dependencies $pkg_dependencies + #Check & regen local for i in $lang ; do - ynh_replace_string "# $i" "$i" /etc/locale.gen + ynh_replace_string --match_string="# $i" --replace_string="$i" --target_file="/etc/locale.gen" done locale-gen +#================================================= +# RESTORE THE PHP-FPM CONFIGURATION +#================================================= +ynh_script_progression --message="Restoring the PHP-FPM configuration..." + +ynh_restore_file --origin_path="/etc/php/$phpversion/fpm/pool.d/$app.conf" #================================================= -# RESTORE POSTFIX ALIASES +# RESTORE THE NGINX CONFIGURATION #================================================= -ynh_script_progression --message="Restore Postfix aliases..." --weight=10 +ynh_script_progression --message="Restoring the NGINX web server configuration..." --time --weight=1 -ynh_restore_file "/usr/share/yunohost/hooks/conf_regen/98-postfix_emailpoubelle" +ynh_restore_file --origin_path="/etc/nginx/conf.d/$domain.d/$app.conf" + +#================================================= +# RESTORE THE MYSQL DATABASE +#================================================= +ynh_script_progression --message="Restoring the MySQL database..." --weight=1 + +db_pwd=$(ynh_app_setting_get --app=$app --key=mysqlpwd) +ynh_mysql_setup_db --db_user=$db_user --db_name=$db_name --db_pwd=$db_pwd +ynh_mysql_connect_as --user=$db_user --password=$db_pwd --database=$db_name < ./db.sql + +#================================================= +# RESTORE VARIOUS FILES +#================================================= +ynh_script_progression --message="Restoring various files..." --weight=10 + +ynh_restore_file --origin_path="/etc/cron.d/$app" + +ynh_restore_file --origin_path="/usr/share/yunohost/hooks/conf_regen/98-postfix_emailpoubelle" yunohost tools regen-conf postfix #create an alias for deleted junk adresses @@ -103,27 +116,20 @@ if ! grep -q "devnull:/dev/null" /etc/aliases ; then newaliases fi -#================================================= -# RESTORE THE CRON FILE -#================================================= -ynh_script_progression --message="Reinstall cron job" --weight=1 - -ynh_restore_file "/etc/cron.d/$app" +ynh_systemd_action --service_name=postfix --action=reload #================================================= # GENERIC FINALIZATION #================================================= -# RELOAD NGINX & ALIASES +# RELOAD NGINX AND PHP-FPM #================================================= -ynh_script_progression --message="Reloading nginx web server and php-fpm..." --weight=1 +ynh_script_progression --message="Reloading NGINX web server and PHP-FPM..." -postmap $final_path/var/virtual -ynh_systemd_action --service_name=php7.0-fpm --action=restart +ynh_systemd_action --service_name=php$phpversion-fpm --action=reload ynh_systemd_action --service_name=nginx --action=reload -ynh_systemd_action --service_name=postfix --action=reload #================================================= # END OF SCRIPT #================================================= -ynh_script_progression --message="Restoration completed for $app" --last \ No newline at end of file +ynh_script_progression --message="Restoration completed for $app" --last diff --git a/scripts/upgrade b/scripts/upgrade index ac92353..747c1ca 100644 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -5,46 +5,59 @@ #================================================= # IMPORT GENERIC HELPERS #================================================= + source _common.sh 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) -path_url=$(ynh_app_setting_get $app path) -is_public=$(ynh_app_setting_get --app=$app --key=is_public) -admin=$(ynh_app_setting_get $app admin) -final_path=$(ynh_app_setting_get $app final_path) -db_name=$(ynh_app_setting_get $app db_name) + +domain=$(ynh_app_setting_get --app=$app --key=domain) +path_url=$(ynh_app_setting_get --app=$app --key=path) +admin=$(ynh_app_setting_get --app=$app --key=admin) +final_path=$(ynh_app_setting_get --app=$app --key=final_path) +db_name=$(ynh_app_setting_get --app=$app --key=db_name) +db_user=$db_name +db_pwd=$(ynh_app_setting_get --app=$app --key=mysqlpwd) +password=$(ynh_app_setting_get --app=$app --key=password) #================================================= # CHECK VERSION #================================================= +ynh_script_progression --message="Checking version..." -### This helper will compare the version of the currently installed app and the version of the upstream package. -### $upgrade_type can have 2 different values -### - UPGRADE_APP if the upstream app version has changed -### - UPGRADE_PACKAGE if only the YunoHost package has changed -### ynh_check_app_version_changed will stop the upgrade if the app is up to date. -### UPGRADE_APP should be used to upgrade the core app only if there's an upgrade to do. -### Not used yet in this script upgrade_type=$(ynh_check_app_version_changed) +#================================================= +# BACKUP BEFORE UPGRADE THEN ACTIVE TRAP +#================================================= +ynh_script_progression --message="Backing up the app before upgrading (may take a while)..." + +# 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 + +#================================================= +# STANDARD UPGRADE STEPS #================================================= # ENSURE DOWNWARD COMPATIBILITY #================================================= ynh_script_progression --message="Ensuring downward compatibility..." -# Fix is_public as a boolean value -if [ "$is_public" = "Yes" ]; then - ynh_app_setting_set --app=$app --key=is_public --value=1 - is_public=1 -elif [ "$is_public" = "No" ]; then - ynh_app_setting_set --app=$app --key=is_public --value=0 - is_public=0 + +# Cleaning legacy permissions +if ynh_legacy_permissions_exists; then + ynh_legacy_permissions_delete_all + + ynh_app_setting_delete --app=$app --key=is_public fi # If db_name doesn't exist, create it @@ -59,150 +72,100 @@ if [ -z "$final_path" ]; then ynh_app_setting_set --app=$app --key=final_path --value=$final_path fi +if [ -z $db_pwd ]; then + db_pwd=$(grep DBPASS $final_path/conf.php | cut -d"'" -f4) + ynh_app_setting_set --app=$app --key=mysqlpwd --value=$db_pwd +fi + +if [ -z $password ]; then + password=$(grep ADMIN_PASSWORD $final_path/conf.php | cut -d"'" -f4) + ynh_app_setting_set --app=$app --key=password --value=$password +fi #================================================= -# BACKUP BEFORE UPGRADE THEN ACTIVE TRAP +# CREATE DEDICATED USER #================================================= -ynh_script_progression --message="Backing up the app before upgrading (may take a while)..." -# 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 +ynh_script_progression --message="Making sure dedicated system user exists..." +# Create a dedicated user (if not existing) +ynh_system_user_create --username=$app --home_dir="$final_path" #================================================= -# CHECK THE PATH +# DOWNLOAD, CHECK AND UNPACK SOURCE #================================================= -# Normalize the URL path syntax -path_url=$(ynh_normalize_url_path $path_url) +if [ "$upgrade_type" == "UPGRADE_APP" ] +then + ynh_script_progression --message="Upgrading source files..." -#================================================= -#check for matlink's version - DEPRECATED - uninstall & reinstall -#================================================= -#deprecated - not maintained for more than a year... -#cat /etc/yunohost/apps/$app/status.json | grep "matlink" -#if [[ $?==0 ]]; then - #add missing info in settings -# final_path=/var/www/$app -# db_name=emailPoubelle -# ynh_app_setting_set $app db_name $db_name -# ynh_app_setting_set $app final_path $final_path - #install geoip dependencies -# ynh_install_app_dependencies $pkg_dependencies - #install locale packages -# for i in $lang ; do -# ynh_replace_string "# $i" "$i" /etc/locale.gen -# done -# locale-gen - #change folder locale => lang as per src2.0 -# rm -rf $final_path/locale -# mkdir -p $final_path/lang - #add new index.php -# cp ../conf/index_source.php $final_path/www/index.php - #switch from previous (modified) conf.php to new one (emailpoubelle original) -# cp ../src/conf-dist.php $final_path/conf-dist.new.php - #insert domain in line 24, DB in line 31, DBUSER in line 32, etc. -# rep=$(cat $final_path/conf.php | grep "^[^//]" | grep "define('DOMAIN',") -# sed -i "24s/.*/${rep}/" $final_path/conf-dist.new.php -# rep=$(cat $final_path/conf.php | grep "^[^//]" | grep "define('DB',") -# sed -i "31s/.*/${rep}/" $final_path/conf-dist.new.php -# rep=$(cat $final_path/conf.php | grep "^[^//]" | grep "define('DBUSER',") -# sed -i "32s/.*/${rep}/" $final_path/conf-dist.new.php -# rep=$(cat $final_path/conf.php | grep "^[^//]" | grep "define('DBPASS',") -# sed -i "33s/.*/${rep}/" $final_path/conf-dist.new.php - #replace old conf and process with install command -# mv $final_path/conf.php $final_path/conf.php.old -# mv $final_path/conf-dist.new.php $final_path/conf.php -# ynh_replace_string "define('DB', 'sqlite:'" "//define('DB', 'sqlite:'" $final_path/conf.php -# ynh_replace_string "define('ALIASLIMITBYMAIL" "//define('ALIASLIMITBYMAIL" $final_path/conf.php -# #setting conf file not world-readable (dude, there is a plain-text password !) -# sudo chmod o-r $final_path/conf.php -#fi + # Download, check integrity, uncompress and patch the source from app.src + ynh_setup_source --dest_dir="$final_path" --keep="conf.php www/index.php" + ynh_add_config --template="../conf/index_source.php" --destination="$final_path/www/index.php" + ynh_secure_remove --file="$final_path/www/admin.php" -#================================================= -# STANDARD UPGRADE STEPS -#================================================= -# NGINX CONFIGURATION -#================================================= -ynh_script_progression --message="Upgrading nginx web server configuration..." + ln -s $final_path/lib $final_path/www/lib +fi -ynh_backup_if_checksum_is_different "/etc/nginx/conf.d/$domain.d/$app.conf" - -# Create a dedicated nginx config -ynh_add_nginx_config +chmod 750 "$final_path" +chmod -R o-rwx "$final_path" +chown -R $app:www-data "$final_path" #================================================= # UPGRADE DEPENDENCIES #================================================= ynh_script_progression --message="Upgrading dependencies..." + ynh_install_app_dependencies $pkg_dependencies #================================================= -#UPDATE SETTINGS +# PHP-FPM CONFIGURATION #================================================= +ynh_script_progression --message="Upgrading PHP-FPM configuration..." -#mysqlpwd setting was implemented in ynh2 - check if saved and if not implement -db_pass=$(ynh_app_setting_get $app mysqlpwd) -if [ -z $db_pass ]; then -#c'est moche mais ça fera bien l'affaire - en deux lignes sinon pb en fonction du type de shell - t=$(cat /var/www/$app/conf.php | grep DBPASS) - db_pass=${t:26:24} - ynh_app_setting_set $app mysqlpwd $db_pass -fi +# Create a dedicated PHP-FPM config +ynh_add_fpm_config #================================================= -#INSTALL SOURCES -#=============================================== +# NGINX CONFIGURATION +#================================================= +ynh_script_progression --message="Upgrading NGINX web server configuration..." -ynh_script_progression --message="Upgrading source files..." -# Download, check integrity, uncompress and patch the source from app.src -ynh_setup_source "$final_path" -cp ../conf/index_source.php $final_path/www/index.php -test -e $final_path/template-exemple -if [[ ! $? -eq 0 ]]; then - ln -s $final_path/www/template-exemple $final_path/template-exemple -fi +# Create a dedicated NGINX config +ynh_add_nginx_config -#Temporaire - mettre en config -if [ ! -e $final_path/lang/fr_FR ]; then -ln -s $final_path/lang/fr $final_path/lang/fr_FR -fi -if [ ! -e $final_path/lang/it_IT ]; then -ln -s $final_path/lang/it $final_path/lang/it_IT -fi +#================================================= +# SPECIFIC UPGRADE +#================================================= +# UPDATE A CONFIG FILE +#================================================= +ynh_script_progression --message="Updating a configuration file..." + +ynh_add_config --template="../conf/conf-dist.php" --destination="$final_path/conf.php" + +chmod 400 "$final_path/conf.php" +chown $app:$app "$final_path/conf.php" -#setting postfix to use virtual aliases file -# Add postfix configuration hook and regen postfix conf -#setting postfix to use virtual aliases file -# Add postfix configuration hook and regen postfix conf cp -R ../sources/hooks/conf_regen/98-postfix_emailpoubelle /usr/share/yunohost/hooks/conf_regen/ mv /etc/postfix/main.cf /etc/postfix/main.cf.emailpoubelle.bak yunohost tools regen-conf postfix -f - -#================================================= -# SECURE FILES AND DIRECTORIES -#================================================= - -chown -R www-data:www-data $final_path -chown root:root /etc/cron.d/$app - - -#================================================= -# RELOAD SERVICES -#================================================= -ynh_script_progression --message="Starting a systemd service..." -ynh_systemd_action --service_name=php7.0-fpm --action=restart - -ynh_script_progression --message="Reloading nginx web server..." -ynh_systemd_action --service_name=nginx --action=reload - -ynh_script_progression --message="Reloading postfix..." ynh_systemd_action --service_name=postfix --action=reload -ynh_script_progression --message="Upgrade of $app completed" --last +# Adding cronjob for removing expired email addresses +ynh_add_config --template="../conf/emailpoubelle.cron" --destination="/etc/cron.d/$app" +chown root:root /etc/cron.d/$app +chmod 644 /etc/cron.d/$app +#================================================= +# GENERIC FINALIZATION +#================================================= +# 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="Upgrade of $app completed"