Contributing

contributing

What can you do to help this project?

Reporting a security issue

If you’ve found a security issue, please report it by email to the address associated to my GPG key:

gpg --search-keys "Nicolas CARPi"
_images/i18n.png

Translating

Do you know several languages? Are you willing to help localize eLabFTW? You’re in the right place.

How to translate?

  • Join the project on poeditor.com
  • Select elabftw
  • Add a language (or select an existing one)
  • Start translating
  • Ignore things like <strong>, <br>, %s, %d and keep the punctuation like it was!

Translations are updated before a release.

Contributing to the code

Note about branches

The repository contains (at least) 3 branches:

  • The master branch points to the latest stable version and should always be in working state
  • The next branch points to the latest unstable version (alpha, beta or rc) (or latest stable if no unstable released yet)
  • The hypernext branch is the dev branch, it might contain bugs and unfinished work, never use it in production! It is the latest version of the code and the one you should work against.

Environment installation

So the dev environment for eLab is an hybrid between Docker and a local install. The files will be served by the webserver in Docker but the source code (elabftw folder) will be on your computer. In this setup, we will put everything in the same folder for simplicity.

Here is a step-by-step for installing an eLabFTW dev setup:

Make sure your user is in the docker group so you can execute docker commands without sudo (see documentation).

  • Next let’s define a directory for dev (adapt to your needs):
# this folder can be anywhere you like
export dev='/home/<YOUR USERNAME>/elabdev'
mkdir -p $dev
cd $dev
  • Go on the repository on GitHub
  • Click the Star button (it helps with visibility of the project)
  • Click the Fork button in the top right of the screen
  • From your fork page, clone it with SSH on your machine:
git clone git@github.com:<YOUR USERNAME>/elabftw.git
# checkout the hypernext branch because this is where dev happens
cd elabftw
git checkout hypernext
cd ..
  • Get elabctl and the configuration files
# get elabctl
wget -qO- https://get.elabftw.net > elabctl && chmod +x elabctl
# get elabctl configuration file
wget -q https://raw.githubusercontent.com/elabftw/elabctl/master/elabctl.conf
# get the docker-compose configuration file (from the dev branch)
wget -qO- https://raw.githubusercontent.com/elabftw/elabimg/dev/src/docker-compose.yml-EXAMPLE > elabftw-dev.yml
  • Edit elabctl.conf, change BACKUP_DIR to $dev/backup or any other directory (write full paths of course, not aliases)
  • Change CONF_FILE to $dev/elabftw-dev.yml. Again, write the full path, not the alias!
  • Change DATA_DIR to $dev/data. Again, write the full path, not the alias!
  • Edit the docker-compose configuration file elabftw-dev.yml
  • Add a SECRET_KEY
  • Change the volumes: line so it points to your $dev/elabftw folder (for elabftw and mysql containers)
  • Start the containers:
./elabctl start

Note

PHP dependencies are managed through Composer. It’ll read the composer.lock file and install packages (see composer.json). Javascript dependencies are managed through Yarn. It’ll read the yarn.lock file and install packages (see package.json). The yarn install command will populate the node_modules directory, and the buildall command will use Webpack to create bundles (see builder.js file) and then Grunt to minify some CSS and JS files (see Gruntfile.js).

  • Now install the PHP and JavaScript dependencies using composer and yarn shipped with the container:
cd $dev/elabftw
# php dependencies (vendor/ directory)
docker exec -it elabftw composer install
# javascript dependencies (node_modules/ directory)
docker exec -it elabftw yarn install
docker exec -it elabftw yarn buildall
  • Now head to https://localhost:3148 once to let elabftw create the mysql tables
  • Enable debug mode to disable the caching of Twig templates
docker exec -it mysql bash
# you are now inside the mysql container
mysql -u$MYSQL_USER -p$MYSQL_PASSWORD $MYSQL_DATABASE
# you are now on the mysql command line
mysql> update config set conf_value = '1' where conf_name = 'debug';
exit;
exit
  • Now head to https://localhost:3148
  • You now should have a running local eLabFTW, and changes made to the code will be immediatly visible

Add export PATH=$PATH:$(pwd)/node_modules/.bin to your editor config file (.zshrc, .bashrc, …). This will allow you to run software installed in the node_modules folder.

Making a pull request

  1. Before working on a feature, it’s a good idea to open an issue first to discuss its implementation
  2. Create a branch from hypernext
  3. Work on a feature
  4. Make a pull request on GitHub to include it in hypernext
cd $dev/elabftw
# create your feature branch from the hypernext branch
git checkout -b my-feature
# modify the code, commit and push to your fork
# go to github.com and create a pull request

Code organization

  • Real accessible pages are in the web/ directory (experiments.php, database.php, login.php, etc…)
  • The rest is in app/ or src/ for PHP classes
  • src/models will contain classes with CRUD (Create, Read, Update, Destroy)
  • src/classes will contain services or utility classes
  • A new class will be loaded automagically thanks to the use of PSR-4 with composer (namespace Elabftw\Elabftw)
  • app/controllers will contain pages that send actions to models (like destroy something), and generally output json for an ajax request, or redirect the user.
  • Check out the scripts in src/tools too

Miscellaneous

  • if you make a change to the SQL stucture, you need to add a schema file in src/sql. See the existing files for an example. Then increment the required version in src/classes/Update. Modify src/sql/structure.sql and tests/_data/phpunit.sql if needed.
  • comment your code wisely
  • your code must follow the PSR standards
  • add a plugin to your editor to show trailing whitespaces in red
  • add a plugin to your editor to show PSR-1 errors
  • see editorconfig.org and configure your editor to follow the settings from .editorconfig
  • remove BOM
  • if you want to work on the documentation, clone the elabdoc repo
  • if you want to make backups of your dev install, you’ll need to edit elabctl.conf to point to the correct folders/config files. See example
  • in php camelCase; in html, dash separation for CSS stuff, camelCase for JS
  • check the commands in the “scripts” part of the package.json file, a lot of nice things in there ;)

Glossary

  • Experiments + Database items = Entities. So when you see Entity it means it can be an experiment or a database item

Build

The javascript and css files are stored unminified in the source code. But the app uses the minified versions, so if you make a change to the javascript or css files, you need to rebuild them. An alternative is to edit the template and load the “src” version instead of the “.min” one. This way you can edit and reload directly without having to compile each time.

  • To minify files:
# install the packages first
yarn install
yarn buildall

Other commands exist, see builder.js (webpack), the scripts part of package.json (yarn) and Gruntfile.js (grunt). If you just want to rebuild the CSS, use grunt css.

Tests

The tests run on the Codeception framework. The acceptance tests will need to download the Selenium + Chrome headless docker image.

$ yarn unit # will run the unit tests
$ yarn test # will run the unit and acceptance tests

For code coverage you need to enable the xdebug PHP extension and run yarn run coverage.

API Documentation

To get a good view of the relations between the classes, get phpDocumentor (download the .phar and the associated pubkey).

To generate a PHP Docblock documentation:

$ yarn srcdoc

Then, point your browser to the _srcdoc/index.html.

You can have a look at the errors report to check that you commented all new functions properly.

To generate the documentation for the API, you’ll need apidoc, install it first:

$ yarn install -g apidoc

Make sure the npm bin folder is in your $PATH.

$ yarn apidoc

Then, point your browser to the _apidoc/index.html.

Exceptions handling

Here are some ground rules for exceptions thrown in the code:

  • Code should not throw a generic Exception, but one of ElabftwExceptions
  • ImproperActionException when something forbidden happens but it’s not suspicious. Error is not logged, and message is shown to user
  • DatabaseErrorException when a SQL query failed, the error is logged and message is shown to user
  • IllegalActionException when something should not happen in normal conditions unless someone is poking around by editing the requests. Error is logged and generic permission error is shown
  • FilesystemErrorException, same as DatabaseErrorException but for file operations
  • For the rest, the error is logged and a generic error message is shown to user
  • Code should throw an Exception as soon as something goes wrong
  • Exceptions should not be catched in the code (models), only in the controllers
  • Instead of returning bool, functions should throw exception if something goes wrong. This removes the need to check for return value in consuming code (something often forgotten!)

Making a gif

  • make a capture with xvidcap, it outputs .xwd
  • convert .xwd to gif:
$ convert -define registry:temporary-path=/path/tmp -limit memory 2G \*.xwd out.gif
# or another way to do it, this will force to write all to disk
$ export MAGICK_TMPDIR=/path/to/disk/with/space
$ convert -limit memory 0 -limit map 0 \*.xwd out.gif
  • generate a palette with ffmpeg:
$ ffmpeg -i out.gif -vf fps=10,scale=600:-1:flags=lanczos,palettegen palette.png
  • make a lighter gif:
$ ffmpeg -i out.gif -i palette.png -filter_complex "fps=10,scale=320:-1:flags=lanczos[x];[x][1:v]paletteuse" out-final.gif
  • upload to original one to gfycat and the smaller one to imgur

Adding a lang

  • Add lang on poeditor.com
  • Get .po
  • Open with poeditor and fix issues
  • Save the .mo
  • Upload .po fixed to poeditor
  • Add the files in src/langs
  • Edit Tools to add lang to menu
  • Get the tinymce translation
  • Rename file to 4 letters code
  • Edit first line of file to match code

Accessing Docker MySQL database with phpmyadmin

You might be used to access your local MySQL dev database with PHPMyadmin. Here is how to do it with elabftw:

$ docker run -d -e PMA_PORT=3307 --link mysql:db -p 8080:80 phpmyadmin/phpmyadmin

This will launch a docker container with phpmyadmin that you can reach on port 8080. Go to localhost:8080. Login with your mysql user (elabftw by default) and your mysql password found in the .yml configuration file. You should see the elabftw database now.

Using a trusted certificate for local dev

When working locally, the docker image will generate a self-signed TLS certificate. This will show a warning in the browser address bar and multiple warnings in the console (when you press F12). To fix this, it is possible to generate certificates that are trusted by your local browser.

We’ll use FiloSottile/mkcert project to achieve this.

Step 1: use a real domain name

I like to use elab.local on port 3148. Edit /etc/hosts and add a line with elab.local pointing to localhost like this:

127.0.0.1 elab.local

Step 2: get certs

Install mkcert and generate certificates for elab.local. Create a new folder somewhere to hold them:

$ mkdir -p $dev/certs/live/elab.local
$ mv elab.local+3.pem $dev/certs/live/elab.local/fullchain.pem
$ mv elab.local+3-key.pem $dev/certs/live/elab.local/privkey.pem

Step 3: edit config to use certificates

Edit the .yml file for elabftw, change ENABLE_LETSENCRYPT to true. Uncomment the volume line with /ssl and make it point to where you have the certs.

Example:

volumes:
  - /home/user/.dev/elabftw:/elabftw
  - /home/user/.dev/certs:/ssl

Step 4: restart containers

elabctl restart, and you should now have a valid certificate on your local dev install of elabftw :)