advertnet 1.0.0

data/app/controllers/furnitures_controller.rb

@@ -0,0 +1,87 @@
+# == Contrôleur de gestion du mobilier urbain, Furniture.
+#
+# Ce contrôleur permet de :
+# * lister le mobilier existant, sans permettre de le modifier pour l'instant.
+# * enregistrer un nouveau mobilier.
+#
+# Suite à l'enregistrement d'un nouveau mobilier, ses panneaux (Panel) s'enregistreront.
+class FurnituresController < ApplicationController
+  # Mise en page globale du site
+  layout "default"
+  
+  # Filtre de récupération des paramètres Second Life
+  before_filter :get_secondlife_attrs, :only => [ :register ]
+  
+  # Renvoie vers l'action 'list'
+  def index
+    list
+    render :action => 'list'
+  end
+
+  # GETs should be safe (see http://www.w3.org/2001/tag/doc/whenToUseGet.html)
+  verify :method => :post, :only => [ :register ],
+         :redirect_to => { :action => :list }
+
+  # Liste des panneaux.
+  def list
+    @furniture_pages, @furnitures = paginate :furnitures, :per_page => 10
+  end
+
+  # Détail d'un panneau.
+  def show
+    @furniture = Furniture.find(params[:id])
+  end
+
+  # Enregistrement d'un nouveau mobilier
+  #
+  # == Input
+  # * Environnement Second Life transmis en HTTP
+  # * <tt>permanent_id=permanent_id</tt> : identifiant permanent du mobilier, s'il existe déjà
+  #
+  # +permanent_id+ est optionnel, si le mobilier n'en remplace pas un qui existait déjà.
+  #
+  # == Output
+  # * Le délai de mise à jour et l'identifiant permanent, sous la forme :
+  #
+  #  delay=delay
+  #  permanent_id=permanent_id
+  def register
+    # Création ou mise à jour du mobilier.
+    # Attention à l'astuce "slattrs.delete(:key)". Grâce à celle-ci, l'appel à
+    # 'update_attributes' ne reçoit que les 3 paramètres à mettre à jour, moins "key".
+    furniture = Furniture.find_or_initialize_by_furniture_key(@slattrs.delete(:key))
+    furniture.update_attributes!(@slattrs.merge({ :permanent_id => params[:permanent_id]}))
+    
+    render :text => "delay=#{furniture.delay}\npermanent_id=#{furniture.permanent_id}\n",
+           :layout => false,
+           :content_type => "text/plain"
+  end
+  
+  # Suppression d'un mobilier. Le mobilier disparaît de la base si ses panneaux ont été
+  # supprimés car non updatés depuis 5 fois le delay (furniture vide)
+  
+  def destroy
+    #Panel.find(:first,:conditions => [ "furniture_id = ?", "1"])
+    furniture = Furniture.find(params[:id])
+    if panel=Panel.find(:first,:conditions => [ "furniture_id = ?", params[:id]]) == nil
+      render :text => "Furniture removed from database"
+      furniture.destroy
+    else
+      
+      redirect_to(:action => :list)
+    end
+  end
+ 
+  # Détruit tous les mobiliers qui n'ont plus de panneaux associés
+  def destroydead
+    for furniture in Furniture.find_all
+      for column in Furniture.content_columns 
+        if Panel.find(:first,:conditions => [ "furniture_id = ?", params[:id]]) == nil
+          furniture.destroy
+        end
+      end
+    end
+    redirect_to :action => 'list'
+  end
+
+end

data/app/controllers/networks_controller.rb

@@ -0,0 +1,269 @@
+require 'ostruct'
+
+# == Gestion des réseaux de publicité
+#
+# Ce contrôleur gère les objets Network. Il permet de :
+#
+# * Lister les réseaux
+# * Créer/supprimer des réseaux
+# * Afficher et modifier le nom et le statut d'un réseau
+# * Modifier les paramètres d'un réseau :
+#   * Texture
+#   * Landmark
+#   * Notecard
+#   * URL
+#   * Media URL
+#   * etc.
+# * Ajouter/enlever des panneaux (Panel) d'un réseau.
+class NetworksController < ApplicationController
+  # Mise en page globale du site
+  layout "default"
+
+  # Renvoie vers l'action 'list'
+  def index
+    list
+    render :action => 'list'
+  end
+
+  # GETs should be safe (see http://www.w3.org/2001/tag/doc/whenToUseGet.html)
+  verify :method => :post, :only => [ :destroy, :create, :update, :set_parameters, :remove_panel, :add_panel ],
+         :redirect_to => { :action => :list }
+
+  # Liste des réseaux
+  def list
+    @network_pages, @networks = paginate :networks, :per_page => 10
+  end
+
+  # Affiche un réseau, ses caractéristiques et l'ensemble des panneaux membres.
+  # Affiche aussi les formulaire permettant de modifier le réseau, son paramétrage
+  # et sa composition.
+  def show
+    @network = Network.find(params[:id])
+    # La liste de tous les panneaux disponibles.
+    @unassigned_panels = Panel.unassigned_panels.map { |p| [ "#{p.name} (#{p.furniture.name})", p.id ]}
+    # On extrait les caractéristiques du réseau depuis le premier panneau
+    # XXX : Ceci suppose que tous les panneaux du réseau sont strictement dans la même configuration.
+    panel1 = @network.panels.first
+    if panel1
+      @network_parameters = OpenStruct.new(
+        :texture  => panel1.objects_in_world.find_by_otype("texture"),
+        :landmark => panel1.objects_in_world.find_by_otype("landmark"),
+        :notecard => panel1.objects_in_world.find_by_otype("notecard"),
+        :url      => panel1.objects_off_world.find_by_otype("url"),
+        :mediaurl => panel1.objects_off_world.find_by_otype("mediaurl")
+      )
+#      @network_parameters.texture_id  = @network_parameters.texture.id rescue nil
+#      @network_parameters.landmark_id = @network_parameters.landmark.id rescue nil
+#      @network_parameters.notecard_id = @network_parameters.notecard.id rescue nil
+#      @network_parameters.url_id      = @network_parameters.url.id rescue nil
+#      @network_parameters.mediaurl_id = @network_parameters.mediaurl.id rescue nil
+#
+#      @textures  = ObjectInWorld.find_all_by_otype("texture",   :order => "name").map { |t| [ t.name, t.id ] }
+#      @landmarks = [ [ 'No Landmark', nil ] ]  + ObjectInWorld.find_all_by_otype("landmark",  :order => "name").map { |t| [ t.name, t.id ] }
+#      @notecards = [ [ 'No Notecard', nil ] ]  + ObjectInWorld.find_all_by_otype("notecard",  :order => "name").map { |t| [ t.name, t.id ] }
+#      @urls      = [ [ 'No URL', nil ] ]       + ObjectOffWorld.find_all_by_otype("url",      :order => "name").map { |t| [ "#{t.name} : #{t.content}", t.id ] }
+#      @mediaurls = [ [ 'No Media URL', nil ] ] + ObjectOffWorld.find_all_by_otype("mediaurl", :order => "name").map { |t| [ "#{t.name} : #{t.content}", t.id ] }
+    else
+      @network_parameters = nil
+    end
+  end
+
+  # Affiche le formulaire de modification des paramètres du réseau, en AJAX
+  #
+  # == Input
+  #
+  # * id : Network id
+  def show_parameters_form
+    @network = Network.find(params[:id])
+    # On extrait les caractéristiques du réseau depuis le premier panneau
+    # XXX : Ceci suppose que tous les panneaux du réseau sont strictement dans la même configuration.
+    panel1 = @network.panels.first
+    @network_parameters = OpenStruct.new(
+      :texture  => panel1.objects_in_world.find_by_otype("texture"),
+      :landmark => panel1.objects_in_world.find_by_otype("landmark"),
+      :notecard => panel1.objects_in_world.find_by_otype("notecard"),
+      :url      => panel1.objects_off_world.find_by_otype("url"),
+      :mediaurl => panel1.objects_off_world.find_by_otype("mediaurl")
+    )
+    @network_parameters.texture_id  = @network_parameters.texture.id rescue nil
+    @network_parameters.landmark_id = @network_parameters.landmark.id rescue nil
+    @network_parameters.notecard_id = @network_parameters.notecard.id rescue nil
+    @network_parameters.url_id      = @network_parameters.url.id rescue nil
+    @network_parameters.mediaurl_id = @network_parameters.mediaurl.id rescue nil
+
+    @textures  = ObjectInWorld.find_all_by_otype("texture",   :order => "name").map { |t| [ t.name, t.id ] }
+    @landmarks = [ [ 'No Landmark', nil ] ]  + ObjectInWorld.find_all_by_otype("landmark",  :order => "name").map { |t| [ t.name, t.id ] }
+    @notecards = [ [ 'No Notecard', nil ] ]  + ObjectInWorld.find_all_by_otype("notecard",  :order => "name").map { |t| [ t.name, t.id ] }
+    @urls      = [ [ 'No URL', nil ] ]       + ObjectOffWorld.find_all_by_otype("url",      :order => "name").map { |t| [ "#{t.name} : #{t.content}", t.id ] }
+    @mediaurls = [ [ 'No Media URL', nil ] ] + ObjectOffWorld.find_all_by_otype("mediaurl", :order => "name").map { |t| [ "#{t.name} : #{t.content}", t.id ] }
+  end
+
+  # Formulaire de création d'un nouveau réseau.
+  def new
+    @network = Network.new
+  end
+
+  # Création d'un nouveau réseau vide.
+  #
+  # == Input
+  #
+  # * <tt>network[]</tt> : Paramètres de création du réseau
+  def create
+    @network = Network.new(params[:network])
+    if @network.save
+      flash[:notice] = 'Network was successfully created.'
+      redirect_to :action => 'show', :id => @network
+    else
+      render :action => 'new'
+    end
+  end
+
+  # Formulaire d'édition d'un réseau.
+  #
+  # == Input
+  #
+  # * +id+ : Network id
+  def edit
+    @network = Network.find(params[:id])
+  end
+
+  # Edition d'un réseau.
+  #
+  # == Input
+  #
+  # * +id+ : Network id
+  def update
+    @network = Network.find(params[:id])
+    if @network.update_attributes(params[:network])
+      flash[:notice] = 'Network was successfully updated.'
+      redirect_to :action => 'show', :id => @network
+    else
+      render :action => 'edit'
+    end
+  end
+
+  # Suppression d'un réseau.
+  #
+  # Tous les panneaux membres du réseau deviennent disponibles.
+  #
+  # == Input
+  #
+  # * +id+ : Network id
+  def destroy
+    network = Network.find(params[:id])
+    network.destroy
+    flash[:notice] = "Network '#{network.name}' deleted."
+    redirect_to :action => 'list'
+  end
+  
+  # Modifie les paramètres du réseau et de ses panneaux :
+  #
+  # * Texture
+  # * Notecard
+  # * Landmark
+  # * URL
+  # * Media URL
+  # * etc.
+  #
+  # La liste des ObjectInWold et ObjectOffWorld est dans les constantes TYPES
+  # définies dans chacun des deux modèles.
+  #
+  # Les paramètres sont fournis par l'action 'show'.
+  #
+  # == Input
+  #
+  # * +id+ : Network id
+  def set_parameters
+    network = Network.find(params[:id])
+    
+    # liste des panneaux à mettre à jour
+    panels = network.panels
+    # Messages à afficher
+    messages = []
+
+    # Traitement Texture, Landmark et Notecard (et autres)
+    ObjectInWorld::TYPES.each do |obj_type|
+      obj_id = params[:network_parameters]["#{obj_type}_id".intern]
+      # Si obj_id est une chaîne vide, alors il faut supprimer l'association avec ce type d'objet
+      # uniquement. Sinon il faut aussi le remplacer dans le nouvel objet.
+      obj = ObjectInWorld.find(obj_id) rescue nil
+      obj_name = obj ? obj.name : 'None'
+      panels.each do |p|
+        # On simule les expressions de type "p.texture = obj" avec 'send'
+        p.send("#{obj_type}=", obj)
+      end
+      messages << "#{obj_type.humanize} set to '%s'." % obj_name
+    end
+    
+    # Traitement URL, Media URL, etc
+    ObjectOffWorld::TYPES.collect { |t| t.last }.each do |obj_type|
+      obj_id = params[:network_parameters]["#{obj_type}_id".intern]
+      # Si obj_id est une chaîne vide, alors il faut supprimer l'association avec ce type d'objet
+      # uniquement. Sinon il faut aussi le remplacer dans le nouvel objet.
+      obj = ObjectOffWorld.find(obj_id) rescue nil
+      obj_name = obj ? obj.name : 'None'
+      panels.each do |p|
+        # On simule les expressions de type "p.url = obj" avec 'send'
+        p.send("#{obj_type}=", obj)
+      end
+      messages << "#{obj_type.humanize} set to '%s'." % obj_name
+    end
+    
+    if messages.empty?
+      flash[:notice] = "Network not modified"
+    else
+      panels.each { |p| p.save! }
+      flash[:notice] = messages.join(" ")
+    end
+    redirect_to :action => 'show', :id => network
+  end
+  
+  # Enlève un panneau d'un réseau, sans le supprimer.
+  #
+  # == Input
+  #
+  # * +id+ : Network id
+  # * Variable POST +panel_id+ : Panel id
+  def remove_panel
+    network = Network.find(params[:id])
+    panel = network.panels.find(params[:panel_id])
+    network.panels.delete(panel)
+    flash[:notice] = "Panel '#{panel.name} : #{panel.furniture.name}' removed from network."
+    redirect_to :action => 'show', :id => network
+  rescue ActiveRecord::RecordNotFound
+    flash[:notice] = "Remove panel: Invalid network id ('#{params[:id]}') or panel id ('#{params[:panel_id]}')."
+    redirect_to :action => 'list'
+  end
+
+  # Ajoute un panneau dans un réseau.
+  #
+  # == Input
+  #
+  # * Variable POST +panel_id+
+  def add_panel
+    network = Network.find(params[:id])
+    panel = Panel.find(params[:panel_id])
+    # On n'ajoute pas un panneau déjà membre d'un autre réseau
+    if panel.network.nil?
+      # Si le réseau a déjà des panneaux, donc des caractéristiques, il faut les appliquer
+      # au nouveau panneau
+      reference_panel = network.panels.first
+      if reference_panel
+        panel.texture  = reference_panel.texture
+        panel.notecard = reference_panel.notecard
+        panel.landmark = reference_panel.landmark
+        panel.url      = reference_panel.url
+        panel.mediaurl = reference_panel.mediaurl
+      end
+      # Et maintenant on ajoute le panneau au réseau
+      network.panels << panel
+      flash[:notice] = "Panel '#{panel.name} : #{panel.furniture.name}' added to network."
+    else
+      flash[:notice] = "Panel '#{panel.name} : #{panel.furniture.name}' already belongs to a network ('#{panel.network.name}')."
+    end
+    redirect_to :action => 'show', :id => network
+  rescue ActiveRecord::RecordNotFound
+    flash[:notice] = "Add panel: Invalid network id ('#{params[:id]}') or panel id ('#{params[:panel_id]}')."
+    redirect_to :action => 'list'
+  end
+end

data/app/controllers/objects_in_world_controller.rb

@@ -0,0 +1,27 @@
+# == Contrôleur de gestion des ObjectInWorld
+#
+# Ce contrôleur liste les ObjectInWorld.
+class ObjectsInWorldController < ApplicationController
+  # Mise en page globale du site
+  layout "default"
+  
+  # Renvoie vers l'action 'list'
+  def index
+    list
+    render :action => 'list'
+  end
+
+  # GETs should be safe (see http://www.w3.org/2001/tag/doc/whenToUseGet.html)
+  verify :method => :post, :only => [ :destroy, :create, :update ],
+         :redirect_to => { :action => :list }
+
+  # Liste des ObjectInWorld
+  def list
+    @object_in_world_pages, @objects_in_world = paginate :objects_in_world, :per_page => 10
+  end
+
+  # Détail d'un ObjectInWorld
+  def show
+    @object_in_world = ObjectInWorld.find(params[:id])
+  end
+end

data/app/controllers/panels_controller.rb

@@ -0,0 +1,186 @@
+# == Gestion des panneaux
+#
+# Ce contrôleur gère les panneaux (Panel). Il permet de :
+#
+# * Liste les panneaux
+# * Enregistrer un nouveau panneau depuis SL
+# * Mettre à jour un panneau depuis SL
+# * Enregistrer le clic d'un avatar dans SL et lui envoyer URL ou Media URL
+class PanelsController < ApplicationController
+  # Mise en page globale du site
+  layout "default"
+  
+  # Filtre de récupération des paramètres Second Life
+  before_filter :get_secondlife_attrs, :only => [ :register, :update, :avtouch ]
+  
+  # Affiche l'index, par défaut la liste des panneaux
+  def index
+    list
+    render :action => 'list'
+  end
+
+  # GETs should be safe (see http://www.w3.org/2001/tag/doc/whenToUseGet.html)
+  verify :method => :post, :only => [ :register ],
+         :redirect_to => { :action => :list }
+
+  # Liste des panneauxs disponibles
+  def list
+    @panel_pages, @panels = paginate :panels, :per_page => 10
+  end
+
+  # Affiche le détail d'un panneau
+  def show
+    @panel = Panel.find(params[:id])
+  end
+
+  # Enregistrement d'un nouveau panneau
+  #
+  # == Input
+  # * Environnement Second Life transmis en HTTP
+  # * +furniture_key+:: Clé SL du mobilier possédant ce panneau
+  #
+  # == Output
+  # * Le délai de mise à jour, sous la forme :
+  #
+  #  delay=delay
+  def register
+    # Quel est le mobilier parent ?
+    furniture_key = params[:furniture_key]
+    furniture = Furniture.find_by_furniture_key(furniture_key)
+    if furniture.nil?
+      render :text => "The furniture id '#{furniture_key}' does not exist.",
+             :status => "409 Undefined furniture '#{furniture_key}'",
+             :layout => false,
+             :content_type => "text/plain"
+      return
+    end
+    # Création ou mise à jour du panneau
+    panel = Panel.find_or_initialize_by_panel_key(@slattrs[:key])
+    panel.furniture = furniture
+    panel.update_attributes!(:name => @slattrs[:name])
+    
+    render :text => "delay=%#{furniture.delay}%",
+           :layout => false,
+           :content_type => "text/plain"
+  end
+
+  # Mise à jour du panel
+  #
+  # == Input
+  # * Environnement Second Life transmis en HTTP
+  #
+  # == Output
+  # * Le délai de mise à jour, la texture, l'url, la media url sous la forme suivante avec un attribut par ligne :
+  #
+  #  delay=delay
+  #  texture=texture_key
+  #  url=url
+  #  mediaurl=mediaurl
+  #
+  # Quand il n'y a pas d'URL ou de Media URL, le contenu envoyé est respectivement +nourl+ ou +nomedia+.
+  def update
+    # Mise à jour du panel
+    panel = Panel.find_by_panel_key(@slattrs[:key])
+    if panel.nil?
+      render :text => "The panel id '#{@slattrs[:key]}' does not exist.",
+             :status => "409 Undefined panel '#{@slattrs[:key]}'",
+             :layout => false,
+             :content_type => "text/plain"
+      return
+    end
+    # Trouve la texture associée
+    texture = panel.texture.object_key
+    # Trouve les URL et Media URL associées, ou une valeur par défaut
+    url = if (obj = panel.url)
+            obj.content
+          else "nourl" end
+    mediaurl = if (obj = panel.mediaurl)
+                 obj.content
+               else "nomedia" end
+
+    # Construit et envoie la réponse
+    panel_response = [ ["delay", panel.furniture.delay], 
+                       ["texture", texture], 
+                       ["url", url], 
+                       ["mediaurl", mediaurl] ].map { |pair| "#{pair[0]}=#{pair[1]}" }.join("\n")
+    render :text => panel_response,
+           :layout => false,
+           :content_type => "text/plain"
+  end
+
+  # Un avatar clique sur le panel
+  #
+  # == Input
+  # * Environnement Second Life transmis en HTTP
+  # * +avatar_key+ : Clé SL de l'avatar qui a cliqué
+  #
+  # == Output
+  # * Le serveur envoie 1 ou 2 mails à des containers pour qu'ils envoient à leur tour
+  #   un landmark et/ou une notecard à l'avatar.
+  def avtouch
+    # Récupère le panel, l'avatar, la notecard, le landmark
+    panel = Panel.find_by_panel_key(@slattrs[:key])
+    if panel.nil?
+      render :text => "The panel id '#{@slattrs[:key]}' does not exist.",
+             :status => "409 Undefined panel '#{@slattrs[:key]}'",
+             :layout => false,
+             :content_type => "text/plain"
+      return
+    end
+    if !(avatar_key = params[:avatar_key])
+      render :text => "Missing avatar key.",
+             :status => "409 Missing avatar key",
+             :layout => false,
+             :content_type => "text/plain"
+      return
+    end
+    # Trouve les landmark et notecard associés, ou une valeur par défaut
+    landmark = panel.landmark
+    notecard = panel.notecard
+
+    # On envoie successivement un mail pour landmark et un pour notecard,
+    # mais uniquement s'il y a quelque chose à envoyer (!= nil).
+    [ landmark, notecard ].each do |obj|
+      Mailer.deliver_avtouch(obj.container.container_key,
+                             avatar_key,
+                             obj.name) if obj
+    end
+    # Fini
+    render :text => "Objects sent.",
+           :layout => false,
+           :content_type => "text/plain"
+  end
+  
+  # Si le panneau n'a pas donné signe de vie depuis 5 fois le délais prévu
+  # on le supprime de la base
+  def destroy
+    # On récupère le delay du furniture associé
+    panel = Panel.find(params[:id])
+    delay =   Furniture.find(panel.furniture.id).delay
+    updated_time = panel.updated_at  + 5 * delay * 60
+    # Si la date actuelle est > à date du updated_at + 5xdelay (également présent dans la vue)
+    # 
+    # on affiche le bouton de suppression
+    if updated_time < Time::now
+      # On sauve dans la table revision
+      # save_to_revision_table
+      panel.destroy
+    end
+    redirect_to :action => 'list'
+  end
+  
+  # Détruit tous les panneaux qui n'ont pas contacté le serveur
+  # depuis 5 x le delay
+  def destroydead
+    for panel in Panel.find_all
+      for column in Panel.content_columns 
+        if (panel.updated_at  + 5 * Furniture.find(panel.furniture.id).delay * 60) < Time.now 
+          panel.destroy
+        end
+      end
+    end
+    redirect_to :action => 'list'
+  end
+
+end
+