The new Xajax is out, and the new Xajax is cool!

I started working on a recode of the Xajax library a few weeks ago, and today, I am pleased to present you with the new Xajax library.
The main goal was to use the latest PHP features to make the Xajax library extensible and modular.

So what is it about?

The new Xajax is modular and extensible

The library is now separated into two main packages.

The first package is the core PHP library https://github.com/lagdo/xajax-core.
It provides the main Xajax class, which is now named Xajax, and implements the functionalities needed to export PHP classes to javascript, and handle the Xajax requests and responses.

The second package contains the javascript files of the library https://github.com/lagdo/xajax-js.
Having a javascript only package will later allow to use an open source CDN like https://cdnjs.com/ or https://www.jsdelivr.com/ to deliver the files. By default, the Xajax core library gets the files from a server of mine, which offers HTTP and HTTPS access (thanks to Let’s Encrypt). Of course, they can also be installed on a private server.

This two packages are the minimum requirement to create an Xajax application, however the library can be extended with additional plugins.
I have created three plugins, which are used in the sample codes in the xajax-examples package https://github.com/lagdo/xajax-examples.

https://github.com/lagdo/xajax-toastr:
this package implements javascript notifications with the Toastr JQuery plugin https://github.com/CodeSeven/toastr.

https://github.com/lagdo/xajax-pgwjs:
this package implements responsive modal dialog with the PgwModal library http://pgwjs.com/pgwmodal/.

https://github.com/lagdo/xajax-bootstrap:
this package implements modal dialog with the Twitter Bootstrap library. It requires to manually load the Twitter Bootstrap javascript and CSS files to work properly.

What’s new is this package

First of all, the package is namespaced, uses PSR-4 autoloading, and installs with Composer.
Some features are deprecated, some others, like javascript code generation (see the examples below) are recoded, and some new features are added.

The new feature I consider the most important is the ability to automatically register all the classes in one or more directories, each directory being associated to a namespace or not.
When exporting PHP classes from a directory, the generated javascript classes are named accordingly. In a directory D, the class A in the file D/S/A.php will generate the javascript class S.A, and if the associated namespace is N, the generated javascript class will be N.S.A. As we’ll see in the examples below, the new Xajax library also takes advantage of PHP autoloading to optimize request processing.
This feature makes the Xajax library more suitable for use in modular applications with hundreds of classes.

Examples

Samples code demonstrating the use of the new Xajax library are provided in the xajax-examples package: https://github.com/lagdo/xajax-examples. All examples are based on the helloword.php example in the original Xajax repository https://github.com/Xajax/Xajax/blob/master/examples/helloworld.php. The installation process is described in the homepage of the repository. After the examples are installed, enter the name of any file in the browser to see the result.

– hello.php
This example shows how to export a function with Xajax.

– class.php
This example shows how to export a class with Xajax.

– merge.php
This example shows how to export the generated javascript code in an external file, which is then loaded into the webpage.
You’ll need to create the « deferred » directory, and adapt the parameter of the mergeJavascript() function to your webserver configuration for this example to work.
The compression of the generated javascript code is not yet implemented.

– plugins.php
The example shows the use of Xajax plugins, by adding javascript notifications and modal windows to the class.php example with the xajax-toastr, xajax-pgwjs and xajax-bootstrap packages.
Using an Xajax plugin is very simple. After a plugin is installed with Composer, its automatically registers into the Xajax core library. It can then be accessed both in the Xajax main object, for configuration, and in the Xajax response object, to provide additional functionalities to the application.

– classdirs.php
This example shows how to automatically register all the PHP classes in a set of directories.
The classes in this example are not namespaced, thus they all need to have different names, even if they are in different subdirs.

– namespaces.php
This example shows how to automatically register all the classes in a set of directories with namespaces.
The namespace is prepended to the generated javascript class names, and PHP classes in different subdirs can have the same name.

– autoload-default.php
This example shows how to optimize Xajax requests processing with autoloading.
In all the examples above, an instance of all exported Xajax classes is created when processing a request, while only an instance of the requested class is needed. In an application with a high number of classes, this can cause performance issues.
In this example, the Xajax classes are not registered when processing a request. However, the Xajax library is smart enough to detect that the required class is missing, and load only the necessary file.

– autoload-composer.php
This example illustrates the use of the Composer autoloader.
By default, the Xajax library implements a simple autoloading mechanism by require_once’ing the corresponding PHP file for each missing class. When provided with the Composer autoloader, the Xajax library registers all directories with a namespace into the PSR-4 autoloader, and it registers all the classes in directories with no namespace into the classmap autoloader.

– autoload-disabled.php
In this example the autoloading is disabled in the Xajax library.
The developer then needs to provides its own autoloading, otherwise the Xajax library will raise an error at any attempt to register classes from a directory.
This example will not work until the autoloading is setup.

What’s next?

This version of the package is still an early alpha release, not yet suitable for use in production.
There is still much work to do, and in my point of view the most important ones are:
– Check security, mainly for input data.
– Write tests.
– Write documentation and tutorials.

All ideas, all comments and any help are welcome.
The plugin interface is quite stable now, so anyone willing to write a plugin is encouraged to do so.

Thanks.

Coming soon: Maelys on Ubuntu

J’ai le plaisir d’annoncer la sortie prochaine de Maelys on Ubuntu (en abrégé MoU). MoU est un pack qui comprend le logiciel Maelys, son extension Doomedo, le tout dans un Linux Ubuntu préconfiguré avec quelques outils, dont un serveur web et un firewall. Il est disponible sous la forme d’un live CD installable, et d’une machine virtuelle. Dans la grande famille des Ubuntu-based OS, XUbuntu a été choisi pour sa légèreté.

mou1

mou2

L’objectif de MoU est de permettre aux cybercafés qui veulent tester la solution Maelys de le faire sans avoir à réaliser une installation complète, soit en démarrant une machine physique sur le live CD, soit en exécutant la machine virtuelle. Ceux qui veulent adopter la solution pourront par la suite installer définitivement MoU sur leur machine, et dans le cas où ils désirent conserver Windows, ils peuvent continuer à utiliser la machine virtuelle.

MoU est la solution que nous apportons à un problème récurrent, celui de l’adoption de Linux par les utilisateurs, qui ont généralement cette crainte, somme toute légitime, de l’inconnu. MoU doit leur montrer que Linux c’est facile à utiliser, et qu’il est possible de le personnaliser à sa guise.

Pour terminer, j’aimerais donner un grand coup de chapeau à Julius qui a assuré la réalisation technique de cet outil. Merci champion!

Maelys and Doomedo: what next?

Comme je le faisais remarquer dans le post précédent, il me semble que le moment est venu pour Maelys, surtout avec l’arrivée de Doomedo, de faire le bilan et de poser les bases pour passer une nouvelle étape. L’objectif étant de gérer tout le bazar de façon plus professionnelle, et aussi d’élargir les retombées des développements au délà de la simple satisfaction de faire un produit techniquement au point.

Avant d’aller plus loin, je voudrais revenir brièvement sur l’historique de Maelys. Au départ, en 2000-2001, il s’agit d’un défi technique d’un jeune diplômé qui veut comprendre, par la pratique, le cycle complet de développement d’un logiciel, de sa conception à sa distribution. Ensuite, lorsque les premiers utilisateurs commencent à faire des feedbacks, 2005-2006, l’aspect fonctionnel a pris le dessus. L’objectif est alors de faire un logiciel simple à installer et à utiliser, et qui s’adapte à des utilisateurs dont les besoins peuvent varier. Cet objectif a donné lieu à des choix tels que la transformation du module d’administration en application web, ou l’ajout d’un système d’extensions qui permet d’ajouter des fonctionnalités « à la carte ». À partir de fin 2008 enfin, il y a eu la dernière phase où l’objectif est de générer des revenus, même sans être forcément rentable (ce qui sera probablement l’objectif de la prochaine phase), avec notamment le service Doomedo.

Suite à ça donc, je me dis que Maelys, après avoir atteint une certaine maturité technique, doit maintenant s’attaquer à une nouvelle étape. Pour ça, il y a deux aspects sur lesquels je sais qu’il va falloir que je prenne des décisions, et je ne sais pas encore très bien lesquelles.

Il y a d’abord l’aspect communautaire. Maelys a bien un forum où ses utilisateurs interviennent de temps à autre, mais on ne peut pas dire que ceux-ci constituent réellement une communauté. C’est un peu chacun qui utilise Maelys dans son coin, et vient poser son problème quand il en rencontre un. En gros, il y a un manque de suivi et coordination. La grande question ici est de savoir comment faire pour créer une vraie communauté dans laquelle les utilisateurs se sentent réellement impliqués, et qui soit reconnue comme telle. Un corollaire doit être ajouté  à cette question, qui concerne en particulier les utilisateurs en Afrique, puisque c’est eux la première cible du logiciel.

Ensuite, il y a les aspects marketing et rentabilité qui je dois l’avouer n’ont jamais vraiment été sérieusement pris en compte. Pour poser la question avec des termes connus, je dirais simplement: quel modèle économique pour Maelys? Il y’en a bien sûr un qui se dégage avec Doomedo, mais pourrait-on en trouver d’autres? Quels avantages, risques et inconvénients? Comment faire de Maelys une marque?

A moins un…

Comme aurait dit le Prési, à moins un!

Nessa que l’autre jour, je me promène comme d’habitude sur le web (moteurs de recherche, forums, etc.) pour entendre un peu ce qui se dit de Maelys. Et là, je tombe sur cette annonce. Ainsi donc, il y a eu quelqu’un quelque part qui était prêt à débourser 500 euros pour se faire un installateur Linux pour Maelys. Il a dû bénir la philosophie du Libre, le mec, le jour où il est revenu sur le site de Maelys et c’est rendu compte que les fameux installateurs y étaient disponibles… gratuitement. 500 euros économisés, en ces temps de crise, c’est pas rien!