util/helpers.lua

   1 -- Prosody IM
   2 -- Copyright (C) 2008-2010 Matthew Wild
   3 -- Copyright (C) 2008-2010 Waqas Hussain
   4 --
   5 -- This project is MIT/X11 licensed. Please see the
   6 -- COPYING file in the source package for more information.
   7 --
   8
   9 local debug = require "util.debug";
  10
  11 module("helpers", package.seeall);
  12
  13 -- Helper functions for debugging
  14
  15 local log = require "util.logger".init("util.debug");
  16
  17 function log_host_events(host)
  18         return log_events(prosody.hosts[host].events, host);
  19 end
  20
  21 function revert_log_host_events(host)
  22         return revert_log_events(prosody.hosts[host].events);
  23 end
  24
  25 function log_events(events, name, logger)
  26         local f = events.fire_event;
  27         if not f then
  28                 error("Object does not appear to be a util.events object");
  29         end
  30         logger = logger or log;
  31         name = name or tostring(events);
  32         function events.fire_event(event, ...)
  33                 logger("debug", "%s firing event: %s", name, event);
  34                 return f(event, ...);
  35         end
  36         events[events.fire_event] = f;
  37         return events;
  38 end
  39
  40 function revert_log_events(events)
  41         events.fire_event, events[events.fire_event] = events[events.fire_event], nil; -- :))
  42 end
  43
  44 function show_events(events, specific_event)
  45         local event_handlers = events._handlers;
  46         local events_array = {};
  47         local event_handler_arrays = {};
  48         for event in pairs(events._event_map) do
  49                 local handlers = event_handlers[event];
  50                 if handlers and (event == specific_event or not specific_event) then
  51                         table.insert(events_array, event);
  52                         local handler_strings = {};
  53                         for i, handler in ipairs(handlers) do
  54                                 local upvals = debug.string_from_var_table(debug.get_upvalues_table(handler));
  55                                 handler_strings[i] = "  "..i..": "..tostring(handler)..(upvals and ("\n        "..upvals) or "");
  56                         end
  57                         event_handler_arrays[event] = handler_strings;
  58                 end
  59         end
  60         table.sort(events_array);
  61         local i = 1;
  62         while i <= #events_array do
  63                 local handlers = event_handler_arrays[events_array[i]];
  64                 for j=#handlers, 1, -1 do
  65                         table.insert(events_array, i+1, handlers[j]);
  66                 end
  67                 if i > 1 then events_array[i] = "\n"..events_array[i]; end
  68                 i = i + #handlers + 1
  69         end
  70         return table.concat(events_array, "\n");
  71 end
  72
  73 function get_upvalue(f, get_name)
  74         local i, name, value = 0;
  75         repeat
  76                 i = i + 1;
  77                 name, value = debug.getupvalue(f, i);
  78         until name == get_name or name == nil;
  79         return value;
  80 end
  81
  82 return _M;