HTTP Request
The traditional loading of a page is a http
request,
e.g. calling the main address https://foodsharing.de
calls /src/Entrypoint/IndexController.php
which uses other php
files to answer the request.
The php
builds html
, css
and javascript
and sends them to the client.
Other ways to interact with the foodsharing platform are:
- (Legacy) XHR - do not use in new code!
- the REST API endpoints - the preferred option
- our chatserver
XHR
XHR (XMLHttpRequest) is used throughout the project for historic reasons, but should be replaced with modern API endpoints where possible. So do not implement new features with XHR! The following is just documentation to understand what exists :)
We used XHR for information transferred from the server to the client which is not a complete new page but javascript-initiated.
For example, the Update-Übersicht on the Dashboard was loaded by an XHR that gets a json file with the information of the updates.
The javascript was found in /client/src/activity.js
, and
it called XHR endpoints like http://foodsharing.de/xhrapp.php?app=basket&m=infobar
.
This requests an answer by /src/Entrypoint/XhrAppController.php
which in turn calls the correct php
file based on the options that are given after the ?
in the url.
For example, the activity.js
requests were answered by
/src/Modules/Activity/ActivityXhr.php
.
In this example, the database was queried for information via ActivityModel.php
which in turn used the /src/Modules/Activity/ActivityGateway.php
.
There are a two mostly identical XHR endpoints - /xhr.php
and /xhrapp.php
. Nowadays, those are handled by XhrController.php
and XhrAppController.php
respectively.
XHR-request answers contain a status and data and ? and always sends the HTTP status 200. So errors are not recognizable by the HTTP status, but by a custom status in the returned json response.
REST API
The more modern way to build our api is a REST api by FOS (friends of symfony). The documentation of the REST api endpoints is located at the definition of the endpoints and can be nicely viewed on (https://beta.foodsharing.de/api/doc/).
In the documentation you can read how to properly include the documentation.
A good example can be found in /src/RestApi/ForumRestController.php
.
In the Code quality page we have some notes on how to define the REST API Endpoints.
The javascript code that sends REST API requests is found under /client/src/api
and is used by other javascript by import.
All php classes working with REST requests are found in /src/Modules/RestApi/<..>RestController.php
.
This is configured in /config/routes/api.yml
.
There it is also configured, that calls to /api/
are interpreted by the REST api, e.g.
https://foodsharing.de/api/conversations/<conversationid>
This is being called when you click on a conversation on the „Alle Nachrichten“ page.
REST is configured via annotations in comments in functions.
@Rest\Get("subsite")
specifies the address to access to start this Action: `https://foodsharing.de/api/subsite"@Rest\QueryParam(name="optionname")
specifies which options can be used. These are found behind the?
in the url:http://foodsharing.de/api/conversations/687484?messagesLimit=1
only sends one message.- Both
Get
andQueryParam
can enforce limitations on the sent data withrequirement="<some regular expression>"
. @SWG\Parameter
,@SWG\Response
, ... create the documentation (see above)
Functions need to have special names for symfony to use them: the end with Action
.
They start with a permission check, throw a HttpException(401)
if the action is not permitted.
Then they somehow react to the request, usually with a Database query via the appropriate Model or Gateway classes.
During running php, the comments get translated to convoluted php code. REST also takes care of the translation from php data structures to json. This json contains data. Errors use the error codes of http-requests.
While reading and writing code a (basic) manual and an annotation overview will help.
nodejs for messages
The chats have a separate way of communication between client and server.
For all other pages the initiative starts at the client,
the client sends a request to the (php
) server and gets an answer.
Each request uses one connection that is closed afterwards.
This is not useful for the chats since the server knows that there are new messages and has to tell the client.
For this case there exists a separate nodejs
server (on the same machine as the php
server but separate). This holds an open connection to each user that has foodsharing.de
open on their device. Each time a message arrives at the php server, it sends this information to the nodejs
server via a websocket
which uses the connection to the client to send the message.
Note that there can be several connections to each session, of which there can be several for each user. nodejs
sends the message to all connections of all addressed users.
The code for the nodejs
server is found in /chat/src/index.ts
and other files in /chat/src
chat/socket.io -> nodejs server, in chat/src/index.ts. There is documentation for all used parts in /chat/node_modules/<modulename>/Readme.md
. All nodejs
-documentation is found on their webpage.