Class: Comments::Controller::CommentsForm

Inherits:
Zen::Controller::FrontendController show all
Defined in:
lib/zen/package/comments/lib/comments/controller/comments_form.rb

Overview

Controller that makes it possible for users to submit comments to section entries. Zen does not provide any way of generating a comment form for you and thus you'll have to do this yourself. When creating such a form you must add the following fields to it:

  • section_entry (required): an ID of a section entry where the comments belong to.
  • user_id: the ID of the currently logged in user (if any). If this ID isn't specified the "name" and "Email" fields are required.
  • comment: the text of the comment.
  • name: the name of the author, required when the "user_id" field is empty.
  • website: the website of the user, if any.
  • email: the Email address of the user, required if the "user_id" field is empty.

An example of such a form looks like the code below. Note that this block of code should be wrapped in a #{} tag.

form_for(
  flash[:form_data],
  :method => :post,
  :action => Comments::Controller::CommentsForm.r(:save)
) do |f|
  if logged_in?
    f.input_hidden(:user_id, user.id)
  end

  f.input_hidden(:section_entry, 10)

  # No need to show these, they'll be filled in based on the user ID.
  unless logged_in?
    f.input_text('Name', :name)
    f.input_text('Email', :email)
    f.input_text('Website', :website)
  end

  f.textarea('Comment', :comment)

  f.input_submit('Submit')
end

In the above example flash[:form_data] is used. This controller sets two objects in the flash just like the backend controllers. These are the following two items:

  • form_data: an instance of Model::Comment
  • form_errros: a hash containing all errors, automatically used by Ramaze::Helper::BlueForm if the form was created using the form_for() method.

Note that both these objects are only set if the comment contained invalid data or the user wasn't allowed to submit the comment.

In the above example the BlueForm helper was used but you're free to use plain old HTML or another helper if you like. If you want to use a helper you'll have to load it into Zen::Controller::MainController. This can be done as following:

Zen::Controller::MainController.helper(:some_helper_name)

Events

Just like Comments newly created comments are passed to an event called "new_comment".

Examples:

Logging whenever a new comment is created

Zen::Event.call(:new_comment) do |comment|
  Ramaze::Log.info(
    "A new comment has been created with ID ##{comment.id}"
  )
end

Since:

Instance Method Summary (collapse)

Instance Method Details

- (Object) save

Creates a new comment for the section entry. Once the comment has been saved the user will be redirected back to the previous page.

Since:

  • 0.1



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/zen/package/comments/lib/comments/controller/comments_form.rb', line 97

def save
  comment = ::Comments::Model::Comment.new
  post    = request.subset(
    :section_entry,
    :user_id,
    :comment,
    :name,
    :website,
    :email
  )

  # Get all the comment statuses.
  comment_statuses = {}
  draft_status     = ::Sections::Model::SectionEntryStatus[
    :name => 'draft'
  ].id

  ::Comments::Model::CommentStatus.all.each do |status|
    comment_statuses[status.name] = status.id
  end

  entry = ::Sections::Model::SectionEntry[post['section_entry']]

  # Remove empty values
  post.each { |k, v| post.delete(k) if v.empty? }

  comment.user_id = post['user_id'] if post.key?('user_id')
  comment.comment = post['comment']

  # If no user ID is specified we'll use the name, website and Email of
  # the POST data.
  if !post.key?('user_id')
    ['name', 'website', 'email'].each do |k|
      if post.key?(k)
        comment.send("#{k}=", post[k])
      end
    end
  end

  # Validate the section entry
  if entry.nil? or entry.section_entry_status_id == draft_status
    message(:error, lang('comments.errors.invalid_entry'))
    redirect_referrer
  end

  comment.section_entry_id = entry.id
  section                  = entry.section

  # Section valid?
  if section.nil?
    message(:error, lang('comments.errors.invalid_entry'))
    redirect_referrer
  end

  # Comments allowed?
  if section.comment_allow == false
    message(:error, lang('comments.errors.comments_not_allowed'))
    redirect_referrer
  end

  # Comments require an account?
  if section. == true and !logged_in?
    message(:error, lang('comments.errors.comments_require_account'))
    redirect_referrer
  end

  # Require moderation?
  if section.comment_moderate == true
    comment.comment_status_id = comment_statuses['closed']
  end

  # Get the details for the anti spam plugin
  if !post['user_id'].nil? and !post['user_id'].empty?
    user  = ::Users::Model::User[post['user_id']]
    name  = user.name
    email = user.email
    url   = user.website
  else
    name  = post['name']
    email = post['email']
    url   = post['website']
  end

  # Require anti-spam validation?
  if get_setting(:enable_antispam).true?
    engine = get_setting(:anti_spam_system).value
    spam   = ::Comments::AntiSpam.validate(
      engine,
      name,
      email,
      url,
      post['comment']
    )

    # Is it spam?
    if spam == false
      if section.comment_moderate == true
        comment.comment_status_id = comment_statuses['closed']
      else
        comment.comment_status_id = comment_statuses['open']
      end
    else
      comment.comment_status_id = comment_statuses['spam']
    end
  end

  # Save the comment
  begin
    Zen::Event.call(:before_new_comment, comment)
    comment.save
  rescue => e
    Ramaze::Log.error(e.inspect)
    message(:error, lang('comments.errors.new'))

    flash[:form_data]   = comment
    flash[:form_errors] = comment.errors

    redirect_referrer
  end

  if section.comment_moderate == true
    message(:success, lang('comments.success.moderate'))
  else
    message(:success, lang('comments.success.new'))
  end

  Zen::Event.call(:after_new_comment, comment)
  redirect_referrer
end