rand() moi un entier !

Cet article est une synthèse de plusieurs conférences, de la documentation C++ et de mon expérience sur la génération de nombre aléatoire en C++.

Mon besoin

Je suis le développeur de Rolisteam. Un logiciel pour faire du jeu de rôle en ligne. Il intègre une solution badass (oui, je m’envoie des fleurs) de lancer de dés. J’ai passé beaucoup de temps entre juillet 2014 et février 2015 pour produire un langage de script interprété de lancement de commandes de dés. Vous pouvez y jeter un œil sur ce lien: DiceParser. Bref, j’ai crée tout un système pour lancer les dés et faire des opérations sur les résultats: tri, relance, filtre, explosion, arithmétique, gestion des priorités mathématiques et il est même capable de générer l’arbre d’exécution avec dot.

L’aléatoire

Pour la partie aléatoire dans tout le système, j’ai réutilisé le code historique de rolistik (l’ancêtre de rolisteam).
Certains utilisateurs sont venus me voir pour me demander de vérifier le système d’aléatoire car ils avaient fait des tests et avez déterminé que Rolisteam favorisait les résultats haut; ou bas selon les personnes.
J’avais droit à un tableau de statistique réalisé sur quelques dizaines de lancer de dés.
Argument qu’il est facile de détruire avec une étude statistique plus riche en lancer. DiceParser fonctionne en ligne de commande, donc très facile à «scripter». Bref, des gens avaient des doutes sans réelle preuve.
Du coup, je me suis un peu renseigné s’il n’y avait pas des méthodes plus «C++» avec le C++11, C++14 et/ou C++17.

L’existant

Quand il s’agit de générer des nombres aléatoires, la première implémentation qu’on apprend est souvent celle ci :

int resultat = std::rand()%MAX+debut;

usage classique de rand();

Je pense que tous les étudiants ont implémenté cette méthode, dans leurs premières années d’études. Elle est facile à comprendre. Elle est disponible dans beaucoup de langages. Elle vient du C. Elle met en avant le modulo, ce qui lui donne peut-être une valeur pédagogique. Elle suffit dans de très nombreux cas.

Nous allons voir un peu ce qui cloche avec cette méthode.

Les défauts

1/ Pauvre entropie
Déjà, rand() ou std::rand() sont définis dans le “man” comme une solution pauvre pour obtenir de l’aléatoire. Il est précisé que les vieilles implémentations de rand() ou les implémentations sur d’autres systèmes fournissent un aléatoire pauvre sur les bits de poids faibles. Cela explique peut-être pourquoi certains utilisateurs sous Windows se plaignent.
Donc l’entropie de rand n’est pas bonne. Il existe une autre méthode: random() qui fonctionne normalement mieux, avec un période beaucoup plus grande.

2/ Erreur de répartition
Ces deux méthodes génèrent un nombre entre 0 et RAND_MAX. Maintenant, nous souhaitons obtenir des résultats sur un dés à 100 faces. (C’est un format de dés courant en Jeux de rôle).
Imaginons que RAND_MAX vaut 32767.

Si je découpe la valeur maximum en tranche de 100 cela donne ceci:

[0 : 99] => 100 valeurs
[100 : 199] => 100 valeurs
[200 : 299] => 100 valeurs
:
:
[32700 : 32767 ] => 67 valeurs.

Nous avons 327 tranches complètes et une dernière de 67. L’usage du modulo vient faire la correspondance entre la valeur tirée dans l’espace de valeurs désirées. Cela favorise les résultats entre 0 et 67. Il y a une chance supplémentaire de tomber en dessous de 67. La différence est probablement négligeables mais tout de même, cela me pose problème d’avoir cela dans mon logiciel.

3/ Problème de portabilité

La valeur RAND_MAX vaut au minimum 32767 dans la norme. Elle diffèrent en fonction des implémentations, nous avons vu également que la portabilité de la méthode rand() n’est pas garantie.
Cette somme de problèmes vient conforter les utilisateurs de Rolisteam dans leur idée de problème relatif au système de dés. Deux problèmes de portabilité se cumulent.

Le constat de ces erreurs m’a poussé à chercher une solution moderne pour générer ces nombres.

Dans les API C++ est arrivé un nouveau “module” avec le C++11. Il s’agit de random.

#include <random>

Ce module présente toute une série de classes pour générer des nombres aléatoires et les répartir.
Il propose un nombre intéressant d’algorithmes ou de moteurs différents pour la génération. Je ne suis pas un expert en génération pseudo-aléatoire de nombre. Du coup, le nom des algorithmes ne me parle pas.
Cependant, il semble que deux éléments sortent du lot: le std::random_device et le std::mt19937.

Le std::random_device

Il est défini dans la documentation comme: Un générateur de nombre aléatoire non déterministe. En gros, cela signifie qu’on ne peut pas prévoir son comportement.
D’habitude, vous initialisez votre méthode aléatoire par un seed. Il peut être intéressant pour des tests automatiques ou une résolution de bug de pouvoir rejouer une séquence entière de nombre aléatoire.
Pour atteindre cet objectif, il suffit de mettre la même seed. Donc vous avez là une méthode de nombre aléatoire qui est déterministe. random_device n’a pas de seed. Il n’a pas besoin d’être initialiser. Il est donc impossible de lui faire “jouer” deux fois la même chose. Dans mon cas, cela me satisfait complètement.

C’est facile à mettre en place:

std::random_device rd;
std::uniform_int_distribution<int> dist(1, 10);
int randomNumber = dist(rd);
std::cout <<  randomNumber << std::endl;

On génère une nombre et on le distribue entre 1 et 10. Cela suffit. Il y a rien besoin de plus. C’est propre, élégant etc.
J’ai implémenté cette méthode dans rolisteam 1.8, malgré les avertissements qu’on trouve à droit à gauche. Cela donne de bons résultats sous Linux. J’ai fait une version pour Windows et là, c’est le drame.
L’entropie du module sous windows est de zéro. Cela signifie qu’il renvoie toujours le même résultat. Bref, les dés étaient toujours de la même valeur.
La solution du random_device ne marche pas. Elle n’est pas portable.

Le std::mt19937

Il reste donc la méthode du std::mt19937. Elle fait toujours partie de l’API de <random>. Voici l’implémentation finale dans rolisteam.

// dans le constructeur de ma classe dé
auto seed = std::chrono::high_resolution_clock::now().time_since_epoch().count();
m_rng = std::mt19937(quintptr(this)+seed);

//dans la fonction lancer (roll())
std::uniform_int_distribution<qint64> dist(m_base,m_faces);
qint64 value = dist(m_rng);

L’implementation dans rolisteam.

On peut voir qu’elle est plus proche de l’ancienne méthode car Il est nécessaire de l’initialiser avec un seed. Pour cela, il est également possible d’utiliser une API C++11: <chrono>.

 #include <chrono>
…
auto seed = std::chrono::high_resolution_clock::now().time_since_epoch().count();
m_rng = std::mt19937(quintptr(this)+seed);

Politique Agricole Commune

Autres méthodes:

Il existe d’autres moyens de tirer des nombres aléatoires en C++. Il existe des tonnes de bibliothèques C++ pour faire cela. Si j’en avais une seule à vous conseiller, je parlerais de PCG (www.pcg-random.org). Elle est écrite par Melissa O’Neill. Cheinan Marks fait l’éloge de cette bibliothèque et du site qui l’accompagne.

Il y a de nombreux articles sur le sujet. Personnellement, je n’ai pas intégré PCG dans rolisteam, tout simplement parce que chaque bibliothèques externes est un calvaire à gérer dans le processus d’installation pour une application multi-plateforme.

Conclusion:

J’espère avoir fait le tour des nouvelles API pour la génération aléatoire de nombres entiers en C++. Il est important de garder à l’esprit que l’API <random> fournit bien sur bien plus de chose que ce que j’ai montré. Je n’ai pas fait d’étude statistique pour démontrer que c’est mieux maintenant. Dans tous les cas, j’ai implémenté le device_random dans mon lecteur audio maison, et je découvre plein de nouvelle musique de ma collection.

Les sources:

CppCon 2016: Cheinan Marks “I Just Wanted a Random Integer!”:
https://www.youtube.com/watch?v=4_QO1nm7uJs
Stephan T. Lavavej – rand() Considered Harmful:
https://channel9.msdn.com/Events/GoingNative/2013/rand-Considered-Harmful

Distribuer une application Qt

Bonjour,

Si vous suivez ce blog, vous savez que je suis développeur C++/Qt et que je contribue beaucoup à Rolisteam (www.rolisteam.org). C’est un logiciel libre pour faire du jeu de rôle. Il vise un public assez large. Il est donc multi-plateforme. Il fonctionne sous GNU/Linux, windows et Mac Os. Je suis un linuxien convaincu mais je développe sur les autres systèmes pour Rolisteam.

L’aspect développement n’est pas vraiment un problème, grâce à Qt. Cela marche grosso modo bien. La chose devient plus périlleuse quand il s’agit de distribuer le logiciel.

Dans mon activité professionnelle, j’ai constaté, qu’il est assez rare qu’un développeur connaisse les solutions pour distribuer facilement un logiciel. Je vais essayer ici d’expliquer comment faire. Du moins, comment je fais dans rolisteam et si vous avez d’autres astuces. N’hésitez pas à en faire part dans les commentaires.

Prédicat de base:

Vous avez un logiciel écrit en C++/Qt, il est géré par un fichier .pro. Certains systèmes de build propose des systèmes identiques, voir plus puissant mais plus complexe (e.g: cmake). Je me contente d’évoquer les outils Qt.

Pour GNU/Linux :

Pour ma part, j’ai opté pour une distribution source et la création de package Ubuntu. Grâce à Launchpad, il est possible de créer un dépôt pour son projet et de soumettre des versions. Il faut l’admettre, c’est très pratique. Il existe probablement des services pour faire cela pour d’autres distributions.

Des contributeurs ont créé des package pour d’autres distributions (fedora…). Pour arch-linux, j’ai crée un script de compilation (à tester).

L’ensemble des outils utilisées ne sont pas des outils Qt. Cela n’est donc pas le propos de cet article. Je me suis mis de côté la tâche de jeter un coup d’œil à appimage. Cela pourrait être une solution intéressante.

Pour Windows:

Trouver tous les éléments

Une application a des dépendances. Sous windows, il est courant d’installer l’exécutable et ses dépendances dans un même dossier. Il est parfois difficile d’identifier les dépendances. Rassurez-vous un outil magique a été créée. Il s’agit de “windeployqt.exe“. C’est un outil distribué avec Qt. Son but est de copier toutes les dépendances Qt d’un binaire dans un dossier.

windeployqt  /chemin/vers/mon/executable.exe

Commande Windeployqt

Cette commande va lire le binaire et va copier l’ensemble des dépendances identifiés à côté du binaire.

Par soucis de clarté, je préfère utiliser un répertoire propre et distinct du répertoire de compilation.

windeployqt --dir /chemin/vers/un/dossier/propre /chemin/vers/mon/application.exe

Dossier séparé

L’ajout du l’argument –dir permet de définir ce «dossier de destination».

Une autre difficulté entre en jeu quand votre application utilise du QML. En effet, il convient de rajouter un argument à la commande afin de permettre à l’outil d’aller lire votre code QML pour trouver ses dépendances.

windeployqt --qmldir /chemin/vers/le/dossier/des/qml --dir /dossier/propre application.exe

Distributer du QML

Et après ?

Une fois cette étape terminée, vous aurez dans votre dossier de destination l’ensemble des dépendances Qt (et QML) de votre projets.

Je vous mets un exemple pour un logiciel utilisant Qt5 et un peu de QML le tout fut compilé avec Visual Studio.

├── accessible/
├── audio/
├── bearer/
├── designer/
├── Enginio.dll
├── iconengines/
├── icudt52.dll
├── icuin52.dll
├── icuuc52.dll
├── imageformats
├── mediaservice
├── msvcp120.dll
├── msvcr120.dll
├── platforms/
│ └── qwindows.dll
├── playlistformats/
├── position/
├── printsupport/
├── qml1tooling/
├── qmltooling/
├── Qt5Core.dll
├── Qt5Declarative.dll
├── Qt5Gui.dll
├── Qt5Network.dll
├── Qt5OpenGL.dll
├── Qt5Qml.dll
├── Qt5Quick.dll
├── Qt5WebKit.dll
├── Qt5Widgets.dll
├── Qt5Xml.dll
├── Qt5XmlPatterns.dll
├── sensorgestures/
├── sensors/
├── sqldrivers/
├── unins000.dat
└── unins000.exe

Si votre projet utilise d’autres bibliothèques (zlib …), il convient de rajouter les .dll correspondantes dans le dossier. La dernière étape est d’inclure le .exe de votre application.
En double-clickant sur le .exe, il devrait se lancer. Si ce n’est pas le cas, une dll est probablement manquante.
Cette procédure est à faire après un changement de version de Qt. Il faut vous assurer que les dll embarquées soient de la bonne version.

A ce stade, il ne reste qu’à mettre en place l’outil de publication de votre application.

Publication

Pour cette étape, il y a principalement deux méthodes:

La méthode de l’archive Zip, il suffit d’archiver le dossier de destination dans une archive .zip. Ce fichier peut être extrait sur n’importe quel windows, et cela fonctionnera. Il faudra créer à la main les raccourcis et il n’y pas d’autre moyen pour dés-installer le logiciel que de supprimer le dossier extrait à la main.

L’autre méthode est d’utiliser un outil qui va créer un installeur. Les plus connus sont Inno setup et NSIS.
J’utilise pour ma part: InstallForge (http://installforge.net), il est graphique et simple.
Qu’importe l’outil choisi, il faudra lui dire d’installer tous les fichiers de votre dossier de destination (en respectant la hiérarchie des fichiers) chez vos utilisateurs. Ces outils permettent de créer automatiquement des scripts de désinstallation, ils créent également les raccourcis sur le bureau et la barre de démarrage. Ils permettent aussi d’afficher du contenu à l’utilisateur (licence, logo du logiciel) et cela lui permet de prendre des décisions, au cours de l’installation (si besoin).

Pour finir, après cette étape, vous aurez un installeur soit en mode .zip, soit un .exe. Il ne reste plus qu’à mettre cet installeur accessible à vos utilisateurs et c’est bon.

Pensez à le tester quand même avant de faire des annonces publiques. On sait jamais !

Pour Mac OS:

Pour MacOs, il existe un outil similaire qui s’appelle: macqtdeploy.
Il utilise les mêmes paramètres que la version windows, la seule différence réside dans l’utilisation d’un .app (en lieu et place du .exe).

macdeploy application.app -qmldir=/User/dossier/vers/code/qml

sur MacOs X

Bien sûr, cela peut être intégrer dans QtCreator comme étape de déployement.
Sur MacOs, il est possible de demander à Qt de compiler une application dans un bundle (c’est d’ailleurs la solution par défaut). Un bundle est un dossier se terminant par «.app». Dans l’environnement graphique de MacOs, un double click lance le logiciel qu’il contient. Il est également possible, d’explorer le contenu du bundle en ligne de commande (cela se comporte comme un dossier) ou par un click droit: «afficher le contenu du packet» en graphique.

Dans tous les cas, l’utilisation de la commande va venir placer l’ensemble des dépendances Qt dans le bundle. Pour être précis, les bibliothèques sont placées dans le dossier Contents/Frameworks du bundle. Les modules QML sont dans Resources/qml.

A l’instar de windows, il faut mettre également d’éventuelles autres bibliothèques dans le bundle. C’est une étape un peu technique. Pour rolisteam, j’utilise zlib, voilà le programme bash qui me permet de faire l’ajout et de bien définir les chemins.

#!/bin/sh

############################################
# Rolisteam 
# Script to deploy libz into rolisteam.
#
###########################################

echo 'Display dependancies'
otool -L rolisteam.app/Contents/MacOS/rolisteam



echo 'Create directory'
mkdir rolisteam.app/Contents/Frameworks/libz.framework/

echo 'Copy lib binary'
cp /usr/lib/libz.1.dylib rolisteam.app/Contents/Frameworks/libz.framework/

echo 'Rewrite path to the lib'
install_name_tool -change /usr/lib/libz.1.dylib @executable_path/../Frameworks/libz.framework/libz.1.dylib rolisteam.app/Contents/MacOS/rolisteam

Ajouter une dépendances à un bundle

En gros, il y a la copie du fichier en lui même puis, la modification de l’exécutable pour lui dire d’aller chercher zlib dans le bundle et non sur mon poste. Cette étape est très importante car sinon, votre bundle ne sera pas portable sur une autre machine.

Et après ?

Le fichier .app complet suffit pour être installé sur une autre machine. Cependant, il est de coutume de distribuer un logiciel par un dmg. Cela permet de le compresser pour faciliter sa distribution et surtout MacOs permet de rendre graphique l’installation par un dmg.

Pour réaliser cela, j’utilise un petit utilitaire: node-appdmg. Il suffit d’un petit fichier de configuration en json pour définir les paramètres.

{
  "title": "Rolisteam  - Mac Os X",
  "icon": "rolisteam.icns",
  "background": "1500-rolisteam.png",
  "icon-size": 80,
  "contents": [
    { "x": 448, "y": 344, "type": "link", "path": "/Applications" },
    { "x": 192, "y": 344, "type": "file", "path": "rolisteam.app" }
  ]
}

Configuration node-appdmg pour rolisteam

Vous lancez l’utilitaire avec le fichier de configuration et le nom de votre dmg pour obtenir votre dmg tout beau, tout propre.

node-appdmg dmg.json monapplication.dmg

Il ne reste qu’à distribuer votre dmg.

Conclusion

Nous venons de voir les solutions et les outils mis en place pour rolisteam.
Si vous avez des questions sur les outils, ou si vous voulez en proposer d’autres, les commentaires sont là pour ça.

Retours d’expérience d’une présentation QML

Pour préparer ma conférence à Pas Sage En Seine [FR], j’ai décidé de faire une présentation QML.
Cela offre un bien meilleur contrôle, bien plus de possibilité graphique (animations, intégration de code, 3D…) et de même de l’interactivité.
Bien sûr, une présentation QML demande plus de temps à faire. Le but de l’article est ici d’expliquer les astuces que j’ai mises en place. Espérant gagner du temps la prochaine fois.

Le contenu de la présentation QML:

Comme vous pouvez le voir, la présentation est une application C++ qui affiche du QML. Cette méthode permet de faciliter le contrôle de la partie QML. Je m’en sers pour enregistrer des captures d’écran de la présentation afin d’en faire un PDF. C’est le meilleur pour distribuer la présentation ou dans le cas ou pour éviter l’effet démo.
Tout en haut, il y a les classes C++, les fichiers de management du projet et le fichier main.qml. Dans le répertoire «pages», vous y trouverez les différentes slides de la présentation. Dans rsrc, il y a l’ensemble des images nécessaire à la présentation.

├── cpphighlighter.cpp
├── cpphighlighter.h 
├── deployment.pri 
├── LICENSE 
├── main.cpp 
├── main.qml 
├── pages 
│ ├── 01_intro.qml 
│ ├── 02_presentation.qml 
│ ├── 03_jdr_et_rolisteam.qml 
│ ├── 043_Exemple_code_1.qml 
│ ├── 04_jdr_avantages_pb.qml 
│ ├── 05_avantage_jdr_virtuel.qml 
│ ├── 06_fonctionnalites_rolisteam.qml 
│ ├── 07_rolisteam_debut.qml 
│ ├── 08_Rolistik_a_Rolisteam.qml 
│ ├── 10_frise_chronologique.qml 
│ ├── 11_son_usage.qml 
│ ├── 12_son_fonctionnement.qml 
│ ├── 13_dice_parser.qml 
│ ├── 14_themes_audio_3_pistes.qml 
│ ├── 15_nouveaute_1_8.qml 
│ ├── 16_projet_avenir.qml 
│ ├── 17_reussites.qml 
│ ├── 18_les_lecons.qml 
│ ├── 19_objectif_rolisteam_libre.qml 
│ ├── 20_FAQ.qml 
├── pasSageEnSeine.pro 
├── pasSageEnSeine.pro.user 
├── qmlcontroler.cpp 
├── qmlcontroler.h 
├── qmlcontroler.ui 
├── qml.qrc 
├── README.md 
├── rsrc 
│ ├── all.png 
│ ├── cc.png 
│ └── chat.png

L’application C++

Il peut être utile de connaître l’état de la présentation QML, et de pouvoir lire des notes sur chaque volet. Pour faire cela, j’ai écris une petite application C++.

le fichier main.cpp

Le premier objectif de l’application est d’afficher la présentation QML. Il faut donc charger le QML et établir des moyens de communication entre le monde QML et le C++. Comme vous pouvez le voir, je passe en paramètre la taille de la présentation en paramètre du QML. Ce dernier élément n’est pas obligatoire car par défaut j’utilise la taille de l’écran comme référence.

#include <QApplication>
#include <QQmlApplicationEngine>
#include "qmlcontroler.h"
#include <QQmlContext>
#include <QQuickTextDocument>

#include "cpphighlighter.h"

int main(int argc, char *argv[])
{
    QApplication app(argc, argv);

    QQmlApplicationEngine engine;

    engine.rootContext()->setContextProperty("ScreenW",1280);
    engine.rootContext()->setContextProperty("ScreenH",720);

    engine.load(QUrl(QStringLiteral("qrc:/main.qml")));

    QmlControler ctr;
    ctr.setEngine(&engine);

    return app.exec();
}

main.cpp

Dans ce projet, la classe QmlControler est l’objet (fenêtre) C++ qui affiche l’aperçu de la présentation et les commentaires/notes.

Regardons en détails cet élément:

La fenêtre d’aperçu

C’est une simple fenêtre. Elle est découpée en deux parties. Celle de gauche affiche dans un QLabel l’aperçu de la présentation QML. La partie de droite affiche les notes et commentaires sur la page courante dans un QTextArea.

void QmlControler::currentPageHasChanged(int i)
{
    m_currentScreen = i;
    QImage img = m_window->grabWindow();

    if(img.isNull())
        return;

    static int count = 0;


    img.save(tr("screens/%1_screen.png").arg(++count,3,10,QChar('0')),"png");
    qDebug() << "screen shot save" << count;

    m_ratioImage = (double)img.size().width()/img.size().height();
    m_ratioImageBis = (double)img.size().height()/img.size().width();

    m_label->setPixmap(QPixmap::fromImage(img));

    if((i+1>=0)&&(i+1<m_commentData.size()))
    {
        ui->textEdit->setHtml(m_commentData.at(i+1));
    }
    resizeLabel();
}

Current slide has changed

Quand la page courante change, la fenêtre C++ est informé par l’appel du slot: currentPageHasChanged alors l’application récupère une capture de la vue QML, l’affiche à l’écran (dans la partie gauche), affiche les notes à propos de la page courante et peut sauvegarder la capture dans un fichier.

Sauvegarder les captures dans des fichiers vous permet de créer un fichier PDF de votre présentation. Il s’agit là d’une solution de secours en cas de problème avec le matériel de la présentation ou une facilité pour distribuer votre présentation.

La commande qui va bien (sous linux) :

$ convert *.png mypresentation.pdf

L’application QML

Le système de chargement (Loader)

Par souci de clarté, je préfère avoir un fichier par page. Cela évite l’écueil d’un fichier QML long et complexe. L’application charge les pages en accord avec le modele de données principal dans le même ordre. Pour faire cela, j’ai utilisé un ListModel. Une page est définie par un titre, un nom de fichier, un temps (non utilisé), et le nom de la page suivante.
Le fichier main.qml affiche toutes les pages comme un «delegate» d’un pathview. Toutes les pages sont chargés depuis le fichier de ressources de Qt (inclue dans le binaire grâce au système de ressources de Qt).

ListModel {
            id: panelModel
            ListElement {
                name: "Intro"
                path: "01_intro.qml"
                time: 1
                next: "Présentation de Rolisteam"
            }

First item of the model.

La donnée vraiment utile pour le chargement est bien sûr le nom du fichier.
Les autres sont là pour aider la rédaction ou la présentation.

Le loader fait son travail, voici les lignes importantes:

    PathView {
        id: view
        anchors.fill: parent
        model: panelModel
        highlightRangeMode:PathView.StrictlyEnforceRange
        snapMode: PathView.SnapOneItem
        delegate:  Loader {
             source: "pages/"+path
        }

Path View

Le temps était destiné à afficher un compte à rebours pour chaque slide mais je n’ai pas eu le temps de l’implémenter.

Il est important de mettre dans le main.qml tous les éléments que vous souhaitez avoir sur toutes les pages: le sommaire, l’indication de la page courante sur le total de pages, etc.

Ajouter un sommaire

Pour réaliser un sommaire, j’ai ajouté un ListView avec le modele suivant:

    ListView {
        id: listView1
        x: ScreenW*0.02
        y: ScreenH*0.3
        width: ScreenW/2
        height: ScreenH*0.2
        delegate: Item {
            width: ScreenW/2
            height: listView1.height/listView1.count
                Text {
                    color: view.currentIndex>=index ? "black" : "gray"
                    text: name
                    font.pointSize: ScreenH/48
                    anchors.verticalCenter: parent.verticalCenter
                    font.bold: true

                }
        }
        visible: view.currentIndex>0 ? true : false

        model: ListModel {
            ListElement {
                name: "Concepts"
                index:1
            }
            ListElement {
                name: "Chroniques"
                index:6
            }
            ListElement {
                name: "Logiciel"//système de build, code spécifique par OS.
                index:9
            }
            ListElement {
                name: "Bilan"
                index:15
            }
        }
    }

Table of contents in QML

Le champs index du modèle permet de connaître la page qui démarre cette section du sommaire.

Page suivante

Quand il y a beaucoup de pages il peut être intéressant de connaître la prochaine page afin de faire une petite transition vers elle. Dans mon cas, j’affiche dans le coin haut-droit le titre de la prochaine page. Ce fut assez utile pour les répétitions, je n’en ai presque pas eu besoin pendant la conférence.

    Text {
        anchors.top: parent.top
        anchors.right: parent.right
        text: panelModel.get(view.currentIndex).next+">"
    }

Next slide

L’autre possibilité est d’utiliser les notes dans la fenêtre C++.

Créer une Page de présentation QML

Chaque page est indépendante, elles peuvent être totalement différentes cependant pour des raisons de simplicité, elle utilise une conception identique. Dans mon cas, elles sont constituées d’une ListView avec un modèle. Chaque élément du modèle est un titre de section à évoquer pendant la présentation.

Les éléments ont un index. Cet index est contrôlé par le clavier (flèche bas pour augmenter l’index, haut pour réduire l’index). Grâce à cet index, il est possible de cacher la liste et d’afficher une image, un schéma ou une vidéo.

Par exemple, dans ma présentation la fonctionnalité «Alias de dés» a pour index 10. Quand la index de la page devient 10, l’élément «Alias de dés» apparaît avec une petite animation. Puis l’index passe à 11, j’affiche une image illustrant la fonctionnalité des alias de dés. A 12, l’image disparaît et le texte revient.

Position et taille

Pour s’assurer de la lisibilité des éléments, je réalise l’ensemble des calculs en rapport à la taille de l’écran. Le positionnement est assuré par des ancres (anchors en qml).

    Image {
        id: image1
        anchors.left: parent.left
        anchors.top: parent.top
        anchors.leftMargin: ScreenW*0.04
        fillMode: Image.PreserveAspectFit
        source: "qrc:/rsrc/Rolisteam.svg"
        width: ScreenW*0.2
    }

Display the logo at the right position and size.

Autre piste

Il existe un module qui fournit des éléments QML pour faciliter la réalisation d’une présentation. Je ne l’ai pas utilisé mais il y a des choses intéressantes.

Module QML

Obtenir le code de mes présentations

Je vous invite à cloner ce code : https://github.com/obiwankennedy/pses

Autre exemple avec une image: https://github.com/obiwankennedy/l5rSummary

Exemple de présentation QML

Rolisteam Evolution

I would like to show the evolution of one function in rolisteam code.
This function is called when the user (Game Master) closes a map or image.

The function must close the map or image and send a network order to each player to close the image or plan.

At the beginning, the function looked like that.
Some code line and comments were written in French. No coding rules were respected.
Low-level code for networking. The function was very long.

 // On recupere la fenetre active (qui est forcement de type CarteFenetre ou Image, sans quoi l'action
        // ne serait pas dispo dans le menu Fichier)
        QWidget *active = workspace->activeWindow();

        // Ne devrait jamais arriver
        if (!active)
        {
                qWarning("Close map action called when no widget is active in the workspace (fermerPlanOuImage - MainWindow.h)");
                return;
        }

        // On verifie pour le principe qu'il s'agit bien d'une CarteFenetre ou d'une Image
        if (active->objectName() != "CarteFenetre" && active->objectName() != "Image")
        {
                qWarning("not expected type of windows (fermerPlanOuImage - MainWindow.h)");
                return;
        }

        // Creation de la boite d'alerte
        QMessageBox msgBox(this);
        msgBox.addButton(QMessageBox::Yes);
        msgBox.addButton(QMessageBox::Cancel);
        msgBox.setIcon(QMessageBox::Information);
        msgBox.move(QPoint(width()/2, height()/2) + QPoint(-100, -50));
        // On supprime l'icone de la barre de titre
        Qt::WindowFlags flags = msgBox.windowFlags();
        msgBox.setWindowFlags(flags ^ Qt::WindowSystemMenuHint);
        // M.a.j du titre et du message
        if (active->objectName() == "CarteFenetre")
        {
                msgBox.setWindowTitle(tr("Close Map"));
                msgBox.setText(tr("Do you want to close this map?\nIt will be closed for everybody"));
        }
        else
        {
                msgBox.setWindowTitle(tr("Close Picture"));
                msgBox.setText(tr("Do you want to close this picture?\nIt will be closed for everybody"));
        }
        msgBox.exec();

        // Si l'utilisateur n'a pas clique sur "Fermer", on quitte
        if (msgBox.result() != QMessageBox::YesRole)
                return;

        // Emission de la demande de fermeture de la carte
        if (active->objectName() == "CarteFenetre")
        {
                // Recuperation de l'identifiant de la carte
                QString idCarte = ((CarteFenetre *)active)->carte()->identifiantCarte();

                // Taille des donnees
                quint32 tailleCorps =
                        // Taille de l'identifiant de la carte
                        sizeof(quint8) + idCarte.size()*sizeof(QChar);

                // Buffer d'emission
                char *donnees = new char[tailleCorps + sizeof(enteteMessage)];

                // Creation de l'entete du message
                enteteMessage *uneEntete;
                uneEntete = (enteteMessage *) donnees;
                uneEntete->categorie = plan;
                uneEntete->action = fermerPlan;
                uneEntete->tailleDonnees = tailleCorps;

                // Creation du corps du message
                int p = sizeof(enteteMessage);
                // Ajout de l'identifiant de la carte
                quint8 tailleIdCarte = idCarte.size();
                memcpy(&(donnees[p]), &tailleIdCarte, sizeof(quint8));
                p+=sizeof(quint8);
                memcpy(&(donnees[p]), idCarte.data(), tailleIdCarte*sizeof(QChar));
                p+=tailleIdCarte*sizeof(QChar);

                // Emission de la demande de fermeture de la carte au serveur ou a l'ensemble des clients
                emettre(donnees, tailleCorps + sizeof(enteteMessage));
                // Liberation du buffer d'emission
                delete[] donnees;

                // Suppression de la CarteFenetre et de l'action associee sur l'ordinateur local
                ((CarteFenetre *)active)->~CarteFenetre();
        }

        // Emission de la demande de fermeture de l'image
        else
        {
                // Recuperation de l'identifiant de la carte
                QString idImage = ((Image *)active)->identifiantImage();

                // Taille des donnees
                quint32 tailleCorps =
                        // Taille de l'identifiant de la carte
                        sizeof(quint8) + idImage.size()*sizeof(QChar);

                // Buffer d'emission
                char *donnees = new char[tailleCorps + sizeof(enteteMessage)];

                // Creation de l'entete du message
                enteteMessage *uneEntete;
                uneEntete = (enteteMessage *) donnees;
                uneEntete->categorie = image;
                uneEntete->action = fermerImage;
                uneEntete->tailleDonnees = tailleCorps;

                // Creation du corps du message
                int p = sizeof(enteteMessage);
                // Ajout de l'identifiant de la carte
                quint8 tailleIdImage = idImage.size();
                memcpy(&(donnees[p]), &tailleIdImage, sizeof(quint8));
                p+=sizeof(quint8);
                memcpy(&(donnees[p]), idImage.data(), tailleIdImage*sizeof(QChar));
                p+=tailleIdImage*sizeof(QChar);

                // Emission de la demande de fermeture de l'image au serveur ou a l'ensemble des clients
                emettre(donnees, tailleCorps + sizeof(enteteMessage));
                // Liberation du buffer d'emission
                delete[] donnees;

                // Suppression de l'Image et de l'action associee sur l'ordinateur local
                ((Image *)active)->~Image();
        }

A big step forward, the networking code has been reworked.
So the readability is improved. It is also possible to see the beginning of polymorphism. MediaContener is used but not everywhere.

QMdiSubWindow* subactive = m_mdiArea->currentSubWindow();
QWidget* active = subactive;
MapFrame* bipMapWindow = NULL;

if (NULL!=active)
{

    QAction* action=NULL;

    Image*  imageFenetre = dynamic_cast(active);

    QString mapImageId;
    QString mapImageTitle;
    mapImageTitle = active->windowTitle();
    bool image=false;
    //it is image
    if(NULL!=imageFenetre)
    {
        m_pictureList.removeOne(imageFenetre);

        mapImageId = imageFenetre->getMediaId();
        image = true;
        action = imageFenetre->getAction();
    }
    else//it is a map
    {
        bipMapWindow= dynamic_cast(active);
        if(NULL!=bipMapWindow)
        {
            mapImageId = bipMapWindow->getMediaId();
            action = bipMapWindow->getAction();

        }
        else// it is undefined
        {
            return;
        }
    }

    QMessageBox msgBox(this);
    msgBox.setStandardButtons(QMessageBox::Yes | QMessageBox::Cancel );
    msgBox.setDefaultButton(QMessageBox::Cancel);
    msgBox.setIcon(QMessageBox::Information);
    msgBox.move(QPoint(width()/2, height()/2) + QPoint(-100, -50));
    Qt::WindowFlags flags = msgBox.windowFlags();
    msgBox.setWindowFlags(flags ^ Qt::WindowSystemMenuHint);

    if (!image)
    {
        msgBox.setWindowTitle(tr("Close Map"));
    }
    else
    {
        msgBox.setWindowTitle(tr("Close Picture"));
    }
    msgBox.setText(tr("Do you want to close %1 %2?\nIt will be closed for everybody").arg(mapImageTitle).arg(image?tr(""):tr("(Map)")));

    msgBox.exec();
    if (msgBox.result() != QMessageBox::Yes)
        return;

    if (!image)
    {
        NetworkMessageWriter msg(NetMsg::MapCategory,NetMsg::CloseMap);
        msg.string8(mapImageId);
        msg.sendAll();

        m_mapWindowMap.remove(mapImageId);
        m_playersListWidget->model()->changeMap(NULL);
        m_toolBar->changeMap(NULL);
    }
    else
    {
        NetworkMessageWriter msg(NetMsg::PictureCategory,NetMsg::DelPictureAction);
        msg.string8(mapImageId);
        msg.sendAll();
    }

    MediaContainer*  mediaContener = dynamic_cast(subactive);
    if(NULL!=mediaContener)
    {
        CleverURI* cluri = mediaContener->getCleverUri();
        cluri->setDisplayed(false);
        if(NULL!=m_sessionManager)
        {
            m_sessionManager->updateCleverUri(cluri);
        }
    }

    delete action;
    delete subactive;
}

Version Intermédiaire

Then, we implements a solution to describe map, vmap (v1.8) or image as mediacontener.
They share a large part of their code, so it becomes really easy to do it.

QMdiSubWindow* subactive = m_mdiArea->currentSubWindow();
    MediaContainer* container = dynamic_cast(subactive);
    if(NULL != container)
    {
        CleverURI::ContentType type = container->getContentType();
        if(CleverURI::VMAP == type)
        {
            removeVMapFromId(container->getMediaId());
        }
        else if(CleverURI::MAP == type)
        {
            removeMapFromId(container->getMediaId());
        }
        else if(CleverURI::PICTURE == type )
        {
            removePictureFromId(container->getMediaId());
        }
    }

Actuel

Make your own slide show presentation in QML

To prepare my conference at Pas Sage En Seine [FR], a French hacking festival, I chose to write my slide presentation in QML.
It allows me to have better control and be free to do whatever I want (such as a timeline or any kind of animation).
Of course, That comes with a price. It is longer to do it that way but now I find some solutions. So, next time will be faster.

File hierarchy:

I preferred use QML through C++ Application. It provides more helpful feature, such as: the ability to make screenshots of your presentation at any time (useful as backup plan).
At the top level, you will found all C++ classes, project files and the main qml. Then, you will have a directory with all your pages and if it is required a directory with all your images.

├── cpphighlighter.cpp
├── cpphighlighter.h
├── deployment.pri
├── LICENSE
├── main.cpp
├── main.qml
├── pages
│   ├── 01_intro.qml
│   ├── 02_presentation.qml
│   ├── 03_jdr_et_rolisteam.qml
│   ├── 043_Exemple_code_1.qml
│   ├── 04_jdr_avantages_pb.qml
│   ├── 05_avantage_jdr_virtuel.qml
│   ├── 06_fonctionnalites_rolisteam.qml
│   ├── 07_rolisteam_debut.qml
│   ├── 08_Rolistik_a_Rolisteam.qml
│   ├── 10_frise_chronologique.qml
│   ├── 11_son_usage.qml
│   ├── 12_son_fonctionnement.qml
│   ├── 13_dice_parser.qml
│   ├── 14_themes_audio_3_pistes.qml
│   ├── 15_nouveaute_1_8.qml
│   ├── 16_projet_avenir.qml
│   ├── 17_reussites.qml
│   ├── 18_les_lecons.qml
│   ├── 19_objectif_rolisteam_libre.qml
│   ├── 20_FAQ.qml
├── pasSageEnSeine.pro
├── pasSageEnSeine.pro.user
├── qmlcontroler.cpp
├── qmlcontroler.h
├── qmlcontroler.ui
├── qml.qrc
├── README.md
├── rsrc
│   ├── all.png
│   ├── cc.png
│   └── chat.png

The C++ application

The main

It can be useful to see the state of the presentation and to read some extra notes about the current slide. To manage that, I wrote a small C++ application.
The first goal is to show the QML view, then add some features and communication between the QML view and the C++ window.

#include <QApplication>
#include <QQmlApplicationEngine>
#include "qmlcontroler.h"
#include <QQmlContext>
#include <QQuickTextDocument>

#include "cpphighlighter.h"

int main(int argc, char *argv[])
{
    QApplication app(argc, argv);

    QQmlApplicationEngine engine;

    engine.rootContext()->setContextProperty("ScreenW",1280);
    engine.rootContext()->setContextProperty("ScreenH",720);

    engine.load(QUrl(QStringLiteral("qrc:/main.qml")));

    QmlControler ctr;
    ctr.setEngine(&engine);

    return app.exec();
}

main.cpp

Really easy, it loads the main.qml from the resources management system provided by Qt. It defines the targeted resolution by setting two constant into QML word: ScreenW and ScreenH.

In this project, the QmlControler class is the C++ window which provides slide feedback and additional information.

Let’s take a look to it:

Feedback window

This window is really simple. It has two parts: On the left, there is a label which displays screenshot of the qml view, and the right part is a QTextArea which display any additional note about the current slide.

void QmlControler::currentPageHasChanged(int i)
{
    m_currentScreen = i;
    QImage img = m_window->grabWindow();

    if(img.isNull())
        return;

    static int count = 0;


    img.save(tr("screens/%1_screen.png").arg(++count,3,10,QChar('0')),"png");
    qDebug() << "screen shot save" << count;

    m_ratioImage = (double)img.size().width()/img.size().height();
    m_ratioImageBis = (double)img.size().height()/img.size().width();

    m_label->setPixmap(QPixmap::fromImage(img));

    if((i+1>=0)&&(i+1<m_commentData.size()))
    {
        ui->textEdit->setHtml(m_commentData.at(i+1));
    }
    resizeLabel();
}

Current slide has changed

When the current slide has changed, the c++ window is notified thought the slot currentPageHasChanged, The application gets screenshot of the qml view, save it as a file, display it thought the label, then it looks for data about the current slide into the model. If any, there are displayed in the textedit.

Saving screenshots into file allows you to create a pdf file as backup plan for your presentation.

$ convert *.png mypresentation.pdf

QML Application

Loader system.

For readability reason, it is easier to have each page into one qml file. The application has to load those pages in the right order. To reach this goal, we have to define the order. I did it thank to a data model inside the main.qml file.
The main.qml displays all pages as item of a pathview. All items are loaded from the qt resource management system.

ListModel {
            id: panelModel
            ListElement {
                name: "Intro"
                path: "01_intro.qml"
                time: 1
                next: "Présentation de Rolisteam"
            }

First item of the model.

A page is mainly defined by two data: name and path. The path is the name of the qml file.
All other data are here as help, the time has not been used.

Then, the loader does its job, the key lines are the following:

    PathView {
        id: view
        anchors.fill: parent
        model: panelModel
        highlightRangeMode:PathView.StrictlyEnforceRange
        snapMode: PathView.SnapOneItem
        delegate:  Loader {
             source: "pages/"+path
        }

Path View

To manage the table of contents, I added a listview with a model:

    ListView {
        id: listView1
        x: ScreenW*0.02
        y: ScreenH*0.3
        width: ScreenW/2
        height: ScreenH*0.2
        delegate: Item {
            width: ScreenW/2
            height: listView1.height/listView1.count
                Text {
                    color: view.currentIndex>=index ? "black" : "gray"
                    text: name
                    font.pointSize: ScreenH/48
                    anchors.verticalCenter: parent.verticalCenter
                    font.bold: true

                }
        }
        visible: view.currentIndex>0 ? true : false

        model: ListModel {
            ListElement {
                name: "Concepts"
                index:1
            }
            ListElement {
                name: "Chroniques"
                index:6
            }
            ListElement {
                name: "Logiciel"//système de build, code spécifique par OS.
                index:9
            }
            ListElement {
                name: "Bilan"
                index:15
            }
        }
    }

Table of contents in QML

Next slide

When you have many slides it can be helpful to have indication about the next one. I chose to display the title in the top-right corner. It was the easier way.

    Text {
        anchors.top: parent.top
        anchors.right: parent.right
        text: panelModel.get(view.currentIndex).next+">"
    }

Next slide

Design a page

Each page are independent but they are all based on the same pattern. In my case, they have a listview with model. Each item of the model is an point I should talk about it.

Each item has a index. The index is controlled with keyboard (down to increase, up to decrease). The page manages what is shown or hidden given the value of the index.

For example, the feature of dice alias has 10 as index. When the index page value becomes 10, the «Dice Alias» item is displayed with an animation. Then, at 11, I can show a screen shot about the dice alias. At 12, the screenshot disappears and another text is displayed.

Position and Size

To ensure that all items will be display at the proper position and size. I have based all computation on anchor or the screen size.

    Image {
        id: image1
        anchors.left: parent.left
        anchors.top: parent.top
        anchors.leftMargin: ScreenW*0.04
        fillMode: Image.PreserveAspectFit
        source: "qrc:/rsrc/Rolisteam.svg"
        width: ScreenW*0.2
    }

Display the logo at the right position and size.

Other way

There is a module that provides Items to create QML presentation. I don’t use it for this one but it may provide interesting things.

https://github.com/qt-labs/qml-presentation-system

Get the code

You are invited to clone the code at : https://github.com/obiwankennedy/pses

Convertir toutes les images (png) d’un dossier en niveaux de gris.

Bonjour,

Une petite commande pour créer des copies en niveaux de gris des images png du dossier courant.

for i in *.png; do name=`echo $i | awk -F '.' '{print $1}'`; convert $i -colorspace Gray $name-gray.png; done

Les copies portent le même nom que l’original avec le suffixe -gray.
Cela peut facilement être adapté pour des jpg ou autres formats d’images.

Définir le terminal par défaut dans Nautilus

Nautilus propose dans son menu contextuel d’ouvrir un terminal.

C’est très pratique mais parfois, nautilus préfère lancer xterm plutôt que gnome-terminal.

Si cela vous arrive; pas de panique. Les deux commandes suivantes peuvent vous aider.

gsettings set org.gnome.desktop.default-applications.terminal exec /usr/bin/gnome-terminal

gsettings set org.gnome.desktop.default-applications.terminal exec-arg '-x'

Il faut donc définir l’exécutable et ses arguments.

Introduction à Dbus avec Qt4

Dbus

Dbus est un bus système de messagerie. C’est un moyen simple pour des applications de communiquer entre elles. En plus de la communication interprocessus, Dbus est aussi un outil aidant au cycle de vie du processus. Il peut vous permettre de n’autoriser qu’une seule instance de votre application ou de votre daemon. Il peut vous permettre de démarrer votre application ou daemon à la demande quand elles sont nécessaires. Il est possible d’établir deux types de connexions: point à point ou point d’accès (daemon central). Grâce au daemon, vos applications peuvent être prévenues du branchement d’un nouvel composant matériel. Le bus de session (un par utilisateur connecté) est le canal générique de communication. Dbus est destiné à la communication entre application d’un même ordinateur. Il est cependant possible de communiquer par TCP/IP crypté avec un dossier home partagé par NFS. Ce genre d’usage reste rare et expérimental.

Il est possible d’utiliser Dbus dans de nombreux langages: C/C++, python, ruby, perl, java, C#. Je vais me concenter sur l’implémentation de Dbus dans Qt4, dans cet article.

Dbus dans Qt4

Qt4 implement sa propre API Dbus. Le support de Dbus sur windows étant en cours (d’après le site internet), Qt a été sage de regrouper toutes les fonctionnalités dans un module. Pour des environnements linux, il suffit d’installer la bibliothèque et à l’édition des liens, ajouter

QT += dbus

Dans le fichier pro pour inclure le module dbus à votre projet.

Les deux classes importantes sont QDbusMessage et QDbusInterface. La première permet d’envoyer facilement un message vers un service Dbus. C’est un moyen rapide pour communiquer une information vers une application dont vous ne maitrisez rien. Le QBusInterface permet une communication plus transparente, car tous les signaux/slots de votre application (d’une classe, pour être précis) seront mis sur Dbus.

Monitorer Dbus

Vous ne le savez peut-être pas mais votre système GNU/Linux (s’il est assez moderne) utilise probablement DBUS en continue. Pour se donner une idée, il existe deux utilitaires assez intéressant: dbus-monitor et qdbusviewer.

Connexion à un service : Pidgin

Nous allons maintenant implémenté une solution pour utiliser un service d’une application. Nous voulons mettre à jour la petite phrase de status de pidgin. Ainsi votre logiciel de lecture audio pourra mettre en petite phrase la chanson actuellement jouée.

La première étape est d’identifié la fonction (et son chemin) qui nous intéresse. En général, les logiciels libres fournissent dans leur documentation l’API dbus qu’ils offrent. Cependant, l’outil qdbusviewer vous permet de voir toutes ces informations.

En terme de code, cela reste très simple. Vous déclarez un message Dbus. Il faut définir les bonnes valeurs: chemin, destinataire, noms..

QDBusConnection sessionbus = QDBusConnection::sessionBus();

if ( !sessionbus.isConnected() )
{
    qDebug() << "Could not connect to session bus";
}
    QDBusMessage m = 
    QDBusMessage::createMethodCall("im.pidgin.purple.PurpleService",
                                   "/im/pidgin/purple/PurpleObject",
                                   "im.pidgin.purple.PurpleInterface",
                                   "PurpleUtilSetCurrentSong");
    QList<QVariant> args;
    args << m_p->Title << m_p->Artist << m_p->album;
    m.setArguments(args);
    QDBusMessage metadatamsg = sessionbus.call(m);
    if(metadatamsg.type() != QDBusMessage::ReplyMessage)
        qDebug() << "Error its not a message " << metadatamsg.type() << metadatamsg.errorMessage ();

Connexion à un service dbus

La première étape est de définir quel bus vous allez utiliser : le sessionBus ou le systembus? Dans notre cas, c'est le sessionBus. On verifie que tout se passe bien niveau connection au bus. Il convient ensuite de créer un message. Les paramètres du messages sont les suivants :

Le nom du service (la colonne de gauche de qdbusviewer)
Le chemin vers l'objet (concaténation de tous les noeuds de l'arbre sauf celui de l'interface).
Le chemin vers l'interface (noeud en italique dans qdbusviewer).
Une liste d'arguments peut être passée à l'appel de la méthode du service. Dans notre cas, nous passons le titre de la chanson, l'artiste et le nom de l'album.
Dernière étape, appel de la méthode suivit d'une vérification d'erreur.

La voie royale pour faire communiquer deux applications via dbus grâce à Qt est l'utilisation des adaptors. Ils traduisent les signaux et slots d'une classe Qt en message Dbus. C'est totalement transparent. Pour faire un exemple simple, je vais faire une application qui propose un service "dbus_example_Service", de définition de brigthness et les clients peuvent définir le nouveau de volume. Plusieurs applications peuvent envoyer le volume au service et elles peuvent également recevoir la brightness. Une seule et unique application peut faire office de service. Deux instance de l'application "dbus_example_Service" vont entrainé des comportements inconnus.

qdbuscpp2xml -S -M mainwindow.h -o org.homelinux.renaudguezennec.xml

qdbusxml2cpp -c GuiAdaptor -a guiadaptor.h:guiadaptor.cpp org.homelinux.renaudguezennec.xml

qdbusxml2cpp -c GuiAdaptor -p test.h:test.cpp org.homelinux.renaudguezennec.xml

La première commande vous permet de générer un fichier xml: org.homelinux.renaudguezennec.xml qui contiendra l'ensemble de l'API de votre fichier .h.
Le resultat est de la forme suivante:

<!DOCTYPE node PUBLIC "-//freedesktop//DTD D-BUS Object Introspection 1.0//EN" "http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd">
<node>
  <interface name="org.homelinux.renaudguezennec">
    <signal name="brightnessChanged">
      <arg type="i" direction="out"/>
    </signal>
    <method name="setVolumeLevel">
      <arg type="i" direction="in"/>
    </method>
  </interface>
</node>

Xml généré

La deuxième commande crée une classe GuiAdaptor (dans les fichiers: guiadaptor.h et guiadaptor.cpp) qui expose l'API d'écrire dans le xml. Cette classe sera utile coté service.

La troisième commande crée une classe GuiAdaptor (dans les fichiers: test.h et test.cpp) que sera capable de contacter l'API décrite dans le xml. Nous allons utiliser cette classe dans le client pour l'API décrite dans le xml.

L'étape suivante consiste à générer une classe Adaptor qui transformera vos signaux/Slots Qt en message dbus. Il est utilisé côté service. Dans le main de votre programme, il convient d'instancier un adaptor généré (ici: ControlPanelAdaptor), comme cela:

#include <QtGui/QApplication>
#include "mainwindow.h"
#include "guiadaptor.h"
int main(int argc, char *argv[])
{
    QApplication a(argc, argv);
    MainWindow w;
    new GuiAdaptor(&w);
    w.show();

    QDBusConnection connection = QDBusConnection::sessionBus();
    bool rel = connection.registerService("org.homelinux.renaudguezennec");
    rel = connection.registerObject("/",&w);

    return a.exec();
}

Creation de service

A ce stade, votre application peut-être un service dbus. Il fournit une API à travers DBus. Nous allons voir maintenant comment créer des clients qui vont utiliser cette API.

Nous allons donc construire un nouveau projet : dbus_example_client. Il contiendra la réciproque du service. Le service est capable d'envoyer le signal brightnessChanged et reçoit son volume par l'appel à setVolumeLevel. Le client lui sera capable d'appeler setVolumeLevel du service et de recevoir la valeur de brightnessChanged. Pour se faire, nous allons utilisé la class GuiAdaptor (test.h et test.cpp) dans notre application cliente.

#include <QtGui/QApplication>
#include "mainwindow.h"
#include "test.h"

int main(int argc, char *argv[])
{
   QApplication a(argc, argv);
   MainWindow w;

    GuiAdaptor* adapteur = new GuiAdaptor("org.homelinux.renaudguezennec", 
    "/",QDBusConnection::sessionBus(),0);

    QObject::connect(&w,SIGNAL(volumeChanged(int)),adapteur,
    SLOT(setVolumeLevel(int)));

    QObject::connect(adapteur,SIGNAL(brightnessChanged(int)),&w,
    SLOT(setBrightnessChanged(int)));
    w.show();

    return a.exec();
}

Client Qt

Comme vous pouvez le voir, il suffit d'instancier une classe GuiAdaptor (#include "test.h") et de connecter les signals et les slots de notre application avec cette instance. En l'occurence, notre application emet le signal volumeChanged(int), nous le lions au slot setVolumeLevel(int) de notre adapteur. Le signal émit par l'adapteur est récupéré dans un slot de notre application.

S’auto-héberger avec un serveur Fanless sur un système GNU/Debian.

Historique des versions

Version	Date	Auteur	Description
0.1 (draft)	22 Mars 2010	Renaud Guezennec	Montage d’un serveur fanless, installation système, déploiement des premiers services (ssh et apache2) et configuration réseau.

Introduction

Faire du vrai internet, c’est facile. Ce tutorial présente les étapes à effectuer. Vous comprendrez que vous en êtes pleinement capable:
Si vous savez lire, que vous êtes motivés et un minimum patient, vous y arriverez.

Pourquoi héberger son site soi-même? Pour des raisons d’indépendance: Je souhaite être la seule personne capable couper ma machine du réseau. Je veux savoir où sont stockés mes fichiers. Faite de votre internet un point intelligent du réseau.
N’utilisez pas internet comme un minitel 2.0.J’ai fais le choix de monter un serveur fanless (sans ventilateur), pour deux raisons principales:

Le bruit : un ordinateur qui est destiné à fonctionner 24h/24 doit être silencieux.
L’économie d’énergie : mes choix techniques sont principalement voués à réduire la consommation électrique de l’appareil. Il existe des solutions bien plus performante que ma solution de ce point de vue, là.

Matériel

Le matériel que j’ai choisi n’est pas vraiment la solution la plus économique. Il est vrai qu’essayer de monter un serveur fanless n’est pas encore très facile; j’espère ouvrir un peu la voie.
On arrive dans des domaines assez inconnus. C’est très rare de trouver des cartes mères passives.
Les boitiers ont souvent un petit ventillo pour l’alimentation ou les disques. J’ai aussi souhaité avoir une capacité en disque importante, cette condition élimine la plupart des solutions tout en un. Je n’avais pas envie d’avoir une boitier relier à un disque dur externe ou une clé USB. Cependant, sachez que ces solutions existent!

Je vous communique les références des différentes pièces que j’ai achetées.

Montage

Les pièces utiles:

le lecteur CD est vraiment optionnel, je n’en ai pas eu besoin.

La carte mère:

Le côté pratique, c’est que les cartes mères atom sont fournies avec le cpu déjà installé et sûrement soudé à la carte. L’installation en est plus facile mais ça empèche toute évolution matérielle par la suite.

le boitier:

Ce boitier est mal agencé, je trouve. Il est gros pour pas grand chose. Le support disque dur n’accueille qu’un disque alors qu’il y a la place d’en mettre bien plus. C’est d’ailleur ce que j’ai fait.

Installation de la carte mère:

La première chose à dire, c’est que le montage ce n’est pas facile. J’ai déjà monté pas mal d’ordinateurs. Celui-ci fut assez pénible. L’absence de documentation pour le boitier est vraiment un problème. La carte mère se colle directement sur le fond du boitier. Il n’y pas les habituelles chemises.

Les cables d’alimentations sont assez mal fichus. Ils sont trop long et surtout le socle du lecteur de CD gène énormément. Par chance, vous pouvez enlever les socles CD et disque. Faites-le pour vous dégager l’espace. Sans ça, le branchement des LED power/disque et des USB sera très compliqué. Pour les disques, j’ai branché le premier sur le socle prévu à cet effet. Le deuxième repose sur un lit de polystirène sous le premier.
Après plusieurs tentatives, ça ne démarré pas. J’ai débranché le lecteur CD, vérifié certains branchements puis il a enfin démarré.

Installation du système et des services

Je suis un fidèle du système de paquet DEB, créer par/pour la distribution debian. J’utilise Ubuntu pour mon poste de travail mais pour un serveur, une vraie debian est bien mieux [Ce n’est que mon avis].
Dans les autres distributions pour faire un serveur, je dirais que Gentoo me parait un bon choix. (Elle reste cependant assez compliqué au premier abord.)
Comment installe-t-on un système debian?

Télécharger les bons fichiers

J’ai installé Debian Lenny. Les images ont été téléchargées le 05/03/2010.
J’ai opté pour un installation assez exotique. Démarrer sur clé USB qui embarque une image iso minimale (netinst).

L’image à copier sur la clé s’appelle boot.img.gz
Une fois l’image téléchargée, il suffit de l’écrire sur votre clé usb (attention, ça écrasera tout le reste) par la commande:

# zcat boot.img.gz /dev/sdX

(La commande sudo ne marche pas. Faite-le en root! C’est surement une histoire de droit de l’utilisateur sur les périphériques).

Montez la clé:

# mount /dev/sdX /mnt

Deux images peuvent être utilisées: la “netinst” et la “businesscard”. J’ai choisi la netinst, elle est très légère, l’installation est très minimaliste (à condition de choisir les bonnes options), cependant le système doit être sur internet pour l’installation.

Pour télécharger l’image netinst :

debian-504-i386-netinst.iso
Copier l’image dans la clé:

# cp /chemin/vers/image/iso/debian-504-i386-netinst.iso /mnt/

Installer sa GNU/Debian

Démarrer l’installation, rien de plus facile. Il suffit de brancher la clé usb puis de démarrer la machine. On voit la still picture (le logo du fabriquant de la carte mère). Vint, en suite, l’écran de choix de la langue de l’installateur debian.

J’ai choisi anglais en langue et un clavier français. Après cet écran, le mini système GNU/Linux cherchera sur la clé installéei, l’image iso à utiliser. L’installeur vous demandera de définir les partitions. J’ai crée deux partitions sur le premier disque: le swap et le point de montage / . Mon swap fait 20 go, ça devrai être suffisant. Le deuxième disque est monté sur /home. Après l’étape des disques, il faudra choisir le type d’installation. Par défaut, la version desktop est sélectionné. J’ai choisi l’installation du strict minimum. Il vous posera des questions pour définir le mot de passe root et le login/password de votre utilisateur.

A l’aboutissement de l’installation, vous redémarrez l’ordinateur en débranchant la clé usb. Maintenant, votre ordinateur est fonctionnel. Nous pouvons lui installer les services et outils nécessaires pour le transformer en vrai serveur.

Installation des premiers services

Le service des services, le premier pas du voyage, c’est le serveur SSH. Afin d’administer son serveur à distante, plus besoin d’écran et de clavier. Ensuite, apache2 le serveur web, l’arme noble pour l’expression de vos libertés. PHP5 pour créer des sites coté serveur. Vim, l’éditeur en ligne de commande que je préfère. Le serveur mysql avec son support php afin d’utiliser une base de données pour vos sites. En dernier lieu, php5-gd c’est un module assez utile pour php.

# apt-get install openssh-server
# apt-get install apache2
# apt-get install php5
# apt-get install vim
# apt-get install mysql-server php5-mysql
# apt-get install php5-gd

Sécurisation des premiers services

Configuration ssh server (la base d’une bonne sécurité)

Editer en root, le fichier /etc/ssh/sshd_config.
Changer le port par défaut (22) par un port quelconque. C’est une sécurité contre les attaques de force brute:
Port 22 en Port 9999
vous pouvez prendre n’importe quelle valeur comprise entre 1024 et 65536. (plus d’info)
Désactiver l’autorisation de login en root directement. Cela augmente la complexité pour forcer le passage. Les méchants devront trouver votre login et mot de passe. De plus, il est plus propre de se connecter en tant qu’utilisateur normal.
PermitRootLogin yes en PermitRootLogin no
Cette option est pour les utilisateurs avancés. Il vous faudra mettre dans votre serveur une clé ssh. Cela rend l’authentification plus sûre.
PasswordAuthentication yes en PasswordAuthentication no

Voici une copie de mon fichier de configuration:

# Package generated configuration file
# See the sshd(8) manpage for details

# What ports, IPs and protocols we listen for
Port 999
# Use these options to restrict which interfaces/protocols 
# sshd will bind to
#ListenAddress ::
#ListenAddress 0.0.0.0
Protocol 2
# HostKeys for protocol version 2
HostKey /etc/ssh/ssh_host_rsa_key
HostKey /etc/ssh/ssh_host_dsa_key
#Privilege Separation is turned on for security
UsePrivilegeSeparation yes

# Lifetime and size of ephemeral version 1 server key
KeyRegenerationInterval 3600
ServerKeyBits 768

# Logging
SyslogFacility AUTH
LogLevel INFO

# Authentication:
LoginGraceTime 120
PermitRootLogin no
StrictModes yes

RSAAuthentication yes
PubkeyAuthentication yes
#AuthorizedKeysFile	%h/.ssh/authorized_keys

# Don't read the user's ~/.rhosts and ~/.shosts files
IgnoreRhosts yes
# For this to work you will also need host keys
# in /etc/ssh_known_hosts
RhostsRSAAuthentication no
# similar for protocol version 2
HostbasedAuthentication no
# Uncomment if you don't trust ~/.ssh/known_hosts 
# for RhostsRSAAuthentication
#IgnoreUserKnownHosts yes

# To enable empty passwords, change to yes (NOT RECOMMENDED)
PermitEmptyPasswords no

# Change to yes to enable challenge-response passwords
# (beware issues with some PAM modules and threads)
ChallengeResponseAuthentication no

# Change to no to disable tunnelled clear text passwords
PasswordAuthentication no

# Kerberos options
#KerberosAuthentication no
#KerberosGetAFSToken no
#KerberosOrLocalPasswd yes
#KerberosTicketCleanup yes

# GSSAPI options
#GSSAPIAuthentication no
#GSSAPICleanupCredentials yes

X11Forwarding no
X11DisplayOffset 10
PrintMotd no
PrintLastLog yes
TCPKeepAlive yes
#UseLogin no

#MaxStartups 10:30:60
#Banner /etc/issue.net

# Allow client to pass locale environment variables
AcceptEnv LANG LC_*

Subsystem sftp /usr/lib/openssh/sftp-server

UsePAM yes

Connexion & réseau

L’auto-hébergement nécessite certaines conditions à propos de votre connexion internet. Elle ne sont pas obligatoire mais cela facilite grandement la vie. Il faut une connexion en continue: type adsl ou (encore mieux) fibre optique, éviter les contrats limités à un volume de données transmis. Personnellement, je n’ai jamais utilisé les “machinBox”. Préférant acheter un modem/routeur configurable: j’utilise le Netgear DG834G et le Netgear DGN2000. Je suis très content de ses deux modèles. Il est facile d’ouvrir les ports et rediriger vers telle ou telle machine. Le contrôle du DHCP permet une gestion élégante de votre réseau LAN.

Hypothèse: vous avez deux machines différentes dans votre LAN réliée à un routeur/modem.

La première des choses à faire est de s’assurer que le serveur recevra toujours la même ip au sein du réseau LAN. Pour cela, il y a deux possibilités:

IP fixe dans le LAN
Utilisation d’un serveur DHCP bien configuré

Je déconseille la première solution. Elle nécessite la configuration de chaque poste, une mauvaise configuration peut entrainé des conflits d’adresse IP. De plus, l’ajout d’une nouvelle machine vous obligera à configurer celle-ci.
La 2ème méthode est plus souple. Votre routeur/modem donne l’adresse IP pour chaque machine et pour fixer les adresses IP, il se fonde sur les adresses MAC.
L’adresse MAC est une sorte de numéro d’immatriculation de votre carte réseau. Il est “normalement” unique au monde. (Dans les faits, il peut être changer logiciellement donc…)
Il est donc possible d’obliger votre modem/routeur à donner l’adresse 192.168.0.3 à votre serveur, l’adresse 192.168.0.2 à votre pc de bureau et de spécifier que pour toutes autres machines, la plage 192.168.0.10 à 192.168.0.120 doit être utilisé.
Pour éviter les problèmes, je vous conseillerais de désactiver le Wi-Fi de votre réseau. Ce n’est pas une technologie très sûre.

La machine serveur reçoit toujours la même ip ? Il est temps de passer à la redirection des ports. Les 1024 premiers ports sont réservés à des usages définis. Par exemple, le port standard d’un serveur http est le 80: www.trucmuche.org et www.trucmuche.org:80 sont strictement identiques dans un navigateur.
Quelques autres ports/protocoles à connaitre (ou pas):

https: 440
FTP: 20 et 21
ssh: 22
smtp(mail) : 25
DNS: 53

Nous voulons rendre accessible notre serveur sur la toile. Le port 80 doit renvoyer vers l’ip du serveur. Toutes les demandes sur le port 80 à l’adresse: 80.80.80.80 seront transmises vers l’ip 192.168.0.3.
La même chose doit être faite pour chaque service qui tourne sur votre serveur et que vous voulez accessible depuis l’extérieur. Le ssh, par exemple, est maintenant sur le port 9999. Parametrez votre routeur/modem afin d’acheminer les connexions sur le port 9999 vers votre serveur. Pour réaliser le chapitre suivant, la redirection du port 53 est nécessaire.

Dynamique Name Server

C’est une partie que je maitrise moins. Je vais donc expliquer ce que j’ai compris. Vous avez acheté un nom de domaine: trucmuche.org. vous voudriez maintenant qu’il pointe vers votre serveur homemade dans votre placard? Il y a en gros, deux solutions: Gérer son DNS à la maison. ou le faire gérer par quelqu’un d’autre (probablement votre FAI ou votre registar).
Le premier cas est la solution la plus éducative et la plus souple: Si vous avez choisi cette option (comme moi), il faut installer bind9. Bind est le soft qui fait marcher internet. Il est le serveur DNS. Les DNS traduisent un nom de domaine en adresse ip.

Pour l’installer:

# apt-get install bind9

La configuration est bien plus complexe. Etudiont d’abord, la hiérarchie des fichiers de configuration.

homemade:~# ls -l /etc/bind/
total 48
-rw-r--r-- 1 root root  237 2009-12-20 21:21 db.0
-rw-r--r-- 1 root root  271 2009-12-20 21:21 db.127
-rw-r--r-- 1 root root  237 2009-12-20 21:21 db.255
-rw-r--r-- 1 root root  353 2009-12-20 21:21 db.empty
-rw-r--r-- 1 root root  270 2009-12-20 21:21 db.local
-rw-r--r-- 1 root root 2878 2009-12-20 21:21 db.root
-rw-r--r-- 1 root bind  907 2009-12-20 21:21 named.conf
-rw-r--r-- 1 root bind  240 2010-03-17 21:24 named.conf.local
-rw-r--r-- 1 root bind  572 2010-03-17 21:50 named.conf.options
-rw-r----- 1 bind bind   77 2010-03-17 21:05 rndc.key
-rw-r--r-- 1 root root 1317 2009-12-20 21:21 zones.rfc1918

Les fichiers de forme db.* sont des fichiers de configuration de zone dns; (nous verrons dans quelques instants, comment créer la zone pour trucmuche.org). Le fichier named.conf.options est le fichier de configuration du serveur. named.conf ne doit pas être modifier enfin sauf si vous êtes un super expert de la mort qui tue. Il convient de modifier named.conf.local pour ajouter notre zone.

Déclarons une zone sous la responsabilité de notre dns.

zone "trucmuche.org" {
	type master;
	file "/etc/bind/db.trucmuche.org";
};

Il y a deux type de zone: master (primaire) et slave (secondaire). Un nom de domaine est forcément attaché, au minimum, à deux serveurs dns: un seul primaire et un (ou plusieurs) secondaire. Le serveur primaire fait loi, les secondaires se mettront à jour par rapport à lui. Créer un fichier, /etc/bind/db.trucmuche.org Il doit contenir ceci:

$ORIGIN trucmuche.org.
$TTL 3h
@       IN      SOA     ns.trucmuche.org. gamemaster.trucmuche.org. (
                                2010031703
                                8H
                                2H
                                1W
                                1D )

@       	IN  NS  ns.trucmuche.org.

@       	IN  MX  10   mail2.trucmuche.org.

@  			IN	A	80.80.80.80


ns			IN	A	80.80.80.80
mail2   	IN	A   80.80.80.80
wiki    	IN	CNAME	trucmuche.org.
forum       IN  CNAME   trucmuche.org.
www         IN  CNAME   trucmuche.org.
};

La première ligne n’est pas importante, elle définit une variable à l’intérieur pour faciliter l’écriture du fichier de conf. Le TTL est le temps de valider des informations de votre zone. Il convient de définir une zone SOA.

2010031703 : Serial sorte de numero de version de la configuration, on utilise en général la date du jour plus un champ 00 qu’on incrémente à chaque modification.
8H : Rafraichissement: le serveur secondaire se mettra à jour en respectant ce temps ci.
2H : retry : temps d’attente avant de réessayer quand une requête de mise à jour à échouer.
1W : Expire : Temps après lequel la zone est gelée si les dns secondaire ne peuvent se mettre à jour.
1D : Semblable à TTL.

@ IN NS ns.trucmuche.org.
Vous définissez le serveur de nom (DNS) qui définit la zone courante.
@ IN MX 10 mail2.trucmuche.org.
Vous définissez le serveur de mail principal de votre domaine.
@ IN A 80.80.80.80
Vous définissez l’ip principale de votre domaine, N’oubliez pas remplacer 80.80.80.80 par votre ip fixe.

ns 		IN	A   80.80.80.80
mail2   	IN	A   80.80.80.80

Définition des adresses ip pour votre serveur de nom et courriel.

wiki    	IN	CNAME	trucmuche.org.
forum       IN  CNAME   trucmuche.org.
www         IN  CNAME   trucmuche.org.

Définition de sorte d’alias, ainsi {wiki,forum,www}.trucmuche.org pointeront vers trucmuche.org. C’est apache (le serveur web) qui fera l’aiguillage.

Configuration Apache

Introduction

Apache, le serveur web du monde libre, le support de votre liberté d’expression, votre megaphone du web. Pour le rendre fonctionnel et l’adapter à vos besoins, il est important de le configurer.
Les dossiers de configuration d’apache se trouve dans l’arboréscence /etc/apache2/

-rw-r--r-- 1 root root 10104 2009-11-14 21:20 apache2.conf
drwxr-xr-x 2 root root  4096 2010-03-05 23:24 conf.d
-rw-r--r-- 1 root root   378 2009-11-14 21:20 envvars
-rw-r--r-- 1 root root    21 2010-03-07 12:59 httpd.conf
drwxr-xr-x 2 root root  4096 2010-03-05 23:24 mods-available
drwxr-xr-x 2 root root  4096 2010-03-07 14:42 mods-enabled
-rw-r--r-- 1 root root   513 2009-11-14 21:20 ports.conf
drwxr-xr-x 2 root root  4096 2010-03-19 00:04 sites-available
drwxr-xr-x 2 root root  4096 2010-03-19 00:05 sites-enabled

Dans l’ordre, le fichier apache2.conf définit la configuration vitale du serveur. Il est déconseillé d’y toucher.
Ce fichier définit le comportement par défaut du serveur: nombre de thread, les chemins et/ou nom de fichier pour modifier la configuration localement.
Le dossier conf.d contient des fichiers de configurations pour des points très spécifique d’apache.
envvars définit des variables d’environnements, présentement, le groupe et l’utilisateur sous lequel apache2 tourne. (Par défaut, www-data)

httpd.conf est partiquement vide. Nous allons utiliser des virtualhosts donc ce fichier ne présente plus beaucoup d’intérêt.
mods-available est un dossier regroupeant les fichiers de conf des modules disponibles pour apache. Un module permet d’étendre les fonctionnalités d’apache. Php est intégré dans apache sous la forme de module. Le support du ssl est aussi un module, il en existe beaucoup et vous pouvez même créer le votre, si cela vous intéresse.mods-enabled regroupe des liens symboliques vers les fichiers de configuration du module présents dans mods-available. Il faut bien comprendre qu’un module présent dans mods-available regroupe les modules activables et mods-enabled regroupe les modules activés. Pour activer un module, il suffit de placer les fichiers du module dans le dossier mods-enabled.

Dans le même principe, les dossiers sites-available et sites-enabled sont réspectivement le dossier des sites internet disponibles et le des sites internet actifs. Là encore, il est bon de créer un fichier de configuration dans available et d’ajouter un lien dans enabled. Nous verrons dans la partie virtuals hosts, comment configurer son site ou plutôt ses sites.

Utilisateur et droit

Il y a plusieurs moyens de gérer un serveur apache au niveau des droits. Cela dépend beaucoup de votre utilisation et de votre philosophie. Les différents choix:

Le cas #1

La situation la plus facile. Vous n’avez pas d’accès à ouvrir. Vous pouvez coder/mettre à jour votre site par ssh. Vous n’aurais pas besoin de FTP.
Je vous conseille de créer un dossier “trucmuche” dans /home/toto. Votre utilisateur (toto) aura tous les droits sur votre futur site et apache sera limité.
Render l’utilisateur www-data membre du groupe toto. Pour cela, éditer le fichier /etc/group comme ceci.

# vi /etc/group

Ajouter www-data à la fin de la ligne toto:

toto:x:1000:www-data

Assurez-vous que le groupe toto ait les droits de lecture sur l’ensemble des sous-dossiers et fichiers présents dans /home/toto/trucmuche. Si vous voulez permettre à votre site uploader des fichiers, le serveur aura besoin des droits en écriture sur le répertoire de destination. C’est un effort de codage sur votre site. Cette configuration est propre et minimaliste.

Si cette vision vous convient sauter directement à la section Cas 1 : virtual host
Si vous cherchez une solution plus puissante et moins minimaliste, vous pouvez lire les sections suivantes.

Le cas #2

C’est déjà plus risqué. Je vous conseillerais de créer un utilisateur webmaster et de créer un dossier dans /home/webmaster/ par site web: [/home/webmaster/www,/home/webmaster/wiki,/home/webmaster/forum]. En termes de droits, il suffit de rendre www-data membre du groupe webmaster:

# vi /etc/group

Ajouter www-data à la fin de la ligne webmaster:

webmaster:x:1001:www-data

Si vous déployez des outils libres, comme un CMS, un wiki et un forum. Il vous suffira de créer des comptes administrateurs dans ces outils.
Si vous voulez donner un accès plus direct. Il est possible de mettre en place un FTP ou bien de donner les identifiants de webmaster.
[Il est encore plus intelligent de créer un utilisateur pour chaque “élu” et de rendre ces utilisateurs membre du groupe webmaster. Les fichiers devront être modifiable par les membres du groupe. Cependant, il vous sera plus facile de connaitre l’identité d’une personne responsable d’une bétise/erreur].

Si cette description répond à votre besoin aller directement à la section Cas 2 : virtual host

Le cas #3

Le plus complèxe des trois à mettre en place. Vous voulez que chaque utilisateur dispose d’un dossier particulier dans leur home (html_public ou www). Ils auront un accès direct au serveur par ssh ou FTP. Chaque utilisateur aura une base de données. Ce cas est assez fréquent dans les universités et/ou hébergeurs. Pour des raisons de sécurités, je vous conseillerais de ne pas donner d’accès ssh.

Cette configuation est relativement complexe, je vous conseillerais de jouer un peu avec les cas précédents. Afin de bien, vous faire la main sur les fichiers de configuration apache et autres.

La gestion des droits est délicate. Il y a plusieurs approches:

Rendre tout le monde membre du groupe d’apache [www-data]
l’opposé; n’ajouter personne mais les fichiers devront être accessible en lecture pour tous le monde.
Le troisième cas, éxécuter apache avec les droits d’un autre utilisateur (voir la section Cas 3 : virtual host)

les virtuals hosts

Ces cas typiques sont des exemples. N’hesitez pas à mélanger les solutions techniques.

Un site unique (cas 1)

La première chose à faire est de créer un dossier dans votre home /home/toto/monsite/.

$ mkdir /home/toto/monsite

Il faut ensuite créer un lien de

/var/www/

vers

/home/toto/monsite/

. Pour cela, tapez la commande suivante dans un terminal (root):

# cd /var/www
# ln -s /home/toto/monsite site

N’oubliez pas de vérifier les droits du groupe.

Ouvrez le fichier /etc/apache2/site-enabled/000-default pour y mettre ceci :
[Les lignes commençant par # sont des commentaires, je les utilise pour expliquer]

<VirtualHost 192.168.0.3:80>
    ServerAdmin toto@trucmuche.org
    ServerName trucmuche.org

    DocumentRoot /var/www/site1/
    #nous définissons le dossier racine du site.
    <Directory /var/www/site1>
        Options Indexes FollowSymLinks
        # Indexes : autorise apache à générer des indexes.
        # nous autorisons apache à suivre les liens symboliques. 
        # Important car /var/www/site1/ est un lien symbolique 
        # vers /home/toto/monsite/
        AllowOverride All
        # Nous autorisons Apache à changer sa configuration 
        # si un fichier .htaccess existe dans le dossier 
        # /var/www/site1
        Order allow,deny
        # Ordre de description des règles
        allow from all
        # Autorise tout le monde 
        # (pas besoin de règle d'interdiction)
        # Vous pouvez ajouter une plage d'ip interdite 
        # avec une ligne du genre Deny from XXX.XXX.XXX.XXX/XXX 
    </Directory>

    
    ErrorLog /var/log/apache2/error.log

# Possible values include: debug, info, notice, warn, error, crit,
# alert, emerg.
    LogLevel warn

    CustomLog /var/log/apache2/access.log combined
    ServerSignature On

     # Configuration par défaut des logs
     # A savoir: 
     # Niveau de log: avertissement (warm). 
     # [debug, info, notice, warn, error, crit]
     # Fichier d'enregistrement des logs dans:
     # /var/log/apache2/access.log 
     # La signature du serveur est activée.


    
    Alias /phpMyAdmin/ "/var/www/phpMyAdmin/"
    <Directory "/var/www/phpMyAdmin/">
        AllowOverride None
        Order allow,deny
        Deny from all
        Allow from 192.168.0.0/24 
        #on restrint l'accès au gestionnaire de base de données.
        #Seule les adresses de type 192.168.0.XXX seront acceptées. 
    </Directory>
    
</VirtualHost>

Un gros site avec sous-domaine (cas 2)

Je vais prendre, dans cet exemple, trois sous-domaines : www, wiki et forum qui afficheront respectivement la page principale du site, un wiki et un forum. La première étape consiste à créer 3 fichiers de configuration dans /etc/apache2/sites-available (en root).

# cd /etc/apache2/sites-available
# touch wiki.trucmuche.org
# touch forum.trucmuche.org
# touch www.trucmuche.org

Il convient ensuite d’installer les différents logiciels. A titre d’exemple, je vous explique la marche à suivre pour installer mediawiki, fluxbb et drupal.

Positionnez-vous, d’abord, dans le répertoire de votre utilisateur webmaster (Il faut être l’utilisateur webmaster).
Téléchargement des logiciels et installation:

$ cd /home/webmaster
$ wget http://download.wikimedia.org/mediawiki/1.15/mediawiki-1.15.1.tar.gz
$ wget http://fluxbb.org/download/releases/1.4-rc1/fluxbb-1.4-rc1.tar.gz
$ wget http://ftp.drupal.org/files/projects/drupal-6.16.tar.gz

$ tar -xzvf drupal-6.16.tar.gz
$ mv drupal-6.16/ drupal

$ tar -xzvf fluxbb-1.4-rc1.tar.gz
$ mv fluxbb-1.4-rc1/ forum

$ tar -xzvf mediawiki-1.15.1.tar.gz
$ mv mediawiki-1.15.1/ wiki

Après cette étape, vous devriez avoir les dossiers : wiki, forum et drupal dans /home/webmaster
Il faut maintenant faire la configuration du serveur apache pour qu’il aille chercher les fichiers au bon endroit.
Commençons par drupal (qui sera www.trucmuche.org): Éditez le ficher : /etc/apache2/sites-available/www.trucmuche.org qui est normalement vide.

<VirtualHost *:80>
	ServerName www.trucmuche.org
    #definition du sous-domaine
	ServerAdmin webmaster@trucmuche.org
	
	DocumentRoot /var/www/webmaster/drupal
	<Directory /home/www/webmaster/drupal>
		Options Indexes FollowSymLinks MultiViews
		AllowOverride All
		Order allow,deny
		Allow from all
	</Directory>
	ErrorLog /var/log/apache2/error.log
	LogLevel warn
	CustomLog /var/log/apache2/trucmuche/trucmuche.log combined
    # Nous spécialisons le log de sortie pour clarifier les logs.
</VirtualHost>

Il faut faire la même chose pour le wiki et le forum:

<VirtualHost *:80>
	ServerName wiki.trucmuche.org
	ServerAdmin webmaster@trucmuche.org
	
	DocumentRoot /var/www/webmaster/wiki
	<Directory /home/www/webmaster/wiki>
		Options Indexes FollowSymLinks MultiViews
		AllowOverride All
		Order deny,allow
		Deny from all
		Allow from 127.0.0.0/255.0.0.0 ::1/128			
	</Directory>
	ErrorLog /var/log/apache2/error.log
	LogLevel warn
   CustomLog /var/log/apache2/trucmuche/wiki.trucmuche.log combined
</VirtualHost>

<VirtualHost *:80>
	ServerName forum.trucmuche.org
	ServerAdmin webmaster@trucmuche.org
	
	DocumentRoot /var/www/webmaster/forum
	<Directory /home/www/webmaster/forum>
		Options Indexes FollowSymLinks MultiViews
		AllowOverride All
		Order deny,allow
		Deny from all
		Allow from 127.0.0.0/255.0.0.0 ::1/128			
	</Directory>
	ErrorLog /var/log/apache2/error.log
	LogLevel warn
CustomLog /var/log/apache2/trucmuche/forum.trucmuche.log combined
</VirtualHost>

Pour finaliser la configuration, il faut créer des liens symboliques dans /etc/apache2/sites-enabled/

# cd /etc/apache2/sites-enabled/
# ln -s ../sites-available/forum.trucmuche.org forum.trucmuche.org
# ln -s ../sites-available/wiki.trucmuche.org wiki.trucmuche.org
# ln -s ../sites-available/www.trucmuche.org www.trucmuche.org

L’usine à site (cas 3)

Je ne donnerai pas de fichier de configuration Apache dans cette section. Je vous conseillerais de regarder du côté des hotes virtuels dynamiques et/ou de la commande suEXEC.

Activer et configurer certains modules : url_rewrite et php5.

Les modules url_rewrite et php sont très utilisés. Ils apportent des fonctionnalités bien appréciables.
Pour les activer, il suffit de faire un lien de leurs fichiers de mods-available vers mods-enabled. [Il est possible qu’ils soient déjà activés par défaut.]

# cd /etc/apache2/mods-enabled/
# ln -s ../mods-available/php5.load php5.load
# ln -s ../mods-available/php5.load php5.conf
# ln -s ../mods-available/rewrite.load rewrite.load

Si vous voulez jouer avec la configuration de php5: éditer le fichier /etc/php5/apache2/php.ini.
Pour utiliser url_rewrite, il suffit d’activer le mode rewrite dans un .htaccess en spécifiant les règles de réécriture.

Installer une solution mail: Smtp + imap + spamAssassin

Section en cours d’écriture.

Script de sauvegarde & crontab

Il est important d’assurer la pérénité de ses données. C’est pourquoi, il est très fortement conseillé de mettre, en production, un serveur uniquement si un système de sauvegarde et restauration est fonctionnel. Les éléments à mettre dans une sauvegarde sont:

La hiérarchie de dossiers et fichiers du site/des sites
Un dump des bases de données
Les fichiers de configuration (si vous estimez que les modifications sont importantes)
Le dossier /home (dans le cas ou des utilisateurs ont des données autres que leur site web.)

#!/bin/sh
HOST='ftp.somewhere.fr'
USERFTP='toto@somewhere.fr'
USER=toto
PASSWDFTP='bidule'
PASSWDSQL='bidule'
DATE=`date +%d`
DRUPALFILE=/home/$USER/script/backup-drupal-file-$DATE.sql
WIKIFILE=/home/$USER/script/backup-wiki-file-$DATE.sql
FORUMFILE=/home/$USER/script/backup-forum-file-$DATE.sql

ARCHIVE=/home/$USER/monsite-$DATE.tar.gz
#tar le dossier /home/toto/monsite
tar -czvf $ARCHIVE /home/$USER/monsite


#dump de postgresql 
export PGPASSWORD=passwordPostgresql
pg_dump -f $DRUPALFILE -U $USER drupal 

#dump de mysql 
mysqldump --set-charset  -u $USER -p$PASSWDSQL wiki > $WIKIFILE
mysqldump --set-charset  -u $USER -p$PASSWDSQL forum > $FORUMFILE



ftp -n $HOST <<END_SCRIPT
quote USER $USERFTP
quote PASS $PASSWD
send $DRUPALFILE backup_drupal_$DATE.sql
send $WIKIFILE backup_wiki_$DATE.sql
send $FORUMFILE backup_forum_$DATE.sql
send $ARCHIVE monsite-$DATE.tar.gz

quit
END_SCRIPT
exit 0

Voilà, un exemple de script de sauvergarde. Il exporte deux bases de données mysql et d’une postgresql dans des fichiers .sql. Il fait aussi une archive du dossier /home/toto/monsite. Tous les fichiers ont le numero du jour du le mois (Ca fait une rotation de sauvegarde de 30 jours en moyennes). Les sauvegardes sont envoyer par FTP sur un autre serveur. Bien entendu, rien ne vous empêche d’améliorer ça. Vous trouverez des multitudes de scripts pour vous aider.
Il faut ensuite executer ce script de façon régulière. Crontab est là pour vous sauver. Tapez la commande suivantes pour ajouter une règle.

# crontab -e

Ajouter la ligne suivante dans le fichier.

0 0 * * * sh /home/toto/script/sauvegarde.sh

La sauvegarde se fera tous les jours à minuit.

Foire Aux Questions

Mon serveur semble ne pas marcher à l’extérieur de mon réseau local.

Vérifiez bien la configuration de votre routeur. Les connexions entrantes sur le port 80 (http) doivent être redirigées vers votre serveur.

Je n’arrive pas à uploader des fichiers.

C’est probablement un problème de droit en écriture sur le serveur. Apache doit pouvoir écrire dans le répertoire de partage choisi. (chmod g+w et chown user:www-data)

Plus d’informations

Des questions ou des commentaires ?
Site officiel de la fondation Apache
Site officiel du projet Apache HTTP Server
La documentation Apache
La documentation Debian
Bibliographie: Apache 2.0 Guide de l’administrateur Linux: Charles Aulds – EYROLLES

Cerfication Qt

j’ai obtenu ma certification Qt : (Qt Essentials).

Je décris vite fait l’examen:
-50 questions à choix multiples.
-1h pour le faire + 30 mins, si vous êtes dans un pays dont la langue officielle n’est pas l’anglais.
– Prix: 140 € si ma mémoire est bonne. (75 € si vous voulez le repasser après un échec)

Je suis sûr d’avoir réussi 40 questions, j’ai des doutes sur les 10 autres. C’était souvent des questions ou il y avait plusieurs réponses demandées, j’en avais souvent une de sûre mais de sérieux doutes pour les autres. Cela ne m’a pas empêché de réussir.

Je suis donc officiellement “Nokia Certified Qt Developer”.

Mon besoin

L’aléatoire

L’existant

Les défauts

#include <random>

Le std::random_device

Le std::mt19937

Autres méthodes:

Conclusion:

Les sources:

Prédicat de base:

Pour GNU/Linux :

Pour Windows:

Trouver tous les éléments

Et après ?

Publication

Pour Mac OS:

Et après ?

Conclusion

Le contenu de la présentation QML:

L’application C++

le fichier main.cpp

La fenêtre d’aperçu

L’application QML

Le système de chargement (Loader)

Ajouter un sommaire

Page suivante

Créer une Page de présentation QML

Position et taille

Autre piste

Obtenir le code de mes présentations

The function evolution…

File hierarchy:

The C++ application

The main

Feedback window

QML Application

Loader system.

Table of Contents

Next slide

Design a page

Position and Size

Other way

Get the code

Dbus

Dbus dans Qt4

Monitorer Dbus

Connexion à un service : Pidgin

Historique des versions

Introduction

Matériel

Montage

Les pièces utiles:

La carte mère:

le boitier:

Installation de la carte mère:

Installation du système et des services

Télécharger les bons fichiers

Installer sa GNU/Debian

Installation des premiers services

Sécurisation des premiers services

Configuration ssh server (la base d’une bonne sécurité)

Connexion & réseau

Dynamique Name Server

Configuration Apache

Introduction

Utilisateur et droit

Le cas #1

Le cas #2

Le cas #3

les virtuals hosts

Un site unique (cas 1)

Un gros site avec sous-domaine (cas 2)

L’usine à site (cas 3)

Activer et configurer certains modules : url_rewrite et php5.

Installer une solution mail: Smtp + imap + spamAssassin

Script de sauvegarde & crontab

Foire Aux Questions

Mon serveur semble ne pas marcher à l’extérieur de mon réseau local.

Je n’arrive pas à uploader des fichiers.