# Surveillance-camera-system---python---Flask---docker-compose-

#### Freelancer contest project

## Key features:

* python subprocessing
* parallel image processing
* composite image with ```openCV```
* interactive image map with ```imagemapster```
* ```flask socketIO``` servers generated on the fly based on ```MySQL``` database content
* all the volumes are ```bind``` types, making it easy to setup before any ```docker-compose up [...]```
* ```vsftpd``` FTP interface for fast archive lookups
* *modus operandi* via ```DEMOMODE``` environment variable

The only registered user 'admin' (pw:'admin') can add/delete cameras, and set up the composite image that all user can see realtime.

Non admin user 'user' can not edit the composite image, but can select one for full-frame watching, and switch back and forth between the single image and composite mode.

For the demo cameras base image can be selected from the ```static/img/``` folder. If the image is larger than the camera image size defined by ```BASEWIDTH``` and ```BASEHEIGHT``` environment variables, the actual camera server scans the image at arbitrary steps from arbitrary start position and direction, with the parameters randomly set at startup.

Setting the camera image size to 256X128 or lower by ```BASEWIDTH``` and ```BASEHEIGHT```, results random coloured timestamps - for testing.

```DEMOMODE``` environment variable can have 4 values:
1. ```DEMOMODE=0``` (or not defined) for demo mode when:
* No file IO (except the reading of the demo image)
* all the image data is in memory throughout the whole process
* the image data is transferred by socket IO
2. ```DEMOMODE=1``` same as mode ```0```, but makes:
* the Camera server instances create (touch) null image files, named as in requirements.
* Cron do test output, so timestamp-named folders with the null images as in requirements.
3. ```DEMOMODE=2``` same as mode ```0```, but image data is saved from camera servers to their last location in each second, so they are accessible to Cron for archiving.
4. ```DEMOMODE=3``` for each camera a new camera module is being created, and put in subprocess for image creation and file IO or FTP accordingly, but without socket IO as real cameras are not expected to do socket IO. Separate instances of camera modules are for socket IO and file IO, as ASCII flowchart shows below.
#### Miscallaneous:
1. <br>It now works like charm by entering ```docker-compose up –build``` from the root directory of my project. Prior to that the app can be tuned by the environment variables in “.env”.
2. <br>Each image is armed with bash shell, so each of them can be playing around with:
<br>```docker exec -it flask_app /bin/bash```
<br>```docker exec -it flask_mysql /bin/bash```
<br>```docker exec -it flask_cron /bin/bash```
<br>```docker exec -it flask_ftp /bin/bash```
3. <br>To use the database (e.g. with mysql-workbench) without running the application, just move the line comment from the “sandbox mode” line to the command below (from line 36 to line 37 as they are at this point in time).
<br>From:
<br>```#command: tail -f /dev/null # Sandbox mode```
<br>```command: gunicorn --worker-class eventlet --workers 1 --bind 0.0.0.0:5000 socketioapp:app```
<br>To:
<br>```command: tail -f /dev/null # Sandbox mode```
<br>```#command: gunicorn --worker-class eventlet --workers 1 --bind 0.0.0.0:5000 socketioapp:app```
<br>Make a connection with the ```mysqlcon.py```, or use the line from that file at the condition “not INSIDEDOCKER".
<br>Host=0.0.0.0, user=user, pw=pass.
4. <br>The generated and cron-arranged files can be found in ```.data/storage```.
#### Flowchart of DEMOMODE=3
```
<------------+
<------------+       +-------------------+  +------------+ +------------+
<------------+       |      SIO App      |  |  Camera 3. | |  Camera 1. |
<------------+       +-------------------+  +------------+ +------------+
    Users    |-------- role1:Web Server  |  | role: FTP  | | role: FTP  |
                     | ----------------- |  +---------|--+ +---|--------+
                     | role2:SIO Client  -----+       |        |
                     +-------------------+    |       |        |
                                              |       \        /
                                              |        |      |
                                              |        |      |
                                              |     +--v------v------+
                    +-------------------+     |     |                |
                    | CamServ (central) |     |     |   FTP Server   |
                    +-------------------+     |     |                |
                    | role1:SIO Server  <-----+     +--------|-------+
                    | ----------------- |                    |
              +------ role2:SIO Client  |                    |
              |     +-------------------+                    |
              |                                    +---------v--------+
              |                                    | ---------------  |
              |     +-------------------+          | ---------------  |
              |     |  Camera Server 1. <---------->      Phys.       |
              |     +-------------------+          |     volume       |
              |-----> role: SIO Server  |          | ---------------  |
              |     +-------------------+          | ---------------  |
              |     +-------------------+          +--------------^---+
              |     |  Camera Server 2. <--\  +------------+      |
              |     +-------------------+   ---  Camera 2. |      |
              |-----> role: SIO Server  |     +------------+      |
              |     +-------------------+     |role: Client|      |
              |     +-------------------+     +------------+      |
              |     |  Camera Server 3. <-------------------------+
              |     +-------------------+
              |-----> role: SIO Server  |
              |     +-------------------+
              |     +-------------------+           +------------+
              |     |  Camera Server 4. <------------  Camera 4. |
              |     +-------------------+           +------------+
              +---->| role: SIO Server  |           |role: Client|
                    +-------------------+           +------------+
```