WikiBR - Contributions [fr]

Passation 2k7-2k8

2009-11-25T16:58:47Z

Fruneau :

Repas de passation 2k7-2k8, qui aura lieu mercredi 25 novembre à 20h30 au Pastapapa : 6 rue Daunou

* 2008
** [[Utilisateur:Feandil|Fëandil]] : 42
** [[Utilisateur:Riton|Riton]] : présent (arf, la veille de la pâle Finky)
** [[Utilisateur:Paulo|Paulo]] : présent (stoi Finky)
** [[Utilisateur:Karlos|Karlos]] : président :D
** [[Utilisateur:Qt|Qt]] : présent
** [[Utilisateur:Wilyo|Wilyo]] : présent
** [[Utilisateur:Pj|Pj]] : présent
** [[Utilisateur:Brice|Brice]] : présent
** [[Utilisateur:whiteknight|Jean]] : présent
** Lad : absent
** Anna : présente
* 2007
** [[Utilisateur:j-philippe|j-philippe]] : présent
** [[Utilisateur:fulanor|fulanor]] : présent
** [[Utilisateur:rogertroutman|rogertroutman]] : présent
** [[Utilisateur:Nathaniel|Nathaniel]] : présent
** [[Utilisateur:Sigma|Sigma]] : présent
** [[Utilisateur:Simon|Simon]] : présent, comme sa soeur
** [[Utilisateur:Totor|Totor]] : présent
** [[Utilisateur:Kithyane|Kithyane]] : présente
** [[Utilisateur:Mikado|Mikado]] : présent
** [[Utilisateur:Boris|Boris]] : présent

* 2006
** [[Utilisateur:Xelnor|Xelnor]] : sys.stdout.write("Présent\n")
** [[Utilisateur:insane0|insane0]] : bite (ça veut dire présent dans le langage des couilles)
** [[Utilisateur:Xav|xavier]] : stoi la bite
** [[Utilisateur:Claire|Claire]] : présenTE
** [[Utilisateur:Patrick|Patrick]] : absent... vous croyez qu'un jour le BR ne fera pas ses réunions/passation les soirs de chorale ? ;)
** [[Utilisateur:Zuzuf|Zuzuf]] : std::cout << Morse::parse("-.---.---.-...-.---.-...-...-.-.-...-...---.-...---").toString() << std::endl; return true;
** [[Utilisateur:eracil|eracil]] : présent

* 2005
** [[Utilisateur:renard|milou]] : BITE. peux pas, ou alors seulement l'after et encore c'est pas sûr <- peux pas, je suis à Marseille
** [[Utilisateur:Drynn|Drynn]] : toujours présent sur les brs
** [[Utilisateur:Gartrog|Gartrog]] : présent
** [[Utilisateur:Elscouta|Elscouta]] : présent (même sur irc!)
** [[Utilisateur:Jp|Jp]] : présent, mais rappelez moi à la semaine quand même :p
** [[Utilisateur:Henri|Henri]] : présent virtuellement cause #loin
** [[Utilisateur:Schientos|Schientos]] : présent en esprit cause #province

* 2004
** jacou : présent
** [[Utilisateur:Gui|GUI]] : pong
** [[Utilisateur:bernardofpc|bernardofpc]] présent
** pilki : présent
** [[Utilisateur:Laure|Laure]] : ''peut-être'', ça dépend de Bébé
** [[Utilisateur:Wilhem|Wilhem]] : présent, et accompagné par [[User:Xikh|Xikh]] (2005)
** [[Utilisateur:Sean|Sean]] présent

* 2003
** [[Utilisateur:mYk|mYk]] présent
** [[Utilisateur:NC|NC]] présent

* 2002

* o< 2002 ?

Passation 2k7-2k8

2009-11-12T13:57:55Z

Fruneau :

Repas de passation 2k7-2k8, qui aura lieu mercredi 25 novembre au soir !
Si vous avez des suggestions de lieu, c'est ici ! <br/>
* [[Utilisateur:fulanor|fulanor]] : 77 rue Mouffetard, resto argentin pour manger de la VIANDE (c'est la force)
* [[Utilisateur:insane0|insane0]] : Pour pas que fufu soit le seul à proposer, j'offre deux options. À côté de la station Cluny - La Sorbonne, il y a un MacDo et un vendeur de panini. Voilà.
* [[Utilisateur:Kithyane|Kithyane]] : insane0, tu sers à rien
* [[Utilisateur:Nathaniel|Nathaniel]] : Y a un restaurant italien plutôt bon du côté de Opéra, il me semble que c'est le pastapapa, 6 rue Daunou

* 2008
** [[Utilisateur:Riton|Riton]] : présent (arf, la veille de la pâle Finky)
** [[Utilisateur:Paulo|Paulo]] : présent (stoi Finky)
** [[Utilisateur:Karlos|Karlos]] : président :D
** [[Utilisateur:Qt|Qt]] : présent
** [[Utilisateur:Wilyo|Wilyo]] : présent
** [[Utilisateur:Pj|Pj]] : présent
** [[Utilisateur:Brice|Brice]] : présent
* 2007
** [[Utilisateur:j-philippe|j-philippe]] : présent
** [[Utilisateur:fulanor|fulanor]] : présent
** [[Utilisateur:rogertroutman|rogertroutman]] : présent
** [[Utilisateur:Nathaniel|Nathaniel]] : présent
** [[Utilisateur:Sigma|Sigma]] : présent
** [[Utilisateur:Simon|Simon]] : présent, comme ta soeur
** [[Utilisateur:Kithyane|Kithyane]] : présente

* 2006
** [[Utilisateur:Xelnor|Xelnor]] : sys.stdout.write("Présent\n")
** [[Utilisateur:insane0|insane0]] : bite (ça veut dire présent dans le langage des couilles)
** [[Utilisateur:Xav|xavier]] : stoi la bite
** [[Utilisateur:Claire|Claire]] : présenTE
** [[Utilisateur:Patrick|Patrick]] : absent... vous croyez qu'un jour le BR ne fera pas ses réunions/passation les soirs de chorale ? ;)
** [[Utilisateur:Zuzuf|Zuzuf]] : std::cout << Morse::parse("-.---.---.-...-.---.-...-...-.-.-...-...---.-...---").toString() << std::endl; return true;
** [[Utilisateur:eracil|eracil]] : présent

* 2005
** [[Utilisateur:renard|milou]] : BITE. peux pas, ou alors seulement l'after et encore c'est pas sûr <- peux pas, je suis à Marseille
** [[Utilisateur:Drynn|Drynn]] : toujours présent sur les brs
** [[Utilisateur:Gartrog|Gartrog]] : présent
** [[Utilisateur:Elscouta|Elscouta]] : présent (même sur irc!)
** [[Utilisateur:Jp|Jp]] : présent, mais rappelez moi à la semaine quand même :p

* 2004
** jacou : présent
** [[Utilisateur:Gui|GUI]] : pong
** [[Utilisateur:bernardofpc|bernardofpc]] présent
** pilki : présent

* 2003
** [[Utilisateur:mYk|mYk]] présent
** [[Utilisateur:NC|NC]] présent
** [[Utilisateur:Fruneau|Fruneau]] je ne saurai que le jour même.

* 2002

* o< 2002 ?

Passation 2k7-2k8

2009-10-05T11:37:11Z

Fruneau :

Marquez ici vos '''in'''disponibilités pour le repas de passation 2k7-2k8, qui aura globalement lieu fin novembre...

* 2007
** [[Utilisateur:j-philippe|j-philippe]] : vendredi 27/11

* 2008
** [[Utilisateur:Qt|Qt]] : Ø
** [[Utilisateur:Feandil|Fëandil]] : Ø
** [[Utilisateur:Brice|Brice]] : Ø

* 2003
** [[Utilisateur:NC|NC]] : 24/11
** [[Utilisateur:Fruneau|Fruneau]] : .* (a priori je ne pourrais pas venir, on verra le moment venu si c'est vraiment le cas)

Discussion:Passation 2k6-2k7

2008-11-10T19:25:19Z

Fruneau :

Et donc, on discute ici pour choisir le restaurant !

* <[[User:Fruneau|Fruneau]]> Pas le bistrot romain, c'était très décevant y'a 2 ans. Il Fiorentino est un peu petit, et ne sera pas adapté pour plus d'une vingtaine de personne. Pas d'autres avis :)

* <[[User:Sheik|Shk]]> Moyennement pong grec, antillais, ... +1 à Fruneau pour Bistro Romain, c'était d'ailleurs pareil il y a 3 ans à l'hippopotamus de mémoire

* <[[User:Jp|JP]]> +1 contre le bistrot romain (pas de place pour tous ensemble...). Sinon je prefère pas de poisson, mais je peux toujours m'arranger... Je connais pas les cuisines greques et antillaise, mais pourquoi pas (tant que l'antillaise soit pas que du poisson :P).

* <[[User:Gartrog|Gtg]]> [HS] Pan NC ! [/HS] Je suis contre le resto romain également. Je crois que la crêperie de Cluny serait trop petite (à vérifier). On peut rajouter à la liste le Pot de (Fer||Terre) (?), passation Faërix de l'an dernier, qui peut être assez adapté pour le nombre que l'on sera.

* <[[User:Fruneau|Fruneau]]> D'après mes collègues VIAmen, le Flam's de Montparnasse est meilleur et plus accueillant que celui de Châtelet (serveur plus sympathique, service vraiment "à volonté", salle plus conviviale...)

Discussion:Passation 2k6-2k7

2008-11-06T09:37:20Z

Fruneau :

Discussion:Passation 2k6-2k7

2008-11-06T09:36:50Z

Fruneau :

Et donc, on discute ici pour choisir le restaurant !

* Pas le bistrot romain, c'était très décevant y'a 2 ans. Il Fiorentino est un peu petit, et ne sera pas adapté pour plus d'une vingtaine de personne. Pas d'autres avis :)

Passation 2k6-2k7

2008-11-06T07:03:56Z

Fruneau : /* BR03 */

Le repas de passation BR2k6-BR2k7 aura lieu le mardi 25 novembre.

Comme l'an dernier, il suffit de ponguer dans la case adéquate ; on peut ajouter des idées de restaurant en fin de page, mais le choix se fera sur la page de [[Discuter:Passation|Discussion]].

=Qui sera là ?=
==BR93==
==BR97==
==BR98==
==BR99==
==BR00==
==BR01==
==BR02==
==BR03==

[[User:Fruneau|Fruneau]]

==BR04==

[[Utilisateur:Alakazam|Alakazam]]

==BR05==

[[Utilisateur:renard|renard]]

==BR06==
==BR07==

[[Utilisateur:Nathaniel|Nathaniel]]

[[Utilisateur:Shuba|Shuba]]

== Amis du BR ==
=Choix du restaurant=

* Hippopotamus
* Bistrot romain
* Un [http://www.restoaparis.com/avis-restaurant-paris/75005-7723-39 Moment Gourmand], cuisine antillaise,
* La [http://www.casa-valentino.com/carte.htm Casa Valentino,Italien] "loungeux", ambiance feutrée,
* Le [http://www.fra.cityvox.fr/restaurants_paris/le-gourmand_93274/Avis-Lieu Gourmand], grec, récent, un menu 22 euros jusqu'à 36 euros
* [http://www.linternaute.com/restaurant/restaurant/17421/le-vin-qui-danse.html Le vin qui danse], restaurant bar à vins, 15-30 euros
* [http://www.lesrestos.com/fiche~local~PARIS~No~1273506093~Memory~%7C%7C%7C%7C%7C%7C%7CNom%7CASC%7C0%7C%7C%7C%7C%7C4052%7C750.htm Il Fiorentino], Italien que les vieux du CA connaissent bien, prix très corrects
* Les Bugnes / Sud Ouest / rue du Pot de Fer
* La Brouette, 41 r Descartes (derrière H IV), fondue ou pierrade, Pas raffiné mais convivial
* la bogeda tapas / cuisine espagnole
* la [http://www.linternaute.com/restaurant/restaurant/245/la-grange-saint-michel.html grange], Savoyard, 15-30 euros
* la creperie de cluny, (déjà fait y'a longtemps)
* "Chez Papa", près de Denfert donc facile d'accès, cuisine du sud ouest, en qualité et surtout en quantité ! Petits mangeurs, s'abstenir (ou pas). Prix abordables, de 20 euros à no-limit.

Discussion:Passation 2k6-2k7

2007-11-15T20:36:20Z

Fruneau :

Faut que quelqu'un commence quand meme :P

JP: Moi je suis bien chaud pour un italien, et "La Casa Valentino" avait un air plus intéressant à mon avis, donc voilà mon vote :P

Gartrog: Par les temps qui courent le savoyard me tente pas mal. Sinon le vin qui danse a pas l'air mal non plus.

Fruneau : La Brouette c'est pas mal, on mange bien... Il Fiorentino est sans doute trop petit à mon avis. Les autres je ne les connais pas

En plus ce qui est bien à la brouette c'est qu'on peut envisager d'avoir une grand table et non pas plein de petites tables, ce qui permet souvent de discuter avec plus de monde. Les deux dernières passations c'était uniquement des petites tables et j'ai trouvé ça moins bien qu'il y a 3 ans où on avait 2 grandes tables pour toute le monde. (just my 2 cents)

Discussion:Passation 2k6-2k7

2007-11-15T20:30:15Z

Fruneau :

Passation 2k6-2k7

2007-11-14T23:33:55Z

Fruneau : /* Choix du restaurant */ Juste pour rendre la page un peu plus lisible

Le repas de passation BR2k5-BR2k6 aura lieu le mercredi 28 novembre. Lieu: Paris, resto: à déterminer (voir plus bas)

=Qui sera là ?=
==BR 93==
==BR97==
==BR98==
==BR99==
==BR00==
==BR01==
==BR02==
==BR03==

* [[User:Fruneau|Fruneau]]
* [[User:NC|NC]] (a priori aussi) (PAN pan pan !)

==BR04==
* [[User:Alakazam|Alakazam]]
* [[User:Sheik|Sheik]] (a priori) (\_o< o< o< !)
* [[User:VinZ2|vinZ2]]
* [[User:Gui|GUI]]
* [[User:Sean|Sean]] (A confirmer..)

==BR05==
[[User:Gartrog|Gartrog]]

==BR06==

=Choix du restaurant=

* Hippopotamus
* Bistrot romain
* Un [http://www.restoaparis.com/avis-restaurant-paris/75005-7723-39 Moment Gourmand], cuisine antillaise,
* La [http://www.casa-valentino.com/carte.htm Casa Valentino,Italien] "loungeux", ambiance feutrée,
* Le [http://www.fra.cityvox.fr/restaurants_paris/le-gourmand_93274/Avis-Lieu Gourmand], grec, récent, un menu 22 euros jusqu'à 36 euros
* [http://www.linternaute.com/restaurant/restaurant/17421/le-vin-qui-danse.html Le vin qui danse], restaurant bar à vins, 15-30 euros
* [http://www.lesrestos.com/fiche~local~PARIS~No~1273506093~Memory~%7C%7C%7C%7C%7C%7C%7CNom%7CASC%7C0%7C%7C%7C%7C%7C4052%7C750.htm Il Fiorentino], Italien que les vieux du CA connaissent bien, prix très corrects
* Les Bugnes / Sud Ouest / rue du Pot de Fer
* La Brouette, 41 r Descartes (derrière H IV), fondue ou pierrade, Pas raffiné mais convivial
* la bogeda tapas / cuisine espagnole
* la [http://www.linternaute.com/restaurant/restaurant/245/la-grange-saint-michel.html grange], Savoyard, 15-30 euros
* la creperie de cluny, (déjà fait y'a longtemps)

Passation 2k6-2k7

2007-11-14T22:57:52Z

Fruneau : /* BR03 */

Le repas de passation BR2k5-BR2k6 aura lieu le mercredi 28 novembre. Lieu: Paris, resto: à déterminer (voir plus bas)

=Qui sera là ?=
==BR 93==
==BR97==
==BR98==
==BR99==
==BR00==
==BR01==
==BR02==
==BR03==

[[User:Fruneau|Fruneau]]

==BR04==
* [[User:Alakazam|Alakazam]]
* [[User:VinZ2|vinZ2 (Vincent Zanotti)]]

==BR05==
==BR06==

=Choix du restaurant=

Hippopotamus

Bistrot romain

Un Moment Gourmand, cuisine antillaise, http://www.restoaparis.com/avis-restaurant-paris/75005-7723-39

La Casa Valentino,Italien "loungeux", ambiance feutrée, http://www.casa-valentino.com/carte.htm

Le Gourmand, grec, récent, http://www.fra.cityvox.fr/restaurants_paris/le-gourmand_93274/Avis-Lieu, un menu 22 euros jusqu'à 36 euros

Le vin qui danse, restaurant bar à vins, http://www.linternaute.com/restaurant/restaurant/17421/le-vin-qui-danse.html, 15-30 euros

Il Fiorentino, Italien que les vieux du CA connaissent bien, http://www.lesrestos.com/fiche~local~PARIS~No~1273506093~Memory~%7C%7C%7C%7C%7C%7C%7CNom%7CASC%7C0%7C%7C%7C%7C%7C4052%7C750.htm, prix très corrects

Les Bugnes / Sud Ouest / rue du Pot de Fer

La Brouette, 41 r Descartes (derrière H IV), fondue ou pierrade, Pas raffiné mais convivial

la bogeda tapas / cuisine espagnole

la grange, Savoyard, http://www.linternaute.com/restaurant/restaurant/245/la-grange-saint-michel.html, 15-30 euros

la creperie de cluny, (déjà fait y'a longtemps)

QRezix

2007-09-20T12:47:03Z

Fruneau : qRezix 2.1.0 est sorti depuis quelques temps maintenant...

{{menu projets}}
qRezix est le principal client [[xNet]] encore maintenu. Il doit sa survie à sa qualité d'être le seul client développé qui soit multiplateforme tout en restant graphiquement potable. Il doit ces deux qualités à la bibliothèque [[Qt]].

== Historique ==

=== BR2000 ===

Le projet en lui-même est né avec un groupe de BRmen X2000 menés par Doudou qui étaient fans de Qt (qui à l'époque n'était pas terrible-terrible...). Ils ont travaillé à 3 ou 4 pour sortir la version 1.0 le 4 mars 2002, suivie de près par la version 1.1 le 6 avril. L'équipe de développement comportait entre autres Doudou, MadCoder et Trasfract (Sylvain Joyeux, Pierre Habouzit et Benoït Casoetto).

Le projet s'est principalement inspiré des clients qui existaient déjà à l'époque (Rezix en particulier, duquel qRezix a tiré son nom). Cette architecture simple est une fenêtre avec une liste de client chaque entrée indiquant le nom, la promo, les serveurs... Les favoris sont affichés en premier selon le choix de l'utilisateur.

=== BR2001 ===

Le BR2001 n'a pas énormément travaillé sur qRezix. Il y a eu la version 1.2, mais on n'a aucune trace de ce que JiBee a bien pu faire sur le projet. Ce qui est certain, c'est qu'après la vesion 1.2, il a porté qRezix en Qt3 et a travaillé sur l'internationalisation du projet. Le but d'origine n'était pas de rendre qRezix international, mais simplement de résoudre les problèmes d'encodage des caractères accentués. Le code source a donc totalement été traduit en anglais et une traduction française a été créée.

[[Image:qrezix-1.2.gif|center]]

A priori, il n'y a pas eu de release en Qt3... mais d'après [[User:Ey|Ey]] qui packageait le projet pour Windows, il y en aurait eu... Mais en tout cas à l'arrivée des 2003 c'était toujours la version 1.2 (en Qt2) qui était disponible... Le BR n'avait de plus pas de license pour Qt3 sous Windows.

=== BR2002 ===

Le projet était géré par Steak. La version 1.3 a été release le 1 mai 2004. Cette version n'était absolument par révolutionnaire mais apportait quelques améliorations dans la structure du code et des amélioration du comportement du programme.

Steak a ensuite travaillé sur la version 1.3.666 et en particulier sur l'authentification avec le serveur. Mais il a vite arrêter de travailler sur qRezix en raison du temps qu'il consacrait à l'étude du japonnais, et à différents problèmes occulaires. Cependant, le [[BR2002]] a réalisé une prépassation très avancée ce qui fait que dès le mois de juin, la relève était en place...

=== BR2002/BR2003 : le temps d'une prépassation ===

Le [[BR2003]] a donc commencé sont travail sur qRezix dès le mois de juin 2004.

La première chose a été de recompiler une version pour Windows, ce qui n'avait plus été fait depuis près d'un an. Ceci permettait donc d'envisager de futures release du programme pas uniquement sous Linux. Le travail s'est finalement concentré pendant les vacances d'été avec une amélioration importante de l'interface et de la structure interne (début de séparation de la gestion des connexions de l'affichage), la création d'une structure (pas terrible) de chargement de plug-ins, l'ajout d'icône pour rendre l'interface plus conviviale... La version a été tagguée tour à tour 1.3.666 puis 1.5.

Une autre innovation importante a été le passage du chat qui reposait sur un protocole en UDP vers un protocole TCP. Le but déclaré du BR2002 étant de rendre les communications fiables et sécurisées (on veut savoir si l'autre ne reçoit pas nos messages).

Toutes ces modifications associées au travail de Steak sur l'authentification et le travail de JiBee pour recoder un nouveau [[xNetServer|serveur xNet]], on conduit à la version 1.6 de qRezix qui est sorti le 14 octobre 2004 à la fois pour Windows, Linux et Mac OS X.

[[Image:qrezix-1.6.png|center]]

Face à qRezix 1.6.0 est apparu Rezix.NET qui se voulait innovant. Conséquence de ceci, on a travaillé à 2 avec Steak pour implémenter dans qRezix toutes les fonctionnalité des Rezix.NET. Ce qui a rapidement conduit à la sortie de qRezix 1.6.1 le 22 novembre 2004. C'était la dernière version sur laquelle ait travailler Steak. Rezix.NET (qui était codé en .NET par un membre dissidant du BR2002) n'a finalement pas fait long feu.

=== BR2003 ===

La suite a été plus calme. La préparation de qRezix 1.6.2 s'est faite tranquillement, l'objectif principal était de supprimer un maximum de bugs de cette future version. Les innovations n'ont pas été nombreuses, mais on pourra noter la completion du nick dans le chat avec tab et la recherche intelligente via clavier. Cette version a vu le retour de Ey parmi les développeurs. Elle a aussi été la seule version à bénéficier d'une sortie ayant été précédée de 2 release-candidates qui ont aidées à corriger plusieurs bugs supplémentaires. La version a finalement été sortie le 22 mars 2005.

Le problème de cette version est qu'elle a introduit un bug... enfin plutôt révélé un bug. Jusqu'à présent qRezix plantait en l'absence de réseau ce qui a été corrigé avec la 1.6.2. Mais ce que je n'avais pas remarqué à l'époque c'était qu'en l'absence de réseau qRezix raffraichissait la fenêtre toutes les secondes et en même temps changeait le thême d'icône. Conséquence directe de ce défaut, qRezix prenait 100% du processeur en l'absence de réseau, ce que j'ai eu la chance de constater lors de ma soutenance de modex... Il fallait donc sortir un version avant l'arrivée des 2004 pour éviter que ce bug ne pose trop de problème aux 2004 qui allaient passer leur soutenance de stage. C'est pour ça qu'est sortie la verson 1.6.3 le 1 mai 2005. Cette version innovait au passage une nouvelle organisation plus agréable des propriétés et peut-être globalement considérée comme stable. La version 1.6.4 sortie le 23 septembre apporte peu d'innovation si ce n'est la cache des propriétés, les icônes en 32bits et une meilleure intégration à Mac OS.

Suite à la sortie de Qt4, le port de qRezix vers cette nouvelle mouture de la bibliothèque de Trolltech a été l'occasion de grand remaniement du code. Le développement du port de qRezix en Qt4 a commencé en mai-juin 2005, en parallèle de la finalisation de la branche 1.6 avec la préparation de qRezix 1.6.4. Le port en Qt4, tout d'abord appelé 1.7, a rapidement évolué. Les vacances d'été ont été l'occasion de préparer une restructuration du programme. La suite de développement a principalement consisté à créer ou améliorer les différents modules. Ceci a abouti à la versin 2.0 de qRezix dont le principal atout est d'être modulaire. La version 2.0.0 est sortie le 6 février 2006, et a rapidement supplanté la version 1.6.x.

La première version de maintenance de qRezix 2 est sortie avant l'arrivée des 2005 sur le plateau et mettait en particuliers à jour les correspondance IP <-> Casert.

[[Image:qrezix-2.0.png|800px|center]]

<div style="border: 1px solid #6f8f9f; padding: .2em .5em .2em .5em; background-color: #EAF5FB">
Pour écrire cette partie, j'ai utilisé mes connaissances personnelles issues ainsi que les informations contenues dans le ChangeLog. Et j'espère bien que d'autres y jetteront un coup d'oeil pour compléter/corriger les parties inexactes.
</div>

=== Versions ===

Voici un description des différentes versions de qRezix. Pour des informations exhaustive, il faut se reporter au ChangeLog du projet.

<table style="border: 1px solid #6f8f9f; width: 100%">
<tr style="padding: .2em .5em .2em .5em; background-color: #EAF5FB">
<th>'''Version'''</th><th>'''Date'''</th><th>'''Changements'''</th>
</tr>
<tr><td>v0.1</td><td>30 janvier 2002</td><td></td></tr>
<tr style="background-color: #FAF5FF;"><td>v0.2</td><td>20 février 2002</td><td></td></tr>
<tr><td>v0.3</td><td>25 février 2002</td><td></td></tr>
<tr style="background-color: #FAF5FF;"><td>'''v1.0'''</td><td>4 mars 2002</td><td></td></tr>
<tr><td>v1.1</td><td>6 avril 2002</td><td></td></tr>
<tr style="background-color: #FAF5FF;"><td>v1.2</td><td>2003</td><td></td></tr>
<tr><td>v1.3</td><td>1er mai 2004</td><td></td></tr>
<tr style="background-color: #FAF5FF;"><td>'''v1.6.0'''</td><td>14 octobre 2004</td><td>
* Passage du chat en TCP
* Ajout de l'authentification des connexions (protocole xNet 3.9)
* Amélioration de l'ergonomie
</td></tr>
<tr><td>v1.6.1</td><td>22 novembre 2004</td><td>
* Ajout d'une 'ignore-list'
* Ajout des notifications d'arrivée/départ des favoris
</td></tr>
<tr style="background-color: #FAF5FF;"><td>v1.6.2</td><td>22 mars 2004</td><td>
* Tab-completion des pseudos dans le chat
* Ajout d'informations (IP, Client, Localisation)
</td></tr>
<tr><td>v1.6.3</td><td>1er mai 2005</td><td>
* Fix principalement un 100% en cas d'absence de réseau
</td></tr>
<tr style="background-color: #FAF5FF;"><td>v1.6.4</td><td>23 septembre 2005</td><td>
* Passage au protocole xNet 4.0
* Ajout du support de BSD
* Sauvegarde des propriétés checkées
</td></tr>
<tr><td>'''v2.0.0'''</td><td>6 février 2006</td><td>
* Réécriture modulaire utilisant Qt4
* Carte permettant de situer visuellement les personnes
* Ajout de la notion de "Groupes"
</td></tr>
<tr style="background-color: #FAF5FF;"><td>v2.0.1</td><td>23 avril 2006</td><td>
* Bugfixes
</td></tr>
<tr><td>v2.1.0</td><td>23 avril 2007</td><td>
* Meilleure intégration à MacOS X (Support de Growl, ajout de menus...)
* Notification des discussions
* Recherches avancées ne se limitant plus aux pseudo
* Transfert de fichiers
* Module "Bob"
* Bugfixes
</td></tr>
</table>

== Développement ==

Cette partie a pour but de présenter brièvement l'état du projet à travers l'organisation du développement.

=== Outils nécessaires ===

* Le développement de qRezix se fait comme tous les projets du BR via un système de partage de projet : [[Subversion|SVN]]. Il est donc nécessaire d'installer un client [[Subversion|SVN]] pour travailler. Sous Linux et Mac OS, il y a des packages de SVN qui sont distribués. Sous Windows, il est fortement conseillé d'utiliser [http://tortoisesvn.tigris.org TortoiseSVN]. Pour plus d'information sur SubVersion, merci de vous référer à la [[Subversion|page correspondante]].

* Il faut également installer [[Qt]], la version dépend de la branche de travail. Pour qRezix 1.6, il faut utiliser Qt3 (3.3.3 ou ultérieure) alors que pour qRezix 1.7, Qt4 (4.0.1 ou ultérieure). Pour obtenir Qt3 pour Windows, merci de demander à [[User:Fruneau|Fruneau]]. Pour Qt4, il faut faire attention sur certaine distribution de bien installer tous les modules nécessaires (au moins Core, GUI et Network) et les outils qui vont avec (designer, linguist, assistant).

* Pour générer la documentation il peut être intéressant d'installer également [http://www.doxygen.org Doxygen]. La plupart du temps l'utilisation de Doxygen est très simple : il suffit de l'appliquer au fichier Doxyfile qui se trouve à la racine du projet.
doxygen Doxyfile

=== Structure de la SVN ===

Pour ce qui est de l'utilisation de SVN, je vous laisse vous référer à la [[Subversion#Utilisation_de_svn|page correspondante]]. Cette partie à plutôt pour but d'expliquer comment utiliser la SVN pour travailler sur qRezix.

Tout d'abord, il est important de noter que qRezix utilise une structure tout ce qu'il y a de plus classique (avec trunk, branches et tags). Le trunk étant la branche principale du projet.

==== Travailler sur la branche principale ====

La branche principale du projet correspond à la version qui évolue actuellement. A l'heure actuelle c'est la 1.6.x. Cette branche change régulièrement et on peut y trouver les dernières innovations réalisée sur cette branche. Lorsqu'on s'approche d'une release de qRezix, il faut freezer la branche principale. Pour ceci, on sépare le développement de la version qui va sortir de celui de la branche principale.

Par exemple pour release qRezix 1.6.4, j'ai freezé la branche environ 1 semaine et demi avant la sortie via :
svn copy trunk branches/qrezix--release--1.6.4

Une fois les branches séparées, la branche de release ne doit plus subir que des corrections de bugs. En cas de besoin, on pourra sortir des pre-release (rc). Une fois qu'une version est considérée stable, on la tag, c'est à dire qu'on fait une photographie instantannée du projet :
svn copy branches/qrezix--release--1.6.4 tags/qrezix--1.6.4-rc1 # pour une préversion
svn copy branches/qrezix--release--1.6.4 tags/qrezix--1.6.4 # pour la version définitive

On peut même envisager alors des révisions sur la version actuelle qui serait des bugfixes de la branche de release intervenu après la sortie. Dans ce cas, on aurait
svn copy branches/qrezix--release--1.6.4 tags/qrezix--1.6.4-r1 # pour une révision de la version

Ceci peut paraître contraignant, mais c'est la base d'un projet mené correctement. Ca permet d'avoir un historique des branches et des versions, de pouvoir envisager de sortir des révisions de toutes les branches de release en cas de découverte d'une faille importante du programme et ça évite surtout d'avoir une version qui s'éternise... lorsqu'on décide de freezer une version, ceux qui veulent continuer à innover travaillent sur le trunk pendant que d'autres stabilise la version de release.

==== Branches de devel ====

A côté de la branche principale, il peut y avoir des branches de devel. Alors que la différence entre 2 releases issues d'une même branche sont le plus souvent mineures voire de la simple maintenance, la différence entre le trunk et la branches de devel est quelque chose de beaucoup plus important. La branche de devel apporte des innonvations importantes et devrait conduire à une nouvelle version majeure du programme.

La branche de devel Qt4 vient d'être passée en branche principale.

==== Numérotation des versions ====

Comme pour tout programme, qRezix a des versions numérotées de la forme X.Y.Z-T
* X est la version majeure, il ne change que lors de modification très importantes de la structure du programme.
* Y est la version mineure, il change lorsque le programme a subit des évolution plus importante qu'une simple maintenance.
* Z est la version de maintenance, il change lorsque le programme subit des bugfixes et l'implémentation de fonctionnalités mineures.
* T est le tag

L'utilisation du tag est particulières :
* ''svn'' pour une version de développement avant les releases ou pre-release.
* ''alpha'' pour une pré-version non encore formalisée d'une nouvelle version majeure ou mineure du programme (2.0.0-alpha1 ou 1.7.0-alpha2 mais pas 1.6.5-alpha1)
* ''beta'' pour une pré-version formalisée d'une nouvelle version majeure ou mineure du programme (2.0.0-beta1 ou 1.7.0-beta2 mais pas 1.6.5-beta1)
* ''rc'' pour une version candidate à la release. Elle sert uniquement à la recherche de derniers bugs (1.6.2-rc1)
* ''r'' pour une révision d'une version déjà sortie. Elle sert uniquement à corriger de graves anomalies de la version (1.6.4-r1)

De manière générale, la numérotation doit être effectuée comme suit :
# A la release de la version X.Y.Z, la branche principale passe ne X.Y.(Z+1)-svn
# Si le besoin s'en fait sentir, des versions alpha, puis bêta et enfin rc peuvent être sorties. Mais attention, une version alpha doit être suivie d'au moins une version bêta puis d'une rc.
# Lorsque la version est considérée stable, elle est détaguée, et la release est effectuée. On revient dès lors au point 1

=== Traductions ===

Les traductions (gentil fardeau offert par JiBee), sont générée relativement simplement par Qt. Pour ceci, il faut procéder dans l'ordre :
* Dans le code, mettre les chaîne à traduire soit dans des tr("mon texte") ou QT_TR_NOOP("mon texte"). Le deuxième cas étant pour les textes qui se trouvent dans les définitions statiques.
* Générer le fichier d'index à l'aide de lupdate sur le projet :
# Pour qRezix 1.6
lupdate qrezix.pro
# Pour qRezix 2.0
lupdate */*.pro
* Editer les fichiers .ts avec Qt Linguist, et enregistrer les modifications. Les fichiers .ts sont dans le répertoires ''translations''.
* Compiler les fichiers .ts à l'aide de lrelease ou de Qt Linguist.
cd translations
lrelease *.ts
* Commiter le tout...

=== Documentation ===

La documentation de qRezix est composée de cette page, de la doc de l'API qu'il est possible de générer grâce à Doxygen, ainsi que de tout ce que vous pourrez trouver sur [http://fruneau cette page]. Dans tous les cas, la meilleure doc restera toujours une personne qui connait bien le projet :)...

Dans l'état actuel des choses, la meilleure doc de qRezix, c'est [[User:Fruneau|moi]].

=== Compiler qRezix ===

La compilation de qRezix n'est pas forcément une opération triviale, et dépend fortement de l'OS sur lequel on travail. La plupart des informations nécessaires sont contenues dans le fichier INSTALL. Voici quelques suppléments qui pourront toutefois être utiles :

==== Windows ====

Sous Windows, à l'heure actuelle, on compile avec Visual C++ 7.1 ou supérieur (qRezix ne compile pas avec VC++ 6). A l'heure actuelle, VC++ ne permet pas de compiler les modules en tant que tels car il est incapable de charger les membres de classes dans les DLL. On est donc forcés de tout compiler en un bloc en passant l'option "RZX_ALL_BUILTIN" à la compilation.

Tout d'abord il faut ouvrir une nouvelle console Visual Studio (pour avoir les variables d'environnement correctement définies). Dans cette console :
qmake qrezix.pro
nmake

Si vous compilez une version SVN de qRezix, vous pouvez exécuter SubWCRev.exe pour convertir les occurences de $WCREV$ en numéro de révision.

Le packaging se fait à l'aidre de [http://nsis.sourceforge.net/Main_Page NSIS] en compilant le script qui est dans le répertoire package/windows

==== Linux ====

Sous Linux, il suffit de procéder strictement comme indiqué dans le fichier INSTALL
qmake qrezix.pro # cet appel est nécessaire dès que la structure du programme est modifiée...
make
qmake qrezix.pro # ce deuxième appel n'est nécessaire qu'à la première compilation où lors de l'apparition de nouveaux fichiers à installer
sudo make install

Pour mettre à jour le numéro de révision il peut être utile de forcer la recompilation de certaines parties du core :
touch core/core.pro
touch core/rzxapplication.cpp
make

Le packaging dépend énormément de la distribution... mais consiste dans la plupart des cas à réaliser une installation dans un chroot, l'archiver et lui ajouter les informations de packages (dépendants de la distribution... rpm, deb...).

<div style="border: 1px solid #9f6f8f; padding: .2em .5em .2em .5em; background-color: #FBEAF5">
Pour packager il faut partir d'un export de la SVN et non pas d'un checkout... Sinon les répertoires .svn resteront présents et peuvent fortement allourdir le paquet ou induire qRezix en erreur dans certains cas.
</div>

==== MacOS X ====

Sous MacOS X, un script est prévu pour réaliser la compilation. Il gère un certain nombre de problèmes liés à MacOS X, et il est fortement déconseillé de ne pas l'utiliser. Donc, pour compiler et créer un bundle utilisable il suffit de lancer la commande :
./build-mac

Pour compiler sous MacOS X il est nécessaire d'avoir installer la SDK de Growl. Et une fois compilé, de mettre Growl-withInstaller.framework dans le bundle qRezix.app/Content/Frameworks, sans quoi qRezix refusera de se lancer.

Ce script peut prendre un certain nombre de paramètres :
* -v : mode verbeux (affiche la sortie de make, qmake...)
* -q : ne lance pas les qmake (si cette option est ajoutée, le numéro de révision ne sera pas mis à jour dans la fenêtre de préférence)
* -jx : option -j de make (attention, la compilation universal binaries utilise déjà les 2 processeurs des biprocs)
* ... : toutes les autres options sont ajoutées aux CXXFLAGS

Pour packager qRezix pour MacOS, il suffit d'exécuter un autre script qui récupère le bundle de build-mac, le nettoie, y ajoute Qt et règle les dépendances des bibliothèques.
cd package/macosx
./package

<div style="border: 1px solid #6f8f9f; padding: .2em .5em .2em .5em; background-color: #EAF5FB">
Pour ceux qui voudraient profiter de Xcode, qmake peut générer des projet Xcode à partir du fichier .pro en exécutant :
qmake -spec macx-pbuilder machin.pro
Mais ceci mérite des test approfondis et une attention accrue pour éviter de délaisser le fichier .pro nécessaire pour les autres plateformes une fois le projet généré.
</div>

=== Coding Rules ===

Il est important de respecter un certain nombre de règles lorsqu'on travail sur un projet collectif. De fait, tout développeur de qRezix est prié de se tenir aux recommandations qui suivent :

<table style="border: 1px solid #6f8f9f; width: 100%">
<tr style="padding: .2em .5em .2em .5em; background-color: #EAF5FB">
<th colspan="2">'''Nomenclature'''</th>
</tr>
<tr>
<td>Les noms des classes sont préfixés par Rzx</td>
<td rowspan="5"><pre>
class RzxApplication
{
bool valid;

public:
bool isValid() const;
};
</pre></td>
</tr>
<tr style="background-color: #FAF5FF">
<td>Les noms des fonctions commencent par une minuscule</td>
</tr>
<tr>
<td>L'utilisation d'underscore est à éviter. On préférera utiliser des nom dont les séparations sont des majuscules</td>
</tr>
<tr style="background-color: #FAF5FF">
<td>La langue à utiliser de préférence est '''l'anglais'''</td>
</tr>
<tr>
<td>Les noms des fonctions/methodes doivent être cohérents avec les APIs Qt et qRezix, on évitera par exemple les getMyVar() en privilégiant myVar().</td>
</tr>
<tr style="padding: .2em .5em .2em .5em; background-color: #EAF5FB">
<th colspan="2">'''Accolades'''</th>
</tr>
<tr>
<td>Les accolades ouvrantes comme fermantes sont placées après un retour à la ligne</td>
<td rowspan="3"><pre>
if(a == b || c != d)
{
a = b + 1;
do(truc);
}

void RzxMyClass::myFunction() const
{
<bloc>;
}

class RzxMyClass
{
};
</pre></td>
</tr>
<tr style="background-color: #FAF5FF">
<td>Les opérateurs sont entourés d'espaces</td>
</tr>
<tr>
<td>Les parenthèse sont collées à l'opération associée (nom de fonction, contrôle de flux...)</td>
</tr>
<tr style="padding: .2em .5em .2em .5em; background-color: #EAF5FB">
<th colspan="2">'''Indentation'''</th>
</tr>
<tr>
<td>Les indentation sont réalisées à l'aide de ''tabulation''</td>
<td rowspan="4"><pre>
class RzxMyClass
{
<firstbloc>

public:
<secondbloc>

protected:
<thirdbloc>
};

switch(value)
{
case 1:
<bloc1>;

case 2:
<bloc2>;

case 3:
<bloc3>;
}

#if CASE1
# define MACHIN
#endif
</pre></td>
</tr>
<tr style="background-color: #FAF5FF">
<td>Les mots clés comme public: ou case: sont indentés et entraînent une indentation supplémentaire jusqu'au prochain mot clé</td>
</tr>
<tr>
<td>Ne pas oublier d'indenter également le préprocesseur</td>
</tr>
<tr style="background-color: #FAF5FF">
<td>Les fichiers doivent finir par une ligne vide</td>
</tr>
<tr style="padding: .2em .5em .2em .5em; background-color: #EAF5FB">
<th colspan="2">'''Commentaires et documentation'''</th>
</tr>
<tr>
<td>Les objets doivent être documentées à l'aide des syntaxe de Doxygen</td>
<td rowspan="3"><pre>
///Ceci est une description rapide
/** Ceci est une description avancée de la fonction
*/
void myFunction()
{
if(machin) // Le cas machin peut poser problème, on le traite donc à part
{
}

// TODO: implémenter le reste de la fonction

}
</pre></td>
</tr>
<tr style="background-color: #FAF5FF">
<td>A l'exception de la documentation des fonctions, on préférera les commentaires de la forme // Mon commentaire en français</td>
</tr>
<tr>
<td>// TODO: peut également être utilisé pour spécifier des implémentations à réaliser</td>
</tr>
</table>

== Branche 1.6 ==

=== Structure du programme ===

La structure interne du programme peut-être résumée au schéma suivant :

[[Image:qrezix-1.6_structure.png]]

Ce schéma n'est pas exhaustif, mais met en évidence les différentes imbrications des éléments. Toutes les cadres qui se chevauchent (et le cas échéant se contiennet) représente des classes qui sont imbriquées l'une à l'autre. Ansi la classe QRezix qui gère la totalité du programme est totalement dépendante de la quasitotalité des autres classes, la classe RzxConnectionLister dont le but est de lister les personnes est complètement dépendante de RzxRezal et vice-versa (il y a même des redondances de stockage)... idem, pour le chat qui est géré partiellement par RzxConnectionLister et partiellement par RzxRezal.

La classe RzxComputer a une importance réduite et la quasitotalité de ses données sont redondantes avec RzxItem. De plus certaines informations de RzxComputer sont stockées directement par RzxConfig, qui est elle-même à moitié implémentée par RzxProperty.

En résumé, la structure (déjà modularisée comparée à la version 1.2 dans laquelle RzxConnectionLister n'existait pas et était partie intégrante de RzxRezal) n'est pas facilement maintenable.

=== Interface de plug-ins ===

qRezix 1.6 est la première version à bénéficier d'une structure d'accueil de plug-in. Cette structure est rudimentaire et souffre du fait que qRezix n'est pas modulaire. En effet la classe RzxPlugIn est compilée à la fois dans le plug-in et dans qRezix, ce qui crée des problèmes dès que les deux versions diffèrent.

Pour éviter les problèmes, la version de la strucutre de plug-in est numéroté de façon très stricte, et le filtrage est fait au chargement du plug-in.

Ce défaut entraîne un grand nombre de complication. Les plug-ins n'ont absolument aucun accès direct aux données stockées par qRezix. Toutes les informations transitent donc par des fonction standardisées du plug-in, mais cette méthode de travail limite le nombre d'information pouvant être échangé. Il n'en reste pas moins que cette structure est tout à fait suffisante pour réaliser des plug-ins comme l'Xplo ou SmiliX (qui sont disponible sur la [[Subversion|SVN]] dans le reposoire qrezix-plugins).

Pour pouvoir faire un plug-in pour qRezix, il faut récupérer la dernière version de rzxplugin.h et rzxplugin.cpp dans la branche de release de qRezix correspondante à la version pour laquelle vous voulez faire le plugin. Il suffit alors de créer un projet dérivant de RzxPlugIn. La documentation de RzxPlugIn peut-être générée automatique à l'aide de [http://www.doxygen.org Doxygen] et peut-être trouvée [http://fruneau.eleves.polytechnique.fr/qrezix-1.6/classRzxPlugIn.html ici], de même pour la [http://fruneau.eleves.polytechnique.fr/xplo/ documentation du plug-in Xplo] qui permet d'avoir un bon exemple de plug-in complet.

Cette structure a totalement disparue avec qRezix 2.0 pour être remplacer par des modules plus souple et mieux conçus.

== Branche 2.0 ==

=== Objectif ===

Cette version de qRezix repose sur un double objectif :
* porter le code en Qt4.
* modulariser le programme.

==== Qt4 ====
Le premier point ne présente pas une difficulté énorme, mais a conduit à pas mal de réorganisation du code. En particulier, qRezix 2.0 bénéficie de la puissance du nouveau système Model/View de Qt4, ce qui a nécessiter de redévelopper la quasitotalité de l'interface principale.

La toute dernière version [[Subversion|SVN]] de qRezix utilise [[Qt]] version 4.1.0 minimum. qRezix 2.0 utilise des fonctions introduites dans Qt 4.1, et ne compilera pas avec Qt 4.0.

==== Modularité ====

La modularisation du programme est un point essentiel. Elle apporte un certain nombre d'évolution nécessaire à la survie de qRezix :
* restructuration du programme qui permet une meilleure maintenance
* possibilité de limiter qRezix à certaines fonctionnalités (utile pour l'utilisation chez des personnes qui n'ont pas besoin d'avoir le logiciel complet si par exemple ils n'utilisent jamais le chat).
* possibilité de travailler avec un plus grand nombre de personne sur le projet. Chacun pouvant en effet travailler sur un module
* possibilité de gérer plusieurs protocoles pour se connecter à plusieurs serveurs

=== Structure du programme ===

Le schéma suivant représente de manière simplifié la structure interne de qRezix 2.0.x :

[[Image:qrezix-2.0_structure.png]]

Bien que le nombre d'élément soit impressionnant, cette structure est beaucoup plus propre que celle de qRezix 1.6. Le schéma montre en effet en particulier que les éléments sont proprement séparé, les seuls dépendances entre les modules qu'il peut y avoir sont gérées par la bibliothèque principale.

Le RzxComputer a acquis un rôle beaucoup plus important, il gère désormais la totalité des informations concernant une machine et inclus les actions qu'il est envisageable d'effectuer (propriétés, chat, http, ftp...). Le chat est géré par les modules qui se déclarent comme supportant cette fonctionnalité, de même pour les propriétés.

La fenêtre de préférences (RzxProperty) génère dynamiquement la page de propriétés en fonction de ce que les modules installés désirent. Et tout est mis en oeuvre (au travers de classe abstraites regroupant tous les outils nécessaires) pour que chaque module puisse créer simplement ses propres classes de configuration.

Les modules peuvent être construit soit en built-in soit en plug-in. Aucun n'est nécessaire au fonctionnement du programme (enfin si on retire tous les protos réseau, programme perd beaucoup de son intérêt).

Utilisateur:Fruneau

2007-02-24T11:50:26Z

Fruneau : Add my own website

membre du [[BR2003]]

Nom réel : [https://www.polytechnique.org/profile/florent.bruneau.2003 Florent Bruneau]

* [[Poste:Root|root]]
* développeur acharné de [[qRezix]]
* [[Poste:News|newsmestre]] (rtfibrp11)
* multiboot (Windows, Gnu/Linux Gentoo, MacOSX ;)

Site perso : [http://fruneau.rznc.net Ma page vide] et [http://fruneau.rznc.net/mind/ mon blog] (pas très plein non plus)

QRezix

2007-02-19T09:13:32Z

Fruneau : Improve qRezix 2 history

{{menu projets}}
qRezix est le principal client [[xNet]] encore maintenu. Il doit sa survie à sa qualité d'être le seul client développé qui soit multiplateforme tout en restant graphiquement potable. Il doit ces deux qualités à la bibliothèque [[Qt]].

== Historique ==

=== BR2000 ===

Le projet en lui-même est né avec un groupe de BRmen X2000 menés par Doudou qui étaient fans de Qt (qui à l'époque n'était pas terrible-terrible...). Ils ont travaillé à 3 ou 4 pour sortir la version 1.0 le 4 mars 2002, suivie de près par la version 1.1 le 6 avril. L'équipe de développement comportait entre autres Doudou, MadCoder et Trasfract (Sylvain Joyeux, Pierre Habouzit et Benoït Casoetto).

Le projet s'est principalement inspiré des clients qui existaient déjà à l'époque (Rezix en particulier, duquel qRezix a tiré son nom). Cette architecture simple est une fenêtre avec une liste de client chaque entrée indiquant le nom, la promo, les serveurs... Les favoris sont affichés en premier selon le choix de l'utilisateur.

=== BR2001 ===

Le BR2001 n'a pas énormément travaillé sur qRezix. Il y a eu la version 1.2, mais on n'a aucune trace de ce que JiBee a bien pu faire sur le projet. Ce qui est certain, c'est qu'après la vesion 1.2, il a porté qRezix en Qt3 et a travaillé sur l'internationalisation du projet. Le but d'origine n'était pas de rendre qRezix international, mais simplement de résoudre les problèmes d'encodage des caractères accentués. Le code source a donc totalement été traduit en anglais et une traduction française a été créée.

[[Image:qrezix-1.2.gif|center]]

A priori, il n'y a pas eu de release en Qt3... mais d'après [[User:Ey|Ey]] qui packageait le projet pour Windows, il y en aurait eu... Mais en tout cas à l'arrivée des 2003 c'était toujours la version 1.2 (en Qt2) qui était disponible... Le BR n'avait de plus pas de license pour Qt3 sous Windows.

=== BR2002 ===

Le projet était géré par Steak. La version 1.3 a été release le 1 mai 2004. Cette version n'était absolument par révolutionnaire mais apportait quelques améliorations dans la structure du code et des amélioration du comportement du programme.

Steak a ensuite travaillé sur la version 1.3.666 et en particulier sur l'authentification avec le serveur. Mais il a vite arrêter de travailler sur qRezix en raison du temps qu'il consacrait à l'étude du japonnais, et à différents problèmes occulaires. Cependant, le [[BR2002]] a réalisé une prépassation très avancée ce qui fait que dès le mois de juin, la relève était en place...

=== BR2002/BR2003 : le temps d'une prépassation ===

Le [[BR2003]] a donc commencé sont travail sur qRezix dès le mois de juin 2004.

La première chose a été de recompiler une version pour Windows, ce qui n'avait plus été fait depuis près d'un an. Ceci permettait donc d'envisager de futures release du programme pas uniquement sous Linux. Le travail s'est finalement concentré pendant les vacances d'été avec une amélioration importante de l'interface et de la structure interne (début de séparation de la gestion des connexions de l'affichage), la création d'une structure (pas terrible) de chargement de plug-ins, l'ajout d'icône pour rendre l'interface plus conviviale... La version a été tagguée tour à tour 1.3.666 puis 1.5.

Une autre innovation importante a été le passage du chat qui reposait sur un protocole en UDP vers un protocole TCP. Le but déclaré du BR2002 étant de rendre les communications fiables et sécurisées (on veut savoir si l'autre ne reçoit pas nos messages).

Toutes ces modifications associées au travail de Steak sur l'authentification et le travail de JiBee pour recoder un nouveau [[xNetServer|serveur xNet]], on conduit à la version 1.6 de qRezix qui est sorti le 14 octobre 2004 à la fois pour Windows, Linux et Mac OS X.

[[Image:qrezix-1.6.png|center]]

Face à qRezix 1.6.0 est apparu Rezix.NET qui se voulait innovant. Conséquence de ceci, on a travaillé à 2 avec Steak pour implémenter dans qRezix toutes les fonctionnalité des Rezix.NET. Ce qui a rapidement conduit à la sortie de qRezix 1.6.1 le 22 novembre 2004. C'était la dernière version sur laquelle ait travailler Steak. Rezix.NET (qui était codé en .NET par un membre dissidant du BR2002) n'a finalement pas fait long feu.

=== BR2003 ===

La suite a été plus calme. La préparation de qRezix 1.6.2 s'est faite tranquillement, l'objectif principal était de supprimer un maximum de bugs de cette future version. Les innovations n'ont pas été nombreuses, mais on pourra noter la completion du nick dans le chat avec tab et la recherche intelligente via clavier. Cette version a vu le retour de Ey parmi les développeurs. Elle a aussi été la seule version à bénéficier d'une sortie ayant été précédée de 2 release-candidates qui ont aidées à corriger plusieurs bugs supplémentaires. La version a finalement été sortie le 22 mars 2005.

Le problème de cette version est qu'elle a introduit un bug... enfin plutôt révélé un bug. Jusqu'à présent qRezix plantait en l'absence de réseau ce qui a été corrigé avec la 1.6.2. Mais ce que je n'avais pas remarqué à l'époque c'était qu'en l'absence de réseau qRezix raffraichissait la fenêtre toutes les secondes et en même temps changeait le thême d'icône. Conséquence directe de ce défaut, qRezix prenait 100% du processeur en l'absence de réseau, ce que j'ai eu la chance de constater lors de ma soutenance de modex... Il fallait donc sortir un version avant l'arrivée des 2004 pour éviter que ce bug ne pose trop de problème aux 2004 qui allaient passer leur soutenance de stage. C'est pour ça qu'est sortie la verson 1.6.3 le 1 mai 2005. Cette version innovait au passage une nouvelle organisation plus agréable des propriétés et peut-être globalement considérée comme stable. La version 1.6.4 sortie le 23 septembre apporte peu d'innovation si ce n'est la cache des propriétés, les icônes en 32bits et une meilleure intégration à Mac OS.

Suite à la sortie de Qt4, le port de qRezix vers cette nouvelle mouture de la bibliothèque de Trolltech a été l'occasion de grand remaniement du code. Le développement du port de qRezix en Qt4 a commencé en mai-juin 2005, en parallèle de la finalisation de la branche 1.6 avec la préparation de qRezix 1.6.4. Le port en Qt4, tout d'abord appelé 1.7, a rapidement évolué. Les vacances d'été ont été l'occasion de préparer une restructuration du programme. La suite de développement a principalement consisté à créer ou améliorer les différents modules. Ceci a abouti à la versin 2.0 de qRezix dont le principal atout est d'être modulaire. La version 2.0.0 est sortie le 6 février 2006, et a rapidement supplanté la version 1.6.x.

La première version de maintenance de qRezix 2 est sortie avant l'arrivée des 2005 sur le plateau et mettait en particuliers à jour les correspondance IP <-> Casert.

[[Image:qrezix-2.0.png|800px|center]]

<div style="border: 1px solid #6f8f9f; padding: .2em .5em .2em .5em; background-color: #EAF5FB">
Pour écrire cette partie, j'ai utilisé mes connaissances personnelles issues ainsi que les informations contenues dans le ChangeLog. Et j'espère bien que d'autres y jetteront un coup d'oeil pour compléter/corriger les parties inexactes.
</div>

=== Versions ===

Voici un description des différentes versions de qRezix. Pour des informations exhaustive, il faut se reporter au ChangeLog du projet.

<table style="border: 1px solid #6f8f9f; width: 100%">
<tr style="padding: .2em .5em .2em .5em; background-color: #EAF5FB">
<th>'''Version'''</th><th>'''Date'''</th><th>'''Changements'''</th>
</tr>
<tr><td>v0.1</td><td>30 janvier 2002</td><td></td></tr>
<tr style="background-color: #FAF5FF;"><td>v0.2</td><td>20 février 2002</td><td></td></tr>
<tr><td>v0.3</td><td>25 février 2002</td><td></td></tr>
<tr style="background-color: #FAF5FF;"><td>'''v1.0'''</td><td>4 mars 2002</td><td></td></tr>
<tr><td>v1.1</td><td>6 avril 2002</td><td></td></tr>
<tr style="background-color: #FAF5FF;"><td>v1.2</td><td>2003</td><td></td></tr>
<tr><td>v1.3</td><td>1er mai 2004</td><td></td></tr>
<tr style="background-color: #FAF5FF;"><td>'''v1.6.0'''</td><td>14 octobre 2004</td><td>
* Passage du chat en TCP
* Ajout de l'authentification des connexions (protocole xNet 3.9)
* Amélioration de l'ergonomie
</td></tr>
<tr><td>v1.6.1</td><td>22 novembre 2004</td><td>
* Ajout d'une 'ignore-list'
* Ajout des notifications d'arrivée/départ des favoris
</td></tr>
<tr style="background-color: #FAF5FF;"><td>v1.6.2</td><td>22 mars 2004</td><td>
* Tab-completion des pseudos dans le chat
* Ajout d'informations (IP, Client, Localisation)
</td></tr>
<tr><td>v1.6.3</td><td>1er mai 2005</td><td>
* Fix principalement un 100% en cas d'absence de réseau
</td></tr>
<tr style="background-color: #FAF5FF;"><td>v1.6.4</td><td>23 septembre 2005</td><td>
* Passage au protocole xNet 4.0
* Ajout du support de BSD
* Sauvegarde des propriétés checkées
</td></tr>
<tr><td>'''v2.0.0'''</td><td>6 février 2006</td><td>
* Réécriture modulaire utilisant Qt4
* Carte permettant de situer visuellement les personnes
* Ajout de la notion de "Groupes"
</td></tr>
<tr style="background-color: #FAF5FF;"><td>v2.0.1</td><td>23 avril 2006</td><td>
* Bugfixes
</td></tr>
<tr><td>''v2.0.2''</td><td>''à venir...''</td><td>
* Meilleure intégration à MacOS X (Support de Growl, ajout de menus...)
* Notification des discussions
* Recherches avancées ne se limitant plus aux pseudo
* Transfert de fichiers
* Bugfixes
</td></tr>
</table>

== Développement ==

Cette partie a pour but de présenter brièvement l'état du projet à travers l'organisation du développement.

=== Outils nécessaires ===

* Le développement de qRezix se fait comme tous les projets du BR via un système de partage de projet : [[Subversion|SVN]]. Il est donc nécessaire d'installer un client [[Subversion|SVN]] pour travailler. Sous Linux et Mac OS, il y a des packages de SVN qui sont distribués. Sous Windows, il est fortement conseillé d'utiliser [http://tortoisesvn.tigris.org TortoiseSVN]. Pour plus d'information sur SubVersion, merci de vous référer à la [[Subversion|page correspondante]].

* Il faut également installer [[Qt]], la version dépend de la branche de travail. Pour qRezix 1.6, il faut utiliser Qt3 (3.3.3 ou ultérieure) alors que pour qRezix 1.7, Qt4 (4.0.1 ou ultérieure). Pour obtenir Qt3 pour Windows, merci de demander à [[User:Fruneau|Fruneau]]. Pour Qt4, il faut faire attention sur certaine distribution de bien installer tous les modules nécessaires (au moins Core, GUI et Network) et les outils qui vont avec (designer, linguist, assistant).

* Pour générer la documentation il peut être intéressant d'installer également [http://www.doxygen.org Doxygen]. La plupart du temps l'utilisation de Doxygen est très simple : il suffit de l'appliquer au fichier Doxyfile qui se trouve à la racine du projet.
doxygen Doxyfile

=== Structure de la SVN ===

Pour ce qui est de l'utilisation de SVN, je vous laisse vous référer à la [[Subversion#Utilisation_de_svn|page correspondante]]. Cette partie à plutôt pour but d'expliquer comment utiliser la SVN pour travailler sur qRezix.

Tout d'abord, il est important de noter que qRezix utilise une structure tout ce qu'il y a de plus classique (avec trunk, branches et tags). Le trunk étant la branche principale du projet.

==== Travailler sur la branche principale ====

La branche principale du projet correspond à la version qui évolue actuellement. A l'heure actuelle c'est la 1.6.x. Cette branche change régulièrement et on peut y trouver les dernières innovations réalisée sur cette branche. Lorsqu'on s'approche d'une release de qRezix, il faut freezer la branche principale. Pour ceci, on sépare le développement de la version qui va sortir de celui de la branche principale.

Par exemple pour release qRezix 1.6.4, j'ai freezé la branche environ 1 semaine et demi avant la sortie via :
svn copy trunk branches/qrezix--release--1.6.4

Une fois les branches séparées, la branche de release ne doit plus subir que des corrections de bugs. En cas de besoin, on pourra sortir des pre-release (rc). Une fois qu'une version est considérée stable, on la tag, c'est à dire qu'on fait une photographie instantannée du projet :
svn copy branches/qrezix--release--1.6.4 tags/qrezix--1.6.4-rc1 # pour une préversion
svn copy branches/qrezix--release--1.6.4 tags/qrezix--1.6.4 # pour la version définitive

On peut même envisager alors des révisions sur la version actuelle qui serait des bugfixes de la branche de release intervenu après la sortie. Dans ce cas, on aurait
svn copy branches/qrezix--release--1.6.4 tags/qrezix--1.6.4-r1 # pour une révision de la version

Ceci peut paraître contraignant, mais c'est la base d'un projet mené correctement. Ca permet d'avoir un historique des branches et des versions, de pouvoir envisager de sortir des révisions de toutes les branches de release en cas de découverte d'une faille importante du programme et ça évite surtout d'avoir une version qui s'éternise... lorsqu'on décide de freezer une version, ceux qui veulent continuer à innover travaillent sur le trunk pendant que d'autres stabilise la version de release.

==== Branches de devel ====

A côté de la branche principale, il peut y avoir des branches de devel. Alors que la différence entre 2 releases issues d'une même branche sont le plus souvent mineures voire de la simple maintenance, la différence entre le trunk et la branches de devel est quelque chose de beaucoup plus important. La branche de devel apporte des innonvations importantes et devrait conduire à une nouvelle version majeure du programme.

La branche de devel Qt4 vient d'être passée en branche principale.

==== Numérotation des versions ====

Comme pour tout programme, qRezix a des versions numérotées de la forme X.Y.Z-T
* X est la version majeure, il ne change que lors de modification très importantes de la structure du programme.
* Y est la version mineure, il change lorsque le programme a subit des évolution plus importante qu'une simple maintenance.
* Z est la version de maintenance, il change lorsque le programme subit des bugfixes et l'implémentation de fonctionnalités mineures.
* T est le tag

L'utilisation du tag est particulières :
* ''svn'' pour une version de développement avant les releases ou pre-release.
* ''alpha'' pour une pré-version non encore formalisée d'une nouvelle version majeure ou mineure du programme (2.0.0-alpha1 ou 1.7.0-alpha2 mais pas 1.6.5-alpha1)
* ''beta'' pour une pré-version formalisée d'une nouvelle version majeure ou mineure du programme (2.0.0-beta1 ou 1.7.0-beta2 mais pas 1.6.5-beta1)
* ''rc'' pour une version candidate à la release. Elle sert uniquement à la recherche de derniers bugs (1.6.2-rc1)
* ''r'' pour une révision d'une version déjà sortie. Elle sert uniquement à corriger de graves anomalies de la version (1.6.4-r1)

De manière générale, la numérotation doit être effectuée comme suit :
# A la release de la version X.Y.Z, la branche principale passe ne X.Y.(Z+1)-svn
# Si le besoin s'en fait sentir, des versions alpha, puis bêta et enfin rc peuvent être sorties. Mais attention, une version alpha doit être suivie d'au moins une version bêta puis d'une rc.
# Lorsque la version est considérée stable, elle est détaguée, et la release est effectuée. On revient dès lors au point 1

=== Traductions ===

Les traductions (gentil fardeau offert par JiBee), sont générée relativement simplement par Qt. Pour ceci, il faut procéder dans l'ordre :
* Dans le code, mettre les chaîne à traduire soit dans des tr("mon texte") ou QT_TR_NOOP("mon texte"). Le deuxième cas étant pour les textes qui se trouvent dans les définitions statiques.
* Générer le fichier d'index à l'aide de lupdate sur le projet :
# Pour qRezix 1.6
lupdate qrezix.pro
# Pour qRezix 2.0
lupdate */*.pro
* Editer les fichiers .ts avec Qt Linguist, et enregistrer les modifications. Les fichiers .ts sont dans le répertoires ''translations''.
* Compiler les fichiers .ts à l'aide de lrelease ou de Qt Linguist.
cd translations
lrelease *.ts
* Commiter le tout...

=== Documentation ===

La documentation de qRezix est composée de cette page, de la doc de l'API qu'il est possible de générer grâce à Doxygen, ainsi que de tout ce que vous pourrez trouver sur [http://fruneau cette page]. Dans tous les cas, la meilleure doc restera toujours une personne qui connait bien le projet :)...

Dans l'état actuel des choses, la meilleure doc de qRezix, c'est [[User:Fruneau|moi]].

=== Compiler qRezix ===

La compilation de qRezix n'est pas forcément une opération triviale, et dépend fortement de l'OS sur lequel on travail. La plupart des informations nécessaires sont contenues dans le fichier INSTALL. Voici quelques suppléments qui pourront toutefois être utiles :

==== Windows ====

Sous Windows, à l'heure actuelle, on compile avec Visual C++ 7.1 ou supérieur (qRezix ne compile pas avec VC++ 6). A l'heure actuelle, VC++ ne permet pas de compiler les modules en tant que tels car il est incapable de charger les membres de classes dans les DLL. On est donc forcés de tout compiler en un bloc en passant l'option "RZX_ALL_BUILTIN" à la compilation.

Tout d'abord il faut ouvrir une nouvelle console Visual Studio (pour avoir les variables d'environnement correctement définies). Dans cette console :
qmake qrezix.pro
nmake

Si vous compilez une version SVN de qRezix, vous pouvez exécuter SubWCRev.exe pour convertir les occurences de $WCREV$ en numéro de révision.

Le packaging se fait à l'aidre de [http://nsis.sourceforge.net/Main_Page NSIS] en compilant le script qui est dans le répertoire package/windows

==== Linux ====

Sous Linux, il suffit de procéder strictement comme indiqué dans le fichier INSTALL
qmake qrezix.pro # cet appel est nécessaire dès que la structure du programme est modifiée...
make
qmake qrezix.pro # ce deuxième appel n'est nécessaire qu'à la première compilation où lors de l'apparition de nouveaux fichiers à installer
sudo make install

Pour mettre à jour le numéro de révision il peut être utile de forcer la recompilation de certaines parties du core :
touch core/core.pro
touch core/rzxapplication.cpp
make

Le packaging dépend énormément de la distribution... mais consiste dans la plupart des cas à réaliser une installation dans un chroot, l'archiver et lui ajouter les informations de packages (dépendants de la distribution... rpm, deb...).

<div style="border: 1px solid #9f6f8f; padding: .2em .5em .2em .5em; background-color: #FBEAF5">
Pour packager il faut partir d'un export de la SVN et non pas d'un checkout... Sinon les répertoires .svn resteront présents et peuvent fortement allourdir le paquet ou induire qRezix en erreur dans certains cas.
</div>

==== MacOS X ====

Sous MacOS X, un script est prévu pour réaliser la compilation. Il gère un certain nombre de problèmes liés à MacOS X, et il est fortement déconseillé de ne pas l'utiliser. Donc, pour compiler et créer un bundle utilisable il suffit de lancer la commande :
./build-mac

Pour compiler sous MacOS X il est nécessaire d'avoir installer la SDK de Growl. Et une fois compilé, de mettre Growl-withInstaller.framework dans le bundle qRezix.app/Content/Frameworks, sans quoi qRezix refusera de se lancer.

Ce script peut prendre un certain nombre de paramètres :
* -v : mode verbeux (affiche la sortie de make, qmake...)
* -q : ne lance pas les qmake (si cette option est ajoutée, le numéro de révision ne sera pas mis à jour dans la fenêtre de préférence)
* -jx : option -j de make (attention, la compilation universal binaries utilise déjà les 2 processeurs des biprocs)
* ... : toutes les autres options sont ajoutées aux CXXFLAGS

Pour packager qRezix pour MacOS, il suffit d'exécuter un autre script qui récupère le bundle de build-mac, le nettoie, y ajoute Qt et règle les dépendances des bibliothèques.
cd package/macosx
./package

<div style="border: 1px solid #6f8f9f; padding: .2em .5em .2em .5em; background-color: #EAF5FB">
Pour ceux qui voudraient profiter de Xcode, qmake peut générer des projet Xcode à partir du fichier .pro en exécutant :
qmake -spec macx-pbuilder machin.pro
Mais ceci mérite des test approfondis et une attention accrue pour éviter de délaisser le fichier .pro nécessaire pour les autres plateformes une fois le projet généré.
</div>

=== Coding Rules ===

Il est important de respecter un certain nombre de règles lorsqu'on travail sur un projet collectif. De fait, tout développeur de qRezix est prié de se tenir aux recommandations qui suivent :

<table style="border: 1px solid #6f8f9f; width: 100%">
<tr style="padding: .2em .5em .2em .5em; background-color: #EAF5FB">
<th colspan="2">'''Nomenclature'''</th>
</tr>
<tr>
<td>Les noms des classes sont préfixés par Rzx</td>
<td rowspan="5"><pre>
class RzxApplication
{
bool valid;

public:
bool isValid() const;
};
</pre></td>
</tr>
<tr style="background-color: #FAF5FF">
<td>Les noms des fonctions commencent par une minuscule</td>
</tr>
<tr>
<td>L'utilisation d'underscore est à éviter. On préférera utiliser des nom dont les séparations sont des majuscules</td>
</tr>
<tr style="background-color: #FAF5FF">
<td>La langue à utiliser de préférence est '''l'anglais'''</td>
</tr>
<tr>
<td>Les noms des fonctions/methodes doivent être cohérents avec les APIs Qt et qRezix, on évitera par exemple les getMyVar() en privilégiant myVar().</td>
</tr>
<tr style="padding: .2em .5em .2em .5em; background-color: #EAF5FB">
<th colspan="2">'''Accolades'''</th>
</tr>
<tr>
<td>Les accolades ouvrantes comme fermantes sont placées après un retour à la ligne</td>
<td rowspan="3"><pre>
if(a == b || c != d)
{
a = b + 1;
do(truc);
}

void RzxMyFunction::do() const
{
<bloc>;
}

class RzxMyClass
{
};
</pre></td>
</tr>
<tr style="background-color: #FAF5FF">
<td>Les opérateurs sont entourés d'espaces</td>
</tr>
<tr>
<td>Les parenthèse sont collées à l'opération associée (nom de fonction, contrôle de flux...)</td>
</tr>
<tr style="padding: .2em .5em .2em .5em; background-color: #EAF5FB">
<th colspan="2">'''Indentation'''</th>
</tr>
<tr>
<td>Les indentation sont réalisées à l'aide de ''tabulation''</td>
<td rowspan="4"><pre>
class RzxMyClass
{
<firstbloc>

public:
<secondbloc>

protected:
<thirdbloc>
};

switch(value)
{
case 1:
<bloc1>;

case 2:
<bloc2>;

case 3:
<bloc3>;
}

#if CASE1
# define MACHIN
#endif
</pre></td>
</tr>
<tr style="background-color: #FAF5FF">
<td>Les mots clés comme public: ou case: sont indentés et entraînent une indentation supplémentaire jusqu'au prochain mot clé</td>
</tr>
<tr>
<td>Ne pas oublier d'indenter également le préprocesseur</td>
</tr>
<tr style="background-color: #FAF5FF">
<td>Les fichiers doivent finir par une ligne vide</td>
</tr>
<tr style="padding: .2em .5em .2em .5em; background-color: #EAF5FB">
<th colspan="2">'''Commentaires et documentation'''</th>
</tr>
<tr>
<td>Les objets doivent être documentées à l'aide des syntaxe de Doxygen</td>
<td rowspan="3"><pre>
///Ceci est une description rapide
/** Ceci est une description avancée de la fonction
*/
void myFunction()
{
if(machin) // Le cas machin peut poser problème, on le traite donc à part
{
}

// TODO: implémenter le reste de la fonction

}
</pre></td>
</tr>
<tr style="background-color: #FAF5FF">
<td>A l'exception de la documentation des fonctions, on préférera les commentaires de la forme // Mon commentaire en français</td>
</tr>
<tr>
<td>// TODO: peut également être utilisé pour spécifier des implémentations à réaliser</td>
</tr>
</table>

== Branche 1.6 ==

=== Structure du programme ===

La structure interne du programme peut-être résumée au schéma suivant :

[[Image:qrezix-1.6_structure.png]]

Ce schéma n'est pas exhaustif, mais met en évidence les différentes imbrications des éléments. Toutes les cadres qui se chevauchent (et le cas échéant se contiennet) représente des classes qui sont imbriquées l'une à l'autre. Ansi la classe QRezix qui gère la totalité du programme est totalement dépendante de la quasitotalité des autres classes, la classe RzxConnectionLister dont le but est de lister les personnes est complètement dépendante de RzxRezal et vice-versa (il y a même des redondances de stockage)... idem, pour le chat qui est géré partiellement par RzxConnectionLister et partiellement par RzxRezal.

La classe RzxComputer a une importance réduite et la quasitotalité de ses données sont redondantes avec RzxItem. De plus certaines informations de RzxComputer sont stockées directement par RzxConfig, qui est elle-même à moitié implémentée par RzxProperty.

En résumé, la structure (déjà modularisée comparée à la version 1.2 dans laquelle RzxConnectionLister n'existait pas et était partie intégrante de RzxRezal) n'est pas facilement maintenable.

=== Interface de plug-ins ===

qRezix 1.6 est la première version à bénéficier d'une structure d'accueil de plug-in. Cette structure est rudimentaire et souffre du fait que qRezix n'est pas modulaire. En effet la classe RzxPlugIn est compilée à la fois dans le plug-in et dans qRezix, ce qui crée des problèmes dès que les deux versions diffèrent.

Pour éviter les problèmes, la version de la strucutre de plug-in est numéroté de façon très stricte, et le filtrage est fait au chargement du plug-in.

Ce défaut entraîne un grand nombre de complication. Les plug-ins n'ont absolument aucun accès direct aux données stockées par qRezix. Toutes les informations transitent donc par des fonction standardisées du plug-in, mais cette méthode de travail limite le nombre d'information pouvant être échangé. Il n'en reste pas moins que cette structure est tout à fait suffisante pour réaliser des plug-ins comme l'Xplo ou SmiliX (qui sont disponible sur la [[Subversion|SVN]] dans le reposoire qrezix-plugins).

Pour pouvoir faire un plug-in pour qRezix, il faut récupérer la dernière version de rzxplugin.h et rzxplugin.cpp dans la branche de release de qRezix correspondante à la version pour laquelle vous voulez faire le plugin. Il suffit alors de créer un projet dérivant de RzxPlugIn. La documentation de RzxPlugIn peut-être générée automatique à l'aide de [http://www.doxygen.org Doxygen] et peut-être trouvée [http://fruneau.eleves.polytechnique.fr/qrezix-1.6/classRzxPlugIn.html ici], de même pour la [http://fruneau.eleves.polytechnique.fr/xplo/ documentation du plug-in Xplo] qui permet d'avoir un bon exemple de plug-in complet.

Cette structure a totalement disparue avec qRezix 2.0 pour être remplacer par des modules plus souple et mieux conçus.

== Branche 2.0 ==

=== Objectif ===

Cette version de qRezix repose sur un double objectif :
* porter le code en Qt4.
* modulariser le programme.

==== Qt4 ====
Le premier point ne présente pas une difficulté énorme, mais a conduit à pas mal de réorganisation du code. En particulier, qRezix 2.0 bénéficie de la puissance du nouveau système Model/View de Qt4, ce qui a nécessiter de redévelopper la quasitotalité de l'interface principale.

La toute dernière version [[Subversion|SVN]] de qRezix utilise [[Qt]] version 4.1.0 minimum. qRezix 2.0 utilise des fonctions introduites dans Qt 4.1, et ne compilera pas avec Qt 4.0.

==== Modularité ====

La modularisation du programme est un point essentiel. Elle apporte un certain nombre d'évolution nécessaire à la survie de qRezix :
* restructuration du programme qui permet une meilleure maintenance
* possibilité de limiter qRezix à certaines fonctionnalités (utile pour l'utilisation chez des personnes qui n'ont pas besoin d'avoir le logiciel complet si par exemple ils n'utilisent jamais le chat).
* possibilité de travailler avec un plus grand nombre de personne sur le projet. Chacun pouvant en effet travailler sur un module
* possibilité de gérer plusieurs protocoles pour se connecter à plusieurs serveurs

=== Structure du programme ===

Le schéma suivant représente de manière simplifié la structure interne de qRezix 2.0.x :

[[Image:qrezix-2.0_structure.png]]

Bien que le nombre d'élément soit impressionnant, cette structure est beaucoup plus propre que celle de qRezix 1.6. Le schéma montre en effet en particulier que les éléments sont proprement séparé, les seuls dépendances entre les modules qu'il peut y avoir sont gérées par la bibliothèque principale.

Le RzxComputer a acquis un rôle beaucoup plus important, il gère désormais la totalité des informations concernant une machine et inclus les actions qu'il est envisageable d'effectuer (propriétés, chat, http, ftp...). Le chat est géré par les modules qui se déclarent comme supportant cette fonctionnalité, de même pour les propriétés.

La fenêtre de préférences (RzxProperty) génère dynamiquement la page de propriétés en fonction de ce que les modules installés désirent. Et tout est mis en oeuvre (au travers de classe abstraites regroupant tous les outils nécessaires) pour que chaque module puisse créer simplement ses propres classes de configuration.

Les modules peuvent être construit soit en built-in soit en plug-in. Aucun n'est nécessaire au fonctionnement du programme (enfin si on retire tous les protos réseau, programme perd beaucoup de son intérêt).

QRezix

2007-02-19T08:52:14Z

Fruneau : Update 2.0.2 Changelog

{{menu projets}}
qRezix est le principal client [[xNet]] encore maintenu. Il doit sa survie à sa qualité d'être le seul client développé qui soit multiplateforme tout en restant graphiquement potable. Il doit ces deux qualités à la bibliothèque [[Qt]].

== Historique ==

=== BR2000 ===

Le projet en lui-même est né avec un groupe de BRmen X2000 menés par Doudou qui étaient fans de Qt (qui à l'époque n'était pas terrible-terrible...). Ils ont travaillé à 3 ou 4 pour sortir la version 1.0 le 4 mars 2002, suivie de près par la version 1.1 le 6 avril. L'équipe de développement comportait entre autres Doudou, MadCoder et Trasfract (Sylvain Joyeux, Pierre Habouzit et Benoït Casoetto).

Le projet s'est principalement inspiré des clients qui existaient déjà à l'époque (Rezix en particulier, duquel qRezix a tiré son nom). Cette architecture simple est une fenêtre avec une liste de client chaque entrée indiquant le nom, la promo, les serveurs... Les favoris sont affichés en premier selon le choix de l'utilisateur.

=== BR2001 ===

Le BR2001 n'a pas énormément travaillé sur qRezix. Il y a eu la version 1.2, mais on n'a aucune trace de ce que JiBee a bien pu faire sur le projet. Ce qui est certain, c'est qu'après la vesion 1.2, il a porté qRezix en Qt3 et a travaillé sur l'internationalisation du projet. Le but d'origine n'était pas de rendre qRezix international, mais simplement de résoudre les problèmes d'encodage des caractères accentués. Le code source a donc totalement été traduit en anglais et une traduction française a été créée.

[[Image:qrezix-1.2.gif|center]]

A priori, il n'y a pas eu de release en Qt3... mais d'après [[User:Ey|Ey]] qui packageait le projet pour Windows, il y en aurait eu... Mais en tout cas à l'arrivée des 2003 c'était toujours la version 1.2 (en Qt2) qui était disponible... Le BR n'avait de plus pas de license pour Qt3 sous Windows.

=== BR2002 ===

Le projet était géré par Steak. La version 1.3 a été release le 1 mai 2004. Cette version n'était absolument par révolutionnaire mais apportait quelques améliorations dans la structure du code et des amélioration du comportement du programme.

Steak a ensuite travaillé sur la version 1.3.666 et en particulier sur l'authentification avec le serveur. Mais il a vite arrêter de travailler sur qRezix en raison du temps qu'il consacrait à l'étude du japonnais, et à différents problèmes occulaires. Cependant, le [[BR2002]] a réalisé une prépassation très avancée ce qui fait que dès le mois de juin, la relève était en place...

=== BR2002/BR2003 : le temps d'une prépassation ===

Le [[BR2003]] a donc commencé sont travail sur qRezix dès le mois de juin 2004.

La première chose a été de recompiler une version pour Windows, ce qui n'avait plus été fait depuis près d'un an. Ceci permettait donc d'envisager de futures release du programme pas uniquement sous Linux. Le travail s'est finalement concentré pendant les vacances d'été avec une amélioration importante de l'interface et de la structure interne (début de séparation de la gestion des connexions de l'affichage), la création d'une structure (pas terrible) de chargement de plug-ins, l'ajout d'icône pour rendre l'interface plus conviviale... La version a été tagguée tour à tour 1.3.666 puis 1.5.

Une autre innovation importante a été le passage du chat qui reposait sur un protocole en UDP vers un protocole TCP. Le but déclaré du BR2002 étant de rendre les communications fiables et sécurisées (on veut savoir si l'autre ne reçoit pas nos messages).

Toutes ces modifications associées au travail de Steak sur l'authentification et le travail de JiBee pour recoder un nouveau [[xNetServer|serveur xNet]], on conduit à la version 1.6 de qRezix qui est sorti le 14 octobre 2004 à la fois pour Windows, Linux et Mac OS X.

[[Image:qrezix-1.6.png|center]]

Face à qRezix 1.6.0 est apparu Rezix.NET qui se voulait innovant. Conséquence de ceci, on a travaillé à 2 avec Steak pour implémenter dans qRezix toutes les fonctionnalité des Rezix.NET. Ce qui a rapidement conduit à la sortie de qRezix 1.6.1 le 22 novembre 2004. C'était la dernière version sur laquelle ait travailler Steak. Rezix.NET (qui était codé en .NET par un membre dissidant du BR2002) n'a finalement pas fait long feu.

=== BR2003 ===

La suite a été plus calme. La préparation de qRezix 1.6.2 s'est faite tranquillement, l'objectif principal était de supprimer un maximum de bugs de cette future version. Les innovations n'ont pas été nombreuses, mais on pourra noter la completion du nick dans le chat avec tab et la recherche intelligente via clavier. Cette version a vu le retour de Ey parmi les développeurs. Elle a aussi été la seule version à bénéficier d'une sortie ayant été précédée de 2 release-candidates qui ont aidées à corriger plusieurs bugs supplémentaires. La version a finalement été sortie le 22 mars 2005.

Le problème de cette version est qu'elle a introduit un bug... enfin plutôt révélé un bug. Jusqu'à présent qRezix plantait en l'absence de réseau ce qui a été corrigé avec la 1.6.2. Mais ce que je n'avais pas remarqué à l'époque c'était qu'en l'absence de réseau qRezix raffraichissait la fenêtre toutes les secondes et en même temps changeait le thême d'icône. Conséquence directe de ce défaut, qRezix prenait 100% du processeur en l'absence de réseau, ce que j'ai eu la chance de constater lors de ma soutenance de modex... Il fallait donc sortir un version avant l'arrivée des 2004 pour éviter que ce bug ne pose trop de problème aux 2004 qui allaient passer leur soutenance de stage. C'est pour ça qu'est sortie la verson 1.6.3 le 1 mai 2005. Cette version innovait au passage une nouvelle organisation plus agréable des propriétés et peut-être globalement considérée comme stable. La version 1.6.4 sortie le 23 septembre apporte peu d'innovation si ce n'est la cache des propriétés, les icônes en 32bits et une meilleure intégration à Mac OS.

Suite à la sortie de Qt4, le port de qRezix vers cette nouvelle mouture de la bibliothèque de Trolltech a été l'occasion de grand remaniement du code. Ceci a abouti à la versin 2.0 de qRezix dont le principal atout est d'être modulaire. La version 2.0.0 est sortie le 6 février 2006, et a rapidement supplanté la version 1.6.x.

[[Image:qrezix-2.0.png|800px|center]]

<div style="border: 1px solid #6f8f9f; padding: .2em .5em .2em .5em; background-color: #EAF5FB">
Pour écrire cette partie, j'ai utilisé mes connaissances personnelles issues ainsi que les informations contenues dans le ChangeLog. Et j'espère bien que d'autres y jetteront un coup d'oeil pour compléter/corriger les parties inexactes.
</div>

=== Versions ===

Voici un description des différentes versions de qRezix. Pour des informations exhaustive, il faut se reporter au ChangeLog du projet.

<table style="border: 1px solid #6f8f9f; width: 100%">
<tr style="padding: .2em .5em .2em .5em; background-color: #EAF5FB">
<th>'''Version'''</th><th>'''Date'''</th><th>'''Changements'''</th>
</tr>
<tr><td>v0.1</td><td>30 janvier 2002</td><td></td></tr>
<tr style="background-color: #FAF5FF;"><td>v0.2</td><td>20 février 2002</td><td></td></tr>
<tr><td>v0.3</td><td>25 février 2002</td><td></td></tr>
<tr style="background-color: #FAF5FF;"><td>'''v1.0'''</td><td>4 mars 2002</td><td></td></tr>
<tr><td>v1.1</td><td>6 avril 2002</td><td></td></tr>
<tr style="background-color: #FAF5FF;"><td>v1.2</td><td>2003</td><td></td></tr>
<tr><td>v1.3</td><td>1er mai 2004</td><td></td></tr>
<tr style="background-color: #FAF5FF;"><td>'''v1.6.0'''</td><td>14 octobre 2004</td><td>
* Passage du chat en TCP
* Ajout de l'authentification des connexions (protocole xNet 3.9)
* Amélioration de l'ergonomie
</td></tr>
<tr><td>v1.6.1</td><td>22 novembre 2004</td><td>
* Ajout d'une 'ignore-list'
* Ajout des notifications d'arrivée/départ des favoris
</td></tr>
<tr style="background-color: #FAF5FF;"><td>v1.6.2</td><td>22 mars 2004</td><td>
* Tab-completion des pseudos dans le chat
* Ajout d'informations (IP, Client, Localisation)
</td></tr>
<tr><td>v1.6.3</td><td>1er mai 2005</td><td>
* Fix principalement un 100% en cas d'absence de réseau
</td></tr>
<tr style="background-color: #FAF5FF;"><td>v1.6.4</td><td>23 septembre 2005</td><td>
* Passage au protocole xNet 4.0
* Ajout du support de BSD
* Sauvegarde des propriétés checkées
</td></tr>
<tr><td>'''v2.0.0'''</td><td>6 février 2006</td><td>
* Réécriture modulaire utilisant Qt4
* Carte permettant de situer visuellement les personnes
* Ajout de la notion de "Groupes"
</td></tr>
<tr style="background-color: #FAF5FF;"><td>v2.0.1</td><td>23 avril 2006</td><td>
* Bugfixes
</td></tr>
<tr><td>''v2.0.2''</td><td>''à venir...''</td><td>
* Meilleure intégration à MacOS X (Support de Growl, ajout de menus...)
* Notification des discussions
* Recherches avancées ne se limitant plus aux pseudo
* Transfert de fichiers
* Bugfixes
</td></tr>
</table>

== Développement ==

Cette partie a pour but de présenter brièvement l'état du projet à travers l'organisation du développement.

=== Outils nécessaires ===

* Le développement de qRezix se fait comme tous les projets du BR via un système de partage de projet : [[Subversion|SVN]]. Il est donc nécessaire d'installer un client [[Subversion|SVN]] pour travailler. Sous Linux et Mac OS, il y a des packages de SVN qui sont distribués. Sous Windows, il est fortement conseillé d'utiliser [http://tortoisesvn.tigris.org TortoiseSVN]. Pour plus d'information sur SubVersion, merci de vous référer à la [[Subversion|page correspondante]].

* Il faut également installer [[Qt]], la version dépend de la branche de travail. Pour qRezix 1.6, il faut utiliser Qt3 (3.3.3 ou ultérieure) alors que pour qRezix 1.7, Qt4 (4.0.1 ou ultérieure). Pour obtenir Qt3 pour Windows, merci de demander à [[User:Fruneau|Fruneau]]. Pour Qt4, il faut faire attention sur certaine distribution de bien installer tous les modules nécessaires (au moins Core, GUI et Network) et les outils qui vont avec (designer, linguist, assistant).

* Pour générer la documentation il peut être intéressant d'installer également [http://www.doxygen.org Doxygen]. La plupart du temps l'utilisation de Doxygen est très simple : il suffit de l'appliquer au fichier Doxyfile qui se trouve à la racine du projet.
doxygen Doxyfile

=== Structure de la SVN ===

Pour ce qui est de l'utilisation de SVN, je vous laisse vous référer à la [[Subversion#Utilisation_de_svn|page correspondante]]. Cette partie à plutôt pour but d'expliquer comment utiliser la SVN pour travailler sur qRezix.

Tout d'abord, il est important de noter que qRezix utilise une structure tout ce qu'il y a de plus classique (avec trunk, branches et tags). Le trunk étant la branche principale du projet.

==== Travailler sur la branche principale ====

La branche principale du projet correspond à la version qui évolue actuellement. A l'heure actuelle c'est la 1.6.x. Cette branche change régulièrement et on peut y trouver les dernières innovations réalisée sur cette branche. Lorsqu'on s'approche d'une release de qRezix, il faut freezer la branche principale. Pour ceci, on sépare le développement de la version qui va sortir de celui de la branche principale.

Par exemple pour release qRezix 1.6.4, j'ai freezé la branche environ 1 semaine et demi avant la sortie via :
svn copy trunk branches/qrezix--release--1.6.4

Une fois les branches séparées, la branche de release ne doit plus subir que des corrections de bugs. En cas de besoin, on pourra sortir des pre-release (rc). Une fois qu'une version est considérée stable, on la tag, c'est à dire qu'on fait une photographie instantannée du projet :
svn copy branches/qrezix--release--1.6.4 tags/qrezix--1.6.4-rc1 # pour une préversion
svn copy branches/qrezix--release--1.6.4 tags/qrezix--1.6.4 # pour la version définitive

On peut même envisager alors des révisions sur la version actuelle qui serait des bugfixes de la branche de release intervenu après la sortie. Dans ce cas, on aurait
svn copy branches/qrezix--release--1.6.4 tags/qrezix--1.6.4-r1 # pour une révision de la version

Ceci peut paraître contraignant, mais c'est la base d'un projet mené correctement. Ca permet d'avoir un historique des branches et des versions, de pouvoir envisager de sortir des révisions de toutes les branches de release en cas de découverte d'une faille importante du programme et ça évite surtout d'avoir une version qui s'éternise... lorsqu'on décide de freezer une version, ceux qui veulent continuer à innover travaillent sur le trunk pendant que d'autres stabilise la version de release.

==== Branches de devel ====

A côté de la branche principale, il peut y avoir des branches de devel. Alors que la différence entre 2 releases issues d'une même branche sont le plus souvent mineures voire de la simple maintenance, la différence entre le trunk et la branches de devel est quelque chose de beaucoup plus important. La branche de devel apporte des innonvations importantes et devrait conduire à une nouvelle version majeure du programme.

La branche de devel Qt4 vient d'être passée en branche principale.

==== Numérotation des versions ====

Comme pour tout programme, qRezix a des versions numérotées de la forme X.Y.Z-T
* X est la version majeure, il ne change que lors de modification très importantes de la structure du programme.
* Y est la version mineure, il change lorsque le programme a subit des évolution plus importante qu'une simple maintenance.
* Z est la version de maintenance, il change lorsque le programme subit des bugfixes et l'implémentation de fonctionnalités mineures.
* T est le tag

L'utilisation du tag est particulières :
* ''svn'' pour une version de développement avant les releases ou pre-release.
* ''alpha'' pour une pré-version non encore formalisée d'une nouvelle version majeure ou mineure du programme (2.0.0-alpha1 ou 1.7.0-alpha2 mais pas 1.6.5-alpha1)
* ''beta'' pour une pré-version formalisée d'une nouvelle version majeure ou mineure du programme (2.0.0-beta1 ou 1.7.0-beta2 mais pas 1.6.5-beta1)
* ''rc'' pour une version candidate à la release. Elle sert uniquement à la recherche de derniers bugs (1.6.2-rc1)
* ''r'' pour une révision d'une version déjà sortie. Elle sert uniquement à corriger de graves anomalies de la version (1.6.4-r1)

De manière générale, la numérotation doit être effectuée comme suit :
# A la release de la version X.Y.Z, la branche principale passe ne X.Y.(Z+1)-svn
# Si le besoin s'en fait sentir, des versions alpha, puis bêta et enfin rc peuvent être sorties. Mais attention, une version alpha doit être suivie d'au moins une version bêta puis d'une rc.
# Lorsque la version est considérée stable, elle est détaguée, et la release est effectuée. On revient dès lors au point 1

=== Traductions ===

Les traductions (gentil fardeau offert par JiBee), sont générée relativement simplement par Qt. Pour ceci, il faut procéder dans l'ordre :
* Dans le code, mettre les chaîne à traduire soit dans des tr("mon texte") ou QT_TR_NOOP("mon texte"). Le deuxième cas étant pour les textes qui se trouvent dans les définitions statiques.
* Générer le fichier d'index à l'aide de lupdate sur le projet :
# Pour qRezix 1.6
lupdate qrezix.pro
# Pour qRezix 2.0
lupdate */*.pro
* Editer les fichiers .ts avec Qt Linguist, et enregistrer les modifications. Les fichiers .ts sont dans le répertoires ''translations''.
* Compiler les fichiers .ts à l'aide de lrelease ou de Qt Linguist.
cd translations
lrelease *.ts
* Commiter le tout...

=== Documentation ===

La documentation de qRezix est composée de cette page, de la doc de l'API qu'il est possible de générer grâce à Doxygen, ainsi que de tout ce que vous pourrez trouver sur [http://fruneau cette page]. Dans tous les cas, la meilleure doc restera toujours une personne qui connait bien le projet :)...

Dans l'état actuel des choses, la meilleure doc de qRezix, c'est [[User:Fruneau|moi]].

=== Compiler qRezix ===

La compilation de qRezix n'est pas forcément une opération triviale, et dépend fortement de l'OS sur lequel on travail. La plupart des informations nécessaires sont contenues dans le fichier INSTALL. Voici quelques suppléments qui pourront toutefois être utiles :

==== Windows ====

Sous Windows, à l'heure actuelle, on compile avec Visual C++ 7.1 ou supérieur (qRezix ne compile pas avec VC++ 6). A l'heure actuelle, VC++ ne permet pas de compiler les modules en tant que tels car il est incapable de charger les membres de classes dans les DLL. On est donc forcés de tout compiler en un bloc en passant l'option "RZX_ALL_BUILTIN" à la compilation.

Tout d'abord il faut ouvrir une nouvelle console Visual Studio (pour avoir les variables d'environnement correctement définies). Dans cette console :
qmake qrezix.pro
nmake

Si vous compilez une version SVN de qRezix, vous pouvez exécuter SubWCRev.exe pour convertir les occurences de $WCREV$ en numéro de révision.

Le packaging se fait à l'aidre de [http://nsis.sourceforge.net/Main_Page NSIS] en compilant le script qui est dans le répertoire package/windows

==== Linux ====

Sous Linux, il suffit de procéder strictement comme indiqué dans le fichier INSTALL
qmake qrezix.pro # cet appel est nécessaire dès que la structure du programme est modifiée...
make
qmake qrezix.pro # ce deuxième appel n'est nécessaire qu'à la première compilation où lors de l'apparition de nouveaux fichiers à installer
sudo make install

Pour mettre à jour le numéro de révision il peut être utile de forcer la recompilation de certaines parties du core :
touch core/core.pro
touch core/rzxapplication.cpp
make

Le packaging dépend énormément de la distribution... mais consiste dans la plupart des cas à réaliser une installation dans un chroot, l'archiver et lui ajouter les informations de packages (dépendants de la distribution... rpm, deb...).

<div style="border: 1px solid #9f6f8f; padding: .2em .5em .2em .5em; background-color: #FBEAF5">
Pour packager il faut partir d'un export de la SVN et non pas d'un checkout... Sinon les répertoires .svn resteront présents et peuvent fortement allourdir le paquet ou induire qRezix en erreur dans certains cas.
</div>

==== MacOS X ====

Sous MacOS X, un script est prévu pour réaliser la compilation. Il gère un certain nombre de problèmes liés à MacOS X, et il est fortement déconseillé de ne pas l'utiliser. Donc, pour compiler et créer un bundle utilisable il suffit de lancer la commande :
./build-mac

Pour compiler sous MacOS X il est nécessaire d'avoir installer la SDK de Growl. Et une fois compilé, de mettre Growl-withInstaller.framework dans le bundle qRezix.app/Content/Frameworks, sans quoi qRezix refusera de se lancer.

Ce script peut prendre un certain nombre de paramètres :
* -v : mode verbeux (affiche la sortie de make, qmake...)
* -q : ne lance pas les qmake (si cette option est ajoutée, le numéro de révision ne sera pas mis à jour dans la fenêtre de préférence)
* -jx : option -j de make (attention, la compilation universal binaries utilise déjà les 2 processeurs des biprocs)
* ... : toutes les autres options sont ajoutées aux CXXFLAGS

Pour packager qRezix pour MacOS, il suffit d'exécuter un autre script qui récupère le bundle de build-mac, le nettoie, y ajoute Qt et règle les dépendances des bibliothèques.
cd package/macosx
./package

<div style="border: 1px solid #6f8f9f; padding: .2em .5em .2em .5em; background-color: #EAF5FB">
Pour ceux qui voudraient profiter de Xcode, qmake peut générer des projet Xcode à partir du fichier .pro en exécutant :
qmake -spec macx-pbuilder machin.pro
Mais ceci mérite des test approfondis et une attention accrue pour éviter de délaisser le fichier .pro nécessaire pour les autres plateformes une fois le projet généré.
</div>

=== Coding Rules ===

Il est important de respecter un certain nombre de règles lorsqu'on travail sur un projet collectif. De fait, tout développeur de qRezix est prié de se tenir aux recommandations qui suivent :

<table style="border: 1px solid #6f8f9f; width: 100%">
<tr style="padding: .2em .5em .2em .5em; background-color: #EAF5FB">
<th colspan="2">'''Nomenclature'''</th>
</tr>
<tr>
<td>Les noms des classes sont préfixés par Rzx</td>
<td rowspan="5"><pre>
class RzxApplication
{
bool valid;

public:
bool isValid() const;
};
</pre></td>
</tr>
<tr style="background-color: #FAF5FF">
<td>Les noms des fonctions commencent par une minuscule</td>
</tr>
<tr>
<td>L'utilisation d'underscore est à éviter. On préférera utiliser des nom dont les séparations sont des majuscules</td>
</tr>
<tr style="background-color: #FAF5FF">
<td>La langue à utiliser de préférence est '''l'anglais'''</td>
</tr>
<tr>
<td>Les noms des fonctions/methodes doivent être cohérents avec les APIs Qt et qRezix, on évitera par exemple les getMyVar() en privilégiant myVar().</td>
</tr>
<tr style="padding: .2em .5em .2em .5em; background-color: #EAF5FB">
<th colspan="2">'''Accolades'''</th>
</tr>
<tr>
<td>Les accolades ouvrantes comme fermantes sont placées après un retour à la ligne</td>
<td rowspan="3"><pre>
if(a == b || c != d)
{
a = b + 1;
do(truc);
}

void RzxMyFunction::do() const
{
<bloc>;
}

class RzxMyClass
{
};
</pre></td>
</tr>
<tr style="background-color: #FAF5FF">
<td>Les opérateurs sont entourés d'espaces</td>
</tr>
<tr>
<td>Les parenthèse sont collées à l'opération associée (nom de fonction, contrôle de flux...)</td>
</tr>
<tr style="padding: .2em .5em .2em .5em; background-color: #EAF5FB">
<th colspan="2">'''Indentation'''</th>
</tr>
<tr>
<td>Les indentation sont réalisées à l'aide de ''tabulation''</td>
<td rowspan="4"><pre>
class RzxMyClass
{
<firstbloc>

public:
<secondbloc>

protected:
<thirdbloc>
};

switch(value)
{
case 1:
<bloc1>;

case 2:
<bloc2>;

case 3:
<bloc3>;
}

#if CASE1
# define MACHIN
#endif
</pre></td>
</tr>
<tr style="background-color: #FAF5FF">
<td>Les mots clés comme public: ou case: sont indentés et entraînent une indentation supplémentaire jusqu'au prochain mot clé</td>
</tr>
<tr>
<td>Ne pas oublier d'indenter également le préprocesseur</td>
</tr>
<tr style="background-color: #FAF5FF">
<td>Les fichiers doivent finir par une ligne vide</td>
</tr>
<tr style="padding: .2em .5em .2em .5em; background-color: #EAF5FB">
<th colspan="2">'''Commentaires et documentation'''</th>
</tr>
<tr>
<td>Les objets doivent être documentées à l'aide des syntaxe de Doxygen</td>
<td rowspan="3"><pre>
///Ceci est une description rapide
/** Ceci est une description avancée de la fonction
*/
void myFunction()
{
if(machin) // Le cas machin peut poser problème, on le traite donc à part
{
}

// TODO: implémenter le reste de la fonction

}
</pre></td>
</tr>
<tr style="background-color: #FAF5FF">
<td>A l'exception de la documentation des fonctions, on préférera les commentaires de la forme // Mon commentaire en français</td>
</tr>
<tr>
<td>// TODO: peut également être utilisé pour spécifier des implémentations à réaliser</td>
</tr>
</table>

== Branche 1.6 ==

=== Structure du programme ===

La structure interne du programme peut-être résumée au schéma suivant :

[[Image:qrezix-1.6_structure.png]]

Ce schéma n'est pas exhaustif, mais met en évidence les différentes imbrications des éléments. Toutes les cadres qui se chevauchent (et le cas échéant se contiennet) représente des classes qui sont imbriquées l'une à l'autre. Ansi la classe QRezix qui gère la totalité du programme est totalement dépendante de la quasitotalité des autres classes, la classe RzxConnectionLister dont le but est de lister les personnes est complètement dépendante de RzxRezal et vice-versa (il y a même des redondances de stockage)... idem, pour le chat qui est géré partiellement par RzxConnectionLister et partiellement par RzxRezal.

La classe RzxComputer a une importance réduite et la quasitotalité de ses données sont redondantes avec RzxItem. De plus certaines informations de RzxComputer sont stockées directement par RzxConfig, qui est elle-même à moitié implémentée par RzxProperty.

En résumé, la structure (déjà modularisée comparée à la version 1.2 dans laquelle RzxConnectionLister n'existait pas et était partie intégrante de RzxRezal) n'est pas facilement maintenable.

=== Interface de plug-ins ===

qRezix 1.6 est la première version à bénéficier d'une structure d'accueil de plug-in. Cette structure est rudimentaire et souffre du fait que qRezix n'est pas modulaire. En effet la classe RzxPlugIn est compilée à la fois dans le plug-in et dans qRezix, ce qui crée des problèmes dès que les deux versions diffèrent.

Pour éviter les problèmes, la version de la strucutre de plug-in est numéroté de façon très stricte, et le filtrage est fait au chargement du plug-in.

Ce défaut entraîne un grand nombre de complication. Les plug-ins n'ont absolument aucun accès direct aux données stockées par qRezix. Toutes les informations transitent donc par des fonction standardisées du plug-in, mais cette méthode de travail limite le nombre d'information pouvant être échangé. Il n'en reste pas moins que cette structure est tout à fait suffisante pour réaliser des plug-ins comme l'Xplo ou SmiliX (qui sont disponible sur la [[Subversion|SVN]] dans le reposoire qrezix-plugins).

Pour pouvoir faire un plug-in pour qRezix, il faut récupérer la dernière version de rzxplugin.h et rzxplugin.cpp dans la branche de release de qRezix correspondante à la version pour laquelle vous voulez faire le plugin. Il suffit alors de créer un projet dérivant de RzxPlugIn. La documentation de RzxPlugIn peut-être générée automatique à l'aide de [http://www.doxygen.org Doxygen] et peut-être trouvée [http://fruneau.eleves.polytechnique.fr/qrezix-1.6/classRzxPlugIn.html ici], de même pour la [http://fruneau.eleves.polytechnique.fr/xplo/ documentation du plug-in Xplo] qui permet d'avoir un bon exemple de plug-in complet.

Cette structure a totalement disparue avec qRezix 2.0 pour être remplacer par des modules plus souple et mieux conçus.

== Branche 2.0 ==

=== Objectif ===

Cette version de qRezix repose sur un double objectif :
* porter le code en Qt4.
* modulariser le programme.

==== Qt4 ====
Le premier point ne présente pas une difficulté énorme, mais a conduit à pas mal de réorganisation du code. En particulier, qRezix 2.0 bénéficie de la puissance du nouveau système Model/View de Qt4, ce qui a nécessiter de redévelopper la quasitotalité de l'interface principale.

La toute dernière version [[Subversion|SVN]] de qRezix utilise [[Qt]] version 4.1.0 minimum. qRezix 2.0 utilise des fonctions introduites dans Qt 4.1, et ne compilera pas avec Qt 4.0.

==== Modularité ====

La modularisation du programme est un point essentiel. Elle apporte un certain nombre d'évolution nécessaire à la survie de qRezix :
* restructuration du programme qui permet une meilleure maintenance
* possibilité de limiter qRezix à certaines fonctionnalités (utile pour l'utilisation chez des personnes qui n'ont pas besoin d'avoir le logiciel complet si par exemple ils n'utilisent jamais le chat).
* possibilité de travailler avec un plus grand nombre de personne sur le projet. Chacun pouvant en effet travailler sur un module
* possibilité de gérer plusieurs protocoles pour se connecter à plusieurs serveurs

=== Structure du programme ===

Le schéma suivant représente de manière simplifié la structure interne de qRezix 2.0.x :

[[Image:qrezix-2.0_structure.png]]

Bien que le nombre d'élément soit impressionnant, cette structure est beaucoup plus propre que celle de qRezix 1.6. Le schéma montre en effet en particulier que les éléments sont proprement séparé, les seuls dépendances entre les modules qu'il peut y avoir sont gérées par la bibliothèque principale.

Le RzxComputer a acquis un rôle beaucoup plus important, il gère désormais la totalité des informations concernant une machine et inclus les actions qu'il est envisageable d'effectuer (propriétés, chat, http, ftp...). Le chat est géré par les modules qui se déclarent comme supportant cette fonctionnalité, de même pour les propriétés.

La fenêtre de préférences (RzxProperty) génère dynamiquement la page de propriétés en fonction de ce que les modules installés désirent. Et tout est mis en oeuvre (au travers de classe abstraites regroupant tous les outils nécessaires) pour que chaque module puisse créer simplement ses propres classes de configuration.

Les modules peuvent être construit soit en built-in soit en plug-in. Aucun n'est nécessaire au fonctionnement du programme (enfin si on retire tous les protos réseau, programme perd beaucoup de son intérêt).

Qt

2006-12-11T22:52:13Z

Fruneau : y'a une gestion du systray en Qt 4.2

== Présentation sommaire ==

[http://www.trolltech.com/qt Qt] est une bibliothèque en C++ multiplateforme.

Qt est distribué, depuis la version 4, sous license GPL sur toutes les plateformes (la nouveauté de cette version étant la version OpenSource pour Windows). Ce qui en fait un outil bien adapté au travail du BR. Néanmoins, le BR avait auparavant des accords qui nous fournissent la version commerciale pour Windows.

=== Intérêts ===
* l'abstraction du système d'exploitation est très poussée, sans pour autant empêcher de travailler de manière spécifique au système d'exploitation. Qt va même jusqu'à inclure des fonctions OS-specific pour faciliter le travail du programmeur.
* l'API est très intuitive (surtout celle de Qt4).
* Qt implémente des outils de haut-niveau qui rende la programmation très facile (le système de signal-slot par exemple est bien plus intuitif que le principe de callbacks) et qui limite le risque de bugs, tout en restant en C++ ce qui offre la flexibilité du C et la possibilité de garder du code de bas-niveau.
* Qt permet de développer facilement un programme traduit en plusieurs langues.
* Qt offre un système de skinnage de l'interface très puissant.
* la documentation est très complète et très bien conçue.
* Qt est réputé pour sa bibliothèque de templates puissante et non-buggée

=== Défauts ===
* La compilation du programme est très lourde en raison d'un grand nombre de définition inline
* L'exécution du programme peut-être plus lente que celle d'un programme en GTK (par exemple) en raison de la forte abstraction de la boucle principale par le système de signals-slots.

== Educationnal Licensing ==

Le BR dispose d'un accord avec Trolltech qui permet d'obtenir gratuitement 100 licenses Qt Windows. Cet accord est valide jusqu'en 2029 et a été négocié en octobre/novembre 2004 alors que Qt pour Windows n'existait qu'en version commerciale.

=== Fonctionnement ===

Le principe de l'Educationnal Licensing est simple : Trolltech met à notre disposition sur un site de téléchargement les packages pour Windows :
[http://dist.trolltech.com/ericgrus/]. Ce téléchargement est protégé par mot de passe, et l'accès sera pour éviter les problèmes restreint à une nombre limité de personnes. Dans tous les cas, pour toute information il suffit de contacter [[User:GUI|GUI]], ou éventuellement [[User:Fruneau|Fruneau]].

On dispose à côté de ceci d'un numéro de license attribué à l'Ecole Polytechnique. Il est important de noter que dans ce cadre particulier, le BR a négocié directement avec Trolltech des licenses qui dans les termes du système de license sont destinées à l'établissement d'enseignement.

=== De l'intérêt de conserver les licenses commerciales ===

Maintenant que Qt est en version libre sur tous les OS, on peut se demander pourquoi le BR conserve ses contacts chez Trolltech. La raison est simple : la version commerciale apporte des outils d'intégration aux IDE qui sont non-négligeables pour pouvoir recruter des programmeurs qui ne sont pas habitués aux outils du monde du Logiciel Libre. Dans la version que nous avons actuellement, il y a les outils d'intégration à Visual Studio, qui fait partie des programmes disponibles gratuitement pour les élèves sur le plateau par le biais du [[MSDNAA]].

Utilisateur:Fruneau

2006-11-08T22:11:58Z

Fruneau : Fix X.org URL

QRezix

2006-07-08T10:13:09Z

Fruneau : /* Windows */ le RZX_ALL_BUILTIN n'est plus nécessaire sous windows (activé par défaut)

{{menu projets}}
qRezix est le principal client [[xNet]] encore maintenu. Il doit sa survie à sa qualité d'être le seul client développé qui soit multiplateforme tout en restant graphiquement potable. Il doit ces deux qualités à la bibliothèque [[Qt]].

== Historique ==

=== BR2000 ===

Le projet en lui-même est né avec un groupe de BRmen X2000 menés par Doudou qui étaient fans de Qt (qui à l'époque n'était pas terrible-terrible...). Ils ont travaillé à 3 ou 4 pour sortir la version 1.0 le 4 mars 2002, suivie de près par la version 1.1 le 6 avril. L'équipe de développement comportait entre autres Doudou, MadCoder et Trasfract (Sylvain Joyeux, Pierre Habouzit et Benoït Casoetto).

Le projet s'est principalement inspiré des clients qui existaient déjà à l'époque (Rezix en particulier, duquel qRezix a tiré son nom). Cette architecture simple est une fenêtre avec une liste de client chaque entrée indiquant le nom, la promo, les serveurs... Les favoris sont affichés en premier selon le choix de l'utilisateur.

=== BR2001 ===

Le BR2001 n'a pas énormément travaillé sur qRezix. Il y a eu la version 1.2, mais on n'a aucune trace de ce que JiBee a bien pu faire sur le projet. Ce qui est certain, c'est qu'après la vesion 1.2, il a porté qRezix en Qt3 et a travaillé sur l'internationalisation du projet. Le but d'origine n'était pas de rendre qRezix international, mais simplement de résoudre les problèmes d'encodage des caractères accentués. Le code source a donc totalement été traduit en anglais et une traduction française a été créée.

[[Image:qrezix-1.2.gif|center]]

A priori, il n'y a pas eu de release en Qt3... mais d'après [[User:Ey|Ey]] qui packageait le projet pour Windows, il y en aurait eu... Mais en tout cas à l'arrivée des 2003 c'était toujours la version 1.2 (en Qt2) qui était disponible... Le BR n'avait de plus pas de license pour Qt3 sous Windows.

=== BR2002 ===

Le projet était géré par Steak. La version 1.3 a été release le 1 mai 2004. Cette version n'était absolument par révolutionnaire mais apportait quelques améliorations dans la structure du code et des amélioration du comportement du programme.

Steak a ensuite travaillé sur la version 1.3.666 et en particulier sur l'authentification avec le serveur. Mais il a vite arrêter de travailler sur qRezix en raison du temps qu'il consacrait à l'étude du japonnais, et à différents problèmes occulaires. Cependant, le [[BR2002]] a réalisé une prépassation très avancée ce qui fait que dès le mois de juin, la relève était en place...

=== BR2002/BR2003 : le temps d'une prépassation ===

Le [[BR2003]] a donc commencé sont travail sur qRezix dès le mois de juin 2004.

La première chose a été de recompiler une version pour Windows, ce qui n'avait plus été fait depuis près d'un an. Ceci permettait donc d'envisager de futures release du programme pas uniquement sous Linux. Le travail s'est finalement concentré pendant les vacances d'été avec une amélioration importante de l'interface et de la structure interne (début de séparation de la gestion des connexions de l'affichage), la création d'une structure (pas terrible) de chargement de plug-ins, l'ajout d'icône pour rendre l'interface plus conviviale... La version a été tagguée tour à tour 1.3.666 puis 1.5.

Une autre innovation importante à été le passage du chat qui reposait sur un protocole en UDP vers un protocole TCP. Le but déclaré du BR2002 étant de rendre les communication fiables et sécurisées (on veut savoir si l'autre ne reçoit pas nos messages).

Toutes ces modifications associées au travail de Steak sur l'authentification et le travail de JiBee pour recoder un nouveau [[xNetServer|serveur xNet]], on conduit à la version 1.6 de qRezix qui est sorti le 14 octobre 2004 à la fois pour Windows, Linux et Mac OS X.

[[Image:qrezix-1.6.png|center]]

Face à qRezix 1.6.0 est apparu Rezix.NET qui se voulait innovant. Conséquence de ceci, on a travaillé à 2 avec Steak pour implémenter dans qRezix toutes les fonctionnalité des Rezix.NET. Ce qui a rapidement conduit à la sortie de qRezix 1.6.1 le 22 novembre 2004. C'était la dernière version sur laquelle ait travailler Steak. Rezix.NET (qui était codé en .NET par un membre dissidant du BR2002) n'a finalement pas fait long feu.

=== BR2003 ===

La suite a été plus calme. La préparation de qRezix 1.6.2 s'est faite tranquillement, l'objectif principal était de supprimer un maximum de bugs de cette future version. Les innovations n'ont pas été nombreuses, mais on pourra noter la completion du nick dans le chat avec tab et la recherche intelligente via clavier. Cette version a vu le retour de Ey parmi les développeurs. Elle a aussi été la seule version à bénéficier d'une sortie ayant été précédée de 2 release-candidates qui ont aidées à corriger plusieurs bugs supplémentaires. La version a finalement été sortie le 22 mars 2005.

Le problème de cette version est qu'elle a introduit un bug... enfin plutôt révélé un bug. Jusqu'à présent qRezix plantait en l'absence de réseau ce qui a été corrigé avec la 1.6.2. Mais ce que je n'avais pas remarqué à l'époque c'était qu'en l'absence de réseau qRezix raffraichissait la fenêtre toutes les secondes et en même temps changeait le thême d'icône. Conséquence directe de ce défaut, qRezix prenait 100% du processeur en l'absence de réseau, ce que j'ai eu la chance de constater lors de ma soutenance de modex... Il fallait donc sortir un version avant l'arrivée des 2004 pour éviter que ce bug ne pose trop de problème aux 2004 qui allaient passer leur soutenance de stage. C'est pour ça qu'est sortie la verson 1.6.3 le 1 mai 2005. Cette version innovait au passage une nouvelle organisation plus agréable des propriétés et peut-être globalement considérée comme stable. La version 1.6.4 sortie le 23 septembre apporte peu d'innovation si ce n'est la cache des propriétés, les icônes en 32bits et une meilleure intégration à Mac OS.

Suite à la sortie de Qt4, le port de qRezix vers cette nouvelle mouture de la bibliothèque de Trolltech a été l'occasion de grand remaniement du code. Ceci a abouti à la versin 2.0 de qRezix dont le principal atout est d'être modulaire. La version 2.0.0 est sortie le 6 février 2006, et a rapidement supplanté la version 1.6.x.

[[Image:qrezix-2.0.png|800px|center]]

<div style="border: 1px solid #6f8f9f; padding: .2em .5em .2em .5em; background-color: #EAF5FB">
Pour écrire cette partie, j'ai utilisé mes connaissances personnelles issues ainsi que les informations contenues dans le ChangeLog. Et j'espère bien que d'autres y jetteront un coup d'oeil pour compléter/corriger les parties inexactes.
</div>

=== Versions ===

Voici un description des différentes versions de qRezix. Pour des informations exhaustive, il faut se reporter au ChangeLog du projet.

<table style="border: 1px solid #6f8f9f; width: 100%">
<tr style="padding: .2em .5em .2em .5em; background-color: #EAF5FB">
<th>'''Version'''</th><th>'''Date'''</th><th>'''Changements'''</th>
</tr>
<tr><td>v0.1</td><td>30 janvier 2002</td><td></td></tr>
<tr style="background-color: #FAF5FF;"><td>v0.2</td><td>20 février 2002</td><td></td></tr>
<tr><td>v0.3</td><td>25 février 2002</td><td></td></tr>
<tr style="background-color: #FAF5FF;"><td>'''v1.0'''</td><td>4 mars 2002</td><td></td></tr>
<tr><td>v1.1</td><td>6 avril 2002</td><td></td></tr>
<tr style="background-color: #FAF5FF;"><td>v1.2</td><td>2003</td><td></td></tr>
<tr><td>v1.3</td><td>1er mai 2004</td><td></td></tr>
<tr style="background-color: #FAF5FF;"><td>'''v1.6.0'''</td><td>14 octobre 2004</td><td>
* Passage du chat en TCP
* Ajout de l'authentification des connexions (protocole xNet 3.9)
* Amélioration de l'ergonomie
</td></tr>
<tr><td>v1.6.1</td><td>22 novembre 2004</td><td>
* Ajout d'une 'ignore-list'
* Ajout des notifications d'arrivée/départ des favoris
</td></tr>
<tr style="background-color: #FAF5FF;"><td>v1.6.2</td><td>22 mars 2004</td><td>
* Tab-completion des pseudos dans le chat
* Ajout d'informations (IP, Client, Localisation)
</td></tr>
<tr><td>v1.6.3</td><td>1er mai 2005</td><td>
* Fix principalement un 100% en cas d'absence de réseau
</td></tr>
<tr style="background-color: #FAF5FF;"><td>v1.6.4</td><td>23 septembre 2005</td><td>
* Passage au protocole xNet 4.0
* Ajout du support de BSD
* Sauvegarde des propriétés checkées
</td></tr>
<tr><td>'''v2.0.0'''</td><td>6 février 2006</td><td>
* Réécriture modulaire utilisant Qt4
* Carte permettant de situer visuellement les personnes
* Ajout de la notion de "Groupes"
</td></tr>
<tr style="background-color: #FAF5FF;"><td>v2.0.1</td><td>23 avril 2006</td><td>
* Bugfixes
</td></tr>
<tr><td>''v2.0.2''</td><td>''à venir...''</td><td>
* Meilleure intégration à MacOS X (Support de Growl, ajout de menus...)
* Notification des discussions
* Recherches avancées ne se limitant plus aux pseudo
* Bugfixes
</td></tr>
</table>

== Développement ==

Cette partie a pour but de présenter brièvement l'état du projet à travers l'organisation du développement.

=== Outils nécessaires ===

* Le développement de qRezix se fait comme tous les projets du BR via un système de partage de projet : [[Subversion|SVN]]. Il est donc nécessaire d'installer un client [[Subversion|SVN]] pour travailler. Sous Linux et Mac OS, il y a des packages de SVN qui sont distribuer. Sous Windows, il est fortement conseillé d'utiliser [http://tortoisesvn.tigris.org TortoiseSVN]. Pour plus d'information sur SubVersion, merci de vous référer à la [[Subversion|page correspondante]].

* Il faut également installer [[Qt]], la version dépend de la branche de travail. Pour qRezix 1.6, il faut utiliser Qt3 (3.3.3 ou ultérieure) alors que pour qRezix 1.7, Qt4 (4.0.1 ou ultérieure). Pour obtenir Qt3 pour Windows, merci de demander à [[User:Fruneau|Fruneau]]. Pour Qt4, il faut faire attention sur certaine distribution de bien installer tous les modules nécessaires (au moins Core, GUI et Network) et les outils qui vont avec (designer, linguist, assistant).

* Pour générer la documentation il peut être intéressant d'installer également [http://www.doxygen.org Doxygen]. La plupart du temps l'utilisation de Doxygen est très simple : il suffit de l'appliquer au fichier Doxyfile qui se trouve à la racine du projet.
doxygen Doxyfile

=== Structure de la SVN ===

Pour ce qui est de l'utilisation de SVN, je vous laisse vous référer à la [[Subversion#Utilisation_de_svn|page correspondante]]. Cette partie à plutôt pour but d'expliquer comment utiliser la SVN pour travailler sur qRezix.

Tout d'abord, il est important de noter que qRezix utilise une structure tout ce qu'il y a de plus classique (avec trunk, branches et tags). Le trunk étant la branche principale du projet.

==== Travailler sur la branche principale ====

La branche principale du projet correspond à la version qui évolue actuellement. A l'heure actuelle c'est la 1.6.x. Cette branche change régulièrement et on peut y trouver les dernières innovations réalisée sur cette branche. Lorsqu'on s'approche d'une release de qRezix, il faut freezer la branche principale. Pour ceci, on sépare le développement de la version qui va sortir de celui de la branche principale.

Par exemple pour release qRezix 1.6.4, j'ai freezé la branche environ 1 semaine et demi avant la sortie via :
svn copy trunk branches/qrezix--release--1.6.4

Une fois les branches séparées, la branche de release ne doit plus subir que des corrections de bugs. En cas de besoin, on pourra sortir des pre-release (rc). Une fois qu'une version est considérée stable, on la tag, c'est à dire qu'on fait une photographie instantannée du projet :
svn copy branches/qrezix--release--1.6.4 tags/qrezix--1.6.4-rc1 # pour une préversion
svn copy branches/qrezix--release--1.6.4 tags/qrezix--1.6.4 # pour la version définitive

On peut même envisager alors des révisions sur la version actuelle qui serait des bugfixes de la branche de release intervenu après la sortie. Dans ce cas, on aurait
svn copy branches/qrezix--release--1.6.4 tags/qrezix--1.6.4-r1 # pour une révision de la version

Ceci peut paraître contraignant, mais c'est la base d'un projet mené correctement. Ca permet d'avoir un historique des branches et des versions, de pouvoir envisager de sortir des révisions de toutes les branches de release en cas de découverte d'une faille importante du programme et ça évite surtout d'avoir une version qui s'éternise... lorsqu'on décide de freezer une version, ceux qui veulent continuer à innover travaillent sur le trunk pendant que d'autres stabilise la version de release.

==== Branches de devel ====

A côté de la branche principale, il peut y avoir des branches de devel. Alors que la différence entre 2 releases issues d'une même branche sont le plus souvent mineures voire de la simple maintenance, la différence entre le trunk et la branches de devel est quelque chose de beaucoup plus important. La branche de devel apporte des innonvations importantes et devrait conduire à une nouvelle version majeure du programme.

La branche de devel Qt4 vient d'être passée en branche principale.

==== Numérotation des versions ====

Comme pour tout programme, qRezix a des versions numérotées de la forme X.Y.Z-T
* X est la version majeure, il ne change que lors de modification très importantes de la structure du programme.
* Y est la version mineure, il change lorsque le programme a subit des évolution plus importante qu'une simple maintenance.
* Z est la version de maintenance, il change lorsque le programme subit des bugfixes et l'implémentation de fonctionnalités mineures.
* T est le tag

L'utilisation du tag est particulières :
* ''svn'' pour une version de développement avant les releases ou pre-release.
* ''alpha'' pour une pré-version non encore formalisée d'une nouvelle version majeure ou mineure du programme (2.0.0-alpha1 ou 1.7.0-alpha2 mais pas 1.6.5-alpha1)
* ''beta'' pour une pré-version formalisée d'une nouvelle version majeure ou mineure du programme (2.0.0-beta1 ou 1.7.0-beta2 mais pas 1.6.5-beta1)
* ''rc'' pour une version candidate à la release. Elle sert uniquement à la recherche de derniers bugs (1.6.2-rc1)
* ''r'' pour une révision d'une version déjà sortie. Elle sert uniquement à corriger de graves anomalies de la version (1.6.4-r1)

De manière générale, la numérotation doit être effectuée comme suit :
# A la release de la version X.Y.Z, la branche principale passe ne X.Y.(Z+1)-svn
# Si le besoin s'en fait sentir, des versions alpha, puis bêta et enfin rc peuvent être sorties. Mais attention, une version alpha doit être suivie d'au moins une version bêta puis d'une rc.
# Lorsque la version est considérée stable, elle est détaguée, et la release est effectuée. On revient dès lors au point 1

=== Traductions ===

Les traductions (gentil fardeau offert par JiBee), sont générée relativement simplement par Qt. Pour ceci, il faut procéder dans l'ordre :
* Dans le code, mettre les chaîne à traduire soit dans des tr("mon texte") ou QT_TR_NOOP("mon texte"). Le deuxième cas étant pour les textes qui se trouvent dans les définitions statiques.
* Générer le fichier d'index à l'aide de lupdate sur le projet :
# Pour qRezix 1.6
lupdate qrezix.pro
# Pour qRezix 2.0
lupdate */*.pro
* Editer les fichiers .ts avec Qt Linguist, et enregistrer les modifications. Les fichiers .ts sont dans le répertoires ''translations''.
* Compiler les fichiers .ts à l'aide de lrelease ou de Qt Linguist.
cd translations
lrelease *.ts
* Commiter le tout...

=== Documentation ===

La documentation de qRezix est composée de cette page, de la doc de l'API qu'il est possible de générer grâce à Doxygen, ainsi que de tout ce que vous pourrez trouver sur [http://fruneau cette page]. Dans tous les cas, la meilleure doc restera toujours une personne qui connait bien le projet :)...

Dans l'état actuel des choses, la meilleure doc de qRezix, c'est [[User:Fruneau|moi]].

=== Compiler qRezix ===

La compilation de qRezix n'est pas forcément une opération triviale, et dépend fortement de l'OS sur lequel on travail. La plupart des informations nécessaires sont contenues dans le fichier INSTALL. Voici quelques suppléments qui pourront toutefois être utiles :

==== Windows ====

Sous Windows, à l'heure actuelle, on compile avec Visual C++ 7.1 ou supérieur (qRezix ne compile pas avec VC++ 6). A l'heure actuelle, VC++ ne permet pas de compiler les modules en tant que tels car il est incapable de charger les membres de classes dans les DLL. On est donc forcés de tout compiler en un bloc en passant l'option "RZX_ALL_BUILTIN" à la compilation.

Tout d'abord il faut ouvrir une nouvelle console Visual Studio (pour avoir les variables d'environnement correctement définies). Dans cette console :
qmake qrezix.pro
nmake

Si vous compilez une version SVN de qRezix, vous pouvez exécuter SubWCRev.exe pour convertir les occurences de $WCREV$ en numéro de révision.

Le packaging se fait à l'aidre de [http://nsis.sourceforge.net/Main_Page NSIS] en compilant le script qui est dans le répertoire package/windows

==== Linux ====

Sous Linux, il suffit de procéder strictement comme indiqué dans le fichier INSTALL
qmake qrezix.pro # cet appel est nécessaire dès que la structure du programme est modifiée...
make
qmake qrezix.pro # ce deuxième appel n'est nécessaire qu'à la première compilation où lors de l'apparition de nouveaux fichiers à installer
sudo make install

Pour mettre à jour le numéro de révision il peut être utile de forcer la recompilation de certaines parties du core :
touch core/core.pro
touch core/rzxapplication.cpp
make

Le packaging dépend énormément de la distribution... mais consiste dans la plupart des cas à réaliser une installation dans un chroot, l'archiver et lui ajouter les informations de packages (dépendants de la distribution... rpm, deb...).

<div style="border: 1px solid #9f6f8f; padding: .2em .5em .2em .5em; background-color: #FBEAF5">
Pour packager il faut partir d'un export de la SVN et non pas d'un checkout... Sinon les répertoires .svn resteront présents et peuvent fortement allourdir le paquet ou induire qRezix en erreur dans certains cas.
</div>

==== MacOS X ====

Sous MacOS X, un script est prévu pour réaliser la compilation. Il gère un certain nombre de problèmes liés à MacOS X, et il est fortement déconseillé de ne pas l'utiliser. Donc, pour compiler et créer un bundle utilisable il suffit de lancer la commande :
./build-mac

Pour compiler sous MacOS X il est nécessaire d'avoir installer la SDK de Growl. Et une fois compilé, de mettre Growl-withInstaller.framework dans le bundle qRezix.app/Content/Frameworks, sans quoi qRezix refusera de se lancer.

Ce script peut prendre un certain nombre de paramètres :
* -v : mode verbeux (affiche la sortie de make, qmake...)
* -q : ne lance pas les qmake (si cette option est ajoutée, le numéro de révision ne sera pas mis à jour dans la fenêtre de préférence)
* -jx : option -j de make (attention, la compilation universal binaries utilise déjà les 2 processeurs des biprocs)
* ... : toutes les autres options sont ajoutées aux CXXFLAGS

Pour packager qRezix pour MacOS, il suffit d'exécuter un autre script qui récupère le bundle de build-mac, le nettoie, y ajoute Qt et règle les dépendances des bibliothèques.
cd package/macosx
./package

<div style="border: 1px solid #6f8f9f; padding: .2em .5em .2em .5em; background-color: #EAF5FB">
Pour ceux qui voudraient profiter de Xcode, qmake peut générer des projet Xcode à partir du fichier .pro en exécutant :
qmake -spec macx-pbuilder machin.pro
Mais ceci mérite des test approfondis et une attention accrue pour éviter de délaisser le fichier .pro nécessaire pour les autres plateformes une fois le projet généré.
</div>

=== Coding Rules ===

Il est important de respecter un certain nombre de règles lorsqu'on travail sur un projet collectif. De fait, tout développeur de qRezix est prié de se tenir aux recommandations qui suivent :

<table style="border: 1px solid #6f8f9f; width: 100%">
<tr style="padding: .2em .5em .2em .5em; background-color: #EAF5FB">
<th colspan="2">'''Nomenclature'''</th>
</tr>
<tr>
<td>Les noms des classes sont préfixés par Rzx</td>
<td rowspan="5"><pre>
class RzxApplication
{
bool valid;

public:
bool isValid() const;
};
</pre></td>
</tr>
<tr style="background-color: #FAF5FF">
<td>Les noms des fonctions commencent par une minuscule</td>
</tr>
<tr>
<td>L'utilisation d'underscore est à éviter. On préférera utiliser des nom dont les séparations sont des majuscules</td>
</tr>
<tr style="background-color: #FAF5FF">
<td>La langue à utiliser de préférence est '''l'anglais'''</td>
</tr>
<tr>
<td>Les noms des fonctions/methodes doivent être cohérents avec les APIs Qt et qRezix, on évitera par exemple les getMyVar() en privilégiant myVar().</td>
</tr>
<tr style="padding: .2em .5em .2em .5em; background-color: #EAF5FB">
<th colspan="2">'''Accolades'''</th>
</tr>
<tr>
<td>Les accolades ouvrantes comme fermantes sont placées après un retour à la ligne</td>
<td rowspan="3"><pre>
if(a == b || c != d)
{
a = b + 1;
do(truc);
}

void RzxMyFunction::do() const
{
<bloc>;
}

class RzxMyClass
{
};
</pre></td>
</tr>
<tr style="background-color: #FAF5FF">
<td>Les opérateurs sont entourés d'espaces</td>
</tr>
<tr>
<td>Les parenthèse sont collées à l'opération associée (nom de fonction, contrôle de flux...)</td>
</tr>
<tr style="padding: .2em .5em .2em .5em; background-color: #EAF5FB">
<th colspan="2">'''Indentation'''</th>
</tr>
<tr>
<td>Les indentation sont réalisées à l'aide de ''tabulation''</td>
<td rowspan="4"><pre>
class RzxMyClass
{
<firstbloc>

public:
<secondbloc>

protected:
<thirdbloc>
};

switch(value)
{
case 1:
<bloc1>;

case 2:
<bloc2>;

case 3:
<bloc3>;
}

#if CASE1
# define MACHIN
#endif
</pre></td>
</tr>
<tr style="background-color: #FAF5FF">
<td>Les mots clés comme public: ou case: sont indentés et entraînent une indentation supplémentaire jusqu'au prochain mot clé</td>
</tr>
<tr>
<td>Ne pas oublier d'indenter également le préprocesseur</td>
</tr>
<tr style="background-color: #FAF5FF">
<td>Les fichiers doivent finir par une ligne vide</td>
</tr>
<tr style="padding: .2em .5em .2em .5em; background-color: #EAF5FB">
<th colspan="2">'''Commentaires et documentation'''</th>
</tr>
<tr>
<td>Les objets doivent être documentées à l'aide des syntaxe de Doxygen</td>
<td rowspan="3"><pre>
///Ceci est une description rapide
/** Ceci est une description avancée de la fonction
*/
void myFunction()
{
if(machin) // Le cas machin peut poser problème, on le traite donc à part
{
}

// TODO: implémenter le reste de la fonction

}
</pre></td>
</tr>
<tr style="background-color: #FAF5FF">
<td>A l'exception de la documentation des fonctions, on préférera les commentaires de la forme // Mon commentaire en français</td>
</tr>
<tr>
<td>// TODO: peut également être utilisé pour spécifier des implémentations à réaliser</td>
</tr>
</table>

== Branche 1.6 ==

=== Structure du programme ===

La structure interne du programme peut-être résumée au schéma suivant :

[[Image:qrezix-1.6_structure.png]]

Ce schéma n'est pas exhaustif, mais met en évidence les différentes imbrications des éléments. Toutes les cadres qui se chevauchent (et le cas échéant se contiennet) représente des classes qui sont imbriquées l'une à l'autre. Ansi la classe QRezix qui gère la totalité du programme est totalement dépendante de la quasitotalité des autres classes, la classe RzxConnectionLister dont le but est de lister les personnes est complètement dépendante de RzxRezal et vice-versa (il y a même des redondances de stockage)... idem, pour le chat qui est géré partiellement par RzxConnectionLister et partiellement par RzxRezal.

La classe RzxComputer a une importance réduite et la quasitotalité de ses données sont redondantes avec RzxItem. De plus certaines informations de RzxComputer sont stockées directement par RzxConfig, qui est elle-même à moitié implémentée par RzxProperty.

En résumé, la structure (déjà modularisée comparée à la version 1.2 dans laquelle RzxConnectionLister n'existait pas et était partie intégrante de RzxRezal) n'est pas facilement maintenable.

=== Interface de plug-ins ===

qRezix 1.6 est la première version à bénéficier d'une structure d'accueil de plug-in. Cette structure est rudimentaire et souffre du fait que qRezix n'est pas modulaire. En effet la classe RzxPlugIn est compilée à la fois dans le plug-in et dans qRezix, ce qui crée des problèmes dès que les deux versions diffèrent.

Pour éviter les problèmes, la version de la strucutre de plug-in est numéroté de façon très stricte, et le filtrage est fait au chargement du plug-in.

Ce défaut entraîne un grand nombre de complication. Les plug-ins n'ont absolument aucun accès direct aux données stockées par qRezix. Toutes les informations transitent donc par des fonction standardisées du plug-in, mais cette méthode de travail limite le nombre d'information pouvant être échangé. Il n'en reste pas moins que cette structure est tout à fait suffisante pour réaliser des plug-ins comme l'Xplo ou SmiliX (qui sont disponible sur la [[Subversion|SVN]] dans le reposoire qrezix-plugins).

Pour pouvoir faire un plug-in pour qRezix, il faut récupérer la dernière version de rzxplugin.h et rzxplugin.cpp dans la branche de release de qRezix correspondante à la version pour laquelle vous voulez faire le plugin. Il suffit alors de créer un projet dérivant de RzxPlugIn. La documentation de RzxPlugIn peut-être générée automatique à l'aide de [http://www.doxygen.org Doxygen] et peut-être trouvée [http://fruneau.eleves.polytechnique.fr/qrezix-1.6/classRzxPlugIn.html ici], de même pour la [http://fruneau.eleves.polytechnique.fr/xplo/ documentation du plug-in Xplo] qui permet d'avoir un bon exemple de plug-in complet.

Cette structure a totalement disparue avec qRezix 2.0 pour être remplacer par des modules plus souple et mieux conçus.

== Branche 2.0 ==

=== Objectif ===

Cette version de qRezix repose sur un double objectif :
* porter le code en Qt4.
* modulariser le programme.

==== Qt4 ====
Le premier point ne présente pas une difficulté énorme, mais a conduit à pas mal de réorganisation du code. En particulier, qRezix 2.0 bénéficie de la puissance du nouveau système Model/View de Qt4, ce qui a nécessiter de redévelopper la quasitotalité de l'interface principale.

La toute dernière version [[Subversion|SVN]] de qRezix utilise [[Qt]] version 4.1.0 minimum. qRezix 2.0 utilise des fonctions introduites dans Qt 4.1, et ne compilera pas avec Qt 4.0.

==== Modularité ====

La modularisation du programme est un point essentiel. Elle apporte un certain nombre d'évolution nécessaire à la survie de qRezix :
* restructuration du programme qui permet une meilleure maintenance
* possibilité de limiter qRezix à certaines fonctionnalités (utile pour l'utilisation chez des personnes qui n'ont pas besoin d'avoir le logiciel complet si par exemple ils n'utilisent jamais le chat).
* possibilité de travailler avec un plus grand nombre de personne sur le projet. Chacun pouvant en effet travailler sur un module
* possibilité de gérer plusieurs protocoles pour se connecter à plusieurs serveurs

=== Structure du programme ===

Le schéma suivant représente de manière simplifié la structure interne de qRezix 2.0.x :

[[Image:qrezix-2.0_structure.png]]

Bien que le nombre d'élément soit impressionnant, cette structure est beaucoup plus propre que celle de qRezix 1.6. Le schéma montre en effet en particulier que les éléments sont proprement séparé, les seuls dépendances entre les modules qu'il peut y avoir sont gérées par la bibliothèque principale.

Le RzxComputer a acquis un rôle beaucoup plus important, il gère désormais la totalité des informations concernant une machine et inclus les actions qu'il est envisageable d'effectuer (propriétés, chat, http, ftp...). Le chat est géré par les modules qui se déclarent comme supportant cette fonctionnalité, de même pour les propriétés.

La fenêtre de préférences (RzxProperty) génère dynamiquement la page de propriétés en fonction de ce que les modules installés désirent. Et tout est mis en oeuvre (au travers de classe abstraites regroupant tous les outils nécessaires) pour que chaque module puisse créer simplement ses propres classes de configuration.

Les modules peuvent être construit soit en built-in soit en plug-in. Aucun n'est nécessaire au fonctionnement du programme (enfin si on retire tous les protos réseau, programme perd beaucoup de son intérêt).

QRezix

2006-07-08T10:07:26Z

Fruneau : typo

{{menu projets}}
qRezix est le principal client [[xNet]] encore maintenu. Il doit sa survie à sa qualité d'être le seul client développé qui soit multiplateforme tout en restant graphiquement potable. Il doit ces deux qualités à la bibliothèque [[Qt]].

== Historique ==

=== BR2000 ===

Le projet en lui-même est né avec un groupe de BRmen X2000 menés par Doudou qui étaient fans de Qt (qui à l'époque n'était pas terrible-terrible...). Ils ont travaillé à 3 ou 4 pour sortir la version 1.0 le 4 mars 2002, suivie de près par la version 1.1 le 6 avril. L'équipe de développement comportait entre autres Doudou, MadCoder et Trasfract (Sylvain Joyeux, Pierre Habouzit et Benoït Casoetto).

Le projet s'est principalement inspiré des clients qui existaient déjà à l'époque (Rezix en particulier, duquel qRezix a tiré son nom). Cette architecture simple est une fenêtre avec une liste de client chaque entrée indiquant le nom, la promo, les serveurs... Les favoris sont affichés en premier selon le choix de l'utilisateur.

=== BR2001 ===

Le BR2001 n'a pas énormément travaillé sur qRezix. Il y a eu la version 1.2, mais on n'a aucune trace de ce que JiBee a bien pu faire sur le projet. Ce qui est certain, c'est qu'après la vesion 1.2, il a porté qRezix en Qt3 et a travaillé sur l'internationalisation du projet. Le but d'origine n'était pas de rendre qRezix international, mais simplement de résoudre les problèmes d'encodage des caractères accentués. Le code source a donc totalement été traduit en anglais et une traduction française a été créée.

[[Image:qrezix-1.2.gif|center]]

A priori, il n'y a pas eu de release en Qt3... mais d'après [[User:Ey|Ey]] qui packageait le projet pour Windows, il y en aurait eu... Mais en tout cas à l'arrivée des 2003 c'était toujours la version 1.2 (en Qt2) qui était disponible... Le BR n'avait de plus pas de license pour Qt3 sous Windows.

=== BR2002 ===

Le projet était géré par Steak. La version 1.3 a été release le 1 mai 2004. Cette version n'était absolument par révolutionnaire mais apportait quelques améliorations dans la structure du code et des amélioration du comportement du programme.

Steak a ensuite travaillé sur la version 1.3.666 et en particulier sur l'authentification avec le serveur. Mais il a vite arrêter de travailler sur qRezix en raison du temps qu'il consacrait à l'étude du japonnais, et à différents problèmes occulaires. Cependant, le [[BR2002]] a réalisé une prépassation très avancée ce qui fait que dès le mois de juin, la relève était en place...

=== BR2002/BR2003 : le temps d'une prépassation ===

Le [[BR2003]] a donc commencé sont travail sur qRezix dès le mois de juin 2004.

La première chose a été de recompiler une version pour Windows, ce qui n'avait plus été fait depuis près d'un an. Ceci permettait donc d'envisager de futures release du programme pas uniquement sous Linux. Le travail s'est finalement concentré pendant les vacances d'été avec une amélioration importante de l'interface et de la structure interne (début de séparation de la gestion des connexions de l'affichage), la création d'une structure (pas terrible) de chargement de plug-ins, l'ajout d'icône pour rendre l'interface plus conviviale... La version a été tagguée tour à tour 1.3.666 puis 1.5.

Une autre innovation importante à été le passage du chat qui reposait sur un protocole en UDP vers un protocole TCP. Le but déclaré du BR2002 étant de rendre les communication fiables et sécurisées (on veut savoir si l'autre ne reçoit pas nos messages).

Toutes ces modifications associées au travail de Steak sur l'authentification et le travail de JiBee pour recoder un nouveau [[xNetServer|serveur xNet]], on conduit à la version 1.6 de qRezix qui est sorti le 14 octobre 2004 à la fois pour Windows, Linux et Mac OS X.

[[Image:qrezix-1.6.png|center]]

Face à qRezix 1.6.0 est apparu Rezix.NET qui se voulait innovant. Conséquence de ceci, on a travaillé à 2 avec Steak pour implémenter dans qRezix toutes les fonctionnalité des Rezix.NET. Ce qui a rapidement conduit à la sortie de qRezix 1.6.1 le 22 novembre 2004. C'était la dernière version sur laquelle ait travailler Steak. Rezix.NET (qui était codé en .NET par un membre dissidant du BR2002) n'a finalement pas fait long feu.

=== BR2003 ===

La suite a été plus calme. La préparation de qRezix 1.6.2 s'est faite tranquillement, l'objectif principal était de supprimer un maximum de bugs de cette future version. Les innovations n'ont pas été nombreuses, mais on pourra noter la completion du nick dans le chat avec tab et la recherche intelligente via clavier. Cette version a vu le retour de Ey parmi les développeurs. Elle a aussi été la seule version à bénéficier d'une sortie ayant été précédée de 2 release-candidates qui ont aidées à corriger plusieurs bugs supplémentaires. La version a finalement été sortie le 22 mars 2005.

Le problème de cette version est qu'elle a introduit un bug... enfin plutôt révélé un bug. Jusqu'à présent qRezix plantait en l'absence de réseau ce qui a été corrigé avec la 1.6.2. Mais ce que je n'avais pas remarqué à l'époque c'était qu'en l'absence de réseau qRezix raffraichissait la fenêtre toutes les secondes et en même temps changeait le thême d'icône. Conséquence directe de ce défaut, qRezix prenait 100% du processeur en l'absence de réseau, ce que j'ai eu la chance de constater lors de ma soutenance de modex... Il fallait donc sortir un version avant l'arrivée des 2004 pour éviter que ce bug ne pose trop de problème aux 2004 qui allaient passer leur soutenance de stage. C'est pour ça qu'est sortie la verson 1.6.3 le 1 mai 2005. Cette version innovait au passage une nouvelle organisation plus agréable des propriétés et peut-être globalement considérée comme stable. La version 1.6.4 sortie le 23 septembre apporte peu d'innovation si ce n'est la cache des propriétés, les icônes en 32bits et une meilleure intégration à Mac OS.

Suite à la sortie de Qt4, le port de qRezix vers cette nouvelle mouture de la bibliothèque de Trolltech a été l'occasion de grand remaniement du code. Ceci a abouti à la versin 2.0 de qRezix dont le principal atout est d'être modulaire. La version 2.0.0 est sortie le 6 février 2006, et a rapidement supplanté la version 1.6.x.

[[Image:qrezix-2.0.png|800px|center]]

<div style="border: 1px solid #6f8f9f; padding: .2em .5em .2em .5em; background-color: #EAF5FB">
Pour écrire cette partie, j'ai utilisé mes connaissances personnelles issues ainsi que les informations contenues dans le ChangeLog. Et j'espère bien que d'autres y jetteront un coup d'oeil pour compléter/corriger les parties inexactes.
</div>

=== Versions ===

Voici un description des différentes versions de qRezix. Pour des informations exhaustive, il faut se reporter au ChangeLog du projet.

<table style="border: 1px solid #6f8f9f; width: 100%">
<tr style="padding: .2em .5em .2em .5em; background-color: #EAF5FB">
<th>'''Version'''</th><th>'''Date'''</th><th>'''Changements'''</th>
</tr>
<tr><td>v0.1</td><td>30 janvier 2002</td><td></td></tr>
<tr style="background-color: #FAF5FF;"><td>v0.2</td><td>20 février 2002</td><td></td></tr>
<tr><td>v0.3</td><td>25 février 2002</td><td></td></tr>
<tr style="background-color: #FAF5FF;"><td>'''v1.0'''</td><td>4 mars 2002</td><td></td></tr>
<tr><td>v1.1</td><td>6 avril 2002</td><td></td></tr>
<tr style="background-color: #FAF5FF;"><td>v1.2</td><td>2003</td><td></td></tr>
<tr><td>v1.3</td><td>1er mai 2004</td><td></td></tr>
<tr style="background-color: #FAF5FF;"><td>'''v1.6.0'''</td><td>14 octobre 2004</td><td>
* Passage du chat en TCP
* Ajout de l'authentification des connexions (protocole xNet 3.9)
* Amélioration de l'ergonomie
</td></tr>
<tr><td>v1.6.1</td><td>22 novembre 2004</td><td>
* Ajout d'une 'ignore-list'
* Ajout des notifications d'arrivée/départ des favoris
</td></tr>
<tr style="background-color: #FAF5FF;"><td>v1.6.2</td><td>22 mars 2004</td><td>
* Tab-completion des pseudos dans le chat
* Ajout d'informations (IP, Client, Localisation)
</td></tr>
<tr><td>v1.6.3</td><td>1er mai 2005</td><td>
* Fix principalement un 100% en cas d'absence de réseau
</td></tr>
<tr style="background-color: #FAF5FF;"><td>v1.6.4</td><td>23 septembre 2005</td><td>
* Passage au protocole xNet 4.0
* Ajout du support de BSD
* Sauvegarde des propriétés checkées
</td></tr>
<tr><td>'''v2.0.0'''</td><td>6 février 2006</td><td>
* Réécriture modulaire utilisant Qt4
* Carte permettant de situer visuellement les personnes
* Ajout de la notion de "Groupes"
</td></tr>
<tr style="background-color: #FAF5FF;"><td>v2.0.1</td><td>23 avril 2006</td><td>
* Bugfixes
</td></tr>
<tr><td>''v2.0.2''</td><td>''à venir...''</td><td>
* Meilleure intégration à MacOS X (Support de Growl, ajout de menus...)
* Notification des discussions
* Recherches avancées ne se limitant plus aux pseudo
* Bugfixes
</td></tr>
</table>

== Développement ==

Cette partie a pour but de présenter brièvement l'état du projet à travers l'organisation du développement.

=== Outils nécessaires ===

* Le développement de qRezix se fait comme tous les projets du BR via un système de partage de projet : [[Subversion|SVN]]. Il est donc nécessaire d'installer un client [[Subversion|SVN]] pour travailler. Sous Linux et Mac OS, il y a des packages de SVN qui sont distribuer. Sous Windows, il est fortement conseillé d'utiliser [http://tortoisesvn.tigris.org TortoiseSVN]. Pour plus d'information sur SubVersion, merci de vous référer à la [[Subversion|page correspondante]].

* Il faut également installer [[Qt]], la version dépend de la branche de travail. Pour qRezix 1.6, il faut utiliser Qt3 (3.3.3 ou ultérieure) alors que pour qRezix 1.7, Qt4 (4.0.1 ou ultérieure). Pour obtenir Qt3 pour Windows, merci de demander à [[User:Fruneau|Fruneau]]. Pour Qt4, il faut faire attention sur certaine distribution de bien installer tous les modules nécessaires (au moins Core, GUI et Network) et les outils qui vont avec (designer, linguist, assistant).

* Pour générer la documentation il peut être intéressant d'installer également [http://www.doxygen.org Doxygen]. La plupart du temps l'utilisation de Doxygen est très simple : il suffit de l'appliquer au fichier Doxyfile qui se trouve à la racine du projet.
doxygen Doxyfile

=== Structure de la SVN ===

Pour ce qui est de l'utilisation de SVN, je vous laisse vous référer à la [[Subversion#Utilisation_de_svn|page correspondante]]. Cette partie à plutôt pour but d'expliquer comment utiliser la SVN pour travailler sur qRezix.

Tout d'abord, il est important de noter que qRezix utilise une structure tout ce qu'il y a de plus classique (avec trunk, branches et tags). Le trunk étant la branche principale du projet.

==== Travailler sur la branche principale ====

La branche principale du projet correspond à la version qui évolue actuellement. A l'heure actuelle c'est la 1.6.x. Cette branche change régulièrement et on peut y trouver les dernières innovations réalisée sur cette branche. Lorsqu'on s'approche d'une release de qRezix, il faut freezer la branche principale. Pour ceci, on sépare le développement de la version qui va sortir de celui de la branche principale.

Par exemple pour release qRezix 1.6.4, j'ai freezé la branche environ 1 semaine et demi avant la sortie via :
svn copy trunk branches/qrezix--release--1.6.4

Une fois les branches séparées, la branche de release ne doit plus subir que des corrections de bugs. En cas de besoin, on pourra sortir des pre-release (rc). Une fois qu'une version est considérée stable, on la tag, c'est à dire qu'on fait une photographie instantannée du projet :
svn copy branches/qrezix--release--1.6.4 tags/qrezix--1.6.4-rc1 # pour une préversion
svn copy branches/qrezix--release--1.6.4 tags/qrezix--1.6.4 # pour la version définitive

On peut même envisager alors des révisions sur la version actuelle qui serait des bugfixes de la branche de release intervenu après la sortie. Dans ce cas, on aurait
svn copy branches/qrezix--release--1.6.4 tags/qrezix--1.6.4-r1 # pour une révision de la version

Ceci peut paraître contraignant, mais c'est la base d'un projet mené correctement. Ca permet d'avoir un historique des branches et des versions, de pouvoir envisager de sortir des révisions de toutes les branches de release en cas de découverte d'une faille importante du programme et ça évite surtout d'avoir une version qui s'éternise... lorsqu'on décide de freezer une version, ceux qui veulent continuer à innover travaillent sur le trunk pendant que d'autres stabilise la version de release.

==== Branches de devel ====

A côté de la branche principale, il peut y avoir des branches de devel. Alors que la différence entre 2 releases issues d'une même branche sont le plus souvent mineures voire de la simple maintenance, la différence entre le trunk et la branches de devel est quelque chose de beaucoup plus important. La branche de devel apporte des innonvations importantes et devrait conduire à une nouvelle version majeure du programme.

La branche de devel Qt4 vient d'être passée en branche principale.

==== Numérotation des versions ====

Comme pour tout programme, qRezix a des versions numérotées de la forme X.Y.Z-T
* X est la version majeure, il ne change que lors de modification très importantes de la structure du programme.
* Y est la version mineure, il change lorsque le programme a subit des évolution plus importante qu'une simple maintenance.
* Z est la version de maintenance, il change lorsque le programme subit des bugfixes et l'implémentation de fonctionnalités mineures.
* T est le tag

L'utilisation du tag est particulières :
* ''svn'' pour une version de développement avant les releases ou pre-release.
* ''alpha'' pour une pré-version non encore formalisée d'une nouvelle version majeure ou mineure du programme (2.0.0-alpha1 ou 1.7.0-alpha2 mais pas 1.6.5-alpha1)
* ''beta'' pour une pré-version formalisée d'une nouvelle version majeure ou mineure du programme (2.0.0-beta1 ou 1.7.0-beta2 mais pas 1.6.5-beta1)
* ''rc'' pour une version candidate à la release. Elle sert uniquement à la recherche de derniers bugs (1.6.2-rc1)
* ''r'' pour une révision d'une version déjà sortie. Elle sert uniquement à corriger de graves anomalies de la version (1.6.4-r1)

De manière générale, la numérotation doit être effectuée comme suit :
# A la release de la version X.Y.Z, la branche principale passe ne X.Y.(Z+1)-svn
# Si le besoin s'en fait sentir, des versions alpha, puis bêta et enfin rc peuvent être sorties. Mais attention, une version alpha doit être suivie d'au moins une version bêta puis d'une rc.
# Lorsque la version est considérée stable, elle est détaguée, et la release est effectuée. On revient dès lors au point 1

=== Traductions ===

Les traductions (gentil fardeau offert par JiBee), sont générée relativement simplement par Qt. Pour ceci, il faut procéder dans l'ordre :
* Dans le code, mettre les chaîne à traduire soit dans des tr("mon texte") ou QT_TR_NOOP("mon texte"). Le deuxième cas étant pour les textes qui se trouvent dans les définitions statiques.
* Générer le fichier d'index à l'aide de lupdate sur le projet :
# Pour qRezix 1.6
lupdate qrezix.pro
# Pour qRezix 2.0
lupdate */*.pro
* Editer les fichiers .ts avec Qt Linguist, et enregistrer les modifications. Les fichiers .ts sont dans le répertoires ''translations''.
* Compiler les fichiers .ts à l'aide de lrelease ou de Qt Linguist.
cd translations
lrelease *.ts
* Commiter le tout...

=== Documentation ===

La documentation de qRezix est composée de cette page, de la doc de l'API qu'il est possible de générer grâce à Doxygen, ainsi que de tout ce que vous pourrez trouver sur [http://fruneau cette page]. Dans tous les cas, la meilleure doc restera toujours une personne qui connait bien le projet :)...

Dans l'état actuel des choses, la meilleure doc de qRezix, c'est [[User:Fruneau|moi]].

=== Compiler qRezix ===

La compilation de qRezix n'est pas forcément une opération triviale, et dépend fortement de l'OS sur lequel on travail. La plupart des informations nécessaires sont contenues dans le fichier INSTALL. Voici quelques suppléments qui pourront toutefois être utiles :

==== Windows ====

Sous Windows, à l'heure actuelle, on compile avec Visual C++ 7.1 ou supérieur (qRezix ne compile pas avec VC++ 6). A l'heure actuelle, VC++ ne permet pas de compiler les modules en tant que tels car il est incapable de charger les membres de classes dans les DLL. On est donc forcés de tout compiler en un bloc en passant l'option "RZX_ALL_BUILTIN" à la compilation.

Tout d'abord il faut ouvrir une nouvelle console Visual Studio (pour avoir les variables d'environnement correctement définies). Dans cette console :
qmake "DEFINES+=RZX_ALL_BUILTIN" qrezix.pro
nmake

Si vous compilez une version SVN de qRezix, vous pouvez exécuter SubWCRev.exe pour convertir les occurences de $WCREV$ en numéro de révision.

Le packaging se fait à l'aidre de [http://nsis.sourceforge.net/Main_Page NSIS] en compilant le script qui est dans le répertoire package/windows

==== Linux ====

Sous Linux, il suffit de procéder strictement comme indiqué dans le fichier INSTALL
qmake qrezix.pro # cet appel est nécessaire dès que la structure du programme est modifiée...
make
qmake qrezix.pro # ce deuxième appel n'est nécessaire qu'à la première compilation où lors de l'apparition de nouveaux fichiers à installer
sudo make install

Pour mettre à jour le numéro de révision il peut être utile de forcer la recompilation de certaines parties du core :
touch core/core.pro
touch core/rzxapplication.cpp
make

Le packaging dépend énormément de la distribution... mais consiste dans la plupart des cas à réaliser une installation dans un chroot, l'archiver et lui ajouter les informations de packages (dépendants de la distribution... rpm, deb...).

<div style="border: 1px solid #9f6f8f; padding: .2em .5em .2em .5em; background-color: #FBEAF5">
Pour packager il faut partir d'un export de la SVN et non pas d'un checkout... Sinon les répertoires .svn resteront présents et peuvent fortement allourdir le paquet ou induire qRezix en erreur dans certains cas.
</div>

==== MacOS X ====

Sous MacOS X, un script est prévu pour réaliser la compilation. Il gère un certain nombre de problèmes liés à MacOS X, et il est fortement déconseillé de ne pas l'utiliser. Donc, pour compiler et créer un bundle utilisable il suffit de lancer la commande :
./build-mac

Pour compiler sous MacOS X il est nécessaire d'avoir installer la SDK de Growl. Et une fois compilé, de mettre Growl-withInstaller.framework dans le bundle qRezix.app/Content/Frameworks, sans quoi qRezix refusera de se lancer.

Ce script peut prendre un certain nombre de paramètres :
* -v : mode verbeux (affiche la sortie de make, qmake...)
* -q : ne lance pas les qmake (si cette option est ajoutée, le numéro de révision ne sera pas mis à jour dans la fenêtre de préférence)
* -jx : option -j de make (attention, la compilation universal binaries utilise déjà les 2 processeurs des biprocs)
* ... : toutes les autres options sont ajoutées aux CXXFLAGS

Pour packager qRezix pour MacOS, il suffit d'exécuter un autre script qui récupère le bundle de build-mac, le nettoie, y ajoute Qt et règle les dépendances des bibliothèques.
cd package/macosx
./package

<div style="border: 1px solid #6f8f9f; padding: .2em .5em .2em .5em; background-color: #EAF5FB">
Pour ceux qui voudraient profiter de Xcode, qmake peut générer des projet Xcode à partir du fichier .pro en exécutant :
qmake -spec macx-pbuilder machin.pro
Mais ceci mérite des test approfondis et une attention accrue pour éviter de délaisser le fichier .pro nécessaire pour les autres plateformes une fois le projet généré.
</div>

=== Coding Rules ===

Il est important de respecter un certain nombre de règles lorsqu'on travail sur un projet collectif. De fait, tout développeur de qRezix est prié de se tenir aux recommandations qui suivent :

<table style="border: 1px solid #6f8f9f; width: 100%">
<tr style="padding: .2em .5em .2em .5em; background-color: #EAF5FB">
<th colspan="2">'''Nomenclature'''</th>
</tr>
<tr>
<td>Les noms des classes sont préfixés par Rzx</td>
<td rowspan="5"><pre>
class RzxApplication
{
bool valid;

public:
bool isValid() const;
};
</pre></td>
</tr>
<tr style="background-color: #FAF5FF">
<td>Les noms des fonctions commencent par une minuscule</td>
</tr>
<tr>
<td>L'utilisation d'underscore est à éviter. On préférera utiliser des nom dont les séparations sont des majuscules</td>
</tr>
<tr style="background-color: #FAF5FF">
<td>La langue à utiliser de préférence est '''l'anglais'''</td>
</tr>
<tr>
<td>Les noms des fonctions/methodes doivent être cohérents avec les APIs Qt et qRezix, on évitera par exemple les getMyVar() en privilégiant myVar().</td>
</tr>
<tr style="padding: .2em .5em .2em .5em; background-color: #EAF5FB">
<th colspan="2">'''Accolades'''</th>
</tr>
<tr>
<td>Les accolades ouvrantes comme fermantes sont placées après un retour à la ligne</td>
<td rowspan="3"><pre>
if(a == b || c != d)
{
a = b + 1;
do(truc);
}

void RzxMyFunction::do() const
{
<bloc>;
}

class RzxMyClass
{
};
</pre></td>
</tr>
<tr style="background-color: #FAF5FF">
<td>Les opérateurs sont entourés d'espaces</td>
</tr>
<tr>
<td>Les parenthèse sont collées à l'opération associée (nom de fonction, contrôle de flux...)</td>
</tr>
<tr style="padding: .2em .5em .2em .5em; background-color: #EAF5FB">
<th colspan="2">'''Indentation'''</th>
</tr>
<tr>
<td>Les indentation sont réalisées à l'aide de ''tabulation''</td>
<td rowspan="4"><pre>
class RzxMyClass
{
<firstbloc>

public:
<secondbloc>

protected:
<thirdbloc>
};

switch(value)
{
case 1:
<bloc1>;

case 2:
<bloc2>;

case 3:
<bloc3>;
}

#if CASE1
# define MACHIN
#endif
</pre></td>
</tr>
<tr style="background-color: #FAF5FF">
<td>Les mots clés comme public: ou case: sont indentés et entraînent une indentation supplémentaire jusqu'au prochain mot clé</td>
</tr>
<tr>
<td>Ne pas oublier d'indenter également le préprocesseur</td>
</tr>
<tr style="background-color: #FAF5FF">
<td>Les fichiers doivent finir par une ligne vide</td>
</tr>
<tr style="padding: .2em .5em .2em .5em; background-color: #EAF5FB">
<th colspan="2">'''Commentaires et documentation'''</th>
</tr>
<tr>
<td>Les objets doivent être documentées à l'aide des syntaxe de Doxygen</td>
<td rowspan="3"><pre>
///Ceci est une description rapide
/** Ceci est une description avancée de la fonction
*/
void myFunction()
{
if(machin) // Le cas machin peut poser problème, on le traite donc à part
{
}

// TODO: implémenter le reste de la fonction

}
</pre></td>
</tr>
<tr style="background-color: #FAF5FF">
<td>A l'exception de la documentation des fonctions, on préférera les commentaires de la forme // Mon commentaire en français</td>
</tr>
<tr>
<td>// TODO: peut également être utilisé pour spécifier des implémentations à réaliser</td>
</tr>
</table>

== Branche 1.6 ==

=== Structure du programme ===

La structure interne du programme peut-être résumée au schéma suivant :

[[Image:qrezix-1.6_structure.png]]

Ce schéma n'est pas exhaustif, mais met en évidence les différentes imbrications des éléments. Toutes les cadres qui se chevauchent (et le cas échéant se contiennet) représente des classes qui sont imbriquées l'une à l'autre. Ansi la classe QRezix qui gère la totalité du programme est totalement dépendante de la quasitotalité des autres classes, la classe RzxConnectionLister dont le but est de lister les personnes est complètement dépendante de RzxRezal et vice-versa (il y a même des redondances de stockage)... idem, pour le chat qui est géré partiellement par RzxConnectionLister et partiellement par RzxRezal.

La classe RzxComputer a une importance réduite et la quasitotalité de ses données sont redondantes avec RzxItem. De plus certaines informations de RzxComputer sont stockées directement par RzxConfig, qui est elle-même à moitié implémentée par RzxProperty.

En résumé, la structure (déjà modularisée comparée à la version 1.2 dans laquelle RzxConnectionLister n'existait pas et était partie intégrante de RzxRezal) n'est pas facilement maintenable.

=== Interface de plug-ins ===

qRezix 1.6 est la première version à bénéficier d'une structure d'accueil de plug-in. Cette structure est rudimentaire et souffre du fait que qRezix n'est pas modulaire. En effet la classe RzxPlugIn est compilée à la fois dans le plug-in et dans qRezix, ce qui crée des problèmes dès que les deux versions diffèrent.

Pour éviter les problèmes, la version de la strucutre de plug-in est numéroté de façon très stricte, et le filtrage est fait au chargement du plug-in.

Ce défaut entraîne un grand nombre de complication. Les plug-ins n'ont absolument aucun accès direct aux données stockées par qRezix. Toutes les informations transitent donc par des fonction standardisées du plug-in, mais cette méthode de travail limite le nombre d'information pouvant être échangé. Il n'en reste pas moins que cette structure est tout à fait suffisante pour réaliser des plug-ins comme l'Xplo ou SmiliX (qui sont disponible sur la [[Subversion|SVN]] dans le reposoire qrezix-plugins).

Pour pouvoir faire un plug-in pour qRezix, il faut récupérer la dernière version de rzxplugin.h et rzxplugin.cpp dans la branche de release de qRezix correspondante à la version pour laquelle vous voulez faire le plugin. Il suffit alors de créer un projet dérivant de RzxPlugIn. La documentation de RzxPlugIn peut-être générée automatique à l'aide de [http://www.doxygen.org Doxygen] et peut-être trouvée [http://fruneau.eleves.polytechnique.fr/qrezix-1.6/classRzxPlugIn.html ici], de même pour la [http://fruneau.eleves.polytechnique.fr/xplo/ documentation du plug-in Xplo] qui permet d'avoir un bon exemple de plug-in complet.

Cette structure a totalement disparue avec qRezix 2.0 pour être remplacer par des modules plus souple et mieux conçus.

== Branche 2.0 ==

=== Objectif ===

Cette version de qRezix repose sur un double objectif :
* porter le code en Qt4.
* modulariser le programme.

==== Qt4 ====
Le premier point ne présente pas une difficulté énorme, mais a conduit à pas mal de réorganisation du code. En particulier, qRezix 2.0 bénéficie de la puissance du nouveau système Model/View de Qt4, ce qui a nécessiter de redévelopper la quasitotalité de l'interface principale.

La toute dernière version [[Subversion|SVN]] de qRezix utilise [[Qt]] version 4.1.0 minimum. qRezix 2.0 utilise des fonctions introduites dans Qt 4.1, et ne compilera pas avec Qt 4.0.

==== Modularité ====

La modularisation du programme est un point essentiel. Elle apporte un certain nombre d'évolution nécessaire à la survie de qRezix :
* restructuration du programme qui permet une meilleure maintenance
* possibilité de limiter qRezix à certaines fonctionnalités (utile pour l'utilisation chez des personnes qui n'ont pas besoin d'avoir le logiciel complet si par exemple ils n'utilisent jamais le chat).
* possibilité de travailler avec un plus grand nombre de personne sur le projet. Chacun pouvant en effet travailler sur un module
* possibilité de gérer plusieurs protocoles pour se connecter à plusieurs serveurs

=== Structure du programme ===

Le schéma suivant représente de manière simplifié la structure interne de qRezix 2.0.x :

[[Image:qrezix-2.0_structure.png]]

Bien que le nombre d'élément soit impressionnant, cette structure est beaucoup plus propre que celle de qRezix 1.6. Le schéma montre en effet en particulier que les éléments sont proprement séparé, les seuls dépendances entre les modules qu'il peut y avoir sont gérées par la bibliothèque principale.

Le RzxComputer a acquis un rôle beaucoup plus important, il gère désormais la totalité des informations concernant une machine et inclus les actions qu'il est envisageable d'effectuer (propriétés, chat, http, ftp...). Le chat est géré par les modules qui se déclarent comme supportant cette fonctionnalité, de même pour les propriétés.

La fenêtre de préférences (RzxProperty) génère dynamiquement la page de propriétés en fonction de ce que les modules installés désirent. Et tout est mis en oeuvre (au travers de classe abstraites regroupant tous les outils nécessaires) pour que chaque module puisse créer simplement ses propres classes de configuration.

Les modules peuvent être construit soit en built-in soit en plug-in. Aucun n'est nécessaire au fonctionnement du programme (enfin si on retire tous les protos réseau, programme perd beaucoup de son intérêt).

QRezix

2006-07-08T10:06:10Z

Fruneau : Ajout d'un historique des version avec des changelogs réduits

{{menu projets}}
qRezix est le principal client [[xNet]] encore maintenu. Il doit sa survie à sa qualité d'être le seul client développé qui soit multiplateforme tout en restant graphiquement potable. Il doit ces deux qualités à la bibliothèque [[Qt]].

== Historique ==

=== BR2000 ===

Le projet en lui-même est né avec un groupe de BRmen X2000 menés par Doudou qui étaient fans de Qt (qui à l'époque n'était pas terrible-terrible...). Ils ont travaillé à 3 ou 4 pour sortir la version 1.0 le 4 mars 2002, suivie de près par la version 1.1 le 6 avril. L'équipe de développement comportait entre autres Doudou, MadCoder et Trasfract (Sylvain Joyeux, Pierre Habouzit et Benoït Casoetto).

Le projet s'est principalement inspiré des clients qui existaient déjà à l'époque (Rezix en particulier, duquel qRezix a tiré son nom). Cette architecture simple est une fenêtre avec une liste de client chaque entrée indiquant le nom, la promo, les serveurs... Les favoris sont affichés en premier selon le choix de l'utilisateur.

=== BR2001 ===

Le BR2001 n'a pas énormément travaillé sur qRezix. Il y a eu la version 1.2, mais on n'a aucune trace de ce que JiBee a bien pu faire sur le projet. Ce qui est certain, c'est qu'après la vesion 1.2, il a porté qRezix en Qt3 et a travaillé sur l'internationalisation du projet. Le but d'origine n'était pas de rendre qRezix international, mais simplement de résoudre les problèmes d'encodage des caractères accentués. Le code source a donc totalement été traduit en anglais et une traduction française a été créée.

[[Image:qrezix-1.2.gif|center]]

A priori, il n'y a pas eu de release en Qt3... mais d'après [[User:Ey|Ey]] qui packageait le projet pour Windows, il y en aurait eu... Mais en tout cas à l'arrivée des 2003 c'était toujours la version 1.2 (en Qt2) qui était disponible... Le BR n'avait de plus pas de license pour Qt3 sous Windows.

=== BR2002 ===

Le projet était géré par Steak. La version 1.3 a été release le 1 mai 2004. Cette version n'était absolument par révolutionnaire mais apportait quelques améliorations dans la structure du code et des amélioration du comportement du programme.

Steak a ensuite travaillé sur la version 1.3.666 et en particulier sur l'authentification avec le serveur. Mais il a vite arrêter de travailler sur qRezix en raison du temps qu'il consacrait à l'étude du japonnais, et à différents problèmes occulaires. Cependant, le [[BR2002]] a réalisé une prépassation très avancée ce qui fait que dès le mois de juin, la relève était en place...

=== BR2002/BR2003 : le temps d'une prépassation ===

Le [[BR2003]] a donc commencé sont travail sur qRezix dès le mois de juin 2004.

La première chose a été de recompiler une version pour Windows, ce qui n'avait plus été fait depuis près d'un an. Ceci permettait donc d'envisager de futures release du programme pas uniquement sous Linux. Le travail s'est finalement concentré pendant les vacances d'été avec une amélioration importante de l'interface et de la structure interne (début de séparation de la gestion des connexions de l'affichage), la création d'une structure (pas terrible) de chargement de plug-ins, l'ajout d'icône pour rendre l'interface plus conviviale... La version a été tagguée tour à tour 1.3.666 puis 1.5.

Une autre innovation importante à été le passage du chat qui reposait sur un protocole en UDP vers un protocole TCP. Le but déclaré du BR2002 étant de rendre les communication fiables et sécurisées (on veut savoir si l'autre ne reçoit pas nos messages).

Toutes ces modifications associées au travail de Steak sur l'authentification et le travail de JiBee pour recoder un nouveau [[xNetServer|serveur xNet]], on conduit à la version 1.6 de qRezix qui est sorti le 14 octobre 2004 à la fois pour Windows, Linux et Mac OS X.

[[Image:qrezix-1.6.png|center]]

Face à qRezix 1.6.0 est apparu Rezix.NET qui se voulait innovant. Conséquence de ceci, on a travaillé à 2 avec Steak pour implémenter dans qRezix toutes les fonctionnalité des Rezix.NET. Ce qui a rapidement conduit à la sortie de qRezix 1.6.1 le 22 novembre 2004. C'était la dernière version sur laquelle ait travailler Steak. Rezix.NET (qui était codé en .NET par un membre dissidant du BR2002) n'a finalement pas fait long feu.

=== BR2003 ===

La suite a été plus calme. La préparation de qRezix 1.6.2 s'est faite tranquillement, l'objectif principal était de supprimer un maximum de bugs de cette future version. Les innovations n'ont pas été nombreuses, mais on pourra noter la completion du nick dans le chat avec tab et la recherche intelligente via clavier. Cette version a vu le retour de Ey parmi les développeurs. Elle a aussi été la seule version à bénéficier d'une sortie ayant été précédée de 2 release-candidates qui ont aidées à corriger plusieurs bugs supplémentaires. La version a finalement été sortie le 22 mars 2005.

Le problème de cette version est qu'elle a introduit un bug... enfin plutôt révélé un bug. Jusqu'à présent qRezix plantait en l'absence de réseau ce qui a été corrigé avec la 1.6.2. Mais ce que je n'avais pas remarqué à l'époque c'était qu'en l'absence de réseau qRezix raffraichissait la fenêtre toutes les secondes et en même temps changeait le thême d'icône. Conséquence directe de ce défaut, qRezix prenait 100% du processeur en l'absence de réseau, ce que j'ai eu la chance de constater lors de ma soutenance de modex... Il fallait donc sortir un version avant l'arrivée des 2004 pour éviter que ce bug ne pose trop de problème aux 2004 qui allaient passer leur soutenance de stage. C'est pour ça qu'est sortie la verson 1.6.3 le 1 mai 2005. Cette version innovait au passage une nouvelle organisation plus agréable des propriétés et peut-être globalement considérée comme stable. La version 1.6.4 sortie le 23 septembre apporte peu d'innovation si ce n'est la cache des propriétés, les icônes en 32bits et une meilleure intégration à Mac OS.

Suite à la sortie de Qt4, le port de qRezix vers cette nouvelle mouture de la bibliothèque de Trolltech a été l'occasion de grand remaniement du code. Ceci a abouti à la versin 2.0 de qRezix dont le principal atout est d'être modulaire. La version 2.0.0 est sortie le 6 février 2006, et a rapidement supplanté la version 1.6.x.

[[Image:qrezix-2.0.png|800px|center]]

<div style="border: 1px solid #6f8f9f; padding: .2em .5em .2em .5em; background-color: #EAF5FB">
Pour écrire cette partie, j'ai utilisé mes connaissances personnelles issues ainsi que les informations contenues dans le ChangeLog. Et j'espère bien que d'autres y jetteront un coup d'oeil pour compléter/corriger les parties inexactes.
</div>

=== Versions ===

Voici un description des différentes versions de qRezix. Pour des informations exhaustive, il faut se reporter au ChangeLog du projet.

<table style="border: 1px solid #6f8f9f; width: 100%">
<tr style="padding: .2em .5em .2em .5em; background-color: #EAF5FB">
<th>'''Version'''</th><th>'''Date'''</th><th>'''Changements'''</th>
</tr>
<tr><td>v0.1</td><td>30 janvier 2002</td><td></td></tr>
<tr style="background-color: #FAF5FF;"><td>v0.2</td><td>20 février 2002</td><td></td></tr>
<tr><td>v0.3</td><td>25 février 2002</td><td></td></tr>
<tr style="background-color: #FAF5FF;"><td>'''v1.0'''</td><td>4 mars 2002</td><td></td></tr>
<tr><td>v1.1</td><td>6 avril 2002</td><td></td></tr>
<tr style="background-color: #FAF5FF;"><td>v1.2</td><td>2003</td><td></td></tr>
<tr><td>v1.3</td><td>1er mai 2004</td><td></td></tr>
<tr style="background-color: #FAF5FF;"><td>'''v1.6.0'''</td><td>14 octobre 2004)</td><td>
* Passage du chat en TCP
* Ajout de l'authentification des connexions (protocole xNet 3.9)
* Amélioration de l'ergonomie
</td></tr>
<tr><td>v1.6.1</td><td>22 novembre 2004</td><td>
* Ajout d'une 'ignore-list'
* Ajout des notifications d'arrivée/départ des favoris
</td></tr>
<tr style="background-color: #FAF5FF;"><td>v1.6.2</td><td>22 mars 2004</td><td>
* Tab-completion des pseudos dans le chat
* Ajout d'informations (IP, Client, Localisation)
</td></tr>
<tr><td>v1.6.3</td><td>1er mai 2005</td><td>
* Fix principalement un 100% en cas d'absence de réseau
</td></tr>
<tr style="background-color: #FAF5FF;"><td>v1.6.4</td><td>23 septembre 2005</td><td>
* Passage au protocole xNet 4.0
* Ajout du support de BSD
* Sauvegarde des propriétés checkées
</td></tr>
<tr><td>'''v2.0.0'''</td><td>6 février 2006</td><td>
* Réécriture modulaire utilisant Qt4
* Carte permettant de situer visuellement les personnes
* Ajout de la notion de "Groupes"
</td></tr>
<tr style="background-color: #FAF5FF;"><td>v2.0.1</td><td>23 avril 2006</td><td>
* Bugfixes
</td></tr>
<tr><td>''v2.0.2''</td><td>''à venir...''</td><td>
* Meilleure intégration à MacOS X (Support de Growl, ajout de menus...)
* Notification des discussions
* Recherches avancées ne se limitant plus aux pseudo
* Bugfixes
</td></tr>
</table>

== Développement ==

Cette partie a pour but de présenter brièvement l'état du projet à travers l'organisation du développement.

=== Outils nécessaires ===

* Le développement de qRezix se fait comme tous les projets du BR via un système de partage de projet : [[Subversion|SVN]]. Il est donc nécessaire d'installer un client [[Subversion|SVN]] pour travailler. Sous Linux et Mac OS, il y a des packages de SVN qui sont distribuer. Sous Windows, il est fortement conseillé d'utiliser [http://tortoisesvn.tigris.org TortoiseSVN]. Pour plus d'information sur SubVersion, merci de vous référer à la [[Subversion|page correspondante]].

* Il faut également installer [[Qt]], la version dépend de la branche de travail. Pour qRezix 1.6, il faut utiliser Qt3 (3.3.3 ou ultérieure) alors que pour qRezix 1.7, Qt4 (4.0.1 ou ultérieure). Pour obtenir Qt3 pour Windows, merci de demander à [[User:Fruneau|Fruneau]]. Pour Qt4, il faut faire attention sur certaine distribution de bien installer tous les modules nécessaires (au moins Core, GUI et Network) et les outils qui vont avec (designer, linguist, assistant).

* Pour générer la documentation il peut être intéressant d'installer également [http://www.doxygen.org Doxygen]. La plupart du temps l'utilisation de Doxygen est très simple : il suffit de l'appliquer au fichier Doxyfile qui se trouve à la racine du projet.
doxygen Doxyfile

=== Structure de la SVN ===

Pour ce qui est de l'utilisation de SVN, je vous laisse vous référer à la [[Subversion#Utilisation_de_svn|page correspondante]]. Cette partie à plutôt pour but d'expliquer comment utiliser la SVN pour travailler sur qRezix.

Tout d'abord, il est important de noter que qRezix utilise une structure tout ce qu'il y a de plus classique (avec trunk, branches et tags). Le trunk étant la branche principale du projet.

==== Travailler sur la branche principale ====

La branche principale du projet correspond à la version qui évolue actuellement. A l'heure actuelle c'est la 1.6.x. Cette branche change régulièrement et on peut y trouver les dernières innovations réalisée sur cette branche. Lorsqu'on s'approche d'une release de qRezix, il faut freezer la branche principale. Pour ceci, on sépare le développement de la version qui va sortir de celui de la branche principale.

Par exemple pour release qRezix 1.6.4, j'ai freezé la branche environ 1 semaine et demi avant la sortie via :
svn copy trunk branches/qrezix--release--1.6.4

Une fois les branches séparées, la branche de release ne doit plus subir que des corrections de bugs. En cas de besoin, on pourra sortir des pre-release (rc). Une fois qu'une version est considérée stable, on la tag, c'est à dire qu'on fait une photographie instantannée du projet :
svn copy branches/qrezix--release--1.6.4 tags/qrezix--1.6.4-rc1 # pour une préversion
svn copy branches/qrezix--release--1.6.4 tags/qrezix--1.6.4 # pour la version définitive

On peut même envisager alors des révisions sur la version actuelle qui serait des bugfixes de la branche de release intervenu après la sortie. Dans ce cas, on aurait
svn copy branches/qrezix--release--1.6.4 tags/qrezix--1.6.4-r1 # pour une révision de la version

Ceci peut paraître contraignant, mais c'est la base d'un projet mené correctement. Ca permet d'avoir un historique des branches et des versions, de pouvoir envisager de sortir des révisions de toutes les branches de release en cas de découverte d'une faille importante du programme et ça évite surtout d'avoir une version qui s'éternise... lorsqu'on décide de freezer une version, ceux qui veulent continuer à innover travaillent sur le trunk pendant que d'autres stabilise la version de release.

==== Branches de devel ====

A côté de la branche principale, il peut y avoir des branches de devel. Alors que la différence entre 2 releases issues d'une même branche sont le plus souvent mineures voire de la simple maintenance, la différence entre le trunk et la branches de devel est quelque chose de beaucoup plus important. La branche de devel apporte des innonvations importantes et devrait conduire à une nouvelle version majeure du programme.

La branche de devel Qt4 vient d'être passée en branche principale.

==== Numérotation des versions ====

Comme pour tout programme, qRezix a des versions numérotées de la forme X.Y.Z-T
* X est la version majeure, il ne change que lors de modification très importantes de la structure du programme.
* Y est la version mineure, il change lorsque le programme a subit des évolution plus importante qu'une simple maintenance.
* Z est la version de maintenance, il change lorsque le programme subit des bugfixes et l'implémentation de fonctionnalités mineures.
* T est le tag

L'utilisation du tag est particulières :
* ''svn'' pour une version de développement avant les releases ou pre-release.
* ''alpha'' pour une pré-version non encore formalisée d'une nouvelle version majeure ou mineure du programme (2.0.0-alpha1 ou 1.7.0-alpha2 mais pas 1.6.5-alpha1)
* ''beta'' pour une pré-version formalisée d'une nouvelle version majeure ou mineure du programme (2.0.0-beta1 ou 1.7.0-beta2 mais pas 1.6.5-beta1)
* ''rc'' pour une version candidate à la release. Elle sert uniquement à la recherche de derniers bugs (1.6.2-rc1)
* ''r'' pour une révision d'une version déjà sortie. Elle sert uniquement à corriger de graves anomalies de la version (1.6.4-r1)

De manière générale, la numérotation doit être effectuée comme suit :
# A la release de la version X.Y.Z, la branche principale passe ne X.Y.(Z+1)-svn
# Si le besoin s'en fait sentir, des versions alpha, puis bêta et enfin rc peuvent être sorties. Mais attention, une version alpha doit être suivie d'au moins une version bêta puis d'une rc.
# Lorsque la version est considérée stable, elle est détaguée, et la release est effectuée. On revient dès lors au point 1

=== Traductions ===

Les traductions (gentil fardeau offert par JiBee), sont générée relativement simplement par Qt. Pour ceci, il faut procéder dans l'ordre :
* Dans le code, mettre les chaîne à traduire soit dans des tr("mon texte") ou QT_TR_NOOP("mon texte"). Le deuxième cas étant pour les textes qui se trouvent dans les définitions statiques.
* Générer le fichier d'index à l'aide de lupdate sur le projet :
# Pour qRezix 1.6
lupdate qrezix.pro
# Pour qRezix 2.0
lupdate */*.pro
* Editer les fichiers .ts avec Qt Linguist, et enregistrer les modifications. Les fichiers .ts sont dans le répertoires ''translations''.
* Compiler les fichiers .ts à l'aide de lrelease ou de Qt Linguist.
cd translations
lrelease *.ts
* Commiter le tout...

=== Documentation ===

La documentation de qRezix est composée de cette page, de la doc de l'API qu'il est possible de générer grâce à Doxygen, ainsi que de tout ce que vous pourrez trouver sur [http://fruneau cette page]. Dans tous les cas, la meilleure doc restera toujours une personne qui connait bien le projet :)...

Dans l'état actuel des choses, la meilleure doc de qRezix, c'est [[User:Fruneau|moi]].

=== Compiler qRezix ===

La compilation de qRezix n'est pas forcément une opération triviale, et dépend fortement de l'OS sur lequel on travail. La plupart des informations nécessaires sont contenues dans le fichier INSTALL. Voici quelques suppléments qui pourront toutefois être utiles :

==== Windows ====

Sous Windows, à l'heure actuelle, on compile avec Visual C++ 7.1 ou supérieur (qRezix ne compile pas avec VC++ 6). A l'heure actuelle, VC++ ne permet pas de compiler les modules en tant que tels car il est incapable de charger les membres de classes dans les DLL. On est donc forcés de tout compiler en un bloc en passant l'option "RZX_ALL_BUILTIN" à la compilation.

Tout d'abord il faut ouvrir une nouvelle console Visual Studio (pour avoir les variables d'environnement correctement définies). Dans cette console :
qmake "DEFINES+=RZX_ALL_BUILTIN" qrezix.pro
nmake

Si vous compilez une version SVN de qRezix, vous pouvez exécuter SubWCRev.exe pour convertir les occurences de $WCREV$ en numéro de révision.

Le packaging se fait à l'aidre de [http://nsis.sourceforge.net/Main_Page NSIS] en compilant le script qui est dans le répertoire package/windows

==== Linux ====

Sous Linux, il suffit de procéder strictement comme indiqué dans le fichier INSTALL
qmake qrezix.pro # cet appel est nécessaire dès que la structure du programme est modifiée...
make
qmake qrezix.pro # ce deuxième appel n'est nécessaire qu'à la première compilation où lors de l'apparition de nouveaux fichiers à installer
sudo make install

Pour mettre à jour le numéro de révision il peut être utile de forcer la recompilation de certaines parties du core :
touch core/core.pro
touch core/rzxapplication.cpp
make

Le packaging dépend énormément de la distribution... mais consiste dans la plupart des cas à réaliser une installation dans un chroot, l'archiver et lui ajouter les informations de packages (dépendants de la distribution... rpm, deb...).

<div style="border: 1px solid #9f6f8f; padding: .2em .5em .2em .5em; background-color: #FBEAF5">
Pour packager il faut partir d'un export de la SVN et non pas d'un checkout... Sinon les répertoires .svn resteront présents et peuvent fortement allourdir le paquet ou induire qRezix en erreur dans certains cas.
</div>

==== MacOS X ====

Sous MacOS X, un script est prévu pour réaliser la compilation. Il gère un certain nombre de problèmes liés à MacOS X, et il est fortement déconseillé de ne pas l'utiliser. Donc, pour compiler et créer un bundle utilisable il suffit de lancer la commande :
./build-mac

Pour compiler sous MacOS X il est nécessaire d'avoir installer la SDK de Growl. Et une fois compilé, de mettre Growl-withInstaller.framework dans le bundle qRezix.app/Content/Frameworks, sans quoi qRezix refusera de se lancer.

Ce script peut prendre un certain nombre de paramètres :
* -v : mode verbeux (affiche la sortie de make, qmake...)
* -q : ne lance pas les qmake (si cette option est ajoutée, le numéro de révision ne sera pas mis à jour dans la fenêtre de préférence)
* -jx : option -j de make (attention, la compilation universal binaries utilise déjà les 2 processeurs des biprocs)
* ... : toutes les autres options sont ajoutées aux CXXFLAGS

Pour packager qRezix pour MacOS, il suffit d'exécuter un autre script qui récupère le bundle de build-mac, le nettoie, y ajoute Qt et règle les dépendances des bibliothèques.
cd package/macosx
./package

<div style="border: 1px solid #6f8f9f; padding: .2em .5em .2em .5em; background-color: #EAF5FB">
Pour ceux qui voudraient profiter de Xcode, qmake peut générer des projet Xcode à partir du fichier .pro en exécutant :
qmake -spec macx-pbuilder machin.pro
Mais ceci mérite des test approfondis et une attention accrue pour éviter de délaisser le fichier .pro nécessaire pour les autres plateformes une fois le projet généré.
</div>

=== Coding Rules ===

Il est important de respecter un certain nombre de règles lorsqu'on travail sur un projet collectif. De fait, tout développeur de qRezix est prié de se tenir aux recommandations qui suivent :

<table style="border: 1px solid #6f8f9f; width: 100%">
<tr style="padding: .2em .5em .2em .5em; background-color: #EAF5FB">
<th colspan="2">'''Nomenclature'''</th>
</tr>
<tr>
<td>Les noms des classes sont préfixés par Rzx</td>
<td rowspan="5"><pre>
class RzxApplication
{
bool valid;

public:
bool isValid() const;
};
</pre></td>
</tr>
<tr style="background-color: #FAF5FF">
<td>Les noms des fonctions commencent par une minuscule</td>
</tr>
<tr>
<td>L'utilisation d'underscore est à éviter. On préférera utiliser des nom dont les séparations sont des majuscules</td>
</tr>
<tr style="background-color: #FAF5FF">
<td>La langue à utiliser de préférence est '''l'anglais'''</td>
</tr>
<tr>
<td>Les noms des fonctions/methodes doivent être cohérents avec les APIs Qt et qRezix, on évitera par exemple les getMyVar() en privilégiant myVar().</td>
</tr>
<tr style="padding: .2em .5em .2em .5em; background-color: #EAF5FB">
<th colspan="2">'''Accolades'''</th>
</tr>
<tr>
<td>Les accolades ouvrantes comme fermantes sont placées après un retour à la ligne</td>
<td rowspan="3"><pre>
if(a == b || c != d)
{
a = b + 1;
do(truc);
}

void RzxMyFunction::do() const
{
<bloc>;
}

class RzxMyClass
{
};
</pre></td>
</tr>
<tr style="background-color: #FAF5FF">
<td>Les opérateurs sont entourés d'espaces</td>
</tr>
<tr>
<td>Les parenthèse sont collées à l'opération associée (nom de fonction, contrôle de flux...)</td>
</tr>
<tr style="padding: .2em .5em .2em .5em; background-color: #EAF5FB">
<th colspan="2">'''Indentation'''</th>
</tr>
<tr>
<td>Les indentation sont réalisées à l'aide de ''tabulation''</td>
<td rowspan="4"><pre>
class RzxMyClass
{
<firstbloc>

public:
<secondbloc>

protected:
<thirdbloc>
};

switch(value)
{
case 1:
<bloc1>;

case 2:
<bloc2>;

case 3:
<bloc3>;
}

#if CASE1
# define MACHIN
#endif
</pre></td>
</tr>
<tr style="background-color: #FAF5FF">
<td>Les mots clés comme public: ou case: sont indentés et entraînent une indentation supplémentaire jusqu'au prochain mot clé</td>
</tr>
<tr>
<td>Ne pas oublier d'indenter également le préprocesseur</td>
</tr>
<tr style="background-color: #FAF5FF">
<td>Les fichiers doivent finir par une ligne vide</td>
</tr>
<tr style="padding: .2em .5em .2em .5em; background-color: #EAF5FB">
<th colspan="2">'''Commentaires et documentation'''</th>
</tr>
<tr>
<td>Les objets doivent être documentées à l'aide des syntaxe de Doxygen</td>
<td rowspan="3"><pre>
///Ceci est une description rapide
/** Ceci est une description avancée de la fonction
*/
void myFunction()
{
if(machin) // Le cas machin peut poser problème, on le traite donc à part
{
}

// TODO: implémenter le reste de la fonction

}
</pre></td>
</tr>
<tr style="background-color: #FAF5FF">
<td>A l'exception de la documentation des fonctions, on préférera les commentaires de la forme // Mon commentaire en français</td>
</tr>
<tr>
<td>// TODO: peut également être utilisé pour spécifier des implémentations à réaliser</td>
</tr>
</table>

== Branche 1.6 ==

=== Structure du programme ===

La structure interne du programme peut-être résumée au schéma suivant :

[[Image:qrezix-1.6_structure.png]]

Ce schéma n'est pas exhaustif, mais met en évidence les différentes imbrications des éléments. Toutes les cadres qui se chevauchent (et le cas échéant se contiennet) représente des classes qui sont imbriquées l'une à l'autre. Ansi la classe QRezix qui gère la totalité du programme est totalement dépendante de la quasitotalité des autres classes, la classe RzxConnectionLister dont le but est de lister les personnes est complètement dépendante de RzxRezal et vice-versa (il y a même des redondances de stockage)... idem, pour le chat qui est géré partiellement par RzxConnectionLister et partiellement par RzxRezal.

La classe RzxComputer a une importance réduite et la quasitotalité de ses données sont redondantes avec RzxItem. De plus certaines informations de RzxComputer sont stockées directement par RzxConfig, qui est elle-même à moitié implémentée par RzxProperty.

En résumé, la structure (déjà modularisée comparée à la version 1.2 dans laquelle RzxConnectionLister n'existait pas et était partie intégrante de RzxRezal) n'est pas facilement maintenable.

=== Interface de plug-ins ===

qRezix 1.6 est la première version à bénéficier d'une structure d'accueil de plug-in. Cette structure est rudimentaire et souffre du fait que qRezix n'est pas modulaire. En effet la classe RzxPlugIn est compilée à la fois dans le plug-in et dans qRezix, ce qui crée des problèmes dès que les deux versions diffèrent.

Pour éviter les problèmes, la version de la strucutre de plug-in est numéroté de façon très stricte, et le filtrage est fait au chargement du plug-in.

Ce défaut entraîne un grand nombre de complication. Les plug-ins n'ont absolument aucun accès direct aux données stockées par qRezix. Toutes les informations transitent donc par des fonction standardisées du plug-in, mais cette méthode de travail limite le nombre d'information pouvant être échangé. Il n'en reste pas moins que cette structure est tout à fait suffisante pour réaliser des plug-ins comme l'Xplo ou SmiliX (qui sont disponible sur la [[Subversion|SVN]] dans le reposoire qrezix-plugins).

Pour pouvoir faire un plug-in pour qRezix, il faut récupérer la dernière version de rzxplugin.h et rzxplugin.cpp dans la branche de release de qRezix correspondante à la version pour laquelle vous voulez faire le plugin. Il suffit alors de créer un projet dérivant de RzxPlugIn. La documentation de RzxPlugIn peut-être générée automatique à l'aide de [http://www.doxygen.org Doxygen] et peut-être trouvée [http://fruneau.eleves.polytechnique.fr/qrezix-1.6/classRzxPlugIn.html ici], de même pour la [http://fruneau.eleves.polytechnique.fr/xplo/ documentation du plug-in Xplo] qui permet d'avoir un bon exemple de plug-in complet.

Cette structure a totalement disparue avec qRezix 2.0 pour être remplacer par des modules plus souple et mieux conçus.

== Branche 2.0 ==

=== Objectif ===

Cette version de qRezix repose sur un double objectif :
* porter le code en Qt4.
* modulariser le programme.

==== Qt4 ====
Le premier point ne présente pas une difficulté énorme, mais a conduit à pas mal de réorganisation du code. En particulier, qRezix 2.0 bénéficie de la puissance du nouveau système Model/View de Qt4, ce qui a nécessiter de redévelopper la quasitotalité de l'interface principale.

La toute dernière version [[Subversion|SVN]] de qRezix utilise [[Qt]] version 4.1.0 minimum. qRezix 2.0 utilise des fonctions introduites dans Qt 4.1, et ne compilera pas avec Qt 4.0.

==== Modularité ====

La modularisation du programme est un point essentiel. Elle apporte un certain nombre d'évolution nécessaire à la survie de qRezix :
* restructuration du programme qui permet une meilleure maintenance
* possibilité de limiter qRezix à certaines fonctionnalités (utile pour l'utilisation chez des personnes qui n'ont pas besoin d'avoir le logiciel complet si par exemple ils n'utilisent jamais le chat).
* possibilité de travailler avec un plus grand nombre de personne sur le projet. Chacun pouvant en effet travailler sur un module
* possibilité de gérer plusieurs protocoles pour se connecter à plusieurs serveurs

=== Structure du programme ===

Le schéma suivant représente de manière simplifié la structure interne de qRezix 2.0.x :

[[Image:qrezix-2.0_structure.png]]

Bien que le nombre d'élément soit impressionnant, cette structure est beaucoup plus propre que celle de qRezix 1.6. Le schéma montre en effet en particulier que les éléments sont proprement séparé, les seuls dépendances entre les modules qu'il peut y avoir sont gérées par la bibliothèque principale.

Le RzxComputer a acquis un rôle beaucoup plus important, il gère désormais la totalité des informations concernant une machine et inclus les actions qu'il est envisageable d'effectuer (propriétés, chat, http, ftp...). Le chat est géré par les modules qui se déclarent comme supportant cette fonctionnalité, de même pour les propriétés.

La fenêtre de préférences (RzxProperty) génère dynamiquement la page de propriétés en fonction de ce que les modules installés désirent. Et tout est mis en oeuvre (au travers de classe abstraites regroupant tous les outils nécessaires) pour que chaque module puisse créer simplement ses propres classes de configuration.

Les modules peuvent être construit soit en built-in soit en plug-in. Aucun n'est nécessaire au fonctionnement du programme (enfin si on retire tous les protos réseau, programme perd beaucoup de son intérêt).

BR2003

2006-06-24T22:43:50Z

Fruneau : Corrige les majuscules dans les pseudo

{{menu BR}}
Le fabuleux BR2003 créateur de ce wiki ;)

== Équipe ==

{| border=0 width=50% align=center
| [[Utilisateur:Dei|dei]] || Prez, admin@windows
|-
| [[Utilisateur:Fruneau|Fruneau]] || devel, root, news
|-
| [[Utilisateur:Pico|Pico]] || root, web, devel, X-share
|-
| [[Utilisateur:NC|NC]] || root, news, IRCop, devel
|-
| [[Utilisateur:El-sio|el-sio]] || root, TV
|-
| [[Utilisateur:Ecco|Ecco]] || root, TOL
|-
| [[Utilisateur:Esope|Esope]] || web@frankiz, TV
|-
| [[Utilisateur:Bery|Bery]] || web@frankiz, Com
|-
| [[Utilisateur:Alban|Alban]] || web@frankiz, Trez
|-
| [[Utilisateur:Maupertuis|Maupertuis]] || admin@windows
|-
| [[Utilisateur:Dr00gun|Dr00gun]] || admin@windows, FAQ
|-
| [[Utilisateur:Copernic|Copernic]] || admin@windows, X-share, FAQ
|-
| [[Utilisateur:GZeuS|GZeuS]] || devel, X-share, FAQ
|-
| [[Utilisateur:MYk|mYk]] || devel, X-share, FAQ, InfoBR
|-
| [[Utilisateur:SchoppenHaueR|SchoppenHaueR]] || FAQ
|-
| [[Utilisateur:OlivPi|OlivPi]] || FAQ
|-
| [[Utilisateur:Thierry|Thierry]] || QDJ Master
|-
|}

==Projets==

* Réalisation et mise en place du nouveau site [[FrankizII|Frankiz]] initié par le [[BR2002]]
* Réseau [[WiFi]]
* Mise en forme du projet [[Admin:DHCP|DHCP]] (page privée)
* Amélioration de [[qRezix]]

News

2006-06-23T12:14:29Z

Fruneau : Ajout des newsgroups d'admin && précision de l'année de la mise en place des restriction de br.kes

{{menu services}}
Le BR fournit aux élèves environ 250 newsgroups. Dans la plupart des autres école les mailings lists ont été privilégiées mais ici une grande partie de la vie promo se déroule sur des forums. On en trouve de toutes les formes (pour les sections, les binets, les nouveaux bâtiments, l'enseignement, les communautés...).

== Utilité des Newsgroups ==

Les différents newsgroups sont regroupés par catégories qui permet une plus grande lisibilité. Chaque catégorie de newsgroup a son rôle propre.
* '''br.binet.*''' : les newsgroups des binets, pour la com interne et externe des binets
* '''br.communaute.*''' : pour regrouper les ''gens'' autour de leurs passions, hors des cadres des binets.
* '''br.section.*''', '''br.promo.*''', '''br.bat.*''' : pour refléter l'organisation de l'école, et permettre la communication facilement entre les différents groupes constitués par le découpage géographique et administratifs des élèves
* '''br.informatique.*''' : pour le dépannage informatique... Il faut bien insister que le BR n'est pas réparateur informatique, et que donc br.binet.br n'est pas adapté pour le dépannage ne dépendant pas du BR.
* '''br.media.*''' : pour le partage de medias (personnellement j'ai pas, c'est un peu de l'incitation au piratage)
* '''br.pa.*''' : pour les petites annonces, 'ping machin', 'vend truc'...
* '''br.enseignement.*''' : pour tout ce qui a rapport à l'enseignement, y compris les 'ping projet machin'
* '''br.eleves''' : pour tout ce qu'on ne peut pas ranger autre part.
* '''br.*''' : tous les autres newsgroups
* '''public.*''' : newsgroups fournit par la DSI dont le BR assure un miroir. Ces newsgroups sont accessible à tout le personnel de l'Ecole
* '''private.*''', '''control.cancel''' : newsgroups privés du BR.
* '''local.*''', '''control.*''', '''junk''' : newsgroups d'administration

== Crossposts ==

Les crossposts sont le seul moyen acceptable de poster un même message sur différents newsgroups. Leur intérêt est de simplifier l'envoi et la lecture des posts :
* Il n'y a besoin que de poster un seul message pour qu'il apparaisse sur plusieurs newsgroups
* Il n'y a besoin de le lire que sur un seul newsgroup
* Toutes les réponses aboutissent au même endroit
* Les newsmestres sont contents
* Les lecteurs sont contens
* Le posteur est content

Il faut tout de même faire attention... il y a une facheuse tendance sur les newsgroups à faire un crosspost sur 50 newsgroups pour 1 message de merde (genre ping clope)...

Faire un crosspost nécessite juste de :
* définir plusieurs newsgroups de destination
* définir un newsgroups de réponse (Follow-up, Transmettre)

== Les fups ==

Les fups, c'est l'art et la manière de forcer quelqu'un à répondre sur le mauvais newsgroups... ça fait bien rire selui qui a fuppé, et ça agace celui qui s'est fait fupper. Il faut en particulier se méfier des vagues de fup (pâles, arrivée des TOS...) qui on tendance à pourir des newsgroups qui hébergent des discussion sérieuses.

Les fups sont bien sûr désactivables via les scripts du serveur.

== br.kes ==

Suite à l'AG Kès de juin 2005 et aux trolls qui on pourrit br.kes à l'issue, la Kès a demandé à ce que br.kes ait un régime spécial :
* tout le monde peut initier une discussion
* les fups vers br.kes sont interdits
* les kessiers peuvent faire ce qu'ils veulent.

BR2002

2006-06-14T10:50:56Z

Fruneau : Ajout d'une photo sur la page du BR2002

{{menu BR}}

{| border=0 width=50% align=center
| [[User:Kikx|Kikx]] || prez
|-
| [[User:Falco|Falco]] || root News IRCop
|-
| Schmurtz || root XShareMac
|-
| [[User:PaXaL|PaXaL]] || root web@frankiz
|-
| Matrix || admin@windows
|-
| Moi || admin@windows
|-
| Bolzano || web@frankiz
|-
| Alyx || Trez
|-
| ArthurB || IRCop
|-
| LazyStuff || QDJ Master
|-
| Arrakis || root
|-
| mlk || web@frankiz
|-
| PsyCow || Faqmestre
|-
| Steak || Devel News
|-
| Neo || XShare
|-
| [[Utilisateur:WakeUpNeo|WakeUpNeo]] || web@poly
|-
| R2 || TOL XShare
|}

[[Image:BR2002_DSI.jpg|thumb|right|Pot BR2002-DSI]]

=== Réalisations ===
* Mise en place du partenariat de [[MSDNAA]]
* Renouvellement des serveurs [[Admin:Frankiz|Frankiz]], [[Admin:Heol|Heol]] et achat de [[Admin:Lunedenn|Lunedenn]]
* Lancement du projet [[WiFi]]
* Lancement du projet [[FrankizII]] de restructuration de [http://frankiz]

Modèle:Block contacts

2006-06-12T20:47:56Z

Fruneau :

<div style="width: 100%; margin-top: 0.5em; margin-bottom: 0.5em; border: 1px solid #6f8f9f;">
<div style="padding: .3em .5em .2em .5em; border-bottom: 1px solid #6f8f9f; background-color: #EAF5FB;"><big>[[Image:Mail.png|16px]] Contacts et liens</big></div>
<div style="padding: .2em .5em .5em .5em; background-color: #FFF; text-align: left;">

* [[Le Binet Réseau]]
* [[Partenaires|Nos partenaires commerciaux]]

'''Autres liens'''
* [http://www.federez.org Federez, l'association des associations réseaux des Ecoles]
* [http://www.polytechnique.fr L'Ecole Polytechnique]
* [http://www.frankiz.net Frankiz, la page des élèves]
* [http://www.polytechnique.org Polytechnique.org]

</div>
</div>

BugTracker

2006-06-12T13:43:46Z

Fruneau : How-To report a bug

{{menu projets}}

Le BR dispose d'un bugtracker pour faciliter la gestion de ses projets. Ce bugtracker est ouvert à tous : tout le monde peut y ajouter une taâche à réaliser. Ce tracker peut-être aussi bien utilisé pour ajouter des rapports de bugs que des demandes de nouvelles fonctionnalités.

== Comment rapporter un bug ? ==

=== Collecter les informations ===
Tout d'abord avant de rapporter un bug, collecte un maximum d'informations sur l'erreur. Les principales informations sont :
* date et heure du problème (en particulier si il s'agit d'un bug d'une page web)
* procédure que tu as effectuée pour obtenir l'erreur et si possible permettant de la reproduire
* la version du programme (ou du navigateur Internet si c'est un bug d'une page web)
* toutes les informations permettant de décrire l'erreur : message, numéro, backtrace...

Une fois que tu as toutes ces informations, il ne te reste plus qu'à les transmettre au BR.

=== Utiliser le tracker ===
Le tracker du BR se trouve à l'adresse [http://bugs.frankiz http://bugs.frankiz]. Il n'est pas accessible à l'extérieur de l'Ecole. Quand tu veux soummettre un nouveau bug, tu as deux solutions :
* soit [http://bugs.frankiz/newuser tu t'enregistres en tant que nouvel utilisateur] et tu pourras ainsi recevoir des informations de suivi des tâches que tu as soumises
* soit tu le fais anonymement

Choisi le projet sur lequel tu veux ajouter une informations dans la liste déroulante (par défaut c'est Frankiz) et clique sur le lien ''Ajouter une nouvelle tâche'' (ou ''Ouvrir une nouvelle tâche anonymement'' si tu ne t'es pas créé de compte). Si le projet n'est pas dans la liste il faudra [[#Contacter_les_développeurs|contacter directement les développeurs]]

Rempli le formulaire avec un '''titre explicite''', et dans les détails mets toutes les informations que tu as pu récolter sur le bug.

=== Contacter les développeurs ===
Si le projet n'est pas dans le tracker ou si la [http://bugs.frankiz page du tracker] est innaccessible, il est également possible de contacter directement les développeurs :
* soit en postant sur [news://frankiz/br.binet.br.devel br.binet.br.devel]
* soit en envoyant un mail à l'adresse du projet :
qRezix : qrezix #AT# frankiz.polytechnique.fr
Frankiz : devel-web #AT# frankiz.polytechnique.fr
TV : tv #AT# frankiz.polytechnique.fr
WiFi : wifi #AT# frankiz.polytechnique.fr
xNetServer, mxNet ou CocaxNet : xnet #AT# frankiz.polytechnique.fr
autre : br #AT# frankiz.polytechnique.fr

== Le tracker utilisé ==

Le tracker utilisé par le BR est [http://flyspray.rocks.cc/ Flyspray]. Il a été choisi pour sa légèreté et sa clareté. Son interface est en effet bien conçu, facile à utilisée même pour un utilisateur peu habitué aux outils informatiques. Il gère correctement plusieurs projets en permettant de personnaliser un grand nombre de paramètres pour chaque projet tout en laissant la possibilité de définir des paramètres globaux. Son interface visuelle et intuitive permettent aux développeurs de trouver facilement les tâches et de faire le point sur l'état du projet.

Le premier choix du [[BR2003]] c'était porté sur bugzilla. Mais cet outil c'est révélé lourd, peu convivial et parfois à la limite de l'illisible. Le tracker s'en était retrouvé abandonné rapidement.

QRezix

2006-06-12T12:26:08Z

Fruneau : Mise à jour de l'organigramme de la structure de qRezix 2.0

{{menu projets}}
qRezix est le principal client [[xNet]] encore maintenu. Il doit sa survie à sa qualité d'être le seul client développé qui soit multiplateforme tout en restant graphiquement potable. Il doit ces deux qualités à la bibliothèque [[Qt]].

== Historique ==

=== BR2000 ===

Le projet en lui-même est né avec un groupe de BRmen X2000 menés par Doudou qui étaient fans de Qt (qui à l'époque n'était pas terrible-terrible...). Ils ont travaillé à 3 ou 4 pour sortir la version 1.0 le 4 mars 2002, suivie de près par la version 1.1 le 6 avril. L'équipe de développement comportait entre autres Doudou, MadCoder et Trasfract (Sylvain Joyeux, Pierre Habouzit et Benoït Casoetto).

Le projet s'est principalement inspiré des clients qui existaient déjà à l'époque (Rezix en particulier, duquel qRezix a tiré son nom). Cette architecture simple est une fenêtre avec une liste de client chaque entrée indiquant le nom, la promo, les serveurs... Les favoris sont affichés en premier selon le choix de l'utilisateur.

=== BR2001 ===

Le BR2001 n'a pas énormément travaillé sur qRezix. Il y a eu la version 1.2, mais on n'a aucune trace de ce que JiBee a bien pu faire sur le projet. Ce qui est certain, c'est qu'après la vesion 1.2, il a porté qRezix en Qt3 et a travaillé sur l'internationalisation du projet. Le but d'origine n'était pas de rendre qRezix international, mais simplement de résoudre les problèmes d'encodage des caractères accentués. Le code source a donc totalement été traduit en anglais et une traduction française a été créée.

[[Image:qrezix-1.2.gif|center]]

A priori, il n'y a pas eu de release en Qt3... mais d'après [[User:Ey|Ey]] qui packageait le projet pour Windows, il y en aurait eu... Mais en tout cas à l'arrivée des 2003 c'était toujours la version 1.2 (en Qt2) qui était disponible... Le BR n'avait de plus pas de license pour Qt3 sous Windows.

=== BR2002 ===

Le projet était géré par Steak. La version 1.3 a été release le 1 mai 2004. Cette version n'était absolument par révolutionnaire mais apportait quelques améliorations dans la structure du code et des amélioration du comportement du programme.

Steak a ensuite travaillé sur la version 1.3.666 et en particulier sur l'authentification avec le serveur. Mais il a vite arrêter de travailler sur qRezix en raison du temps qu'il consacrait à l'étude du japonnais, et à différents problèmes occulaires. Cependant, le [[BR2002]] a réalisé une prépassation très avancée ce qui fait que dès le mois de juin, la relève était en place...

=== BR2002/BR2003 : le temps d'une prépassation ===

Le [[BR2003]] a donc commencé sont travail sur qRezix dès le mois de juin 2004.

La première chose a été de recompiler une version pour Windows, ce qui n'avait plus été fait depuis près d'un an. Ceci permettait donc d'envisager de futures release du programme pas uniquement sous Linux. Le travail s'est finalement concentré pendant les vacances d'été avec une amélioration importante de l'interface et de la structure interne (début de séparation de la gestion des connexions de l'affichage), la création d'une structure (pas terrible) de chargement de plug-ins, l'ajout d'icône pour rendre l'interface plus conviviale... La version a été tagguée tour à tour 1.3.666 puis 1.5.

Une autre innovation importante à été le passage du chat qui reposait sur un protocole en UDP vers un protocole TCP. Le but déclaré du BR2002 étant de rendre les communication fiables et sécurisées (on veut savoir si l'autre ne reçoit pas nos messages).

Toutes ces modifications associées au travail de Steak sur l'authentification et le travail de JiBee pour recoder un nouveau [[xNetServer|serveur xNet]], on conduit à la version 1.6 de qRezix qui est sorti le 14 octobre 2004 à la fois pour Windows, Linux et Mac OS X.

[[Image:qrezix-1.6.png|center]]

Face à qRezix 1.6.0 est apparu Rezix.NET qui se voulait innovant. Conséquence de ceci, on a travaillé à 2 avec Steak pour implémenter dans qRezix toutes les fonctionnalité des Rezix.NET. Ce qui a rapidement conduit à la sortie de qRezix 1.6.1 le 22 novembre 2004. C'était la dernière version sur laquelle ait travailler Steak. Rezix.NET (qui était codé en .NET par un membre dissidant du BR2002) n'a finalement pas fait long feu.

=== BR2003 ===

La suite a été plus calme. La préparation de qRezix 1.6.2 s'est faite tranquillement, l'objectif principal était de supprimer un maximum de bugs de cette future version. Les innovations n'ont pas été nombreuses, mais on pourra noter la completion du nick dans le chat avec tab et la recherche intelligente via clavier. Cette version a vu le retour de Ey parmi les développeurs. Elle a aussi été la seule version à bénéficier d'une sortie ayant été précédée de 2 release-candidates qui ont aidées à corriger plusieurs bugs supplémentaires. La version a finalement été sortie le 22 mars 2005.

Le problème de cette version est qu'elle a introduit un bug... enfin plutôt révélé un bug. Jusqu'à présent qRezix plantait en l'absence de réseau ce qui a été corrigé avec la 1.6.2. Mais ce que je n'avais pas remarqué à l'époque c'était qu'en l'absence de réseau qRezix raffraichissait la fenêtre toutes les secondes et en même temps changeait le thême d'icône. Conséquence directe de ce défaut, qRezix prenait 100% du processeur en l'absence de réseau, ce que j'ai eu la chance de constater lors de ma soutenance de modex... Il fallait donc sortir un version avant l'arrivée des 2004 pour éviter que ce bug ne pose trop de problème aux 2004 qui allaient passer leur soutenance de stage. C'est pour ça qu'est sortie la verson 1.6.3 le 1 mai 2005. Cette version innovait au passage une nouvelle organisation plus agréable des propriétés et peut-être globalement considérée comme stable. La version 1.6.4 sortie le 23 septembre apporte peu d'innovation si ce n'est la cache des propriétés, les icônes en 32bits et une meilleure intégration à Mac OS.

Suite à la sortie de Qt4, le port de qRezix vers cette nouvelle mouture de la bibliothèque de Trolltech a été l'occasion de grand remaniement du code. Ceci a abouti à la versin 2.0 de qRezix dont le principal atout est d'être modulaire. La version 2.0.0 est sortie le 6 février 2006, et a rapidement supplanté la version 1.6.x.

[[Image:qrezix-2.0.png|800px|center]]

<div style="border: 1px solid #6f8f9f; padding: .2em .5em .2em .5em; background-color: #EAF5FB">
Pour écrire cette partie, j'ai utilisé mes connaissances personnelles issues ainsi que les informations contenues dans le ChangeLog. Et j'espère bien que d'autres y jetteront un coup d'oeil pour compléter/corriger les parties inexactes.
</div>

== Développement ==

Cette partie a pour but de présenter brièvement l'état du projet à travers l'organisation du développement.

=== Outils nécessaires ===

* Le développement de qRezix se fait comme tous les projets du BR via un système de partage de projet : [[Subversion|SVN]]. Il est donc nécessaire d'installer un client [[Subversion|SVN]] pour travailler. Sous Linux et Mac OS, il y a des packages de SVN qui sont distribuer. Sous Windows, il est fortement conseillé d'utiliser [http://tortoisesvn.tigris.org TortoiseSVN]. Pour plus d'information sur SubVersion, merci de vous référer à la [[Subversion|page correspondante]].

* Il faut également installer [[Qt]], la version dépend de la branche de travail. Pour qRezix 1.6, il faut utiliser Qt3 (3.3.3 ou ultérieure) alors que pour qRezix 1.7, Qt4 (4.0.1 ou ultérieure). Pour obtenir Qt3 pour Windows, merci de demander à [[User:Fruneau|Fruneau]]. Pour Qt4, il faut faire attention sur certaine distribution de bien installer tous les modules nécessaires (au moins Core, GUI et Network) et les outils qui vont avec (designer, linguist, assistant).

* Pour générer la documentation il peut être intéressant d'installer également [http://www.doxygen.org Doxygen]. La plupart du temps l'utilisation de Doxygen est très simple : il suffit de l'appliquer au fichier Doxyfile qui se trouve à la racine du projet.
doxygen Doxyfile

=== Structure de la SVN ===

Pour ce qui est de l'utilisation de SVN, je vous laisse vous référer à la [[Subversion#Utilisation_de_svn|page correspondante]]. Cette partie à plutôt pour but d'expliquer comment utiliser la SVN pour travailler sur qRezix.

Tout d'abord, il est important de noter que qRezix utilise une structure tout ce qu'il y a de plus classique (avec trunk, branches et tags). Le trunk étant la branche principale du projet.

==== Travailler sur la branche principale ====

La branche principale du projet correspond à la version qui évolue actuellement. A l'heure actuelle c'est la 1.6.x. Cette branche change régulièrement et on peut y trouver les dernières innovations réalisée sur cette branche. Lorsqu'on s'approche d'une release de qRezix, il faut freezer la branche principale. Pour ceci, on sépare le développement de la version qui va sortir de celui de la branche principale.

Par exemple pour release qRezix 1.6.4, j'ai freezé la branche environ 1 semaine et demi avant la sortie via :
svn copy trunk branches/qrezix--release--1.6.4

Une fois les branches séparées, la branche de release ne doit plus subir que des corrections de bugs. En cas de besoin, on pourra sortir des pre-release (rc). Une fois qu'une version est considérée stable, on la tag, c'est à dire qu'on fait une photographie instantannée du projet :
svn copy branches/qrezix--release--1.6.4 tags/qrezix--1.6.4-rc1 # pour une préversion
svn copy branches/qrezix--release--1.6.4 tags/qrezix--1.6.4 # pour la version définitive

On peut même envisager alors des révisions sur la version actuelle qui serait des bugfixes de la branche de release intervenu après la sortie. Dans ce cas, on aurait
svn copy branches/qrezix--release--1.6.4 tags/qrezix--1.6.4-r1 # pour une révision de la version

Ceci peut paraître contraignant, mais c'est la base d'un projet mené correctement. Ca permet d'avoir un historique des branches et des versions, de pouvoir envisager de sortir des révisions de toutes les branches de release en cas de découverte d'une faille importante du programme et ça évite surtout d'avoir une version qui s'éternise... lorsqu'on décide de freezer une version, ceux qui veulent continuer à innover travaillent sur le trunk pendant que d'autres stabilise la version de release.

==== Branches de devel ====

A côté de la branche principale, il peut y avoir des branches de devel. Alors que la différence entre 2 releases issues d'une même branche sont le plus souvent mineures voire de la simple maintenance, la différence entre le trunk et la branches de devel est quelque chose de beaucoup plus important. La branche de devel apporte des innonvations importantes et devrait conduire à une nouvelle version majeure du programme.

La branche de devel Qt4 vient d'être passée en branche principale.

==== Numérotation des versions ====

Comme pour tout programme, qRezix a des versions numérotées de la forme X.Y.Z-T
* X est la version majeure, il ne change que lors de modification très importantes de la structure du programme.
* Y est la version mineure, il change lorsque le programme a subit des évolution plus importante qu'une simple maintenance.
* Z est la version de maintenance, il change lorsque le programme subit des bugfixes et l'implémentation de fonctionnalités mineures.
* T est le tag

L'utilisation du tag est particulières :
* ''svn'' pour une version de développement avant les releases ou pre-release.
* ''alpha'' pour une pré-version non encore formalisée d'une nouvelle version majeure ou mineure du programme (2.0.0-alpha1 ou 1.7.0-alpha2 mais pas 1.6.5-alpha1)
* ''beta'' pour une pré-version formalisée d'une nouvelle version majeure ou mineure du programme (2.0.0-beta1 ou 1.7.0-beta2 mais pas 1.6.5-beta1)
* ''rc'' pour une version candidate à la release. Elle sert uniquement à la recherche de derniers bugs (1.6.2-rc1)
* ''r'' pour une révision d'une version déjà sortie. Elle sert uniquement à corriger de graves anomalies de la version (1.6.4-r1)

De manière générale, la numérotation doit être effectuée comme suit :
# A la release de la version X.Y.Z, la branche principale passe ne X.Y.(Z+1)-svn
# Si le besoin s'en fait sentir, des versions alpha, puis bêta et enfin rc peuvent être sorties. Mais attention, une version alpha doit être suivie d'au moins une version bêta puis d'une rc.
# Lorsque la version est considérée stable, elle est détaguée, et la release est effectuée. On revient dès lors au point 1

=== Traductions ===

Les traductions (gentil fardeau offert par JiBee), sont générée relativement simplement par Qt. Pour ceci, il faut procéder dans l'ordre :
* Dans le code, mettre les chaîne à traduire soit dans des tr("mon texte") ou QT_TR_NOOP("mon texte"). Le deuxième cas étant pour les textes qui se trouvent dans les définitions statiques.
* Générer le fichier d'index à l'aide de lupdate sur le projet :
# Pour qRezix 1.6
lupdate qrezix.pro
# Pour qRezix 2.0
lupdate */*.pro
* Editer les fichiers .ts avec Qt Linguist, et enregistrer les modifications. Les fichiers .ts sont dans le répertoires ''translations''.
* Compiler les fichiers .ts à l'aide de lrelease ou de Qt Linguist.
cd translations
lrelease *.ts
* Commiter le tout...

=== Documentation ===

La documentation de qRezix est composée de cette page, de la doc de l'API qu'il est possible de générer grâce à Doxygen, ainsi que de tout ce que vous pourrez trouver sur [http://fruneau cette page]. Dans tous les cas, la meilleure doc restera toujours une personne qui connait bien le projet :)...

Dans l'état actuel des choses, la meilleure doc de qRezix, c'est [[User:Fruneau|moi]].

=== Compiler qRezix ===

La compilation de qRezix n'est pas forcément une opération triviale, et dépend fortement de l'OS sur lequel on travail. La plupart des informations nécessaires sont contenues dans le fichier INSTALL. Voici quelques suppléments qui pourront toutefois être utiles :

==== Windows ====

Sous Windows, à l'heure actuelle, on compile avec Visual C++ 7.1 ou supérieur (qRezix ne compile pas avec VC++ 6). A l'heure actuelle, VC++ ne permet pas de compiler les modules en tant que tels car il est incapable de charger les membres de classes dans les DLL. On est donc forcés de tout compiler en un bloc en passant l'option "RZX_ALL_BUILTIN" à la compilation.

Tout d'abord il faut ouvrir une nouvelle console Visual Studio (pour avoir les variables d'environnement correctement définies). Dans cette console :
qmake "DEFINES+=RZX_ALL_BUILTIN" qrezix.pro
nmake

Si vous compilez une version SVN de qRezix, vous pouvez exécuter SubWCRev.exe pour convertir les occurences de $WCREV$ en numéro de révision.

Le packaging se fait à l'aidre de [http://nsis.sourceforge.net/Main_Page NSIS] en compilant le script qui est dans le répertoire package/windows

==== Linux ====

Sous Linux, il suffit de procéder strictement comme indiqué dans le fichier INSTALL
qmake qrezix.pro # cet appel est nécessaire dès que la structure du programme est modifiée...
make
qmake qrezix.pro # ce deuxième appel n'est nécessaire qu'à la première compilation où lors de l'apparition de nouveaux fichiers à installer
sudo make install

Pour mettre à jour le numéro de révision il peut être utile de forcer la recompilation de certaines parties du core :
touch core/core.pro
touch core/rzxapplication.cpp
make

Le packaging dépend énormément de la distribution... mais consiste dans la plupart des cas à réaliser une installation dans un chroot, l'archiver et lui ajouter les informations de packages (dépendants de la distribution... rpm, deb...).

<div style="border: 1px solid #9f6f8f; padding: .2em .5em .2em .5em; background-color: #FBEAF5">
Pour packager il faut partir d'un export de la SVN et non pas d'un checkout... Sinon les répertoires .svn resteront présents et peuvent fortement allourdir le paquet ou induire qRezix en erreur dans certains cas.
</div>

==== MacOS X ====

Sous MacOS X, un script est prévu pour réaliser la compilation. Il gère un certain nombre de problèmes liés à MacOS X, et il est fortement déconseillé de ne pas l'utiliser. Donc, pour compiler et créer un bundle utilisable il suffit de lancer la commande :
./build-mac

Pour compiler sous MacOS X il est nécessaire d'avoir installer la SDK de Growl. Et une fois compilé, de mettre Growl-withInstaller.framework dans le bundle qRezix.app/Content/Frameworks, sans quoi qRezix refusera de se lancer.

Ce script peut prendre un certain nombre de paramètres :
* -v : mode verbeux (affiche la sortie de make, qmake...)
* -q : ne lance pas les qmake (si cette option est ajoutée, le numéro de révision ne sera pas mis à jour dans la fenêtre de préférence)
* -jx : option -j de make (attention, la compilation universal binaries utilise déjà les 2 processeurs des biprocs)
* ... : toutes les autres options sont ajoutées aux CXXFLAGS

Pour packager qRezix pour MacOS, il suffit d'exécuter un autre script qui récupère le bundle de build-mac, le nettoie, y ajoute Qt et règle les dépendances des bibliothèques.
cd package/macosx
./package

<div style="border: 1px solid #6f8f9f; padding: .2em .5em .2em .5em; background-color: #EAF5FB">
Pour ceux qui voudraient profiter de Xcode, qmake peut générer des projet Xcode à partir du fichier .pro en exécutant :
qmake -spec macx-pbuilder machin.pro
Mais ceci mérite des test approfondis et une attention accrue pour éviter de délaisser le fichier .pro nécessaire pour les autres plateformes une fois le projet généré.
</div>

=== Coding Rules ===

Il est important de respecter un certain nombre de règles lorsqu'on travail sur un projet collectif. De fait, tout développeur de qRezix est prié de se tenir aux recommandations qui suivent :

<table style="border: 1px solid #6f8f9f; width: 100%">
<tr style="padding: .2em .5em .2em .5em; background-color: #EAF5FB">
<th colspan="2">'''Nomenclature'''</th>
</tr>
<tr>
<td>Les noms des classes sont préfixés par Rzx</td>
<td rowspan="5"><pre>
class RzxApplication
{
bool valid;

public:
bool isValid() const;
};
</pre></td>
</tr>
<tr style="background-color: #FAF5FF">
<td>Les noms des fonctions commencent par une minuscule</td>
</tr>
<tr>
<td>L'utilisation d'underscore est à éviter. On préférera utiliser des nom dont les séparations sont des majuscules</td>
</tr>
<tr style="background-color: #FAF5FF">
<td>La langue à utiliser de préférence est '''l'anglais'''</td>
</tr>
<tr>
<td>Les noms des fonctions/methodes doivent être cohérents avec les APIs Qt et qRezix, on évitera par exemple les getMyVar() en privilégiant myVar().</td>
</tr>
<tr style="padding: .2em .5em .2em .5em; background-color: #EAF5FB">
<th colspan="2">'''Accolades'''</th>
</tr>
<tr>
<td>Les accolades ouvrantes comme fermantes sont placées après un retour à la ligne</td>
<td rowspan="3"><pre>
if(a == b || c != d)
{
a = b + 1;
do(truc);
}

void RzxMyFunction::do() const
{
<bloc>;
}

class RzxMyClass
{
};
</pre></td>
</tr>
<tr style="background-color: #FAF5FF">
<td>Les opérateurs sont entourés d'espaces</td>
</tr>
<tr>
<td>Les parenthèse sont collées à l'opération associée (nom de fonction, contrôle de flux...)</td>
</tr>
<tr style="padding: .2em .5em .2em .5em; background-color: #EAF5FB">
<th colspan="2">'''Indentation'''</th>
</tr>
<tr>
<td>Les indentation sont réalisées à l'aide de ''tabulation''</td>
<td rowspan="4"><pre>
class RzxMyClass
{
<firstbloc>

public:
<secondbloc>

protected:
<thirdbloc>
};

switch(value)
{
case 1:
<bloc1>;

case 2:
<bloc2>;

case 3:
<bloc3>;
}

#if CASE1
# define MACHIN
#endif
</pre></td>
</tr>
<tr style="background-color: #FAF5FF">
<td>Les mots clés comme public: ou case: sont indentés et entraînent une indentation supplémentaire jusqu'au prochain mot clé</td>
</tr>
<tr>
<td>Ne pas oublier d'indenter également le préprocesseur</td>
</tr>
<tr style="background-color: #FAF5FF">
<td>Les fichiers doivent finir par une ligne vide</td>
</tr>
<tr style="padding: .2em .5em .2em .5em; background-color: #EAF5FB">
<th colspan="2">'''Commentaires et documentation'''</th>
</tr>
<tr>
<td>Les objets doivent être documentées à l'aide des syntaxe de Doxygen</td>
<td rowspan="3"><pre>
///Ceci est une description rapide
/** Ceci est une description avancée de la fonction
*/
void myFunction()
{
if(machin) // Le cas machin peut poser problème, on le traite donc à part
{
}

// TODO: implémenter le reste de la fonction

}
</pre></td>
</tr>
<tr style="background-color: #FAF5FF">
<td>A l'exception de la documentation des fonctions, on préférera les commentaires de la forme // Mon commentaire en français</td>
</tr>
<tr>
<td>// TODO: peut également être utilisé pour spécifier des implémentations à réaliser</td>
</tr>
</table>

== Branche 1.6 ==

=== Structure du programme ===

La structure interne du programme peut-être résumée au schéma suivant :

[[Image:qrezix-1.6_structure.png]]

Ce schéma n'est pas exhaustif, mais met en évidence les différentes imbrications des éléments. Toutes les cadres qui se chevauchent (et le cas échéant se contiennet) représente des classes qui sont imbriquées l'une à l'autre. Ansi la classe QRezix qui gère la totalité du programme est totalement dépendante de la quasitotalité des autres classes, la classe RzxConnectionLister dont le but est de lister les personnes est complètement dépendante de RzxRezal et vice-versa (il y a même des redondances de stockage)... idem, pour le chat qui est géré partiellement par RzxConnectionLister et partiellement par RzxRezal.

La classe RzxComputer a une importance réduite et la quasitotalité de ses données sont redondantes avec RzxItem. De plus certaines informations de RzxComputer sont stockées directement par RzxConfig, qui est elle-même à moitié implémentée par RzxProperty.

En résumé, la structure (déjà modularisée comparée à la version 1.2 dans laquelle RzxConnectionLister n'existait pas et était partie intégrante de RzxRezal) n'est pas facilement maintenable.

=== Interface de plug-ins ===

qRezix 1.6 est la première version à bénéficier d'une structure d'accueil de plug-in. Cette structure est rudimentaire et souffre du fait que qRezix n'est pas modulaire. En effet la classe RzxPlugIn est compilée à la fois dans le plug-in et dans qRezix, ce qui crée des problèmes dès que les deux versions diffèrent.

Pour éviter les problèmes, la version de la strucutre de plug-in est numéroté de façon très stricte, et le filtrage est fait au chargement du plug-in.

Ce défaut entraîne un grand nombre de complication. Les plug-ins n'ont absolument aucun accès direct aux données stockées par qRezix. Toutes les informations transitent donc par des fonction standardisées du plug-in, mais cette méthode de travail limite le nombre d'information pouvant être échangé. Il n'en reste pas moins que cette structure est tout à fait suffisante pour réaliser des plug-ins comme l'Xplo ou SmiliX (qui sont disponible sur la [[Subversion|SVN]] dans le reposoire qrezix-plugins).

Pour pouvoir faire un plug-in pour qRezix, il faut récupérer la dernière version de rzxplugin.h et rzxplugin.cpp dans la branche de release de qRezix correspondante à la version pour laquelle vous voulez faire le plugin. Il suffit alors de créer un projet dérivant de RzxPlugIn. La documentation de RzxPlugIn peut-être générée automatique à l'aide de [http://www.doxygen.org Doxygen] et peut-être trouvée [http://fruneau.eleves.polytechnique.fr/qrezix-1.6/classRzxPlugIn.html ici], de même pour la [http://fruneau.eleves.polytechnique.fr/xplo/ documentation du plug-in Xplo] qui permet d'avoir un bon exemple de plug-in complet.

Cette structure a totalement disparue avec qRezix 2.0 pour être remplacer par des modules plus souple et mieux conçus.

== Branche 2.0 ==

=== Objectif ===

Cette version de qRezix repose sur un double objectif :
* porter le code en Qt4.
* modulariser le programme.

==== Qt4 ====
Le premier point ne présente pas une difficulté énorme, mais a conduit à pas mal de réorganisation du code. En particulier, qRezix 2.0 bénéficie de la puissance du nouveau système Model/View de Qt4, ce qui a nécessiter de redévelopper la quasitotalité de l'interface principale.

La toute dernière version [[Subversion|SVN]] de qRezix utilise [[Qt]] version 4.1.0 minimum. qRezix 2.0 utilise des fonctions introduites dans Qt 4.1, et ne compilera pas avec Qt 4.0.

==== Modularité ====

La modularisation du programme est un point essentiel. Elle apporte un certain nombre d'évolution nécessaire à la survie de qRezix :
* restructuration du programme qui permet une meilleure maintenance
* possibilité de limiter qRezix à certaines fonctionnalités (utile pour l'utilisation chez des personnes qui n'ont pas besoin d'avoir le logiciel complet si par exemple ils n'utilisent jamais le chat).
* possibilité de travailler avec un plus grand nombre de personne sur le projet. Chacun pouvant en effet travailler sur un module
* possibilité de gérer plusieurs protocoles pour se connecter à plusieurs serveurs

=== Structure du programme ===

Le schéma suivant représente de manière simplifié la structure interne de qRezix 2.0.x :

[[Image:qrezix-2.0_structure.png]]

Bien que le nombre d'élément soit impressionnant, cette structure est beaucoup plus propre que celle de qRezix 1.6. Le schéma montre en effet en particulier que les éléments sont proprement séparé, les seuls dépendances entre les modules qu'il peut y avoir sont gérées par la bibliothèque principale.

Le RzxComputer a acquis un rôle beaucoup plus important, il gère désormais la totalité des informations concernant une machine et inclus les actions qu'il est envisageable d'effectuer (propriétés, chat, http, ftp...). Le chat est géré par les modules qui se déclarent comme supportant cette fonctionnalité, de même pour les propriétés.

La fenêtre de préférences (RzxProperty) génère dynamiquement la page de propriétés en fonction de ce que les modules installés désirent. Et tout est mis en oeuvre (au travers de classe abstraites regroupant tous les outils nécessaires) pour que chaque module puisse créer simplement ses propres classes de configuration.

Les modules peuvent être construit soit en built-in soit en plug-in. Aucun n'est nécessaire au fonctionnement du programme (enfin si on retire tous les protos réseau, programme perd beaucoup de son intérêt).

QRezix

2006-06-12T12:03:57Z

Fruneau : centre les screenshots

{{menu projets}}
qRezix est le principal client [[xNet]] encore maintenu. Il doit sa survie à sa qualité d'être le seul client développé qui soit multiplateforme tout en restant graphiquement potable. Il doit ces deux qualités à la bibliothèque [[Qt]].

== Historique ==

=== BR2000 ===

Le projet en lui-même est né avec un groupe de BRmen X2000 menés par Doudou qui étaient fans de Qt (qui à l'époque n'était pas terrible-terrible...). Ils ont travaillé à 3 ou 4 pour sortir la version 1.0 le 4 mars 2002, suivie de près par la version 1.1 le 6 avril. L'équipe de développement comportait entre autres Doudou, MadCoder et Trasfract (Sylvain Joyeux, Pierre Habouzit et Benoït Casoetto).

Le projet s'est principalement inspiré des clients qui existaient déjà à l'époque (Rezix en particulier, duquel qRezix a tiré son nom). Cette architecture simple est une fenêtre avec une liste de client chaque entrée indiquant le nom, la promo, les serveurs... Les favoris sont affichés en premier selon le choix de l'utilisateur.

=== BR2001 ===

Le BR2001 n'a pas énormément travaillé sur qRezix. Il y a eu la version 1.2, mais on n'a aucune trace de ce que JiBee a bien pu faire sur le projet. Ce qui est certain, c'est qu'après la vesion 1.2, il a porté qRezix en Qt3 et a travaillé sur l'internationalisation du projet. Le but d'origine n'était pas de rendre qRezix international, mais simplement de résoudre les problèmes d'encodage des caractères accentués. Le code source a donc totalement été traduit en anglais et une traduction française a été créée.

[[Image:qrezix-1.2.gif|center]]

A priori, il n'y a pas eu de release en Qt3... mais d'après [[User:Ey|Ey]] qui packageait le projet pour Windows, il y en aurait eu... Mais en tout cas à l'arrivée des 2003 c'était toujours la version 1.2 (en Qt2) qui était disponible... Le BR n'avait de plus pas de license pour Qt3 sous Windows.

=== BR2002 ===

Le projet était géré par Steak. La version 1.3 a été release le 1 mai 2004. Cette version n'était absolument par révolutionnaire mais apportait quelques améliorations dans la structure du code et des amélioration du comportement du programme.

Steak a ensuite travaillé sur la version 1.3.666 et en particulier sur l'authentification avec le serveur. Mais il a vite arrêter de travailler sur qRezix en raison du temps qu'il consacrait à l'étude du japonnais, et à différents problèmes occulaires. Cependant, le [[BR2002]] a réalisé une prépassation très avancée ce qui fait que dès le mois de juin, la relève était en place...

=== BR2002/BR2003 : le temps d'une prépassation ===

Le [[BR2003]] a donc commencé sont travail sur qRezix dès le mois de juin 2004.

La première chose a été de recompiler une version pour Windows, ce qui n'avait plus été fait depuis près d'un an. Ceci permettait donc d'envisager de futures release du programme pas uniquement sous Linux. Le travail s'est finalement concentré pendant les vacances d'été avec une amélioration importante de l'interface et de la structure interne (début de séparation de la gestion des connexions de l'affichage), la création d'une structure (pas terrible) de chargement de plug-ins, l'ajout d'icône pour rendre l'interface plus conviviale... La version a été tagguée tour à tour 1.3.666 puis 1.5.

Une autre innovation importante à été le passage du chat qui reposait sur un protocole en UDP vers un protocole TCP. Le but déclaré du BR2002 étant de rendre les communication fiables et sécurisées (on veut savoir si l'autre ne reçoit pas nos messages).

Toutes ces modifications associées au travail de Steak sur l'authentification et le travail de JiBee pour recoder un nouveau [[xNetServer|serveur xNet]], on conduit à la version 1.6 de qRezix qui est sorti le 14 octobre 2004 à la fois pour Windows, Linux et Mac OS X.

[[Image:qrezix-1.6.png|center]]

Face à qRezix 1.6.0 est apparu Rezix.NET qui se voulait innovant. Conséquence de ceci, on a travaillé à 2 avec Steak pour implémenter dans qRezix toutes les fonctionnalité des Rezix.NET. Ce qui a rapidement conduit à la sortie de qRezix 1.6.1 le 22 novembre 2004. C'était la dernière version sur laquelle ait travailler Steak. Rezix.NET (qui était codé en .NET par un membre dissidant du BR2002) n'a finalement pas fait long feu.

=== BR2003 ===

La suite a été plus calme. La préparation de qRezix 1.6.2 s'est faite tranquillement, l'objectif principal était de supprimer un maximum de bugs de cette future version. Les innovations n'ont pas été nombreuses, mais on pourra noter la completion du nick dans le chat avec tab et la recherche intelligente via clavier. Cette version a vu le retour de Ey parmi les développeurs. Elle a aussi été la seule version à bénéficier d'une sortie ayant été précédée de 2 release-candidates qui ont aidées à corriger plusieurs bugs supplémentaires. La version a finalement été sortie le 22 mars 2005.

Le problème de cette version est qu'elle a introduit un bug... enfin plutôt révélé un bug. Jusqu'à présent qRezix plantait en l'absence de réseau ce qui a été corrigé avec la 1.6.2. Mais ce que je n'avais pas remarqué à l'époque c'était qu'en l'absence de réseau qRezix raffraichissait la fenêtre toutes les secondes et en même temps changeait le thême d'icône. Conséquence directe de ce défaut, qRezix prenait 100% du processeur en l'absence de réseau, ce que j'ai eu la chance de constater lors de ma soutenance de modex... Il fallait donc sortir un version avant l'arrivée des 2004 pour éviter que ce bug ne pose trop de problème aux 2004 qui allaient passer leur soutenance de stage. C'est pour ça qu'est sortie la verson 1.6.3 le 1 mai 2005. Cette version innovait au passage une nouvelle organisation plus agréable des propriétés et peut-être globalement considérée comme stable. La version 1.6.4 sortie le 23 septembre apporte peu d'innovation si ce n'est la cache des propriétés, les icônes en 32bits et une meilleure intégration à Mac OS.

Suite à la sortie de Qt4, le port de qRezix vers cette nouvelle mouture de la bibliothèque de Trolltech a été l'occasion de grand remaniement du code. Ceci a abouti à la versin 2.0 de qRezix dont le principal atout est d'être modulaire. La version 2.0.0 est sortie le 6 février 2006, et a rapidement supplanté la version 1.6.x.

[[Image:qrezix-2.0.png|800px|center]]

<div style="border: 1px solid #6f8f9f; padding: .2em .5em .2em .5em; background-color: #EAF5FB">
Pour écrire cette partie, j'ai utilisé mes connaissances personnelles issues ainsi que les informations contenues dans le ChangeLog. Et j'espère bien que d'autres y jetteront un coup d'oeil pour compléter/corriger les parties inexactes.
</div>

== Développement ==

Cette partie a pour but de présenter brièvement l'état du projet à travers l'organisation du développement.

=== Outils nécessaires ===

* Le développement de qRezix se fait comme tous les projets du BR via un système de partage de projet : [[Subversion|SVN]]. Il est donc nécessaire d'installer un client [[Subversion|SVN]] pour travailler. Sous Linux et Mac OS, il y a des packages de SVN qui sont distribuer. Sous Windows, il est fortement conseillé d'utiliser [http://tortoisesvn.tigris.org TortoiseSVN]. Pour plus d'information sur SubVersion, merci de vous référer à la [[Subversion|page correspondante]].

* Il faut également installer [[Qt]], la version dépend de la branche de travail. Pour qRezix 1.6, il faut utiliser Qt3 (3.3.3 ou ultérieure) alors que pour qRezix 1.7, Qt4 (4.0.1 ou ultérieure). Pour obtenir Qt3 pour Windows, merci de demander à [[User:Fruneau|Fruneau]]. Pour Qt4, il faut faire attention sur certaine distribution de bien installer tous les modules nécessaires (au moins Core, GUI et Network) et les outils qui vont avec (designer, linguist, assistant).

* Pour générer la documentation il peut être intéressant d'installer également [http://www.doxygen.org Doxygen]. La plupart du temps l'utilisation de Doxygen est très simple : il suffit de l'appliquer au fichier Doxyfile qui se trouve à la racine du projet.
doxygen Doxyfile

=== Structure de la SVN ===

Pour ce qui est de l'utilisation de SVN, je vous laisse vous référer à la [[Subversion#Utilisation_de_svn|page correspondante]]. Cette partie à plutôt pour but d'expliquer comment utiliser la SVN pour travailler sur qRezix.

Tout d'abord, il est important de noter que qRezix utilise une structure tout ce qu'il y a de plus classique (avec trunk, branches et tags). Le trunk étant la branche principale du projet.

==== Travailler sur la branche principale ====

La branche principale du projet correspond à la version qui évolue actuellement. A l'heure actuelle c'est la 1.6.x. Cette branche change régulièrement et on peut y trouver les dernières innovations réalisée sur cette branche. Lorsqu'on s'approche d'une release de qRezix, il faut freezer la branche principale. Pour ceci, on sépare le développement de la version qui va sortir de celui de la branche principale.

Par exemple pour release qRezix 1.6.4, j'ai freezé la branche environ 1 semaine et demi avant la sortie via :
svn copy trunk branches/qrezix--release--1.6.4

Une fois les branches séparées, la branche de release ne doit plus subir que des corrections de bugs. En cas de besoin, on pourra sortir des pre-release (rc). Une fois qu'une version est considérée stable, on la tag, c'est à dire qu'on fait une photographie instantannée du projet :
svn copy branches/qrezix--release--1.6.4 tags/qrezix--1.6.4-rc1 # pour une préversion
svn copy branches/qrezix--release--1.6.4 tags/qrezix--1.6.4 # pour la version définitive

On peut même envisager alors des révisions sur la version actuelle qui serait des bugfixes de la branche de release intervenu après la sortie. Dans ce cas, on aurait
svn copy branches/qrezix--release--1.6.4 tags/qrezix--1.6.4-r1 # pour une révision de la version

Ceci peut paraître contraignant, mais c'est la base d'un projet mené correctement. Ca permet d'avoir un historique des branches et des versions, de pouvoir envisager de sortir des révisions de toutes les branches de release en cas de découverte d'une faille importante du programme et ça évite surtout d'avoir une version qui s'éternise... lorsqu'on décide de freezer une version, ceux qui veulent continuer à innover travaillent sur le trunk pendant que d'autres stabilise la version de release.

==== Branches de devel ====

A côté de la branche principale, il peut y avoir des branches de devel. Alors que la différence entre 2 releases issues d'une même branche sont le plus souvent mineures voire de la simple maintenance, la différence entre le trunk et la branches de devel est quelque chose de beaucoup plus important. La branche de devel apporte des innonvations importantes et devrait conduire à une nouvelle version majeure du programme.

La branche de devel Qt4 vient d'être passée en branche principale.

==== Numérotation des versions ====

Comme pour tout programme, qRezix a des versions numérotées de la forme X.Y.Z-T
* X est la version majeure, il ne change que lors de modification très importantes de la structure du programme.
* Y est la version mineure, il change lorsque le programme a subit des évolution plus importante qu'une simple maintenance.
* Z est la version de maintenance, il change lorsque le programme subit des bugfixes et l'implémentation de fonctionnalités mineures.
* T est le tag

L'utilisation du tag est particulières :
* ''svn'' pour une version de développement avant les releases ou pre-release.
* ''alpha'' pour une pré-version non encore formalisée d'une nouvelle version majeure ou mineure du programme (2.0.0-alpha1 ou 1.7.0-alpha2 mais pas 1.6.5-alpha1)
* ''beta'' pour une pré-version formalisée d'une nouvelle version majeure ou mineure du programme (2.0.0-beta1 ou 1.7.0-beta2 mais pas 1.6.5-beta1)
* ''rc'' pour une version candidate à la release. Elle sert uniquement à la recherche de derniers bugs (1.6.2-rc1)
* ''r'' pour une révision d'une version déjà sortie. Elle sert uniquement à corriger de graves anomalies de la version (1.6.4-r1)

De manière générale, la numérotation doit être effectuée comme suit :
# A la release de la version X.Y.Z, la branche principale passe ne X.Y.(Z+1)-svn
# Si le besoin s'en fait sentir, des versions alpha, puis bêta et enfin rc peuvent être sorties. Mais attention, une version alpha doit être suivie d'au moins une version bêta puis d'une rc.
# Lorsque la version est considérée stable, elle est détaguée, et la release est effectuée. On revient dès lors au point 1

=== Traductions ===

Les traductions (gentil fardeau offert par JiBee), sont générée relativement simplement par Qt. Pour ceci, il faut procéder dans l'ordre :
* Dans le code, mettre les chaîne à traduire soit dans des tr("mon texte") ou QT_TR_NOOP("mon texte"). Le deuxième cas étant pour les textes qui se trouvent dans les définitions statiques.
* Générer le fichier d'index à l'aide de lupdate sur le projet :
# Pour qRezix 1.6
lupdate qrezix.pro
# Pour qRezix 2.0
lupdate */*.pro
* Editer les fichiers .ts avec Qt Linguist, et enregistrer les modifications. Les fichiers .ts sont dans le répertoires ''translations''.
* Compiler les fichiers .ts à l'aide de lrelease ou de Qt Linguist.
cd translations
lrelease *.ts
* Commiter le tout...

=== Documentation ===

La documentation de qRezix est composée de cette page, de la doc de l'API qu'il est possible de générer grâce à Doxygen, ainsi que de tout ce que vous pourrez trouver sur [http://fruneau cette page]. Dans tous les cas, la meilleure doc restera toujours une personne qui connait bien le projet :)...

Dans l'état actuel des choses, la meilleure doc de qRezix, c'est [[User:Fruneau|moi]].

=== Compiler qRezix ===

La compilation de qRezix n'est pas forcément une opération triviale, et dépend fortement de l'OS sur lequel on travail. La plupart des informations nécessaires sont contenues dans le fichier INSTALL. Voici quelques suppléments qui pourront toutefois être utiles :

==== Windows ====

Sous Windows, à l'heure actuelle, on compile avec Visual C++ 7.1 ou supérieur (qRezix ne compile pas avec VC++ 6). A l'heure actuelle, VC++ ne permet pas de compiler les modules en tant que tels car il est incapable de charger les membres de classes dans les DLL. On est donc forcés de tout compiler en un bloc en passant l'option "RZX_ALL_BUILTIN" à la compilation.

Tout d'abord il faut ouvrir une nouvelle console Visual Studio (pour avoir les variables d'environnement correctement définies). Dans cette console :
qmake "DEFINES+=RZX_ALL_BUILTIN" qrezix.pro
nmake

Si vous compilez une version SVN de qRezix, vous pouvez exécuter SubWCRev.exe pour convertir les occurences de $WCREV$ en numéro de révision.

Le packaging se fait à l'aidre de [http://nsis.sourceforge.net/Main_Page NSIS] en compilant le script qui est dans le répertoire package/windows

==== Linux ====

Sous Linux, il suffit de procéder strictement comme indiqué dans le fichier INSTALL
qmake qrezix.pro # cet appel est nécessaire dès que la structure du programme est modifiée...
make
qmake qrezix.pro # ce deuxième appel n'est nécessaire qu'à la première compilation où lors de l'apparition de nouveaux fichiers à installer
sudo make install

Pour mettre à jour le numéro de révision il peut être utile de forcer la recompilation de certaines parties du core :
touch core/core.pro
touch core/rzxapplication.cpp
make

Le packaging dépend énormément de la distribution... mais consiste dans la plupart des cas à réaliser une installation dans un chroot, l'archiver et lui ajouter les informations de packages (dépendants de la distribution... rpm, deb...).

<div style="border: 1px solid #9f6f8f; padding: .2em .5em .2em .5em; background-color: #FBEAF5">
Pour packager il faut partir d'un export de la SVN et non pas d'un checkout... Sinon les répertoires .svn resteront présents et peuvent fortement allourdir le paquet ou induire qRezix en erreur dans certains cas.
</div>

==== MacOS X ====

Sous MacOS X, un script est prévu pour réaliser la compilation. Il gère un certain nombre de problèmes liés à MacOS X, et il est fortement déconseillé de ne pas l'utiliser. Donc, pour compiler et créer un bundle utilisable il suffit de lancer la commande :
./build-mac

Pour compiler sous MacOS X il est nécessaire d'avoir installer la SDK de Growl. Et une fois compilé, de mettre Growl-withInstaller.framework dans le bundle qRezix.app/Content/Frameworks, sans quoi qRezix refusera de se lancer.

Ce script peut prendre un certain nombre de paramètres :
* -v : mode verbeux (affiche la sortie de make, qmake...)
* -q : ne lance pas les qmake (si cette option est ajoutée, le numéro de révision ne sera pas mis à jour dans la fenêtre de préférence)
* -jx : option -j de make (attention, la compilation universal binaries utilise déjà les 2 processeurs des biprocs)
* ... : toutes les autres options sont ajoutées aux CXXFLAGS

Pour packager qRezix pour MacOS, il suffit d'exécuter un autre script qui récupère le bundle de build-mac, le nettoie, y ajoute Qt et règle les dépendances des bibliothèques.
cd package/macosx
./package

<div style="border: 1px solid #6f8f9f; padding: .2em .5em .2em .5em; background-color: #EAF5FB">
Pour ceux qui voudraient profiter de Xcode, qmake peut générer des projet Xcode à partir du fichier .pro en exécutant :
qmake -spec macx-pbuilder machin.pro
Mais ceci mérite des test approfondis et une attention accrue pour éviter de délaisser le fichier .pro nécessaire pour les autres plateformes une fois le projet généré.
</div>

=== Coding Rules ===

Il est important de respecter un certain nombre de règles lorsqu'on travail sur un projet collectif. De fait, tout développeur de qRezix est prié de se tenir aux recommandations qui suivent :

<table style="border: 1px solid #6f8f9f; width: 100%">
<tr style="padding: .2em .5em .2em .5em; background-color: #EAF5FB">
<th colspan="2">'''Nomenclature'''</th>
</tr>
<tr>
<td>Les noms des classes sont préfixés par Rzx</td>
<td rowspan="5"><pre>
class RzxApplication
{
bool valid;

public:
bool isValid() const;
};
</pre></td>
</tr>
<tr style="background-color: #FAF5FF">
<td>Les noms des fonctions commencent par une minuscule</td>
</tr>
<tr>
<td>L'utilisation d'underscore est à éviter. On préférera utiliser des nom dont les séparations sont des majuscules</td>
</tr>
<tr style="background-color: #FAF5FF">
<td>La langue à utiliser de préférence est '''l'anglais'''</td>
</tr>
<tr>
<td>Les noms des fonctions/methodes doivent être cohérents avec les APIs Qt et qRezix, on évitera par exemple les getMyVar() en privilégiant myVar().</td>
</tr>
<tr style="padding: .2em .5em .2em .5em; background-color: #EAF5FB">
<th colspan="2">'''Accolades'''</th>
</tr>
<tr>
<td>Les accolades ouvrantes comme fermantes sont placées après un retour à la ligne</td>
<td rowspan="3"><pre>
if(a == b || c != d)
{
a = b + 1;
do(truc);
}

void RzxMyFunction::do() const
{
<bloc>;
}

class RzxMyClass
{
};
</pre></td>
</tr>
<tr style="background-color: #FAF5FF">
<td>Les opérateurs sont entourés d'espaces</td>
</tr>
<tr>
<td>Les parenthèse sont collées à l'opération associée (nom de fonction, contrôle de flux...)</td>
</tr>
<tr style="padding: .2em .5em .2em .5em; background-color: #EAF5FB">
<th colspan="2">'''Indentation'''</th>
</tr>
<tr>
<td>Les indentation sont réalisées à l'aide de ''tabulation''</td>
<td rowspan="4"><pre>
class RzxMyClass
{
<firstbloc>

public:
<secondbloc>

protected:
<thirdbloc>
};

switch(value)
{
case 1:
<bloc1>;

case 2:
<bloc2>;

case 3:
<bloc3>;
}

#if CASE1
# define MACHIN
#endif
</pre></td>
</tr>
<tr style="background-color: #FAF5FF">
<td>Les mots clés comme public: ou case: sont indentés et entraînent une indentation supplémentaire jusqu'au prochain mot clé</td>
</tr>
<tr>
<td>Ne pas oublier d'indenter également le préprocesseur</td>
</tr>
<tr style="background-color: #FAF5FF">
<td>Les fichiers doivent finir par une ligne vide</td>
</tr>
<tr style="padding: .2em .5em .2em .5em; background-color: #EAF5FB">
<th colspan="2">'''Commentaires et documentation'''</th>
</tr>
<tr>
<td>Les objets doivent être documentées à l'aide des syntaxe de Doxygen</td>
<td rowspan="3"><pre>
///Ceci est une description rapide
/** Ceci est une description avancée de la fonction
*/
void myFunction()
{
if(machin) // Le cas machin peut poser problème, on le traite donc à part
{
}

// TODO: implémenter le reste de la fonction

}
</pre></td>
</tr>
<tr style="background-color: #FAF5FF">
<td>A l'exception de la documentation des fonctions, on préférera les commentaires de la forme // Mon commentaire en français</td>
</tr>
<tr>
<td>// TODO: peut également être utilisé pour spécifier des implémentations à réaliser</td>
</tr>
</table>

== Branche 1.6 ==

=== Structure du programme ===

La structure interne du programme peut-être résumée au schéma suivant :

[[Image:qrezix-1.6_structure.png]]

Ce schéma n'est pas exhaustif, mais met en évidence les différentes imbrications des éléments. Toutes les cadres qui se chevauchent (et le cas échéant se contiennet) représente des classes qui sont imbriquées l'une à l'autre. Ansi la classe QRezix qui gère la totalité du programme est totalement dépendante de la quasitotalité des autres classes, la classe RzxConnectionLister dont le but est de lister les personnes est complètement dépendante de RzxRezal et vice-versa (il y a même des redondances de stockage)... idem, pour le chat qui est géré partiellement par RzxConnectionLister et partiellement par RzxRezal.

La classe RzxComputer a une importance réduite et la quasitotalité de ses données sont redondantes avec RzxItem. De plus certaines informations de RzxComputer sont stockées directement par RzxConfig, qui est elle-même à moitié implémentée par RzxProperty.

En résumé, la structure (déjà modularisée comparée à la version 1.2 dans laquelle RzxConnectionLister n'existait pas et était partie intégrante de RzxRezal) n'est pas facilement maintenable.

=== Interface de plug-ins ===

qRezix 1.6 est la première version à bénéficier d'une structure d'accueil de plug-in. Cette structure est rudimentaire et souffre du fait que qRezix n'est pas modulaire. En effet la classe RzxPlugIn est compilée à la fois dans le plug-in et dans qRezix, ce qui crée des problèmes dès que les deux versions diffèrent.

Pour éviter les problèmes, la version de la strucutre de plug-in est numéroté de façon très stricte, et le filtrage est fait au chargement du plug-in.

Ce défaut entraîne un grand nombre de complication. Les plug-ins n'ont absolument aucun accès direct aux données stockées par qRezix. Toutes les informations transitent donc par des fonction standardisées du plug-in, mais cette méthode de travail limite le nombre d'information pouvant être échangé. Il n'en reste pas moins que cette structure est tout à fait suffisante pour réaliser des plug-ins comme l'Xplo ou SmiliX (qui sont disponible sur la [[Subversion|SVN]] dans le reposoire qrezix-plugins).

Pour pouvoir faire un plug-in pour qRezix, il faut récupérer la dernière version de rzxplugin.h et rzxplugin.cpp dans la branche de release de qRezix correspondante à la version pour laquelle vous voulez faire le plugin. Il suffit alors de créer un projet dérivant de RzxPlugIn. La documentation de RzxPlugIn peut-être générée automatique à l'aide de [http://www.doxygen.org Doxygen] et peut-être trouvée [http://fruneau.eleves.polytechnique.fr/qrezix-1.6/classRzxPlugIn.html ici], de même pour la [http://fruneau.eleves.polytechnique.fr/xplo/ documentation du plug-in Xplo] qui permet d'avoir un bon exemple de plug-in complet.

Cette structure a totalement disparue avec qRezix 2.0 pour être remplacer par des modules plus souple et mieux conçus.

== Branche 2.0 ==

=== Objectif ===

Cette version de qRezix repose sur un double objectif :
* porter le code en Qt4.
* modulariser le programme.

==== Qt4 ====
Le premier point ne présente pas une difficulté énorme, mais a conduit à pas mal de réorganisation du code. En particulier, qRezix 2.0 bénéficie de la puissance du nouveau système Model/View de Qt4, ce qui a nécessiter de redévelopper la quasitotalité de l'interface principale.

La toute dernière version [[Subversion|SVN]] de qRezix utilise [[Qt]] version 4.1.0 minimum. qRezix 2.0 utilise des fonctions introduites dans Qt 4.1, et ne compilera pas avec Qt 4.0.

==== Modularité ====

La modularisation du programme est un point essentiel. Elle apporte un certain nombre d'évolution nécessaire à la survie de qRezix :
* restructuration du programme qui permet une meilleure maintenance
* possibilité de limiter qRezix à certaines fonctionnalités (utile pour l'utilisation chez des personnes qui n'ont pas besoin d'avoir le logiciel complet si par exemple ils n'utilisent jamais le chat).
* possibilité de travailler avec un plus grand nombre de personne sur le projet. Chacun pouvant en effet travailler sur un module
* possibilité de gérer plusieurs protocoles pour se connecter à plusieurs serveurs

=== Structure du programme ===

Le schéma suivant représente de manière simplifié la structure interne de qRezix 2.0.x :

[[Image:qrezix-1.7_structure.png]]

Bien que le nombre d'élément soit impressionnant, cette structure est beaucoup plus propre que celle de qRezix 1.6. Le schéma montre en effet en particulier que les éléments sont proprement séparé, les seuls dépendances entre les modules qu'il peut y avoir sont gérées par la bibliothèque principale.

Le RzxComputer a acquis un rôle beaucoup plus important, il gère désormais la totalité des informations concernant une machine et inclus les actions qu'il est envisageable d'effectuer (propriétés, chat, http, ftp...). Le chat est géré par les modules qui se déclarent comme supportant cette fonctionnalité, de même pour les propriétés.

La fenêtre de préférences (RzxProperty) génère dynamiquement la page de propriétés en fonction de ce que les modules installés désirent. Et tout est mis en oeuvre (au travers de classe abstraites regroupant tous les outils nécessaires) pour que chaque module puisse créer simplement ses propres classes de configuration.

Les modules peuvent être construit soit en built-in soit en plug-in. Aucun n'est nécessaire au fonctionnement du programme (enfin si on retire tous les protos réseau, programme perd beaucoup de son intérêt).

QRezix

2006-06-12T12:03:06Z

Fruneau : /* BR2003 */ Resize de l'image de qRezix 2.0.0

{{menu projets}}
qRezix est le principal client [[xNet]] encore maintenu. Il doit sa survie à sa qualité d'être le seul client développé qui soit multiplateforme tout en restant graphiquement potable. Il doit ces deux qualités à la bibliothèque [[Qt]].

== Historique ==

=== BR2000 ===

Le projet en lui-même est né avec un groupe de BRmen X2000 menés par Doudou qui étaient fans de Qt (qui à l'époque n'était pas terrible-terrible...). Ils ont travaillé à 3 ou 4 pour sortir la version 1.0 le 4 mars 2002, suivie de près par la version 1.1 le 6 avril. L'équipe de développement comportait entre autres Doudou, MadCoder et Trasfract (Sylvain Joyeux, Pierre Habouzit et Benoït Casoetto).

Le projet s'est principalement inspiré des clients qui existaient déjà à l'époque (Rezix en particulier, duquel qRezix a tiré son nom). Cette architecture simple est une fenêtre avec une liste de client chaque entrée indiquant le nom, la promo, les serveurs... Les favoris sont affichés en premier selon le choix de l'utilisateur.

=== BR2001 ===

Le BR2001 n'a pas énormément travaillé sur qRezix. Il y a eu la version 1.2, mais on n'a aucune trace de ce que JiBee a bien pu faire sur le projet. Ce qui est certain, c'est qu'après la vesion 1.2, il a porté qRezix en Qt3 et a travaillé sur l'internationalisation du projet. Le but d'origine n'était pas de rendre qRezix international, mais simplement de résoudre les problèmes d'encodage des caractères accentués. Le code source a donc totalement été traduit en anglais et une traduction française a été créée.

[[Image:qrezix-1.2.gif]]

A priori, il n'y a pas eu de release en Qt3... mais d'après [[User:Ey|Ey]] qui packageait le projet pour Windows, il y en aurait eu... Mais en tout cas à l'arrivée des 2003 c'était toujours la version 1.2 (en Qt2) qui était disponible... Le BR n'avait de plus pas de license pour Qt3 sous Windows.

=== BR2002 ===

Le projet était géré par Steak. La version 1.3 a été release le 1 mai 2004. Cette version n'était absolument par révolutionnaire mais apportait quelques améliorations dans la structure du code et des amélioration du comportement du programme.

Steak a ensuite travaillé sur la version 1.3.666 et en particulier sur l'authentification avec le serveur. Mais il a vite arrêter de travailler sur qRezix en raison du temps qu'il consacrait à l'étude du japonnais, et à différents problèmes occulaires. Cependant, le [[BR2002]] a réalisé une prépassation très avancée ce qui fait que dès le mois de juin, la relève était en place...

=== BR2002/BR2003 : le temps d'une prépassation ===

Le [[BR2003]] a donc commencé sont travail sur qRezix dès le mois de juin 2004.

La première chose a été de recompiler une version pour Windows, ce qui n'avait plus été fait depuis près d'un an. Ceci permettait donc d'envisager de futures release du programme pas uniquement sous Linux. Le travail s'est finalement concentré pendant les vacances d'été avec une amélioration importante de l'interface et de la structure interne (début de séparation de la gestion des connexions de l'affichage), la création d'une structure (pas terrible) de chargement de plug-ins, l'ajout d'icône pour rendre l'interface plus conviviale... La version a été tagguée tour à tour 1.3.666 puis 1.5.

Une autre innovation importante à été le passage du chat qui reposait sur un protocole en UDP vers un protocole TCP. Le but déclaré du BR2002 étant de rendre les communication fiables et sécurisées (on veut savoir si l'autre ne reçoit pas nos messages).

Toutes ces modifications associées au travail de Steak sur l'authentification et le travail de JiBee pour recoder un nouveau [[xNetServer|serveur xNet]], on conduit à la version 1.6 de qRezix qui est sorti le 14 octobre 2004 à la fois pour Windows, Linux et Mac OS X.

[[Image:qrezix-1.6.png]]

Face à qRezix 1.6.0 est apparu Rezix.NET qui se voulait innovant. Conséquence de ceci, on a travaillé à 2 avec Steak pour implémenter dans qRezix toutes les fonctionnalité des Rezix.NET. Ce qui a rapidement conduit à la sortie de qRezix 1.6.1 le 22 novembre 2004. C'était la dernière version sur laquelle ait travailler Steak. Rezix.NET (qui était codé en .NET par un membre dissidant du BR2002) n'a finalement pas fait long feu.

=== BR2003 ===

La suite a été plus calme. La préparation de qRezix 1.6.2 s'est faite tranquillement, l'objectif principal était de supprimer un maximum de bugs de cette future version. Les innovations n'ont pas été nombreuses, mais on pourra noter la completion du nick dans le chat avec tab et la recherche intelligente via clavier. Cette version a vu le retour de Ey parmi les développeurs. Elle a aussi été la seule version à bénéficier d'une sortie ayant été précédée de 2 release-candidates qui ont aidées à corriger plusieurs bugs supplémentaires. La version a finalement été sortie le 22 mars 2005.

Le problème de cette version est qu'elle a introduit un bug... enfin plutôt révélé un bug. Jusqu'à présent qRezix plantait en l'absence de réseau ce qui a été corrigé avec la 1.6.2. Mais ce que je n'avais pas remarqué à l'époque c'était qu'en l'absence de réseau qRezix raffraichissait la fenêtre toutes les secondes et en même temps changeait le thême d'icône. Conséquence directe de ce défaut, qRezix prenait 100% du processeur en l'absence de réseau, ce que j'ai eu la chance de constater lors de ma soutenance de modex... Il fallait donc sortir un version avant l'arrivée des 2004 pour éviter que ce bug ne pose trop de problème aux 2004 qui allaient passer leur soutenance de stage. C'est pour ça qu'est sortie la verson 1.6.3 le 1 mai 2005. Cette version innovait au passage une nouvelle organisation plus agréable des propriétés et peut-être globalement considérée comme stable. La version 1.6.4 sortie le 23 septembre apporte peu d'innovation si ce n'est la cache des propriétés, les icônes en 32bits et une meilleure intégration à Mac OS.

Suite à la sortie de Qt4, le port de qRezix vers cette nouvelle mouture de la bibliothèque de Trolltech a été l'occasion de grand remaniement du code. Ceci a abouti à la versin 2.0 de qRezix dont le principal atout est d'être modulaire. La version 2.0.0 est sortie le 6 février 2006, et a rapidement supplanté la version 1.6.x.

[[Image:qrezix-2.0.png|800px|center]]

<div style="border: 1px solid #6f8f9f; padding: .2em .5em .2em .5em; background-color: #EAF5FB">
Pour écrire cette partie, j'ai utilisé mes connaissances personnelles issues ainsi que les informations contenues dans le ChangeLog. Et j'espère bien que d'autres y jetteront un coup d'oeil pour compléter/corriger les parties inexactes.
</div>

== Développement ==

Cette partie a pour but de présenter brièvement l'état du projet à travers l'organisation du développement.

=== Outils nécessaires ===

* Le développement de qRezix se fait comme tous les projets du BR via un système de partage de projet : [[Subversion|SVN]]. Il est donc nécessaire d'installer un client [[Subversion|SVN]] pour travailler. Sous Linux et Mac OS, il y a des packages de SVN qui sont distribuer. Sous Windows, il est fortement conseillé d'utiliser [http://tortoisesvn.tigris.org TortoiseSVN]. Pour plus d'information sur SubVersion, merci de vous référer à la [[Subversion|page correspondante]].

* Il faut également installer [[Qt]], la version dépend de la branche de travail. Pour qRezix 1.6, il faut utiliser Qt3 (3.3.3 ou ultérieure) alors que pour qRezix 1.7, Qt4 (4.0.1 ou ultérieure). Pour obtenir Qt3 pour Windows, merci de demander à [[User:Fruneau|Fruneau]]. Pour Qt4, il faut faire attention sur certaine distribution de bien installer tous les modules nécessaires (au moins Core, GUI et Network) et les outils qui vont avec (designer, linguist, assistant).

* Pour générer la documentation il peut être intéressant d'installer également [http://www.doxygen.org Doxygen]. La plupart du temps l'utilisation de Doxygen est très simple : il suffit de l'appliquer au fichier Doxyfile qui se trouve à la racine du projet.
doxygen Doxyfile

=== Structure de la SVN ===

Pour ce qui est de l'utilisation de SVN, je vous laisse vous référer à la [[Subversion#Utilisation_de_svn|page correspondante]]. Cette partie à plutôt pour but d'expliquer comment utiliser la SVN pour travailler sur qRezix.

Tout d'abord, il est important de noter que qRezix utilise une structure tout ce qu'il y a de plus classique (avec trunk, branches et tags). Le trunk étant la branche principale du projet.

==== Travailler sur la branche principale ====

La branche principale du projet correspond à la version qui évolue actuellement. A l'heure actuelle c'est la 1.6.x. Cette branche change régulièrement et on peut y trouver les dernières innovations réalisée sur cette branche. Lorsqu'on s'approche d'une release de qRezix, il faut freezer la branche principale. Pour ceci, on sépare le développement de la version qui va sortir de celui de la branche principale.

Par exemple pour release qRezix 1.6.4, j'ai freezé la branche environ 1 semaine et demi avant la sortie via :
svn copy trunk branches/qrezix--release--1.6.4

Une fois les branches séparées, la branche de release ne doit plus subir que des corrections de bugs. En cas de besoin, on pourra sortir des pre-release (rc). Une fois qu'une version est considérée stable, on la tag, c'est à dire qu'on fait une photographie instantannée du projet :
svn copy branches/qrezix--release--1.6.4 tags/qrezix--1.6.4-rc1 # pour une préversion
svn copy branches/qrezix--release--1.6.4 tags/qrezix--1.6.4 # pour la version définitive

On peut même envisager alors des révisions sur la version actuelle qui serait des bugfixes de la branche de release intervenu après la sortie. Dans ce cas, on aurait
svn copy branches/qrezix--release--1.6.4 tags/qrezix--1.6.4-r1 # pour une révision de la version

Ceci peut paraître contraignant, mais c'est la base d'un projet mené correctement. Ca permet d'avoir un historique des branches et des versions, de pouvoir envisager de sortir des révisions de toutes les branches de release en cas de découverte d'une faille importante du programme et ça évite surtout d'avoir une version qui s'éternise... lorsqu'on décide de freezer une version, ceux qui veulent continuer à innover travaillent sur le trunk pendant que d'autres stabilise la version de release.

==== Branches de devel ====

A côté de la branche principale, il peut y avoir des branches de devel. Alors que la différence entre 2 releases issues d'une même branche sont le plus souvent mineures voire de la simple maintenance, la différence entre le trunk et la branches de devel est quelque chose de beaucoup plus important. La branche de devel apporte des innonvations importantes et devrait conduire à une nouvelle version majeure du programme.

La branche de devel Qt4 vient d'être passée en branche principale.

==== Numérotation des versions ====

Comme pour tout programme, qRezix a des versions numérotées de la forme X.Y.Z-T
* X est la version majeure, il ne change que lors de modification très importantes de la structure du programme.
* Y est la version mineure, il change lorsque le programme a subit des évolution plus importante qu'une simple maintenance.
* Z est la version de maintenance, il change lorsque le programme subit des bugfixes et l'implémentation de fonctionnalités mineures.
* T est le tag

L'utilisation du tag est particulières :
* ''svn'' pour une version de développement avant les releases ou pre-release.
* ''alpha'' pour une pré-version non encore formalisée d'une nouvelle version majeure ou mineure du programme (2.0.0-alpha1 ou 1.7.0-alpha2 mais pas 1.6.5-alpha1)
* ''beta'' pour une pré-version formalisée d'une nouvelle version majeure ou mineure du programme (2.0.0-beta1 ou 1.7.0-beta2 mais pas 1.6.5-beta1)
* ''rc'' pour une version candidate à la release. Elle sert uniquement à la recherche de derniers bugs (1.6.2-rc1)
* ''r'' pour une révision d'une version déjà sortie. Elle sert uniquement à corriger de graves anomalies de la version (1.6.4-r1)

De manière générale, la numérotation doit être effectuée comme suit :
# A la release de la version X.Y.Z, la branche principale passe ne X.Y.(Z+1)-svn
# Si le besoin s'en fait sentir, des versions alpha, puis bêta et enfin rc peuvent être sorties. Mais attention, une version alpha doit être suivie d'au moins une version bêta puis d'une rc.
# Lorsque la version est considérée stable, elle est détaguée, et la release est effectuée. On revient dès lors au point 1

=== Traductions ===

Les traductions (gentil fardeau offert par JiBee), sont générée relativement simplement par Qt. Pour ceci, il faut procéder dans l'ordre :
* Dans le code, mettre les chaîne à traduire soit dans des tr("mon texte") ou QT_TR_NOOP("mon texte"). Le deuxième cas étant pour les textes qui se trouvent dans les définitions statiques.
* Générer le fichier d'index à l'aide de lupdate sur le projet :
# Pour qRezix 1.6
lupdate qrezix.pro
# Pour qRezix 2.0
lupdate */*.pro
* Editer les fichiers .ts avec Qt Linguist, et enregistrer les modifications. Les fichiers .ts sont dans le répertoires ''translations''.
* Compiler les fichiers .ts à l'aide de lrelease ou de Qt Linguist.
cd translations
lrelease *.ts
* Commiter le tout...

=== Documentation ===

La documentation de qRezix est composée de cette page, de la doc de l'API qu'il est possible de générer grâce à Doxygen, ainsi que de tout ce que vous pourrez trouver sur [http://fruneau cette page]. Dans tous les cas, la meilleure doc restera toujours une personne qui connait bien le projet :)...

Dans l'état actuel des choses, la meilleure doc de qRezix, c'est [[User:Fruneau|moi]].

=== Compiler qRezix ===

La compilation de qRezix n'est pas forcément une opération triviale, et dépend fortement de l'OS sur lequel on travail. La plupart des informations nécessaires sont contenues dans le fichier INSTALL. Voici quelques suppléments qui pourront toutefois être utiles :

==== Windows ====

Sous Windows, à l'heure actuelle, on compile avec Visual C++ 7.1 ou supérieur (qRezix ne compile pas avec VC++ 6). A l'heure actuelle, VC++ ne permet pas de compiler les modules en tant que tels car il est incapable de charger les membres de classes dans les DLL. On est donc forcés de tout compiler en un bloc en passant l'option "RZX_ALL_BUILTIN" à la compilation.

Tout d'abord il faut ouvrir une nouvelle console Visual Studio (pour avoir les variables d'environnement correctement définies). Dans cette console :
qmake "DEFINES+=RZX_ALL_BUILTIN" qrezix.pro
nmake

Si vous compilez une version SVN de qRezix, vous pouvez exécuter SubWCRev.exe pour convertir les occurences de $WCREV$ en numéro de révision.

Le packaging se fait à l'aidre de [http://nsis.sourceforge.net/Main_Page NSIS] en compilant le script qui est dans le répertoire package/windows

==== Linux ====

Sous Linux, il suffit de procéder strictement comme indiqué dans le fichier INSTALL
qmake qrezix.pro # cet appel est nécessaire dès que la structure du programme est modifiée...
make
qmake qrezix.pro # ce deuxième appel n'est nécessaire qu'à la première compilation où lors de l'apparition de nouveaux fichiers à installer
sudo make install

Pour mettre à jour le numéro de révision il peut être utile de forcer la recompilation de certaines parties du core :
touch core/core.pro
touch core/rzxapplication.cpp
make

Le packaging dépend énormément de la distribution... mais consiste dans la plupart des cas à réaliser une installation dans un chroot, l'archiver et lui ajouter les informations de packages (dépendants de la distribution... rpm, deb...).

<div style="border: 1px solid #9f6f8f; padding: .2em .5em .2em .5em; background-color: #FBEAF5">
Pour packager il faut partir d'un export de la SVN et non pas d'un checkout... Sinon les répertoires .svn resteront présents et peuvent fortement allourdir le paquet ou induire qRezix en erreur dans certains cas.
</div>

==== MacOS X ====

Sous MacOS X, un script est prévu pour réaliser la compilation. Il gère un certain nombre de problèmes liés à MacOS X, et il est fortement déconseillé de ne pas l'utiliser. Donc, pour compiler et créer un bundle utilisable il suffit de lancer la commande :
./build-mac

Pour compiler sous MacOS X il est nécessaire d'avoir installer la SDK de Growl. Et une fois compilé, de mettre Growl-withInstaller.framework dans le bundle qRezix.app/Content/Frameworks, sans quoi qRezix refusera de se lancer.

Ce script peut prendre un certain nombre de paramètres :
* -v : mode verbeux (affiche la sortie de make, qmake...)
* -q : ne lance pas les qmake (si cette option est ajoutée, le numéro de révision ne sera pas mis à jour dans la fenêtre de préférence)
* -jx : option -j de make (attention, la compilation universal binaries utilise déjà les 2 processeurs des biprocs)
* ... : toutes les autres options sont ajoutées aux CXXFLAGS

Pour packager qRezix pour MacOS, il suffit d'exécuter un autre script qui récupère le bundle de build-mac, le nettoie, y ajoute Qt et règle les dépendances des bibliothèques.
cd package/macosx
./package

<div style="border: 1px solid #6f8f9f; padding: .2em .5em .2em .5em; background-color: #EAF5FB">
Pour ceux qui voudraient profiter de Xcode, qmake peut générer des projet Xcode à partir du fichier .pro en exécutant :
qmake -spec macx-pbuilder machin.pro
Mais ceci mérite des test approfondis et une attention accrue pour éviter de délaisser le fichier .pro nécessaire pour les autres plateformes une fois le projet généré.
</div>

=== Coding Rules ===

Il est important de respecter un certain nombre de règles lorsqu'on travail sur un projet collectif. De fait, tout développeur de qRezix est prié de se tenir aux recommandations qui suivent :

<table style="border: 1px solid #6f8f9f; width: 100%">
<tr style="padding: .2em .5em .2em .5em; background-color: #EAF5FB">
<th colspan="2">'''Nomenclature'''</th>
</tr>
<tr>
<td>Les noms des classes sont préfixés par Rzx</td>
<td rowspan="5"><pre>
class RzxApplication
{
bool valid;

public:
bool isValid() const;
};
</pre></td>
</tr>
<tr style="background-color: #FAF5FF">
<td>Les noms des fonctions commencent par une minuscule</td>
</tr>
<tr>
<td>L'utilisation d'underscore est à éviter. On préférera utiliser des nom dont les séparations sont des majuscules</td>
</tr>
<tr style="background-color: #FAF5FF">
<td>La langue à utiliser de préférence est '''l'anglais'''</td>
</tr>
<tr>
<td>Les noms des fonctions/methodes doivent être cohérents avec les APIs Qt et qRezix, on évitera par exemple les getMyVar() en privilégiant myVar().</td>
</tr>
<tr style="padding: .2em .5em .2em .5em; background-color: #EAF5FB">
<th colspan="2">'''Accolades'''</th>
</tr>
<tr>
<td>Les accolades ouvrantes comme fermantes sont placées après un retour à la ligne</td>
<td rowspan="3"><pre>
if(a == b || c != d)
{
a = b + 1;
do(truc);
}

void RzxMyFunction::do() const
{
<bloc>;
}

class RzxMyClass
{
};
</pre></td>
</tr>
<tr style="background-color: #FAF5FF">
<td>Les opérateurs sont entourés d'espaces</td>
</tr>
<tr>
<td>Les parenthèse sont collées à l'opération associée (nom de fonction, contrôle de flux...)</td>
</tr>
<tr style="padding: .2em .5em .2em .5em; background-color: #EAF5FB">
<th colspan="2">'''Indentation'''</th>
</tr>
<tr>
<td>Les indentation sont réalisées à l'aide de ''tabulation''</td>
<td rowspan="4"><pre>
class RzxMyClass
{
<firstbloc>

public:
<secondbloc>

protected:
<thirdbloc>
};

switch(value)
{
case 1:
<bloc1>;

case 2:
<bloc2>;

case 3:
<bloc3>;
}

#if CASE1
# define MACHIN
#endif
</pre></td>
</tr>
<tr style="background-color: #FAF5FF">
<td>Les mots clés comme public: ou case: sont indentés et entraînent une indentation supplémentaire jusqu'au prochain mot clé</td>
</tr>
<tr>
<td>Ne pas oublier d'indenter également le préprocesseur</td>
</tr>
<tr style="background-color: #FAF5FF">
<td>Les fichiers doivent finir par une ligne vide</td>
</tr>
<tr style="padding: .2em .5em .2em .5em; background-color: #EAF5FB">
<th colspan="2">'''Commentaires et documentation'''</th>
</tr>
<tr>
<td>Les objets doivent être documentées à l'aide des syntaxe de Doxygen</td>
<td rowspan="3"><pre>
///Ceci est une description rapide
/** Ceci est une description avancée de la fonction
*/
void myFunction()
{
if(machin) // Le cas machin peut poser problème, on le traite donc à part
{
}

// TODO: implémenter le reste de la fonction

}
</pre></td>
</tr>
<tr style="background-color: #FAF5FF">
<td>A l'exception de la documentation des fonctions, on préférera les commentaires de la forme // Mon commentaire en français</td>
</tr>
<tr>
<td>// TODO: peut également être utilisé pour spécifier des implémentations à réaliser</td>
</tr>
</table>

== Branche 1.6 ==

=== Structure du programme ===

La structure interne du programme peut-être résumée au schéma suivant :

[[Image:qrezix-1.6_structure.png]]

Ce schéma n'est pas exhaustif, mais met en évidence les différentes imbrications des éléments. Toutes les cadres qui se chevauchent (et le cas échéant se contiennet) représente des classes qui sont imbriquées l'une à l'autre. Ansi la classe QRezix qui gère la totalité du programme est totalement dépendante de la quasitotalité des autres classes, la classe RzxConnectionLister dont le but est de lister les personnes est complètement dépendante de RzxRezal et vice-versa (il y a même des redondances de stockage)... idem, pour le chat qui est géré partiellement par RzxConnectionLister et partiellement par RzxRezal.

La classe RzxComputer a une importance réduite et la quasitotalité de ses données sont redondantes avec RzxItem. De plus certaines informations de RzxComputer sont stockées directement par RzxConfig, qui est elle-même à moitié implémentée par RzxProperty.

En résumé, la structure (déjà modularisée comparée à la version 1.2 dans laquelle RzxConnectionLister n'existait pas et était partie intégrante de RzxRezal) n'est pas facilement maintenable.

=== Interface de plug-ins ===

qRezix 1.6 est la première version à bénéficier d'une structure d'accueil de plug-in. Cette structure est rudimentaire et souffre du fait que qRezix n'est pas modulaire. En effet la classe RzxPlugIn est compilée à la fois dans le plug-in et dans qRezix, ce qui crée des problèmes dès que les deux versions diffèrent.

Pour éviter les problèmes, la version de la strucutre de plug-in est numéroté de façon très stricte, et le filtrage est fait au chargement du plug-in.

Ce défaut entraîne un grand nombre de complication. Les plug-ins n'ont absolument aucun accès direct aux données stockées par qRezix. Toutes les informations transitent donc par des fonction standardisées du plug-in, mais cette méthode de travail limite le nombre d'information pouvant être échangé. Il n'en reste pas moins que cette structure est tout à fait suffisante pour réaliser des plug-ins comme l'Xplo ou SmiliX (qui sont disponible sur la [[Subversion|SVN]] dans le reposoire qrezix-plugins).

Pour pouvoir faire un plug-in pour qRezix, il faut récupérer la dernière version de rzxplugin.h et rzxplugin.cpp dans la branche de release de qRezix correspondante à la version pour laquelle vous voulez faire le plugin. Il suffit alors de créer un projet dérivant de RzxPlugIn. La documentation de RzxPlugIn peut-être générée automatique à l'aide de [http://www.doxygen.org Doxygen] et peut-être trouvée [http://fruneau.eleves.polytechnique.fr/qrezix-1.6/classRzxPlugIn.html ici], de même pour la [http://fruneau.eleves.polytechnique.fr/xplo/ documentation du plug-in Xplo] qui permet d'avoir un bon exemple de plug-in complet.

Cette structure a totalement disparue avec qRezix 2.0 pour être remplacer par des modules plus souple et mieux conçus.

== Branche 2.0 ==

=== Objectif ===

Cette version de qRezix repose sur un double objectif :
* porter le code en Qt4.
* modulariser le programme.

==== Qt4 ====
Le premier point ne présente pas une difficulté énorme, mais a conduit à pas mal de réorganisation du code. En particulier, qRezix 2.0 bénéficie de la puissance du nouveau système Model/View de Qt4, ce qui a nécessiter de redévelopper la quasitotalité de l'interface principale.

La toute dernière version [[Subversion|SVN]] de qRezix utilise [[Qt]] version 4.1.0 minimum. qRezix 2.0 utilise des fonctions introduites dans Qt 4.1, et ne compilera pas avec Qt 4.0.

==== Modularité ====

La modularisation du programme est un point essentiel. Elle apporte un certain nombre d'évolution nécessaire à la survie de qRezix :
* restructuration du programme qui permet une meilleure maintenance
* possibilité de limiter qRezix à certaines fonctionnalités (utile pour l'utilisation chez des personnes qui n'ont pas besoin d'avoir le logiciel complet si par exemple ils n'utilisent jamais le chat).
* possibilité de travailler avec un plus grand nombre de personne sur le projet. Chacun pouvant en effet travailler sur un module
* possibilité de gérer plusieurs protocoles pour se connecter à plusieurs serveurs

=== Structure du programme ===

Le schéma suivant représente de manière simplifié la structure interne de qRezix 2.0.x :

[[Image:qrezix-1.7_structure.png]]

Bien que le nombre d'élément soit impressionnant, cette structure est beaucoup plus propre que celle de qRezix 1.6. Le schéma montre en effet en particulier que les éléments sont proprement séparé, les seuls dépendances entre les modules qu'il peut y avoir sont gérées par la bibliothèque principale.

Le RzxComputer a acquis un rôle beaucoup plus important, il gère désormais la totalité des informations concernant une machine et inclus les actions qu'il est envisageable d'effectuer (propriétés, chat, http, ftp...). Le chat est géré par les modules qui se déclarent comme supportant cette fonctionnalité, de même pour les propriétés.

La fenêtre de préférences (RzxProperty) génère dynamiquement la page de propriétés en fonction de ce que les modules installés désirent. Et tout est mis en oeuvre (au travers de classe abstraites regroupant tous les outils nécessaires) pour que chaque module puisse créer simplement ses propres classes de configuration.

Les modules peuvent être construit soit en built-in soit en plug-in. Aucun n'est nécessaire au fonctionnement du programme (enfin si on retire tous les protos réseau, programme perd beaucoup de son intérêt).

Accueil

2006-06-12T07:35:51Z

Fruneau : Lien vers la page d'accueil privée fait moins 'parachuté'

__NOTOC__
__NOEDITSECTION__
{{Menu public}}

<div class="logobr" style="float: left; max-width: 70%; background-position: center; background-repeat: no-repeat;">

=== Le Binet réseau, le binet du mythe ... ===

Le Binet Réseau est une association d'étudiants en deuxième année à l'[http://www.polytechnique.fr Ecole Polytechnique] qui s'occupent de la gestion du réseau élève. Souvent aidés par leurs anciens, ils s'efforcent de maintenir et d'améliorer la qualité des services offerts aux élèves.

''Gestion des serveurs élèves, développement d'outils pour le réseau et mise en place de services ([[news|newsgroup]], [[Miroir FTP|miroirs ftp]], [[domaine Windows]], licenses [[MSDNAA]]) en sont la principale activité.''

Les membres du Binet Réseau ne sont pas pour autant tous des férus d'informatique et se partagent les taches en fonction de leurs capacités et de leurs envies : relations avec nos partenaires, communication avec les élèves constituent aussi des postes essentiels.

'''Ainsi, le Binet Reseau offre une chance unique d'approfondir ses connaissances en informatique, au service des autres et en se faisant plaisir !'''

=== Des services ===
Le binet réseau, c'est avant tout la maintenance d'un service pour tous les élèves de l'école : un accés au réseau interne et externe le plus fiable et le plus performant possible. Comme le réseau physique est essentiellement propriété de la DSI sur notre campus, notre binet gère surtout ses propres serveurs et ses services, ainsi que les relations entre les élèves et la DSI.

Dans les services, on trouve en particulier l'administration du domaine Windows qui permet aux élèves client de se connecter plus facilement sur le réseau et au BR de protéger le réseau des virus via la mise à jour de Windows et la diffusion d'un antivirus.

Le binet réseau maintient aussi de nombreux serveurs qui assurent les différentes fonctions de controle et de service du réseau. En particulier, nous hébergeons des [[Miroir FTP|miroirs]] (linux, etc.) qui en raison des restrictions de la DSI ne sont malheureusent pas accessibles de l'extérieur de l'Ecole.

=== Des projets ===
La deuxième activité du binet est la programmation d'outils logiciels. En particulier, le binet a développé un outil de gestion de [[DNS]] (serveur et client [[xNet]]) incluant des services de chat et de voisinage réseau, ainsi qu'un [http://www.frankiz.net portail web pour les élèves] permettant une diffusion facile des annonces et activités de la promotion, l'accés à un annuaire et à de nombreux autres services.

Enfin, dans une perspective d'équipement à long terme, le binet compte, dans la mesure de son budget, faire l'ensemble des investissements matériels nécessaire à l'amélioration des performances de son réseau, notamment par [[WiFi|intégration des technologies sans fil]].

<div style="margin-bottom:1em; padding:0.3em; border:solid 1px #808080; background: #FFFFDD;">
<center>[[Image:Home.png|16px]] [[WikiBR:Accueil|Accéder à la page d'accueil privée]]</center>
</div>

</div>

{{Footer public}}

BR2002

2006-06-12T07:23:57Z

Fruneau : Les réalisations du BR2002

{{menu BR}}

{| border=0 width=50% align=center
| [[User:Kikx|Kikx]] || prez
|-
| [[User:Falco|Falco]] || root News IRCop
|-
| Schmurtz || root XShareMac
|-
| [[User:PaXaL|PaXaL]] || root web@frankiz
|-
| Matrix || admin@windows
|-
| Moi || admin@windows
|-
| Bolzano || web@frankiz
|-
| Alyx || Trez
|-
| ArthurB || IRCop
|-
| LazyStuff || QDJ Master
|-
| Arrakis || root
|-
| mlk || web@frankiz
|-
| PsyCow || Faqmestre
|-
| Steak || Devel News
|-
| Neo || XShare
|-
| [[Utilisateur:WakeUpNeo|WakeUpNeo]] || web@poly
|-
| R2 || TOL XShare
|}

=== Réalisations ===
* Mise en place du partenariat de [[MSDNAA]]
* Renouvellement des serveurs [[Admin:Frankiz|Frankiz]], [[Admin:Heol|Heol]] et achat de [[Admin:Lunedenn|Lunedenn]]
* Lancement du projet [[WiFi]]
* Lancement du projet [[FrankizII]] de restructuration de [http://frankiz]

Modèle:Block adminprojets

2006-06-11T15:55:18Z

Fruneau :

<div style="margin: 0.5em; border: 1px solid #6f8f9f;">
<div style="padding: .3em .5em .2em .5em; border-bottom: 1px solid #6f8f9f; background-color: #EAF5FB;"><big>[[Image:Project.png|16px]] Gestion des projets</big></div>
<div style="padding: .2em .5em .5em .5em; background-color: #fff;">
* [[BR:Evolutions Frankiz|Evolutions Frankiz]]
* [[Admin:DHCP|DHCP]]
* [[Admin:TV|TV]]
* [[WiFi]]
** [[Réseau:Architecture du réseau WiFi|Architecture du réseau WiFi]] (privé)
** [[Admin:Serveur Radius|Serveur Radius]] (privé)
** [[Configuration des clients pour le WiFi]]
* [[BR:Journées Federez 2006|Journées Federez en 2006]]
</div>
</div>

Modèle:Block secretariat

2006-06-11T15:54:35Z

Fruneau :

<div style="margin: 0.5em; border: 1px solid #6f8f9f;">
<div style="padding: .3em .5em .2em .5em; border-bottom: 1px solid #6f8f9f; background-color: #EAF5FB;"><big>[[Image:Desktop.png|16px]] Secrétariat</big></div>
<div style="padding: .2em .5em .5em .5em; background-color: #fff;">
* [[BR:InfoBR|InfoBR]]
* [[BR:Telephony Over IP|Telephony Over IP]]
* [[BR:Contacts|Contacts]]
* [[BR:La DSI|La DSI]]
* [[BR:Charte interne du BR (projet)|Charte interne du BR]]
* [[BR:Statut du BR|Statut du BR]]
* [[BR:Documents externes|Documents externes]]
* [[BR:Ethique Root|Ethique root/newsmestre]]
* [{{SERVER}}{{localurl:Special:Allpages|namespace=104}} Réunions]
</div>
</div>

WikiBR:Aide

2006-06-11T15:48:30Z

Fruneau : Correction du formatage des blocs

Ce wiki est censé contenir le matériel nécessaire pour pouvoir retrouver un savoir-faire, une idée,...
Son utilisation est relativement simple.

== Aide Officielle de Media Wiki ==

Vous pouvez la trouver ici : [http://meta.wikimedia.org/wiki/Aide:Contenu], n'hésitez pas à vous y référer si vous avez des questions sur le fonctionnement 'technique' du wiki.

== Obtenir un compte ==
<div style="border: 1px solid #6f8f9f; padding: .2em .5em .2em .5em; background-color: #EAF5FB">
La première étape, est d'obtenir un compte sur le wiki, puisque même les pages publiques ne sont editables que par des personnes ayant un compte. Pour des raisons évidentes de sécurité des informations, cette opération nécessite une intervention humaine. Contacte les [mailto:root@frankiz administrateurs du wiki] en précisant ton '''adresse mail''', ton '''nom''', et le '''login''' souhaité (qui commencera obligatoirement par une majuscule, c'est le moteur wiki utilisé qui l'impose).
</div>

Il te suffira désormais de t'identifier à chaque fois que tu viendras consulter ou écrire sur le wiki.

== Editer une page ==
Pour éditer une page, il suffit de s'identifier et de se rendre sur cette page. Il y a un lien ''éditer'' (placé différemment selon la skin). Tu cliques dessus et le texte de la page apparaît alors dans une boîte d'édition... à toi de faire ce que tu veux avec.

Toutes les modifications sont enregistrées. Donc ne t'inquiètes pas tu peux faire des modifications même si tu n'es pas sûr qu'elles conviendront à tout le monde.

== Créer une nouvelle page ==
Une page du wiki aura un nom de la forme Nom_de_page (avec une majuscule au début du nom de la page). Pour la créer, il y a 2 manières.
* tu crées un liens vers ''Nom_de_page'' (<tt><nowiki>[[Nom de page]]</nowiki></tt>), et tu suis le liens... tu n'a plus qu'à éditer ;
* tu vas sur la page <tt><nowiki>http://gwennoz/wiki/index.php?title=Nom_de_page&action=edit</nowiki></tt>.

Attention aux pattes cassées... il est très facile de faire une page non référencée, donc pensez toujours à mettre un lien dans la section qui va bien vers votre page !!!

Pour les conventions de nommage des pages et en particulier pour les placer dans le bon namespace, il faut se référer à [[WikiBR:Wiki]]

== Syntaxe Wiki ==
MediaWiki utilise la [http://fr.wikipedia.org/wiki/Aide:Syntaxe_Wikipédia Syntaxe Wikipédia].

'''Aide-mémoire rapide'''

{| border=0
|
'''gras'''
|
<nowiki>'''gras'''</nowiki>
|-
|
''italique''
|
<nowiki>''italique''</nowiki>
|-
|
[[Accueil]]<br />[[Accueil|lien vers l'accueil]]<br />http://www.mediawiki.org<br />[http://www.mediawiki.org]<br />[http://www.mediawiki.org lien externe]<br />[mailto:root@frankiz mail]
|
<nowiki>[[Accueil]]</nowiki><br /><nowiki>[[Accueil|lien vers l'accueil]]</nowiki><br /><nowiki>http://www.mediawiki.org</nowiki><br /><nowiki>[http://www.mediawiki.org]</nowiki><br /><nowiki>[http://www.mediawiki.org lien externe]</nowiki><br /><nowiki>[mailto:root@frankiz mail]</nowiki>
|-
|
Titres<br />En général, on n'utilise que les<br/>titres de niveau 2 ou supérieur.
|
<nowiki>= Titre 1 =</nowiki><br /><nowiki>== Titre 2 ==</nowiki><br /><nowiki>=== Titre 3 ===</nowiki><br /><nowiki>==== Titre 4 ====</nowiki>
|-
|
Insérer une image
|
<nowiki>[[Image:Exemple.jpg]]</nowiki>
Utiliser le lien [[Special:Upload|Copier sur le serveur]] pour enregistrer l'image.
|-
|
code
|
laisser un espace en début de ligne
|-
|
Saut de<br/>ligne !
|
<nowiki>Saut de<br/>ligne !</nowiki>
|}

'''Pour faire des cadres bleus comme ci-dessus'''

C'est une convention adoptée pour le WikiBR, qui permet de mettre en évidence des informations essentielles. La syntaxe est la suivante :
<nowiki><div style="border: 1px solid #6f8f9f; padding: .2em .5em .2em .5em; background-color: #EAF5FB"></nowiki>
Le texte dans le cadre ici, la syntaxe Wiki s'applique normalement.
<nowiki></div></nowiki>
Et pour un cadre rouge ? Voici le code, à utiliser avec parcimonie :
<nowiki><div style="border: 1px solid #9f6f8f; padding: .2em .5em .2em .5em; background-color: #FBEAF5"></nowiki>
Placer ici le texte d'avertissement !
<nowiki></div></nowiki>

'''Pour faire un block comme le menu de la page d'accueil'''

<nowiki><div style="margin: 0.5em; border: 1px solid #6f8f9f;">
<div style="padding: .3em .5em .2em .5em; border-bottom: 1px solid #6f8f9f; background-color: #EAF5FB;"><big>[[Image:MonIcone|16px]] Mon titre</big></div>
<div style="padding: .2em .5em .5em .5em; background-color: #FFF;">
contenu du block...
</div>
</div></nowiki>

Pour avoir un block accessible de manière globale, il suffit de le stocker à la page
<nowiki>{{block monblock}}</nowiki>

'''Pour mettre en objet en menu'''

<nowiki><div style="float: right; width: auto; max-width: 25%;">
mon contenu
</div></nowiki>

Si le contenu est constitué de bloc, le menu aura la forme :

<nowiki><div style="float: right; width: auto; max-width: 25%; margin-left: 0.5em;">
{{block monblock}}
</div></nowiki>

Pour pouvoir être utilisé comme un composant de plusieurs pages, un menu doit être stocké dans une page :
<nowiki>{{menu monmenu}}</nowiki>

Modèle:Block secretariat

2006-06-11T15:45:59Z

Fruneau : Block pour les trucs administratifs

<div style="margin: 0.5em; border: 1px solid #6f8f9f;">
<div style="padding: .3em .5em .2em .5em; border-bottom: 1px solid #6f8f9f; background-color: #EAF5FB;"><big>[[Image:Desktop.png|16px]] Secrétariat</big></div>
<div style="padding: .2em .5em .5em .5em;">
* [[BR:InfoBR|InfoBR]]
* [[BR:Telephony Over IP|Telephony Over IP]]
* [[BR:Contacts|Contacts]]
* [[BR:La DSI|La DSI]]
* [[BR:Charte interne du BR (projet)|Charte interne du BR]]
* [[BR:Statut du BR|Statut du BR]]
* [[BR:Documents externes|Documents externes]]
* [[BR:Ethique Root|Ethique root/newsmestre]]
* [{{SERVER}}{{localurl:Special:Allpages|namespace=104}} Réunions]
</div>
</div>

Modèle:Block adminprojets

2006-06-11T15:42:24Z

Fruneau : Block sur la gestion des projets

<div style="margin: 0.5em; border: 1px solid #6f8f9f;">
<div style="padding: .3em .5em .2em .5em; border-bottom: 1px solid #6f8f9f; background-color: #EAF5FB;"><big>[[Image:Project.png|16px]] Gestion des projets</big></div>
<div style="padding: .2em .5em .5em .5em;">
* [[BR:Evolutions Frankiz|Evolutions Frankiz]]
* [[Admin:DHCP|DHCP]]
* [[Admin:TV|TV]]
* [[WiFi]]
** [[Réseau:Architecture du réseau WiFi|Architecture du réseau WiFi]] (privé)
** [[Admin:Serveur Radius|Serveur Radius]] (privé)
** [[Configuration des clients pour le WiFi]]
* [[BR:Journées Federez 2006|Journées Federez en 2006]]
</div>
</div>

MSDNAA

2006-06-11T13:54:48Z

Fruneau :

{{menu services}}

== Les MSDNAA ==

MSDNAA signifie "MSDN Academic Alliance". Le MSDN étant le centre de ressources pour développeur de Microsoft.

Le MSDNAA est une offre de Microsoft destinée aux etablissement d'enseignement supérieur. Il s'agit de la mise à disposition pour toutes les personnes qui suivent des cours dans l'établissement de licenses gratuites, valables à vie, pour un certain nombre de logiciel Microsoft. Ces logiciels sont tous les logiciels microsofts à l'exception d'Office et des jeux. Ce sont donc principalement Windows, les logiciels de développement (Visual Studio, Access), les logiciels professionnels (Project), Virtual PC... Ceci est valable pour les logiciels disponible sous Windows mais également sous MacOS X.

== Obtenir ses licenses ==

Pour obtenir ses numéros de licenses, il y a deux solutions :
* faire une demande par l'interface de [http://www.frankiz.net/profil/licences.php Frankiz].
* si le logiciel n'est pas disponible sur Frankiz, envoyer un mail aux [[Poste:admin@windows|admin@windows]] en indiquant le logiciel recherché.
windows #AT# frankiz.polytechnique.fr

<div style="border: 1px solid #6f8f9f; padding: .2em .5em .2em .5em; background-color: #EAF5FB">
Ma politique actuelle ([[User:L'Aspirant|L'aspi]]) est de :
* distribuer des cles aux binets pour faciliter leur integration au domaine
* distibuer des 2emes (ou neme) cles aux eleves pour des ordis **presents sur le plateau**
</div>

MSDNAA

2006-06-11T13:54:19Z

Fruneau : Description du MSDNAA et de 'Comment obtenir ses licences'

{{menu services}}

== Les MSDNAA ==

MSDNAA signifie "MSDN Academic Alliance". Le MSDN étant le centre de ressources pour développeur de Microsoft.

Le MSDNAA est une offre de Microsoft destinée aux etablissement d'enseignement supérieur. Il s'agit de la mise à disposition pour toutes les personnes qui suivent des cours dans l'établissement de licenses gratuites, valables à vie, pour un certain nombre de logiciel Microsoft. Ces logiciels sont tous les logiciels microsofts à l'exception d'Office et des jeux. Ce sont donc principalement Windows, les logiciels de développement (Visual Studio, Access), les logiciels professionnels (Project), Virtual PC... Ceci est valable pour les logiciels disponible sous Windows mais également sous MacOS X.

== Obtenir ses licenses ==

Pour obtenir ses numéros de licenses, il y a deux solutions :
* faire une demande par l'interface de [http://www.frankiz.net/profil/licences.php Frankiz].
* si le logiciel n'est pas disponible sur Frankiz, envoyer un mail aux [[Poste:admin@windows]] en indiquant le logiciel recherché.
windows #AT# frankiz.polytechnique.fr

<div style="border: 1px solid #6f8f9f; padding: .2em .5em .2em .5em; background-color: #EAF5FB">
Ma politique actuelle ([[User:L'Aspirant|L'aspi]]) est de :
* distribuer des cles aux binets pour faciliter leur integration au domaine
* distibuer des 2emes (ou neme) cles aux eleves pour des ordis **presents sur le plateau**
</div>