documentation/api/modules/luci.http.protocol.conditionals.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
   2    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
   3 <html>
   4 <head>
   5     <title>Reference</title>
   6     <link rel="stylesheet" href="../luadoc.css" type="text/css" />
   7         <!--meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/-->
   8 </head>
   9
  10 <body>
  11 <div id="container">
  12
  13 <div id="product">
  14         <div id="product_logo"></div>
  15         <div id="product_name"><big><b></b></big></div>
  16         <div id="product_description"></div>
  17 </div> <!-- id="product" -->
  18
  19 <div id="main">
  20
  21 <div id="navigation">
  22
  23
  24 <h1>LuaDoc</h1>
  25 <ul>
  26
  27         <li><a href="../index.html">Index</a></li>
  28
  29 </ul>
  30
  31
  32 <!-- Module list -->
  33
  34 <h1>Modules</h1>
  35 <ul>
  36
  37         <li>
  38                 <a href="../modules/luci.dispatcher.html">luci.dispatcher</a>
  39         </li>
  40
  41         <li>
  42                 <a href="../modules/luci.http.html">luci.http</a>
  43         </li>
  44
  45         <li>
  46                 <a href="../modules/luci.http.protocol.html">luci.http.protocol</a>
  47         </li>
  48
  49         <li><strong>luci.http.protocol.conditionals</strong></li>
  50
  51         <li>
  52                 <a href="../modules/luci.http.protocol.date.html">luci.http.protocol.date</a>
  53         </li>
  54
  55         <li>
  56                 <a href="../modules/luci.http.protocol.mime.html">luci.http.protocol.mime</a>
  57         </li>
  58
  59         <li>
  60                 <a href="../modules/luci.i18n.html">luci.i18n</a>
  61         </li>
  62
  63         <li>
  64                 <a href="../modules/luci.ip.html">luci.ip</a>
  65         </li>
  66
  67         <li>
  68                 <a href="../modules/luci.ip.cidr.html">luci.ip.cidr</a>
  69         </li>
  70
  71         <li>
  72                 <a href="../modules/luci.json.html">luci.json</a>
  73         </li>
  74
  75         <li>
  76                 <a href="../modules/luci.jsonc.html">luci.jsonc</a>
  77         </li>
  78
  79         <li>
  80                 <a href="../modules/luci.jsonc.parser.html">luci.jsonc.parser</a>
  81         </li>
  82
  83         <li>
  84                 <a href="../modules/luci.model.ipkg.html">luci.model.ipkg</a>
  85         </li>
  86
  87         <li>
  88                 <a href="../modules/luci.model.uci.html">luci.model.uci</a>
  89         </li>
  90
  91         <li>
  92                 <a href="../modules/luci.rpcc.html">luci.rpcc</a>
  93         </li>
  94
  95         <li>
  96                 <a href="../modules/luci.rpcc.ruci.html">luci.rpcc.ruci</a>
  97         </li>
  98
  99         <li>
 100                 <a href="../modules/luci.sys.html">luci.sys</a>
 101         </li>
 102
 103         <li>
 104                 <a href="../modules/luci.sys.init.html">luci.sys.init</a>
 105         </li>
 106
 107         <li>
 108                 <a href="../modules/luci.sys.iptparser.html">luci.sys.iptparser</a>
 109         </li>
 110
 111         <li>
 112                 <a href="../modules/luci.sys.net.html">luci.sys.net</a>
 113         </li>
 114
 115         <li>
 116                 <a href="../modules/luci.sys.process.html">luci.sys.process</a>
 117         </li>
 118
 119         <li>
 120                 <a href="../modules/luci.sys.user.html">luci.sys.user</a>
 121         </li>
 122
 123         <li>
 124                 <a href="../modules/luci.sys.wifi.html">luci.sys.wifi</a>
 125         </li>
 126
 127         <li>
 128                 <a href="../modules/luci.util.html">luci.util</a>
 129         </li>
 130
 131         <li>
 132                 <a href="../modules/nixio.html">nixio</a>
 133         </li>
 134
 135         <li>
 136                 <a href="../modules/nixio.CHANGELOG.html">nixio.CHANGELOG</a>
 137         </li>
 138
 139         <li>
 140                 <a href="../modules/nixio.CryptoHash.html">nixio.CryptoHash</a>
 141         </li>
 142
 143         <li>
 144                 <a href="../modules/nixio.File.html">nixio.File</a>
 145         </li>
 146
 147         <li>
 148                 <a href="../modules/nixio.README.html">nixio.README</a>
 149         </li>
 150
 151         <li>
 152                 <a href="../modules/nixio.Socket.html">nixio.Socket</a>
 153         </li>
 154
 155         <li>
 156                 <a href="../modules/nixio.TLSContext.html">nixio.TLSContext</a>
 157         </li>
 158
 159         <li>
 160                 <a href="../modules/nixio.TLSSocket.html">nixio.TLSSocket</a>
 161         </li>
 162
 163         <li>
 164                 <a href="../modules/nixio.UnifiedIO.html">nixio.UnifiedIO</a>
 165         </li>
 166
 167         <li>
 168                 <a href="../modules/nixio.bin.html">nixio.bin</a>
 169         </li>
 170
 171         <li>
 172                 <a href="../modules/nixio.bit.html">nixio.bit</a>
 173         </li>
 174
 175         <li>
 176                 <a href="../modules/nixio.crypto.html">nixio.crypto</a>
 177         </li>
 178
 179         <li>
 180                 <a href="../modules/nixio.fs.html">nixio.fs</a>
 181         </li>
 182
 183 </ul>
 184
 185
 186
 187 <!-- File list -->
 188
 189
 190
 191
 192
 193
 194
 195 </div><!-- id="navigation" -->
 196
 197 <div id="content">
 198
 199 <h1>Class <code>luci.http.protocol.conditionals</code></h1>
 200
 201 <p></p>
 202
 203
 204
 205
 206
 207
 208
 209 <h2>Functions</h2>
 210 <table class="function_list">
 211
 212         <tr>
 213         <td class="name" nowrap><a href="#if_match">if_match</a>&nbsp;(req, stat)</td>
 214         <td class="summary">
 215
 216 14.24 / If-Match
 217
 218 Test whether the given message object contains an "If-Match" header and
 219 compare it against the given stat object.</td>
 220         </tr>
 221
 222         <tr>
 223         <td class="name" nowrap><a href="#if_modified_since">if_modified_since</a>&nbsp;(req, stat)</td>
 224         <td class="summary">
 225
 226 14.25 / If-Modified-Since
 227
 228 Test whether the given message object contains an "If-Modified-Since" header
 229 and compare it against the given stat object.</td>
 230         </tr>
 231
 232         <tr>
 233         <td class="name" nowrap><a href="#if_none_match">if_none_match</a>&nbsp;(req, stat)</td>
 234         <td class="summary">
 235
 236 14.26 / If-None-Match
 237
 238 Test whether the given message object contains an "If-None-Match" header and
 239 compare it against the given stat object.</td>
 240         </tr>
 241
 242         <tr>
 243         <td class="name" nowrap><a href="#if_range">if_range</a>&nbsp;(req, stat)</td>
 244         <td class="summary">
 245
 246 14.27 / If-Range
 247
 248 The If-Range header is currently not implemented due to the lack of general
 249 byte range stuff in luci.http.protocol .</td>
 250         </tr>
 251
 252         <tr>
 253         <td class="name" nowrap><a href="#if_unmodified_since">if_unmodified_since</a>&nbsp;(req, stat)</td>
 254         <td class="summary">
 255
 256 14.28 / If-Unmodified-Since
 257
 258 Test whether the given message object contains an "If-Unmodified-Since"
 259 header and compare it against the given stat object.</td>
 260         </tr>
 261
 262         <tr>
 263         <td class="name" nowrap><a href="#mk_etag">mk_etag</a>&nbsp;(stat)</td>
 264         <td class="summary">
 265
 266 Implement 14.19 / ETag.</td>
 267         </tr>
 268
 269 </table>
 270
 271
 272
 273
 274
 275
 276 <br/>
 277 <br/>
 278
 279
 280 <h2><a name="functions"></a>Functions</h2>
 281 <dl class="function">
 282
 283
 284
 285 <dt><a name="if_match"></a><strong>if_match</strong>&nbsp;(req, stat)</dt>
 286 <dd>
 287
 288
 289 14.24 / If-Match
 290
 291 Test whether the given message object contains an "If-Match" header and
 292 compare it against the given stat object.
 293
 294
 295 <h3>Parameters</h3>
 296 <ul>
 297
 298         <li>
 299           req: HTTP request message object
 300         </li>
 301
 302         <li>
 303           stat: A file.stat object
 304         </li>
 305
 306 </ul>
 307
 308
 309
 310
 311
 312
 313 <h3>Return values:</h3>
 314 <ol>
 315
 316         <li>Boolean indicating whether the precondition is ok
 317
 318         <li>Alternative status code if the precondition failed
 319
 320 </ol>
 321
 322
 323
 324 </dd>
 325
 326
 327
 328
 329 <dt><a name="if_modified_since"></a><strong>if_modified_since</strong>&nbsp;(req, stat)</dt>
 330 <dd>
 331
 332
 333 14.25 / If-Modified-Since
 334
 335 Test whether the given message object contains an "If-Modified-Since" header
 336 and compare it against the given stat object.
 337
 338
 339 <h3>Parameters</h3>
 340 <ul>
 341
 342         <li>
 343           req: HTTP request message object
 344         </li>
 345
 346         <li>
 347           stat: A file.stat object
 348         </li>
 349
 350 </ul>
 351
 352
 353
 354
 355
 356
 357 <h3>Return values:</h3>
 358 <ol>
 359
 360         <li>Boolean indicating whether the precondition is ok
 361
 362         <li>Alternative status code if the precondition failed
 363
 364         <li>Table containing extra HTTP headers if the precondition failed
 365
 366 </ol>
 367
 368
 369
 370 </dd>
 371
 372
 373
 374
 375 <dt><a name="if_none_match"></a><strong>if_none_match</strong>&nbsp;(req, stat)</dt>
 376 <dd>
 377
 378
 379 14.26 / If-None-Match
 380
 381 Test whether the given message object contains an "If-None-Match" header and
 382 compare it against the given stat object.
 383
 384
 385 <h3>Parameters</h3>
 386 <ul>
 387
 388         <li>
 389           req: HTTP request message object
 390         </li>
 391
 392         <li>
 393           stat: A file.stat object
 394         </li>
 395
 396 </ul>
 397
 398
 399
 400
 401
 402
 403 <h3>Return values:</h3>
 404 <ol>
 405
 406         <li>Boolean indicating whether the precondition is ok
 407
 408         <li>Alternative status code if the precondition failed
 409
 410         <li>Table containing extra HTTP headers if the precondition failed
 411
 412 </ol>
 413
 414
 415
 416 </dd>
 417
 418
 419
 420
 421 <dt><a name="if_range"></a><strong>if_range</strong>&nbsp;(req, stat)</dt>
 422 <dd>
 423
 424
 425 14.27 / If-Range
 426
 427 The If-Range header is currently not implemented due to the lack of general
 428 byte range stuff in luci.http.protocol . This function will always return
 429 false, 412 to indicate a failed precondition.
 430
 431
 432 <h3>Parameters</h3>
 433 <ul>
 434
 435         <li>
 436           req: HTTP request message object
 437         </li>
 438
 439         <li>
 440           stat: A file.stat object
 441         </li>
 442
 443 </ul>
 444
 445
 446
 447
 448
 449
 450 <h3>Return values:</h3>
 451 <ol>
 452
 453         <li>Boolean indicating whether the precondition is ok
 454
 455         <li>Alternative status code if the precondition failed
 456
 457 </ol>
 458
 459
 460
 461 </dd>
 462
 463
 464
 465
 466 <dt><a name="if_unmodified_since"></a><strong>if_unmodified_since</strong>&nbsp;(req, stat)</dt>
 467 <dd>
 468
 469
 470 14.28 / If-Unmodified-Since
 471
 472 Test whether the given message object contains an "If-Unmodified-Since"
 473 header and compare it against the given stat object.
 474
 475
 476 <h3>Parameters</h3>
 477 <ul>
 478
 479         <li>
 480           req: HTTP request message object
 481         </li>
 482
 483         <li>
 484           stat: A file.stat object
 485         </li>
 486
 487 </ul>
 488
 489
 490
 491
 492
 493
 494 <h3>Return values:</h3>
 495 <ol>
 496
 497         <li>Boolean indicating whether the precondition is ok
 498
 499         <li>Alternative status code if the precondition failed
 500
 501 </ol>
 502
 503
 504
 505 </dd>
 506
 507
 508
 509
 510 <dt><a name="mk_etag"></a><strong>mk_etag</strong>&nbsp;(stat)</dt>
 511 <dd>
 512
 513
 514 Implement 14.19 / ETag.
 515
 516
 517
 518 <h3>Parameters</h3>
 519 <ul>
 520
 521         <li>
 522           stat: A file.stat structure
 523         </li>
 524
 525 </ul>
 526
 527
 528
 529
 530
 531
 532 <h3>Return value:</h3>
 533 String containing the generated tag suitable for ETag headers
 534
 535
 536
 537 </dd>
 538
 539
 540 </dl>
 541
 542
 543
 544
 545
 546 </div> <!-- id="content" -->
 547
 548 </div> <!-- id="main" -->
 549
 550 <div id="about">
 551         <p><a href="http://validator.w3.org/check?uri=referer"><img src="http://www.w3.org/Icons/valid-xhtml10" alt="Valid XHTML 1.0!" height="31" width="88" /></a></p>
 552 </div> <!-- id="about" -->
 553
 554 </div> <!-- id="container" -->
 555 </body>
 556 </html>