Class: Pageflow::Configuration

Inherits:
Object
  • Object
show all
Defined in:
lib/pageflow/configuration.rb,
lib/pageflow/configuration/defaults.rb,
lib/pageflow/configuration/permissions.rb

Overview

Options to be defined in the pageflow initializer of the main app.

Defined Under Namespace

Modules: Defaults Classes: ConfigView, FeatureLevelConfiguration, Permissions

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(target_type_name = nil) ⇒ Configuration

Returns a new instance of Configuration.



341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
 
# File 'lib/pageflow/configuration.rb', line 341

def initialize(target_type_name = nil)
  @target_type_name = target_type_name

  @paperclip_attachments_version = 'v1'
  @paperclip_s3_root = 'main'

  @paperclip_s3_default_options = Defaults::PAPERCLIP_S3_DEFAULT_OPTIONS.dup

  @paperclip_direct_upload_options = lambda { |attachment|
    max_upload_size = 4_294_967_296 # max file size in bytes
    presigned_post_config = attachment.s3_bucket
                                      .presigned_post(key: attachment.path,
                                                      success_action_status: '201',
                                                      acl: 'public-read',
                                                      content_length_range: 0..max_upload_size)
    {
      url: presigned_post_config.url,
      fields: presigned_post_config.fields
    }
  }

  @zencoder_options = {}

  @encryption_options = {}

  @mailer_sender = '[email protected]'

  @features = Features.new
  @hooks = Hooks.new
  @quotas = Quotas.new
  @themes = Themes.new
  @entry_types = EntryTypes.new
  @entry_type_configs = {}
  @entry_type_configure_blocks = Hash.new { |h, k| h[k] = [] }
  @file_types = FileTypes.new
  @widget_types = WidgetTypes.new
  @file_importers = FileImporters.new
  @help_entries = HelpEntries.new
  @revision_components = RevisionComponents.new

  @thumbnail_styles = Defaults::THUMBNAIL_STYLES.dup
  @css_rendered_thumbnail_styles = Defaults::CSS_RENDERED_THUMBNAIL_STYLES.dup

  @theming_request_scope = CnameThemingRequestScope.new
  @public_entry_request_scope = lambda { |entries, request| entries }
  @public_entry_redirect = ->(_entry, _request) { nil }
  @public_entry_url_options = Pageflow::ThemingsHelper::DEFAULT_PUBLIC_ENTRY_OPTIONS
  @entry_embed_url_options = {protocol: 'https'}

  @confirm_encoding_jobs = false

  @admin_resource_tabs = Pageflow::Admin::Tabs.new
  @admin_form_inputs = Pageflow::Admin::FormInputs.new
  @admin_attributes_table_rows = Pageflow::Admin::AttributesTableRows.new

  @available_locales = [:en, :de]
  @available_public_locales = PublicI18n.available_locales
  @available_share_providers = [:email, :facebook, :linked_in, :twitter, :telegram, :whats_app]

  @public_https_mode = :prevent

  @default_keywords_meta_tag = 'pageflow, multimedia, reportage'
  @default_author_meta_tag = 'Pageflow'
  @default_publisher_meta_tag = 'Pageflow'

  @default_share_providers = @available_share_providers

  @authorize_user_deletion = lambda { |_user| true }

  @available_text_track_kinds = [:captions, :subtitles, :descriptions]

  @allow_multiaccount_users = true

  @account_admin_menu_options = {}

  @permissions = Permissions.new

  @edit_lock_polling_interval = 15.seconds
end

Instance Attribute Details

#account_admin_menu_options ⇒ Object

Options hash for account admin menu. Options from config precede defaults.

Since:

  • 12.1



324
325
326
 
# File 'lib/pageflow/configuration.rb', line 324

def 
  @account_admin_menu_options
end

#admin_attributes_table_rows ⇒ Admin::AttributesTableRows (readonly)

Insert additional rows into admin attributes tables.

Examples:


config.admin_attributes_table_rows.register(:entry, :custom)
config.admin_attributes_table_rows.register(:entry, :my_attribute, after: :title)
config.admin_attributes_table_rows.register(:entry, :some_attribute, before: :updated_at)

Custom content


config.admin_attributes_table_rows.register(:entry, :custom) do |entry|
  span(entry.custom_attribute)
end

Returns:

Since:

  • 12.2



250
251
252
 
# File 'lib/pageflow/configuration.rb', line 250

def admin_attributes_table_rows
  @admin_attributes_table_rows
end

#admin_form_inputs ⇒ Admin::FormInputs (readonly)

Add custom form fields to admin forms.

Examples:


config.admin_form_inputs.register(:entry, :custom_field) do

Returns:

Since:

  • 0.9



232
233
234
 
# File 'lib/pageflow/configuration.rb', line 232

def admin_form_inputs
  @admin_form_inputs
end

#admin_resource_tabs ⇒ Admin::Tabs (readonly)

Used by Pageflow extensions to provide new tabs to be displayed in the admin.

Examples:


config.admin_resource_tabs.register(:entry, Admin::CustomTab)

Returns:



222
223
224
 
# File 'lib/pageflow/configuration.rb', line 222

def admin_resource_tabs
  @admin_resource_tabs
end

#allow_multiaccount_users ⇒ Object

Allow one user to be member of multiple accounts. Defaults to true.

Since:

  • 12.1



319
320
321
 
# File 'lib/pageflow/configuration.rb', line 319

def allow_multiaccount_users
  @allow_multiaccount_users
end

#authorize_user_deletion ⇒ Object

Whether a user can be deleted.

Examples:


config.authorize_user_deletion =
  lambda do |user_to_delete|
    if user_to_delete.accounts.all? { || .users.size > 1 }
      true
    else
      'Last user on account. Permission denied'
    end
  end

Since:

  • 0.11



310
311
312
 
# File 'lib/pageflow/configuration.rb', line 310

def authorize_user_deletion
  @authorize_user_deletion
end

#available_locales ⇒ Object

Array of locales which can be chosen as interface language by a user. Defaults to ‘[:en, :de]`.

Since:

  • 0.7



255
256
257
 
# File 'lib/pageflow/configuration.rb', line 255

def available_locales
  @available_locales
end

#available_public_locales ⇒ Object

Array of locales which can be chosen as interface language for an entry. Defaults to the locales supported by the ‘pageflow-public-i18n` gem.

Since:

  • 0.10



261
262
263
 
# File 'lib/pageflow/configuration.rb', line 261

def available_public_locales
  @available_public_locales
end

#available_share_providers ⇒ Object

Array of sharing providers which can be configured on theming level. Defaults to ‘[:facebook, :twitter, :linked_in, :whats_app, :telegram, :email]`.

Since:

  • 14.1



266
267
268
 
# File 'lib/pageflow/configuration.rb', line 266

def available_share_providers
  @available_share_providers
end

#available_text_track_kinds ⇒ Object (readonly)

Array of values that the ‘kind` attribute on text tracks can take. Defaults to `[:captions, :subtitles, :descriptions]`.



314
315
316
 
# File 'lib/pageflow/configuration.rb', line 314

def available_text_track_kinds
  @available_text_track_kinds
end

#confirm_encoding_jobs ⇒ Object

Submit video/audio encoding jobs only after the user has explicitly confirmed in the editor. Defaults to false.



212
213
214
 
# File 'lib/pageflow/configuration.rb', line 212

def confirm_encoding_jobs
  @confirm_encoding_jobs
end

#css_rendered_thumbnail_styles ⇒ Object

Names of Paperclip styles that shall be rendered into entry specific stylesheets.



136
137
138
 
# File 'lib/pageflow/configuration.rb', line 136

def css_rendered_thumbnail_styles
  @css_rendered_thumbnail_styles
end

#default_author_meta_tag ⇒ Object

Returns the value of attribute default_author_meta_tag.



287
288
289
 
# File 'lib/pageflow/configuration.rb', line 287

def default_author_meta_tag
  @default_author_meta_tag
end

#default_keywords_meta_tag ⇒ Object

Meta tag defaults.

These defaults will be included in the page <head> unless overriden by the Entry. If you set these to nil or "" the meta tag won’t be included.

Since:

  • 0.10



286
287
288
 
# File 'lib/pageflow/configuration.rb', line 286

def default_keywords_meta_tag
  @default_keywords_meta_tag
end

#default_publisher_meta_tag ⇒ Object

Returns the value of attribute default_publisher_meta_tag.



288
289
290
 
# File 'lib/pageflow/configuration.rb', line 288

def default_publisher_meta_tag
  @default_publisher_meta_tag
end

#default_share_providers ⇒ Object

Share provider defaults.

Default share providers for new themings. Must be a subset or equal to ‘available_share_providers`

Since:

  • 14.1



295
296
297
 
# File 'lib/pageflow/configuration.rb', line 295

def default_share_providers
  @default_share_providers
end

#edit_lock_polling_interval ⇒ number

Defines the editor lock polling interval.

Returns:

  • (number)

Since:

  • 12.1



333
334
335
 
# File 'lib/pageflow/configuration.rb', line 333

def edit_lock_polling_interval
  @edit_lock_polling_interval
end

#editor_route_constraint ⇒ Object

A constraint used by the pageflow engine to restrict access to the editor related HTTP end points. This can be used to ensure the editor is only accessable via a certain host when different CNAMES are used to access the public end points of pageflow.



44
45
46
 
# File 'lib/pageflow/configuration.rb', line 44

def editor_route_constraint
  @editor_route_constraint
end

#editor_routing_constraint ⇒ Object

Either a lambda or an object with a ‘match?` method, to restrict access to the editor routes defined by Pageflow.

This can be used if published entries shall be available under different CNAMES but the admin and the editor shall only be accessible via one official url.



144
145
146
 
# File 'lib/pageflow/configuration.rb', line 144

def editor_routing_constraint
  @editor_routing_constraint
end

#encryption_options ⇒ Object

Contains key and iv used to encrypt string used by SymmetricEncryption



38
39
40
 
# File 'lib/pageflow/configuration.rb', line 38

def encryption_options
  @encryption_options
end

#entry_embed_url_options ⇒ Object

Either a lambda or an object with a ‘call` method taking a Theming as paramater and returing a hash of options used to construct the embed url of a published entry.



208
209
210
 
# File 'lib/pageflow/configuration.rb', line 208

def entry_embed_url_options
  @entry_embed_url_options
end

#entry_types ⇒ EntryTypes (readonly)

Register new types of entries.

Returns:

Since:

  • 15.1



96
97
98
 
# File 'lib/pageflow/configuration.rb', line 96

def entry_types
  @entry_types
end

#features ⇒ Object (readonly)

Extend the configuration based on feature flags set for accounts or entries.

Make a widget type only available if a feature flag is set on the entry or its account

config.features.register('some_special_widget_type' do |config
  config.widget_types.register(Pageflow::SomeSpecial.widget_type)
end

Since:

  • 0.9



64
65
66
 
# File 'lib/pageflow/configuration.rb', line 64

def features
  @features
end

#file_importers ⇒ fileImporters (readonly)

Used to register new file importers, to be used for importing files

Returns:

  • (fileImporters) 


114
115
116
 
# File 'lib/pageflow/configuration.rb', line 114

def file_importers
  @file_importers
end

#file_types ⇒ FileTypes (readonly)

List of FileType instances. Can be registered globally or provided by page types.

Returns:



101
102
103
 
# File 'lib/pageflow/configuration.rb', line 101

def file_types
  @file_types
end

#help_entries ⇒ HelpEntries (readonly)

Used to add new sections to the help dialog displayed in the editor.

Returns:

Since:

  • 0.7



127
128
129
 
# File 'lib/pageflow/configuration.rb', line 127

def help_entries
  @help_entries
end

#hooks ⇒ Object (readonly)

Subscribe to hooks in order to be notified of events. Any object with a call method can be a subscriber

Example:

config.hooks.subscribe(:submit_file, -> { do_something })



73
74
75
 
# File 'lib/pageflow/configuration.rb', line 73

def hooks
  @hooks
end

#mailer_sender ⇒ Object

The email address to use as from header in invitation mails to new users



48
49
50
 
# File 'lib/pageflow/configuration.rb', line 48

def mailer_sender
  @mailer_sender
end

#news ⇒ #item

News collection to add items to. Can be used to integrate Pageflow with Krant (see github.com/codevise/krant).

Returns:

  • (#item)

Since:

  • 12.2



339
340
341
 
# File 'lib/pageflow/configuration.rb', line 339

def news
  @news
end

#paperclip_attachments_version ⇒ Object

String to interpolate into paths of files generated by paperclip preprocessors. This allows to refresh cdn caches after reprocessing attachments.



11
12
13
 
# File 'lib/pageflow/configuration.rb', line 11

def paperclip_attachments_version
  @paperclip_attachments_version
end

#paperclip_direct_upload_options ⇒ Object

Upload options provided to direct upload form. Defaults to S3 storage options. returns a hash with keys:

  • url: The URL to use as the action of the form

  • fields: A hash of fields that will be included in the direct upload form.

    This hash should include the signed POST policy, the access key ID and
security token (if present), etc.
These fields will be included as input elements of type 'hidden' on the form

# @since 14.0



30
31
32
 
# File 'lib/pageflow/configuration.rb', line 30

def paperclip_direct_upload_options
  @paperclip_direct_upload_options
end

#paperclip_s3_default_options ⇒ Object

Default options for paperclip attachments which are supposed to use s3 storage.



6
7
8
 
# File 'lib/pageflow/configuration.rb', line 6

def paperclip_s3_default_options
  @paperclip_s3_default_options
end

#paperclip_s3_root ⇒ Object

Root folder in S3 bucket to store files in. Can be used to separate files of multiple development instances in a shared development S3 bucket.

Since:

  • 13.0



18
19
20
 
# File 'lib/pageflow/configuration.rb', line 18

def paperclip_s3_root
  @paperclip_s3_root
end

#permissions ⇒ Object (readonly)

Sublayer for permissions related config.

Since:

  • 12.1



328
329
330
 
# File 'lib/pageflow/configuration.rb', line 328

def permissions
  @permissions
end

#public_entry_redirect ⇒ Object

Either a lambda or an object with a ‘call` method taking an Entry record and an ActionDispatch::Request object and returning `nil` or a path to redirect to. Can be used in conjuction with PrimaryDomainEntryRedirect to make sure entries are accessed via their account’s configured cname.

Since:

  • 12.4



189
190
191
 
# File 'lib/pageflow/configuration.rb', line 189

def public_entry_redirect
  @public_entry_redirect
end

#public_entry_request_scope ⇒ Object

Either a lambda or an object with a ‘call` method taking two parameters: An `ActiveRecord` scope of `Pageflow::Entry` records and an `ActionDispatch::Request` object. Has to return the scope in which to find entries.

Used by all public actions that display entries to restrict the available entries by hostname or other request attributes.

Use #public_entry_url_options to make sure urls of published entries conform twith the restrictions.

Example:

# Only make entries of one account available under <account.name>.example.com
config.public_entry_request_scope = lambda do |entries, request|
  entries.includes(:account).where(pageflow_accounts: {name: request.subdomain})
end



180
181
182
 
# File 'lib/pageflow/configuration.rb', line 180

def public_entry_request_scope
  @public_entry_request_scope
end

#public_entry_url_options ⇒ Object

Either a lambda or an object with a ‘call` method taking a Theming as paramater and returing a hash of options used to construct the url of a published entry.

Can be used to change the host of the url under which entries are available.

Example:

config.public_entry_url_options = lambda do |theming|
  {host: "#{theming..name}.example.com"}
end



203
204
205
 
# File 'lib/pageflow/configuration.rb', line 203

def public_entry_url_options
  @public_entry_url_options
end

#public_https_mode ⇒ Object

How to handle https requests for URLs which will have assets in the page. If you wish to serve all assets over http and prevent mixed-content warnings, you can force a redirect to http. The inverse is also true: you can force a redirect to https for all http requests.

Examples:


config.public_https_mode = :prevent (default) # => redirects https to http
config.public_https_mode = :enforce # => redirects http to https
config.public_https_mode = :ignore # => does nothing

Since:

  • 0.9



279
280
281
 
# File 'lib/pageflow/configuration.rb', line 279

def public_https_mode
  @public_https_mode
end

#quotas ⇒ Object

Limit the use of certain resources. Any object implementing the interface of Pageflow::Quota can be registered.

Example:

config.quotas.register(:users, UserQuota)



82
83
84
 
# File 'lib/pageflow/configuration.rb', line 82

def quotas
  @quotas
end

#revision_components ⇒ RevisionComponents (readonly)

Used to register components whose current state must be persisted as part of a revision.

Returns:



106
107
108
 
# File 'lib/pageflow/configuration.rb', line 106

def revision_components
  @revision_components
end

#themes ⇒ Themes (readonly)

Additional themes can be registered to use custom css.

Example:

config.themes.register(:custom)

Returns:



91
92
93
 
# File 'lib/pageflow/configuration.rb', line 91

def themes
  @themes
end

#theming_request_scope ⇒ Object

Either a lambda or an object with a ‘call` method taking two parameters: An `ActiveRecord` scope of Theming records and an ActionDispatch::Request object. Has to return the scope in which to find themings.

Defaults to Pageflow::CnameThemingRequestScope which finds themings based on the request subdomain. Can be used to alter the logic of finding a theming whose home_url to redirect to when visiting the public root path.

Example:

config.theming_request_scope = lambda do |themings, request|
  themings.where(id: Pageflow::Account.find_by_name!(request.subdomain).default_theming_id)
end



161
162
163
 
# File 'lib/pageflow/configuration.rb', line 161

def theming_request_scope
  @theming_request_scope
end

#thumbnail_styles ⇒ Object

Paperclip style definitions of thumbnails used by Pageflow.

Returns:

  • Hash



131
132
133
 
# File 'lib/pageflow/configuration.rb', line 131

def thumbnail_styles
  @thumbnail_styles
end

#widget_types ⇒ WidgetTypes (readonly)

Used to register new types of widgets to be displayed in entries.

Returns:



110
111
112
 
# File 'lib/pageflow/configuration.rb', line 110

def widget_types
  @widget_types
end

#zencoder_options ⇒ Object

Refer to the pageflow initializer template for a list of supported options.



34
35
36
 
# File 'lib/pageflow/configuration.rb', line 34

def zencoder_options
  @zencoder_options
end

Instance Method Details

#enable_all_features ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



496
497
498
 
# File 'lib/pageflow/configuration.rb', line 496

def enable_all_features
  features.enable_all(FeatureLevelConfiguration.new(self))
end

#enable_features(names) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



491
492
493
 
# File 'lib/pageflow/configuration.rb', line 491

def enable_features(names)
  features.enable(names, FeatureLevelConfiguration.new(self))
end

#for_entry_type(type) {|entry_type_config| ... } ⇒ Object

Scope configuration to entries of a certain entry type or access entry type specific configuration. When building a configuration object for an entry, the passed block is only evaluated when types match. When building ‘Pageflow.config`, all `for_entry_type` blocks are evaluated.

Parameters:

Yield Parameters:

  • entry_type_config (EntryTypeConfiguration) —

    - Instance of configuration class passed as ‘configuration` option during registration of entry type.

Since:

  • 15.1



468
469
470
471
472
 
# File 'lib/pageflow/configuration.rb', line 468

def for_entry_type(type)
  return if @target_type_name && @target_type_name != type.name

  yield get_entry_type_config(type)
end

#get_entry_type_config(type) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



475
476
477
 
# File 'lib/pageflow/configuration.rb', line 475

def get_entry_type_config(type)
  @entry_type_configs[type.name] ||= type.configuration.new(self, type)
end

#lint! ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



480
481
482
 
# File 'lib/pageflow/configuration.rb', line 480

def lint!
  @features.lint!
end

#page_types ⇒ PageTypes

Provide backwards compatibility as long as paged entry type has not been extracted completely. Prefer accessing entry type specific config via #for_entry_type for new code.

Returns:

Since:

  • 0.7



435
436
437
 
# File 'lib/pageflow/configuration.rb', line 435

def page_types
  get_entry_type_config(PageflowPaged.entry_type).page_types
end

#paperclip_filesystem_root ⇒ Object

Deprecated.

Pageflow now supports direct uploads to S3 via signed post requests.

Please change your forms accordingly.



447
448
449
 
# File 'lib/pageflow/configuration.rb', line 447

def paperclip_filesystem_root
  ActiveSupport::Deprecation.warn('Pageflow::Configuration#paperclip_filesystem_root is deprecated.', caller)
end

#paperclip_filesystem_root=(_val) ⇒ Object 



451
452
453
 
# File 'lib/pageflow/configuration.rb', line 451

def paperclip_filesystem_root=(_val)
  ActiveSupport::Deprecation.warn('Pageflow::Configuration#paperclip_filesystem_root is deprecated.', caller)
end

#plugin(plugin) ⇒ Object

Activate a plugin.

Parameters:

Since:

  • 0.7



425
426
427
 
# File 'lib/pageflow/configuration.rb', line 425

def plugin(plugin)
  plugin.configure(self)
end

#register_page_type(page_type) ⇒ Object

Deprecated.

Use ‘config.page_types.register` instead.



440
441
442
443
 
# File 'lib/pageflow/configuration.rb', line 440

def register_page_type(page_type)
  ActiveSupport::Deprecation.warn('Pageflow::Configuration#register_page_type is deprecated. Use config.page_types.register instead.', caller)
  page_types.register(page_type)
end

#theming_url_options(theming) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



485
486
487
488
 
# File 'lib/pageflow/configuration.rb', line 485

def theming_url_options(theming)
  options = public_entry_url_options
  options.respond_to?(:call) ? options.call(theming) : options
end