https://github.com/mrjones-plip/fobber

PHP and Javascript app to show recent fob activity
https://github.com/mrjones-plip/fobber

javascript php

Last synced: 5 days ago
JSON representation

PHP and Javascript app to show recent fob activity

• Host: GitHub
• URL: https://github.com/mrjones-plip/fobber
• Owner: mrjones-plip
• License: mit
• Created: 2019-12-06T07:52:15.000Z (about 5 years ago)
• Default Branch: main
• Last Pushed: 2024-02-04T06:08:19.000Z (11 months ago)
• Last Synced: 2024-03-18T18:10:38.663Z (9 months ago)
• Topics: javascript, php
• Language: JavaScript
• Size: 47.9 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# fobber

## Overview

Log POST results to a text file.  Using AJAX, show most recent 10 POSTs.

## History

I wanted a way to show recent instances of members of my hackerspace

unlocking the front door with their fob. The security system does a webhook

POST to this software.  The software then saves the POST to a file.  Any

GET requests grab the last N lines (default 6) from the log file and 

show this list, along with a logo.

## Install

`git clone` this repo into a web accessible directory.  Ensure that

the directory is writable by the web user.  Copy the `config.dist.php`

to `config.php` and change any values you see fit:

```php

// where you want to save the file

$file = 'fobbers.txt';

// valid fields you accept

$requiredVars = array('user', 'handle', 'color');

// optionally include a path to logo

$logo = null;

// number of recent events to show

$eventCount = 6;

// function you want to use to protect against command line injection and XSS

$cleanseFunction = 'cleanse';

```

# Use

The assumption is that you're going to use the three fields we use

and that the `color` will be an HTML color, possibly two separated by

a comma. Have something do a `POST` with the values you defined

in `$requiredVars`.  Have a device, we use a Raspberry Pi attached

to big TV, show this web page.  Enjoy! 

If you have another use of the events on an external system,

you access JSON feed of events by doing a `GET` request to `/ajax.php`. 

## Cleanse

By default, fobber is very strict with what it writes to disk via [the `cleanse()` function](https://github.com/mrjones-plip/fobber/blob/b265076ad9e145561525d0630d56f99ce622d900/helpers.php#L11).  But maybe you'd like it to be more permissive? You can easily do so with these steps:

1. Create a file called `newCleanse.php` in the `fobber` directory.  

2. In the new file, create a function.  For example it could be called `newCleanse()`.  It should accept one `STRING` argument and return a `STRING`. 

3. Update your `config.php` file so that `$cleanseFunction = 'newCleanse';`. 

   For example, this function will allow Unicode:

   ```php

   function newCleanse($input){

     $result = trim(preg_replace('/[^\w\d\p{L} -|]/u', "", $input));

     return $result;

   }   

   ```

That's it! Your new function will take effect immediately. 

## Development

I use a local PHP web server running in the directory of the repo:

```bash

php -S localhost:8001

```

And then pull up a browser pointing at `localhost:8001` to test `GET` events. 

I use cURL to mimic fob `POST` events:

```bash

curl -d "user=foo2&handle=bar&color=#000,#fff" http://localhost:8001

```

Pull requests welcome!!