A propos du moteur de .node

Hiérarchie des fichiers

Dossiers à la racine

La racine du projet comporte les répertoires importants suivants :

  • actions/ : scripts executés pour toutes les actions ne demandant pas d'affichage (submit de formulaire, action de suppresionn d'un element (images, bookmarks, ...), appel par XMLhttpRequest).
  • bin/ : ne contient actuellement qu'un script. Il est appelé par le serveur de mail lors d'un retour en erreur d'un mail d'invitation.
  • codepix/ : contient les images permettant de proteger certain formulaire des robots (images avec un code déformé à saisir par l'utilisateur)
  • data/: contient tous les fichiers créés par apache et donc avec des droits "non secure". C'est à dire : les albums photos, les photos de profils, les logos de communautés.
  • hp/: DocumentRoot des .pages
  • inc/: scripts contenant la "logique applicative" donnant lieu à un affichage (géré par un template)
  • inc_hp/ : comme inc/ mais pour les .pages
  • inc_xml/ : comme inc/ mais pour les sorties en XML (RSS et FOAF).
  • includes/ : includes en général ... classes, fonctions, etc ...
  • locale/ : contient les fichiers .mo pour GetText dans les différentes langues.
  • log/ : contient les logs de php. Dans la version dev, ce répertoire recoit également les logs de apache (access et error)
  • responses/ : scripts appelés lors d'un clic sur un lien dans un email (généralement le mail d'invitation de .node). Ces scripts ne font que créer un environnement de session et font une redirection sur le script adéquate qui produira un affichage grâce à une template.
  • robots/ : contient des "robots" et des scripts d'automatisation de taches (comme la suppression d'un membres), ainsi que 2 scripts bash pour les cron (launch_robots.sh et launch_robots_2h.sh) qui appelle des scripts php de ce répertoire (envoi de mail, dispatch de message interne, envoi d'invitations, ..., rapatriement des RSS).
  • sessions/ : comme son nom l'indique ...
  • smarty/ : le systeme de template étant smarty Smarty, j'ai pas fait très original pour le répertoire de template (contient également le cache de templates compilées et le cache de contenu).
  • et enfin www/ : le DocumentRoot de la partie principale de .node (la ou il faut s'identifier ;) )

J'ai volontairement passé sous silence certains répertoires comme dntp ou wiki. Ceux-ci appartiennent à des projets connexes à .node :

  • wiki/ : wikini (patché en UTF-8 et multilangue) permettant la gestion du contenu de certaines pages et mails. Il permet également de faciliter le travail de traduction de ces contenus (ceci n'étant pas géré par GetText).
  • dntp/ (et inc_dntp/) : DNTP (Dot Node Translation Project) est l'interface de traduction pour GetText. Ces 2 repertoires sont donc la partie "applicative" et le DocumentRoot

Fichiers à la racine

J'ai pris pour habitude de mettre les scripts principaux en dehors du DocumentRoot Apache. Ces scripts sont les points d'entrée dans l'"application .node". Il y en a plusieurs suivant le contexte. Une évolution pourrait-être de les regrouper et d'uniformiser leurs fonctionnements...

Dans l'archive, on trouve également les fichiers suivant :

  • convert-utf8.vim : simple copier collé a mettre dans un vim pour convertire un fichier en UTF-8. Rien a voir avec .node, mais tellement pratique ;)
  • COPYING : La licence (GPL2)
  • data.tar.gz : Les données de base pour commencer à travailler (quelques photos, logos de communauté, photos d'album)
  • dntp.sql : La base de donnée de DNTP (contient tous les termes GetText et leur traduction etc...)
  • dotnode-clear.sql : juste quelques commandes SQL pour vider les bases
  • dotnode-struct.sql : structure SQL de la base de dotnode
  • dotnode-data.sql : les quelques données pour la base de travail
  • dotnode-wiki.sql : contenu de la base du wikini
  • README : L'indispensable fichier Lisez-moi ;)
  • reset_data.sh : un script bash pour réinitialiser des données (pour repartir sur de bonne base ;))
  • reset_sql.sh : un script bash pour réinitialiser la base de donnée