advertnet 1.0.0

data/README

@@ -0,0 +1,257 @@
+= AdvertNet
+
+A tool for managing multiple networks of advertising boards.
+
+Copyright (C) 2007 Pragmatic Source
+
+Authors:
+* Farzad Farid <ffarid@pragmatic-source.com>: Main developper
+* Yves Rougy <yrougy@gmail.com>: Development, Data modeling, first version of the application in PHP
+* Loïc Dachary <loic@dachary.org>: Packaging, Testing.
+
+  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 3 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, see <http://www.gnu.org/licenses/>.
+
+== INSTALLATION
+
+=== Dependencies
+
+This application needs a MySQL 5.0 database.
+
+After installing MySQL, create 3 databases:
+* advertnet_development
+* advertnet_test
+* advertnet_production
+
+The default "<tt>config/database.yml</tt>" is configured to use the "+root+" account
+<em>without a password</em>. You must eventually edit it in order to change the login
+or add a password.
+
+For example, you can create a user, for example +advertnet+ and give it
+read/write access (select, insert, update, create table, drop table, alter
+table, etc.) on the 3 databases.
+
+=== Basic MySQL configuration
+
+Run the following commands <em>as root</em> (for example on a Debian system):
+
+  for i in development test production ; do mysqladmin -u root create advertnet_$i ; done
+
+Now create the SQL tables, run these commands from Advertnet's root directory:
+
+  rake db:migrate RAILS_ENV=development
+  rake db:migrate RAILS_ENV=production
+
+=== Testing the configuration
+
+To ensure that the application works correctly, first run the following commands:
+
+  rake db:test:prepare
+  rake test
+  
+*Note*: There is at least one unit test that is known to fails, other unit
+tests and all functional tests should pass correctly.
+
+= Rails documentation
+
+You will find below the original, unmodified, Rails documentation.
+
+To generate the application's technical documentation in HTML format, run:
+
+  rake doc:app_utf8
+
+The whole documentation will then be available as HTML files in the "doc/app"
+directory, starting at "index.html".
+
+== Welcome to Rails
+
+Rails is a web-application and persistence framework that includes everything
+needed to create database-backed web-applications according to the
+Model-View-Control pattern of separation. This pattern splits the view (also
+called the presentation) into "dumb" templates that are primarily responsible
+for inserting pre-built data in between HTML tags. The model contains the
+"smart" domain objects (such as Account, Product, Person, Post) that holds all
+the business logic and knows how to persist themselves to a database. The
+controller handles the incoming requests (such as Save New Account, Update
+Product, Show Post) by manipulating the model and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails.  You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting started
+
+1. At the command prompt, start a new rails application using the rails command
+   and your application name. Ex: rails myapp
+   (If you've downloaded rails in a complete tgz or zip, this step is already done)
+2. Change directory into myapp and start the web server: <tt>script/server</tt> (run with --help for options)
+3. Go to http://localhost:3000/ and get "Welcome aboard: You’re riding the Rails!"
+4. Follow the guidelines to start developing your application
+
+
+== Web Servers
+
+By default, Rails will try to use Mongrel and lighttpd if they are installed, otherwise
+Rails will use the WEBrick, the webserver that ships with Ruby. When you run script/server,
+Rails will check if Mongrel exists, then lighttpd and finally fall back to WEBrick. This ensures
+that you can always get up and running quickly.
+
+Mongrel is a Ruby-based webserver with a C-component (which requires compilation) that is
+suitable for development and deployment of Rails applications. If you have Ruby Gems installed,
+getting up and running with mongrel is as easy as: <tt>gem install mongrel</tt>.
+More info at: http://mongrel.rubyforge.org
+
+If Mongrel is not installed, Rails will look for lighttpd. It's considerably faster than
+Mongrel and WEBrick and also suited for production use, but requires additional
+installation and currently only works well on OS X/Unix (Windows users are encouraged
+to start with Mongrel). We recommend version 1.4.11 and higher. You can download it from
+http://www.lighttpd.net.
+
+And finally, if neither Mongrel or lighttpd are installed, Rails will use the built-in Ruby
+web server, WEBrick. WEBrick is a small Ruby web server suitable for development, but not
+for production.
+
+But of course its also possible to run Rails on any platform that supports FCGI.
+Apache, LiteSpeed, IIS are just a few. For more information on FCGI,
+please visit: http://wiki.rubyonrails.com/rails/pages/FastCGI
+
+
+== Debugging Rails
+
+Have "tail -f" commands running on the server.log and development.log. Rails will
+automatically display debugging and runtime information to these files. Debugging
+info will also be shown in the browser on requests from 127.0.0.1.
+
+
+== Breakpoints
+
+Breakpoint support is available through the script/breakpointer client. This
+means that you can break out of execution at any point in the code, investigate
+and change the model, AND then resume execution! Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.find(:all)
+      breakpoint "Breaking out from the list"
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the breakpointer window. Here you can do things like:
+
+Executing breakpoint "Breaking out from the list" at .../webrick_server.rb:16 in 'breakpoint'
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8 @attributes={\"title\"=>nil, \"body\"=>nil, \"id\"=>\"1\"}>,
+       #<Post:0x14a6620 @attributes={\"title\"=>\"Rails you know!\", \"body\"=>\"Only ten..\", \"id\"=>\"2\"}>]"
+  >> @posts.first.title = "hello from a breakpoint"
+  => "hello from a breakpoint"
+
+...and even better is that you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you press CTRL-D
+
+
+== Console
+
+You can interact with the domain model by starting the console through <tt>script/console</tt>.
+Here you'll have all parts of the application configured, just like it is when the
+application is running. You can inspect domain models, change values, and save to the
+database. Starting the script without arguments will launch it in the development environment.
+Passing an argument will specify a different environment, like <tt>script/console production</tt>.
+
+To reload your controllers and models after launching the console run <tt>reload!</tt>
+
+To reload your controllers and models after launching the console run <tt>reload!</tt>
+
+
+
+== Description of contents
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from ApplicationController
+  which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb.
+  Most models will descend from ActiveRecord::Base.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.rhtml for the WeblogsController#index action. All views use eRuby
+  syntax.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the common
+  header/footer method of wrapping views. In your views, define a layout using the
+  <tt>layout :default</tt> and create a file named default.rhtml. Inside default.rhtml,
+  call <% yield %> to render the view using this layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are generated
+  for you automatically when using script/generate for controllers. Helpers can be used to
+  wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database, and other dependencies.
+
+components
+  Self-contained mini-applications that can bundle together controllers, models, and views.
+
+db
+  Contains the database schema in schema.rb.  db/migrate contains all
+  the sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when generated
+  using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that doesn't
+  belong under controllers, models, or helpers. This directory is in the load path.
+
+public
+  The directory available for the web server. Contains subdirectories for images, stylesheets,
+  and javascripts. Also contains the dispatchers and the default HTML files. This should be
+  set as the DOCUMENT_ROOT of your web server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the script/generate scripts, template
+  test files will be generated for you and placed in this directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins subdirectory.
+  This directory is in the load path.

data/Rakefile

@@ -0,0 +1,10 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require(File.join(File.dirname(__FILE__), 'config', 'boot'))
+
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+require 'tasks/rails'

data/app/controllers/application.rb

@@ -0,0 +1,40 @@
+# Filters added to this controller apply to all controllers in the application.
+# Likewise, all the methods added will be available for all controllers.
+
+class ApplicationController < ActionController::Base
+  # Pick a unique cookie name to distinguish our session data from others'
+  session :session_key => '_advertnet_session_id'
+
+  private
+  
+  # Filtre de préparation des attributs Second Life.
+  #
+  # * Récupère les attributs Second Life de l'objet qui a appelé Rails.
+  # * Envoie une page d'erreur et arrête le traitement normal de l'action si les attributs sont absents de la requête HTTP.
+  #
+  # Ce filtre crée un attribut <tt>@slattrs</tt> contenant les clés suivantes :
+  # +key+:: Object Key
+  # +sim+:: Nom de la sim/région
+  # +position+:: Coordonnées dans la sim
+  # +name+:: Nom de l'objet appelant
+  #
+  # *Note* : +sim+ et +position+ sont au format SL, pas normalisés. Cf SecondLifeSimPosNormalizer.
+  def get_secondlife_attrs #:doc:
+    if request.env.include?("HTTP_X_SECONDLIFE_OBJECT_KEY")
+      @slattrs = {
+             :key => request.env["HTTP_X_SECONDLIFE_OBJECT_KEY"],
+             :sim => request.env["HTTP_X_SECONDLIFE_REGION"],
+        :position => request.env["HTTP_X_SECONDLIFE_LOCAL_POSITION"],
+            :name => request.env["HTTP_X_SECONDLIFE_OBJECT_NAME"]
+      }    
+    else
+      # Envoie une erreur et arrête le traitement
+      render :text => "Missing Second Life environment",
+             :status => "409 Missing Second Life environment",
+             :layout => false,
+             :content_type => "text/plain"
+      return false
+    end
+  end
+  
+end

data/app/controllers/container_controller.rb

@@ -0,0 +1,83 @@
+class ContainerController < ApplicationController
+  # Mise en page globale du site
+  layout "default"
+  
+  # Renvoi 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, :register ],
+         :redirect_to => { :action => :list }
+
+  # Affiche une liste, en lecture seule, des Container SL.
+  def list
+    @container_pages, @containers = paginate :containers, :per_page => 10
+  end
+
+  # Enregistrement ou mise à jour d'un container et de ses objects in world.
+  # Cette action est appelée en +POST+ avec un seul paramètre, +content+.
+  # Le format de données est l'un des 2 suivants :
+  #
+  # * nom1|key1|type1,nom2|key2,type2,...
+  # * nom1|key1,nom2|key2,...
+  #
+  # Si le champ +type+ n'est pas donné, il prend la valeur par défaut "texture".
+  #
+  # Après la création ou mise à jour du container, tous ses objets sont mises à jour :
+  # * ceux qui n'existent plus sont supprimés
+  # * les objets à modifier sont mis à jour
+  # * les nouveaux objets sont créés
+  def register
+    # Récupère les paramètres fournis par Second Life
+    slattrs = get_secondlife_attrs
+    # Création ou mise à jour du container
+    container = Container.find_or_initialize_by_container_key(slattrs.delete(:key))
+    container.update_attributes!(slattrs)
+    # Maintenant création ou mise à jour des objets
+    # Les objets sont séparés par des virgules
+    objects = params[:content].split(/,/).collect { |line|
+      # Les champs sont séparés par une barre verticale
+      fields = line.split(/\|/)
+      # Conservation de la structure historique du script Webia en PHP,
+      # qui avait une version spéciale uniquement pour les textures,
+      # dont le champ type était donc implicite.
+      fields = fields + ["texture"] if fields.size == 2
+      object = ObjectInWorld.find_or_initialize_by_object_key(fields[1])
+      object.update_attributes!(:name => fields[0], :otype => fields[2], :container => container)
+      object
+    }
+    # Et on remplace les objets existants par ceux-là, avec une fonction qui
+    # optimise les ajouts/suppressions
+    container.objects_in_world.replace(objects)
+    
+    render :nothing => true
+  end
+  
+  # Affiche le détail d'un Container
+  def show
+    @container = Container.find(params[:id])
+  end
+
+  # Destruction d'un Container.
+  #
+  # *Important* : la version actuelle refuse de détruire un Container non vide.
+  def destroy
+    # XXX : Ce n'est pas propre, mais puisqu'on est obligé d'avoir ":dependent => :destroy"
+    # dans la relation entre un container et les objets in world, c'est dans le controleur
+    # qu'on doit s'assurer qu'il n'est pas interdit de supprimer un container plein...
+    container = Container.find(params[:id])
+    if container.objects_in_world.empty?
+      container.destroy
+      redirect_to :action => 'list'
+    else
+      # Interdiction de supprimer un conteneur plein
+      render :text => "Cannot delete a non-empty container.",
+             :status => "409 Container not empty",
+             :layout => false,
+             :content_type => "text/plain"
+    end
+  end
+end

data/app/controllers/content_controller.rb

@@ -0,0 +1,61 @@
+# == Gestion des ObjectOffWorld : URL, Media URL, etc.
+# 
+# Ce contrôleur permet la création et la consultation des objets de type
+# ObjectOffWorld.
+class ContentController < 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 => :index }
+
+  # Liste les ObjectOffWorld
+  def list
+    @object_off_world_pages, @objects_off_world = paginate :objects_off_world, :per_page => 10
+  end
+
+  # Affichage du formulaire de création d'un nouvel ObjectOffWorld
+  def new
+    @object_off_world = ObjectOffWorld.new
+  end
+
+  # Création du nouvel ObjectOffWorld
+  def create
+    @object_off_world = ObjectOffWorld.new(params[:object_off_world])
+    if @object_off_world.save
+      flash[:notice] = "Object '#{@object_off_world.name}' was successfully created."
+      redirect_to :action => 'list'
+    else
+      render :action => 'new'
+    end
+  end
+
+  # Affichage du formulaire d'édition d'un ObjectOffWorld
+  def edit
+    @object_off_world = ObjectOffWorld.find(params[:id])
+  end
+
+  # Modification d'un ObjectOffWorld
+  def update
+    @object_off_world = ObjectOffWorld.find(params[:id])
+    if @object_off_world.update_attributes(params[:object_off_world])
+      flash[:notice] = "Object '#{@object_off_world.name}' was successfully updated."
+      redirect_to :action => 'list'
+    else
+      render :action => 'edit'
+    end
+  end
+
+  # Suppression d'un ObjectOffWorld
+  def destroy
+    ObjectOffWorld.find(params[:id]).destroy
+    redirect_to :action => 'list'
+  end
+end