zotonic/cowmachine

Webmachine for Zotonic and Cowboy

Zotonic

Zotonic is the open source, high speed, real-time web framework and content management system, built with Erlang.

It is flexible, extensible and designed from the ground up to support dynamic, interactive websites and mobile solutions.

Zotonic is incredibly fast and wonderfully stable – suited for anything from basic websites to complex distributed applications. It offers an elegant backend for managing content with the flexibility that developers need to build truly amazing applications.

Installation

• Download Zotonic from the official website or start Zotonic from a Docker image.
• Read the Installation chapter in the documentation.

Documentation

You can find out more about Zotonic on http://zotonic.com, including:

• Official documentation.
• Release notes.

Contributing

Zotonic is an open source project, made possible by the community. If you’d like to contribute, please read the Contributing chapter in the documentation.

If you encounter any issues, please report them in our issue tracker. If you discover any security-related issues, please contact us at [email protected].

License

Zotonic is released under the Apache 2.0 License. Please refer to the included LICENSE file for more information.

Thanks

Thanks to the following services for supporting Open Source:

cowmachine's Issues

Add test cases

We need test cases for whole requests with different test controllers.

Make controller_http_error configurable

Also test if controller_http_error exists.

Maybe provide a default controller in cowmachine and add a configuration to set an application specific error controller?

Publish action is broken

The publish action shows a repeating error:

Proceed? ("Y")> I didn't get that. This boolean kind of question.

And won't finish.

Remove lager and use a standard logger

Lager has a lot of dependencies, and it logs to disk during development. For a low level library it might be better to use erlangs default error_logger` module.

Application specific logging libraries are able to pick up the messages from there easily.

See: https://github.com/ninenines/cowboy/blob/master/src/cowboy.erl#L82 for inspiration

Check why cowboy sometimes responds with a 204 instead of a 500

When an error happens during responding, cowboy sometimes returns with a 204 response instead of the expected 500 response we are requesting.

Steps to reproduce..

Make a bad match in cowmachine_response:server_header/0, and check the server response in cowmachine_test:cowmachine_start_test/0

Any chance of an example conversion from webmachine to cowmachine?

I'd love to try the conversion, but there's no information on what I need to do, what needs to change with my current webmachine resources, etc. I can fumble around but hoping maybe there's already a doc somewhere?

Wiki documentation. Controller-Functions

• There is strange -spec description of known_methods (Another name for the function). It is very likely that this is a typo.
• content_types_provided. The selected content type can be found with: cowmachine_req:resp_content_type(Context) instead of cowmachine_req:resp_content_type(Request).
• charsets_provided. The selected character set can be found with: cowmachine_req:resp_chosen_charset(Context) instead of cowmachine_req:resp_chosen_charset(Request).

Remove tuncer/sendfile dependency

Cf. zotonic/zotonic#1478.

Crash with search param ?=PHPB8B5F2A0-3C92-11d3-A3A9-4C7B08C10000

In the logs I’m seeing a (silent) crash:

2022-01-04 00:26:07.698 [error] <0.26448.8> Cowboy stream 1 with ranch listener zotonic_https_listener_ipv4 
and connection process <0.26442.8> had its request process exit with reason: {nocatch,{stop_request,500,
{function_clause,[{cowmachine_util,parse_qs_name,[<<"=PHPB8B5F2A0-3C92-11d3-A3A9-4C7B08C10000">>,[],<<>>],[
  {file,"/home/zotonic/zotonic/_build/default/lib/cowmachine/src/cowmachine_util.erl"},{line,284}]},
  {z_context,ensure_qs,1,[{file,"/home/zotonic/zotonic/apps/zotonic_core/src/support/z_context.erl"},{line,
  523}]},{z_cowmachine_middleware,'-execute/2-fun-0-',1,[{file,"/home/zotonic/zotonic/apps/zotonic_core/src/
  support/z_cowmachine_middleware.erl"},{line,54}]},{cowmachine_decision_core,...},...]}}} in 
  cowmachine_decision_core:handle_request/2 line 40

This is caused by search param ?=PHPB8B5F2A0-3C92-11d3-A3A9-4C7B08C10000 which is an easter egg in PHP applications - it is a common way to check if the server exposes sensitive data.

Publish this package to Hex

Currently, publishing to Hex fails because

cowboy, cowlib, mochiweb, parse_trans, ranch, sendfile

are not published on Hex.

• I switched parse_trans to the Hex dep.
• Removed sendfile (#2).
• Cowboy, cowlib and ranch will be fine with Cowboy 2 is released.
• Perhaps we should try to move away from Mochiweb (we only rely on some small parts of it anyway).

Make sure custom websocket handlers are loaded

Cowboy loads custom websocket handlers via cowboy_handler:execute/2 it calls an extra init export. Cowmachine can use custom websocket handlers, but it doesn't call the init/2 export of the handler. Therefore it will not automatically load the handler module. This leads to an initialization problem. You will only notice this when you need special websocket handlers.

Change black/whitelist to block/allowlist

New names:

• Allow-list
• Block-list
• Check-list