drg_cms 0.5.8 → 0.5.8.2

data/app/models/dc_folder_permission.rb

@@ -22,7 +22,17 @@
 #++
 
 #########################################################################
-# Mongoid::Document model for dc_folder_permissions collection. 
+# == Schema information
+#
+# Collection name: dc_folder_permission : Folders permissions
+#
+#  _id                  BSON::ObjectId       _id
+#  created_at           Time                 created_at
+#  updated_at           Time                 updated_at
+#  folder_name          String               Folder name
+#  inherited            Mongoid::Boolean     Inherit permissions from parent
+#  active               Mongoid::Boolean     Permission is valid
+#  dc_policy_rules      Embedded:DcPolicyRule Policy rules
 # 
 # Similar to DcPermission DcFolderPermission model defines documents
 # for accessing file system. Permissions defined on a parent folder automatically

data/app/models/dc_ident.rb

@@ -22,7 +22,15 @@
 #++
 
 ########################################################################
-# Mongoid::Document model for dc_idents emdedded documents.
+# == Schema information
+#
+# Collection name: dc_ident : Additional identification
+#
+#  _id                  BSON::ObjectId       _id
+#  created_at           Time                 created_at
+#  updated_at           Time                 updated_at
+#  key                  String               Key which defines ident
+#  value                String               Ident value
 # 
 # dc_idents are similar to mongoid hash structure and can be used for saveing 
 # key/value object. Fact is that I have overlooked the existance of MongoDB Hash field type

data/app/models/dc_internals.rb

@@ -0,0 +1,58 @@
+#--
+# Copyright (c) 2012+ Damjan Rems
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#++
+
+##########################################################################
+# Internals model represents bridge to action's internal variables like 
+# session, params, record ... They are used for interacting with user in terms
+# they understand and provides internal values behind the scene. 
+##########################################################################
+module DcInternals
+  INTERNALS = {
+    'current_user' => 'session[:user_id]',
+    'current_user_name' => 'session[:user_name]',
+    'current_site' => 'dc_get_site.id'
+  }
+#
+  @additions = {}
+  
+##########################################################################
+# Add additional internal. This method allows application specific internals 
+# to be added to structure and be used together with predefined values.
+##########################################################################
+def self.add_internal(hash)
+  hash.each {|key,value| additions[key] = value} 
+end
+
+##########################################################################
+# Add additional internal. This method allows application specific internals 
+# to be added to structure and be used together with predefined values.
+##########################################################################
+def self.get(key)
+  key = key.sub('@','')
+
+  value = INTERNALS[key]
+  value = @additions[key] if value.nil?
+  value
+end
+
+end

data/app/models/dc_journal.rb

@@ -22,7 +22,20 @@
 #++
 
 #########################################################################
-# Mongoid::Document model for dc_journals collection. 
+# == Schema information
+#
+# Collection name: dc_journal : Update journal
+#
+#  _id                  BSON::ObjectId       _id
+#  user_id              BSON::ObjectId       User
+#  site_id              BSON::ObjectId       Site
+#  doc_id               BSON::ObjectId       doc_id
+#  operation            String               Operation
+#  tables               String               Table name
+#  ids                  String               Parent ids
+#  ip                   String               ip address from where operation was performed
+#  time                 DateTime             Time of operation
+#  diff                 String               Differences
 # 
 # dc_journals collections saves all data that has been updated through cmsedit 
 # controller. It saves old and new values of changed fields and can be used for

data/app/models/dc_key_value_store.rb

@@ -22,10 +22,16 @@
 #++
 
 #########################################################################
-# Mongoid::Document model for dc_key_value_stores collection. 
+# == Schema information
+#
+# Collection name: dc_key_value_store : Table used for storing all kind of values
+#
+#  _id                  BSON::ObjectId       _id
+#  key                  String               Identification key
+#  value                String               Stored value
 # 
 # This model represents key/value store. Typical usage is for saving last
-# used document number on some internal document numbering schema.
+# used document number on internal document numbering schema.
 # 
 # Example: 
 #    doc_number = DcKeyValueStore.get_next_value('invoices', invoice_date.year)

data/app/models/dc_link.rb

@@ -22,7 +22,20 @@
 #++
 
 #########################################################################
-# Mongoid::Document model for dc_links collection. 
+# == Schema information
+#
+# Collection name: dc_link : Alternative links
+#
+#  _id                  BSON::ObjectId       _id
+#  created_at           Time                 created_at
+#  updated_at           Time                 updated_at
+#  name                 String               Link name ex. homepage
+#  params               String               Aditional parameters passed to document renderer
+#  active               Mongoid::Boolean     Link is active
+#  page_id              BSON::ObjectId       Page redirected to by this shortcut link
+#  created_by           BSON::ObjectId       created_by
+#  updated_by           BSON::ObjectId       updated_by
+#  dc_site_id           Object               Link is valid for site
 # 
 # DcLink documents may be used for creating alternative url links. page_id field must 
 # point to valid DcPage document which will be used for further processing. 

data/app/models/dc_menu.rb

@@ -22,7 +22,22 @@
 #++
 
 #########################################################################
-# Mongoid::Document model for dc_menus collection. 
+# == Schema information
+#
+# Collection name: dc_menu : Menus
+#
+#  _id                  BSON::ObjectId       _id
+#  created_at           Time                 created_at
+#  updated_at           Time                 updated_at
+#  name                 String               Menu name
+#  description          String               Short description of menu
+#  div_name             String               Div id name around menu area
+#  link_prepend         String               Link field usually holds direct link to document. Prepand field holds data, that has to be prepanded to the link.
+#  css                  String               CSS for this menu
+#  active               Mongoid::Boolean     Active
+#  created_by           BSON::ObjectId       created_by
+#  updated_by           BSON::ObjectId       updated_by
+#  dc_menu_items        Embedded:DcMenuItem  Menu items
 # 
 # Default menu system for DRG CMS. Model recursively embeds DcMenuItem documents
 # which (theoretically) results in infinite level of sub menus. In practice 

data/app/models/dc_menu_item.rb

@@ -22,7 +22,25 @@
 #++
 
 #########################################################################
-# Mongoid::Document model for dc_menu_items embedded documents. 
+# == Schema information
+#
+# Collection name: dc_menu_item : Menu items
+#
+#  _id                  BSON::ObjectId       _id
+#  created_at           Time                 created_at
+#  updated_at           Time                 updated_at
+#  caption              String               Caption of menu item
+#  picture              String               Picture for the menu
+#  link                 String               Link called when menu is chosen
+#  link_prepend         String               Link field usually holds direct link to document. Prepand field holds data, that has to be prepanded to the link.
+#  target               String               Target window for the link. Leave empty when same window.
+#  page_id              BSON::ObjectId       Page link
+#  order                Integer              Order on which menu item is shown. Lower number means prior position.
+#  active               Mongoid::Boolean     Is active
+#  policy_id            BSON::ObjectId       Menu item will be diplayed according to this policy
+#  created_by           BSON::ObjectId       created_by
+#  updated_by           BSON::ObjectId       updated_by
+#  dc_menu_items        Embedded:DcMenuItem  Submenu items
 # 
 # DcMenuItem documents are embedded in the DcMenu document and define one menu
 # item of menu system. 

data/app/models/dc_page.rb

@@ -117,11 +117,53 @@ def self.all_pages_for_site(site)
     inject([]) { |r,page| r << [ page.subject, page.subject_link] }
 end
 
+########################################################################
+# Return filter options
+########################################################################
+def self.dc_filters
+  {'title' => 'drgcms.filters.this_site_only', 'operation' => 'eq', 
+   'field' => 'dc_site_id', 'value' => '@current_site'}
+end
+
 end
 end
 
 #########################################################################
-# Mongoid::Document model for dc_page documents. 
+# == Schema information
+#
+# Collection name: dc_page : Pages
+#
+#  _id                  BSON::ObjectId       _id
+#  created_at           Time                 created_at
+#  updated_at           Time                 Updated
+#  subject              String               Articles subject
+#  title                String               Browser title. Optimization for SEO.
+#  subject_link         String               Friendly link defined
+#  alt_link             String               Alternative link, by which page could be found
+#  sub_subject          String               Sub subject, short description of text
+#  picture              String               Picture used in conjunction with page
+#  gallery              String               Gallery pictures are defined in parts of page. Value defines name of parts which hold data about pictures in gallary.
+#  body                 String               Content of this page
+#  css                  String               CSS only for this menu page
+#  script               String               Javascript only for this page
+#  params               String               Special parameters which may come handy when displaying page
+#  menu_id              BSON::ObjectId       Top menu under where this page is displayed
+#  author_id            BSON::ObjectId       Author of the article
+#  dc_poll_id           BSON::ObjectId       Select poll, if poll is to be used with page
+#  author_name          String               Author of the article
+#  publish_date         DateTime             Publish date
+#  user_name            String               user_name
+#  valid_from           DateTime             Article is valid from date
+#  valid_to             DateTime             Article is valid to date
+#  comments             Integer              Comments on this article are allowed
+#  active               Mongoid::Boolean     Page is active
+#  created_by           BSON::ObjectId       created_by
+#  updated_by           BSON::ObjectId       updated_by
+#  kats                 Array                Categories for this article
+#  policy_id            BSON::ObjectId       Access policy for the page
+#  dc_site_id           Object               dc_site_id
+#  dc_design_id         Object               Design used for rendering page
+#  dc_parts             Embedded:DcPart      Parts of the article
 # 
 # DcPage documents are anchors for urls. Default DcApplicationController::dc_process_default_request() 
 # method searches for DcPage document by subject_link, id or alt_link. When found it loads 

data/app/models/dc_part.rb

@@ -23,7 +23,34 @@
 require_dependency DrgCms.model 'dc_piece'
 
 ########################################################################
-# Mongoid::Document model for dc_part embedded documents.
+# == Schema information
+#
+# Collection name: dc_part : Parts of page
+#
+#  _id                  BSON::ObjectId       _id
+#  created_at           Time                 created_at
+#  updated_at           Time                 Last updated at
+#  name                 String               Parts can be searched by name or by id
+#  description          String               Short description of part
+#  picture              String               Picture contents of part
+#  thumbnail            String               Small version of picture if available
+#  body                 String               Content of this part
+#  css                  String               CSS
+#  script               String               Script, if script is included in part
+#  script_type          String               Script type
+#  params               String               params
+#  piece_id             BSON::ObjectId       Piece name if part is connected to piece
+#  div_id               String               Div id (position name) where this part is displayed as defined on design
+#  site_id              BSON::ObjectId       site_id
+#  order                Integer              Order between parts
+#  active               Mongoid::Boolean     Part is active
+#  valid_from           DateTime             Part is valid from
+#  valid_to             DateTime             Part is valid to
+#  created_by           BSON::ObjectId       created_by
+#  updated_by           BSON::ObjectId       Last updated by
+#  _type                String               _type
+#  policy_id            BSON::ObjectId       Access policy for the part
+#  link                 String               Link when part can be accessed with pretty link
 # 
 # DcPart model is used for embedding parts of final document into other models. It declares fields
 # which may be used in various scenarios. For example:

data/app/models/dc_permission.rb

@@ -22,7 +22,17 @@
 #++
 
 ########################################################################
-# Mongoid::Document model for dc_permissions collection.
+# == Schema information
+#
+# Collection name: dc_permission : Collection permissions
+#
+#  _id                  BSON::ObjectId       _id
+#  created_at           Time                 created_at
+#  updated_at           Time                 updated_at
+#  table_name           String               Permission is valid for collection
+#  is_default           Mongoid::Boolean     This is default permission for all collections in database
+#  active               Mongoid::Boolean     Permission is active
+#  dc_policy_rules      Embedded:DcPolicyRule Defined policy rules
 # 
 # dc_permissions collection is used for saving documents which define permissions 
 # for accessing individual collections within DRG CMS system. Document which is marked 

data/app/models/dc_piece.rb

@@ -57,7 +57,31 @@ end
 end
 
 ########################################################################
-# Mongoid::Document model for dc_piece documents.
+# == Schema information
+#
+# Collection name: dc_piece : Pieces of content
+#
+#  _id                  BSON::ObjectId       _id
+#  created_at           Time                 created_at
+#  updated_at           Time                 Last updated at
+#  name                 String               Unique name for piece
+#  description          String               Short description of piece
+#  picture              String               Picture contents of piece
+#  thumbnail            String               Small version of picture if available
+#  body                 String               Content of this piece
+#  css                  String               CSS
+#  script               String               Script, if script is included in piece
+#  script_type          String               Script type
+#  params               String               params
+#  piece_id             BSON::ObjectId       Piece
+#  div_id               String               Div (position name) id on design where this piece is rendered
+#  site_id              BSON::ObjectId       Site name where this piece will belong to
+#  order                Integer              Order to be used when pieces are positioned in the same div (location)
+#  active               Mongoid::Boolean     Piece is active
+#  valid_from           DateTime             Piece is valid from
+#  valid_to             DateTime             Piece is valid to
+#  created_by           BSON::ObjectId       created_by
+#  updated_by           BSON::ObjectId       Last updated by
 # 
 # DcPiece collection is used for documents or pieces of web site which are common to site 
 # or perhaps to all sites in database. For example page footer is a good candidate 

data/app/models/dc_policy.rb

@@ -22,7 +22,20 @@
 #++
 
 ########################################################################
-# Mongoid::Document model for dc_policy documents embedded into dc_sites collection documents.
+# == Schema information
+#
+# Collection name: dc_policy : Access policy declarations
+#
+#  _id                  BSON::ObjectId       _id
+#  created_at           Time                 created_at
+#  updated_at           Time                 updated_at
+#  name                 String               Unique policy name
+#  description          String               Description for this policy
+#  is_default           Mongoid::Boolean     This is default policy for the site
+#  active               Mongoid::Boolean     Policy is active
+#  updated_by           BSON::ObjectId       updated_by
+#  message              String               Error message when blocked by this policy
+#  dc_policy_rules      Embedded:DcPolicyRule Policy rules
 # 
 # DcPolicy documents define policies for accessing data on web site. Policies define which 
 # user roles (defined in dc_policy_roles collection) has no access, can view or edit data (sees CMS menu) on

data/app/models/dc_policy_role.rb

@@ -22,7 +22,16 @@
 #++
 
 ########################################################################
-# Mongoid::Document model for dc_policy_roles collection.
+# == Schema information
+#
+# Collection name: dc_policy_role : User roles
+#
+#  _id                  BSON::ObjectId       _id
+#  created_at           Time                 created_at
+#  updated_at           Time                 updated_at
+#  name                 String               Role name
+#  system_name          String               System role name if required by application
+#  active               Mongoid::Boolean     Role is active
 # 
 # Documents in this model define all available user roles in the application. Roles 
 # are defined by unique name which is valid for current application or as alternative name (system_name) 

data/app/models/dc_policy_rule.rb

@@ -78,7 +78,15 @@ end
 end
 
 #########################################################################
-# Mongoid::Document model for dc_policy_rule documents embedded into documents.
+# == Schema information
+#
+# Collection name: dc_policy_rule : Access policy rules
+#
+#  _id                  BSON::ObjectId       _id
+#  created_at           Time                 created_at
+#  updated_at           Time                 updated_at
+#  dc_policy_role_id    Object               User role access defined by this rule
+#  permission           Integer              Access permission
 # 
 # DcPolicyRule documents define policies for accessing data. DRG CMS uses policy rules for
 # defining policies in DcSite, DcPermission and DcFolderPermission documents. 

data/app/models/dc_poll.rb

@@ -22,7 +22,29 @@
 #++
 
 ########################################################################
-# Mongoid::Document model for dc_poll documents.
+# == Schema information
+#
+# Collection name: dc_poll : Polls
+#
+#  _id                  BSON::ObjectId       _id
+#  created_at           Time                 created_at
+#  updated_at           Time                 updated_at
+#  name                 String               Unique poll name
+#  title                String               Title for the poll
+#  sub_text             String               Short description of the poll
+#  pre_display          String               pre_display
+#  operation            String               Operation performed on submit
+#  parameters           String               Aditional parameters for operation
+#  display              String               Select how fields are positioned on form
+#  css                  String               CSS specific to this poll
+#  form                 String               You can specified input items by providing form acording to rules of drgCMS form.
+#  valid_from           DateTime             Pole is valid from
+#  valid_to             DateTime             Pole is valid to
+#  captcha_type         String               Catpcha type name if captcha is used
+#  active               Mongoid::Boolean     active
+#  created_by           BSON::ObjectId       created_by
+#  updated_by           BSON::ObjectId       updated_by
+#  dc_poll_items        Embedded:DcPollItem  Items for this poll
 # 
 # DcPoll documents are used for different questionaries and formulars which can
 # be accessed independent or connected with DcPage documents. Entry fields can be defined