This repository has been archived on 2024-04-08. You can view files and clone it, but cannot push or open issues or pull requests.
vbbs/app/Console/Commands/Server.php
2018-12-03 23:59:22 +11:00

927 lines
25 KiB
PHP

<?php
/**
* Viewdata/Videotex Server
*
* Inspired by Rob O'Donnell at irrelevant.com
*/
namespace App\Console\Commands;
use App\Classes\Frame;
use Illuminate\Console\Command;
use Illuminate\Database\Eloquent\ModelNotFoundException;
use Illuminate\Support\Facades\Log;
use Sock\{SocketClient,SocketServer,SocketException};
class Server extends Command
{
// @todo Understand how is this used.
private $fieldoptions = ['f'=>['edit'=>TRUE],'a'=>['edit'=>TRUE]];
/**
* The name and signature of the console command.
*
* @var string
*/
protected $signature = 'server';
/**
* The console command description.
*
* @var string
*/
protected $description = 'Start Videotex Server';
/**
* Create a new command instance.
*
* @return void
*/
public function __construct()
{
parent::__construct();
}
/**
* Execute the console command.
*
* @return mixed
* @throws \Sock\SocketException
*/
public function handle()
{
/**
* Check dependencies
*/
if (! extension_loaded('sockets' ) ) {
throw new SocketException(SocketException::CANT_ACCEPT,'Missing sockets extension');
}
if (! extension_loaded('pcntl' ) ) {
throw new SocketException(SocketException::CANT_ACCEPT,'Missing pcntl extension');
}
// @todo Deprecate this function
define('MSG_TIMEWARP_ON', WHITE . 'TIMEWARP ON' . GREEN . 'VIEW INFO WITH *02');
define('MSG_TIMEWARP_OFF', WHITE . 'TIMEWARP OFF' . GREEN . 'VIEWING DATE IS FIXED');
define('MSG_TIMEWARP_TO', GREEN . 'TIMEWARP TO %s');
define('MSG_TIMEWARP', WHITE . 'OTHER VERSIONS EXIST' . GREEN . 'KEY *02 TO VIEW');
// @todo Deprecate this
include_once('classes/vvdatabase.class.php');
$server = new SocketServer(config('app.port'),config('app.bind'));
$server->init();
$server->setConnectionHandler([$this,'onConnect']);
$server->listen();
}
/**
* Connection handler
*
* @todo: Pressing * three times gets "Shouldnt get here".
*/
function onConnect(SocketClient $client) {
Log::info('Connection from: ',['client'=>$client->getAddress()]);
// @todo To Deprecate in favour of config()
global $config;
include ('config/config.php');
$childpid = pcntl_fork();
if ($childpid == -1)
throw new SocketException(SocketException::CANT_ACCEPT,'Could not fork process');
// Parent return ready for next connection
elseif ($childpid)
return;
// We are now the child.
try {
$session_init = $session_option = FALSE;
$session_note = ''; // TCP Session Notice
$session_term = ''; // TCP Terminal Type
$client->send(TCP_IAC . TCP_DO . TCP_OPT_SUP_GOAHEAD); // DO SUPPRES GO AHEAD
$client->send(TCP_IAC . TCP_WONT . TCP_OPT_LINEMODE); // WONT LINEMODE
$client->send(TCP_IAC . TCP_DO . TCP_OPT_ECHO); // DO ECHO
// $client->send(TCP_IAC.TCP_AYT); // AYT
$client->send(TCP_IAC . TCP_DO . TCP_OPT_TERMTYPE . TCP_IAC . TCP_SB . TCP_OPT_TERMTYPE . TCP_OPT_ECHO . TCP_IAC . TCP_SE); // Request Term Type
$client->send(CLS);
// @todo Deprecate and have an exception handler handle this.
// like throw new FatalClientException(CLS.UP.ERR_DATABASE,500,NULL,$client);
// @todo Get the login/start page, and if it is not available, throw the ERR_DATEBASE error.
$db = new \vvdb();
// Connect to database. Returns error message if unable to connect.
$r = $db->connect($config['dbserver'], $config['database'], $config['dbuser'], $config['dbpass']);
/*
if (!empty($r)) {
http_response_code(500);
$client->send(CLS . UP . ERR_DATABASE);
die ($r);
}
*/
// $user will eventually contain validated user details.
$user = array('systel' => '019990001',
'username' => 'DEMONSTRATION DATA USER',
'address1' => '8 HERBAL HILL',
'address2' => 'LONDON',
'address3' => 'EC1R 5EJ',
'address4' => '',
'address5' => '',
'CUGS' => array(7800, 15500), // Closed User Groups this user has access to
);
$history = array(); // backup history
$cmd = ''; // Current *command being typed in
$mode = false; // input mode.
$prevmode = false; // previous mode
$timewarp = false;
$action = ACTION_GOTO; // do something if set. used here to trigger a goto to the login form.
if (isset($config['loginpage'])) {
$page = $config['loginpage'];
$subpage = 'a';
} else if (!empty($service['start_page'])) {
$page = $service['start_page'];
$subpage = 'a';
} else {
$page = '98'; // next page
$subpage = 'a';
}
$curpage = ''; // current page
$cursub = '';
$curfield = null; // current input field
$curfp = 0; // current field, position within.
$blp = 0; // botton line polluted (by this no. of characters)
$resetpsn = false; // flag to reset position (used in fields)
if (!isset($config['varient_id']))
$config['varient_id'] = NULL;
$service = $db->getServiceById($config['service_id']);
//dd($service);
$varient = $db->getAllVarients($config['service_id'], $config['varient_id']);
if ($varient === false) {
die ("no varient");
}
$varient = reset($varient);
$matches = array();
if (preg_match('@' . $service['page_format'] . '@', $service['start_frame'], $matches)) {
$page = $matches[1];
$subpage = $matches[2];
echo " Using start page " . $page . $subpage . "\n";
}
// $start = $service['start_frame'];
// where to start from
while ($action != ACTION_TERMINATE) {
// Read a character from the client session
$read = $client->read(1);
if ($read != '') {
dump(sprintf('Mode: [%s] CMD: [%s] frame: [%s] Received [%s (%s)]', $mode, $cmd, $page, $read, ord($read)));
// Client initiation input
// TELNET http://pcmicro.com/netfoss/telnet.html
if ($read == TCP_IAC OR $session_init OR $session_option) {
Log::debug(sprintf('Session Char (%s)', ord($read)), ['init' => $session_init, 'option' => $session_option]);
switch ($read) {
// Command being sent.
case TCP_IAC:
$session_init = TRUE;
$session_note = 'IAC ';
continue 2;
case TCP_SB:
$session_option = TRUE;
continue 2;
case TCP_SE:
$session_option = $session_init = FALSE;
Log::debug('Session Terminal: ' . $session_term);
break;
case TCP_DO:
$session_note .= 'DO ';
continue 2;
case TCP_WILL:
$session_note .= 'WILL ';
continue 2;
case TCP_WONT:
$session_note .= 'WONT ';
continue 2;
case TCP_OPT_TERMTYPE:
continue 2;
case TCP_OPT_ECHO:
$session_note .= 'ECHO';
$session_init = FALSE;
$read = '';
Log::debug($session_note);
continue;
case TCP_OPT_SUP_GOAHEAD:
$session_note .= 'SUPPRESS GO AHEAD';
$session_init = FALSE;
$read = '';
Log::debug($session_note);
continue;
default:
if ($session_option AND $read) {
$session_term .= $read;
$read = '';
} else {
Log::debug(sprintf('Unhandled char in session_init :%s (%s)', $read, ord($read)));
}
}
}
switch ($mode) {
// Key presses during field input.
case MODE_FIELD:
//dump(sprintf('** Processing Keypress in MODE_FIELD [%s (%s)]. Last POS [%s]',$read,ord($read),$curfp));
$cmd = '';
$action = FALSE;
switch ($fo->type()) {
// Input frame.
case 'a':
switch ($read) {
// End of field entry.
case HASH:
// Next Field
$curfield++;
//dump(['current'=>$curfield, 'numfields'=>count($fields)]);
if ($curfield < count($fields)) { // skip past non-editable fields
for ($i = $curfield; $i < count($fields); $i++) {
if (isset($this->fieldoptions[$fields[$i]['type']]) &&
$this->fieldoptions[$fields[$i]['type']]['edit']) {
$curfield = $i;
break;
}
}
if ($curfield !== false) {
$client->send(outputPosition($fields[$curfield]['x'], $fields[$curfield]['y']) . CON);
$mode = MODE_FIELD;
$fielddate[$curfield] = '';
} else {
// there were no (more) editable fields.
$action = ACTION_SUBMITRF;
}
} else {
// done them all editable fields.
$action = ACTION_SUBMITRF;
}
break;
case STAR:
$prevmode = MODE_FIELD;
$action = ACTION_STAR;
break;
case KEY_LEFT:
if ($curfp) {
$client->send(LEFT);
$curfp--;
};
break;
case KEY_RIGHT:
if ($curfp++ < $fields[$curfield]['length']) {
$client->send(RIGHT);
//$curfp++;
};
break;
case KEY_DOWN:
if ($curfp + 40 < $fields[$curfield]['length']) {
$client->send(DOWN);
$curfp = $curfp + 40;
};
break;
case KEY_UP:
if ($curfp - 40 >= 0) {
$client->send($read);
$curfp = $curfp - 40;
};
break;
case CR:
if ($curfp + $fields[$curfield]['x'] > 40) { // on second or later line of a field
$client->send($read);
$curfp = (($curfp + $fields[$curfield]['x']) % 40) * 40;
} else {
$client->send(outputPosition($fields[$curfield]['x'], $fields[$curfield]['y']) . CON);
$curfp = 0;
}
break;
case ESC:
break;;
// Record Data Entry
default:
if (ord($read) > 31 && $curfp < $fields[$curfield]['length']) {
$fielddata[$curfield]{$curfp} = $read;
$curfp++;
$client->send($read);
}
}
break;
// Other Frame Types - Shouldnt get here.
default:
$client->close();
throw new \Exception('Shouldnt get here', 500);
} // switch frame types
break;
// Form submission: 1 to send, 2 not to send.
case MODE_SUBMITRF:
switch ($read) {
// @todo Input received, process it.
case '1':
dump(['s' => $service, 'f' => $fielddata]);
if (TRUE) {
sendBaseline($client, $blp, MSG_SENT);
$mode = MODE_RFSENT;
} else {
sendBaseline($client, $blp, ERR_NOTSENT);
$mode = MODE_RFERROR;
}
break;
case '2':
sendBaseline($client, $blp, MSG_NOTSENT);;
$mode = MODE_RFNOTSENT;
break;
case STAR:
$action = ACTION_STAR;
break;
}
break;
// Response form after Sent processing
// @todo To fix.
case MODE_RFSENT:
$client->send(COFF);
if ($read == HASH) {
if (!empty($pagedata['route1'])) {
$action = ACTION_GOTO;
$page = $pagedata['route1'];
$subpage = 'a';
} else if ($r = $db->getFrame($service['service_id'], $varient['varient_id'], $page, chr(1 + ord($subpage)))) {
$action = ACTION_GOTO;
$page = $curpage;
$subpage = chr(1 + ord($subpage));
} else if (!empty($pagedata['route0'])) {
$action = ACTION_GOTO;
$page = $pagedata['route0'];
$subpage = 'a';
// No further routes defined, go home.
} else {
$action = ACTION_GOTO;
$page = '0';
$subpage = 'a';
}
} elseif ($read == STAR) {
$action = ACTION_STAR;
break;
}
break;
// Response form after NOT sending
case MODE_RFNOTSENT:
// Response form ERROR
// @todo To fix
case MODE_RFERROR:
$client->send(COFF);
if ($read == HASH) {
if (!empty($pagedata['route2'])) {
$action = ACTION_GOTO;
$page = $pagedata['route2'];
$subpage = 'a';
} else if ($r = $db->getFrame($service['service_id'], $varient['varient_id'], $page, chr(1 + ord($subpage)))) {
$action = ACTION_GOTO;
$page = $curpage;
$subpage = chr(1 + ord($subpage));
} else if (!empty($pagedata['route0'])) {
$action = ACTION_GOTO;
$page = $pagedata['route0'];
$subpage = 'a';
// No further routes defined, go home.
} else {
$action = ACTION_GOTO;
$page = '0';
$subpage = 'a';
}
} else if ($read == STAR) {
$action = ACTION_STAR;
break;
}
break;
/*
List of alternate options has been presented
*/
case MODE_WARPTO: // expecting a timewarp selection
if (isset($alts[$read - 1])) {
$v = $db->getAllVarients($config['service_id'], $alts[$read - 1]['varient_id']);
if (!empty($v)) {
$varient = reset($v);
$page = $curpage;
$subpage = $cursub;
$action = ACTION_GOTO;
break;
}
}
// if wasn't a valid warpto keypress,
//drop into
// Not doing anything in particular.
case FALSE:
$cmd = '';
Log::debug('Idle', ['pid' => $childpid]);
switch ($read) {
case HASH:
$action = ACTION_NEXT;
break;
case STAR:
$action = ACTION_STAR;
break;
// Frame Routing
case '0':
case '1':
case '2':
case '3':
case '4':
case '5':
case '6':
case '7':
case '8':
case '9':
if ($frame = $fo->route($read)) {
$action = ACTION_GOTO;
} else {
sendBaseline($client, $blp, ERR_ROUTE);
$mode = $action = FALSE;
}
break;
}
break;
/*
currently accepting baseline imput after a * was received
*/
case MODE_BL: // entering a baseline command
echo "was waiting for page number\n";
// if it's a number, continue entry
if (strpos('0123456789', $read) !== false) { // numeric
$cmd .= $read;
$client->send($read);
$blp++;
}
// if we hit a special numeric command, deal with it.
if ($cmd === '00') { // refresh page
$client->send(COFF);
$action = ACTION_RELOAD;
$cmd = '';
break;
}
if ($cmd === '09') { // reload page
$client->send(COFF);
$action = ACTION_GOTO;
$cmd = '';
break;
}
if ($cmd === '02') { // new for emulator
$client->send(COFF);
$action = ACTION_INFO;
$cmd = '';
break;
}
if (($cmd === '01')) { // new for emulator
$client->send(COFF);
$timewarp = !$timewarp;
sendBaseline($client, $blp,
($timewarp ? MSG_TIMEWARP_ON : MSG_TIMEWARP_OFF));
$cmd = '';
$action = $mode = false;
}
// another star aborts the command.
if ($read === "*") { // abort command or reset input field.
$action = false;
sendBaseline($client, $blp, '');
$cmd = '';
if ($prevmode == MODE_FIELD) {
$mode = $prevmode;
$prevmode = false;
$client->send(outputPosition($fields[$curfield]['x'], $fields[$curfield]['y']) . CON);
$client->send(str_repeat(' ', $fields[$curfield]['length']));
// tood reset stored entered text
$resetpsn = $curfield;
} else {
$mode = false;
}
break;
}
// user hit # to complete request
if ($read === '_') { // really the # key,
$client->send(COFF);
if ($cmd === '') { // nothing typed between * and #
$action = ACTION_BACKUP;
} else { // *# means go back
$page = $cmd;
$subpage = 'a';
$action = ACTION_GOTO;
}
$cmd = ''; // finished with this now
break;
}
break;
default:
echo "not sure what we were doing\n";
} // switch $mode
} // something in $read
/*
This section performs some action if it is deemed necessary
*/
if ($action) {
echo "Performing action $action\n";
}
switch ($action) {
case ACTION_STAR:
echo " star command started\n";
sendBaseline($client, $blp, GREEN . '*', true);
$client->send(CON);
$action = false;
$mode = MODE_BL;
break;
case ACTION_SUBMITRF:
$action = false;
sendBaseline($client, $bpl, MSG_SENDORNOT);
$mode = MODE_SUBMITRF;
break;
case ACTION_BACKUP:
// do we have anywhere to go?
if (count($history) > 1) { // because current page should always be in there.
array_pop($history); // drop current page to reveal previous
}
list($page, $subpage) = end($history); // get new last entry,
echo "Backing up to $page$subpage\n";
// drop into
case ACTION_NEXT:
if ($action == ACTION_NEXT) {
$cursub = $subpage;
$subpage = chr(ord($subpage) + 1);
}
case ACTION_GOTO:
// $client->send(HOME . UP . GREEN . "Searching for page $page");
// $blp = 20 + strlenv($page);
// look for requested page
try {
$fo = (new \App\Models\Frame)->fetch($page, $subpage);
} catch (ModelNotFoundException $e) {
Log::debug(sprintf('Frame: %s%s NOT found', $page, $subpage));
if ($action == ACTION_NEXT) {
$subpage = $cursub; // Put subpage back as it was
}
sendBaseline($client, $blp, ERR_PAGE);
$mode = $action = FALSE;
break;
}
dump(['m' => __METHOD__, 'service' => $service['service_id'], 'varient' => $varient['varient_id'], 'frame' => $fo->framenum(), 'type' => $fo->type()]);
// validate if we have access top it
/* if (isset($m['access']) && $m['access'] == 'n') {
sendBaseline($client, $blp, ERR_PAGE);
$mode = $action = false;
break;
}
if (isset($m['cug']) && is_numeric($m['cug']) && $m['cug'] && !in_array($m['cug'],$usercugs)) {
sendBaseline($client, $blp, ERR_PRIVATE);
$mode = $action = false;
break;
}
*/
// we have access...
if ($r['varient_id'] != $varient['varient_id']) {
if (empty($v['varient_date'])) {
sendBaseline($client, $blp, sprintf(MSG_TIMEWARP_TO, 'unknown date'));
} else {
sendBaseline($client, $blp, sprintf(MSG_TIMEWARP_TO, date('j f Y', strtotime($v['varient_date']))));
}
$varient = array_merge($varient, array_intersect_key($r, $varient));
}
//var_dump(['B','r'=>$r,'m'=>$m]);
//$pagedata = array_merge($r, $m);
//$varient = $v;
$curpage = $page;
$cursub = $subpage;
$cufield = 0;
$curfp = 0;
//$pageflags = $db->getFrameTypeFlags($pagedata['type']); // method missing.
$pageflags = [];
if ($action == ACTION_GOTO || $action == ACTION_NEXT) { // only if new location, not going backwards
$history[] = array($page, $subpage);
}
// drop into
case ACTION_RELOAD:
//
/* if ($pageflags['clear']) {
$output = CLS;
$blp = 0;
} else {
$output = HOME;
}
*/
// print_r($pageflags); print_r($pagedata);
switch ($fo->type()) {
default:
case 'i': // standard frame
if ($timewarp && 1 < count(
$alts = $db->getAlternateFrames($service['service_id'], $varient['varient_id'], $curpage, $cursub)
)) {
$msg = MSG_TIMEWARP;
} else {
$msg = '';
}
$output = getOutputx($curpage, $cursub, [], $pageflags, $msg);
//var_dump(['output'=>$output,'curpage'=>$curpage,'cursub'=>$cursub,'pagedata'=>$pagedata,'pageflag'=>$pageflags,'m'=>$msg]);
$blp = strlenv($msg);
$client->send($output);
$mode = $action = false;
break;
case 'a': // active frame. Prestel uses this for Response Framea.
/*
if ($timewarp && 1 < count(
$alts = $db->getAlternateFrames($service['service_id'],$varient['varient_id'],$curpage,$cursub)
)) {
$msg = MSG_TIMEWARP;
} else {
$msg = '';
}
*/
// this is a glorious hack to fix three out of 30,000 pages but might
// break lots more.
//$pagedata = str_replace(chr(12),chr(27),$pagedata);
// holds data entered by user.
$fielddata = array();
$fields = $fo->fields;
$msg = '?';
$output = getOutputx($curpage, $cursub, [], $pageflags, $msg, $user, $fields);
$blp = strlenv($msg);
$client->send($output);
if ($fields->count()) {
// dump($fields,count($fields));
// need t skip to first field that is..
// of a field type that is editable
// or finish.
$curfield = FALSE;
for ($i = 0; $i < count($fields); $i++) {
//dump($this->fieldoptions,$i,isset($this->fieldoptions[$fields[$i]['type']]));
if (isset($this->fieldoptions[$fields[$i]['type']]) &&
$this->fieldoptions[$fields[$i]['type']]['edit']) {
$curfield = $i;
break;
}
}
$resetpsn = $curfield;
if ($curfield !== false) {
$mode = MODE_FIELD;
} else {
// there were no editable fields.
$mode = MODE_COMPLETE;
}
$curfp = 0;
//dump(['curfield'=>$curfield,'mode'=>$mode]);
}
break;
case 't': // terminate
$output = getOutputx($curpage, $cursub, [], $pageflags);
$client->send($output);
$action = ACTION_TERMINATE;
break;
} // switch
break;
case ACTION_INFO: // special emulator command
$mode = false;
$cmd = '';
$action = false;
$output = outputPosition(0, 0) . WHITE . NEWBG . RED . 'TIMEWARP INFO FOR Pg.' . BLUE . $curpage . $cursub . WHITE;
$output .= outputPosition(0, 1) . WHITE . NEWBG . BLUE . 'Service : ' . substr($service['service_name'] . str_repeat(' ', 27), 0, 27);
$output .= outputPosition(0, 2) . WHITE . NEWBG . BLUE . 'Varient : ' . substr($varient['varient_name'] . str_repeat(' ', 27), 0, 27);
$output .= outputPosition(0, 3) . WHITE . NEWBG . BLUE . 'Dated : ' . substr(date('j F Y', strtotime($varient['varient_date'])) . str_repeat(' ', 27), 0, 27);
$alts = $db->getAlternateFrames($service['service_id'], $varient['varient_id'], $curpage, $cursub);
if (count($alts) > 1) {
$n = 1;
$output .= outputPosition(0, 4) . WHITE . NEWBG . RED . 'ALTERNATIVE VERSIONS:' . str_repeat(' ', 16);
$y = 5;
foreach ($alts as $ss) {
// if (is_numeric($ss['varient_date'])) {
$date = date('d M Y', strtotime($ss['varient_date']));
// } else {
// $date = 'unknown';
// }
$line = WHITE . NEWBG;
if ($timewarp) {
$line .= RED . $n;
}
$line .= BLUE . $date . ' ' . $ss['varient_name'];
$output .= outputPosition(0, $y) . $line . str_repeat(' ', 40 - strlenv($line));
$y++;
$n++;
}
if ($timewarp) {
$mode = MODE_WARPTO;
}
}
$client->send($output);
break;
default:
;
} // switch $action
if ($resetpsn !== false && isset($fields[$resetpsn])) {
$client->send(outputPosition($fields[$resetpsn]['x'], $fields[$resetpsn]['y']) . CON);
$resetpsn = false;
}
if ($read === null || socket_last_error()) {
printf("[%s] Disconnected\n", $client->getaddress());
return false;
}
}
// Something bad happened. We'll log it and then disconnect.
} catch (\Exception $e) {
Log::emergency($e->getMessage());
}
$client->close();
printf( "[%s] Disconnected\n", $client->getaddress() );
}
}
function strlenv($text){
return strlen($text) - substr_count($text, ESC);
}
// @todo Not clearing to end of line.
function sendBaseline($client, &$blp, $text, $reposition = false){
$client->send(HOME . UP . $text .
( $blp > strlenv($text) ? str_repeat(' ',$blp-strlenv($text)) .
( $reposition ? HOME . UP . str_repeat(RIGHT, strlenv($text)) : '' )
: '')
);
$blp = strlenv($text);
return;
}
function outputPosition($x,$y){
if ($y < 12) {
if ($x < 21) {
return HOME . str_repeat(DOWN, $y) . str_repeat(RIGHT, $x);
} else {
return HOME . str_repeat(DOWN, $y+1) . str_repeat(LEFT, 40-$x);
}
} else {
if ($x < 21) {
return HOME . str_repeat(UP, 24-$y) . str_repeat(RIGHT, $x);
} else {
return HOME . str_repeat(UP, 24-$y) . str_repeat(LEFT, 40-$x);
}
}
}
/*
return a screen output ... $msg sent on baseline just after the cls.
remember to update $blp manually after calling this.
*/
function getOutputx($page, $subpage, $pagedata, $pageflags, $msg = '', $user = array(), &$fields = null, &$frame_content = null) {
global $blp;
global $fieldmap; // @todo this is not set outside of the class.
$price = isset($pagerecord['price']) ? $pagerecord['price'] : 0;
// get textual content.
$fo = (new \App\Models\Frame)->fetch($page,$subpage);
$text = (string)$fo;
//$text = $pagedata['frame_content'];
// dump(['C'=>__METHOD__,'frame_content'=>$text,'msg'=>$output,'p'=>$page,'s'=>$subpage,'startline'=>$startline,'frame'=>$fo,'fields'=>$fo->fields($startline)]);
return (string)$fo;
}