xref: /OpenGrok/opengrok-indexer/src/test/resources/analysis/lua/sample.lua (revision eeb7e5b33d1bcc524fcc9d1d560447b044e286a4)
1--
2--                                  Apache License
3--                            Version 2.0, January 2004
4--                         http://www.apache.org/licenses/
5--
6--    TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7--
8--    1. Definitions.
9--
10--       "License" shall mean the terms and conditions for use, reproduction,
11--       and distribution as defined by Sections 1 through 9 of this document.
12--
13--       "Licensor" shall mean the copyright owner or entity authorized by
14--       the copyright owner that is granting the License.
15--
16--       "Legal Entity" shall mean the union of the acting entity and all
17--       other entities that control, are controlled by, or are under common
18--       control with that entity. For the purposes of this definition,
19--       "control" means (i) the power, direct or indirect, to cause the
20--       direction or management of such entity, whether by contract or
21--       otherwise, or (ii) ownership of fifty percent (50%) or more of the
22--       outstanding shares, or (iii) beneficial ownership of such entity.
23--
24--       "You" (or "Your") shall mean an individual or Legal Entity
25--       exercising permissions granted by this License.
26--
27--       "Source" form shall mean the preferred form for making modifications,
28--       including but not limited to software source code, documentation
29--       source, and configuration files.
30--
31--       "Object" form shall mean any form resulting from mechanical
32--       transformation or translation of a Source form, including but
33--       not limited to compiled object code, generated documentation,
34--       and conversions to other media types.
35--
36--       "Work" shall mean the work of authorship, whether in Source or
37--       Object form, made available under the License, as indicated by a
38--       copyright notice that is included in or attached to the work
39--       (an example is provided in the Appendix below).
40--
41--       "Derivative Works" shall mean any work, whether in Source or Object
42--       form, that is based on (or derived from) the Work and for which the
43--       editorial revisions, annotations, elaborations, or other modifications
44--       represent, as a whole, an original work of authorship. For the purposes
45--       of this License, Derivative Works shall not include works that remain
46--       separable from, or merely link (or bind by name) to the interfaces of,
47--       the Work and Derivative Works thereof.
48--
49--       "Contribution" shall mean any work of authorship, including
50--       the original version of the Work and any modifications or additions
51--       to that Work or Derivative Works thereof, that is intentionally
52--       submitted to Licensor for inclusion in the Work by the copyright owner
53--       or by an individual or Legal Entity authorized to submit on behalf of
54--       the copyright owner. For the purposes of this definition, "submitted"
55--       means any form of electronic, verbal, or written communication sent
56--       to the Licensor or its representatives, including but not limited to
57--       communication on electronic mailing lists, source code control systems,
58--       and issue tracking systems that are managed by, or on behalf of, the
59--       Licensor for the purpose of discussing and improving the Work, but
60--       excluding communication that is conspicuously marked or otherwise
61--       designated in writing by the copyright owner as "Not a Contribution."
62--
63--       "Contributor" shall mean Licensor and any individual or Legal Entity
64--       on behalf of whom a Contribution has been received by Licensor and
65--       subsequently incorporated within the Work.
66--
67--    2. Grant of Copyright License. Subject to the terms and conditions of
68--       this License, each Contributor hereby grants to You a perpetual,
69--       worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70--       copyright license to reproduce, prepare Derivative Works of,
71--       publicly display, publicly perform, sublicense, and distribute the
72--       Work and such Derivative Works in Source or Object form.
73--
74--    3. Grant of Patent License. Subject to the terms and conditions of
75--       this License, each Contributor hereby grants to You a perpetual,
76--       worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77--       (except as stated in this section) patent license to make, have made,
78--       use, offer to sell, sell, import, and otherwise transfer the Work,
79--       where such license applies only to those patent claims licensable
80--       by such Contributor that are necessarily infringed by their
81--       Contribution(s) alone or by combination of their Contribution(s)
82--       with the Work to which such Contribution(s) was submitted. If You
83--       institute patent litigation against any entity (including a
84--       cross-claim or counterclaim in a lawsuit) alleging that the Work
85--       or a Contribution incorporated within the Work constitutes direct
86--       or contributory patent infringement, then any patent licenses
87--       granted to You under this License for that Work shall terminate
88--       as of the date such litigation is filed.
89--
90--    4. Redistribution. You may reproduce and distribute copies of the
91--       Work or Derivative Works thereof in any medium, with or without
92--       modifications, and in Source or Object form, provided that You
93--       meet the following conditions:
94--
95--       (a) You must give any other recipients of the Work or
96--           Derivative Works a copy of this License; and
97--
98--       (b) You must cause any modified files to carry prominent notices
99--           stating that You changed the files; and
100--
101--       (c) You must retain, in the Source form of any Derivative Works
102--           that You distribute, all copyright, patent, trademark, and
103--           attribution notices from the Source form of the Work,
104--           excluding those notices that do not pertain to any part of
105--           the Derivative Works; and
106--
107--       (d) If the Work includes a "NOTICE" text file as part of its
108--           distribution, then any Derivative Works that You distribute must
109--           include a readable copy of the attribution notices contained
110--           within such NOTICE file, excluding those notices that do not
111--           pertain to any part of the Derivative Works, in at least one
112--           of the following places: within a NOTICE text file distributed
113--           as part of the Derivative Works; within the Source form or
114--           documentation, if provided along with the Derivative Works; or,
115--           within a display generated by the Derivative Works, if and
116--           wherever such third-party notices normally appear. The contents
117--           of the NOTICE file are for informational purposes only and
118--           do not modify the License. You may add Your own attribution
119--           notices within Derivative Works that You distribute, alongside
120--           or as an addendum to the NOTICE text from the Work, provided
121--           that such additional attribution notices cannot be construed
122--           as modifying the License.
123--
124--       You may add Your own copyright statement to Your modifications and
125--       may provide additional or different license terms and conditions
126--       for use, reproduction, or distribution of Your modifications, or
127--       for any such Derivative Works as a whole, provided Your use,
128--       reproduction, and distribution of the Work otherwise complies with
129--       the conditions stated in this License.
130--
131--    5. Submission of Contributions. Unless You explicitly state otherwise,
132--       any Contribution intentionally submitted for inclusion in the Work
133--       by You to the Licensor shall be under the terms and conditions of
134--       this License, without any additional terms or conditions.
135--       Notwithstanding the above, nothing herein shall supersede or modify
136--       the terms of any separate license agreement you may have executed
137--       with Licensor regarding such Contributions.
138--
139--    6. Trademarks. This License does not grant permission to use the trade
140--       names, trademarks, service marks, or product names of the Licensor,
141--       except as required for reasonable and customary use in describing the
142--       origin of the Work and reproducing the content of the NOTICE file.
143--
144--    7. Disclaimer of Warranty. Unless required by applicable law or
145--       agreed to in writing, Licensor provides the Work (and each
146--       Contributor provides its Contributions) on an "AS IS" BASIS,
147--       WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148--       implied, including, without limitation, any warranties or conditions
149--       of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150--       PARTICULAR PURPOSE. You are solely responsible for determining the
151--       appropriateness of using or redistributing the Work and assume any
152--       risks associated with Your exercise of permissions under this License.
153--
154--    8. Limitation of Liability. In no event and under no legal theory,
155--       whether in tort (including negligence), contract, or otherwise,
156--       unless required by applicable law (such as deliberate and grossly
157--       negligent acts) or agreed to in writing, shall any Contributor be
158--       liable to You for damages, including any direct, indirect, special,
159--       incidental, or consequential damages of any character arising as a
160--       result of this License or out of the use or inability to use the
161--       Work (including but not limited to damages for loss of goodwill,
162--       work stoppage, computer failure or malfunction, or any and all
163--       other commercial damages or losses), even if such Contributor
164--       has been advised of the possibility of such damages.
165--
166--    9. Accepting Warranty or Additional Liability. While redistributing
167--       the Work or Derivative Works thereof, You may choose to offer,
168--       and charge a fee for, acceptance of support, warranty, indemnity,
169--       or other liability obligations and/or rights consistent with this
170--       License. However, in accepting such obligations, You may act only
171--       on Your own behalf and on Your sole responsibility, not on behalf
172--       of any other Contributor, and only if You agree to indemnify,
173--       defend, and hold each Contributor harmless for any liability
174--       incurred by, or claims asserted against, such Contributor by reason
175--       of your accepting any such warranty or additional liability.
176--
177--    END OF TERMS AND CONDITIONS
178--
179--    APPENDIX: How to apply the Apache License to your work.
180--
181--       To apply the Apache License to your work, attach the following
182--       boilerplate notice, with the fields enclosed by brackets "[]"
183--       replaced with your own identifying information. (Don't include
184--       the brackets!)  The text should be enclosed in the appropriate
185--       comment syntax for the file format. We also recommend that a
186--       file or class name and description of purpose be included on the
187--       same "printed page" as the copyright notice for easier
188--       identification within third-party archives.
189--
190--    Copyright 2016-2017 Kong Inc.
191--
192--    Licensed under the Apache License, Version 2.0 (the "License");
193--    you may not use this file except in compliance with the License.
194--    You may obtain a copy of the License at
195--
196--        http://www.apache.org/licenses/LICENSE-2.0
197--
198--    Unless required by applicable law or agreed to in writing, software
199--    distributed under the License is distributed on an "AS IS" BASIS,
200--    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201--    See the License for the specific language governing permissions and
202--    limitations under the License.
203
204local pcall = pcall
205local ngx_log = ngx.log
206local ERR = ngx.ERR
207
208
209local _M = {}
210
211
212do
213  local multipart = require "multipart"
214  local cjson     = require "cjson.safe"
215
216
217  local str_find              = string.find
218  local str_format            = string.format
219  local ngx_req_get_post_args = ngx.req.get_post_args
220  local ngx_req_get_body_data = ngx.req.get_body_data
221
222
223  local MIME_TYPES = {
224    form_url_encoded = 1,
225    json             = 2,
226    xml              = 3,
227    multipart        = 4,
228    text             = 5,
229    html             = 6,
230  }
231
232
233  local ERRORS     = {
234    no_ct          = 1 + 0xFFFF - 0XFFFF,
235    [1]            = "don't know how to parse request body (no Content-Type)",
236    unknown_ct     = 2,
237    [2]            = "don't know how to parse request body (" ..
238                     "unknown Content-Type '%s')",
239    unsupported_ct = 3,
240    [3]            = "don't know how to parse request body (" ..
241                     "can't decode Content-Type '%s')",
242  }
243
244
245  _M.req_mime_types  = MIME_TYPES
246  _M.req_body_errors = ERRORS
247
248
249  local MIME_DECODERS = {
250    [MIME_TYPES.multipart] = function(content_type)
251      local raw_body = ngx_req_get_body_data()
252      local args     = multipart(raw_body, content_type):get_all()
253
254      return args, raw_body
255    end,
256
257    [MIME_TYPES.json] = function()
258      local raw_body  = ngx_req_get_body_data()
259      local args, err = cjson.decode(raw_body)
260      if err then
261        ngx_log(ERR, "could not decode JSON body args: ", err)
262        return {}, raw_body
263      end
264
265      return args, raw_body
266    end,
267
268    [MIME_TYPES.form_url_encoded] = function()
269      local ok, res, err = pcall(ngx_req_get_post_args)
270      if not ok or err then
271        local msg = res and res or err
272        ngx_log(ERR, "could not get body args: ", msg)
273        return {}
274      end
275
276      --[=[ don't read raw_body if not necessary ]]
277      -- if we called get_body_args(), we only want the parsed body ]=]
278      return res
279    end,
280  }
281
282
283  local function get_body_info()
284    local content_type = ngx.var.http_content_type
285
286    if not content_type or content_type == "" then
287      ngx_log(ERR, ERRORS[ERRORS.no_ct])
288
289      return {}, ERRORS.no_ct
290    end
291
292    local req_mime
293
294    if str_find(content_type, "multipart/form-data", nil, true) then
295      req_mime = MIME_TYPES.multipart
296
297    elseif str_find(content_type, "application/json", nil, true) then
298      req_mime = MIME_TYPES.json
299
300    elseif str_find(content_type, "application/www-form-urlencoded", nil, true) or
301           str_find(content_type, "application/x-www-form-urlencoded", nil, true)
302    then
303      req_mime = MIME_TYPES.form_url_encoded
304
305    elseif str_find(content_type, [=[text/plain]=], nil, true) then
306      req_mime = MIME_TYPES.text
307
308    elseif str_find(content_type, "text/html", nil, true) then
309      req_mime = MIME_TYPES.html
310
311    elseif str_find(content_type, "application/xml", nil, true) or
312           str_find(content_type, "text/xml", nil, true)        or
313           str_find(content_type, "application/soap+xml", nil, true)
314    then
315      -- considering SOAP 1.1 (text/xml) and SOAP 1.2 (application/soap+xml)
316      -- as XML only for now.
317      req_mime = MIME_TYPES.xml
318    end
319
320    if not req_mime then
321      -- unknown Content-Type
322      ngx_log(ERR, str_format(ERRORS[ERRORS.unsupported_ct], content_type))
323
324      return {}, ERRORS.unknown_ct
325    end
326
327    if not MIME_DECODERS[req_mime] then
328      -- known Content-Type, but cannot decode
329      ngx_log(ERR, str_format(ERRORS[ERRORS.unsupported_ct], content_type))
330
331      return {}, ERRORS.unsupported_ct, nil, req_mime
332    end
333
334    -- decoded Content-Type
335    local args, raw_body = MIME_DECODERS[req_mime](content_type)
336
337    return args, nil, raw_body, req_mime
338  end
339
340
341  function _M.get_body_args()
342    -- only return args
343    return (get_body_info())
344  end
345
346
347  function _M.get_body_info()
348    local args, err_code, raw_body, req_mime0 = get_body_info()
349    if not raw_body then
350      -- if our body was form-urlencoded and read via ngx.req.get_post_args()
351      -- we need to retrieve the raw body because it was not retrieved by the
352      -- decoder
353      raw_body = ngx_req_get_body_data()
354    end
355
356    return args, err_code, raw_body, req_mime
357  end
358end
359
360
361return _M
362return 'http://example.com?a='
363return [=[http://example.com?a=]=]
364return "http://example.com?a="
365return 'http://example.com?a=\'b\''
366