artemk-ckeditor 3.4.3

data/README.rdoc

@@ -0,0 +1,161 @@
+=Rails CKEditor integration plugin with SWFUpload support
+
+CKEditor is a text editor to be used inside web pages. It's a WYSIWYG editor, which means that the text being edited on it looks as similar as possible to 
+the results users have when publishing it. It brings to the web common editing features found on desktop editing applications like Microsoft Word and OpenOffice.
+
+Because CKEditor is licensed under flexible Open Source and commercial licenses, you'll be able to integrate and use it inside any kind of application. 
+This is the ideal editor for developers, created to provide easy and powerful solutions to their users.
+
+CKEditor version: 3.4.2 (http://ckeditor.com)
+
+SWFUpload version: 2.2.0.1 Core (http://swfupload.org)
+
+{Demo appication (Rails 2.3.8)}[http://github.com/galetahub/rails-ckeditor-demo-app]
+
+==Install
+
+===Rails 2.3.8
+
+Via gem:
+  config.gem 'ckeditor', '3.4.3'
+
+Via plugin
+  ./script/plugin install git://github.com/galetahub/rails-ckeditor.git
+
+Next step is generate ckeditor js files and configuration file
+Check "config/initializers/ckeditor.rb" for more configuration options:
+  
+  ./script/generate ckeditor_install
+
+Generate ckeditor models for file upload support:
+For paperclip:
+
+  ./script/generate ckeditor_migration
+
+For attachment_fu:
+  ./script/generate ckeditor_migration --backend=attachment_fu
+
+Don't forget about migration:
+
+  rake db:migrate
+
+In your environment:
+
+  config.load_paths += %W( #{RAILS_ROOT}/app/models/ckeditor )
+
+===Rails 3.0.0
+
+  gem 'ckeditor', '3.4.2.pre'
+
+Or
+
+  gem 'ckeditor', :git => 'git://github.com/galetahub/rails-ckeditor.git', :branch => 'rails3'
+
+Next step is generate ckeditor js files and configuration file
+Check "config/initializers/ckeditor.rb" for more configuration options:
+
+  rails generate ckeditor:base
+
+Generate ckeditor models for file upload support:
+For paperclip:
+
+  rails generate ckeditor:migration
+
+For attachment_fu:
+
+  rails generate ckeditor:migration --backend=attachment_fu
+
+Don't forget about migration:
+
+  rake db:migrate
+  
+In your application.rb:
+
+  config.autoload_paths += %W( #{config.root}/app/models/ckeditor )
+
+==Usage
+
+Basically include this in the page you wish to use the editor in:
+  <%= javascript_include_tag :ckeditor %>
+
+Then instead of the normal textarea helper from Rails use this one:
+  <%= ckeditor_textarea("object", "field", :width => '100%', :height => '200px') %>
+
+FormBuilder helper for more usefully:
+
+  <%= form_for @page do |form| -%>
+    ...
+    <%= form.cktext_area :notes, :toolbar=>'Full', :width=>'400px', :height=>'200px' %>
+    ...
+    <%= form.cktext_area :content, :swf_params=>{:assetable_type=>'User', :assetable_id=>current_user.id} %>
+    ...
+  <% end -%>
+  
+===Support options
+  :cols         # Textarea cols (default: 70)
+  :rows         # Textarea rows (default: 20)
+  :width        # Editor width (default: 100%)
+  :height       # Editor height (default: 100%)
+  :class        # Textarea css class name
+  :toolbar      # Toolbar name
+  :skin         # Editor skin
+  :language     # Editor language (default: I18n.locale)
+  :swf_params   # SWFUpload additional params (Hash)
+  :id           # textarea DOM element id
+  :index        # element id index 
+
+For configure ckeditor default options check:
+  public/javascripts/ckeditor/config.js
+  
+This stylesheet use editor for displaying edit area:
+  public/javascripts/ckeditor/contents.css
+  
+===AJAX
+
+To use a remote form you need to call "ckeditor_ajax_script" helper method:
+
+  <%= form_for @page, :remote => true do |form| -%>
+    <%= form.cktext_area("note", "content") %>
+    ...
+    <%= form.cktext_area("note", "about") %>
+    ...
+    <%= ckeditor_ajax_script %>
+  <% end %>
+
+Helper "ckeditor_ajax_script" generate next script (jquery):
+
+  <script type='text/javascript' charset='UTF-8'>
+    $(document).ready(function(){  
+      $('form[data-remote]').bind("ajax:before", function(){
+        for (instance in CKEDITOR.instances){
+          CKEDITOR.instances[instance].updateElement();
+        }
+      });
+    });
+  </script>
+
+==File uploads
+
+We recommend using a paperclip plugin for file storage and processing images. Controller @../rails-ckeditor/app/controllers/ckeditor_controller.rb@ has actions 
+for displaying and uploading files. It uses classes Picture and AttachmentFile, who are descendants of the Asset class. So, your project must have these classes.
+
+  http://github.com/thoughtbot/paperclip
+
+For S3 storage look at "../ckeditor/examples/s3"
+
+==Formtastic integration
+Ckeditor detects if your use Formtastic and appends "Ckeditor::CustomFormBuilder".
+
+  <%= form.input :content, :as => :ckeditor %>
+
+==Middleware
+
+Ckeditor appends middleware ("Ckeditor::Middleware") before session store to 
+support swf upload with AuthenticityToken.
+
+  rake middleware
+
+==TODOs
+
+1. Add support for choose filemanager storage
+2. More integration upload system

data/Rakefile

@@ -0,0 +1,45 @@
+# encoding: utf-8
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require File.join(File.dirname(__FILE__), 'lib', 'ckeditor', 'version')
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the ckeditor plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the ckeditor plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Ckeditor'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "artemk-ckeditor"
+    gemspec.version = Ckeditor::Version.dup
+    gemspec.summary = "Rails plugin for integration ckeditor 3.x"
+    gemspec.description = "CKEditor is a WYSIWYG editor to be used inside web pages"
+    gemspec.email = "galeta.igor@gmail.com"
+    gemspec.homepage = "http://github.com/galetahub/rails-ckeditor"
+    gemspec.authors = ["Igor Galeta"]
+    gemspec.files = FileList["[A-Z]*", "{app,config,lib,generators,examples}/**/*"]
+    gemspec.rubyforge_project = "artemk-ckeditor"
+    
+    gemspec.add_dependency('mime-types', '>= 1.16')
+  end
+  
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with: gem install jeweler"
+end

data/app/controllers/ckeditor_controller.rb

@@ -0,0 +1,85 @@
+class CkeditorController < ApplicationController
+  skip_before_filter :verify_authenticity_token, :only => [:create]
+  before_filter :swf_options, :only => [:images, :files, :create]
+  layout "ckeditor"
+  
+  # GET /ckeditor/images
+  def images
+    @images = Ckeditor.image_model.find(:all, :order=>"id DESC")
+    
+    respond_to do |format|
+      format.html {}
+      format.xml { render :xml=>@images }
+    end
+  end
+  
+  # GET /ckeditor/files
+  def files
+    @files = Ckeditor.file_model.find(:all, :order=>"id DESC")
+    
+    respond_to do |format|
+      format.html {}
+      format.xml { render :xml=>@files }
+    end
+  end
+  
+  # POST /ckeditor/create/:kind
+  def create
+    @kind = params[:kind] || 'file'
+    
+    unless params[:CKEditor].blank?	  
+	    params[@swf_file_post_name] = params.delete(:upload)
+	  end
+	  
+    klass = case @kind.downcase
+      when 'file'  then Ckeditor.file_model
+			when 'image' then Ckeditor.image_model
+	  end
+  
+	  @record = klass.new
+	  
+	  options = {}
+	  
+	  params.each do |k, v|
+	    key = k.to_s.downcase
+	    options[key] = v if @record.respond_to?("#{key}=")
+	  end
+    
+    @record.attributes = options
+    @record.user ||= current_user if respond_to?(:current_user)
+    
+    if @record.valid? && @record.save
+      @text = params[:CKEditor].blank? ? @record.to_json(:only=>[:id, :type], :methods=>[:url, :content_type, :size, :filename, :format_created_at], :root => "asset") : %Q"<script type='text/javascript'>
+        window.parent.CKEDITOR.tools.callFunction(#{params[:CKEditorFuncNum]}, '#{Ckeditor::Utils.escape_single_quotes(@record.url_content)}');
+      </script>"
+      
+      render :text => @text
+    else
+      render :nothing => true
+    end
+  end
+
+  private
+    
+    def swf_options
+      @swf_file_post_name = Ckeditor.swf_file_post_name
+      
+      if params[:action] == 'images'
+        @file_size_limit        = Ckeditor.swf_image_file_size_limit
+			  @file_types             = Ckeditor.swf_image_file_types
+			  @file_types_description = Ckeditor.swf_image_file_types_description
+			  @file_upload_limit      = Ckeditor.swf_image_file_upload_limit
+		  else
+		    @file_size_limit        = Ckeditor.swf_file_size_limit
+		    @file_types             = Ckeditor.swf_file_types
+		    @file_types_description = Ckeditor.swf_file_types_description
+		    @file_upload_limit      = Ckeditor.swf_file_upload_limit
+		  end
+      
+      @swf_file_post_name ||= 'data'
+      @file_size_limit ||= "5 MB"
+      @file_types ||= "*.jpg;*.jpeg;*.png;*.gif"
+      @file_types_description ||= "Images"
+      @file_upload_limit ||= 10
+    end
+end

data/app/helpers/ckeditor_helper.rb

@@ -0,0 +1,38 @@
+module CkeditorHelper
+  def ckeditor_attachment_path(kind)
+    path = case kind
+      when :image then Ckeditor.file_manager_image_upload_uri
+      when :file  then Ckeditor.file_manager_upload_uri
+      else '/ckeditor/create/default'
+    end
+    
+    session_key = ActionController::Base.session_options[:key]
+    
+    options = ActionController::Routing::Routes.recognize_path(path, :method => :post)
+    
+    options[:protocol] = "http://"
+    options[session_key] = Rack::Utils.escape(cookies[session_key])
+    
+    if protect_against_forgery?
+      options[request_forgery_protection_token] = Rack::Utils.escape(form_authenticity_token)
+    end
+    
+    url_for(options)
+  end
+  
+  def file_image_tag(filename, path)
+    extname = File.extname(filename)
+    
+    image = case extname.to_s
+      when '.swf' then '/javascripts/ckeditor/images/swf.gif'
+      when '.pdf' then '/javascripts/ckeditor/images/pdf.gif'
+      when '.doc', '.txt' then '/javascripts/ckeditor/images/doc.gif'
+      when '.mp3' then '/javascripts/ckeditor/images/mp3.gif'
+      when '.rar', '.zip', '.tg' then '/javascripts/ckeditor/images/rar.gif'
+      when '.xls' then '/javascripts/ckeditor/images/xls.gif'
+      else '/javascripts/ckeditor/images/ckfnothumb.gif'
+    end
+    
+    image_tag(image, :alt=>path, :title=>filename, :onerror=>"this.src='/javascripts/ckeditor/images/ckfnothumb.gif'", :class=>'image')
+  end
+end

data/app/views/ckeditor/_asset.html.erb

@@ -0,0 +1,15 @@
+<div class="FCKThumb">
+  <table border="0" cellpadding="0" cellspacing="0" height="100" width="100">
+    <tbody>
+      <tr>
+        <td align="center" valign="middle">
+          <%= image_tag(asset.url_thumb, :alt => asset.url_content, :title => asset.filename, :onerror=>"this.src='/javascripts/ckeditor/images/ckfnothumb.gif'", :class=>'image') %>
+        </td>
+       </tr>
+     </tbody>
+   </table>
+   
+   <div class="FCKFileName"><%= asset.filename %></div>
+   <div class="FCKFileDate"><%= asset.format_created_at %></div>
+   <div class="FCKFileSize"><%= number_to_human_size(asset.size, :precision => 2) %></div>
+</div>

data/app/views/ckeditor/_swfupload.html.erb

@@ -0,0 +1,51 @@
+<script type="text/javascript">
+		var swfu = null;
+	
+		function init_swfupload() {
+		  var params = editor.config['swf_params'];
+		
+			swfu = new SWFUpload({
+				// Backend settings
+				upload_url: upload_path,
+				post_params: params,
+				file_post_name: "<%= @swf_file_post_name %>",
+
+				// Flash file settings
+				file_size_limit : "<%= @file_size_limit %>",
+				file_types : "<%= @file_types %>",
+				file_types_description : "<%= @file_types_description %>",
+				file_upload_limit : "<%= @file_upload_limit %>",
+				file_queue_limit : 0,
+
+				// The event handler functions are defined in handlers.js
+				//swfupload_loaded_handler : swfUploadLoaded,
+				file_queued_handler : fileQueued,
+				file_queue_error_handler : fileQueueError,
+				file_dialog_complete_handler : fileDialogComplete,
+				upload_start_handler : uploadStart,
+				upload_progress_handler : uploadProgress,
+				upload_error_handler : uploadError,
+				upload_success_handler : uploadSuccess,
+				upload_complete_handler : uploadComplete,
+				queue_complete_handler : queueComplete,	// Queue plugin event
+
+				// Button Settings
+				button_image_url : "/javascripts/ckeditor/images/select_files.png",
+				button_placeholder_id : "spanButtonPlaceholder",
+				button_width: 117,
+				button_height: 29,
+				button_window_mode: SWFUpload.WINDOW_MODE.TRANSPARENT,
+				button_cursor: SWFUpload.CURSOR.HAND,
+				
+				// Flash Settings
+				flash_url : "/javascripts/ckeditor/swfupload/swfupload.swf",
+
+				custom_settings : { 
+					progressTarget : "divFileProgressContainer"
+				},
+				
+				// Debug settings
+				debug: false
+			});
+		};
+</script>

data/app/views/ckeditor/files.html.erb

@@ -0,0 +1,91 @@
+<script type="text/javascript">	  
+  var upload_path = "<%=raw ckeditor_attachment_path(:file) %>";
+  
+  function setUrl(url) 
+  {  
+    CKEDITOR.tools.callFunction(CKEditorFuncNum, url);
+    window.close();
+  }
+  
+  function uploadButton(button)
+  {
+    var element = $('fj');
+    
+    if (element.style.display == '')
+    {
+      element.style.display = 'none';
+    }
+    else
+    {
+      element.style.display = '';
+    }
+  }
+  
+  window.onload = function()
+  {
+    init_swfupload();
+    var f = new FileThumb('qu');
+    var t = new ToolBar('nv');
+    
+    var b1 = new Button('Upload New File', 'Upload', 'add.gif');
+    var b2 = new Button('Refresh', 'Refresh', 'refresh.gif');
+    
+    b1.callback = uploadButton;
+    b2.callback = function(){ window.location.reload(); }
+    
+    t.buttons.push(b1);
+    t.buttons.push(b2);
+    
+    t.init();
+  }
+</script>
+
+<table width="100%" cellspacing="0" cellpadding="0">
+	<tbody>
+	<tr>
+		<td class="TB_ToolbarSet" id="nv"></td>
+	</tr>
+
+	<tr id="fj" style='display:none;'>
+		<td style="white-space: normal;" class="FCKUploadArea">
+			<div class="PopupTitle">
+				<span>Upload New Files</span>
+			</div>
+			<div id="cY">
+				<table cellspacing="0" cellpadding="0" style="padding: 10px;">
+					<tbody>
+					<tr>
+						<td>
+              <span id='spanButtonPlaceholder'></span>
+              <div id="divFileProgressContainer" style="clear:both;"></div>
+              
+							<%= render :partial=>"swfupload" %>
+						</td>
+					</tr>
+				  </tbody>
+			  </table>
+			  <div class="PopupButtons">
+				  <div style="width: 100%;">
+					  <table width="100%" cellspacing="0" cellpadding="0">
+						  <tbody><tr>
+							  <td width="100%"></td>
+							  <td nowrap="nowrap">
+								  <button onclick="uploadButton()" class="Button"><span ckf:lang="CancelBtn">Cancel</span></button>
+							  </td>
+						  </tr>
+					  </tbody></table>
+				  </div>
+			  </div>
+			</div>
+		</td>
+	</tr>
+
+	<tr>
+		<td style="height: 100%;" id="qu">
+		  <div style="overflow:auto; height:550px;" id='container'>
+			 <%= render :partial => "asset", :collection => @files, :as => :asset %>
+		  </div>
+		</td>
+	</tr>
+</tbody>
+</table>