Many hyperlinks are disabled.
Use anonymous login
to enable hyperlinks.
Overview
Comment: | Rebrand as "W3" |
---|---|
Downloads: | Tarball | ZIP archive |
Timelines: | family | ancestors | w3 |
Files: | files | file ages | folders |
SHA3-256: |
c0bf5ea89645a250a9a81bae9acdec27 |
User & Date: | drh 2024-04-15 10:28:22.709 |
Context
2024-04-15
| ||
10:28 | Rebrand as "W3" (Leaf check-in: c0bf5ea896 user: drh tags: w3) | |
2024-04-14
| ||
19:36 | Update the built-in SQLite to the latest 3.46.0 alpha version. (check-in: 3dfe5da86a user: drh tags: trunk) | |
Changes
Changes to Makefile.
1 2 3 4 5 6 7 8 9 | #!/usr/bin/make CFLAGS = -Os -static CC = gcc $(CFLAGS) OPTS = -DSQLITE_ENABLE_DESERIALIZE TCLLIB = /home/drh/tcl/lib/libtcl8.7.a -lm -lz -lpthread -ldl TCLINC = /home/drh/tcl/include TCLSH = tclsh | | | | | | | | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | #!/usr/bin/make CFLAGS = -Os -static CC = gcc $(CFLAGS) OPTS = -DSQLITE_ENABLE_DESERIALIZE TCLLIB = /home/drh/tcl/lib/libtcl8.7.a -lm -lz -lpthread -ldl TCLINC = /home/drh/tcl/include TCLSH = tclsh all: w3tclsh w3tclsh: w3tclsh.c $(CC) -I. -I$(TCLINC) -o $@ $(OPTS) w3tclsh.c $(TCLLIB) w3tclsh.c: w3tclsh.c.in w3.tcl w3tclsh.tcl tclsqlite3.c mkccode.tcl $(TCLSH) mkccode.tcl w3tclsh.c.in >$@ clean: rm w3tclsh w3tclsh.c |
Changes to Makefile.macos.
1 2 3 4 5 6 7 | #!/usr/bin/make CC = gcc -O0 -framework CoreFoundation TCLLIB = /Users/drh/tcl/lib/libtcl8.7.a -lm -lz -lpthread -ldl TCLINC = /Users/drh/tcl/include TCLSH = /Users/drh/tcl/bin/tclsh8.7 | | | | | | | | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | #!/usr/bin/make CC = gcc -O0 -framework CoreFoundation TCLLIB = /Users/drh/tcl/lib/libtcl8.7.a -lm -lz -lpthread -ldl TCLINC = /Users/drh/tcl/include TCLSH = /Users/drh/tcl/bin/tclsh8.7 all: w3tclsh w3tclsh: w3tclsh.c $(CC) -I. -I$(TCLINC) -o $@ w3tclsh.c $(TCLLIB) w3tclsh.c: w3tclsh.c.in w3.tcl w3tclsh.tcl tclsqlite3.c mkccode.tcl $(TCLSH) mkccode.tcl w3tclsh.c.in >$@ clean: rm w3tclsh w3tclsh.c |
Changes to README.md.
|
| | | | | | | | | | | | | | | | | | 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 | W3 - A Web-Application Framework for TCL ========================================== W3 is a framework for writing web applications in TCL, with the following advantages: * Small and simple API → easy to learn and use * A complete app is a single small file of TCL * Resistant to attacks and exploits * Cross-platform → CGI, SCGI, or a built-in web server * The W3 framework itself is a single-file TCL script * Easy to embed in a larger application, if desired * 2-clause BSD license Documentation ------------- * ["Hello World!" App (6 lines of code)](/doc/trunk/docs/helloworld.md) * [Introduction To Writing W3 Applications](/doc/trunk/docs/intro.md) * [Quick Reference](/doc/trunk/docs/quickref.md) * [W3 Parameters](/doc/trunk/docs/params.md) * [W3 Commands](/doc/trunk/docs/commands.md) * [CGI Parameters](/doc/trunk/docs/quickref.md#cgiparams) * [URL Mapping](/doc/trunk/docs/urlmapping.md) * [Security Features](/doc/trunk/docs/security.md) * [How To Compile w3tclsh - Or Not](/doc/trunk/docs/compiling.md) * [Limitations of W3](/doc/trunk/docs/limitations.md) * [Example Applications](/file/examples) * [Real-World Uses Of W3](/doc/trunk/docs/usageexamples.md) * [Debugging Hints](/doc/trunk/docs/debughints.md) Simple Live Demos ----------------- * <https://w3.tcl.tk/demo/> Downloads --------- * Download just the single [W3 TCL file](/file/w3.tcl?mimetype=text/plain), if you already have a TCL environment * Download a [tarball](/tarball/w3.tar.gz) or [ZIP Archive](/zip/w3.zip) of the latest snapshot of this entire repository, or * Clone the entire repository using the [Fossil](https://fossil-scm.org/) command "fossil clone [](https://w3.tcl.tk)". Extended And Enhanced W3 By Oleg (lego12239) ---------------------------------------------- * <https://github.com/lego12239/w3> |
Changes to docs/commands.md.
1 2 3 | Wapp Commands ============= | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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 | Wapp Commands ============= W3 is really just a collection of TCL procs. All procs are in a single file named "w3.tcl". The procs that form the public interface for W3 begin with "w3-". The implementation uses various private procedures that have names beginning with "w3Int-". Applications should use the public interface only. The most important W3 interfaces are: + **w3-start** + **w3-subst** and **w3-trim** + **w3-param** Understand the four interfaces above, and you will have a good understanding of W3. The other interfaces are merely details. The following is a complete list of the public interface procs in W3: + **w3-start** _ARGLIST_ Start up the application. _ARGLIST_ is typically the value of $::argv, though it might be some subset of $::argv if the containing application has already processed some command-line parameters for itself. By default, this proc never returns, and so it should be very last command in the application script. To embed W3 in a larger application, include the -nowait option in _ARGLIST_ and this proc will return immediately after setting up all necessary file events. + <a name='w3-subst'></a>**w3-subst** _TEXT_ This command appends text to the end of reply to an HTTP request. The _TEXT_ argument should be enclosed in {...} to prevent accidental substitutions. The "w3-subst" command itself will do all necessary backslash substitutions. [Command and variable substitutions](./subst.md) occur within "%html(...)", "%url(...)", "%qp(...)", "%string(...)", and "%unsafe(...)". The substitutions are escaped (except in the case of "%unsafe(...)") so that the result is safe for inclusion within the body of an HTML document, a URL, a query parameter, or a javascript or JSON string literal, respectively. > > <b>Caution #1:</b> When using Tcl 8.6 or earlier, command substitution, but not variable substitution, occurs outside of the quoted regions. This problem is fixed using the new "-command" option to the regsub command in Tcl 8.7. Nevertheless, it is suggested that you avoid using the "[" character outside of the %-quotes. Use "\[" instead. > > <b>Caution #2:</b> The %html() and similar %-substitutions are parsed using a regexp, which means that they cannot do matching parentheses. The %-substitution is terminated by the first close parenthesis, not the first matching close-parenthesis. + <a name='w3-trim'></a>**w3-trim** _TEXT_ Just like w3-subst, this routine appends _TEXT_ to the web page under construction. The same [substitution functions](./subst.md) are supported. The difference is that this routine also removes surplus whitespace from the left margin, so that if the _TEXT_ argument is indented in the source script, it will appear at the left margin in the generated output. + <a name='w3-param'></a>**w3-param** _NAME_ _DEFAULT_ Return the value of the [W3 parameter](params.md) _NAME_, or return _DEFAULT_ if there is no such query parameter or environment variable. If _DEFAULT_ is omitted, then it is an empty string. + **w3-set-param** _NAME_ _VALUE_ Change the value of parameter _NAME_ to _VALUE_. If _NAME_ does not currently exist, it is created. + **w3-param-exists** _NAME_ Return true if and only if a parameter called _NAME_ exists for the current request. + **w3-param-list** _GLOB_ Return a TCL list containing the names of all parameters for the current request. The _GLOB_ argument is optional. If provided, only parameters that match the GLOB pattern are returned. If omitted, `*` is used as the GLOB pattern. Note that there are several parameters that W3 uses internally. Those internal-use parameters all have names that begin with ".". + <a name='allow-xorigin'></a>**w3-allow-xorigin-params** Query parameters and POST parameters are usually only parsed and added to the set of parameters available to "w3-param" for same-origin requests. This restriction helps prevent cross-site request forgery (CSRF) attacks. Query-only web pages for which it is safe to accept cross-site query parameters can invoke this routine to cause query parameters to be decoded. + **w3-mimetype** _MIMETYPE_ Set the MIME-type for the generated web page. The default is "text/html". + **w3-reply-code** _CODE_ Set the reply-code for the HTTP request. The default is "200 Ok". If this value is set to ABORT (with no numeric code, just the 5 upper-case letters "ABORT") then W3 will drop the connection without sending any reply at all. + **w3-redirect** _TARGET-URL_ Cause an HTTP redirect to _TARGET-URL_. + **w3-reset** Reset the web page under construction back to an empty string. + **w3-set-cookie** _NAME_ _VALUE_ Cause the cookie _NAME_ to be set to _VALUE_. + **w3-clear-cookie** _NAME_ Erase the cookie _NAME_. + **w3-safety-check** Examine all TCL procedures in the application and return a text string containing warnings about unsafe usage of W3 commands. This command is run automatically if the "w3-start" command is invoked with a --lint option. + **w3-cache-control** _CONTROL_ The _CONTROL_ argument should be one of "no-cache", "max-age=N", or "private,max-age=N", where N is an integer number of seconds. + <a name='csp'></a>**w3-content-security-policy** _POLICY_ Set the Content Security Policy (hereafter "CSP") to _POLICY_. The default CSP is _default\_src 'self'_, which is very restrictive. The default CSP disallows (a) loading any resources from other origins, (b) the use of eval(), and (c) in-line javascript or CSS of any kind. Set _POLICY_ to "off" to completely disable the CSP mechanism. Or specify some other policy suitable for the needs of the application. <p>The following allows inline images using <img src='data:...'> and inline "style='...'" attributes, but restricts all other attack vectors and thus seems to be a good choice for many applications: <blockquote><pre> w3-content-security-policy { default-src 'self' data:; style-src 'self' 'unsafe-inline'; }</pre><blockquote> + <a name="debug-env"></a>**w3-debug-env** This routine returns text that describes all of the W3 parameters. Use it to get a parameter dump for troubleshooting purposes. + **w3** _TEXT_ Add _TEXT_ to the web page output currently under construction. No interpretation or transformation of _TEXT_ is performed. The _TEXT_ is appended to the output as-is. + **w3-unsafe** _TEXT_ Add _TEXT_ to the web page under construction even though _TEXT_ does contain TCL variable and command substitutions. The application developer must ensure that the variable and command substitutions does not allow XSS attacks. Avoid using this command. The use of "w3-subst" is preferred in most situations. |
Changes to docs/compiling.md.
1 2 3 4 5 6 | How To Compile, Or Not ====================== 1.0 Use As Pure Tcl - No Compilation Required --------------------------------------------- | | | | | | | | | | | | | | 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 | How To Compile, Or Not ====================== 1.0 Use As Pure Tcl - No Compilation Required --------------------------------------------- The W3 framework is pure Tcl contained in a single file called "[w3.tcl](/file/wapp.tcl)". That, and a generic "tclsh", is all you need to run a W3 application. For example, when testing W3, the developers run the following command from the root of the source tree: > tclsh tests/test01.tcl The [test01.tcl](/file/tests/test01.tcl) script does a "source ../wapp.tcl" to load the W3 framework. No special interpreter is required. The [search function](https://sqlite.org/search) of the SQLite homepage takes this one step further. The Tcl script that implements the search function embeds the wapp.tcl script when the website is built. The "wapp.tcl" is neither "source"-ed nor "package require"-ed. The wapp.tcl script is embedded into the "search" script. 2.0 Using A Special Interpreter ------------------------------- It is sometimes convenient to use the special "wapptclsh" interpreter to run W3 applications. The "wapptclsh" works just like ordinary "tclsh" with the following minor differences: + W3tclsh understands "package require wapp" natively, without any extra finagling. + W3tclsh comes with SQLite built-in. SQLite turns out to be very handy for the kinds of small web applications that W3 is designed for. + W3tclsh builds are (by default) statically linked, so that it works inside chroot jails that lack all the shared libraries needed by generic "tclsh". To reiterate: "wapptclsh" is not required to run W3 applications. But it is convenient. The developer of W3 prefers using "wapptclsh" on his installations. 2.1 Compiling The Special Interpreter ------------------------------------- To build wapptclsh, make a copy of either Makefile or Makefile.macos in the top-level directory of the source tree. Change a few settings. (This step is not hard as each Makefile is less than 20 lines long.) Then run the Makefile. |
︙ | ︙ |
Changes to docs/debughints.md.
|
| | | | | | | | | | | 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 | Hints For Debugging W3 Applications ===================================== Here are some suggestions for debugging W3 applications: + If it seems like the [w3-param](commands.md#w3-param) command is not working correctly, that might be because the same-origin policy is preventing query parameters from being parsed. Try adding the [w3-allow-xorigin-parameters](commands.md#allow-xorigin) command to the top of the page generator proc, at least temporarily, to see if that clears the problem. + If parts of your webpage do not appear to be working, that might be due to the restrictive default [Content Security Policy (CSP)](https://en.wikipedia.org/wiki/Content_Security_Policy) that W3 uses. Try temporarily disabling the CSP using a command like <blockquote><b>w3-content-security-policy off</b></blockquote> near the top of your page-generator proc. + Temporarily insert the output of the [w3-debug-env](commands.md#debug-env) command in your output to see what is going on. Example: > > w3-trim { <h1>Environment</h1> <pre>%html([w3-debug-env])</pre> } |
Changes to docs/development.md.
|
| | | | | | | | | 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 | Developing Applications Using W3 ================================== You can use whatever development practices you are comformable with. But if you want some hints for getting started, consider the following: 1. Compile the "w3tclsh" executable. You do not need a separate interpreter to run W3. A standard "tclsh" will work fine. But "w3tclsh" contains the a built-in copy of "w3.tcl" and it has SQLite compiled in. We find it convenient to use. The sequel will assume you have "w3tclsh" somewhere on your $PATH. 2. Seed your application using one of the templates scripts in the [examples](/file/examples) folder of this repository. Verify that you can run the template and that it works. 3. Make a few simple changes to the code. 4. Run "w3tclsh yourcode.tcl" to test your changes. Use the --trace option to list each HTTP request URI as it is encountered. Use the --lint option to scan the application code for dodgy constructs that might be a security problem. 5. Goto 3. Continue looping until your application does what you want. 6. Move the application script to your server for deployment. During the loop between steps (3) and (5), there is no web server sitting in between the application and your browser, which means there is no translation or interpretation of traffic. This can help make debugging easier. Also, you can add "puts" commands to the application to get interactive debugging in the shell that ran the "w3tclsh yourcode.tcl" command while the application is running. |
Changes to docs/doclist.html.
|
| | | | | | | | | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 | <div class='fossil-doc' data-title='W3 Documentation Index'> <center> <form action='$ROOT/docsrch' method='GET'> <input type="text" name="s" size="40" autofocus> <input type="submit" value="Search Docs"> </form> </center> <h1>Primary Documents</h1> <ul> <li><a href="$ROOT/doc/trunk/docs/intro.md">Introduction To Writing W3 Applications</a></li> <li><a href="$ROOT/doc/trunk/docs/quickref.md">Quick Reference</a></li> <li><a href="$ROOT/doc/trunk/docs/params.md">W3 Parameters</a></li> <li><a href="$ROOT/doc/trunk/docs/commands.md">W3 Commands</a></li> <li><a href="$ROOT/doc/trunk/docs/urlmapping.md">URL Mapping</a></li> <li><a href="$ROOT/doc/trunk/docs/security.md">Security Features</a></li> <li><a href="$ROOT/doc/trunk/docs/compiling.md">How To Compile w3tclsh - Or Not</a></li> <li><a href="$ROOT/doc/trunk/docs/limitations.md">Limitations of W3</a></li> <li><a href="$ROOT/file/examples">Example Applications</a></li> <li><a href="$ROOT/doc/trunk/docs/usageexamples.md">Real-World Uses Of W3</a></li> </ul> </div> |
Changes to docs/download.md.
1 2 3 4 5 6 | Downloads ========= Complete Source Bundles ----------------------- | | | | | | | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 | Downloads ========= Complete Source Bundles ----------------------- * [Tarball](/tarball/w3.tar.gz) * [ZIP Archive](/zip/w3.zip) * [SQL Archive](/sqlar/w3.sqlar) ← [what is this?](https://sqlite.org/sqlar) Just The w3.tcl Script ------------------------ * [w3.tcl](/file/wapp.tcl) To Clone The Repository ----------------------- > fossil clone https://wapp.tcl.tk/index.html wapp.fossil fossil open wapp.fossil |
Changes to docs/helloworld.md.
1 2 3 | Hello World =========== | | | | | | | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | Hello World =========== Here is a "Hello, World!" web application written using W3: > #!/usr/bin/tclsh package require w3 proc w3-default {} { w3-subst {<h1>Hello, World!</h1>\n} } w3-start $argv To run this application using the built-in web-server, store the code above in a file (here we use the name "hello.tcl") and do: > tclsh hello.tcl |
︙ | ︙ | |||
30 31 32 33 34 35 36 | To run the application as CGI, make the hello.tcl file executable and move it into the appropriate directory of the web server. Further Information ------------------- | | | | | | | | 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 | To run the application as CGI, make the hello.tcl file executable and move it into the appropriate directory of the web server. Further Information ------------------- * [Introduction To Writing W3 Applications](/doc/trunk/docs/intro.md) * [Quick Reference](/doc/trunk/docs/quickref.md) * [W3 Parameters](/doc/trunk/docs/params.md) * [W3 Commands](/doc/trunk/docs/commands.md) * [URL Mapping](/doc/trunk/docs/urlmapping.md) * [Security Features](/doc/trunk/docs/security.md) * [How To Compile w3tclsh - Or Not](/doc/trunk/docs/compiling.md) * [Limitations of W3](/doc/trunk/docs/limitations.md) * [Example Applications](/file/examples) * [Real-World Uses Of W3](/doc/trunk/docs/usageexamples.md) * [Debugging Hints](/doc/trunk/docs/debughints.md) |
Changes to docs/intro.md.
|
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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 | Introducing To Writing W3 Applications ======================================== 1.0 Hello World --------------- W3 applications are easy to develop. A hello-world program is as follows: > #!/usr/bin/w3tclsh package require w3 proc w3-default {} { w3-subst {<h1>Hello, World!</h1>\n} } w3-start $::argv Every W3 application defines one or more procedures that accept HTTP requests and generate appropriate replies. For an HTTP request where the initial portion of the URI path is "abcde", the procedure named "w3-page-abcde" will be invoked to construct the reply. If no such procedure exists, "w3-default" is invoked instead. The latter technique is used for the hello-world example above. The hello-world example generates the reply using a single call to the "w3-subst" command. Each "w3-subst" command appends new text to the reply, applying various substitutions as it goes. The only substitution in this example is the \\n at the end of the line. The "w3-start" command starts up the application. 1.1 Running A W3 Application ------------------------------ To run this application, copy the code above into a file named "main.tcl" and then enter the following command: > w3tclsh main.tcl That command will start up a web-server bound to the loopback IP address, then launch a web-browser pointing at that web-server. The result is that the "Hello, World!" page will automatically appear in your web browser. To run this same program as a traditional web-server on TCP port 8080, enter: > w3tclsh main.tcl --server 8080 Here the built-in web-server listens on all IP addresses and so the web page is available on other machines. But the web-browser is not automatically started in this case, so you will have to manually enter "http://localhost:8080/" into your web-browser in order to see the page. To run this program as CGI, put the main.tcl script in your web-servers file hierarchy, in the appropriate place for CGI scripts, and make any other web-server specific configuration changes so that the web-server understands that the main.tcl file is a CGI script. Then point your web-browser at that script. Run the hello-world program as SCGI like this: > w3tclsh main.tcl --scgi 9000 Then configure your web-server to send SCGI requests to TCP port 9000 for some specific URI, and point your web-browser at that URI. By default, the web-server must be on the same machine as the w3 script. The --scgi option only accepts SCGI requests from IP address 127.0.0.1. If your webserver is running on a different machine, use the --remote-scgi option instead, probably with a --fromip option to specify the IP address of the machine that is running the webserver. 1.2 Using Plain Old Tclsh ------------------------- W3 applications are pure TCL code. You can run them using an ordinary "tclsh" command if desired, instead of the "w3tclsh" shown above. We normally use "w3tclsh" for the following reasons: + W3tclsh is statically linked, so there is never a worry about having the right shared libraries on hand. This is particularly important if the application will ultimately be deployed into a chroot jail. + W3tclsh has SQLite built-in and SQLite turns out to be very useful for the kinds of small applications where W3 excels. + W3tclsh knows how to process "package require w3". If you run with ordinary tclsh, you might need to change the "package require w3" into "source w3.tcl" and ship the separate "w3.tcl" script together with your application. We prefer to use w3tclsh and w3tclsh is shown in all of the examples. But ordinary "tclsh" will work in the examples too. 2.0 Longer Examples ------------------- W3 keeps track of various [parameters](params.md) that describe each HTTP request. Those parameters are accessible using routines like "w3-param _NAME_" The following sample program gives some examples: > package require w3 proc w3-default {} { set B [w3-param BASE_URL] w3-trim { <h1>Hello, World!</h1> <p>See the <a href='%html($B)/env'>W3 Environment</a></p> } } proc w3-page-env {} { w3-allow-xorigin-params w3-subst {<h1>W3 Environment</h1>\n<pre>\n} foreach var [lsort [w3-param-list]] { if {[string index $var 0]=="."} continue w3-subst {%html($var) = %html([list [w3-param $var]])\n} } w3-subst {</pre>\n} } w3-start $argv In this application, the default "Hello, World!" page has been extended with a hyperlink to the /env page. The "w3-subst" command has been replaced by "w3-trim", which works the same way with the addition that it removes surplus whitespace from the left margin, so that the generated HTML text does not come out indented. The "w3-trim" and "w3-subst" commands in this example use "%html(...)" substitutions. The "..." argument is expanded using the usual TCL rules, but then the result is escaped so that it is safe to include in an HTML document. Other supported substitutions are "%url(...)" for URLs on the href= and src= attributes of HTML entities, "%qp(...)" for query parameters, "%string(...)" for string literals within javascript, and "%unsafe(...)" for direct literal substitution. As its name implies, the %unsafe() substitution should be avoided whenever possible. The /env page is implemented by the "w3-page-env" proc. This proc generates HTML that describes all of the query parameters. Parameter names that begin with "." are for internal use by W3 and are skipped for this display. Notice the use of "w3-subst" to safely escape text for inclusion in an HTML document. The printing of all the parameters as is done by the /env page turns out to be so useful that there is a special "w3-debug-env" command to render the text for us. Using "w3-debug-env", the program above can be simplified to the following: > package require w3 proc w3-default {} { set B [w3-param BASE_URL] w3-trim { <h1>Hello, World!</h1> <p>See the <a href='%html($B)/env'>W3 Environment</a></p> } } proc w3-page-env {} { w3-allow-xorigin-params w3-trim { <h1>W3 Environment</h1>\n<pre> <pre>%html([w3-debug-env])</pre> } } w3-start $argv Many W3 applications contain an /env page for debugging and trouble-shooting purpose. Examples: <https://sqlite.org/src/ext/checklist/top/env> and <https://sqlite.org/search?env=1> 2.1 Binary Resources -------------------- Here is another variation on the same "hello, world" program that adds an image to the main page: > package require w3 proc w3-default {} { set B [w3-param BASE_URL] w3-trim { <h1>Hello, World!</h1> <p>See the <a href='%html($B)/env'>W3 Environment</a></p> <p>Broccoli: <img src='broccoli.gif'></p> } } proc w3-page-env {} { w3-allow-xorigin-params w3-trim { <h1>W3 Environment</h1>\n<pre> <pre>%html([w3-debug-env])</pre> } } proc w3-page-broccoli.gif {} { w3-mimetype image/gif w3-cache-control max-age=3600 w3-unsafe [binary decode base64 { R0lGODlhIAAgAPMAAAAAAAAiAAAzMwBEAABVAABmMwCZMzPMM2bMM5nMM5nMmZn/ mczMmcz/mQAAAAAAACH5BAEAAA4ALAAAAAAgACAAAAT+0MlJXbmF1M35VUcojNJI dh5YKEbRmqthAABaFaFsKG4hxJhCzSbBxXSGgYD1wQw7mENLd1FOMa3nZhUauFoY K/YioEEP4WB1pB4NtJMMgTCoe3NWg2lfh68SCSEHP2hkYD4yPgJ9FFwGUkiHij87 ZF5vjQmPO4kuOZCIPYsFmEUgkIlJOVcXAS8DSVoxB0xgA6hqAZaksiCpPThghwO6 i0kBvb9BU8KkASPHfrXAF4VqSgAGAbpwDgRSaqQXrLwDCF5CG9/hpJKkb17n6RwA 18To7whJX0k2NHYjtgXoAwCWPgMM+hEBIFDguDrjZCBIOICIg4J27Lg4aGCBPn0/ FS1itJdNX4OPChditGOmpIGTMkJavEjDzASXMFPO7IAT5M6FBvQtiPnTX9CjdYqi cFlgoNKlLbbJfLqh5pAIADs= }] } w3-start $argv This application is the same as the previous except that it adds the "broccoli.gif" image on the main "Hello, World" page. The image file is a separate resource, which is provided by the new "w3-page-broccoli.gif" proc. The image is a GIF which has been encoded using base64 so that it can be put into an text TCL script. The "[binary decode base64 ...]" command is used to convert the image back into binary before returning it. Other resources might be added using procs like "w3-page-style.css" or "w3-page-script.js". 3.0 General Structure Of A W3 Application ------------------------------------------- W3 applications all follow the same basic template: > package require w3; proc w3-page-XXXXX {} { # code to generate page XXXXX } proc w3-page-YYYYY {} { # code to generate page YYYYY } proc w3-default {} { # code to generate any page not otherwise # covered by w3-page-* procs } w3-start $argv The application script first loads the W3 code itself using the "package require" at the top. (Some applications may choose to substitute "source w3.tcl" to accomplish the same thing.) Next the application defines various procs that will generate the replies to HTTP requests. Different procs are invoked based on the first element of the URI past the W3 script name. Finally, the "w3-start" routine is called to start W3 running. The "w3-start" routine never returns (or in the case of CGI, it only returns after the HTTP request has been completely processed), so it should be the very last command in the application script. 3.1 W3 Applications As Model-View-Controller ---------------------------------------------- If you are accustomed to thinking of web applications using the Model-View-Controller (MVC) design pattern, W3 supports that point of view. A basic template for an MVC W3 application is like this: > package require w3; # procs to implement the model go here proc w3-page-XXXXX {} { # code to implement controller for XXXXX # code to implement view for XXXXX } proc w3-page-YYYYY {} { # code to implement controller for YYYYY # code to implement view for YYYYY } proc w3-default {} { # code to implement controller for all other pages # code to implement view for all other pages } w3-start $argv The controller and view portions of each page need not be coded together into the same proc. They can each be sub-procs that are invoked from the main proc, if separating the functions make code clearer. So W3 does support MVC, but without a lot of complex machinary and syntax. |
Changes to docs/limitations.md.
1 2 3 | Wapp Limitations ================ | | | | 1 2 3 4 5 6 7 8 9 10 11 12 13 | Wapp Limitations ================ The current W3 implementation has the following limitations: 1. The actual page generation step is single threaded. Multiple connections can be incoming and multiple replies can be in-flight at the same time. But the generation of each reply happens all at once. <p> This limitation can be worked around by deploying the W3 application using CGI, such that each HTTP request is handled by a separate process. |
Changes to docs/params.md.
1 2 3 | Wapp Parameters =============== | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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 | Wapp Parameters =============== The purpose of a W3 invocation is to answer an HTTP request. That HTTP request is described by various "parameters". Each parameter has a key and a value. The W3 application retrieves the value for the parameter with key _NAME_ using a call to [w3-param _NAME_]. If there is no parameter with the key _NAME_, then the w3-param function returns an empty string. Or, if w3-param is given a second argument, the value of the second argument is returned if there exists no parameter with a key of _NAME_. 1.0 Parameter Types ------------------- Each request has four different kinds or sources of parameters: 1. **CGI Parameters** Parameters with upper-case names contain information about the HTTP request as it was received by the web server. Examples of CGI parameters are CONTENT\_LENGTH which is the number of bytes of content in the HTTP request, REMOTE\_ADDR which holds the IP address from which the HTTP request originated, REQUEST\_URI which is the path component of the URL that caused the HTTP request, and many others. Many of the CGI Parameters have names that are the same as the traditional environment variables used to pass information into CGI programs - hence the name "CGI Parameters". However, with W3 these values are not necessarily environment variables and they all exist regardless of whether the application is run using CGI, via SCGI, or using the built-in web server. 2. **Cookies** If the HTTP request contained cookies, W3 automatically decodes the cookies into new W3 parameters. Only cookies that have lower-case names are decoded. This prevents a cookie name from colliding with a CGI parameter. Cookies that have uppercase letters in their name are silently ignored. 3. **Query Parameters** Query parameters are the key/value arguments that follow the "?" in the URL of the HTTP request. W3 automatically decodes the key/value pairs and makes a new W3 parameter for each one. <p> Only query parameter that have lower-case names are decoded. This prevents a query parameter from overriding or impersonating a CGI parameter. Query parameter with upper-case letters in their name are silently ignored. Furthermore, query parameters are only decoded if the HTTP request uses the same origin as the application, or if the "w3-allow-xorigin-params" has been run to signal W3 that cross-origin query parameters are allowed. 4. **POST Parameters** POST parameters are the application/x-www-form-urlencoded key/value pairs in the content of a POST request that typically originate from forms. POST parameters are treated exactly like query parameters in that they are decoded to form new W3 parameters as long as they have all lower-case keys and as long as either the HTTP request comes from the same origin or the "w3-allow-xorigin-params" command has been run. All W3 parameters are held in a single namespace. There is no way to distinguish a cookie from a query parameter from a POST parameter. CGI parameters can be distinguished from the others by having all upper-case names. 1.1 Parameter Examples ---------------------- To better understand how parameters work in W3, run the "[env.tcl](/file/examples/env.tcl)" sample application in the [examples](/file/examples) folder of the source repository. Like this: > w3tclsh examples/env.tcl The command above should cause a web page to pop up in your web browser. That page will look something like this: >**W3 Environment** > BASE_URL = http://127.0.0.1:33999 DOCUMENT_ROOT = /home/drh/w3/examples HTTP_ACCEPT_ENCODING = {gzip, deflate} HTTP_COOKIE = {env-cookie=simple} HTTP_HOST = 127.0.0.1:33999 HTTP_USER_AGENT = {Mozilla/5.0 (X11; Linux x86_64; rv:59.0) Gecko/20100101 Firefox/59.0} PATH_HEAD = {} PATH_INFO = {} PATH_TAIL = {} QUERY_STRING = {} REMOTE_ADDR = 127.0.0.1 REMOTE_PORT = 53060 REQUEST_METHOD = GET REQUEST_URI = / SAME_ORIGIN = 0 SCRIPT_FILENAME = /home/drh/w3/examples/env.tcl SCRIPT_NAME = {} SELF_URL = http://127.0.0.1:33999/ W3_MODE = local env-cookie = simple [pwd] = /home/drh/w3 Try this. Then modify the URL by adding new path elements and query parameters to see how this affects the W3 parameters. Notice in particular how query parameters are decoded and added to the set of W3 parameters. 2.0 Security By Default ----------------------- Parameter values in the original HTTP request may be encoded in various ways. W3 decodes parameter values before returning them to the application. Application developers never see the encoded values. There is never an opportunity to miss a decoding step. For security reasons, Query and POST parameters are only added to the W3 parameter set if the inbound request is from the "same origin" or if the special "w3-allow-xorigin-params" interface is called. An inbound request is from the same origin if it is in response to clicking on a hyperlink or form on a page that was generated by the same website. Manually typing in a URL does not constitute the "same origin". Hence, in the "env.tcl" example above the "w3-allow-xorigin-params" interface is used so that you can manually extend the URL to add new query parameters. If query parameters can have side effects, then you should omit the w3-allow-xorigin-params call. The w3-allow-xorigin-params command is safe for read-only web pages. Do not invoke w3-allow-xorigin-params on pages where the parameters can be used to change server state. <a name='cgidetail'></a> 3.0 CGI Parameter Details [(Quick reference)](quickref.md#cgiparams) ------------------------- The CGI parameters in W3 describe the HTTP request that is to be answered and the execution environment. These parameter look like CGI environment variables. To prevent environment information from overlapping and overwriting query parameters, all the environment information uses upper-case names and all query parameters are required to be lower case. If an input URL contains an upper-case query parameter (or POST parameter or cookie), that parameter is silently omitted. |
︙ | ︙ | |||
155 156 157 158 159 160 161 | + **CONTENT\_TYPE** The mimetype of the POST data. Usually this is application/x-www-form-urlencoded. This parameter is omitted for non-POST requests. + **DOCUMENT\_ROOT** For CGI or SCGI, this parameter is the name a directory on the server | | | 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 | + **CONTENT\_TYPE** The mimetype of the POST data. Usually this is application/x-www-form-urlencoded. This parameter is omitted for non-POST requests. + **DOCUMENT\_ROOT** For CGI or SCGI, this parameter is the name a directory on the server that is the root of the static content tree. When running a W3 script using the built-in web server, this is the name of the directory that contains the script. + **HTTP\_COOKIE** The values of all cookies in the HTTP header. This parameter is omitted if there are no cookies. |
︙ | ︙ | |||
202 203 204 205 206 207 208 | "https://" and without the HTTP\_HOST. This variable is the same as the concatenation of $SCRIPT\_NAME and $PATH\_INFO if $QUERY\_STRING is blank, or $SCRIPT\NAME/$PATH\_INFO?$QUERY\_STRING if $QUERY\_STRING is non-empty. $REQUEST\_URI is the second field of the first line of the HTTP request. + **SCRIPT\_FILENAME** | | | | | | | | | | | 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 | "https://" and without the HTTP\_HOST. This variable is the same as the concatenation of $SCRIPT\_NAME and $PATH\_INFO if $QUERY\_STRING is blank, or $SCRIPT\NAME/$PATH\_INFO?$QUERY\_STRING if $QUERY\_STRING is non-empty. $REQUEST\_URI is the second field of the first line of the HTTP request. + **SCRIPT\_FILENAME** The full pathname on the server for the W3 script. This parameter is usually undefined for SCGI. + **SCRIPT\_NAME** In CGI mode, this is the name of the CGI script in the URL. In other words, this is the initial part of the URL path that identifies the CGI script. When using the built-in webserver, the value of this parameter is an empty string. For SCGI, this parameter is normally undefined. All of the above are standard CGI environment values. The following are supplemental environment parameters are added by W3: + **BASE\_URL** The text of the request URL through the SCRIPT\_NAME. This value can be prepended to hyperlinks to ensure that the correct page is reached by those hyperlinks. + **CONTENT** The raw POST data text. + **PATH\_HEAD** The first element in the PATH\_INFO. The value of PATH\_HEAD is used to select one of the "w3-page-XXXXX" commands to run in order to generate the output web page. + **PATH\_TAIL** All of PATH\_INFO that follows PATH\_HEAD. + **SAME\_ORIGIN** This value is either "1" or "0" depending on whether the current HTTP request is a follow-on to another request from this same website or not. Query parameters and POST parameters are usually only decoded and added to W3's parameter list if SAME\_ORIGIN is 1. If a webpage implemented by W3 needs access to query parameters for a cross-origin request, then it should invoke the "w3-allow-xorigin-params" interface to explicitly signal that cross-origin parameters are safe for that page. + **SELF\_URL** The URL for the current page, stripped of query parameter. This is useful for filling in the action= attribute of forms. + **SERVER\_ADDR** In SCGI mode only, this variable is the address of the webserver from which the SCGI request originates. + **W3\_MODE** This parameter has a value of "cgi", "local", "scgi", or "server" depending on how W3 was launched. ### 3.1 URL Parsing Example For the input URL "http://example.com/cgi-bin/script/method/extra/path?q1=5" and for a CGI script named "script" in the /cgi-bin/ directory, the following CGI environment values are generated: + **HTTP\_HOST** → "example.com:80" + **SCRIPT\_NAME** → "/cgi-bin/script" + **PATH\_INFO** → "/method/extra/path" + **REQUEST\_URI** → "/cgi-bin/script/method/extra/path" + **QUERY\_STRING** → "q1=5" + **BASE\_URL** → "http://example.com/cgi-bin/script" + **SELF\_URL** → "http://example.com/cgi-bin/script/method" + **PATH\_HEAD** → "method" + **PATH\_TAIL** → "extra/path" The first five elements of the example above, HTTP\_HOST through QUERY\_STRING, are standard CGI. The final four elements are W3 extensions. The following is the same information show in a diagram: > REQUEST_URI __________________|_________________ / \ http://example.com/cgi-bin/script/method/extra/path?q1=5 |
︙ | ︙ |
Changes to docs/quickref.md.
1 2 3 4 5 6 7 | Wapp Quick Reference ==================== 1.0 Application Template ------------------------ > | | | | | | | | | | | | | | | | 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 | Wapp Quick Reference ==================== 1.0 Application Template ------------------------ > package require w3 proc w3-page-XXXXX {} { w3-trim { # Content to deliver for page XXXXX } } proc w3-default {} { w3-trim { # Content for all other pages } } w3-start $argv 2.0 Interfaces -------------- > |**w3-start** $argv|→|Starts up the W3 application| |**w3-subst** {_TEXT_}|→|Append _TEXT_ to the output with substitution| |**w3-trim** {_TEXT_}|→|Like **wapp-subst** but also removes left-margin whitespace| |**wapp-param** _NAME_ _DEFAULT_|→|Return value of parameter _NAME_| |**wapp-set-param** _NAME_ _VALUE_|→|Set parameter _NAME_ to _VALUE_| |**wapp-param-exists** _NAME_|→|True if parameter _NAME_ exists| |**wapp-param-list** _GLOB_|→|Return parameter names matching _GLOB_| |**wapp-allow-xorigin-params**|→|Allow GET and POST parameters for cross-origin requests| |**wapp-mimetype** _MIMETYPE_|→|Set the reply mimetype| |**wapp-reply-code** _CODE_|→|Set the HTTP reply code| |**wapp-redirect** _TARGET_|→|Redirect to _TARGET_| |**wapp-reset**|→|Reset the output back to an empty string| |**wapp-set-cookie** _NAME_ _VALUE_|→|Set cookie _NAME_ to have _VALUE_| |**wapp-clear-cookie** _NAME_|→|Delete cookie _NAME_| |**wapp-cache-control** _CONTROL_|→|Set caching behavior of current page| |**wapp-content-security-policy** _POLICY_|→|Set the CSP for the current page| |**wapp-debug-env**|→|Return a text description of the W3 environment| |**wapp** {_TEXT_}|→|Append _TEXT_ without substitution| |**wapp-unsafe** _TEXT_|→|Append _TEXT_ that contains nothing that needs to be escaped| <a name="cgiparams"></a> 3.0 CGI Parameters [(More detail)](params.md#cgidetail) ------------------ > |BASE\_URL|→|URL for the W3 script without a method| |CONTENT|→|Raw (unparsed) POST content| |CONTENT\_LENGTH|→|Number of bytes of raw, unparsed POST content| |CONTENT\_TYPE|→|Mimetype of the POST content| |DOCUMENT\_ROOT|→|Directory that is the root of the webserver content tree| |HTTP\_COOKIE|→|Raw, unparsed cookies| |HTTP\_HOST|→|Hostname to which this request was sent| |HTTP\_USER\_AGENT|→|Name of client program that sent current request| |HTTPS|→|Exists and has value "on" if the request is TLS encrypted| |PATH\_HEAD|→|First element of PATH\_INFO. Determines request handler| |PATH\_INFO|→|URL path beyond the application script name| |PATH\_TAIL|→|Part of PATH\_INFO beyond PATH\_HEAD| |REMOTE\_ADDR|→|IP address of the client| |REMOTE\_PORT|→|TCP port of the client| |REQUEST\_METHOD|→|"GET" or "POST" or "HEAD"| |SAME\_ORIGIN|→|True if this request is from the same origin| |SCRIPT\_FILENAME|→|Full pathname of the W3 application script| |SCRIPT\_NAME|→|Prefix of PATH\_INFO that identifies the application script| |SELF\_URL|→|URL of this request without PATH\_TAIL| |SERVER\_ADDR|→|IP address of the webserver sending an SCGI request| |W3\_MODE|→|One of "cgi", "scgi", "remote-scgi", "server", or "local"| 4.0 URL Parsing --------------- Assuming "env.tcl" is the name of the W3 application script: > https://wapp.tcl.tk/demo/env.tcl/abc/def/ghi?a=5&b=22.425#point42 \_________/\___________/\__________/ \__________/ | | | | HTTP_HOST SCRIPT_NAME PATH_INFO QUERY_STRING |
︙ | ︙ |
Changes to docs/security.md.
1 2 3 | Security Considerations ======================= | | | | | | | | | | | | | | 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 | Security Considerations ======================= W3 strives for security by default. Applications can disable security features on an as-needed basis, but the default setting for security features is always "on". Security features in W3 include: 1. The default [Content Security Policy](https://en.wikipedia.org/wiki/Content_Security_Policy) ("CSP") for all W3 applications is _default-src 'self'_. In that mode, resources must all be loaded from the same origin, the use of eval() and similar commands in javascript is prohibited, and no in-line javascript or CSS is allowed. These limitations help keep applications safe from [XSS attacks](https://en.wikipedia.org/wiki/Cross-site_scripting), even in the face of application coding errors. If these restrictions are too severe for an application, the CSP can be relaxed or disabled using the "[w3-content-security-policy](commands.md#csp)" command. 2. Access to GET query parameters and POST parameters is prohibited unless the origin of the request is the application itself, as determined by the Referrer field in the HTTP header. This feature helps to prevent [Cross-site Request Forgery](https://en.wikipedia.org/wiki/Cross-site_request_forgery) attacks. The "[w3-allow-xorigin-params](commands.md#allow-xorigin)" command can be used to disable this protection on a case-by-case basis. 3. Cookies, query parameters, and POST parameters are automatically decoded before they reach application code. There is no risk that the application program will forget a decoding step or accidently miscode a decoding operation. 4. Cookies, query parameters, and POST parameters are silently discarded unless their names begin with a lower-case letter and contain only alphanumerics, underscores, and minus-signs. Hence, there is no risk that unusual parameter names can cause quoting problems or other vulnerabilities. 5. Reply text generated using the "[w3-subst](commands.md#w3-subst)" and "[w3-trim](commands.md#w3-trim)" commands automatically escapes generated text so that it is safe for inclusion within HTML, within a javascript or JSON string literal, as a URL, or as the value of a query parameter. As long as the application programmer is careful to always use "w3-subst" and/or "w3-trim" to generate replies, there is little risk of injection attacks. 6. If the application is launched on a command-line with the --lint option, then instead of running the application, W3 scans the application code looking for constructs that are unsafe. Unsafe constructs include things such as using "[w3-subst](commands.md#w3-subst)" with an argument that is not contained within {...}. 7. The new (non-standard) SAME\_ORIGIN variable is provided. This variable has a value of "1" or "0" depending on whether or not the current HTTP request comes from the same origin. Applications can use this information to enhance their own security precautions by refusing to provide sensitive information or perform sensitive actions if SAME\_ORIGIN is not "1". 8. The --scgi mode only accepts SCGI requests from localhost. This prevents an attacker from sending an SCGI request directly to the script and bypassing the webserver in the event that the site firewall is misconfigured or omitted. 9. Though cookies, query parameters and POST parameters are accessed using the same mechanism as CGI variables, the CGI variable names use a disjoint namespace. (CGI variables are all upper-case and all others are lower-case.) Hence, it is not possible for a remote attacher to create a fake CGI variable or override the value of a CGI variable. Part of what makes W3 easy to use is that it helps free application developers from the worry of accidently introducing security vulnerabilities via programming errors. Of course, no framework is fool-proof. Developers still must be aware of security. W3 does not prevent every error, but it does help make writing a secure application easier and less stressful. |
Changes to docs/subst.md.
1 2 3 | Inserting Generated Text Into A Document ======================================== | | | 1 2 3 4 5 6 7 8 9 10 11 | Inserting Generated Text Into A Document ======================================== The [w3-subst](./commands.md#wapp-subst) and [wapp-trim](./commands.md#wapp-trim) commands accept various substitution functions so that generated content can be inserted into the webpage <i>safely</i>. "Safely" in this context means that characters having special meaning to HTML or Javascript are escaped. <center> <table border="0"> |
︙ | ︙ | |||
55 56 57 58 59 60 61 | In these cases, the regular expression terminates at the first ")%" that it sees, rather than the first ")". The ")%" character sequence is is less likely to appear as TCL in the argument and hence these routines provide added flexibility for complex TCL expressions. ## Examples | | | 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 | In these cases, the regular expression terminates at the first ")%" that it sees, rather than the first ")". The ")%" character sequence is is less likely to appear as TCL in the argument and hence these routines provide added flexibility for complex TCL expressions. ## Examples Consider this simple W3 program: > package require wapp proc wapp-default {} { set var1 {Hello <y'all>} wapp-subst {<p>%html($var1)</p>} } |
︙ | ︙ |
Changes to docs/urlmapping.md.
|
| | | | | | | | | | | | | | | | | | | | | | 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 | URL Mapping In W3 =================== 1.0 Anatomy Of A URL -------------------- A Uniform Resource Locator (URL) is divided into parts as follows: > https://w3.tcl.tk/demo/env.tcl/abc/def/ghi?a=5&b=22.425#point42 \___/ \_______/\_______________________/ \__________/ \_____/ | | | | | scheme authority path query fragment Assuming that /demo/env.tcl is the script that implements the application, traditional CGI and SCGI provide the following breakdown: > https://w3.tcl.tk/demo/env.tcl/abc/def/ghi?a=5&b=22.425#point42 \_______/\___________/\__________/ \__________/ | | | | HTTP_HOST SCRIPT_NAME PATH_INFO QUERY_STRING W3 provides additional variables not found in traditional CGI: > SELF_URL ______________|___________________ / \ https://w3.tcl.tk/demo/env.tcl/abc/def/ghi?a=5&b=22.425#point42 \____________________________/ \_/ \_____/ | | | BASE_URL PATH_HEAD '-- PATH_TAIL 2.0 URL Mapping --------------- The URL Mapper is the function that determines which routine in the application should handle an HTTP request based on the URL. In W3, the default URL Mapper simply looks at PATH\_HEAD and invokes the application-defined proc name "w3-page-$PATH\_HEAD". If no such proc exists, then W3 invokes the application-defined proc "w3-default". 2.1 Customizing The URL Mapper ------------------------------ Just prior to dispatch of the HTTP request handler, W3 invokes a proc named "w3-before-dispatch-hook". This proc is normally a no-op. But, applications can redefine the "w3-before-dispatch-hook" proc to make modifications to the environment prior to dispatch. So, for example, a custom w3-before-dispatch-hook function can change the value of the PATH\_HEAD parameter to cause a different request handler to be invoked. The [checklist](https://sqlite.org/checklistapp) application does this. See [these lines](https://sqlite.org/checklistapp/artifact/8f94882fa0?ln=715-744) for the implementation. If the original PATH\_HEAD is really the name of a checklist database, then that name is moved to a new parameter called OBJECT, and PATH\_HEAD is shifted to be the next element of PATH\_TAIL. In this way, the PATH\_INFO for checklist is parsed into OBJECT/METHOD rather than just a METHOD. This is but one example. Applications can make creative use of the "w3-before-dispatch-hook" to make whatever changes are appropriate for the task at hand. |
Changes to docs/usageexamples.md.
|
| | | | | | | | 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 | Web Applications Using W3 =========================== The following are some of the known uses of W3 in the wild: 1. The [checklist](https://sqlite.org/checklists) application used to manage testing and release of SQLite is a W3 script. Source code for the checklist application is at <https://sqlite.org/checklistapp>. 2. The [search feature](https://sqlite.org/search?q=fts5) on the SQLite homepage is implemented using a W3-script, seen [here](https://sqlite.org/docsrc/file/search/search.tcl.in). (NB: The search.tcl.in script is processed using [mkscript.tcl](https://sqlite.org/docsrc/file/search/mkscript.tcl) prior to being deployed.) 3. The [TCL-driven tests for SQLite](https://www.sqlite.org/testing.html#test_harnesses) have a W3-based interface that shows the testing progress. To see this interface in action, get a copy of the SQLite source tree and run: > configure make testfixture tclsh test/w3test.tcl |
Changes to encode-binary-file.tcl.
︙ | ︙ | |||
14 15 16 17 18 19 20 | if {$mode!="hex" && $mode!="base64"} { puts stderr "Usage: $argv0 (hex|base64) FILENAME" exit } set filename [lindex $argv 1] set fd [open $filename rb] set x [binary encode $mode [read $fd]] | | | 14 15 16 17 18 19 20 21 22 23 24 25 26 | if {$mode!="hex" && $mode!="base64"} { puts stderr "Usage: $argv0 (hex|base64) FILENAME" exit } set filename [lindex $argv 1] set fd [open $filename rb] set x [binary encode $mode [read $fd]] puts " w3-unsafe \[binary decode $mode \173" set n [string length $x] for {set i 0} {$i<$n} {incr i 64} { puts " [string range $x $i [expr {$i+63}]]" } puts " \175\]" |
Changes to examples/beforereply.tcl.
|
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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 | #!/usr/bin/w3tclsh # # This script demonstrates the use of the w3-before-reply-hook interface. # # The w3-before-reply-hook is a TCL proc that runs just before the reply # to an HTTP request is generated. It has the opportunity to review the # HTTP reply to ensure that no sensitive information is present in the # reply, due to accidents or bugs in the code. It can modify the reply # or generate an error. # # Most applications omit the w3-before-reply-hook in which case it is # a no-op. # # This demo is the "self.tcl" demo, with a w3-before-reply-hook added # that changes all instances of the string "before-reply" into "XXXXXXXXXXXX". # package require w3 proc w3-before-reply-hook {} { global w3 dict set w3 .reply \ [string map {before-reply XXXXXXXXXXXX} [dict get $w3 .reply]] } proc common-header {} { w3-trim { <html> <head> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta http-equiv="content-type" content="text/html; charset=UTF-8"> <link href="%url([w3-param SCRIPT_NAME]/style.css)" rel="stylesheet"> <title>W3 Self-Display Demo</title> </head> <body> } } proc common-footer {} { w3-trim { </body> </html> } } proc w3-default {} { w3-cache-control max-age=3600 common-header w3-trim { <h1>W3 Self-Display Demo</h1> <p>(Strings "before-reply" changed into "XXXXXXXXXXXX".)</p> <ul> <li> <a href='%url([w3-param SCRIPT_NAME])/self'>Show the script that generates this page</a> <li> <a href='%url([w3-param SCRIPT_NAME])/env'>W3 Environment</a> </ul> } common-footer } proc w3-page-env {} { w3-allow-xorigin-params common-header w3-trim { <h1>W3 Environment</h1> <pre>%html([w3-debug-env])</pre> } common-footer } proc w3-page-self {} { w3-cache-control max-age=3600 common-header set fd [open [w3-param SCRIPT_FILENAME] rb] set script [read $fd] close $fd w3-trim { <h1>W3 Script That Shows A Copy Of Itself</h1> <pre>%html($script)</pre> } common-footer } proc w3-page-style.css {} { w3-mimetype text/css w3-cache-control max-age=3600 w3-trim { pre { border: 1px solid black; padding: 1ex; } } } w3-start $argv |
Changes to examples/capture.tcl.
|
| | | | | | | | | | | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 | # This W3 script records all inbound HTTP requests. A description # of each request is stored in -SCRIPT-log.txt where SCRIPT is the base # name of this script. # package require w3 proc w3-default {} { w3-allow-xorigin-params set msg "------------ New request ---------\n" foreach var [lsort [w3-param-list]] { append msg "$var [list [w3-param $var]]\n" } set dnam [w3-param SCRIPT_FILENAME] set logfile [file dir $dnam] append logfile /- append logfile [file root [file tail $dnam]]-log.txt set out [open $logfile a] puts $out $msg close $out w3-trim {<p>Ok</p>} } w3-start $argv |
Changes to examples/env.tcl.
1 2 3 4 5 | # This script is a template used for testing. # # After making modifications to this script to test out bits of HTML # (or not - the script works fine as it is), invoke the script using # | | | | | | | | | | | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 | # This script is a template used for testing. # # After making modifications to this script to test out bits of HTML # (or not - the script works fine as it is), invoke the script using # # w3tclsh env.tcl # # All web pages show the W3 execution environment, which includes # CGI-line environment variables, decoded query and POST parameters, and # decoded cookies. # package require w3 proc w3-default {} { w3-allow-xorigin-params w3-trim { <h1>W3 Environment</h1> <pre>%html([w3-debug-env])</pre> } } w3-start $argv |
Changes to examples/externimage.tcl.
|
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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 | #!/usr/bin/w3tclsh # # This script demonstrates how W3 to return resources (such as # an image) held in separate files or in a separate SQLite database. # package require w3 # Common header and footer. proc common-header {} { w3-trim { <html> <head> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta http-equiv="content-type" content="text/html; charset=UTF-8"> <link href="%url([w3-param SCRIPT_NAME]/style.css)" rel="stylesheet"> <title>W3 External Content Demo</title> </head> <body> } } proc common-footer {} { w3-trim { </body> </html> } } # The style sheet proc w3-page-style.css {} { w3-mimetype text/css w3-cache-control max-age=3600 w3-trim { pre { border: 1px solid black; padding: 1ex; } } } # This is the default page proc w3-default {} { common-header w3-trim { <h1>External Content Demo</h1> <p>This demo shows how W3 can return resources (such as images) that are loaded from separate files on disk, or from a separate database. This demo shows two images: <p><img src="image1"><br>"plume1" <p><img src="image2"><br>"plume2" <p>Both images are the same PNG file. The first image is loaded from a separate file on disk. The second image is loaded form an SQLite database. <p>Click <a href="self">here</a> to see the complete W3 script that generates this application. } } # The /self page that returns HTML that displays a copy of this script itself proc w3-page-self {} { w3-cache-control max-age=3600 common-header set fd [open [w3-param SCRIPT_FILENAME] rb] set script [read $fd] close $fd w3-trim { <h1>Text Of The External Content Demo Script</h1> <pre>%html($script)</pre> } common-footer } # The /image1 image, read from a separate file named "plume.png" # found in the same directory as this script. # proc w3-page-image1 {} { w3-mimetype image/png set filename [file dir [w3-param SCRIPT_FILENAME]]/plume.png set fd [open $filename rb] w3 [read $fd] close $fd } # The /image2 image, read from an SQLite database named "plume.db" # found in the same directory as this script. # proc w3-page-image2 {} { set dbname [file dir [w3-param SCRIPT_FILENAME]]/plume.db sqlite3 db $dbname db eval {SELECT data, mimetype FROM image LIMIT 1} break w3-mimetype $mimetype w3 $data db close } # Start W3 running w3-start $argv |
Changes to examples/filelist.tcl.
|
| | | | | | | | | | | | | | | | 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 | #!/usr/bin/w3tclsh # # Show all files in the same directory as the script. # package require w3 proc w3-page-env {} { w3-allow-xorigin-params w3-trim { <h1>W3 Environment</h1> <pre>%html([w3-debug-env])</pre> } } proc w3-default {} { cd [file dir [w3-param SCRIPT_FILENAME {}]] regsub {/[^/]+$} [w3-param BASE_URL] {} base w3-trim { <html> <body> <ol> } foreach file [lsort [glob -nocomplain *]] { if {[file isdir $file]} continue if {![file readable $file]} continue w3-trim { <li><a href="%html($base/$file)">%html($file)</a></li> } } w3-trim {</ol>\n} } w3-start $argv |
Changes to examples/fileupload.tcl.
|
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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 | #!/usr/bin/w3tclsh # # This script demonstrates a W3 application that can accept a file # upload using <input type="file"> # package require w3 proc common-header {} { w3-trim { <html> <head> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta http-equiv="content-type" content="text/html; charset=UTF-8"> <link href="%url([w3-param SCRIPT_NAME]/style.css)" rel="stylesheet"> <title>W3 File-Upload Demo</title> </head> <body> } } proc common-footer {} { w3-trim { </body> </html> } } proc w3-default {} { w3-content-security-policy {default-src 'self'; img-src 'self' data:} common-header w3-trim { <h1>W3 File-Upload Demo</h1> } # NB: You must set enctype="multipart/form-data" on your <form> in order # for file upload to work. w3-trim { <p><form method="POST" enctype="multipart/form-data"> File To Upload: <input type="file" name="file"><br> <input type="checkbox" name="showenv" value="1">Show CGI Environment<br> <input type="hidden" name="PARAM1" value="Post parameter with non-lowercase names are suppressed"> <input type="hidden" name="param2.value" value="Post parameters with non-lowercase names are suppressed"> <input type="submit" value="Submit"> </form></p> <p><a href='%html([w3-param SCRIPT_NAME])/self'>Show the script that generates this page</a></p> } # Ordinary query parameters come through just like normal if {[w3-param showenv 0]} { w3-trim { <h1>W3 Environment</h1> <pre>%html([w3-debug-env])</pre> } } # File upload query parameters come in three parts: The *.mimetype, # the *.filename, and the *.content. set mimetype [w3-param file.mimetype {}] set filename [w3-param file.filename {}] set content [w3-param file.content {}] if {$filename!=""} { w3-trim { <h1>Uploaded File Content</h1> <p>Filename: %html($filename)<br> MIME-Type: %html($mimetype)<br> } if {[string match image/* $mimetype]} { # If the mimetype is an image, display the image using an # in-line <img> mark. Note that the content-security-policy # must be changed to allow "data:" for type img-src in order # for this to work. set b64 [binary encode base64 $content] w3-trim { Content:</p> <blockquote> <img src='data:%html($mimetype);base64,%html($b64)'> </blockquote> } } else { # Anything other than image, just show it as text. w3-trim { Content:</p> <blockquote><pre> %html($content) </pre></blockquote> } } } common-footer } proc w3-page-self {} { w3-cache-control max-age=3600 common-header set fd [open [w3-param SCRIPT_FILENAME] rb] set script [read $fd] close $fd w3-trim { <h1>W3 Script That Shows A Copy Of Itself</h1> <pre>%html($script)</pre> } common-footer } proc w3-page-style.css {} { w3-mimetype text/css w3-cache-control max-age=3600 w3-trim { pre { border: 1px solid black; padding: 1ex; } } } w3-start $argv |
Changes to examples/formajax01.tcl.
1 2 3 | # This script demonstrates how to send form data from the client browser # back up to the server using an XMLHttpRequest with JSON content. # | | | | | | | | | | | | | | | | 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 | # This script demonstrates how to send form data from the client browser # back up to the server using an XMLHttpRequest with JSON content. # package require w3 # The default page paints a form to be submitted. # The default content-security-policy of W3 restricts the use # of in-line javascript, so the script content must be returned by # a separate resource. # proc w3-default {} { w3-trim { <h1>Example Of Sending Form Data As JSON Using AJAX</h1> <form id="nameForm"> <table border="0"> <tr><td align="right"><label for="firstName">First name:</label> </td> <td><input type="text" id="firstName" width="20"> <tr><td align="right"><label for="lastName">Last name:</label> </td> <td><input type="text" id="lastName" width="20"> <tr><td align="right"><label for="age">Age:</label> </td> <td><input type="text" id="age" width="6"> <tr><td><td><input type="submit" value="Send"> </table> </form> <script src='%url([w3-param SCRIPT_NAME]/script.js)'></script> } } # This is the javascript that takes control of the form and causes form # submissions to be send using XMLHttpRequest with JSON content # proc w3-page-script.js {} { w3-mimetype text/javascript w3-cache-control max-age=3600 w3-trim { document.getElementById("nameForm").onsubmit = function(){ function val(id){ return document.getElementById(id).value } var jx = { "firstname":val("firstName"), "lastname": val("lastName"), "age": val("age") } var xhttp = new XMLHttpRequest(); xhttp.open("POST", "%string([w3-param SCRIPT_NAME])/acceptjson", true); xhttp.setRequestHeader("Content-Type","text/json"); xhttp.send(JSON.stringify(jx)); return false } } } # This page accepts a form submission and prints it on standard output. # A real server would do something useful with the data. # proc w3-page-acceptjson {} { puts "Accept Json Called" puts "mimetype: [list [w3-param CONTENT_TYPE]]" puts "content: [list [w3-param CONTENT]]" } w3-start $argv |
Changes to examples/formajax02.tcl.
1 2 3 4 | # This script demonstrates how to send form data from the client browser # back up to the server using an XMLHttpRequest with # application/x-www-form-urlencoded content. # | | | | | | | | | | | | | | | | | | 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 | # This script demonstrates how to send form data from the client browser # back up to the server using an XMLHttpRequest with # application/x-www-form-urlencoded content. # package require w3 # The default page paints a form to be submitted. # The default content-security-policy of W3 restricts the use # of in-line javascript, so the script content must be returned by # a separate resource. # proc w3-default {} { w3-trim { <h1>Example Of Sending application/x-www-form-urlencoded Using AJAX</h1> <form id="nameForm"> <table border="0"> <tr><td align="right"><label for="firstName">First name:</label> </td> <td><input type="text" id="firstName" width="20"> <tr><td align="right"><label for="lastName">Last name:</label> </td> <td><input type="text" id="lastName" width="20"> <tr><td align="right"><label for="age">Age:</label> </td> <td><input type="text" id="age" width="6"> <tr><td><td><input type="submit" value="Send"> </table> </form> <script src='%url([w3-param SCRIPT_NAME]/script.js)'></script> } } # This is the javascript that takes control of the form and causes form # submissions to be send using XMLHttpRequest with urlencoded content. # proc w3-page-script.js {} { w3-mimetype text/javascript w3-cache-control max-age=3600 w3-trim { document.getElementById("nameForm").onsubmit = function(){ function val(id){ return encodeURIComponent(document.getElementById(id).value) } var jx = "firstname="+val("firstName")+ "&lastname="+val("lastName")+ "&age="+val("age"); var xhttp = new XMLHttpRequest(); xhttp.open("POST", "%string([w3-param SCRIPT_NAME])/acceptajax", true); xhttp.setRequestHeader("Content-Type", "application/x-www-form-urlencoded"); xhttp.send(jx); return false } } } # This page accepts a form submission and prints it on standard output. # A real server would do something useful with the data. # proc w3-page-acceptajax {} { puts "Accept Callback" puts "mimetype: [list [w3-param CONTENT_TYPE]]" puts "content: [list [w3-param CONTENT]]" foreach var [lsort [w3-param-list]] { if {![regexp {^[a-z]} $var]} continue puts "$var = [list [w3-param $var]]" } } w3-start $argv |
Changes to examples/mediaquery.tcl.
1 2 3 | # This application demonstrates responsive CSS design principles using # the media-query mechanism. To run this app: # | | | | | | | | 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 | # This application demonstrates responsive CSS design principles using # the media-query mechanism. To run this app: # # w3tclsh mediaquery.tcl --server 8080 # # Then connect various devices to see how their display changes according # to the viewport size. Or resize the browser window. Or twist the # handheld device between landscape and portrait modes. # # The foreground and background colors change according to the viewport size # of the device. In a real application, the CSS would be extended to make # other changes according to the viewport size. # source w3.tcl proc w3-default {} { w3-content-security-policy {default_src 'self' 'unsafe-inline'} set top [w3-param SCRIPT_NAME] w3-trim { <!DOCTYPE html> <html> <head> <meta name="viewport" content="width=device-width,initial-scale=1.0"> <link href="%url($top/style.css)" rel="stylesheet"> </head> <body> |
︙ | ︙ | |||
42 43 44 45 46 47 48 | } window.onresize = setwidth; setwidth(); </script> </html> } } | | | | | | 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 | } window.onresize = setwidth; setwidth(); </script> </html> } } proc w3-page-style.css {} { w3-mimetype text/css w3-cache-control max-age=3600 w3-trim { @media screen and (max-width: 600px) { /* Smallest devices, small phones. Less than 600px */ .media-bg {background:red;color:white;} } @media screen and (min-width: 600px) { /* Large phones and tablets in portrait mode. 600px and up */ .media-bg {background:orange;color:black;} |
︙ | ︙ | |||
68 69 70 71 72 73 74 | } @media screen and (min-width: 1200px) { /* wide-screen desktops. 1200px and up */ .media-bg {background:blue;color:white;} } } } | | | 68 69 70 71 72 73 74 75 | } @media screen and (min-width: 1200px) { /* wide-screen desktops. 1200px and up */ .media-bg {background:blue;color:white;} } } } w3-start $argv |
Changes to examples/plume.db.
cannot compute difference between binary files
Changes to examples/plume.png.
cannot compute difference between binary files
Changes to examples/self.tcl.
|
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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 | #!/usr/bin/w3tclsh # # This script demonstrates a W3 application that can display a copy # of itself via the /self page. (See the w3-page-self procedure for # how that one page is generated.) # # This script also has a homepage and an /env page that show the w3 # environment. The header and footer for each page are broken out into # separate subroutines. # # Just for grins, there is also a style-sheet and some cache-control # lines to show how those things work. # package require w3 proc common-header {} { w3-trim { <html> <head> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta http-equiv="content-type" content="text/html; charset=UTF-8"> <link href="%url([w3-param SCRIPT_NAME]/style.css)" rel="stylesheet"> <title>W3 Self-Display Demo</title> </head> <body> } } proc common-footer {} { w3-trim { </body> </html> } } proc w3-default {} { w3-cache-control max-age=3600 common-header w3-trim { <h1>W3 Self-Display Demo</h1> <ul> <li> <a href='%url([w3-param SCRIPT_NAME])/self'>Show the script that generates this page</a> <li> <a href='%url([w3-param SCRIPT_NAME])/env'>W3 Environment</a> </ul> } common-footer } proc w3-page-env {} { common-header w3-trim { <h1>W3 Environment</h1> <pre>%html([w3-debug-env])</pre> } common-footer } proc w3-page-self {} { w3-cache-control max-age=3600 common-header set fd [open [w3-param SCRIPT_FILENAME] rb] set script [read $fd] close $fd w3-trim { <h1>W3 Script That Shows A Copy Of Itself</h1> <pre>%html($script)</pre> } common-footer } proc w3-page-style.css {} { w3-mimetype text/css w3-cache-control max-age=3600 w3-trim { pre { border: 1px solid black; padding: 1ex; } } } w3-start $argv |
Changes to examples/self2.tcl.
|
| | | | | | | | | | | | | | | | | | | | | | | 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 | #!/usr/bin/w3tclsh # # This script demonstrates a W3 application that can display a copy # of itself using a font color selected by a query parameter. # # The foreground color is whatever value is given by the color= query # parameter. The color is inserted into a style= attribute on the # <pre> element using the %url(...) substitution mechanism of W3, # so it is safe from XSS injections. Try it! You won't be able to # slip in any unwanted HTML, but you can use %23 to get a # for # an RGB color, like this: # # ?color=%23003f7f # # Notice that the "w3-content-security-policy" command had to be used # to enable in-line CSS. In-line CSS is off by default. # # Also notice that the "w3-allow-xorigin-params" command had to be used # to enable users to manually add new color= query parameters. # package require w3 proc w3-default {} { w3-content-security-policy {default-src 'self' 'unsafe-inline'} w3-allow-xorigin-params set fd [open [w3-param SCRIPT_FILENAME] rb] set script [read $fd] close $fd set self [w3-param SELF_URL] w3-trim { <html> <head> <link href="%url([w3-param SCRIPT_NAME]/style.css)" rel="stylesheet"> <title>W3 Self-Display Demo</title> </head> <body> <p>The box below shows the W3 script that generated this page. Change the foreground color using the color= query parameter. Examples:</p> <ul> <li><a href='%url($self?color=red)'>%html($self?color=red)</a> <li><a href='%url($self?color=green)'>%html($self?color=green)</a> <li><a href='%url($self?color=blue)'>%html($self?color=blue)</a> <li><a href='%url($self)?color=%23003f7f'>%html($self?color=%23003f7f)</a> </ul> </p> <pre style='color: %url([w3-param color black]);'>%html($script)</pre> } } proc w3-page-style.css {} { w3-mimetype text/css w3-cache-control max-age=3600 w3-trim { pre { border: 1px solid black; padding: 1ex; } } } w3-start $argv |
Changes to examples/shoplist-demo.db.
cannot compute difference between binary files
Changes to examples/shoplist.tcl.
|
| | | | | | | | | | | | | 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 | #!/usr/bin/w3tclsh # # This script implements a simple shopping list. To install: # # (1) Create the database using: # # CREATE TABLE shoplist(id INTEGER PRIMARY KEY AUTOINCREMENT, # x TEXT UNIQUE COLLATE nocase); # CREATE TABLE done(delid INTEGER PRIMARY KEY AUTOINCREMENT, # id INTEGER, x TEXT COLLATE nocase); # CREATE TABLE config(name TEXT PRIMARY KEY, value ANY) WITHOUT ROWID; # INSERT INTO config VALUES('password',<Your-Password-Here>); # # (2) Edit this script to put the full pathname of the database as the # DBFILE variable # # (3) Make this script a CGI on your server. Or run it in some other # way that W3 supports. # set DBFILE /shoppinglist.db ;# Change to name of the database. # Every page should call this routine first, and abort if this # routine returns non-zero. # # This routine outputs the page header and opens the database file. # It checks the login cookie. If the user is not logged in, this routine # paints the login screen and returns 1 (causing the caller page to abort). # proc shopping-list-header {} { set top [w3-param SCRIPT_NAME] w3-trim { <html> <head> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta http-equiv="content-type" content="text/html; charset=UTF-8"> <link href="%url($top/style.css)" rel="stylesheet"> <link rel="icon" type="image/gif" href="%url($top/favicon.ico)"> <title>Grocery List</title> </head><body> <h1>Grocery List</h1> } sqlite3 db $::DBFILE db timeout 1000 db eval BEGIN if {[w3-param-exists logout]} { w3-clear-cookie shopping-list-login set pswd {} } else { set pswd [w3-param pswd [w3-param shopping-list-login]] } if {$pswd=="" || ![db exists {SELECT 1 FROM config WHERE name='password' AND value=$pswd}] } { w3-trim { <p><form method="POST" action="%url([w3-param SELF_URL])"> Password: <input type="password" name="pswd" width=12> <input type="submit" value="Login"></form></p> } db eval COMMIT db close return 1 } if {[w3-param-exists pswd]} { w3-set-cookie shopping-list-login $pswd } return 0 } # Every page should call this routine at the end to clean up the database # connection. # |
︙ | ︙ | |||
82 83 84 85 86 87 88 | # but only if there is no existing item with the # same name # undel=ID Undo a prior delete of item ID. # Only one of the above edit operations may be applied per request. # The edit action is applied prior to displaying the shopping list. # All edit actions are idempotent. # | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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 | # but only if there is no existing item with the # same name # undel=ID Undo a prior delete of item ID. # Only one of the above edit operations may be applied per request. # The edit action is applied prior to displaying the shopping list. # All edit actions are idempotent. # proc w3-default {} { if {[shopping-list-header]} return set base [w3-param SCRIPT_NAME] if {[w3-param-exists del]} { set id [expr {[w3-param del]+0}] db eval { INSERT INTO done(id,x) SELECT id, x FROM shoplist WHERE id=$id; DELETE FROM shoplist WHERE id=$id; } } elseif {[w3-param-exists add]} { set add [w3-param add] db eval {INSERT OR IGNORE INTO shoplist(x) VALUES($add)} } elseif {[w3-param-exists undel]} { set undelid [expr {[w3-param undel]+0}] db eval { INSERT OR IGNORE INTO shoplist(id,x) SELECT id, x FROM done WHERE delid=$undelid; DELETE FROM done WHERE delid=$undelid; } } set cnt 0 db eval {SELECT id, x FROM shoplist ORDER BY x} { # if {$cnt} {w3-subst {<hr>\n}} incr cnt w3-trim { <p>%html($x) <a class="button" href="%url($base/list?del=$id)">Got It!</a> } } if {$cnt} {w3-subst {<hr>\n}} w3-trim { <p><form method="GET" action="%url($base/list)"> <input type="text" width="20" name="add"> <input class="button" type="submit" value="Add"></form> <p><a class="button" href="%url($base/common)">Common Purchases</a> } db eval {SELECT delid FROM done ORDER BY delid DESC limit 1} { w3-trim { <p><a class="button" href="%url($base/list?undel=$delid)">Undelete</a> } } w3-trim { <p><a class="button" href="%url($base/list)">Refresh</a> <p><a class="button" href="%url($base/edit)">Edit</a> <p><a class="button" href="%url($base/list?logout=1)">Logout</a> } shopping-list-footer } # This page shows recent purchases with an opportunity to re-add those # purchases to the shopping list. The idea is that to have easy access # to common purchases. # proc w3-page-common {} { if {[shopping-list-header]} return set base [w3-param SCRIPT_NAME] w3-subst {<p><a class="button" href="%url($base/list)">Go Back</a>} db eval {SELECT x FROM (SELECT DISTINCT x FROM done ORDER BY delid DESC LIMIT 30) ORDER BY x} { w3-trim { <p>%html($x) <a class="button" href="%url($base/list?add=)%qp($x)">Add</a><br> } } shopping-list-footer } # provide forms to edit all current entries. # proc w3-page-edit {} { if {[shopping-list-header]} return set id [w3-param id] set x [w3-param x] if {[string is int -strict $id] && $x!=""} { db eval { UPDATE shoplist SET x=$x WHERE id=$id; } w3-redirect list shopping-list-footer return } db eval {SELECT id, x FROM shoplist ORDER BY x} { w3-trim { <p><form method="POST"> <input type="hidden" name="id" value="%html($id)"> <input type="text" width="20" name="x" value="%html($x)"> <input type="submit" value="Change"></form></p> } } w3-subst {<p><a class="button" href="list">Cancel</a>\n} shopping-list-footer } # The /env page shows the CGI environment. This is for testing only. # There are no links to this page. # proc w3-page-env {} { if {[shopping-list-header]} return w3-trim { <html> <h1>CGI Environment</h1> <pre>%html([w3-debug-env])</pre> } shopping-list-footer } # The style-sheet # proc w3-page-style.css {} { w3-mimetype text/css w3-cache-control max-age=3600 w3-trim { .button { font-size: 80%; text-decoration: none; padding: 2px 6px 2px 6px; border: 1px solid black; border-radius: 8px; background-color: #ddd; } } } # The application icon is a gif image of a head of broccoli. # proc w3-page-favicon.ico {} { w3-mimetype image/gif w3-cache-control max-age=3600 w3-unsafe [binary decode hex { 47494638396120002000f300000000000022000033330044000055000066330 0993333cc3366cc3399cc3399cc9999ff99cccc99ccff9900000000000021f9 040100000e002c00000000200020000004fed0c9495db985d4cdf95547288cd 248761e582846d19aab6100005a15a16c286e21c49842cd26c1c574868180f5 c10c3b98434b77514e31ade766151ab85a182bf622a0410fe16075a41e0db49 30c8130a87b735683695f87af120921073f6864603e323e027d145c06524887 8a3f3b645e6f8d098f3b892e3990883d8b05984520908949395717012f03495 a31074c6003a86a0196a4b220a93d38608703ba8b4901bdbf4153c2a40123c7 7eb5c017856a4a000601ba700e04526aa417acbc03085e421bdfe1a492a46f5 ee7e91c00d7c4e8ef08495f4936347623b605e80300963e030cfa11012050e0 b83ae3642048388088838276ecb8386860813e7d3f152d62b4974d5f838f0a1 762b463a6a4819332425abc48c3cc04973053ceec8013e4ce8506f42d88f9d3 5fd0a3758aa2705960a0d2a52db6c97cbaa1e69008003b }] } # After all pages handling routines have been defined, start up # the W3 handler. # w3-start $argv |
Changes to examples/tableajax01.tcl.
|
| | | | | | | | | | | | | | | | | | | | | | | | | | | | 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 | #!/usr/bin/w3tclsh # This script demonstrates how to receive bulk HTML content # (such as a complete <table>) and insert it in the middle # of the DOM using XMLHttpRequest # package require w3 proc common-header {} { w3-trim { <html> <head> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta http-equiv="content-type" content="text/html; charset=UTF-8"> <link href="%url([w3-param SCRIPT_NAME]/style.css)" rel="stylesheet"> <body> } } proc common-footer {} { w3-trim { </body> </html> } } proc w3-default {} { common-header w3-trim { <p>This application demonstrates how to use XMLHttpResult to obtain bulk HTML text (such as a large <table>) and then insert that text in the middle of the DOM.</p> <div id="insertionPoint"></div> <p><form id="theForm"> Click the button <input type="submit" id="theButton" value="Click Here"> to cause content to be inserted above this paragraph and below the initial paragraph </form></p> <script src='%url([w3-param SCRIPT_NAME]/script.js)'></script> <p><a href='%html([w3-param SCRIPT_NAME])/self'>Show the W3 script that generates this page</a></p> } common-footer } # This is the javascript that takes control of the form and causes form # submissions to fetch and insert HTML text. # proc w3-page-script.js {} { w3-mimetype text/javascript w3-cache-control max-age=3600 w3-trim { document.getElementById("theForm").onsubmit = function(){ var xhttp = new XMLHttpRequest(); xhttp.open("GET", "%string([w3-param BASE_URL])/gettable", true); xhttp.onreadystatechange = function(){ if(this.readyState!=4)return document.getElementById("insertionPoint").innerHTML = this.responseText; document.getElementById("insCancel").onclick = function(){ document.getElementById("insertionPoint").innerHTML = null } } xhttp.send(); return false } } } # This counter increments on each /gettable call. set counter 0 # The /gettable page returns the content of a table to be inserted # in the original page. # proc w3-page-gettable {} { global counter incr counter w3-trim { <table border="1"> <tr><th>Column 1<th>Column 2<th>Column 3 <tr><td>1.1<td>1.2<td>1.3 <tr><td>2.1<td>2.2<td>2.3 <tr><td>%html($counter)<td><td><button id="insCancel">Cancel</button> </table> } } # The /self page that shows the text of this script. # proc w3-page-self {} { w3-cache-control max-age=3600 common-header set fd [open [w3-param SCRIPT_FILENAME] rb] set script [read $fd] close $fd w3-trim { <h1>W3 Script That Shows A Copy Of Itself</h1> <pre>%html($script)</pre> } common-footer } proc w3-page-style.css {} { w3-mimetype text/css w3-cache-control max-age=3600 w3-trim { pre { border: 1px solid black; padding: 1ex; } } } w3-start $argv |
Changes to tclsqlite3.c.
︙ | ︙ | |||
34685 34686 34687 34688 34689 34690 34691 | #endif /* SQLITE_OMIT_UTF16 */ #ifndef SQLITE_OMIT_UTF16 /* ** This routine checks for a byte-order mark at the beginning of the ** UTF-16 string stored in *pMem. If one is present, it is removed and ** the encoding of the Mem adjusted. This routine does not do any | | | 34685 34686 34687 34688 34689 34690 34691 34692 34693 34694 34695 34696 34697 34698 34699 | #endif /* SQLITE_OMIT_UTF16 */ #ifndef SQLITE_OMIT_UTF16 /* ** This routine checks for a byte-order mark at the beginning of the ** UTF-16 string stored in *pMem. If one is present, it is removed and ** the encoding of the Mem adjusted. This routine does not do any ** byte-sw3ing, it just sets Mem.enc appropriately. ** ** The allocation (static, dynamic etc.) and encoding of the Mem may be ** changed by this function. */ SQLITE_PRIVATE int sqlite3VdbeMemHandleBom(Mem *pMem){ int rc = SQLITE_OK; u8 bom = 0; |
︙ | ︙ | |||
37621 37622 37623 37624 37625 37626 37627 | int (*xRead)(const char *zClass, const char *zKey, char *zBuf, int nBuf); int (*xWrite)(const char *zClass, const char *zKey, const char *zData); int (*xDelete)(const char *zClass, const char *zKey); const int nKeySize; }; /* | | | 37621 37622 37623 37624 37625 37626 37627 37628 37629 37630 37631 37632 37633 37634 37635 | int (*xRead)(const char *zClass, const char *zKey, char *zBuf, int nBuf); int (*xWrite)(const char *zClass, const char *zKey, const char *zData); int (*xDelete)(const char *zClass, const char *zKey); const int nKeySize; }; /* ** This object holds the kvvfs I/O methods which may be sw3ed out ** for JavaScript-side implementations in WASM builds. In such builds ** it cannot be const, but in native builds it should be so that ** the compiler can hopefully optimize this level of indirection out. ** That said, kvvfs is intended primarily for use in WASM builds. ** ** Note that this is not explicitly flagged as static because the ** amalgamation build will tag it with SQLITE_PRIVATE. |
︙ | ︙ | |||
74529 74530 74531 74532 74533 74534 74535 | rc = btreeGetPage(pBt, iLastPg, &pLastPg, 0); if( rc!=SQLITE_OK ){ return rc; } /* If bCommit is zero, this loop runs exactly once and page pLastPg | | | 74529 74530 74531 74532 74533 74534 74535 74536 74537 74538 74539 74540 74541 74542 74543 | rc = btreeGetPage(pBt, iLastPg, &pLastPg, 0); if( rc!=SQLITE_OK ){ return rc; } /* If bCommit is zero, this loop runs exactly once and page pLastPg ** is sw3ed with the first free page pulled off the free list. ** ** On the other hand, if bCommit is greater than zero, then keep ** looping until a free-page located within the first nFin pages ** of the file is found. */ if( bCommit==0 ){ eMode = BTALLOC_LE; |
︙ | ︙ | |||
88772 88773 88774 88775 88776 88777 88778 | ** ** (2007-08-30) Frank van Vugt has studied this problem closely ** and has send his findings to the SQLite developers. Frank ** writes that some Linux kernels offer floating point hardware ** emulation that uses only 32-bit mantissas instead of a full ** 48-bits as required by the IEEE standard. (This is the ** CONFIG_FPE_FASTFPE option.) On such systems, floating point | | | | 88772 88773 88774 88775 88776 88777 88778 88779 88780 88781 88782 88783 88784 88785 88786 88787 | ** ** (2007-08-30) Frank van Vugt has studied this problem closely ** and has send his findings to the SQLite developers. Frank ** writes that some Linux kernels offer floating point hardware ** emulation that uses only 32-bit mantissas instead of a full ** 48-bits as required by the IEEE standard. (This is the ** CONFIG_FPE_FASTFPE option.) On such systems, floating point ** byte sw3ing becomes very complicated. To avoid problems, ** the necessary byte sw3ing is carried out using a 64-bit integer ** rather than a 64-bit float. Frank assures us that the code here ** works for him. We, the developers, have no way to independently ** verify this, but Frank seems to know what he is talking about ** so we trust him. */ #ifdef SQLITE_MIXED_ENDIAN_64BIT_FLOAT SQLITE_PRIVATE u64 sqlite3FloatSwap(u64 in){ |
︙ | ︙ | |||
163901 163902 163903 163904 163905 163906 163907 | iUpper = a[0] + a[1]; } assert( pLower==0 || (pLower->eOperator & (WO_GT|WO_GE))!=0 ); assert( pUpper==0 || (pUpper->eOperator & (WO_LT|WO_LE))!=0 ); assert( p->aSortOrder!=0 ); if( p->aSortOrder[nEq] ){ | | | 163901 163902 163903 163904 163905 163906 163907 163908 163909 163910 163911 163912 163913 163914 163915 | iUpper = a[0] + a[1]; } assert( pLower==0 || (pLower->eOperator & (WO_GT|WO_GE))!=0 ); assert( pUpper==0 || (pUpper->eOperator & (WO_LT|WO_LE))!=0 ); assert( p->aSortOrder!=0 ); if( p->aSortOrder[nEq] ){ /* The roles of pLower and pUpper are sw3ed for a DESC index */ SWAP(WhereTerm*, pLower, pUpper); SWAP(int, nBtm, nTop); } /* If possible, improve on the iLower estimate using ($P:$L). */ if( pLower ){ int n; /* Values extracted from pExpr */ |
︙ | ︙ | |||
166565 166566 166567 166568 166569 166570 166571 | pBuilder->iPlanLimit += SQLITE_QUERY_PLANNER_LIMIT_INCR; pNew->maskSelf = sqlite3WhereGetMask(&pWInfo->sMaskSet, pItem->iCursor); if( bFirstPastRJ || (pItem->fg.jointype & (JT_OUTER|JT_CROSS|JT_LTORJ))!=0 ){ /* Add prerequisites to prevent reordering of FROM clause terms ** across CROSS joins and outer joins. The bFirstPastRJ boolean | | | 166565 166566 166567 166568 166569 166570 166571 166572 166573 166574 166575 166576 166577 166578 166579 | pBuilder->iPlanLimit += SQLITE_QUERY_PLANNER_LIMIT_INCR; pNew->maskSelf = sqlite3WhereGetMask(&pWInfo->sMaskSet, pItem->iCursor); if( bFirstPastRJ || (pItem->fg.jointype & (JT_OUTER|JT_CROSS|JT_LTORJ))!=0 ){ /* Add prerequisites to prevent reordering of FROM clause terms ** across CROSS joins and outer joins. The bFirstPastRJ boolean ** prevents the right operand of a RIGHT JOIN from being sw3ed with ** other elements even further to the right. ** ** The JT_LTORJ case and the hasRightJoin flag work together to ** prevent FROM-clause terms from moving from the right side of ** a LEFT JOIN over to the left side of that join if the LEFT JOIN ** is itself on the left side of a RIGHT JOIN. */ |
︙ | ︙ |
Changes to tests/drh4.jpg.
cannot compute difference between binary files
Changes to tests/one"two'three.txt.
|
| | | 1 2 | This file exists to test w3's handling of files with unusual filenames. |
Changes to tests/test01.tcl.
|
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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 | #!/usr/bin/w3tclsh # # Invoke as "tclsh test01.tcl" and then surf the website that pops up # to verify the logic in w3. # if {[catch {package require w3}]} { source [file dir [file dir [info script]]]/w3.tcl } proc w3-default {} { global w3 set B [w3-param BASE_URL] set BX(y) $B set R [w3-param SCRIPT_NAME] w3-cache-control max-age=15 w3 "<h1>Hello, World!</h1>\n" w3 "<ol>" w3-unsafe "<li><p><a href='$R/env'>W3 Environment</a></p>\n" w3-subst {<li><p><a href='env2'>Environment using w3-debug-env</a>\n} w3-subst {<li><p><a href='%url%($B)%/fullenv'>Full Environment</a>\n} set crazy [lsort [w3-param-list]] w3-subst {<li><p><a href='%url($B)/env?keys=%url($crazy)'>} w3 "Environment with crazy URL</a>\n" w3-trim { <li><p><a href='%url($B)/lint'>Lint</a> <li><p><a href='%url($B)/errorout'>Deliberate error</a> <li><p><a href='%url($B)/encodings'>Encoding checks</a> <li><p><a href='%url($B)/redirect'>Redirect to env</a> <li><p><a href='%url($B)/globals'>TCL global variables</a> <li><p><a href='%url%($BX(y))%/csptest'>Content Security Policy</a> <li><p><a href='%url($B)/fileupload'>File Upload Using multipart/form-data</a> <li><p><a href='%url($B)/self'>The source code to this script</a> } set x "%string(...)" set v abc'def\"ghi\\jkl</script> w3-subst {<li>%html($x) substitution test: "%string%($v)%"\n} w3 "</ol>" if {[w3-param-exists showenv]} { w3-page-env } w3-trim { <p>The creator of W3:<br> <img src="%url($R/drh.jpg)"> } } proc w3-page-redirect {} { w3-redirect env } proc w3-page-globals {} { w3-trim { <h1>TCL Global Variables</h1> <ul> } foreach vname [lsort [uplevel #0 info vars]] { set val ??? catch {set val [set ::$vname]} set len [string length $val] if {$len>100} { w3-subst {<li>%html($vname) = <i>... %html($len) byte string...</i>\n} } else { w3-subst {<li>%html($vname = [list $val])</li>\n} } } } proc w3-page-env2 {} { w3-allow-xorigin-params w3-trim { <h1>W3 Environment using w3-debug-env</h1> <p>This page uses w3-allow-xorigin-params so that new query parameters may be added manually to the URL.</p> <pre>%html([w3-debug-env])</pre> } } proc w3-page-env {} { global w3 w3-allow-xorigin-params w3-set-cookie env-cookie simple w3 "<h1>W3 Environment</h1>\n" w3-unsafe "<form method='GET' action='[wapp-param SELF_URL]'>\n" wapp "<input type='checkbox' name='showhdr'" if {[wapp-param-exists showhdr]} { wapp " checked" } wapp "> Show Header\n" wapp "<input type='submit' value='Go'>\n" wapp "</form>" |
︙ | ︙ | |||
99 100 101 102 103 104 105 | ($var!=".header" || ![wapp-param-exists showhdr])} continue wapp-subst {%html($var) = %string([list [wapp-param $var]])\n} } wapp "</pre>" } proc wapp-page-fullenv {} { wapp-set-cookie env-cookie full | | | 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 | ($var!=".header" || ![wapp-param-exists showhdr])} continue wapp-subst {%html($var) = %string([list [wapp-param $var]])\n} } wapp "</pre>" } proc wapp-page-fullenv {} { wapp-set-cookie env-cookie full wapp "<h1>W3 Full Environment</h1>\n" wapp-unsafe "<form method='POST' action='[wapp-param SELF_URL]'>\n" wapp "<input type='checkbox' name='var1'" if {[wapp-param-exists showhdr]} { wapp " checked" } # Deliberately unsafe calls to wapp-subst and wapp-trim, added here # to test wapp-safety-check |
︙ | ︙ | |||
137 138 139 140 141 142 143 | </pre> } } } proc wapp-page-fileupload {} { wapp-content-security-policy {default_src 'self' 'inline'} wapp-trim { | | | 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 | </pre> } } } proc wapp-page-fileupload {} { wapp-content-security-policy {default_src 'self' 'inline'} wapp-trim { <h1>W3 File Upload Form Test</h1> <p><form method="POST" enctype="multipart/form-data"> <input type="file" name="f1"><br> <input type="file" name="f2"><br> <input type="file" name="f3"><br> <input type="submit" value="Upload Files"> </form></p> } |
︙ | ︙ | |||
205 206 207 208 209 210 211 | wapp-subst {</table>} } # Deliberately generate an error to test error handling. proc wapp-page-errorout {} { wapp "<h1>Intentially generate an error</h1>\n" wapp "<p>This test should be ignored by the error handler\n" # The following line deliberately throws an error to test the | | | 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 | wapp-subst {</table>} } # Deliberately generate an error to test error handling. proc wapp-page-errorout {} { wapp "<h1>Intentially generate an error</h1>\n" wapp "<p>This test should be ignored by the error handler\n" # The following line deliberately throws an error to test the # error recovering logic within W3 wapp $noSuchVariable wapp "This is a $test of wapp-safety-check" wapp "This is another [test of] wapp-safety-check" wapp "<p>After the error\n" } proc wapp-page-csptest {} { wapp-allow-xorigin-params |
︙ | ︙ |
Changes to tests/test02.
1 2 | #!/usr/bin/tclsh # | | | 1 2 3 4 5 6 7 8 9 10 | #!/usr/bin/tclsh # # This script is for testing w3 in CGI mode using the althttpd web-server. # This script is contained inside the "default.website" subdirectory. Let # $ROOT be the name of the root of this source archive - the directory that # contains "default.website". Then to start up althttpd for this test # run: # # althttpd -root $ROOT -port 8080 # |
︙ | ︙ |
Name change from wapp.tcl to w3.tcl.
︙ | ︙ | |||
8 9 10 11 12 13 14 | # but without any warranty; without even the implied warranty of # merchantability or fitness for a particular purpose. # #--------------------------------------------------------------------------- # # Design rules: # | | | | | | | | | | | | | | 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 | # but without any warranty; without even the implied warranty of # merchantability or fitness for a particular purpose. # #--------------------------------------------------------------------------- # # Design rules: # # (1) All identifiers in the global namespace begin with "w3" # # (2) Indentifiers intended for internal use only begin with "w3Int" # package require Tcl 8.6 # Add text to the end of the HTTP reply. No interpretation or transformation # of the text is performs. The argument should be enclosed within {...} # proc w3 {txt} { global w3 dict append w3 .reply $txt } # Add text to the page under construction. Do no escaping on the text. # # Though "unsafe" in general, there are uses for this kind of thing. # For example, if you want to return the complete, unmodified content of # a file: # # set fd [open content.html rb] # w3-unsafe [read $fd] # close $fd # # You could do the same thing using ordinary "w3" instead of "w3-unsafe". # The difference is that w3-safety-check will complain about the misuse # of "w3", but it assumes that the person who write "w3-unsafe" understands # the risks. # # Though occasionally necessary, the use of this interface should be minimized. # proc w3-unsafe {txt} { global w3 dict append w3 .reply $txt } # Add text to the end of the reply under construction. The following # substitutions are made: # # %html(...) Escape text for inclusion in HTML # %url(...) Escape text for use as a URL |
︙ | ︙ | |||
69 70 71 72 73 74 75 | # In other words, use "%(...)%" instead of "(...)" to include the TCL string # to substitute. # # The %unsafe substitution should be avoided whenever possible, obviously. # In addition to the substitutions above, the text also does backslash # escapes. # | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | > > > > > > > > > < < < < < < < < < | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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 | # In other words, use "%(...)%" instead of "(...)" to include the TCL string # to substitute. # # The %unsafe substitution should be avoided whenever possible, obviously. # In addition to the substitutions above, the text also does backslash # escapes. # # The w3-trim proc works the same as w3-subst except that it also removes # whitespace from the left margin, so that the generated HTML/CSS/Javascript # does not appear to be indented when delivered to the client web browser. # if {$tcl_version>=8.7} { proc w3-subst {txt} { global w3 regsub -all -command \ {%(html|url|qp|string|unsafe){1,1}?(|%)\((.+)\)\2} $txt w3Int-enc txt dict append w3 .reply [subst -novariables -nocommand $txt] } proc w3-trim {txt} { global w3 regsub -all {\n\s+} [string trim $txt] \n txt regsub -all -command \ {%(html|url|qp|string|unsafe){1,1}?(|%)\((.+)\)\2} $txt w3Int-enc txt dict append w3 .reply [subst -novariables -nocommand $txt] } proc w3Int-enc {all mode nu1 txt} { return [uplevel 2 "w3Int-enc-$mode \"$txt\""] } } else { proc w3-subst {txt} { global w3 regsub -all {%(html|url|qp|string|unsafe){1,1}?(|%)\((.+)\)\2} $txt \ {[w3Int-enc-\1 "\3"]} txt dict append w3 .reply [uplevel 1 [list subst -novariables $txt]] } proc w3-trim {txt} { global w3 regsub -all {\n\s+} [string trim $txt] \n txt regsub -all {%(html|url|qp|string|unsafe){1,1}?(|%)\((.+)\)\2} $txt \ {[w3Int-enc-\1 "\3"]} txt dict append w3 .reply [uplevel 1 [list subst -novariables $txt]] } } # There must be a w3Int-enc-NAME routine for each possible substitution # in w3-subst. Thus there are routines for "html", "url", "qp", and "unsafe". # # w3Int-enc-html Escape text so that it is safe to use in the # body of an HTML document. # # w3Int-enc-url Escape text so that it is safe to pass as an # argument to href= and src= attributes in HTML. # # w3Int-enc-qp Escape text so that it is safe to use as the # value of a query parameter in a URL or in # post data or in a cookie. # # w3Int-enc-string Escape ", ', \, and < for using inside of a # javascript string literal. The < character # is escaped to prevent "</script>" from causing # problems in embedded javascript. # # w3Int-enc-unsafe Perform no encoding at all. Unsafe. # proc w3Int-enc-html {txt} { return [string map {& & < < > > \" " \\ \} $txt] } proc w3Int-enc-unsafe {txt} { return $txt } proc w3Int-enc-url {s} { if {[regsub -all {[^-{}\\@~?=#_.:/a-zA-Z0-9]} $s {[w3Int-%HHchar {&}]} s]} { set s [subst -novar -noback $s] } if {[regsub -all {[\\{}]} $s {[w3Int-%HHchar \\&]} s]} { set s [subst -novar -noback $s] } return $s } proc w3Int-enc-qp {s} { if {[regsub -all {[^-{}\\_.a-zA-Z0-9]} $s {[w3Int-%HHchar {&}]} s]} { set s [subst -novar -noback $s] } if {[regsub -all {[\\{}]} $s {[w3Int-%HHchar \\&]} s]} { set s [subst -novar -noback $s] } return $s } proc w3Int-enc-string {s} { return [string map {\\ \\\\ \" \\\" ' \\' < \\u003c \n \\n \r \\r \f \\f \t \\t \x01 \\u0001 \x02 \\u0002 \x03 \\u0003 \x04 \\u0004 \x05 \\u0005 \x06 \\u0006 \x07 \\u0007 \x0b \\u000b \x0e \\u000e \x0f \\u000f \x10 \\u0010 \x11 \\u0011 \x12 \\u0012 \x13 \\u0013 \x14 \\u0014 \x15 \\u0015 \x16 \\u0016 \x17 \\u0017 \x18 \\u0018 \x19 \\u0019 \x1a \\u001a \x1b \\u001b \x1c \\u001c \x1d \\u001d \x1e \\u001e \x1f \\u001f} $s] } # This is a helper routine for w3Int-enc-url and w3Int-enc-qp. It returns # an appropriate %HH encoding for the single character c. If c is a unicode # character, then this routine might return multiple bytes: %HH%HH%HH # proc w3Int-%HHchar {c} { if {$c==" "} {return +} return [regsub -all .. [binary encode hex [encoding convertto utf-8 $c]] {%&}] } # Undo the www-url-encoded format. # # HT: This code stolen from ncgi.tcl # proc w3Int-decode-url {str} { set str [string map [list + { } "\\" "\\\\" \[ \\\[ \] \\\]] $str] regsub -all -- \ {%([Ee][A-Fa-f0-9])%([89ABab][A-Fa-f0-9])%([89ABab][A-Fa-f0-9])} \ $str {[encoding convertfrom utf-8 [binary decode hex \1\2\3]]} str regsub -all -- \ {%([CDcd][A-Fa-f0-9])%([89ABab][A-Fa-f0-9])} \ $str {[encoding convertfrom utf-8 [binary decode hex \1\2]]} str regsub -all -- {%([0-7][A-Fa-f0-9])} $str {\\u00\1} str return [subst -novar $str] } # Reset the document back to an empty string. # proc w3-reset {} { global w3 dict set w3 .reply {} } # Change the mime-type of the result document. # proc w3-mimetype {x} { global w3 dict set w3 .mimetype $x } # Change the reply code. # proc w3-reply-code {x} { global w3 dict set w3 .reply-code $x } # Set a cookie # proc w3-set-cookie {name value} { global w3 dict lappend w3 .new-cookies $name $value } # Unset a cookie # proc w3-clear-cookie {name} { w3-set-cookie $name {} } # Add extra entries to the reply header # proc w3-reply-extra {name value} { global w3 dict lappend w3 .reply-extra $name $value } # Specifies how the web-page under construction should be cached. # The argument should be one of: # # no-cache # max-age=N (for some integer number of seconds, N) # private,max-age=N # proc w3-cache-control {x} { w3-reply-extra Cache-Control $x } # Redirect to a different web page # proc w3-redirect {uri} { w3-reset w3-reply-code {303 Redirect} w3-reply-extra Location $uri } # Return the value of a w3 parameter # proc w3-param {name {dflt {}}} { global w3 if {![dict exists $w3 $name]} {return $dflt} return [dict get $w3 $name] } # Return true if a and only if the w3 parameter $name exists # proc w3-param-exists {name} { global w3 return [dict exists $w3 $name] } # Set the value of a w3 parameter # proc w3-set-param {name value} { global w3 dict set w3 $name $value } # Return all parameter names that match the GLOB pattern, or all # names if the GLOB pattern is omitted. # proc w3-param-list {{glob {*}}} { global w3 return [dict keys $w3 $glob] } # By default, W3 does not decode query parameters and POST parameters # for cross-origin requests. This is a security restriction, designed to # help prevent cross-site request forgery (CSRF) attacks. # # As a consequence of this restriction, URLs for sites generated by W3 # that contain query parameters will not work as URLs found in other # websites. You cannot create a link from a second website into a W3 # website if the link contains query planner, by default. # # Of course, it is sometimes desirable to allow query parameters on external # links. For URLs for which this is safe, the application should invoke # w3-allow-xorigin-params. This procedure tells W3 that it is safe to # go ahead and decode the query parameters even for cross-site requests. # # In other words, for W3 security is the default setting. Individual pages # need to actively disable the cross-site request security if those pages # are safe for cross-site access. # proc w3-allow-xorigin-params {} { global w3 if {![dict exists $w3 .qp] && ![dict get $w3 SAME_ORIGIN]} { w3Int-decode-query-params } } # Set the content-security-policy. # # The default content-security-policy is very strict: "default-src 'self'" # The default policy prohibits the use of in-line javascript or CSS. # # Provide an alternative CSP as the argument. Or use "off" to disable # the CSP completely. # proc w3-content-security-policy {val} { global w3 if {$val=="off"} { dict unset w3 .csp } else { dict set w3 .csp $val } } # Examine the bodys of all procedures in this program looking for # unsafe calls to various W3 interfaces. Return a text string # containing warnings. Return an empty string if all is ok. # # This routine is advisory only. It misses some constructs that are # dangerous and flags others that are safe. # proc w3-safety-check {} { set res {} foreach p [info command] { set ln 0 foreach x [split [info body $p] \n] { incr ln if {[regexp {^[ \t]*w3[ \t]+([^\n]+)} $x all tail] && [string index $tail 0]!="\173" && [regexp {[[$]} $tail] } { append res "$p:$ln: unsafe \"w3\" call: \"[string trim $x]\"\n" } if {[regexp {^[ \t]*w3-(subst|trim)[ \t]+[^\173]} $x all cx]} { append res "$p:$ln: unsafe \"w3-$cx\" call: \"[string trim $x]\"\n" } } } return $res } # Return a string that descripts the current environment. Applications # might find this useful for debugging. # proc w3-debug-env {} { global w3 set out {} foreach var [lsort [dict keys $w3]] { if {[string index $var 0]=="."} continue append out "$var = [list [dict get $w3 $var]]\n" } append out "\[pwd\] = [list [pwd]]\n" return $out } # Tracing function for each HTTP request. This is overridden by w3-start # if tracing is enabled. # proc w3Int-trace {} {} # Start up a listening socket. Arrange to invoke w3Int-new-connection # for each inbound HTTP connection. # # port Listen on this TCP port. 0 means to select a port # that is not currently in use # # w3mode One of "scgi", "remote-scgi", "server", or "local". # # fromip If not {}, then reject all requests from IP addresses # other than $fromip # proc w3Int-start-listener {port w3mode fromip} { if {[string match *scgi $w3mode]} { set type SCGI set server [list w3Int-new-connection \ w3Int-scgi-readable $w3mode $fromip] } else { set type HTTP set server [list w3Int-new-connection \ w3Int-http-readable $w3mode $fromip] } if {$w3mode=="local" || $w3mode=="scgi"} { set x [socket -server $server -myaddr 127.0.0.1 $port] } else { set x [socket -server $server $port] } set coninfo [chan configure $x -sockname] set port [lindex $coninfo 2] if {$w3mode=="local"} { w3Int-start-browser http://127.0.0.1:$port/ } elseif {$fromip!=""} { puts "Listening for $type requests on TCP port $port from IP $fromip" } else { puts "Listening for $type requests on TCP port $port" } } # Start a web-browser and point it at $URL # proc w3Int-start-browser {url} { global tcl_platform if {$tcl_platform(platform)=="windows"} { exec cmd /c start $url & } elseif {$tcl_platform(os)=="Darwin"} { exec open $url & } elseif {[catch {exec -ignorestderr xdg-open $url}]} { exec firefox $url & } } # This routine is a "socket -server" callback. The $chan, $ip, and $port # arguments are added by the socket command. # # Arrange to invoke $callback when content is available on the new socket. # The $callback will process inbound HTTP or SCGI content. Reject the # request if $fromip is not an empty string and does not match $ip. # proc w3Int-new-connection {callback w3mode fromip chan ip port} { upvar #0 w3Int-$chan W if {$fromip!="" && ![string match $fromip $ip]} { close $chan return } set W [dict create REMOTE_ADDR $ip REMOTE_PORT $port W3_MODE $w3mode \ .header {}] fconfigure $chan -blocking 0 -translation binary fileevent $chan readable [list $callback $chan] } # Close an input channel # proc w3Int-close-channel {chan} { if {$chan=="stdout"} { # This happens after completing a CGI request exit 0 } else { unset ::w3Int-$chan close $chan } } # Process new text received on an inbound HTTP request # proc w3Int-http-readable {chan} { if {[catch [list w3Int-http-readable-unsafe $chan] msg]} { puts stderr "$msg\n$::errorInfo" w3Int-close-channel $chan } } proc w3Int-http-readable-unsafe {chan} { upvar #0 w3Int-$chan W w3 w3 if {![dict exists $W .toread]} { # If the .toread key is not set, that means we are still reading # the header set line [string trimright [gets $chan]] set n [string length $line] if {$n>0} { if {[dict get $W .header]=="" || [regexp {^\s+} $line]} { |
︙ | ︙ | |||
480 481 482 483 484 485 486 | if {[info exists ::argv0]} { set a0 [file normalize $argv0] } else { set a0 / } dict set W SCRIPT_FILENAME $a0 dict set W DOCUMENT_ROOT [file dir $a0] | | | | | | | | | 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 | if {[info exists ::argv0]} { set a0 [file normalize $argv0] } else { set a0 / } dict set W SCRIPT_FILENAME $a0 dict set W DOCUMENT_ROOT [file dir $a0] if {[w3Int-parse-header $chan]} { catch {close $chan} return } set len 0 if {[dict exists $W CONTENT_LENGTH]} { set len [dict get $W CONTENT_LENGTH] } if {$len>0} { # Still need to read the query content dict set W .toread $len } else { # There is no query content, so handle the request immediately set w3 $W w3Int-handle-request $chan } } } else { # If .toread is set, that means we are reading the query content. # Continue reading until .toread reaches zero. set got [read $chan [dict get $W .toread]] dict append W CONTENT $got dict set W .toread [expr {[dict get $W .toread]-[string length $got]}] if {[dict get $W .toread]<=0} { # Handle the request as soon as all the query content is received set w3 $W w3Int-handle-request $chan } } } # Decode the HTTP request header. # # This routine is always running inside of a [catch], so if # any problems arise, simply raise an error. # proc w3Int-parse-header {chan} { upvar #0 w3Int-$chan W set hdr [split [dict get $W .header] \n] if {$hdr==""} {return 1} set req [lindex $hdr 0] dict set W REQUEST_METHOD [set method [lindex $req 0]] if {[lsearch {GET HEAD POST} $method]<0} { error "unsupported request method: \"[dict get $W REQUEST_METHOD]\"" } |
︙ | ︙ | |||
560 561 562 563 564 565 566 | } return 0 } # Decode the QUERY_STRING parameters from a GET request or the # application/x-www-form-urlencoded CONTENT from a POST request. # | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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 | } return 0 } # Decode the QUERY_STRING parameters from a GET request or the # application/x-www-form-urlencoded CONTENT from a POST request. # # This routine sets the ".qp" element of the ::w3 dict as a signal # that query parameters have already been decoded. # proc w3Int-decode-query-params {} { global w3 dict set w3 .qp 1 if {[dict exists $w3 QUERY_STRING]} { foreach qterm [split [dict get $w3 QUERY_STRING] &] { set qsplit [split $qterm =] set nm [lindex $qsplit 0] if {[regexp {^[a-z][a-z0-9]*$} $nm]} { dict set w3 $nm [w3Int-decode-url [lindex $qsplit 1]] } } } if {[dict exists $w3 CONTENT_TYPE] && [dict exists $w3 CONTENT]} { set ctype [dict get $w3 CONTENT_TYPE] if {$ctype=="application/x-www-form-urlencoded"} { foreach qterm [split [string trim [dict get $w3 CONTENT]] &] { set qsplit [split $qterm =] set nm [lindex $qsplit 0] if {[regexp {^[a-z][-a-z0-9_]*$} $nm]} { dict set w3 $nm [w3Int-decode-url [lindex $qsplit 1]] } } } elseif {[string match multipart/form-data* $ctype]} { regexp {^(.*?)\r\n(.*)$} [dict get $w3 CONTENT] all divider body set ndiv [string length $divider] while {[string length $body]} { set idx [string first $divider $body] set unit [string range $body 0 [expr {$idx-3}]] set body [string range $body [expr {$idx+$ndiv+2}] end] if {[regexp {^Content-Disposition: form-data; (.*?)\r\n\r\n(.*)$} \ $unit unit hdr content]} { if {[regexp {name="(.*)"; filename="(.*)"\r\nContent-Type: (.*?)$}\ $hdr hr name filename mimetype] && [regexp {^[a-z][a-z0-9]*$} $name]} { dict set w3 $name.filename \ [string map [list \\\" \" \\\\ \\] $filename] dict set w3 $name.mimetype $mimetype dict set w3 $name.content $content } elseif {[regexp {name="(.*)"} $hdr hr name] && [regexp {^[a-z][a-z0-9]*$} $name]} { dict set w3 $name $content } } } } } } # Invoke application-supplied methods to generate a reply to # a single HTTP request. # # This routine uses the global variable ::w3 and so must not be nested. # It must run to completion before the next instance runs. If a recursive # instances of this routine starts while another is running, the the # recursive instance is added to a queue to be invoked after the current # instance finishes. Yes, this means that W3 IS SINGLE THREADED. Only # a single page rendering instance my be running at a time. There can # be multiple HTTP requests inbound at once, but only one my be processed # at a time once the request is full read and parsed. # set w3IntPending {} set w3IntLock 0 proc w3Int-handle-request {chan} { global w3IntPending w3IntLock fileevent $chan readable {} if {$w3IntLock} { # Another instance of request is already running, so defer this one lappend w3IntPending [list w3Int-handle-request $chan] return } set w3IntLock 1 catch [list w3Int-handle-request-unsafe $chan] set w3IntLock 0 if {[llength $w3IntPending]>0} { # If there are deferred requests, then launch the oldest one after idle [lindex $w3IntPending 0] set w3IntPending [lrange $w3IntPending 1 end] } } proc w3Int-handle-request-unsafe {chan} { global w3 dict set w3 .reply {} dict set w3 .mimetype {text/html; charset=utf-8} dict set w3 .reply-code {200 Ok} dict set w3 .csp {default-src 'self'} # Set up additional CGI environment values # if {![dict exists $w3 HTTP_HOST]} { dict set w3 BASE_URL {} } elseif {[dict exists $w3 HTTPS]} { dict set w3 BASE_URL https://[dict get $w3 HTTP_HOST] } else { dict set w3 BASE_URL http://[dict get $w3 HTTP_HOST] } if {![dict exists $w3 REQUEST_URI]} { dict set w3 REQUEST_URI / } if {[dict exists $w3 SCRIPT_NAME]} { dict append w3 BASE_URL [dict get $w3 SCRIPT_NAME] } else { dict set w3 SCRIPT_NAME {} } if {![dict exists $w3 PATH_INFO]} { # If PATH_INFO is missing (ex: nginx) then construct it set URI [dict get $w3 REQUEST_URI] regsub {\?.*} $URI {} URI set skip [string length [dict get $w3 SCRIPT_NAME]] dict set w3 PATH_INFO [string range $URI $skip end] } if {[regexp {^/([^/]+)(.*)$} [dict get $w3 PATH_INFO] all head tail]} { dict set w3 PATH_HEAD $head dict set w3 PATH_TAIL [string trimleft $tail /] } else { dict set w3 PATH_INFO {} dict set w3 PATH_HEAD {} dict set w3 PATH_TAIL {} } dict set w3 SELF_URL [dict get $w3 BASE_URL]/[dict get $w3 PATH_HEAD] # Parse query parameters from the query string, the cookies, and # POST data # if {[dict exists $w3 HTTP_COOKIE]} { foreach qterm [split [dict get $w3 HTTP_COOKIE] {;}] { set qsplit [split [string trim $qterm] =] set nm [lindex $qsplit 0] if {[regexp {^[a-z][-a-z0-9_]*$} $nm]} { dict set w3 $nm [w3Int-decode-url [lindex $qsplit 1]] } } } set same_origin 0 if {[dict exists $w3 HTTP_REFERER]} { set referer [dict get $w3 HTTP_REFERER] set base [dict get $w3 BASE_URL] if {$referer==$base || [string match $base/* $referer]} { set same_origin 1 } } dict set w3 SAME_ORIGIN $same_origin if {$same_origin} { w3Int-decode-query-params } # Invoke the application-defined handler procedure for this page # request. If an error occurs while running that procedure, generate # an HTTP reply that contains the error message. # w3-before-dispatch-hook w3Int-trace set mname [dict get $w3 PATH_HEAD] if {[catch { if {$mname!="" && [llength [info command w3-page-$mname]]>0} { w3-page-$mname } else { w3-default } } msg]} { if {[w3-param W3_MODE]=="local" || [w3-param W3_MODE]=="server"} { puts "ERROR: $::errorInfo" } w3-reset w3-reply-code "500 Internal Server Error" w3-mimetype text/html w3-trim { <h1>W3 Application Error</h1> <pre>%html($::errorInfo)</pre> } dict unset w3 .new-cookies } w3-before-reply-hook # Transmit the HTTP reply # set rc [dict get $w3 .reply-code] if {$rc=="ABORT"} { # If the page handler invokes "w3-reply-code ABORT" then close the # TCP/IP connection without sending any reply w3Int-close-channel $chan return } elseif {$chan=="stdout"} { puts $chan "Status: $rc\r" } else { puts $chan "HTTP/1.1 $rc\r" puts $chan "Server: w3\r" puts $chan "Connection: close\r" } if {[dict exists $w3 .reply-extra]} { foreach {name value} [dict get $w3 .reply-extra] { puts $chan "$name: $value\r" } } if {[dict exists $w3 .csp]} { puts $chan "Content-Security-Policy: [dict get $w3 .csp]\r" } set mimetype [dict get $w3 .mimetype] puts $chan "Content-Type: $mimetype\r" if {[dict exists $w3 .new-cookies]} { foreach {nm val} [dict get $w3 .new-cookies] { if {[regexp {^[a-z][-a-z0-9_]*$} $nm]} { if {$val==""} { puts $chan "Set-Cookie: $nm=; HttpOnly; Path=/; Max-Age=1\r" } else { set val [w3Int-enc-url $val] puts $chan "Set-Cookie: $nm=$val; HttpOnly; Path=/\r" } } } } if {[string match text/* $mimetype]} { set reply [encoding convertto utf-8 [dict get $w3 .reply]] if {[regexp {\ygzip\y} [w3-param HTTP_ACCEPT_ENCODING]]} { catch {w3Int-gzip-reply reply chan} } } else { set reply [dict get $w3 .reply] } puts $chan "Content-Length: [string length $reply]\r" puts $chan \r puts -nonewline $chan $reply flush $chan w3Int-close-channel $chan } # Compress the reply content # proc w3Int-gzip-reply {replyVar chanVar} { upvar $replyVar reply $chanVar chan set x [zlib gzip $reply] set reply $x puts $chan "Content-Encoding: gzip\r" } # This routine runs just prior to request-handler dispatch. The # default implementation is a no-op, but applications can override # to do additional transformations or checks. # proc w3-before-dispatch-hook {} {return} # This routine runs after the request-handler dispatch and just # before the reply is generated. The default implementation is # a no-op, but applications can override to do validation and security # checks on the reply, such as verifying that no sensitive information # such as an API key or password is accidentally included in the # reply text. # proc w3-before-reply-hook {} {return} # Process a single CGI request # proc w3Int-handle-cgi-request {} { global w3 env foreach key [array names env {[A-Z]*}] {dict set w3 $key $env($key)} set len 0 if {[dict exists $w3 CONTENT_LENGTH]} { set len [dict get $w3 CONTENT_LENGTH] } if {$len>0} { fconfigure stdin -translation binary dict set w3 CONTENT [read stdin $len] } dict set w3 W3_MODE cgi fconfigure stdout -translation binary w3Int-handle-request-unsafe stdout } # Process new text received on an inbound SCGI request # proc w3Int-scgi-readable {chan} { if {[catch [list w3Int-scgi-readable-unsafe $chan] msg]} { puts stderr "$msg\n$::errorInfo" w3Int-close-channel $chan } } proc w3Int-scgi-readable-unsafe {chan} { upvar #0 w3Int-$chan W w3 w3 if {![dict exists $W .toread]} { # If the .toread key is not set, that means we are still reading # the header. # # An SGI header is short. This implementation assumes the entire # header is available all at once. # |
︙ | ︙ | |||
867 868 869 870 871 872 873 | } if {$len>0} { # Still need to read the query content dict set W .toread $len } else { # There is no query content, so handle the request immediately dict set W SERVER_ADDR [dict get $W .remove_addr] | | | | | | | 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 | } if {$len>0} { # Still need to read the query content dict set W .toread $len } else { # There is no query content, so handle the request immediately dict set W SERVER_ADDR [dict get $W .remove_addr] set w3 $W w3Int-handle-request $chan } } else { # If .toread is set, that means we are reading the query content. # Continue reading until .toread reaches zero. set got [read $chan [dict get $W .toread]] dict append W CONTENT $got dict set W .toread [expr {[dict get $W .toread]-[string length $got]}] if {[dict get $W .toread]<=0} { # Handle the request as soon as all the query content is received dict set W SERVER_ADDR [dict get $W .remove_addr] set w3 $W w3Int-handle-request $chan } } } # Start up the w3 framework. Parameters are a list passed as the # single argument. # # -server $PORT Listen for HTTP requests on this TCP port $PORT # # -local $PORT Listen for HTTP requests on 127.0.0.1:$PORT # # -scgi $PORT Listen for SCGI requests on 127.0.0.1:$PORT |
︙ | ︙ | |||
918 919 920 921 922 923 924 | # after all event handlers are established. # # -trace "puts" each request URL as it is handled, for # debugging # # -debug Disable content compression # | | | | 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 | # after all event handlers are established. # # -trace "puts" each request URL as it is handled, for # debugging # # -debug Disable content compression # # -lint Run w3-safety-check on the application instead # of running the application itself # # -Dvar=value Set TCL global variable "var" to "value" # # proc w3-start {arglist} { global env set mode auto set port 0 set nowait 0 set fromip {} set n [llength $arglist] for {set i 0} {$i<$n} {incr i} { |
︙ | ︙ | |||
968 969 970 971 972 973 974 | incr i set fromip [lindex $arglist $i] } -nowait { set nowait 1 } -debug { | | | | | | | 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 | incr i set fromip [lindex $arglist $i] } -nowait { set nowait 1 } -debug { proc w3Int-gzip-reply {a b} {return} } -trace { proc w3Int-trace {} { set q [w3-param QUERY_STRING] set uri [w3-param BASE_URL][w3-param PATH_INFO] if {$q!=""} {append uri ?$q} puts $uri } } -lint { set res [w3-safety-check] if {$res!=""} { puts "Potential problems in this code:" puts $res exit 1 } else { exit } |
︙ | ︙ | |||
1007 1008 1009 1010 1011 1012 1013 | && [string match CGI/1.* $env(GATEWAY_INTERFACE)]} { set mode cgi } else { set mode local } } if {$mode=="cgi"} { | | | | | 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 | && [string match CGI/1.* $env(GATEWAY_INTERFACE)]} { set mode cgi } else { set mode local } } if {$mode=="cgi"} { w3Int-handle-cgi-request } else { w3Int-start-listener $port $mode $fromip if {!$nowait} { vwait ::forever } } } # Call this version 1.0 package provide w3 1.0 |
Name change from wapptclsh.c.in to w3tclsh.c.in.
1 2 3 4 5 6 | /* ** A TCLSH that reads itself as its initialization script. This is ** intended for use as CGI. The CGI script should look like: ** ** #/usr/bin/cgitclsh ** # | | | | | | | | | | | | | | | 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 | /* ** A TCLSH that reads itself as its initialization script. This is ** intended for use as CGI. The CGI script should look like: ** ** #/usr/bin/cgitclsh ** # ** proc w3-default {} { ** w3 "<h1>Hello, World!</h1>\n" ** } ** w3-default -cgi ** */ #define SQLITE_THREADSAFE 0 #undef SQLITE_ENABLE_COLUMN_METADATA #define SQLITE_OMIT_DECLTYPE 1 #define SQLITE_OMIT_DEPRECATED 1 #define SQLITE_OMIT_PROGRESS_CALLBACK 1 #define SQLITE_OMIT_SHARED_CACHE 1 #define SQLITE_DEFAULT_MEMSTATUS 0 #define SQLITE_MAX_EXPR_DEPTH 0 #define SQLITE_OMIT_LOAD_EXTENSION 1 #define SQLITE_ENABLE_FTS4 1 #define SQLITE_ENABLE_FTS5 1 #define SQLITE_ENABLE_RTREE 1 #define SQLITE_ENABLE_JSON1 1 #define TCLSH_INIT_PROC w3tclsh_init_proc INCLUDE tclsqlite3.c /* The w3.tcl script contains the useful web-application interface ** procedures. After loading this script, "package require w3" becomes ** a no-op */ static const char zW3[] = BEGIN_STRING INCLUDE $ROOT/w3.tcl END_STRING ; /* This script runs to figure out what the main script should be. It ** loads the main script into a TCL variable named "main_script". Or, ** if an interactive shell is desired, "main_script" is unset. */ static const char zW3TclshInit[] = BEGIN_STRING INCLUDE $ROOT/w3tclsh.tcl END_STRING ; /* ** Return the text of the script to run. Or, return NULL to run an ** interactive shell. */ const char *w3tclsh_init_proc(Tcl_Interp *interp){ Tcl_GlobalEval(interp, zW3); /* Load the w3.tcl extension */ Tcl_GlobalEval(interp, zW3TclshInit); /* Load the main loop script */ return Tcl_GetVar(interp, "main_script", TCL_GLOBAL_ONLY); } |
Name change from wapptclsh.tcl to w3tclsh.tcl.
|
| | | | | | 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 | # This script runs to initialize w3tclsh. # proc initialize_w3tclsh {} { global argv argv0 main_script if {[llength $argv]==0} { set script --help } else { set script [lindex $argv 0] } if {[string index $script 0]=="-"} { set opt [string trim $script -] if {$opt=="v"} { puts stderr "W3 using SQLite version [sqlite3 -version]" } else { puts stderr "Usage: $argv0 FILENAME" puts stderr "Options:" puts stderr " -v Show version information" } exit 1 } elseif {[file readable $script]} { set fd [open $script r] set main_script [read $fd] close $fd set argv [lrange $argv 1 end] set argv0 $script } else { puts stderr "unknown option: \"$script\"\nthe --help option is available" } } initialize_w3tclsh |