annotate .svn/pristine/c8/c86b179f5d130043d8c3b043bc12c22e16c1356d.svn-base @ 1628:9c5f8e24dadc live tip

Quieten this cron script
author Chris Cannam
date Tue, 25 Aug 2020 11:38:49 +0100
parents e248c7af89ec
children
rev   line source
Chris@1494 1 # Redmine - project management software
Chris@1494 2 # Copyright (C) 2006-2014 Jean-Philippe Lang
Chris@1494 3 #
Chris@1494 4 # This program is free software; you can redistribute it and/or
Chris@1494 5 # modify it under the terms of the GNU General Public License
Chris@1494 6 # as published by the Free Software Foundation; either version 2
Chris@1494 7 # of the License, or (at your option) any later version.
Chris@1494 8 #
Chris@1494 9 # This program is distributed in the hope that it will be useful,
Chris@1494 10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
Chris@1494 11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
Chris@1494 12 # GNU General Public License for more details.
Chris@1494 13 #
Chris@1494 14 # You should have received a copy of the GNU General Public License
Chris@1494 15 # along with this program; if not, write to the Free Software
Chris@1494 16 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
Chris@1494 17
Chris@1494 18 module Redmine
Chris@1494 19 module MenuManager
Chris@1494 20 class MenuError < StandardError #:nodoc:
Chris@1494 21 end
Chris@1494 22
Chris@1494 23 module MenuController
Chris@1494 24 def self.included(base)
Chris@1494 25 base.extend(ClassMethods)
Chris@1494 26 end
Chris@1494 27
Chris@1494 28 module ClassMethods
Chris@1494 29 @@menu_items = Hash.new {|hash, key| hash[key] = {:default => key, :actions => {}}}
Chris@1494 30 mattr_accessor :menu_items
Chris@1494 31
Chris@1494 32 # Set the menu item name for a controller or specific actions
Chris@1494 33 # Examples:
Chris@1494 34 # * menu_item :tickets # => sets the menu name to :tickets for the whole controller
Chris@1494 35 # * menu_item :tickets, :only => :list # => sets the menu name to :tickets for the 'list' action only
Chris@1494 36 # * menu_item :tickets, :only => [:list, :show] # => sets the menu name to :tickets for 2 actions only
Chris@1494 37 #
Chris@1494 38 # The default menu item name for a controller is controller_name by default
Chris@1494 39 # Eg. the default menu item name for ProjectsController is :projects
Chris@1494 40 def menu_item(id, options = {})
Chris@1494 41 if actions = options[:only]
Chris@1494 42 actions = [] << actions unless actions.is_a?(Array)
Chris@1494 43 actions.each {|a| menu_items[controller_name.to_sym][:actions][a.to_sym] = id}
Chris@1494 44 else
Chris@1494 45 menu_items[controller_name.to_sym][:default] = id
Chris@1494 46 end
Chris@1494 47 end
Chris@1494 48 end
Chris@1494 49
Chris@1494 50 def menu_items
Chris@1494 51 self.class.menu_items
Chris@1494 52 end
Chris@1494 53
Chris@1494 54 # Returns the menu item name according to the current action
Chris@1494 55 def current_menu_item
Chris@1494 56 @current_menu_item ||= menu_items[controller_name.to_sym][:actions][action_name.to_sym] ||
Chris@1494 57 menu_items[controller_name.to_sym][:default]
Chris@1494 58 end
Chris@1494 59
Chris@1494 60 # Redirects user to the menu item of the given project
Chris@1494 61 # Returns false if user is not authorized
Chris@1494 62 def redirect_to_project_menu_item(project, name)
Chris@1494 63 item = Redmine::MenuManager.items(:project_menu).detect {|i| i.name.to_s == name.to_s}
Chris@1494 64 if item && User.current.allowed_to?(item.url, project) && (item.condition.nil? || item.condition.call(project))
Chris@1494 65 redirect_to({item.param => project}.merge(item.url))
Chris@1494 66 return true
Chris@1494 67 end
Chris@1494 68 false
Chris@1494 69 end
Chris@1494 70 end
Chris@1494 71
Chris@1494 72 module MenuHelper
Chris@1494 73 # Returns the current menu item name
Chris@1494 74 def current_menu_item
Chris@1494 75 controller.current_menu_item
Chris@1494 76 end
Chris@1494 77
Chris@1494 78 # Renders the application main menu
Chris@1494 79 def render_main_menu(project)
Chris@1494 80 render_menu((project && !project.new_record?) ? :project_menu : :application_menu, project)
Chris@1494 81 end
Chris@1494 82
Chris@1494 83 def display_main_menu?(project)
Chris@1494 84 menu_name = project && !project.new_record? ? :project_menu : :application_menu
Chris@1494 85 Redmine::MenuManager.items(menu_name).children.present?
Chris@1494 86 end
Chris@1494 87
Chris@1494 88 def render_menu(menu, project=nil)
Chris@1494 89 links = []
Chris@1494 90 menu_items_for(menu, project) do |node|
Chris@1494 91 links << render_menu_node(node, project)
Chris@1494 92 end
Chris@1494 93 links.empty? ? nil : content_tag('ul', links.join("\n").html_safe)
Chris@1494 94 end
Chris@1494 95
Chris@1494 96 def render_menu_node(node, project=nil)
Chris@1494 97 if node.children.present? || !node.child_menus.nil?
Chris@1494 98 return render_menu_node_with_children(node, project)
Chris@1494 99 else
Chris@1494 100 caption, url, selected = extract_node_details(node, project)
Chris@1494 101 return content_tag('li',
Chris@1494 102 render_single_menu_node(node, caption, url, selected))
Chris@1494 103 end
Chris@1494 104 end
Chris@1494 105
Chris@1494 106 def render_menu_node_with_children(node, project=nil)
Chris@1494 107 caption, url, selected = extract_node_details(node, project)
Chris@1494 108
Chris@1494 109 html = [].tap do |html|
Chris@1494 110 html << '<li>'
Chris@1494 111 # Parent
Chris@1494 112 html << render_single_menu_node(node, caption, url, selected)
Chris@1494 113
Chris@1494 114 # Standard children
Chris@1494 115 standard_children_list = "".html_safe.tap do |child_html|
Chris@1494 116 node.children.each do |child|
Chris@1494 117 child_html << render_menu_node(child, project)
Chris@1494 118 end
Chris@1494 119 end
Chris@1494 120
Chris@1494 121 html << content_tag(:ul, standard_children_list, :class => 'menu-children') unless standard_children_list.empty?
Chris@1494 122
Chris@1494 123 # Unattached children
Chris@1494 124 unattached_children_list = render_unattached_children_menu(node, project)
Chris@1494 125 html << content_tag(:ul, unattached_children_list, :class => 'menu-children unattached') unless unattached_children_list.blank?
Chris@1494 126
Chris@1494 127 html << '</li>'
Chris@1494 128 end
Chris@1494 129 return html.join("\n").html_safe
Chris@1494 130 end
Chris@1494 131
Chris@1494 132 # Returns a list of unattached children menu items
Chris@1494 133 def render_unattached_children_menu(node, project)
Chris@1494 134 return nil unless node.child_menus
Chris@1494 135
Chris@1494 136 "".html_safe.tap do |child_html|
Chris@1494 137 unattached_children = node.child_menus.call(project)
Chris@1494 138 # Tree nodes support #each so we need to do object detection
Chris@1494 139 if unattached_children.is_a? Array
Chris@1494 140 unattached_children.each do |child|
Chris@1494 141 child_html << content_tag(:li, render_unattached_menu_item(child, project))
Chris@1494 142 end
Chris@1494 143 else
Chris@1494 144 raise MenuError, ":child_menus must be an array of MenuItems"
Chris@1494 145 end
Chris@1494 146 end
Chris@1494 147 end
Chris@1494 148
Chris@1494 149 def render_single_menu_node(item, caption, url, selected)
Chris@1494 150 link_to(h(caption), url, item.html_options(:selected => selected))
Chris@1494 151 end
Chris@1494 152
Chris@1494 153 def render_unattached_menu_item(menu_item, project)
Chris@1494 154 raise MenuError, ":child_menus must be an array of MenuItems" unless menu_item.is_a? MenuItem
Chris@1494 155
Chris@1494 156 if User.current.allowed_to?(menu_item.url, project)
Chris@1494 157 link_to(h(menu_item.caption),
Chris@1494 158 menu_item.url,
Chris@1494 159 menu_item.html_options)
Chris@1494 160 end
Chris@1494 161 end
Chris@1494 162
Chris@1494 163 def menu_items_for(menu, project=nil)
Chris@1494 164 items = []
Chris@1494 165 Redmine::MenuManager.items(menu).root.children.each do |node|
Chris@1494 166 if allowed_node?(node, User.current, project)
Chris@1494 167 if block_given?
Chris@1494 168 yield node
Chris@1494 169 else
Chris@1494 170 items << node # TODO: not used?
Chris@1494 171 end
Chris@1494 172 end
Chris@1494 173 end
Chris@1494 174 return block_given? ? nil : items
Chris@1494 175 end
Chris@1494 176
Chris@1494 177 def extract_node_details(node, project=nil)
Chris@1494 178 item = node
Chris@1494 179 url = case item.url
Chris@1494 180 when Hash
Chris@1494 181 project.nil? ? item.url : {item.param => project}.merge(item.url)
Chris@1494 182 when Symbol
Chris@1494 183 send(item.url)
Chris@1494 184 else
Chris@1494 185 item.url
Chris@1494 186 end
Chris@1494 187 caption = item.caption(project)
Chris@1494 188 return [caption, url, (current_menu_item == item.name)]
Chris@1494 189 end
Chris@1494 190
Chris@1494 191 # Checks if a user is allowed to access the menu item by:
Chris@1494 192 #
Chris@1494 193 # * Checking the url target (project only)
Chris@1494 194 # * Checking the conditions of the item
Chris@1494 195 def allowed_node?(node, user, project)
Chris@1494 196 if project && user && !user.allowed_to?(node.url, project)
Chris@1494 197 return false
Chris@1494 198 end
Chris@1494 199 if node.condition && !node.condition.call(project)
Chris@1494 200 # Condition that doesn't pass
Chris@1494 201 return false
Chris@1494 202 end
Chris@1494 203 return true
Chris@1494 204 end
Chris@1494 205 end
Chris@1494 206
Chris@1494 207 class << self
Chris@1494 208 def map(menu_name)
Chris@1494 209 @items ||= {}
Chris@1494 210 mapper = Mapper.new(menu_name.to_sym, @items)
Chris@1494 211 if block_given?
Chris@1494 212 yield mapper
Chris@1494 213 else
Chris@1494 214 mapper
Chris@1494 215 end
Chris@1494 216 end
Chris@1494 217
Chris@1494 218 def items(menu_name)
Chris@1494 219 @items[menu_name.to_sym] || MenuNode.new(:root, {})
Chris@1494 220 end
Chris@1494 221 end
Chris@1494 222
Chris@1494 223 class Mapper
Chris@1494 224 attr_reader :menu, :menu_items
Chris@1494 225
Chris@1494 226 def initialize(menu, items)
Chris@1494 227 items[menu] ||= MenuNode.new(:root, {})
Chris@1494 228 @menu = menu
Chris@1494 229 @menu_items = items[menu]
Chris@1494 230 end
Chris@1494 231
Chris@1494 232 # Adds an item at the end of the menu. Available options:
Chris@1494 233 # * param: the parameter name that is used for the project id (default is :id)
Chris@1494 234 # * if: a Proc that is called before rendering the item, the item is displayed only if it returns true
Chris@1494 235 # * caption that can be:
Chris@1494 236 # * a localized string Symbol
Chris@1494 237 # * a String
Chris@1494 238 # * a Proc that can take the project as argument
Chris@1494 239 # * before, after: specify where the menu item should be inserted (eg. :after => :activity)
Chris@1494 240 # * parent: menu item will be added as a child of another named menu (eg. :parent => :issues)
Chris@1494 241 # * children: a Proc that is called before rendering the item. The Proc should return an array of MenuItems, which will be added as children to this item.
Chris@1494 242 # eg. :children => Proc.new {|project| [Redmine::MenuManager::MenuItem.new(...)] }
Chris@1494 243 # * last: menu item will stay at the end (eg. :last => true)
Chris@1494 244 # * html_options: a hash of html options that are passed to link_to
Chris@1494 245 def push(name, url, options={})
Chris@1494 246 options = options.dup
Chris@1494 247
Chris@1494 248 if options[:parent]
Chris@1494 249 subtree = self.find(options[:parent])
Chris@1494 250 if subtree
Chris@1494 251 target_root = subtree
Chris@1494 252 else
Chris@1494 253 target_root = @menu_items.root
Chris@1494 254 end
Chris@1494 255
Chris@1494 256 else
Chris@1494 257 target_root = @menu_items.root
Chris@1494 258 end
Chris@1494 259
Chris@1494 260 # menu item position
Chris@1494 261 if first = options.delete(:first)
Chris@1494 262 target_root.prepend(MenuItem.new(name, url, options))
Chris@1494 263 elsif before = options.delete(:before)
Chris@1494 264
Chris@1494 265 if exists?(before)
Chris@1494 266 target_root.add_at(MenuItem.new(name, url, options), position_of(before))
Chris@1494 267 else
Chris@1494 268 target_root.add(MenuItem.new(name, url, options))
Chris@1494 269 end
Chris@1494 270
Chris@1494 271 elsif after = options.delete(:after)
Chris@1494 272
Chris@1494 273 if exists?(after)
Chris@1494 274 target_root.add_at(MenuItem.new(name, url, options), position_of(after) + 1)
Chris@1494 275 else
Chris@1494 276 target_root.add(MenuItem.new(name, url, options))
Chris@1494 277 end
Chris@1494 278
Chris@1494 279 elsif options[:last] # don't delete, needs to be stored
Chris@1494 280 target_root.add_last(MenuItem.new(name, url, options))
Chris@1494 281 else
Chris@1494 282 target_root.add(MenuItem.new(name, url, options))
Chris@1494 283 end
Chris@1494 284 end
Chris@1494 285
Chris@1494 286 # Removes a menu item
Chris@1494 287 def delete(name)
Chris@1494 288 if found = self.find(name)
Chris@1494 289 @menu_items.remove!(found)
Chris@1494 290 end
Chris@1494 291 end
Chris@1494 292
Chris@1494 293 # Checks if a menu item exists
Chris@1494 294 def exists?(name)
Chris@1494 295 @menu_items.any? {|node| node.name == name}
Chris@1494 296 end
Chris@1494 297
Chris@1494 298 def find(name)
Chris@1494 299 @menu_items.find {|node| node.name == name}
Chris@1494 300 end
Chris@1494 301
Chris@1494 302 def position_of(name)
Chris@1494 303 @menu_items.each do |node|
Chris@1494 304 if node.name == name
Chris@1494 305 return node.position
Chris@1494 306 end
Chris@1494 307 end
Chris@1494 308 end
Chris@1494 309 end
Chris@1494 310
Chris@1494 311 class MenuNode
Chris@1494 312 include Enumerable
Chris@1494 313 attr_accessor :parent
Chris@1494 314 attr_reader :last_items_count, :name
Chris@1494 315
Chris@1494 316 def initialize(name, content = nil)
Chris@1494 317 @name = name
Chris@1494 318 @children = []
Chris@1494 319 @last_items_count = 0
Chris@1494 320 end
Chris@1494 321
Chris@1494 322 def children
Chris@1494 323 if block_given?
Chris@1494 324 @children.each {|child| yield child}
Chris@1494 325 else
Chris@1494 326 @children
Chris@1494 327 end
Chris@1494 328 end
Chris@1494 329
Chris@1494 330 # Returns the number of descendants + 1
Chris@1494 331 def size
Chris@1494 332 @children.inject(1) {|sum, node| sum + node.size}
Chris@1494 333 end
Chris@1494 334
Chris@1494 335 def each &block
Chris@1494 336 yield self
Chris@1494 337 children { |child| child.each(&block) }
Chris@1494 338 end
Chris@1494 339
Chris@1494 340 # Adds a child at first position
Chris@1494 341 def prepend(child)
Chris@1494 342 add_at(child, 0)
Chris@1494 343 end
Chris@1494 344
Chris@1494 345 # Adds a child at given position
Chris@1494 346 def add_at(child, position)
Chris@1494 347 raise "Child already added" if find {|node| node.name == child.name}
Chris@1494 348
Chris@1494 349 @children = @children.insert(position, child)
Chris@1494 350 child.parent = self
Chris@1494 351 child
Chris@1494 352 end
Chris@1494 353
Chris@1494 354 # Adds a child as last child
Chris@1494 355 def add_last(child)
Chris@1494 356 add_at(child, -1)
Chris@1494 357 @last_items_count += 1
Chris@1494 358 child
Chris@1494 359 end
Chris@1494 360
Chris@1494 361 # Adds a child
Chris@1494 362 def add(child)
Chris@1494 363 position = @children.size - @last_items_count
Chris@1494 364 add_at(child, position)
Chris@1494 365 end
Chris@1494 366 alias :<< :add
Chris@1494 367
Chris@1494 368 # Removes a child
Chris@1494 369 def remove!(child)
Chris@1494 370 @children.delete(child)
Chris@1494 371 @last_items_count -= +1 if child && child.last
Chris@1494 372 child.parent = nil
Chris@1494 373 child
Chris@1494 374 end
Chris@1494 375
Chris@1494 376 # Returns the position for this node in it's parent
Chris@1494 377 def position
Chris@1494 378 self.parent.children.index(self)
Chris@1494 379 end
Chris@1494 380
Chris@1494 381 # Returns the root for this node
Chris@1494 382 def root
Chris@1494 383 root = self
Chris@1494 384 root = root.parent while root.parent
Chris@1494 385 root
Chris@1494 386 end
Chris@1494 387 end
Chris@1494 388
Chris@1494 389 class MenuItem < MenuNode
Chris@1494 390 include Redmine::I18n
Chris@1494 391 attr_reader :name, :url, :param, :condition, :parent, :child_menus, :last
Chris@1494 392
Chris@1494 393 def initialize(name, url, options)
Chris@1494 394 raise ArgumentError, "Invalid option :if for menu item '#{name}'" if options[:if] && !options[:if].respond_to?(:call)
Chris@1494 395 raise ArgumentError, "Invalid option :html for menu item '#{name}'" if options[:html] && !options[:html].is_a?(Hash)
Chris@1494 396 raise ArgumentError, "Cannot set the :parent to be the same as this item" if options[:parent] == name.to_sym
Chris@1494 397 raise ArgumentError, "Invalid option :children for menu item '#{name}'" if options[:children] && !options[:children].respond_to?(:call)
Chris@1494 398 @name = name
Chris@1494 399 @url = url
Chris@1494 400 @condition = options[:if]
Chris@1494 401 @param = options[:param] || :id
Chris@1494 402 @caption = options[:caption]
Chris@1494 403 @html_options = options[:html] || {}
Chris@1494 404 # Adds a unique class to each menu item based on its name
Chris@1494 405 @html_options[:class] = [@html_options[:class], @name.to_s.dasherize].compact.join(' ')
Chris@1494 406 @parent = options[:parent]
Chris@1494 407 @child_menus = options[:children]
Chris@1494 408 @last = options[:last] || false
Chris@1494 409 super @name.to_sym
Chris@1494 410 end
Chris@1494 411
Chris@1494 412 def caption(project=nil)
Chris@1494 413 if @caption.is_a?(Proc)
Chris@1494 414 c = @caption.call(project).to_s
Chris@1494 415 c = @name.to_s.humanize if c.blank?
Chris@1494 416 c
Chris@1494 417 else
Chris@1494 418 if @caption.nil?
Chris@1494 419 l_or_humanize(name, :prefix => 'label_')
Chris@1494 420 else
Chris@1494 421 @caption.is_a?(Symbol) ? l(@caption) : @caption
Chris@1494 422 end
Chris@1494 423 end
Chris@1494 424 end
Chris@1494 425
Chris@1494 426 def html_options(options={})
Chris@1494 427 if options[:selected]
Chris@1494 428 o = @html_options.dup
Chris@1494 429 o[:class] += ' selected'
Chris@1494 430 o
Chris@1494 431 else
Chris@1494 432 @html_options
Chris@1494 433 end
Chris@1494 434 end
Chris@1494 435 end
Chris@1494 436 end
Chris@1494 437 end