La roadmap de CiviKey : déjà une V2.5 ?

Le nom final du produit CVK a été trouvé et accepté lors d’une réunion des partenaires actuels : il s’agit de CiViKey (ou CiviKey ?). Compromis certes (l’historique est préservé) mais promesse d’une communication grand public facilitée.
 
C’est l’occasion pour moi de faire un petit point sur les aspects techniques : un état des lieux d’abord et un éclairage sur le futur ensuite.
 
Ce que l’on appelle aujourd’hui CiviKey a pour nom de code CVK-V2. A l’origine, ce projet n’était qu’un support de cours qui avait pour objectif :

  • D’effectuer une « Modélisation » en direct, « Les claviers » étant la réalité à modéliser.
    (Note : Le fait que des notions « irréelles », applicables uniquement à la modélisation était un aspect particulièrement intéressant n’a guère excité que moi… Solitude du pédagogue…
    Exercice : isoler ces aspects propres au modèle dans le code.)
  • De mettre en œuvre des collections, des accesseurs complexes, d’encapsuler, de sécuriser une API (au sens de limiter le développeur à des actions en accord avec la donnée), de couvrir autant de types de relations directs entre objets possibles (cycle de vie, attachement/détachement, unicité de nommage, multiplicité d’accesseurs), etc.
  • De réaliser une application graphique en .Net (un petit peu plus complexe que les applications scolaires traditionnelles).

Nous n’avons pas eu le temps, au moment où la décision a été prise d’utiliser cette base pour la V2, de revoir le noyau. De fait, la conception initiale du Contexte (Keyboard, Zone, Key, etc.) a couvert les besoins durant deux ans en supportant très correctement l’ajout des fonctionnalités : la gestion des plugins, des propriétés dynamiques (le Shared Dictionary), de la persistance, des éditeurs, etc.
 
Ayant relu attentivement le code dernièrement, j’ai néanmoins tiqué sur 2 aspects très discutables de l’implémentation actuelle car peu ou mal spécifié et réfléchis (ce qui est nettement plus grave J) que sont :

  1. la gestion des Modes du clavier (pour des raisons qui seraient un peu longue à détailler ici) ;
  2. le support du copier-coller, principalement car elle se contente d’utiliser « de l’extérieur » l’import/export xml original (destiné à la persistance) alors qu’il eut fallu une refonte/adaptation/extension de l’import afin de supporter naturellement le collage.

Nous avions par ailleurs pris la décision il y a quelques mois de masquer l’implémentation (absolument tous les objets d’implémentation) au profit d’un modèle public purement abstrait (constitué uniquement d’interfaces) et ce afin de maximiser les capacités d’évolutions du noyau. Ce travail de refactoring est un très classique processus de découplage que nous pensons nécessaire compte tenu des objectifs de pérennité de l’application.
 
Enfin, une évolution très importante en termes de fiabilité est actuellement en attente dans les cartons : la création dynamique de proxy d’interception des Services supportés par les Plugins qui ont pour objectifs :

  • d’isoler les plugins mal programmés (qui ne respectent pas les règles du jeu en terme d’appel des autres plugins ou d’émission d’événements selon l’état – Running/Stopped – des plugins) ;
  • de pouvoir éventuellement tracer tous les appels inter-plugins (idéalement, il est possible de décider des traces pour chaque méthode ou événements du système en cours d’exécution) ;
  • d’être une démonstration de la <pub>capacité de .Net à faire des trucs impressionnants et ce, tout bien pesé, assez facilement </pub>.

Le proxy (le modèle ainsi que la génération dynamique de code IL) est prêt. Il ne contient pas les fonctionnalités d’interception en tant que telle (et évidemment encore moins sa « configurabilité »). Il est maintenant nécessaire de l’intégrer et de fournir les objets proxy aux plugins plutôt que les objets Plugins eux-mêmes.

Regroupées, ces évolutions sont assez lourdes et nous avons donc décidé d’en faire une mile stone importante de release dans les prochains mois : CiviKey (CVK-V2) n’est pas encore (vraiment) sorti qu’une version 2.5 se profile déjà.

Le Nom de la Chose

Quel doit être le nom du CVK ?
Je ne sais pas. Il y a des gens autrement plus qualifiés que moi qui se posent la question. En attendant, on a besoin d’avancer et ce genre de détail a un impact sur le code.
Dans la version actuelle, un très grand nombre de classes sont préfixées par CVK (CVKContext par exemple). Nous avons décidé de supprimer ce préfixe.
Il reste cependant l’espace de nommage : CVK.Core, CVK.Model, etc.
Si le nom retenu finalement est Ubikey (par exemple ;-)), va-t-il falloir tout renommer en UBK ? Si oui, il faudra aussi renommer les répertoires du système de fichier (il serait très désagréable de travailler avec un tel décalage).
 
Non seulement cela demande quelques heures de travail, mais renommer des répertoires proche de la racine « casse » assez violemment le dépôt de code source sous Subversion (notamment la consultation de l’historique). (Oui, je sais, normalement cela fonctionne très bien le renommage dans SVN… J’ai néanmoins eu des très mauvaises expériences.)
 
Parallèlement à cela, en essayant de faire passer FxCop sur les sources, cette règle est apparue :
 
 Resolution   : "Correct the casing of 'CVK' in assembly name 'CVK.SharedDic.dll'
                 by changing it to 'Cvk'."
 Help         : http://msdn2.microsoft.com/library/ms182240(VS.90).aspx  (String)
 RuleFile     : Naming Rules  (String)
 Info         : "Type, namespace, and member identifiers are Pascal-cased.
                 Parameter identifiers are camel-cased. Two letter acronyms
                 within these identifiers should be upper-cased, for
                 example, use System.IO instead of System.Io. Acronyms
                 of three or more letters should be Pascal-cased, for
                 example, use System.Xml instead of System.XML. The
                 pascal-casing convention capitalizes the first letter
                 of each word, as in BackColor. The camel-casing convention
                 formats the first letter of the first word in lowercase
                 and capitalizes the first letter of all subsequent
                 words, as in backgroundColor. Although it may be common
                 practice for some two letter acronyms to not be fully
                 capitalized, violations of this rule should not be
                 excluded for this reason. For example, 'DbConnection',
                 is common but incorrect; use DBConnection. A violation
                 of this rule might be required for compatibility with
                 existing, non-managed symbol schemes. In general, however,
                 these symbols should not be visible outside the assembly
                 that uses them."

 
En substance, il faut renommer CVK en Cvk pour être parfaitement en ligne avec les règles de nommage… Ou alors, si l’on souhaite conserver les majuscules, il faut retirer une lettre…
 
Du coup, j’ai décidé de nommer (une bonne fois pour toute je l’espère) l’objet technique qu’est ce Custom Keyboard en… Custom Keyboard. Ce qui nous fait un assez satisfaisant (de mon point de vue) espace de nommage (et préfixe éventuel) CK.
 
Pour conclure, il est clair que CK : « C’est le Kode ! »
Cela ne présage nullement de la dénomination officielle du produit. Mais au moins, on peut bosser.

La licence de CiviKey

Un petit mot au sujet de la licence de CiviKey. Il s’agit d’une L-GPL. Qu’est-ce donc exactement ? Que pouvez-vous faire réellement avec les codes sources, les binaires (librairies dynamiques compilées et exécutables) ?

1. Un résumé

Ci-dessous un descriptif de licence type trouvé sur internet (http://dbaling.blogspot.com/2009/02/find-missing-index.html), comme on peut en trouver beaucoup, mais avec en sus une explication claire et concise (mise en gras ci-dessous).
Il s’agit d’une licence associée à une procédure stockée, d’où la référence à une base de données.

Copyright:
Licensed under the L-GPL - a weak copyleft license - you are permitted to use this as a component of a proprietary database and call this from proprietary software.
Copyleft lets you do anything you want except plagiarize, conceal the source, proprietarize modifications, or prohibit copying & re-distribution of this script/proc.
This program is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Lesser General Public License for more details.
see <http://www.fsf.org/licensing/licenses/lgpl.html> for the license text.

Je considère cet « extrême résumé » comme plutôt bien fait et vais donc en profiter pour le traduire et le commenter dans le cadre de CiviKey.

2. La notion de « copyleft licence »

Voir wikipedia pour le terme de copyleft. En résumé c’est un jeu de mot sur l’opposition à copyright (droit d’auteur) dont le principe est le suivant
« Je suis l’auteur de ce code. J’ai fixé des limites (ou pas) à ce que vous pouvez faire de ce code via une licence. Vous pouvez faire ce que vous voulez de mon code (dans les limites de la licence : le vendre, le distribuer gracieusement, le modifier, etc.), mais en aucun cas vous ne pouvez restreindre les libertés garanties par cette licence. »
 
Pour faire encore plus simpl(ist ?)e : la notion de Copyleft permet à un auteur gentil de mettre à disposition son œuvre en ayant la garantie qu’aucun business man méchant ne s’accapare son travail et dénie à autrui ce que l’auteur gentil l’avait gentiment autorisé à faire.
 
Ça, c’est le Copyleft en général. On en distingue deux catégories très différentes en pratique : le faible (weak) et le fort (strong).

2.1    Strong Copyleft

Toujours de façon très synthétique : le Copyleft « fort » impose à toute utilisation de l’œuvre d’être redistribuée sous la même licence, là où le « faible » n’impose sa licence que pour certaines utilisations qui touchent à l’intégrité de l’œuvre elle-même : principalement la modification ou la traduction.
 
Le Copyleft fort est souvent qualifié de « virale » : tout programme qui utilise un composant avec ce type de licence devient de facto, et dans son intégralité, soumis à cette licence. La licence GPL est de ce type et l’enjeu devient alors de distinguer les utilisations qui imposent la licence de celles qui ne l’imposent pas.
Ici, on entre dans des détails techniques auxquels d’une part les juristes ne comprennent pas grand-chose (à l’instar de certains « informaticiens » d’ailleurs) et d’autre part qui évoluent avec les technologies : liens statiques ou dynamiques, encapsulation d’un exécutable, utilisation de la spécialisation (héritage), etc.
En résumé : l’objectif d’un Copyleft fort est de dire aux autres informaticiens « Mon composant vous plaît ? Si vous l’utilisez, vous devez jouer le jeu de l’Open Source comme moi ! Sinon, débrouillez vous autrement. »

2.2 Weak Copyleft

Ce n’est pas le cas de CiviKey qui est en L-GPL. « L » pour « Lesser », c'est-à-dire plus faible. Elle est plus faible dans le sens où elle permet l’utilisation du composant logiciel sans imposer sa licence : le coté « viral » a disparu.

3. La licence de CiviKey : L-GPL

Alors que reste-t-il comme contraintes à respecter ? Très peu.

you are permitted to use this as a component of a proprietary application and call this from proprietary software.

Vous pouvez utiliser CiviKey dans une application spécifique et propriétaire (dont vous ne divulguez pas les sources) et la commercialiser, développer des plugins propriétaires (dont vous ne divulguez toujours pas les sources) et les commercialiser conjointement ou non avec leur propre licence que vous choisissez comme bon vous semble.

Copyleft lets you do anything you want except plagiarize, conceal the source, proprietarize modifications, or prohibit copying & re-distribution of this script/proc.

Vous ne pouvez pas :

  • Plagier CiviKey, c'est-à-dire copier tout ou partie du code source en l’intégrant à votre programme.
  • Dissimuler l’origine : c'est-à-dire distribuer CiviKey ou une application qui l'utilise sans dire clairement à vos utilisateurs, collègues, patrons ou investisseurs que vous l'utilisez.
  • Garder les modifications pour vous : c'est-à-dire faire évoluer CivKey lui-même (le noyau) sans remettre vos modifications dans le « pot commun » et rendre ces modifications visibles à toute personne qui le demande.
  • Interdire la copie ou la redistribution : ce n’est pas parce que votre application ou plugin propriétaire ne peut être copié ou redistribué que ces interdictions s’appliquent aux composants de CiviKey eux-mêmes.

En substance, vous pouvez utiliser les composants exécutables ou librairies dynamiques comme bon vous semble. Si vous modifiez les sources, vos modifications sont de facto sous licence L-GPL. A ce titre, nous apprécierons que vous les soumettiez à la communauté afin de faire progresser le projet.
Enfin, si vous « récupérez » un ou plusieurs fichiers, une classe ou un morceau de framework et que vous l’intégrer directement dans votre application (que celle-ci soit une librairie dynamique ou un exécutable), vous devez conserver l’entête du ou des fichiers, ne pas modifier leur contenu (sauf à publier ses modifications) et surtout, afficher le fait que votre application repose, en partie, sur un « morceau » de CiviKey.

Il n’y a donc finalement que quatre écueils à éviter qui ont pour nom : Plagiat, Dissimulation, Privatisation et Restriction.
Si vous échouez sur un de ces écueils, vous vous asseyez tranquillement sur notre travail. Ce ne serait pas gentil.