ObjFW  History of src/OFHTTPServer.m of efc6b07e2c8fab5e

This deprecates OFHTTPRequestMethodName(), which returns a C string.
APIs should avoid C strings as much as possible.

This function was initially only used internally, where this was fine.
However, when it was made public, it should have been converted to
OFString at the same time.

Adds OFHTTPRequestMethodParseString() for consistency, which behaves the
same as OFHTTPRequestMethodParseName() and deprecates it. file: [c229043b21] check-in: [12c09ef41e] user: js, branch: trunk, size: 20104 [annotate] [blame] [check-ins using] [diff]

This allows for a much cleaner solution to avoid the internal read
buffer of e.g. a TLS connection never being processed while waiting for
a delimiter. file: [ab884b4ab8] check-in: [a61e0594b4] user: js, branch: trunk, size: 20102 [annotate] [blame] [check-ins using] [diff]

This is as per the RFC, which says the scheme and path can never be
missing, while the path can be empty. file: [e75cf57b42] check-in: [3e455c4839] user: js, branch: trunk, size: 20016 [annotate] [blame] [check-ins using] [diff]

The previous API could never work cleanly and would always require
hacks, as it needed intercepting all interactions of OFTCPSocket with
the raw socket and did not work at all if the OFTCPSocket had anything
in its read buffer before starting the TLS handshake. This also could
not be fixed easily, as it would have required the object to contain two
read buffers, one for the unencrypted connection and one for the
encrypted connection. There was also no clean way to perform the
handshake in a non-blocking way.

The new API is a lot cleaner and requires none of the hacks, but using
it requires slightly more work. But this is more than made up for by
making a fully asynchronous handshake possible. It uses the concept of a
stream wrapping another stream, meaning the entire connecting part is
being handled by OFTCPSocket and then the connected socket is passed off
to OFTLSStream to wrap it. This also makes for a lot cleaner separation
of concerns. file: [9d3b80f535] check-in: [d30efa8bbf] user: js, branch: trunk, size: 19818 [annotate] [blame] [check-ins using] [diff]

The old write API made it too easy to lose bytes when a stream is set to
non-blocking mode. The new API always throws when not all bytes were
written, which forces handling the number of bytes being written being
smaller than the number of bytes requested to be written. file: [fa53a5562c] check-in: [d1d36ae522] user: js, branch: trunk, size: 19842 [annotate] [blame] [check-ins using] [diff]

The current API is too tied to OpenSSL. file: [48c91c9511] check-in: [a5a3047210] user: js, branch: trunk, size: 19680 [annotate] [blame] [check-ins using] [diff]

This is only migrating some places, others will be migrated as they are
touched. file: [038308e952] check-in: [a0fd103a0b] user: js, branch: trunk, size: 21359 [annotate] [blame] [check-ins using] [diff]

While -[OFData initWithDataNoCopy:count:itemSize:freeWhenDone:] can
currently never throw, it might in the future, and when it does so in
the future, these would be memory leaks then. file: [ac3250a22a] check-in: [a2b4238850] user: js, branch: trunk, size: 21471 [annotate] [blame] [check-ins using] [diff]

It used to be a short in some places and an int in other places. file: [28acc739df] check-in: [6e42ee482f] user: js, branch: trunk, size: 21688 [annotate] [blame] [check-ins using] [diff]

Since C guarantees minimum sizes for char, short, int, long and long
long, these can be used instead. file: [abf9a790cd] check-in: [25c985fec1] user: js, branch: trunk, size: 21686 [annotate] [blame] [check-ins using] [diff]

This solves the old signed vs. unsigned problem and allows for more
bases than just 8, 10 and 16, as well as auto-detection of the base (if
base is 0). file: [0eb4bcc334] check-in: [b6ee372b98] user: js, branch: trunk, size: 21679 [annotate] [blame] [check-ins using] [diff]

This is a new superclass for OFTCPSocket to allow sharing code with
other IP stream socket types, namely SCTP. file: [1d12ee9c38] check-in: [3dfe642dd3] user: js, branch: trunk, size: 21397 [annotate] [blame] [check-ins using] [diff]

Without this, there would be no indication of the error when using -q. file: [69c85c4501] check-in: [9c506fc995] user: js, branch: trunk, size: 18813 [annotate] [blame] [check-ins using] [diff]

This means refusing to close twice, calling -[close] from -[dealloc] and
not calling -[cancelAsyncRequests].

Calling -[cancelAsyncRequests] in -[close] is too dangerous, as -[close]
gets called by -[dealloc]: If the queue is the last reference to the
object, at the point where -[cancelAsyncRequests] removes it from the
queue, the object will start to deallocate and call into
-[cancelAsyncRequests] again, which is still in the middle of removing
it and now finds itself with an inconsistent state. file: [e03c4b06ca] check-in: [3b43d51006] user: js, branch: trunk, size: 20441 [annotate] [blame] [check-ins using] [diff]

Otherwise, there would be two methods for every operation: One for
success and one for failure. It also makes it easy to forget about
handling failure, so it's better to always pass an optional exception. file: [aae9d41f78] check-in: [064dbe5127] user: js, branch: trunk, size: 17630 [annotate] [blame] [check-ins using] [diff]

The target / selector approach had several drawbacks:

* It was inconvenient to use, as for every read or write, a target,
selector and context would need to be specified.
* It lacked any kind of type-safety and would not even warn about using
a callback method with the wrong number of parameters.
* It encouraged using a different callback method for each read or
write call, which results in code that is hard to follow and also
slower (as it needs to recreate the async operation with a new
callback every time). file: [fe26303808] check-in: [d16ad96cbd] user: js, branch: trunk, size: 17752 [annotate] [blame] [check-ins using] [diff]

This makes it more clear that this has nothing to do with the body of
the response, as the body of the response is read from the
OFHTTPResponse itself. file: [d2c22eea59] check-in: [d375061886] user: js, branch: trunk, size: 17226 [annotate] [blame] [check-ins using] [diff]

Instead, provide a stream for the body to the callback. file: [b47d8bb3a2] check-in: [f756fb2ff6] user: js, branch: trunk, size: 17177 [annotate] [blame] [check-ins using] [diff]

Instead of letting OFStream conform to it, which itself does not really
conform to it, let all the subclasses that actually do conform to it. file: [1522d55623] check-in: [69749b6a5b] user: js, branch: trunk, size: 16990 [annotate] [blame] [check-ins using] [diff]

This allows retrieving it how it was originally stored, which is useful
for example for query strings, as these often URL-encode allowed
characters in order to allow pairs of the form foo=bar&bar=qux. file: [3bc806eac7] check-in: [a15b403a11] user: js, branch: trunk, size: 16961 [annotate] [blame] [check-ins using] [diff]

This removes the special handling dependent on the scheme. file: [380d4e5179] check-in: [0f995db06d] user: js, branch: trunk, size: 16931 [annotate] [blame] [check-ins using] [diff]

Instead, explicitly declare them, as OF_ASSUME_NONNULL_{BEGIN,END} does
not apply to implicit return types. This means that after this commit,
all init methods have a nonnull return type, as they should have. file: [339d905a8d] check-in: [2f4e0df8be] user: js, branch: trunk, size: 16887 [annotate] [blame] [check-ins using] [diff]

This was overlooked when URLs were changed to include the / in the path. file: [d18b7e3988] check-in: [2b6fb5530e] user: js, branch: trunk, size: 16502 [annotate] [blame] [check-ins using] [diff]

This matches Apple's style. file: [4d2868ce13] check-in: [6b77a5dd8b] user: js, branch: trunk, size: 16552 [annotate] [blame] [check-ins using] [diff]

Casts are now written like types in variable declarations. file: [6f3529bdbf] check-in: [4af49a13c3] user: js, branch: trunk, size: 16552 [annotate] [blame] [check-ins using] [diff]

Forgot to add 2017, even though I already did quite some changes in
2017. file: [fe9e1ee8d4] check-in: [44f45c2e35] user: js, branch: trunk, size: 16533 [annotate] [blame] [check-ins using] [diff]

These are independent of the locale and work on the ASCII character set.

Unlike the C ones, these are 8-bit safe, meaning if a character > 0x7F
is passed, is{alpha,alnum} returns false and to{upper,lower} returns the
original character. file: [30505eba7a] check-in: [d9eb7b50b3] user: js, branch: trunk, size: 16527 [annotate] [blame] [check-ins using] [diff]

Right now, this is only useful for OFTCPSocket, as this is the only
class so far not establishing the stream in the init method. However,
this adds the general infrastructure to allow reuse to all subclasses of
OFStream. file: [28126036a1] check-in: [1de551cb5f] user: js, branch: trunk, size: 16488 [annotate] [blame] [check-ins using] [diff]

This is required as passing something signed to it is an error on
NetBSD, but passing anything else than a char is undefined on Linux. file: [b9d140020a] check-in: [09a0d12bae] user: js, branch: trunk, size: 16471 [annotate] [blame] [check-ins using] [diff]

Setting it to nil means no Server header is sent. file: [e2c16ad886] check-in: [6b4d138cc3] user: js, branch: trunk, size: 15936 [annotate] [blame] [check-ins using] [diff]

This should randomize the order of all headers now, preventing
fingerprinting by the order of HTTP headers. file: [5b5e9e2174] check-in: [58d4025602] user: js, branch: trunk, size: 15884 [annotate] [blame] [check-ins using] [diff]

While at it, also update the mail address. file: [aed0368bbf] check-in: [cec0f072f8] user: js, branch: 0.8, size: 16110 [annotate] [blame] [check-ins using] [diff]

While at it, also update the mail address. file: [9cfe1fbff0] check-in: [2a27cf3000] user: js, branch: trunk, size: 15701 [annotate] [blame] [check-ins using] [diff]

Now that we can require GCC >= 4.6, we no longer need to fall back to
using a category on old compilers. file: [3f7a396278] check-in: [2aca549d60] user: js, branch: trunk, size: 15697 [annotate] [blame] [check-ins using] [diff]

This increases the required GCC version from 4.0 to 4.6 (exception:
Apple GCC, which already supports this with >= 4.0 starting with OS X
10.5). Since even GCC 4.6 is really old by now, there is no point in
still supporting something even older and making the code ugly because
of that. While some hardware and OS support was dropped from GCC 4.6
compared to GCC 4.0, there is nothing in there that would be an
interesting target with the exception of BeOS maybe - but a port to BeOS
can also be achieved using the Haiku support. The other dropped OSes are
mostly old versions of OSes while newer ones are still being supported
(and those newer versions of those OSes still support the same
hardware). file: [c7dbee91dc] check-in: [48980f2297] user: js, branch: trunk, size: 15716 [annotate] [blame] [check-ins using] [diff]

Closing it manually causes the fd to become invalid before it is removed
from the OFKernelEventObserver. file: [36dd983976] check-in: [b87a5d3b46] user: js, branch: trunk, size: 15772 [annotate] [blame] [check-ins using] [diff]

While Cocoa includes it, RFC 1738 explicitly states that the "/" between
host / port and path is not part of the path. file: [3efdaebeee] check-in: [d2487bc7e1] user: js, branch: trunk, size: 15501 [annotate] [blame] [check-ins using] [diff]

This means that OFObject.h imports macros.h now, making it unnecessary
to manually import macros.h in almost every file. And while at it, also
import autorelease.h in OFObject.h, so that this doesn't need to be
manually imported in almost every file as well. file: [79b7aacf76] check-in: [13ee56edf3] user: js, branch: trunk, size: 15354 [annotate] [blame] [check-ins using] [diff]

This replaces -[numberOfBytesInReadBuffer], as it's not always known how
many bytes there are exactly and thus the number would often be wrong
(e.g. because data is compressed). file: [7f98124205] check-in: [acc999a75e] user: js, branch: trunk, size: 15398 [annotate] [blame] [check-ins using] [diff]

Not using -std=gnu11 means _GNU_SOURCE does not get defined anymore,
therefore this commit also adds the required feature defines for glibc.

Additionally, this adds of_strdup in macros.h, as strdup is an
extension. file: [48d8bdc4b1] check-in: [2f5af58573] user: js, branch: trunk, size: 15389 [annotate] [blame] [check-ins using] [diff]

This allows binding to a random port and calling [server port] to get
the port used. file: [3104ed8898] check-in: [1724525754] user: js, branch: trunk, size: 15386 [annotate] [blame] [check-ins using] [diff]

A file documenting the coding style will be written soon. This will
hopefully prevent conflicts in the future, such as whether static
functions are written in camelCase or_with_underscores, like was the
case here. file: [6a0ef70d6f] check-in: [fa6496efc7] user: js, branch: trunk, size: 15385 [annotate] [blame] [check-ins using] [diff]

This mostly removes the argument for the class in which the exception
occurred. As backtraces were recently added for all platforms, the
passed class does not give any extra information on where the exception
occurred anymore.

This also removes a few other arguments which were not too helpful. In
the past, the idea was to pass as many arguments as possible so that it
is easier to find the origin of the exception. However, as backtraces
are a much better way to find the origin, those are not useful anymore
and just make the exception more cumbersome to use. The rule is now to
only pass arguments that might help in recovering from the exception or
provide information that is otherwise not easily accessible. file: [0971f78b90] check-in: [3d16a30f41] user: js, branch: trunk, size: 15499 [annotate] [blame] [check-ins using] [diff]

The only places where BOOL is left are those where they are required by
the ABI. file: [a4708f3429] check-in: [c5ef582958] user: js, branch: trunk, size: 15624 [annotate] [blame] [check-ins using] [diff]

This also implements chunked transfer encoding for OFHTTPServer and adds
a property for the protocol version to OFHTTPRequest(Reply).

Additionally, this makes it possible to add an async version of
OFHTTPClient. file: [3a7faef063] check-in: [bdf9c4d96b] user: js, branch: trunk, size: 15267 [annotate] [blame] [check-ins using] [diff]

This also makes sure those aren't sent twice in case they are also in
the headers. file: [85b2274e9b] check-in: [8472e9eade] user: js, branch: trunk, size: 14288 [annotate] [blame] [check-ins using] [diff]

This way, it is possible to recover from errors by e.g. stopping the
server in the main thread and then restarting it, or by just ignoring
the exception. file: [f75ba40071] check-in: [df7b88405a] user: js, branch: trunk, size: 14288 [annotate] [blame] [check-ins using] [diff]

The class also has its own file now. file: [80903ac435] check-in: [75f187cef5] user: js, branch: trunk, size: 14089 [annotate] [blame] [check-ins using] [diff]

Before, it incorrectly was part of the path instead of being in the
query field. file: [a3b1ef98c3] check-in: [f8a7660ac7] user: js, branch: trunk, size: 14059 [annotate] [blame] [check-ins using] [diff]