jro_apps/redmine Commit - r8156:cf5dba2beb87

1

# Redmine - project management software

1

# Redmine - project management software

2

3

#

3

#

4

# This program is free software; you can redistribute it and/or

4

# This program is free software; you can redistribute it and/or

5

# modify it under the terms of the GNU General Public License

5

# modify it under the terms of the GNU General Public License

6

# as published by the Free Software Foundation; either version 2

6

# as published by the Free Software Foundation; either version 2

7

# of the License, or (at your option) any later version.

7

# of the License, or (at your option) any later version.

8

#

8

#

9

# This program is distributed in the hope that it will be useful,

9

# This program is distributed in the hope that it will be useful,

10

# but WITHOUT ANY WARRANTY; without even the implied warranty of

10

# but WITHOUT ANY WARRANTY; without even the implied warranty of

11

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

11

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

12

# GNU General Public License for more details.

12

# GNU General Public License for more details.

13

#

13

#

14

# You should have received a copy of the GNU General Public License

14

# You should have received a copy of the GNU General Public License

15

# along with this program; if not, write to the Free Software

15

# along with this program; if not, write to the Free Software

16

# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

16

# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

17

18

module Redmine

18

module Redmine

19

module Hook

19

module Hook

20

include ActionController::UrlWriter

20

include ActionController::UrlWriter

21

22

@@listener_classes = []

22

@@listener_classes = []

23

@@listeners = nil

23

@@listeners = nil

24

@@hook_listeners = {}

24

@@hook_listeners = {}

25

26

class << self

26

class << self

27

# Adds a listener class.

27

# Adds a listener class.

28

# Automatically called when a class inherits from Redmine::Hook::Listener.

28

# Automatically called when a class inherits from Redmine::Hook::Listener.

29

def add_listener(klass)

29

def add_listener(klass)

30

raise "Hooks must include Singleton module." unless klass.included_modules.include?(Singleton)

30

raise "Hooks must include Singleton module." unless klass.included_modules.include?(Singleton)

31

@@listener_classes << klass

31

@@listener_classes << klass

32

clear_listeners_instances

32

clear_listeners_instances

33

end

33

end

34

35

# Returns all the listerners instances.

35

# Returns all the listerners instances.

36

def listeners

36

def listeners

37

@@listeners ||= @@listener_classes.collect {|listener| listener.instance}

37

@@listeners ||= @@listener_classes.collect {|listener| listener.instance}

38

end

38

end

39

40

# Returns the listeners instances for the given hook.

40

# Returns the listeners instances for the given hook.

41

def hook_listeners(hook)

41

def hook_listeners(hook)

42

@@hook_listeners[hook] ||= listeners.select {|listener| listener.respond_to?(hook)}

42

@@hook_listeners[hook] ||= listeners.select {|listener| listener.respond_to?(hook)}

43

end

43

end

44

45

# Clears all the listeners.

45

# Clears all the listeners.

46

def clear_listeners

46

def clear_listeners

47

@@listener_classes = []

47

@@listener_classes = []

48

clear_listeners_instances

48

clear_listeners_instances

49

end

49

end

50

51

# Clears all the listeners instances.

51

# Clears all the listeners instances.

52

def clear_listeners_instances

52

def clear_listeners_instances

53

@@listeners = nil

53

@@listeners = nil

54

@@hook_listeners = {}

54

@@hook_listeners = {}

55

end

55

end

56

57

# Calls a hook.

57

# Calls a hook.

58

# Returns the listeners response.

58

# Returns the listeners response.

59

def call_hook(hook, context={})

59

def call_hook(hook, context={})

60

[].tap do |response|

60

[].tap do |response|

61

hls = hook_listeners(hook)

61

hls = hook_listeners(hook)

62

if hls.any?

62

if hls.any?

63

hls.each {|listener| response << listener.send(hook, context)}

63

hls.each {|listener| response << listener.send(hook, context)}

64

end

64

end

65

end

65

end

66

end

66

end

67

end

67

end

68

69

# Base class for hook listeners.

69

# Base class for hook listeners.

70

class Listener

70

class Listener

71

include Singleton

71

include Singleton

72

include Redmine::I18n

72

include Redmine::I18n

73

74

# Registers the listener

74

# Registers the listener

75

def self.inherited(child)

75

def self.inherited(child)

76

Redmine::Hook.add_listener(child)

76

Redmine::Hook.add_listener(child)

77

super

77

super

78

end

78

end

79

80

end

80

end

81

82

# Listener class used for views hooks.

82

# Listener class used for views hooks.

83

# Listeners that inherit this class will include various helpers by default.

83

# Listeners that inherit this class will include various helpers by default.

84

class ViewListener < Listener

84

class ViewListener < Listener

85

include ERB::Util

85

include ERB::Util

86

include ActionView::Helpers::TagHelper

86

include ActionView::Helpers::TagHelper

87

include ActionView::Helpers::FormHelper

87

include ActionView::Helpers::FormHelper

88

include ActionView::Helpers::FormTagHelper

88

include ActionView::Helpers::FormTagHelper

89

include ActionView::Helpers::FormOptionsHelper

89

include ActionView::Helpers::FormOptionsHelper

90

include ActionView::Helpers::JavaScriptHelper

90

include ActionView::Helpers::JavaScriptHelper

91

include ActionView::Helpers::PrototypeHelper

91

include ActionView::Helpers::PrototypeHelper

92

include ActionView::Helpers::NumberHelper

92

include ActionView::Helpers::NumberHelper

93

include ActionView::Helpers::UrlHelper

93

include ActionView::Helpers::UrlHelper

94

include ActionView::Helpers::AssetTagHelper

94

include ActionView::Helpers::AssetTagHelper

95

include ActionView::Helpers::TextHelper

95

include ActionView::Helpers::TextHelper

96

include ActionController::UrlWriter

96

include ActionController::UrlWriter

97

include ApplicationHelper

97

include ApplicationHelper

98

99

# Default to creating links using only the path. Subclasses can

99

# Default to creating links using only the path. Subclasses can

100

# change this default as needed

100

# change this default as needed

101

def self.default_url_options

101

def self.default_url_options

102

{:only_path => true }

102

{:only_path => true }

103

end

103

end

104

105

# Helper method to directly render a partial using the context:

105

# Helper method to directly render a partial using the context:

106

#

106

#

107

# class MyHook < Redmine::Hook::ViewListener

107

# class MyHook < Redmine::Hook::ViewListener

108

# render_on :view_issues_show_details_bottom, :partial => "show_more_data"

108

# render_on :view_issues_show_details_bottom, :partial => "show_more_data"

109

# end

109

# end

110

#

110

#

111

def self.render_on(hook, options={})

111

def self.render_on(hook, options={})

112

define_method hook do |context|

112

define_method hook do |context|

113

context[:controller].send(:render_to_string, {:locals => context}.merge(options))

113

context[:controller].send(:render_to_string, {:locals => context}.merge(options))

114

end

114

end

115

end

115

end

116

end

116

end

117

118

# Helper module included in ApplicationHelper and ActionController so that

118

# Helper module included in ApplicationHelper and ActionController so that

119

# hooks can be called in views like this:

119

# hooks can be called in views like this:

120

#

120

#

121

# <%= call_hook(:some_hook) %>

121

# <%= call_hook(:some_hook) %>

122

# <%= call_hook(:another_hook, :foo => 'bar') %>

122

# <%= call_hook(:another_hook, :foo => 'bar') %>

123

#

123

#

124

# Or in controllers like:

124

# Or in controllers like:

125

# call_hook(:some_hook)

125

# call_hook(:some_hook)

126

# call_hook(:another_hook, :foo => 'bar')

126

# call_hook(:another_hook, :foo => 'bar')

127

#

127

#

128

# Hooks added to views will be concatenated into a string. Hooks added to

128

# Hooks added to views will be concatenated into a string. Hooks added to

129

# controllers will return an array of results.

129

# controllers will return an array of results.

130

#

130

#

131

# Several objects are automatically added to the call context:

131

# Several objects are automatically added to the call context:

132

#

132

#

133

# * project => current project

133

# * project => current project

134

# * request => Request instance

134

# * request => Request instance

135

# * controller => current Controller instance

135

# * controller => current Controller instance

136

#

136

#

137

module Helper

137

module Helper

138

def call_hook(hook, context={})

138

def call_hook(hook, context={})

139

if is_a?(ActionController::Base)

139

if is_a?(ActionController::Base)

140

default_context = {:controller => self, :project => @project, :request => request}

140

default_context = {:controller => self, :project => @project, :request => request}

141

Redmine::Hook.call_hook(hook, default_context.merge(context))

141

Redmine::Hook.call_hook(hook, default_context.merge(context))

142

else

142

else

143

default_context = {~~:controller~~ => ~~controller~~, :project => @project, ~~:request~~ => ~~request~~}

143

default_context = { :project => @project }

144

default_context[:controller] = controller if respond_to?(:controller)

145

default_context[:request] = request if respond_to?(:request)

144

Redmine::Hook.call_hook(hook, default_context.merge(context)).join(' ')

146

Redmine::Hook.call_hook(hook, default_context.merge(context)).join(' ')

145

end

147

end

146

end

148

end

147

end

149

end

148

end

150

end

149

end

151

end

150

152

151

ApplicationHelper.send(:include, Redmine::Hook::Helper)

153

ApplicationHelper.send(:include, Redmine::Hook::Helper)

152

ActionController::Base.send(:include, Redmine::Hook::Helper)

154

ActionController::Base.send(:include, Redmine::Hook::Helper)

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages

             # Redmine - project management software
             # Copyright (C) 2006-2011  Jean-Philippe Lang
             #
             # This program is free software; you can redistribute it and/or
             # modify it under the terms of the GNU General Public License
             # as published by the Free Software Foundation; either version 2
             # of the License, or (at your option) any later version.
             #
             # This program is distributed in the hope that it will be useful,
             # but WITHOUT ANY WARRANTY; without even the implied warranty of
             # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
             # GNU General Public License for more details.
             #
             # You should have received a copy of the GNU General Public License
             # along with this program; if not, write to the Free Software
             # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
             module Redmine
               module Hook
                 include ActionController::UrlWriter
                 @@listener_classes = []
                 @@listeners = nil
                 @@hook_listeners = {}
                 class << self
                   # Adds a listener class.
                   # Automatically called when a class inherits from Redmine::Hook::Listener.
                   def add_listener(klass)
                     raise "Hooks must include Singleton module." unless klass.included_modules.include?(Singleton)
                     @@listener_classes << klass
                     clear_listeners_instances
                   end
                   # Returns all the listerners instances.
                   def listeners
                     @@listeners ||= @@listener_classes.collect {|listener| listener.instance}
                   end
                   # Returns the listeners instances for the given hook.
                   def hook_listeners(hook)
                     @@hook_listeners[hook] ||= listeners.select {|listener| listener.respond_to?(hook)}
                   end
                   # Clears all the listeners.
                   def clear_listeners
                     @@listener_classes = []
                     clear_listeners_instances
                   end
                   # Clears all the listeners instances.
                   def clear_listeners_instances
                     @@listeners = nil
                     @@hook_listeners = {}
                   end
                   # Calls a hook.
                   # Returns the listeners response.
                   def call_hook(hook, context={})
                     [].tap do |response|
                       hls = hook_listeners(hook)
                       if hls.any?
                         hls.each {|listener| response << listener.send(hook, context)}
                       end
                     end
                   end
                 end
                 # Base class for hook listeners.
                 class Listener
                   include Singleton
                   include Redmine::I18n
                   # Registers the listener
                   def self.inherited(child)
                     Redmine::Hook.add_listener(child)
                     super
                   end
                 end
                 # Listener class used for views hooks.
                 # Listeners that inherit this class will include various helpers by default.
                 class ViewListener < Listener
                   include ERB::Util
                   include ActionView::Helpers::TagHelper
                   include ActionView::Helpers::FormHelper
                   include ActionView::Helpers::FormTagHelper
                   include ActionView::Helpers::FormOptionsHelper
                   include ActionView::Helpers::JavaScriptHelper
                   include ActionView::Helpers::PrototypeHelper
                   include ActionView::Helpers::NumberHelper
                   include ActionView::Helpers::UrlHelper
                   include ActionView::Helpers::AssetTagHelper
                   include ActionView::Helpers::TextHelper
                   include ActionController::UrlWriter
                   include ApplicationHelper
                   # Default to creating links using only the path.  Subclasses can
                   # change this default as needed
                   def self.default_url_options
                     {:only_path => true }
                   end
                   # Helper method to directly render a partial using the context:
                   #
                   #   class MyHook < Redmine::Hook::ViewListener
                   #     render_on :view_issues_show_details_bottom, :partial => "show_more_data"
                   #   end
                   #
                   def self.render_on(hook, options={})
                     define_method hook do |context|
                       context[:controller].send(:render_to_string, {:locals => context}.merge(options))
                     end
                   end
                 end
                 # Helper module included in ApplicationHelper and ActionController so that
                 # hooks can be called in views like this:
                 #
                 #   <%= call_hook(:some_hook) %>
                 #   <%= call_hook(:another_hook, :foo => 'bar') %>
                 #
                 # Or in controllers like:
                 #   call_hook(:some_hook)
                 #   call_hook(:another_hook, :foo => 'bar')
                 #
                 # Hooks added to views will be concatenated into a string. Hooks added to
                 # controllers will return an array of results.
                 #
                 # Several objects are automatically added to the call context:
                 #
                 # * project => current project
                 # * request => Request instance
                 # * controller => current Controller instance
                 #
                 module Helper
                   def call_hook(hook, context={})
                     if is_a?(ActionController::Base)
                       default_context = {:controller => self, :project => @project, :request => request}
                       Redmine::Hook.call_hook(hook, default_context.merge(context))
                     else
-                      default_context = {:controller => controller, :project => @project, :request => request}
+                      default_context = { :project => @project }
+                      default_context[:controller] = controller if respond_to?(:controller)
+                      default_context[:request] = request if respond_to?(:request)
                       Redmine::Hook.call_hook(hook, default_context.merge(context)).join(' ')
                     end
                   end
                 end
               end
             end
             ApplicationHelper.send(:include, Redmine::Hook::Helper)
             ActionController::Base.send(:include, Redmine::Hook::Helper)