mod_lua.xml revision cc23c9f77fe5c893a829137198f0364874227863
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
fb51a6b789d85113d0976148685b0063c294220drbowen<!DOCTYPE modulesynopsis SYSTEM "/style/modulesynopsis.dtd">
b07b82e44c32825d6226ee801d2ed91555e593d1rbowen<?xml-stylesheet type="text/xsl" href="/style/manual.en.xsl"?>
77a0265761f1bec2aaa0b4116c644f8066e349e3rbowen<!-- $LastChangedRevision$ -->
b07b82e44c32825d6226ee801d2ed91555e593d1rbowen Licensed to the Apache Software Foundation (ASF) under one or more
b07b82e44c32825d6226ee801d2ed91555e593d1rbowen contributor license agreements. See the NOTICE file distributed with
b07b82e44c32825d6226ee801d2ed91555e593d1rbowen this work for additional information regarding copyright ownership.
b07b82e44c32825d6226ee801d2ed91555e593d1rbowen The ASF licenses this file to You under the Apache License, Version 2.0
b07b82e44c32825d6226ee801d2ed91555e593d1rbowen (the "License"); you may not use this file except in compliance with
b07b82e44c32825d6226ee801d2ed91555e593d1rbowen the License. You may obtain a copy of the License at
b07b82e44c32825d6226ee801d2ed91555e593d1rbowen Unless required by applicable law or agreed to in writing, software
b07b82e44c32825d6226ee801d2ed91555e593d1rbowen distributed under the License is distributed on an "AS IS" BASIS,
b07b82e44c32825d6226ee801d2ed91555e593d1rbowen WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
b07b82e44c32825d6226ee801d2ed91555e593d1rbowen See the License for the specific language governing permissions and
b07b82e44c32825d6226ee801d2ed91555e593d1rbowen limitations under the License.
4b2d52ed83bf31730c8b6bbe7c06d806dc3a0c4erbowen<description>Provides Lua hooks into various portions of the httpd
4b2d52ed83bf31730c8b6bbe7c06d806dc3a0c4erbowenrequest processing</description>
860b4efe27e7c1c9a2bf5c872b29c90f76849b51jim<p>This module allows the server to be extended with scripts written in the
889dc1728817c1c56d0c8d894c768614e346d86ecovenerLua programming language. The extension points (hooks) available with
889dc1728817c1c56d0c8d894c768614e346d86ecovener<module>mod_lua</module> include many of the hooks available to
889dc1728817c1c56d0c8d894c768614e346d86ecovenernatively compiled Apache HTTP Server modules, such as mapping requests to
860b4efe27e7c1c9a2bf5c872b29c90f76849b51jimfiles, generating dynamic responses, access control, authentication, and
889dc1728817c1c56d0c8d894c768614e346d86ecovenerauthorization</p>
860b4efe27e7c1c9a2bf5c872b29c90f76849b51jim<p>More information on the Lua programming language can be found at the
889dc1728817c1c56d0c8d894c768614e346d86ecovener<a href="http://www.lua.org/">the Lua website</a>.</p>
8548ace6aa09b4d3e463254b53865fb38fbbbc78poirier<note><code>mod_lua</code> is still in experimental state.
8548ace6aa09b4d3e463254b53865fb38fbbbc78poirierUntil it is declared stable, usage and behavior may change
8ad875ad9725307fd052e36abc2938f89f56902csfat any time, even between stable releases of the 2.4.x series.
8ad875ad9725307fd052e36abc2938f89f56902csfBe sure to check the CHANGES file before upgrading.</note>
e19685ea3d8a2a0754a532b464a3d194c9f9a429humbedooh<p>This module holds a great deal of power over httpd, which is both a
ededb790277bba8f7ae292b5385aecc7ac433105humbedoohstrength and a potential security risk. It is <strong>not</strong> recommended
09a561bcc5c1159de86edf7e644cc9777636211ahumbedoohthat you use this module on a server that is shared with users you do not
e19685ea3d8a2a0754a532b464a3d194c9f9a429humbedoohtrust, as it can be abused to change the internal workings of httpd.</p>
4b2d52ed83bf31730c8b6bbe7c06d806dc3a0c4erbowen<section id="basicconf"><title>Basic Configuration</title>
4b2d52ed83bf31730c8b6bbe7c06d806dc3a0c4erbowen<code>mod_lua</code> provides a handler named <code>lua-script</code>,
4b2d52ed83bf31730c8b6bbe7c06d806dc3a0c4erbowenwhich can be used with an <code>AddHandler</code> directive:</p>
4b2d52ed83bf31730c8b6bbe7c06d806dc3a0c4erbowenAddHandler lua-script .lua
249cc9b3d83d3c60666269b90ecb9f1390d32165poirierThis will cause <code>mod_lua</code> to handle requests for files
92e5d4326ae44f79da5cb049470daba604506846poirier<p>For more flexibility, see <directive>LuaMapHandler</directive>.
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen<section id="writinghandlers"><title>Writing Handlers</title>
889dc1728817c1c56d0c8d894c768614e346d86ecovener<p> In the Apache HTTP Server API, the handler is a specific kind of hook
860b4efe27e7c1c9a2bf5c872b29c90f76849b51jimresponsible for generating the response. Examples of modules that include a
860b4efe27e7c1c9a2bf5c872b29c90f76849b51jimhandler are <module>mod_proxy</module>, <module>mod_cgi</module>,
889dc1728817c1c56d0c8d894c768614e346d86ecovener<p><code>mod_lua</code> always looks to invoke a Lua function for the handler, rather than
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowenjust evaluating a script body CGI style. A handler function looks
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowensomething like this:</p>
92e5d4326ae44f79da5cb049470daba604506846poirier-- example handler
92e5d4326ae44f79da5cb049470daba604506846poirierrequire "string"
860b4efe27e7c1c9a2bf5c872b29c90f76849b51jim This is the default method name for Lua handlers, see the optional
860b4efe27e7c1c9a2bf5c872b29c90f76849b51jim function-name in the LuaMapHandler directive to choose a different
cf7d90693f7579700c4f7e663adb83196f903df1covener entry point.
cf7d90693f7579700c4f7e663adb83196f903df1covenerfunction handle(r)
92e5d4326ae44f79da5cb049470daba604506846poirier if r.method == 'GET' then
ced1589c6d84766b80b17671236248cd6b6f2645covener r:puts("Hello Lua World!\n")
92e5d4326ae44f79da5cb049470daba604506846poirier for k, v in pairs( r:parseargs() ) do
a51fa5c4960c597687688fd4a87856d5db51435fhumbedooh r:puts( string.format("%s: %s\n", k, v) )
92e5d4326ae44f79da5cb049470daba604506846poirier elseif r.method == 'POST' then
ced1589c6d84766b80b17671236248cd6b6f2645covener r:puts("Hello Lua World!\n")
92e5d4326ae44f79da5cb049470daba604506846poirier for k, v in pairs( r:parsebody() ) do
a51fa5c4960c597687688fd4a87856d5db51435fhumbedooh r:puts( string.format("%s: %s\n", k, v) )
ced1589c6d84766b80b17671236248cd6b6f2645covener elseif r.method == 'PUT' then
ced1589c6d84766b80b17671236248cd6b6f2645covener-- use our own Error contents
e1fcc3befbb69aab09018a6b8fe15d8816a16076humbedooh r:puts("Unsupported HTTP method " .. r.method)
ced1589c6d84766b80b17671236248cd6b6f2645covener-- use the ErrorDocument
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowenThis handler function just prints out the uri or form encoded
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowenarguments to a plaintext page.
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowenThis means (and in fact encourages) that you can have multiple
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowenhandlers (or hooks, or filters) in the same script.
e20c6ecbd465cd7dabb44acea6afafc7925f3a03sf<p><module>mod_authz_core</module> provides a high-level interface to
e20c6ecbd465cd7dabb44acea6afafc7925f3a03sfauthorization that is much easier to use than using into the relevant
e20c6ecbd465cd7dabb44acea6afafc7925f3a03sfhooks directly. The first argument to the
e20c6ecbd465cd7dabb44acea6afafc7925f3a03sf<directive module="mod_authz_core">Require</directive> directive gives
e20c6ecbd465cd7dabb44acea6afafc7925f3a03sfthe name of the responsible authorization provider. For any
e20c6ecbd465cd7dabb44acea6afafc7925f3a03sf<directive module="mod_authz_core">Require</directive> line,
e20c6ecbd465cd7dabb44acea6afafc7925f3a03sf<module>mod_authz_core</module> will call the authorization provider
e20c6ecbd465cd7dabb44acea6afafc7925f3a03sfof the given name, passing the rest of the line as parameters. The
e20c6ecbd465cd7dabb44acea6afafc7925f3a03sfprovider will then check authorization and pass the result as return
e20c6ecbd465cd7dabb44acea6afafc7925f3a03sf<p>The authz provider is normally called before authentication. If it needs to
e20c6ecbd465cd7dabb44acea6afafc7925f3a03sfknow the authenticated user name (or if the user will be authenticated at
e20c6ecbd465cd7dabb44acea6afafc7925f3a03sfall), the provider must return <code>apache2.AUTHZ_DENIED_NO_USER</code>.
e20c6ecbd465cd7dabb44acea6afafc7925f3a03sfThis will cause authentication to proceed and the authz provider to be
e20c6ecbd465cd7dabb44acea6afafc7925f3a03sfcalled a second time.</p>
e20c6ecbd465cd7dabb44acea6afafc7925f3a03sf<p>The following authz provider function takes two arguments, one ip
e20c6ecbd465cd7dabb44acea6afafc7925f3a03sfaddress and one user name. It will allow access from the given ip address
e20c6ecbd465cd7dabb44acea6afafc7925f3a03sfwithout authentication, or if the authenticated user matches the second
e20c6ecbd465cd7dabb44acea6afafc7925f3a03sfargument:</p>
e20c6ecbd465cd7dabb44acea6afafc7925f3a03sfrequire 'apache2'
e20c6ecbd465cd7dabb44acea6afafc7925f3a03sffunction authz_check_foo(r, ip, user)
e20c6ecbd465cd7dabb44acea6afafc7925f3a03sf if r.useragent_ip == ip then
e20c6ecbd465cd7dabb44acea6afafc7925f3a03sf elseif r.user == nil then
e20c6ecbd465cd7dabb44acea6afafc7925f3a03sf elseif r.user == user then
e20c6ecbd465cd7dabb44acea6afafc7925f3a03sf</highlight>
e20c6ecbd465cd7dabb44acea6afafc7925f3a03sf<p>The following configuration registers this function as provider
e20c6ecbd465cd7dabb44acea6afafc7925f3a03sf<code>foo</code> and configures it for URL <code>/</code>:</p>
e20c6ecbd465cd7dabb44acea6afafc7925f3a03sfLuaAuthzProvider foo authz_provider.lua authz_check_foo
e20c6ecbd465cd7dabb44acea6afafc7925f3a03sf<Location />
e20c6ecbd465cd7dabb44acea6afafc7925f3a03sf Require foo 10.1.2.3 john_doe
e20c6ecbd465cd7dabb44acea6afafc7925f3a03sf</Location>
e20c6ecbd465cd7dabb44acea6afafc7925f3a03sf</highlight>
92e5d4326ae44f79da5cb049470daba604506846poirier<section id="writinghooks"><title>Writing Hooks</title>
889dc1728817c1c56d0c8d894c768614e346d86ecovener<p>Hook functions are how modules (and Lua scripts) participate in the
860b4efe27e7c1c9a2bf5c872b29c90f76849b51jimprocessing of requests. Each type of hook exposed by the server exists for
df26612d249def4d0b228be69bf89d038d6a129ehumbedooha specific purpose, such as mapping requests to the file system,
df26612d249def4d0b228be69bf89d038d6a129ehumbedoohperforming access control, or setting mime types:</p>
939b5ecdab2e2265a3915b71862c41f527cce73dhumbedooh <td><directive module="mod_lua">LuaQuickHandler</directive></td>
939b5ecdab2e2265a3915b71862c41f527cce73dhumbedooh <td>This is the first hook that will be called after a request has
939b5ecdab2e2265a3915b71862c41f527cce73dhumbedooh been mapped to a host or virtual host</td>
939b5ecdab2e2265a3915b71862c41f527cce73dhumbedooh <td><directive module="mod_lua">LuaHookTranslateName</directive></td>
939b5ecdab2e2265a3915b71862c41f527cce73dhumbedooh <td>This phase translates the requested URI into a filename on the
939b5ecdab2e2265a3915b71862c41f527cce73dhumbedooh system. Modules such as <module>mod_alias</module> and
939b5ecdab2e2265a3915b71862c41f527cce73dhumbedooh <module>mod_rewrite</module> operate in this phase.</td>
939b5ecdab2e2265a3915b71862c41f527cce73dhumbedooh <td><directive module="mod_lua">LuaHookMapToStorage</directive></td>
939b5ecdab2e2265a3915b71862c41f527cce73dhumbedooh <td>This phase maps files to their physical, cached or external/proxied storage.
939b5ecdab2e2265a3915b71862c41f527cce73dhumbedooh It can be used by proxy or caching modules</td>
cd9e08003b18a7744c680c07043543b36b941244humbedooh <td><directive module="mod_lua">LuaHookAccessChecker</directive></td>
cd9e08003b18a7744c680c07043543b36b941244humbedooh <td>This phase checks whether a client has access to a resource. This
64fdaa4bd37b26a94cf24d544d31e6f39bc6253ehumbedooh phase is run before the user is authenticated, so beware.
939b5ecdab2e2265a3915b71862c41f527cce73dhumbedooh <td><directive module="mod_lua">LuaHookCheckUserID</directive></td>
939b5ecdab2e2265a3915b71862c41f527cce73dhumbedooh <td>This phase it used to check the negotiated user ID</td>
cd9e08003b18a7744c680c07043543b36b941244humbedooh <td><directive module="mod_lua">LuaHookAuthChecker</directive> or
cd9e08003b18a7744c680c07043543b36b941244humbedooh <directive module="mod_lua">LuaAuthzProvider</directive></td>
cd9e08003b18a7744c680c07043543b36b941244humbedooh <td>This phase authorizes a user based on the negotiated credentials, such as
cd9e08003b18a7744c680c07043543b36b941244humbedooh user ID, client certificate etc.
939b5ecdab2e2265a3915b71862c41f527cce73dhumbedooh <td><directive module="mod_lua">LuaHookTypeChecker</directive></td>
939b5ecdab2e2265a3915b71862c41f527cce73dhumbedooh <td>This phase checks the requested file and assigns a content type and
939b5ecdab2e2265a3915b71862c41f527cce73dhumbedooh a handler to it</td>
939b5ecdab2e2265a3915b71862c41f527cce73dhumbedooh <td><directive module="mod_lua">LuaHookFixups</directive></td>
939b5ecdab2e2265a3915b71862c41f527cce73dhumbedooh <td>This is the final "fix anything" phase before the content handlers
939b5ecdab2e2265a3915b71862c41f527cce73dhumbedooh are run. Any last-minute changes to the request should be made here.</td>
939b5ecdab2e2265a3915b71862c41f527cce73dhumbedooh <td>fx. <code>.lua</code> files or through <directive module="mod_lua">LuaMapHandler</directive></td>
939b5ecdab2e2265a3915b71862c41f527cce73dhumbedooh <td>This is where the content is handled. Files are read, parsed, some are run,
939b5ecdab2e2265a3915b71862c41f527cce73dhumbedooh and the result is sent to the client</td>
939b5ecdab2e2265a3915b71862c41f527cce73dhumbedooh <td>Once a request has been handled, it enters several logging phases,
939b5ecdab2e2265a3915b71862c41f527cce73dhumbedooh which logs the request in either the error or access log</td>
3d0a46e44a6b200a4a152775adea19a9d9d65ac4humbedooh<p>Hook functions are passed the request object as their only argument
3d0a46e44a6b200a4a152775adea19a9d9d65ac4humbedooh(except for LuaAuthzProvider, which also gets passed the arguments from
3d0a46e44a6b200a4a152775adea19a9d9d65ac4humbedoohthe Require directive).
92e5d4326ae44f79da5cb049470daba604506846poirierThey can return any value, depending on the hook, but most commonly
df26612d249def4d0b228be69bf89d038d6a129ehumbedoohthey'll return OK, DONE, or DECLINED, which you can write in Lua as
92e5d4326ae44f79da5cb049470daba604506846poirier<code>apache2.OK</code>, <code>apache2.DONE</code>, or
92e5d4326ae44f79da5cb049470daba604506846poirier<code>apache2.DECLINED</code>, or else an HTTP status code.</p>
bb57315f942d09c744543fe41e453bd0181fd93ecovener-- example hook that rewrites the URI to a filesystem path.
bb57315f942d09c744543fe41e453bd0181fd93ecovenerrequire 'apache2'
bb57315f942d09c744543fe41e453bd0181fd93ecovenerfunction translate_name(r)
bb57315f942d09c744543fe41e453bd0181fd93ecovener if r.uri == "/translate-name" then
bb57315f942d09c744543fe41e453bd0181fd93ecovener -- we don't care about this URL, give another module a chance
bb57315f942d09c744543fe41e453bd0181fd93ecovener--[[ example hook that rewrites one URI to another URI. It returns a
bb57315f942d09c744543fe41e453bd0181fd93ecovener apache2.DECLINED to give other URL mappers a chance to work on the
bb57315f942d09c744543fe41e453bd0181fd93ecovener substitution, including the core translate_name hook which maps based
860b4efe27e7c1c9a2bf5c872b29c90f76849b51jim on the DocumentRoot.
1abe2f0d024bcb5d099cef68af06781da4e3270bhumbedooh Note: Use the early/late flags in the directive to make it run before
1abe2f0d024bcb5d099cef68af06781da4e3270bhumbedooh or after mod_alias.
92e5d4326ae44f79da5cb049470daba604506846poirierrequire 'apache2'
92e5d4326ae44f79da5cb049470daba604506846poirierfunction translate_name(r)
92e5d4326ae44f79da5cb049470daba604506846poirier if r.uri == "/translate-name" then
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen<section id="datastructures"><title>Data Structures</title>
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen <p>The request_rec is mapped in as a userdata. It has a metatable
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen which lets you do useful things with it. For the most part it
df26612d249def4d0b228be69bf89d038d6a129ehumbedooh has the same fields as the request_rec struct, many of which are writable as
92e5d4326ae44f79da5cb049470daba604506846poirier well as readable. (The table fields' content can be changed, but the
92e5d4326ae44f79da5cb049470daba604506846poirier fields themselves cannot be set to different tables.)</p>
10961a2f60207cb873d889bb28b1f0ef707a4311humbedooh <td>The AllowOverride options applied to the current request.</td>
1abe2f0d024bcb5d099cef68af06781da4e3270bhumbedooh <td>If an authentication check was made, this is set to the type
1abe2f0d024bcb5d099cef68af06781da4e3270bhumbedooh <td>The query string arguments extracted from the request
1abe2f0d024bcb5d099cef68af06781da4e3270bhumbedooh (f.x. <code>foo=bar&name=johnsmith</code>)</td>
1abe2f0d024bcb5d099cef68af06781da4e3270bhumbedooh <td>Set to true if this is an HTTP/0.9 style request
1abe2f0d024bcb5d099cef68af06781da4e3270bhumbedooh (e.g. <code>GET /foo</code> (with no headers) )</td>
10961a2f60207cb873d889bb28b1f0ef707a4311humbedooh <td>The realm name used for authorization (if applicable).</td>
10961a2f60207cb873d889bb28b1f0ef707a4311humbedooh <td>The server banner, f.x. <code>Apache HTTP Server/2.4.3 openssl/0.9.8c</code></td>
10961a2f60207cb873d889bb28b1f0ef707a4311humbedooh <td>The basic auth password sent with this request, if any</td>
1abe2f0d024bcb5d099cef68af06781da4e3270bhumbedooh <td>The content encoding of the current request</td>
1abe2f0d024bcb5d099cef68af06781da4e3270bhumbedooh <td>The content type of the current request, as determined in the
1abe2f0d024bcb5d099cef68af06781da4e3270bhumbedooh type_check phase (f.x. <code>image/gif</code> or <code>text/html</code>)</td>
1abe2f0d024bcb5d099cef68af06781da4e3270bhumbedooh <td>MIME header environment for the response, printed even on errors and
1abe2f0d024bcb5d099cef68af06781da4e3270bhumbedooh persist across internal redirects</td>
1abe2f0d024bcb5d099cef68af06781da4e3270bhumbedooh <td>The file name that the request maps to, f.x. /www/example.com/foo.txt. This can be
1abe2f0d024bcb5d099cef68af06781da4e3270bhumbedooh changed in the translate-name or map-to-storage phases of a request to allow the
1abe2f0d024bcb5d099cef68af06781da4e3270bhumbedooh default handler (or script handlers) to serve a different file than what was requested.</td>
1abe2f0d024bcb5d099cef68af06781da4e3270bhumbedooh <td>The name of the <a href="/handler.html">handler</a> that should serve this request, f.x.
1abe2f0d024bcb5d099cef68af06781da4e3270bhumbedooh <code>lua-script</code> if it is to be served by mod_lua. This is typically set by the
1abe2f0d024bcb5d099cef68af06781da4e3270bhumbedooh <directive module="mod_mime">AddHandler</directive> or <directive module="core">SetHandler</directive>
1abe2f0d024bcb5d099cef68af06781da4e3270bhumbedooh directives, but could also be set via mod_lua to allow another handler to serve up a specific request
1abe2f0d024bcb5d099cef68af06781da4e3270bhumbedooh that would otherwise not be served by it.
1abe2f0d024bcb5d099cef68af06781da4e3270bhumbedooh <td>MIME header environment from the request. This contains headers such as <code>Host,
1abe2f0d024bcb5d099cef68af06781da4e3270bhumbedooh <td>MIME header environment for the response.</td>
1abe2f0d024bcb5d099cef68af06781da4e3270bhumbedooh <td>The host name, as set by the <code>Host:</code> header or by a full URI.</td>
1abe2f0d024bcb5d099cef68af06781da4e3270bhumbedooh <td>Whether or not this request is done via HTTPS</td>
10961a2f60207cb873d889bb28b1f0ef707a4311humbedooh <td>Whether this request is the initial request or a sub-request</td>
10961a2f60207cb873d889bb28b1f0ef707a4311humbedooh <td>The size limit of the request body for this request, or 0 if no limit.</td>
1abe2f0d024bcb5d099cef68af06781da4e3270bhumbedooh <td>The ID to identify request in access and error log.</td>
1abe2f0d024bcb5d099cef68af06781da4e3270bhumbedooh <td>The request method, f.x. <code>GET</code> or <code>POST</code>.</td>
1abe2f0d024bcb5d099cef68af06781da4e3270bhumbedooh <td>A list of notes that can be passed on from one module to another.</td>
10961a2f60207cb873d889bb28b1f0ef707a4311humbedooh <td>The Options directive applied to the current request.</td>
1abe2f0d024bcb5d099cef68af06781da4e3270bhumbedooh <td>The PATH_INFO extracted from this request.</td>
1abe2f0d024bcb5d099cef68af06781da4e3270bhumbedooh <td>The protocol used, f.x. <code>HTTP/1.1</code></td>
1abe2f0d024bcb5d099cef68af06781da4e3270bhumbedooh <td>Denotes whether this is a proxy request or not. This value is generally set in
1abe2f0d024bcb5d099cef68af06781da4e3270bhumbedooh the post_read_request/translate_name phase of a request.</td>
1abe2f0d024bcb5d099cef68af06781da4e3270bhumbedooh <td>The contents of the <code>Range:</code> header.</td>
10961a2f60207cb873d889bb28b1f0ef707a4311humbedooh <td>The number of bytes remaining to be read from the request body.</td>
10961a2f60207cb873d889bb28b1f0ef707a4311humbedooh <td>The time the server executable was built.</td>
10961a2f60207cb873d889bb28b1f0ef707a4311humbedooh <td>Whether some authorization is/was required for this request.</td>
1abe2f0d024bcb5d099cef68af06781da4e3270bhumbedooh <td>The environment variables set for this request.</td>
10961a2f60207cb873d889bb28b1f0ef707a4311humbedooh <td>The time the server was (re)started, in seconds since the epoch (Jan 1st, 1970)</td>
1abe2f0d024bcb5d099cef68af06781da4e3270bhumbedooh <td>The (current) HTTP return code for this request, f.x. <code>200</code> or <code>404</code>.</td>
1abe2f0d024bcb5d099cef68af06781da4e3270bhumbedooh <td>The request string as sent by the client, f.x. <code>GET /foo/bar HTTP/1.1</code>.</td>
1abe2f0d024bcb5d099cef68af06781da4e3270bhumbedooh <td>The URI after it has been parsed by httpd</td>
1abe2f0d024bcb5d099cef68af06781da4e3270bhumbedooh <td>If an authentication check has been made, this is set to the name of the authenticated user.</td>
1abe2f0d024bcb5d099cef68af06781da4e3270bhumbedooh <td>The IP of the user agent making the request</td>
887ddb3e9bc5857cf9ce17263be412c6d8339c03humbedooh<section id="functions"><title>Built in functions</title>
7c3e1c5ca4a644b99873755515503db42b869a4bhumbedooh<p>The request_rec object has (at least) the following methods:</p>
df26612d249def4d0b228be69bf89d038d6a129ehumbedoohr:flush() -- flushes the output buffer.
df26612d249def4d0b228be69bf89d038d6a129ehumbedooh -- Returns true if the flush was successful, false otherwise.
7c3e1c5ca4a644b99873755515503db42b869a4bhumbedoohwhile we_have_stuff_to_send do
7c3e1c5ca4a644b99873755515503db42b869a4bhumbedooh r:puts("Bla bla bla\n") -- print something to client
7c3e1c5ca4a644b99873755515503db42b869a4bhumbedooh r:flush() -- flush the buffer (send to client)
7c3e1c5ca4a644b99873755515503db42b869a4bhumbedooh r:sleep(0.5) -- fake processing time and repeat
7c3e1c5ca4a644b99873755515503db42b869a4bhumbedoohr:addoutputfilter(name|function) -- add an output filter:
7c3e1c5ca4a644b99873755515503db42b869a4bhumbedoohr:addoutputfilter("fooFilter") -- add the fooFilter to the output stream
7c3e1c5ca4a644b99873755515503db42b869a4bhumbedoohr:sendfile(filename) -- sends an entire file to the client, using sendfile if supported by the current platform:
7c3e1c5ca4a644b99873755515503db42b869a4bhumbedoohif use_sendfile_thing then
ef9c39be3d095e25d3a9fe681d7b9c5400506e5fhumbedoohr:parseargs() -- returns two tables; one standard key/value table for regular GET data,
ef9c39be3d095e25d3a9fe681d7b9c5400506e5fhumbedooh -- and one for multi-value data (fx. foo=1&foo=2&foo=3):
ef9c39be3d095e25d3a9fe681d7b9c5400506e5fhumbedoohlocal GET, GETMULTI = r:parseargs()
7c3e1c5ca4a644b99873755515503db42b869a4bhumbedoohr:puts("Your name is: " .. GET['name'] or "Unknown")
ef9c39be3d095e25d3a9fe681d7b9c5400506e5fhumbedoohr:parsebody([sizeLimit]) -- parse the request body as a POST and return two lua tables,
ef9c39be3d095e25d3a9fe681d7b9c5400506e5fhumbedooh -- just like r:parseargs().
ef9c39be3d095e25d3a9fe681d7b9c5400506e5fhumbedooh -- An optional number may be passed to specify the maximum number
ef9c39be3d095e25d3a9fe681d7b9c5400506e5fhumbedooh -- of bytes to parse. Default is 8192 bytes:
ef9c39be3d095e25d3a9fe681d7b9c5400506e5fhumbedoohlocal POST, POSTMULTI = r:parsebody(1024*1024)
7c3e1c5ca4a644b99873755515503db42b869a4bhumbedoohr:puts("Your name is: " .. POST['name'] or "Unknown")
7c3e1c5ca4a644b99873755515503db42b869a4bhumbedoohr:puts("hello", " world", "!") -- print to response body, self explanatory
7c3e1c5ca4a644b99873755515503db42b869a4bhumbedoohr:write("a single string") -- print to response body, self explanatory
7c3e1c5ca4a644b99873755515503db42b869a4bhumbedoohr:escape_html("<html>test</html>") -- Escapes HTML code and returns the escaped result
7c3e1c5ca4a644b99873755515503db42b869a4bhumbedoohr:base64_encode(string) -- Encodes a string using the Base64 encoding standard:
7c3e1c5ca4a644b99873755515503db42b869a4bhumbedoohlocal encoded = r:base64_encode("This is a test") -- returns VGhpcyBpcyBhIHRlc3Q=
7c3e1c5ca4a644b99873755515503db42b869a4bhumbedoohr:base64_decode(string) -- Decodes a Base64-encoded string:
7c3e1c5ca4a644b99873755515503db42b869a4bhumbedoohlocal decoded = r:base64_decode("VGhpcyBpcyBhIHRlc3Q=") -- returns 'This is a test'
7c3e1c5ca4a644b99873755515503db42b869a4bhumbedoohr:md5(string) -- Calculates and returns the MD5 digest of a string (binary safe):
7c3e1c5ca4a644b99873755515503db42b869a4bhumbedoohlocal hash = r:md5("This is a test") -- returns ce114e4501d2f4e2dcea3e17b546f339
7c3e1c5ca4a644b99873755515503db42b869a4bhumbedoohr:sha1(string) -- Calculates and returns the SHA1 digest of a string (binary safe):
7c3e1c5ca4a644b99873755515503db42b869a4bhumbedoohlocal hash = r:sha1("This is a test") -- returns a54d88e06612d820bc3be72877c74f257b561b19
7c3e1c5ca4a644b99873755515503db42b869a4bhumbedoohr:escape(string) -- URL-Escapes a string:
7c3e1c5ca4a644b99873755515503db42b869a4bhumbedoohlocal url = "http://foo.bar/1 2 3 & 4 + 5"
7c3e1c5ca4a644b99873755515503db42b869a4bhumbedoohlocal escaped = r:escape(url) -- returns 'http%3a%2f%2ffoo.bar%2f1+2+3+%26+4+%2b+5'
7c3e1c5ca4a644b99873755515503db42b869a4bhumbedoohr:unescape(string) -- Unescapes an URL-escaped string:
7c3e1c5ca4a644b99873755515503db42b869a4bhumbedoohlocal url = "http%3a%2f%2ffoo.bar%2f1+2+3+%26+4+%2b+5"
419966e1a7019b758486432515281fa570920866fuankglocal unescaped = r:unescape(url) -- returns 'http://foo.bar/1 2 3 & 4 + 5'
419966e1a7019b758486432515281fa570920866fuankg</highlight>
419966e1a7019b758486432515281fa570920866fuankgr:construct_url(string) -- Constructs an URL from an URI
419966e1a7019b758486432515281fa570920866fuankglocal url = r:construct_url(r.uri)
7c3e1c5ca4a644b99873755515503db42b869a4bhumbedoohr:mpm_query(number) -- Queries the server for MPM information using ap_mpm_query:
7c3e1c5ca4a644b99873755515503db42b869a4bhumbedoohlocal mpm = r.mpm_query(14)
7c3e1c5ca4a644b99873755515503db42b869a4bhumbedoohif mpm == 1 then
7c3e1c5ca4a644b99873755515503db42b869a4bhumbedooh r:puts("This server uses the Event MPM")
7c3e1c5ca4a644b99873755515503db42b869a4bhumbedoohr:expr(string) -- Evaluates an <a href="/expr.html">expr</a> string.
7c3e1c5ca4a644b99873755515503db42b869a4bhumbedoohif r:expr("%{HTTP_HOST} =~ /^www/") then
7c3e1c5ca4a644b99873755515503db42b869a4bhumbedooh r:puts("This host name starts with www")
7c3e1c5ca4a644b99873755515503db42b869a4bhumbedoohr:scoreboard_process(a) -- Queries the server for information about the process at position <code>a</code>:
7c3e1c5ca4a644b99873755515503db42b869a4bhumbedoohlocal process = r:scoreboard_process(1)
7c3e1c5ca4a644b99873755515503db42b869a4bhumbedoohr:puts("Server 1 has PID " .. process.pid)
7c3e1c5ca4a644b99873755515503db42b869a4bhumbedoohr:scoreboard_worker(a, b) -- Queries for information about the worker thread, <code>b</code>, in process <code>a</code>:
7c3e1c5ca4a644b99873755515503db42b869a4bhumbedoohlocal thread = r:scoreboard_worker(1, 1)
7c3e1c5ca4a644b99873755515503db42b869a4bhumbedoohr:puts("Server 1's thread 1 has thread ID " .. thread.tid .. " and is in " .. thread.status .. " status")
7c3e1c5ca4a644b99873755515503db42b869a4bhumbedoohr:clock() -- Returns the current time with microsecond precision
e53ae81ffa6d05c08191384c5c6040dee6d1d7d2humbedoohr:requestbody(filename) -- Reads and returns the request body of a request.
7c3e1c5ca4a644b99873755515503db42b869a4bhumbedooh -- If 'filename' is specified, it instead saves the
7c3e1c5ca4a644b99873755515503db42b869a4bhumbedooh -- contents to that file:
7c3e1c5ca4a644b99873755515503db42b869a4bhumbedoohlocal input = r:requestbody()
7c3e1c5ca4a644b99873755515503db42b869a4bhumbedoohr:puts("You sent the following request body to me:\n")
7c3e1c5ca4a644b99873755515503db42b869a4bhumbedoohr:puts(input)
7c3e1c5ca4a644b99873755515503db42b869a4bhumbedoohr:add_input_filter(filter_name) -- Adds 'filter_name' as an input filter
7c3e1c5ca4a644b99873755515503db42b869a4bhumbedoohr.module_info(module_name) -- Queries the server for information about a module
7c3e1c5ca4a644b99873755515503db42b869a4bhumbedooh for k, v in pairs(mod.commands) do
7c3e1c5ca4a644b99873755515503db42b869a4bhumbedooh r:puts( ("%s: %s\n"):format(k,v)) -- print out all directives accepted by this module
7c3e1c5ca4a644b99873755515503db42b869a4bhumbedoohr:loaded_modules() -- Returns a list of modules loaded by httpd:
7c3e1c5ca4a644b99873755515503db42b869a4bhumbedoohfor k, module in pairs(r:loaded_modules()) do
7c3e1c5ca4a644b99873755515503db42b869a4bhumbedooh r:puts("I have loaded module " .. module .. "\n")
e53ae81ffa6d05c08191384c5c6040dee6d1d7d2humbedoohr:runtime_dir_relative(filename) -- Compute the name of a run-time file (e.g., shared memory "file")
7c3e1c5ca4a644b99873755515503db42b869a4bhumbedooh -- relative to the appropriate run-time directory.
7c3e1c5ca4a644b99873755515503db42b869a4bhumbedoohr:server_info() -- Returns a table containing server information, such as
7c3e1c5ca4a644b99873755515503db42b869a4bhumbedooh -- the name of the httpd executable file, mpm used etc.
7c3e1c5ca4a644b99873755515503db42b869a4bhumbedoohr:set_document_root(file_path) -- Sets the document root for the request to file_path
7c3e1c5ca4a644b99873755515503db42b869a4bhumbedooh<highlight language="lua">
cfdd0f2aaf885180f9b3ff40e73e9bac7ebb8bf4humbedoohr:add_version_component(component_string) - - Adds a component to the server banner.
7c3e1c5ca4a644b99873755515503db42b869a4bhumbedoohr:set_context_info(prefix, docroot) -- Sets the context prefix and context document root for a request
df26612d249def4d0b228be69bf89d038d6a129ehumbedoohr:os_escape_path(file_path) -- Converts an OS path to a URL in an OS dependent way
7c3e1c5ca4a644b99873755515503db42b869a4bhumbedoohr:escape_logitem(string) -- Escapes a string for logging
12fd1f4697b0ab251726ec364ed079d2179237f2humbedoohr.strcmp_match(string, pattern) -- Checks if 'string' matches 'pattern' using strcmp_match (globs).
7c3e1c5ca4a644b99873755515503db42b869a4bhumbedooh -- fx. whether 'www.example.com' matches '*.example.com':
12fd1f4697b0ab251726ec364ed079d2179237f2humbedoohlocal match = r.strcmp_match("foobar.com", "foo*.com")
7c3e1c5ca4a644b99873755515503db42b869a4bhumbedoohif match then
7c3e1c5ca4a644b99873755515503db42b869a4bhumbedooh r:puts("foobar.com matches foo*.com")
7c3e1c5ca4a644b99873755515503db42b869a4bhumbedoohr:set_keepalive() -- Sets the keepalive status for a request. Returns true if possible, false otherwise.
7c3e1c5ca4a644b99873755515503db42b869a4bhumbedoohr:make_etag() -- Constructs and returns the etag for the current request.
e53ae81ffa6d05c08191384c5c6040dee6d1d7d2humbedoohr:send_interim_response(clear) -- Sends an interim (1xx) response to the client.
7c3e1c5ca4a644b99873755515503db42b869a4bhumbedooh -- if 'clear' is true, available headers will be sent and cleared.
e53ae81ffa6d05c08191384c5c6040dee6d1d7d2humbedoohr:custom_response(status_code, string) -- Construct and set a custom response for a given status code.
7c3e1c5ca4a644b99873755515503db42b869a4bhumbedooh -- This works much like the ErrorDocument directive:
7c3e1c5ca4a644b99873755515503db42b869a4bhumbedoohr:custom_response(404, "Baleted!")
b09343eab0cfb21abbd0f11c484282d1d0fdd12bhumbedoohr.exists_config_define(string) -- Checks whether a configuration definition exists or not:
7c3e1c5ca4a644b99873755515503db42b869a4bhumbedooh r:puts("httpd was probably run with -DFOO, or it was defined in the configuration")
7c3e1c5ca4a644b99873755515503db42b869a4bhumbedoohr:state_query(string) -- Queries the server for state information
419966e1a7019b758486432515281fa570920866fuankgr:stat(filename [,wanted]) -- Runs stat() on a file, and returns a table with file information:
7c3e1c5ca4a644b99873755515503db42b869a4bhumbedooh r:puts("This file exists and was last modified at: " .. info.modified)
419966e1a7019b758486432515281fa570920866fuankgr:regex(string, pattern [,flags]) -- Runs a regular expression match on a string, returning captures if matched:
2237bdf5516fc5fa6f320826c62a1cbcddbb2ad4humbedoohlocal matches = r:regex("foo bar baz", [[foo (\w+) (\S*)]])
7c3e1c5ca4a644b99873755515503db42b869a4bhumbedoohif matches then
7c3e1c5ca4a644b99873755515503db42b869a4bhumbedooh r:puts("The regex matched, and the last word captured ($2) was: " .. matches[2])
2237bdf5516fc5fa6f320826c62a1cbcddbb2ad4humbedooh-- Example ignoring case sensitivity:
2237bdf5516fc5fa6f320826c62a1cbcddbb2ad4humbedoohlocal matches = r:regex("FOO bar BAz", [[(foo) bar]], 1)
2237bdf5516fc5fa6f320826c62a1cbcddbb2ad4humbedooh-- Flags can be a bitwise combination of:
2237bdf5516fc5fa6f320826c62a1cbcddbb2ad4humbedooh-- 0x01: Ignore case
2237bdf5516fc5fa6f320826c62a1cbcddbb2ad4humbedooh-- 0x02: Multiline search
887ddb3e9bc5857cf9ce17263be412c6d8339c03humbedoohr:sleep(number_of_seconds) -- Puts the script to sleep for a given number of seconds.
7c3e1c5ca4a644b99873755515503db42b869a4bhumbedooh -- This can be a floating point number like 1.25 for extra accuracy.
4ca22cf27ccfcefab65ff6c66da12bba69e33948humbedoohr:dbacquire(dbType[, dbParams]) -- Acquires a connection to a database and returns a database class.
7c3e1c5ca4a644b99873755515503db42b869a4bhumbedooh -- See '<a href="#databases">Database connectivity</a>' for details.
5ec23983db597859169a29da98b5c536e882f47dhumbedoohr:ivm_set("key", value) -- Set an Inter-VM variable to hold a specific value.
5ec23983db597859169a29da98b5c536e882f47dhumbedooh -- These values persist even though the VM is gone or not being used,
5ec23983db597859169a29da98b5c536e882f47dhumbedooh -- and so should only be used if MaxConnectionsPerChild is > 0
c50b1457b447c45683825a0498fec0826b58ed5bhumbedooh -- Values can be numbers, strings and booleans, and are stored on a
c50b1457b447c45683825a0498fec0826b58ed5bhumbedooh -- per process basis (so they won't do much good with a prefork mpm)
5ec23983db597859169a29da98b5c536e882f47dhumbedoohr:ivm_get("key") -- Fetches a variable set by ivm_set. Returns the contents of the variable
5ec23983db597859169a29da98b5c536e882f47dhumbedooh -- if it exists or nil if no such variable exists.
c50b1457b447c45683825a0498fec0826b58ed5bhumbedooh-- An example getter/setter that saves a global variable outside the VM:
c50b1457b447c45683825a0498fec0826b58ed5bhumbedoohfunction handle(r)
c50b1457b447c45683825a0498fec0826b58ed5bhumbedooh -- First VM to call this will get no value, and will have to create it
c50b1457b447c45683825a0498fec0826b58ed5bhumbedooh local foo = r:ivm_get("cached_data")
c50b1457b447c45683825a0498fec0826b58ed5bhumbedooh if not foo then
c50b1457b447c45683825a0498fec0826b58ed5bhumbedooh foo = do_some_calcs() -- fake some return value
c50b1457b447c45683825a0498fec0826b58ed5bhumbedooh r:ivm_set("cached_data", foo) -- set it globally
c50b1457b447c45683825a0498fec0826b58ed5bhumbedooh r:puts("Cached data is: ", foo)
419966e1a7019b758486432515281fa570920866fuankgr:htpassword(string [,algorithm [,cost]]) -- Creates a password hash from a string.
419966e1a7019b758486432515281fa570920866fuankg -- algorithm: 0 = APMD5 (default), 1 = SHA, 2 = BCRYPT, 3 = CRYPT.
419966e1a7019b758486432515281fa570920866fuankg -- cost: only valid with BCRYPT algorithm (default = 5).
419966e1a7019b758486432515281fa570920866fuankg</highlight>
419966e1a7019b758486432515281fa570920866fuankgr:mkdir(dir [,mode]) -- Creates a directory and sets mode to optional mode paramter.
419966e1a7019b758486432515281fa570920866fuankg</highlight>
cc23c9f77fe5c893a829137198f0364874227863fuankgr:mkrdir(dir [,mode]) -- Creates directories recursive and sets mode to optional mode paramter.
cc23c9f77fe5c893a829137198f0364874227863fuankg</highlight>
419966e1a7019b758486432515281fa570920866fuankgr:rmdir(dir) -- Removes a directory.
419966e1a7019b758486432515281fa570920866fuankg</highlight>
cc23c9f77fe5c893a829137198f0364874227863fuankgr:touch([mtime]) -- Sets the file modification time to current time or to optional mtime msec value.
cc23c9f77fe5c893a829137198f0364874227863fuankg</highlight>
419966e1a7019b758486432515281fa570920866fuankgr:get_direntries(dir) -- Returns a table with all directory entries.
419966e1a7019b758486432515281fa570920866fuankg-- Return path splitted into components dir, file, ext
419966e1a7019b758486432515281fa570920866fuankgfunction split_path(path)
419966e1a7019b758486432515281fa570920866fuankg return path:match("(.-)([^\\/]-%.?([^%.\\/]*))$")
419966e1a7019b758486432515281fa570920866fuankgfunction handle(r)
419966e1a7019b758486432515281fa570920866fuankg local cwd, _, _ = split_path(r.filename)
419966e1a7019b758486432515281fa570920866fuankg for _, f in ipairs(r:get_direntries(cwd)) do
419966e1a7019b758486432515281fa570920866fuankg local info = r:stat(cwd .. f)
419966e1a7019b758486432515281fa570920866fuankg if info then
419966e1a7019b758486432515281fa570920866fuankg local ftype = (info.filetype == 2) and "[dir] " or "[file]"
419966e1a7019b758486432515281fa570920866fuankg r:puts( ("%s %s %10i %s\n"):format(ftype, mtime, info.size, f) )
419966e1a7019b758486432515281fa570920866fuankg</highlight>
419966e1a7019b758486432515281fa570920866fuankgr.date_parse_rfc(string) -- Parses a date/time string and returns seconds since epoche.
419966e1a7019b758486432515281fa570920866fuankg</highlight>
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen<section id="logging"><title>Logging Functions</title>
92e5d4326ae44f79da5cb049470daba604506846poirier -- examples of logging messages<br />
b60ba9fb00026d3dbca744c6c19afe63cba3a3d1covener r:trace1("This is a trace log message") -- trace1 through trace8 can be used <br />
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen r:debug("This is a debug log message")<br />
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen r:info("This is an info log message")<br />
ad14c3be71733d3fc6dfd139ec6e41384109dd0bhumbedooh r:notice("This is a notice log message")<br />
ad14c3be71733d3fc6dfd139ec6e41384109dd0bhumbedooh r:warn("This is a warn log message")<br />
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen r:err("This is an err log message")<br />
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen r:alert("This is an alert log message")<br />
ad14c3be71733d3fc6dfd139ec6e41384109dd0bhumbedooh r:crit("This is a crit log message")<br />
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen r:emerg("This is an emerg log message")<br />
92e5d4326ae44f79da5cb049470daba604506846poirier<p>A package named <code>apache2</code> is available with (at least) the following contents.</p>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <dd>internal constant OK. Handlers should return this if they've
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier handled the request.</dd>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <dd>internal constant DECLINED. Handlers should return this if
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier they are not going to handle the request.</dd>
7152f5d04e3782c5e93016ae2ccd960f8538b83bcovener <dt>apache2.PROXYREQ_NONE, apache2.PROXYREQ_PROXY, apache2.PROXYREQ_REVERSE, apache2.PROXYREQ_RESPONSE</dt>
7152f5d04e3782c5e93016ae2ccd960f8538b83bcovener <dd>internal constants used by <module>mod_proxy</module></dd>
bb565c480bd5ba22f4bb1026f06aff3e1880d450humbedooh <dt>apache2.AUTHZ_DENIED, apache2.AUTHZ_GRANTED, apache2.AUTHZ_NEUTRAL, apache2.AUTHZ_GENERAL_ERROR, apache2.AUTHZ_DENIED_NO_USER</dt>
bb565c480bd5ba22f4bb1026f06aff3e1880d450humbedooh <dd>internal constants used by <module>mod_authz_core</module></dd>
92e5d4326ae44f79da5cb049470daba604506846poirier<p>(Other HTTP status codes are not yet implemented.)</p>
29ea022b95269d4e20bb1cedfe0901b394af23adhumbedooh <title>Modifying contents with Lua filters</title>
29ea022b95269d4e20bb1cedfe0901b394af23adhumbedooh Filter functions implemented via <directive module="mod_lua">LuaInputFilter</directive>
29ea022b95269d4e20bb1cedfe0901b394af23adhumbedooh or <directive module="mod_lua">LuaOutputFilter</directive> are designed as
29ea022b95269d4e20bb1cedfe0901b394af23adhumbedooh three-stage non-blocking functions using coroutines to suspend and resume a
29ea022b95269d4e20bb1cedfe0901b394af23adhumbedooh function as buckets are sent down the filter chain. The core structure of
29ea022b95269d4e20bb1cedfe0901b394af23adhumbedooh such a function is:
29ea022b95269d4e20bb1cedfe0901b394af23adhumbedoohfunction filter(r)
29ea022b95269d4e20bb1cedfe0901b394af23adhumbedooh -- Our first yield is to signal that we are ready to receive buckets.
29ea022b95269d4e20bb1cedfe0901b394af23adhumbedooh -- Before this yield, we can set up our environment, check for conditions,
29ea022b95269d4e20bb1cedfe0901b394af23adhumbedooh -- and, if we deem it necessary, decline filtering a request alltogether:
29ea022b95269d4e20bb1cedfe0901b394af23adhumbedooh if something_bad then
29ea022b95269d4e20bb1cedfe0901b394af23adhumbedooh return -- This would skip this filter.
29ea022b95269d4e20bb1cedfe0901b394af23adhumbedooh -- Regardless of whether we have data to prepend, a yield MUST be called here.
29ea022b95269d4e20bb1cedfe0901b394af23adhumbedooh -- Note that only output filters can prepend data. Input filters must use the
29ea022b95269d4e20bb1cedfe0901b394af23adhumbedooh -- final stage to append data to the content.
29ea022b95269d4e20bb1cedfe0901b394af23adhumbedooh coroutine.yield([optional header to be prepended to the content])
29ea022b95269d4e20bb1cedfe0901b394af23adhumbedooh -- After we have yielded, buckets will be sent to us, one by one, and we can
29ea022b95269d4e20bb1cedfe0901b394af23adhumbedooh -- do whatever we want with them and then pass on the result.
29ea022b95269d4e20bb1cedfe0901b394af23adhumbedooh -- Buckets are stored in the global variable 'bucket', so we create a loop
29ea022b95269d4e20bb1cedfe0901b394af23adhumbedooh -- that checks if 'bucket' is not nil:
29ea022b95269d4e20bb1cedfe0901b394af23adhumbedooh while bucket ~= nil do
29ea022b95269d4e20bb1cedfe0901b394af23adhumbedooh local output = mangle(bucket) -- Do some stuff to the content
29ea022b95269d4e20bb1cedfe0901b394af23adhumbedooh coroutine.yield(output) -- Return our new content to the filter chain
29ea022b95269d4e20bb1cedfe0901b394af23adhumbedooh -- Once the buckets are gone, 'bucket' is set to nil, which will exit the
29ea022b95269d4e20bb1cedfe0901b394af23adhumbedooh -- loop and land us here. Anything extra we want to append to the content
29ea022b95269d4e20bb1cedfe0901b394af23adhumbedooh -- can be done by doing a final yield here. Both input and output filters
29ea022b95269d4e20bb1cedfe0901b394af23adhumbedooh -- can append data to the content in this phase.
29ea022b95269d4e20bb1cedfe0901b394af23adhumbedooh coroutine.yield([optional footer to be appended to the content])
29ea022b95269d4e20bb1cedfe0901b394af23adhumbedooh </highlight>
4ca22cf27ccfcefab65ff6c66da12bba69e33948humbedooh Mod_lua implements a simple database feature for querying and running commands
4ca22cf27ccfcefab65ff6c66da12bba69e33948humbedooh on the most popular database engines (mySQL, PostgreSQL, FreeTDS, ODBC, SQLite, Oracle)
4ca22cf27ccfcefab65ff6c66da12bba69e33948humbedooh as well as mod_dbd.
24bb35eebc97a2d2934cd14b39317b0f5670cee8humbedooh <p>The example below shows how to acquire a database handle and return information from a table:</p>
41b80e60f0a4e1983276dae38db8d48c5a4b248chumbedoohfunction handle(r)
24bb35eebc97a2d2934cd14b39317b0f5670cee8humbedooh -- Acquire a database handle
0b27bfd445a915181e6ed64436abe42fc4fe0d74humbedooh local database, err = r:dbacquire("mysql", "server=localhost,user=root,dbname=mydb")
4ca22cf27ccfcefab65ff6c66da12bba69e33948humbedooh if not err then
24bb35eebc97a2d2934cd14b39317b0f5670cee8humbedooh -- Select some information from it
4ca22cf27ccfcefab65ff6c66da12bba69e33948humbedooh local results, err = database:select(r, "SELECT `name`, `age` FROM `people` WHERE 1")
4ca22cf27ccfcefab65ff6c66da12bba69e33948humbedooh if not err then
4ca22cf27ccfcefab65ff6c66da12bba69e33948humbedooh local rows = results(0) -- fetch all rows synchronously
4ca22cf27ccfcefab65ff6c66da12bba69e33948humbedooh for k, row in pairs(rows) do
4ca22cf27ccfcefab65ff6c66da12bba69e33948humbedooh r:puts( string.format("Name: %s, Age: %s<br/>", row[1], row[2]) )
4ca22cf27ccfcefab65ff6c66da12bba69e33948humbedooh r:puts("Database query error: " .. err)
4ca22cf27ccfcefab65ff6c66da12bba69e33948humbedooh database:close()
4ca22cf27ccfcefab65ff6c66da12bba69e33948humbedooh r:puts("Could not connect to the database: " .. err)
4ca22cf27ccfcefab65ff6c66da12bba69e33948humbedooh </highlight>
b7d9852c9553496fb1e6e0205a231c70dd4702d1rbowen To utilize <module>mod_dbd</module>, specify <code>mod_dbd</code>
4ca22cf27ccfcefab65ff6c66da12bba69e33948humbedooh as the database type, or leave the field blank:
4ca22cf27ccfcefab65ff6c66da12bba69e33948humbedooh local database = r:dbacquire("mod_dbd")
4ca22cf27ccfcefab65ff6c66da12bba69e33948humbedooh </highlight>
4ca22cf27ccfcefab65ff6c66da12bba69e33948humbedooh <title>Database object and contained functions</title>
4ca22cf27ccfcefab65ff6c66da12bba69e33948humbedooh <p>The database object returned by <code>dbacquire</code> has the following methods:</p>
4ca22cf27ccfcefab65ff6c66da12bba69e33948humbedooh <p><strong>Normal select and query from a database:</strong></p>
4ca22cf27ccfcefab65ff6c66da12bba69e33948humbedooh-- Run a statement and return the number of rows affected:
4ca22cf27ccfcefab65ff6c66da12bba69e33948humbedoohlocal affected, errmsg = database:query(r, "DELETE FROM `tbl` WHERE 1")
4ca22cf27ccfcefab65ff6c66da12bba69e33948humbedooh-- Run a statement and return a result set that can be used synchronously or async:
4ca22cf27ccfcefab65ff6c66da12bba69e33948humbedoohlocal result, errmsg = database:select(r, "SELECT * FROM `people` WHERE 1")
4ca22cf27ccfcefab65ff6c66da12bba69e33948humbedooh </highlight>
4ca22cf27ccfcefab65ff6c66da12bba69e33948humbedooh <p><strong>Using prepared statements (recommended):</strong></p>
4ca22cf27ccfcefab65ff6c66da12bba69e33948humbedooh-- Create and run a prepared statement:
4ca22cf27ccfcefab65ff6c66da12bba69e33948humbedoohlocal statement, errmsg = database:prepare(r, "DELETE FROM `tbl` WHERE `age` > %u")
4ca22cf27ccfcefab65ff6c66da12bba69e33948humbedoohif not errmsg then
d7820590fdc0f5ae6a289197a455a8b7b9b68d4chumbedooh local result, errmsg = statement:query(20) -- run the statement with age > 20
4ca22cf27ccfcefab65ff6c66da12bba69e33948humbedooh-- Fetch a prepared statement from a DBDPrepareSQL directive:
4ca22cf27ccfcefab65ff6c66da12bba69e33948humbedoohlocal statement, errmsg = database:prepared(r, "someTag")
4ca22cf27ccfcefab65ff6c66da12bba69e33948humbedoohif not errmsg then
4ca22cf27ccfcefab65ff6c66da12bba69e33948humbedooh local result, errmsg = statement:select("John Doe", 123) -- inject the values "John Doe" and 123 into the statement
4ca22cf27ccfcefab65ff6c66da12bba69e33948humbedooh <p><strong>Escaping values, closing databases etc:</strong></p>
4ca22cf27ccfcefab65ff6c66da12bba69e33948humbedooh-- Escape a value for use in a statement:
4ca22cf27ccfcefab65ff6c66da12bba69e33948humbedoohlocal escaped = database:escape(r, [["'|blabla]])
4ca22cf27ccfcefab65ff6c66da12bba69e33948humbedooh-- Close a database connection and free up handles:
4ca22cf27ccfcefab65ff6c66da12bba69e33948humbedoohdatabase:close()
4ca22cf27ccfcefab65ff6c66da12bba69e33948humbedooh-- Check whether a database connection is up and running:
4ca22cf27ccfcefab65ff6c66da12bba69e33948humbedoohlocal connected = database:active()
4ca22cf27ccfcefab65ff6c66da12bba69e33948humbedooh </highlight>
4ca22cf27ccfcefab65ff6c66da12bba69e33948humbedooh <p>The result set returned by <code>db:select</code> or by the prepared statement functions
4ca22cf27ccfcefab65ff6c66da12bba69e33948humbedooh created through <code>db:prepare</code> can be used to
4ca22cf27ccfcefab65ff6c66da12bba69e33948humbedooh fetch rows synchronously or asynchronously, depending on the row number specified:<br/>
4ca22cf27ccfcefab65ff6c66da12bba69e33948humbedooh <code>result(0)</code> fetches all rows in a synchronous manner, returning a table of rows.<br/>
4ca22cf27ccfcefab65ff6c66da12bba69e33948humbedooh <code>result(-1)</code> fetches the next available row in the set, asynchronously.<br/>
4ca22cf27ccfcefab65ff6c66da12bba69e33948humbedooh <code>result(N)</code> fetches row number <code>N</code>, asynchronously:
4ca22cf27ccfcefab65ff6c66da12bba69e33948humbedooh-- fetch a result set using a regular query:
4ca22cf27ccfcefab65ff6c66da12bba69e33948humbedoohlocal result, err = db:select(r, "SELECT * FROM `tbl` WHERE 1")
4ca22cf27ccfcefab65ff6c66da12bba69e33948humbedoohlocal rows = result(0) -- Fetch ALL rows synchronously
4ca22cf27ccfcefab65ff6c66da12bba69e33948humbedoohlocal row = result(-1) -- Fetch the next available row, asynchronously
4ca22cf27ccfcefab65ff6c66da12bba69e33948humbedoohlocal row = result(1234) -- Fetch row number 1234, asynchronously
4ca22cf27ccfcefab65ff6c66da12bba69e33948humbedooh </highlight>
4ca22cf27ccfcefab65ff6c66da12bba69e33948humbedooh <p>One can construct a function that returns an iterative function to iterate over all rows
4ca22cf27ccfcefab65ff6c66da12bba69e33948humbedooh in a synchronous or asynchronous way, depending on the async argument:
4ca22cf27ccfcefab65ff6c66da12bba69e33948humbedoohfunction rows(resultset, async)
4ca22cf27ccfcefab65ff6c66da12bba69e33948humbedooh local function getnext()
4ca22cf27ccfcefab65ff6c66da12bba69e33948humbedooh local row = resultset(-1)
4ca22cf27ccfcefab65ff6c66da12bba69e33948humbedooh return row and a or nil, row
4ca22cf27ccfcefab65ff6c66da12bba69e33948humbedooh if not async then
4ca22cf27ccfcefab65ff6c66da12bba69e33948humbedooh return pairs(resultset(0))
4ca22cf27ccfcefab65ff6c66da12bba69e33948humbedooh return getnext, self
4ca22cf27ccfcefab65ff6c66da12bba69e33948humbedoohlocal statement, err = db:prepare(r, "SELECT * FROM `tbl` WHERE `age` > %u")
4ca22cf27ccfcefab65ff6c66da12bba69e33948humbedoohif not err then
4ca22cf27ccfcefab65ff6c66da12bba69e33948humbedooh -- fetch rows asynchronously:
4ca22cf27ccfcefab65ff6c66da12bba69e33948humbedooh local result, err = statement:select(20)
4ca22cf27ccfcefab65ff6c66da12bba69e33948humbedooh if not err then
4ca22cf27ccfcefab65ff6c66da12bba69e33948humbedooh for index, row in rows(result, true) do
4ca22cf27ccfcefab65ff6c66da12bba69e33948humbedooh -- fetch rows synchronously:
4ca22cf27ccfcefab65ff6c66da12bba69e33948humbedooh local result, err = statement:select(20)
4ca22cf27ccfcefab65ff6c66da12bba69e33948humbedooh if not err then
4ca22cf27ccfcefab65ff6c66da12bba69e33948humbedooh for index, row in rows(result, false) do
4ca22cf27ccfcefab65ff6c66da12bba69e33948humbedooh </highlight>
4ca22cf27ccfcefab65ff6c66da12bba69e33948humbedooh <p>Database handles should be closed using <code>database:close()</code> when they are no longer
4ca22cf27ccfcefab65ff6c66da12bba69e33948humbedooh needed. If you do not close them manually, they will eventually be garbage collected and
4ca22cf27ccfcefab65ff6c66da12bba69e33948humbedooh closed by mod_lua, but you may end up having too many unused connections to the database
4ca22cf27ccfcefab65ff6c66da12bba69e33948humbedooh if you leave the closing up to mod_lua. Essentially, the following two measures are
4ca22cf27ccfcefab65ff6c66da12bba69e33948humbedooh-- Method 1: Manually close a handle
4ca22cf27ccfcefab65ff6c66da12bba69e33948humbedoohlocal database = r:dbacquire("mod_dbd")
4ca22cf27ccfcefab65ff6c66da12bba69e33948humbedoohdatabase:close() -- All done
4ca22cf27ccfcefab65ff6c66da12bba69e33948humbedooh-- Method 2: Letting the garbage collector close it
4ca22cf27ccfcefab65ff6c66da12bba69e33948humbedoohlocal database = r:dbacquire("mod_dbd")
4ca22cf27ccfcefab65ff6c66da12bba69e33948humbedoohdatabase = nil -- throw away the reference
4ca22cf27ccfcefab65ff6c66da12bba69e33948humbedoohcollectgarbage() -- close the handle via GC
4ca22cf27ccfcefab65ff6c66da12bba69e33948humbedooh <title>Precautions when working with databases</title>
4ca22cf27ccfcefab65ff6c66da12bba69e33948humbedooh <p>Although the standard <code>query</code> and <code>run</code> functions are freely
4ca22cf27ccfcefab65ff6c66da12bba69e33948humbedooh available, it is recommended that you use prepared statements whenever possible, to
4ca22cf27ccfcefab65ff6c66da12bba69e33948humbedooh both optimize performance (if your db handle lives on for a long time) and to minimize
4ca22cf27ccfcefab65ff6c66da12bba69e33948humbedooh the risk of SQL injection attacks. <code>run</code> and <code>query</code> should only
4ca22cf27ccfcefab65ff6c66da12bba69e33948humbedooh be used when there are no variables inserted into a statement (a static statement).
4ca22cf27ccfcefab65ff6c66da12bba69e33948humbedooh When using dynamic statements, use <code>db:prepare</code> or <code>db:prepared</code>.
fb51a6b789d85113d0976148685b0063c294220drbowen<directivesynopsis>
6b4cd1f143d5d7244d2476d1e28456212faddb72rbowen<description>Specify the base path for resolving relative paths for mod_lua directives</description>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<contextlist><context>server config</context><context>virtual host</context>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<context>directory</context><context>.htaccess</context>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic</contextlist>
fb51a6b789d85113d0976148685b0063c294220drbowen <p>Specify the base path which will be used to evaluate all
2219c51bf0756c2f6f7deb88a13baf30f141c12epoirier relative paths within mod_lua. If not specified they
fb51a6b789d85113d0976148685b0063c294220drbowen will be resolved relative to the current working directory,
fb51a6b789d85113d0976148685b0063c294220drbowen which may not always work well for a server.</p>
fb51a6b789d85113d0976148685b0063c294220drbowen</directivesynopsis>
fb51a6b789d85113d0976148685b0063c294220drbowen<directivesynopsis>
bb565c480bd5ba22f4bb1026f06aff3e1880d450humbedooh<description>One of once, request, conn, thread -- default is once</description>
64fdaa4bd37b26a94cf24d544d31e6f39bc6253ehumbedooh<syntax>LuaScope once|request|conn|thread|server [min] [max]</syntax>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<contextlist><context>server config</context><context>virtual host</context>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<context>directory</context><context>.htaccess</context>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic</contextlist>
df26612d249def4d0b228be69bf89d038d6a129ehumbedooh <p>Specify the life cycle scope of the Lua interpreter which will
c994f52ac80f9664d2940e5ccd9e77466572013frbowen be used by handlers in this "Directory." The default is "once"</p>
c994f52ac80f9664d2940e5ccd9e77466572013frbowen <dt>once:</dt> <dd>use the interpreter once and throw it away.</dd>
860b4efe27e7c1c9a2bf5c872b29c90f76849b51jim <dt>request:</dt> <dd>use the interpreter to handle anything based on
860b4efe27e7c1c9a2bf5c872b29c90f76849b51jim the same file within this request, which is also
c994f52ac80f9664d2940e5ccd9e77466572013frbowen request scoped.</dd>
c994f52ac80f9664d2940e5ccd9e77466572013frbowen <dt>conn:</dt> <dd>Same as request but attached to the connection_rec</dd>
4c5d2aefce1b8d2f1a391aa4b36c323b0394257ehumbedooh <dt>thread:</dt> <dd>Use the interpreter for the lifetime of the thread
154995171968d5fbc34d840ffdb303b5b1f26486humbedooh handling the request (only available with threaded MPMs).</dd>
c994f52ac80f9664d2940e5ccd9e77466572013frbowen <dt>server:</dt> <dd>This one is different than others because the
fb51a6b789d85113d0976148685b0063c294220drbowen server scope is quite long lived, and multiple threads
396c4422f2dc5e4d199a4f84d4504afa0c2fad8ahumbedooh will have the same server_rec. To accommodate this,
396c4422f2dc5e4d199a4f84d4504afa0c2fad8ahumbedooh server scoped Lua states are stored in an apr
64fdaa4bd37b26a94cf24d544d31e6f39bc6253ehumbedooh resource list. The <code>min</code> and <code>max</code> arguments
64fdaa4bd37b26a94cf24d544d31e6f39bc6253ehumbedooh specify the minimum and maximum number of Lua states to keep in the
64fdaa4bd37b26a94cf24d544d31e6f39bc6253ehumbedooh Generally speaking, the <code>thread</code> and <code>server</code> scopes
64fdaa4bd37b26a94cf24d544d31e6f39bc6253ehumbedooh execute roughly 2-3 times faster than the rest, because they don't have to
64fdaa4bd37b26a94cf24d544d31e6f39bc6253ehumbedooh spawn new Lua states on every request (especially with the event MPM, as
64fdaa4bd37b26a94cf24d544d31e6f39bc6253ehumbedooh even keepalive requests will use a new thread for each request). If you are
64fdaa4bd37b26a94cf24d544d31e6f39bc6253ehumbedooh satisfied that your scripts will not have problems reusing a state, then
64fdaa4bd37b26a94cf24d544d31e6f39bc6253ehumbedooh the <code>thread</code> or <code>server</code> scopes should be used for
64fdaa4bd37b26a94cf24d544d31e6f39bc6253ehumbedooh maximum performance. While the <code>thread</code> scope will provide the
64fdaa4bd37b26a94cf24d544d31e6f39bc6253ehumbedooh fastest responses, the <code>server</code> scope will use less memory, as
64fdaa4bd37b26a94cf24d544d31e6f39bc6253ehumbedooh states are pooled, allowing f.x. 1000 threads to share only 100 Lua states,
396c4422f2dc5e4d199a4f84d4504afa0c2fad8ahumbedooh thus using only 10% of the memory required by the <code>thread</code> scope.
fb51a6b789d85113d0976148685b0063c294220drbowen</directivesynopsis>
fb51a6b789d85113d0976148685b0063c294220drbowen<directivesynopsis>
6b4cd1f143d5d7244d2476d1e28456212faddb72rbowen<description>Map a path to a lua handler</description>
fb51a6b789d85113d0976148685b0063c294220drbowen<syntax>LuaMapHandler uri-pattern /path/to/lua/script.lua [function-name]</syntax>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<contextlist><context>server config</context><context>virtual host</context>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<context>directory</context><context>.htaccess</context>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic</contextlist>
fb51a6b789d85113d0976148685b0063c294220drbowen <p>This directive matches a uri pattern to invoke a specific
fb51a6b789d85113d0976148685b0063c294220drbowen handler function in a specific file. It uses PCRE regular
fb51a6b789d85113d0976148685b0063c294220drbowen expressions to match the uri, and supports interpolating
396c4422f2dc5e4d199a4f84d4504afa0c2fad8ahumbedooh match groups into both the file path and the function name.
396c4422f2dc5e4d199a4f84d4504afa0c2fad8ahumbedooh Be careful writing your regular expressions to avoid security
fb51a6b789d85113d0976148685b0063c294220drbowen issues.</p>
fb926c8c319705c9fe42d55a6ad13d9b0972cb72humbedooh LuaMapHandler /(\w+)/(\w+) /scripts/$1.lua handle_$2
6265962c731aed3af3aa7242b35852f3f181d437humbedooh </highlight>
fb51a6b789d85113d0976148685b0063c294220drbowen handler function handle_show on the lua vm after
fb51a6b789d85113d0976148685b0063c294220drbowen loading that file.</p>
fb51a6b789d85113d0976148685b0063c294220drbowen <p>This would invoke the "handle" function, which
fb51a6b789d85113d0976148685b0063c294220drbowen is the default if no specific function name is
fb51a6b789d85113d0976148685b0063c294220drbowen provided.</p>
fb51a6b789d85113d0976148685b0063c294220drbowen</directivesynopsis>
fb51a6b789d85113d0976148685b0063c294220drbowen<directivesynopsis>
6b4cd1f143d5d7244d2476d1e28456212faddb72rbowen<description>Add a directory to lua's package.path</description>
fb51a6b789d85113d0976148685b0063c294220drbowen<syntax>LuaPackagePath /path/to/include/?.lua</syntax>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<contextlist><context>server config</context><context>virtual host</context>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<context>directory</context><context>.htaccess</context>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic</contextlist>
fb51a6b789d85113d0976148685b0063c294220drbowen <usage><p>Add a path to lua's module search path. Follows the same
860b4efe27e7c1c9a2bf5c872b29c90f76849b51jim conventions as lua. This just munges the package.path in the
c994f52ac80f9664d2940e5ccd9e77466572013frbowen lua vms.</p>
6265962c731aed3af3aa7242b35852f3f181d437humbedooh </highlight>
fb51a6b789d85113d0976148685b0063c294220drbowen</directivesynopsis>
fb51a6b789d85113d0976148685b0063c294220drbowen<directivesynopsis>
6b4cd1f143d5d7244d2476d1e28456212faddb72rbowen<description>Add a directory to lua's package.cpath</description>
fb51a6b789d85113d0976148685b0063c294220drbowen<syntax>LuaPackageCPath /path/to/include/?.soa</syntax>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<contextlist><context>server config</context><context>virtual host</context>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<context>directory</context><context>.htaccess</context>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic</contextlist>
fb51a6b789d85113d0976148685b0063c294220drbowen <p>Add a path to lua's shared library search path. Follows the same
860b4efe27e7c1c9a2bf5c872b29c90f76849b51jim conventions as lua. This just munges the package.cpath in the
c994f52ac80f9664d2940e5ccd9e77466572013frbowen lua vms.</p>
fb51a6b789d85113d0976148685b0063c294220drbowen</directivesynopsis>
fb51a6b789d85113d0976148685b0063c294220drbowen<directivesynopsis>
6b4cd1f143d5d7244d2476d1e28456212faddb72rbowen<description>Configure the compiled code cache.</description>
194cfd38d691d74500b4a1751b58ae92d9a31d0bhumbedooh<contextlist>
194cfd38d691d74500b4a1751b58ae92d9a31d0bhumbedooh<context>server config</context><context>virtual host</context>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<context>directory</context><context>.htaccess</context>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic</contextlist>
fb51a6b789d85113d0976148685b0063c294220drbowen Specify the behavior of the in-memory code cache. The default
fb51a6b789d85113d0976148685b0063c294220drbowen is stat, which stats the top level script (not any included
fb51a6b789d85113d0976148685b0063c294220drbowen ones) each time that file is needed, and reloads it if the
fb51a6b789d85113d0976148685b0063c294220drbowen modified time indicates it is newer than the one it has
fb51a6b789d85113d0976148685b0063c294220drbowen already loaded. The other values cause it to keep the file
860b4efe27e7c1c9a2bf5c872b29c90f76849b51jim cached forever (don't stat and replace) or to never cache the
92e5d4326ae44f79da5cb049470daba604506846poirier <p>In general stat or forever is good for production, and stat or never
3a602d0ba8536a79a780655bb92133b571e38378poirier for development.</p>
6265962c731aed3af3aa7242b35852f3f181d437humbedoohLuaCodeCache stat
6265962c731aed3af3aa7242b35852f3f181d437humbedoohLuaCodeCache forever
6265962c731aed3af3aa7242b35852f3f181d437humbedoohLuaCodeCache never
6265962c731aed3af3aa7242b35852f3f181d437humbedooh </highlight>
fb51a6b789d85113d0976148685b0063c294220drbowen</directivesynopsis>
fb51a6b789d85113d0976148685b0063c294220drbowen<directivesynopsis>
6b4cd1f143d5d7244d2476d1e28456212faddb72rbowen<description>Provide a hook for the translate name phase of request processing</description>
457256c49209d6e56bfe63b411688ad9cb2a8429covener<syntax>LuaHookTranslateName /path/to/lua/script.lua hook_function_name [early|late]</syntax>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<contextlist><context>server config</context><context>virtual host</context>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic</contextlist>
247c1db2eb82d5c836df7bafc7380887890e11a2rjung<compatibility>The optional third argument is supported in 2.3.15 and later</compatibility>
fb51a6b789d85113d0976148685b0063c294220drbowen Add a hook (at APR_HOOK_MIDDLE) to the translate name phase of
fb51a6b789d85113d0976148685b0063c294220drbowen request processing. The hook function receives a single
860b4efe27e7c1c9a2bf5c872b29c90f76849b51jim argument, the request_rec, and should return a status code,
fb51a6b789d85113d0976148685b0063c294220drbowen which is either an HTTP error code, or the constants defined
fb51a6b789d85113d0976148685b0063c294220drbowen in the apache2 module: apache2.OK, apache2.DECLINED, or
fb51a6b789d85113d0976148685b0063c294220drbowen <p>For those new to hooks, basically each hook will be invoked
fb51a6b789d85113d0976148685b0063c294220drbowen until one of them returns apache2.OK. If your hook doesn't
fb51a6b789d85113d0976148685b0063c294220drbowen want to do the translation it should just return
fb51a6b789d85113d0976148685b0063c294220drbowen apache2.DECLINED. If the request should stop processing, then
92e5d4326ae44f79da5cb049470daba604506846poirierLuaHookTranslateName /scripts/conf/hooks.lua silly_mapper
92e5d4326ae44f79da5cb049470daba604506846poirierrequire "apache2"
92e5d4326ae44f79da5cb049470daba604506846poirierfunction silly_mapper(r)
92e5d4326ae44f79da5cb049470daba604506846poirier if r.uri == "/" then
457256c49209d6e56bfe63b411688ad9cb2a8429covener <note><title>Context</title><p>This directive is not valid in <directive
457256c49209d6e56bfe63b411688ad9cb2a8429covener type="section" module="core">Directory</directive>, <directive
457256c49209d6e56bfe63b411688ad9cb2a8429covener type="section" module="core">Files</directive>, or htaccess
457256c49209d6e56bfe63b411688ad9cb2a8429covener <note><title>Ordering</title><p>The optional arguments "early" or "late"
457256c49209d6e56bfe63b411688ad9cb2a8429covener control when this script runs relative to other modules.</p></note>
fb51a6b789d85113d0976148685b0063c294220drbowen</directivesynopsis>
fb51a6b789d85113d0976148685b0063c294220drbowen<directivesynopsis>
890b9ed4c432913c66d39ef44823c2ec5f63fbe8humbedooh<description>Provide a hook for the fixups phase of a request
6b4cd1f143d5d7244d2476d1e28456212faddb72rbowenprocessing</description>
fb51a6b789d85113d0976148685b0063c294220drbowen<syntax>LuaHookFixups /path/to/lua/script.lua hook_function_name</syntax>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<contextlist><context>server config</context><context>virtual host</context>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<context>directory</context><context>.htaccess</context>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic</contextlist>
fb51a6b789d85113d0976148685b0063c294220drbowen Just like LuaHookTranslateName, but executed at the fixups phase
fb51a6b789d85113d0976148685b0063c294220drbowen</directivesynopsis>
fb51a6b789d85113d0976148685b0063c294220drbowen<directivesynopsis>
6b4cd1f143d5d7244d2476d1e28456212faddb72rbowen<description>Provide a hook for the map_to_storage phase of request processing</description>
fb51a6b789d85113d0976148685b0063c294220drbowen<syntax>LuaHookMapToStorage /path/to/lua/script.lua hook_function_name</syntax>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<contextlist><context>server config</context><context>virtual host</context>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<context>directory</context><context>.htaccess</context>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic</contextlist>
890b9ed4c432913c66d39ef44823c2ec5f63fbe8humbedooh <p>Like <directive>LuaHookTranslateName</directive> but executed at the
890b9ed4c432913c66d39ef44823c2ec5f63fbe8humbedooh map-to-storage phase of a request. Modules like mod_cache run at this phase,
194cfd38d691d74500b4a1751b58ae92d9a31d0bhumbedooh which makes for an interesting example on what to do here:</p>
890b9ed4c432913c66d39ef44823c2ec5f63fbe8humbedooh LuaHookMapToStorage /path/to/lua/script.lua check_cache
890b9ed4c432913c66d39ef44823c2ec5f63fbe8humbedooh </highlight>
890b9ed4c432913c66d39ef44823c2ec5f63fbe8humbedoohrequire"apache2"
890b9ed4c432913c66d39ef44823c2ec5f63fbe8humbedoohcached_files = {}
890b9ed4c432913c66d39ef44823c2ec5f63fbe8humbedoohfunction read_file(filename)
890b9ed4c432913c66d39ef44823c2ec5f63fbe8humbedooh local input = io.open(filename, "r")
890b9ed4c432913c66d39ef44823c2ec5f63fbe8humbedooh if input then
890b9ed4c432913c66d39ef44823c2ec5f63fbe8humbedooh local data = input:read("*a")
890b9ed4c432913c66d39ef44823c2ec5f63fbe8humbedooh cached_files[filename] = data
890b9ed4c432913c66d39ef44823c2ec5f63fbe8humbedooh file = cached_files[filename]
890b9ed4c432913c66d39ef44823c2ec5f63fbe8humbedooh input:close()
890b9ed4c432913c66d39ef44823c2ec5f63fbe8humbedooh return cached_files[filename]
890b9ed4c432913c66d39ef44823c2ec5f63fbe8humbedoohfunction check_cache(r)
890b9ed4c432913c66d39ef44823c2ec5f63fbe8humbedooh if r.filename:match("%.png$") then -- Only match PNG files
890b9ed4c432913c66d39ef44823c2ec5f63fbe8humbedooh local file = cached_files[r.filename] -- Check cache entries
890b9ed4c432913c66d39ef44823c2ec5f63fbe8humbedooh if not file then
890b9ed4c432913c66d39ef44823c2ec5f63fbe8humbedooh file = read_file(r.filename) -- Read file into cache
890b9ed4c432913c66d39ef44823c2ec5f63fbe8humbedooh if file then -- If file exists, write it out
890b9ed4c432913c66d39ef44823c2ec5f63fbe8humbedooh r:write(file)
890b9ed4c432913c66d39ef44823c2ec5f63fbe8humbedooh r:info(("Sent %s to client from cache"):format(r.filename))
890b9ed4c432913c66d39ef44823c2ec5f63fbe8humbedooh return apache2.DONE -- skip default handler for PNG files
890b9ed4c432913c66d39ef44823c2ec5f63fbe8humbedooh return apache2.DECLINED -- If we had nothing to do, let others serve this.
890b9ed4c432913c66d39ef44823c2ec5f63fbe8humbedooh </highlight>
fb51a6b789d85113d0976148685b0063c294220drbowen</directivesynopsis>
fb51a6b789d85113d0976148685b0063c294220drbowen<directivesynopsis>
6b4cd1f143d5d7244d2476d1e28456212faddb72rbowen<description>Provide a hook for the check_user_id phase of request processing</description>
457256c49209d6e56bfe63b411688ad9cb2a8429covener<syntax>LuaHookCheckUserID /path/to/lua/script.lua hook_function_name [early|late]</syntax>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<contextlist><context>server config</context><context>virtual host</context>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<context>directory</context><context>.htaccess</context>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic</contextlist>
247c1db2eb82d5c836df7bafc7380887890e11a2rjung<compatibility>The optional third argument is supported in 2.3.15 and later</compatibility>
457256c49209d6e56bfe63b411688ad9cb2a8429covener <note><title>Ordering</title><p>The optional arguments "early" or "late"
457256c49209d6e56bfe63b411688ad9cb2a8429covener control when this script runs relative to other modules.</p></note>
fb51a6b789d85113d0976148685b0063c294220drbowen</directivesynopsis>
fb51a6b789d85113d0976148685b0063c294220drbowen<directivesynopsis>
6b4cd1f143d5d7244d2476d1e28456212faddb72rbowen<description>Provide a hook for the type_checker phase of request processing</description>
fb51a6b789d85113d0976148685b0063c294220drbowen<syntax>LuaHookTypeChecker /path/to/lua/script.lua hook_function_name</syntax>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<contextlist><context>server config</context><context>virtual host</context>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<context>directory</context><context>.htaccess</context>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic</contextlist>
2d4c56d61d0746f3d3bd08f61936631037a8c23chumbedooh This directive provides a hook for the type_checker phase of the request processing.
2d4c56d61d0746f3d3bd08f61936631037a8c23chumbedooh This phase is where requests are assigned a content type and a handler, and thus can
2d4c56d61d0746f3d3bd08f61936631037a8c23chumbedooh be used to modify the type and handler based on input:
2d4c56d61d0746f3d3bd08f61936631037a8c23chumbedooh LuaHookTypeChecker /path/to/lua/script.lua type_checker
2d4c56d61d0746f3d3bd08f61936631037a8c23chumbedooh </highlight>
2d4c56d61d0746f3d3bd08f61936631037a8c23chumbedooh function type_checker(r)
2d4c56d61d0746f3d3bd08f61936631037a8c23chumbedooh if r.uri:match("%.to_gif$") then -- match foo.png.to_gif
2d4c56d61d0746f3d3bd08f61936631037a8c23chumbedooh r.content_type = "image/gif" -- assign it the image/gif type
2d4c56d61d0746f3d3bd08f61936631037a8c23chumbedooh r.handler = "gifWizard" -- tell the gifWizard module to handle this
2d4c56d61d0746f3d3bd08f61936631037a8c23chumbedooh r.filename = r.uri:gsub("%.to_gif$", "") -- fix the filename requested
2d4c56d61d0746f3d3bd08f61936631037a8c23chumbedooh </highlight>
fb51a6b789d85113d0976148685b0063c294220drbowen</directivesynopsis>
fb51a6b789d85113d0976148685b0063c294220drbowen<directivesynopsis>
9cd56c73a0fd508522ba2f6bc6c9839c478c61c3rbowen<description>Provide a hook for the auth_checker phase of request processing</description>
457256c49209d6e56bfe63b411688ad9cb2a8429covener<syntax>LuaHookAuthChecker /path/to/lua/script.lua hook_function_name [early|late]</syntax>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<contextlist><context>server config</context><context>virtual host</context>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<context>directory</context><context>.htaccess</context>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic</contextlist>
247c1db2eb82d5c836df7bafc7380887890e11a2rjung<compatibility>The optional third argument is supported in 2.3.15 and later</compatibility>
768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirier<p>Invoke a lua function in the auth_checker phase of processing
768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poiriera request. This can be used to implement arbitrary authentication
768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirierand authorization checking. A very simple example:
768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirierrequire 'apache2'
768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirier-- fake authcheck hook
768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirier-- If request has no auth info, set the response header and
768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirier-- return a 401 to ask the browser for basic auth info.
768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirier-- If request has auth info, don't actually look at it, just
768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirier-- pretend we got userid 'foo' and validated it.
768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirier-- Then check if the userid is 'foo' and accept the request.
768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirierfunction authcheck_hook(r)
768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirier -- look for auth info
768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirier auth = r.headers_in['Authorization']
768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirier if auth ~= nil then
768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirier -- fake the user
768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirier if r.user == nil then
768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirier r:debug("authcheck: user is nil, returning 401")
768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirier r.err_headers_out['WWW-Authenticate'] = 'Basic realm="WallyWorld"'
768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirier elseif r.user == "foo" then
768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirier r:debug('user foo: OK')
768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirier r:debug("authcheck: user='" .. r.user .. "'")
768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirier r.err_headers_out['WWW-Authenticate'] = 'Basic realm="WallyWorld"'
457256c49209d6e56bfe63b411688ad9cb2a8429covener <note><title>Ordering</title><p>The optional arguments "early" or "late"
457256c49209d6e56bfe63b411688ad9cb2a8429covener control when this script runs relative to other modules.</p></note>
fb51a6b789d85113d0976148685b0063c294220drbowen</directivesynopsis>
fb51a6b789d85113d0976148685b0063c294220drbowen<directivesynopsis>
9cd56c73a0fd508522ba2f6bc6c9839c478c61c3rbowen<description>Provide a hook for the access_checker phase of request processing</description>
457256c49209d6e56bfe63b411688ad9cb2a8429covener<syntax>LuaHookAccessChecker /path/to/lua/script.lua hook_function_name [early|late]</syntax>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<contextlist><context>server config</context><context>virtual host</context>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<context>directory</context><context>.htaccess</context>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic</contextlist>
247c1db2eb82d5c836df7bafc7380887890e11a2rjung<compatibility>The optional third argument is supported in 2.3.15 and later</compatibility>
92e5d4326ae44f79da5cb049470daba604506846poirier<p>Add your hook to the access_checker phase. An access checker
92e5d4326ae44f79da5cb049470daba604506846poirierhook function usually returns OK, DECLINED, or HTTP_FORBIDDEN.</p>
457256c49209d6e56bfe63b411688ad9cb2a8429covener <note><title>Ordering</title><p>The optional arguments "early" or "late"
457256c49209d6e56bfe63b411688ad9cb2a8429covener control when this script runs relative to other modules.</p></note>
fb51a6b789d85113d0976148685b0063c294220drbowen</directivesynopsis>
fb51a6b789d85113d0976148685b0063c294220drbowen<directivesynopsis>
9cd56c73a0fd508522ba2f6bc6c9839c478c61c3rbowen<description>Provide a hook for the insert_filter phase of request processing</description>
fb51a6b789d85113d0976148685b0063c294220drbowen<syntax>LuaHookInsertFilter /path/to/lua/script.lua hook_function_name</syntax>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<contextlist><context>server config</context><context>virtual host</context>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<context>directory</context><context>.htaccess</context>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic</contextlist>
fb51a6b789d85113d0976148685b0063c294220drbowen</directivesynopsis>
ae600ca541efc686b34f8b1f21bd3d0741d37674covener<directivesynopsis>
ae600ca541efc686b34f8b1f21bd3d0741d37674covener<description>Controls how parent configuration sections are merged into children</description>
ae600ca541efc686b34f8b1f21bd3d0741d37674covener<syntax>LuaInherit none|parent-first|parent-last</syntax>
ae600ca541efc686b34f8b1f21bd3d0741d37674covener<contextlist><context>server config</context><context>virtual host</context>
ae600ca541efc686b34f8b1f21bd3d0741d37674covener<context>directory</context><context>.htaccess</context>
ae600ca541efc686b34f8b1f21bd3d0741d37674covener</contextlist>
ae600ca541efc686b34f8b1f21bd3d0741d37674covener <usage><p>By default, if LuaHook* directives are used in overlapping
ae600ca541efc686b34f8b1f21bd3d0741d37674covener Directory or Location configuration sections, the scripts defined in the
ae600ca541efc686b34f8b1f21bd3d0741d37674covener more specific section are run <em>after</em> those defined in the more
ae600ca541efc686b34f8b1f21bd3d0741d37674covener generic section (LuaInherit parent-first). You can reverse this order, or
ae600ca541efc686b34f8b1f21bd3d0741d37674covener make the parent context not apply at all.</p>
ae600ca541efc686b34f8b1f21bd3d0741d37674covener <p> In previous 2.3.x releases, the default was effectively to ignore LuaHook*
ae600ca541efc686b34f8b1f21bd3d0741d37674covener directives from parent configuration sections.</p></usage>
ae600ca541efc686b34f8b1f21bd3d0741d37674covener</directivesynopsis>
6b4cd1f143d5d7244d2476d1e28456212faddb72rbowen<directivesynopsis>
6b4cd1f143d5d7244d2476d1e28456212faddb72rbowen<description>Provide a hook for the quick handler of request processing</description>
35b6187510aac978a1e2a242560ef5fff9f09e8ehumbedooh<syntax>LuaQuickHandler /path/to/script.lua hook_function_name</syntax>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<contextlist><context>server config</context><context>virtual host</context>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic</contextlist>
72b1f0c347c49fa217617de9864e4f30cfa0cbd4humbedooh This phase is run immediately after the request has been mapped to a virtal host,
72b1f0c347c49fa217617de9864e4f30cfa0cbd4humbedooh and can be used to either do some request processing before the other phases kick
72b1f0c347c49fa217617de9864e4f30cfa0cbd4humbedooh in, or to serve a request without the need to translate, map to storage et cetera.
72b1f0c347c49fa217617de9864e4f30cfa0cbd4humbedooh As this phase is run before anything else, directives such as <directive
72b1f0c347c49fa217617de9864e4f30cfa0cbd4humbedooh type="section" module="core">Location</directive> or <directive
72b1f0c347c49fa217617de9864e4f30cfa0cbd4humbedooh type="section" module="core">Directory</directive> are void in this phase, just as
72b1f0c347c49fa217617de9864e4f30cfa0cbd4humbedooh URIs have not been properly parsed yet.
457256c49209d6e56bfe63b411688ad9cb2a8429covener <note><title>Context</title><p>This directive is not valid in <directive
457256c49209d6e56bfe63b411688ad9cb2a8429covener type="section" module="core">Directory</directive>, <directive
457256c49209d6e56bfe63b411688ad9cb2a8429covener type="section" module="core">Files</directive>, or htaccess
6b4cd1f143d5d7244d2476d1e28456212faddb72rbowen</directivesynopsis>
e20c6ecbd465cd7dabb44acea6afafc7925f3a03sf<directivesynopsis>
e20c6ecbd465cd7dabb44acea6afafc7925f3a03sf<description>Plug an authorization provider function into <module>mod_authz_core</module>
e20c6ecbd465cd7dabb44acea6afafc7925f3a03sf</description>
e20c6ecbd465cd7dabb44acea6afafc7925f3a03sf<syntax>LuaAuthzProvider provider_name /path/to/lua/script.lua function_name</syntax>
e20c6ecbd465cd7dabb44acea6afafc7925f3a03sf<contextlist><context>server config</context> </contextlist>
e20c6ecbd465cd7dabb44acea6afafc7925f3a03sf<p>After a lua function has been registered as authorization provider, it can be used
e20c6ecbd465cd7dabb44acea6afafc7925f3a03sfwith the <directive module="mod_authz_core">Require</directive> directive:</p>
e20c6ecbd465cd7dabb44acea6afafc7925f3a03sfLuaAuthzProvider foo authz.lua authz_check_foo
e20c6ecbd465cd7dabb44acea6afafc7925f3a03sf<Location />
890b9ed4c432913c66d39ef44823c2ec5f63fbe8humbedooh Require foo johndoe
e20c6ecbd465cd7dabb44acea6afafc7925f3a03sf</Location>
e20c6ecbd465cd7dabb44acea6afafc7925f3a03sf</highlight>
890b9ed4c432913c66d39ef44823c2ec5f63fbe8humbedoohrequire "apache2"
890b9ed4c432913c66d39ef44823c2ec5f63fbe8humbedoohfunction authz_check_foo(r, who)
e20c6ecbd465cd7dabb44acea6afafc7925f3a03sf</directivesynopsis>
78f94f1d06c4e6828ce04d618221e0fcecb57849humbedooh<directivesynopsis>
78f94f1d06c4e6828ce04d618221e0fcecb57849humbedooh<description>Provide a Lua function for content input filtering</description>
78f94f1d06c4e6828ce04d618221e0fcecb57849humbedooh<syntax>LuaInputFilter filter_name /path/to/lua/script.lua function_name</syntax>
78f94f1d06c4e6828ce04d618221e0fcecb57849humbedooh<contextlist><context>server config</context> </contextlist>
78f94f1d06c4e6828ce04d618221e0fcecb57849humbedooh<p>Provides a means of adding a Lua function as an input filter.
78f94f1d06c4e6828ce04d618221e0fcecb57849humbedoohAs with output filters, input filters work as coroutines,
78f94f1d06c4e6828ce04d618221e0fcecb57849humbedoohfirst yielding before buffers are sent, then yielding whenever
78f94f1d06c4e6828ce04d618221e0fcecb57849humbedooha bucket needs to be passed down the chain, and finally (optionally)
78f94f1d06c4e6828ce04d618221e0fcecb57849humbedoohyielding anything that needs to be appended to the input data. The
78f94f1d06c4e6828ce04d618221e0fcecb57849humbedoohglobal variable <code>bucket</code> holds the buckets as they are passed
78f94f1d06c4e6828ce04d618221e0fcecb57849humbedoohonto the Lua script:
78f94f1d06c4e6828ce04d618221e0fcecb57849humbedoohLuaInputFilter myInputFilter /www/filter.lua input_filter
78f94f1d06c4e6828ce04d618221e0fcecb57849humbedooh<FilesMatch "\.lua>
78f94f1d06c4e6828ce04d618221e0fcecb57849humbedooh SetInputFilter myInputFilter
78f94f1d06c4e6828ce04d618221e0fcecb57849humbedooh</FilesMatch>
78f94f1d06c4e6828ce04d618221e0fcecb57849humbedooh Example input filter that converts all POST data to uppercase.
78f94f1d06c4e6828ce04d618221e0fcecb57849humbedoohfunction input_filter(r)
78f94f1d06c4e6828ce04d618221e0fcecb57849humbedooh print("luaInputFilter called") -- debug print
78f94f1d06c4e6828ce04d618221e0fcecb57849humbedooh coroutine.yield() -- Yield and wait for buckets
78f94f1d06c4e6828ce04d618221e0fcecb57849humbedooh while bucket do -- For each bucket, do...
78f94f1d06c4e6828ce04d618221e0fcecb57849humbedooh local output = string.upper(bucket) -- Convert all POST data to uppercase
78f94f1d06c4e6828ce04d618221e0fcecb57849humbedooh coroutine.yield(output) -- Send converted data down the chain
78f94f1d06c4e6828ce04d618221e0fcecb57849humbedooh -- No more buckets available.
78f94f1d06c4e6828ce04d618221e0fcecb57849humbedooh coroutine.yield("&filterSignature=1234") -- Append signature at the end
78f94f1d06c4e6828ce04d618221e0fcecb57849humbedoohThe input filter supports denying/skipping a filter if it is deemed unwanted:
78f94f1d06c4e6828ce04d618221e0fcecb57849humbedoohfunction input_filter(r)
78f94f1d06c4e6828ce04d618221e0fcecb57849humbedooh if not good then
78f94f1d06c4e6828ce04d618221e0fcecb57849humbedooh return -- Simply deny filtering, passing on the original content instead
78f94f1d06c4e6828ce04d618221e0fcecb57849humbedooh coroutine.yield() -- wait for buckets
78f94f1d06c4e6828ce04d618221e0fcecb57849humbedooh ... -- insert filter stuff here
78f94f1d06c4e6828ce04d618221e0fcecb57849humbedoohSee "<a href="#modifying_buckets">Modifying contents with Lua
78f94f1d06c4e6828ce04d618221e0fcecb57849humbedoohfilters</a>" for more information.
78f94f1d06c4e6828ce04d618221e0fcecb57849humbedooh</directivesynopsis>
78f94f1d06c4e6828ce04d618221e0fcecb57849humbedooh<directivesynopsis>
78f94f1d06c4e6828ce04d618221e0fcecb57849humbedooh<description>Provide a Lua function for content output filtering</description>
78f94f1d06c4e6828ce04d618221e0fcecb57849humbedooh<syntax>LuaOutputFilter filter_name /path/to/lua/script.lua function_name</syntax>
78f94f1d06c4e6828ce04d618221e0fcecb57849humbedooh<contextlist><context>server config</context> </contextlist>
78f94f1d06c4e6828ce04d618221e0fcecb57849humbedooh<p>Provides a means of adding a Lua function as an output filter.
78f94f1d06c4e6828ce04d618221e0fcecb57849humbedoohAs with input filters, output filters work as coroutines,
78f94f1d06c4e6828ce04d618221e0fcecb57849humbedoohfirst yielding before buffers are sent, then yielding whenever
78f94f1d06c4e6828ce04d618221e0fcecb57849humbedooha bucket needs to be passed down the chain, and finally (optionally)
78f94f1d06c4e6828ce04d618221e0fcecb57849humbedoohyielding anything that needs to be appended to the input data. The
78f94f1d06c4e6828ce04d618221e0fcecb57849humbedoohglobal variable <code>bucket</code> holds the buckets as they are passed
78f94f1d06c4e6828ce04d618221e0fcecb57849humbedoohonto the Lua script:
78f94f1d06c4e6828ce04d618221e0fcecb57849humbedoohLuaOutputFilter myOutputFilter /www/filter.lua output_filter
78f94f1d06c4e6828ce04d618221e0fcecb57849humbedooh<FilesMatch "\.lua>
78f94f1d06c4e6828ce04d618221e0fcecb57849humbedooh SetOutputFilter myOutputFilter
78f94f1d06c4e6828ce04d618221e0fcecb57849humbedooh</FilesMatch>
78f94f1d06c4e6828ce04d618221e0fcecb57849humbedooh Example output filter that escapes all HTML entities in the output
78f94f1d06c4e6828ce04d618221e0fcecb57849humbedoohfunction output_filter(r)
78f94f1d06c4e6828ce04d618221e0fcecb57849humbedooh coroutine.yield("(Handled by myOutputFilter)<br/>\n") -- Prepend some data to the output,
78f94f1d06c4e6828ce04d618221e0fcecb57849humbedooh -- yield and wait for buckets.
78f94f1d06c4e6828ce04d618221e0fcecb57849humbedooh while bucket do -- For each bucket, do...
78f94f1d06c4e6828ce04d618221e0fcecb57849humbedooh local output = r:escape_html(bucket) -- Escape all output
78f94f1d06c4e6828ce04d618221e0fcecb57849humbedooh coroutine.yield(output) -- Send converted data down the chain
78f94f1d06c4e6828ce04d618221e0fcecb57849humbedooh -- No more buckets available.
78f94f1d06c4e6828ce04d618221e0fcecb57849humbedoohAs with the input filter, the output filter supports denying/skipping a filter
78f94f1d06c4e6828ce04d618221e0fcecb57849humbedoohif it is deemed unwanted:
78f94f1d06c4e6828ce04d618221e0fcecb57849humbedoohfunction output_filter(r)
78f94f1d06c4e6828ce04d618221e0fcecb57849humbedooh return -- Simply deny filtering, passing on the original content instead
78f94f1d06c4e6828ce04d618221e0fcecb57849humbedooh coroutine.yield() -- wait for buckets
78f94f1d06c4e6828ce04d618221e0fcecb57849humbedooh ... -- insert filter stuff here
78f94f1d06c4e6828ce04d618221e0fcecb57849humbedoohSee "<a href="#modifying_buckets">Modifying contents with Lua filters</a>" for more
78f94f1d06c4e6828ce04d618221e0fcecb57849humbedooh</directivesynopsis>
fb51a6b789d85113d0976148685b0063c294220drbowen</modulesynopsis>