zen 0.2.7 → 0.2.8

data/lib/zen/package/custom_fields/lib/custom_fields/controller/custom_field_groups.rb

@@ -3,9 +3,9 @@ module CustomFields
   #:nodoc:
   module Controller
     ##
-    # Controller for managing custom field groups. These groups are used
-    # to organize individual fields into a larger group which in turn will
-    # be assigned to a section.
+    # Controller for managing custom field groups. These groups are used to
+    # organize individual fields into a larger group which in turn will be
+    # assigned to a section.
     #
     # @author  Yorick Peterse
     # @since   0.1
@@ -13,7 +13,8 @@ module CustomFields
     class CustomFieldGroups < Zen::Controller::AdminController
       include ::CustomFields::Model
 
-      map('/admin/custom-field-groups')
+      helper :custom_field
+      map    '/admin/custom-field-groups'
 
       before_all do
         csrf_protection(:save, :delete) do
@@ -22,8 +23,8 @@ module CustomFields
       end
 
       ##
-      # Constructor method, called upon initialization. It's used to set the
-      # URL to which forms send their data and load the language pack.
+      # Constructor method, called upon initialization. It's used to set the URL
+      # to which forms send their data and load the language pack.
       #
       # This method loads the following language files:
       #
@@ -35,9 +36,6 @@ module CustomFields
       def initialize
         super
 
-        @form_save_url     = CustomFieldGroups.r(:save)
-        @form_delete_url   = CustomFieldGroups.r(:delete)
-
         Zen::Language.load('custom_field_groups')
 
         # Set the page title
@@ -48,8 +46,9 @@ module CustomFields
       end
 
       ##
-      # Show an overview of all existing custom field groups. Using this overview a user
-      # can manage an existing field group, delete it or create a new one.
+      # Show an overview of all existing custom field groups. Using this
+      # overview a user can manage an existing field group, delete it or create
+      # a new one.
       #
       # This method requires the following permissions:
       #
@@ -59,13 +58,11 @@ module CustomFields
       # @since  0.1
       #
       def index
-        if !user_authorized?([:read])
-          respond(lang('zen_general.errors.not_authorized'), 403)
-        end
+        require_permissions(:read)
 
         set_breadcrumbs(lang('custom_field_groups.titles.index'))
 
-        @field_groups = CustomFieldGroup.all
+        @field_groups = paginate(CustomFieldGroup)
       end
 
       ##
@@ -77,25 +74,25 @@ module CustomFields
       # * update
       #
       # @author Yorick Peterse
-      # @param  [Integer] id The ID of the custom field group to retrieve so that we
-      # can edit it.
+      # @param  [Integer] id The ID of the custom field group to retrieve so
+      # that we can edit it.
       # @since  0.1
       #
       def edit(id)
-        if !user_authorized?([:read, :update])
-          respond(lang('zen_general.errors.not_authorized'), 403)
-        end
+        require_permissions(:read, :update)
 
         set_breadcrumbs(
-          anchor_to(lang('custom_field_groups.titles.index'), CustomFieldGroups.r(:index)),
+          CustomFieldGroups.a(lang('custom_field_groups.titles.index'), :index),
           @page_title
         )
 
         if flash[:form_data]
           @field_group = flash[:form_data]
         else
-          @field_group = CustomFieldGroup[id.to_i]
+          @field_group = validate_custom_field_group(id)
         end
+
+        render_view(:form)
       end
 
       ##
@@ -110,22 +107,23 @@ module CustomFields
       # @since  0.1
       #
       def new
-        if !user_authorized?([:read, :create])
-          respond(lang('zen_general.errors.not_authorized'), 403)
-        end
+        require_permissions(:read, :create)
 
         set_breadcrumbs(
-          anchor_to(lang('custom_field_groups.titles.index'), CustomFieldGroups.r(:index)),
+          CustomFieldGroups.a(lang('custom_field_groups.titles.index'), :index),
           @page_title
         )
 
         @field_group = CustomFieldGroup.new
+
+        render_view(:form)
       end
 
       ##
-      # Method used for processing the form data and redirecting the user back to
-      # the proper URL. Based on the value of a hidden field named 'id' we'll determine
-      # if the data will be used to create a new group or to update an existing one.
+      # Method used for processing the form data and redirecting the user back
+      # to the proper URL. Based on the value of a hidden field named 'id' we'll
+      # determine if the data will be used to create a new group or to update an
+      # existing one.
       #
       # This method requires the following permissions:
       #
@@ -136,17 +134,16 @@ module CustomFields
       # @since  0.1
       #
       def save
-        if !user_authorized?([:create, :update])
-          respond(lang('zen_general.errors.not_authorized'), 403)
-        end
-
         post = request.subset(:id, :name, :description)
 
-        # Get or create a custom field group based on the ID from the hidden field.
         if post['id'] and !post['id'].empty?
-          @field_group  = CustomFieldGroup[post['id']]
+          require_permissions(:update)
+
+          @field_group  = validate_custom_field_group(post['id'])
           save_action   = :save
         else
+          require_permissions(:create)
+
           @field_group  = CustomFieldGroup.new
           save_action   = :new
         end
@@ -160,26 +157,30 @@ module CustomFields
         begin
           @field_group.update(post)
           message(:success, flash_success)
-        rescue
+        rescue => e
+          Ramaze::Log.error(e.inspect)
           message(:error, flash_error)
 
           flash[:form_errors] = @field_group.errors
           flash[:form_data]   = @field_group
+
+          redirect_referrer
         end
 
         if !@field_group.nil? and @field_group.id
           redirect(CustomFieldGroups.r(:edit, @field_group.id))
         else
-          redirect(CustomFieldGroups.r(:new))
+          redirect_referrer
         end
       end
 
       ##
       # Delete an existing custom field group.
       #
-      # In order to delete a custom field group you'll need to send a POST request
-      # that contains a field named 'custom_field_group_ids[]'. This field should
-      # contain the primary values of each field group that has to be deleted.
+      # In order to delete a custom field group you'll need to send a POST
+      # request that contains a field named 'custom_field_group_ids[]'. This
+      # field should contain the primary values of each field group that has to
+      # be deleted.
       #
       # This method requires the following permissions:
       #
@@ -189,21 +190,23 @@ module CustomFields
       # @since  0.1
       #
       def delete
-        if !user_authorized?([:delete])
-          respond(lang('zen_general.errors.not_authorized'), 403)
-        end
+        require_permissions(:delete)
 
-        if !request.params['custom_field_group_ids'] or request.params['custom_field_group_ids'].empty?
+        if !request.params['custom_field_group_ids'] \
+        or request.params['custom_field_group_ids'].empty?
           message(:error, lang('custom_field_groups.errors.no_delete'))
-          redirect(CustomFieldGroups.r(:index))
+          redirect_referrer
         end
 
         request.params['custom_field_group_ids'].each do |id|
           begin
-            CustomFieldGroup[id.to_i].destroy
+            CustomFieldGroup[id].destroy
             message(:success, lang('custom_field_groups.success.delete'))
-          rescue
+          rescue => e
+            Ramaze::Log.error(e.inspect)
             message(:error, lang('custom_field_groups.errors.delete') % id)
+
+            redirect_referrer
           end
         end
 

data/lib/zen/package/custom_fields/lib/custom_fields/controller/custom_field_types.rb

@@ -0,0 +1,215 @@
+#:nodoc:
+module CustomFields
+  #:nodoc:
+  module Controller
+    ##
+    # Controller that can be used to manage individual custom field types.
+    #
+    # @author Yorick Peterse
+    # @since  0.2.8
+    #
+    class CustomFieldTypes < Zen::Controller::AdminController
+      include ::CustomFields::Model
+
+      map    '/admin/custom-field-types'
+      helper :custom_field
+
+      before_all do
+        csrf_protection(:save, :delete) do
+          respond(lang('zen_general.errors.csrf'), 403)
+        end
+      end
+
+      ##
+      # Creates a new instance of the controller, loads all the required
+      # language files and sets the page title.
+      #
+      # @author Yorick Peterse
+      # @since  0.2.8
+      #
+      def initialize
+        super
+
+        Zen::Language.load('custom_field_types')
+
+        if !action.method.nil?
+          @page_title = lang(
+            "custom_field_types.titles.#{action.method}"
+          ) rescue nil
+        end
+
+        @boolean_hash = {
+          true  => lang('zen_general.special.boolean_hash.true'),
+          false => lang('zen_general.special.boolean_hash.false')
+        }
+      end
+
+      ##
+      # Shows an overview of all the available custom field types and allows the
+      # user to create new ones, edit existing ones or delete a group of field
+      # types.
+      #
+      # This method requires read permissions for a user to be able to view all
+      # the field types.
+      #
+      # @author Yorick Peterse
+      # @since  0.2.8
+      #
+      def index
+        require_permissions(:read)
+
+        set_breadcrumbs(lang('custom_field_types.titles.index'))
+
+        @field_types = paginate(CustomFieldType.eager(:custom_field_method))
+      end
+
+      ##
+      # Allows a user to edit an existing custom field type.
+      #
+      # This method requires the following permissions:
+      #
+      # * read
+      # * update
+      #
+      # @author Yorick Peterse
+      # @since  0.2.8
+      # @param  [Fixnum] custom_field_type_id The ID of the custom field type to
+      # edit.
+      #
+      def edit(custom_field_type_id)
+        require_permissions(:read, :update)
+
+        set_breadcrumbs(
+          CustomFieldTypes.a(lang('custom_field_types.titles.index'), :index),
+          lang('custom_field_types.titles.edit')
+        )
+
+        if flash[:form_data]
+          @custom_field_type = flash[:form_data]
+        else
+          @custom_field_type = validate_custom_field_type(custom_field_type_id)
+        end
+
+        @custom_field_methods = CustomFieldMethod.pk_hash(:name)
+
+        render_view :form
+      end
+
+      ##
+      # Allows a user to add a new custom field type.
+      #
+      # This method requires the following permissions:
+      #
+      # * read
+      # * create
+      #
+      # @author Yorick Peterse
+      # @since  0.2.8
+      #
+      def new
+        require_permissions(:read, :create)
+
+        set_breadcrumbs(
+          CustomFieldTypes.a(lang('custom_field_types.titles.index'), :index),
+          lang('custom_field_types.titles.new')
+        )
+
+        @custom_field_methods = CustomFieldMethod.pk_hash(:name)
+        @custom_field_type    = CustomFieldType.new
+
+        render_view :form
+      end
+
+      ##
+      # Saves the data submitted by CustomFieldTypes#edit() and
+      # CustomFieldTypes#add().
+      #
+      # This method requires either create or update permissions based on the
+      # supplied data.
+      #
+      # @author Yorick Peterse
+      # @since  0.2.8
+      #
+      def save
+        post = request.subset(
+          :id,
+          :name,
+          :language_string,
+          :html_class,
+          :serialize,
+          :allow_markup,
+          :custom_field_method_id
+        )
+
+        if post['id'] and !post['id'].empty?
+          require_permissions(:update)
+
+          field_type  = validate_custom_field_type(post['id'])
+          save_action = :save
+        else
+          require_permissions(:create)
+
+          field_type  = CustomFieldType.new
+          save_action = :new
+        end
+
+        post.delete('id')
+
+        success = lang("custom_field_types.success.#{save_action}")
+        error   = lang("custom_field_types.errors.#{save_action}")
+
+        begin
+          field_type.update(post)
+          message(:success, success)
+        rescue => e
+          Ramaze::Log.error(e.inspect)
+          message(:error, error)
+
+          flash[:form_data]   = field_type
+          flash[:form_errors] = field_type.errors
+
+          redirect_referrer
+        end
+
+        if field_type.id
+          redirect(CustomFieldTypes.r(:edit, field_type.id))
+        else
+          redirect_referrer
+        end
+      end
+
+      ##
+      # Deletes a number of custom field types.
+      #
+      # This method requires delete permissions for a user to be able to remove
+      # a number of database records.
+      #
+      # @author Yorick Peterse
+      # @since  0.2.8
+      #
+      def delete
+        require_permissions(:delete)
+
+        if !request.params['custom_field_type_ids'] \
+        or request.params['custom_field_type_ids'].empty?
+          message(:error, lang('custom_field_types.errors.no_delete'))
+          redirect_referrer
+        end
+
+        request.params['custom_field_type_ids'].each do |id|
+          begin
+            CustomFieldType[id].destroy
+          rescue => e
+            Ramaze::Log.error(e.inspect)
+            message(:error, lang('custom_field_types.errors.delete') % id)
+
+            redirect_referrer
+          end
+        end
+
+        message(:success, lang('custom_field_types.success.delete'))
+        redirect_referrer
+      end
+    end # CustomFieldTypes
+  end # Controller
+end # CustomFields

data/lib/zen/package/custom_fields/lib/custom_fields/controller/custom_fields.rb

@@ -9,16 +9,17 @@ module CustomFields
     # being able to use a custom field you'll need to add it to a group
     # and bind that group to a section.
     #
-    # @author  Yorick Peterse
-    # @since   0.1
+    # @author Yorick Peterse
+    # @since  0.1
     #
     class CustomFields < Zen::Controller::AdminController
       include ::CustomFields::Model
 
-      map('/admin/custom-fields')
+      helper :custom_field
+      map    '/admin/custom-fields'
 
       # Load all required Javascript files
-      javascript ['zen/tabs']
+      javascript ['zen/lib/tabs']
 
       before_all do
         csrf_protection(:save, :delete) do
@@ -26,6 +27,16 @@ module CustomFields
         end
       end
 
+      ##
+      # Hook that is executed before the index(), edit() and new() methods.
+      #
+      # @author Yorick Peterse
+      # @since  0.2.8
+      #
+      before(:index, :edit, :new) do
+        @custom_field_types = CustomFieldType.type_hash
+      end
+
       ##
       # Constructor method, called upon initialization. It's used to set the
       # URL to which forms send their data and load the language pack.
@@ -41,9 +52,6 @@ module CustomFields
       def initialize
         super
 
-        @form_save_url     = CustomFields.r(:save)
-        @form_delete_url   = CustomFields.r(:delete)
-
         Zen::Language.load('custom_fields')
         Zen::Language.load('custom_field_groups')
 
@@ -53,43 +61,41 @@ module CustomFields
           @page_title = lang("custom_fields.titles.#{method}") rescue nil
         end
 
-        # Build our array containing all custom field formats
-        @field_type_hash = {
-          'textbox'         => lang('custom_fields.special.type_hash.textbox'),
-          'textarea'        => lang('custom_fields.special.type_hash.textarea'),
-          'radio'           => lang('custom_fields.special.type_hash.radio'),
-          'checkbox'        => lang('custom_fields.special.type_hash.checkbox'),
-          'date'            => lang('custom_fields.special.type_hash.date'),
-          'select'          => lang('custom_fields.special.type_hash.select'),
-          'select_multiple' => lang('custom_fields.special.type_hash.select_multiple')
+        @boolean_hash = {
+          true  => lang('zen_general.special.boolean_hash.true'),
+          false => lang('zen_general.special.boolean_hash.false')
         }
       end
 
       ##
-      # Show an overview of all existing custom fields. Using this overview a user
-      # can manage an existing field, delete it or create a new one.
+      # Show an overview of all existing custom fields. Using this overview a
+      # user can manage an existing field, delete it or create a new one.
       #
       # This method requires the following permissions:
       #
       # * read
       #
       # @author Yorick Peterse
-      # @param  [Integer] custom_field_group_id The ID of the custom field group to
-      # which all fields belong.
+      # @param  [Fixnum] custom_field_group_id The ID of the custom field group
+      # to which all fields belong.
       # @since  0.1
       #
       def index(custom_field_group_id)
-        if !user_authorized?([:read])
-          respond(lang('zen_general.errors.not_authorized'), 403)
-        end
+        require_permissions(:read)
+
+        field_group = validate_custom_field_group(custom_field_group_id)
 
         set_breadcrumbs(
-          anchor_to(lang('custom_field_groups.titles.index'), CustomFieldGroups.r(:index)),
+          CustomFieldGroups.a(lang('custom_field_groups.titles.index'), :index),
           lang('custom_fields.titles.index')
         )
 
-        @custom_field_group_id = custom_field_group_id.to_i
-        @custom_fields         = CustomFieldGroup[@custom_field_group_id].custom_fields
+        @custom_field_group_id = custom_field_group_id
+        @custom_fields         = CustomField.filter(
+          :custom_field_group_id => custom_field_group_id
+        )
+
+        @custom_fields = paginate(@custom_fields)
       end
 
       ##
@@ -101,19 +107,24 @@ module CustomFields
       # * update
       #
       # @author Yorick Peterse
-      # @param  [Integer] custom_field_group_id The ID of the custom field group to
-      # which all fields belong.
-      # @param  [Integer] id The ID of the custom field to retrieve so that we can edit it.
+      # @param  [Fixnum] custom_field_group_id The ID of the custom field
+      # group to which all fields belong.
+      # @param  [Fixnum] id The ID of the custom field to retrieve so that we
+      # can edit it.
       # @since  0.1
       #
       def edit(custom_field_group_id, id)
-        if !user_authorized?([:read, :update])
-          respond(lang('zen_general.errors.not_authorized'), 403)
-        end
+        require_permissions(:read, :update)
+
+        validate_custom_field_group(custom_field_group_id)
 
         set_breadcrumbs(
-          anchor_to(lang('custom_field_groups.titles.index'), CustomFieldGroups.r(:index)),
-          anchor_to(lang('custom_fields.titles.index'), CustomFields.r(:index, custom_field_group_id)),
+          CustomFieldGroups.a(
+            lang('custom_field_groups.titles.index'), :index
+          ),
+          CustomFields.a(
+            lang('custom_fields.titles.index'), :index, custom_field_group_id
+          ),
           lang('custom_fields.titles.edit')
         )
 
@@ -122,8 +133,10 @@ module CustomFields
         if flash[:form_data]
           @custom_field = flash[:form_data]
         else
-          @custom_field = CustomField[id.to_i]
+          @custom_field = validate_custom_field(id, custom_field_group_id)
         end
+
+        render_view(:form)
       end
 
       ##
@@ -135,35 +148,36 @@ module CustomFields
       # * read
       #
       # @author Yorick Peterse
-      # @param  [Integer] custom_field_group_id The ID of the custom field group to
-      # which all fields belong.
+      # @param  [Fixnum] custom_field_group_id The ID of the custom field group
+      # to which all fields belong.
       # @since  0.1
       #
       def new(custom_field_group_id)
-        if !user_authorized?([:read, :create])
-          respond(lang('zen_general.errors.not_authorized'), 403)
-        end
+        require_permissions(:read, :create)
+
+        validate_custom_field_group(custom_field_group_id)
 
         set_breadcrumbs(
-          anchor_to(
-            lang('custom_field_groups.titles.index'),
-            CustomFieldGroups.r(:index)
+          CustomFieldGroups.a(
+            lang('custom_field_groups.titles.index'), :index
           ),
-          anchor_to(
-            lang('custom_fields.titles.index'),
-            CustomFields.r(:index, custom_field_group_id)
+          CustomFields.a(
+            lang('custom_fields.titles.index'), :index, custom_field_group_id
           ),
-          lang('custom_fields.titles.index')
+          lang('custom_fields.titles.new')
         )
 
         @custom_field_group_id = custom_field_group_id
         @custom_field          = CustomField.new
+
+        render_view(:form)
       end
 
       ##
-      # Method used for processing the form data and redirecting the user back to
-      # the proper URL. Based on the value of a hidden field named 'id' we'll determine
-      # if the data will be used to create a new custom field or to update an existing one.
+      # Method used for processing the form data and redirecting the user back
+      # to the proper URL. Based on the value of a hidden field named 'id' we'll
+      # determine if the data will be used to create a new custom field or to
+      # update an existing one.
       #
       # This method requires the following permissions:
       #
@@ -174,22 +188,39 @@ module CustomFields
       # @since  0.1
       #
       def save
-        if !user_authorized?([:create, :update])
-          respond(lang('zen_general.errors.not_authorized'), 403)
-        end
-
         post = request.subset(
-          :id, :name, :slug, :description, :sort_order, :type, :format, :possible_values,
-          :required, :visual_editor, :textarea_rows, :text_limit, :custom_field_group_id
+          :id,
+          :name,
+          :slug,
+          :description,
+          :sort_order,
+          :format,
+          :possible_values,
+          :required,
+          :text_editor,
+          :textarea_rows,
+          :text_limit,
+          :custom_field_group_id,
+          :custom_field_type_id
         )
 
-        # Get or create a custom field group based on the ID from the hidden field.
+        validate_custom_field_group(post['custom_field_group_id'])
+
+        # Get or create a custom field group based on the ID from the hidden
+        # field.
         if post['id'] and !post['id'].empty?
-          @custom_field = CustomField[post['id']]
-          save_action   = :save
+          require_permissions(:update)
+
+          custom_field = validate_custom_field(
+            post['id'], post['custom_field_group_id']
+          )
+
+          save_action  = :save
         else
-          @custom_field = CustomField.new
-          save_action   = :new
+          require_permissions(:create)
+
+          custom_field = CustomField.new
+          save_action  = :new
         end
 
         post.delete('slug') if post['slug'].empty?
@@ -199,18 +230,24 @@ module CustomFields
         flash_error   = lang("custom_fields.errors.#{save_action}")
 
         begin
-          @custom_field.update(post)
+          custom_field.update(post)
           message(:success, flash_success)
         rescue => e
           Ramaze::Log.error(e.inspect)
           message(:error, flash_error)
 
-          flash[:form_data]   = @custom_field
-          flash[:form_errors] = @custom_field.errors
+          flash[:form_data]   = custom_field
+          flash[:form_errors] = custom_field.errors
+
+          redirect_referrer
         end
 
-        if @custom_field.id
-          redirect(CustomFields.r(:edit, post['custom_field_group_id'], @custom_field.id))
+        if custom_field.id
+          redirect(
+            CustomFields.r(
+              :edit, post['custom_field_group_id'], custom_field.id
+            )
+          )
         else
           redirect_referrer
         end
@@ -219,9 +256,9 @@ module CustomFields
       ##
       # Delete an existing custom field.
       #
-      # In order to delete a custom field group you'll need to send a POST request that
-      # contains a field named 'custom_field_ids[]'. This field should contain the
-      # primary values of each field that has to be deleted.
+      # In order to delete a custom field group you'll need to send a POST
+      # request that contains a field named 'custom_field_ids[]'. This field
+      # should contain the primary values of each field that has to be deleted.
       #
       # This method requires the following permissions:
       #
@@ -231,13 +268,12 @@ module CustomFields
       # @since  0.1
       #
       def delete
-        if !user_authorized?([:delete])
-          respond(lang('zen_general.errors.not_authorized'), 403)
-        end
+        require_permissions(:delete)
 
         post = request.subset(:custom_field_ids, :custom_field_group_id)
 
-        if !request.params['custom_field_ids'] or request.params['custom_field_ids'].empty?
+        if !request.params['custom_field_ids'] \
+        or request.params['custom_field_ids'].empty?
           message(:error, lang('custom_fields.errors.no_delete'))
           redirect(CustomFields.r(:index, post['custom_field_group_id']))
         end
@@ -249,6 +285,8 @@ module CustomFields
           rescue => e
             Ramaze::Log.error(e.inspect)
             message(:error, lang('custom_fields.errors.delete') % id)
+
+            redirect_referrer
           end
         end