advertnet 1.0.0

data/config/environments/test.rb

@@ -0,0 +1,19 @@
+# Settings specified here will take precedence over those in config/environment.rb
+
+# The test environment is used exclusively to run your application's
+# test suite.  You never need to work with it otherwise.  Remember that
+# your test database is "scratch space" for the test suite and is wiped
+# and recreated between test runs.  Don't rely on the data there!
+config.cache_classes = true
+
+# Log error messages when you accidentally call methods on nil.
+config.whiny_nils = true
+
+# Show full error reports and disable caching
+config.action_controller.consider_all_requests_local = true
+config.action_controller.perform_caching             = false
+
+# Tell ActionMailer not to deliver emails to the real world.
+# The :test delivery method accumulates sent emails in the
+# ActionMailer::Base.deliveries array.
+config.action_mailer.delivery_method = :test

data/config/routes.rb

@@ -0,0 +1,23 @@
+ActionController::Routing::Routes.draw do |map|
+  # The priority is based upon order of creation: first created -> highest priority.
+  
+  # Sample of regular route:
+  # map.connect 'products/:id', :controller => 'catalog', :action => 'view'
+  # Keep in mind you can assign values other than :controller and :action
+
+  # Sample of named route:
+  # map.purchase 'products/:id/purchase', :controller => 'catalog', :action => 'purchase'
+  # This route can be invoked with purchase_url(:id => product.id)
+
+  # You can have the root of your site routed by hooking up '' 
+  # -- just remember to delete public/index.html.
+  map.connect '', :controller => 'networks'
+
+  # Allow downloading Web Service WSDL as a file with an extension
+  # instead of a file named 'wsdl'
+  map.connect ':controller/service.wsdl', :action => 'wsdl'
+
+  # Install the default route as the lowest priority.
+  map.connect ':controller/:action/:id.:format'
+  map.connect ':controller/:action/:id'
+end

data/db/migrate/001_create_networks.rb

@@ -0,0 +1,14 @@
+class CreateNetworks < ActiveRecord::Migration
+  def self.up
+    create_table :networks do |t|
+      t.column :name, :string, :limit => 64, :null => false
+      t.column :active, :boolean, :null => false, :default => true
+      t.column :created_at, :datetime
+      t.column :updated_at, :datetime
+    end
+  end
+
+  def self.down
+    drop_table :networks
+  end
+end

data/db/migrate/002_create_furnitures.rb

@@ -0,0 +1,17 @@
+class CreateFurnitures < ActiveRecord::Migration
+  def self.up
+    create_table :furnitures do |t|
+      t.column :name, :string, :limit => 64, :null => false
+      t.column :furniture_key, :string, :limit => 36, :null => false
+      t.column :sim, :string, :limit => 64, :null => false
+      t.column :position, :string, :limit => 40, :null => false
+      t.column :delay, :integer, :null => false, :default => 30
+      t.column :created_at, :datetime
+      t.column :updated_at, :datetime
+    end
+  end
+
+  def self.down
+    drop_table :furnitures
+  end
+end

data/db/migrate/003_create_containers.rb

@@ -0,0 +1,16 @@
+class CreateContainers < ActiveRecord::Migration
+  def self.up
+    create_table :containers do |t|
+      t.column :container_key, :string, :limit => 64, :null => false
+      t.column :sim, :string, :limit => 64, :null => false
+      t.column :position, :string, :limit => 40, :null => false
+      t.column :delay, :integer, :null => false, :default => 30
+      t.column :created_at, :datetime
+      t.column :updated_at, :datetime
+    end
+  end
+
+  def self.down
+    drop_table :containers
+  end
+end

data/db/migrate/004_create_objects_in_world.rb

@@ -0,0 +1,16 @@
+class CreateObjectsInWorld < ActiveRecord::Migration
+  def self.up
+    create_table :objects_in_world do |t|
+      t.column :name, :string, :limit => 64, :null => false
+      t.column :object_key, :string, :limit => 36, :null => false
+      t.column :type, :string, :limit => 16, :null => false
+      t.column :container_id, :integer, :null => false, :on_update => :cascade, :on_delete => :restrict
+      t.column :created_at, :datetime
+      t.column :updated_at, :datetime
+    end
+  end
+
+  def self.down
+    drop_table :objects_in_world
+  end
+end

data/db/migrate/005_create_objects_off_world.rb

@@ -0,0 +1,16 @@
+class CreateObjectsOffWorld < ActiveRecord::Migration
+  def self.up
+    create_table :objects_off_world do |t|
+      t.column :name, :string, :limit => 64, :null => false
+      t.column :object_key, :string, :limit => 36, :null => false
+      t.column :type, :string, :limit => 16, :null => false
+      t.column :content, :text
+      t.column :created_at, :datetime
+      t.column :updated_at, :datetime
+    end
+  end
+
+  def self.down
+    drop_table :objects_off_world
+  end
+end

data/db/migrate/006_create_panels.rb

@@ -0,0 +1,17 @@
+class CreatePanels < ActiveRecord::Migration
+  def self.up
+    create_table :panels do |t|
+      t.column :name, :string, :limit => 64, :null => false
+      t.column :panel_key, :string, :limit => 36, :null => false
+      t.column :picture, :string, :limit => 36, :null => false
+      t.column :furniture_id, :integer, :null => false, :on_update => :cascade, :on_delete => :restrict
+      t.column :network_id, :integer, :null => true, :on_update => :cascade, :on_delete => :set_null
+      t.column :created_at, :datetime
+      t.column :updated_at, :datetime
+    end
+  end
+
+  def self.down
+    drop_table :panels
+  end
+end

data/db/migrate/007_join_objects_in_world_panels.rb

@@ -0,0 +1,17 @@
+# Table de jointure entre les modèles ObjectInWorld et Panel
+class JoinObjectsInWorldPanels < ActiveRecord::Migration
+  def self.up
+    create_table :objects_in_world_panels, :id => false do |t|
+      t.column :panel_id, :integer, :null => false, 
+        :on_update => :cascade, :on_delete => :cascade
+    # Attention au pluriel du nom de la table étrangère
+      t.column :object_in_world_id, :integer, :null => false, 
+        :references => :objects_in_world, 
+        :on_update => :cascade, :on_delete => :cascade
+    end
+  end
+
+  def self.down
+    drop_table :objects_in_world_panels
+  end
+end

data/db/migrate/008_join_objects_off_world_panels.rb

@@ -0,0 +1,17 @@
+# Table de jointure entre les modèles ObjectOffWorld et Panel
+class JoinObjectsOffWorldPanels < ActiveRecord::Migration
+  def self.up
+    create_table :objects_off_world_panels, :id => false do |t|
+      t.column :panel_id, :integer, :null => false, 
+        :on_update => :cascade, :on_delete => :cascade
+    # Attention au pluriel du nom de la table étrangère
+      t.column :object_off_world_id, :integer, :null => false, 
+        :references => :objects_off_world, 
+        :on_update => :cascade, :on_delete => :cascade
+    end
+  end
+
+  def self.down
+    drop_table :objects_off_world_panels
+  end
+end

data/db/migrate/009_add_sessions.rb

@@ -0,0 +1,19 @@
+class AddSessions < ActiveRecord::Migration
+  def self.up
+    create_table :sessions do |t|
+      # Attention : comme on utilise le plugin Foreign Key Migration, qui utilisent
+      # les champs dont le nom se finit par "_id" on doit explicitement signaler que
+      # ce champs n'est pas une clé étrangère.
+      t.column :session_id, :string, :references => nil
+      t.column :data, :text
+      t.column :updated_at, :datetime
+    end
+
+    add_index :sessions, :session_id
+    add_index :sessions, :updated_at
+  end
+
+  def self.down
+    drop_table :sessions
+  end
+end

data/db/migrate/010_add_or_rename_fields.rb

@@ -0,0 +1,25 @@
+class AddOrRenameFields < ActiveRecord::Migration
+  def self.up
+    # Champ 'name' manquant. On veut qu'elle soit ajoutée après le champ 'sim'
+    # Cette commande ne convient pas : add_column :containers, :name, :string, :limit => 64, :null => false
+    say_with_time("Adding column 'name' to 'containers'") do
+      execute "ALTER TABLE containers ADD COLUMN `name` VARCHAR(64) NOT NULL AFTER `sim`"
+    end
+    # Le champ 'type' est réservé par Rails
+    # Attention, Rails perd les attributs d'une colonne renommée !!! On doit les remettre à la main.
+    rename_column :objects_in_world, :type, :otype
+    change_column :objects_in_world, :otype, :string, :limit => 16, :null => false
+    rename_column :objects_off_world, :type, :otype
+    change_column :objects_off_world, :otype, :string, :limit => 16, :null => false
+  end
+
+  def self.down
+    remove_column :containers, :name
+    # Idem ici, en théorie même s'il y a peut de chance qu'on fasse une migration arrière,
+    # il faudrait redonner les attributs perdus lors du renommage.
+    rename_column :objects_in_world, :otype, :type
+    change_column :objects_in_world, :type, :string, :limit => 16, :null => false
+    rename_column :objects_off_world, :otype, :type
+    change_column :objects_off_world, :type, :string, :limit => 16, :null => false
+  end
+end

data/db/migrate/011_move_texture_to_object_in_world.rb

@@ -0,0 +1,25 @@
+# Déplace le contenu du champ "picture" de la table Panel dans la relation +hatm+ liant
+# Panel à ObjectInWorld.
+#
+# Le codage de la texture d'un panneau n'a pas besoin d'avoir un statut particulier, qui
+# rend en plus la programmation moins générique.
+class MoveTextureToObjectInWorld < ActiveRecord::Migration
+  def self.up
+    panels = Panel.find(:all)
+    panels.each do |p|
+      # Suppression d'une ancienne texture liée, si nécessaire.
+      old_texture = p.objects_in_world.find_by_otype("texture")
+      p.objects_in_world.delete(old_texture) if old_texture
+      # Transfert de "picture" en texture liée. On ne crée pas l'objet, on sait qu'il existe déjà.
+      new_texture = ObjectInWorld.find_by_object_key(p.picture)
+      p.objects_in_world << new_texture
+    end
+    remove_column :panels, :picture
+  end
+
+  def self.down
+      # Cette migration retour est incomplète car elle ne restaure pas les données, mais 
+      # ce n'est pas grave car elle ne devrait jamais servir.
+      add_column :panels, :picture, :string, :limit => 36, :null => false
+  end
+end

data/db/migrate/012_add_permanent_furniture_id.rb

@@ -0,0 +1,18 @@
+class AddPermanentFurnitureId < ActiveRecord::Migration
+  def self.up
+    # Ce champ stocke l'ID permanent du mobilier urbain, qu'il faudra conserver
+    # à chaque fois que le mobilier est supprimé puis recréé dans SL.
+    # Attention : comme on utilise le plugin Foreign Key Migration, qui utilisent
+    # les champs dont le nom se finit par "_id" on doit explicitement signaler que
+    # ce champs n'est pas une clé étrangère.
+    add_column :furnitures, :permanent_id, :integer, :references => nil
+    Furniture.find(:all).each { |f|
+      f.permanent_id = f.id
+      f.save
+    }
+  end
+
+  def self.down
+    remove_column :furnitures, :permanent_id
+  end
+end

data/db/migrate/013_create_panel_revisions.rb

@@ -0,0 +1,42 @@
+class CreatePanelRevisions < ActiveRecord::Migration
+  def self.up
+    # La table d'historique des panneaux n'a pas de clé primaire
+    create_table :panel_revisions, :id => false do |t|
+      # Identifiant unique de mobilier
+      t.column :permanent_id, :integer, :references => nil
+      # Attributs de panneau
+      t.column :panel_name, :string, :limit => 64, :null => false
+      t.column :panel_key, :string, :limit => 36, :null => false
+      # Attributs de mobilier
+      t.column :furniture_name, :string, :limit => 64, :null => false
+      t.column :furniture_key, :string, :limit => 36, :null => false
+      # Attributs de réseau
+      t.column :network_name, :string, :limit => 64
+      t.column :network_status, :boolean
+      # Attributs de texture
+      t.column :texture_name, :string, :limit => 64
+      t.column :texture_key, :string, :limit => 36
+      # Attributs de Landmark
+      t.column :landmark_name, :string, :limit => 64
+      t.column :landmark_key, :string, :limit => 36
+      # Attributs de Notecard
+      t.column :notecard_name, :string, :limit => 64
+      t.column :notecard_key, :string, :limit => 36
+      # Attributs de URL
+      t.column :url_name, :string, :limit => 64
+      t.column :url_content, :text
+      # Attributs de Media URL
+      t.column :mediaurl_name, :string, :limit => 64
+      t.column :mediaurl_content, :text
+      # Position dans Second Life
+      t.column :sim, :string, :limit => 64, :null => false
+      t.column :position, :string, :limit => 40, :null => false
+      # Date de création/modification de la révision
+      t.column :created_at, :datetime
+    end
+  end
+
+  def self.down
+    drop_table :panel_revisions
+  end
+end

data/db/schema.rb

@@ -0,0 +1,102 @@
+# This file is autogenerated. Instead of editing this file, please use the
+# migrations feature of ActiveRecord to incrementally modify your database, and
+# then regenerate this schema definition.
+
+ActiveRecord::Schema.define(:version => 11) do
+
+  create_table "containers", :force => true do |t|
+    t.column "container_key", :string,   :limit => 64,                 :null => false
+    t.column "sim",           :string,   :limit => 64,                 :null => false
+    t.column "name",          :string,   :limit => 64,                 :null => false
+    t.column "position",      :string,   :limit => 40,                 :null => false
+    t.column "delay",         :integer,                :default => 30, :null => false
+    t.column "created_at",    :datetime
+    t.column "updated_at",    :datetime
+  end
+
+  create_table "furnitures", :force => true do |t|
+    t.column "name",          :string,   :limit => 64,                 :null => false
+    t.column "furniture_key", :string,   :limit => 36,                 :null => false
+    t.column "sim",           :string,   :limit => 64,                 :null => false
+    t.column "position",      :string,   :limit => 40,                 :null => false
+    t.column "delay",         :integer,                :default => 30, :null => false
+    t.column "created_at",    :datetime
+    t.column "updated_at",    :datetime
+  end
+
+  create_table "networks", :force => true do |t|
+    t.column "name",       :string,   :limit => 64,                   :null => false
+    t.column "active",     :boolean,                :default => true, :null => false
+    t.column "created_at", :datetime
+    t.column "updated_at", :datetime
+  end
+
+  create_table "objects_in_world", :force => true do |t|
+    t.column "name",         :string,   :limit => 64, :null => false
+    t.column "object_key",   :string,   :limit => 36, :null => false
+    t.column "otype",        :string,   :limit => 16, :null => false
+    t.column "container_id", :integer,                :null => false
+    t.column "created_at",   :datetime
+    t.column "updated_at",   :datetime
+  end
+
+  add_index "objects_in_world", ["container_id"], :name => "container_id"
+
+  create_table "objects_in_world_panels", :id => false, :force => true do |t|
+    t.column "panel_id",           :integer, :null => false
+    t.column "object_in_world_id", :integer, :null => false
+  end
+
+  add_index "objects_in_world_panels", ["panel_id"], :name => "panel_id"
+  add_index "objects_in_world_panels", ["object_in_world_id"], :name => "object_in_world_id"
+
+  create_table "objects_off_world", :force => true do |t|
+    t.column "name",       :string,   :limit => 64, :null => false
+    t.column "object_key", :string,   :limit => 36, :null => false
+    t.column "otype",      :string,   :limit => 16, :null => false
+    t.column "content",    :text
+    t.column "created_at", :datetime
+    t.column "updated_at", :datetime
+  end
+
+  create_table "objects_off_world_panels", :id => false, :force => true do |t|
+    t.column "panel_id",            :integer, :null => false
+    t.column "object_off_world_id", :integer, :null => false
+  end
+
+  add_index "objects_off_world_panels", ["panel_id"], :name => "panel_id"
+  add_index "objects_off_world_panels", ["object_off_world_id"], :name => "object_off_world_id"
+
+  create_table "panels", :force => true do |t|
+    t.column "name",         :string,   :limit => 64, :null => false
+    t.column "panel_key",    :string,   :limit => 36, :null => false
+    t.column "furniture_id", :integer,                :null => false
+    t.column "network_id",   :integer
+    t.column "created_at",   :datetime
+    t.column "updated_at",   :datetime
+  end
+
+  add_index "panels", ["furniture_id"], :name => "furniture_id"
+  add_index "panels", ["network_id"], :name => "network_id"
+
+  create_table "sessions", :force => true do |t|
+    t.column "session_id", :string
+    t.column "data",       :text
+    t.column "updated_at", :datetime
+  end
+
+  add_index "sessions", ["session_id"], :name => "index_sessions_on_session_id"
+  add_index "sessions", ["updated_at"], :name => "index_sessions_on_updated_at"
+
+  add_foreign_key "objects_in_world", ["container_id"], "containers", ["id"], :on_update => :cascade, :name => "objects_in_world_ibfk_1"
+
+  add_foreign_key "objects_in_world_panels", ["panel_id"], "panels", ["id"], :on_update => :cascade, :on_delete => :cascade, :name => "objects_in_world_panels_ibfk_1"
+  add_foreign_key "objects_in_world_panels", ["object_in_world_id"], "objects_in_world", ["id"], :on_update => :cascade, :on_delete => :cascade, :name => "objects_in_world_panels_ibfk_2"
+
+  add_foreign_key "objects_off_world_panels", ["panel_id"], "panels", ["id"], :on_update => :cascade, :on_delete => :cascade, :name => "objects_off_world_panels_ibfk_1"
+  add_foreign_key "objects_off_world_panels", ["object_off_world_id"], "objects_off_world", ["id"], :on_update => :cascade, :on_delete => :cascade, :name => "objects_off_world_panels_ibfk_2"
+
+  add_foreign_key "panels", ["furniture_id"], "furnitures", ["id"], :on_update => :cascade, :name => "panels_ibfk_1"
+  add_foreign_key "panels", ["network_id"], "networks", ["id"], :on_update => :cascade, :on_delete => :set_null, :name => "panels_ibfk_2"
+
+end

data/doc/README_FOR_APP

@@ -0,0 +1,108 @@
+= Webia / Réseaupub
+
+== Description
+
+Cette application sert à la gestion du réseau de panneaux publicitaires *Webia*
+dans Second Life.
+
+L'application, écrite en Ruby on Rails, fournit une interface web d'administration
+du réseau de panneaux, ainsi qu'une interface de type <em>Web Services</em>, qui
+répond aux requêtes, écrites en LSL, des objets Second Life.
+
+== Auteurs / Licence
+
+Copyright (C) 2007 Community Chest
+
+Auteurs :
+* Farzad FARID <ffarid@pramatic-source.com>
+* Yves Rougy <yrougy@gmail.com>
+
+Le code de cette application est diffusé sous licence GPL 2 ou supérieure :
+
+  This program is free software; you can redistribute it and/or modify
+  it under the terms of the GNU General Public License as published by
+  the Free Software Foundation; either version 2 of the License, or
+  (at your option) any later version.
+
+  This program is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+  GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program; if not, write to the Free Software
+Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
+
+== Extensions utilisées
+
+Ce projet utilise les plugins suivants :
++annotate_models+ :: 
+    Ajoute une tâche Rake qui ajoute en commentaire aux modèles la structure de données.
++redhillonrails_core+ :: 
+    Plugin de base pour +foreign_key_migrations+
++foreign_key_migrations+ ::
+    Ajout le support de la création automatique des clés étrangères dans les migrations.
+  
+== Librairies et tâches maison
+
+=== Tâches
+
+Les tâches sont installées dans <tt>lib/tasks</tt> ou dans <tt>vendors/plugins</tt>.
+
+<tt>documentation</tt> ::
+    La tâche <tt>doc:app</tt> ne supporte pas les accents UTF-8 ! C'est pourquoi elle a été
+    dupliquée en locale et modifiée pour appeler +rdoc+ avec le charset UTF-8.
+    Un bug report a été ouvert sur Rails : http://dev.rubyonrails.org/ticket/8906.
+    Fournit la tâche <tt>doc:app_utf8</tt>.
+<tt>extract_fixtures</tt> ::
+    Tâche tirée du livre "Rails Recipes", extrait les données des tables sous forme de
+    fixtures, dans le répertoire <tt>db/exported_fixtures</tt>.
+    Fournit la tâche <tt>db:fixtures:extract_fixtures</tt>. *RAILS_ENV* détermine la base
+    qui sera dumpée.
+<tt>load_exported_fixtures</tt> ::
+    L'opération inverse, avec les mêmes données, qui sont importées dans la base.
+    Fournit la tâche <b>db:fixtures:load_extracted_fixtures</b>. *RAILS_ENV* détermine la base
+    qui sera dumpée. Si la variable d'environnement <b>FIXTURES=fichier1,fichier2,...</b> est fournie, 
+    les fichiers passés en paramètres seront utilisés, sinon la tâche utilise les fichiers
+    du répertoire <tt>db/exported_fixtures</tt>.
+<tt>annotate_models</tt> ::
+    Lancer cette tâche après toute modification des modèles. La tâche modifie tous les fichiers
+    décrivant les modèles de la base de données, en y ajoutant des commentaires décrivant le
+    modèle physique de chaque table.
+    Si la base est modifiée, alors les commentaires et le numéro de version seront modifiés aussi, ce
+    qui nécessitera de refaire un commit SVN.
+    *IMPORTANT* : Lors de modification ou déplacement de bloc de commentaires dans la documentation des modèles, il faut
+    penser à conserver une ligne vide après la dernière ligne "<tt>#</tt>" du bloc ajouté par +annotate_models+.
+
+=== Librairies
+
+La librairie SecondLifeSimPosNormalizer contient des validateurs pour Second Life. Voir la page de 
+SecondLifeSimPosNormalizer pour plus d'informations.
+
+== Bugs et points importants
+
+<b>ATTENTION AUX POINTS SUIVANTS</b>
+
+=== Support des clés étrangères dans les tests
+
+<tt>rake db:test:prepare</tt> ne copie pas les contraintes de clés étrangères dans la base <tt>*_test</tt>
+si on garde <tt>:ruby</tt> comme schéma pour les dumps.
+Il faut configurer le projet pour qu'il fasse les dumps au format SQL au lieu de Ruby.
+Voir '<tt>config.active_record.schema_format = :sql</tt>' dans <tt>environment.rb</tt>.
+
+=== Renommage de colonnes
+
+Quand on renomme une colonne dans une migration (avec +rename_column+, on perd tous les attributs
+(null, default..). Il faut remettre les attributs à la main avec +change_column+, on bien ne pas 
+utilisation les migrations.
+
+=== Ajout de colonnes
+
+De même, les migrations (avec +add_column+) ne permettent d'ajouter la colonne qu'en dernière position.
+Il faut utiliser +execute+ et une commande SQL pour choisir l'emplacement de la nouvelle colonne.
+
+== Installation
+
+=== Génération de la documentation
+
+Lancer '<tt>rake doc:app_utf8</tt>' pour génération la documentation à partir des sources du projet.