advertnet 1.0.0

data/app/helpers/application_helper.rb

@@ -0,0 +1,31 @@
+# Methods added to this helper will be available to all templates in the application.
+module ApplicationHelper
+  
+  # Affiche proprement le nom d'un object in world ou bien "none"
+  #
+  # XXX Ce helper n'est plus utilisé, on peut sans doute le supprimer.
+  #
+  # == Input
+  #
+  # +oiw+:: ObjectInWorld
+  #
+  # == Output
+  #
+  # Affiche le nom, échappé avec "<tt>h()</tt>", ou bien le mot "+none+"
+  def object_name(oiw)
+    oiw ? h(oiw.name) : "none"
+  end
+
+  # Affiche proprement l'url d'un ObjectOffWorld
+  #
+  # == Input
+  #
+  # +oow+:: ObjectOffWorld
+  #
+  # == Output
+  #
+  # Affiche le nom, avec un lien hypertexte, ou bien le mot "+none+"
+  def object_url(oow)
+    oow ? "<a href=\"#{oow.content}\">#{oow.name}</a>" : "none"
+  end
+end

data/app/helpers/container_helper.rb

@@ -0,0 +1,2 @@
+module ContainerHelper
+end

data/app/helpers/content_helper.rb

@@ -0,0 +1,2 @@
+module ContentHelper
+end

data/app/helpers/furnitures_helper.rb

@@ -0,0 +1,2 @@
+module FurnituresHelper
+end

data/app/helpers/network_helper.rb

@@ -0,0 +1,2 @@
+module NetworkHelper
+end

data/app/helpers/networks_helper.rb

@@ -0,0 +1,2 @@
+module NetworksHelper
+end

data/app/helpers/objects_in_world_helper.rb

@@ -0,0 +1,2 @@
+module ObjectsInWorldHelper
+end

data/app/helpers/panels_helper.rb

@@ -0,0 +1,2 @@
+module PanelsHelper
+end

data/app/models/container.rb

@@ -0,0 +1,51 @@
+# Modèle Container Second Life pour le stockage des objets Second Life. Voir ObjectInWorld
+# pour la description des objets stockés.
+
+# Inclut la librairie ("lib/second_life_validators.rb") qui contient les
+# validateurs Second Life
+require 'second_life_validators'
+
+# Conteneur Second Life de stockage des objets Second Life. Voir ObjectInWorld
+# pour la description des objets stockés.
+#
+# == Schema Information
+# Schema version: 13
+#
+# Table name: containers
+#
+#  id            :integer(11)   not null, primary key
+#  container_key :string(64)    not null
+#  sim           :string(64)    not null
+#  name          :string(64)    not null
+#  position      :string(40)    not null
+#  delay         :integer(11)   default(30), not null
+#  created_at    :datetime      
+#  updated_at    :datetime      
+#
+
+class Container < ActiveRecord::Base
+  # Pas besoin de ':dependent', on gère la cohérence (i.e. interdiction de
+  # supprimer un Container qui contient des OIWs) via les clés étrangères.
+  # --------
+  # En fait si ! Sinon on ne peut pas utiliser un appel du type
+  # "container.objects_in_wold.replace([o1, o2])"...
+  # Il faut en effet détruire les objets qui ne sont plus rattachés à un
+  # container.
+  has_many :objects_in_world,
+           :dependent => :destroy
+
+  # Correction de la sim et de la position avant validation et insertion en
+  # base de données
+  before_validation SecondLifeSimPosNormalizer.new(:sim, :position)
+  
+  validates_presence_of(:name, :container_key, :sim, :position, :delay, :message => "must be given a value")
+  validates_uniqueness_of(:container_key, :message => "must be unique")
+  validates_numericality_of(:delay, :only_integer => true)
+  # Format des id d'object dans Second Life
+  validates_format_of_sl_key(:container_key)
+  # Format de la position relative dans une Sim : X,Y,Z
+  validates_format_of_sl_position(:position)
+  # Valeurs tolérées pour delay
+  # (TODO : Trouver quelle est la plage de valeur raisonnable pour delay)
+  validates_inclusion_of(:delay, :in => 5..60, :message => "is not a valid delay")
+end

data/app/models/furniture.rb

@@ -0,0 +1,60 @@
+# == Schema Information
+# Schema version: 13
+#
+# Table name: furnitures
+#
+#  id            :integer(11)   not null, primary key
+#  name          :string(64)    not null
+#  furniture_key :string(36)    not null
+#  sim           :string(64)    not null
+#  position      :string(40)    not null
+#  delay         :integer(11)   default(30), not null
+#  created_at    :datetime      
+#  updated_at    :datetime      
+#  permanent_id  :integer(11)   
+#
+
+# Inclut la librairie ("lib/second_life_validators.rb") qui contient les
+# validateurs Second Life
+require 'second_life_validators'
+
+class Furniture < ActiveRecord::Base
+  # Pas besoin de ':dependent', on gère la cohérence (i.e. interdiction de
+  # supprimer un Furniture qui contient des Panels) via les clés étrangères.
+  has_many :panels
+
+  # Correction de la sim et de la position avant validation et insertion en
+  # base de données
+  before_validation SecondLifeSimPosNormalizer.new(:sim, :position)
+  
+  validates_presence_of(:name, :furniture_key, :sim, :position, :delay, :message => "must be given a value")
+  validates_uniqueness_of(:furniture_key, :message => "must be unique")
+  validates_numericality_of(:delay, :only_integer => true)
+  # permanent_id peut être numérique ou nul
+  validates_numericality_of :permanent_id, :only_integer => true,
+        :if => Proc.new { |u| !u.permanent_id.nil? }
+  # Format des id d'object dans Second Life
+  validates_format_of_sl_key(:furniture_key)
+  # Format de la position relative dans une Sim : X,Y,Z
+  validates_format_of_sl_position(:position)
+  # Valeurs tolérées pour delay
+  # (TODO : Trouver quelle est la plage de valeur raisonnable pour delay)
+  validates_inclusion_of(:delay, :in => 5..60, :message => "is not a valid delay")
+  
+  # Affecte l'id permanent lors de la création d'un mobilier, s'il n'a pas déjà été renseigné.
+  # Par convention, l'id permanent est l'id principal du premier mobilier créé dans SL.
+  # Lorsque l'on remplace dans SL un mobilier par une nouvelle version, on doit lui attribuer
+  # manuellement son id permanent, afin qu'il l'envoie à l'application Rails lors de l'appel
+  # de "register".
+  def after_create
+    update_attribute(:permanent_id, id) if !permanent_id?
+  end
+
+  # Enregistrement d'une nouvelle révision des panneaux du mobilier à chaque enregistrement,
+  # que ce soit "save" ou "update".
+  def after_save
+    panels.each do |p|
+      PanelRevision.add(p) # Nouvelle révision du panneau
+    end
+  end
+end

data/app/models/mailer.rb

@@ -0,0 +1,22 @@
+# Cette classe gère les envois de mails
+class Mailer < ActionMailer::Base
+
+  # Envoi de mail à un container lorsqu'un avatar clique sur un panel
+  #
+  # == Input
+  # +container_key+:: Clé du container contenant l'object à envoyer
+  # +avatar_key+:: Clé de l'avatar qui a cliqué sur le panel
+  # +object_name+:: Nom de l'object à envoyer
+  #
+  # == Output
+  #
+  # * Envoi d'un mail à un container dans SL.
+  def avtouch(container_key, avatar_key, object_name)
+    @subject    = 'give inventory'
+    @body       = { "avatar_key" => avatar_key, "object_name" => object_name }
+    @recipients = container_key + "@lsl.secondlife.com"
+    @from       = 'webia@community-chest.net'
+    @sent_on    = Time.now
+    @headers    = {}
+  end
+end

data/app/models/network.rb

@@ -0,0 +1,38 @@
+# == Schema Information
+# Schema version: 13
+#
+# Table name: networks
+#
+#  id         :integer(11)   not null, primary key
+#  name       :string(64)    not null
+#  active     :boolean(1)    default(TRUE), not null
+#  created_at :datetime      
+#  updated_at :datetime      
+#
+
+class Network < ActiveRecord::Base
+  # XXX : Argh avec :nullify il se passe exactement le contraire de l'effet attendu !
+  # * Avec ":dependent => :nullify"
+  #   - Quand on casse l'association d'un réseau et d'un panneau, Rails *supprime* le panneau
+  #     au lieu de mettre le champ network_id à NULL
+  #   - Mais Rails mets bien ce champ à NULL quand on fait "network.destroy"
+  # * Sans ":dependent => :nullify"
+  #   - Quand on casse l'association, Rails mets à NULL le champ network_id, ce qui est bien, mais
+  #     c'est le contraire de ce que dit la doc !
+  #   - Quand on fait "network.destroy", Rails ne met pas à NULL network_id. Mais heureusement
+  #     les FOREIGN KEYS de MySQL, qu'on a activé grâce à un plugin, corrige le problème.
+  has_many :panels #, :dependent => :nullify
+  
+  STATES = [ [ "True", true ], [ "False", false ]]
+  
+  validates_presence_of(:name, :message => "must be given a value")
+  validates_uniqueness_of(:name, :message => "is already use by another network")
+  
+  # Enregistrement d'une nouvelle révision des panneaux du mobilier à chaque enregistrement,
+  # que ce soit "save" ou "update".
+  def after_save
+    panels.each do |p|
+      PanelRevision.add(p) # Nouvelle révision du panneau
+    end
+  end
+end

data/app/models/object_in_world.rb

@@ -0,0 +1,60 @@
+# == Schema Information
+# Schema version: 13
+#
+# Table name: objects_in_world
+#
+#  id           :integer(11)   not null, primary key
+#  name         :string(64)    not null
+#  object_key   :string(36)    not null
+#  otype        :string(16)    not null
+#  container_id :integer(11)   not null
+#  created_at   :datetime      
+#  updated_at   :datetime      
+#
+
+# Inclut la librairie ("lib/second_life_validators.rb") qui contient les
+# validateurs Second Life
+require 'second_life_validators'
+
+class ObjectInWorld < ActiveRecord::Base
+  # Type d'objets in world autorisés
+  TYPES = [ "texture", "landmark", "notecard" ]
+  
+  belongs_to :container
+  has_and_belongs_to_many :panels
+  
+  validates_presence_of(:object_key, :name, :otype, :container_id, :message => "must be given a value")
+  validates_uniqueness_of(:object_key, :message => "must be unique")
+
+  # Format des id d'object dans Second Life
+  validates_format_of_sl_key(:object_key)
+  
+  # Format du type d'objet
+  validates_inclusion_of(:otype, :in => TYPES, :message => "is an invalid object type")
+
+  # Retourne la texture par défaut
+  def self.default_texture
+    find_by_name_and_otype("default", "texture")
+  end
+
+  #----------------------------------------------------------------------------
+  # Gestion de la création de révisions de panneaux en 2 étapes.
+  # - Avant 'destroy', on note la liste des panneaux comportant l'objet à détruire
+  # - Après 'destroy', on crée une nouvelle révision pour chaque de ces objets.
+  @panels_needing_revisions = nil
+  
+  # Note les id des panneaux dont on doit créer une nouvelle révision, avant destruction des objets associés
+  def before_destroy
+    @panels_needing_revisions = self.panels.map(&:id)
+  end
+  
+  # Enregistrement d'une nouvelle révision des panneaux du mobilier à chaque suppression d'objet.
+  # On reprend les id de panneaux qu'on a notés avant la destruction de l'objet.
+  def after_destroy
+    @panels_needing_revisions.each do |panel_id|
+      PanelRevision.add(Panel.find(panel_id)) # Nouvelle révision du panneau
+    end
+  end
+  # Fin gestion de la création des révisions de panneaux
+  #----------------------------------------------------------------------------
+end

data/app/models/object_off_world.rb

@@ -0,0 +1,77 @@
+# == Schema Information
+# Schema version: 13
+#
+# Table name: objects_off_world
+#
+#  id         :integer(11)   not null, primary key
+#  name       :string(64)    not null
+#  object_key :string(36)    not null
+#  otype      :string(16)    not null
+#  content    :text          
+#  created_at :datetime      
+#  updated_at :datetime      
+#
+
+require 'digest/md5'
+# Inclut la librairie ("lib/second_life_validators.rb") qui contient les
+# validateurs Second Life
+require 'second_life_validators'
+
+class ObjectOffWorld < ActiveRecord::Base
+  has_and_belongs_to_many :panels
+  
+  # Types d'objets autorisés. Le format de la liste imbriquée est :
+  #
+  # Premier champ:: Valeur à afficher
+  # Deuxième champ:: Valeur à stocker en base
+  #
+  # On peut étendre cette liste pour ajouter de nouveaux types.
+  TYPES = [ [ "URL", "url" ], 
+            [ "Media URL", "mediaurl" ] ]
+
+  validates_presence_of(:object_key, :name, :otype, :content, :message => "must be given a value")
+  # La clé est construite à partir de 'name' et 'content', seule elle a besoin d'être
+  # unique. Voir 'before_validation' pour la génération de la clé.
+  validates_uniqueness_of(:object_key, :message => "must be unique")
+
+  # Format des id d'object dans Second Life
+  validates_format_of_sl_key(:object_key)
+
+  # Format du type d'objet
+  validates_inclusion_of(:otype, :in => TYPES.collect { |type| type[1] }, :message => "is an invalid object type")
+
+  # Pour remplir le champ 'object_key', calcule le md5 de 'name' plus 'content'
+  # et réécrit le de façon à ce que ça ressemble à une clé Second Life, en
+  # rajoutant 4 tirets aux bons endroits.
+  def before_validation
+    # Si name ou content sont indéfini on ne peut pas calculer le MD5
+    return if name.nil? or content.nil?
+    
+    key = Digest::MD5.new.update(name + content).to_s
+    self.object_key = key.sub(
+              /^([[:xdigit:]]{8})([[:xdigit:]]{4})([[:xdigit:]]{4})([[:xdigit:]]{4})([[:xdigit:]]{12})$/, 
+              '\1-\2-\3-\4-\5')
+  end
+
+
+  #----------------------------------------------------------------------------
+  # Gestion de la création de révisions de panneaux en 2 étapes.
+  # - Avant 'destroy', on note la liste des panneaux comportant l'objet à détruire
+  # - Après 'destroy', on crée une nouvelle révision pour chaque de ces objets.
+  @panels_needing_revisions = nil
+  
+  # Note les id des panneaux dont on doit créer une nouvelle révision, avant destruction des objets associés
+  def before_destroy
+    @panels_needing_revisions = self.panels.map(&:id)
+  end
+  
+  # Enregistrement d'une nouvelle révision des panneaux du mobilier à chaque suppression d'objet.
+  # On reprend les id de panneaux qu'on a notés avant la destruction de l'objet.
+  def after_destroy
+    @panels_needing_revisions.each do |panel_id|
+      PanelRevision.add(Panel.find(panel_id)) # Nouvelle révision du panneau
+    end
+  end
+  # Fin gestion de la création des révisions de panneaux
+  #----------------------------------------------------------------------------
+end

data/app/models/panel.rb

@@ -0,0 +1,136 @@
+# == Panel 
+#
+# Panel contient les panneaux publicitaires proprement dits. Ces panneaux appartiennent à
+# des médias, décrits par le modèle Furniture.
+
+# Inclut la librairie ("lib/second_life_validators.rb") qui contient les
+# validateurs Second Life
+require 'second_life_validators'
+
+# == Panel 
+#
+# Panel contient les panneaux publicitaires proprement dits. Ces panneaux appartiennent à
+# des médias, décrits par le modèle Furniture.
+#
+# == Schema Information
+# Schema version: 13
+#
+# Table name: panels
+#
+#  id           :integer(11)   not null, primary key
+#  name         :string(64)    not null
+#  panel_key    :string(36)    not null
+#  furniture_id :integer(11)   not null
+#  network_id   :integer(11)   
+#  created_at   :datetime      
+#  updated_at   :datetime      
+#
+
+class Panel < ActiveRecord::Base
+  belongs_to :network
+  belongs_to :furniture
+  has_and_belongs_to_many :objects_in_world
+  has_and_belongs_to_many :objects_off_world
+  
+  validates_presence_of(:name, :panel_key, :furniture_id, :message => "must be given a value")
+  validates_uniqueness_of(:panel_key, :message => "must be unique")
+  # Format des id d'objets dans Second Life
+  validates_format_of_sl_key(:panel_key)
+  
+  # Crée dynamiquement de nouveaux accessors pour les ObjectInWorld
+  #
+  # * texture()
+  # * texture=(new_texture)
+  # * landmark()
+  # * landmark=(new_landmark)
+  # * etc.
+  ObjectInWorld::TYPES.each do |type|
+    module_eval(%Q{
+      # Applique un object in world d'un type donné à un panneau
+      def #{type}=(new_oiw)
+        oiw = objects_in_world.find_by_otype("#{type}")
+        # Suppression si argument est nil
+        if new_oiw.nil?
+          objects_in_world.delete(oiw) if oiw
+          PanelRevision.add(self) # Nouvelle révision du panneau
+          return nil
+        end
+        # Vérification de type
+        if !new_oiw.instance_of?(ObjectInWorld) or new_oiw.otype != "#{type}"
+          raise TypeError, "Argument \#{new_oiw.inspect} is not a '#{type}' object"
+        end
+        # Le nouvel object est-il égal au précédent ?
+        if new_oiw == oiw
+          return oiw
+        end
+        objects_in_world.delete(oiw) if oiw
+        objects_in_world << new_oiw
+        PanelRevision.add(self) # Nouvelle révision du panneau
+        new_oiw
+      end
+  
+      # Retourne l'object in world du type donné, associé à ce panneau
+      def #{type}
+        objects_in_world.find_by_otype("#{type}")
+      end
+    }, __FILE__, __LINE__)
+  end
+
+  # Crée dynamiquement de nouveaux accessors pour les ObjectOffWorld
+  #
+  # * url()
+  # * url=(new_url)
+  # * etc.
+  ObjectOffWorld::TYPES.map { |t| t[1] }.each do |type|
+    # Retourne l'object off world du type donné, associé à ce panneau
+    module_eval(%Q{
+      # Applique un object off world d'un type donné à un panneau
+      def #{type}=(new_oow)
+        oow = objects_off_world.find_by_otype("#{type}")
+        # Suppression si argument est nil
+        if new_oow.nil?
+          objects_off_world.delete(oow) if oow
+          PanelRevision.add(self) # Nouvelle révision du panneau
+          return nil
+        end
+        # Vérification de type
+        if !new_oow.instance_of?(ObjectOffWorld) or new_oow.otype != "#{type}"
+          raise TypeError, "Argument \#{new_oow.inspect} is not a '#{type}' object"
+        end
+        # Le nouvel object est-il égal au précédent ?
+        if new_oow == oow
+          return oow
+        end
+        objects_off_world.delete(oow) if oow
+        objects_off_world << new_oow
+        PanelRevision.add(self) # Nouvelle révision du panneau
+        new_oow
+      end
+  
+      def #{type}
+        objects_off_world.find_by_otype("#{type}")
+      end
+    }, __FILE__, __LINE__)
+  end
+
+  # Retourne la liste de tous les panneaux non attribués à un réseau
+  def self.unassigned_panels
+    Panel.find(:all, :conditions => [ 'network_id IS NULL' ])
+  end
+
+  # Met une texture par défaut si aucune n'est précisée à la création
+  def before_validation # :doc:
+    if !texture
+      self.texture = ObjectInWorld.default_texture
+    end
+  end
+  
+  # Enregistrement d'une nouvelle révision du panneau à chaque enregistrement,
+  # que ce soit "save" ou "update".
+  # 
+  # Ce callback sera appelé aussi bien pour les modification sur le panneau
+  # que lors de modifications du réseau associé.
+  def after_save
+    PanelRevision.add(self) # Nouvelle révision du panneau
+  end
+end