diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100755 index 0000000..2729a6b --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,55 @@ +--- +name: Bug report +about: When creating a bug report, please use the following template to provide all the relevant information and help debugging efficiently. + +--- + +**How to post a meaningful bug report** +1. *Read this whole template first.* +2. *Determine if you are on the right place:* + - *If you were performing an action on the app from the webadmin or the CLI (install, update, backup, restore, change_url...), you are on the right place!* + - *Otherwise, the issue may be due to the app itself. Refer to its documentation or repository for help.* + - *When in doubt, post here and we will figure it out together.* +3. *Delete the italic comments as you write over them below, and remove this guide.* +--- + +### Describe the bug + +*A clear and concise description of what the bug is.* + +### Context + +- Hardware: *VPS bought online / Old laptop or computer / Raspberry Pi at home / Internet Cube with VPN / Other ARM board / ...* +- YunoHost version: x.x.x +- I have access to my server: *Through SSH | through the webadmin | direct access via keyboard / screen | ...* +- Are you in a special context or did you perform some particular tweaking on your YunoHost instance?: *no / yes* + - If yes, please explain: +- Using, or trying to install package version/branch: +- If upgrading, current package version: *can be found in the admin, or with `yunohost app info $app_id`* + +### Steps to reproduce + +- *If you performed a command from the CLI, the command itself is enough. For example:* + ```sh + sudo yunohost app install the_app + ``` +- *If you used the webadmin, please perform the equivalent command from the CLI first.* +- *If the error occurs in your browser, explain what you did:* + 1. *Go to '...'* + 2. *Click on '...'* + 3. *Scroll down to '...'* + 4. *See error* + +### Expected behavior + +*A clear and concise description of what you expected to happen. You can remove this section if the command above is enough to understand your intent.* + +### Logs + +*When an operation fails, YunoHost provides a simple way to share the logs.* +- *In the webadmin, the error message contains a link to the relevant log page. On that page, you will be able to 'Share with Yunopaste'. If you missed it, the logs of previous operations are also available under Tools > Logs.* +- *In command line, the command to share the logs is displayed at the end of the operation and looks like `yunohost log display [log name] --share`. If you missed it, you can find the log ID of a previous operation using `yunohost log list`.* + +*After sharing the log, please copypaste directly the link provided by YunoHost (to help readability, no need to copypaste the entire content of the log here, just the link is enough...)* + +*If applicable and useful, add screenshots to help explain your problem.* diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100755 index 0000000..ef70e18 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,16 @@ +## Problem + +- *Description of why you made this PR* + +## Solution + +- *And how do you fix that problem* + +## PR Status + +- [ ] Code finished and ready to be reviewed/tested +- [ ] The fix/enhancement were manually tested (if applicable) + +## Automatic tests + +Automatic tests can be triggered on https://ci-apps-dev.yunohost.org/ *after creating the PR*, by commenting "!testme", "!gogogadgetoci" or "By the power of systemd, I invoke The Great App CI to test this Pull Request!". (N.B. : for this to work you need to be a member of the Yunohost-Apps organization) diff --git a/.github/workflows/updater.sh b/.github/workflows/updater.sh new file mode 100755 index 0000000..2422a5e --- /dev/null +++ b/.github/workflows/updater.sh @@ -0,0 +1,136 @@ +#!/bin/bash + +#================================================= +# PACKAGE UPDATING HELPER +#================================================= + +# This script is meant to be run by GitHub Actions +# The YunoHost-Apps organisation offers a template Action to run this script periodically +# Since each app is different, maintainers can adapt its contents so as to perform +# automatic actions when a new upstream release is detected. + +# Remove this exit command when you are ready to run this Action +#exit 1 + +#================================================= +# FETCHING LATEST RELEASE AND ITS ASSETS +#================================================= + +# Fetching information +current_version=$(cat manifest.json | jq -j '.version|split("~")[0]') +repo=$(cat manifest.json | jq -j '.upstream.code|split("https://github.com/")[1]') +# Some jq magic is needed, because the latest upstream release is not always the latest version (e.g. security patches for older versions) +version=$(curl --silent "https://api.github.com/repos/$repo/releases" | jq -r '.[] | select( .prerelease != true ) | .tag_name' | sort -V | tail -1) +assets=($(curl --silent "https://api.github.com/repos/$repo/releases" | jq -r '[ .[] | select(.tag_name=="'$version'").assets[].browser_download_url ] | join(" ") | @sh' | tr -d "'")) + +# Later down the script, we assume the version has only digits and dots +# Sometimes the release name starts with a "v", so let's filter it out. +# You may need more tweaks here if the upstream repository has different naming conventions. +if [[ ${version:0:1} == "v" || ${version:0:1} == "V" ]]; then + version=${version:1} +fi + +# Setting up the environment variables +echo "Current version: $current_version" +echo "Latest release from upstream: $version" +echo "VERSION=$version" >> $GITHUB_ENV +# For the time being, let's assume the script will fail +echo "PROCEED=false" >> $GITHUB_ENV + +# Proceed only if the retrieved version is greater than the current one +if ! dpkg --compare-versions "$current_version" "lt" "$version" ; then + echo "::warning ::No new version available" + exit 0 +# Proceed only if a PR for this new version does not already exist +elif git ls-remote -q --exit-code --heads https://github.com/$GITHUB_REPOSITORY.git ci-auto-update-v$version ; then + echo "::warning ::A branch already exists for this update" + exit 0 +fi + +# Each release can hold multiple assets (e.g. binaries for different architectures, source code, etc.) +echo "${#assets[@]} available asset(s)" + +#================================================= +# UPDATE SOURCE FILES +#================================================= + +# Here we use the $assets variable to get the resources published in the upstream release. +# Here is an example for Grav, it has to be adapted in accordance with how the upstream releases look like. + +# Let's loop over the array of assets URLs +for asset_url in ${assets[@]}; do + +echo "Handling asset at $asset_url" + +# Assign the asset to a source file in conf/ directory +# Here we base the source file name upon a unique keyword in the assets url (admin vs. update) +# Leave $src empty to ignore the asset +case $asset_url in + *"admin"*) + src="app" + ;; + *"update"*) + src="app-upgrade" + ;; + *) + src="" + ;; +esac + +# If $src is not empty, let's process the asset +if [ ! -z "$src" ]; then + +# Create the temporary directory +tempdir="$(mktemp -d)" + +# Download sources and calculate checksum +filename=${asset_url##*/} +curl --silent -4 -L $asset_url -o "$tempdir/$filename" +checksum=$(sha256sum "$tempdir/$filename" | head -c 64) + +# Delete temporary directory +rm -rf $tempdir + +# Get extension +if [[ $filename == *.tar.gz ]]; then + extension=tar.gz +else + extension=${filename##*.} +fi + +# Rewrite source file +cat < conf/$src.src +SOURCE_URL=$asset_url +SOURCE_SUM=$checksum +SOURCE_SUM_PRG=sha256sum +SOURCE_FORMAT=$extension +SOURCE_IN_SUBDIR=true +SOURCE_FILENAME= +EOT +echo "... conf/$src.src updated" + +else +echo "... asset ignored" +fi + +done + +#================================================= +# SPECIFIC UPDATE STEPS +#================================================= + +# Any action on the app's source code can be done. +# The GitHub Action workflow takes care of committing all changes after this script ends. + +#================================================= +# GENERIC FINALIZATION +#================================================= + +# Replace new version in manifest +echo "$(jq -s --indent 4 ".[] | .version = \"$version~ynh1\"" manifest.json)" > manifest.json + +# No need to update the README, yunohost-bot takes care of it + +# The Action will proceed only if the PROCEED environment variable is set to true +echo "PROCEED=true" >> $GITHUB_ENV +exit 0 diff --git a/README.md b/README.md index 49cb622..df6b8e2 100644 --- a/README.md +++ b/README.md @@ -1,31 +1,67 @@ -# Turtl app for YunoHost + -[![Integration level](https://dash.yunohost.org/integration/turtl.svg)](https://dash.yunohost.org/appci/app/turtl) ![](https://ci-apps.yunohost.org/ci/badges/turtl.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/turtl.maintain.svg) +# Turtl for YunoHost -- [Yunohost project](https://yunohost.org) -- [Turtl website](https://turtlapp.com/) +[![Integration level](https://dash.yunohost.org/integration/turtl.svg)](https://dash.yunohost.org/appci/app/turtl) ![](https://ci-apps.yunohost.org/ci/badges/turtl.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/turtl.maintain.svg) +[![Install Turtl with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=turtl) -![Turtl logo](https://avatars1.githubusercontent.com/u/5256479?v=4&s=200 "Turtl logo"). +*[Lire ce readme en français.](./README_fr.md)* -**WARNING**: this is a work in progress, test it at your own risks! +> *This package allows you to install Turtl 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.* -## Todo +## Overview -- [ ] test on x86 (only tested on arm for now) -- [ ] upgrade script -- [ ] backup script -- [ ] restore script -- [ ] check_process +Turtl is a free online service that allows you to create, synchronize and find your notes, in an encrypted manner. ------------------------------- +### Features -## What's Turtl +- Different note types: text, bookmark, password, image, and file/document +- Client-side cryptography to keep all of your data safe +- Securely share with anyone without compromising the security of your data +- Sharing allows different permissions ranging from read-only to full ownership of shared content +- Find your notes easily. Turtl supports full-text search, filtering by tag (or lack of tag), and sort by create/edit date +- Attach photos, files, and documents to your notes. Files are stored securely just like the rest of your data. +- Browser extension makes bookmarking easy on desktop +- Share to Turtl on Android for easy bookmarking and file uploads +- Write notes in Markdown, an easy and natural way to format text +- TeX math expressions in notes for math people (surround them by $$ to use) +- Multiple translations (German, Spanish, French, and more) +- RTL text support for our Farsi/Hebrew/etc-speaking friends +- Export/import your entire profile for backup purposes or to move between servers +- Semi-offline mode (you only need to be connected to log in) +- A number of keyboard shortcuts for navigation the app without mouse (type ? in-app to see shortcuts) +- An open-source server allows you to host your own Turtl data -Turtl lets you take notes, bookmark websites, and store documents for sensitive projects. -From sharing passwords with your coworkers to tracking research on an article you're writing, Turtl keeps it all safe from everyone but you and those you share with. -You will need apps to use Turtl. Get them from . +**Shipped version:** 1.0~ynh1 -## Nota bene -The `rethinkdb_2.3.6_armhf.deb` debian package in `conf` directory of this repository is a cross-compiled RethinkDB package for ARM architecture since no ARM package is provided by RethinkDB. + +## Screenshots + +![](./doc/screenshots/screenshot.png) + +## Documentation and resources + +* Official app website: https://turtlapp.com +* Official admin documentation: https://turtlapp.com/docs/ +* Upstream app code repository: https://github.com/turtl/server +* YunoHost documentation for this app: https://yunohost.org/app_turtl +* Report a bug: https://github.com/YunoHost-Apps/turtl_ynh/issues + +## Developer info + +Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/turtl_ynh/tree/testing). + +To try the testing branch, please proceed like that. +``` +sudo yunohost app install https://github.com/YunoHost-Apps/turtl_ynh/tree/testing --debug +or +sudo yunohost app upgrade turtl -u https://github.com/YunoHost-Apps/turtl_ynh/tree/testing --debug +``` + +**More info regarding app packaging:** https://yunohost.org/packaging_apps \ No newline at end of file diff --git a/README_fr.md b/README_fr.md new file mode 100644 index 0000000..26b343a --- /dev/null +++ b/README_fr.md @@ -0,0 +1,63 @@ +# Turtl pour YunoHost + +[![Niveau d'intégration](https://dash.yunohost.org/integration/turtl.svg)](https://dash.yunohost.org/appci/app/turtl) ![](https://ci-apps.yunohost.org/ci/badges/turtl.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/turtl.maintain.svg) +[![Installer Turtl avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=turtl) + +*[Read this readme in english.](./README.md)* +*[Lire ce readme en français.](./README_fr.md)* + +> *Ce package vous permet d'installer Turtl 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 + +Turtl is a free online service that allows you to create, synchronize and find your notes, in an encrypted manner. + +### Features + +- Different note types: text, bookmark, password, image, and file/document +- Client-side cryptography to keep all of your data safe +- Securely share with anyone without compromising the security of your data +- Sharing allows different permissions ranging from read-only to full ownership of shared content +- Find your notes easily. Turtl supports full-text search, filtering by tag (or lack of tag), and sort by create/edit date +- Attach photos, files, and documents to your notes. Files are stored securely just like the rest of your data. +- Browser extension makes bookmarking easy on desktop +- Share to Turtl on Android for easy bookmarking and file uploads +- Write notes in Markdown, an easy and natural way to format text +- TeX math expressions in notes for math people (surround them by $$ to use) +- Multiple translations (German, Spanish, French, and more) +- RTL text support for our Farsi/Hebrew/etc-speaking friends +- Export/import your entire profile for backup purposes or to move between servers +- Semi-offline mode (you only need to be connected to log in) +- A number of keyboard shortcuts for navigation the app without mouse (type ? in-app to see shortcuts) +- An open-source server allows you to host your own Turtl data + + +**Version incluse :** 1.0~ynh1 + + + +## Captures d'écran + +![](./doc/screenshots/screenshot.png) + +## Documentations et ressources + +* Site officiel de l'app : https://turtlapp.com +* Documentation officielle de l'admin : https://turtlapp.com/docs/ +* Dépôt de code officiel de l'app : https://github.com/turtl/server +* Documentation YunoHost pour cette app : https://yunohost.org/app_turtl +* Signaler un bug : https://github.com/YunoHost-Apps/turtl_ynh/issues + +## Informations pour les développeurs + +Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/turtl_ynh/tree/testing). + +Pour essayer la branche testing, procédez comme suit. +``` +sudo yunohost app install https://github.com/YunoHost-Apps/turtl_ynh/tree/testing --debug +ou +sudo yunohost app upgrade turtl -u https://github.com/YunoHost-Apps/turtl_ynh/tree/testing --debug +``` + +**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps \ No newline at end of file diff --git a/check_process b/check_process new file mode 100644 index 0000000..a57fd19 --- /dev/null +++ b/check_process @@ -0,0 +1,23 @@ +;; Test complet + ; Manifest + domain="domain.tld" + is_public=1 + ; Checks + pkg_linter=1 + setup_sub_dir=0 + setup_root=1 + setup_nourl=0 + setup_private=1 + setup_public=1 + upgrade=1 + #upgrade=1 from_commit=CommitHash + backup_restore=1 + multi_instance=0 + port_already_use=0 + change_url=0 +;;; Options +Email= +Notification=none +;;; Upgrade options + ; commit=CommitHash + name=Name and date of the commit. diff --git a/conf/app.src b/conf/app.src new file mode 100644 index 0000000..b0f784b --- /dev/null +++ b/conf/app.src @@ -0,0 +1,7 @@ +SOURCE_URL=https://codeload.github.com/turtl/server/tar.gz/0e59ee0a47fc5937600999d14ceb1aca6392aec8 +SOURCE_SUM=be1482756fed2fc80dd8592049c2282727439c883eae732844a6e30856eb55da +SOURCE_SUM_PRG=sha256sum +SOURCE_FORMAT=tar.gz +SOURCE_IN_SUBDIR=true +SOURCE_FILENAME= +SOURCE_EXTRACT=true diff --git a/conf/ccl-init.lisp b/conf/ccl-init.lisp deleted file mode 100644 index c2a9b1d..0000000 --- a/conf/ccl-init.lisp +++ /dev/null @@ -1,4 +0,0 @@ -#-quicklisp -(let ((quicklisp-init (merge-pathnames "quicklisp/setup.lisp" (user-homedir-pathname)))) - (when (probe-file quicklisp-init) - (load quicklisp-init))) diff --git a/conf/config.yaml.default b/conf/config.yaml.default new file mode 100644 index 0000000..326d0e1 --- /dev/null +++ b/conf/config.yaml.default @@ -0,0 +1,71 @@ +--- +server: + # Per default, turtl will listen on all IP addresses + # You can choose the IP it will use with this parameter + host: '127.0.0.1' + port: __PORT__ + +db: + connstr: 'postgres://__DB_USER__:__DB_PWD__@127.0.0.1:5432/__DB_NAME__' + pool: 24 + +loglevel: 'info' + +app: + # ALWAYS false in production. Always. + # Set to 'I UNDERSTAND THIS VIOLATES THE PRIVACY OF MY USERS' to enable + enable_bookmarker_proxy: false + # no trailing slash + api_url: 'https://__DOMAIN__' + www_url: 'https://__DOMAIN__' + login: + # Max failed login attemps. Set to -1 to disable + max_attemps: 5 + # User locked for this duration in seconds + lock_duration: 60 + emails: + admin: 'admin@__DOMAIN__' + info: 'Turtl ' + invites: 'invites@__DOMAIN__' + # TODO: replace this with a long, unique value. seriously. write down a dream + # you had, or the short story you came up with during your creative writing + # class in your freshmen year of college. have fun with it. + secure_hash_salt: "__HASH__" + # set to true if you think it's ok to SEND invites if you have not confirmed + # your account. great for testing, not so great for production. but what do + # i know... + allow_unconfirmed_invites: false + +sync: + # how many sync records can a client send at a time? it's a good idea to have + # a limit here, lest a rogue client flood the server with sync items + max_bulk_sync_records: 32 + +plugins: + plugin_location: '__FINALPATH__/plugins' + # each key here corresponds to a folder name in the plugins folder, so `email` + # below would be a plugin at /var/www/turtl/server/plugins/email (see the + # example-plugins/ folder for an email plugin you can use) + #email: + # enabled: false + # endpoint: 'smtps://user:password@smtp.gmail.com/?pool=true' + # defaults: {} + +uploads: + # if set to a path, files will be uploaded to the local filesystem instead of + # S3. otherwise, set to false + local: '__DATADIR__' + # if true, downloading local files will be proxied through the turtl server. + # this avoids needing to set up any CORS config in your favorite webserver, + # but may slightly affect performance on high-demand servers. + local_proxy: true + # if local_proxy is false, this is should be the url path the uploaded files + # are publicly available on + url: 'http://api.turtl.dev/uploads' + +s3: + token: '' + secret: '' + bucket: '' + endpoint: 'https://s3.amazonaws.com' + pathstyle: false diff --git a/conf/logrotate.conf b/conf/logrotate.conf deleted file mode 100644 index a6e12e6..0000000 --- a/conf/logrotate.conf +++ /dev/null @@ -1,12 +0,0 @@ -/var/log/turtl/turtl.log -{ - rotate 7 - daily - missingok - notifempty - delaycompress - compress - postrotate - service turtl restart - endscript -} diff --git a/conf/nginx.conf b/conf/nginx.conf index 8d54e79..83c83e2 100644 --- a/conf/nginx.conf +++ b/conf/nginx.conf @@ -1,6 +1,10 @@ -location __PATH__ { - proxy_set_header Host $host; - proxy_pass http://127.0.0.1:__PORT____PATH__; - #--PRIVATE--# Include SSOWAT user panel. - include conf.d/yunohost_panel.conf.inc; +location / { + + proxy_pass http://127.0.0.1:__PORT__; + proxy_redirect off; + proxy_set_header Host $host; + proxy_set_header X-Real-IP $remote_addr; + proxy_set_header X-Forwarded-Proto $scheme; + proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; + proxy_set_header X-Forwarded-Host $server_name; } diff --git a/conf/quicklisp.lisp b/conf/quicklisp.lisp deleted file mode 100644 index 6cda472..0000000 --- a/conf/quicklisp.lisp +++ /dev/null @@ -1,1757 +0,0 @@ -;;;; -;;;; This is quicklisp.lisp, the quickstart file for Quicklisp. To use -;;;; it, start Lisp, then (load "quicklisp.lisp") -;;;; -;;;; Quicklisp is beta software and comes with no warranty of any kind. -;;;; -;;;; For more information about the Quicklisp beta, see: -;;;; -;;;; http://www.quicklisp.org/beta/ -;;;; -;;;; If you have any questions or comments about Quicklisp, please -;;;; contact: -;;;; -;;;; Zach Beane -;;;; - -(cl:in-package #:cl-user) -(cl:defpackage #:qlqs-user - (:use #:cl)) -(cl:in-package #:qlqs-user) - -(defpackage #:qlqs-info - (:export #:*version*)) - -(defvar qlqs-info:*version* "2015-01-28") - -(defpackage #:qlqs-impl - (:use #:cl) - (:export #:*implementation*) - (:export #:definterface - #:defimplementation) - (:export #:lisp - #:abcl - #:allegro - #:ccl - #:clasp - #:clisp - #:cmucl - #:cormanlisp - #:ecl - #:gcl - #:lispworks - #:mkcl - #:scl - #:sbcl)) - -(defpackage #:qlqs-impl-util - (:use #:cl #:qlqs-impl) - (:export #:call-with-quiet-compilation)) - -(defpackage #:qlqs-network - (:use #:cl #:qlqs-impl) - (:export #:open-connection - #:write-octets - #:read-octets - #:close-connection - #:with-connection)) - -(defpackage #:qlqs-progress - (:use #:cl) - (:export #:make-progress-bar - #:start-display - #:update-progress - #:finish-display)) - -(defpackage #:qlqs-http - (:use #:cl #:qlqs-network #:qlqs-progress) - (:export #:fetch - #:*proxy-url* - #:*maximum-redirects* - #:*default-url-defaults*)) - -(defpackage #:qlqs-minitar - (:use #:cl) - (:export #:unpack-tarball)) - -(defpackage #:quicklisp-quickstart - (:use #:cl #:qlqs-impl #:qlqs-impl-util #:qlqs-http #:qlqs-minitar) - (:export #:install - #:help - #:*proxy-url* - #:*asdf-url* - #:*quicklisp-tar-url* - #:*setup-url* - #:*help-message* - #:*after-load-message* - #:*after-initial-setup-message*)) - - -;;; -;;; Defining implementation-specific packages and functionality -;;; - -(in-package #:qlqs-impl) - -(eval-when (:compile-toplevel :load-toplevel :execute) - (defun error-unimplemented (&rest args) - (declare (ignore args)) - (error "Not implemented"))) - -(defmacro neuter-package (name) - `(eval-when (:compile-toplevel :load-toplevel :execute) - (let ((definition (fdefinition 'error-unimplemented))) - (do-external-symbols (symbol ,(string name)) - (unless (fboundp symbol) - (setf (fdefinition symbol) definition)))))) - -(eval-when (:compile-toplevel :load-toplevel :execute) - (defun feature-expression-passes-p (expression) - (cond ((keywordp expression) - (member expression *features*)) - ((consp expression) - (case (first expression) - (or - (some 'feature-expression-passes-p (rest expression))) - (and - (every 'feature-expression-passes-p (rest expression))))) - (t (error "Unrecognized feature expression -- ~S" expression))))) - - -(defmacro define-implementation-package (feature package-name &rest options) - (let* ((output-options '((:use) - (:export #:lisp))) - (prep (cdr (assoc :prep options))) - (class-option (cdr (assoc :class options))) - (class (first class-option)) - (superclasses (rest class-option)) - (import-options '()) - (effectivep (feature-expression-passes-p feature))) - (dolist (option options) - (ecase (first option) - ((:prep :class)) - ((:import-from - :import) - (push option import-options)) - ((:export - :shadow - :intern - :documentation) - (push option output-options)) - ((:reexport-from) - (push (cons :export (cddr option)) output-options) - (push (cons :import-from (cdr option)) import-options)))) - `(eval-when (:compile-toplevel :load-toplevel :execute) - ,@(when effectivep - prep) - (defclass ,class ,superclasses ()) - (defpackage ,package-name ,@output-options - ,@(when effectivep - import-options)) - ,@(when effectivep - `((setf *implementation* (make-instance ',class)))) - ,@(unless effectivep - `((neuter-package ,package-name)))))) - -(defmacro definterface (name lambda-list &body options) - (let* ((forbidden (intersection lambda-list lambda-list-keywords)) - (gf-options (remove :implementation options :key #'first)) - (implementations (set-difference options gf-options))) - (when forbidden - (error "~S not allowed in definterface lambda list" forbidden)) - (flet ((method-option (class body) - `(:method ((*implementation* ,class) ,@lambda-list) - ,@body))) - (let ((generic-name (intern (format nil "%~A" name)))) - `(eval-when (:compile-toplevel :load-toplevel :execute) - (defgeneric ,generic-name (lisp ,@lambda-list) - ,@gf-options - ,@(mapcar (lambda (implementation) - (destructuring-bind (class &rest body) - (rest implementation) - (method-option class body))) - implementations)) - (defun ,name ,lambda-list - (,generic-name *implementation* ,@lambda-list))))))) - -(defmacro defimplementation (name-and-options - lambda-list &body body) - (destructuring-bind (name &key (for t) qualifier) - (if (consp name-and-options) - name-and-options - (list name-and-options)) - (unless for - (error "You must specify an implementation name.")) - (let ((generic-name (find-symbol (format nil "%~A" name)))) - (unless (and generic-name - (fboundp generic-name)) - (error "~S does not name an implementation function" name)) - `(defmethod ,generic-name - ,@(when qualifier (list qualifier)) - ,(list* `(*implementation* ,for) lambda-list) ,@body)))) - - -;;; Bootstrap implementations - -(defvar *implementation* nil) -(defclass lisp () ()) - - -;;; Allegro Common Lisp - -(define-implementation-package :allegro #:qlqs-allegro - (:documentation - "Allegro Common Lisp - http://www.franz.com/products/allegrocl/") - (:class allegro) - (:reexport-from #:socket - #:make-socket) - (:reexport-from #:excl - #:read-vector)) - - -;;; Armed Bear Common Lisp - -(define-implementation-package :abcl #:qlqs-abcl - (:documentation - "Armed Bear Common Lisp - http://common-lisp.net/project/armedbear/") - (:class abcl) - (:reexport-from #:system - #:make-socket - #:get-socket-stream)) - -;;; Clozure CL - -(define-implementation-package :ccl #:qlqs-ccl - (:documentation - "Clozure Common Lisp - http://www.clozure.com/clozurecl.html") - (:class ccl) - (:reexport-from #:ccl - #:make-socket)) - - -;;; CLASP - -(define-implementation-package :clasp #:qlqs-clasp - (:documentation "CLASP - http://github.com/drmeister/clasp") - (:class clasp) - (:prep - (require 'sockets)) - (:intern #:host-network-address) - (:reexport-from #:sb-bsd-sockets - #:get-host-by-name - #:host-ent-address - #:socket-connect - #:socket-make-stream - #:inet-socket)) - - -;;; GNU CLISP - -(define-implementation-package :clisp #:qlqs-clisp - (:documentation "GNU CLISP - http://clisp.cons.org/") - (:class clisp) - (:reexport-from #:socket - #:socket-connect) - (:reexport-from #:ext - #:read-byte-sequence)) - - -;;; CMUCL - -(define-implementation-package :cmu #:qlqs-cmucl - (:documentation "CMU Common Lisp - http://www.cons.org/cmucl/") - (:class cmucl) - (:reexport-from #:ext - #:*gc-verbose*) - (:reexport-from #:system - #:make-fd-stream) - (:reexport-from #:extensions - #:connect-to-inet-socket)) - -(defvar qlqs-cmucl:*gc-verbose* nil) - - -;;; Scieneer CL - -(define-implementation-package :scl #:qlqs-scl - (:documentation "Scieneer Common Lisp - http://www.scieneer.com/scl/") - (:class scl) - (:reexport-from #:system - #:make-fd-stream) - (:reexport-from #:extensions - #:connect-to-inet-socket)) - -;;; ECL - -(define-implementation-package :ecl #:qlqs-ecl - (:documentation "ECL - http://ecls.sourceforge.net/") - (:class ecl) - (:prep - (require 'sockets)) - (:intern #:host-network-address) - (:reexport-from #:sb-bsd-sockets - #:get-host-by-name - #:host-ent-address - #:socket-connect - #:socket-make-stream - #:inet-socket)) - - -;;; LispWorks - -(define-implementation-package :lispworks #:qlqs-lispworks - (:documentation "LispWorks - http://www.lispworks.com/") - (:class lispworks) - (:prep - (require "comm")) - (:reexport-from #:comm - #:open-tcp-stream - #:get-host-entry)) - - -;;; SBCL - -(define-implementation-package :sbcl #:qlqs-sbcl - (:class sbcl) - (:documentation - "Steel Bank Common Lisp - http://www.sbcl.org/") - (:prep - (require 'sb-bsd-sockets)) - (:intern #:host-network-address) - (:reexport-from #:sb-ext - #:compiler-note) - (:reexport-from #:sb-bsd-sockets - #:get-host-by-name - #:inet-socket - #:host-ent-address - #:socket-connect - #:socket-make-stream)) - -;;; MKCL - -(define-implementation-package :mkcl #:qlqs-mkcl - (:class mkcl) - (:documentation - "ManKai Common Lisp - http://common-lisp.net/project/mkcl/") - (:prep - (require 'sockets)) - (:intern #:host-network-address) - (:reexport-from #:sb-bsd-sockets - #:get-host-by-name - #:inet-socket - #:host-ent-address - #:socket-connect - #:socket-make-stream)) - -;;; -;;; Utility function -;;; - -(in-package #:qlqs-impl-util) - -(definterface call-with-quiet-compilation (fun) - (:implementation t - (let ((*load-verbose* nil) - (*compile-verbose* nil) - (*load-print* nil) - (*compile-print* nil)) - (handler-bind ((warning #'muffle-warning)) - (funcall fun))))) - -(defimplementation (call-with-quiet-compilation :for sbcl :qualifier :around) - (fun) - (declare (ignorable fun)) - (handler-bind ((qlqs-sbcl:compiler-note #'muffle-warning)) - (call-next-method))) - -(defimplementation (call-with-quiet-compilation :for cmucl :qualifier :around) - (fun) - (declare (ignorable fun)) - (let ((qlqs-cmucl:*gc-verbose* nil)) - (call-next-method))) - - -;;; -;;; Low-level networking implementations -;;; - -(in-package #:qlqs-network) - -(definterface host-address (host) - (:implementation t - host) - (:implementation mkcl - (qlqs-mkcl:host-ent-address (qlqs-mkcl:get-host-by-name host))) - (:implementation sbcl - (qlqs-sbcl:host-ent-address (qlqs-sbcl:get-host-by-name host)))) - -(definterface open-connection (host port) - (:implementation t - (declare (ignorable host port)) - (error "Sorry, quicklisp in implementation ~S is not supported yet." - (lisp-implementation-type))) - (:implementation allegro - (qlqs-allegro:make-socket :remote-host host - :remote-port port)) - (:implementation abcl - (let ((socket (qlqs-abcl:make-socket host port))) - (qlqs-abcl:get-socket-stream socket :element-type '(unsigned-byte 8)))) - (:implementation ccl - (qlqs-ccl:make-socket :remote-host host - :remote-port port)) - (:implementation clasp - (let* ((endpoint (qlqs-clasp:host-ent-address - (qlqs-clasp:get-host-by-name host))) - (socket (make-instance 'qlqs-clasp:inet-socket - :protocol :tcp - :type :stream))) - (qlqs-clasp:socket-connect socket endpoint port) - (qlqs-clasp:socket-make-stream socket - :element-type '(unsigned-byte 8) - :input t - :output t - :buffering :full))) - (:implementation clisp - (qlqs-clisp:socket-connect port host :element-type '(unsigned-byte 8))) - (:implementation cmucl - (let ((fd (qlqs-cmucl:connect-to-inet-socket host port))) - (qlqs-cmucl:make-fd-stream fd - :element-type '(unsigned-byte 8) - :binary-stream-p t - :input t - :output t))) - (:implementation scl - (let ((fd (qlqs-scl:connect-to-inet-socket host port))) - (qlqs-scl:make-fd-stream fd - :element-type '(unsigned-byte 8) - :input t - :output t))) - (:implementation ecl - (let* ((endpoint (qlqs-ecl:host-ent-address - (qlqs-ecl:get-host-by-name host))) - (socket (make-instance 'qlqs-ecl:inet-socket - :protocol :tcp - :type :stream))) - (qlqs-ecl:socket-connect socket endpoint port) - (qlqs-ecl:socket-make-stream socket - :element-type '(unsigned-byte 8) - :input t - :output t - :buffering :full))) - (:implementation lispworks - (qlqs-lispworks:open-tcp-stream host port - :direction :io - :errorp t - :read-timeout nil - :element-type '(unsigned-byte 8) - :timeout 5)) - (:implementation mkcl - (let* ((endpoint (qlqs-mkcl:host-ent-address - (qlqs-mkcl:get-host-by-name host))) - (socket (make-instance 'qlqs-mkcl:inet-socket - :protocol :tcp - :type :stream))) - (qlqs-mkcl:socket-connect socket endpoint port) - (qlqs-mkcl:socket-make-stream socket - :element-type '(unsigned-byte 8) - :input t - :output t - :buffering :full))) - (:implementation sbcl - (let* ((endpoint (qlqs-sbcl:host-ent-address - (qlqs-sbcl:get-host-by-name host))) - (socket (make-instance 'qlqs-sbcl:inet-socket - :protocol :tcp - :type :stream))) - (qlqs-sbcl:socket-connect socket endpoint port) - (qlqs-sbcl:socket-make-stream socket - :element-type '(unsigned-byte 8) - :input t - :output t - :buffering :full)))) - -(definterface read-octets (buffer connection) - (:implementation t - (read-sequence buffer connection)) - (:implementation allegro - (qlqs-allegro:read-vector buffer connection)) - (:implementation clisp - (qlqs-clisp:read-byte-sequence buffer connection - :no-hang nil - :interactive t))) - -(definterface write-octets (buffer connection) - (:implementation t - (write-sequence buffer connection) - (finish-output connection))) - -(definterface close-connection (connection) - (:implementation t - (ignore-errors (close connection)))) - -(definterface call-with-connection (host port fun) - (:implementation t - (let (connection) - (unwind-protect - (progn - (setf connection (open-connection host port)) - (funcall fun connection)) - (when connection - (close connection)))))) - -(defmacro with-connection ((connection host port) &body body) - `(call-with-connection ,host ,port (lambda (,connection) ,@body))) - - -;;; -;;; A text progress bar -;;; - -(in-package #:qlqs-progress) - -(defclass progress-bar () - ((start-time - :initarg :start-time - :accessor start-time) - (end-time - :initarg :end-time - :accessor end-time) - (progress-character - :initarg :progress-character - :accessor progress-character) - (character-count - :initarg :character-count - :accessor character-count - :documentation "How many characters wide is the progress bar?") - (characters-so-far - :initarg :characters-so-far - :accessor characters-so-far) - (update-interval - :initarg :update-interval - :accessor update-interval - :documentation "Update the progress bar display after this many - internal-time units.") - (last-update-time - :initarg :last-update-time - :accessor last-update-time - :documentation "The display was last updated at this time.") - (total - :initarg :total - :accessor total - :documentation "The total number of units tracked by this progress bar.") - (progress - :initarg :progress - :accessor progress - :documentation "How far in the progress are we?") - (pending - :initarg :pending - :accessor pending - :documentation "How many raw units should be tracked in the next - display update?")) - (:default-initargs - :progress-character #\= - :character-count 50 - :characters-so-far 0 - :update-interval (floor internal-time-units-per-second 4) - :last-update-time 0 - :total 0 - :progress 0 - :pending 0)) - -(defgeneric start-display (progress-bar)) -(defgeneric update-progress (progress-bar unit-count)) -(defgeneric update-display (progress-bar)) -(defgeneric finish-display (progress-bar)) -(defgeneric elapsed-time (progress-bar)) -(defgeneric units-per-second (progress-bar)) - -(defmethod start-display (progress-bar) - (setf (last-update-time progress-bar) (get-internal-real-time)) - (setf (start-time progress-bar) (get-internal-real-time)) - (fresh-line) - (finish-output)) - -(defmethod update-display (progress-bar) - (incf (progress progress-bar) (pending progress-bar)) - (setf (pending progress-bar) 0) - (setf (last-update-time progress-bar) (get-internal-real-time)) - (let* ((showable (floor (character-count progress-bar) - (/ (total progress-bar) (progress progress-bar)))) - (needed (- showable (characters-so-far progress-bar)))) - (setf (characters-so-far progress-bar) showable) - (dotimes (i needed) - (write-char (progress-character progress-bar))) - (finish-output))) - -(defmethod update-progress (progress-bar unit-count) - (incf (pending progress-bar) unit-count) - (let ((now (get-internal-real-time))) - (when (< (update-interval progress-bar) - (- now (last-update-time progress-bar))) - (update-display progress-bar)))) - -(defmethod finish-display (progress-bar) - (update-display progress-bar) - (setf (end-time progress-bar) (get-internal-real-time)) - (terpri) - (format t "~:D bytes in ~$ seconds (~$KB/sec)" - (total progress-bar) - (elapsed-time progress-bar) - (/ (units-per-second progress-bar) 1024)) - (finish-output)) - -(defmethod elapsed-time (progress-bar) - (/ (- (end-time progress-bar) (start-time progress-bar)) - internal-time-units-per-second)) - -(defmethod units-per-second (progress-bar) - (if (plusp (elapsed-time progress-bar)) - (/ (total progress-bar) (elapsed-time progress-bar)) - 0)) - -(defun kb/sec (progress-bar) - (/ (units-per-second progress-bar) 1024)) - - - -(defparameter *uncertain-progress-chars* "?") - -(defclass uncertain-size-progress-bar (progress-bar) - ((progress-char-index - :initarg :progress-char-index - :accessor progress-char-index) - (units-per-char - :initarg :units-per-char - :accessor units-per-char)) - (:default-initargs - :total 0 - :progress-char-index 0 - :units-per-char (floor (expt 1024 2) 50))) - -(defmethod update-progress :after ((progress-bar uncertain-size-progress-bar) - unit-count) - (incf (total progress-bar) unit-count)) - -(defmethod progress-character ((progress-bar uncertain-size-progress-bar)) - (let ((index (progress-char-index progress-bar))) - (prog1 - (char *uncertain-progress-chars* index) - (setf (progress-char-index progress-bar) - (mod (1+ index) (length *uncertain-progress-chars*)))))) - -(defmethod update-display ((progress-bar uncertain-size-progress-bar)) - (setf (last-update-time progress-bar) (get-internal-real-time)) - (multiple-value-bind (chars pend) - (floor (pending progress-bar) (units-per-char progress-bar)) - (setf (pending progress-bar) pend) - (dotimes (i chars) - (write-char (progress-character progress-bar)) - (incf (characters-so-far progress-bar)) - (when (<= (character-count progress-bar) - (characters-so-far progress-bar)) - (terpri) - (setf (characters-so-far progress-bar) 0) - (finish-output))) - (finish-output))) - -(defun make-progress-bar (total) - (if (or (not total) (zerop total)) - (make-instance 'uncertain-size-progress-bar) - (make-instance 'progress-bar :total total))) - -;;; -;;; A simple HTTP client -;;; - -(in-package #:qlqs-http) - -;;; Octet data - -(deftype octet () - '(unsigned-byte 8)) - -(defun make-octet-vector (size) - (make-array size :element-type 'octet - :initial-element 0)) - -(defun octet-vector (&rest octets) - (make-array (length octets) :element-type 'octet - :initial-contents octets)) - -;;; ASCII characters as integers - -(defun acode (char) - (cond ((eql char :cr) - 13) - ((eql char :lf) - 10) - (t - (let ((code (char-code char))) - (if (<= 0 code 127) - code - (error "Character ~S is not in the ASCII character set" - char)))))) - -(defvar *whitespace* - (list (acode #\Space) (acode #\Tab) (acode :cr) (acode :lf))) - -(defun whitep (code) - (member code *whitespace*)) - -(defun ascii-vector (string) - (let ((vector (make-octet-vector (length string)))) - (loop for char across string - for code = (char-code char) - for i from 0 - if (< 127 code) do - (error "Invalid character for ASCII -- ~A" char) - else - do (setf (aref vector i) code)) - vector)) - -(defun ascii-subseq (vector start end) - "Return a subseq of octet-specialized VECTOR as a string." - (let ((string (make-string (- end start)))) - (loop for i from 0 - for j from start below end - do (setf (char string i) (code-char (aref vector j)))) - string)) - -(defun ascii-downcase (code) - (if (<= 65 code 90) - (+ code 32) - code)) - -(defun ascii-equal (a b) - (eql (ascii-downcase a) (ascii-downcase b))) - -(defmacro acase (value &body cases) - (flet ((convert-case-keys (keys) - (mapcar (lambda (key) - (etypecase key - (integer key) - (character (char-code key)) - (symbol - (ecase key - (:cr 13) - (:lf 10) - ((t) t))))) - (if (consp keys) keys (list keys))))) - `(case ,value - ,@(mapcar (lambda (case) - (destructuring-bind (keys &rest body) - case - `(,(if (eql keys t) - t - (convert-case-keys keys)) - ,@body))) - cases)))) - -;;; Pattern matching (for finding headers) - -(defclass matcher () - ((pattern - :initarg :pattern - :reader pattern) - (pos - :initform 0 - :accessor match-pos) - (matchedp - :initform nil - :accessor matchedp))) - -(defun reset-match (matcher) - (setf (match-pos matcher) 0 - (matchedp matcher) nil)) - -(define-condition match-failure (error) ()) - -(defun match (matcher input &key (start 0) end error) - (let ((i start) - (end (or end (length input))) - (match-end (length (pattern matcher)))) - (with-slots (pattern pos) - matcher - (loop - (cond ((= pos match-end) - (let ((match-start (- i pos))) - (setf pos 0) - (setf (matchedp matcher) t) - (return (values match-start (+ match-start match-end))))) - ((= i end) - (return nil)) - ((= (aref pattern pos) - (aref input i)) - (incf i) - (incf pos)) - (t - (if error - (error 'match-failure) - (if (zerop pos) - (incf i) - (setf pos 0))))))))) - -(defun ascii-matcher (string) - (make-instance 'matcher - :pattern (ascii-vector string))) - -(defun octet-matcher (&rest octets) - (make-instance 'matcher - :pattern (apply 'octet-vector octets))) - -(defun acode-matcher (&rest codes) - (make-instance 'matcher - :pattern (make-array (length codes) - :element-type 'octet - :initial-contents - (mapcar 'acode codes)))) - - -;;; "Connection Buffers" are a kind of callback-driven, -;;; pattern-matching chunky stream. Callbacks can be called for a -;;; certain number of octets or until one or more patterns are seen in -;;; the input. cbufs automatically refill themselves from a -;;; connection as needed. - -(defvar *cbuf-buffer-size* 8192) - -(define-condition end-of-data (error) ()) - -(defclass cbuf () - ((data - :initarg :data - :accessor data) - (connection - :initarg :connection - :accessor connection) - (start - :initarg :start - :accessor start) - (end - :initarg :end - :accessor end) - (eofp - :initarg :eofp - :accessor eofp)) - (:default-initargs - :data (make-octet-vector *cbuf-buffer-size*) - :connection nil - :start 0 - :end 0 - :eofp nil) - (:documentation "A CBUF is a connection buffer that keeps track of - incoming data from a connection. Several functions make it easy to - treat a CBUF as a kind of chunky, callback-driven stream.")) - -(define-condition cbuf-progress () - ((size - :initarg :size - :accessor cbuf-progress-size - :initform 0))) - -(defun call-processor (fun cbuf start end) - (signal 'cbuf-progress :size (- end start)) - (funcall fun (data cbuf) start end)) - -(defun make-cbuf (connection) - (make-instance 'cbuf :connection connection)) - -(defun make-stream-writer (stream) - "Create a callback for writing data to STREAM." - (lambda (data start end) - (write-sequence data stream :start start :end end))) - -(defgeneric size (cbuf) - (:method ((cbuf cbuf)) - (- (end cbuf) (start cbuf)))) - -(defgeneric emptyp (cbuf) - (:method ((cbuf cbuf)) - (zerop (size cbuf)))) - -(defgeneric refill (cbuf) - (:method ((cbuf cbuf)) - (when (eofp cbuf) - (error 'end-of-data)) - (setf (start cbuf) 0) - (setf (end cbuf) - (read-octets (data cbuf) - (connection cbuf))) - (cond ((emptyp cbuf) - (setf (eofp cbuf) t) - (error 'end-of-data)) - (t (size cbuf))))) - -(defun process-all (fun cbuf) - (unless (emptyp cbuf) - (call-processor fun cbuf (start cbuf) (end cbuf)))) - -(defun multi-cmatch (matchers cbuf) - (let (start end) - (dolist (matcher matchers (values start end)) - (multiple-value-bind (s e) - (match matcher (data cbuf) - :start (start cbuf) - :end (end cbuf)) - (when (and s (or (null start) (< s start))) - (setf start s - end e)))))) - -(defun cmatch (matcher cbuf) - (if (consp matcher) - (multi-cmatch matcher cbuf) - (match matcher (data cbuf) :start (start cbuf) :end (end cbuf)))) - -(defun call-until-end (fun cbuf) - (handler-case - (loop - (process-all fun cbuf) - (refill cbuf)) - (end-of-data () - (return-from call-until-end)))) - -(defun show-cbuf (context cbuf) - (format t "cbuf: ~A ~D - ~D~%" context (start cbuf) (end cbuf))) - -(defun call-for-n-octets (n fun cbuf) - (let ((remaining n)) - (loop - (when (<= remaining (size cbuf)) - (let ((end (+ (start cbuf) remaining))) - (call-processor fun cbuf (start cbuf) end) - (setf (start cbuf) end) - (return))) - (process-all fun cbuf) - (decf remaining (size cbuf)) - (refill cbuf)))) - -(defun call-until-matching (matcher fun cbuf) - (loop - (multiple-value-bind (start end) - (cmatch matcher cbuf) - (when start - (call-processor fun cbuf (start cbuf) end) - (setf (start cbuf) end) - (return))) - (process-all fun cbuf) - (refill cbuf))) - -(defun ignore-data (data start end) - (declare (ignore data start end))) - -(defun skip-until-matching (matcher cbuf) - (call-until-matching matcher 'ignore-data cbuf)) - - -;;; Creating HTTP requests as octet buffers - -(defclass octet-sink () - ((storage - :initarg :storage - :accessor storage)) - (:default-initargs - :storage (make-array 1024 :element-type 'octet - :fill-pointer 0 - :adjustable t)) - (:documentation "A simple stream-like target for collecting - octets.")) - -(defun add-octet (octet sink) - (vector-push-extend octet (storage sink))) - -(defun add-octets (octets sink &key (start 0) end) - (setf end (or end (length octets))) - (loop for i from start below end - do (add-octet (aref octets i) sink))) - -(defun add-string (string sink) - (loop for char across string - for code = (char-code char) - do (add-octet code sink))) - -(defun add-strings (sink &rest strings) - (mapc (lambda (string) (add-string string sink)) strings)) - -(defun add-newline (sink) - (add-octet 13 sink) - (add-octet 10 sink)) - -(defun sink-buffer (sink) - (subseq (storage sink) 0)) - -(defvar *proxy-url* nil) - -(defun full-proxy-path (host port path) - (format nil "~:[http~;https~]://~A~:[:~D~;~*~]~A" - (= port 443) - host - (or (= port 80) - (= port 443)) - port - path)) - -(defun make-request-buffer (host port path &key (method "GET")) - (setf method (string method)) - (when *proxy-url* - (setf path (full-proxy-path host port path))) - (let ((sink (make-instance 'octet-sink))) - (flet ((add-line (&rest strings) - (apply #'add-strings sink strings) - (add-newline sink))) - (add-line method " " path " HTTP/1.1") - (add-line "Host: " host (if (= port 80) "" - (format nil ":~D" port))) - (add-line "Connection: close") - ;; FIXME: get this version string from somewhere else. - (add-line "User-Agent: quicklisp-bootstrap/" - qlqs-info:*version*) - (add-newline sink) - (sink-buffer sink)))) - -(defun sink-until-matching (matcher cbuf) - (let ((sink (make-instance 'octet-sink))) - (call-until-matching - matcher - (lambda (buffer start end) - (add-octets buffer sink :start start :end end)) - cbuf) - (sink-buffer sink))) - - -;;; HTTP headers - -(defclass header () - ((data - :initarg :data - :accessor data) - (status - :initarg :status - :accessor status) - (name-starts - :initarg :name-starts - :accessor name-starts) - (name-ends - :initarg :name-ends - :accessor name-ends) - (value-starts - :initarg :value-starts - :accessor value-starts) - (value-ends - :initarg :value-ends - :accessor value-ends))) - -(defmethod print-object ((header header) stream) - (print-unreadable-object (header stream :type t) - (prin1 (status header) stream))) - -(defun matches-at (pattern target pos) - (= (mismatch pattern target :start2 pos) (length pattern))) - -(defun header-value-indexes (field-name header) - (loop with data = (data header) - with pattern = (ascii-vector (string-downcase field-name)) - for start across (name-starts header) - for i from 0 - when (matches-at pattern data start) - return (values (aref (value-starts header) i) - (aref (value-ends header) i)))) - -(defun ascii-header-value (field-name header) - (multiple-value-bind (start end) - (header-value-indexes field-name header) - (when start - (ascii-subseq (data header) start end)))) - -(defun all-field-names (header) - (map 'list - (lambda (start end) - (ascii-subseq (data header) start end)) - (name-starts header) - (name-ends header))) - -(defun headers-alist (header) - (mapcar (lambda (name) - (cons name (ascii-header-value name header))) - (all-field-names header))) - -(defmethod describe-object :after ((header header) stream) - (format stream "~&Decoded headers:~% ~S~%" (headers-alist header))) - -(defun content-length (header) - (let ((field-value (ascii-header-value "content-length" header))) - (when field-value - (let ((value (ignore-errors (parse-integer field-value)))) - (or value - (error "Content-Length header field value is not a number -- ~A" - field-value)))))) - -(defun chunkedp (header) - (string= (ascii-header-value "transfer-encoding" header) "chunked")) - -(defun location (header) - (ascii-header-value "location" header)) - -(defun status-code (vector) - (let* ((space (position (acode #\Space) vector)) - (c1 (- (aref vector (incf space)) 48)) - (c2 (- (aref vector (incf space)) 48)) - (c3 (- (aref vector (incf space)) 48))) - (+ (* c1 100) - (* c2 10) - (* c3 1)))) - -(defun force-downcase-field-names (header) - (loop with data = (data header) - for start across (name-starts header) - for end across (name-ends header) - do (loop for i from start below end - for code = (aref data i) - do (setf (aref data i) (ascii-downcase code))))) - -(defun skip-white-forward (pos vector) - (position-if-not 'whitep vector :start pos)) - -(defun skip-white-backward (pos vector) - (let ((nonwhite (position-if-not 'whitep vector :end pos :from-end t))) - (if nonwhite - (1+ nonwhite) - pos))) - -(defun contract-field-value-indexes (header) - "Header field values exclude leading and trailing whitespace; adjust -the indexes in the header accordingly." - (loop with starts = (value-starts header) - with ends = (value-ends header) - with data = (data header) - for i from 0 - for start across starts - for end across ends - do - (setf (aref starts i) (skip-white-forward start data)) - (setf (aref ends i) (skip-white-backward end data)))) - -(defun next-line-pos (vector) - (let ((pos 0)) - (labels ((finish (&optional (i pos)) - (return-from next-line-pos i)) - (after-cr (code) - (acase code - (:lf (finish pos)) - (t (finish (1- pos))))) - (pending (code) - (acase code - (:cr #'after-cr) - (:lf (finish pos)) - (t #'pending)))) - (let ((state #'pending)) - (loop - (setf state (funcall state (aref vector pos))) - (incf pos)))))) - -(defun make-hvector () - (make-array 16 :fill-pointer 0 :adjustable t)) - -(defun process-header (vector) - "Create a HEADER instance from the octet data in VECTOR." - (let* ((name-starts (make-hvector)) - (name-ends (make-hvector)) - (value-starts (make-hvector)) - (value-ends (make-hvector)) - (header (make-instance 'header - :data vector - :status 999 - :name-starts name-starts - :name-ends name-ends - :value-starts value-starts - :value-ends value-ends)) - (mark nil) - (pos (next-line-pos vector))) - (unless pos - (error "Unable to process HTTP header")) - (setf (status header) (status-code vector)) - (labels ((save (value vector) - (vector-push-extend value vector)) - (mark () - (setf mark pos)) - (clear-mark () - (setf mark nil)) - (finish () - (if mark - (save mark value-ends) - (save pos value-ends)) - (force-downcase-field-names header) - (contract-field-value-indexes header) - (return-from process-header header)) - (in-new-line (code) - (acase code - ((#\Tab #\Space) (setf mark nil) #'in-value) - (t - (when mark - (save mark value-ends)) - (clear-mark) - (save pos name-starts) - (in-name code)))) - (after-cr (code) - (acase code - (:lf #'in-new-line) - (t (in-new-line code)))) - (pending-value (code) - (acase code - ((#\Tab #\Space) #'pending-value) - (:cr #'after-cr) - (:lf #'in-new-line) - (t (save pos value-starts) #'in-value))) - (in-name (code) - (acase code - (#\: - (save pos name-ends) - (save (1+ pos) value-starts) - #'in-value) - ((:cr :lf) - (finish)) - ((#\Tab #\Space) - (error "Unexpected whitespace in header field name")) - (t - (unless (<= 0 code 127) - (error "Unexpected non-ASCII header field name")) - #'in-name))) - (in-value (code) - (acase code - (:lf (mark) #'in-new-line) - (:cr (mark) #'after-cr) - (t #'in-value)))) - (let ((state #'in-new-line)) - (loop - (incf pos) - (when (<= (length vector) pos) - (error "No header found in response")) - (setf state (funcall state (aref vector pos)))))))) - - -;;; HTTP URL parsing - -(defclass url () - ((hostname - :initarg :hostname - :accessor hostname - :initform nil) - (port - :initarg :port - :accessor port - :initform 80) - (path - :initarg :path - :accessor path - :initform "/"))) - -(defun parse-urlstring (urlstring) - (setf urlstring (string-trim " " urlstring)) - (let* ((pos (mismatch urlstring "http://" :test 'char-equal)) - (mark pos) - (url (make-instance 'url))) - (labels ((save () - (subseq urlstring mark pos)) - (mark () - (setf mark pos)) - (finish () - (return-from parse-urlstring url)) - (hostname-char-p (char) - (position char "ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789-_." - :test 'char-equal)) - (at-start (char) - (case char - (#\/ - (setf (port url) nil) - (mark) - #'in-path) - (t - #'in-host))) - (in-host (char) - (case char - ((#\/ :end) - (setf (hostname url) (save)) - (mark) - #'in-path) - (#\: - (setf (hostname url) (save)) - (mark) - #'in-port) - (t - (unless (hostname-char-p char) - (error "~S is not a valid URL" urlstring)) - #'in-host))) - (in-port (char) - (case char - ((#\/ :end) - (setf (port url) - (parse-integer urlstring - :start (1+ mark) - :end pos)) - (mark) - #'in-path) - (t - (unless (digit-char-p char) - (error "Bad port in URL ~S" urlstring)) - #'in-port))) - (in-path (char) - (case char - ((#\# :end) - (setf (path url) (save)) - (finish))) - #'in-path)) - (let ((state #'at-start)) - (loop - (when (<= (length urlstring) pos) - (funcall state :end) - (finish)) - (setf state (funcall state (aref urlstring pos))) - (incf pos)))))) - -(defun url (thing) - (if (stringp thing) - (parse-urlstring thing) - thing)) - -(defgeneric request-buffer (method url) - (:method (method url) - (setf url (url url)) - (make-request-buffer (hostname url) (port url) (path url) - :method method))) - -(defun urlstring (url) - (format nil "~@[http://~A~]~@[:~D~]~A" - (hostname url) - (and (/= 80 (port url)) (port url)) - (path url))) - -(defmethod print-object ((url url) stream) - (print-unreadable-object (url stream :type t) - (prin1 (urlstring url) stream))) - -(defun merge-urls (url1 url2) - (setf url1 (url url1)) - (setf url2 (url url2)) - (make-instance 'url - :hostname (or (hostname url1) - (hostname url2)) - :port (or (port url1) - (port url2)) - :path (or (path url1) - (path url2)))) - - -;;; Requesting an URL and saving it to a file - -(defparameter *maximum-redirects* 10) -(defvar *default-url-defaults* (url "http://src.quicklisp.org/")) - -(defun read-http-header (cbuf) - (let ((header-data (sink-until-matching (list (acode-matcher :lf :lf) - (acode-matcher :cr :cr) - (acode-matcher :cr :lf :cr :lf)) - cbuf))) - (process-header header-data))) - -(defun read-chunk-header (cbuf) - (let* ((header-data (sink-until-matching (acode-matcher :cr :lf) cbuf)) - (end (or (position (acode :cr) header-data) - (position (acode #\;) header-data)))) - (values (parse-integer (ascii-subseq header-data 0 end) :radix 16)))) - -(defun save-chunk-response (stream cbuf) - "For a chunked response, read all chunks and write them to STREAM." - (let ((fun (make-stream-writer stream)) - (matcher (acode-matcher :cr :lf))) - (loop - (let ((chunk-size (read-chunk-header cbuf))) - (when (zerop chunk-size) - (return)) - (call-for-n-octets chunk-size fun cbuf) - (skip-until-matching matcher cbuf))))) - -(defun save-response (file header cbuf) - (with-open-file (stream file - :direction :output - :if-exists :supersede - :element-type 'octet) - (let ((content-length (content-length header))) - (cond ((chunkedp header) - (save-chunk-response stream cbuf)) - (content-length - (call-for-n-octets content-length - (make-stream-writer stream) - cbuf)) - (t - (call-until-end (make-stream-writer stream) cbuf)))))) - -(defun call-with-progress-bar (size fun) - (let ((progress-bar (make-progress-bar size))) - (start-display progress-bar) - (flet ((update (condition) - (update-progress progress-bar - (cbuf-progress-size condition)))) - (handler-bind ((cbuf-progress #'update)) - (funcall fun))) - (finish-display progress-bar))) - -(defun fetch (url file &key (follow-redirects t) quietly - (maximum-redirects *maximum-redirects*)) - "Request URL and write the body of the response to FILE." - (setf url (merge-urls url *default-url-defaults*)) - (setf file (merge-pathnames file)) - (let ((redirect-count 0) - (original-url url) - (connect-url (or (url *proxy-url*) url)) - (stream (if quietly - (make-broadcast-stream) - *trace-output*))) - (loop - (when (<= maximum-redirects redirect-count) - (error "Too many redirects for ~A" original-url)) - (with-connection (connection (hostname connect-url) (port connect-url)) - (let ((cbuf (make-instance 'cbuf :connection connection)) - (request (request-buffer "GET" url))) - (write-octets request connection) - (let ((header (read-http-header cbuf))) - (loop while (= (status header) 100) - do (setf header (read-http-header cbuf))) - (cond ((= (status header) 200) - (let ((size (content-length header))) - (format stream "~&; Fetching ~A~%" url) - (if (and (numberp size) - (plusp size)) - (format stream "; ~$KB~%" (/ size 1024)) - (format stream "; Unknown size~%")) - (if quietly - (save-response file header cbuf) - (call-with-progress-bar (content-length header) - (lambda () - (save-response file header cbuf)))))) - ((not (<= 300 (status header) 399)) - (error "Unexpected status for ~A: ~A" - url (status header)))) - (if (and follow-redirects (<= 300 (status header) 399)) - (let ((new-urlstring (ascii-header-value "location" header))) - (when (not new-urlstring) - (error "Redirect code ~D received, but no Location: header" - (status header))) - (incf redirect-count) - (setf url (merge-urls new-urlstring - url)) - (format stream "~&; Redirecting to ~A~%" url)) - (return (values header (and file (probe-file file))))))))))) - - -;;; A primitive tar unpacker - -(in-package #:qlqs-minitar) - -(defun make-block-buffer () - (make-array 512 :element-type '(unsigned-byte 8) :initial-element 0)) - -(defun skip-n-blocks (n stream) - (let ((block (make-block-buffer))) - (dotimes (i n) - (read-sequence block stream)))) - -(defun ascii-subseq (vector start end) - (let ((string (make-string (- end start)))) - (loop for i from 0 - for j from start below end - do (setf (char string i) (code-char (aref vector j)))) - string)) - -(defun block-asciiz-string (block start length) - (let* ((end (+ start length)) - (eos (or (position 0 block :start start :end end) - end))) - (ascii-subseq block start eos))) - -(defun prefix (header) - (when (plusp (aref header 345)) - (block-asciiz-string header 345 155))) - -(defun name (header) - (block-asciiz-string header 0 100)) - -(defun payload-size (header) - (values (parse-integer (block-asciiz-string header 124 12) :radix 8))) - -(defun nth-block (n file) - (with-open-file (stream file :element-type '(unsigned-byte 8)) - (let ((block (make-block-buffer))) - (skip-n-blocks (1- n) stream) - (read-sequence block stream) - block))) - -(defun payload-type (code) - (case code - (0 :file) - (48 :file) - (53 :directory) - (t :unsupported))) - -(defun full-path (header) - (let ((prefix (prefix header)) - (name (name header))) - (if prefix - (format nil "~A/~A" prefix name) - name))) - -(defun save-file (file size stream) - (multiple-value-bind (full-blocks partial) - (truncate size 512) - (ensure-directories-exist file) - (with-open-file (outstream file - :direction :output - :if-exists :supersede - :element-type '(unsigned-byte 8)) - (let ((block (make-block-buffer))) - (dotimes (i full-blocks) - (read-sequence block stream) - (write-sequence block outstream)) - (when (plusp partial) - (read-sequence block stream) - (write-sequence block outstream :end partial)))))) - -(defun unpack-tarball (tarfile &key (directory *default-pathname-defaults*)) - (let ((block (make-block-buffer))) - (with-open-file (stream tarfile :element-type '(unsigned-byte 8)) - (loop - (let ((size (read-sequence block stream))) - (when (zerop size) - (return)) - (unless (= size 512) - (error "Bad size on tarfile")) - (when (every #'zerop block) - (return)) - (let* ((payload-code (aref block 156)) - (payload-type (payload-type payload-code)) - (tar-path (full-path block)) - (full-path (merge-pathnames tar-path directory)) - (payload-size (payload-size block))) - (case payload-type - (:file - (save-file full-path payload-size stream)) - (:directory - (ensure-directories-exist full-path)) - (t - (warn "Unknown tar block payload code -- ~D" payload-code) - (skip-n-blocks (ceiling (payload-size block) 512) stream))))))))) - -(defun contents (tarfile) - (let ((block (make-block-buffer)) - (result '())) - (with-open-file (stream tarfile :element-type '(unsigned-byte 8)) - (loop - (let ((size (read-sequence block stream))) - (when (zerop size) - (return (nreverse result))) - (unless (= size 512) - (error "Bad size on tarfile")) - (when (every #'zerop block) - (return (nreverse result))) - (let* ((payload-type (payload-type (aref block 156))) - (tar-path (full-path block)) - (payload-size (payload-size block))) - (skip-n-blocks (ceiling payload-size 512) stream) - (case payload-type - (:file - (push tar-path result)) - (:directory - (push tar-path result))))))))) - - -;;; -;;; The actual bootstrapping work -;;; - -(in-package #:quicklisp-quickstart) - -(defvar *home* - (merge-pathnames (make-pathname :directory '(:relative "quicklisp")) - (user-homedir-pathname))) - -(defun qmerge (pathname) - (merge-pathnames pathname *home*)) - -(defun renaming-fetch (url file) - (let ((tmpfile (qmerge "tmp/fetch.dat"))) - (fetch url tmpfile) - (rename-file tmpfile file))) - -(defvar *quickstart-parameters* nil - "This plist is populated with parameters that may carry over to the - initial configuration of the client, e.g. :proxy-url - or :initial-dist-url") - -(defvar *quicklisp-hostname* "beta.quicklisp.org") - -(defvar *client-info-url* - (format nil "http://~A/client/quicklisp.sexp" - *quicklisp-hostname*)) - -(defclass client-info () - ((setup-url - :reader setup-url - :initarg :setup-url) - (asdf-url - :reader asdf-url - :initarg :asdf-url) - (client-tar-url - :reader client-tar-url - :initarg :client-tar-url) - (version - :reader version - :initarg :version) - (plist - :reader plist - :initarg :plist) - (source-file - :reader source-file - :initarg :source-file))) - -(defmethod print-object ((client-info client-info) stream) - (print-unreadable-object (client-info stream :type t) - (prin1 (version client-info) stream))) - -(defun safely-read (stream) - (let ((*read-eval* nil)) - (read stream))) - -(defun fetch-client-info-plist (url) - "Fetch and return the client info data at URL." - (let ((local-client-info-file (qmerge "tmp/client-info.sexp"))) - (ensure-directories-exist local-client-info-file) - (renaming-fetch url local-client-info-file) - (with-open-file (stream local-client-info-file) - (list* :source-file local-client-info-file - (safely-read stream))))) - -(defun fetch-client-info (url) - (let ((plist (fetch-client-info-plist url))) - (destructuring-bind (&key setup asdf client-tar version - source-file - &allow-other-keys) - plist - (unless (and setup asdf client-tar version) - (error "Invalid data from client info URL -- ~A" url)) - (make-instance 'client-info - :setup-url (getf setup :url) - :asdf-url (getf asdf :url) - :client-tar-url (getf client-tar :url) - :version version - :plist plist - :source-file source-file)))) - -(defun client-info-url-from-version (version) - (format nil "http://~A/client/~A/client-info.sexp" - *quicklisp-hostname* - version)) - -(defun distinfo-url-from-version (version) - (format nil "http://~A/dist/~A/distinfo.txt" - *quicklisp-hostname* - version)) - -(defvar *help-message* - (format nil "~&~% ==== quicklisp quickstart install help ====~%~% ~ - quicklisp-quickstart:install can take the following ~ - optional arguments:~%~% ~ - :path \"/path/to/installation/\"~%~% ~ - :proxy \"http://your.proxy:port/\"~%~% ~ - :client-url ~%~% ~ - :client-version ~%~% ~ - :dist-url ~%~% ~ - :dist-version ~%~%")) - -(defvar *after-load-message* - (format nil "~&~% ==== quicklisp quickstart ~A loaded ====~%~% ~ - To continue with installation, evaluate: (quicklisp-quickstart:install)~%~% ~ - For installation options, evaluate: (quicklisp-quickstart:help)~%~%" - qlqs-info:*version*)) - -(defvar *after-initial-setup-message* - (with-output-to-string (*standard-output*) - (format t "~&~% ==== quicklisp installed ====~%~%") - (format t " To load a system, use: (ql:quickload \"system-name\")~%~%") - (format t " To find systems, use: (ql:system-apropos \"term\")~%~%") - (format t " To load Quicklisp every time you start Lisp, use: (ql:add-to-init-file)~%~%") - (format t " For more information, see http://www.quicklisp.org/beta/~%~%"))) - -(defun initial-install (&key (client-url *client-info-url*) dist-url) - (setf *quickstart-parameters* - (list :proxy-url *proxy-url* - :initial-dist-url dist-url)) - (ensure-directories-exist (qmerge "tmp/")) - (let ((client-info (fetch-client-info client-url)) - (tmptar (qmerge "tmp/quicklisp.tar")) - (setup (qmerge "setup.lisp")) - (asdf (qmerge "asdf.lisp"))) - (renaming-fetch (client-tar-url client-info) tmptar) - (unpack-tarball tmptar :directory (qmerge "./")) - (renaming-fetch (setup-url client-info) setup) - (renaming-fetch (asdf-url client-info) asdf) - (rename-file (source-file client-info) (qmerge "client-info.sexp")) - (load setup :verbose nil :print nil) - (write-string *after-initial-setup-message*) - (finish-output))) - -(defun help () - (write-string *help-message*) - t) - -(defun non-empty-file-namestring (pathname) - (let ((string (file-namestring pathname))) - (unless (or (null string) - (equal string "")) - string))) - -(defun install (&key ((:path *home*) *home*) - ((:proxy *proxy-url*) *proxy-url*) - client-url - client-version - dist-url - dist-version) - (setf *home* (merge-pathnames *home* (truename *default-pathname-defaults*))) - (let ((name (non-empty-file-namestring *home*))) - (when name - (warn "Making ~A part of the install pathname directory" - name) - ;; This corrects a pathname like "/foo/bar" to "/foo/bar/" and - ;; "foo" to "foo/" - (setf *home* - (make-pathname :defaults *home* - :directory (append (pathname-directory *home*) - (list name)))))) - (let ((setup-file (qmerge "setup.lisp"))) - (when (probe-file setup-file) - (multiple-value-bind (result proceed) - (with-simple-restart (load-setup "Load ~S" setup-file) - (error "Quicklisp has already been installed. Load ~S instead." - setup-file)) - (declare (ignore result)) - (when proceed - (return-from install (load setup-file)))))) - (if (find-package '#:ql) - (progn - (write-line "!!! Quicklisp has already been set up. !!!") - (write-string *after-initial-setup-message*) - t) - (call-with-quiet-compilation - (lambda () - (let ((client-url (or client-url - (and client-version - (client-info-url-from-version client-version)) - *client-info-url*)) - ;; It's ok for dist-url to be nil; there's a default in - ;; the client - (dist-url (or dist-url - (and dist-version - (distinfo-url-from-version dist-version))))) - (initial-install :client-url client-url - :dist-url dist-url)))))) - -(write-string *after-load-message*) - -;;; End of quicklisp.lisp diff --git a/conf/quicklisp.lisp.asc b/conf/quicklisp.lisp.asc deleted file mode 100644 index ba70143..0000000 --- a/conf/quicklisp.lisp.asc +++ /dev/null @@ -1,18 +0,0 @@ ------BEGIN PGP SIGNATURE----- -Version: GnuPG/MacGPG2 v2.0.22 (Darwin) -Comment: GPGTools - https://gpgtools.org - -iQIcBAABCgAGBQJUyVD2AAoJEDB5ZasCi1/3EYAQAIPm+dXrTCRgHA6aFZTc8VeB -DoBFsQPlFsLeKjixy3wSalPhI751ItWyy3DOx1tRYpFN0aYGSRbiMuVUF9DVMsSB -ROeNCg+f6lvtHuSokHKiZ95y8GarBqs4qguHi1Ir+n+inno4ZfE+8JvrxxQ9Lo4Z -KGgRoyJceaVcku3lmQK131i2eOf8RZaHmXv24tHprXpnle0d74etXO0TAdmpk5R2 -OaeduaitR7o3cGT0JCS39rC5qH/H19jz9XkTjuLOGNqiKcX7XePTejdSLbT7FphN -4G2uTN8Z5HiYy56OpcuLdjHlPFiThwmIId6NMO3PHNlVAeL5PMKzw9tZTQlw4C5E -XKgL7gqC4L6Ys64/70IIBPo+L8TG74VkEbcWkNr3TCzAdz8x1Sa40YHRoVpRFK8M -T+v/qMJ8sgHb9o1OsEniv8eCFyFNPd7AlrRYehWQqRaVCuFG//95jEGNI/ig7vjK -v/z6tIyqi2e6zJPsJxAPJ8Y23jkTH4u5dvFct+k1fkZOCIpA/jLUT1RuWqLKTpOF -pSlDVmrqjrhM+jVnFEyWOg/mkSmQsY0jfC2sVDpx4XEGq3PdBnKqpPBTL0L8s5sg -YmqsGjMVk9IMCtylwuBlP5VGgoB8GmHGdhbeSKNxQJb75voDOiIS/sOP5+ACOxcA -Yg8wz616XOOHpLNUki3j -=yTd1 ------END PGP SIGNATURE----- diff --git a/conf/rethinkdb_2.3.6_armhf.deb b/conf/rethinkdb_2.3.6_armhf.deb deleted file mode 100644 index 11b293e..0000000 Binary files a/conf/rethinkdb_2.3.6_armhf.deb and /dev/null differ diff --git a/conf/rsyslogd.conf b/conf/rsyslogd.conf deleted file mode 100644 index f48a078..0000000 --- a/conf/rsyslogd.conf +++ /dev/null @@ -1,2 +0,0 @@ -if $programname == 'ccl' then /var/log/turtl/turtl.log -if $programname == 'ccl' then ~ diff --git a/conf/systemd.service b/conf/systemd.service new file mode 100644 index 0000000..97f64d6 --- /dev/null +++ b/conf/systemd.service @@ -0,0 +1,22 @@ +[Unit] +Description=Turtl Server: Note taking service +Documentation=https://turtlapp.com/ +After=network.target postgresql.service + +[Service] +Type=simple +User=__APP__ +Group=__APP__ +WorkingDirectory=__FINALPATH__/ +Environment="PATH=__PATH__" +ExecStart=__YNH_NODE__ __FINALPATH__/server.js +StandardOutput=syslog +StandardError=syslog +SyslogIdentifier=__APP__ +Restart=always +RestartSec=10 +StartLimitInterval=900 +StartLimitBurst=3 + +[Install] +WantedBy=multi-user.target diff --git a/conf/turtl-preferences b/conf/turtl-preferences deleted file mode 100644 index a29a5d7..0000000 --- a/conf/turtl-preferences +++ /dev/null @@ -1,7 +0,0 @@ -Package: libuv1-dev -Pin: release a=jessie-backports -Pin-Priority: 900 - -Package: rethinkdb -Pin: origin download.rethinkdb.com -Pin-Priority: 900 diff --git a/conf/turtl.list b/conf/turtl.list deleted file mode 100644 index e3e55be..0000000 --- a/conf/turtl.list +++ /dev/null @@ -1 +0,0 @@ -deb http://http.debian.net/debian jessie-backports main diff --git a/conf/turtl.service b/conf/turtl.service deleted file mode 100644 index c6d5917..0000000 --- a/conf/turtl.service +++ /dev/null @@ -1,17 +0,0 @@ -[Unit] -Description=Note taking service -Documentation=http://turtl.it -Requires=network.target -Requires=rethinkdb.service -After=network.target -After=rethinkdb.service - -[Service] -Type=simple -User=www-data -WorkingDirectory=/var/www/turtl/api/ -ExecStart=/usr/bin/ccl -Q -b --load start.lisp -Restart=on-failure - -[Install] -WantedBy=multi-user.target diff --git a/doc/.gitkeep b/doc/.gitkeep new file mode 100755 index 0000000..e69de29 diff --git a/doc/DESCRIPTION.md b/doc/DESCRIPTION.md new file mode 100755 index 0000000..48339c6 --- /dev/null +++ b/doc/DESCRIPTION.md @@ -0,0 +1,20 @@ +Turtl is a free online service that allows you to create, synchronize and find your notes, in an encrypted manner. + +### Features + +- Different note types: text, bookmark, password, image, and file/document +- Client-side cryptography to keep all of your data safe +- Securely share with anyone without compromising the security of your data +- Sharing allows different permissions ranging from read-only to full ownership of shared content +- Find your notes easily. Turtl supports full-text search, filtering by tag (or lack of tag), and sort by create/edit date +- Attach photos, files, and documents to your notes. Files are stored securely just like the rest of your data. +- Browser extension makes bookmarking easy on desktop +- Share to Turtl on Android for easy bookmarking and file uploads +- Write notes in Markdown, an easy and natural way to format text +- TeX math expressions in notes for math people (surround them by $$ to use) +- Multiple translations (German, Spanish, French, and more) +- RTL text support for our Farsi/Hebrew/etc-speaking friends +- Export/import your entire profile for backup purposes or to move between servers +- Semi-offline mode (you only need to be connected to log in) +- A number of keyboard shortcuts for navigation the app without mouse (type ? in-app to see shortcuts) +- An open-source server allows you to host your own Turtl data diff --git a/doc/DISCLAIMER.md b/doc/DISCLAIMER.md new file mode 100755 index 0000000..e69de29 diff --git a/doc/screenshots/.gitkeep b/doc/screenshots/.gitkeep new file mode 100755 index 0000000..e69de29 diff --git a/doc/screenshots/screenshot.png b/doc/screenshots/screenshot.png new file mode 100644 index 0000000..60d3608 Binary files /dev/null and b/doc/screenshots/screenshot.png differ diff --git a/manifest.json b/manifest.json index 4b45358..8c80a2d 100644 --- a/manifest.json +++ b/manifest.json @@ -2,12 +2,18 @@ "name": "Turtl", "id": "turtl", "packaging_format": 1, - "version": "0.01", "description": { "en": "Share notes, bookmarks, and documents for sensitive projects", "fr": "Partagez des notes, des marque-pages et autre documents pour des projets sensibles" }, - "url": "https://turtlapp.com/", + "version": "1.0~ynh1", + "url": "https://turtlapp.com", + "upstream": { + "license": "MIT", + "website": "https://turtlapp.com", + "admindoc": "https://turtlapp.com/docs/", + "code": "https://github.com/turtl/server" + }, "license": "MIT", "maintainer": { "name": "Luc Didry", @@ -15,41 +21,22 @@ "url": "https://framasoft.org" }, "requirements": { - "yunohost": ">> 2.6.4" + "yunohost": ">= 4.3.0" }, "multi_instance": false, "services": [ - "turtl" + "nginx" ], "arguments": { - "install" : [ + "install": [ { "name": "domain", - "type": "domain", - "ask": { - "en": "Choose a domain for your turtl server", - "fr": "Choisissez un domaine pour votre serveur turtl" - }, - "example": "domain.org" - }, - { - "name": "path", - "type": "path", - "ask": { - "en": "Choose a path for Turtl", - "fr": "Choisissez un chemin pour Turtl" - }, - "example": "/turtl", - "default": "/" + "type": "domain" }, { "name": "is_public", "type": "boolean", - "ask": { - "en": "Is it a public server? (should we announce it?)", - "fr": "Est-ce un serveur public ? (devons-nous l'annoncer ?)" - }, - "default": false + "default": true } ] } diff --git a/scripts/_common.sh b/scripts/_common.sh index 266a076..538dd0d 100644 --- a/scripts/_common.sh +++ b/scripts/_common.sh @@ -1,850 +1,23 @@ #!/bin/bash #================================================= -#================================================= -# TESTING -#================================================= +# COMMON VARIABLES #================================================= -ynh_fpm_config () { - finalphpconf="/etc/php5/fpm/pool.d/$app.conf" - ynh_backup_if_checksum_is_different "$finalphpconf" 1 - sudo cp ../conf/php-fpm.conf "$finalphpconf" - ynh_replace_string "__NAMETOCHANGE__" "$app" "$finalphpconf" - ynh_replace_string "__FINALPATH__" "$final_path" "$finalphpconf" - ynh_replace_string "__USER__" "$app" "$finalphpconf" - sudo chown root: "$finalphpconf" - ynh_store_file_checksum "$finalphpconf" +# dependencies used by the app +pkg_dependencies="postgresql postgresql-contrib" - if [ -e "../conf/php-fpm.ini" ] - then - finalphpini="/etc/php5/fpm/conf.d/20-$app.ini" - ynh_backup_if_checksum_is_different "$finalphpini" 1 - sudo cp ../conf/php-fpm.ini "$finalphpini" - sudo chown root: "$finalphpini" - ynh_store_file_checksum "$finalphpini" - fi - - sudo systemctl reload php5-fpm -} - -ynh_remove_fpm_config () { - ynh_secure_remove "/etc/php5/fpm/pool.d/$app.conf" - ynh_secure_remove "/etc/php5/fpm/conf.d/20-$app.ini" - sudo systemctl reload php5-fpm -} - -ynh_nginx_config () { - finalnginxconf="/etc/nginx/conf.d/$domain.d/$app.conf" - ynh_backup_if_checksum_is_different "$finalnginxconf" 1 - sudo cp ../conf/nginx.conf "$finalnginxconf" - - # To avoid a break by set -u, use a void substitution ${var:-}. If the variable is not set, it's simply set with an empty variable. - # Substitute in a nginx config file only if the variable is not empty - if test -n "${path_url:-}"; then - ynh_replace_string "__PATH__" "$path_url" "$finalnginxconf" - fi - if test -n "${domain:-}"; then - ynh_replace_string "__DOMAIN__" "$domain" "$finalnginxconf" - fi - if test -n "${port:-}"; then - ynh_replace_string "__PORT__" "$port" "$finalnginxconf" - fi - if test -n "${app:-}"; then - ynh_replace_string "__NAME__" "$app" "$finalnginxconf" - fi - if test -n "${final_path:-}"; then - ynh_replace_string "__FINALPATH__" "$final_path" "$finalnginxconf" - fi - ynh_store_file_checksum "$finalnginxconf" - - sudo systemctl reload nginx -} - -ynh_remove_nginx_config () { - ynh_secure_remove "/etc/nginx/conf.d/$domain.d/$app.conf" - sudo systemctl reload nginx -} - -ynh_systemd_config () { - finalsystemdconf="/etc/systemd/system/$app.service" - ynh_backup_if_checksum_is_different "$finalsystemdconf" 1 - sudo cp ../conf/systemd.service "$finalsystemdconf" - - # To avoid a break by set -u, use a void substitution ${var:-}. If the variable is not set, it's simply set with an empty variable. - # Substitute in a nginx config file only if the variable is not empty - if test -n "${final_path:-}"; then - ynh_replace_string "__FINALPATH__" "$final_path" "$finalsystemdconf" - fi - if test -n "${app:-}"; then - ynh_replace_string "__APP__" "$app" "$finalsystemdconf" - fi - ynh_store_file_checksum "$finalsystemdconf" - - sudo chown root: "$finalsystemdconf" - sudo systemctl enable $app - sudo systemctl daemon-reload -} - -ynh_remove_systemd_config () { - finalsystemdconf="/etc/systemd/system/$app.service" - if [ -e "$finalsystemdconf" ]; then - sudo systemctl stop $app - sudo systemctl disable $app - ynh_secure_remove "$finalsystemdconf" - fi -} +nodejs_version=12 +version_commit=0e59ee0a47fc5937600999d14ceb1aca6392aec8 #================================================= +# PERSONAL HELPERS #================================================= #================================================= -# CHECKING +# EXPERIMENTAL HELPERS #================================================= -CHECK_DOMAINPATH () { # Vérifie la disponibilité du path et du domaine. - if sudo yunohost app --help | grep --quiet url-available - then - # Check availability of a web path - ynh_webpath_available $domain $path_url - # Register/book a web path for an app - ynh_webpath_register $app $domain $path_url - else - # Use the legacy command - sudo yunohost app checkurl $domain$path_url -a $app - fi -} - -CHECK_FINALPATH () { # Vérifie que le dossier de destination n'est pas déjà utilisé. - final_path=/var/www/$app - test ! -e "$final_path" || ynh_die "This path already contains a folder" -} - #================================================= -# DISPLAYING +# FUTURE OFFICIAL HELPERS #================================================= - -NO_PRINT () { # Supprime l'affichage dans stdout pour la commande en argument. - set +x - $@ - set -x -} - -WARNING () { # Écrit sur le canal d'erreur pour passer en warning. - $@ >&2 -} - -SUPPRESS_WARNING () { # Force l'écriture sur la sortie standard - $@ 2>&1 -} - -QUIET () { # Redirige la sortie standard dans /dev/null - $@ > /dev/null -} - -ALL_QUIET () { # Redirige la sortie standard et d'erreur dans /dev/null - $@ > /dev/null 2>&1 -} - -#================================================= -# BACKUP -#================================================= - -BACKUP_FAIL_UPGRADE () { - WARNING echo "Upgrade failed." - app_bck=${app//_/-} # Replace all '_' by '-' - if sudo yunohost backup list | grep -q $app_bck-pre-upgrade$backup_number; then # Vérifie l'existence de l'archive avant de supprimer l'application et de restaurer - sudo yunohost app remove $app # Supprime l'application avant de la restaurer. - sudo yunohost backup restore --ignore-hooks $app_bck-pre-upgrade$backup_number --apps $app --force # Restore the backup if upgrade failed - ynh_die "The app was restored to the way it was before the failed upgrade." - fi -} - -BACKUP_BEFORE_UPGRADE () { # Backup the current version of the app, restore it if the upgrade fails - backup_number=1 - old_backup_number=2 - app_bck=${app//_/-} # Replace all '_' by '-' - if sudo yunohost backup list | grep -q $app_bck-pre-upgrade1; then # Vérifie l'existence d'une archive déjà numéroté à 1. - backup_number=2 # Et passe le numéro de l'archive à 2 - old_backup_number=1 - fi - - sudo yunohost backup create --ignore-hooks --apps $app --name $app_bck-pre-upgrade$backup_number # Créer un backup différent de celui existant. - if [ "$?" -eq 0 ]; then # Si le backup est un succès, supprime l'archive précédente. - if sudo yunohost backup list | grep -q $app_bck-pre-upgrade$old_backup_number; then # Vérifie l'existence de l'ancienne archive avant de la supprimer, pour éviter une erreur. - QUIET sudo yunohost backup delete $app_bck-pre-upgrade$old_backup_number - fi - else # Si le backup a échoué - ynh_die "Backup failed, the upgrade process was aborted." - fi -} - -HUMAN_SIZE () { # Transforme une taille en Ko en une taille lisible pour un humain - human=$(numfmt --to=iec --from-unit=1K $1) - echo $human -} - -CHECK_SIZE () { # Vérifie avant chaque backup que l'espace est suffisant - file_to_analyse=$1 - backup_size=$(sudo du --summarize "$file_to_analyse" | cut -f1) - free_space=$(sudo df --output=avail "/home/yunohost.backup" | sed 1d) - - if [ $free_space -le $backup_size ] - then - WARNING echo "Espace insuffisant pour sauvegarder $file_to_analyse." - WARNING echo "Espace disponible: $(HUMAN_SIZE $free_space)" - ynh_die "Espace nécessaire: $(HUMAN_SIZE $backup_size)" - fi -} - -# Ce helper est temporaire et sert de remplacement à la véritable fonction ynh_restore_file. Le temps qu'elle arrive... -ynh_restore_file () { - if [ -f "$1" ]; then - ynh_die "There is already a file at this path: $1" - fi - sudo cp -a "${YNH_APP_BACKUP_DIR}$1" "$1" -} - -#================================================= -# PACKAGE CHECK BYPASSING... -#================================================= - -IS_PACKAGE_CHECK () { # Détermine une exécution en conteneur (Non testé) - return $(uname -n | grep -c 'pchecker_lxc') -} - -#================================================= -# NODEJS -#================================================= - -sudo_path () { - sudo env "PATH=$PATH" $@ -} - -# INFOS -# n (Node version management) utilise la variable PATH pour stocker le path de la version de node à utiliser. -# C'est ainsi qu'il change de version -# En attendant une généralisation de root, il est possible d'utiliser sudo avec le helper temporaire sudo_path -# Il permet d'utiliser sudo en gardant le $PATH modifié -# ynh_install_nodejs installe la version de nodejs demandée en argument, avec n -# ynh_use_nodejs active une version de nodejs dans le script courant -# 3 variables sont mises à disposition, et 2 sont stockées dans la config de l'app -# - nodejs_path: Le chemin absolu de cette version de node -# Utilisé pour des appels directs à node. -# - nodejs_version: Simplement le numéro de version de nodejs pour cette application -# - nodejs_use_version: Un alias pour charger une version de node dans le shell courant. -# Utilisé pour démarrer un service ou un script qui utilise node ou npm -# Dans ce cas, c'est $PATH qui contient le chemin de la version de node. Il doit être propagé sur les autres shell si nécessaire. - -n_install_dir="/opt/node_n" -ynh_use_nodejs () { - nodejs_version=$(ynh_app_setting_get $app nodejs_version) - - load_n_path="[[ :$PATH: == *\":$n_install_dir/bin:\"* ]] || PATH+=\":$n_install_dir/bin\"" - - nodejs_use_version="n $nodejs_version" - - # "Load" a version of node - eval $load_n_path; $nodejs_use_version - eval $load_n_path; sudo env "PATH=$PATH" $nodejs_use_version - - # Get the absolute path of this version of node - nodejs_path="$(n bin $nodejs_version)" - - # Make an alias for node use - ynh_node_exec="eval $load_n_path; n use $nodejs_version" - sudo_ynh_node_exec="eval $load_n_path; sudo env \"PATH=$PATH\" n use $nodejs_version" -} - -ynh_install_nodejs () { - # Use n, https://github.com/tj/n to manage the nodejs versions - local nodejs_version="$1" - local n_install_script="https://git.io/n-install" - - # Create $n_install_dir - sudo mkdir -p "$n_install_dir" - - # Load n path in PATH - PATH+=":$n_install_dir/bin" - - # If n is not previously setup, install it - n --version > /dev/null 2>&1 || \ - ( echo "Installation of N - Node.js version management" >&2; \ - curl -sL $n_install_script | sudo N_PREFIX="$n_install_dir" bash -s -- -y $nodejs_version ) - - # Install the requested version of nodejs (except for the first installation of n, which installed the requested version of node.) - sudo env "PATH=$PATH" n $nodejs_version - - # Use the real installed version. Sometimes slightly different - nodejs_version=$(node --version | cut -c2-) - - # Store the ID of this app and the version of node requested for it - echo "$YNH_APP_ID:$nodejs_version" | sudo tee --append "$n_install_dir/ynh_app_version" - - # Store nodejs_version into the config of this app - ynh_app_setting_set $app nodejs_version $nodejs_version - - ynh_use_nodejs -} - -ynh_remove_nodejs () { - ynh_use_nodejs - - # Remove the line for this app - sudo sed --in-place "/$YNH_APP_ID:$nodejs_version/d" "$n_install_dir/ynh_app_version" - - # If none another app uses this version of nodejs, remove it. - if ! grep --quiet "$nodejs_version" "$n_install_dir/ynh_app_version" - then - n rm $nodejs_version - fi - - # If none another app uses n, remove n - if [ ! -s "$n_install_dir/ynh_app_version" ] - then - ynh_secure_remove "$n_install_dir" - sudo sed --in-place "/N_PREFIX/d" /root/.bashrc - fi -} - -#================================================= -#================================================= -# FUTUR YNH HELPERS -#================================================= -# Importer ce fichier de fonction avant celui des helpers officiel -# Ainsi, les officiels prendront le pas sur ceux-ci le cas échéant -#================================================= - -# Normalize the url path syntax -# Handle the slash at the beginning of path and its absence at ending -# Return a normalized url path -# -# example: url_path=$(ynh_normalize_url_path $url_path) -# ynh_normalize_url_path example -> /example -# ynh_normalize_url_path /example -> /example -# ynh_normalize_url_path /example/ -> /example -# ynh_normalize_url_path / -> / -# -# usage: ynh_normalize_url_path path_to_normalize -# | arg: url_path_to_normalize - URL path to normalize before using it -ynh_normalize_url_path () { - path_url=$1 - test -n "$path_url" || ynh_die "ynh_normalize_url_path expect a URL path as first argument and received nothing." - if [ "${path_url:0:1}" != "/" ]; then # If the first character is not a / - path_url="/$path_url" # Add / at begin of path variable - fi - if [ "${path_url:${#path_url}-1}" == "/" ] && [ ${#path_url} -gt 1 ]; then # If the last character is a / and that not the only character. - path_url="${path_url:0:${#path_url}-1}" # Delete the last character - fi - echo $path_url -} - -# Check if a mysql user exists -# -# usage: ynh_mysql_user_exists user -# | arg: user - the user for which to check existence -function ynh_mysql_user_exists() -{ - local user=$1 - if [[ -z $(ynh_mysql_execute_as_root "SELECT User from mysql.user WHERE User = '$user';") ]] - then - return 1 - else - return 0 - fi -} - -# Create a database, an user and its password. Then store the password in the app's config -# -# After executing this helper, the password of the created database will be available in $db_pwd -# It will also be stored as "mysqlpwd" into the app settings. -# -# usage: ynh_mysql_setup_db user name [pwd] -# | arg: user - Owner of the database -# | arg: name - Name of the database -# | arg: pwd - Password of the database. If not given, a password will be generated -ynh_mysql_setup_db () { - local db_user="$1" - local db_name="$2" - local new_db_pwd=$(ynh_string_random) # Generate a random password - db_pwd="${3:-$new_db_pwd}" - ynh_mysql_create_db "$db_name" "$db_user" "$db_pwd" # Create the database - ynh_app_setting_set $app mysqlpwd $db_pwd # Store the password in the app's config -} - -# Remove a database if it exists, and the associated user -# -# usage: ynh_mysql_remove_db user name -# | arg: user - Owner of the database -# | arg: name - Name of the database -ynh_mysql_remove_db () { - local db_user="$1" - local db_name="$2" - local mysql_root_password=$(sudo cat $MYSQL_ROOT_PWD_FILE) - if mysqlshow -u root -p$mysql_root_password | grep -q "^| $db_name"; then # Check if the database exists - echo "Removing database $db_name" >&2 - ynh_mysql_drop_db $db_name # Remove the database - else - echo "Database $db_name not found" >&2 - fi - - # Remove mysql user if it exists - if $(ynh_mysql_user_exists $db_user); then - ynh_mysql_drop_user $db_user - fi -} - -# Correct the name given in argument for mariadb -# -# Avoid invalid name for your database -# -# Exemple: dbname=$(ynh_make_valid_dbid $app) -# -# usage: ynh_make_valid_dbid name -# | arg: name - name to correct -# | ret: the corrected name -ynh_sanitize_dbid () { - dbid=${1//[-.]/_} # We should avoid having - and . in the name of databases. They are replaced by _ - echo $dbid -} - -# Manage a fail of the script -# -# Print a warning to inform that the script was failed -# Execute the ynh_clean_setup function if used in the app script -# -# usage of ynh_clean_setup function -# This function provide a way to clean some residual of installation that not managed by remove script. -# To use it, simply add in your script: -# ynh_clean_setup () { -# instructions... -# } -# This function is optionnal. -# -# Usage: ynh_exit_properly is used only by the helper ynh_abort_if_errors. -# You must not use it directly. -ynh_exit_properly () { - exit_code=$? - if [ "$exit_code" -eq 0 ]; then - exit 0 # Exit without error if the script ended correctly - fi - - trap '' EXIT # Ignore new exit signals - set +eu # Do not exit anymore if a command fail or if a variable is empty - - echo -e "!!\n $app's script has encountered an error. Its execution was cancelled.\n!!" >&2 - - if type -t ynh_clean_setup > /dev/null; then # Check if the function exist in the app script. - ynh_clean_setup # Call the function to do specific cleaning for the app. - fi - - ynh_die # Exit with error status -} - -# Exit if an error occurs during the execution of the script. -# -# Stop immediatly the execution if an error occured or if a empty variable is used. -# The execution of the script is derivate to ynh_exit_properly function before exit. -# -# Usage: ynh_abort_if_errors -ynh_abort_if_errors () { - set -eu # Exit if a command fail, and if a variable is used unset. - trap ynh_exit_properly EXIT # Capturing exit signals on shell script -} - -# Define and install dependencies with a equivs control file -# This helper can/should only be called once per app -# -# usage: ynh_install_app_dependencies dep [dep [...]] -# | arg: dep - the package name to install in dependence -ynh_install_app_dependencies () { - dependencies=$@ - manifest_path="../manifest.json" - if [ ! -e "$manifest_path" ]; then - manifest_path="../settings/manifest.json" # Into the restore script, the manifest is not at the same place - fi - version=$(sudo grep '\"version\": ' "$manifest_path" | cut -d '"' -f 4) # Retrieve the version number in the manifest file. - dep_app=${app//_/-} # Replace all '_' by '-' - - if ynh_package_is_installed "${dep_app}-ynh-deps"; then - echo "A package named ${dep_app}-ynh-deps is already installed" >&2 - else - cat > ./${dep_app}-ynh-deps.control << EOF # Make a control file for equivs-build -Section: misc -Priority: optional -Package: ${dep_app}-ynh-deps -Version: ${version} -Depends: ${dependencies// /, } -Architecture: all -Description: Fake package for ${app} (YunoHost app) dependencies - This meta-package is only responsible of installing its dependencies. -EOF - ynh_package_install_from_equivs ./${dep_app}-ynh-deps.control \ - || ynh_die "Unable to install dependencies" # Install the fake package and its dependencies - ynh_app_setting_set $app apt_dependencies $dependencies - fi -} - -# Remove fake package and its dependencies -# -# Dependencies will removed only if no other package need them. -# -# usage: ynh_remove_app_dependencies -ynh_remove_app_dependencies () { - dep_app=${app//_/-} # Replace all '_' by '-' - ynh_package_autoremove ${dep_app}-ynh-deps # Remove the fake package and its dependencies if they not still used. -} - -# Use logrotate to manage the logfile -# -# usage: ynh_use_logrotate [logfile] -# | arg: logfile - absolute path of logfile -# -# If no argument provided, a standard directory will be use. /var/log/${app} -# You can provide a path with the directory only or with the logfile. -# /parentdir/logdir/ -# /parentdir/logdir/logfile.log -# -# It's possible to use this helper several times, each config will added to same logrotate config file. -ynh_use_logrotate () { - if [ "$#" -gt 0 ]; then - if [ "$(echo ${1##*.})" == "log" ]; then # Keep only the extension to check if it's a logfile - logfile=$1 # In this case, focus logrotate on the logfile - else - logfile=$1/.log # Else, uses the directory and all logfile into it. - fi - else - logfile="/var/log/${app}/*.log" # Without argument, use a defaut directory in /var/log - fi - cat > ./${app}-logrotate << EOF # Build a config file for logrotate -$logfile { - # Rotate if the logfile exceeds 100Mo - size 100M - # Keep 12 old log maximum - rotate 12 - # Compress the logs with gzip - compress - # Compress the log at the next cycle. So keep always 2 non compressed logs - delaycompress - # Copy and truncate the log to allow to continue write on it. Instead of move the log. - copytruncate - # Do not do an error if the log is missing - missingok - # Not rotate if the log is empty - notifempty - # Keep old logs in the same dir - noolddir -} -EOF - sudo mkdir -p $(dirname "$logfile") # Create the log directory, if not exist - cat ${app}-logrotate | sudo tee -a /etc/logrotate.d/$app > /dev/null # Append this config to the others for this app. If a config file already exist -} - -# Remove the app's logrotate config. -# -# usage: ynh_remove_logrotate -ynh_remove_logrotate () { - if [ -e "/etc/logrotate.d/$app" ]; then - sudo rm "/etc/logrotate.d/$app" - fi -} - -# Find a free port and return it -# -# example: port=$(ynh_find_port 8080) -# -# usage: ynh_find_port begin_port -# | arg: begin_port - port to start to search -ynh_find_port () { - port=$1 - test -n "$port" || ynh_die "The argument of ynh_find_port must be a valid port." - while netcat -z 127.0.0.1 $port # Check if the port is free - do - port=$((port+1)) # Else, pass to next port - done - echo $port -} - -# Create a system user -# -# usage: ynh_system_user_create user_name [home_dir] -# | arg: user_name - Name of the system user that will be create -# | arg: home_dir - Path of the home dir for the user. Usually the final path of the app. If this argument is omitted, the user will be created without home -ynh_system_user_create () { - if ! ynh_system_user_exists "$1" # Check if the user exists on the system - then # If the user doesn't exist - if [ $# -ge 2 ]; then # If a home dir is mentioned - user_home_dir="-d $2" - else - user_home_dir="--no-create-home" - fi - sudo useradd $user_home_dir --system --user-group $1 --shell /usr/sbin/nologin || ynh_die "Unable to create $1 system account" - fi -} - -# Delete a system user -# -# usage: ynh_system_user_delete user_name -# | arg: user_name - Name of the system user that will be create -ynh_system_user_delete () { - if ynh_system_user_exists "$1" # Check if the user exists on the system - then - echo "Remove the user $1" >&2 - sudo userdel $1 - else - echo "The user $1 was not found" >&2 - fi -} - -# Curl abstraction to help with POST requests to local pages (such as installation forms) -# -# $domain and $path_url should be defined externally (and correspond to the domain.tld and the /path (of the app?)) -# -# example: ynh_local_curl "/install.php?installButton" "foo=$var1" "bar=$var2" -# -# usage: ynh_local_curl "page_uri" "key1=value1" "key2=value2" ... -# | arg: page_uri - Path (relative to $path_url) of the page where POST data will be sent -# | arg: key1=value1 - (Optionnal) POST key and corresponding value -# | arg: key2=value2 - (Optionnal) Another POST key and corresponding value -# | arg: ... - (Optionnal) More POST keys and values -ynh_local_curl () { - # Define url of page to curl - full_page_url=https://localhost$path_url$1 - - # Concatenate all other arguments with '&' to prepare POST data - POST_data="" - for arg in "${@:2}" - do - POST_data="${POST_data}${arg}&" - done - if [ -n "$POST_data" ] - then - # Add --data arg and remove the last character, which is an unecessary '&' - POST_data="--data \"${POST_data::-1}\"" - fi - - # Curl the URL - curl --silent --show-error -kL -H "Host: $domain" --resolve $domain:443:127.0.0.1 $POST_data "$full_page_url" -} - -# Substitute/replace a string by another in a file -# -# usage: ynh_replace_string match_string replace_string target_file -# | arg: match_string - String to be searched and replaced in the file -# | arg: replace_string - String that will replace matches -# | arg: target_file - File in which the string will be replaced. -ynh_replace_string () { - delimit=@ - match_string=${1//${delimit}/"\\${delimit}"} # Escape the delimiter if it's in the string. - replace_string=${2//${delimit}/"\\${delimit}"} - workfile=$3 - - sudo sed --in-place "s${delimit}${match_string}${delimit}${replace_string}${delimit}g" "$workfile" -} - -# Remove a file or a directory securely -# -# usage: ynh_secure_remove path_to_remove -# | arg: path_to_remove - File or directory to remove -ynh_secure_remove () { - path_to_remove=$1 - forbidden_path=" \ - /var/www \ - /home/yunohost.app" - - if [[ "$forbidden_path" =~ "$path_to_remove" \ - # Match all paths or subpaths in $forbidden_path - || "$path_to_remove" =~ ^/[[:alnum:]]+$ \ - # Match all first level paths from / (Like /var, /root, etc...) - || "${path_to_remove:${#path_to_remove}-1}" = "/" ]] - # Match if the path finishes by /. Because it seems there is an empty variable - then - echo "Avoid deleting $path_to_remove." >&2 - else - if [ -e "$path_to_remove" ] - then - sudo rm -R "$path_to_remove" - else - echo "$path_to_remove wasn't deleted because it doesn't exist." >&2 - fi - fi -} - -# Download, check integrity, uncompress and patch the source from app.src -# -# The file conf/app.src need to contains: -# -# SOURCE_URL=Address to download the app archive -# SOURCE_SUM=Control sum -# # (Optional) Programm to check the integrity (sha256sum, md5sum$YNH_EXECUTION_DIR/...) -# # default: sha256 -# SOURCE_SUM_PRG=sha256 -# # (Optional) Archive format -# # default: tar.gz -# SOURCE_FORMAT=tar.gz -# # (Optional) Put false if source are directly in the archive root -# # default: true -# SOURCE_IN_SUBDIR=false -# # (Optionnal) Name of the local archive (offline setup support) -# # default: ${src_id}.${src_format} -# SOURCE_FILENAME=example.tar.gz -# -# Details: -# This helper download sources from SOURCE_URL if there is no local source -# archive in /opt/yunohost-apps-src/APP_ID/SOURCE_FILENAME -# -# Next, it check the integrity with "SOURCE_SUM_PRG -c --status" command. -# -# If it's ok, the source archive will be uncompress in $dest_dir. If the -# SOURCE_IN_SUBDIR is true, the first level directory of the archive will be -# removed. -# -# Finally, patches named sources/patches/${src_id}-*.patch and extra files in -# sources/extra_files/$src_id will be applyed to dest_dir -# -# -# usage: ynh_setup_source dest_dir [source_id] -# | arg: dest_dir - Directory where to setup sources -# | arg: source_id - Name of the app, if the package contains more than one app -YNH_EXECUTION_DIR="." -ynh_setup_source () { - local dest_dir=$1 - local src_id=${2:-app} # If the argument is not given, source_id equal "app" - - # Load value from configuration file (see above for a small doc about this file - # format) - local src_url=$(grep 'SOURCE_URL=' "$YNH_EXECUTION_DIR/../conf/${src_id}.src" | cut -d= -f2-) - local src_sum=$(grep 'SOURCE_SUM=' "$YNH_EXECUTION_DIR/../conf/${src_id}.src" | cut -d= -f2-) - local src_sumprg=$(grep 'SOURCE_SUM_PRG=' "$YNH_EXECUTION_DIR/../conf/${src_id}.src" | cut -d= -f2-) - local src_format=$(grep 'SOURCE_FORMAT=' "$YNH_EXECUTION_DIR/../conf/${src_id}.src" | cut -d= -f2-) - local src_in_subdir=$(grep 'SOURCE_IN_SUBDIR=' "$YNH_EXECUTION_DIR/../conf/${src_id}.src" | cut -d= -f2-) - local src_filename=$(grep 'SOURCE_FILENAME=' "$YNH_EXECUTION_DIR/../conf/${src_id}.src" | cut -d= -f2-) - - # Default value - src_sumprg=${src_sumprg:-sha256sum} - src_in_subdir=${src_in_subdir:-true} - src_format=${src_format:-tar.gz} - src_format=$(echo "$src_format" | tr '[:upper:]' '[:lower:]') - if [ "$src_filename" = "" ] ; then - src_filename="${src_id}.${src_format}" - fi - local local_src="/opt/yunohost-apps-src/${YNH_APP_ID}/${src_filename}" - - if test -e "$local_src" - then # Use the local source file if it is present - cp $local_src $src_filename - else # If not, download the source - wget -nv -O $src_filename $src_url - fi - - # Check the control sum - echo "${src_sum} ${src_filename}" | ${src_sumprg} -c --status \ - || ynh_die "Corrupt source" - - # Extract source into the app dir - sudo mkdir -p "$dest_dir" - if [ "$src_format" = "zip" ] - then - # Zip format - # Using of a temp directory, because unzip doesn't manage --strip-components - if $src_in_subdir ; then - local tmp_dir=$(mktemp -d) - sudo unzip -quo $src_filename -d "$tmp_dir" - sudo cp -a $tmp_dir/*/. "$dest_dir" - ynh_secure_remove "$tmp_dir" - else - sudo unzip -quo $src_filename -d "$dest_dir" - fi - else - local strip="" - if $src_in_subdir ; then - strip="--strip-components 1" - fi - if [[ "$src_format" =~ ^tar.gz|tar.bz2|tar.xz$ ]] ; then - sudo tar -xf $src_filename -C "$dest_dir" $strip - else - ynh_die "Archive format unrecognized." - fi - fi - - # Apply patches - if (( $(find $YNH_EXECUTION_DIR/../sources/patches/ -type f -name "${src_id}-*.patch" 2> /dev/null | wc -l) > "0" )); then - local old_dir=$(pwd) - (cd "$dest_dir" \ - && for p in $YNH_EXECUTION_DIR/../sources/patches/${src_id}-*.patch; do \ - sudo patch -p1 < $p; done) \ - || ynh_die "Unable to apply patches" - cd $old_dir - fi - - # Add supplementary files - if test -e "$YNH_EXECUTION_DIR/../sources/extra_files/${src_id}"; then - sudo cp -a $YNH_EXECUTION_DIR/../sources/extra_files/$src_id/. "$dest_dir" - fi -} - -# Check availability of a web path -# -# example: ynh_webpath_available some.domain.tld /coffee -# -# usage: ynh_webpath_available domain path -# | arg: domain - the domain/host of the url -# | arg: path - the web path to check the availability of -ynh_webpath_available () { - local domain=$1 - local path=$2 - sudo yunohost domain url-available $domain $path -} - -# Register/book a web path for an app -# -# example: ynh_webpath_register wordpress some.domain.tld /coffee -# -# usage: ynh_webpath_register app domain path -# | arg: app - the app for which the domain should be registered -# | arg: domain - the domain/host of the web path -# | arg: path - the web path to be registered -ynh_webpath_register () { - local app=$1 - local domain=$2 - local path=$3 - sudo yunohost app register-url $app $domain $path -} - -# Calculate and store a file checksum into the app settings -# -# $app should be defined when calling this helper -# -# usage: ynh_store_file_checksum file -# | arg: file - The file on which the checksum will performed, then stored. -ynh_store_file_checksum () { - local checksum_setting_name=checksum_${1//[\/ ]/_} # Replace all '/' and ' ' by '_' - ynh_app_setting_set $app $checksum_setting_name $(sudo md5sum "$1" | cut -d' ' -f1) -} - -# Verify the checksum and backup the file if it's different -# This helper is primarily meant to allow to easily backup personalised/manually -# modified config files. -# -# $app should be defined when calling this helper -# -# usage: ynh_backup_if_checksum_is_different file -# | arg: file - The file on which the checksum test will be perfomed. -# -# | ret: Return the name a the backup file, or nothing -ynh_backup_if_checksum_is_different () { - local file=$1 - local checksum_setting_name=checksum_${file//[\/ ]/_} # Replace all '/' and ' ' by '_' - local checksum_value=$(ynh_app_setting_get $app $checksum_setting_name) - if [ -n "$checksum_value" ] - then # Proceed only if a value was stored into the app settings - if ! echo "$checksum_value $file" | sudo md5sum -c --status - then # If the checksum is now different - backup_file="/home/yunohost.conf/backup/$file.backup.$(date '+%Y%m%d.%H%M%S')" - sudo mkdir -p "$(dirname "$backup_file")" - sudo cp -a "$file" "$backup_file" # Backup the current file - echo "File $file has been manually modified since the installation or last upgrade. So it has been duplicated in $backup_file" >&2 - echo "$backup_file" # Return the name of the backup file - fi - fi -} diff --git a/scripts/backup b/scripts/backup index 83b0a5b..aa60d39 100755 --- a/scripts/backup +++ b/scripts/backup @@ -1,101 +1,77 @@ #!/bin/bash -# Exit on command errors and treat unset variables as an error -set -eu #================================================= -# GENERIC STARTING -#================================================= - +# GENERIC START #================================================= # IMPORT GENERIC HELPERS #================================================= -if [ ! -e _common.sh ]; then - # Get the functions file if not present in the current directory - sudo cp ../settings/scripts/_common.sh ./_common.sh - sudo chmod a+rx _common.sh -fi -source _common.sh +# 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 +#================================================= +# 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_print_info --message="Loading installation settings..." app=$YNH_APP_INSTANCE_NAME -port=$(ynh_app_setting_get $app port) -domain=$(ynh_app_setting_get $app domain) -is_public=$(ynh_app_setting_get $app is_public) - -wwwhome=~wwwdata -final_path="$wwwhome/$app" -#================================================= -# STANDARD BACKUP STEPS -#================================================= -# BACKUP OF THE BDD AND ITS CONFIGURATION -#================================================= - -# Backup the configuration -CHECK_SIZE "/etc/rethinkdb/instances.d/turtl.conf" -ynh_backup "/etc/rethinkdb/instances.d/turtl.conf" - -# Dump data -/usr/local/bin/rethinkdb dump -q --overwrite-file -f "$final_path/rethinkdb_dump.tar.gz" +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) +datadir=$(ynh_app_setting_get --app=$app --key=datadir) #================================================= -# BACKUP OF THE MAIN DIR OF THE APP +# DECLARE DATA AND CONF FILES TO BACKUP #================================================= -CHECK_SIZE "$final_path" -ynh_backup "$final_path" +ynh_print_info --message="Declaring files to be backed up..." #================================================= -# BACKUP OF THE SYSTEMD SERVICE +# BACKUP THE APP MAIN DIR #================================================= -CHECK_SIZE "/etc/systemd/system/$app.service" -ynh_backup "/etc/systemd/system/$app.service" + +ynh_backup --src_path="$final_path" #================================================= -# BACKUP OF THE NGINX CONFIGURATION +# BACKUP THE DATA DIR #================================================= -CHECK_SIZE "/etc/nginx/conf.d/$domain.d/$app.conf" -ynh_backup "/etc/nginx/conf.d/$domain.d/$app.conf" + +ynh_backup --src_path="$datadir" --is_big + +#================================================= +# BACKUP THE NGINX CONFIGURATION +#================================================= + +ynh_backup --src_path="/etc/nginx/conf.d/$domain.d/$app.conf" #================================================= # SPECIFIC BACKUP #================================================= -# BACKUP OF APT PREFERENCES AND SOURCES.LIST +# BACKUP SYSTEMD #================================================= -CHECK_SIZE "/etc/apt/sources.list.d/$app.list" -ynh_backup "/etc/apt/sources.list.d/$app.list" -CHECK_SIZE "/etc/apt/preferences.d/00TurtlPinning" -ynh_backup "/etc/apt/preferences.d/00TurtlPinning" +ynh_backup --src_path="/etc/systemd/system/$app.service" #================================================= -# BACKUP OF CCL DIRECTORIES +# BACKUP THE MYSQL DATABASE #================================================= -CHECK_SIZE "$wwwhome/.ccl-init.lisp" -ynh_backup "$wwwhome/.ccl-init.lisp" -CHECK_SIZE "$wwwhome/quicklisp" -ynh_backup "$wwwhome/quicklisp" -CHECK_SIZE "$wwwhome/.cache" -ynh_backup "$wwwhome/.cache" +ynh_print_info --message="Backing up the PostgreSQL database..." + +ynh_psql_dump_db --database="$db_name" > db.sql #================================================= -# BACKUP OF RSYSLOG CONFIGURATION +# END OF SCRIPT #================================================= -CHECK_SIZE "/etc/rsyslog.d/$app.conf" -ynh_backup "/etc/rsyslog.d/$app.conf" -#================================================= -# BACKUP OF LOGS -#================================================= -CHECK_SIZE "/var/log/turtl" -ynh_backup "/var/log/turtl" - -#================================================= -# BACKUP OF LOGROTATE CONFIGURATION -#================================================= -CHECK_SIZE "/etc/logrotate.d/$app" -ynh_backup "/etc/logrotate.d/$app" +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 2180c4e..483956d 100755 --- a/scripts/install +++ b/scripts/install @@ -1,7 +1,7 @@ #!/bin/bash -set -eu - +#================================================= +# GENERIC START #================================================= # IMPORT GENERIC HELPERS #================================================= @@ -10,198 +10,191 @@ source _common.sh source /usr/share/yunohost/helpers #================================================= -# MANAGE FAILURE OF THE SCRIPT +# MANAGE SCRIPT FAILURE #================================================= -ynh_abort_if_errors # Active trap pour arrêter le script si une erreur est détectée. +ynh_clean_setup () { + ynh_clean_check_starting +} +# Exit if an error occurs during the execution of the script +ynh_abort_if_errors #================================================= # RETRIEVE ARGUMENTS FROM THE MANIFEST #================================================= -app=$YNH_APP_INSTANCE_NAME - -path=$YNH_APP_ARG_PATH domain=$YNH_APP_ARG_DOMAIN +path_url="/" is_public=$YNH_APP_ARG_IS_PUBLIC -#================================================= -# CHECK THE DEBIAN'S CODENAME -#================================================= +hash=$(ynh_string_random --length=128) -codename=$(lsb_release -a 2>/dev/null | grep Codename | cut -f 2) -test -z "$codename" && (ynh_die "codename empty") -if [ $codename != 'jessie' ] -then - ynh_die "Sorry, it can only be installed on Debian Jessie" -fi -archi=$(uname -m) -pwd=$(pwd) -wwwhome=~www-data +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 #================================================= # FIND AND OPEN A PORT #================================================= +ynh_script_progression --message="Finding an available port..." --weight=2 -port=$(ynh_find_port 8181) # Cherche un port libre. - -# Store infos in YunoHost config -ynh_app_setting_set $app port $port -ynh_app_setting_set $app path ${path} -ynh_app_setting_set $app domain ${domain} -ynh_app_setting_set $app is_public ${is_public} +# Find an available port +port=$(ynh_find_port --port=8181) +ynh_app_setting_set --app=$app --key=port --value=$port #================================================= -# DEPENDENCIES +# INSTALL DEPENDENCIES #================================================= -# Activate backports sources.list -cp -a "../conf/turtl.list" "/etc/apt/sources.list.d/$app.list" -cp -a "../conf/turtl-preferences" "/etc/apt/preferences.d/00TurtlPinning" -if [ $archi == "armv7l" ] -then - gpg --list-keys 7638D0442B90D010 > /dev/null 2>&1 - if [ $? != 0 ] - then - gpg --keyserver pgpkeys.mit.edu --recv-key 7638D0442B90D010 - fi - gpg --list-keys 8B48AD6246925553 > /dev/null 2>&1 - if [ $? != 0 ] - then - gpg --keyserver pgpkeys.mit.edu --recv-key 8B48AD6246925553 - fi - if [ $(apt-key finger | grep "7638 D044 2B90 D010" -c) == 0 ] - then - gpg -a --export 7638D0442B90D010 | apt-key add - - fi - if [ $(apt-key finger | grep "8B48 AD62 4692 5553" -c) == 0 ] - then - gpg -a --export 8B48AD6246925553 | apt-key add - - fi -fi +ynh_script_progression --message="Installing dependencies..." --weight=20 -if [ $archi == "armv7l" ] -then - # Install RethinkDB - dpkg -i ../conf/rethinkdb_2.3.6_armhf.deb -else - # Activate RethinkDB sources.list - release=$(lsb_release -cs) - echo "deb http://download.rethinkdb.com/apt $release main" | tee /etc/apt/sources.list.d/rethinkdb.list - wget -qO- https://download.rethinkdb.com/apt/pubkey.gpg | apt-key add - - ynh_package_update -fi - -# Install dependencies -ynh_package_update -ynh_install_app_dependencies wget git build-essential rethinkdb libuv1-dev python-pip - - -# Install Clozure Common Lisp -cd /opt -if [ $archi == "armv7l" ] -then - wget -q ftp://ftp.clozure.com/pub/release/1.11/ccl-1.11-linuxarm.tar.gz - tar xf ccl-1.11-linuxarm.tar.gz -else - wget -q ftp://ftp.clozure.com/pub/release/1.11/ccl-1.11-linuxx86.tar.gz - tar xf ccl-1.11-linuxx86.tar.gz -fi - -cd ccl -if [ $(grep -c "flags.* lm .*" /proc/cpuinfo) -eq 0 ] -then - cp scripts/ccl /usr/bin/ccl -else - cp scripts/ccl64 /usr/bin/ccl -fi -sed -e "s@CCL_DEFAULT_DIRECTORY=/usr/local/src/ccl@CCL_DEFAULT_DIRECTORY=/opt/ccl@" -i /usr/bin/ccl - -# Install QuickLisp -cd $pwd -cp -a ../conf/ccl-init.lisp $wwwhome/.ccl-init.lisp -cp -a ../conf/quicklisp.lisp /tmp/quicklisp.lisp -cp -a ../conf/quicklisp.lisp.asc /tmp/quicklisp.lisp.asc - -mkdir $wwwhome/quicklisp $wwwhome/.cache/ -chown www-data: $wwwhome/quicklisp $wwwhome/.cache/ $wwwhome/.ccl-init.lisp - -gpg --keyserver pgpkeys.mit.edu --recv-key 307965AB028B5FF7 -gpg --verify /tmp/quicklisp.lisp.asc /tmp/quicklisp.lisp - -su -c 'echo -e "(quicklisp-quickstart:install)\n(quit)" | ccl --load /tmp/quicklisp.lisp' -s /bin/bash www-data - -echo "(pushnew \"./\" asdf :*central-registry* :test #'equal)" >> $wwwhome/.ccl-init.lisp - -rm -f /tmp/quicklisp /tmp/quicklisp.lisp.asc - -# Configure RethinkDB -echo "http-port=8091" > /etc/rethinkdb/instances.d/turtl.conf -service rethinkdb restart - -# Install RethinkDB tools (needed for backup) -pip install rethinkdb - -# Install Turtl -cd $wwwhome -mkdir turtl/data -p -cd turtl -git clone https://github.com/turtl/api.git +ynh_exec_warn_less ynh_install_app_dependencies $pkg_dependencies +ynh_exec_warn_less ynh_install_nodejs --nodejs_version=$nodejs_version #================================================= -# CONFIGURE TURTL +# CREATE DEDICATED USER #================================================= -cd api +ynh_script_progression --message="Configuring system user..." --weight=1 -# Copions le modèle de fichier de configuration -cp config/config.default.lisp config/config.lisp +# Create a system user +ynh_system_user_create --username=$app --home_dir="$final_path" -# Modifie la configuration de turtl -sed -e "s@\*server-port\* 8181@*server-port* $port@" \ - -e "s@\*server-bind\* nil@*server-bind* \"127.0.0.1\"@" \ - -e "s@\*production-error-handling\* nil@*production-error-handling* t@" \ - -e "s@\*site-url\* \"http://turtl.dev:8181\"@*site-url* \"https://$domain\"@" \ - -e "s@\*smtp-host\* nil@*smtp-host* \"localhost\"@" \ - -e "s@\*display-errors\* t@*display-errors* nil@" \ - -e "s@\*local-upload\* nil@*local-upload* \"$wwwhome/turtl/data\"@" \ - -e "s@\*local-upload-url\* nil@*local-upload-url* \"https://$domain\"@" \ - -i config/config.lisp +#================================================= +# CREATE A POSTGRESQL DATABASE +#================================================= +ynh_script_progression --message="Creating a PostgreSQL database..." --weight=2 -if [ $path != '/' ] +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_psql_test_if_first_run +ynh_psql_setup_db --db_user=$db_user --db_name=$db_name + +#================================================= +# DOWNLOAD, CHECK AND UNPACK SOURCE +#================================================= +ynh_script_progression --message="Setting up source files..." --weight=3 + +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" + +mkdir -p $final_path/plugins + +chmod 700 $final_path/plugins +chown $app:$app $final_path/plugins + +chmod 750 "$final_path" +chmod -R o-rwx "$final_path" +chown -R $app:www-data "$final_path" + +#================================================= +# NGINX CONFIGURATION +#================================================= +ynh_script_progression --message="Configuring NGINX web server..." --weight=1 + +# Create a dedicated NGINX config +ynh_add_nginx_config + +#================================================= +# SPECIFIC SETUP +#================================================= +# BUILD TURTLE +#================================================= +ynh_script_progression --message="Building turtl... (this will take some time and resources!)" --weight=20 + +pushd $final_path + ynh_use_nodejs + ynh_exec_as $app env $ynh_node_load_PATH npm install --unsafe-perm 2>/dev/null +popd + +#================================================= +# CREATE DATA DIRECTORY +#================================================= +ynh_script_progression --message="Creating a data directory..." --weight=2 + +datadir=/home/yunohost.app/$app +ynh_app_setting_set --app=$app --key=datadir --value=$datadir + +mkdir -p $datadir + +chmod 750 "$datadir" +chmod -R o-rwx "$datadir" +chown -R $app:www-data "$datadir" + +#================================================= +# ADD A CONFIGURATION +#================================================= +ynh_script_progression --message="Adding a configuration file..." --weight=1 + +ynh_add_config --template="../conf/config.yaml.default" --destination="$final_path/config/config.yaml" + +chmod 400 "$final_path/config/config.yaml" +chown $app:$app "$final_path/config/config.yaml" + +#================================================= +# SETUP SYSTEMD +#================================================= +ynh_script_progression --message="Configuring a systemd service..." --weight=2 + +# Create a dedicated systemd config +ynh_add_systemd_config + +#================================================= +# GENERIC FINALIZATION +#================================================= +# INTEGRATE SERVICE IN YUNOHOST +#================================================= +ynh_script_progression --message="Integrating service in YunoHost..." --weight=1 + +yunohost service add $app --description="Share notes, bookmarks, and documents" + +#================================================= +# START SYSTEMD SERVICE +#================================================= +ynh_script_progression --message="Starting a systemd service..." --weight=5 + +# Start a systemd service +ynh_systemd_action --service_name=$app --action="start" --log_path=systemd --line_match="Listening for turtls on IP" + +#================================================= +# SETUP SSOWAT +#================================================= +ynh_script_progression --message="Configuring permissions..." --weight=1 + +# Make app public if necessary +if [ $is_public -eq 1 ] then - sed -e "s@\*api-path\* \"\"@\*api-path\* \"$path\"@" -i config/config.lisp + # Everyone can access the app. + # The "main" permission is automatically created before the install script. + ynh_permission_update --permission="main" --add="visitors" fi #================================================= -# LOG HANDLING +# RELOAD NGINX #================================================= -cd $pwd -cp "../conf/rsyslogd.conf" "/etc/rsyslog.d/$app.conf" -service rsyslog restart -mkdir /var/log/turtl/ -p -cp "../conf/logrotate.conf" "/etc/logrotate.d/$app" +ynh_script_progression --message="Reloading NGINX web server..." --weight=1 + +ynh_systemd_action --service_name=nginx --action=reload #================================================= -# ENABLE SERVICE IN ADMIN PANEL +# END OF SCRIPT #================================================= -# Add service to Yunohost monitoring -cp "../conf/turtl.service" "/etc/systemd/system/$app.service" -systemctl daemon-reload -yunohost service add turtl --log "/var/log/turtl/$app.log" -yunohost service start turtl -#================================================= -# NGINX -#================================================= -# Copy Nginx conf -cp ../conf/nginx.conf /etc/nginx/conf.d/$domain.d/$app.conf - -# Change variables in Nginx configuration -if [ $is_public -eq 1 ]; -then - ynh_app_setting_set "$app" unprotected_uris "$path" -fi -sed -i "s@__PATH__@$path@g" /etc/nginx/conf.d/$domain.d/$app.conf -sed -i "s@__PORT__@$port@g" /etc/nginx/conf.d/$domain.d/$app.conf - -# Reload Nginx -service nginx reload +ynh_script_progression --message="Installation of $app completed" --last diff --git a/scripts/remove b/scripts/remove index c29960d..5439bf7 100755 --- a/scripts/remove +++ b/scripts/remove @@ -1,9 +1,7 @@ #!/bin/bash -set -u - #================================================= -# GENERIC STARTING +# GENERIC START #================================================= # IMPORT GENERIC HELPERS #================================================= @@ -14,53 +12,92 @@ 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" domain) +domain=$(ynh_app_setting_get --app=$app --key=domain) +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) +datadir=$(ynh_app_setting_get --app=$app --key=datadir) #================================================= # STANDARD REMOVE #================================================= -# DISABLE SERVICE IN ADMIN PANEL +# REMOVE SERVICE INTEGRATION IN YUNOHOST #================================================= -# Retire le service du monitoring de Yunohost. -if sudo yunohost service status | grep -q turtl # Test l'existence du service dans Yunohost +# Remove the service from the list of services known by YunoHost (added from `yunohost service add`) +if ynh_exec_warn_less yunohost service status $app >/dev/null then - echo "Remove turtl service" - sudo systemctl stop turtl - sudo systemctl disable turtl - ynh_secure_remove "/etc/systemd/system/turtl.service" - sudo systemctl daemon-reload - sudo yunohost service remove turtl + ynh_script_progression --message="Removing $app service integration..." --weight=1 + yunohost service remove $app fi #================================================= -# SPECIFIC REMOVE +# STOP AND REMOVE SERVICE #================================================= -# REMOVE TURTL -#================================================= -# Remove sources -sudo rm -rf "/var/www/$app/" -# Remove dependencies -sudo pip uninstall rethinkdb -y -ynh_remove_app_dependencies -ynh_secure_remove "/etc/rethinkdb/instances.d/turtl.conf" -sudo rm -rf "/var/lib/rethinkdb/turtl" -sudo rm -rf "/var/www/.cache/" -sudo rm -rf "/var/www/quicklisp/" -sudo rm -rf "/opt/ccl/" -ynh_secure_remove "/var/www/.ccl-init.lisp" -ynh_secure_remove "/usr/bin/ccl" -ynh_secure_remove "/etc/logrotate.d/turtl" -ynh_secure_remove "/etc/rsyslog.d/turtl.conf" -sudo rm -rf "/var/log/turtl/" -sudo service rsyslog restart -# Remove source.list -ynh_secure_remove "/etc/apt/sources.list.d/turtl.list" -# Remove nginx configuration file -ynh_secure_remove "/etc/nginx/conf.d/$domain.d/$app.conf" +ynh_script_progression --message="Stopping and removing the systemd service..." --weight=1 -# Reload nginx service -sudo service nginx reload +# Remove the dedicated systemd config +ynh_remove_systemd_config + +#================================================= +# REMOVE THE POSTGRESQL DATABASE +#================================================= +ynh_script_progression --message="Removing the PostgreSQL database..." --weight=1 + +# Remove a database if it exists, along with the associated user +ynh_psql_remove_db --db_user=$db_user --db_name=$db_name + +#================================================= +# REMOVE APP MAIN DIR +#================================================= +ynh_script_progression --message="Removing app main directory..." --weight=2 + +# Remove the app directory securely +ynh_secure_remove --file="$final_path" + +#================================================= +# REMOVE DATA DIR +#================================================= + +# Remove the data directory if --purge option is used +if [ "${YNH_APP_PURGE:-0}" -eq 1 ] +then + ynh_script_progression --message="Removing app data directory..." --weight=1 + ynh_secure_remove --file="$datadir" +fi + +#================================================= +# REMOVE NGINX CONFIGURATION +#================================================= +ynh_script_progression --message="Removing NGINX web server configuration..." --weight=1 + +# Remove the dedicated NGINX config +ynh_remove_nginx_config + +#================================================= +# REMOVE DEPENDENCIES +#================================================= +ynh_script_progression --message="Removing dependencies..." --weight=3 + +# 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 +#================================================= + +ynh_script_progression --message="Removal of $app completed" --last diff --git a/scripts/restore b/scripts/restore index 12ed6df..d8dc82c 100755 --- a/scripts/restore +++ b/scripts/restore @@ -6,162 +6,136 @@ # IMPORT GENERIC HELPERS #================================================= -if [ ! -e _common.sh ]; then - # Get the _common.sh file if it's not in the current directory - cp ../settings/scripts/_common.sh ./_common.sh - chmod a+rx _common.sh -fi -source _common.sh +# 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 #================================================= # MANAGE SCRIPT FAILURE #================================================= +ynh_clean_setup () { + ynh_clean_check_starting +} # 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 -path=$(ynh_app_setting_get $app path) -port=$(ynh_app_setting_get $app port) -domain=$(ynh_app_setting_get $app domain) -is_public=$(ynh_app_setting_get $app is_public) - -wwwhome=~wwwdata -final_path="$wwwhome/$app" +domain=$(ynh_app_setting_get --app=$app --key=domain) +path_url=$(ynh_app_setting_get --app=$app --key=path) +final_path=$(ynh_app_setting_get --app=$app --key=final_path) +db_name=$(ynh_app_setting_get --app=$app --key=db_name) +db_user=$db_name +datadir=$(ynh_app_setting_get --app=$app --key=datadir) #================================================= # CHECK IF THE APP CAN BE RESTORED #================================================= +ynh_script_progression --message="Validating restoration parameters..." --weight=1 -yunohost app checkurl "${domain}${path_url}" -a "$app" \ test ! -d $final_path \ - || ynh_die "There is already a directory: $final_path " + || ynh_die --message="There is already a directory: $final_path " #================================================= -# RESTORE OF THE NGINX CONFIGURATION +# STANDARD RESTORATION STEPS #================================================= -ynh_restore_file "/etc/nginx/conf.d/$domain.d/$app.conf" +# RESTORE THE NGINX CONFIGURATION +#================================================= +ynh_script_progression --message="Restoring the NGINX configuration..." --weight=1 + +ynh_restore_file --origin_path="/etc/nginx/conf.d/$domain.d/$app.conf" #================================================= -# RESTORE OF THE MAIN DIR OF THE APP +# RECREATE THE DEDICATED USER #================================================= -ynh_restore_file "$final_path" +ynh_script_progression --message="Recreating the dedicated system user..." --weight=1 + +# Create the dedicated user (if not existing) +ynh_system_user_create --username=$app --home_dir="$final_path" #================================================= -# HANDLE LOG FILES AND LOGROTATE +# RESTORE THE APP MAIN DIR #================================================= -mkdir -p /var/log/turtl -# Restore rsyslog conf -ynh_restore_file "/etc/rsyslog.d/$app.conf" -# Restore logrotate conf -ynh_restore_file "/etc/logrotate.d/$app" +ynh_script_progression --message="Restoring the app main directory..." --weight=3 + +ynh_restore_file --origin_path="$final_path" + +chmod 750 "$final_path" +chmod -R o-rwx "$final_path" +chown -R $app:www-data "$final_path" #================================================= -# APT STUFF +# RESTORE THE DATA DIRECTORY #================================================= -ynh_restore_file "/etc/apt/sources.list.d/$app.list" -ynh_restore_file "/etc/apt/preferences.d/00TurtlPinning" +ynh_script_progression --message="Restoring the data directory..." --weight=1 + +ynh_restore_file --origin_path="$datadir" --not_mandatory + +mkdir -p $datadir + +chmod 750 "$datadir" +chmod -R o-rwx "$datadir" +chown -R $app:www-data "$datadir" #================================================= -# INSTALL DEPENDENCIES +# SPECIFIC RESTORATION #================================================= -ynh_package_update -if ! ynh_package_is_installed "wget" ; then - ynh_install_app_dependencies wget -fi -if ! ynh_package_is_installed "git" ; then - ynh_install_app_dependencies git -fi +# REINSTALL DEPENDENCIES +#================================================= +ynh_script_progression --message="Reinstalling dependencies..." --weight=20 + +ynh_exec_warn_less ynh_install_app_dependencies $pkg_dependencies +ynh_exec_warn_less ynh_install_nodejs --nodejs_version=$nodejs_version #================================================= -# INSTALL CCL +# RESTORE THE POSTGRESQL DATABASE #================================================= -cd /opt -if [ $archi == "armv7l" ] -then - wget -q ftp://ftp.clozure.com/pub/release/1.11/ccl-1.11-linuxarm.tar.gz - tar xf ccl-1.11-linuxarm.tar.gz -else - wget -q ftp://ftp.clozure.com/pub/release/1.11/ccl-1.11-linuxx86.tar.gz - tar xf ccl-1.11-linuxx86.tar.gz -fi +ynh_script_progression --message="Restoring the PostgreSQL database..." --weight=6 -cd ccl -if [ $(grep -c "flags.* lm .*" /proc/cpuinfo) -eq 0 ] -then - cp scripts/ccl /usr/bin/ccl -else - cp scripts/ccl64 /usr/bin/ccl -fi -sed -e "s@CCL_DEFAULT_DIRECTORY=/usr/local/src/ccl@CCL_DEFAULT_DIRECTORY=/opt/ccl@" -i /usr/bin/ccl - -# Install some dependencies -if [ $archi == "armv7l" ] -then - gpg --keyserver pgpkeys.mit.edu --recv-key 7638D0442B90D010 - gpg -a --export 7638D0442B90D010 | apt-key add - -fi -if ! ynh_package_is_installed "build-essential" ; then - ynh_install_app_dependencies build-essential -fi -ynh_install_app_dependencies libuv1-dev - -ynh_restore_file "$wwwhome/.ccl-init.lisp" -ynh_restore_file "$wwwhome/quicklisp" -ynh_restore_file "$wwwhome/.cache" +ynh_psql_test_if_first_run +db_pwd=$(ynh_app_setting_get --app=$app --key=psqlpwd) +ynh_psql_setup_db --db_user=$db_user --db_name=$db_name --db_pwd=$db_pwd +ynh_psql_execute_file_as_root --file="./db.sql" --database=$db_name #================================================= -# INSTALL Rethinkdb +# RESTORE SYSTEMD #================================================= -if [ $archi == "armv7l" ] -then - dpkg -i ../conf/rethinkdb_2.3.6_armhf.deb -else - release=$(lsb_release -cs) - echo "deb http://download.rethinkdb.com/apt $release main" | tee /etc/apt/sources.list.d/rethinkdb.list - wget -qO- https://download.rethinkdb.com/apt/pubkey.gpg | apt-key add - - ynh_package_update - ynh_install_app_dependencies rethinkdb -fi +ynh_script_progression --message="Restoring the systemd configuration..." --weight=1 -echo "http-port=8091" > /etc/rethinkdb/instances.d/turtl.conf -service rethinkdb restart - -# Install RethinkDB tools (needed for backup) -ynh_install_app_dependencies python-pip -pip install rethinkdb +ynh_restore_file --origin_path="/etc/systemd/system/$app.service" +systemctl enable $app.service --quiet #================================================= -# RESTORE OF THE BDD +# INTEGRATE SERVICE IN YUNOHOST #================================================= -/usr/local/bin/rethinkdb restore "$final_path/rethinkdb_dump.tar.gz" +ynh_script_progression --message="Integrating service in YunoHost..." --weight=1 + +yunohost service add $app --description="Share notes, bookmarks, and documents" #================================================= -# RESTORE SYSTEMD SERVICE +# START SYSTEMD SERVICE #================================================= +ynh_script_progression --message="Starting a systemd service..." --weight=5 -ynh_restore_file "/etc/systemd/system/$app.service" -systemctl daemon-reload -systemctl enable $app.service +ynh_systemd_action --service_name=$app --action="start" --log_path=systemd --line_match="Listening for turtls on IP" #================================================= -# ENABLE SERVICE IN ADMIN PANEL +# GENERIC FINALIZATION #================================================= -systemctl daemon-reload -yunohost service add turtl --log "/var/log/turtl/$app.log" +# RELOAD NGINX AND PHP-FPM +#================================================= +ynh_script_progression --message="Reloading NGINX web server..." --weight=1 + +ynh_systemd_action --service_name=nginx --action=reload #================================================= -# START SERVICE +# END OF SCRIPT #================================================= -yunohost service start turtl -#================================================= -# RELOAD NGINX -#================================================= -systemctl reload nginx +ynh_script_progression --message="Restoration completed for $app" --last diff --git a/scripts/upgrade b/scripts/upgrade index f79ea38..76e98fe 100755 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -1,9 +1,7 @@ #!/bin/bash -# Exit on command errors and treat unset variables as an error -set -eu #================================================= -# GENERIC STARTING +# GENERIC START #================================================= # IMPORT GENERIC HELPERS #================================================= @@ -14,39 +12,134 @@ source /usr/share/yunohost/helpers #================================================= # LOAD SETTINGS #================================================= +ynh_script_progression --message="Loading installation settings..." --weight=1 app=$YNH_APP_INSTANCE_NAME -path=$(ynh_app_setting_get $app path) -port=$(ynh_app_setting_get $app port) -domain=$(ynh_app_setting_get $app domain) -is_public=$(ynh_app_setting_get $app path) +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 +db_pwd=$(ynh_app_setting_get --app=$app --key=psqlpwd) +port=$(ynh_app_setting_get --app=$app --key=port) #================================================= -# FIX OLD THINGS +# CHECK VERSION #================================================= -cp ../conf/rsyslogd.conf /etc/rsyslog.d/turtl.conf -service rsyslog restart -cp ../conf/logrotate.conf /etc/logrotate.d/turtl +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=1 + # Backup the current version of the app ynh_backup_before_upgrade ynh_clean_setup () { - # restore it if the upgrade fails - ynh_restore_upgradebackup + ynh_clean_check_starting + # 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 THE PATH -#================================================= -# Verify and correct path syntax -path_url=$(ynh_normalize_url_path $path_url) # Vérifie et corrige la syntaxe du path. - #================================================= # STANDARD UPGRADE STEPS #================================================= +# STOP SYSTEMD SERVICE +#================================================= +ynh_script_progression --message="Stopping a systemd service..." --weight=1 + +ynh_systemd_action --service_name=$app --action="stop" --log_path=systemd --line_match="Stopped Turtl Server" + +#================================================= +# ENSURE DOWNWARD COMPATIBILITY +#================================================= +ynh_script_progression --message="Ensuring downward compatibility..." --weight=1 + +# 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 +#================================================= + +if [ "$upgrade_type" == "UPGRADE_APP" ] +then + ynh_script_progression --message="Upgrading source files..." --weight=2 + + # Download, check integrity, uncompress and patch the source from app.src + ynh_setup_source --dest_dir="$final_path" +fi + +chmod 750 "$final_path" +chmod -R o-rwx "$final_path" +chown -R $app:www-data "$final_path" + +#================================================= +# NGINX CONFIGURATION +#================================================= +ynh_script_progression --message="Upgrading NGINX web server configuration..." --weight=2 + +# Create a dedicated NGINX config +ynh_add_nginx_config + +#================================================= +# UPGRADE DEPENDENCIES +#================================================= +ynh_script_progression --message="Upgrading dependencies..." --weight=20 + +ynh_exec_warn_less ynh_install_app_dependencies $pkg_dependencies +ynh_exec_warn_less ynh_install_nodejs --nodejs_version=$nodejs_version + +#================================================= +# SETUP SYSTEMD +#================================================= +ynh_script_progression --message="Upgrading systemd configuration..." --weight=1 + +# Create a dedicated systemd config +ynh_add_systemd_config + +#================================================= +# GENERIC FINALIZATION +#================================================= +# INTEGRATE SERVICE IN YUNOHOST +#================================================= +ynh_script_progression --message="Integrating service in YunoHost..." --weight=1 + +yunohost service add $app --description="Share notes, bookmarks, and documents" + +#================================================= +# START SYSTEMD SERVICE +#================================================= +ynh_script_progression --message="Starting a systemd service..." --weight=5 + +ynh_systemd_action --service_name=$app --action="start" --log_path=systemd --line_match="Listening for turtls on IP" + +#================================================= +# RELOAD NGINX +#================================================= +ynh_script_progression --message="Reloading NGINX web server..." --weight=1 + +ynh_systemd_action --service_name=nginx --action=reload + +#================================================= +# END OF SCRIPT +#================================================= + +ynh_script_progression --message="Upgrade of $app completed" --last