2006-09-25 01:09:00 +00:00
-- init.lua
--
2007-01-26 01:34:29 +00:00
-- initialize wireshark's lua
2006-09-25 01:09:00 +00:00
--
-- This file is going to be executed before any other lua script.
-- It can be used to load libraries, disable functions and more.
--
-- Wireshark - Network traffic analyzer
-- By Gerald Combs <gerald@wireshark.org>
-- Copyright 1998 Gerald Combs
--
-- 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
2012-06-28 22:56:06 +00:00
-- Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
2006-09-25 01:09:00 +00:00
2010-06-17 16:38:05 +00:00
-- Set disable_lua to true to disable Lua support.
disable_lua = false
2006-09-25 01:09:00 +00:00
2010-06-17 16:38:05 +00:00
if disable_lua then
2010-06-18 15:25:41 +00:00
return
2010-06-17 16:38:05 +00:00
end
2006-09-25 01:09:00 +00:00
-- If set and we are running with special privileges this setting
-- tells whether scripts other than this one are to be run.
run_user_scripts_when_superuser = false
2006-10-04 14:37:46 +00:00
2006-09-25 01:09:00 +00:00
-- disable potentialy harmful lua functions when running superuser
if running_superuser then
2012-06-22 15:18:03 +00:00
local hint = " has been disabled due to running Wireshark as superuser. See http://wiki.wireshark.org/CaptureSetup/CapturePrivileges for help in running Wireshark as an unprivileged user. "
2008-04-25 19:04:52 +00:00
local disabled_lib = { }
2012-06-22 15:18:03 +00:00
setmetatable ( disabled_lib , { __index = function ( ) error ( " this package " .. hint ) end } ) ;
2006-10-04 14:37:46 +00:00
2012-06-22 15:18:03 +00:00
dofile = function ( ) error ( " dofile " .. hint ) end
loadfile = function ( ) error ( " loadfile " .. hint ) end
loadlib = function ( ) error ( " loadlib " .. hint ) end
require = function ( ) error ( " require " .. hint ) end
2006-10-04 14:37:46 +00:00
os = disabled_lib
io = disabled_lib
file = disabled_lib
2006-09-25 01:09:00 +00:00
end
2006-10-24 13:16:57 +00:00
-- to avoid output to stdout which can cause problems lua's print ()
2006-09-25 01:09:00 +00:00
-- has been suppresed so that it yields an error.
-- have print() call info() instead.
2007-01-21 17:06:16 +00:00
if gui_enabled ( ) then
2008-04-25 19:04:52 +00:00
print = info
2007-01-21 17:06:16 +00:00
end
2006-09-25 01:09:00 +00:00
2013-02-25 22:05:28 +00:00
function typeof ( obj )
local mt = getmetatable ( obj )
2014-02-03 03:49:30 +00:00
return mt and mt.__typeof or obj.__typeof or type ( obj )
2013-02-25 22:05:28 +00:00
end
2014-03-26 23:12:04 +00:00
-- the following function checks if a file exists
-- since 1.11.3
2014-01-29 15:05:48 +00:00
function file_exists ( name )
local f = io.open ( name , " r " )
if f ~= nil then io.close ( f ) return true else return false end
end
2014-03-26 23:12:04 +00:00
-- the following function prepends the given directory name to
-- the package.path, so that a 'require "foo"' will work if 'foo'
-- is in the directory name given to this function. For example,
-- if your Lua file will do a 'require "foo"' and the foo.lua
-- file is in a local directory (local to your script) named 'bar',
-- then call this function before doing your 'require', by doing
-- package.prepend_path("bar")
-- and that will let Wireshark's Lua find the file "bar/foo.lua"
-- when you later do 'require "foo"'
--
-- Because this function resides here in init.lua, it does not
-- have the same environment as your script, so it has to get it
-- using the debug library, which is why the code appears so
-- cumbersome.
--
-- since 1.11.3
function package . prepend_path ( name )
local debug = require " debug "
-- get the function calling this package.prepend_path function
local dt = debug.getinfo ( 2 , " f " )
if not dt then
error ( " could not retrieve debug info table " )
end
-- get its upvalue
local _ , val = debug.getupvalue ( dt.func , 1 )
if not val or type ( val ) ~= ' table ' then
error ( " No calling function upvalue or it is not a table " )
end
-- get the __DIR__ field in its upvalue table
local dir = val [ " __DIR__ " ]
-- get the platform-specific directory separator character
local sep = package.config : sub ( 1 , 1 )
-- prepend the dir and given name to path
if dir and dir : len ( ) > 0 then
package.path = dir .. sep .. name .. sep .. " ?.lua; " .. package.path
end
-- also prepend just the name as a directory
package.path = name .. sep .. " ?.lua; " .. package.path
end
2006-09-27 17:12:42 +00:00
-- %WTAP_ENCAPS%
2013-05-29 06:50:28 +00:00
-- %WTAP_FILETYPES%
2014-09-29 02:32:33 +00:00
-- %WTAP_TSPRECS%
2014-03-18 17:21:51 +00:00
-- %WTAP_COMMENTTYPES%
2006-09-27 17:12:42 +00:00
-- %FT_TYPES%
2014-05-24 18:28:30 +00:00
-- the following table is since 1.12
-- %WTAP_REC_TYPES%
2014-03-25 22:11:05 +00:00
-- the following table is since 1.11.3
2014-03-18 17:21:51 +00:00
-- %WTAP_PRESENCE_FLAGS%
2006-09-27 17:12:42 +00:00
-- %BASES%
2006-09-27 02:51:08 +00:00
2012-05-14 00:49:05 +00:00
-- %ENCODINGS%
2006-09-27 17:12:42 +00:00
-- %EXPERT%
2014-03-25 22:11:05 +00:00
-- the following table is since 1.11.3
-- %EXPERT_TABLE%
2006-09-27 17:12:42 +00:00
-- %MENU_GROUPS%
2006-10-17 18:20:44 +00:00
-- other useful constants
GUI_ENABLED = gui_enabled ( )
2014-03-26 06:24:51 +00:00
DATA_DIR = Dir.global_config_path ( )
USER_DIR = Dir.personal_config_path ( )
-- deprecated function names
datafile_path = Dir.global_config_path
persconffile_path = Dir.personal_config_path
2006-09-25 01:09:00 +00:00
2011-08-08 19:10:19 +00:00
dofile ( DATA_DIR .. " console.lua " )
--dofile(DATA_DIR.."dtd_gen.lua")