util/dependencies.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 module("dependencies", package.seeall)
  10
  11 function softreq(...) local ok, lib =  pcall(require, ...); if ok then return lib; else return nil, lib; end end
  12
  13 -- Required to be able to find packages installed with luarocks
  14 if not softreq "luarocks.loader" then -- LuaRocks 2.x
  15         softreq "luarocks.require"; -- LuaRocks <1.x
  16 end
  17
  18 function missingdep(name, sources, msg)
  19         print("");
  20         print("**************************");
  21         print("Prosody was unable to find "..tostring(name));
  22         print("This package can be obtained in the following ways:");
  23         print("");
  24         local longest_platform = 0;
  25         for platform in pairs(sources) do
  26                 longest_platform = math.max(longest_platform, #platform);
  27         end
  28         for platform, source in pairs(sources) do
  29                 print("", platform..":"..(" "):rep(4+longest_platform-#platform)..source);
  30         end
  31         print("");
  32         print(msg or (name.." is required for Prosody to run, so we will now exit."));
  33         print("More help can be found on our website, at http://prosody.im/doc/depends");
  34         print("**************************");
  35         print("");
  36 end
  37
  38 -- COMPAT w/pre-0.8 Debian: The Debian config file used to use
  39 -- util.ztact, which has been removed from Prosody in 0.8. This
  40 -- is to log an error for people who still use it, so they can
  41 -- update their configs.
  42 package.preload["util.ztact"] = function ()
  43         if not package.loaded["core.loggingmanager"] then
  44                 error("util.ztact has been removed from Prosody and you need to fix your config "
  45                     .."file. More information can be found at http://prosody.im/doc/packagers#ztact", 0);
  46         else
  47                 error("module 'util.ztact' has been deprecated in Prosody 0.8.");
  48         end
  49 end;
  50
  51 function check_dependencies()
  52         local fatal;
  53
  54         local lxp = softreq "lxp"
  55
  56         if not lxp then
  57                 missingdep("luaexpat", {
  58                                 ["Debian/Ubuntu"] = "sudo apt-get install liblua5.1-expat0";
  59                                 ["luarocks"] = "luarocks install luaexpat";
  60                                 ["Source"] = "http://www.keplerproject.org/luaexpat/";
  61                         });
  62                 fatal = true;
  63         end
  64
  65         local socket = softreq "socket"
  66
  67         if not socket then
  68                 missingdep("luasocket", {
  69                                 ["Debian/Ubuntu"] = "sudo apt-get install liblua5.1-socket2";
  70                                 ["luarocks"] = "luarocks install luasocket";
  71                                 ["Source"] = "http://www.tecgraf.puc-rio.br/~diego/professional/luasocket/";
  72                         });
  73                 fatal = true;
  74         end
  75
  76         local lfs, err = softreq "lfs"
  77         if not lfs then
  78                 missingdep("luafilesystem", {
  79                                 ["luarocks"] = "luarocks install luafilesystem";
  80                                 ["Debian/Ubuntu"] = "sudo apt-get install liblua5.1-filesystem0";
  81                                 ["Source"] = "http://www.keplerproject.org/luafilesystem/";
  82                         });
  83                 fatal = true;
  84         end
  85
  86         local ssl = softreq "ssl"
  87
  88         if not ssl then
  89                 missingdep("LuaSec", {
  90                                 ["Debian/Ubuntu"] = "http://prosody.im/download/start#debian_and_ubuntu";
  91                                 ["luarocks"] = "luarocks install luasec";
  92                                 ["Source"] = "http://www.inf.puc-rio.br/~brunoos/luasec/";
  93                         }, "SSL/TLS support will not be available");
  94         end
  95
  96         local encodings, err = softreq "util.encodings"
  97         if not encodings then
  98                 if err:match("not found") then
  99                         missingdep("util.encodings", { ["Windows"] = "Make sure you have encodings.dll from the Prosody distribution in util/";
 100                                                 ["GNU/Linux"] = "Run './configure' and 'make' in the Prosody source directory to build util/encodings.so";
 101                                         });
 102                 else
 103                         print "***********************************"
 104                         print("util/encodings couldn't be loaded. Check that you have a recent version of libidn");
 105                         print ""
 106                         print("The full error was:");
 107                         print(err)
 108                         print "***********************************"
 109                 end
 110                 fatal = true;
 111         end
 112
 113         local hashes, err = softreq "util.hashes"
 114         if not hashes then
 115                 if err:match("not found") then
 116                         missingdep("util.hashes", { ["Windows"] = "Make sure you have hashes.dll from the Prosody distribution in util/";
 117                                                 ["GNU/Linux"] = "Run './configure' and 'make' in the Prosody source directory to build util/hashes.so";
 118                                         });
 119                 else
 120                         print "***********************************"
 121                         print("util/hashes couldn't be loaded. Check that you have a recent version of OpenSSL (libcrypto in particular)");
 122                         print ""
 123                         print("The full error was:");
 124                         print(err)
 125                         print "***********************************"
 126                 end
 127                 fatal = true;
 128         end
 129         return not fatal;
 130 end
 131
 132 function log_warnings()
 133         if ssl then
 134                 local major, minor, veryminor, patched = ssl._VERSION:match("(%d+)%.(%d+)%.?(%d*)(M?)");
 135                 if not major or ((tonumber(major) == 0 and (tonumber(minor) or 0) <= 3 and (tonumber(veryminor) or 0) <= 2) and patched ~= "M") then
 136                         log("error", "This version of LuaSec contains a known bug that causes disconnects, see http://prosody.im/doc/depends");
 137                 end
 138         end
 139 end
 140
 141 return _M;