From 0988cb3daf53b8ec17d121d4b9b64c865cffa1ff Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?F=C3=A9lix=20Pi=C3=A9dallu?= Date: Wed, 17 Jan 2024 11:23:28 +0100 Subject: [PATCH] Manifestv2 --- check_process | 28 --- conf/app.src | 5 - conf/config.php | 48 ++--- conf/extra_php-fpm.conf | 0 conf/ggp.less | 7 +- conf/mimoza.css | 2 +- conf/minimaxing.css | 26 +-- conf/minimaxing.less | 79 ++++---- conf/nginx.conf | 34 ++-- conf/pheditor.php | 2 +- conf/php-fpm.conf | 430 ---------------------------------------- manifest.json | 103 ---------- manifest.toml | 98 +++++++++ scripts/_common.sh | 6 - scripts/backup | 32 +-- scripts/change_url | 86 +------- scripts/install | 191 +++--------------- scripts/remove | 47 +---- scripts/restore | 70 +------ scripts/upgrade | 132 ++---------- tests.toml | 7 + 21 files changed, 270 insertions(+), 1163 deletions(-) delete mode 100755 check_process delete mode 100755 conf/app.src create mode 100755 conf/extra_php-fpm.conf delete mode 100755 conf/php-fpm.conf delete mode 100755 manifest.json create mode 100644 manifest.toml create mode 100644 tests.toml diff --git a/check_process b/check_process deleted file mode 100755 index 53cffea..0000000 --- a/check_process +++ /dev/null @@ -1,28 +0,0 @@ -;; Test complet - auto_remove=1 - ; Manifest - domain="domain.tld" - path="/path" - is_public=1 - language="en" - admin="john" - password="azerty1234" - wiki="My Wiki" - color="328cc1" - ; Checks - pkg_linter=1 - setup_sub_dir=1 - setup_root=1 - setup_nourl=0 - setup_private=1 - setup_public=1 - upgrade=1 - # 3.2.12~ynh1 - upgrade=1 from_commit=a59e01aec10bd3a749ce062d2931906151d8f8be - backup_restore=1 - multi_instance=1 - port_already_use=0 - change_url=1 -;;; Options -Email= -Notification=none diff --git a/conf/app.src b/conf/app.src deleted file mode 100755 index b9a461e..0000000 --- a/conf/app.src +++ /dev/null @@ -1,5 +0,0 @@ -SOURCE_URL=https://sourceforge.net/projects/lionwiki-t2t/files/lionwiki-t2t.zip -SOURCE_SUM=081a05b07446183da5cf065b07cab2baaabe69e57d11b61c0aaf3d187ee2ff30 -SOURCE_SUM_PRG=sha256sum -SOURCE_FORMAT=zip -SOURCE_IN_SUBDIR=true diff --git a/conf/config.php b/conf/config.php index 392fcbb..c523952 100755 --- a/conf/config.php +++ b/conf/config.php @@ -1,16 +1,16 @@ -RSS'; -// if needed (if autodetection doesn't work), force language +// if needed (if autodetection doesn't work), force language //$LANG = fr; -$LANG = __YNH_LANG__; +$LANG = __LANGUAGE__; /* see the file config.t2t to tweak the syntax and even more! */ diff --git a/conf/extra_php-fpm.conf b/conf/extra_php-fpm.conf new file mode 100755 index 0000000..e69de29 diff --git a/conf/ggp.less b/conf/ggp.less index afdd8a4..57a52c7 100755 --- a/conf/ggp.less +++ b/conf/ggp.less @@ -13,7 +13,7 @@ /* font colors:*/ -@MainColor: #__YNH_COLOR__; +@MainColor: #__COLOR__; /* or D17732 */ @FontColor: darken(desaturate(@MainColor, 80%),30%) ; @SecondaryColor: spin(@LinkColor, 25) ; @@ -27,7 +27,7 @@ /*@BackgroundColor: contrast(@FontColor) ; */ /*@BackgroundColor: mix(@MainColor, @LinkColor) ; */ - + @@ -41,7 +41,7 @@ @SecondaryColor: #42C200 ; @LinkColor: #328cc1 ; @LinkColorHover: #d9b310 ; -@BackgroundColor: #FAFAFA ; +@BackgroundColor: #FAFAFA ; */ @@ -548,4 +548,3 @@ progress { color: @MainColor; background-color: @BackgroundColor - #111; bord progress::-moz-progress-bar { background: @MainColor;} progress::-webkit-progress-value { background: @MainColor;} progress::-webkit-progress-bar { background: @MainColor;} - diff --git a/conf/mimoza.css b/conf/mimoza.css index 3ba47b6..fe7fdc0 100644 --- a/conf/mimoza.css +++ b/conf/mimoza.css @@ -1,5 +1,5 @@ :root { - --couleur-primaire: #__YNH_COLOR__; + --couleur-primaire: #__COLOR__; --underline-max-width: 100%; --underline-hover-width: 0; diff --git a/conf/minimaxing.css b/conf/minimaxing.css index 113e361..69e9bcf 100755 --- a/conf/minimaxing.css +++ b/conf/minimaxing.css @@ -3,18 +3,18 @@ -------------- - Minimaxing - -------------- - + a template for Lionwiki-t2t https://lionwiki-t2t.sourceforge.io/ - - based on - + + based on + https://html5up.net/minimaxing licence Creative Commons Attribution 3.0 Unported http://creativecommons.org/licenses/by/3.0/ - + ----------------------------*/ -/* This CSS file was generated from the minimaxing.less template. +/* This CSS file was generated from the minimaxing.less template. See http://lesscss.org/ */ /* @@ -26,9 +26,9 @@ You can create your own manuscript / handwriting font on http://www.myscriptfont #8B9AB8 : lighter grey blue #7B8AA8 : light grey blue #56A3B5 : turquoise blue - #B1494D : brick red + #B1494D : brick red #465E7C : dark blue - #549136 : green + #549136 : green #799037 : grass green #D07732 : orange #754496 : purple @@ -36,16 +36,16 @@ You can create your own manuscript / handwriting font on http://www.myscriptfont */ /* define mixin */ /* we disable it as it's sometimes a problem with lesscss -.generateColor() { +.generateColor() { @background-color: color(~`@{all-background-colors}.split(',')[Math.floor(Math.random()*@{all-background-colors}.split(',').length)]`); } -.generateColor(); +.generateColor(); */ /* This line below will use a random main color: */ /* @fg: @background-color; */ /* if you prefer to select a fixed background color, just uncomment one color from below */ /* For YunoHost config */ -/* @fg: #__YNH_COLOR__; */ +/* @fg: #__COLOR__; */ /* Header color */ /* You can use a shade of MainColor: */ /* or a complementary color: */ @@ -111,7 +111,7 @@ You can create your own manuscript / handwriting font on http://www.myscriptfont font-family: Fengardo; font-weight: bold; src: url(../fonts/fengardoneue-black.woff) format('woff'), url(../fonts/fengardoneue-black.otf) format('opentype'), url(../fonts/fengardoneue-black.svg) format('svg'); - + /*font-weight: 500;*/ } @font-face { @@ -126,7 +126,7 @@ You can create your own manuscript / handwriting font on http://www.myscriptfont http://nodethirtythree.com | @nodethirtythree Released under the Creative Commons Attribution 3.0 license (nodethirtythree.com/license) * http://html5up.net/minimaxing/ - + Based also on the work from http://wiki.lapetitesissone.fr/index.php?page=Lionwiki */ /* LionWiki specific */ diff --git a/conf/minimaxing.less b/conf/minimaxing.less index e063aa1..fc45e63 100755 --- a/conf/minimaxing.less +++ b/conf/minimaxing.less @@ -1,24 +1,24 @@ - + /*----------------------- -------------- - Minimaxing - -------------- - + a template for Lionwiki-t2t https://lionwiki-t2t.sourceforge.io/ - - based on - + + based on + https://html5up.net/minimaxing licence Creative Commons Attribution 3.0 Unported http://creativecommons.org/licenses/by/3.0/ - + ----------------------------*/ -/* This CSS file was generated from the minimaxing.less template. +/* This CSS file was generated from the minimaxing.less template. See http://lesscss.org/ */ @@ -41,9 +41,9 @@ You can create your own manuscript / handwriting font on http://www.myscriptfont #8B9AB8 : lighter grey blue #7B8AA8 : light grey blue #56A3B5 : turquoise blue - #B1494D : brick red + #B1494D : brick red #465E7C : dark blue - #549136 : green + #549136 : green #799037 : grass green #D07732 : orange #754496 : purple @@ -54,10 +54,10 @@ You can create your own manuscript / handwriting font on http://www.myscriptfont /* define mixin */ /* we disable it as it's sometimes a problem with lesscss -.generateColor() { +.generateColor() { @background-color: color(~`@{all-background-colors}.split(',')[Math.floor(Math.random()*@{all-background-colors}.split(',').length)]`); } -.generateColor(); +.generateColor(); */ /* This line below will use a random main color: */ @@ -73,18 +73,18 @@ You can create your own manuscript / handwriting font on http://www.myscriptfont // @fg: #847457; /* Marron */ /* For YunoHost config */ -/* @fg: #__YNH_COLOR__; */ +/* @fg: #__COLOR__; */ + - /* Header color */ /* You can use a shade of MainColor: */ -@HeaderColor: (@fg - #111); +@HeaderColor: (@fg - #111); /* or a complementary color: */ /*@HeaderColor: (#ffffff - @fg - (#ffffff - @fg)/3); */ -@HeaderColor: spin(@fg, 180); +@HeaderColor: spin(@fg, 180); @MainFontColor: (#878e83 - #222); @@ -129,7 +129,7 @@ You can create your own manuscript / handwriting font on http://www.myscriptfont @heading: @fg; @heading-weight: bold; /* normal or bold */ @font: Ubuntu; -@font-heading: Fengardo Neue; +@font-heading: Fengardo Neue; @Bg-dark: (@fg - #121212); @@ -177,7 +177,7 @@ You can create your own manuscript / handwriting font on http://www.myscriptfont http://nodethirtythree.com | @nodethirtythree Released under the Creative Commons Attribution 3.0 license (nodethirtythree.com/license) * http://html5up.net/minimaxing/ - + Based also on the work from http://wiki.lapetitesissone.fr/index.php?page=Lionwiki */ @@ -234,7 +234,7 @@ h1 a:hover, h2 a:hover, h3 a:hover, h4 a:hover, h5 a:hover, h6 a:hover { font-size: 105%; } -.markItUpEditor +.markItUpEditor { width: 90%; font-family: @fontEdit; @@ -371,13 +371,13 @@ th, thead, #previewPane th, #previewPane thead { word-break: break-all; /* Instead use this non-standard one: */ word-break: break-word; - + /* Adds a hyphen where the word breaks, if supported (No Blink) */ -ms-hyphens: auto; -moz-hyphens: auto; -webkit-hyphens: auto; hyphens: auto; -} +} @@ -492,12 +492,12 @@ s { } ::selection { - background: @fg; + background: @fg; color: @bg; } - + ::-moz-selection { - background: @fg; + background: @fg; color: @bg; } @@ -533,7 +533,7 @@ img { /*float: left;*/ /*margin: 2px 1.25em 0 0;*/ margin: 1.5em; - + max-width: 50%; max-height: 500px; padding:1px; @@ -556,13 +556,13 @@ img.noborder { position: absolute; z-index: 10; } - + .img-circle { border-radius: 50%; border: solid 0px ; min-width:100px; max-width:200px; - background: @HeaderColor; + background: @HeaderColor; } @@ -701,7 +701,7 @@ a.toolbarTextareaItem b { body { font-size: (@MainFontSize + 0); } - + section, article { margin: 0 0 60px 0; } @@ -838,7 +838,7 @@ a.toolbarTextareaItem b { body { font-size: (@MainFontSize + 1); } - + section, article { margin: 10px 10px 50px 10px; } @@ -978,7 +978,7 @@ a.toolbarTextareaItem b { body { font-size: (@MainFontSize + 1); } - + h2 { font-size: 1.4em; } @@ -1098,7 +1098,7 @@ a.toolbarTextareaItem b { #footer-wrapper section, #footer-wrapper article { border-bottom: solid 1px #ced0b7; } - + /* important for markitup : */ .contentTextarea { @@ -1108,7 +1108,7 @@ a.toolbarTextareaItem b { padding: 0px; margin-left: -0.25px; } - + #main { /*overflow: auto;*/ background-color: @bg; @@ -1117,12 +1117,12 @@ a.toolbarTextareaItem b { } /* from 5grid/core.css */ - + .\35 grid { /*overflow: hidden;*/ /* prevent horizontal scroll */ - overflow: visible; + overflow: visible; } - + } @@ -1226,10 +1226,10 @@ progress::-webkit-progress-bar { /*cursor: pointer;*/ text-align: center; vertical-align: middle; - + /*transition: box-shadow 0.25s cubic-bezier(0.08, 0.59, 0.29, 0.99) 0s, color 0.25s cubic-bezier(0.08, 0.59, 0.29, 0.99) 0s, border-color 0.25s cubic-bezier(0.08, 0.59, 0.29, 0.99) 0s, transform 0.25s cubic-bezier(0.08, 0.59, 0.29, 0.99) 0s, background-color 0.25s cubic-bezier(0.08, 0.59, 0.29, 0.99) 0s;*/ - + border-radius: 0px; } @@ -1298,17 +1298,17 @@ progress::-webkit-progress-bar { img, video, iframe { filter: invert(100%) hue-rotate(180deg); } - + #header-wrapper { filter: invert(100%) hue-rotate(180deg); } - + h1, h2, h3, h4 { color: @fg; } - + /* Improve contrast on icons. */ .icon { filter: invert(15%) hue-rotate(180deg); @@ -1324,4 +1324,3 @@ progress::-webkit-progress-bar { color: #555; } } - diff --git a/conf/nginx.conf b/conf/nginx.conf index b7c8793..eef57bf 100755 --- a/conf/nginx.conf +++ b/conf/nginx.conf @@ -1,26 +1,26 @@ #sub_path_only rewrite ^__PATH__$ __PATH__/ permanent; location __PATH__/ { - # Path to source - alias __FINALPATH__/; + # Path to source + alias __INSTALL_DIR__/; - index index.php; + index index.php; - # Common parameter to increase upload size limit in conjunction with dedicated php-fpm file - #client_max_body_size 50M; + # Common parameter to increase upload size limit in conjunction with dedicated php-fpm file + client_max_body_size 100M; - try_files $uri $uri/ index.php; - location ~ [^/]\.php(/|$) { - fastcgi_split_path_info ^(.+?\.php)(/.*)$; - fastcgi_pass unix:/var/run/php/php__PHPVERSION__-fpm-__NAME__.sock; + try_files $uri $uri/ index.php; + location ~ [^/]\.php(/|$) { + fastcgi_split_path_info ^(.+?\.php)(/.*)$; + fastcgi_pass unix:/var/run/php/php__PHPVERSION__-fpm-__NAME__.sock; - fastcgi_index index.php; - include fastcgi_params; - fastcgi_param REMOTE_USER $remote_user; - fastcgi_param PATH_INFO $fastcgi_path_info; - fastcgi_param SCRIPT_FILENAME $request_filename; - } + fastcgi_index index.php; + include fastcgi_params; + fastcgi_param REMOTE_USER $remote_user; + fastcgi_param PATH_INFO $fastcgi_path_info; + fastcgi_param SCRIPT_FILENAME $request_filename; + } - # Don't include SSOWAT user panel (can lead to some server error, like "bad gateway") - # include conf.d/yunohost_panel.conf.inc; + # Don't include SSOWAT user panel (can lead to some server error, like "bad gateway") + # include conf.d/yunohost_panel.conf.inc; } diff --git a/conf/pheditor.php b/conf/pheditor.php index 3c79e22..5e92729 100755 --- a/conf/pheditor.php +++ b/conf/pheditor.php @@ -8,7 +8,7 @@ * Release under MIT license */ -define('PASSWORD', '__YNH_PASSWORD__'); +define('PASSWORD', '__PASSWORD_SHA1__'); define('DS', DIRECTORY_SEPARATOR); define('MAIN_DIR', __DIR__); define('VERSION', '2.0.0'); diff --git a/conf/php-fpm.conf b/conf/php-fpm.conf deleted file mode 100755 index ab1a471..0000000 --- a/conf/php-fpm.conf +++ /dev/null @@ -1,430 +0,0 @@ -; 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__ - -; 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/manifest.json b/manifest.json deleted file mode 100755 index ad8688d..0000000 --- a/manifest.json +++ /dev/null @@ -1,103 +0,0 @@ -{ - "name": "Lionwiki", - "id": "lionwiki-t2t", - "packaging_format": 1, - "description": { - "en": "Lightweight wiki-style CMS using the txt2tags syntax", - "fr": "CMS léger, géré sous forme de wiki utilisant la syntaxe txt2tags" - }, - "version": "3.2.12~ynh4", - "url": "https://lionwiki-t2t.sourceforge.io/", - "upstream": { - "license": "MIT", - "website": "https://lionwiki-t2t.sourceforge.io/", - "admindoc": "https://lionwiki-t2t.sourceforge.io/", - "userdoc": "https://github.com/farvardin/whatistxt2tags", - "code": "https://sourceforge.net/projects/lionwiki-t2t" - }, - "license": "MIT", - "maintainer": { - "name": "Eric Forgeot" - }, - "requirements": { - "yunohost": ">= 4.3.0" - }, - "multi_instance": true, - "services": [ - "nginx", - "php7.3-fpm" - ], - "arguments": { - "install": [ - { - "name": "domain", - "type": "domain" - }, - { - "name": "path", - "type": "path", - "example": "/lionwiki", - "default": "/lionwiki" - }, - { - "name": "is_public", - "type": "boolean", - "help": { - "en": "If it's not public, only SSO registered users will be able to user it.", - "fr": "Si ce n'est pas public, seuls les utilisateurs enregistrés sur le SSO pourront l'utiliser." - }, - "default": true - }, - { - "name": "language", - "type": "string", - "ask": { - "en": "Choose the application language", - "fr": "Choisissez la langue de l'application" - }, - "choices": ["fr", "en"], - "default": "en" - }, - { - "name": "admin", - "type": "user" - }, - { - "name": "password", - "type": "password", - "help": { - "en": "Define a password which will be used for wiki edition and administration.", - "fr": "Veuillez définir un mot de passe qui sera valable pour l'édition des pages de ce wiki ainsi que pour l'administration." - } - }, - { - "name": "wiki", - "type": "string", - "ask": { - "en": "Set the wiki name", - "fr": "Définissez le titre de votre wiki" - }, - "help": { - "en": "This name will be displayed in the header of the wiki.", - "fr": "Ce nom sera affiché dans l'entête de votre wiki." - }, - "example": "My Wiki", - "default": "My Wiki" - }, - { - "name": "color", - "type": "string", - "ask": { - "en": "Set color base", - "fr": "Définissez la couleur de base" - }, - "help": { - "en": "Use hexadecimal value (6 figures without #)", - "fr": "Utilisez une valeur hexadecimale (6 chiffres sans # devant)" - }, - "example": "D17732", - "default": "328cc1" - } - ] - } -} diff --git a/manifest.toml b/manifest.toml new file mode 100644 index 0000000..9f90b54 --- /dev/null +++ b/manifest.toml @@ -0,0 +1,98 @@ +#:schema https://raw.githubusercontent.com/YunoHost/apps/master/schemas/manifest.v2.schema.json + +packaging_format = 2 + +id = "lionwiki-t2t" +name = "Lionwiki" +description.en = "Lightweight wiki-style CMS using the txt2tags syntax" +description.fr = "CMS léger, géré sous forme de wiki utilisant la syntaxe txt2tags" + +version = "3.2.12~ynh5" + +maintainers = ["Eric Forgeot"] + +[upstream] +license = "MIT" +website = "https://lionwiki-t2t.sourceforge.io/" +admindoc = "https://lionwiki-t2t.sourceforge.io/" +userdoc = "https://github.com/farvardin/whatistxt2tags" +code = "https://sourceforge.net/projects/lionwiki-t2t" +cpe = "???" # FIXME: optional but recommended if relevant, this is meant to contain the Common Platform Enumeration, which is sort of a standard id for applications defined by the NIST. In particular, Yunohost may use this is in the future to easily track CVE (=security reports) related to apps. The CPE may be obtained by searching here: https://nvd.nist.gov/products/cpe/search. For example, for Nextcloud, the CPE is 'cpe:2.3:a:nextcloud:nextcloud' (no need to include the version number) +fund = "???" # FIXME: optional but recommended (or remove if irrelevant / not applicable). This is meant to be an URL where people can financially support this app, especially when its development is based on volunteers and/or financed by its community. YunoHost may later advertise it in the webadmin. + +[integration] +yunohost = ">=11.2" +architectures = "all" +multi_instance = true +ldap = false +sso = false +disk = "50M" # FIXME: replace with an **estimate** minimum disk requirement. e.g. 20M, 400M, 1G, ... +ram.build = "50M" # FIXME: replace with an **estimate** minimum ram requirement. e.g. 50M, 400M, 1G, ... +ram.runtime = "50M" # FIXME: replace with an **estimate** minimum ram requirement. e.g. 50M, 400M, 1G, ... + +[install] + [install.domain] + type = "domain" + + [install.path] + type = "path" + default = "/lionwiki" + + [install.init_main_permission] + help.en = "If it's not public, only SSO registered users will be able to user it." + help.fr = "Si ce n'est pas public, seuls les utilisateurs enregistrés sur le SSO pourront l'utiliser." + type = "group" + default = "visitors" + + [install.language] + ask.en = "Choose the application language" + ask.fr = "Choisissez la langue de l'application" + type = "select" + choices = ["fr", "en"] + default = "en" + + [install.admin] + type = "user" + + [install.password] + help.en = "Define a password which will be used for wiki edition and administration." + help.fr = "Veuillez définir un mot de passe qui sera valable pour l'édition des pages de ce wiki ainsi que pour l'administration." + type = "password" + + [install.wiki] + ask.en = "Set the wiki name" + ask.fr = "Définissez le titre de votre wiki" + help.en = "This name will be displayed in the header of the wiki." + help.fr = "Ce nom sera affiché dans l'entête de votre wiki." + type = "string" + example = "My Wiki" + default = "My Wiki" + + [install.color] + ask.en = "Set color base" + ask.fr = "Définissez la couleur de base" + help.en = "Use hexadecimal value (6 figures without #)" + help.fr = "Utilisez une valeur hexadecimale (6 chiffres sans # devant)" + type = "string" + example = "D17732" + default = "328cc1" + +[resources] + [resources.sources.main] + url = "https://sourceforge.net/projects/lionwiki-t2t/files/lionwiki-t2t.zip" + sha256 = "081a05b07446183da5cf065b07cab2baaabe69e57d11b61c0aaf3d187ee2ff30" + + + [resources.system_user] + + [resources.install_dir] + + [resources.permissions] + main.url = "/" + + [resources.apt] + packages = [ + "php7.4-fpm", + "node-less", + "acl", + ] diff --git a/scripts/_common.sh b/scripts/_common.sh index ebea59a..944a65e 100755 --- a/scripts/_common.sh +++ b/scripts/_common.sh @@ -4,12 +4,6 @@ # COMMON VARIABLES #================================================= -YNH_PHP_VERSION="7.3" - -# dependencies used by the app -#pkg_dependencies="node-less" -pkg_dependencies="acl" - #================================================= # PERSONAL HELPERS #================================================= diff --git a/scripts/backup b/scripts/backup index 75ce3e0..59d33dc 100755 --- a/scripts/backup +++ b/scripts/backup @@ -10,24 +10,6 @@ source ../settings/scripts/_common.sh source /usr/share/yunohost/helpers -#================================================= -# MANAGE SCRIPT FAILURE -#================================================= - -# Exit if an error occurs during the execution of the script -ynh_abort_if_errors - -#================================================= -# LOAD SETTINGS -#================================================= -ynh_print_info --message="Loading installation settings..." - -app=$YNH_APP_INSTANCE_NAME - -final_path=$(ynh_app_setting_get --app=$app --key=final_path) -domain=$(ynh_app_setting_get --app=$app --key=domain) -phpversion=$(ynh_app_setting_get --app=$app --key=phpversion) - #================================================= # DECLARE DATA AND CONF FILES TO BACKUP #================================================= @@ -37,20 +19,18 @@ ynh_print_info --message="Declaring files to be backed up..." # BACKUP THE APP MAIN DIR #================================================= -ynh_backup --src_path="$final_path" +ynh_backup --src_path="$install_dir" #================================================= -# BACKUP THE NGINX CONFIGURATION -#================================================= - -ynh_backup --src_path="/etc/nginx/conf.d/$domain.d/$app.conf" - -#================================================= -# BACKUP THE PHP-FPM CONFIGURATION +# SYSTEM CONFIGURATION #================================================= +# Backup the PHP-FPM configuration ynh_backup --src_path="/etc/php/$phpversion/fpm/pool.d/$app.conf" +# Backup the nginx configuration +ynh_backup --src_path="/etc/nginx/conf.d/$domain.d/$app.conf" + #================================================= # END OF SCRIPT #================================================= diff --git a/scripts/change_url b/scripts/change_url index ba919a3..16e0f3c 100755 --- a/scripts/change_url +++ b/scripts/change_url @@ -9,59 +9,6 @@ source _common.sh source /usr/share/yunohost/helpers -#================================================= -# RETRIEVE ARGUMENTS -#================================================= - -old_domain=$YNH_APP_OLD_DOMAIN -old_path=$YNH_APP_OLD_PATH - -new_domain=$YNH_APP_NEW_DOMAIN -new_path=$YNH_APP_NEW_PATH - -app=$YNH_APP_INSTANCE_NAME - -#================================================= -# LOAD SETTINGS -#================================================= -ynh_script_progression --message="Loading installation settings..." --weight=1 - -# Needed for helper "ynh_add_nginx_config" -final_path=$(ynh_app_setting_get --app=$app --key=final_path) - -#================================================= -# BACKUP BEFORE CHANGE URL THEN ACTIVE TRAP -#================================================= -ynh_script_progression --message="Backing up the app before changing its URL (may take a while)..." --weight=4 - -# Backup the current version of the app -ynh_backup_before_upgrade -ynh_clean_setup () { - # Remove the new domain config file, the remove script won't do it as it doesn't know yet its location. - ynh_secure_remove --file="/etc/nginx/conf.d/$new_domain.d/$app.conf" - - # Restore it if the upgrade fails - ynh_restore_upgradebackup -} -# Exit if an error occurs during the execution of the script -ynh_abort_if_errors - -#================================================= -# CHECK WHICH PARTS SHOULD BE CHANGED -#================================================= - -change_domain=0 -if [ "$old_domain" != "$new_domain" ] -then - change_domain=1 -fi - -change_path=0 -if [ "$old_path" != "$new_path" ] -then - change_path=1 -fi - #================================================= # STANDARD MODIFICATIONS #================================================= @@ -69,38 +16,7 @@ fi #================================================= ynh_script_progression --message="Updating NGINX web server configuration..." --weight=2 -nginx_conf_path=/etc/nginx/conf.d/$old_domain.d/$app.conf - -# Change the path in the NGINX config file -if [ $change_path -eq 1 ] -then - # Make a backup of the original NGINX config file if modified - ynh_backup_if_checksum_is_different --file="$nginx_conf_path" - # Set global variables for NGINX helper - domain="$old_domain" - path_url="$new_path" - # Create a dedicated NGINX config - ynh_add_nginx_config -fi - -# Change the domain for NGINX -if [ $change_domain -eq 1 ] -then - # Delete file checksum for the old conf file location - ynh_delete_file_checksum --file="$nginx_conf_path" - mv $nginx_conf_path /etc/nginx/conf.d/$new_domain.d/$app.conf - # Store file checksum for the new config file location - ynh_store_file_checksum --file="/etc/nginx/conf.d/$new_domain.d/$app.conf" -fi - -#================================================= -# GENERIC FINALISATION -#================================================= -# RELOAD NGINX -#================================================= -ynh_script_progression --message="Reloading NGINX web server..." --weight=1 - -ynh_systemd_action --service_name=nginx --action=reload +ynh_change_url_nginx_config #================================================= # END OF SCRIPT diff --git a/scripts/install b/scripts/install index 9811b07..935ae2f 100755 --- a/scripts/install +++ b/scripts/install @@ -10,93 +10,33 @@ source _common.sh source /usr/share/yunohost/helpers #================================================= -# MANAGE SCRIPT FAILURE +# INITIALIZE AND STORE SETTINGS #================================================= -ynh_clean_setup () { - true -} -# Exit if an error occurs during the execution of the script -ynh_abort_if_errors +# Password is required to regen the files... +ynh_app_setting_set --app="$app" --key=password --value="$password" -#================================================= -# RETRIEVE ARGUMENTS FROM THE MANIFEST -#================================================= +password_sha1=$(python -c 'import hashlib; import sys; a=str(sys.argv[1]); print(hashlib.sha512(a.encode("UTF-8")).hexdigest())' $password) -domain=$YNH_APP_ARG_DOMAIN -path_url=$YNH_APP_ARG_PATH -is_public=$YNH_APP_ARG_IS_PUBLIC -language=$YNH_APP_ARG_LANGUAGE -admin=$YNH_APP_ARG_ADMIN -password=$YNH_APP_ARG_PASSWORD -wiki=$YNH_APP_ARG_WIKI -color=$YNH_APP_ARG_COLOR - -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 --message="This path already contains a folder" - -# Register (book) web path -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=$app --key=domain --value=$domain -ynh_app_setting_set --app=$app --key=path --value=$path_url -ynh_app_setting_set --app=$app --key=language --value=$language -ynh_app_setting_set --app=$app --key=admin --value=$admin - -#================================================= -# STANDARD MODIFICATIONS -#================================================= -# INSTALL DEPENDENCIES -#================================================= -ynh_script_progression --message="Installing dependencies..." --weight=3 - -ynh_install_app_dependencies $pkg_dependencies - -#================================================= -# CREATE DEDICATED USER -#================================================= -ynh_script_progression --message="Configuring system user..." --weight=1 - -# Create a system user -ynh_system_user_create --username=$app --home_dir="$final_path" +# Remove eventual '#' prefix from color +color=${color#"#"} +# Check if the format is valid, put #555555 instead +if [[ ! "$color" =~ ^[A-Fa-f0-9]{6}$ ]]; then + color=555555 +fi +# Save color back +ynh_app_setting_set --app="$app" --key=color --value="$color" #================================================= # DOWNLOAD, CHECK AND UNPACK SOURCE #================================================= ynh_script_progression --message="Setting up source files..." --weight=4 -ynh_app_setting_set --app=$app --key=final_path --value=$final_path # Download, check integrity, uncompress and patch the source from app.src -ynh_setup_source --dest_dir="$final_path" +ynh_setup_source --dest_dir="$install_dir" -#================================================= -# PHP-FPM CONFIGURATION -#================================================= -ynh_script_progression --message="Configuring PHP-FPM..." --weight=1 - -# Create a dedicated PHP-FPM config -ynh_add_fpm_config -phpversion=$(ynh_app_setting_get --app=$app --key=phpversion) - -#================================================= -# NGINX CONFIGURATION -#================================================= -ynh_script_progression --message="Configuring NGINX web server..." --weight=2 - -# Create a dedicated NGINX config -ynh_add_nginx_config +chmod -R o-rwx "$install_dir" +chown -R "$app:www-data" "$install_dir" #================================================= # SPECIFIC SETUP @@ -105,98 +45,33 @@ ynh_add_nginx_config #================================================= ynh_script_progression --message="Adding a configuration file..." -### Copy Yunohost specific configuration -# This File cannot be modified directly by wiki, only by hand or by Yunohost -# It will only be updated by Yunohost package or directly by adventurous users -cp ../conf/config.php $final_path/ +# Workaround for php code containing __FILE__ and __DIR__ +file=__FILE__ +dir=__DIR__ -cp ../conf/minimaxing.less $final_path/templates/minimaxing/ -cp ../conf/minimaxing.css $final_path/templates/minimaxing/minimaxing.css -cp ../conf/mimoza.css $final_path/templates/mimoza/ +ynh_add_config --template="config.php" --destination="$install_dir/config.php" +ynh_add_config --template="pheditor.php" --destination="$install_dir/pheditor.php" -cp ../conf/pheditor.php $final_path/ +mkdir -p "$install_dir/templates/minimaxing/" +ynh_add_config --template="minimaxing.less" --destination="$install_dir/templates/minimaxing/minimaxing.less" +ynh_add_config --template="minimaxing.css" --destination="$install_dir/templates/minimaxing/minimaxing.css" -# we already use the default html template -#cp ../conf/minimaxing.html $final_path/templates/ +mkdir -p "$install_dir/templates/mimoza/" +ynh_add_config --template="mimoza.css" --destination="$install_dir/templates/mimoza/mimoza.css" -# Set the password -ynh_replace_string --match_string="__YNH_PASSWORD__" --replace_string="$password" --target_file="$final_path/config.php" - -# Set the "admin" user (not used, admin password = user password, you can modify it later) -# ynh_replace_string --match_string="__YNH_ADMINPASSWORD__" --replace_string="$password" --target_file="$final_path/config.php" - -# set user password in pheditor - -pheditorhash=`python -c 'import hashlib; import sys; a=str(sys.argv[1]); print(hashlib.sha512(a.encode("UTF-8")).hexdigest())' $password` - -ynh_replace_string --match_string="__YNH_PASSWORD__" --replace_string="$pheditorhash" --target_file="$final_path/pheditor.php" - -ynh_replace_string --match_string="__YNH_LANG__" --replace_string="$language" --target_file="$final_path/config.php" - -ynh_replace_string --match_string="__YNH_LABEL__" --replace_string="$wiki" --target_file="$final_path/config.php" - - -#ynh_replace_string --match_string="__YNH_COLOR__" --replace_string="$color" --target_file="$final_path/templates/minimaxing/minimaxing.less" - -# test if the color was correctly set (6 hexadecimal values) -# if not, we'll use a default grey color (#555555) - -if echo "$color" | grep -q -E '[A-Fa-f0-9]{6}' -then - ynh_replace_string --match_string="__YNH_COLOR__" --replace_string="$color" --target_file="$final_path/templates/minimaxing/minimaxing.less" - ynh_replace_string --match_string="__YNH_COLOR__" --replace_string="$color" --target_file="$final_path/templates/ggp/ggp.less" - ynh_replace_string --match_string="__YNH_COLOR__" --replace_string="$color" --target_file="$final_path/templates/mimoza/mimoza.css" -else - ynh_replace_string --match_string="__YNH_COLOR__" --replace_string="555555" --target_file="$final_path/templates/minimaxing/minimaxing.less" - ynh_replace_string --match_string="__YNH_COLOR__" --replace_string="555555" --target_file="$final_path/templates/ggp/ggp.less" - ynh_replace_string --match_string="__YNH_COLOR__" --replace_string="555555" --target_file="$final_path/templates/mimoza/mimoza.css" -fi - -## lessc seems to have a dependancy problem in debian, even with the node-tslib package it complains "Cannot find module "tslib"" -## so we'll use basic css instead at the moment - -# soon lessc will require the --js option -# lessc --js $final_path/templates/minimaxing/minimaxing.less > $final_path/templates/minimaxing/minimaxing.css - -#lessc $final_path/templates/minimaxing/minimaxing.less > $final_path/templates/minimaxing/minimaxing.css -#lessc $final_path/templates/ggp/ggp.less > $final_path/templates/ggp/ggp.css - - -ynh_store_file_checksum --file="$final_path/config.php" -ynh_store_file_checksum --file="$final_path/config.t2t" -ynh_store_file_checksum --file="$final_path/menu.php" +ynh_store_file_checksum --file="$install_dir/config.t2t" +ynh_store_file_checksum --file="$install_dir/menu.php" #================================================= -# SECURE FILES AND DIRECTORIES +# SYSTEM CONFIGURATION #================================================= +ynh_script_progression --message="Adding system configurations related to $app..." --weight=1 -# Set permissions to app files -chown -R $app:www-data $final_path -chmod -R o-rwx $final_path -find $final_path -type d -exec chmod g=rx {} + -find $final_path -type f -exec chmod g=r {} + +# Create a dedicated PHP-FPM config +ynh_add_fpm_config -#================================================= -# GENERIC FINALIZATION -#================================================= -# SETUP SSOWAT -#================================================= -ynh_script_progression --message="Configuring permissions..." --weight=1 - -# Make app public if necessary -if [ $is_public -eq 1 ] -then - # Everyone can access the app. - # The "main" permission is automatically created before the install script. - ynh_permission_update --permission="main" --add="visitors" -fi - -#================================================= -# RELOAD NGINX -#================================================= -ynh_script_progression --message="Reloading NGINX web server..." --weight=1 - -ynh_systemd_action --service_name=nginx --action=reload +# Create a dedicated NGINX config +ynh_add_nginx_config #================================================= # END OF SCRIPT diff --git a/scripts/remove b/scripts/remove index cca754d..5b17c2d 100755 --- a/scripts/remove +++ b/scripts/remove @@ -10,59 +10,16 @@ source _common.sh source /usr/share/yunohost/helpers #================================================= -# LOAD SETTINGS +# REMOVE SYSTEM CONFIGURATIONS #================================================= -ynh_script_progression --message="Loading installation settings..." --weight=1 - -app=$YNH_APP_INSTANCE_NAME - -domain=$(ynh_app_setting_get --app=$app --key=domain) -final_path=$(ynh_app_setting_get --app=$app --key=final_path) - -#================================================= -# STANDARD REMOVE -#================================================= -# REMOVE APP MAIN DIR -#================================================= -ynh_script_progression --message="Removing app main directory..." --weight=2 - -# Remove the app directory securely -ynh_secure_remove --file="$final_path" - -#================================================= -# REMOVE NGINX CONFIGURATION -#================================================= -ynh_script_progression --message="Removing NGINX web server configuration..." --weight=1 +ynh_script_progression --message="Removing system configurations related to $app..." --weight=1 # Remove the dedicated NGINX config ynh_remove_nginx_config -#================================================= -# REMOVE PHP-FPM CONFIGURATION -#================================================= -ynh_script_progression --message="Removing PHP-FPM configuration..." --weight=1 - # Remove the dedicated PHP-FPM config ynh_remove_fpm_config -#================================================= -# REMOVE DEPENDENCIES -#================================================= -ynh_script_progression --message="Removing dependencies..." --weight=2 - -# Remove metapackage and its dependencies -ynh_remove_app_dependencies - -#================================================= -# GENERIC FINALIZATION -#================================================= -# REMOVE DEDICATED USER -#================================================= -ynh_script_progression --message="Removing the dedicated system user..." --weight=1 - -# Delete a system user -ynh_system_user_delete --username=$app - #================================================= # END OF SCRIPT #================================================= diff --git a/scripts/restore b/scripts/restore index a1d649c..661bb5f 100755 --- a/scripts/restore +++ b/scripts/restore @@ -10,81 +10,23 @@ source ../settings/scripts/_common.sh source /usr/share/yunohost/helpers -#================================================= -# MANAGE SCRIPT FAILURE -#================================================= - -ynh_clean_setup () { - true -} -# Exit if an error occurs during the execution of the script -ynh_abort_if_errors - -#================================================= -# LOAD SETTINGS -#================================================= -ynh_script_progression --message="Loading installation settings..." --weight=1 - -app=$YNH_APP_INSTANCE_NAME - -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) -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 - -test ! -d $final_path \ - || ynh_die --message="There is already a directory: $final_path " - -#================================================= -# STANDARD RESTORATION STEPS -#================================================= -# RECREATE THE DEDICATED USER -#================================================= -ynh_script_progression --message="Recreating the dedicated system user..." --weight=1 - -# Create the dedicated user (if not existing) -ynh_system_user_create --username=$app - #================================================= # RESTORE THE APP MAIN DIR #================================================= ynh_script_progression --message="Restoring the app main directory..." --weight=2 -ynh_restore_file --origin_path="$final_path" +ynh_restore_file --origin_path="$install_dir" -# Restore permissions on app files -chown -R $app:www-data $final_path -chmod -R o-rwx $final_path -find $final_path -type d -exec chmod g=rx {} + -find $final_path -type f -exec chmod g=r {} + +chmod -R o-rwx "$install_dir" +chown -R "$app:www-data" "$install_dir" #================================================= -# SPECIFIC RESTORATION +# RESTORE SYSTEM CONFIGURATIONS #================================================= -# REINSTALL DEPENDENCIES -#================================================= -ynh_script_progression --message="Reinstalling dependencies..." --weight=4 - -# Define and install dependencies -ynh_install_app_dependencies $pkg_dependencies - -#================================================= -# RESTORE THE PHP-FPM CONFIGURATION -#================================================= -ynh_script_progression --message="Restoring the PHP-FPM configuration..." --weight=3 +ynh_script_progression --message="Restoring system configurations related to $app..." --weight=1 ynh_restore_file --origin_path="/etc/php/$phpversion/fpm/pool.d/$app.conf" -#================================================= -# RESTORE THE NGINX CONFIGURATION -#================================================= -ynh_script_progression --message="Restoring the NGINX web server configuration..." - ynh_restore_file --origin_path="/etc/nginx/conf.d/$domain.d/$app.conf" #================================================= @@ -94,7 +36,7 @@ ynh_restore_file --origin_path="/etc/nginx/conf.d/$domain.d/$app.conf" #================================================= ynh_script_progression --message="Reloading NGINX web server and PHP-FPM..." --weight=1 -ynh_systemd_action --service_name=php$phpversion-fpm --action=reload +ynh_systemd_action --service_name="php$phpversion-fpm" --action=reload ynh_systemd_action --service_name=nginx --action=reload #================================================= diff --git a/scripts/upgrade b/scripts/upgrade index 6e77b71..74fd19f 100755 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -9,101 +9,16 @@ source _common.sh source /usr/share/yunohost/helpers -#================================================= -# LOAD SETTINGS -#================================================= -ynh_script_progression --message="Loading installation settings..." --weight=1 - -app=$YNH_APP_INSTANCE_NAME - -domain=$(ynh_app_setting_get --app=$app --key=domain) -path_url=$(ynh_app_setting_get --app=$app --key=path) -language=$(ynh_app_setting_get --app=$app --key=language) -admin=$(ynh_app_setting_get --app=$app --key=admin) -final_path=$(ynh_app_setting_get --app=$app --key=final_path) -phpversion=$(ynh_app_setting_get --app=$app --key=phpversion) - -#================================================= -# CHECK VERSION -#================================================= -ynh_script_progression --message="Checking version..." - -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)..." --weight=4 - -# 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 - -#================================================= -# ENSURE DOWNWARD COMPATIBILITY -#================================================= -ynh_script_progression --message="Ensuring downward compatibility..." --weight=1 - -# If final_path doesn't exist, create it -if [ -z "$final_path" ]; then - final_path=/var/www/$app - ynh_app_setting_set --app=$app --key=final_path --value=$final_path -fi - -# Cleaning legacy permissions -if ynh_legacy_permissions_exists; then - ynh_legacy_permissions_delete_all - - ynh_app_setting_delete --app=$app --key=is_public -fi - -#================================================= -# CREATE DEDICATED USER -#================================================= -ynh_script_progression --message="Making sure dedicated system user exists..." --weight=1 - -# Create a dedicated user (if not existing) -ynh_system_user_create --username=$app --home_dir="$final_path" - #================================================= # DOWNLOAD, CHECK AND UNPACK SOURCE #================================================= +ynh_script_progression --message="Upgrading source files..." --weight=3 -if [ "$upgrade_type" == "UPGRADE_APP" ] -then - ynh_script_progression --message="Upgrading source files..." --weight=3 +# Download, check integrity, uncompress and patch the source from app.src +ynh_setup_source --dest_dir="$install_dir" --full_replace=1 --keep= - # Download, check integrity, uncompress and patch the source from app.src - ynh_setup_source --dest_dir="$final_path" -fi - -#================================================= -# UPGRADE DEPENDENCIES -#================================================= -ynh_script_progression --message="Upgrading dependencies..." --weight=3 - -ynh_install_app_dependencies $pkg_dependencies - -#================================================= -# PHP-FPM CONFIGURATION -#================================================= -ynh_script_progression --message="Upgrading PHP-FPM configuration..." --weight=1 - -# Create a dedicated PHP-FPM config -ynh_add_fpm_config - -#================================================= -# NGINX CONFIGURATION -#================================================= -ynh_script_progression --message="Upgrading NGINX web server configuration..." --weight=2 - -# Create a dedicated NGINX config -ynh_add_nginx_config +chmod -R o-rwx "$install_dir" +chown -R "$app:www-data" "$install_dir" #================================================= # STORE THE CONFIG FILE CHECKSUM @@ -111,35 +26,26 @@ ynh_add_nginx_config ### Verify the checksum of a file, stored by `ynh_store_file_checksum` in the install script. ### And create a backup of this file if the checksum is different. So the file will be backed up if the admin had modified it. -ynh_backup_if_checksum_is_different --file="$final_path/config.php" -ynh_backup_if_checksum_is_different --file="$final_path/config.t2t" -ynh_backup_if_checksum_is_different --file="$final_path/menu.php" +ynh_backup_if_checksum_is_different --file="$install_dir/config.php" +ynh_backup_if_checksum_is_different --file="$install_dir/config.t2t" +ynh_backup_if_checksum_is_different --file="$install_dir/menu.php" # Recalculate and store the checksum of the file for the next upgrade. -ynh_store_file_checksum --file="$final_path/config.php" -ynh_store_file_checksum --file="$final_path/config.t2t" -ynh_store_file_checksum --file="$final_path/menu.php" +ynh_store_file_checksum --file="$install_dir/config.php" +ynh_store_file_checksum --file="$install_dir/config.t2t" +ynh_store_file_checksum --file="$install_dir/menu.php" #ynh_restore_file -o "conf/config.php" +#================================================= +# REAPPLY SYSTEM CONFIGURATIONS +#================================================= +ynh_script_progression --message="Upgrading system configurations related to $app..." --weight=1 -#================================================= -# SECURE FILES AND DIRECTORIES -#================================================= +# Create a dedicated PHP-FPM config +ynh_add_fpm_config -# Set permissions on app files -chown -R $app:www-data $final_path -chmod -R o-rwx $final_path -find $final_path -type d -exec chmod g=rx {} + -find $final_path -type f -exec chmod g=r {} + - -#================================================= -# GENERIC FINALIZATION -#================================================= -# RELOAD NGINX -#================================================= -ynh_script_progression --message="Reloading NGINX web server..." --weight=1 - -ynh_systemd_action --service_name=nginx --action=reload +# Create a dedicated NGINX config +ynh_add_nginx_config #================================================= # END OF SCRIPT diff --git a/tests.toml b/tests.toml new file mode 100644 index 0000000..2d6550b --- /dev/null +++ b/tests.toml @@ -0,0 +1,7 @@ +#:schema https://raw.githubusercontent.com/YunoHost/apps/master/schemas/tests.v1.schema.json + +test_format = 1.0 + +[default] + + test_upgrade_from.a59e01.name = "3.2.12~ynh1"