Redmine

It would be sweet if something like this could be done so that we don't need (as plugin developers) to access the "request" variable.

include ActionController::UrlWriter

default_url_options[:host] = request.env[ 'SERVER_NAME' ]
default_url_options[:port] = request.env[ 'SERVER_PORT' ]

Douglas Manley wrote:

It would be sweet if something like this could be done so that we don't need (as plugin developers) to access the "request" variable.

That would solve the host and port issue (would also need protocol) but request has a lot of other useful information. For example, a plugin might want to sniff the User Agent and resent a mobile view.

I'd also love to be able to use render in a hook but I know it's not trivial. Putting "view" code in a class as a string feels so dirty to me.

This is how I would change hook.rb:

module Helper
  def call_hook(hook, context={})
    Redmine::Hook.call_hook(hook, {:project => @project, :request => request}.merge(context))
  end
end

And Redmine::Hook.call_hook:

# Calls a hook.
# Returns the listeners response.
def call_hook(hook, context={})
  returning "" do |response|
    hls = hook_listeners(hook)
    if hls.any?
      request = context[:request]
      if request
        default_url_options[:host] = request.env["SERVER_NAME"]
        default_url_options[:port] = request.env["SERVER_PORT"]
      end
      hls.each do |listener|
        response << listener.send(hook, context).to_s
      end
    end
  end
end

This works for me at least. I can use "link_to" in a hook listener and I can query context[:response].

What do you think?

Eric Davis wrote:

I'd also love to be able to use render in a hook but I know it's not trivial. Putting "view" code in a class as a string feels so dirty to me.

If the call_hook method is extended like this:

module Helper
  def call_hook(hook, context={})
    ctx_init = {:project => @project, :controller => controller, :request => request}
    Redmine::Hook.call_hook(hook, ctx_init.merge(context))
  end
end

you can use render_to_string in your hook listener method:

def view_issues_show_details_bottom(context)
  controller = context[:controller]
  issue = context[:issue]
  controller.send(:render_to_string, :partial => "show_more_data", :locals => {:issue => issue})
end

It works, but I wonder if this is the correct way to do it. At least the HTML is in a (partial) view again.

Actually the above method has to be:

module Helper
  def call_hook(hook, context={})
    ctx_init = {:project => @project, :request => request}
    ctx_init[:controller] = self.is_a?(ActionController::Base) ? self : controller
    Redmine::Hook.call_hook(hook, ctx_init.merge(context))
  end
end

This is how we can make calling render_to_string more straightforward:

In hook.rb

class ViewListener < Listener
  [...]
  def self.render_on(hook, options={})
    define_method hook do |context|
      context[:controller].send(:render_to_string, {:locals => context}.merge(options))
    end
  end
end

Then we can define a hook that renders its result using a partial view like this:

class MyHook < Redmine::Hook::ViewListener
  render_on :view_issues_show_details_bottom, :partial => "show_more_data" 
end

The partial view will have access to issue because it is given as a parameter in the call_hook call.

Great, thank you!

This should work just fine; thanks!

This will make the default_url_options[:only_path] to be true permanently. So the link in the notification mail will lost it's protocal, host and port.

Chaoqun Zou wrote:

> default_url_options[:only_path] ||= true >

This will make the default_url_options[:only_path] to be true permanently. So the link in the notification mail will lost it's protocal, host and port.

Can you provide a test case showing the incorrect behavior? The email urls were being generated correctly for me (see #2754).

I believe I fixed the Plugin and Mailer default_url_options in r2522. It turned out to be a tricky bug that was caused by using default_url_options incorrectly.

Both the plugin hooks and Mailer were setting default_url_options incorrectly and causing ActionContoller::UrlWritter to cache the settings on the module (mattr_accessor) causing several url generators to fail in either the plugin hooks or the Mailer. I found a good description of why this was happening on Stackoverflow.

Thanks for reporting the bug and providing the test case, it helped debugging.