text:
<?xml version="1.0"?>
<!DOCTYPE modulesynopsis SYSTEM "../style/modulesynopsis.dtd">
<?xml-stylesheet type="text/xsl" href="../style/manual.en.xsl"?>

<modulesynopsis metafile="mod_lua.xml.meta">

<name>mod_lua</name>

<description>Provides Lua hooks into various portions of the httpd
request processing</description>
<status>Experimental</status>
<sourcefile>mod_lua.c</sourcefile>
<identifier>lua_module</identifier>
<compatibility>2.3 and later</compatibility>

This module allows the server to be extended with scripts written in the
Lua programming language.  The extension points (hooks) available with
<module>mod_lua</module> include many of the hooks available to
natively compiled Apache HTTP Server modules, such as mapping requests to
files, generating dynamic responses, access control, authentication, and
authorization

More information on the Lua programming language can be found at the
the Lua website.

<note>mod_lua is still in experimental state.
Until it is declared stable, usage and behavior may change
at any time, even between stable releases of the 2.4.x series.
Be sure to check the CHANGES file before upgrading.</note>

<note type="warning"><title>Warning</title>

This module holds a great deal of power over httpd, which is both a
strength and a potential security risk. It is not recommended
that you use this module on a server that is shared with users you do not
trust, as it can be abused to change the internal workings of httpd.

</note>

<title>Basic Configuration</title>

The basic module loading directive is

<highlight language="config">
    LoadModule lua_module modules/mod_lua.so
</highlight>

mod_lua provides a handler named lua-script,
which can be used with a <directive
module="core">SetHandler</directive> or
<directive module="mod_mime">AddHandler</directive> directive:

<highlight language="config">
<Files "*.lua">
    SetHandler lua-script
</Files>
</highlight>

This will cause mod_lua to handle requests for files
ending in .lua by invoking that file's
handle function.

For more flexibility, see <directive>LuaMapHandler</directive>.

<title>Writing Handlers</title>

 In the Apache HTTP Server API, the handler is a specific kind of hook
responsible for generating the response.  Examples of modules that include a
handler are <module>mod_proxy</module>, <module>mod_cgi</module>,
and <module>mod_status</module>.

mod_lua always looks to invoke a Lua function for the handler, rather than
just evaluating a script body CGI style. A handler function looks
something like this:

<highlight language="lua">
example.lua

-- example handler

require "string"

--[[
     This is the default method name for Lua handlers, see the optional
     function-name in the LuaMapHandler directive to choose a different
     entry point.
--]]
function handle(r)
    r.content_type = "text/plain"

    if r.method == 'GET' then
        r:puts("Hello Lua World!\n")
        for k, v in pairs( r:parseargs() ) do
            r:puts( string.format("%s: %s\n", k, v) )
        end
    elseif r.method == 'POST' then
        r:puts("Hello Lua World!\n")
        for k, v in pairs( r:parsebody() ) do
            r:puts( string.format("%s: %s\n", k, v) )
        end
    elseif r.method == 'PUT' then
-- use our own Error contents
        r:puts("Unsupported HTTP method " .. r.method)
        r.status = 405
        return apache2.OK
    else
-- use the ErrorDocument
        return 501
    end
    return apache2.OK
end
</highlight>

This handler function just prints out the uri or form encoded
arguments to a plaintext page.

This means (and in fact encourages) that you can have multiple
handlers (or hooks, or filters) in the same script.

<title>Writing Authorization Providers</title>

<module>mod_authz_core</module> provides a high-level interface to
authorization that is much easier to use than using into the relevant
hooks directly. The first argument to the
<directive module="mod_authz_core">Require</directive> directive gives
the name of the responsible authorization provider. For any
<directive module="mod_authz_core">Require</directive> line,
<module>mod_authz_core</module> will call the authorization provider
of the given name, passing the rest of the line as parameters. The
provider will then check authorization and pass the result as return
value.

The authz provider is normally called before authentication. If it needs to
know the authenticated user name (or if the user will be authenticated at
all), the provider must return apache2.AUTHZ_DENIED_NO_USER.
This will cause authentication to proceed and the authz provider to be
called a second time.

The following authz provider function takes two arguments, one ip
address and one user name. It will allow access from the given ip address
without authentication, or if the authenticated user matches the second
argument:

<highlight language="lua">
authz_provider.lua

require 'apache2'

function authz_check_foo(r, ip, user)
    if r.useragent_ip == ip then
        return apache2.AUTHZ_GRANTED
    elseif r.user == nil then
        return apache2.AUTHZ_DENIED_NO_USER
    elseif r.user == user then
        return apache2.AUTHZ_GRANTED
    else
        return apache2.AUTHZ_DENIED
    end
end
</highlight>

The following configuration registers this function as provider
foo and configures it for URL /:

<highlight language="config">
LuaAuthzProvider foo authz_provider.lua authz_check_foo
<Location "/">
  Require foo 10.1.2.3 john_doe
</Location>
</highlight>

<title>Writing Hooks</title>

Hook functions are how modules (and Lua scripts) participate in the
processing of requests. Each type of hook exposed by the server exists for
a specific purpose, such as mapping requests to the file system,
performing access control, or setting mime types:

        Hook phase
        mod_lua directive
        Description

        Quick handler
        <directive module="mod_lua">LuaQuickHandler</directive>
        This is the first hook that will be called after a request has
            been mapped to a host or virtual host

        Translate name
        <directive module="mod_lua">LuaHookTranslateName</directive>
        This phase translates the requested URI into a filename on the
            system. Modules such as <module>mod_alias</module> and
            <module>mod_rewrite</module> operate in this phase.

        Map to storage
        <directive module="mod_lua">LuaHookMapToStorage</directive>
        This phase maps files to their physical, cached or external/proxied storage.
            It can be used by proxy or caching modules

        Check Access
        <directive module="mod_lua">LuaHookAccessChecker</directive>
        This phase checks whether a client has access to a resource. This
            phase is run before the user is authenticated, so beware.

        Check User ID
        <directive module="mod_lua">LuaHookCheckUserID</directive>
        This phase it used to check the negotiated user ID

        Check Authorization
        <directive module="mod_lua">LuaHookAuthChecker</directive> or
            <directive module="mod_lua">LuaAuthzProvider</directive>
        This phase authorizes a user based on the negotiated credentials, such as
            user ID, client certificate etc.

        Check Type
        <directive module="mod_lua">LuaHookTypeChecker</directive>
        This phase checks the requested file and assigns a content type and
            a handler to it

        Fixups
        <directive module="mod_lua">LuaHookFixups</directive>
        This is the final "fix anything" phase before the content handlers
            are run. Any last-minute changes to the request should be made here.

        Content handler
        fx. .lua files or through <directive module="mod_lua">LuaMapHandler</directive>
        This is where the content is handled. Files are read, parsed, some are run,
            and the result is sent to the client

        Logging
        <directive module="mod_lua">LuaHookLog</directive>
        Once a request has been handled, it enters several logging phases,
            which logs the request in either the error or access log. Mod_lua
            is able to hook into the start of this and control logging output.

Hook functions are passed the request object as their only argument
(except for LuaAuthzProvider, which also gets passed the arguments from
the Require directive).
They can return any value, depending on the hook, but most commonly
they'll return OK, DONE, or DECLINED, which you can write in Lua as
apache2.OK, apache2.DONE, or
apache2.DECLINED, or else an HTTP status code.

<highlight language="lua">
translate_name.lua

-- example hook that rewrites the URI to a filesystem path.

require 'apache2'

function translate_name(r)
    if r.uri == "/translate-name" then
        r.filename = r.document_root .. "/find_me.txt"
        return apache2.OK
    end
    -- we don't care about this URL, give another module a chance
    return apache2.DECLINED
end
</highlight>

<highlight language="lua">
translate_name2.lua

--[[ example hook that rewrites one URI to another URI. It returns a
     apache2.DECLINED to give other URL mappers a chance to work on the
     substitution, including the core translate_name hook which maps based
     on the DocumentRoot.

     Note: Use the early/late flags in the directive to make it run before
           or after mod_alias.
--]]

require 'apache2'

function translate_name(r)
    if r.uri == "/translate-name" then
        r.uri = "/find_me.txt"
        return apache2.DECLINED
    end
    return apache2.DECLINED
end
</highlight>

<title>Data Structures</title>

request_rec

The request_rec is mapped in as a userdata. It has a metatable
        which lets you do useful things with it. For the most part it
        has the same fields as the request_rec struct, many of which are writable as
        well as readable.  (The table fields' content can be changed, but the
        fields themselves cannot be set to different tables.)

          Name
          Lua type
          Writable
          Description

          allowoverrides
          string
          no
          The AllowOverride options applied to the current request.

          ap_auth_type
          string
          no
          If an authentication check was made, this is set to the type
          of authentication (f.x. basic)

          args
          string
          yes
          The query string arguments extracted from the request
            (f.x. foo=bar&name=johnsmith)

          assbackwards
          boolean
          no
          Set to true if this is an HTTP/0.9 style request
            (e.g. GET /foo (with no headers) )

          auth_name
          string
          no
          The realm name used for authorization (if applicable).

          banner
          string
          no
          The server banner, f.x. Apache HTTP Server/2.4.3 openssl/0.9.8c

          basic_auth_pw
          string
          no
          The basic auth password sent with this request, if any

          canonical_filename
          string
          no
          The canonical filename of the request

          content_encoding
          string
          no
          The content encoding of the current request

          content_type
          string
          yes
          The content type of the current request, as determined in the
            type_check phase (f.x. image/gif or text/html)

          context_prefix
          string
          no

          context_document_root
          string
          no

          document_root
          string
          no
          The document root of the host

          err_headers_out
          table
          no
          MIME header environment for the response, printed even on errors and
            persist across internal redirects

          filename
          string
          yes
          The file name that the request maps to, f.x. /www/example.com/foo.txt. This can be
            changed in the translate-name or map-to-storage phases of a request to allow the
            default handler (or script handlers) to serve a different file than what was requested.

          handler
          string
          yes
          The name of the handler that should serve this request, f.x.
            lua-script if it is to be served by mod_lua. This is typically set by the
            <directive module="mod_mime">AddHandler</directive> or <directive module="core">SetHandler</directive>
            directives, but could also be set via mod_lua to allow another handler to serve up a specific request
            that would otherwise not be served by it.

          headers_in
          table
          yes
          MIME header environment from the request. This contains headers such as Host,
            User-Agent, Referer and so on.

          headers_out
          table
          yes
          MIME header environment for the response.

          hostname
          string
          no
          The host name, as set by the Host: header or by a full URI.

          is_https
          boolean
          no
          Whether or not this request is done via HTTPS

          is_initial_req
          boolean
          no
          Whether this request is the initial request or a sub-request

          limit_req_body
          number
          no
          The size limit of the request body for this request, or 0 if no limit.

          log_id
          string
          no
          The ID to identify request in access and error log.

          method
          string
          no
          The request method, f.x. GET or POST.

          notes
          table
          yes
          A list of notes that can be passed on from one module to another.

          options
          string
          no
          The Options directive applied to the current request.

          path_info
          string
          no
          The PATH_INFO extracted from this request.

          port
          number
          no
          The server port used by the request.

          protocol
          string
          no
          The protocol used, f.x. HTTP/1.1

          proxyreq
          string
          yes
          Denotes whether this is a proxy request or not. This value is generally set in
            the post_read_request/translate_name phase of a request.

          range
          string
          no
          The contents of the Range: header.

          remaining
          number
          no
          The number of bytes remaining to be read from the request body.

          server_built
          string
          no
          The time the server executable was built.

          server_name
          string
          no
          The server name for this request.

          some_auth_required
          boolean
          no
          Whether some authorization is/was required for this request.

          subprocess_env
          table
          yes
          The environment variables set for this request.

          started
          number
          no
          The time the server was (re)started, in seconds since the epoch (Jan 1st, 1970)

          status
          number
          yes
          The (current) HTTP return code for this request, f.x. 200 or 404.

          the_request
          string
          no
          The request string as sent by the client, f.x. GET /foo/bar HTTP/1.1.

          unparsed_uri
          string
          no
          The unparsed URI of the request

          uri
          string
          yes
          The URI after it has been parsed by httpd

          user
          string
          yes
          If an authentication check has been made, this is set to the name of the authenticated user.

          useragent_ip
          string
          no
          The IP of the user agent making the request

<title>Built in functions</title>

The request_rec object has (at least) the following methods:

<highlight language="lua">
r:flush()   -- flushes the output buffer.
            -- Returns true if the flush was successful, false otherwise.

while we_have_stuff_to_send do
    r:puts("Bla bla bla\n") -- print something to client
    r:flush() -- flush the buffer (send to client)
    r.usleep(500000) -- fake processing time for 0.5 sec. and repeat
end
</highlight>

<highlight language="lua">
r:addoutputfilter(name|function) -- add an output filter:

r:addoutputfilter("fooFilter") -- add the fooFilter to the output stream
</highlight>

<highlight language="lua">
r:sendfile(filename) -- sends an entire file to the client, using sendfile if supported by the current platform:

if use_sendfile_thing then
    r:sendfile("/var/www/large_file.img")
end
</highlight>

<highlight language="lua">
r:parseargs() -- returns two tables; one standard key/value table for regular GET data,
              -- and one for multi-value data (fx. foo=1&foo=2&foo=3):

local GET, GETMULTI = r:parseargs()
r:puts("Your name is: " .. GET['name'] or "Unknown")
</highlight>

<highlight language="lua">
r:parsebody([sizeLimit]) -- parse the request body as a POST and return two lua tables,
                         -- just like r:parseargs().
                         -- An optional number may be passed to specify the maximum number
                         -- of bytes to parse. Default is 8192 bytes:

local POST, POSTMULTI = r:parsebody(1024*1024)
r:puts("Your name is: " .. POST['name'] or "Unknown")
</highlight>

<highlight language="lua">
r:puts("hello", " world", "!") -- print to response body, self explanatory
</highlight>

<highlight language="lua">
r:write("a single string") -- print to response body, self explanatory
</highlight>

<highlight language="lua">
r:escape_html("<html>test</html>") -- Escapes HTML code and returns the escaped result
</highlight>

<highlight language="lua">
r:base64_encode(string) -- Encodes a string using the Base64 encoding standard:

local encoded = r:base64_encode("This is a test") -- returns VGhpcyBpcyBhIHRlc3Q=
</highlight>

<highlight language="lua">
r:base64_decode(string) -- Decodes a Base64-encoded string:

local decoded = r:base64_decode("VGhpcyBpcyBhIHRlc3Q=") -- returns 'This is a test'
</highlight>

<highlight language="lua">
r:md5(string) -- Calculates and returns the MD5 digest of a string (binary safe):

local hash = r:md5("This is a test") -- returns ce114e4501d2f4e2dcea3e17b546f339
</highlight>

<highlight language="lua">
r:sha1(string) -- Calculates and returns the SHA1 digest of a string (binary safe):

local hash = r:sha1("This is a test") -- returns a54d88e06612d820bc3be72877c74f257b561b19
</highlight>

<highlight language="lua">
r:escape(string) -- URL-Escapes a string:

local url = "http://foo.bar/1 2 3 & 4 + 5"
local escaped = r:escape(url) -- returns 'http%3a%2f%2ffoo.bar%2f1+2+3+%26+4+%2b+5'
</highlight>

<highlight language="lua">
r:unescape(string) -- Unescapes an URL-escaped string:

local url = "http%3a%2f%2ffoo.bar%2f1+2+3+%26+4+%2b+5"
local unescaped = r:unescape(url) -- returns 'http://foo.bar/1 2 3 & 4 + 5'
</highlight>

<highlight language="lua">
r:construct_url(string) -- Constructs an URL from an URI

local url = r:construct_url(r.uri)
</highlight>

<highlight language="lua">
r.mpm_query(number) -- Queries the server for MPM information using ap_mpm_query:

local mpm = r.mpm_query(14)
if mpm == 1 then
    r:puts("This server uses the Event MPM")
end
</highlight>

<highlight language="lua">
r:expr(string) -- Evaluates an expr string.

if r:expr("%{HTTP_HOST} =~ /^www/") then
    r:puts("This host name starts with www")
end
</highlight>

<highlight language="lua">
r:scoreboard_process(a) -- Queries the server for information about the process at position a:

local process = r:scoreboard_process(1)
r:puts("Server 1 has PID " .. process.pid)
</highlight>

<highlight language="lua">
r:scoreboard_worker(a, b) -- Queries for information about the worker thread, b, in process a:

local thread = r:scoreboard_worker(1, 1)
r:puts("Server 1's thread 1 has thread ID " .. thread.tid .. " and is in " .. thread.status .. " status")
</highlight>

<highlight language="lua">
r:clock() -- Returns the current time with microsecond precision
</highlight>

<highlight language="lua">
r:requestbody(filename) -- Reads and returns the request body of a request.
                -- If 'filename' is specified, it instead saves the
                -- contents to that file:

local input = r:requestbody()
r:puts("You sent the following request body to me:\n")
r:puts(input)
</highlight>

<highlight language="lua">
r:add_input_filter(filter_name) -- Adds 'filter_name' as an input filter
</highlight>

<highlight language="lua">
r.module_info(module_name) -- Queries the server for information about a module

local mod = r.module_info("mod_lua.c")
if mod then
    for k, v in pairs(mod.commands) do
       r:puts( ("%s: %s\n"):format(k,v)) -- print out all directives accepted by this module
    end
end
</highlight>

<highlight language="lua">
r:loaded_modules() -- Returns a list of modules loaded by httpd:

for k, module in pairs(r:loaded_modules()) do
    r:puts("I have loaded module " .. module .. "\n")
end
</highlight>

<highlight language="lua">
r:runtime_dir_relative(filename) -- Compute the name of a run-time file (e.g., shared memory "file")
                         -- relative to the appropriate run-time directory.
</highlight>

<highlight language="lua">
r:server_info() -- Returns a table containing server information, such as
                -- the name of the httpd executable file, mpm used etc.
</highlight>

<highlight language="lua">
r:set_document_root(file_path) -- Sets the document root for the request to file_path
</highlight>

<highlight language="lua">
r:set_context_info(prefix, docroot) -- Sets the context prefix and context document root for a request
</highlight>

<highlight language="lua">
r:os_escape_path(file_path) -- Converts an OS path to a URL in an OS dependent way
</highlight>

<highlight language="lua">
r:escape_logitem(string) -- Escapes a string for logging
</highlight>

<highlight language="lua">
r.strcmp_match(string, pattern) -- Checks if 'string' matches 'pattern' using strcmp_match (globs).
                        -- fx. whether 'www.example.com' matches '*.example.com':

local match = r.strcmp_match("foobar.com", "foo*.com")
if match then
    r:puts("foobar.com matches foo*.com")
end
</highlight>

<highlight language="lua">
r:set_keepalive() -- Sets the keepalive status for a request. Returns true if possible, false otherwise.
</highlight>

<highlight language="lua">
r:make_etag() -- Constructs and returns the etag for the current request.
</highlight>

<highlight language="lua">
r:send_interim_response(clear) -- Sends an interim (1xx) response to the client.
                       -- if 'clear' is true, available headers will be sent and cleared.
</highlight>

<highlight language="lua">
r:custom_response(status_code, string) -- Construct and set a custom response for a given status code.
                               -- This works much like the ErrorDocument directive:

r:custom_response(404, "Baleted!")
</highlight>

<highlight language="lua">
r.exists_config_define(string) -- Checks whether a configuration definition exists or not:

if r.exists_config_define("FOO") then
    r:puts("httpd was probably run with -DFOO, or it was defined in the configuration")
end
</highlight>

<highlight language="lua">
r:state_query(string) -- Queries the server for state information
</highlight>

<highlight language="lua">
r:stat(filename [,wanted]) -- Runs stat() on a file, and returns a table with file information:

local info = r:stat("/var/www/foo.txt")
if info then
    r:puts("This file exists and was last modified at: " .. info.modified)
end
</highlight>

<highlight language="lua">
r:regex(string, pattern [,flags]) -- Runs a regular expression match on a string, returning captures if matched:

local matches = r:regex("foo bar baz", [[foo (\w+) (\S*)]])
if matches then
    r:puts("The regex matched, and the last word captured ($2) was: " .. matches[2])
end

-- Example ignoring case sensitivity:
local matches = r:regex("FOO bar BAz", [[(foo) bar]], 1)

-- Flags can be a bitwise combination of:
-- 0x01: Ignore case
-- 0x02: Multiline search
</highlight>

<highlight language="lua">
r.usleep(number_of_microseconds) -- Puts the script to sleep for a given number of microseconds.
</highlight>

<highlight language="lua">
r:dbacquire(dbType[, dbParams]) -- Acquires a connection to a database and returns a database class.
                        -- See 'Database connectivity' for details.
</highlight>

<highlight language="lua">
r:ivm_set("key", value) -- Set an Inter-VM variable to hold a specific value.
                        -- These values persist even though the VM is gone or not being used,
                        -- and so should only be used if MaxConnectionsPerChild is > 0
                        -- Values can be numbers, strings and booleans, and are stored on a
                        -- per process basis (so they won't do much good with a prefork mpm)

r:ivm_get("key")        -- Fetches a variable set by ivm_set. Returns the contents of the variable
                        -- if it exists or nil if no such variable exists.

-- An example getter/setter that saves a global variable outside the VM:
function handle(r)
    -- First VM to call this will get no value, and will have to create it
    local foo = r:ivm_get("cached_data")
    if not foo then
        foo = do_some_calcs() -- fake some return value
        r:ivm_set("cached_data", foo) -- set it globally
    end
    r:puts("Cached data is: ", foo)
end
</highlight>

<highlight language="lua">
r:htpassword(string [,algorithm [,cost]]) -- Creates a password hash from a string.
                                          -- algorithm: 0 = APMD5 (default), 1 = SHA, 2 = BCRYPT, 3 = CRYPT.
                                          -- cost: only valid with BCRYPT algorithm (default = 5).
</highlight>

<highlight language="lua">
r:mkdir(dir [,mode]) -- Creates a directory and sets mode to optional mode parameter.
</highlight>

<highlight language="lua">
r:mkrdir(dir [,mode]) -- Creates directories recursive and sets mode to optional mode parameter.
</highlight>

<highlight language="lua">
r:rmdir(dir) -- Removes a directory.
</highlight>

<highlight language="lua">
r:touch(file [,mtime]) -- Sets the file modification time to current time or to optional mtime msec value.
</highlight>

<highlight language="lua">
r:get_direntries(dir) -- Returns a table with all directory entries.

function handle(r)
  local dir = r.context_document_root
  for _, f in ipairs(r:get_direntries(dir)) do
    local info = r:stat(dir .. "/" .. f)
    if info then
      local mtime = os.date(fmt, info.mtime / 1000000)
      local ftype = (info.filetype == 2) and "[dir] " or "[file]"
      r:puts( ("%s %s %10i %s\n"):format(ftype, mtime, info.size, f) )
    end
  end
end
</highlight>

<highlight language="lua">
r.date_parse_rfc(string) -- Parses a date/time string and returns seconds since epoche.
</highlight>

<highlight language="lua">
r:getcookie(key) -- Gets a HTTP cookie
</highlight>

<highlight language="lua">
r:setcookie{
  key = [key],
  value = [value],
  expires = [expiry],
  secure = [boolean],
  httponly = [boolean],
  path = [path],
  domain = [domain]
} -- Sets a HTTP cookie, for instance:

r:setcookie{
  key = "cookie1",
  value = "HDHfa9eyffh396rt",
  expires = os.time() + 86400,
  secure = true
}
</highlight>

<highlight language="lua">
r:wsupgrade() -- Upgrades a connection to WebSockets if possible (and requested):
if r:wsupgrade() then -- if we can upgrade:
    r:wswrite("Welcome to websockets!") -- write something to the client
    r:wsclose()  -- goodbye!
end
</highlight>

<highlight language="lua">
r:wsread() -- Reads a WebSocket frame from a WebSocket upgraded connection (see above):

local line, isFinal = r:wsread() -- isFinal denotes whether this is the final frame.
                                 -- If it isn't, then more frames can be read
r:wswrite("You wrote: " .. line)
</highlight>

<highlight language="lua">
r:wswrite(line) -- Writes a frame to a WebSocket client:
r:wswrite("Hello, world!")
</highlight>

<highlight language="lua">
r:wsclose() -- Closes a WebSocket request and terminates it for httpd:

if r:wsupgrade() then
    r:wswrite("Write something: ")
    local line = r:wsread() or "nothing"
    r:wswrite("You wrote: " .. line);
    r:wswrite("Goodbye!")
    r:wsclose()
end
</highlight>

<highlight language="lua">
r:wspeek() -- Checks if any data is ready to be read

-- Sleep while nothing is being sent to us...
while r:wspeek() == false do
   r.usleep(50000)
end
-- We have data ready!
local line = r:wsread()

</highlight>

<highlight language="lua">
r:config() -- Get a walkable tree of the entire httpd configuration
</highlight>

<highlight language="lua">
r:activeconfig() -- Get a walkable tree of the active (virtualhost-specific) httpd configuration
</highlight>

<title>Logging Functions</title>

<highlight language="lua">
-- examples of logging messages
r:trace1("This is a trace log message") -- trace1 through trace8 can be used
r:debug("This is a debug log message")
r:info("This is an info log message")
r:notice("This is a notice log message")
r:warn("This is a warn log message")
r:err("This is an err log message")
r:alert("This is an alert log message")
r:crit("This is a crit log message")
r:emerg("This is an emerg log message")
</highlight>

<title>apache2 Package</title>

A package named apache2 is available with (at least) the following contents.

apache2.OK

internal constant OK.  Handlers should return this if they've
  handled the request.

apache2.DECLINED

internal constant DECLINED.  Handlers should return this if
  they are not going to handle the request.

apache2.DONE

internal constant DONE.

apache2.version

Apache HTTP server version string

apache2.HTTP_MOVED_TEMPORARILY

HTTP status code

apache2.PROXYREQ_NONE, apache2.PROXYREQ_PROXY, apache2.PROXYREQ_REVERSE, apache2.PROXYREQ_RESPONSE

internal constants used by <module>mod_proxy</module>

apache2.AUTHZ_DENIED, apache2.AUTHZ_GRANTED, apache2.AUTHZ_NEUTRAL, apache2.AUTHZ_GENERAL_ERROR, apache2.AUTHZ_DENIED_NO_USER

internal constants used by <module>mod_authz_core</module>

(Other HTTP status codes are not yet implemented.)

    <title>Modifying contents with Lua filters</title>

    Filter functions implemented via <directive module="mod_lua">LuaInputFilter</directive>
    or <directive module="mod_lua">LuaOutputFilter</directive> are designed as
    three-stage non-blocking functions using coroutines to suspend and resume a
    function as buckets are sent down the filter chain. The core structure of
    such a function is:

    <highlight language="lua">
function filter(r)
    -- Our first yield is to signal that we are ready to receive buckets.
    -- Before this yield, we can set up our environment, check for conditions,
    -- and, if we deem it necessary, decline filtering a request alltogether:
    if something_bad then
        return -- This would skip this filter.
    end
    -- Regardless of whether we have data to prepend, a yield MUST be called here.
    -- Note that only output filters can prepend data. Input filters must use the
    -- final stage to append data to the content.
    coroutine.yield([optional header to be prepended to the content])

    -- After we have yielded, buckets will be sent to us, one by one, and we can
    -- do whatever we want with them and then pass on the result.
    -- Buckets are stored in the global variable 'bucket', so we create a loop
    -- that checks if 'bucket' is not nil:
    while bucket ~= nil do
        local output = mangle(bucket) -- Do some stuff to the content
        coroutine.yield(output) -- Return our new content to the filter chain
    end

    -- Once the buckets are gone, 'bucket' is set to nil, which will exit the
    -- loop and land us here. Anything extra we want to append to the content
    -- can be done by doing a final yield here. Both input and output filters
    -- can append data to the content in this phase.
    coroutine.yield([optional footer to be appended to the content])
end
    </highlight>

    <title>Database connectivity</title>

    Mod_lua implements a simple database feature for querying and running commands
    on the most popular database engines (mySQL, PostgreSQL, FreeTDS, ODBC, SQLite, Oracle)
    as well as mod_dbd.

The example below shows how to acquire a database handle and return information from a table:

    <highlight language="lua">
function handle(r)
    -- Acquire a database handle
    local database, err = r:dbacquire("mysql", "server=localhost,user=someuser,pass=somepass,dbname=mydb")
    if not err then
        -- Select some information from it
        local results, err = database:select(r, "SELECT `name`, `age` FROM `people` WHERE 1")
        if not err then
            local rows = results(0) -- fetch all rows synchronously
            for k, row in pairs(rows) do
                r:puts( string.format("Name: %s, Age: %s<br/>", row[1], row[2]) )
            end
        else
            r:puts("Database query error: " .. err)
        end
        database:close()
    else
        r:puts("Could not connect to the database: " .. err)
    end
end
    </highlight>

    To utilize <module>mod_dbd</module>, specify mod_dbd
    as the database type, or leave the field blank:

    <highlight language="lua">
    local database = r:dbacquire("mod_dbd")
    </highlight>

        <title>Database object and contained functions</title>

The database object returned by dbacquire has the following methods:

Normal select and query from a database:

    <highlight language="lua">
-- Run a statement and return the number of rows affected:
local affected, errmsg = database:query(r, "DELETE FROM `tbl` WHERE 1")

-- Run a statement and return a result set that can be used synchronously or async:
local result, errmsg = database:select(r, "SELECT * FROM `people` WHERE 1")
    </highlight>

Using prepared statements (recommended):

    <highlight language="lua">
-- Create and run a prepared statement:
local statement, errmsg = database:prepare(r, "DELETE FROM `tbl` WHERE `age` > %u")
if not errmsg then
    local result, errmsg = statement:query(20) -- run the statement with age > 20
end

-- Fetch a prepared statement from a DBDPrepareSQL directive:
local statement, errmsg = database:prepared(r, "someTag")
if not errmsg then
    local result, errmsg = statement:select("John Doe", 123) -- inject the values "John Doe" and 123 into the statement
end

</highlight>

Escaping values, closing databases etc:

    <highlight language="lua">
-- Escape a value for use in a statement:
local escaped = database:escape(r, [["'|blabla]])

-- Close a database connection and free up handles:
database:close()

-- Check whether a database connection is up and running:
local connected = database:active()
    </highlight>

    <title>Working with result sets</title>

The result set returned by db:select or by the prepared statement functions
    created through db:prepare can be used to
    fetch rows synchronously or asynchronously, depending on the row number specified:

    result(0) fetches all rows in a synchronous manner, returning a table of rows.

    result(-1) fetches the next available row in the set, asynchronously.

    result(N) fetches row number N, asynchronously:

    <highlight language="lua">
-- fetch a result set using a regular query:
local result, err = db:select(r, "SELECT * FROM `tbl` WHERE 1")

local rows = result(0) -- Fetch ALL rows synchronously
local row = result(-1) -- Fetch the next available row, asynchronously
local row = result(1234) -- Fetch row number 1234, asynchronously
local row = result(-1, true) -- Fetch the next available row, using row names as key indexes.
    </highlight>

One can construct a function that returns an iterative function to iterate over all rows
    in a synchronous or asynchronous way, depending on the async argument:

    <highlight language="lua">
function rows(resultset, async)
    local a = 0
    local function getnext()
        a = a + 1
        local row = resultset(-1)
        return row and a or nil, row
    end
    if not async then
        return pairs(resultset(0))
    else
        return getnext, self
    end
end

local statement, err = db:prepare(r, "SELECT * FROM `tbl` WHERE `age` > %u")
if not err then
     -- fetch rows asynchronously:
    local result, err = statement:select(20)
    if not err then
        for index, row in rows(result, true) do
            ....
        end
    end

     -- fetch rows synchronously:
    local result, err = statement:select(20)
    if not err then
        for index, row in rows(result, false) do
            ....
        end
    end
end
    </highlight>

        <title>Closing a database connection</title>

Database handles should be closed using database:close() when they are no longer
    needed. If you do not close them manually, they will eventually be garbage collected and
    closed by mod_lua, but you may end up having too many unused connections to the database
    if you leave the closing up to mod_lua. Essentially, the following two measures are
    the same:

    <highlight language="lua">
-- Method 1: Manually close a handle
local database = r:dbacquire("mod_dbd")
database:close() -- All done

-- Method 2: Letting the garbage collector close it
local database = r:dbacquire("mod_dbd")
database = nil -- throw away the reference
collectgarbage() -- close the handle via GC
</highlight>

    <title>Precautions when working with databases</title>

Although the standard query and run functions are freely
    available, it is recommended that you use prepared statements whenever possible, to
    both optimize performance (if your db handle lives on for a long time) and to minimize
    the risk of SQL injection attacks. run and query should only
    be used when there are no variables inserted into a statement (a static statement).
    When using dynamic statements, use db:prepare or db:prepared.

<directivesynopsis>
<name>LuaRoot</name>
<description>Specify the base path for resolving relative paths for mod_lua directives</description>
<syntax>LuaRoot /path/to/a/directory</syntax>
<contextlist><context>server config</context><context>virtual host</context>
<context>directory</context><context>.htaccess</context>
</contextlist>
<override>All</override>

<usage>

Specify the base path which will be used to evaluate all
    relative paths within mod_lua. If not specified they
    will be resolved relative to the current working directory,
    which may not always work well for a server.

</usage>
</directivesynopsis>

<directivesynopsis>
<name>LuaScope</name>
<description>One of once, request, conn, thread -- default is once</description>
<syntax>LuaScope once|request|conn|thread|server [min] [max]</syntax>
<default>LuaScope once</default>
<contextlist><context>server config</context><context>virtual host</context>
<context>directory</context><context>.htaccess</context>
</contextlist>
<override>All</override>

<usage>

Specify the life cycle scope of the Lua interpreter which will
    be used by handlers in this "Directory." The default is "once"

once:

use the interpreter once and throw it away.

request:

use the interpreter to handle anything based on
             the same file within this request, which is also
             request scoped.

conn:

Same as request but attached to the connection_rec

thread:

Use the interpreter for the lifetime of the thread
            handling the request (only available with threaded MPMs).

server:

This one is different than others because the
            server scope is quite long lived, and multiple threads
            will have the same server_rec. To accommodate this,
            server scoped Lua states are stored in an apr
            resource list. The min and max arguments
            specify the minimum and maximum number of Lua states to keep in the
            pool.

    Generally speaking, the thread and server scopes
    execute roughly 2-3 times faster than the rest, because they don't have to
    spawn new Lua states on every request (especially with the event MPM, as
    even keepalive requests will use a new thread for each request). If you are
    satisfied that your scripts will not have problems reusing a state, then
    the thread or server scopes should be used for
    maximum performance. While the thread scope will provide the
    fastest responses, the server scope will use less memory, as
    states are pooled, allowing f.x. 1000 threads to share only 100 Lua states,
    thus using only 10% of the memory required by the thread scope.

</usage>
</directivesynopsis>

<directivesynopsis>
<name>LuaMapHandler</name>
<description>Map a path to a lua handler</description>
<syntax>LuaMapHandler uri-pattern /path/to/lua/script.lua [function-name]</syntax>
<contextlist><context>server config</context><context>virtual host</context>
<context>directory</context><context>.htaccess</context>
</contextlist>
<override>All</override>
<usage>

This directive matches a uri pattern to invoke a specific
    handler function in a specific file. It uses PCRE regular
    expressions to match the uri, and supports interpolating
    match groups into both the file path and the function name.
    Be careful writing your regular expressions to avoid security
    issues.

   <example><title>Examples:</title>
   <highlight language="config">
    LuaMapHandler /(\w+)/(\w+) /scripts/$1.lua handle_$2
    </highlight>
   </example>

This would match uri's such as /photos/show?id=9
        to the file /scripts/photos.lua and invoke the
        handler function handle_show on the lua vm after
        loading that file.

<highlight language="config">
    LuaMapHandler /bingo /scripts/wombat.lua
</highlight>

This would invoke the "handle" function, which
        is the default if no specific function name is
        provided.

</usage>
</directivesynopsis>

<directivesynopsis>
<name>LuaPackagePath</name>
<description>Add a directory to lua's package.path</description>
<syntax>LuaPackagePath /path/to/include/?.lua</syntax>
<contextlist><context>server config</context><context>virtual host</context>
<context>directory</context><context>.htaccess</context>
</contextlist>
<override>All</override>
    <usage>
Add a path to lua's module search path. Follows the same
    conventions as lua. This just munges the package.path in the
    lua vms.

    <example><title>Examples:</title>
    <highlight language="config">
LuaPackagePath /scripts/lib/?.lua
LuaPackagePath /scripts/lib/?/init.lua
    </highlight>
    </example>
</usage>
</directivesynopsis>

<directivesynopsis>
<name>LuaPackageCPath</name>
<description>Add a directory to lua's package.cpath</description>
<syntax>LuaPackageCPath /path/to/include/?.soa</syntax>
<contextlist><context>server config</context><context>virtual host</context>
<context>directory</context><context>.htaccess</context>
</contextlist>
<override>All</override>

<usage>

Add a path to lua's shared library search path. Follows the same
    conventions as lua. This just munges the package.cpath in the
    lua vms.

</usage>
</directivesynopsis>

<directivesynopsis>
<name>LuaCodeCache</name>
<description>Configure the compiled code cache.</description>
<syntax>LuaCodeCache stat|forever|never</syntax>
<default>LuaCodeCache stat</default>
<contextlist>
<context>server config</context><context>virtual host</context>
<context>directory</context><context>.htaccess</context>
</contextlist>
<override>All</override>

<usage>

    Specify the behavior of the in-memory code cache. The default
    is stat, which stats the top level script (not any included
    ones) each time that file is needed, and reloads it if the
    modified time indicates it is newer than the one it has
    already loaded. The other values cause it to keep the file
    cached forever (don't stat and replace) or to never cache the
    file.

In general stat or forever is good for production, and stat or never
    for development.

    <example><title>Examples:</title>
    <highlight language="config">
LuaCodeCache stat
LuaCodeCache forever
LuaCodeCache never
    </highlight>
    </example>

</usage>
</directivesynopsis>

<directivesynopsis>
<name>LuaHookTranslateName</name>
<description>Provide a hook for the translate name phase of request processing</description>
<syntax>LuaHookTranslateName  /path/to/lua/script.lua  hook_function_name [early|late]</syntax>
<contextlist><context>server config</context><context>virtual host</context>
</contextlist>
<override>All</override>
<compatibility>The optional third argument is supported in 2.3.15 and later</compatibility>

<usage>

    Add a hook (at APR_HOOK_MIDDLE) to the translate name phase of
    request processing. The hook function receives a single
    argument, the request_rec, and should return a status code,
    which is either an HTTP error code, or the constants defined
    in the apache2 module: apache2.OK, apache2.DECLINED, or
    apache2.DONE.

For those new to hooks, basically each hook will be invoked
    until one of them returns apache2.OK. If your hook doesn't
    want to do the translation it should just return
    apache2.DECLINED. If the request should stop processing, then
    return apache2.DONE.

Example:

<highlight language="config">
# httpd.conf
LuaHookTranslateName /scripts/conf/hooks.lua silly_mapper
</highlight>

<highlight language="lua">
-- /scripts/conf/hooks.lua --
require "apache2"
function silly_mapper(r)
    if r.uri == "/" then
        r.filename = "/var/www/home.lua"
        return apache2.OK
    else
        return apache2.DECLINED
    end
end
</highlight>

   <note><title>Context</title>
This directive is not valid in <directive
   type="section" module="core">Directory</directive>, <directive
   type="section" module="core">Files</directive>, or htaccess
   context.
</note>

   <note><title>Ordering</title>
The optional arguments "early" or "late"
   control when this script runs relative to other modules.
</note>

</usage>
</directivesynopsis>

<directivesynopsis>
<name>LuaHookFixups</name>
<description>Provide a hook for the fixups phase of a request
processing</description>
<syntax>LuaHookFixups  /path/to/lua/script.lua hook_function_name</syntax>
<contextlist><context>server config</context><context>virtual host</context>
<context>directory</context><context>.htaccess</context>
</contextlist>
<override>All</override>
<usage>

    Just like LuaHookTranslateName, but executed at the fixups phase

</usage>
</directivesynopsis>

<directivesynopsis>
<name>LuaHookLog</name>
<description>Provide a hook for the access log phase of a request
processing</description>
<syntax>LuaHookLog  /path/to/lua/script.lua log_function_name</syntax>
<contextlist><context>server config</context><context>virtual host</context>
<context>directory</context><context>.htaccess</context>
</contextlist>
<override>All</override>
<usage>

    This simple logging hook allows you to run a function when httpd enters the
    logging phase of a request. With it, you can append data to your own logs,
    manipulate data before the regular log is written, or prevent a log entry
    from being created. To prevent the usual logging from happening, simply return
    apache2.DONE in your logging handler, otherwise return
    apache2.OK to tell httpd to log as normal.

Example:

<highlight language="config">
LuaHookLog /path/to/script.lua logger
</highlight>
<highlight language="lua">
-- /path/to/script.lua --
function logger(r)
    -- flip a coin:
    -- If 1, then we write to our own Lua log and tell httpd not to log
    -- in the main log.
    -- If 2, then we just sanitize the output a bit and tell httpd to
    -- log the sanitized bits.

    if math.random(1,2) == 1 then
        -- Log stuff ourselves and don't log in the regular log
        local f = io.open("/foo/secret.log", "a")
        if f then
            f:write("Something secret happened at " .. r.uri .. "\n")
            f:close()
        end
        return apache2.DONE -- Tell httpd not to use the regular logging functions
    else
        r.uri = r.uri:gsub("somesecretstuff", "") -- sanitize the URI
        return apache2.OK -- tell httpd to log it.
    end
end
</highlight>
</usage>
</directivesynopsis>

<directivesynopsis>
<name>LuaHookMapToStorage</name>
<description>Provide a hook for the map_to_storage phase of request processing</description>
<syntax>LuaHookMapToStorage  /path/to/lua/script.lua hook_function_name</syntax>
<contextlist><context>server config</context><context>virtual host</context>
<context>directory</context><context>.htaccess</context>
</contextlist>
<override>All</override>
    <usage>

Like <directive>LuaHookTranslateName</directive> but executed at the
    map-to-storage phase of a request. Modules like mod_cache run at this phase,
    which makes for an interesting example on what to do here:

    <highlight language="config">
    LuaHookMapToStorage /path/to/lua/script.lua check_cache
    </highlight>
    <highlight language="lua">
require"apache2"
cached_files = {}

function read_file(filename)
    local input = io.open(filename, "r")
    if input then
        local data = input:read("*a")
        cached_files[filename] = data
        file = cached_files[filename]
        input:close()
    end
    return cached_files[filename]
end

function check_cache(r)
    if r.filename:match("%.png$") then -- Only match PNG files
        local file = cached_files[r.filename] -- Check cache entries
        if not file then
            file = read_file(r.filename)  -- Read file into cache
        end
        if file then -- If file exists, write it out
            r.status = 200
            r:write(file)
            r:info(("Sent %s to client from cache"):format(r.filename))
            return apache2.DONE -- skip default handler for PNG files
        end
    end
    return apache2.DECLINED -- If we had nothing to do, let others serve this.
end
    </highlight>

    </usage>
</directivesynopsis>

<directivesynopsis>
<name>LuaHookCheckUserID</name>
<description>Provide a hook for the check_user_id phase of request processing</description>
<syntax>LuaHookCheckUserID  /path/to/lua/script.lua hook_function_name</syntax>
<contextlist><context>server config</context><context>virtual host</context>
<context>directory</context><context>.htaccess</context>
</contextlist>
<override>All</override>

</directivesynopsis>

<directivesynopsis>
<name>LuaHookTypeChecker</name>
<description>Provide a hook for the type_checker phase of request processing</description>
<syntax>LuaHookTypeChecker  /path/to/lua/script.lua hook_function_name</syntax>
<contextlist><context>server config</context><context>virtual host</context>
<context>directory</context><context>.htaccess</context>
</contextlist>
<override>All</override>
    <usage>

    This directive provides a hook for the type_checker phase of the request processing.
    This phase is where requests are assigned a content type and a handler, and thus can
    be used to modify the type and handler based on input:

    <highlight language="config">
    LuaHookTypeChecker /path/to/lua/script.lua type_checker
    </highlight>
    <highlight language="lua">
    function type_checker(r)
        if r.uri:match("%.to_gif$") then -- match foo.png.to_gif
            r.content_type = "image/gif" -- assign it the image/gif type
            r.handler = "gifWizard"      -- tell the gifWizard module to handle this
            r.filename = r.uri:gsub("%.to_gif$", "") -- fix the filename requested
            return apache2.OK
        end

        return apache2.DECLINED
    end
    </highlight>
</usage>
</directivesynopsis>

<directivesynopsis>
<name>LuaHookAuthChecker</name>
<description>Provide a hook for the auth_checker phase of request processing</description>
<syntax>LuaHookAuthChecker  /path/to/lua/script.lua hook_function_name [early|late]</syntax>
<contextlist><context>server config</context><context>virtual host</context>
<context>directory</context><context>.htaccess</context>
</contextlist>
<override>All</override>
<compatibility>The optional third argument is supported in 2.3.15 and later</compatibility>
<usage>

Invoke a lua function in the auth_checker phase of processing
a request.  This can be used to implement arbitrary authentication
and authorization checking.  A very simple example:

<highlight language="lua">
require 'apache2'

-- fake authcheck hook
-- If request has no auth info, set the response header and
-- return a 401 to ask the browser for basic auth info.
-- If request has auth info, don't actually look at it, just
-- pretend we got userid 'foo' and validated it.
-- Then check if the userid is 'foo' and accept the request.
function authcheck_hook(r)

   -- look for auth info
   auth = r.headers_in['Authorization']
   if auth ~= nil then
     -- fake the user
     r.user = 'foo'
   end

   if r.user == nil then
      r:debug("authcheck: user is nil, returning 401")
      r.err_headers_out['WWW-Authenticate'] = 'Basic realm="WallyWorld"'
      return 401
   elseif r.user == "foo" then
      r:debug('user foo: OK')
   else
      r:debug("authcheck: user='" .. r.user .. "'")
      r.err_headers_out['WWW-Authenticate'] = 'Basic realm="WallyWorld"'
      return 401
   end
   return apache2.OK
end
</highlight>
   <note><title>Ordering</title>
The optional arguments "early" or "late"
   control when this script runs relative to other modules.
</note>
</usage>
</directivesynopsis>

<directivesynopsis>
<name>LuaHookAccessChecker</name>
<description>Provide a hook for the access_checker phase of request processing</description>
<syntax>LuaHookAccessChecker  /path/to/lua/script.lua  hook_function_name [early|late]</syntax>
<contextlist><context>server config</context><context>virtual host</context>
<context>directory</context><context>.htaccess</context>
</contextlist>
<override>All</override>
<compatibility>The optional third argument is supported in 2.3.15 and later</compatibility>
<usage>

Add your hook to the access_checker phase.  An access checker
hook function usually returns OK, DECLINED, or HTTP_FORBIDDEN.

   <note><title>Ordering</title>
The optional arguments "early" or "late"
   control when this script runs relative to other modules.
</note>
</usage>
</directivesynopsis>

<directivesynopsis>
<name>LuaHookInsertFilter</name>
<description>Provide a hook for the insert_filter phase of request processing</description>
<syntax>LuaHookInsertFilter  /path/to/lua/script.lua hook_function_name</syntax>
<contextlist><context>server config</context><context>virtual host</context>
<context>directory</context><context>.htaccess</context>
</contextlist>
<override>All</override>
    <usage>
Not Yet Implemented
</usage>
</directivesynopsis>

<directivesynopsis>
<name>LuaInherit</name>
<description>Controls how parent configuration sections are merged into children</description>
<syntax>LuaInherit none|parent-first|parent-last</syntax>
<default>LuaInherit parent-first</default>
<contextlist><context>server config</context><context>virtual host</context>
<context>directory</context><context>.htaccess</context>
</contextlist>
<override>All</override>
<compatibility>2.4.0 and later</compatibility>
    <usage>
By default, if LuaHook* directives are used in overlapping
    Directory or Location configuration sections, the scripts defined in the
    more specific section are run after those defined in the more
    generic section (LuaInherit parent-first).  You can reverse this order, or
    make the parent context not apply at all.

 In previous 2.3.x releases, the default was effectively to ignore LuaHook*
    directives from parent configuration sections.
</usage>
</directivesynopsis>

<directivesynopsis>
<name>LuaQuickHandler</name>
<description>Provide a hook for the quick handler of request processing</description>
<syntax>LuaQuickHandler /path/to/script.lua hook_function_name</syntax>
<contextlist><context>server config</context><context>virtual host</context>
</contextlist>
<override>All</override>
<usage>

    This phase is run immediately after the request has been mapped to a virtal host,
    and can be used to either do some request processing before the other phases kick
    in, or to serve a request without the need to translate, map to storage et cetera.
    As this phase is run before anything else, directives such as <directive
   type="section" module="core">Location</directive> or <directive
   type="section" module="core">Directory</directive> are void in this phase, just as
    URIs have not been properly parsed yet.

   <note><title>Context</title>
This directive is not valid in <directive
   type="section" module="core">Directory</directive>, <directive
   type="section" module="core">Files</directive>, or htaccess
   context.
</note>
</usage>
</directivesynopsis>

<directivesynopsis>
<name>LuaAuthzProvider</name>
<description>Plug an authorization provider function into <module>mod_authz_core</module>
</description>
<syntax>LuaAuthzProvider provider_name /path/to/lua/script.lua function_name</syntax>
<contextlist><context>server config</context> </contextlist>
<compatibility>2.4.3 and later</compatibility>

<usage>

After a lua function has been registered as authorization provider, it can be used
with the <directive module="mod_authz_core">Require</directive> directive:

<highlight language="config">
LuaRoot /usr/local/apache2/lua
LuaAuthzProvider foo authz.lua authz_check_foo
<Location "/">
  Require foo johndoe
</Location>
</highlight>
<highlight language="lua">
require "apache2"
function authz_check_foo(r, who)
    if r.user ~= who then return apache2.AUTHZ_DENIED
    return apache2.AUTHZ_GRANTED
end
</highlight>

</usage>
</directivesynopsis>

<directivesynopsis>
<name>LuaInputFilter</name>
<description>Provide a Lua function for content input filtering</description>
<syntax>LuaInputFilter filter_name /path/to/lua/script.lua function_name</syntax>
<contextlist><context>server config</context> </contextlist>
<override>All</override>
<compatibility>2.4.5 and later</compatibility>

<usage>

Provides a means of adding a Lua function as an input filter.
As with output filters, input filters work as coroutines,
first yielding before buffers are sent, then yielding whenever
a bucket needs to be passed down the chain, and finally (optionally)
yielding anything that needs to be appended to the input data. The
global variable bucket holds the buckets as they are passed
onto the Lua script:

<highlight language="config">
LuaInputFilter myInputFilter /www/filter.lua input_filter
<Files "*.lua">
  SetInputFilter myInputFilter
</Files>
</highlight>
<highlight language="lua">
--[[
    Example input filter that converts all POST data to uppercase.
]]--
function input_filter(r)
    print("luaInputFilter called") -- debug print
    coroutine.yield() -- Yield and wait for buckets
    while bucket do -- For each bucket, do...
        local output = string.upper(bucket) -- Convert all POST data to uppercase
        coroutine.yield(output) -- Send converted data down the chain
    end
    -- No more buckets available.
    coroutine.yield("&filterSignature=1234") -- Append signature at the end
end
</highlight>

The input filter supports denying/skipping a filter if it is deemed unwanted:

<highlight language="lua">
function input_filter(r)
    if not good then
        return -- Simply deny filtering, passing on the original content instead
    end
    coroutine.yield() -- wait for buckets
    ... -- insert filter stuff here
end
</highlight>

See "Modifying contents with Lua
filters" for more information.

</usage>
</directivesynopsis>

<directivesynopsis>
<name>LuaOutputFilter</name>
<description>Provide a Lua function for content output filtering</description>
<syntax>LuaOutputFilter filter_name /path/to/lua/script.lua function_name</syntax>
<contextlist><context>server config</context> </contextlist>
<override>All</override>
<compatibility>2.4.5 and later</compatibility>

<usage>

Provides a means of adding a Lua function as an output filter.
As with input filters, output filters work as coroutines,
first yielding before buffers are sent, then yielding whenever
a bucket needs to be passed down the chain, and finally (optionally)
yielding anything that needs to be appended to the input data. The
global variable bucket holds the buckets as they are passed
onto the Lua script:

<highlight language="config">
LuaOutputFilter myOutputFilter /www/filter.lua output_filter
<Files "*.lua">
  SetOutputFilter myOutputFilter
</Files>
</highlight>
<highlight language="lua">
--[[
    Example output filter that escapes all HTML entities in the output
]]--
function output_filter(r)
    coroutine.yield("(Handled by myOutputFilter)<br/>\n") -- Prepend some data to the output,
                                                          -- yield and wait for buckets.
    while bucket do -- For each bucket, do...
        local output = r:escape_html(bucket) -- Escape all output
        coroutine.yield(output) -- Send converted data down the chain
    end
    -- No more buckets available.
end
</highlight>

As with the input filter, the output filter supports denying/skipping a filter
if it is deemed unwanted:

<highlight language="lua">
function output_filter(r)
    if not r.content_type:match("text/html") then
        return -- Simply deny filtering, passing on the original content instead
    end
    coroutine.yield() -- wait for buckets
    ... -- insert filter stuff here
end
</highlight>
<note><title>Lua filters with <module>mod_filter</module></title>

 When a Lua filter is used as the underlying provider via the
<directive module="mod_filter">FilterProvider</directive> directive, filtering
will only work when the <var>filter-name</var> is identical to the <var>provider-name</var>.

 </note>

See "Modifying contents with Lua filters" for more
information.

</usage>
</directivesynopsis>

</modulesynopsis>


text:
package org.apache.hadoop.hbase.master.handler;

import java.io.IOException;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.NavigableMap;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.apache.hadoop.classification.InterfaceAudience;
import org.apache.hadoop.hbase.HConstants;
import org.apache.hadoop.hbase.HRegionInfo;
import org.apache.hadoop.hbase.Server;
import org.apache.hadoop.hbase.ServerName;
import org.apache.hadoop.hbase.catalog.CatalogTracker;
import org.apache.hadoop.hbase.catalog.MetaEditor;
import org.apache.hadoop.hbase.catalog.MetaReader;
import org.apache.hadoop.hbase.client.Result;
import org.apache.hadoop.hbase.executor.EventHandler;
import org.apache.hadoop.hbase.master.AssignmentManager;
import org.apache.hadoop.hbase.master.DeadServer;
import org.apache.hadoop.hbase.master.MasterServices;
import org.apache.hadoop.hbase.master.RegionState;
import org.apache.hadoop.hbase.master.RegionStates;
import org.apache.hadoop.hbase.master.ServerManager;
import org.apache.hadoop.hbase.util.Bytes;
import org.apache.hadoop.hbase.util.PairOfSameType;
import org.apache.hadoop.hbase.zookeeper.ZKAssign;
import org.apache.zookeeper.KeeperException;

/**
 * Process server shutdown.
 * Server-to-handle must be already in the deadservers lists.  See
 * {@link ServerManager#expireServer(ServerName)}
 */
@InterfaceAudience.Private
public class ServerShutdownHandler extends EventHandler {
  private static final Log LOG = LogFactory.getLog(ServerShutdownHandler.class);
  protected final ServerName serverName;
  protected final MasterServices services;
  protected final DeadServer deadServers;
  protected final boolean shouldSplitHlog; // whether to split HLog or not

  public ServerShutdownHandler(final Server server, final MasterServices services,
      final DeadServer deadServers, final ServerName serverName,
      final boolean shouldSplitHlog) {
    this(server, services, deadServers, serverName, EventType.M_SERVER_SHUTDOWN,
        shouldSplitHlog);
  }

  ServerShutdownHandler(final Server server, final MasterServices services,
      final DeadServer deadServers, final ServerName serverName, EventType type,
      final boolean shouldSplitHlog) {
    super(server, type);
    this.serverName = serverName;
    this.server = server;
    this.services = services;
    this.deadServers = deadServers;
    if (!this.deadServers.contains(this.serverName)) {
      LOG.warn(this.serverName + " is NOT in deadservers; it should be!");
    }
    this.shouldSplitHlog = shouldSplitHlog;
  }

  @Override
  public String getInformativeName() {
    if (serverName != null) {
      return this.getClass().getSimpleName() + " for " + serverName;
    } else {
      return super.getInformativeName();
    }
  }

  /**
   * @return True if the server we are processing was carrying -ROOT-
   */
  boolean isCarryingRoot() {
    return false;
  }

  /**
   * @return True if the server we are processing was carrying .META.
   */
  boolean isCarryingMeta() {
    return false;
  }

  @Override
  public String toString() {
    String name = "UnknownServerName";
    if(server != null && server.getServerName() != null) {
      name = server.getServerName().toString();
    }
    return getClass().getSimpleName() + "-" + name + "-" + getSeqid();
  }

  @Override
  public void process() throws IOException {
    final ServerName serverName = this.serverName;
    try {
      try {
        if (this.shouldSplitHlog) {
          LOG.info("Splitting logs for " + serverName);
          this.services.getMasterFileSystem().splitLog(serverName);
        } else {
          LOG.info("Skipping log splitting for " + serverName);
        }
      } catch (IOException ioe) {
        //typecast to SSH so that we make sure that it is the SSH instance that
        //gets submitted as opposed to MSSH or some other derived instance of SSH
        this.services.getExecutorService().submit((ServerShutdownHandler)this);
        this.deadServers.add(serverName);
        throw new IOException("failed log splitting for " +
          serverName + ", will retry", ioe);
      }
      // We don't want worker thread in the MetaServerShutdownHandler
      // executor pool to block by waiting availability of -ROOT-
      // and .META. server. Otherwise, it could run into the following issue:
      // 1. The current MetaServerShutdownHandler instance For RS1 waits for the .META.
      //    to come online.
      // 2. The newly assigned .META. region server RS2 was shutdown right after
      //    it opens the .META. region. So the MetaServerShutdownHandler
      //    instance For RS1 will still be blocked.
      // 3. The new instance of MetaServerShutdownHandler for RS2 is queued.
      // 4. The newly assigned .META. region server RS3 was shutdown right after
      //    it opens the .META. region. So the MetaServerShutdownHandler
      //    instance For RS1 and RS2 will still be blocked.
      // 5. The new instance of MetaServerShutdownHandler for RS3 is queued.
      // 6. Repeat until we run out of MetaServerShutdownHandler worker threads
      // The solution here is to resubmit a ServerShutdownHandler request to process
      // user regions on that server so that MetaServerShutdownHandler
      // executor pool is always available.
      //
      // If AssignmentManager hasn't finished rebuilding user regions,
      // we are not ready to assign dead regions either. So we re-queue up
      // the dead server for further processing too.
      if (isCarryingRoot() || isCarryingMeta() // -ROOT- or .META.
          || !services.getAssignmentManager().isFailoverCleanupDone()) {
        this.services.getServerManager().processDeadServer(serverName);
        return;
      }

      // Wait on meta to come online; we need it to progress.
      // TODO: Best way to hold strictly here?  We should build this retry logic
      // into the MetaReader operations themselves.
      // TODO: Is the reading of .META. necessary when the Master has state of
      // cluster in its head?  It should be possible to do without reading .META.
      // in all but one case. On split, the RS updates the .META.
      // table and THEN informs the master of the split via zk nodes in
      // 'unassigned' dir.  Currently the RS puts ephemeral nodes into zk so if
      // the regionserver dies, these nodes do not stick around and this server
      // shutdown processing does fixup (see the fixupDaughters method below).
      // If we wanted to skip the .META. scan, we'd have to change at least the
      // final SPLIT message to be permanent in zk so in here we'd know a SPLIT
      // completed (zk is updated after edits to .META. have gone in).  See
      // {@link SplitTransaction}.  We'd also have to be figure another way for
      // doing the below .META. daughters fixup.
      NavigableMap<HRegionInfo, Result> hris = null;
      while (!this.server.isStopped()) {
        try {
          this.server.getCatalogTracker().waitForMeta();
          hris = MetaReader.getServerUserRegions(this.server.getCatalogTracker(),
            this.serverName);
          break;
        } catch (InterruptedException e) {
          Thread.currentThread().interrupt();
          throw new IOException("Interrupted", e);
        } catch (IOException ioe) {
          LOG.info("Received exception accessing META during server shutdown of " +
              serverName + ", retrying META read", ioe);
        }
      }
      if (this.server.isStopped()) {
        throw new IOException("Server is stopped");
      }

      // Clean out anything in regions in transition.  Being conservative and
      // doing after log splitting.  Could do some states before -- OPENING?
      // OFFLINE? -- and then others after like CLOSING that depend on log
      // splitting.
      AssignmentManager am = services.getAssignmentManager();
      List<RegionState> regionsInTransition = am.processServerShutdown(serverName);
      LOG.info("Reassigning " + ((hris == null)? 0: hris.size()) +
        " region(s) that " + (serverName == null? "null": serverName)  +
        " was carrying (skipping " + regionsInTransition.size() +
        " regions(s) that are already in transition)");

      // Iterate regions that were on this server and assign them
      if (hris != null) {
        RegionStates regionStates = am.getRegionStates();
        List<HRegionInfo> toAssignRegions = new ArrayList<HRegionInfo>();
        for (Map.Entry<HRegionInfo, Result> e: hris.entrySet()) {
          HRegionInfo hri = e.getKey();
          RegionState rit = regionStates.getRegionTransitionState(hri);
          if (processDeadRegion(hri, e.getValue(), am, server.getCatalogTracker())) {
            ServerName addressFromAM = regionStates.getRegionServerOfRegion(hri);
            if (addressFromAM != null && !addressFromAM.equals(this.serverName)) {
              // If this region is in transition on the dead server, it must be
              // opening or pending_open, which is covered by AM#processServerShutdown
              LOG.debug("Skip assigning region " + hri.getRegionNameAsString()
                + " because it has been opened in " + addressFromAM.getServerName());
              continue;
            }
            if (rit != null) {
              if (!rit.isOnServer(serverName)
                  || rit.isClosed() || rit.isOpened() || rit.isSplit()) {
                // Skip regions that are in transition on other server,
                // or in state closed/opened/split
                LOG.info("Skip assigning region " + rit);
                continue;
              }
              try{
                //clean zk node
                LOG.info("Reassigning region with rs = " + rit + " and deleting zk node if exists");
                ZKAssign.deleteNodeFailSilent(services.getZooKeeper(), hri);
              } catch (KeeperException ke) {
                this.server.abort("Unexpected ZK exception deleting unassigned node " + hri, ke);
                return;
              }
            }
            toAssignRegions.add(hri);
          } else if (rit != null) {
            if (rit.isSplitting() || rit.isSplit()) {
              // This will happen when the RS went down and the call back for the SPLIITING or SPLIT
              // has not yet happened for node Deleted event. In that case if the region was actually
              // split
              // but the RS had gone down before completing the split process then will not try to
              // assign the parent region again. In that case we should make the region offline and
              // also delete the region from RIT.
              am.regionOffline(hri);
            } else if ((rit.isClosing() || rit.isPendingClose())
                && am.getZKTable().isDisablingOrDisabledTable(hri.getTableNameAsString())) {
              // If the table was partially disabled and the RS went down, we should clear the RIT
              // and remove the node for the region.
              // The rit that we use may be stale in case the table was in DISABLING state
              // but though we did assign we will not be clearing the znode in CLOSING state.
              // Doing this will have no harm. See HBASE-5927
              am.deleteClosingOrClosedNode(hri);
              am.regionOffline(hri);
            } else {
              LOG.warn("THIS SHOULD NOT HAPPEN: unexpected region in transition "
                + rit + " not to be assigned by SSH of server " + serverName);
            }
          }
        }
        try {
          am.assign(toAssignRegions);
        } catch (InterruptedException ie) {
          LOG.error("Caught " + ie + " during round-robin assignment");
          throw new IOException(ie);
        }
      }
    } finally {
      this.deadServers.finish(serverName);
    }
    LOG.info("Finished processing of shutdown of " + serverName);
  }

  /**
   * Process a dead region from a dead RS. Checks if the region is disabled or
   * disabling or if the region has a partially completed split.
   * @param hri
   * @param result
   * @param assignmentManager
   * @param catalogTracker
   * @return Returns true if specified region should be assigned, false if not.
   * @throws IOException
   */
  public static boolean processDeadRegion(HRegionInfo hri, Result result,
      AssignmentManager assignmentManager, CatalogTracker catalogTracker)
  throws IOException {
    boolean tablePresent = assignmentManager.getZKTable().isTablePresent(
        hri.getTableNameAsString());
    if (!tablePresent) {
      LOG.info("The table " + hri.getTableNameAsString()
          + " was deleted.  Hence not proceeding.");
      return false;
    }
    // If table is not disabled but the region is offlined,
    boolean disabled = assignmentManager.getZKTable().isDisabledTable(
        hri.getTableNameAsString());
    if (disabled){
      LOG.info("The table " + hri.getTableNameAsString()
          + " was disabled.  Hence not proceeding.");
      return false;
    }
    if (hri.isOffline() && hri.isSplit()) {
      LOG.debug("Offlined and split region " + hri.getRegionNameAsString() +
        "; checking daughter presence");
      if (MetaReader.getRegion(catalogTracker, hri.getRegionName()) == null) {
        return false;
      }
      fixupDaughters(result, assignmentManager, catalogTracker);
      return false;
    }
    boolean disabling = assignmentManager.getZKTable().isDisablingTable(
        hri.getTableNameAsString());
    if (disabling) {
      LOG.info("The table " + hri.getTableNameAsString()
          + " is disabled.  Hence not assigning region" + hri.getEncodedName());
      return false;
    }
    return true;
  }

  /**
   * Check that daughter regions are up in .META. and if not, add them.
   * @param result The contents of the parent row in .META.
   * @param assignmentManager
   * @param catalogTracker
   * @return the number of daughters missing and fixed
   * @throws IOException
   */
  public static int fixupDaughters(final Result result,
      final AssignmentManager assignmentManager,
      final CatalogTracker catalogTracker)
  throws IOException {
    PairOfSameType<HRegionInfo> daughters = HRegionInfo.getDaughterRegions(result);
    int fixedA = fixupDaughter(result, daughters.getFirst(),
      assignmentManager, catalogTracker);
    int fixedB = fixupDaughter(result, daughters.getSecond(),
      assignmentManager, catalogTracker);
    return fixedA + fixedB;
  }

  /**
   * Check individual daughter is up in .META.; fixup if its not.
   * @param result The contents of the parent row in .META. - not used
   * @param daughter Which daughter to check for.
   * @return 1 if the daughter is missing and fixed. Otherwise 0
   * @throws IOException
   */
  static int fixupDaughter(final Result result, HRegionInfo daughter,
      final AssignmentManager assignmentManager,
      final CatalogTracker catalogTracker)
  throws IOException {
    if (daughter == null) return 0;
    if (isDaughterMissing(catalogTracker, daughter)) {
      LOG.info("Fixup; missing daughter " + daughter.getRegionNameAsString());
      MetaEditor.addDaughter(catalogTracker, daughter, null);

      // TODO: Log WARN if the regiondir does not exist in the fs.  If its not
      // there then something wonky about the split -- things will keep going
      // but could be missing references to parent region.

      // And assign it.
      assignmentManager.assign(daughter, true, true);
      return 1;
    } else {
      LOG.debug("Daughter " + daughter.getRegionNameAsString() + " present");
    }
    return 0;
  }

  /**
   * Look for presence of the daughter OR of a split of the daughter in .META.
   * Daughter could have been split over on regionserver before a run of the
   * catalogJanitor had chance to clear reference from parent.
   * @param daughter Daughter region to search for.
   * @throws IOException
   */
  private static boolean isDaughterMissing(final CatalogTracker catalogTracker,
      final HRegionInfo daughter) throws IOException {
    FindDaughterVisitor visitor = new FindDaughterVisitor(daughter);
    // Start the scan at what should be the daughter's row in the .META.
    // We will either 1., find the daughter or some derivative split of the
    // daughter (will have same table name and start row at least but will sort
    // after because has larger regionid -- the regionid is timestamp of region
    // creation), OR, we will not find anything with same table name and start
    // row.  If the latter, then assume daughter missing and do fixup.
    byte [] startrow = daughter.getRegionName();
    MetaReader.fullScan(catalogTracker, visitor, startrow);
    return !visitor.foundDaughter();
  }

  /**
   * Looks for daughter.  Sets a flag if daughter or some progeny of daughter
   * is found up in .META..
   */
  static class FindDaughterVisitor implements MetaReader.Visitor {
    private final HRegionInfo daughter;
    private boolean found = false;

    FindDaughterVisitor(final HRegionInfo daughter) {
      this.daughter = daughter;
    }

    /**
     * @return True if we found a daughter region during our visiting.
     */
    boolean foundDaughter() {
      return this.found;
    }

    @Override
    public boolean visit(Result r) throws IOException {
      HRegionInfo hri =
        HRegionInfo.getHRegionInfo(r);
      if (hri == null) {
        LOG.warn("No serialized HRegionInfo in " + r);
        return true;
      }
      byte [] value = r.getValue(HConstants.CATALOG_FAMILY,
          HConstants.SERVER_QUALIFIER);
      // See if daughter is assigned to some server
      if (value == null) return false;

      // Now see if we have gone beyond the daughter's startrow.
      if (!Bytes.equals(daughter.getTableName(),
          hri.getTableName())) {
        // We fell into another table.  Stop scanning.
        return false;
      }
      // If our start rows do not compare, move on.
      if (!Bytes.equals(daughter.getStartKey(), hri.getStartKey())) {
        return false;
      }
      // Else, table name and start rows compare.  It means that the daughter
      // or some derivative split of the daughter is up in .META.  Daughter
      // exists.
      this.found = true;
      return false;
    }
  }
}

redpajama_set_name: RedPajamaGithub


text:
// Copyright 2009 the Sputnik authors.  All rights reserved.
// This code is governed by the BSD license found in the LICENSE file.

/*---
info: >
    pattern is an object R whose [[Class]] property is "RegExp" and flags
    is not undefined
es5id: 15.10.4.1_A2_T1
description: >
    Checking if execution of "new RegExp(pattern, "i")", where the
    pattern is "/\u0042/i", does not fail
---*/

//CHECK#1
var regExpObj = new RegExp(/\u0042/i, "i");
assert(regExpObj.ignoreCase);


text:
-- =============================================
-- Author:		Ken Taylor
-- Create date: February 5, 2014
-- Description:	Given a Kerberos/LoginId, Return a list of open orders that the user has access to.
--	Notes:
--		Replaces vOpenAccess.
--		Permissions access for open orders only.  Orders that are not in the following status codes: ('CN', 'CP', 'OC', 'OD')
--
-- Usage:
/*
	select * from udf_GetOpenOrdersForLogin('bazemore')
*/
-- Modifications:
--	2014-02-10 by kjt: Revised logic to reduce number of executions, i.e. loop iterations.
--	2014-02-12 by kjt: Revised logic once again to maximize efficiency.
-- =============================================
CREATE FUNCTION [dbo].[udf_GetOpenOrdersForLogin_Old]
  (
    -- Add the parameters for the function here
    @LoginId varchar(50)
  )
  RETURNS
    @OpenAccessOrders TABLE
  (
    id           int,
    orderid      int,
    accessuserid varchar(10),
    isadmin      bit,
    accesslevel  char(2),
    Edit         bit,
    [Read]       bit
  )
AS
  BEGIN
    INSERT INTO @OpenAccessOrders
    select ROW_NUMBER() over (order by orderid) id, *
    from (
         -- regular permissions
         select distinct o.id                 orderid,
                         case
                           when ap.userid is null then wp.userid
                           when ap.userid is not null and ouser.isaway = 1 then wp.userid
                           else ap.userid
                             end              accessuserid,
                         0                    isadmin,
                         ap.orderstatuscodeid accesslevel,
                         1                    Edit,
                         1                    [Read]
         from orders o
                inner join orderstatuscodes osc on o.orderstatuscodeid = osc.id
                left outer join approvals ap on o.id = ap.orderid
                inner join orderstatuscodes aposc on ap.OrderStatusCodeId = aposc.id
                left outer join workgrouppermissions wp
                  on o.workgroupid = wp.workgroupid and ap.orderstatuscodeid = wp.roleid
                left outer join users ouser on ouser.id = ap.userid
         where case
                 when ap.userid is null then wp.userid
                 when ap.userid is not null and ouser.isaway = 1 then wp.userid
                 else ap.userid
                   end = @LoginId
           and ap.Completed = 0
           and osc.iscomplete = 0
           and aposc.level = osc.Level
           and (
                   wp.isadmin = 0
                     or
                   (
                       wp.isadmin = 1 and wp.isfullfeatured = 1
                       )
                   )
           and (
                   ap.userid in (select userid from workgrouppermissions where workgroupid = o.workgroupid)
                     or
                   ap.userid is null
                   )
           and o.orderstatuscodeid not in ('CN', 'CP', 'OC', 'OD')
         --and osc.id not in ('CN', 'CP', 'OC', 'OD')

         union

         -- ad hoc permissons
         select distinct o.id                 orderid,
                         ap.userid            accessuserid,
                         0                    isadmin,
                         ap.orderstatuscodeid accesslevel,
                         1                    Edit,
                         1                    [Read]
         from orders o
                inner join orderstatuscodes osc on o.orderstatuscodeid = osc.id
                left outer join approvals ap on o.id = ap.orderid
                inner join orderstatuscodes aposc on ap.OrderStatusCodeId = aposc.id
         where ap.userid = @LoginId
           and ap.Completed = 0
           and osc.iscomplete = 0
           and aposc.level = osc.level
           and ap.userid not in (select userid from workgrouppermissions where workgroupid = o.workgroupid)
             --and o.orderstatuscodeid not in ('CN', 'CP', 'OC', 'OD')
           and osc.id not in ('CN', 'CP', 'OC', 'OD')

         union

         -- override, provides admin permissions
         select o.id orderid, userid, isadmin, wp.roleid, 1 Edit, 1 [Read]
         from orders o
                inner join workgrouppermissions wp on o.workgroupid = wp.workgroupid and o.OrderStatusCodeId = wp.roleid

         where userid = @LoginId
           and wp.isadmin = 1
           and wp.IsFullFeatured = 0
           and o.orderstatuscodeid not in ('CN', 'CP', 'OC', 'OD')

         union

         -- secondary Conditional Approval
         select ap.OrderId,
                ap.SecondaryUserId accessuserid,
                cast(0 as bit)     isadmin,
                ap.OrderStatusCodeId,
                1                  Edit,
                1                  [Read]
         from approvals ap
                inner join orders o on ap.OrderId = o.id
                inner join OrderStatusCodes aposc on ap.OrderStatusCodeId = aposc.id
                inner join OrderStatusCodes oosc on o.orderstatuscodeid = oosc.id
         where ap.SecondaryUserId = @LoginId
           and ap.OrderStatusCodeId = 'CA'
           and ap.SecondaryUserId is not null
           and aposc.level = oosc.level
           and ap.Completed = 0
           and o.orderstatuscodeid not in ('CN', 'CP', 'OC', 'OD')
         --and oosc.id not in ('CN', 'CP', 'OC', 'OD')

         union

         -- Primary Conditional Approval
         select ap.OrderId, ap.UserId accessuserid, cast(0 as bit) isadmin, ap.OrderStatusCodeId, 1 Edit, 1 [Read]
         from approvals ap
                inner join orders o on ap.OrderId = o.id
                inner join OrderStatusCodes aposc on ap.OrderStatusCodeId = aposc.id
                inner join OrderStatusCodes oosc on o.orderstatuscodeid = oosc.id
         where ap.UserId = @LoginId
           and ap.OrderStatusCodeId = 'CA'
           and aposc.level = oosc.level
           and ap.Completed = 0
           and o.orderstatuscodeid not in ('CN', 'CP', 'OC', 'OD')
         --and oosc.id not in ('CN', 'CP', 'OC', 'OD')

         union

         select orderid, userid accessuserid, 0 [admin], ordertracking.OrderStatusCodeId, 0 Edit, 1 [Read]
         from ordertracking
                inner join orders o on ordertracking.orderid = o.id
             --inner join OrderStatusCodes osc on o.orderstatuscodeid = osc.id
         where userid = @LoginId
           and o.orderstatuscodeid not in ('CN', 'CP', 'OC', 'OD')
         --and osc.id not in ('CN', 'CP', 'OC', 'OD')

         union

         -- reviewer role
         select o.id                                                                              orderid,
                wp.userid                                                                         accessuserid,
                cast(case when wp.isadmin = 1 and wp.isfullfeatured = 0 then 1 else 0 end as bit) [admin],
                wp.RoleId                                                                         orderstatuscodeid,
                0                                                                                Edit,
                1                                                                                [Read]
         from workgrouppermissions wp
                inner join orders o on o.WorkgroupId = wp.WorkgroupId
                inner join workgroups w on wp.workgroupid = w.id and w.IsActive = 1
                inner join OrderStatusCodes osc on o.orderstatuscodeid = osc.id
         where wp.userid = @LoginId
           and wp.roleid = 'RV'
             --and o.orderstatuscodeid not in ('CN', 'CP', 'OC', 'OD')
           and osc.id not in ('CN', 'CP', 'OC', 'OD')) vopenaccess
    where accessuserid is not null

    RETURN
  END


text:
package cn.newcapec.foundation.privilege.biz;

import cn.newcapec.foundation.privilege.model.DepartmentUser;
import cn.newcapec.framework.core.biz.BaseService;

/**
 * 用户部门接口业务接口类
 * @author andy.li
 *
 */
@SuppressWarnings("all")
public interface UserDepartmentService extends BaseService<DepartmentUser> {

/**
 * 查询当前部门下 是否有 人员
 * 如果存在返回 true 否则 返回 false
 * **/
 public boolean findDepartmentsbyIdsExist(String[] idss);

}


text:
package com.mocircle.cidrawing.utils;

import com.mocircle.cidrawing.element.DrawElement;

import java.util.Collections;
import java.util.Comparator;
import java.util.List;

public class ElementUtils {

    public static void sortElementsInLayer(List<DrawElement> elements) {
        Collections.sort(elements, new Comparator<DrawElement>() {
            @Override
            public int compare(DrawElement o1, DrawElement o2) {
                return o1.getOrderIndex() - o2.getOrderIndex();
            }
        });
    }

}


text:
<?xml version="1.0" encoding="utf-8"?>
<TextView
    xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:tools="http://schemas.android.com/tools"
    android:id="@android:id/text1"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    android:paddingEnd="4dp"
    android:textAppearance="@style/TextAppearance.Widget.AppCompat.Toolbar.Title"
    android:textColor="@color/timespan_title_text"
    tools:ignore="RtlSymmetry"
    />


text: Repositorio con el curso de MEN que impartiré


text:
package com.haulmont.cuba.desktop.sys.validation;

import java.awt.event.WindowAdapter;
import java.awt.event.WindowEvent;

public abstract class ValidationAwareWindowClosingListener extends WindowAdapter {

    @Override
    public void windowClosing(final WindowEvent e) {
        ValidationAlertHolder.runIfValid(new Runnable() {
            @Override
            public void run() {
                windowClosingAfterValidation(e);
            }
        });
    }

    public abstract void windowClosingAfterValidation(WindowEvent e);
}


text:
<?xml version="1.0" encoding="utf-8" standalone="yes" ?>
<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom">
  <channel>
    <title>Maximilian Aaron Rogers-Grazado | My bits</title>
    <link>http://lpantano.github.io/author/maximilian-aaron-rogers-grazado/</link>
      <atom:link href="http://lpantano.github.io/author/maximilian-aaron-rogers-grazado/index.xml" rel="self" type="application/rss+xml" />
    <description>Maximilian Aaron Rogers-Grazado</description>
    <generator>Wowchemy (https://wowchemy.com)</generator><language>en-us</language><lastBuildDate>Tue, 01 Jan 2019 00:00:00 +0000</lastBuildDate>
    <image>
      <url>http://lpantano.github.io/images/icon_hu0b7a4cb9992c9ac0e91bd28ffd38dd00_9727_512x512_fill_lanczos_center_3.png</url>
      <title>Maximilian Aaron Rogers-Grazado</title>
      <link>http://lpantano.github.io/author/maximilian-aaron-rogers-grazado/</link>
    </image>

    <item>
      <title>Sex-dependent changes in miRNA expression in the bed nucleus of the stria terminalis following stress</title>
      <link>http://lpantano.github.io/publication/mavrikaki-2019-sex/</link>
      <pubDate>Tue, 01 Jan 2019 00:00:00 +0000</pubDate>
      <guid>http://lpantano.github.io/publication/mavrikaki-2019-sex/</guid>
      <description></description>
    </item>

  </channel>
</rss>


text:
import { HttpClient, HttpErrorResponse } from '@angular/common/http';
import { BehaviorSubject, Observable, of, from, Subject } from 'rxjs';
import { catchError, distinctUntilChanged, filter, map, switchMap } from 'rxjs/operators';
import { WpAuthState, WpAuthToken } from './wp-auth.interface';
import { WpUser, WpConfig } from '../interfaces';
import { JwtService } from '../jwt';

export const defaultAuthState: WpAuthState = {
  user: null,
  loading: false,
  loggedIn: false,
  error: null
};

export class WpAuthRef {

  /**
   * Stream that emits WpAuth state
   */
  private _state = new BehaviorSubject<WpAuthState>({...defaultAuthState});
  state: Observable<any> = this._state.asObservable();

  /**
   * Stream that emits logged in state
   */
  loggedIn: Observable<boolean> = this._state.pipe(
    map((state: WpAuthState) => state.loggedIn),
    distinctUntilChanged()
  );

  /**
   * Stream that emits logged in user
   */
  user: Observable<WpUser> = this._state.pipe(
    map((state: WpAuthState) => state.user),
    distinctUntilChanged()
  );

  /**
   * Stream that emits loading state
   */
  loading: Observable<boolean> = this.state.pipe(
    map((state: WpAuthState) => state.loading),
    distinctUntilChanged()
  );

  /**
   * Stream that emits auth errors
   */
  error: Observable<Error> = this._state.pipe(
    map((state: WpAuthState) => state.error),
    distinctUntilChanged()
  );

  constructor(private config: WpConfig, private http: HttpClient, private errorEmitter: Subject<Error>, jwt: JwtService) {
    jwt.isTokenExpired().pipe(
      filter((isTokenExpired: boolean) => !isTokenExpired),
      switchMap(() => this.getLoggedInUser())
    ).subscribe();
  }

  /**
   * Sign in
   */
  signIn(username: string, password: string): Observable<WpAuthState> {
    this._updateState({
      loading: true,
      error: null
    });
    const url = this.config.baseUrl + this.config.authUrl;
    return this.http.post(url, {username, password}).pipe(
      switchMap((res: WpAuthToken) => this.storeToken(res.token)),
      switchMap(() => this.getLoggedInUser()),
      catchError((res: HttpErrorResponse) => this._onError(res.error))
    );
  }

  /**
   * Validate a JWT token
   */
  validateToken(): Observable<WpAuthState> {
    this._updateState({loading: true});
    const url = this.config.baseUrl + this.config.validateAuthUrl;
    return this.http.post(url, {}).pipe(
      map(() => this._onValidateTokenSuccess()),
      catchError((res: HttpErrorResponse) => this._onError(res.error))
    );
  }

  /**
   * Get the logged in user
   */
  getLoggedInUser(): Observable<WpAuthState> {
    this._updateState({loading: true});
    return this.http.get(this.config.baseUrl + this.config.restUrl + 'users/me').pipe(
      map((user: WpUser) => this._onSignInSuccess(user)),
      catchError((res: HttpErrorResponse) => this._onError(res.error))
    );
  }

  /**
   * Sign out
   */
  signOut(): Observable<WpAuthState> {
    return this.removeToken().pipe(
      map(() => this._updateState(defaultAuthState))
    );
  }

  /**
   * Sign in success
   */
  private _onSignInSuccess(user: WpUser) {
    return this._updateState({
      user: user,
      loading: false,
      loggedIn: true,
      error: null
    });
  }

  /**
   * Validate token success
   */
  private _onValidateTokenSuccess() {
    return this._updateState({
      loading: false,
      loggedIn: true,
      error: null
    });
  }

  /**
   * Error handling
   */
  private _onError(err: Error): Observable<WpAuthState> {
    return this.removeToken().pipe(
      map(() => {
        const state = this._updateState({
          user: null,
          loading: false,
          loggedIn: false,
          error: err
        });
        this.errorEmitter.next(err);
        return state;
      })
    );
  }

  /**
   * Store token in storage
   */
  private storeToken(token: string): Observable<any> {
    return of(this.config.jwtOptions.tokenSetter).pipe(
      switchMap((tokenSetter: Promise<void | null> | any) => (tokenSetter instanceof Promise)
        ? from(tokenSetter) : tokenSetter(token))
    );
  }

  /**
   * Remove token from storage
   */
  private removeToken(): Observable<any> {
    return of(this.config.jwtOptions.tokenRemover).pipe(
      switchMap((tokenRemover: Promise<void | null> | any) => (tokenRemover instanceof Promise)
        ? from(tokenRemover) : tokenRemover())
    );
  }

  /**
   * Update local state
   */
  private _updateState(state: WpAuthState): WpAuthState {
    this._state.next({...this._state.value, ...state});
    return this._state.value;
  }

}


text:
package io.dockstore.webservice.core;

import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import java.sql.Timestamp;
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.Index;
import javax.persistence.NamedQueries;
import javax.persistence.NamedQuery;
import javax.persistence.Table;
import org.hibernate.annotations.CreationTimestamp;
import org.hibernate.annotations.UpdateTimestamp;

@ApiModel(value = "OrcidAuthor", description = "This describes an ORCID-author of a version in Dockstore")
@Entity
@Table(name = "orcidauthor", indexes = @Index(name = "unique_orcid_index", columnList = "orcid", unique = true))
@NamedQueries({
    @NamedQuery(name = "io.dockstore.webservice.core.OrcidAuthor.findByOrcidId", query = "SELECT o FROM OrcidAuthor o WHERE o.orcid = :orcidId")
})
public class OrcidAuthor {

    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    @ApiModelProperty(value = "Implementation specific ID for the author in this web service", required = true, position = 0)
    private long id;

    @Column(columnDefinition = "varchar(50)", nullable = false)
    @ApiModelProperty(value = "ORCID iD of the author", required = true, position = 1)
    private String orcid;

    // database timestamps
    @Column(updatable = false)
    @CreationTimestamp
    private Timestamp dbCreateDate;

    @Column()
    @UpdateTimestamp
    private Timestamp dbUpdateDate;

    public OrcidAuthor() {}

    public OrcidAuthor(String orcid) {
        this.orcid = orcid;
    }

    public long getId() {
        return this.id;
    }

    public String getOrcid() {
        return orcid;
    }
}


text:
Get check code and Print record

You can get a check code to share your driving licence information with someone else, like your employer or a car hire company.

Get a licence summary to print or save by clicking here.

You must also give them the last 8 characters of your driving licence number.

Your code will be valid for 21 days.

		{{>share/includes/buttons/get-another-code}}

Active codes

						Code
						Expiry
						Print
						Cancel

						sw F2 zf RS
						25 April 2016
						Print
						Cancel

		View all check codes (active, inactive and expired)