KB is now project-based. New view permissions added. Adjusted README.

Author: Joshua Villagomez

Diff for: AUTHORS

@@ -10,6 +10,7 @@ Contributors:
 * shoorick
 * fabiob
 * Martin Denizet
+* whqcd
 
 Documentation:
 * Alan Bowman

Diff for: CHANGES

@@ -10,3 +10,9 @@
   the setting in the configuration panel (default => true)
 * cleanup category list on the main page
 * fixed comment creation popup not being displayed
+
+0.3.2 (11-JUL-23)
+-----------------
+* Wiki macros for articles and categories.
+* Knowledgebase is now project-based, fully configurable through permissions.
+

Diff for: README.markdown

@@ -1,18 +1,20 @@
 # Redmine Knowledgebase plugin
 
-This plugin adds generic knowledgebase funcationlity to the redmine project management application.
+This plugin adds a professional knowledgebase functionality to the Redmine project management application.
 
 ## Introduction
 
-Redmine (www.redmine.org) is just plain awesome, and has proven to provide 90% of the functionality I need. The one feature that was missing was a usable knowledgebase component. I've looked at some of the open source solutions available, but couldn't find anything that fit my needs exactly. Seeing as redmine is so easily extended, I figured why not create it for this platform instead of starting yet another project from scratch :P
+Redmine (www.redmine.org) is just plain awesome, and has proven to provide 90% of the functionality I need. The one feature that was missing was a usable knowledgebase component. I've looked at some of the open source solutions available, but couldn't find anything that fit my needs exactly. Seeing as Redmine is so easily extended, I figured why not create it for this platform instead of starting yet another project from scratch :P
 
 ## Features
 
+* Knowledgebase articles per project
 * Categorization of Articles
 * Article ratings
 * File attachments
 * Article Comments
 * Article Tags
+* Wiki macros
 * Permissions
 
 ## Requirements
@@ -63,22 +65,13 @@ need to restart Redmine for the plugin to be available.
 
 ## Overview
 
-Once the Redmine Knowledgebase Plugin is installed, there will be a
-Knowledgebase link in the Redmine navigation header. Unlike the Redmine
-Wiki, which is only available at the per-project or subproject level,
-the Knowledgebase is available at the root level of the Redmine
-application.
+Once the Redmine Knowledgebase Plugin is installed, Knowledgebase articles are managed and controlled at the project level. After enabling and setting the right roles/permissions, each project will have its own categories and articles. Knowledgebase will appear as a tab view per project. 
 
 ## Configuring the Knowledgebase
 
-To start using the Knowledgebase plugin, click on the Knowledgebase link
-in the Redmine navigation header.
+To start using the Knowledgebase plugin, go to your project Settings -> Modules and enable Knowledgebase. Then, go to Administration -> Roles and Permissions. Select a role (e.g. Non member). Under Knowledgebase, add at least Manage Articles and Manage Article Categories permission (to test functionality; later apply real permissions for your users). Select any other that apply and Save. See Permissions section for more information.
 
-This takes you to the default page for
-the Knowledgebase, with this text: *"No articles have been added to the
-knowledgebase yet. Maybe you want to get the ball rolling ..."*. To the
-right is a green circle with a plus (+) sign, and the link to add a New
-Category.
+This takes you to the default page for the Knowledgebase, with this text: *"There have been no articles added"*. To the right is a green circle with a plus (+) sign, and the link to add a New Category.
 
 Click on **New Category**. This takes you to the Create Category page.
 
@@ -110,11 +103,28 @@ use that to navigate to any category or sub-category. You can also
 navigate to categories (not sub-categories) by clicking on the category
 name in the right hand *Browse by Category* side bar.
 
+### Knowledgebase Permissions
+
+The following permissions are available: 
+
+* View articles
+* Create articles
+* Edit articles
+* Manage articles
+* Create article categories
+* Comment and rate articles
+* Manage articles comments
+* Manage article categories
+* View newest articles
+* View most popular articles
+* View top rated articles
+* View recently updated articles
+
+For granular permissions, create specific Knowledgebase roles, associate the permissions and add them to a project. The Knowledebase home page statistic quadrants will appear or dissapear, based on the View permissions. 
 
 ## Using the Knowledgebase
 
-Once you have created categories, you can then add articles and
-sub-categories.
+Once you have enabled the module, set proper permissions and created categories, you can then add articles and sub-categories.
 
 ### Creating Sub-categories
 
@@ -190,7 +200,15 @@ You can easily create links to articles and categories from issues or Wiki pages
 * {{article(<article_id>)}} will render a link to the "kb#<article_id>: <article_title>" format.
 * {{category(<category_id>)}} will render a link to the "<category_title>" format, only renders the title of the category.
 
+For example: {{kb(71)}} will render a link: KB#71
+
 ## Knowledgebase Home Page
 
-Now that categories and articles have been created, the Home page of the Knowledgebase will show the *Newest Articles*, *Recently Updated Articles*, *Most Popular Articles*, and *Top Rated Articles*. You can use this page to help navigate the Knowledgebase, as well as using the *Jump to Category* drop down menu or the *Browse by Category* menu on the right of the screen. You can reach this page from anywhere inside the Knowledgebase by clicking on the Home link.
+Now that categories and articles have been created, the Home page of the Knowledgebase will show the *Newest Articles*, *Recently Updated Articles*, *Most Popular Articles*, and *Top Rated Articles* base on view permissions you have granted. You can use this page to help navigate the Knowledgebase, as well as using the *Jump to Category* drop down menu or the *Browse by Category* menu on the right of the screen. You can reach this page from anywhere inside the Knowledgebase by clicking on the Home link.
+
+**Note:** URL Links to categories or articles will appear as follows:
+
+* Categories: http://redmine-server.foo.bar/categories/[number]
+
+* Articles: http://redmine-server.foo.bar/articles/[number]
 

Diff for: app/controllers/articles_controller.rb

@@ -5,11 +5,27 @@ class ArticlesController < KnowledgebaseController
   include AttachmentsHelper
   include FaceboxRender
 
-  #Authorize against global permissions defined in init.rb
-  before_filter :authorize_global
+  before_filter :find_project, :authorize
 
+  def find_project
+    if !params[:project_id].nil?
+        @project=Project.find(params[:project_id])
+    elsif !params[:category_id].nil?
+        @project=Category.find(params[:category_id]).project
+    elsif !params[:id].nil?
+        @project=Article.find(params[:id]).category.project
+    elsif !params[:article_id].nil?
+        @project=Article.find(params[:article_id]).category.project
+    end
+  end
+
   def new
     @article = Article.new
+
+    # only get root categories
+    # which will then be fed into the function
+    # this will make it render correctly
+    @categories=@project.categories.find(:all, :conditions=>["parent_id IS Null"])
     @default_category = params[:category_id]
     @article.category_id = params[:category_id]
   end
@@ -20,14 +36,15 @@ def rate
     render :partial => "rating", :locals => {:article => @article}
   end
 
-  def create    
+  def create
     @article = Article.new(params[:article])
     @article.category_id = params[:category_id]
     @article.author_id = User.current.id
+    @article.project_id=Category.find(params[:category_id]).project_id
     if @article.save
       attachments = attach(@article, params[:attachments])
       flash[:notice] = "Created Article " + @article.title
-      redirect_to({ :controller => 'knowledgebase', :action => 'index' })
+      redirect_to({ :controller=>'categories', :action=>'show', :id=>Category.find(params[:category_id])})
     else
       render(:action => 'new')
     end
@@ -41,6 +58,7 @@ def show
   end
 
   def edit
+    @categories=@project.categories.find(:all, :conditions=>["parent_id IS Null"])
     @article = Article.find(params[:id])
   end
 
@@ -77,9 +95,10 @@ def destroy_comment
 
   def destroy
     @article = Article.find(params[:id])
+    category_id=@article.category.id
     @article.destroy
     flash[:notice] = "Article Removed"
-    redirect_to({ :controller => 'knowledgebase', :action => 'index' })
+    redirect_to({ :controller => 'categories', :action=>'show', :id=>category_id })
   end
 
   def add_attachment

Diff for: app/controllers/categories_controller.rb

@@ -1,8 +1,19 @@
 class CategoriesController < KnowledgebaseController
-	unloadable
+  unloadable
 
-  #Authorize against global permissions defined in init.rb
-  before_filter :authorize_global
+  before_filter :find_project, :authorize
+
+  def find_project
+    if !params[:project_id].nil?
+        @project=Project.find(params[:project_id])
+    elsif !params[:category_id].nil?
+        @project=Category.find(params[:category_id]).project
+    elsif !params[:parent_id].nil?
+        @project=Category.find(params[:parent_id]).project
+    elsif !params[:id].nil?
+        @project=Category.find(params[:id]).project
+    end
+  end
 
   def show
     @category = Category.find(params[:id])
@@ -12,15 +23,18 @@ def show
   def new
     @category = Category.new
     @parent_id = params[:parent_id]
+    @categories=@project.categories.find(:all, :conditions=>["parent_id Is Null"])
   end
 
   def create
     @category = Category.new(params[:category])
+    @category.project_id=@project.id
+
     if @category.save
       # Test if the new category is a root category, and if more categories exist.
       # We check for a value > 1 because if this is the first entry, the category
       # count would be 1 (since the create operation already succeeded)
-      if !params[:root_category] and Category.count > 1
+      if !params[:root_category] and @project.categories.count > 1
         @category.move_to_child_of(Category.find(params[:parent_id]))
       end
 
@@ -33,14 +47,16 @@ def create
 
   def edit
     @category = Category.find(params[:id])
+    @categories=@project.categories.find(:all, :conditions=>["parent_id Is Null"])
   end
 
   def delete
     @category = Category.find(params[:id])
     if @category.articles.size == 0
+      project_identifier=@category.project.identifier
       @category.destroy
       flash[:notice] = "Category deleted"
-      redirect_to({ :controller => :knowledgebase, :action => 'index' })
+      redirect_to({ :controller=>'knowledgebase', :action => 'index', :id=>project_identifier})
     else
       @articles = @category.articles.find(:all)
       flash[:error] = "Category is assigned to articles and could not be deleted."

Diff for: app/controllers/knowledgebase_controller.rb

@@ -1,8 +1,7 @@
 class KnowledgebaseController < ApplicationController
   unloadable
 
-  #Authorize against global permissions defined in init.rb
-  before_filter :authorize_global, :unless => :allow_anonymous_access?
+  before_filter :find_project, :authorize
 
   rescue_from ActionView::MissingTemplate, :with => :force_404
   rescue_from ActiveRecord::RecordNotFound, :with => :force_404
@@ -13,17 +12,18 @@ def index
     rescue
       summary_limit = 5
     end
+
+    article_table=Article.table_name
+    @categories=@project.categories.find(:all, :conditions=>["parent_id IS NULL"])
+
+    @articles_newest = @project.articles.find(:all, :limit => summary_limit, :order => "#{article_table}.created_at DESC")
+    @articles_updated = @project.articles.find(:all, :limit => summary_limit, :conditions => ["#{article_table}.created_at <> #{article_table}.updated_at"], :order => "#{article_table}.updated_at DESC")
 
-    @categories = Category.find(:all)
-    @articles_newest   = Article.find(:all, :limit => summary_limit, :order => 'created_at DESC')
-    @articles_updated  = Article.find(:all, :limit => summary_limit, :conditions => ['created_at <> updated_at'], :order => 'updated_at DESC')
-    
-    #FIXME the following method still requires ALL records to be loaded before being filtered.
-    
-    a = Article.find(:all, :include => :viewings).sort_by(&:view_count)
+    a = @project.articles.find(:all, :include => :viewings).sort_by(&:view_count)   
     a = a.drop(a.count - summary_limit) if a.count > summary_limit
     @articles_popular  = a.reverse
-    a = Article.find(:all, :include => :ratings).sort_by(&:rated_count)
+
+    a = @project.articles.find(:all, :include => :ratings).sort_by(&:rated_count)
     a = a.drop(a.count - summary_limit) if a.count > summary_limit
     @articles_toprated = a.reverse
   end
@@ -38,10 +38,6 @@ def is_user_logged_in
     end
   end
 
-  def allow_anonymous_access?
-    Setting['plugin_redmine_knowledgebase']['knowledgebase_anonymous_access'].to_i == 1
-  end
-
 #######
 private
 #######
@@ -50,5 +46,7 @@ def force_404
     render_404
   end
 
+
+
 end
 

Diff for: app/helpers/knowledgebase_helper.rb

@@ -1,27 +1,14 @@
 module KnowledgebaseHelper
 
-  # Display a link if the user has a global permission
-  def link_to_if_authorized_globally(name, options = {}, html_options = nil, *parameters_for_method_reference)
-    if authorized_globally(options[:controller],options[:action])
-      link_to(name, options, html_options, *parameters_for_method_reference)
-    end
-  end
-  
-  def link_to_remote_if_authorized_globally(name, options = {}, html_options = nil, *parameters_for_method_reference)
-    if authorized_globally(options[:controller],options[:action])
-      link_to_remote(name, options, html_options, *parameters_for_method_reference)
-    end
+  def user_allowed(action,scope=nil)
+    User.current.allowed_to?(action,scope)
   end
 
-  def authorized_globally(controller,action)
-    User.current.allowed_to?({:controller => controller, :action => action}, nil, :global => true)
-  end
- 
   def format_article_summary(article, format)
     output = nil
     case format
     when "normal"
-      output = textilizable article.summary
+      output = article.summary
     when "newest"
       output = "Created " + time_ago_in_words(article.created_at) + " ago in " + link_to(article.category.title, {:controller => 'categories', :action => 'show', :id => article.category.id})
     when "updated"

Diff for: app/models/article.rb

@@ -6,7 +6,7 @@ class Article < ActiveRecord::Base
   validates_presence_of :title
   validates_presence_of :category_id
 
-  belongs_to :project # XXX association added to allow searching to work
+  belongs_to :project # this will allow the article to be searched through, works along with init.rb
   belongs_to :category
   belongs_to :author, :class_name => 'User', :foreign_key => 'author_id'
 
@@ -18,13 +18,18 @@ class Article < ActiveRecord::Base
   acts_as_searchable :columns => [ "kb_articles.title", "kb_articles.content"],
                      :include => [ :project ],
                      :order_column => "kb_articles.id",
-                     :permission => nil
+                     :permission => nil,
+                     :date_column => "#{table_name}.created_at"
 
+  # this controls what text is displayed
+  # when results come back as an article
   acts_as_event :title => Proc.new { |o| "#{l(:label_title_articles)} ##{o.id}: #{o.title}" },
                 :description => Proc.new { |o| "#{o.content}" },
                 :datetime => :created_at,
                 :type => 'articles',
-                :url => Proc.new { |o| {:controller => 'articles', :action => 'show', :id => nil, :article_id => o.id} }
+                :url => Proc.new { |o| {:controller => 'articles', :action => 'show', :id => o.id}
+  }
+
 
   has_many :comments, :as => :commented, :dependent => :delete_all, :order => "created_on"
 

Diff for: app/models/category.rb

@@ -5,6 +5,7 @@ class Category < ActiveRecord::Base
 
   validates_presence_of :title
 
+  belongs_to :project
   has_many :articles
 
   acts_as_nested_set :order => 'title'

Diff for: app/views/articles/_form.html.erb

@@ -2,7 +2,7 @@
 <div class="box tabular">
 <p>
 <label for="category_id"><%= l(:label_category) %></label>
-<%= select_tag :category_id, options_for_select(nested_set_options(Category) {|i| "#{'»' * i.level} #{i.title}" }, @article.category_id) %><br />
+<%= select_tag :category_id, options_for_select(nested_set_options(@categories) {|i| "#{'»' * i.level} #{i.title}" }, @article.category_id) %><br />
 </p>
 <p><%= f.text_field :title, :size => 60, :label => l(:label_title) %></p>
 <p><%= f.text_area :summary, :cols => 60, :rows => 5, :class => 'wiki-edit', :label => l(:label_summary) %></p>
@@ -14,4 +14,4 @@
 </div>
 
 <%= wikitoolbar_for 'article_summary' %>
-<%= wikitoolbar_for 'article_content' %>
+<%= wikitoolbar_for 'article_content' %>

Diff for: app/views/articles/comment.html.erb

@@ -1,6 +1,6 @@
 <div id="section-title" class="comments">Add Comment</div>
 
-<% form_tag({:action => 'add_comment', :id => @article_id}, :id => "add_comment_form") do %>
+<% form_tag({:action => 'add_comment', :id => @article_id,:project_id=>params[:project_id]}, :id => "add_comment_form" ) do %>
   <div class="box">
       <%= text_area 'comment', 'comments', :cols => 80, :rows => 15, :class => 'wiki-edit' %>    
   </div>